cradova 3.3.3 → 3.3.5

package/README.md

@@ -511,9 +511,9 @@ Join Us on [telegram](https://t.me/UiedbookHQ).
 
 If you contribute code to this project, you are implicitly allowing your code to be distributed under same license. You are also implicitly verifying that all code is your original work.
 
-## Supporting Exabase development
+## Supporting Cradova development
 
-Your Support is a good force for change anytime you do it, you can ensure Our projects, growth, Cradova, Exabase, JetPath etc, growth and improvement by making a re-occuring or fixed sponsorship
+Your Support is a good force for change anytime you do it, you can ensure Our projects, growth, Cradova, Cradova, JetPath etc, growth and improvement by making a re-occuring or fixed sponsorship
 to [github sponsors](https://github.com/sponsors/FridayCandour):
 or crypto using
 etheruen: `0xD7DDD4312A4e514751A582AF725238C7E6dF206c`,

package/dist/index.d.ts

@@ -1,592 +1,3 @@
-import * as CSS from 'csstype';
-
-/*! *****************************************************************************
-Copyright 2022 Friday Candour. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-********************************************************************************/
-
-/**
- * Cradova event
- */
-declare class cradovaEvent {
-    private listeners;
-    private active_listeners;
-    addEventListener(eventName: string, callback: () => void): Promise<void>;
-    addActiveEventListener(eventName: string, callback: () => void): Promise<void>;
-    dispatchEvent(eventName: string, eventArgs?: unknown): Promise<void>;
-    /**
-     * Active refs is a concept for delegated screens to keep their active refs alive
-     * even in the case of naviagtion
-     * @param eventName
-     * @param eventArgs
-     */
-    dispatchActiveEvent(eventName: string, eventArgs?: unknown): Promise<void>;
-}
-declare const CradovaEvent: cradovaEvent;
-/**
- * Cradova Ref
- * -------
- * create dynamic components
- */
-declare class Ref<Prop extends Record<string, any> = any> {
-    private component;
-    private effects;
-    private effectuate;
-    methods: Record<string, Function>;
-    private rendered;
-    private published;
-    private preRendered;
-    private reference;
-    Signal: createSignal<any> | undefined;
-    _state: Prop[];
-    _state_track: {
-        [x: number]: boolean;
-    };
-    _state_index: number;
-    stash: Prop | undefined;
-    constructor(component: (this: Ref<Prop>, data: Prop) => HTMLElement | DocumentFragment);
-    preRender(data?: Prop, stash?: boolean): void;
-    destroyPreRendered(): void;
-    /**
-     * Cradova Ref
-     * ---
-     * construct to add custom methods to Refs
-     * @param methodName
-     * @param method
-     * @returns  void
-     */
-    define(methodName: string, method: (this: this, ...arg: any) => void): void;
-    /**
-     * Cradova Ref
-     * ---
-     * returns html with cradova reference
-     * @param data
-     * @returns () => HTMLElement
-     */
-    render(data?: Prop, stash?: boolean): HTMLElement | DocumentFragment;
-    instance(): HTMLElement;
-    _setExtra(Extra: createSignal<any>): void;
-    _roll_state(data: any, idx: number, get?: boolean): Prop;
-    _effect(fn: () => Promise<void> | void): void;
-    private effector;
-    /**
-     * Cradova Ref
-     * ---
-     * update ref component with new data and update the dom.
-     * @param data
-     * @returns
-     */
-    updateState(data?: Prop, stash?: boolean): void;
-    private Activate;
-}
-/**
- * cradova
- * ---
- * lazy load a file
- */
-declare class lazy<Type> {
-    content: Type | undefined;
-    private _cb;
-    constructor(cb: () => Promise<unknown>);
-    load(): Promise<void>;
-}
-/**
- * Cradova
- * ---
- * make reference to dom elements
- */
-declare class reference {
-    tree: Record<string, any>;
-    globalTree: Record<string, HTMLElement>;
-    /**
-     * Bind a DOM element to a reference name.
-     * @param name - The name to reference the DOM element by.
-     */
-    bindAs(name: string): reference;
-    /**
-     * Retrieve a referenced DOM element.
-     * @param name - The name of the referenced DOM element.
-     */
-    current<ElementType extends HTMLElement = HTMLElement>(name: string): ElementType;
-    /**
-     * Append a DOM element to the reference, overwriting any existing reference.
-     * @param name - The name to reference the DOM element by.
-     * @param element - The DOM element to reference.
-     */
-    _appendDomForce(name: string, Element: HTMLElement): void;
-    _appendDomForceGlobal(name: string, Element: HTMLElement): void;
-}
-/**
- *  Cradova Signal
- * ----
- *  Create stateful data store.
- *  Features:
- * - create a store
- * - create actions and fire them
- * - bind a Ref and elements
- * - listen to updates
- * - set object keys instead of all values
- * - persist changes to localStorage
- * - update a cradova Ref automatically
- * @constructor initial: unknown, props: {useHistory, persist}
- */
-declare class createSignal<Type extends Record<string, any>> {
-    private callback;
-    private persistName;
-    private actions;
-    private ref;
-    value: Type;
-    constructor(initial: Type, props?: {
-        persistName?: string | undefined;
-    });
-    /**
-     *  Cradova Signal
-     * ----
-     *  set signal value
-     * @param value - signal value
-     * @returns void
-     */
-    set(value: Type | ((value: Type) => Type), shouldRefRender?: boolean): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a key value if it's an object
-     * @param key - key of the key
-     * @param value - value of the key
-     * @returns void
-     */
-    setKey<k extends keyof Type>(key: k, value: unknown, 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, action: (data?: unknown) => void): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  creates man y actions at a time
-     * @param name - name of the action
-     * @param action function to execute
-     */
-    createActions(Actions: Record<string, (data?: unknown) => void>): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  fires an action if available
-     * @param key - string key of the action
-     * @param data - data for the action
-     */
-    fireAction(key: string, data?: Type): Type;
-    /**
-     * Cradova
-     * ---
-     * is used to bind signal data to elements and Refs
-     *
-     * @param prop
-     * @returns something
-     */
-    bind(prop: string): any;
-    private _updateState;
-    /**
-     *  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: Partial<Ref>, binding?: {
-        event?: string;
-        signalProperty: string;
-        _element_property: string;
-    }): void;
-    /**
-     *  Cradova Signal
-     * ----
-     *  set a update listener on value changes
-     * @param callback
-     */
-    listen(callback: (a: Type) => void): void;
-    /**
-     *  Cradova Signal
-     * ----
-     * clear the history on local storage
-     *
-     */
-    clearPersist(): void;
-}
-/**
- *  Cradova Screen
- * ---
- * create instances of manageable pages
- * @param name
- * @param template
- */
-declare class Screen$1 {
-    /**
-     * used internally
-     */
-    private _name;
-    /**
-     * this should be a cradova screen component
-     */
-    _html: ((this: Screen$1, data?: unknown) => HTMLElement | DocumentFragment) | HTMLElement | DocumentFragment;
-    _packed: boolean;
-    private _template;
-    private _callBack;
-    private _deCallBack;
-    private _persist;
-    private _delegatedRoutesCount;
-    private _dropped;
-    /**
-     * error handler for the screen
-     */
-    _errorHandler: ((err: unknown) => void) | null;
-    constructor(cradova_screen_initials: CradovaScreenType);
-    _derive(): {
-        _name: string;
-        _callBack: ((cradovaScreenSet: HTMLElement) => void | Promise<void>) | undefined;
-        _deCallBack: ((cradovaScreenSet: HTMLElement) => void | Promise<void>) | undefined;
-    };
-    _apply_derivation(derivation: {
-        _name: string;
-        _callBack: ((cradovaScreenSet: HTMLElement) => void | Promise<void>) | undefined;
-        _deCallBack: ((cradovaScreenSet: HTMLElement) => void | Promise<void>) | undefined;
-    }): void;
-    get _delegatedRoutes(): number;
-    set _delegatedRoutes(count: number);
-    setErrorHandler(errorHandler: (err: unknown) => void): void;
-    _package(): Promise<void>;
-    onActivate(cb: () => Promise<void> | void): void;
-    onDeactivate(cb: () => Promise<void> | void): void;
-    _deActivate(): Promise<void>;
-    drop(state?: boolean): boolean | undefined;
-    _Activate(force?: boolean): Promise<void>;
-}
-/** cradova router
- * ---
- * Registers a route.
- *
- * @param {string}   path     Route path.
- * @param  screen the cradova document tree for the route.
- */
-declare class Router {
-    /** cradova router
-     * ---
-     * Registers a route.
-     *
-     * accepts an object containing
-     *
-     * @param {string}   path     Route path.
-     * @param  screen the cradova screen.
-     */
-    static BrowserRoutes(obj: Record<string, any>): void;
-    /**
-      Go back in Navigation history
-      */
-    static back(): void;
-    /**
-      Go forward in Navigation history
-      */
-    static forward(): void;
-    /**
-      Pause navigation
-      */
-    static pauseNaviagtion(): void;
-    /**
-     resume navigation
-    */
-    static resumeNaviagtion(): void;
-    /**
-     * Cradova Router
-     * ------
-     *
-     * Navigates to a designated screen in your app
-     *
-     * @param href string
-     * @param data object
-     * @param force boolean
-     */
-    static navigate(href: string, data?: Record<string, unknown> | null, force?: boolean): void;
-    /**
-     * Cradova Router
-     * ------
-     *
-     * Navigates to a designated screen in your app by loading a seperate page;
-     *
-     * @param pathname string
-     */
-    static navigateNauturally(pathname: string): void;
-    /**
-     * Cradova
-     * ---
-     * Loading screen for your app
-     *
-     * lazy loaded loading use
-     *
-     * @param screen
-     */
-    static setLoadingScreen(screen: Screen$1): void;
-    /** cradova router
-     * ---
-     * Listen for navigation events
-     *
-     * @param callback   () => void
-     */
-    static onPageEvent(callback: () => void): void;
-    /** cradova router
-     * ---
-     * get a screen ready before time.
-     *
-     * @param {string}   path Route path.
-     * @param  data data for the screen.
-     */
-    static packageScreen(path: string): Promise<void>;
-    /**
-     * Cradova Router
-     * ------
-     *
-     * return last set router params
-     *
-     * .
-     */
-    static getParams(): Record<string, unknown>;
-    /**
-     * Cradova
-     * ---
-     * Error Handler for your app
-     *
-     * @param callback
-     * @param path? page path
-     */
-    static addErrorHandler(callback: (err: unknown) => void): void;
-    static _mount(): void;
-}
-
-/*! *****************************************************************************
-Copyright 2022 Friday Candour. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-***************************************************************************** */
-
-type DataAttributes = {
-    [key: `data-${string}`]: string;
-};
-type AriaAttributes = {
-    [key: `aria-${string}`]: string;
-};
-type VJSType<T> = (...VJS: (undefined | string | HTMLElement | HTMLElement[] | Ref | Ref[] | DocumentFragment | DocumentFragment[] | TemplateStringsArray | Partial<T> | (() => HTMLElement) | Partial<DataAttributes> | Partial<AriaAttributes> | CSS.Properties | {
-    style?: CSS.Properties;
-    onmount?: (this: T) => void;
-    reference?: reference;
-})[]) => T;
-type VJS_params_TYPE<T> = (undefined | string | HTMLElement | HTMLElement[] | Ref | Ref[] | DocumentFragment | DocumentFragment[] | TemplateStringsArray | Partial<T> | (() => HTMLElement) | Partial<DataAttributes> | Partial<AriaAttributes> | CSS.Properties<string | number> | {
-    src?: string;
-    href?: string;
-    placeholder?: string;
-    type?: string;
-    action?: string;
-    name?: string;
-    alt?: string;
-    for?: string;
-    method?: string;
-    rows?: string;
-    value?: string;
-    target?: string;
-    rel?: string;
-    required?: string;
-    frameBorder?: string;
-    style?: CSS.Properties;
-    onmount?: (this: T) => void;
-    reference?: reference;
-})[];
-type VJS_Child_TYPE<T> = undefined | string | T | (() => T);
-type VJS_props_TYPE = {
-    style?: CSS.Properties;
-    onmount?: () => void;
-    reference?: reference;
-};
-type CradovaScreenType<T = unknown> = {
-    /**
-     * Cradova screen
-     * ---
-     * title of the page
-     * .
-     */
-    name?: string;
-    /**
-     * Cradova screen
-     * ---
-     * a css className to add to screen when rendering it
-     * Usually for adding css transitions
-     * .
-     */
-    /**
-     * Cradova screen
-     * ---
-     * The component for the screen
-     * @param data
-     * @returns void
-     * .
-     */
-    template: ((this: Screen, data?: T | unknown) => HTMLElement | DocumentFragment) | HTMLElement | DocumentFragment | Ref<any>;
-    /**
-     * Cradova screen
-     * ---
-     * Allows this screen render in parallel for unique routes
-     *
-     * limit is 1000
-     *
-     * .
-     */
-    renderInParallel?: boolean;
-    /**
-     * Cradova screen
-     * ---
-     * Should this screen be cached after first render?
-     * you can use Route.navigate(url, null, true) to force later
-     *
-     * .
-     */
-    persist?: boolean;
-};
-
-/*! *****************************************************************************
-Copyright 2022 Friday Candour. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
-
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
-********************************************************************************/
-
-declare const makeElement: <E extends HTMLElement>(element: E & HTMLElement, ElementChildrenAndPropertyList: VJS_params_TYPE<E>) => E;
-declare const make: (descriptor: any) => any[];
-declare const cra: <E extends HTMLElement>(tag: string) => VJSType<E>;
-declare function Rhoda(l: VJSType<HTMLElement>[] | (() => any)[] | Ref[] | HTMLElement[]): DocumentFragment;
-declare function css(identifier: string | TemplateStringsArray): void;
-/**
- *
- * @param {expression} condition
- * @param {function} elements[]
- */
-declare function $if<Type>(condition: boolean, ...elements: VJS_Child_TYPE<Type | HTMLElement>[]): HTMLElement[] | undefined;
-declare function $ifelse<Type>(condition: boolean, ifTrue: VJS_Child_TYPE<Type | HTMLElement> | VJS_Child_TYPE<Type | HTMLElement>[], ifFalse: VJS_Child_TYPE<Type | HTMLElement> | VJS_Child_TYPE<Type | HTMLElement>[]): VJS_Child_TYPE<HTMLElement | Type> | VJS_Child_TYPE<HTMLElement | Type>[];
-declare function $case<Type>(value: any, ...elements: VJS_Child_TYPE<Type | HTMLElement>[]): (key: any) => HTMLElement[] | undefined;
-declare function $switch(key: unknown, ...cases: ((key: any) => HTMLElement[] | undefined)[]): HTMLElement[] | undefined;
-type LoopData<Type> = Type[];
-declare function loop<Type>(datalist: LoopData<Type>, component: (value: Type, index?: number, array?: LoopData<Type>) => HTMLElement | DocumentFragment | undefined): HTMLElement[] | undefined;
-/**  Calculate a simple numerical representation of the URL */
-declare const SNRU: {
-    snru: string;
-    memo_SNRU(): void;
-};
-/**
- * Document fragment
- * @param children
- * @returns
- */
-declare const frag: (children: VJSType<HTMLElement>[]) => DocumentFragment;
-/**
- * Cradova
- * ---
- *  Allows functional components to manage state by providing a state value and a function to update it.
- * @param initialValue
- * @param ActiveRef
- * @returns [state, setState]
- */
-declare function useState<S = unknown>(initialValue: S, ActiveRef: Ref): [S, (newState: S) => void];
-/**
- * Cradova
- * ---
-Allows side effects to be performed in functional components (Refs), such as fetching data or subscribing to events.
- * @param effect
- * @returns
- */
-declare function useEffect(effect: () => void, ActiveRef: Ref): void;
-/**
- * Cradova
- * ---
-Returns a mutable reference object of dom elements that persists across component renders.
- * @returns reference
- */
-declare function useRef(): Record<string, HTMLElement | undefined>;
-
-declare const a: VJSType<HTMLAnchorElement>;
-declare const article: VJSType<HTMLElement>;
-declare const audio: VJSType<HTMLAudioElement>;
-declare const br: VJSType<HTMLBRElement>;
-declare const button: VJSType<HTMLButtonElement>;
-declare const canvas: VJSType<HTMLCanvasElement>;
-declare const caption: VJSType<HTMLTableCaptionElement>;
-declare const col: VJSType<HTMLTableColElement>;
-declare const colgroup: VJSType<HTMLOptGroupElement>;
-declare const datalist: VJSType<HTMLDataListElement>;
-declare const details: VJSType<HTMLDetailsElement>;
-declare const dialog: VJSType<HTMLDialogElement>;
-declare const div: VJSType<HTMLDivElement>;
-declare const em: VJSType<HTMLElement>;
-declare const embed: VJSType<HTMLEmbedElement>;
-declare const figure: VJSType<HTMLElement>;
-declare const footer: VJSType<HTMLElement>;
-declare const form: VJSType<HTMLFormElement>;
-declare const h1: VJSType<HTMLHeadingElement>;
-declare const h2: VJSType<HTMLHeadingElement>;
-declare const h3: VJSType<HTMLHeadingElement>;
-declare const h4: VJSType<HTMLHeadingElement>;
-declare const h5: VJSType<HTMLHeadingElement>;
-declare const h6: VJSType<HTMLHeadingElement>;
-declare const head: VJSType<HTMLHeadElement>;
-declare const header: VJSType<HTMLHeadElement>;
-declare const hr: VJSType<HTMLHRElement>;
-declare const i: VJSType<HTMLLIElement>;
-declare const iframe: VJSType<HTMLIFrameElement>;
-declare const img: VJSType<HTMLImageElement>;
-declare const input: VJSType<HTMLInputElement>;
-declare const label: VJSType<HTMLLabelElement>;
-declare const li: VJSType<HTMLLIElement>;
-declare const main: VJSType<HTMLElement>;
-declare const nav: VJSType<HTMLElement>;
-declare const ol: VJSType<HTMLOListElement>;
-declare const optgroup: VJSType<HTMLOptGroupElement>;
-declare const option: VJSType<HTMLOptionElement>;
-declare const p: VJSType<HTMLParagraphElement>;
-declare const progress: VJSType<HTMLProgressElement>;
-declare const q: VJSType<HTMLQuoteElement>;
-declare const section: VJSType<HTMLElement>;
-declare const select: VJSType<HTMLSelectElement>;
-declare const source: VJSType<HTMLSourceElement>;
-declare const span: VJSType<HTMLSpanElement>;
-declare const strong: VJSType<HTMLElement>;
-declare const summary: VJSType<HTMLElement>;
-declare const table: VJSType<HTMLTableElement>;
-declare const tbody: VJSType<HTMLTableColElement>;
-declare const td: VJSType<HTMLTableCellElement>;
-declare const template: VJSType<HTMLTemplateElement>;
-declare const textarea: VJSType<HTMLTextAreaElement>;
-declare const th: VJSType<HTMLTableSectionElement>;
-declare const title: VJSType<HTMLTitleElement>;
-declare const tr: VJSType<HTMLTableRowElement>;
-declare const track: VJSType<HTMLTrackElement>;
-declare const u: VJSType<HTMLUListElement>;
-declare const ul: VJSType<HTMLUListElement>;
-declare const video: VJSType<HTMLVideoElement>;
-declare const svg: (svg: string, properties?: VJS_props_TYPE) => HTMLSpanElement;
-declare const raw: (html: string) => HTMLElement[];
-
 /*! *****************************************************************************
 Copyright 2022 Friday Candour. All rights reserved.
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use
@@ -596,29 +7,6 @@ License at http://www.apache.org/licenses/LICENSE-2.0
 See the Apache Version 2.0 License for specific language governing permissions
 and limitations under the License.
 ********************************************************************************/
-
-type TemplateType = <E extends HTMLElement>(...element_initials: VJS_params_TYPE<E | HTMLElement>) => E | HTMLElement | DocumentFragment;
-/**
- * Cradova
- * ---
- * Creates new cradova HTML element
- *  @example
- * // using template
- * const p = _("p");
- * _("p.foo.bar#poo.loo");
- *
- * // full example
- * _("p", // template first
- *  // property next if wanted
- *  {style: {color: "brown"}, // optional
- *  // the rest should be children or text
- * _("span", " am a span tag text like so"),
- * ...
- * )
- *
- * @param element_initials
- * @returns function - cradova element
- */
-declare const _: TemplateType;
-
-export { $case, $if, $ifelse, $switch, CradovaEvent, Ref, Rhoda, Router, SNRU, Screen$1 as Screen, a, article, audio, br, button, canvas, caption, col, colgroup, cra, createSignal, css, datalist, _ as default, details, dialog, div, em, embed, figure, footer, form, frag, h1, h2, h3, h4, h5, h6, head, header, hr, i, iframe, img, input, label, lazy, li, loop, main, make, makeElement, nav, ol, optgroup, option, p, progress, q, raw, reference, section, select, source, span, strong, summary, svg, table, tbody, td, template, textarea, th, title, tr, track, u, ul, useEffect, useRef, useState, video };
+export * from "./primitives/classes";
+export * from "./primitives/functions";
+export * from "./primitives/dom-objects";