@base-framework/base 3.0.79 → 3.0.80

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

@@ -0,0 +1,136 @@
+export function normalizeAttr(prop: string): string;
+export function removeEventPrefix(prop: string): string;
+/**
+ * Html
+ *
+ * This will create html elements.
+ *
+ * @class
+ */
+export class Html {
+    /**
+     * This will create a new element.
+     *
+     * @param {string} node The node name.
+     * @param {object} attrs The node attributes.
+     * @param {object} container The node container.
+     * @param {boolean} [prepend=false] Add to the begining of the container.
+     * @returns {object} The new element.
+     */
+    static create(node: string, attrs: object, container: object, prepend?: boolean): object;
+    /**
+     * This will add the element attributes.
+     *
+     * @param {object} obj
+     * @param {object} attrs
+     * @returns {void}
+     */
+    static addAttributes(obj: object, attrs: object): void;
+    /**
+     * This will add html to an element.
+     *
+     * @param {object} obj
+     * @param {string} content
+     * @returns {object}
+     */
+    static addHtml(obj: object, content: string): object;
+    /**
+     * This will add an element attribute.
+     *
+     * @param {object} obj
+     * @param {object} attr
+     * @param {*} value
+     * @returns {void}
+     */
+    static addAttr(obj: object, attr: object, value: any): void;
+    /**
+     * This will create a doc fragment.
+     *
+     * @returns {object}
+     */
+    static createDocFragment(): object;
+    /**
+     * This will create a text node.
+     *
+     * @param {string} text
+     * @param {object} container
+     * @returns {object}
+     */
+    static createText(text: string, container: object): object;
+    /**
+     * This will create a text node.
+     *
+     * @param {string} text
+     * @param {object} container
+     * @returns {object}
+     */
+    static createComment(text: string, container: object): object;
+    /**
+     * This will create the options on a select.
+     *
+     * @param {object} selectElem
+     * @param {array} optionArray
+     * @param {string} [defaultValue]
+     */
+    static setupSelectOptions(selectElem: object, optionArray: any[], defaultValue?: string): boolean;
+    /**
+     * This will remove an elements data.
+     *
+     * @param {object} ele
+     */
+    static removeElementData(ele: object): void;
+    /**
+     * This will remove an element and its data.
+     *
+     * @param {object} obj
+     * @returns {object} this
+     */
+    static removeElement(obj: object): object;
+    /**
+     * This will remove an element.
+     *
+     * @param {object} child
+     * @returns {object} this
+     */
+    static removeChild(child: object): object;
+    /**
+     * This will remove all elements from the container.
+     *
+     * @param {object} container
+     * @returns {object} this
+     */
+    static removeAll(container: object): object;
+    /**
+     * This change the parent of an element.
+     *
+     * @param {object} child
+     * @param {object} newParent
+     * @returns {object} this
+     */
+    static changeParent(child: object, newParent: object): object;
+    /**
+     * This will append a child element.
+     *
+     * @param {object} parent
+     * @param {object} child
+     * @returns {object} this
+     */
+    static append(parent: object, child: object): object;
+    /**
+     * This will prepend a child element.
+     *
+     * @param {object} parent
+     * @param {object} child
+     * @param {object} [optionalNode]
+     * @returns {object}
+     */
+    static prepend(parent: object, child: object, optionalNode?: object): object;
+    /**
+     * This will clone an element.
+     *
+     * @param {object} node
+     * @param {boolean} deepCopy
+     * @returns {object}
+     */
+    static clone(node: object, deepCopy?: boolean): object;
+}

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

@@ -0,0 +1 @@
+export function Import(props: object): object;

package/dist/types/modules/layout/builder.d.ts

@@ -0,0 +1,102 @@
+/**
+ * Builder
+ *
+ * This will build JSON layouts.
+ *
+ * @class
+ */
+export class Builder {
+    /**
+     * This will render a function/Unit/Component.
+     *
+     * @param {object|function} layout
+     * @param {object} container
+     * @param {object} [parent]
+     * @returns {object|null} The layout Unit, Component, or null.
+     */
+    static render(layout: object | Function, container: object, parent?: object): object | null;
+    /**
+     * This will build a JSON layout.
+     *
+     * @param {object} obj The JSON layout.
+     * @param {object} [container] The parent receiving the layout.
+     * @param {object} [parent] The component adding the layout.
+     * @returns {object} The doc Frag element.
+     */
+    static build(obj: object, container?: object, parent?: object): object;
+    /**
+     * This will rebuild a layout.
+     *
+     * @param {object} layout
+     * @param {object} ele
+     * @param {object} parent
+     * @returns {object}
+     */
+    static rebuild(layout: object, ele: object, parent: object): object;
+    /**
+     * This will build an element or component.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} container
+     * @param {object} [parent] The component adding the layout.
+     * @returns {void}
+     */
+    protected static buildElement(obj: object, container: object, parent?: object): void;
+    /**
+     * This will create an element.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} container
+     * @param {object} [parent] The component adding the layout.
+     * @returns {void}
+     */
+    protected static createElement(obj: object, container: object, parent?: object): void;
+    /**
+     * This will add the element directives.
+     *
+     * @param {object} ele
+     * @param {array} directives
+     * @param {object} parent
+     * @returns {void}
+     */
+    static setDirectives(ele: object, directives: any[], parent: object): void;
+    /**
+     * This will handle an attr directive.
+     *
+     * @protected
+     * @param {object} ele
+     * @param {object} attrDirective
+     * @param {object} parent
+     * @returns {void}
+     */
+    protected static handleDirective(ele: object, attrDirective: object, parent: object): void;
+    /**
+     * This will cache an element ot the parent.
+     *
+     * @param {object} ele
+     * @param {object} propName
+     * @param {object} parent
+     */
+    static cache(ele: object, propName: object, parent: object): void;
+    /**
+     * This will create a component.
+     *
+     * @protected
+     * @param {object} obj
+     * @param {object} container
+     * @param {object} parent
+     * @returns {void}
+     */
+    protected static createComponent(obj: object, container: object, parent: object): void;
+    /**
+     * This will create a node.
+     *
+     * @param {object} settings
+     * @param {object} container
+     * @param {object} parent
+     * @returns {object}
+     */
+    static createNode(settings: object, container: object, parent: object): object;
+}

package/dist/types/modules/layout/directives/core/aria/aria.d.ts

@@ -0,0 +1,2 @@
+export function addRole(ele: object, role: string, parent: object): void;
+export function addAria(ele: object, attributes: object, parent: object): void;

package/dist/types/modules/layout/directives/core/context/context-directives.d.ts

@@ -0,0 +1,3 @@
+export function context(ele: object, context: Function, parent?: object): void;
+export function useContext(ele: object, callBack: Function, parent?: object): void;
+export function addContext(ele: object, callBack: any[] | Function, parent?: object): void;

package/dist/types/modules/layout/directives/core/default-directives.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/modules/layout/directives/core/dom-methods.d.ts

@@ -0,0 +1 @@
+export function onUpdate(ele: object, data: object, settings: (Function | object), parent: string): void;

package/dist/types/modules/layout/directives/core/parent/parent-directives.d.ts

@@ -0,0 +1,5 @@
+export function cache(ele: object, propName: string, parent: object): void;
+export function useParent(ele: object, callBack: Function, parent: object): void;
+export function useData(ele: object, callBack: Function, parent: object): void;
+export function useState(ele: object, callBack: Function, parent: object): void;
+export function addState(ele: object, callBack: Function, parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/bind.d.ts

@@ -0,0 +1 @@
+export function bind(ele: object, bind: (string | any[]), parent: any): void;

package/dist/types/modules/layout/directives/core/reactive/for-each.d.ts

@@ -0,0 +1 @@
+export function forEach(ele: object, settings: any[], parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/get-parent-data.d.ts

@@ -0,0 +1 @@
+export function getParentData(parent: object): object | null;

package/dist/types/modules/layout/directives/core/reactive/map.d.ts

@@ -0,0 +1 @@
+export function map(ele: object, settings: any[], parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/on-created.d.ts

@@ -0,0 +1 @@
+export function onCreated(ele: object, callBack: Function, parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/on-destroyed.d.ts

@@ -0,0 +1 @@
+export function onDestroyed(ele: object, callBack: (object | any[]), parent?: object): void;

package/dist/types/modules/layout/directives/core/reactive/on-set.d.ts

@@ -0,0 +1 @@
+export function onSet(ele: object, onSet: any[], parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/on-state.d.ts

@@ -0,0 +1 @@
+export function onState(ele: object, onState: any[], parent: object): void;

package/dist/types/modules/layout/directives/core/reactive/watch.d.ts

@@ -0,0 +1 @@
+export function watch(ele: object, watcher: (any[] | object), parent?: object): void;

package/dist/types/modules/layout/directives/core/route.d.ts

@@ -0,0 +1 @@
+export function addRoute(ele: object, route: (object | any[]), parent: object): void;

package/dist/types/modules/layout/directives/core/switch.d.ts

@@ -0,0 +1 @@
+export function addSwitch(ele: object, group: any[], parent: object): void;

package/dist/types/modules/layout/directives/directive.d.ts

@@ -0,0 +1 @@
+export function Directive(name: string, callBack: Function): object;

package/dist/types/modules/layout/directives/directives.d.ts

@@ -0,0 +1,25 @@
+export namespace Directives {
+    let keys: any[];
+    let items: {};
+    /**
+     * This will add a directive.
+     *
+     * @param {string} name
+     * @param {function} callBack
+     * @returns {object}
+     */
+    function add(name: string, callBack: Function): any;
+    /**
+     * This will get a directive.
+     *
+     * @param {string} name
+     * @returns {object|null}
+     */
+    function get(name: string): any;
+    /**
+     * This will get all directive names.
+     *
+     * @returns {array}
+     */
+    function all(): any[];
+}

package/dist/types/modules/layout/element/attribute-directive.d.ts

@@ -0,0 +1 @@
+export function AttributeDirective(attr: string, directive: object): object;

package/dist/types/modules/layout/element/attribute.d.ts

@@ -0,0 +1 @@
+export function Attribute(key: string, value: any): object;

package/dist/types/modules/layout/element/element.d.ts

@@ -0,0 +1 @@
+export function Element(tag: string, attr: any[], directives: any[], children: any[]): object;

package/dist/types/modules/layout/element/parser.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Parser
+ *
+ * This will parse JSON layouts.
+ *
+ * @class
+ */
+export class Parser {
+    /**
+     * This will get the tag name of an element.
+     *
+     * @static
+     * @private
+     * @param {object} obj
+     * @returns {string}
+     */
+    private static getTag;
+    /**
+     * This will setup the element children.
+     *
+     * @static
+     * @param {object} obj
+     * @returns {void}
+     */
+    static setupChildren(obj: object): void;
+    /**
+     * This will setup the element content.
+     *
+     * @param {string} key
+     * @param {*} value
+     * @param {array} attr
+     * @param {array} children
+     * @returns {boolean}
+     */
+    static setElementContent(key: string, value: any, attr: any[], children: any[]): boolean;
+    /**
+     * This will set the text as a watcher.
+     *
+     * @private
+     * @static
+     * @param {array} directives
+     * @param {string} key
+     * @param {string} value
+     * @returns {void}
+     */
+    private static setTextAsWatcher;
+    /**
+     * This will set the button type.
+     *
+     * @static
+     * @param {string} tag
+     * @param {object} obj
+     * @param {array} attr
+     */
+    static setButtonType(tag: string, obj: object, attr: any[]): void;
+    /**
+     * This will parse a layout element.
+     *
+     * @static
+     * @param {object} obj
+     * @param {object} parent
+     * @returns {object}
+     */
+    static parse(obj: object, parent: object): object;
+}

package/dist/types/modules/layout/html-helper.d.ts

@@ -0,0 +1,57 @@
+/**
+ * HtmlHelper
+ *
+ * This will build JSON layouts.
+ *
+ * @class
+ * @extends Html
+ */
+export class HtmlHelper extends Html {
+    /**
+     * This will create a new element.
+     *
+     * @override
+     * @param {string} nodeName The node name.
+     * @param {array} attrs The node attributes.
+     * @param {object} container The node container.
+     * @param {object} parent
+     * @returns {object} The new element.
+     */
+    static override create(nodeName: string, attrs: any[], container: object, parent: object): object;
+    /**
+     * This will add the element attributes.
+     *
+     * @overload
+     * @param {object} ele
+     * @param {array} attrs
+     * @param {object} parent
+     * @returns {void}
+     */
+    static addAttributes(ele: object, attrs: any[], parent: object): void;
+    /**
+     * This will add an element attribute.
+     *
+     * @param {object} ele
+     * @param {object} attr
+     * @param {*} value
+     * @returns {void}
+     */
+    static addAttr(ele: object, attr: object, value: any, parent: any): void;
+    /**
+     * This will add content to an element.
+     *
+     * @param {object} ele
+     * @param {object|null} content
+     */
+    static addContent(ele: object, content: object | null): void;
+    /**
+     * This will append a child element to a parent.
+     *
+     * @override
+     * @param {object} parent
+     * @param {object} child
+     * @returns {void}
+     */
+    static override append(parent: object, child: object): void;
+}
+import { Html } from '../html/html.js';

package/dist/types/modules/layout/render/browser-render.d.ts

@@ -0,0 +1,10 @@
+/**
+ * BrowserRender
+ *
+ * This will redner the layout in the browser.
+ *
+ * @class
+ */
+export class BrowserRender extends Render {
+}
+import { Render } from './render.js';

package/dist/types/modules/layout/render/render-controller.d.ts

@@ -0,0 +1,23 @@
+/**
+ * RenderController
+ *
+ * This will set up the render engine.
+ *
+ * @class
+ */
+export class RenderController {
+    /**
+     * This will check if we are in the browser.
+     *
+     * @returns boolean
+     */
+    static browserIsSupported(): Window & typeof globalThis;
+    /**
+     * This will create a History Object based on navigation support
+     *
+     * @returns Render
+     */
+    static setup(): BrowserRender | ServerRender;
+}
+import { BrowserRender } from './browser-render.js';
+import { ServerRender } from './server-render.js';

package/dist/types/modules/layout/render/render.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Render
+ *
+ * This will be thase class for a render.
+ *
+ * @class
+ */
+export class Render {
+    /**
+     * This will create a node.
+     *
+     * @param {object} settings
+     * @param {object} container
+     * @param {object} parent
+     * @returns {object}
+     */
+    createNode(settings: object, container: object, parent: object): object;
+}

package/dist/types/modules/layout/render/server-render.d.ts

@@ -0,0 +1,10 @@
+/**
+ * ServerRender
+ *
+ * This will render the layout on the server.
+ *
+ * @class
+ */
+export class ServerRender extends Render {
+}
+import { Render } from './render.js';

package/dist/types/modules/layout/watcher-helper.d.ts

@@ -0,0 +1,103 @@
+export namespace WatcherHelper {
+    /**
+     * This will check if the value is a watcher.
+     *
+     * @param {*} value
+     * @returns {boolean}
+     * @static
+     * @private
+     */
+    function isWatching(value: any): boolean;
+    /**
+     * This will check if a string has params.
+     *
+     * @param {string} string
+     * @returns {boolean}
+     */
+    function hasParams(string: string): boolean;
+    /**
+     * This will get the property names to be watched.
+     *
+     * @protected
+     * @param {string} string
+     * @returns {(array|null)}
+     */
+    function _getWatcherProps(string: string): any[];
+    /**
+     * This will update an element attribute.
+     *
+     * @protected
+     * @param {object} ele
+     * @param {string} attr
+     * @param {string} value
+     */
+    function updateAttr(ele: any, attr: string, value: string): void;
+    /**
+     * This will get a watcher callBack.
+     *
+     * @protected
+     * @param {object} ele
+     * @param {(string|array)} data
+     * @param {string} string
+     * @param {string} attr
+     * @param {boolean} isArray
+     * @returns {function}
+     */
+    function _getWatcherCallBack(ele: any, data: string | any[], string: string, attr: string, isArray: boolean): Function;
+    /**
+     * This will get a watcher value.
+     *
+     * @private
+     * @param {(string|object)} settings
+     * @param {object} parent
+     * @returns {array}
+     */
+    function getValue(settings: any, parent: any): any[];
+    /**
+     * This will get the prop values.
+     *
+     * @param {object} data
+     * @param {array} props
+     * @param {boolean} isArray
+     * @returns {array}
+     */
+    function getPropValues(data: any, props: any[], isArray: boolean): any[];
+    /**
+     * This will get the watcher callBack.
+     *
+     * @param {object} settings
+     * @param {object} ele
+     * @param {object} data
+     * @param {string} string
+     * @param {boolean} isDataArray
+     * @returns {function}
+     */
+    function getCallBack(settings: any, ele: any, data: any, string: string, isDataArray: boolean): Function;
+    /**
+     * This will add a data watcher.
+     *
+     * @private
+     * @param {object} ele
+     * @param {(string|object)} settings
+     * @param {object} parent
+     */
+    function addDataWatcher(ele: any, settings: any, parent: any): void;
+    /**
+     * This will setup a data watcher.
+     *
+     * @param {object} ele
+     * @param {(string|object)} settings
+     * @param {object} parent
+     */
+    function setup(ele: any, settings: any, parent: any): void;
+    /**
+     * This will add a watcher.
+     *
+     * @private
+     * @param {object} ele
+     * @param {object} data
+     * @param {string} prop
+     * @param {function} callBack
+     */
+    function addWatcher(ele: any, data: any, prop: string, callBack: Function): void;
+}

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

@@ -0,0 +1,45 @@
+/**
+ * Mouse
+ *
+ * This will create a mouse event object.
+ * @class
+ */
+export class Mouse {
+    /**
+     * @contrustor
+     * @param {string} [mode]
+     * @param {function} [callBackFn]
+     * @param {object} [obj]
+     * @param {boolean} [capture]
+     */
+    constructor(mode?: string, callBackFn?: Function, obj?: object, capture?: boolean);
+    position: {
+        x: any;
+        y: any;
+    };
+    callBackFn: Function;
+    obj: any;
+    capture: boolean;
+    mode: string;
+    /**
+     * This will update the mode.
+     *
+     * @param {string} mode
+     */
+    updateMode(mode: string): void;
+    /**
+     * This will update the position.
+     *
+     * @param {object} e
+     * @returns {object}
+     */
+    updatePosition(e: object): object;
+    /**
+     * This will start tracking.
+     */
+    start(): void;
+    /**
+     * This will stop tracking.
+     */
+    stop(): void;
+}