vevet 3.20.0 → 4.0.0-beta.0

package/lib/types/Vevet/global.d.ts

@@ -0,0 +1,51 @@
+import { IOnPageLoad } from './events/createOnPageLoad/types';
+import { IViewport } from './events/createViewport/types';
+import { IVevetProps } from './types';
+import { PCancelable } from '../utils/common/PCancelable';
+/** Vevet Application */
+export interface IVevet {
+    /** Current Vevet version */
+    version: string;
+    /** Appliction properties */
+    props: IVevetProps;
+    /** Prefix used by Vevet for class names. */
+    prefix: string;
+    /** Is phone device */
+    isPhone: boolean;
+    /** Is tablet device */
+    isTablet: boolean;
+    /** Is desktop device */
+    isDesktop: boolean;
+    /** Is mobile device */
+    isMobile: boolean;
+    /** OS name */
+    osName: string;
+    /** Browser name */
+    browserName: string;
+    /** If WebP is supported in the browser */
+    isWebpSupported: boolean;
+    /** Page load handler */
+    pageLoad: IOnPageLoad;
+    /** If the page is loaded */
+    isPageLoaded: boolean;
+    /** Viewport handler */
+    viewport: IViewport;
+    /** Document */
+    doc: Document;
+    /** HTML element */
+    html: HTMLElement;
+    /** Body element */
+    body: HTMLElement;
+    /**
+     * Add an event on page load
+     *
+     * @example
+     * const promise = vevet.onPageLoad();
+     *
+     * promise
+     *   .then(() => console.log('Page loaded'))
+     *   .catch(() => console.log('Error'));
+     */
+    onPageLoad: () => PCancelable<void>;
+}
+//# sourceMappingURL=global.d.ts.map

package/lib/types/Vevet/global.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"global.d.ts","sourceRoot":"","sources":["../../../src/Vevet/global.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AACtC,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,wBAAwB;AACxB,MAAM,WAAW,MAAM;IACrB,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,4BAA4B;IAC5B,KAAK,EAAE,WAAW,CAAC;IACnB,4CAA4C;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,sBAAsB;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,uBAAuB;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,wBAAwB;IACxB,SAAS,EAAE,OAAO,CAAC;IACnB,uBAAuB;IACvB,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc;IACd,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,WAAW,EAAE,MAAM,CAAC;IACpB,0CAA0C;IAC1C,eAAe,EAAE,OAAO,CAAC;IACzB,wBAAwB;IACxB,QAAQ,EAAE,WAAW,CAAC;IACtB,4BAA4B;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,uBAAuB;IACvB,QAAQ,EAAE,SAAS,CAAC;IACpB,eAAe;IACf,GAAG,EAAE,QAAQ,CAAC;IACd,mBAAmB;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB,mBAAmB;IACnB,IAAI,EAAE,WAAW,CAAC;IAClB;;;;;;;;;OASG;IACH,UAAU,EAAE,MAAM,WAAW,CAAC,IAAI,CAAC,CAAC;CACrC"}

package/lib/types/Vevet/index.d.ts

@@ -0,0 +1,4 @@
+import { IVevetProps } from './types';
+import { IVevet } from './global';
+export declare function Vevet(input: Partial<IVevetProps>): IVevet;
+//# sourceMappingURL=index.d.ts.map

package/lib/types/Vevet/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/Vevet/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAItC,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,wBAAgB,KAAK,CAAC,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,GAAG,MAAM,CAwFzD"}

package/lib/types/Vevet/types.d.ts

@@ -0,0 +1,43 @@
+import { TEasingType } from '../utils/math';
+/**
+ * Application configuration properties for initializing Vevet.
+ */
+export interface IVevetProps {
+    /**
+     * Tablet identification max width in pixels.
+     * When changing this property, you need to
+     * update SASS variables: `$viewport-tablet`. The values must be equal.
+     * @default 1199
+     */
+    tablet: number;
+    /**
+     * Phone identification max width in pixels.
+     * When changing this property, you need to
+     * update SASS variables: `$viewport-phone`. The values must be equal.
+     * @default 899
+     */
+    phone: number;
+    /**
+     * Timeout (in ms) for viewport callbacks debouncing.
+     * @default 16
+     */
+    resizeDebounce: number;
+    /**
+     * Default easing function used in animations.
+     * Accepts a cubic-bezier array, function or an easing name defined {@link https://antonbobrov.github.io/easing-progress/|here}.
+     * @default [.25, .1, .25, 1]
+     */
+    easing: TEasingType;
+    /**
+     * Enable or disable WebP support check in the browser.
+     * @default false
+     */
+    checkWebpSupport: boolean;
+    /**
+     * Method for detecting the viewport width.
+     * Can be 'boundingRect' or 'clientWidth'.
+     * @default 'boundingRect'
+     */
+    widthDetection: 'boundingRect' | 'clientWidth';
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/types/Vevet/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/Vevet/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAE3C;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;;OAKG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;OAKG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;;OAGG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAE1B;;;;OAIG;IACH,cAAc,EAAE,cAAc,GAAG,aAAa,CAAC;CAChD"}

package/lib/types/Vevet/utils/fetchWebpSupport.d.ts

@@ -0,0 +1,3 @@
+import { PCancelable } from '../../utils/common/PCancelable';
+export declare function fetchWebpSupport(): PCancelable<unknown>;
+//# sourceMappingURL=fetchWebpSupport.d.ts.map

package/lib/types/Vevet/utils/fetchWebpSupport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchWebpSupport.d.ts","sourceRoot":"","sources":["../../../../src/Vevet/utils/fetchWebpSupport.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAEzD,wBAAgB,gBAAgB,yBAiB/B"}

package/lib/types/Vevet/utils/getDeviceInfo.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getDeviceInfo.d.ts","sourceRoot":"","sources":["../../../../src/Vevet/utils/getDeviceInfo.ts"],"names":[],"mappings":"AAGA,wBAAgB,aAAa;;;;EAa5B"}

package/lib/types/base/Callbacks/index.d.ts

@@ -1,14 +1,22 @@
 import { NCallbacks } from './types';
 export type { NCallbacks };
 /**
- * This class is responsible for adding, removing, and executing callbacks of different kinds.
+ * Manages the registration and execution of callbacks for specific event types.
+ * Supports adding, removing, and triggering callbacks, with optional features such as protected callbacks,
+ * one-time execution, and execution delays.
  */
 export declare class Callbacks<Types extends NCallbacks.ITypes = NCallbacks.ITypes> {
-    /** List of callbacks */
+    /**
+     * Internal storage for registered callbacks.
+     */
     private _callbacks;
-    /** List of callbacks */
+    /**
+     * Returns an array of currently registered callbacks.
+     */
     get callbacks(): NCallbacks.ICallback<Types>[];
     /**
+     * Initializes a new `Callbacks` instance with an empty list of callbacks.
+     *
      * @example
      *
      * interface ICallbacks {
@@ -18,65 +26,78 @@ export declare class Callbacks<Types extends NCallbacks.ITypes = NCallbacks.ITyp
      *
      * const callbacks = new Callbacks<ICallbacks>();
      *
-     * callbacks.add('onAdd', () => console.log('callback on add #1'));
-     *
-     * const addCallback2 = callbacks.add('onAdd', () =>
-     *   console.log('callback on add #2'),
-     * );
-     *
-     * const addCallback3 = callbacks.add(
-     *   'onAdd',
-     *   () => console.log('callback on add #3'),
-     *   { isProtected: true },
-     * );
-     *
-     * callbacks.add('onDelete', () => console.log('callback on delete'));
+     * callbacks.add('onAdd', () => console.log('Callback for add'));
+     * callbacks.add('onDelete', () => console.log('Callback for delete'));
      *
-     * console.log('--- All callbacks by the target "onAdd" will be executed:');
-     * callbacks.tbt('onAdd', undefined);
+     * callbacks.tbt('onAdd', undefined); // Trigger all "onAdd" callbacks
+     * callbacks.tbt('onDelete', undefined); // Trigger all "onDelete" callbacks
+     */
+    constructor();
+    /**
+     * Registers a new callback for a specific target event.
      *
-     * console.log('--- addCallback2 will be removed:');
-     * addCallback2.remove();
-     * callbacks.tbt('onAdd', undefined);
-     * console.log('---');
+     * @param target - The event name or target to associate the callback with.
+     * @param action - The function to be executed when the event is triggered.
+     * @param [settings={}] - Additional settings, such as whether the callback is protected or should execute only once.
      *
-     * console.log('--- addCallback3 cannot be removed because it is protected:');
-     * addCallback3.remove();
-     * callbacks.tbt('onAdd', undefined);
-     * console.log('---');
+     * @example
+     * const callback = callbacks.add('onAdd', () => console.log('Callback added'));
+     * callback.remove(); // Removes this specific callback
+     */
+    add<T extends keyof Types>(target: T, action: NCallbacks.TAction<Types[T]>, settings?: NCallbacks.ISettings): NCallbacks.IAddedCallback;
+    /**
+     * Removes a callback by its unique ID.
      *
-     * console.log('--- Execute all callbacks by the target "onDelete":');
-     * callbacks.tbt('onDelete', undefined);
+     * @param id - The unique identifier of the callback to remove.
+     * @returns {boolean} `true` if the callback was successfully removed; `false` otherwise.
      */
-    constructor();
+    remove(id: string): boolean;
     /**
-     * Adds a callback
+     * Removes a callback from the list, with an option to force removal even if it's protected.
      *
-     * @param target - Callback target name
-     * @param action - Callback function
-     * @param settings - Callback settings
+     * @param callbackId - The unique identifier of the callback to remove.
+     * @param canRemoveProtected - If `true`, will forcibly remove protected callbacks.
+     * @returns {boolean} `true` if the callback was successfully removed; `false` otherwise.
      */
-    add<T extends keyof Types>(target: T, action: NCallbacks.TAction<Types[T]>, settings?: NCallbacks.ISettings): NCallbacks.IAddedCallback;
-    /** Remove a callback */
-    remove(callbackId: string): boolean;
-    /** Remove a callback */
     private _remove;
-    /** Remove all callbacks */
+    /**
+     * Removes all registered callbacks, including protected ones.
+     */
     private _removeAll;
-    /** Enable/disable a callback */
-    turn(id: string, isEnabled?: boolean): void;
-    /** Get a callback by id */
-    get(callbackId: string): undefined | NCallbacks.ICallback<Types>;
     /**
-     * Launch callback action. It will work only if the callback is enabled
+     * Enables or disables a callback by its ID.
+     *
+     * @param id - The unique identifier of the callback.
+     * @param isEnabled - Set to `false` to disable the callback; `true` to enable it.
+     */
+    turn(id: string, isEnabled: boolean): void;
+    /**
+     * Retrieves a callback by its ID.
+     *
+     * @param callbackId - The unique identifier of the callback.
+     * @returns The matching callback, or `undefined` if not found.
+     */
+    get(callbackId: string): NCallbacks.ICallback<Types> | undefined;
+    /**
+     * Executes the action of a callback if it is enabled, optionally removing it if it's set to execute only once.
+     *
+     * @param callback - The callback to execute.
+     * @param parameter - The parameter to pass to the callback function.
      */
     private _callAction;
     /**
-     * Trigger by target.
-     * Trigger all enabled callbacks under a certain target name.
+     * Triggers all callbacks associated with the specified target.
+     *
+     * @param target - The target event name for which callbacks should be executed.
+     * @param arg - The argument to pass to each callback.
+     *
+     * @example
+     * callbacks.tbt('onAdd', undefined); // Trigger all "onAdd" callbacks
      */
     tbt<T extends keyof Types>(target: T, arg: Types[T]): void;
-    /** Destroy the callbacks */
+    /**
+     * Removes all registered callbacks and cleans up internal data.
+     */
     destroy(): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/base/Callbacks/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Callbacks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;GAEG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM;IACxE,wBAAwB;IACxB,OAAO,CAAC,UAAU,CAAgC;IAElD,wBAAwB;IACxB,IAAI,SAAS,kCAEZ;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;;IAKH;;;;;;OAMG;IACI,GAAG,CAAC,CAAC,SAAS,MAAM,KAAK,EAC9B,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpC,QAAQ,GAAE,UAAU,CAAC,SAAc,GAClC,UAAU,CAAC,cAAc;IAiB5B,wBAAwB;IACjB,MAAM,CAAC,UAAU,EAAE,MAAM;IAIhC,wBAAwB;IACxB,OAAO,CAAC,OAAO;IAoBf,2BAA2B;IAC3B,OAAO,CAAC,UAAU;IAMlB,gCAAgC;IACzB,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,UAAO;IAUxC,2BAA2B;IACpB,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC;IAMvE;;OAEG;IACH,OAAO,CAAC,WAAW;IAenB;;;OAGG;IACI,GAAG,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAQ1D,4BAA4B;IACrB,OAAO;CAGf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Callbacks/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;;;GAIG;AACH,qBAAa,SAAS,CAAC,KAAK,SAAS,UAAU,CAAC,MAAM,GAAG,UAAU,CAAC,MAAM;IACxE;;OAEG;IACH,OAAO,CAAC,UAAU,CAAgC;IAElD;;OAEG;IACH,IAAI,SAAS,kCAEZ;IAED;;;;;;;;;;;;;;;;;OAiBG;;IAKH;;;;;;;;;;OAUG;IACI,GAAG,CAAC,CAAC,SAAS,MAAM,KAAK,EAC9B,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACpC,QAAQ,GAAE,UAAU,CAAC,SAAc,GAClC,UAAU,CAAC,cAAc;IAiB5B;;;;;OAKG;IACI,MAAM,CAAC,EAAE,EAAE,MAAM;IAIxB;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAoBf;;OAEG;IACH,OAAO,CAAC,UAAU;IAMlB;;;;;OAKG;IACI,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAU1C;;;;;OAKG;IACI,GAAG,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS;IAIvE;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAenB;;;;;;;;OAQG;IACI,GAAG,CAAC,CAAC,SAAS,MAAM,KAAK,EAAE,MAAM,EAAE,CAAC,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC;IAQ1D;;OAEG;IACI,OAAO;CAGf"}

package/lib/types/base/Callbacks/types.d.ts

@@ -1,40 +1,72 @@
 import { IRemovable } from '../../types/general';
 export declare namespace NCallbacks {
-    /** Callbacks types */
+    /**
+     * Represents a mapping of event types to their callback parameter types.
+     * Each key in this interface corresponds to an event name, and its value
+     * represents the type of argument passed to that event's callback.
+     */
     interface ITypes {
     }
-    /** Callback settings */
+    /**
+     * Settings that can be applied to a callback, such as timeout, protection status, and one-time execution.
+     */
     interface ISettings {
-        /** Callback name */
+        /**
+         * The name of the callback.
+         */
         name?: string | undefined;
-        /**  Callback timeout (in ms) */
+        /**
+         * The timeout (in milliseconds) before the callback is executed.
+         * A value of `undefined` means no timeout.
+         */
         timeout?: number | undefined;
-        /** If true, the callback can't be removed */
+        /**
+         * If `true`, the callback is protected and cannot be removed by standard removal methods.
+         */
         isProtected?: boolean | undefined;
-        /** If true, the callback is to be removed after it is called */
+        /**
+         * If `true`, the callback will automatically be removed after it is called once.
+         */
         isOnce?: boolean | undefined;
     }
     /**
-     * Callback action
+     * Defines the function signature for a callback action.
+     * - If the parameter type is `undefined`, the callback takes no arguments.
+     * - Otherwise, the callback takes a single argument of the specified parameter type.
      */
     type TAction<Parameter> = Parameter extends undefined ? () => void : (arg: Parameter) => void;
     /**
-     * Callback full data
+     * Full data for a registered callback, including its settings and unique information such as ID and target.
      */
     interface ICallback<Types> extends ISettings {
-        /** Callback ID */
+        /**
+         * The unique identifier of the callback.
+         */
         id: string;
-        /** Defines if the callback is enabled */
+        /**
+         * Indicates whether the callback is enabled. If `false`, the callback will not be executed.
+         */
         isEnabled: boolean;
-        /** Callback target */
+        /**
+         * The target event or event name for which the callback is registered.
+         */
         target: keyof Types;
-        /** Callback itself */
+        /**
+         * The actual callback function to be executed.
+         */
         action: TAction<Types[keyof Types]>;
     }
+    /**
+     * An interface representing an added callback, with methods to manage it.
+     */
     interface IAddedCallback extends IRemovable {
-        /** Callback ID */
+        /**
+         * The unique identifier of the callback.
+         */
         id: string;
-        /** Remove the callback */
+        /**
+         * Removes the callback from the registered list.
+         */
         remove: () => void;
     }
 }

package/lib/types/base/Callbacks/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Callbacks/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,yBAAiB,UAAU,CAAC;IAC1B,sBAAsB;IACtB,UAAiB,MAAM;KAAG;IAE1B,wBAAwB;IACxB,UAAiB,SAAS;QACxB,oBAAoB;QACpB,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC1B,gCAAgC;QAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,6CAA6C;QAC7C,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAClC,gEAAgE;QAChE,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B;IAED;;OAEG;IACH,KAAY,OAAO,CAAC,SAAS,IAAI,SAAS,SAAS,SAAS,GACxD,MAAM,IAAI,GACV,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;IAE7B;;OAEG;IACH,UAAiB,SAAS,CAAC,KAAK,CAAE,SAAQ,SAAS;QACjD,kBAAkB;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,yCAAyC;QACzC,SAAS,EAAE,OAAO,CAAC;QACnB,sBAAsB;QACtB,MAAM,EAAE,MAAM,KAAK,CAAC;QACpB,sBAAsB;QACtB,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;KACrC;IAED,UAAiB,cAAe,SAAQ,UAAU;QAChD,kBAAkB;QAClB,EAAE,EAAE,MAAM,CAAC;QACX,0BAA0B;QAC1B,MAAM,EAAE,MAAM,IAAI,CAAC;KACpB;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Callbacks/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAE7C,yBAAiB,UAAU,CAAC;IAC1B;;;;OAIG;IACH,UAAiB,MAAM;KAAG;IAE1B;;OAEG;IACH,UAAiB,SAAS;QACxB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAE1B;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAE7B;;WAEG;QACH,WAAW,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;QAElC;;WAEG;QACH,MAAM,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;KAC9B;IAED;;;;OAIG;IACH,KAAY,OAAO,CAAC,SAAS,IAAI,SAAS,SAAS,SAAS,GACxD,MAAM,IAAI,GACV,CAAC,GAAG,EAAE,SAAS,KAAK,IAAI,CAAC;IAE7B;;OAEG;IACH,UAAiB,SAAS,CAAC,KAAK,CAAE,SAAQ,SAAS;QACjD;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,SAAS,EAAE,OAAO,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,MAAM,KAAK,CAAC;QAEpB;;WAEG;QACH,MAAM,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;KACrC;IAED;;OAEG;IACH,UAAiB,cAAe,SAAQ,UAAU;QAChD;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,MAAM,EAAE,MAAM,IAAI,CAAC;KACpB;CACF"}

package/lib/types/base/Component/index.d.ts

@@ -3,16 +3,30 @@ import { Plugin } from '../Plugin';
 import { NComponent } from './types';
 export type { NComponent };
 /**
- * A class for Components.
+ * A class representing a component that extends the functionality of the {@link Module} class.
+ * It allows for the addition of plugins, which can further extend or enhance the component's behavior.
  */
 export declare class Component<StaticProps extends NComponent.IStaticProps = NComponent.IStaticProps, ChangeableProps extends NComponent.IChangeableProps = NComponent.IChangeableProps, CallbacksTypes extends NComponent.ICallbacksTypes = NComponent.ICallbacksTypes> extends Module<StaticProps, ChangeableProps, CallbacksTypes> {
-    /** Inner plugins */
+    /**
+     * Holds the list of inner plugins associated with the component.
+     * Plugins can enhance the component's functionality.
+     */
     private _plugins?;
-    /** Add a single plugin */
+    /**
+     * Adds a plugin to the component. The plugin is initialized upon being added,
+     * and the plugin's `component` property is set to the current component instance.
+     *
+     * @param plugin - An instance of the {@link Plugin} class to be added.
+     */
     addPlugin<T extends Plugin<any, any, any, any>>(plugin: T): void;
-    /** Destroy all plugins */
+    /**
+     * Destroys all plugins associated with the component.
+     * This ensures proper cleanup when the component is destroyed.
+     */
     private _destroyPlugins;
-    /** Destroy the component */
+    /**
+     * Destroys the component, ensuring that all plugins are properly destroyed as well.
+     */
     protected _destroy(): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/types/base/Component/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Component/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;GAEG;AACH,qBAAa,SAAS,CACpB,WAAW,SAAS,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,EACrE,eAAe,SACb,UAAU,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,EAC3D,cAAc,SACZ,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CACzD,SAAQ,MAAM,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IAC5D,oBAAoB;IACpB,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B,0BAA0B;IACnB,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IAYhE,0BAA0B;IAC1B,OAAO,CAAC,eAAe;IAIvB,4BAA4B;IAC5B,SAAS,CAAC,QAAQ;CAKnB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Component/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,YAAY,EAAE,UAAU,EAAE,CAAC;AAE3B;;;GAGG;AACH,qBAAa,SAAS,CACpB,WAAW,SAAS,UAAU,CAAC,YAAY,GAAG,UAAU,CAAC,YAAY,EACrE,eAAe,SACb,UAAU,CAAC,gBAAgB,GAAG,UAAU,CAAC,gBAAgB,EAC3D,cAAc,SACZ,UAAU,CAAC,eAAe,GAAG,UAAU,CAAC,eAAe,CACzD,SAAQ,MAAM,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IAC5D;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,CAAW;IAE5B;;;;;OAKG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IAYhE;;;OAGG;IACH,OAAO,CAAC,eAAe;IAIvB;;OAEG;IACH,SAAS,CAAC,QAAQ;CAKnB"}

package/lib/types/base/Component/types.d.ts

@@ -1,12 +1,24 @@
 import { NModule } from '../Module/types';
 export declare namespace NComponent {
-    /** Static properties */
+    /**
+     * Static properties for a component.
+     * These properties remain constant throughout the lifecycle of the component.
+     * This interface extends {@link NModule.IStaticProps}, inheriting the static properties defined for modules.
+     */
     interface IStaticProps extends NModule.IStaticProps {
     }
-    /** Changeable Properties */
+    /**
+     * Changeable properties for a component.
+     * These properties may change during the component's lifecycle, such as in response to window resizing or user actions.
+     * This interface extends {@link NModule.IChangeableProps}, inheriting the mutable properties defined for modules.
+     */
     interface IChangeableProps extends NModule.IChangeableProps {
     }
-    /** Available callbacks */
+    /**
+     * Available callback types for a component.
+     * These callbacks allow external interaction with the component's lifecycle events.
+     * This interface extends {@link NModule.ICallbacksTypes}, inheriting the callbacks defined for modules.
+     */
     interface ICallbacksTypes extends NModule.ICallbacksTypes {
     }
 }

package/lib/types/base/Component/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Component/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,yBAAiB,UAAU,CAAC;IAC1B,wBAAwB;IACxB,UAAiB,YAAa,SAAQ,OAAO,CAAC,YAAY;KAAG;IAE7D,4BAA4B;IAC5B,UAAiB,gBAAiB,SAAQ,OAAO,CAAC,gBAAgB;KAAG;IAErE,0BAA0B;IAC1B,UAAiB,eAAgB,SAAQ,OAAO,CAAC,eAAe;KAAG;CACpE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Component/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,yBAAiB,UAAU,CAAC;IAC1B;;;;OAIG;IACH,UAAiB,YAAa,SAAQ,OAAO,CAAC,YAAY;KAAG;IAE7D;;;;OAIG;IACH,UAAiB,gBAAiB,SAAQ,OAAO,CAAC,gBAAgB;KAAG;IAErE;;;;OAIG;IACH,UAAiB,eAAgB,SAAQ,OAAO,CAAC,eAAe;KAAG;CACpE"}