@base-framework/base 3.0.79 → 3.0.81

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

@@ -0,0 +1,175 @@
+export { DataPubSub } from "./data-pub-sub.js";
+/**
+ * DataBinder
+ *
+ * This will create a data binder object that can
+ * create one way and two way data bindings.
+ *
+ * @class
+ */
+export class DataBinder {
+    /**
+     * @member {string} version
+     */
+    version: string;
+    /**
+     * @member {string} attr
+     */
+    attr: string;
+    /**
+     * @member {array} blockedKeys
+     * @protected
+     */
+    protected blockedKeys: number[];
+    /**
+     * @member {object} connections
+     * @protected
+     */
+    protected connections: ConnectionTracker;
+    /**
+     * @member {object} pubSub
+     * @protected
+     */
+    protected pubSub: DataPubSub;
+    /**
+     * @member {number} idCount
+     */
+    idCount: number;
+    /**
+     * This will setup the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setup(): void;
+    /**
+     * This will bind an element to a data property.
+     *
+     * @param {object} element
+     * @param {object} data
+     * @param {string} prop
+     * @param {(string|function)} [filter]
+     * @returns {object} an instance of the databinder.
+     */
+    bind(element: object, data: object, prop: string, filter?: (string | Function)): object;
+    /**
+     * This will bind an element to a data property.
+     *
+     * @protected
+     * @param {object} element
+     * @param {object} data
+     * @param {string} prop
+     * @param {string} customAttr
+     * @param {(string|function)} [filter]
+     * @returns {object} The new connection.
+     */
+    protected setupConnection(element: object, data: object, prop: string, customAttr: string, filter?: (string | Function)): object;
+    /**
+     * This will add a new connection to the
+     * connection tracker.
+     *
+     * @protected
+     * @param {string} id
+     * @param {string} attr
+     * @param {object} connection
+     * @returns {object}
+     */
+    protected addConnection(id: string, attr: string, connection: object): object;
+    /**
+     * This will set the bind id.
+     *
+     * @protected
+     * @param {object} element
+     * @returns {string}
+     */
+    protected setBindId(element: object): string;
+    /**
+     * This will get the bind id.
+     *
+     * @protected
+     * @param {object} element
+     * @returns {string}
+     */
+    protected getBindId(element: object): string;
+    /**
+     * This will unbind the element.
+     *
+     * @param {object} element
+     * @returns {object} an instance of the data binder.
+     */
+    unbind(element: object): object;
+    /**
+     * This will setup a watcher for an element.
+     *
+     * @param {object} element
+     * @param {object} data
+     * @param {string} prop
+     * @param {function} callBack
+     * @returns {object}
+     */
+    watch(element: object, data: object, prop: string, callBack: Function): object;
+    /**
+     * This will remove a watcher from an element.
+     *
+     * @param {object} element
+     * @param {object} data
+     * @param {string} prop
+     * @returns {object}
+     */
+    unwatch(element: object, data: object, prop: string): object;
+    /**
+     * This will publish to the pub sub.
+     *
+     * @param {string} msg
+     * @param {*} value
+     * @param {object} committer
+     * @returns {object} an instance of the data binder.
+     */
+    publish(msg: string, value: any, committer: object): object;
+    /**
+     * This will check if an element is bound.
+     *
+     * @protected
+     * @param {object} element
+     * @returns {?string}
+     */
+    protected isDataBound(element: object): string | null;
+    /**
+     * This will check if the key is blocked.
+     *
+     * @protected
+     * @param {object} evt
+     * @returns {boolean}
+     */
+    protected isBlocked(evt: object): boolean;
+    /**
+     * This is the callBack for the chnage event.
+     *
+     * @param {object} evt
+     */
+    bindHandler(evt: object): boolean;
+    /**
+     * This wil setup the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setupEvents(): void;
+    changeHandler: any;
+    /**
+     * This will add the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected addEvents(): void;
+    /**
+     * This will remove the events.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected removeEvents(): void;
+}
+export const dataBinder: DataBinder;
+import { ConnectionTracker } from './connection-tracker/connection-tracker.js';

package/dist/types/modules/data-binder/data-pub-sub.d.ts

@@ -0,0 +1,66 @@
+/**
+ * DataPubSub
+ *
+ * This is a pub sub class to allow subscribers to
+ * listen for updates when published by publishers.
+ *
+ * @class
+ */
+export class DataPubSub {
+    /**
+     * @member {Map} callBacks
+     * @protected
+     */
+    protected callBacks: Map<any, any>;
+    /**
+     * @member {number} lastToken
+     * @protected
+     */
+    protected lastToken: number;
+    /**
+     * This will get a subscriber array.
+     *
+     * @param {string} msg
+     * @returns {array}
+     */
+    get(msg: string): any[];
+    /**
+     * This will reset pub sub.
+     *
+     * @returns {void}
+     */
+    reset(): void;
+    /**
+     * This will add a subscriber.
+     *
+     * @param {string} msg
+     * @param {function} callBack
+     * @returns {string} The subscriber token.
+     */
+    on(msg: string, callBack: Function): string;
+    /**
+     * This will remove a subscriber.
+     *
+     * @param {string} msg
+     * @param {string} token
+     * @returns {void}
+     */
+    off(msg: string, token: string): void;
+    /**
+     * This will delete a message.
+     *
+     * @param {string} msg
+     * @returns {void}
+     */
+    remove(msg: string): void;
+    /**
+     * This will publish a message.
+     *
+     * @overload
+     * @param {string} msg
+     * @param {string} value
+     * @param {object} [committer]
+     * @returns {void}
+     */
+    publish(msg: string, value: string, committer?: object): void;
+}

package/dist/types/modules/data-binder/sources/data-source.d.ts

@@ -0,0 +1,51 @@
+/**
+ * DataSource
+ *
+ * This will create a data source to use with
+ * a connection.
+ *
+ * @class
+ * @augments TwoWaySource
+ */
+export class DataSource extends TwoWaySource {
+    /**
+     * This will create a new data source.
+     *
+     * @constructor
+     * @param {object} data
+     * @param {string} prop
+     * @param {object} pubSub
+     */
+    constructor(data: object, prop: string, pubSub: object);
+    /**
+     * @member {object} data
+     */
+    data: any;
+    /**
+     * @member {string} prop
+     */
+    prop: string;
+    /**
+     * This will set the data value.
+     *
+     * @param {*} value
+     * @returns {void}
+     */
+    set(value: any): void;
+    /**
+     * This will get the data value.
+     *
+     * @returns {*}
+     */
+    get(): any;
+    /**
+     * The callBack when updated.
+     *
+     * @overload
+     * @param {*} value
+     * @param {object} committer
+     * @returns {void}
+     */
+    callBack(value: any, committer: object): void;
+}
+import { TwoWaySource } from './two-way-source.js';

package/dist/types/modules/data-binder/sources/element-source.d.ts

@@ -0,0 +1,84 @@
+/**
+ * ElementSource
+ *
+ * This will create an element source to use with
+ * a connection.
+ *
+ * @class
+ * @augments TwoWaySource
+ */
+export class ElementSource extends TwoWaySource {
+    /**
+     * This will create a new element source.
+     *
+     * @constructor
+     * @param {object} element
+     * @param {string} attr
+     * @param {string|function} filter
+     * @param {object} pubSub
+     */
+    constructor(element: object, attr: string, filter: string | Function, pubSub: object);
+    /**
+     * @member {object} element
+     */
+    element: any;
+    /**
+     * @member {string} attr
+     */
+    attr: string;
+    /**
+     * @member {function} filter
+     * @private
+     */
+    private filter;
+    /**
+     * This will set up the set and get methods.
+     *
+     * @private
+     * @param {object} element
+     * @param {string} attr
+     * @returns {object}
+     */
+    private addSetMethod;
+    setValue: ((element: any, attr: string, value: any) => void) | ((element: any, attr: string, value: any) => void) | ((element: any, attr: string, value: any) => void) | ((element: any, attr: string, value: any) => void);
+    getValue: ((element: any, attr: string) => any) | ((element: any, attr: string) => any);
+    /**
+     * This will get the bind attribute.
+     *
+     * @private
+     * @param {string} [customAttr]
+     * @returns {string}
+     */
+    private getAttrBind;
+    /**
+     * This will setup a filter callBack.
+     *
+     * @private
+     * @param {string} filter
+     * @returns {function}
+     */
+    private setupFilter;
+    /**
+     * This will set a value on an element.
+     *
+     * @param {*} value
+     * @returns {object}
+     */
+    set(value: any): object;
+    /**
+     * This will get the value from an element.
+     *
+     * @returns {*}
+     */
+    get(): any;
+    /**
+     * The callBack when updated.
+     *
+     * @overload
+     * @param {*} value
+     * @param {object} committer
+     * @returns {object}
+     */
+    callBack(value: any, committer: object): object;
+}
+import { TwoWaySource } from './two-way-source.js';

package/dist/types/modules/data-binder/sources/one-way-source.d.ts

@@ -0,0 +1,33 @@
+/**
+ * OneWaySource
+ *
+ * This will create a one way source to use with
+ * a connection.
+ *
+ * @class
+ * @augments Source
+ */
+export class OneWaySource extends Source {
+    /**
+     * This will setup the data source.
+     *
+     * @param {object} data
+     */
+    constructor(data: object);
+    data: any;
+    /**
+     * This will subscribe to a message.
+     *
+     * @param {string} msg
+     * @param {function} callBack
+     * @returns {void}
+     */
+    subscribe(msg: string, callBack: Function): void;
+    /**
+     * This will unsubscribe from the message.
+     *
+     * @returns {void}
+     */
+    unsubscribe(): void;
+}
+import { Source } from './source.js';

package/dist/types/modules/data-binder/sources/source.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Source
+ *
+ * This will create a new source to use with
+ * a connection.
+ *
+ * @class
+ */
+export class Source {
+    /**
+     * @member {string} msg
+     * @protected
+     */
+    protected msg: any;
+    /**
+     * @member {string} token
+     */
+    token: string;
+    /**
+     * This will set the token.
+     *
+     * @param {string} token
+     * @returns {void}
+     */
+    setToken(token: string): void;
+}

package/dist/types/modules/data-binder/sources/two-way-source.d.ts

@@ -0,0 +1,42 @@
+/**
+ * TwoWaySource
+ *
+ * This will create a two way source to use with
+ * a connection.
+ *
+ * @class
+ * @augments Source
+ */
+export class TwoWaySource extends Source {
+    /**
+     * This will create a new source.
+     *
+     * @constructor
+     * @param {object} pubSub
+     */
+    constructor(pubSub: object);
+    /**
+     * @member {object} pubSub
+     */
+    pubSub: any;
+    /**
+     * This will subscribe to a message.
+     *
+     * @param {string} msg
+     * @returns {void}
+     */
+    subscribe(msg: string): void;
+    /**
+     * This will unsubscribe from a message.
+     *
+     * @returns {void}
+     */
+    unsubscribe(): void;
+    /**
+     * Override this to setup cource callBack.
+     *
+     * @returns {void}
+     */
+    callBack(): void;
+}
+import { Source } from './source.js';

package/dist/types/modules/date/date-time.d.ts

@@ -0,0 +1,165 @@
+export namespace DateTime {
+    let monthNames: string[];
+    let dayNames: string[];
+    /**
+     * This will get the day name.
+     *
+     * @param {number} [day]
+     * @param {boolean} [shortenName=false]
+     * @returns {?string}
+     */
+    function getDayName(day?: number, shortenName?: boolean): string;
+    /**
+     * This will convert month to js.
+     *
+     * @param {number} month
+     * @returns {string}
+     */
+    function convertJsMonth(month: number): string;
+    /**
+     * This will convert a date.
+     *
+     * @param {string} dateString
+     * @param {boolean} addYear
+     * @returns {string}
+     */
+    function convertDate(dateString: string, addYear: boolean): string;
+    /**
+     * This will add leading zero to number less than 10.
+     *
+     * @param {number} number
+     * @returns {string}
+     */
+    function padNumber(number: number): string;
+    /**
+     * This will create a new date object.
+     *
+     * @param {string} dateString
+     * @returns {Date}
+     */
+    function createDate(dateString: string): Date;
+    /**
+     * This will format a date.
+     *
+     * @param {string} type
+     * @param {string} dateString
+     * @returns {string}
+     */
+    function format(type: string, dateString: string): string;
+    /**
+     * This will format time.
+     *
+     * @param {string} dateString
+     * @param {number} format
+     * @returns {string}
+     */
+    function formatTime(dateString: string, format: number): string;
+    /**
+     * This will check for leap year.
+     *
+     * @param {number} year
+     * @returns {boolean}
+     */
+    function leapYear(year: number): boolean;
+    /**
+     * This will get a month name.
+     *
+     * @param {number} [month]
+     * @param {boolean} [shortenName]
+     * @returns {string}
+     */
+    function getMonthName(month?: number, shortenName?: boolean): string;
+    /**
+     * This will return the month length.
+     *
+     * @param {number} [month]
+     * @param {number} [year]
+     * @returns {number}
+     */
+    function getMonthLength(month?: number, year?: number): number;
+    /**
+     * This will get the length of all the months.
+     *
+     * @param {number} year
+     * @returns {array}
+     */
+    function getMonthsLength(year?: number): any[];
+    /**
+     * This will get the difference from now.
+     *
+     * @param {string} date
+     * @param {boolean} [setHours]
+     * @returns {number}
+     */
+    function getDiffFromNow(date: string, setHours?: boolean): number;
+    /**
+     * This will get the age.
+     *
+     * @param {string} date
+     * @returns {string}
+     */
+    function getAge(date: string): string;
+    /**
+     * This will get the time frame.
+     *
+     * @param {string} date
+     * @returns {string}
+     */
+    function getTimeFrame(date: string): string;
+    /**
+     *
+     * @param {number} milliseconds
+     * @returns {string}
+     */
+    function convertToEstimate(milliseconds: number): string;
+    /**
+     * This will convert to years.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toYears(milliseconds: number): number;
+    /**
+     * This will convert to months.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toMonths(milliseconds: number): number;
+    /**
+     * This will convert to days.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toDays(milliseconds: number): number;
+    /**
+     * This will convert to hours.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toHours(milliseconds: number): number;
+    /**
+     * This will convert to minutes.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toMinutes(milliseconds: number): number;
+    /**
+     * This will convert to seconds.
+     *
+     * @param {number} milliseconds
+     * @returns {number}
+     */
+    function toSeconds(milliseconds: number): number;
+    /**
+     * This will get the difference between two dates.
+     *
+     * @param {string} startDate
+     * @param {string} endDate
+     * @returns {object}
+     */
+    function getDifference(startDate: string, endDate: string): any;
+}

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

@@ -0,0 +1,10 @@
+export namespace history {
+    function isSupported(): boolean;
+    function addEvent(fn: any, capture: any): void;
+    function removeEvent(fn: any, capture: any): void;
+    function pushState(object: any, title: any, url: any): void;
+    function replaceState(object: any, title: any, url: any): void;
+    function nextState(): void;
+    function prevState(): void;
+    function goTo(indexNumber: any): void;
+}