vevet 3.19.2 → 4.0.0-beta.0

package/lib/cjs/base/Component/index.js

@@ -18,14 +18,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Component = void 0;
 var Module_1 = require("../Module");
 /**
- * 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.
  */
 var Component = /** @class */ (function (_super) {
     __extends(Component, _super);
     function Component() {
         return _super !== null && _super.apply(this, arguments) || this;
     }
-    /** 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.
+     */
     Component.prototype.addPlugin = function (plugin) {
         if (typeof this._plugins === 'undefined') {
             this._plugins = [];
@@ -35,12 +41,17 @@ var Component = /** @class */ (function (_super) {
         plugin.component = this;
         plugin.init();
     };
-    /** Destroy all plugins */
+    /**
+     * Destroys all plugins associated with the component.
+     * This ensures proper cleanup when the component is destroyed.
+     */
     Component.prototype._destroyPlugins = function () {
         var _a;
         (_a = this._plugins) === null || _a === void 0 ? void 0 : _a.forEach(function (plugin) { return plugin.destroy(); });
     };
-    /** Destroy the component */
+    /**
+     * Destroys the component, ensuring that all plugins are properly destroyed as well.
+     */
     Component.prototype._destroy = function () {
         _super.prototype._destroy.call(this);
         this._destroyPlugins();

package/lib/cjs/base/Component/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Component/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,oCAAmC;AAMnC;;GAEG;AACH;IAMU,6BAAoD;IAN9D;;IAkCA,CAAC;IAxBC,0BAA0B;IACnB,6BAAS,GAAhB,UAAuD,MAAS;QAC9D,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE;YACxC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;SACpB;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE3B,6CAA6C;QAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,MAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAED,0BAA0B;IAClB,mCAAe,GAAvB;;QACE,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,OAAO,EAAE,EAAhB,CAAgB,CAAC,CAAC;IACvD,CAAC;IAED,4BAA4B;IAClB,4BAAQ,GAAlB;QACE,iBAAM,QAAQ,WAAE,CAAC;QAEjB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IACH,gBAAC;AAAD,CAAC,AAlCD,CAMU,eAAM,GA4Bf;AAlCY,8BAAS"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Component/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,oCAAmC;AAMnC;;;GAGG;AACH;IAMU,6BAAoD;IAN9D;;IA+CA,CAAC;IAlCC;;;;;OAKG;IACI,6BAAS,GAAhB,UAAuD,MAAS;QAC9D,IAAI,OAAO,IAAI,CAAC,QAAQ,KAAK,WAAW,EAAE;YACxC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;SACpB;QAED,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAE3B,6CAA6C;QAC7C,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,MAAM,CAAC,IAAI,EAAE,CAAC;IAChB,CAAC;IAED;;;OAGG;IACK,mCAAe,GAAvB;;QACE,MAAA,IAAI,CAAC,QAAQ,0CAAE,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,CAAC,OAAO,EAAE,EAAhB,CAAgB,CAAC,CAAC;IACvD,CAAC;IAED;;OAEG;IACO,4BAAQ,GAAlB;QACE,iBAAM,QAAQ,WAAE,CAAC;QAEjB,IAAI,CAAC,eAAe,EAAE,CAAC;IACzB,CAAC;IACH,gBAAC;AAAD,CAAC,AA/CD,CAMU,eAAM,GAyCf;AA/CY,8BAAS"}

package/lib/cjs/base/Module/index.js

@@ -17,61 +17,56 @@ var MutableProps_1 = require("../MutableProps");
 var Callbacks_1 = require("../Callbacks");
 var getApp_1 = require("../../utils/internal/getApp");
 /**
- * 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'));
  */
 var Module = /** @class */ (function () {
     /**
-     * @example
+     * Creates a new instance of the Module class.
      *
-     * 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'));
+     * @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.
      */
-    function Module(
-    /** Initial properties */
-    initialProps, 
-    /**
-     * 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) {
+    function Module(initialProps, canInit) {
         if (canInit === void 0) { canInit = true; }
         var _this = this;
-        /** The module is initialized */
+        /** Tracks whether the module has been initialized */
         this._isInitialized = false;
-        /** The module is destroyed */
+        /** Tracks whether the module has been destroyed */
         this._isDestroyed = false;
         if (!(0, getApp_1.getApp)()) {
-            throw new Error('Vevet.Application does not exist yet. Call "new Vevet.Application()" before using all the stuff');
+            throw new Error('Vevet.Application does not exist yet');
         }
         this._callbacks = new Callbacks_1.Callbacks();
         this._listeners = [];
@@ -84,13 +79,16 @@ var Module = /** @class */ (function () {
         }
     }
     /**
-     * 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.
      */
     Module.prototype._getDefaultProps = function () {
         return {};
     };
     Object.defineProperty(Module.prototype, "props", {
-        /** 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: function () {
             return this._mutableProps.props;
         },
@@ -98,7 +96,9 @@ var Module = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Module.prototype, "callbacks", {
-        /** Module Callbacks */
+        /**
+         * Retrieves the module's registered callbacks.
+         */
         get: function () {
             return this._callbacks;
         },
@@ -106,7 +106,7 @@ var Module = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Module.prototype, "name", {
-        /** Module name */
+        /** The name of the module, derived from the class name */
         get: function () {
             return this.constructor.name;
         },
@@ -114,7 +114,7 @@ var Module = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Module.prototype, "prefix", {
-        /** Module prefix */
+        /** Optional prefix for class names used by the module */
         get: function () {
             return '';
         },
@@ -122,7 +122,9 @@ var Module = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Module.prototype, "isInitialized", {
-        /** The module is initialized */
+        /**
+         * Checks if the module has been initialized.
+         */
         get: function () {
             return this._isInitialized;
         },
@@ -130,14 +132,20 @@ var Module = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(Module.prototype, "isDestroyed", {
-        /** The module is destroyed */
+        /**
+         * Checks if the module has been destroyed.
+         */
         get: function () {
             return this._isDestroyed;
         },
         enumerable: false,
         configurable: true
     });
-    /** Add responsive rules */
+    /**
+     * Adds responsive property rules to the module. This must be done before initialization.
+     *
+     * @param rules - The responsive property rules to be added.
+     */
     Module.prototype.addResponsiveProps = function (rules) {
         if (this.isInitialized) {
             throw new Error('Responsive properties cannot be added after `init` is called');
@@ -146,7 +154,11 @@ var Module = /** @class */ (function () {
             this._mutableProps.addResponsiveProps(rules);
         }
     };
-    /** Change module properties */
+    /**
+     * Updates the changeable properties of the module.
+     *
+     * @param props - The properties to be updated.
+     */
     Module.prototype.changeProps = function (props) {
         if (this.isDestroyed) {
             return;
@@ -155,12 +167,14 @@ var Module = /** @class */ (function () {
         this._callbacks.tbt('propsChange', undefined);
     };
     /**
-     * This method is called on properties change
+     * This method is called internally when the module's properties change.
      */
     Module.prototype._onPropsMutate = function () {
         this._callbacks.tbt('propsMutate', undefined);
     };
-    /** Initializes the class */
+    /**
+     * Initializes the module. Calls the internal `_init` method and marks the module as initialized.
+     */
     Module.prototype.init = function () {
         if (this.isInitialized) {
             return;
@@ -168,26 +182,49 @@ var Module = /** @class */ (function () {
         this._isInitialized = true;
         this._init();
     };
-    /** Inner extra initialization */
+    /**
+     * Additional initialization logic that can be overridden in subclasses.
+     */
     Module.prototype._init = function () { };
-    /** 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.
+     */
     Module.prototype.addDestroyableAction = function (action) {
         this._destroyableActions.push(action);
     };
     /**
-     * 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.
      */
     Module.prototype.addViewportCallback = function (target, action, data) {
         if (data === void 0) { data = {}; }
         var callback = (0, getApp_1.getApp)().viewport.callbacks.add(target, action, __assign(__assign({}, data), { name: this.constructor.name }));
         this.addDestroyableAction(function () { return callback.remove(); });
     };
-    /** 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.
+     */
     Module.prototype.addCallback = function (target, action, settings) {
         if (settings === void 0) { settings = {}; }
         return this.callbacks.add(target, action, settings);
     };
-    /** 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.
+     */
     Module.prototype.addEventListener = function (el, target, callback, options) {
         var _this = this;
         var listener = (0, vevet_dom_1.addEventListener)(el, target, callback, options);
@@ -197,6 +234,12 @@ var Module = /** @class */ (function () {
                 return listener.remove();
             } });
     };
+    /**
+     * 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.
+     */
     Module.prototype.className = function () {
         var _this = this;
         var classNames = [];
@@ -205,7 +248,13 @@ var Module = /** @class */ (function () {
         }
         return classNames.map(function (value) { return "".concat(_this.prefix).concat(value); }).join(' ');
     };
-    /** 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.
+     */
     Module.prototype.toggleClassName = function (element, className, isActive) {
         var isAlreadyExists = element.classList.contains(className);
         element.classList.toggle(className, isActive);
@@ -213,14 +262,19 @@ var Module = /** @class */ (function () {
             this._classNamesToRemove.push({ element: element, className: className });
         }
     };
-    /** Destroy the module */
+    /**
+     * Destroys the module, cleaning up resources, callbacks, and event listeners.
+     */
     Module.prototype.destroy = function () {
         if (this.isDestroyed) {
             return;
         }
         this._destroy();
     };
-    /** 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.
+     */
     Module.prototype._destroy = function () {
         this._callbacks.tbt('destroy', undefined);
         this._callbacks.destroy();

package/lib/cjs/base/Module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Module/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,uCAKmB;AAEnB,gDAA8D;AAC9D,0CAAqD;AAErD,kDAAiD;AAOjD;;GAEG;AACH;IAqEE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH;IACE,yBAAyB;IACzB,YAA4C;IAC5C;;;OAGG;IACH,OAAc;QAAd,wBAAA,EAAA,cAAc;QAPhB,iBAkCC;QAtFD,gCAAgC;QACxB,mBAAc,GAAG,KAAK,CAAC;QAO/B,8BAA8B;QACtB,iBAAY,GAAG,KAAK,CAAC;QAoD3B,IAAI,CAAC,IAAA,eAAM,GAAE,EAAE;YACb,MAAM,IAAI,KAAK,CACb,iGAAiG,CAClG,CAAC;SACH;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAS,EAAkB,CAAC;QAClD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAE9B,IAAM,KAAK,yBACN,IAAI,CAAC,gBAAgB,EAAE,GACvB,CAAC,YAAY,IAAI,EAAE,CAAC,CACxB,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,CACnC,KAAsC,EACtC,cAAM,OAAA,KAAI,CAAC,cAAc,EAAE,EAArB,CAAqB,EAC3B,IAAI,CAAC,IAAI,CACV,CAAC;QAEF,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,IAAI,EAAE,CAAC;SACb;IACH,CAAC;IAtID;;OAEG;IACO,iCAAgB,GAA1B;QACE,OAAO,EAAE,CAAC;IACZ,CAAC;IAGD,sBAAI,yBAAK;QADT,yBAAyB;aACzB;YACE,OAAO,IAAI,CAAC,aAAa,CAAC,KAEzB,CAAC;QACJ,CAAC;;;OAAA;IASD,sBAAI,6BAAS;QADb,uBAAuB;aACvB;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAgBD,sBAAI,wBAAI;QADR,kBAAkB;aAClB;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/B,CAAC;;;OAAA;IAGD,sBAAI,0BAAM;QADV,oBAAoB;aACpB;YACE,OAAO,EAAE,CAAC;QACZ,CAAC;;;OAAA;IAMD,sBAAI,iCAAa;QADjB,gCAAgC;aAChC;YACE,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;;;OAAA;IAMD,sBAAI,+BAAW;QADf,8BAA8B;aAC9B;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;;;OAAA;IA0ED,2BAA2B;IACpB,mCAAkB,GAAzB,UAA0B,KAAiD;QACzE,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;IACH,CAAC;IAED,+BAA+B;IACxB,4BAAW,GAAlB,UAAmB,KAA+B;QAChD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACO,+BAAc,GAAxB;QACE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChD,CAAC;IAED,4BAA4B;IACrB,qBAAI,GAAX;QACE,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,OAAO;SACR;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED,iCAAiC;IACvB,sBAAK,GAAf,cAAmB,CAAC;IAEpB,8BAA8B;IACpB,qCAAoB,GAA9B,UAA+B,MAAkB;QAC/C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACI,oCAAmB,GAA1B,UACE,MAAmC,EACnC,MAAmC,EACnC,IAAsC;QAAtC,qBAAA,EAAA,SAAsC;QAEtC,IAAM,QAAQ,GAAG,IAAA,eAAM,GAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,wBAC1D,IAAI,KACP,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAC3B,CAAC;QAEH,IAAI,CAAC,oBAAoB,CAAC,cAAM,OAAA,QAAQ,CAAC,MAAM,EAAE,EAAjB,CAAiB,CAAC,CAAC;IACrD,CAAC;IAED,4BAA4B;IACrB,4BAAW,GAAlB,UACE,MAAS,EACT,MAA6C,EAC7C,QAAmC;QAAnC,yBAAA,EAAA,aAAmC;QAEnC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,+BAA+B;IACxB,iCAAgB,GAAvB,UAKE,EAAM,EACN,MAAc,EACd,QAAkB,EAClB,OAAkC;QARpC,iBAuBC;QAbC,IAAM,QAAQ,GAAG,IAAA,4BAAgB,EAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE/B,6BACK,QAAQ,KACX,MAAM,EAAE;gBACN,KAAI,CAAC,UAAU,GAAG,KAAI,CAAC,UAAU,CAAC,MAAM,CACtC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,EAAvB,CAAuB,CAClC,CAAC;gBAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC3B,CAAC,IACD;IACJ,CAAC;IAES,0BAAS,GAAnB;QAAA,iBAEC;QAFmB,oBAAuB;aAAvB,UAAuB,EAAvB,qBAAuB,EAAvB,IAAuB;YAAvB,+BAAuB;;QACzC,OAAO,UAAU,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,UAAG,KAAI,CAAC,MAAM,SAAG,KAAK,CAAE,EAAxB,CAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;IAED,uBAAuB;IACb,gCAAe,GAAzB,UACE,OAAgB,EAChB,SAAiB,EACjB,QAAiB;QAEjB,IAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE9D,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE9C,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,SAAA,EAAE,SAAS,WAAA,EAAE,CAAC,CAAC;SACvD;IACH,CAAC;IAED,yBAAyB;IAClB,wBAAO,GAAd;QACE,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED,yBAAyB;IACf,yBAAQ,GAAlB;QACE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAE1B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAE7B,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,EAAE,EAAR,CAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,MAAM,EAAE,EAAjB,CAAiB,CAAC,CAAC;QAEzD,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAC,EAAsB;gBAApB,OAAO,aAAA,EAAE,SAAS,eAAA;YACpD,OAAA,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;QAAnC,CAAmC,CACpC,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IACH,aAAC;AAAD,CAAC,AA5RD,IA4RC;AA5RY,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Module/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,uCAKmB;AAEnB,gDAA8D;AAC9D,0CAAqD;AAErD,kDAAiD;AAOjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH;IA0EE;;;;;OAKG;IACH,gBAAY,YAA4C,EAAE,OAAc;QAAd,wBAAA,EAAA,cAAc;QAAxE,iBAwBC;QAlDD,qDAAqD;QAC7C,mBAAc,GAAG,KAAK,CAAC;QAS/B,mDAAmD;QAC3C,iBAAY,GAAG,KAAK,CAAC;QAgB3B,IAAI,CAAC,IAAA,eAAM,GAAE,EAAE;YACb,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;SACzD;QAED,IAAI,CAAC,UAAU,GAAG,IAAI,qBAAS,EAAkB,CAAC;QAClD,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACrB,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAC9B,IAAI,CAAC,mBAAmB,GAAG,EAAE,CAAC;QAE9B,IAAM,KAAK,yBACN,IAAI,CAAC,gBAAgB,EAAE,GACvB,CAAC,YAAY,IAAI,EAAE,CAAC,CACxB,CAAC;QAEF,IAAI,CAAC,aAAa,GAAG,IAAI,2BAAY,CACnC,KAAsC,EACtC,cAAM,OAAA,KAAI,CAAC,cAAc,EAAE,EAArB,CAAqB,EAC3B,IAAI,CAAC,IAAI,CACV,CAAC;QAEF,IAAI,OAAO,EAAE;YACX,IAAI,CAAC,IAAI,EAAE,CAAC;SACb;IACH,CAAC;IAnGD;;OAEG;IACO,iCAAgB,GAA1B;QACE,OAAO,EAAE,CAAC;IACZ,CAAC;IAMD,sBAAI,yBAAK;QAJT;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAC,KAEzB,CAAC;QACJ,CAAC;;;OAAA;IAWD,sBAAI,6BAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;;;OAAA;IAYD,sBAAI,wBAAI;QADR,0DAA0D;aAC1D;YACE,OAAO,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAC/B,CAAC;;;OAAA;IAGD,sBAAI,0BAAM;QADV,yDAAyD;aACzD;YACE,OAAO,EAAE,CAAC;QACZ,CAAC;;;OAAA;IAQD,sBAAI,iCAAa;QAHjB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;;;OAAA;IAQD,sBAAI,+BAAW;QAHf;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,YAAY,CAAC;QAC3B,CAAC;;;OAAA;IAkCD;;;;OAIG;IACI,mCAAkB,GAAzB,UAA0B,KAAiD;QACzE,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;aAAM;YACL,IAAI,CAAC,aAAa,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;SAC9C;IACH,CAAC;IAED;;;;OAIG;IACI,4BAAW,GAAlB,UAAmB,KAA+B;QAChD,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,aAAa,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;QAEtC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACO,+BAAc,GAAxB;QACE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;IAChD,CAAC;IAED;;OAEG;IACI,qBAAI,GAAX;QACE,IAAI,IAAI,CAAC,aAAa,EAAE;YACtB,OAAO;SACR;QAED,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;QAE3B,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAED;;OAEG;IACO,sBAAK,GAAf,cAAmB,CAAC;IAEpB;;;;OAIG;IACO,qCAAoB,GAA9B,UAA+B,MAAkB;QAC/C,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACI,oCAAmB,GAA1B,UACE,MAAmC,EACnC,MAAmC,EACnC,IAAsC;QAAtC,qBAAA,EAAA,SAAsC;QAEtC,IAAM,QAAQ,GAAG,IAAA,eAAM,GAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,wBAC1D,IAAI,KACP,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,IAC3B,CAAC;QAEH,IAAI,CAAC,oBAAoB,CAAC,cAAM,OAAA,QAAQ,CAAC,MAAM,EAAE,EAAjB,CAAiB,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,4BAAW,GAAlB,UACE,MAAS,EACT,MAA6C,EAC7C,QAAmC;QAAnC,yBAAA,EAAA,aAAmC;QAEnC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED;;;;;;;OAOG;IACI,iCAAgB,GAAvB,UAKE,EAAM,EACN,MAAc,EACd,QAAkB,EAClB,OAAkC;QARpC,iBAuBC;QAbC,IAAM,QAAQ,GAAG,IAAA,4BAAgB,EAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;QACjE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE/B,6BACK,QAAQ,KACX,MAAM,EAAE;gBACN,KAAI,CAAC,UAAU,GAAG,KAAI,CAAC,UAAU,CAAC,MAAM,CACtC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,EAAE,KAAK,QAAQ,CAAC,EAAE,EAAvB,CAAuB,CAClC,CAAC;gBAEF,OAAO,QAAQ,CAAC,MAAM,EAAE,CAAC;YAC3B,CAAC,IACD;IACJ,CAAC;IAED;;;;;OAKG;IACO,0BAAS,GAAnB;QAAA,iBAEC;QAFmB,oBAAuB;aAAvB,UAAuB,EAAvB,qBAAuB,EAAvB,IAAuB;YAAvB,+BAAuB;;QACzC,OAAO,UAAU,CAAC,GAAG,CAAC,UAAC,KAAK,IAAK,OAAA,UAAG,KAAI,CAAC,MAAM,SAAG,KAAK,CAAE,EAAxB,CAAwB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;OAMG;IACO,gCAAe,GAAzB,UACE,OAAgB,EAChB,SAAiB,EACjB,QAAiB;QAEjB,IAAM,eAAe,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAE9D,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;QAE9C,IAAI,CAAC,eAAe,EAAE;YACpB,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,OAAO,SAAA,EAAE,SAAS,WAAA,EAAE,CAAC,CAAC;SACvD;IACH,CAAC;IAED;;OAEG;IACI,wBAAO,GAAd;QACE,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,OAAO;SACR;QAED,IAAI,CAAC,QAAQ,EAAE,CAAC;IAClB,CAAC;IAED;;;OAGG;IACO,yBAAQ,GAAlB;QACE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAC1C,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAE1B,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;QAE7B,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAC,MAAM,IAAK,OAAA,MAAM,EAAE,EAAR,CAAQ,CAAC,CAAC;QACvD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,UAAC,QAAQ,IAAK,OAAA,QAAQ,CAAC,MAAM,EAAE,EAAjB,CAAiB,CAAC,CAAC;QAEzD,IAAI,CAAC,mBAAmB,CAAC,OAAO,CAAC,UAAC,EAAsB;gBAApB,OAAO,aAAA,EAAE,SAAS,eAAA;YACpD,OAAA,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC;QAAnC,CAAmC,CACpC,CAAC;QAEF,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;IAC3B,CAAC;IACH,aAAC;AAAD,CAAC,AA3SD,IA2SC;AA3SY,wBAAM"}

package/lib/cjs/base/MutableProps/index.js

@@ -23,89 +23,60 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MutableProps = void 0;
 var getApp_1 = require("../../utils/internal/getApp");
 /**
- * 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' });
  */
 var MutableProps = /** @class */ (function () {
     /**
-     * @example
-     *
-     * const static = {
-     *   myProp: true,
-     * };
+     * Initializes the `MutableProps` instance with static and changeable properties,
+     * and sets up a mutation callback to be called when properties change.
      *
-     * const responsive = [
-     *   {
-     *     breakpoint: 'm',
-     *     settings: {
-     *       myProp: false
-     *     }
-     *   }
-     * ];
-     *
-     * 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.
      */
-    function MutableProps(
-    /**
-     * The properties that were set while initialization.
-     * These properties will nevet change.
-     */
-    _initProps, 
-    /**
-     * A callback that is launched when properties are changed
-     */
-    _onMutate, 
-    /**
-     * Name of the responsive properties.
-     */
-    _name) {
+    function MutableProps(initProps, _onMutate, _name) {
         if (_onMutate === void 0) { _onMutate = function () { }; }
         if (_name === void 0) { _name = 'Responsive Props'; }
-        this._initProps = _initProps;
         this._onMutate = _onMutate;
         this._name = _name;
         /**
-         * 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.
          */
         this._responsiveRules = [];
-        this._refProps = __assign({}, _initProps);
-        this._props = __assign({}, _initProps);
+        this._refProps = __assign({}, initProps);
+        this._props = __assign({}, initProps);
         this._activeBreakpoints = [];
     }
     Object.defineProperty(MutableProps.prototype, "props", {
         /**
-         * Get current properties
+         * Retrieves the current properties.
+         * These may change either due to responsive rules or through manual updates.
          */
         get: function () {
             return this._props;
@@ -114,18 +85,21 @@ var MutableProps = /** @class */ (function () {
         configurable: true
     });
     /**
-     * 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.
      */
     MutableProps.prototype.addResponsiveProps = function (rules) {
         this._responsiveRules.push(rules);
         this._responseProps();
-        if (typeof this._viewportCallback !== 'undefined') {
+        if (this._viewportCallback) {
             return;
         }
         this._viewportCallback = (0, getApp_1.getApp)().viewport.callbacks.add('width', this._responseProps.bind(this), { name: this._name });
     };
     /**
-     * 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.
      */
     MutableProps.prototype._responseProps = function () {
         var _this = this;
@@ -135,8 +109,7 @@ var MutableProps = /** @class */ (function () {
         var statProp = __assign({}, this._refProps);
         var prevActiveBreakpointsString = __spreadArray([], this._activeBreakpoints, true).join('_');
         this._activeBreakpoints = [];
-        // go through all breakpoints
-        // and check if a proper breakpoint exists
+        // Evaluate each responsive rule to see if it should be applied
         this._responsiveRules.forEach(function (_a) {
             var settings = _a.settings, breakpoint = _a.breakpoint;
             if (typeof breakpoint === 'number') {
@@ -173,13 +146,15 @@ var MutableProps = /** @class */ (function () {
             // otherwise, change the properties
             this._props = __assign(__assign({}, this._props), newProps);
         }
-        // callback
+        // Call the mutation callback if properties have changed
         if (isPropsChanged) {
             this._onMutate();
         }
     };
     /**
-     * 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.
      */
     MutableProps.prototype.changeProps = function (props) {
         this._props = __assign(__assign({}, this._props), props);
@@ -187,7 +162,7 @@ var MutableProps = /** @class */ (function () {
         this._onMutate();
     };
     /**
-     * Destroy the responsive properties.
+     * Cleans up and destroys the responsive properties.
      */
     MutableProps.prototype.destroy = function () {
         if (this._viewportCallback) {

package/lib/cjs/base/MutableProps/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/MutableProps/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAiD;AAMjD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH;IA6CE;;;;;;;;;;;;;;;;;OAiBG;IACH;IACE;;;OAGG;IACK,UAAyC;IACjD;;OAEG;IACK,SAAgC;IACxC;;OAEG;IACK,KAA0B;QAJ1B,0BAAA,EAAA,0BAA+B,CAAC;QAIhC,sBAAA,EAAA,0BAA0B;QAR1B,eAAU,GAAV,UAAU,CAA+B;QAIzC,cAAS,GAAT,SAAS,CAAuB;QAIhC,UAAK,GAAL,KAAK,CAAqB;QArDpC;;WAEG;QACK,qBAAgB,GAAiD,EAAE,CAAC;QAoD1E,IAAI,CAAC,SAAS,gBAAQ,UAAU,CAAE,CAAC;QACnC,IAAI,CAAC,MAAM,gBAAQ,UAAU,CAAE,CAAC;QAEhC,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAnDD,sBAAI,+BAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;;;OAAA;IAmDD;;OAEG;IACI,yCAAkB,GAAzB,UAA0B,KAAiD;QACzE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,OAAO,IAAI,CAAC,iBAAiB,KAAK,WAAW,EAAE;YACjD,OAAO;SACR;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAA,eAAM,GAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CACtD,OAAO,EACP,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAC9B,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CACrB,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,qCAAc,GAAtB;QAAA,iBA0DC;QAzDC,IAAM,GAAG,GAAG,IAAA,eAAM,GAAE,CAAC;QACb,IAAA,QAAQ,GAAK,GAAG,SAAR,CAAS;QAEzB,IAAI,QAAQ,GAA4C,KAAK,CAAC;QAC9D,IAAM,QAAQ,gBAAQ,IAAI,CAAC,SAAS,CAAE,CAAC;QAEvC,IAAM,2BAA2B,GAAG,kBAAI,IAAI,CAAC,kBAAkB,QAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAE7B,6BAA6B;QAC7B,0CAA0C;QAC1C,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAC,EAAwB;gBAAtB,QAAQ,cAAA,EAAE,UAAU,gBAAA;YACnD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBAClC,IAAI,QAAQ,CAAC,KAAK,IAAI,UAAU,EAAE;oBAChC,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,QAAQ,GAAK,QAAQ,CAAE,CAAC;iBACzC;aACF;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBACzC,gBAAgB;gBAChB,IACE,CAAC,UAAU,KAAK,kBAAkB,IAAI,QAAQ,CAAC,SAAS,CAAC;oBACzD,CAAC,UAAU,KAAK,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,CAAC;oBACvD,CAAC,UAAU,KAAK,gBAAgB,IAAI,QAAQ,CAAC,OAAO,CAAC,EACrD;oBACA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAK,QAAQ,CAAE,CAAC;iBACvD;gBAED,cAAc;gBACd,IACE,CAAC,UAAU,KAAK,cAAc,IAAI,GAAG,CAAC,OAAO,CAAC;oBAC9C,CAAC,UAAU,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,CAAC;oBAChD,CAAC,UAAU,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,CAAC,EAChD;oBACA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAK,QAAQ,CAAE,CAAC;iBACvD;aACF;QACH,CAAC,CAAC,CAAC;QAEH,qCAAqC;QACrC,IAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClE,IAAM,cAAc,GAClB,uBAAuB,KAAK,2BAA2B,CAAC;QAE1D,8CAA8C;QAC9C,IAAI,CAAC,QAAQ,EAAE;YACb,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAK,IAAI,CAAC,SAAS,CAAE,CAAC;SACrD;aAAM;YACL,mCAAmC;YACnC,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAM,QAAgB,CAAE,CAAC;SACxD;QAED,WAAW;QACX,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;IACH,CAAC;IAED;;OAEG;IACI,kCAAW,GAAlB,UAAmB,KAA+B;QAChD,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAK,KAAK,CAAE,CAAC;QAC3C,IAAI,CAAC,SAAS,yBAAQ,IAAI,CAAC,SAAS,GAAK,KAAK,CAAE,CAAC;QAEjD,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,8BAAO,GAAd;QACE,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;SACjC;IACH,CAAC;IACH,mBAAC;AAAD,CAAC,AAxLD,IAwLC;AAxLY,oCAAY"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/MutableProps/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAAA,kDAAiD;AAMjD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH;IAgCE;;;;;;;OAOG;IACH,sBACE,SAAwC,EAChC,SAAgC,EAChC,KAA0B;QAD1B,0BAAA,EAAA,0BAA+B,CAAC;QAChC,sBAAA,EAAA,0BAA0B;QAD1B,cAAS,GAAT,SAAS,CAAuB;QAChC,UAAK,GAAL,KAAK,CAAqB;QA3BpC;;;WAGG;QACK,qBAAgB,GAAiD,EAAE,CAAC;QAyB1E,IAAI,CAAC,SAAS,gBAAQ,SAAS,CAAE,CAAC;QAClC,IAAI,CAAC,MAAM,gBAAQ,SAAS,CAAE,CAAC;QAC/B,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;IAC/B,CAAC;IAMD,sBAAI,+BAAK;QAJT;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAC;QACrB,CAAC;;;OAAA;IAED;;;;OAIG;IACI,yCAAkB,GAAzB,UAA0B,KAAiD;QACzE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAElC,IAAI,CAAC,cAAc,EAAE,CAAC;QAEtB,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,OAAO;SACR;QAED,IAAI,CAAC,iBAAiB,GAAG,IAAA,eAAM,GAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CACtD,OAAO,EACP,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAC9B,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,CACrB,CAAC;IACJ,CAAC;IAED;;;OAGG;IACK,qCAAc,GAAtB;QAAA,iBAyDC;QAxDC,IAAM,GAAG,GAAG,IAAA,eAAM,GAAE,CAAC;QACb,IAAA,QAAQ,GAAK,GAAG,SAAR,CAAS;QAEzB,IAAI,QAAQ,GAA4C,KAAK,CAAC;QAC9D,IAAM,QAAQ,gBAAQ,IAAI,CAAC,SAAS,CAAE,CAAC;QAEvC,IAAM,2BAA2B,GAAG,kBAAI,IAAI,CAAC,kBAAkB,QAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAC3E,IAAI,CAAC,kBAAkB,GAAG,EAAE,CAAC;QAE7B,+DAA+D;QAC/D,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,UAAC,EAAwB;gBAAtB,QAAQ,cAAA,EAAE,UAAU,gBAAA;YACnD,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBAClC,IAAI,QAAQ,CAAC,KAAK,IAAI,UAAU,EAAE;oBAChC,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,QAAQ,GAAK,QAAQ,CAAE,CAAC;iBACzC;aACF;iBAAM,IAAI,OAAO,UAAU,KAAK,QAAQ,EAAE;gBACzC,gBAAgB;gBAChB,IACE,CAAC,UAAU,KAAK,kBAAkB,IAAI,QAAQ,CAAC,SAAS,CAAC;oBACzD,CAAC,UAAU,KAAK,iBAAiB,IAAI,QAAQ,CAAC,QAAQ,CAAC;oBACvD,CAAC,UAAU,KAAK,gBAAgB,IAAI,QAAQ,CAAC,OAAO,CAAC,EACrD;oBACA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAK,QAAQ,CAAE,CAAC;iBACvD;gBAED,cAAc;gBACd,IACE,CAAC,UAAU,KAAK,cAAc,IAAI,GAAG,CAAC,OAAO,CAAC;oBAC9C,CAAC,UAAU,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,CAAC;oBAChD,CAAC,UAAU,KAAK,eAAe,IAAI,GAAG,CAAC,QAAQ,CAAC,EAChD;oBACA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;oBACzC,QAAQ,yBAAQ,CAAC,QAAQ,IAAI,QAAQ,CAAC,GAAK,QAAQ,CAAE,CAAC;iBACvD;aACF;QACH,CAAC,CAAC,CAAC;QAEH,qCAAqC;QACrC,IAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClE,IAAM,cAAc,GAClB,uBAAuB,KAAK,2BAA2B,CAAC;QAE1D,8CAA8C;QAC9C,IAAI,CAAC,QAAQ,EAAE;YACb,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAK,IAAI,CAAC,SAAS,CAAE,CAAC;SACrD;aAAM;YACL,mCAAmC;YACnC,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAM,QAAgB,CAAE,CAAC;SACxD;QAED,wDAAwD;QACxD,IAAI,cAAc,EAAE;YAClB,IAAI,CAAC,SAAS,EAAE,CAAC;SAClB;IACH,CAAC;IAED;;;;OAIG;IACI,kCAAW,GAAlB,UAAmB,KAA+B;QAChD,IAAI,CAAC,MAAM,yBAAQ,IAAI,CAAC,MAAM,GAAK,KAAK,CAAE,CAAC;QAC3C,IAAI,CAAC,SAAS,yBAAQ,IAAI,CAAC,SAAS,GAAK,KAAK,CAAE,CAAC;QAEjD,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IAED;;OAEG;IACI,8BAAO,GAAd;QACE,IAAI,IAAI,CAAC,iBAAiB,EAAE;YAC1B,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC;SACjC;IACH,CAAC;IACH,mBAAC;AAAD,CAAC,AAlKD,IAkKC;AAlKY,oCAAY"}

package/lib/cjs/base/Plugin/index.js

@@ -18,23 +18,42 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Plugin = void 0;
 var Module_1 = require("../Module");
 /**
- * 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.
  */
 var Plugin = /** @class */ (function (_super) {
     __extends(Plugin, _super);
+    /**
+     * Constructs the plugin.
+     *
+     * @param initialProps - Initial static and changeable properties for the plugin.
+     */
     function Plugin(initialProps) {
         return _super.call(this, initialProps, false) || this;
     }
     Object.defineProperty(Plugin.prototype, "component", {
+        /**
+         * Retrieves the component to which this plugin is attached.
+         */
         get: function () {
             return this._component;
         },
+        /**
+         * Sets the component for this plugin. This method is called by the parent component when the plugin is added.
+         */
         set: function (value) {
             this._component = value;
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * 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.
+     */
     Plugin.prototype.init = function () {
         if (!this.component) {
             throw new Error('Component is unknown. Be sure that `plugin.component` is non-nullable.');

package/lib/cjs/base/Plugin/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Plugin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,oCAAmC;AAKnC;;GAEG;AACH;IAKU,0BAAoD;IAC5D,gBAAY,YAA4C;eACtD,kBAAM,YAAY,EAAE,KAAK,CAAC;IAC5B,CAAC;IAID,sBAAI,6BAAS;aAAb;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;aAED,UAAc,KAAK;YACjB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;;;OAJA;IAMM,qBAAI,GAAX;QACE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;SACH;QAED,iBAAM,IAAI,WAAE,CAAC;IACf,CAAC;IACH,aAAC;AAAD,CAAC,AA7BD,CAKU,eAAM,GAwBf;AA7BqB,wBAAM"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/base/Plugin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;AAAA,oCAAmC;AAKnC;;;;GAIG;AACH;IAKU,0BAAoD;IAC5D;;;;OAIG;IACH,gBAAY,YAA4C;eACtD,kBAAM,YAAY,EAAE,KAAK,CAAC;IAC5B,CAAC;IAWD,sBAAI,6BAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAC;QACzB,CAAC;QAED;;WAEG;aACH,UAAc,KAAK;YACjB,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QAC1B,CAAC;;;OAPA;IASD;;;;;OAKG;IACI,qBAAI,GAAX;QACE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;SACH;QAED,iBAAM,IAAI,WAAE,CAAC;IACf,CAAC;IACH,aAAC;AAAD,CAAC,AAlDD,CAKU,eAAM,GA6Cf;AAlDqB,wBAAM"}