@base-framework/base 3.7.52 → 3.7.53

package/dist/types/main/base.d.ts

@@ -24,9 +24,9 @@ declare class Base {
      * this will augement the base framework with new functionality.
      *
      * @param {object} methods The new methods to add.
-     * @returns {object} An instance of base.
+     * @returns {this}
      */
-    augment(methods: object): object;
+    augment(methods: object): this;
     /**
      * This will override a method function with a new function.
      *

package/dist/types/modules/component/cloak.d.ts

@@ -8,6 +8,12 @@
  * @type {typeof Component}
  */
 export class CloakComponent extends Component {
+    /**
+     * This will get the child scope instance of the component.
+     *
+     * @returns {object}
+     */
+    getChildScope(): object;
 }
 export function Cloak(props: any): typeof Component;
 import { Component } from "./component.js";

package/dist/types/modules/component/unit.d.ts

@@ -65,6 +65,10 @@ export class Unit {
      * @type {?string} _classId
      */
     _classId: string | null;
+    /**
+     * @type {string} id
+     */
+    id: string;
     /**
      * @type {Array<any>} cached
      */
@@ -91,7 +95,6 @@ export class Unit {
      * @returns {void}
      */
     protected init(): void;
-    id: string;
     /**
      * This will declare the component props.
      *
@@ -125,9 +128,9 @@ export class Unit {
      * If the component is transparent, children see through
      * to the parent scope instead.
      *
-     * @returns {object}
+     * @returns {this}
      */
-    getChildScope(): object;
+    getChildScope(): this;
     /**
      * This will get the parent context.
      *

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

@@ -66,9 +66,9 @@ export class BasicData {
      * Use this when accumulated state (filters, selections,
      * loaded content) should survive across route navigations.
      *
-     * @returns {object} this (for chaining)
+     * @returns {this}
      */
-    retainState(): object;
+    retainState(): this;
     /**
      * This will setup the data object.
      *
@@ -176,7 +176,7 @@ export class BasicData {
      *
      * @overload
      * @param {object} data
-     * @returns {object} this
+     * @returns {this}
      */
     set(key: string, value: any, committer?: object): any;
     /**
@@ -189,9 +189,9 @@ export class BasicData {
      *
      * @overload
      * @param {object} data
-     * @returns {object} this
+     * @returns {this}
      */
-    set(data: object): object;
+    set(data: object): this;
     /**
      * This will get the model data.
      *
@@ -213,55 +213,55 @@ export class BasicData {
      * This will toggle a bool attribute.
      *
      * @param {string} attr
-     * @returns {object} this
+     * @returns {this}
      */
-    toggle(attr: string): object;
+    toggle(attr: string): this;
     /**
      * This will increment an attribute.
      *
      * @param {string} attr
      * @param {number|null} value
-     * @returns {object} this
+     * @returns {this}
      */
-    increment(attr: string, value?: number | null): object;
+    increment(attr: string, value?: number | null): this;
     /**
      * This will decrement an attribute.
      *
      * @param {string} attr
      * @param {number|null} value
-     * @returns {object} this
+     * @returns {this}
      */
-    decrement(attr: string, value?: number | null): object;
+    decrement(attr: string, value?: number | null): this;
     /**
      * This will concat an attribute.
      *
      * @param {string} attr
-     * @returns {object} this
+     * @returns {this}
      */
-    concat(attr: string, value: any): object;
+    concat(attr: string, value: any): this;
     /**
      * This will set the key value if it is null.
      *
      * @param {string} key
      * @param {*} value
-     * @returns {object} this
+     * @returns {this}
      */
-    ifNull(key: string, value: any): object;
+    ifNull(key: string, value: any): this;
     /**
      * This will set the data local storage key.
      *
      * @param {string} key
-     * @returns {object} this
+     * @returns {this}
      */
-    setKey(key: string): object;
+    setKey(key: string): this;
     key: string;
     /**
      * This will restore the data from local storage.
      *
      * @param {*} defaultValue
-     * @returns {object} this
+     * @returns {this}
      */
-    resume(defaultValue: any): object;
+    resume(defaultValue: any): this;
     /**
      * This will store the data to the local stoage under
      * the storage key.
@@ -273,9 +273,9 @@ export class BasicData {
      * This will delete a property value or the model data.
      *
      * @param {object|string|null} [attrName]
-     * @returns {object} this
+     * @returns {this}
      */
-    delete(attrName?: object | string | null): object;
+    delete(attrName?: object | string | null): this;
     /**
      * This will get the value of an attribute.
      *

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

@@ -44,33 +44,33 @@ export class Data extends BasicData {
      *
      * @param {string} attr
      * @param {number} index
-     * @returns {object} this
+     * @returns {this}
      */
-    splice(attr: string, index: number): object;
+    splice(attr: string, index: number): this;
     /**
      * This will add a value to an array and set the result.
      *
      * @param {string} attr
      * @param {*} value
-     * @returns {object} this
+     * @returns {this}
      */
-    push(attr: string, value: any): object;
+    push(attr: string, value: any): this;
     /**
      * This will concatenate values to an array and set the result.
      *
      * @param {string} attr
      * @param {Array<any>} values
-     * @returns {object} this
+     * @returns {this}
      */
-    concat(attr: string, values: Array<any>): object;
+    concat(attr: string, values: Array<any>): this;
     /**
      * This will add a value to an array and set the result.
      *
      * @param {string} attr
      * @param {*} value
-     * @returns {object} this
+     * @returns {this}
      */
-    unshift(attr: string, value: any): object;
+    unshift(attr: string, value: any): this;
     /**
      * This will add a value to an array and set the result.
      *
@@ -98,9 +98,9 @@ export class Data extends BasicData {
      * This will refresh the value.
      *
      * @param {string} attr
-     * @returns {object} this
+     * @returns {this}
      */
-    refresh(attr: string): object;
+    refresh(attr: string): this;
     _pubCommitter: any;
     _pubEvent: string;
     _publishCb: (path: any, obj: any) => void;

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

@@ -47,15 +47,15 @@ export class TwoWayConnection extends Connection {
      * This will unsubscribe from a source.
      *
      * @param {object} source
-     * @returns {object}
+     * @returns {this}
      */
-    unsubscribeSource(source: object): object;
+    unsubscribeSource(source: object): this;
     /**
      * This will be used to unsubscribe.
      *
      * @override
-     * @returns {object}
+     * @returns {this}
      */
-    override unsubscribe(): object;
+    override unsubscribe(): this;
 }
 import { Connection } from './connection.js';

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

@@ -48,9 +48,9 @@ export class DataBinder {
      * @param {object} data
      * @param {string} prop
      * @param {string|function} filter
-     * @returns {object} an instance of the databinder.
+     * @returns {this} an instance of the databinder.
      */
-    bind(element: object, data: object, prop: string, filter: string | Function): object;
+    bind(element: object, data: object, prop: string, filter: string | Function): this;
     /**
      * This will bind an element to a data property.
      *
@@ -71,9 +71,9 @@ export class DataBinder {
      * @param {string} id
      * @param {string} attr
      * @param {object} connection
-     * @returns {object}
+     * @returns {this}
      */
-    protected addConnection(id: string, attr: string, connection: object): object;
+    protected addConnection(id: string, attr: string, connection: object): this;
     /**
      * This will set the bind id.
      *
@@ -94,9 +94,9 @@ export class DataBinder {
      * This will unbind the element.
      *
      * @param {object} element
-     * @returns {object} an instance of the data binder.
+     * @returns {this} an instance of the data binder.
      */
-    unbind(element: object): object;
+    unbind(element: object): this;
     /**
      * This will setup a watcher for an element.
      *
@@ -104,27 +104,27 @@ export class DataBinder {
      * @param {object} data
      * @param {string} prop
      * @param {function} callBack
-     * @returns {object}
+     * @returns {this}
      */
-    watch(element: object, data: object, prop: string, callBack: Function): object;
+    watch(element: object, data: object, prop: string, callBack: Function): this;
     /**
      * This will remove a watcher from an element.
      *
      * @param {object} element
      * @param {object} data
      * @param {string} prop
-     * @returns {object}
+     * @returns {this}
      */
-    unwatch(element: object, data: object, prop: string): object;
+    unwatch(element: object, data: object, prop: string): this;
     /**
      * This will publish to the pub sub.
      *
      * @param {string} msg
      * @param {*} value
      * @param {object} committer
-     * @returns {object} an instance of the data binder.
+     * @returns {this} an instance of the data binder.
      */
-    publish(msg: string, value: any, committer: object): object;
+    publish(msg: string, value: any, committer: object): this;
     /**
      * This will check if an element is bound.
      *

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

@@ -37,7 +37,7 @@ export class ElementSource extends TwoWaySource {
      * @private
      * @param {object} element
      * @param {string} attr
-     * @returns {object}
+     * @returns {this}
      */
     private addSetMethod;
     setValue: ((element: object, attr: string, value: any) => void) | ((element: object, attr: string, value: any) => void) | ((element: object, attr: string, value: any) => void) | ((element: object, attr: string, value: any) => void);
@@ -62,9 +62,9 @@ export class ElementSource extends TwoWaySource {
      * This will set a value on an element.
      *
      * @param {*} value
-     * @returns {object}
+     * @returns {this}
      */
-    set(value: any): object;
+    set(value: any): this;
     /**
      * This will get the value from an element.
      *
@@ -77,8 +77,8 @@ export class ElementSource extends TwoWaySource {
      * @overload
      * @param {*} value
      * @param {object} committer
-     * @returns {object}
+     * @returns {this}
      */
-    callBack(value: any, committer: object): object;
+    callBack(value: any, committer: object): this;
 }
 import { TwoWaySource } from './two-way-source.js';

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

@@ -6,13 +6,19 @@
  * @class
  */
 export class BrowserHistory extends History {
+    /**
+     * This will add the events.
+     *
+     * @returns {this} a reference to the object.
+     */
+    addEvent(): this;
     pageShowCallBack: any;
     /**
      * This will remove the events.
      *
-     * @returns {object} a reference to the object.
+     * @returns {this} a reference to the object.
      */
-    removeEvent(): object;
+    removeEvent(): this;
     /**
      * Handles the pageshow event for bfcache restoration.
      *
@@ -40,8 +46,8 @@ export class BrowserHistory extends History {
      * @param {string} uri
      * @param {object|null} data
      * @param {boolean} replace
-     * @returns {object} a reference to the object.
+     * @returns {this} a reference to the object.
      */
-    addState(uri: string, data: object | null, replace?: boolean): object;
+    addState(uri: string, data: object | null, replace?: boolean): this;
 }
 import { History } from "./history.js";

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

@@ -6,12 +6,18 @@
  * @class
  */
 export class HashHistory extends History {
+    /**
+     * This will add the events.
+     *
+     * @returns {this} a reference to the object.
+     */
+    addEvent(): this;
     /**
      * This will remove the events.
      *
-     * @returns {object} a reference to the object.
+     * @returns {this} a reference to the object.
      */
-    removeEvent(): object;
+    removeEvent(): this;
     /**
      * This will check to activate the router.
      *
@@ -24,8 +30,8 @@ export class HashHistory extends History {
      * @param {string} uri
      * @param {object} data
      * @param {boolean} replace
-     * @returns {object} a reference to the object.
+     * @returns {this} a reference to the object.
      */
-    addState(uri: string, data: object, replace: boolean): object;
+    addState(uri: string, data: object, replace: boolean): this;
 }
 import { History } from "./history.js";

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

@@ -150,17 +150,17 @@ export class Router {
      * This will remove a route by uri.
      *
      * @param {string} uri
-     * @returns {object} a reference to the router object.
+     * @returns {this} a reference to the router object.
      */
-    remove(uri: string): object;
+    remove(uri: string): this;
     /**
      * This will setup the router.
      *
      * @param {string} [baseURI]
      * @param {string} [title]
-     * @returns {object} a reference to the router object.
+     * @returns {this} a reference to the router object.
      */
-    setup(baseURI?: string, title?: string): object;
+    setup(baseURI?: string, title?: string): this;
     /**
      * Update the base tag href to the base URI for correct relative URL resolution.
      *
@@ -185,24 +185,24 @@ export class Router {
     /**
      * This will reset the router.
      *
-     * @returns {object} a reference to the router object.
+     * @returns {this} a reference to the router object.
      */
-    reset(): object;
+    reset(): this;
     /**
      * This will check the active routes.
      *
-     * @returns {object} a reference to the router object.
+     * @returns {this} a reference to the router object.
      */
-    activate(): object;
+    activate(): this;
     /**
      * This will navigate the router.
      *
      * @param {string} uri
      * @param {object|null} [data]
      * @param {boolean} [replace]
-     * @returns {object} a reference to the router object.
+     * @returns {this} a reference to the router object.
      */
-    navigate(uri: string, data?: object | null, replace?: boolean): object;
+    navigate(uri: string, data?: object | null, replace?: boolean): this;
     /**
      * This will update the data path.
      * @protected
@@ -213,6 +213,7 @@ export class Router {
      *
      * @protected
      * @param {object} route
+     * @returns {this} a reference to the router object.
      */
     protected updateTitle(route: object): this;
     /**

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

@@ -78,7 +78,7 @@ export class Route extends BasicData {
      * @param {object} container
      * @returns {void}
      */
-    resume(container: object): void;
+    resumeRoute(container: object): void;
     /**
      * This will set the route path.
      *

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

@@ -13,9 +13,9 @@ export class State extends SimpleData {
      *
      * @param {string} action
      * @param {*} state
-     * @returns {object} self
+     * @returns {this}
      */
-    addAction(action: string, state: any): object;
+    addAction(action: string, state: any): this;
     /**
      * This will get the state of an action.
      *
@@ -30,8 +30,8 @@ export class State extends SimpleData {
      *
      * @param {string} action
      * @param {string} [token]
-     * @returns {object} self
+     * @returns {this}
      */
-    removeAction(action: string, token?: string): object;
+    removeAction(action: string, token?: string): this;
 }
 import { SimpleData } from '../data/data.js';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@base-framework/base",
-	"version": "3.7.52",
+	"version": "3.7.53",
 	"description": "This is a javascript framework.",
 	"main": "./dist/base.js",
 	"type": "module",