cradova 1.1.0 → 1.1.1

package/dist/index.d.ts

@@ -1,148 +1,4 @@
 declare module "cradova" {
-  /**
-   * swipe
-   * ---
-   * Now you can detect swipes the best way possible
-   *
-   * @param callback
-   * @param touching?
-   * @param element?
-   */
-  export function swipe(
-    callback: (swipe_data: Record<string, number>) => void,
-    touching?: boolean,
-    element?: HTMLElement
-  ): {
-    start(): void;
-    stop(): void;
-  };
-  /**
-   *  Cradova Signal
-   * ----
-   *  create stateful data store.
-   * ability to:
-   * - create a store
-   * - create actions and fire them
-   * - bind a Ref or RefList
-   * - listen to changes
-   * -  persist changes to localStorage
-   * - go back and forward in value history
-   * - set keys instead of all values
-   * - update a cradova Ref/RefList automatically
-   * @constructor initial: any, props: {useHistory, persist}
-   */
-  export class createSignal {
-    value: any;
-    constructor(
-      initial: unknown,
-      props?: {
-        useHistory?: boolean;
-        persistName?: string | undefined;
-      }
-    );
-    /**
-     *  Cradova Signal
-     * ----
-     *  set signal value
-     * @param value - signal value
-     * @returns void
-     */
-    set(value: unknown, shouldRefRender?: boolean): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a key value if it's an object
-     * @param name - name of the key
-     * @param value - value of the key
-     * @returns void
-     */
-    setKey(name: string, value: any, shouldRefRender?: boolean): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a prop value inside an object prop of the store
-     * @param key - a prop of the store - object value
-     * @param name - prop of the key object
-     * @param value - value of the name
-     * @returns void
-     */
-    setPath(
-      key: string,
-      name: string,
-      value: any,
-      shouldRefRender?: boolean
-    ): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a prop value inside an array prop of the store
-     * @param key - a prop of the store - object value
-     * @param index - index of the key object
-     * @param value - value of the index
-     * @returns void
-     */
-    setIndex(
-      key: string,
-      index: number,
-      value: any,
-      shouldRefRender?: boolean
-    ): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a key to signal an action
-     * @param name - name of the action
-     * @param action function to execute
-     */
-    createAction(
-      name: string | Record<string, (self?: any, data?: any) => void>,
-      action?: (self?: any, data?: any) => void
-    ): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  fires an action if available
-     * @param name - string name of the action
-     * @param data - data for the action
-     */
-    fireAction(name: string, data?: any): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a auto - rendering component for this store
-     *
-     * @param Ref component to bind to.
-     * @param path a property in the object to send to attached ref
-     */
-    bindRef(Ref: any, path?: string): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set signal value to a future one
-     * @returns void
-     */
-    forward(): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set signal value to a old past one
-     * @returns void
-     */
-    backward(): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a update listener on value changes
-     * @param callback
-     */
-    listen(callback: (a: any) => void): void;
-    /**
-     *  Cradova Signal
-     * ----
-     * clear the history on local storage
-     */
-    clearPersist(): void;
-  }
   type CradovaScreenType = {
     name: string;
     template: Function | HTMLElement;
@@ -244,24 +100,34 @@ declare module "cradova" {
         ) => void;
       }
     | Record<string, any>;
-  /**
-   * Cradova Router
-   * ---
-   * Facilitates navigation within the application and initializes
-   * page views based on the matched routes.
-   */
-  export const Router: RouterType;
+
   /**
    * @param name
    * @param template
    * @param transitions
    */
   export class Screen {
+    /**
+     * this should be a cradova screen component
+     */
+    private html;
     /**
      * this is the name of the screen that appears as the title
      */
     name: string;
+    private packed;
     secondaryChildren: Array<any>;
+    /**
+     * used internally
+     */
+    private template;
+    /**
+     * this a set of two class names
+     * one for the entry transition
+     * and one for the exit transition
+     */
+    private transition;
+    private callBack;
     static SCALE_IN: string;
     static SCALE_OUT: string;
     static CIRCLE_IN: string;
@@ -288,11 +154,258 @@ declare module "cradova" {
     deActivate(): void;
     Activate(data?: any, force?: boolean): Promise<void>;
   }
+
   export class Scaffold {
+    private history;
+    private Scaffolds;
     push(label: string, data?: unknown, force?: boolean): Promise<void>;
     pop(data?: unknown, force?: boolean): Promise<void>;
     addScaffolds(scaffolds: Record<string, CradovaScreenType>): Promise<void>;
   }
+
+  /**
+   * Cradova Router
+   * ---
+   * Facilitates navigation within the application and initializes
+   * page views based on the matched routes.
+   */
+  export const Router: RouterType;
+
+  /**
+   * Send a new state to specified element with stateID
+   *
+   * @param stateID
+   * @param state
+   * @returns element(s)
+   */
+  export function dispatch(
+    stateID: string | Record<string, any>,
+    state?: Record<string, any>
+  ): any;
+
+  /**
+   *  Cradova Signal
+   * ----
+   *  create stateful data store.
+   * ability to:
+   * - create a store
+   * - create actions and fire them
+   * - bind a Ref or RefList
+   * - listen to changes
+   * -  persist changes to localStorage
+   * - go back and forward in value history
+   * - set keys instead of all values
+   * - update a cradova Ref/RefList automatically
+   * @constructor initial: any, props: {useHistory, persist}
+   */
+  export class Signal {
+    private callback;
+    private persistName;
+    private actions;
+    private useHistory;
+    private history;
+    private ref;
+    private index;
+    private path;
+    value: any;
+    constructor(
+      initial: unknown,
+      props?: {
+        useHistory?: boolean;
+        persistName?: string | undefined;
+      }
+    );
+    /**
+     *  Cradova Signal
+     * ----
+     *  set signal value
+     * @param value - signal value
+     * @returns void
+     */
+    set(value: unknown, shouldRefRender?: boolean): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a key value if it's an object
+     * @param name - name of the key
+     * @param value - value of the key
+     * @returns void
+     */
+    setKey(name: string, value: any, shouldRefRender?: boolean): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a prop value inside an object prop of the store
+     * @param key - a prop of the store - object value
+     * @param name - prop of the key object
+     * @param value - value of the name
+     * @returns void
+     */
+    setPath(
+      key: string,
+      name: string,
+      value: any,
+      shouldRefRender?: boolean
+    ): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a prop value inside an array prop of the store
+     * @param key - a prop of the store - object value
+     * @param index - index of the key object
+     * @param value - value of the index
+     * @returns void
+     */
+    setIndex(
+      key: string,
+      index: number,
+      value: any,
+      shouldRefRender?: boolean
+    ): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a key to signal an action
+     * @param name - name of the action
+     * @param action function to execute
+     */
+    createAction(
+      name: string | Record<string, (self?: any, data?: any) => void>,
+      action?: (self?: any, data?: any) => void
+    ): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  fires an action if available
+     * @param name - string name of the action
+     * @param data - data for the action
+     */
+    fireAction(name: string, data?: any): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a auto - rendering component for this store
+     *
+     * @param Ref component to bind to.
+     * @param path a property in the object to send to attached ref
+     */
+    bindRef(Ref: any, path?: string): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set signal value to a future one
+     * @returns void
+     */
+    forward(): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set signal value to a old past one
+     * @returns void
+     */
+    backward(): void;
+    /**
+     *  Cradova Signal
+     * ----
+     *  set a update listener on value changes
+     * @param callback
+     */
+    listen(callback: (a: any) => void): void;
+    /**
+     *  Cradova Signal
+     * ----
+     * clear the history on local storage
+     */
+    clearPersist(): void;
+  }
+
+  /**
+   *  Cradova simpleStore
+   * ----
+   *  create stateful data store.
+   * ability to:
+   * - create a store
+   * - set keys instead of all values
+   * - update a cradova Ref/RefList/RefElement automatically
+   * @constructor initial: any, Ref/RefList/RefElement: any
+   */
+
+  export class simpleStore {
+    private ref;
+    value: any;
+    constructor(initial: unknown, ref: RefType);
+    /**
+     *  Cradova simpleStore
+     * ----
+     *  set simpleStore value
+     * @param value - simpleStore value
+     * @returns void
+     */
+    set(value: unknown, shouldRefRender?: boolean): void;
+    /**
+     *  Cradova simpleStore
+     * ----
+     *  set a key value if it's an object
+     * @param name - name of the key
+     * @param value - value of the key
+     * @returns void
+     */
+    setKey(name: string, value: any, shouldRefRender?: boolean): void;
+    /**
+     *  Cradova simpleStore
+     * ----
+     *  set a auto - rendering component for this store
+     *
+     * @param Ref component to bind to.
+     * @param path a property in the object to send to attached ref
+     */
+    bindRef(Ref: any): void;
+  }
+
+  /**
+   *
+   * Cradova Ajax
+   * ------------------
+   * your new axios alternative
+   * supports files upload
+   * @param url string
+   * @param {{method: string;data;header;callbacks;}} opts
+   * @returns any
+   */
+  export function Ajax(
+    url: string | URL,
+    opts?:
+      | {
+          method?: string;
+          data?: Record<string, any>;
+          header?: Record<string, any>;
+          callbacks?: Record<string, (arg: any) => void>;
+        }
+      | any
+  ): Promise<unknown>;
+
+  /**
+   * swipe
+   * ---
+   * Now you can detect swipes the best way possible
+   *
+   * @param callback
+   * @param touching?
+   * @param element?
+   */
+  export function swipe(
+    callback: (swipe_data: Record<string, number>) => void,
+    touching?: boolean,
+    element?: HTMLElement
+  ): {
+    start(): void;
+    stop(): void;
+  };
+
+  export function loadCradovaUICss(seconds?: number): void;
+
+  export function IsElementInView(element: HTMLElement): boolean;
+
   export const controls: () => void;
   export function uuid(): string;
   export function PromptBeforeLeave(callback?: (e: any) => void): void;
@@ -405,6 +518,10 @@ _.animate("polarization",
     exist(): void;
   };
   export class RefList {
+    private component;
+    private stateID;
+    private parentElement;
+    private datas;
     constructor(component: (...data: any) => any);
     stale(datas: any): void;
     r(d?: any): any;
@@ -422,6 +539,10 @@ _.animate("polarization",
    *
    */
   export class Ref {
+    private component;
+    private stateID;
+    private upcb;
+    private data;
     constructor(component: (...data: any) => any);
     stale(data: any): void;
     r(d?: any): () => any;
@@ -461,81 +582,41 @@ _.animate("polarization",
   type fragmentTYPE = () => (() => HTMLElement) | HTMLElement;
   export const frag: (...children: fragmentTYPE[]) => DocumentFragment;
   /**
-   * Send a new state to specified element with stateID
+   * Creates new cradova HTML element
+   *  @example
+   * _("p") // or _("p.class") or _("p#id") or _("p.class#id")
+   * using inline props
+   * _("p",{
+   * text: "am a p tag",
+   * style: {
+   * color: "blue"
+   * }
+   * )
+   * adding children
+   * _("p",
+   * _("span",{text:" am a span tag like so",
+   *  {style: {color: "brown"}
+   * })
+   * )
    *
-   * @param stateID
-   * @param state
-   * @returns element(s)
-   */
-  export function dispatch(
-    stateID: string | Record<string, any>,
-    state?: Record<string, any>
-  ): any;
-  /**
+   * props and children
+   * _("p",
+   * // props first
+   * {
+   * text: "am a p tag",
+   * style: {
+   * color: "blue"
+   * },
+   * // all children goes after
+   * _("span",{text:" am a span tag like so",
+   *  {style: {color: "brown"}
+   * })
+   * )
    *
-   * Cradova Ajax
-   * ------------------
-   * your new axios alternative
-   * supports files upload
-   * @param url string
-   * @param {{method: string;data;header;callbacks;}} opts
-   * @returns any
+   * @param  {...any} element_initials
+   * @returns function - cradova element
    */
-  export function Ajax(
-    url: string | URL,
-    opts?:
-      | {
-          method?: string;
-          data?: Record<string, any>;
-          header?: Record<string, any>;
-          callbacks?: Record<string, (arg: any) => void>;
-        }
-      | any
-  ): Promise<unknown>;
-  export function IsElementInView(element: HTMLElement): boolean;
-  export class simpleStore {
-    value: any;
-    constructor(initial: unknown, ref: RefType);
-    /**
-     *  Cradova simpleStore
-     * ----
-     *  set simpleStore value
-     * @param value - simpleStore value
-     * @returns void
-     */
-    set(value: unknown, shouldRefRender?: boolean): void;
-    /**
-     *  Cradova simpleStore
-     * ----
-     *  set a key value if it's an object
-     * @param name - name of the key
-     * @param value - value of the key
-     * @returns void
-     */
-    setKey(name: string, value: any, shouldRefRender?: boolean): void;
-    /**
-     *  Cradova simpleStore
-     * ----
-     *  set a auto - rendering component for this store
-     *
-     * @param Ref component to bind to.
-     * @param path a property in the object to send to attached ref
-     */
-    bindRef(Ref: any): void;
-  }
-  export const make: (txx: any) =>
-    | {
-        tag: string;
-        className?: undefined;
-        ID?: undefined;
-        innerValue?: undefined;
-      }
-    | {
-        tag: undefined;
-        className: any;
-        ID: any;
-        innerValue: string;
-      };
+
   /**
    * Creates new cradova HTML element
    *  @example