vevet 3.19.2 → 4.0.0-beta.0

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

@@ -3,119 +3,169 @@ import { NModule } from './types';
 import { NMutableProps } from '../MutableProps';
 import { Callbacks, NCallbacks } from '../Callbacks';
 import { TRequiredModuleProp } from '../../types/utility';
-import { createViewport } from '../../Application/events/createViewport';
+import { createViewport } from '../../Vevet/events/createViewport';
 export type { NModule };
 type TViewportAdd = ReturnType<typeof createViewport>['callbacks']['add'];
 /**
- * Module base
+ * A base class for modules that handle responsive properties, event listeners, and custom callbacks.
+ * This class provides a structure for modules that can dynamically respond to viewport changes, property mutations, and various lifecycle events.
+ *
+ * @example
+ *
+ * interface IStaticProps extends NModule.IStaticProps {
+ *   staticName: 'My name';
+ * }
+ *
+ * interface IChangeableProps extends NModule.IChangeableProps {
+ *   weight: number;
+ *   height: number;
+ * }
+ *
+ * interface ICallbacks extends NModule.ICallbacksTypes {}
+ *
+ * const module = new Module<IStaticProps, IChangeableProps, ICallbacks>({
+ *   staticName: 'My name',
+ *   weight: 70,
+ *   height: 175,
+ * }, false);
+ *
+ * module.addResponsiveProps({
+ *   breakpoint: 'viewport_phone',
+ *   settings: {
+ *     weight: 80,
+ *   },
+ * });
+ *
+ * module.init();
+ *
+ * module.addCallback('propsMutate', () => console.log('mutate props'));
+ * module.addCallback('destroy', () => console.log('destroy'));
  */
 export declare class Module<StaticProps extends NModule.IStaticProps = NModule.IStaticProps, ChangeableProps extends NModule.IChangeableProps = NModule.IChangeableProps, CallbacksTypes extends NModule.ICallbacksTypes = NModule.ICallbacksTypes> {
     /**
-     * Get Default properties (should be extended)
+     * Retrieves the default properties for the module. This method is intended to be overridden in subclasses to provide default values for the module's properties.
      */
     protected _getDefaultProps(): {};
-    /** Current properties */
+    /**
+     * The current properties of the module, which include both static and changeable properties.
+     * These can be retrieved dynamically during the module's lifecycle.
+     */
     get props(): TRequiredModuleProp<StaticProps & ChangeableProps>;
-    /** Responsive properties */
+    /** Manages the module's mutable properties */
     private _mutableProps;
-    /** Module Callbacks */
+    /** Manages the module's callbacks */
     private _callbacks;
-    /** Module Callbacks */
-    get callbacks(): Callbacks<CallbacksTypes>;
-    /** Module listeners */
-    private _listeners;
     /**
-     * Destroyable actions
+     * Retrieves the module's registered callbacks.
      */
+    get callbacks(): Callbacks<CallbacksTypes>;
+    /** Holds the list of event listeners added to the module */
+    private _listeners;
+    /** Stores actions that need to be executed when the module is destroyed */
     private _destroyableActions;
-    /**
-     * Classnames to remove
-     */
+    /** Stores the class names to be removed when the module is destroyed */
     private _classNamesToRemove;
-    /** Module name */
+    /** The name of the module, derived from the class name */
     get name(): string;
-    /** Module prefix */
+    /** Optional prefix for class names used by the module */
     get prefix(): string;
-    /** The module is initialized */
+    /** Tracks whether the module has been initialized */
     private _isInitialized;
-    /** The module is initialized */
+    /**
+     * Checks if the module has been initialized.
+     */
     get isInitialized(): boolean;
-    /** The module is destroyed */
+    /** Tracks whether the module has been destroyed */
     private _isDestroyed;
-    /** The module is destroyed */
+    /**
+     * Checks if the module has been destroyed.
+     */
     get isDestroyed(): boolean;
     /**
-     * @example
+     * Creates a new instance of the Module class.
+     *
+     * @param initialProps - The initial static and changeable properties to be used by the module.
+     * @param canInit - Whether to automatically initialize the module after construction. Set this to `false` if you want to add responsive properties before initializing.
+     */
+    constructor(initialProps?: StaticProps & ChangeableProps, canInit?: boolean);
+    /**
+     * Adds responsive property rules to the module. This must be done before initialization.
      *
-     * interface IStaticProps extends NModule.IStaticProps {
-     *   staticName: 'My name';
-     * }
-  
-     * interface IChangeableProps extends NModule.IChangeableProps {
-     *   weight: number;
-     *   height: number;
-     * }
-  
-     * interface ICallbacks extends NModule.ICallbacksTypes {}
-  
-     * const module = new Module<IStaticProps, IChangeableProps, ICallbacks>(
-     *   {
-     *     staticName: 'My name',
-     *     weight: 70,
-     *     height: 175,
-     *   },
-     *   false
-     * );
-  
-     * module.addResponsiveProps({
-     *   breakpoint: 'viewport_phone',
-     *   settings: {
-     *     weight: 80,
-     *   },
-     * });
-  
-     * module.init();
-  
-     * module.addCallback('propsMutate', () => console.log('mutate props'));
-  
-     * module.addCallback('destroy', () => console.log('destroy'));
-     */
-    constructor(
-    /** Initial properties */
-    initialProps?: StaticProps & ChangeableProps, 
-    /**
-     * Defines if you need to call {@linkcode Module.init} at the constructor's end.
-     * If you want to add responsive properties, set this parameter to `false`.
-     */
-    canInit?: boolean);
-    /** Add responsive rules */
+     * @param rules - The responsive property rules to be added.
+     */
     addResponsiveProps(rules: NMutableProps.IResponsive<ChangeableProps>): void;
-    /** Change module properties */
+    /**
+     * Updates the changeable properties of the module.
+     *
+     * @param props - The properties to be updated.
+     */
     changeProps(props: Partial<ChangeableProps>): void;
     /**
-     * This method is called on properties change
+     * This method is called internally when the module's properties change.
      */
     protected _onPropsMutate(): void;
-    /** Initializes the class */
+    /**
+     * Initializes the module. Calls the internal `_init` method and marks the module as initialized.
+     */
     init(): void;
-    /** Inner extra initialization */
+    /**
+     * Additional initialization logic that can be overridden in subclasses.
+     */
     protected _init(): void;
-    /** Add destroyable actions */
+    /**
+     * Adds an action to the list of actions to be executed when the module is destroyed.
+     *
+     * @param action - The function to execute during destruction.
+     */
     protected addDestroyableAction(action: () => void): void;
     /**
-     * Add a viewport callback that will be removed on class destroy
+     * Adds a viewport callback that will be automatically removed when the module is destroyed.
+     *
+     * @param target - The viewport target (e.g., width or height).
+     * @param action - The callback function to execute when the viewport target changes.
+     * @param data - Additional data for the callback.
      */
     addViewportCallback(target: Parameters<TViewportAdd>[0], action: Parameters<TViewportAdd>[1], data?: Parameters<TViewportAdd>[2]): void;
-    /** Add a module callback */
+    /**
+     * Adds a custom callback to the module.
+     *
+     * @param target - The event type to listen for (e.g., 'propsChange', 'destroy').
+     * @param action - The function to execute when the event is triggered.
+     * @param settings - Additional settings for the callback.
+     */
     addCallback<T extends keyof CallbacksTypes>(target: T, action: NCallbacks.TAction<CallbacksTypes[T]>, settings?: NCallbacks.ISettings): NCallbacks.IAddedCallback;
-    /** Add a DOM event listener */
+    /**
+     * Adds a DOM event listener that will be automatically removed when the module is destroyed.
+     *
+     * @param el - The target element for the event listener.
+     * @param target - The event type to listen for (e.g., 'click', 'resize').
+     * @param callback - The callback function to execute when the event is triggered.
+     * @param options - Additional options for the event listener.
+     */
     addEventListener<El extends ListenerElement, Target extends keyof HTMLElementEventMap, Callback extends (evt: HTMLElementEventMap[Target]) => void>(el: El, target: Target, callback: Callback, options?: IAddEventListenerOptions): IAddEventListener;
+    /**
+     * Helper function to generate class names with the module's prefix.
+     *
+     * @param classNames - The class names to generate.
+     * @returns A string of class names with the module's prefix applied.
+     */
     protected className(...classNames: string[]): string;
-    /** Toggle classList */
+    /**
+     * Toggles a class name on an element, and keeps track of it for removal when the module is destroyed.
+     *
+     * @param element - The target DOM element.
+     * @param className - The class name to toggle.
+     * @param isActive - Whether the class should be added or removed.
+     */
     protected toggleClassName(element: Element, className: string, isActive: boolean): void;
-    /** Destroy the module */
+    /**
+     * Destroys the module, cleaning up resources, callbacks, and event listeners.
+     */
     destroy(): void;
-    /** Destroy the module */
+    /**
+     * Internal method to handle the destruction of the module.
+     * It removes all callbacks, destroys properties, and cleans up event listeners and class names.
+     */
     protected _destroy(): void;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Module/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,EAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAgB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AAEzE,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB,KAAK,YAAY,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAE1E;;GAEG;AACH,qBAAa,MAAM,CACjB,WAAW,SAAS,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAC/D,eAAe,SAAS,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,EAC3E,cAAc,SAAS,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe;IAExE;;OAEG;IACH,SAAS,CAAC,gBAAgB;IAI1B,yBAAyB;IACzB,IAAI,KAAK,uDAIR;IAED,4BAA4B;IAC5B,OAAO,CAAC,aAAa,CAA6C;IAElE,uBAAuB;IACvB,OAAO,CAAC,UAAU,CAA4B;IAE9C,uBAAuB;IACvB,IAAI,SAAS,8BAEZ;IAED,uBAAuB;IACvB,OAAO,CAAC,UAAU,CAAsB;IAExC;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAiB;IAE5C;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAgC;IAE3D,kBAAkB;IAClB,IAAI,IAAI,WAEP;IAED,oBAAoB;IACpB,IAAI,MAAM,WAET;IAED,gCAAgC;IAChC,OAAO,CAAC,cAAc,CAAS;IAE/B,gCAAgC;IAChC,IAAI,aAAa,YAEhB;IAED,8BAA8B;IAC9B,OAAO,CAAC,YAAY,CAAS;IAE7B,8BAA8B;IAC9B,IAAI,WAAW,YAEd;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;;IAED,yBAAyB;IACzB,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe;IAC5C;;;OAGG;IACH,OAAO,UAAO;IA6BhB,2BAA2B;IACpB,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;IAU3E,+BAA+B;IACxB,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC;IAUlD;;OAEG;IACH,SAAS,CAAC,cAAc;IAIxB,4BAA4B;IACrB,IAAI;IAUX,iCAAiC;IACjC,SAAS,CAAC,KAAK;IAEf,8BAA8B;IAC9B,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,IAAI;IAIjD;;OAEG;IACI,mBAAmB,CACxB,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACnC,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACnC,IAAI,GAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAM;IAUxC,4BAA4B;IACrB,WAAW,CAAC,CAAC,SAAS,MAAM,cAAc,EAC/C,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAC7C,QAAQ,GAAE,UAAU,CAAC,SAAc;IAKrC,+BAA+B;IACxB,gBAAgB,CACrB,EAAE,SAAS,eAAe,EAC1B,MAAM,SAAS,MAAM,mBAAmB,EACxC,QAAQ,SAAS,CAAC,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC,KAAK,IAAI,EAE3D,EAAE,EAAE,EAAE,EACN,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,wBAAwB,GACjC,iBAAiB;IAgBpB,SAAS,CAAC,SAAS,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE;IAI3C,uBAAuB;IACvB,SAAS,CAAC,eAAe,CACvB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,OAAO;IAWnB,yBAAyB;IAClB,OAAO;IAQd,yBAAyB;IACzB,SAAS,CAAC,QAAQ;CAenB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Module/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,iBAAiB,EACjB,wBAAwB,EACxB,eAAe,EAChB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAgB,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAEtD,OAAO,EAAE,cAAc,EAAE,MAAM,mCAAmC,CAAC;AAEnE,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB,KAAK,YAAY,GAAG,UAAU,CAAC,OAAO,cAAc,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC;AAE1E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,MAAM,CACjB,WAAW,SAAS,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAC/D,eAAe,SAAS,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,EAC3E,cAAc,SAAS,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe;IAExE;;OAEG;IACH,SAAS,CAAC,gBAAgB;IAI1B;;;OAGG;IACH,IAAI,KAAK,uDAIR;IAED,8CAA8C;IAC9C,OAAO,CAAC,aAAa,CAA6C;IAElE,qCAAqC;IACrC,OAAO,CAAC,UAAU,CAA4B;IAE9C;;OAEG;IACH,IAAI,SAAS,8BAEZ;IAED,4DAA4D;IAC5D,OAAO,CAAC,UAAU,CAAsB;IAExC,2EAA2E;IAC3E,OAAO,CAAC,mBAAmB,CAAiB;IAE5C,wEAAwE;IACxE,OAAO,CAAC,mBAAmB,CAAgC;IAE3D,0DAA0D;IAC1D,IAAI,IAAI,WAEP;IAED,yDAAyD;IACzD,IAAI,MAAM,WAET;IAED,qDAAqD;IACrD,OAAO,CAAC,cAAc,CAAS;IAE/B;;OAEG;IACH,IAAI,aAAa,YAEhB;IAED,mDAAmD;IACnD,OAAO,CAAC,YAAY,CAAS;IAE7B;;OAEG;IACH,IAAI,WAAW,YAEd;IAED;;;;;OAKG;gBACS,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe,EAAE,OAAO,UAAO;IA0BxE;;;;OAIG;IACI,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;IAU3E;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC;IAUlD;;OAEG;IACH,SAAS,CAAC,cAAc;IAIxB;;OAEG;IACI,IAAI;IAUX;;OAEG;IACH,SAAS,CAAC,KAAK;IAEf;;;;OAIG;IACH,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,IAAI;IAIjD;;;;;;OAMG;IACI,mBAAmB,CACxB,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACnC,MAAM,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACnC,IAAI,GAAE,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAM;IAUxC;;;;;;OAMG;IACI,WAAW,CAAC,CAAC,SAAS,MAAM,cAAc,EAC/C,MAAM,EAAE,CAAC,EACT,MAAM,EAAE,UAAU,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAC7C,QAAQ,GAAE,UAAU,CAAC,SAAc;IAKrC;;;;;;;OAOG;IACI,gBAAgB,CACrB,EAAE,SAAS,eAAe,EAC1B,MAAM,SAAS,MAAM,mBAAmB,EACxC,QAAQ,SAAS,CAAC,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC,KAAK,IAAI,EAE3D,EAAE,EAAE,EAAE,EACN,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,QAAQ,EAClB,OAAO,CAAC,EAAE,wBAAwB,GACjC,iBAAiB;IAgBpB;;;;;OAKG;IACH,SAAS,CAAC,SAAS,CAAC,GAAG,UAAU,EAAE,MAAM,EAAE;IAI3C;;;;;;OAMG;IACH,SAAS,CAAC,eAAe,CACvB,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,EACjB,QAAQ,EAAE,OAAO;IAWnB;;OAEG;IACI,OAAO;IAQd;;;OAGG;IACH,SAAS,CAAC,QAAQ;CAenB"}

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

@@ -1,23 +1,49 @@
 import { NCallbacks } from '../Callbacks/types';
 export declare namespace NModule {
     /**
-     * Mutable Properties (may change on window resize or through {@linkcode Module.changeProps})
+     * Interface representing the properties that can change dynamically.
+     * These properties may be updated during window resize events or through
+     * the {@linkcode Module.changeProps} method.
      */
     interface IChangeableProps {
         __fixHelperChangeableProps?: any;
     }
-    /** Static properties */
+    /**
+     * Interface representing static properties that remain constant and do not change
+     * after initialization.
+     */
     interface IStaticProps {
         __fixHelperStaticProps?: any;
     }
-    /** Available callbacks */
+    /**
+     * Defines the available callback types for the module.
+     * These callbacks allow interaction with specific module events.
+     */
     interface ICallbacksTypes extends NCallbacks.ITypes {
+        /**
+         * Triggered when the module is destroyed.
+         */
         destroy: undefined;
+        /**
+         * Triggered when module properties are manually changed.
+         */
         propsChange: undefined;
+        /**
+         * Triggered when module properties mutate due to responsive settings or other updates.
+         */
         propsMutate: undefined;
     }
+    /**
+     * Represents the class names to be removed from an element when the module is destroyed.
+     */
     interface IClassNamesToRemove {
+        /**
+         * The DOM element from which the class name should be removed.
+         */
         element: Element;
+        /**
+         * The class name that should be removed from the element.
+         */
         className: string;
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Module/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,gBAAgB;QAC/B,0BAA0B,CAAC,EAAE,GAAG,CAAC;KAClC;IAED,wBAAwB;IACxB,UAAiB,YAAY;QAC3B,sBAAsB,CAAC,EAAE,GAAG,CAAC;KAC9B;IAED,0BAA0B;IAC1B,UAAiB,eAAgB,SAAQ,UAAU,CAAC,MAAM;QACxD,OAAO,EAAE,SAAS,CAAC;QACnB,WAAW,EAAE,SAAS,CAAC;QACvB,WAAW,EAAE,SAAS,CAAC;KACxB;IAED,UAAiB,mBAAmB;QAClC,OAAO,EAAE,OAAO,CAAC;QACjB,SAAS,EAAE,MAAM,CAAC;KACnB;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Module/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAEhD,yBAAiB,OAAO,CAAC;IACvB;;;;OAIG;IACH,UAAiB,gBAAgB;QAC/B,0BAA0B,CAAC,EAAE,GAAG,CAAC;KAClC;IAED;;;OAGG;IACH,UAAiB,YAAY;QAC3B,sBAAsB,CAAC,EAAE,GAAG,CAAC;KAC9B;IAED;;;OAGG;IACH,UAAiB,eAAgB,SAAQ,UAAU,CAAC,MAAM;QACxD;;WAEG;QACH,OAAO,EAAE,SAAS,CAAC;QAEnB;;WAEG;QACH,WAAW,EAAE,SAAS,CAAC;QAEvB;;WAEG;QACH,WAAW,EAAE,SAAS,CAAC;KACxB;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,SAAS,EAAE,MAAM,CAAC;KACnB;CACF"}

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

@@ -1,135 +1,92 @@
 import { NMutableProps } from './types';
 export type { NMutableProps };
 /**
- * A class for creating mutable properties that can change on window resize. <br><br>
- *
- * There are two ways to change properties:
- * - To set a resize-listener on window (or use {@linkcode Viewport}).
- * When the window is resized, change the properties with the help of
- * {@linkcode MutableProps.changeProps}
- *
- * - The second way is to use the MutableProps and add responsive properties
- * with help of {@linkcode MutableProps.addResponsiveProps}.
+ * A class for managing mutable properties that can change based on window size (responsive design).
+ * This allows certain properties to update dynamically when the window is resized or in response to manual changes.
  *
  * @example
  *
  * interface IStatic {
  *   static: string;
  * }
-
+ *
  * interface IChangeable {
  *   changeable: string;
  * }
-
+ *
  * const props = new MutableProps<IStatic, IChangeable>({
  *   static: '',
  *   changeable: 'something',
  * });
-
+ *
  * props.addResponsiveProps({
  *   breakpoint: 'viewport_phone',
  *   settings: {
  *     changeable: 'phone',
  *   },
  * });
-
+ *
  * props.changeProps({ changeable: 'changed' });
  */
-export declare class MutableProps<
-/**
- * Static Properties (they never change)
- */
-StaticProps extends Record<string, any>, 
-/**
- * Mutable Properties
- * (may change on window resize or through {@linkcode MutableProps.changeProps})
- */
-ChangeableProps extends Record<string, any>> {
-    /**
-     * The properties that were set while initialization.
-     * These properties will nevet change.
-     */
-    private _initProps;
-    /**
-     * A callback that is launched when properties are changed
-     */
+export declare class MutableProps<StaticProps extends Record<string, any>, ChangeableProps extends Record<string, any>> {
     private _onMutate;
-    /**
-     * Name of the responsive properties.
-     */
     private _name;
     /**
-     * Reference properties.
-     * These properties may change only through {@linkcode MutableProps.changeProps}.
+     * A reference to the original properties (both static and changeable).
+     * These properties are only updated manually via {@linkcode changeProps}.
      */
     private _refProps;
     /**
-     * Current properties.
-     * These properties may change both on {@linkcode MutableProps.changeProps} and resize.
+     * The current active properties. These can be updated through both window resizing
+     * (via responsive rules) and manual changes through {@linkcode changeProps}.
      */
     private _props;
     /**
-     * A set of responsive rules
+     * A set of responsive rules defining how properties should change based on viewport size or device type.
+     * Each rule is defined by a breakpoint and corresponding property settings.
      */
     private _responsiveRules;
     /**
-     * Get current properties
+     * The active breakpoints currently applied to the properties.
      */
-    get props(): StaticProps & ChangeableProps;
+    private _activeBreakpoints;
     /**
-     * Viewport callback
+     * A callback used to update properties when the viewport size changes.
      */
     private _viewportCallback?;
     /**
-     * Active breakpoints used to define if properties have changed
-     */
-    private _activeBreakpoints;
-    /**
-     * @example
-     *
-     * const static = {
-     *   myProp: true,
-     * };
-     *
-     * const responsive = [
-     *   {
-     *     breakpoint: 'm',
-     *     settings: {
-     *       myProp: false
-     *     }
-     *   }
-     * ];
+     * Initializes the `MutableProps` instance with static and changeable properties,
+     * and sets up a mutation callback to be called when properties change.
      *
-     * const props = new MutableProps(static, responsive);
+     * @param initProps - Initial properties, including both static and changeable properties.
+     * @param _onMutate - Callback function triggered whenever the properties change.
+     * @param _name - The name used to identify the set of responsive properties.
      */
-    constructor(
+    constructor(initProps: StaticProps & ChangeableProps, _onMutate?: () => void, _name?: string);
     /**
-     * The properties that were set while initialization.
-     * These properties will nevet change.
+     * Retrieves the current properties.
+     * These may change either due to responsive rules or through manual updates.
      */
-    _initProps: StaticProps & ChangeableProps, 
-    /**
-     * A callback that is launched when properties are changed
-     */
-    _onMutate?: () => void, 
-    /**
-     * Name of the responsive properties.
-     */
-    _name?: string);
+    get props(): StaticProps & ChangeableProps;
     /**
-     * Add responsive rules
+     * Adds responsive rules that define how the properties should change based on viewport breakpoints.
+     *
+     * @param rules - Responsive rules specifying breakpoints and corresponding property settings.
      */
     addResponsiveProps(rules: NMutableProps.IResponsive<ChangeableProps>): void;
     /**
-     * Change properties according to the "responsive" settings
+     * Handles updating the properties based on the current viewport size.
+     * It checks all responsive rules and applies the appropriate settings for active breakpoints.
      */
     private _responseProps;
     /**
-     * This method allows you to change the properties manually.
+     * Manually changes the properties. The updated properties persist and trigger the mutation callback.
+     *
+     * @param props - A partial set of changeable properties to be updated.
      */
     changeProps(props: Partial<ChangeableProps>): void;
     /**
-     * Destroy the responsive properties.
+     * Cleans up and destroys the responsive properties.
      */
     destroy(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/MutableProps/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,qBAAa,YAAY;AACvB;;GAEG;AACH,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AACvC;;;GAGG;AACH,eAAe,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAuDzC;;;OAGG;IACH,OAAO,CAAC,UAAU;IAClB;;OAEG;IACH,OAAO,CAAC,SAAS;IACjB;;OAEG;IACH,OAAO,CAAC,KAAK;IAjEf;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAgC;IAEjD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAgC;IAE9C;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAoD;IAE5E;;OAEG;IACH,IAAI,KAAK,kCAER;IAED;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAA4B;IAEtD;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAsB;IAEhD;;;;;;;;;;;;;;;;;OAiBG;;IAED;;;OAGG;IACK,UAAU,EAAE,WAAW,GAAG,eAAe;IACjD;;OAEG;IACK,SAAS,GAAE,MAAM,IAAe;IACxC;;OAEG;IACK,KAAK,SAAqB;IAQpC;;OAEG;IACI,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;IAgB3E;;OAEG;IACH,OAAO,CAAC,cAAc;IA4DtB;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC;IAOlD;;OAEG;IACI,OAAO;CAKf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/MutableProps/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAExC,YAAY,EAAE,aAAa,EAAE,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,YAAY,CACvB,WAAW,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACvC,eAAe,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAwCzC,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,KAAK;IAvCf;;;OAGG;IACH,OAAO,CAAC,SAAS,CAAgC;IAEjD;;;OAGG;IACH,OAAO,CAAC,MAAM,CAAgC;IAE9C;;;OAGG;IACH,OAAO,CAAC,gBAAgB,CAAoD;IAE5E;;OAEG;IACH,OAAO,CAAC,kBAAkB,CAAsB;IAEhD;;OAEG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAA4B;IAEtD;;;;;;;OAOG;gBAED,SAAS,EAAE,WAAW,GAAG,eAAe,EAChC,SAAS,GAAE,MAAM,IAAe,EAChC,KAAK,SAAqB;IAOpC;;;OAGG;IACH,IAAI,KAAK,kCAER;IAED;;;;OAIG;IACI,kBAAkB,CAAC,KAAK,EAAE,aAAa,CAAC,WAAW,CAAC,eAAe,CAAC;IAgB3E;;;OAGG;IACH,OAAO,CAAC,cAAc;IA2DtB;;;;OAIG;IACI,WAAW,CAAC,KAAK,EAAE,OAAO,CAAC,eAAe,CAAC;IAOlD;;OAEG;IACI,OAAO;CAKf"}

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

@@ -1,19 +1,25 @@
 export declare namespace NMutableProps {
     interface IResponsive<S> {
         /**
-         * The breakpoint at which properties will change.
+         * Defines the breakpoint at which the properties should change.
+         * The `breakpoint` can represent either a specific screen width (in pixels)
+         * or a predefined device type or viewport size.
+         *
          * Available breakpoints:
          * <ul>
-         *   <li>any number - width breakpoint</li>
-         *   <li>'d' - for desktop size</li>
-         *   <li>'t' - for tablet size</li>
-         *   <li>'p' - for phone size</li>
-         *   <li>'phone' - for phone devices</li>
-         *   <li>'tablet' - for tablet devices</li>
-         *   <li>'mobile' - for phone or tablet devices</li>
+         *   <li><code>number</code> - Width breakpoint in pixels, e.g., 768 for tablets or 1024 for desktops.</li>
+         *   <li><code>'viewport_desktop'</code> - When the viewport width is categorized as desktop size.</li>
+         *   <li><code>'viewport_tablet'</code> - When the viewport width is categorized as tablet size.</li>
+         *   <li><code>'viewport_phone'</code> - When the viewport width is categorized as phone size.</li>
+         *   <li><code>'device_phone'</code> - When the user is on a phone device, regardless of viewport size.</li>
+         *   <li><code>'device_tablet'</code> - When the user is on a tablet device, regardless of viewport size.</li>
+         *   <li><code>'device_mobile'</code> - When the user is on any mobile device (either phone or tablet).</li>
          * </ul>
          */
         breakpoint: number | 'viewport_desktop' | 'viewport_tablet' | 'viewport_phone' | 'device_phone' | 'device_tablet' | 'device_mobile';
+        /**
+         * The property settings that should be applied when the defined breakpoint is matched.
+         */
         settings: Partial<S>;
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/MutableProps/types.ts"],"names":[],"mappings":"AAAA,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,WAAW,CAAC,CAAC;QAC5B;;;;;;;;;;;;WAYG;QACH,UAAU,EACN,MAAM,GACN,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,CAAC;QACpB,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;KACtB;CACF"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/MutableProps/types.ts"],"names":[],"mappings":"AAAA,yBAAiB,aAAa,CAAC;IAC7B,UAAiB,WAAW,CAAC,CAAC;QAC5B;;;;;;;;;;;;;;;WAeG;QACH,UAAU,EACN,MAAM,GACN,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,cAAc,GACd,eAAe,GACf,eAAe,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC;KACtB;CACF"}

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

@@ -2,13 +2,36 @@ import { Module } from '../Module';
 import { NPlugin } from './types';
 export type { NPlugin };
 /**
- * A class for Plugins.
+ * A base abstract class for Plugins that extend the functionality of components.
+ * A plugin is designed to attach to a component and modify or enhance its behavior.
+ * It inherits from the {@link Module} class and adds functionality to work with a component.
  */
 export declare abstract class Plugin<StaticProps extends NPlugin.IStaticProps = NPlugin.IStaticProps, ChangeableProps extends NPlugin.IChangeableProps = NPlugin.IChangeableProps, CallbacksTypes extends NPlugin.ICallbacksTypes = NPlugin.ICallbacksTypes, Component = any> extends Module<StaticProps, ChangeableProps, CallbacksTypes> {
+    /**
+     * Constructs the plugin.
+     *
+     * @param initialProps - Initial static and changeable properties for the plugin.
+     */
     constructor(initialProps?: StaticProps & ChangeableProps);
+    /**
+     * The component to which the plugin is attached.
+     * This property must be set before initializing the plugin.
+     */
     private _component;
+    /**
+     * Retrieves the component to which this plugin is attached.
+     */
     get component(): Component;
+    /**
+     * Sets the component for this plugin. This method is called by the parent component when the plugin is added.
+     */
     set component(value: Component);
+    /**
+     * Initializes the plugin and ensures it is properly associated with a component.
+     * If the component is not set before calling `init`, it throws an error.
+     *
+     * @throws {Error} If `component` is not set.
+     */
     init(): void;
 }
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Plugin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;GAEG;AACH,8BAAsB,MAAM,CAC1B,WAAW,SAAS,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAC/D,eAAe,SAAS,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,EAC3E,cAAc,SAAS,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,EACxE,SAAS,GAAG,GAAG,CACf,SAAQ,MAAM,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;gBAChD,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe;IAIxD,OAAO,CAAC,UAAU,CAAa;IAE/B,IAAI,SAAS,cAEZ;IAED,IAAI,SAAS,CAAC,KAAK,WAAA,EAElB;IAEM,IAAI;CASZ"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/base/Plugin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAElC,YAAY,EAAE,OAAO,EAAE,CAAC;AAExB;;;;GAIG;AACH,8BAAsB,MAAM,CAC1B,WAAW,SAAS,OAAO,CAAC,YAAY,GAAG,OAAO,CAAC,YAAY,EAC/D,eAAe,SAAS,OAAO,CAAC,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,EAC3E,cAAc,SAAS,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,eAAe,EACxE,SAAS,GAAG,GAAG,CACf,SAAQ,MAAM,CAAC,WAAW,EAAE,eAAe,EAAE,cAAc,CAAC;IAC5D;;;;OAIG;gBACS,YAAY,CAAC,EAAE,WAAW,GAAG,eAAe;IAIxD;;;OAGG;IACH,OAAO,CAAC,UAAU,CAAa;IAE/B;;OAEG;IACH,IAAI,SAAS,cAEZ;IAED;;OAEG;IACH,IAAI,SAAS,CAAC,KAAK,WAAA,EAElB;IAED;;;;;OAKG;IACI,IAAI;CASZ"}

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

@@ -1,9 +1,20 @@
 import { NModule } from '../Module/types';
 export declare namespace NPlugin {
+    /**
+     * Static properties for plugins. These properties remain constant throughout the lifecycle of the plugin.
+     */
     interface IStaticProps extends NModule.IStaticProps {
     }
+    /**
+     * Changeable properties for plugins. These properties can change dynamically during the lifecycle of the plugin.
+     * Extends from {@link NModule.IChangeableProps}, providing plugins with the ability to update their properties over time.
+     */
     interface IChangeableProps extends NModule.IChangeableProps {
     }
+    /**
+     * Defines the available callback types for plugins. These callbacks allow plugins to respond to lifecycle events or property changes.
+     * Extends from {@link NModule.ICallbacksTypes}, meaning that plugins share the same callback structure as modules.
+     */
     interface ICallbacksTypes extends NModule.ICallbacksTypes {
     }
 }

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

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Plugin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,yBAAiB,OAAO,CAAC;IACvB,UAAiB,YAAa,SAAQ,OAAO,CAAC,YAAY;KAAG;IAE7D,UAAiB,gBAAiB,SAAQ,OAAO,CAAC,gBAAgB;KAAG;IAErE,UAAiB,eAAgB,SAAQ,OAAO,CAAC,eAAe;KAAG;CACpE"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/base/Plugin/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,YAAa,SAAQ,OAAO,CAAC,YAAY;KAAG;IAE7D;;;OAGG;IACH,UAAiB,gBAAiB,SAAQ,OAAO,CAAC,gBAAgB;KAAG;IAErE;;;OAGG;IACH,UAAiB,eAAgB,SAAQ,OAAO,CAAC,eAAe;KAAG;CACpE"}