@base-framework/base 3.0.79 → 3.0.81

package/dist/types/modules/component/unit.d.ts

@@ -0,0 +1,281 @@
+/**
+ * Unit
+ *
+ * @class
+ *
+ * This will allow units to be extended
+ * from a single factory.
+ *
+ * @example
+ * class Alert extends Unit
+ *	{
+ *		render()
+ *		{
+ *			return {
+ *
+ *			};
+ *		}
+ *	}
+ */
+export class Unit {
+    /**
+     * This will create a unit.
+     *
+     * @constructor
+     * @param {array} args
+     */
+    constructor(...args: any[]);
+    /**
+     * @member {boolean} isUnit
+     */
+    isUnit: boolean;
+    /**
+     * @member {?object} data
+     */
+    data: any;
+    /**
+     * @member {boolean} persist
+     */
+    persist: boolean;
+    /**
+     * @member {?array} children
+     */
+    children: any;
+    /**
+     * @member {?array} nest
+     */
+    nest: any;
+    /**
+     * @member {?object} state
+     */
+    state: any;
+    /**
+     * @member {?object} panel
+     */
+    panel: any;
+    /**
+     * @member {?object} parent
+     */
+    parent: any;
+    rendered: boolean;
+    container: any;
+    /**
+     * This will setup the component number and unique
+     * instance id for the component elements.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected init(): void;
+    id: string;
+    /**
+     * This will setup the component props.
+     *
+     * @param {object} [props]
+     * @returns {void}
+     */
+    setupProps(props?: object): void;
+    /**
+     * This will get the parent context.
+     *
+     * @returns {object|null}
+     */
+    getParentContext(): object | null;
+    /**
+     * This will set up the context.
+     *
+     * @returns {void}
+     */
+    setupContext(): void;
+    context: any;
+    /**
+     * This will set up the adding context.
+     *
+     * @returns {void}
+     */
+    setupAddingContext(): void;
+    addingContext: boolean;
+    contextBranchName: any;
+    /**
+     * This will add a branch to the context.
+     *
+     * @protected
+     * @param {string} branchName
+     * @param {*} value
+     * @returns {void}
+     */
+    protected addContextBranch(branchName: string, value: any): void;
+    /**
+     * This will set the component context.
+     *
+     * @param {object|null} context
+     * @returns {object|null}
+     */
+    setContext(context: object | null): object | null;
+    /**
+     * This will add context to the parent context.
+     *
+     * @param {object|null} context
+     * @returns {array|null}
+     */
+    addContext(context: object | null): any[] | null;
+    /**
+     * This will remove the added context from the parent.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected removeContext(): void;
+    /**
+     * This will remove a context branch.
+     *
+     * @protected
+     * @param {string} branch
+     * @returns {void}
+     */
+    protected removeContextBranch(branch: string): void;
+    /**
+     * This will get the context.
+     *
+     * @protected
+     * @returns {object|null}
+     */
+    protected getContext(): object | null;
+    /**
+     * override this to do something when created.
+     *
+     * @returns {void}
+     */
+    onCreated(): void;
+    /**
+     * This will render the component.
+     *
+     * @returns {object}
+     */
+    render(): object;
+    /**
+     * This will cache the layout panel and set the main id.
+     * @param {object} layout
+     * @returns {object}
+     */
+    _cacheRoot(layout: object): object;
+    /**
+     * This will create the component layout.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected _createLayout(): object;
+    _layout: any;
+    /**
+     * This will prepare the layout.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected prepareLayout(): object;
+    /**
+     * This will build the layout.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected afterBuild(): void;
+    /**
+     * This will activate the post build actions.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected afterLayout(): void;
+    /**
+     * This will render the content on condition of a property.
+     *
+     * @protected
+     * @param {*} prop
+     * @param {*} content
+     * @returns {object}
+     */
+    protected if(prop: any, content: any): object;
+    /**
+     * This will map an array to children elements.
+     *
+     * @protected
+     * @param {array} items
+     * @param {function} callBack
+     * @returns {array}
+     */
+    protected map(items: any[], callBack: Function): any[];
+    /**
+     * This will remove children from an element.
+     *
+     * @protected
+     * @param {object} ele
+     * @returns {object}
+     */
+    protected removeAll(ele: object): object;
+    /**
+     * This will get an id of the component or the full
+     * id that has the component id prepended to the
+     * requested id.
+     *
+     * @param {string} [id]
+     * @returns {string}
+     */
+    getId(id?: string): string;
+    /**
+     * This will initialize the component.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected initialize(): void;
+    /**
+     * override this to do something before setup.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected beforeSetup(): void;
+    /**
+     * override this to do something after setup.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected afterSetup(): void;
+    /**
+     * This will setup and render the component.
+     *
+     * @param {object} container
+     * @returns {void}
+     */
+    setup(container: object): void;
+    /**
+     * This will remove the component.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected remove(): void;
+    /**
+     * This will prepare the component to be destroyed.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected prepareDestroy(): void;
+    /**
+     * Override this to do something before destroy.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected beforeDestroy(): void;
+    /**
+     * This will destroy the component.
+     *
+     * @returns {void}
+     */
+    destroy(): void;
+}

package/dist/types/modules/data/attrs.d.ts

@@ -0,0 +1 @@
+export function setupAttrSettings(settings: object): object;

package/dist/types/modules/data/basic-data.d.ts

@@ -0,0 +1,259 @@
+/**
+ * BasicData
+ *
+ * This will create a bindable base class. This will
+ * allow shallow one level deep data to be created
+ * and watched.
+ *
+ * @class
+ */
+export class BasicData {
+    /**
+     * This will create a basic data object.
+     *
+     * @constructor
+     * @param {object} [settings]
+     */
+    constructor(settings?: object);
+    dirty: boolean;
+    links: {};
+    /**
+     * @member {string} dataTypeId
+     */
+    dataTypeId: string;
+    eventSub: DataPubSub;
+    /**
+     * This will setup the data object.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setup(): void;
+    stage: {};
+    /**
+     * This will setup the number and unique id of the data object.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected _init(): void;
+    _dataNumber: number;
+    _id: string;
+    _dataId: string;
+    /**
+     * This will get the data id.
+     *
+     * @returns {string}
+     */
+    getDataId(): string;
+    /**
+     * This is a placeholder.
+     *
+     * @returns {void}
+     */
+    remove(): void;
+    /**
+     * This will setup a one way bind.
+     *
+     * @param {string} attrName
+     * @param {function} callBack
+     * @returns {string} The subscription token.
+     */
+    on(attrName: string, callBack: Function): string;
+    /**
+     * This will unbind from a one way bind.
+     *
+     * @param {string} attrName
+     * @param {string} token
+     * @returns {void}
+     */
+    off(attrName: string, token: string): void;
+    /**
+     * This will set the attribute value.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {object} committer
+     * @param {boolean} stopMerge
+     * @returns {void}
+     */
+    protected _setAttr(attr: string, val: any, committer?: object, stopMerge?: boolean): void;
+    /**
+     * This will publish an update to the data binder.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {*} committer
+     * @param {*} prevValue
+     * @returns {void}
+     */
+    protected _publish(attr: string, val: any, committer: any, prevValue: any): void;
+    /**
+     * This will set the data value of an attribute or attributes.
+     *
+     * @overload
+     * @param {string} key
+     * @param {*} value
+     * @param {object} [committer]
+     *
+     * @overload
+     * @param {object} data
+     * @returns {object} this
+     */
+    set(key: string, value: any, committer?: object): any;
+    /**
+     * This will set the data value of an attribute or attributes.
+     *
+     * @overload
+     * @param {string} key
+     * @param {*} value
+     * @param {object} [committer]
+     *
+     * @overload
+     * @param {object} data
+     * @returns {object} this
+     */
+    set(data: object): object;
+    /**
+     * This will get the model data.
+     *
+     * @protected
+     * @returns {object}
+     */
+    protected getModelData(): object;
+    /**
+     * This will delete an attribute.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {string} attr
+     * @returns {void}
+     */
+    protected _deleteAttr(obj: object, attr: string): void;
+    /**
+     * This will toggle a bool attribute.
+     *
+     * @param {string} attr
+     * @returns {object} this
+     */
+    toggle(attr: string): object;
+    /**
+     * This will increment an attribute.
+     *
+     * @param {string} attr
+     * @returns {object} this
+     */
+    increment(attr: string): object;
+    /**
+     * This will decrement an attribute.
+     *
+     * @param {string} attr
+     * @returns {object} this
+     */
+    decrement(attr: string): object;
+    /**
+     * This will concat an attribute.
+     *
+     * @param {string} attr
+     * @returns {object} this
+     */
+    concat(attr: string, value: any): object;
+    /**
+     * This will set the key value if it is null.
+     *
+     * @param {string} key
+     * @param {*} value
+     * @returns {object} this
+     */
+    ifNull(key: string, value: any): object;
+    /**
+     * This will set the data local storage key.
+     *
+     * @param {string} key
+     * @returns {object} this
+     */
+    setKey(key: string): object;
+    key: string;
+    /**
+     * This will restore the data from local storage.
+     *
+     * @param {*} defaultValue
+     * @returns {object} this
+     */
+    resume(defaultValue: any): object;
+    /**
+     * This will store the data to the local stoage under
+     * the storage key.
+     *
+     * @returns {boolean}
+     */
+    store(): boolean;
+    /**
+     * This will delete a property value or the model data.
+     *
+     * @param {string} [attrName]
+     * @returns {*}
+     */
+    delete(attrName?: string): any;
+    /**
+     * This will get the value of an attribute.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {string} attr
+     * @returns {*}
+     */
+    protected _getAttr(obj: object, attr: string): any;
+    /**
+     * This will get a property value or the model data.
+     *
+     * @param {string} [attrName]
+     * @returns {*}
+     */
+    get(attrName?: string): any;
+    /**
+     * This will link a data source property to another data source.
+     *
+     * @param {object} data
+     * @param {string|object} attr
+     * @param {string} alias
+     * @returns {string|array}
+     */
+    link(data: object, attr: string | object, alias: string, ...args: any[]): string | any[];
+    /**
+     * This will link a remote data source by property.
+     *
+     * @param {object} data
+     * @param {string} attr
+     * @param {string} [alias]
+     * @returns {string}
+     */
+    remoteLink(data: object, attr: string, alias?: string): string;
+    /**
+     * This will add a link token to the links array.
+     *
+     * @param {string} token
+     * @param {object} data
+     * @returns {void}
+     */
+    addLink(token: string, data: object): void;
+    /**
+     * This will remove a link or all links if no token is provided.
+     *
+     * @param {string} [token]
+     * @returns {void}
+     */
+    unlink(token?: string): void;
+    /**
+     * This will remove the linked subscription.
+     *
+     * @param {string} token
+     * @param {boolean} [removeFromLinks]
+     * @returns {void}
+     */
+    removeLink(token: string, removeFromLinks?: boolean): void;
+    isData: boolean;
+}
+import { DataPubSub } from '../data-binder/data-pub-sub.js';

package/dist/types/modules/data/data-proxy.d.ts

@@ -0,0 +1 @@
+export function DataProxy(data: object, root?: string): ProxyConstructor;

package/dist/types/modules/data/data-utils.d.ts

@@ -0,0 +1,17 @@
+export namespace DataUtils {
+    let deepDataPattern: RegExp;
+    /**
+     * This will check if a string has deep data.
+     *
+     * @param {string} str
+     * @returns {boolean}
+     */
+    function hasDeepData(str: string): boolean;
+    /**
+     * This will get the deep data segments.
+     *
+     * @param {string} str
+     * @returns {array}
+     */
+    function getSegments(str: string): any[];
+}

package/dist/types/modules/data/data.d.ts

@@ -0,0 +1,3 @@
+export { Data } from "./deep-data.js";
+export { Model } from "./model.js";
+export { SimpleData } from "./simple-data.js";