@base-framework/base 3.0.79 → 3.0.80

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

@@ -0,0 +1,162 @@
+/**
+ * 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 update an attribute value.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {string} attr
+     * @param {*} val
+     * @returns {void}
+     */
+    protected _updateAttr(obj: object, attr: string, val: any): void;
+    /**
+     * 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 to the data binder.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {*} committer
+     * @returns {void}
+     */
+    protected _publish(attr: string, val: any, committer: any): void;
+    /**
+     * This will publish deep and simple data to the data binder.
+     *
+     * @protected
+     * @param {string} attr
+     * @param {*} val
+     * @param {object} committer
+     * @returns {void}
+     */
+    protected publishDeep(attr: string, val: any, committer: object): void;
+    /**
+     * This will publish an update to the data binder.
+     *
+     * @protected
+     * @param {string} pathString
+     * @param {*} obj
+     * @param {*} committer
+     * @returns {void}
+     */
+    protected publish(pathString: string, obj: any, committer: any): void;
+    /**
+     * This will check if the value is an object and publish
+     * the value or the object.
+     *
+     * @protected
+     * @param {string} subPath
+     * @param {*} val
+     * @param {object} committer
+     * @returns {void}
+     */
+    protected _checkPublish(subPath: string, val: any, committer: object): void;
+    /**
+     * This will publish an update on an attribute.
+     *
+     * @protected
+     * @param {string} subPath
+     * @param {*} val
+     * @param {object} committer
+     * @returns {void}
+     */
+    protected _publishAttr(subPath: string, val: any, committer: object): 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/model-service.d.ts

@@ -0,0 +1,280 @@
+/**
+ * ModelService
+ *
+ * This will create a new model service.
+ *
+ * @class
+ */
+export class ModelService {
+    /**
+     * This will extend the model service.
+     *
+     * @param {object} child
+     * @returns {object}
+     */
+    static extend(child: object): object;
+    /**
+     * This will create a model service.
+     *
+     * @constructor
+     * @param {object} model
+     */
+    constructor(model: object);
+    /**
+     * @member {object} model
+     */
+    model: any;
+    /**
+     * @member {string} objectType The return type.
+     */
+    objectType: string;
+    /**
+     * @member {string} url
+     */
+    url: string;
+    /**
+     * @member {function} validateCallBack
+     */
+    validateCallBack: any;
+    /**
+     * This will initialize the model service.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected init(): void;
+    /**
+     * This will check if the model is valid.
+     *
+     * @returns {boolean}
+     */
+    isValid(): boolean;
+    /**
+     * This should be overriden to validate the model
+     * before submitting.
+     *
+     * @returns {boolean}
+     */
+    validate(): boolean;
+    /**
+     * This can be overriden to add default params
+     * with each request.
+     *
+     * @protected
+     * @returns {string}
+     */
+    protected getDefaultParams(): string;
+    /**
+     * This will setup the request params.
+     *
+     * @protected
+     * @param {(string|object)} params
+     * @returns {(string|object)}
+     */
+    protected setupParams(params: (string | object)): (string | object);
+    /**
+     * This will convert an object to a string.
+     *
+     * @protected
+     * @param {object} object
+     * @returns {string}
+     */
+    protected objectToString(object: object): string;
+    /**
+     * This will add the params.
+     *
+     * @protected
+     * @param {*} params
+     * @param {*} addingParams
+     * @returns {(string|object)}
+     */
+    protected addParams(params: any, addingParams: any): (string | object);
+    /**
+     * This will get the model by id.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    get(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will get the object from the response.
+     *
+     * @protected
+     * @param {object} response
+     * @returns {object}
+     */
+    protected getObject(response: object): object;
+    /**
+     * This will return a string with the model data json encoded.
+     *
+     * @protected
+     * @returns {string}
+     */
+    protected setupObjectData(): string;
+    /**
+     * This will add or update the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    setup(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will add the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    add(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will update the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    update(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will delete the model.
+     *
+     * @param {string} [instanceParams]
+     * @param {function} [callBack]
+     * @returns {object}
+     */
+    delete(instanceParams?: string, callBack?: Function): object;
+    /**
+     * This will list rows of the model.
+     *
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {number} start
+     * @param {number} count
+     * @param {string} filter
+     * @returns {object}
+     */
+    all(instanceParams: string, callBack: Function, start: number, count: number, filter: string): object;
+    /**
+     * This will get the url.
+     *
+     * @protected
+     * @param {string} url
+     * @returns {string}
+     */
+    protected getUrl(url: string): string;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {string} method
+     * @param {(string|object)} params
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected setupRequest(url: string, method: string, params: (string | object), callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will check if the data is a form data object.
+     *
+     * @protected
+     * @param {*} data
+     * @returns {boolean}
+     */
+    protected _isFormData(data: any): boolean;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected request(params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a GET request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _get(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a POST request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _post(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a PUT request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _put(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a PATCH request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _patch(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make a DELETE request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _delete(url: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will make an ajax request.
+     *
+     * @protected
+     * @param {string} url
+     * @param {string} method
+     * @param {(string|object)} params
+     * @param {string} instanceParams
+     * @param {function} callBack
+     * @param {function} [requestCallBack]
+     * @returns {object}
+     */
+    protected _request(url: string, method: string, params: (string | object), instanceParams: string, callBack: Function, requestCallBack?: Function): object;
+    /**
+     * This will get the response.
+     *
+     * @protected
+     * @param {object} response
+     * @param {function} callBack
+     * @param {object} xhr
+     * @returns {void}
+     */
+    protected getResponse(response: object, callBack: Function, xhr: object): void;
+}

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

@@ -0,0 +1,33 @@
+/**
+ * Model
+ *
+ * This will extend Data to add a model that can specify
+ * a service that connects to a remote source.
+ *
+ * @class
+ * @extends Data
+ */
+export class Model extends Data {
+    /**
+     * This will extend the model to a child model.
+     *
+     * @param {object} [settings]
+     * @returns {object}
+     */
+    static extend(settings?: object): object;
+    /**
+     * @member {object|null} xhr
+     */
+    xhr: any;
+    /**
+     * This adds a method to call if you want the model
+     * to do something when its initialized.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected initialize(): void;
+    service: typeof ModelService;
+}
+import { Data } from './deep-data.js';
+import { ModelService } from './model-service.js';

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

@@ -0,0 +1,12 @@
+/**
+ * SimpleData
+ *
+ * This will extend Data to add a simple data object
+ * that doesn't allow deep nested data.
+ *
+ * @class
+ * @augments BasicData
+ */
+export class SimpleData extends BasicData {
+}
+import { BasicData } from './basic-data.js';

package/dist/types/modules/data-binder/connection-tracker/connection-tracker.d.ts

@@ -0,0 +1,45 @@
+/**
+ * ConnectionTracker
+ *
+ * This will create a new connection tracker to track active
+ * connections in the data binder.
+ *
+ * @class
+ */
+export class ConnectionTracker {
+    /**
+     * @member {Map} connections
+     */
+    connections: Map<any, any>;
+    /**
+     * This will add a new connection to be tracked.
+     *
+     * @param {string} id
+     * @param {string} attr
+     * @param {object} connection
+     * @returns {object}
+     */
+    add(id: string, attr: string, connection: object): object;
+    /**
+     * This will get a connection.
+     *
+     * @param {string} id
+     * @param {string} attr
+     * @returns {object|boolean}
+     */
+    get(id: string, attr: string): object | boolean;
+    /**
+     * This will find a connection.
+     *
+     * @param {string} id
+     * @returns {object}
+     */
+    find(id: string): object;
+    /**
+     * This will remove a connection or all connections by id.
+     * @param {string} id
+     * @param {string} [attr]
+     * @returns {void}
+     */
+    remove(id: string, attr?: string): void;
+}

package/dist/types/modules/data-binder/connection-tracker/connections/connection.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Connection
+ *
+ * This will create a connection.
+ *
+ * @class
+ */
+export class Connection {
+    /**
+     * This will be used to unsubscribe.
+     *
+     * @returns {void}
+     */
+    unsubscribe(): void;
+}

package/dist/types/modules/data-binder/connection-tracker/connections/one-way-connection.d.ts

@@ -0,0 +1,23 @@
+/**
+ * OneWayConnection
+ *
+ * This will create a one way connection.
+ *
+ * @class
+ * @augments Connection
+ */
+export class OneWayConnection extends Connection {
+    /**
+     * @member {object} source
+     */
+    source: OneWaySource;
+    /**
+     * This will setup the connection source.
+     *
+     * @param {object} data
+     * @returns {object}
+     */
+    addSource(data: object): object;
+}
+import { Connection } from './connection.js';
+import { OneWaySource } from '../../sources/one-way-source.js';

package/dist/types/modules/data-binder/connection-tracker/connections/two-way-connection.d.ts

@@ -0,0 +1,62 @@
+/**
+ * TwoWayConnection
+ *
+ * This will setup a two way connection.
+ *
+ * @class
+ * @augments Connection
+ */
+export class TwoWayConnection extends Connection {
+    /**
+     * This will create a two way connection.
+     *
+     * @constructor
+     */
+    constructor(pubSub: any);
+    /**
+     * @member {object} element
+     */
+    element: ElementSource;
+    /**
+     * @member {object} data
+     */
+    data: DataSource;
+    /**
+     * @member {object} pubSub
+     */
+    pubSub: any;
+    /**
+     * This will add the element source.
+     *
+     * @param {object} element
+     * @param {string} attr
+     * @param {(string|function)} filter
+     * @returns {object}
+     */
+    addElement(element: object, attr: string, filter: (string | Function)): object;
+    /**
+     * This will add the data source.
+     *
+     * @param {object} data
+     * @param {string} prop
+     * @returns {object}
+     */
+    addData(data: object, prop: string): object;
+    /**
+     * This will unsubscribe from a source.
+     *
+     * @param {object} source
+     * @returns {object}
+     */
+    unsubscribeSource(source: object): object;
+    /**
+     * This will be used to unsubscribe.
+     *
+     * @override
+     * @returns {object}
+     */
+    override unsubscribe(): object;
+}
+import { Connection } from './connection.js';
+import { ElementSource } from '../../sources/element-source.js';
+import { DataSource } from '../../sources/data-source.js';