@base-framework/base 3.0.78 → 3.0.80

package/dist/types/modules/router/history/browser-history.d.ts

@@ -0,0 +1,39 @@
+/**
+ * BrowserHistory
+ *
+ * This will setup the history controller.
+ *
+ * @class
+ */
+export class BrowserHistory extends History {
+    /**
+     * This will remove the events.
+     *
+     * @returns {object} a reference to the object.
+     */
+    removeEvent(): object;
+    /**
+     * This will check to activate the router.
+     *
+     * @param {object} evt
+     */
+    check(evt: object): boolean;
+    /**
+     * This will create a state object.
+     *
+     * @param {string} uri
+     * @param {*} data
+     * @returns {object}
+     */
+    createState(uri: string, data?: any): object;
+    /**
+     * This will add a state to the history.
+     *
+     * @param {string} uri
+     * @param {object} data
+     * @param {boolean} replace
+     * @returns {object} a reference to the object.
+     */
+    addState(uri: string, data: object, replace?: boolean): object;
+}
+import { History } from "./history.js";

package/dist/types/modules/router/history/hash-history.d.ts

@@ -0,0 +1,25 @@
+/**
+ * HashHistory
+ *
+ * This will setup the history controller.
+ *
+ * @class
+ */
+export class HashHistory extends History {
+    /**
+     * This will remove the events.
+     *
+     * @returns {object} a reference to the object.
+     */
+    removeEvent(): object;
+    /**
+     * This will add a state to the history.
+     *
+     * @param {string} uri
+     * @param {object} data
+     * @param {boolean} replace
+     * @returns {object} a reference to the object.
+     */
+    addState(uri: string, data: object, replace: boolean): object;
+}
+import { History } from "./history.js";

package/dist/types/modules/router/history/history-controller.d.ts

@@ -0,0 +1,21 @@
+/**
+ * HistoryController
+ *
+ * This will setup the history controller.
+ * @class
+ */
+export class HistoryController {
+    /**
+     * This will check if browser based navigation is supported
+     *
+     * @returns boolean
+     */
+    static browserIsSupported(): boolean;
+    /**
+     * This will create a History Object based on navigation support
+     *
+     * @param {object} router
+     * @returns History
+     */
+    static setup(router: object): any;
+}

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

@@ -0,0 +1,35 @@
+/**
+ * History
+ *
+ * This will setup the history controller.
+ * @class
+ */
+export class History {
+    /**
+     * @constructor
+     * @param {object} router
+     */
+    constructor(router: object);
+    router: any;
+    locationId: string;
+    callBack: any;
+    /**
+     * This will check if the history api is supported
+     * and add events.
+     *
+     * @returns {object} a reference to the object.
+     */
+    setup(): object;
+    /**
+     * This will check to activate the router.
+     *
+     * @param {object} evt
+     */
+    check(evt: object): void;
+    /**
+     * This will add the events.
+     *
+     * @returns {object} a reference to the object.
+     */
+    addEvent(): object;
+}

package/dist/types/modules/router/nav-link.d.ts

@@ -0,0 +1,37 @@
+/**
+ * NavLink
+ *
+ * This will create a nav link that will add an active
+ * class when the browser route path matches the link
+ * href.
+ *
+ * @class
+ * @extends Component
+ */
+export class NavLink extends Component {
+    selectedClass: any;
+    /**
+     * This will get string.
+     *
+     * @param {string} string
+     * @returns {(string|null)}
+     */
+    getString(string: string): (string | null);
+    /**
+     * This will setup the watchers.
+     *
+     * @protected
+     * @param {string} href
+     * @param {string} text
+     * @returns {array}
+     */
+    protected setupWatchers(href: string, text: string): any[];
+    /**
+     * This will update the class on the element.
+     *
+     * @param {boolean} selected
+     * @returns {void}
+     */
+    update(selected: boolean): void;
+}
+import { Component } from '../component/component.js';

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

@@ -0,0 +1,268 @@
+export { NavLink } from "./nav-link.js";
+/**
+ * Router
+ *
+ * This will create a browser router.
+ *
+ * @class
+ */
+export class Router {
+    /**
+     * @member {string} version
+     */
+    version: string;
+    /**
+     * This is the root of the uri for the routing object
+     * and the base title.
+     */
+    baseURI: string;
+    title: string;
+    lastPath: string;
+    path: string;
+    /**
+     * This will be used to access our history object.
+     */
+    history: any;
+    callBackLink: any;
+    location: Location;
+    /**
+     * This will store each route added to the router.
+     */
+    routes: any[];
+    switches: {};
+    switchCount: number;
+    /**
+     * @member {object} data
+     */
+    data: Data;
+    /**
+     * This will setup our history object.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setupHistory(): void;
+    /**
+     * This will create a new route.
+     *
+     * @protected
+     * @param {object} settings
+     * @returns {object}
+     */
+    protected createRoute(settings: object): object;
+    /**
+     * This will add a new route to the router.
+     *
+     * @param {object} settings
+     * @returns {object}
+     */
+    add(settings: object, ...args: any[]): object;
+    /**
+     * This will add a route.
+     *
+     * @param {object} route
+     * @returns {void}
+     */
+    addRoute(route: object): void;
+    /**
+     * This will resume a route.
+     *
+     * @param {object} route
+     * @param {object} container
+     * @returns {void}
+     */
+    resume(route: object, container: object): void;
+    /**
+     * This will get the base path.
+     *
+     * @protected
+     * @returns {string}
+     */
+    protected getBasePath(): string;
+    basePath: string;
+    /**
+     * This will create a uri.
+     *
+     * @protected
+     * @param {string} uri
+     * @returns {string}
+     */
+    protected createURI(uri: string): string;
+    /**
+     * This will get a route by uri.
+     *
+     * @param {string} uri
+     * @returns {(object|boolean)}
+     */
+    getRoute(uri: string): (object | boolean);
+    /**
+     * This will get a route by id.
+     *
+     * @param {string} id
+     * @returns {(object|boolean)}
+     */
+    getRouteById(id: string): (object | boolean);
+    /**
+     * This will remove a route.
+     *
+     * @param {object} route
+     */
+    removeRoute(route: object): void;
+    /**
+     * This will add a switch.
+     *
+     * @param {array} group
+     * @returns {number} the switch id.
+     */
+    addSwitch(group: any[]): number;
+    /**
+     * This will resume a switch.
+     *
+     * @param {object} group
+     * @param {object} container
+     * @returns {number} the switch id.
+     */
+    resumeSwitch(group: object, container: object): number;
+    getSwitchGroup(id: any): any[];
+    /**
+     * This will remove a switch by id.
+     *
+     * @param {string} id
+     */
+    removeSwitch(id: string): void;
+    /**
+     * This will remove a route by uri.
+     *
+     * @param {string} uri
+     * @returns {object} a reference to the router object.
+     */
+    remove(uri: string): object;
+    /**
+     * This will setup the router.
+     *
+     * @param {string} [baseURI]
+     * @param {string} [title]
+     * @returns {object} a reference to the router object.
+     */
+    setup(baseURI?: string, title?: string): object;
+    updateBaseTag(url: any): void;
+    /**
+     * This will get the parent element link.
+     *
+     * @param {object} ele
+     * @returns {(object|boolean)}
+     */
+    getParentLink(ele: object): (object | boolean);
+    /**
+     * This will check if a link was routed.
+     *
+     * @protected
+     * @param {object} evt
+     */
+    protected checkLink(evt: object): boolean;
+    /**
+     * This will reset the router.
+     *
+     * @returns {object} a reference to the router object.
+     */
+    reset(): object;
+    /**
+     * This will check the active routes.
+     *
+     * @returns {object} a reference to the router object.
+     */
+    activate(): object;
+    /**
+     * This will navigate the router.
+     *
+     * @param {string} uri
+     * @param {object} [data]
+     * @param {boolean} [replace]
+     * @returns {object} a reference to the router object.
+     */
+    navigate(uri: string, data?: object, replace?: boolean): object;
+    /**
+     * This will update the data path.
+     * @protected
+     */
+    protected updatePath(): void;
+    /**
+     * This will update the title.
+     *
+     * @protected
+     * @param {object} route
+     */
+    protected updateTitle(route: object): this;
+    /**
+     * This will check the routes to match the path.
+     *
+     * @protected
+     * @param {string} [path]
+     */
+    protected checkActiveRoutes(path?: string): void;
+    /**
+     * This will check the switches to match the path.
+     *
+     * @protected
+     * @param {string} [path]
+     * @returns {void}
+     */
+    protected checkSwitches(path?: string): void;
+    /**
+     * This will check a group to match a path.
+     *
+     * @protected
+     * @param {object} group
+     * @param {string} path
+     * @returns {void}
+     */
+    protected checkGroup(group: object, path: string): void;
+    /**
+     * This will check if a route matches the path.
+     *
+     * @param {object} route
+     * @param {string} path
+     * @returns {boolean}
+     */
+    checkRoute(route: object, path: string): boolean;
+    /**
+     * This will select a route if the route matches the path.
+     *
+     * @param {object} route
+     * @param {string} [path]
+     * @returns {boolean}
+     */
+    check(route: object, path?: string): boolean;
+    /**
+     * This will select the route.
+     *
+     * @param {object} route
+     * @returns {void}
+     */
+    select(route: object): void;
+    /**
+     * This will get the endpoint.
+     *
+     * @returns {string}
+     */
+    getEndPoint(): string;
+    /**
+     * This will remove the router events.
+     *
+     * @returns {void}
+     */
+    destroy(): void;
+    /**
+     * This will get the location pathname.
+     *
+     * @returns {string}
+     */
+    getPath(): string;
+}
+/**
+ * This will create a new router.
+ *
+ * @type {Router}
+ */
+export const router: Router;
+import { Data } from '../data/data.js';

package/dist/types/modules/router/routes/component-helper.d.ts

@@ -0,0 +1,75 @@
+/**
+ * ComponentHelper
+ *
+ * This will create a helper to create and destroy components
+ * that are added to a route.
+ *
+ * @class
+ */
+export class ComponentHelper {
+    /**
+     * This will create a component helper.
+     *
+     * @constructor
+     * @param {object} route
+     * @param {object} settings
+     */
+    constructor(route: object, settings: object);
+    route: any;
+    template: any;
+    component: any;
+    hasTemplate: boolean;
+    setup: boolean;
+    container: any;
+    persist: any;
+    parent: any;
+    /**
+     * This will create the component.
+     *
+     * @param {object} params
+     * @returns {void}
+     */
+    focus(params: object): void;
+    /**
+     * This will setup the template.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected setupTemplate(): void;
+    /**
+     * This will initialize the component.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected initializeComponent(): void;
+    /**
+     * This will initialize the template object.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected initializeTemplateObject(): void;
+    /**
+     * This will create the route component.
+     *
+     * @protected
+     * @returns {void}
+     */
+    protected create(): void;
+    /**
+     * This will remove the component.
+     *
+     * @returns {void}
+     */
+    remove(): void;
+    /**
+     * This will call the component update method and pass the params.
+     *
+     * @protected
+     * @param {object} params
+     * @returns {void}
+     */
+    protected update(params: object): void;
+}

package/dist/types/modules/router/routes/param-pattern.d.ts

@@ -0,0 +1,2 @@
+export function getParamDefaults(params: any[]): (object | null);
+export function paramPattern(uri: string): any[];

package/dist/types/modules/router/routes/route-pattern.d.ts

@@ -0,0 +1 @@
+export function routePattern(uri: string): string;

package/dist/types/modules/router/routes/route.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Route
+ *
+ * This will create a route.
+ *
+ * @class
+ * @augments SimpleData
+ */
+export class Route extends SimpleData {
+    /**
+     * This will create a route.
+     *
+     * @constructor
+     * @param {object} settings
+     * @param {function} titleCallBack
+     */
+    constructor(settings: object, titleCallBack: Function);
+    uri: any;
+    paramKeys: any[];
+    titleCallBack: Function;
+    id: any;
+    uriQuery: RegExp;
+    controller: ComponentHelper;
+    path: string;
+    referralPath: string;
+    params: any;
+    callBack: any;
+    title: any;
+    /**
+     * This will setup the route settings.
+     *
+     * @protected
+     * @param {object} settings
+     * @returns {void}
+     */
+    protected setupRoute(settings: object): void;
+    /**
+     * This will update the route title.
+     *
+     * @param {string|function} title
+     * @returns {void}
+     */
+    setTitle(title: string | Function): void;
+    /**
+     * This will deactivate the route.
+     *
+     * @returns {void}
+     */
+    deactivate(): void;
+    /**
+     * This will get the route layout.
+     *
+     * @param {object} settings
+     * @returns {object|null}
+     */
+    getLayout(settings: object): object | null;
+    /**
+     * This will setup the route layout.
+     *
+     * @protected
+     * @param {object} settings
+     * @returns {void}
+     */
+    protected setupComponentHelper(settings: object): void;
+    /**
+     * This will resume the route.
+     *
+     * @param {object} container
+     * @returns {void}
+     */
+    resume(container: object): void;
+    /**
+     * This will set the route path.
+     *
+     * @param {string} path
+     * @param {string} referralPath
+     * @returns {void}
+     */
+    setPath(path: string, referralPath: string): void;
+    /**
+     * This will select the route.
+     *
+     * @returns {void}
+     */
+    select(): void;
+    /**
+     * This will scroll to the element by id.
+     *
+     * @param {string} hash
+     * @returns {void}
+     */
+    scrollToId(hash: string): void;
+    /**
+     * This will check if a route matches the path.
+     *
+     * @param {string} path
+     * @returns {object|boolean}
+     */
+    match(path: string): object | boolean;
+    /**
+     * This will reset the params.
+     *
+     * @returns {void}
+     */
+    resetParams(): void;
+    /**
+     * This will set the params.
+     *
+     * @param {object} values
+     */
+    setParams(values: object): void;
+    /**
+     * This will get the params.
+     *
+     * @returns {object}
+     */
+    getParams(): object;
+}
+import { SimpleData } from '../../data/data.js';
+import { ComponentHelper } from './component-helper.js';

package/dist/types/modules/router/set-title.d.ts

@@ -0,0 +1 @@
+export function setTitle(route: object, title: any, rootTitle: string): string;

package/dist/types/modules/router/utils.d.ts

@@ -0,0 +1,9 @@
+export namespace Utils {
+    /**
+     * This will remove the begining and ending slashes from a url.
+     *
+     * @param {string} uri
+     * @returns {string}
+     */
+    function removeSlashes(uri: string): string;
+}

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

@@ -0,0 +1,45 @@
+/**
+* StateTarget
+*
+* This will create a state target to track the state
+* of an object.
+*
+* @class
+* @augments SimpleData
+*/
+export class StateTarget extends SimpleData {
+    /**
+     * This will create a state target.
+     *
+     * @constructor
+     * @param {string} id
+     */
+    constructor(id: string);
+    id: string;
+    /**
+     * This will add an action to the target.
+     *
+     * @param {string} action
+     * @param {*} state
+     * @returns {void}
+     */
+    addAction(action: string, state: any): void;
+    /**
+     * This will get the state of an action.
+     *
+     * @param {string} action
+     * @returns {*}
+     */
+    getState(action: string): any;
+    /**
+     * This will remove an action or a callBack
+     * from an action. if no token is passed the
+     * whole action is removed.
+     *
+     * @param {string} action
+     * @param {string} [token]
+     * @returns {void}
+     */
+    removeAction(action: string, token?: string): void;
+}
+import { SimpleData } from '../data/data.js';