@base-framework/base 3.0.90 → 3.0.92

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

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

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

@@ -0,0 +1,36 @@
+/**
+ * LocalData
+ *
+ * This will help manage the local data.
+ *
+ * @class
+ */
+export class LocalData {
+    /**
+     * This will restore the data from local storage.
+     *
+     * @static
+     * @param {string} key
+     * @param {*} defaultValue
+     * @returns {*}
+     */
+    static resume(key: string, defaultValue: any): any;
+    /**
+     * This will store the data to the local stoage under
+     * the storage key.
+     *
+     * @static
+     * @param {string} key
+     * @param {*} data
+     * @returns {boolean}
+     */
+    static store(key: string, data: any): boolean;
+    /**
+     * This will remove the data from the local storage.
+     *
+     * @static
+     * @param {string} key
+     * @returns {boolean}
+     */
+    static remove(key: string): boolean;
+}

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

@@ -0,0 +1,289 @@
+/**
+ * EVENT - The event strings for the data object.
+ */
+export type EVENT = string;
+/**
+ * EVENT
+ *
+ * This will hold the event strings for the data object.
+ *
+ * @type {object} EVENT
+ * @property {string} CHANGE
+ * @property {string} DELETE
+ * @readonly
+ * @enum {string} EVENT - The event strings for the data object.
+ * @const
+ */
+export const EVENT: object;
+export function createEventMessage(attr: string, event: string): string;
+/**
+ * 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 a local event.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {object|null} committer
+     * @param {string} event
+     * @returns {void}
+     */
+    protected publishLocalEvent(attr: string, val: any, committer: object | null, event: string): void;
+    /**
+     * This will publish an update to the data binder.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {*} committer
+     * @param {string} event
+     * @returns {void}
+     */
+    protected _publish(attr: string, val: any, committer: any, event: string): 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
+     * @param {object} [committer]
+     * @returns {void}
+     */
+    protected _deleteAttr(obj: object, attr: string, committer?: object): 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 {object|string|null} [attrName]
+     * @returns {void}
+     */
+    delete(attrName?: object | string | null): void;
+    /**
+     * 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/types/deep-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/types/deep-data/deep-data.d.ts

@@ -0,0 +1,112 @@
+/**
+ * Data
+ *
+ * This will create a new data object that can be used to
+ * bind elements to values.
+ *
+ * @class
+ * @augments BasicData
+ */
+export class Data extends BasicData {
+    attributes: any;
+    /**
+     * This will set the attribute value.
+     *
+     * @override
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {object} committer
+     * @param {boolean} stopMerge
+     * @returns {void}
+     */
+    protected override _setAttr(attr: string, val: any, committer: object, stopMerge: boolean): void;
+    /**
+     * This will link a data attr object to another data object.
+     *
+     * @param {object} data
+     * @param {string} attr
+     * @returns {void}
+     */
+    linkAttr(data: object, attr: string): void;
+    /**
+     * This will create a new data source by scoping the parent
+     * data attr and linking the two sources.
+     *
+     * @param {string} attr
+     * @param {object} [constructor]
+     * @returns {object}
+     */
+    scope(attr: string, constructor?: object): object;
+    /**
+     * This will splice a value from an array and set
+     * the result.
+     *
+     * @param {string} attr
+     * @param {number} index
+     * @returns {object} this
+     */
+    splice(attr: string, index: number): object;
+    /**
+     * This will add a value to an array and set the result.
+     *
+     * @param {string} attr
+     * @param {*} value
+     * @returns {object} this
+     */
+    push(attr: string, value: any): object;
+    /**
+     * This will add a value to an array and set the result.
+     *
+     * @param {string} attr
+     * @param {*} value
+     * @returns {object} this
+     */
+    unshift(attr: string, value: any): object;
+    /**
+     * This will add a value to an array and set the result.
+     *
+     * @param {string} attr
+     * @returns {*}
+     */
+    shift(attr: string): any;
+    /**
+     * This will pop the last value from an array and set the result.
+     *
+     * @param {string} attr
+     * @returns {*}
+     */
+    pop(attr: string): any;
+    /**
+     * This will refresh the value.
+     *
+     * @param {string} attr
+     * @returns {object} this
+     */
+    refresh(attr: string): object;
+    /**
+     * This will publish an update on an attribute.
+     *
+     * @protected
+     * @param {string} subPath
+     * @param {*} val
+     * @param {object} committer
+     * @param {string} event
+     * @returns {void}
+     */
+    protected _publishAttr(subPath: string, val: any, committer: object, event: string): void;
+    /**
+     * This will merge the attribute with the stage.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected mergeStage(): void;
+    /**
+     * This will revert the stage back to the previous attributes.
+     *
+     * @returns {void}
+     */
+    revert(): void;
+}
+import { BasicData } from '../basic-data.js';

package/dist/types/modules/data/types/deep-data/property-helper.d.ts

@@ -0,0 +1,37 @@
+/**
+ * PropertyHelper
+ *
+ * This will help get, set, and delete properties from a data object.
+ *
+ * @class
+ */
+export class PropertyHelper {
+    /**
+     * This will set the attribute value.
+     *
+     * @static
+     * @param {object} obj
+     * @param {string} attr
+     * @param {*} val
+     * @returns {void}
+     */
+    static set(obj: object, attr: string, val: any): void;
+    /**
+     * This will delete an attribute.
+     *
+     * @static
+     * @param {object} obj
+     * @param {string} attr
+     * @returns {void}
+     */
+    static delete(obj: object, attr: string): void;
+    /**
+     * This will get the value of an attribute.
+     *
+     * @static
+     * @param {object} obj
+     * @param {string} attr
+     * @returns {*}
+     */
+    static get(obj: object, attr: string): any;
+}

package/dist/types/modules/data/types/deep-data/publisher.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Publisher
+ *
+ * This will contain methods for publishing data.
+ *
+ * @class
+ */
+export class Publisher {
+    /**
+     * This will publish deep data.
+     *
+     * @param {object} obj
+     * @param {string} attr
+     * @param {*} val
+     * @param {function} callBack
+     * @returns {void}
+     */
+    static publishDeep(obj: object, attr: string, val: any, callBack: Function): void;
+    /**
+     * This will publish an update to the data binder.
+     *
+     * @param {string} pathString
+     * @param {*} obj
+     * @param {function} callBack
+     * @returns {void}
+     */
+    static publish(pathString: string, obj: any, callBack: Function): void;
+    /**
+     * This will publish an array to the data binder.
+     *
+     * @protected
+     * @param {string} pathString
+     * @param {array} obj
+     * @param {function} callBack
+     * @returns {void}
+     */
+    protected static publishArray(pathString: string, obj: any[], callBack: Function): void;
+    /**
+     * This will publish an object to the data binder.
+     *
+     * @protected
+     * @param {string} pathString
+     * @param {object} obj
+     * @param {function} callBack
+     * @returns {void}
+     */
+    protected static publishObject(pathString: string, obj: object, callBack: Function): void;
+    /**
+     * This will check if the value is an object and publish
+     * the value or the object.
+     *
+     * @protected
+     * @param {string} subPath
+     * @param {*} val
+     * @param {function} callBack
+     * @returns {void}
+     */
+    protected static _checkPublish(subPath: string, val: any, callBack: Function): void;
+}

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

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