@base-framework/base 3.0.79 → 3.0.81

package/dist/types/modules/state/state-tracker.d.ts

@@ -0,0 +1,103 @@
+/**
+* StateTracker
+*
+* This will create a state tracker that can
+* add and remove targets, actions, and action
+* subscriber callBack functions.
+*
+* @class
+*/
+export class StateTracker {
+    /**
+     * @member {Map} targets
+     * @private
+     */
+    private static targets;
+    /**
+     * This will restore a state target.
+     *
+     * @param {string} id
+     * @param {object} target
+     * @returns {void}
+     */
+    static restore(id: string, target: object): void;
+    /**
+     * This will get the state target.
+     *
+     * @param {string} id
+     * @returns {object}
+     */
+    static getTarget(id: string): object;
+    /**
+     * This will get the state of an action.
+     *
+     * @protected
+     * @param {string} targetId
+     * @param {string} action
+     * @returns {*}
+     */
+    protected static getActionState(targetId: string, action: string): any;
+    /**
+     * This will add a new target.
+     *
+     * @param {string} targetId
+     * @param {string} [action]
+     * @param {*} [state] the primary action state
+     * @returns {object}
+     */
+    static add(targetId: string, action?: string, state?: any): object;
+    /**
+     * This will add a new action to a target.
+     *
+     * @param {string} targetId
+     * @param {string} action
+     * @param {string} [state]
+     * @returns {object}
+     */
+    static addAction(targetId: string, action: string, state?: string): object;
+    /**
+     * This will remove the action from a target.
+     *
+     * @param {string} targetId
+     * @param {string} action
+     * @param {string} [token]
+     * @returns {void}
+     */
+    static removeAction(targetId: string, action: string, token?: string): void;
+    /**
+     * This will add a new subscriber to the action.
+     *
+     * @param {string} targetId
+     * @param {string} action
+     * @param {function} callBack
+     * @returns {?string}
+     */
+    static on(targetId: string, action: string, callBack: Function): string | null;
+    /**
+     * This will remove a subscriber from an action.
+     *
+     * @param {string} targetId
+     * @param {string} action
+     * @param {string} token
+     * @returns {void}
+     */
+    static off(targetId: string, action: string, token: string): void;
+    /**
+     * This will remove a target or action or callBack.
+     *
+     * @param {string} targetId
+     * @param {string} [action]
+     * @param {string} [token]
+     * @returns {void}
+     */
+    static remove(targetId: string, action?: string, token?: string): void;
+    /**
+     * This will set the action state.
+     *
+     * @param {string} targetId
+     * @param {string} action
+     * @param {*} state
+     * @returns {void}
+     */
+    static set(targetId: string, action: string, state: any): void;
+}

package/dist/types/shared/arrays.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Arrays
+ *
+ * This will contain methods for working with arrays.
+ *
+ * @module
+ * @name Arrays
+ */
+export class Arrays {
+    /**
+     * This will convert an object or collection into an array.
+     *
+     * @param {object} list
+     * @returns {array}
+     */
+    static toArray(list: object): any[];
+    /**
+     * This will check if a value is found in an array.
+     *
+     * @param {array} array
+     * @param {string} element
+     * @param {number} [fromIndex]
+     * @returns {number} This will return -1 if not found.
+     */
+    static inArray(array: any[], element: string, fromIndex?: number): number;
+}

package/dist/types/shared/dom.d.ts

@@ -0,0 +1,272 @@
+/**
+ * Dom
+ *
+ * This will contain methods for working with the dom.
+ *
+ * @module
+ * @name Dom
+ */
+export class Dom {
+    /**
+     * This will select an element by id.
+     *
+     * @param {string} id
+     * @returns {object|boolean} The element object or false.
+     */
+    static getById(id: string): object | boolean;
+    /**
+     * This will select elements by name.
+     *
+     * @param {string} name
+     * @returns {object|boolean} The elements array or false.
+     */
+    static getByName(name: string): object | boolean;
+    /**
+     * This will select by css selector.
+     *
+     * @param {string} selector
+     * @param {boolean} single Set to true if you only want one result.
+     * @returns {*}
+     */
+    static getBySelector(selector: string, single: boolean): any;
+    /**
+     * This will get or set the innerHTML or an element.
+     *
+     * @param {object} obj
+     * @param {string} [html] If the html is not set, the html of the
+     * element will be returned.
+     *
+     * @returns {*}
+     */
+    static html(obj: object, html?: string): any;
+    /**
+     * This will set the css property of an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} value
+     * @returns {object} an instance of base.
+     */
+    static setCss(obj: object, property: string, value: string): object;
+    /**
+     * This will get the css property of an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @returns {*}
+     */
+    static getCss(obj: object, property: string): any;
+    /**
+     * This will get or set the css propety or an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} [value]
+     * @returns {*}
+     */
+    static css(obj: object, property: string, value?: string): any;
+    /**
+     * This will remove an attribute from an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @returns {object} an instance of base.
+     */
+    static removeAttr(obj: object, property: string): object;
+    /**
+     * This will set an attribute of an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} value
+     * @returns {void}
+     */
+    static setAttr(obj: object, property: string, value: string): void;
+    /**
+     * This will get an attribute of an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @returns {string}
+     */
+    static getAttr(obj: object, property: string): string;
+    /**
+     * This will get or set an attribute from an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} [value]
+     * @returns {*}
+     */
+    static attr(obj: object, property: string, value?: string): any;
+    /**
+     * This will prefix a string with "data-" if not set.
+     *
+     * @protected
+     * @param {string} prop
+     * @returns {string}
+     */
+    protected static _checkDataPrefix(prop: string): string;
+    /**
+     * This will remove "data-" from a string.
+     *
+     * @protected
+     * @param {string} prop
+     * @returns {string}
+     */
+    protected static removeDataPrefix(prop: string): string;
+    /**
+     * This will set data to an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} value
+     */
+    static setData(obj: object, property: string, value: string): void;
+    /**
+     * This will get data from an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @returns {string}
+     */
+    static getData(obj: object, property: string): string;
+    /**
+     * This will get or set data to an element.
+     *
+     * @param {object} obj
+     * @param {string} property
+     * @param {string} [value]
+     * @returns {*}
+     */
+    static data(obj: object, property: string, value?: string): any;
+    /**
+     * This will find elements in an element.
+     *
+     * @param {object} obj
+     * @param {string} queryString
+     * @returns {array}
+     */
+    static find(obj: object, queryString: string): any[];
+    /**
+     * This will display an element.
+     *
+     * @param {object} obj
+     * @returns {object} An instance of base.
+     */
+    static show(obj: object): object;
+    /**
+     * This will hide an element.
+     *
+     * @param {object} obj
+     * @returns {object} An instance of base.
+     */
+    static hide(obj: object): object;
+    /**
+     * This will toggle the display an element.
+     *
+     * @param {object} obj
+     * @returns {object} An instance of base.
+     */
+    static toggle(obj: object): object;
+    /**
+     * This will get the size of an element.
+     *
+     * @param {object} obj
+     * @returns {object|boolean} A size object or false.
+     */
+    static getSize(obj: object): object | boolean;
+    /**
+     * This will get the width of an element.
+     *
+     * @param {object} obj
+     * @returns {number|boolean} A width or false.
+     */
+    static getWidth(obj: object): number | boolean;
+    /**
+     * This will get the height of an element.
+     *
+     * @param {object} obj
+     * @returns {number|boolean} A height or false.
+     */
+    static getHeight(obj: object): number | boolean;
+    /**
+    * This will get the scroll position.
+    *
+    * @param {object} [obj] The element or document element if not set.
+    * @returns {object}
+    */
+    static getScrollPosition(obj?: object): object;
+    /**
+     * This will get the scroll top position.
+     *
+     * @param {object} [obj] The element or document element if not set.
+     * @returns {object}
+     */
+    static getScrollTop(obj?: object): object;
+    /**
+     * This will get the scroll left position.
+     *
+     * @param {object} [obj] The element or document element if not set.
+     * @returns {object}
+     */
+    static getScrollLeft(obj?: object): object;
+    /**
+     * This will get the window size.
+     *
+     * @returns {object}
+     */
+    static getWindowSize(): object;
+    /**
+     * This will get the document size.
+     *
+     * @returns {object}
+     */
+    static getDocumentSize(): object;
+    /**
+     * This will get the document height.
+     *
+     * @returns {object}
+     */
+    static getDocumentHeight(): object;
+    /**
+     * This will get the position of an element.
+     *
+     * @param {object} obj
+     * @param {number} [depth] The number of levels, default is 1, 0 is to the root.
+     * @returns {object}
+     */
+    static position(obj: object, depth?: number): object;
+    /**
+     * This will add a class to an element.
+     *
+     * @param {object} obj
+     * @param {string} tmpClassName
+     * @returns {object}
+     */
+    static addClass(obj: object, tmpClassName: string): object;
+    /**
+     * This will remove a class or classes from an element.
+     *
+     * @param {object} obj
+     * @param {string} [tmpClassName]
+     * @returns {object}
+     */
+    static removeClass(obj: object, tmpClassName?: string): object;
+    /**
+     * This will check if an element has a class.
+     *
+     * @param {object} obj
+     * @param {string} tmpClassName
+     * @returns {boolean}
+     */
+    static hasClass(obj: object, tmpClassName: string): boolean;
+    /**
+     * This will toggle a class on an element.
+     *
+     * @param {object} obj
+     * @param {string} tmpClassName
+     * @returns {object}
+     */
+    static toggleClass(obj: object, tmpClassName: string): object;
+}

package/dist/types/shared/encode/encode.d.ts

@@ -0,0 +1,38 @@
+/**
+ * Encode
+ *
+ * This will contain methods for working with encoding.
+ *
+ * @module
+ * @name Encode
+ */
+export class Encode {
+    /**
+     * This will prepare a json object to be used in an
+     * xhr request. This will sanitize the object values
+     * by encoding them to not break the param string.
+     *
+     * @param {object} obj
+     * @param {boolean} [removeNewLines]
+     * @returns {string}
+     */
+    static prepareJsonUrl(obj: object, removeNewLines?: boolean): string;
+    /**
+     * This will encode and decode json data.
+     *
+     * @member {object} json
+     */
+    static json: {
+        encode: typeof encode;
+        decode: typeof decode;
+    };
+    /**
+     * This will parse xml data.
+     *
+     * @param {string} data
+     * @returns {object}
+     */
+    static xmlParse(data: string): object;
+}
+import { encode } from "./json.js";
+import { decode } from "./json.js";

package/dist/types/shared/encode/json.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This will parse JSON data.
+ *
+ * @param {string} data
+ * @returns {*}
+ */
+export function decode(data: string): any;
+/**
+ * This will encode JSON data.
+ *
+ * @param {*} data
+ * @returns {?string}
+ */
+export function encode(data: any): string | null;
+export function prepareUrl(data: any, removeNewLines?: boolean): string;

package/dist/types/shared/objects.d.ts

@@ -0,0 +1,62 @@
+export namespace Objects {
+    /**
+     * This will create a new object.
+     *
+     * @param {object} [object] An object to extend.
+     * @returns {object}
+     */
+    function create(object?: any): any;
+    /**
+     * This will extend an object to another object.
+     *
+     * @param {(function|object)} sourceObj
+     * @param {(function|object)} targetObj
+     * @returns {object}
+     */
+    function extendObject(sourceObj: any, targetObj: any): any;
+    /**
+     * This will clone an object.
+     *
+     * @param {object} obj
+     * @returns {object}
+     */
+    function clone(obj: any): any;
+    /**
+     * This will get the class prototype.
+     *
+     * @protected
+     * @param {function|object} object
+     * @returns {object}
+     */
+    function getClassObject(object: any): any;
+    /**
+     * This will extend an object to another object.
+     *
+     * @param {function|object} sourceClass
+     * @param {function|object} targetClass
+     * @returns {object}
+     */
+    function extendClass(sourceClass: any, targetClass: any): any;
+    /**
+     * This will check if an object has a property.
+     *
+     * @param {object} obj
+     * @param {string} prop
+     * @returns {boolean}
+     */
+    function hasOwnProp(obj: any, prop: string): boolean;
+    /**
+     * This will check if an object is a plain object.
+     *
+     * @param {object} obj
+     * @returns {boolean}
+     */
+    function isPlainObject(obj: any): boolean;
+    /**
+     * This will check if an object is empty.
+     *
+     * @param {object} obj
+     * @returns {boolean}
+     */
+    function isEmpty(obj: any): boolean;
+}

package/dist/types/shared/strings.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Strings
+ *
+ * This will contain methods for working with strings.
+ *
+ * @module
+ * @name Strings
+ */
+export class Strings {
+    /**
+     * This will parse a query string.
+     *
+     * @param {string} [str] The string to parse or the global
+     * location will be parsed.
+     * @param {boolean} [decode]
+     * @returns {object}
+     */
+    static parseQueryString(str?: string, decode?: boolean): object;
+    /**
+     * This will camelCase a string.
+     *
+     * @param {string} str
+     * @returns {string} The string or false.
+     */
+    static camelCase(str: string): string;
+    /**
+     * This will uncamel-case a string.
+     *
+     * @param {string} str
+     * @param {string} delimiter
+     * @returns {string} The string.
+     */
+    static uncamelCase(str: string, delimiter?: string): string;
+}

package/dist/types/shared/types.d.ts

@@ -0,0 +1,52 @@
+/**
+ * Types
+ *
+ * This will contain methods for working with types.
+ *
+ * @module
+ * @name Types
+ */
+export class Types {
+    /**
+     * This will get the type of a variable.
+     *
+     * @param {*} data
+     * @returns {string}
+     */
+    static getType(data: any): string;
+    /**
+     * This will check if a request is undefined.
+     *
+     * @param {*} data
+     * @returns {boolean}
+     */
+    static isUndefined(data: any): boolean;
+    /**
+     * This will check if the request is an object.
+     *
+     * @param {object} obj
+     * @returns {boolean}
+     */
+    static isObject(obj: object): boolean;
+    /**
+     * This will check if the request is an object.
+     *
+     * @param {object} obj
+     * @returns {boolean}
+     */
+    static isFunction(obj: object): boolean;
+    /**
+     * This will check if the request is an object.
+     *
+     * @param {object} obj
+     * @returns {boolean}
+     */
+    static isString(obj: object): boolean;
+    /**
+     * This will check if the data is an array.
+     *
+     * @param {*} data
+     * @returns {boolean}
+     */
+    static isArray(data: any): boolean;
+}

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@base-framework/base",
-	"version": "3.0.79",
+	"version": "3.0.81",
 	"description": "This is a javascript framework.",
 	"main": "/dist/base.js",
 	"scripts": {
-		"build": "node ./esbuild.js",
+		"build": "node ./esbuild.js && tsc",
 		"prepublishOnly": "node ./esbuild.js"
 	},
 	"keywords": [
@@ -23,8 +23,10 @@
 		"url": "https://github.com/chrisdurfee/base/issues"
 	},
 	"devDependencies": {
-		"esbuild": "^0.15.7"
+		"esbuild": "^0.15.7",
+		"typescript": "^5.4.2"
 	},
+	"types": "dist/types/base.d.ts",
 	"files": [
 		"pacakge.json",
 		"readme.md",