@base-framework/base 3.5.49 → 3.5.50

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

@@ -13,13 +13,13 @@ export const base: Base;
  */
 declare class Base {
     /**
-     * @member {array} errors
+     * @type {Array<any>} errors
      */
-    errors: any[];
+    errors: Array<any>;
     /**
-     * @member {object} dataTracker
+     * @type {object} dataTracker
      */
-    dataTracker: typeof DataTracker;
+    dataTracker: object;
     /**
      * this will augement the base framework with new functionality.
      *
@@ -33,10 +33,10 @@ declare class Base {
      * @param {object} obj The object being modified.
      * @param {string} methodName the method name being overriden.
      * @param {function} overrideMethod The new function to call.
-     * @param {array} args The args to pass to the first function call.
+     * @param {Array<any>} args The args to pass to the first function call.
      * @returns {*} The results of the function being called.
      */
-    override(obj: object, methodName: string, overrideMethod: Function, args: any[]): any;
+    override(obj: object, methodName: string, overrideMethod: Function, args: Array<any>): any;
     /**
      * This will get the last error.
      *
@@ -53,23 +53,23 @@ declare class Base {
     /**
      * This will get the value from a property on an object.
      *
-     * @param {object} obj
+     * @param {Record<string, any>} obj
      * @param {string} property
      * @param {*} [defaultText] A value if no value is set.
      * @returns {string}
      */
-    getProperty(obj: object, property: string, defaultText?: any): string;
+    getProperty(obj: Record<string, any>, property: string, defaultText?: any): string;
     /**
      * This will create a callBack.
      *
      * @param {object} obj
      * @param {function} method
-     * @param {array} [argArray] Default args to pass.
+     * @param {Array<any>} [argArray] Default args to pass.
      * @param {boolean} [addArgs] Set to add merge args from the
      * curried function.
      * @returns {function|boolean} The callBack function or false.
      */
-    createCallBack(obj: object, method: Function, argArray?: any[], addArgs?: boolean): Function | boolean;
+    createCallBack(obj: object, method: Function, argArray?: Array<any>, addArgs?: boolean): Function | boolean;
     /**
      * This will bind scope to a method.
      *
@@ -86,5 +86,4 @@ declare class Base {
      */
     extend: Base;
 }
-import { DataTracker } from './data-tracker/data-tracker.js';
 export {};

package/dist/types/main/data-tracker/data-tracker.d.ts

@@ -13,14 +13,14 @@ export class DataTracker {
     /**
      * @private
      * @static
-     * @member {Map} trackers This is an object that stores all tracker
+     * @type {Map} trackers This is an object that stores all tracker
      * objects by tracking id.
      */
     private static trackers;
     /**
      * @private
      * @static
-     * @member {number} trackingCount
+     * @type {number} trackingCount
      */
     private static trackingCount;
     /**

package/dist/types/main/data-tracker/tracker.d.ts

@@ -9,7 +9,7 @@
  */
 export class Tracker {
     /**
-     * @member {Map} types
+     * @type {Map} types
      */
     types: Map<any, any>;
     /**

package/dist/types/main/events/event-methods.d.ts

@@ -79,7 +79,7 @@ export namespace EventMethods {
      * @returns {object}
      */
     export function trigger(event: string | object, obj: object, params?: object): object;
-    export let mouseWheelEventType: any;
+    export let mouseWheelEventType: string | null;
     /**
      * This will get the system mouse event.
      *

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

@@ -3,9 +3,9 @@ export namespace Events {
      * This will get the events on an element.
      *
      * @param {object} obj
-     * @returns {array}
+     * @returns {Array<any>}
      */
-    function getEvents(obj: object): any[];
+    function getEvents(obj: object): Array<any>;
     /**
      * This will create an object to use with the dataTracker.
      *
@@ -14,10 +14,10 @@ export namespace Events {
      * @param {function} fn
      * @param {boolean|object} [capture]
      * @param {boolean} [swapped]
-     * @param {function} [originalFn]
+     * @param {function|null} [originalFn]
      * @returns {object}
      */
-    function create(event: string, obj: object, fn: Function, capture?: boolean | object, swapped?: boolean, originalFn?: Function): object;
+    function create(event: string, obj: object, fn: Function, capture?: boolean | object, swapped?: boolean, originalFn?: Function | null): object;
     /**
      * This will add an event to an object.
      *
@@ -46,10 +46,10 @@ export namespace Events {
      * @param {function} fn
      * @param {object|boolean} [capture]
      * @param {boolean} [swapped]
-     * @param {function} [originalFn]
+     * @param {function|null} [originalFn]
      * @returns {object} The events object.
      */
-    function add(event: string, obj: object, fn: Function, capture?: object | boolean, swapped?: boolean, originalFn?: Function): object;
+    function add(event: string, obj: object, fn: Function, capture?: object | boolean, swapped?: boolean, originalFn?: Function | null): object;
     /**
      * This will remove an event from an object.
      *
@@ -81,10 +81,10 @@ export namespace Events {
      * This will search for an event from the object events.
      *
      * @param {object} eventObj
-     * @param {array} events
+     * @param {Array<any>} events
      * @returns {object|boolean}
      */
-    function search(eventObj: object, events: any[]): object | boolean;
+    function search(eventObj: object, events: Array<any>): object | boolean;
     /**
      * This will remove all events on an object.
      *
@@ -92,7 +92,7 @@ export namespace Events {
      * @returns {object} a reference to the events object.
      */
     function removeEvents(obj: object): object;
-    let swap: string[];
+    let swap: Array<any>;
     /**
      * This will a event type to the swappable array.
      *

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

@@ -21,7 +21,7 @@
  * 	}
  * }
  *
- * @returns {XMLHttpRequest} xhr object.
+ * @returns {XMLHttpRequest|null} xhr object.
  */
 export function Ajax(url: string, params?: string, callBackFn?: Function, responseType?: string, method?: string, async?: boolean): any;
 /**
@@ -47,7 +47,7 @@ export function Ajax(url: string, params?: string, callBackFn?: Function, respon
  * 	}
  * }
  *
- * @returns {XMLHttpRequest} xhr object.
+ * @returns {XMLHttpRequest|null} xhr object.
  */
 export function Ajax(settings: object): any;
 export { XhrRequest };

package/dist/types/modules/ajax/xhr-default-settings.d.ts

@@ -2,16 +2,14 @@ export namespace XhrDefaultSettings {
     let url: string;
     let responseType: string;
     let method: string;
-    let fixedParams: string;
-    let headers: {
-        'Content-Type': string;
-    };
-    let beforeSend: any[];
+    let fixedParams: object | string;
+    let headers: object;
+    let beforeSend: Array<any>;
     let async: boolean;
     let crossDomain: boolean;
     let withCredentials: boolean;
-    let completed: any;
-    let failed: any;
-    let aborted: any;
-    let progress: any;
+    let completed: Function | null;
+    let failed: Function | null;
+    let aborted: Function | null;
+    let progress: Function | null;
 }

package/dist/types/modules/ajax/xhr-request.d.ts

@@ -42,10 +42,10 @@ export class XhrRequest {
      *
      * @protected
      * @param {*} params
-     * @param {*} addingParams
+     * @param {*} [addingParams]
      * @returns {*}
      */
-    protected setupParams(params: any, addingParams: any): any;
+    protected setupParams(params: any, addingParams?: any): any;
     /**
      * This will get the params.
      *
@@ -57,10 +57,10 @@ export class XhrRequest {
      * This will set the settings from the args.
      *
      * @protected
-     * @param {array} args
+     * @param {Array<any>} args
      * @returns {void}
      */
-    protected getXhrSettings(args: any[]): void;
+    protected getXhrSettings(args: Array<any>): void;
     /**
      * This will create the xhr object.
      *

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

@@ -1,6 +1,6 @@
 export namespace animate {
     namespace animating {
-        let objects: any[];
+        let objects: Array<object>;
         /**
          * This will add an animation.
          *
@@ -24,9 +24,9 @@ export namespace animate {
         /**
          * This will check if the element is animating.
          * @param {object} obj
-         * @returns {array}
+         * @returns {Array<any>}
          */
-        function checkAnimating(obj: object): any[];
+        function checkAnimating(obj: object): Array<any>;
         /**
          * This will stop previous animations still animating.
          * @param {object} obj

package/dist/types/modules/animations/animation-controller.d.ts

@@ -10,8 +10,11 @@ export class AnimationController {
     ease: any;
     callBack: any;
     fps: any;
+    /**
+     * @type {Function|null} animationCallBack
+     */
+    animationCallBack: Function | null;
     setup(settings: any): this;
-    animationCallBack: any;
     /**
      * This will setup the animation.
      *

package/dist/types/modules/animations/attr-movement.d.ts

@@ -14,14 +14,6 @@ export class AttrMovement extends Movement {
      */
     constructor(element: object, settings: object);
     filter: any;
-    /**
-     * This will get the value of the element property.
-     *
-     * @param {*} value - The value to get.
-     * @param {*} end - The end value.
-     * @returns {*} The value.
-     */
-    getStartValue(value: any, end: any): any;
     /**
      * This will get the value of the element property.
      *
@@ -29,11 +21,5 @@ export class AttrMovement extends Movement {
      * @returns {*} The value.
      */
     filterValue(value: any, ...args: any[]): any;
-    /**
-     * This will update the value of the element property.
-     *
-     * @param {*} value
-     */
-    update(value: any): void;
 }
 import { Movement } from './movement.js';

package/dist/types/modules/animations/css-movement.d.ts

@@ -1,8 +1,18 @@
 export class CssMovement extends Movement {
+    constructor(element: any, settings: any);
     style: any;
+    getStartValue(value: any, end: any): any;
+    getEndValue(text: any): any;
     getCssValue(text: any): any;
     setMethod(method: any): void;
     method: any;
-    updateValue(delta: any): any[];
+    /**
+     * Updates the value based on the animation delta.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {Array<string>} The updated value as an array of strings
+     */
+    updateValue(delta: number): Array<string>;
+    update(value: any): void;
 }
 import { Movement } from './movement.js';

package/dist/types/modules/animations/movement.d.ts

@@ -1,24 +1,89 @@
+/**
+ * Movement
+ *
+ * This class manages animation movements for DOM elements,
+ * handling property updates and value calculations.
+ *
+ * @class
+ */
 export class Movement {
-    constructor(element: any, settings: any);
-    element: any;
+    /**
+     * Creates a new Movement instance.
+     *
+     * @constructor
+     * @param {HTMLElement} element - The DOM element to animate
+     * @param {object} settings - The movement settings
+     */
+    constructor(element: HTMLElement, settings: object);
+    element: HTMLElement;
     property: any;
+    /**
+     * @type {any}
+     */
     value: any;
-    setup(settings: any): void;
     /**
-     * This will create a value.
+     * Sets up the movement with the given settings.
+     *
+     * @param {object} settings - The movement settings
+     * @returns {void}
+     */
+    setup(settings: object): void;
+    /**
+     * Creates a Value instance for the movement.
      *
-     * @param {object} settings
-     * @returns {object}
+     * @param {object} settings - The settings containing start and end values
+     * @returns {any} A Value instance or array of Value instances
+     */
+    createValue(settings: object): any;
+    /**
+     * Gets the start and end values from settings.
+     *
+     * @param {object} settings - The settings containing startValue and endValue
+     * @returns {object} Object with start and end properties
+     */
+    getValue(settings: object): object;
+    /**
+     * Gets the start value for the animation.
+     *
+     * @param {*} value - The start value
+     * @param {*} end - The end value
+     * @returns {*} The start value
      */
-    createValue(settings: object): object;
-    getValue(settings: any): {
-        start: any;
-        end: any;
-    };
     getStartValue(value: any, end: any): any;
+    /**
+     * Gets the end value for the animation.
+     *
+     * @param {*} text - The end value
+     * @returns {*} The end value
+     */
     getEndValue(text: any): any;
-    setupProperty(settings: any): void;
-    updateValue(delta: any): any;
-    step(delta: any): void;
+    /**
+     * Sets up the property and value for the movement.
+     *
+     * @param {object} settings - The settings containing property and values
+     * @returns {void}
+     */
+    setupProperty(settings: object): void;
+    /**
+     * Updates the value based on the animation delta.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {any} The updated value (string or array of strings)
+     */
+    updateValue(delta: number): any;
+    /**
+     * Performs a step in the animation.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {void}
+     */
+    step(delta: number): void;
+    /**
+     * Updates the element with the new value.
+     * Override this method in subclasses to implement specific update logic.
+     *
+     * @param {*} value - The value to apply
+     * @returns {void}
+     */
     update(value: any): void;
 }

package/dist/types/modules/animations/value.d.ts

@@ -1,30 +1,118 @@
+/**
+ * Value
+ *
+ * This class manages animation values including start, end, units,
+ * and calculations for smooth transitions.
+ *
+ * @class
+ */
 export class Value {
-    constructor(settings: any);
-    value: {
-        combining: boolean;
-        start: number;
-        end: number;
-        units: any;
-        difference: number;
-    };
-    setup(settings: any): void;
-    createValue(settings: any): {
-        combining: boolean;
-        start: number;
-        end: number;
-        units: any;
-        difference: number;
-    };
-    getUnits(text: any): any;
+    /**
+     * Creates a new Value instance.
+     *
+     * @constructor
+     * @param {object} settings - The settings object containing start and end values
+     */
+    constructor(settings: object);
+    value: any;
+    /**
+     * Sets up the value by creating and configuring it.
+     *
+     * @param {object} settings - The settings object containing start and end values
+     * @returns {void}
+     */
+    setup(settings: object): void;
+    /**
+     * Creates a value object with start, end, units, and difference properties.
+     *
+     * @param {object} settings - The settings object containing start and end values
+     * @returns {object} The value object with combining, start, end, units, and difference properties
+     */ createValue(settings: object): object;
+    /**
+     * Extracts the units from a value string (e.g., 'px', 'em', '%').
+     *
+     * @param {*} text - The text to extract units from
+     * @returns {string} The extracted units or empty string
+     */
+    getUnits(text: any): string;
+    /**
+     * Checks if the value should be combined with the current value (+= or -=).
+     *
+     * @param {*} end - The end value to check
+     * @returns {boolean} True if combining, false otherwise
+     */
     checkCombind(end: any): boolean;
-    getString(value: any): any;
+    /**
+     * Converts a value to a string.
+     *
+     * @param {*} value - The value to convert
+     * @returns {string} The string representation of the value
+     */
+    getString(value: any): string;
+    /**
+     * Extracts the numeric value from a string.
+     *
+     * @param {*} text - The text to extract numeric value from
+     * @returns {number} The numeric value or 0
+     */
     getValue(text: any): number;
+    /**
+     * Determines if the animation value is increasing or decreasing.
+     *
+     * @param {*} endValue - The end value to check against
+     * @returns {boolean} True if increasing, false if decreasing
+     */
     isIncreasing(endValue: any): boolean;
-    combindValue(delta: any): number;
-    calcValue(delta: any): number;
-    step(delta: any, ...args: any[]): any;
-    update(delta: any): any;
-    increaseValue(value: any, step: any): any;
-    decreaseValue(value: any, step: any): any;
-    applyStep(value: any, step: any, ...args: any[]): any;
+    /**
+     * Calculates the combined value for += or -= operations.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {number} The calculated combined value
+     */
+    combindValue(delta: number): number;
+    /**
+     * Calculates the value based on the difference between start and end.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {number} The calculated value
+     */
+    calcValue(delta: number): number;
+    /**
+     * Calculates the step value for the current animation frame.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {number} The calculated step value
+     */
+    step(delta: number): number;
+    /**
+     * Updates the value based on the animation delta.
+     *
+     * @param {number} delta - The delta value (0-1) representing animation progress
+     * @returns {string} The updated value with units
+     */
+    update(delta: number): string;
+    /**
+     * Increases a value by the given step.
+     *
+     * @param {object} value - The value object containing start and units
+     * @param {number} step - The step amount to add
+     * @returns {string} The increased value with units
+     */
+    increaseValue(value: object, step: number): string;
+    /**
+     * Decreases a value by the given step.
+     *
+     * @param {object} value - The value object containing start and units
+     * @param {number} step - The step amount to subtract
+     * @returns {string} The decreased value with units
+     */
+    decreaseValue(value: object, step: number): string;
+    /**
+     * Applies the step to the value (increase or decrease).
+     *
+     * @param {object} value - The value object
+     * @param {number} step - The step amount
+     * @returns {string} The updated value with units
+     */
+    applyStep(value: object, step: number): string;
 }

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

@@ -9,5 +9,5 @@
  */
 export class CloakComponent extends Component {
 }
-export function Cloak(props: any): typeof CloakComponent;
+export function Cloak(props: any): typeof Component | null;
 import { Component } from "./component.js";

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

@@ -30,9 +30,9 @@ export class Component extends Unit {
      */
     stateResumed: boolean;
     /**
-     * @member {string} [stateTargetId] // optional override of state id
+     * @type {string|null} stateTargetId // optional override of state id
      */
-    stateTargetId: any;
+    stateTargetId: string | null;
     /**
      * This will set the data.
      *
@@ -49,18 +49,17 @@ export class Component extends Unit {
     /**
      *  This will resume the component scope when persisting.
      *
-     * @param {object} persistedLayout
+     * @param {{data: any, state: any, stateHelper: any, persistedChildren: any, id: string}} persistedLayout
      * @returns {void}
      */
-    resumeScope(persistedLayout: object): void;
+    resumeScope(persistedLayout: {
+        data: any;
+        state: any;
+        stateHelper: any;
+        persistedChildren: any;
+        id: string;
+    }): void;
     stateHelper: any;
-    /**
-     * This will initialize the component.
-     *
-     * @protected
-     * @returns {object}
-     */
-    protected initialize(): object;
     /**
      * This will setup the state target.
      *
@@ -131,7 +130,7 @@ export class Component extends Unit {
      * This will setup the events.
      *
      * @protected
-     * @returns {array}
+     * @returns {Array<Array<any>>}
      *
      * @example
      * return [
@@ -139,7 +138,7 @@ export class Component extends Unit {
      * 	['click', this.element, function(e){}, false]
      * ];
      */
-    protected setupEvents(): any[];
+    protected setupEvents(): Array<Array<any>>;
     /**
      * This will add the events.
      *

package/dist/types/modules/component/event-helper.d.ts

@@ -8,16 +8,16 @@
  */
 export class EventHelper {
     /**
-     * @member {Array<object>} events
+     * @type {Array<object>} events
      */
-    events: any[];
+    events: Array<object>;
     /**
      * This will add an array of events.
      *
-     * @param {Array<Array>} events
+     * @param {Array<Array<any>>} events
      * @returns {void}
      */
-    addEvents(events: Array<any[]>): void;
+    addEvents(events: Array<Array<any>>): void;
     /**
      * This will add an event.
      *

package/dist/types/modules/component/parse-args.d.ts

@@ -1 +1 @@
-export function parseArgs(args: any[]): object;
+export function parseArgs(args: Array<any>): object;

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

@@ -1,2 +1,2 @@
-export function Pod(callBack: Function, extend?: typeof Component): typeof Component;
+export function Pod(callBack: Function, extend?: typeof Component): typeof Component | null;
 import { Component } from './component.js';

package/dist/types/modules/component/prop-utils.d.ts

@@ -1,4 +1,4 @@
 export function DefaultProps(): object;
 export function StringProp(value: string): object;
-export function ArrayProp(value: any[]): object;
-export function ObjectProp(args: any[]): object;
+export function ArrayProp(value: Array<any>): object;
+export function ObjectProp(args: Array<any>): object;