@studiometa/js-toolkit 2.0.0-rc.1 → 2.0.1

package/Base/index.cjs

@@ -75,7 +75,6 @@ var Base = class extends EventTarget {
     if (isDev) {
       this.__debug("constructor", this);
     }
-    return this;
   }
   get $root() {
     if (!this.$parent) {
@@ -214,7 +213,7 @@ var Base = class extends EventTarget {
   }
   __removeEmits(event) {
     const ctor = this.__ctor;
-    const index = ctor.config.emits.findIndex((value) => value === event);
+    const index = ctor.config.emits.indexOf(event);
     ctor.config.emits.splice(index, 1);
   }
   get __ctor() {

package/Base/index.d.ts

@@ -10,11 +10,11 @@
  */
 /**
  * @typedef {Object} BaseConfig
- * @property {String} name
- * @property {Boolean} [debug]
- * @property {Boolean} [log]
- * @property {String[]} [refs]
- * @property {String[]} [emits]
+ * @property {string} name
+ * @property {boolean} [debug]
+ * @property {boolean} [log]
+ * @property {string[]} [refs]
+ * @property {string[]} [emits]
  * @property {BaseConfigComponents} [components]
  * @property {BaseConfigOptions} [options]
  */
@@ -24,7 +24,7 @@
 export default class Base extends EventTarget {
     /**
      * This is a Base instance.
-     * @type {Boolean}
+     * @type {boolean}
      * @readonly
      */
     static readonly $isBase: boolean;
@@ -35,8 +35,8 @@ export default class Base extends EventTarget {
     /**
      * Factory method to generate multiple instance of the class.
      *
-     * @param  {String}      nameOrSelector The selector on which to mount each instance.
-     * @return {Array<Base>}                A list of the created instance.
+     * @param  {string}      nameOrSelector The selector on which to mount each instance.
+     * @returns {Array<Base>}                A list of the created instance.
      */
     static $factory(nameOrSelector: string): Array<Base>;
     /**
@@ -64,7 +64,7 @@ export default class Base extends EventTarget {
     };
     /**
      * The state of the component.
-     * @type {Boolean}
+     * @type {boolean}
      */
     $isMounted: boolean;
     /**
@@ -76,13 +76,13 @@ export default class Base extends EventTarget {
     private __eventHandlers;
     /**
      * Get the root instance of the app.
-     * @return {Base}
+     * @returns {Base}
      */
     get $root(): Base;
     /**
      * Merge configuration with the parents' configurations.
      *
-     * @return {BaseConfig}
+     * @returns {BaseConfig}
      * @private
      */
     private get __config();
@@ -101,7 +101,7 @@ export default class Base extends EventTarget {
      */
     private __refs;
     /**
-     * @return {RefsManager}
+     * @returns {RefsManager}
      */
     get $refs(): RefsManager;
     /**
@@ -110,7 +110,7 @@ export default class Base extends EventTarget {
      */
     private __options;
     /**
-     * @return {BaseOptions}
+     * @returns {BaseOptions}
      */
     get $options(): BaseOptions;
     /**
@@ -119,7 +119,7 @@ export default class Base extends EventTarget {
      */
     private __children;
     /**
-     * @return {ChildrenManager}
+     * @returns {ChildrenManager}
      */
     get $children(): ChildrenManager;
     /**
@@ -130,14 +130,14 @@ export default class Base extends EventTarget {
     /**
      * Small helper to log stuff.
      *
-     * @return {(...args: any) => void}
+     * @returns {(...args: any) => void}
      */
     get $log(): (...args: any) => void;
     /**
      * Small helper to debug information.
      *
      * @private
-     * @return {(...args:any) => void}
+     * @returns {(...args:any) => void}
      */
     private get __debug();
     /**
@@ -146,7 +146,7 @@ export default class Base extends EventTarget {
      * @private
      * @param {string} method
      * @param {any[]} args
-     * @return {void}
+     * @returns {void}
      */
     private __callMethod;
     /**
@@ -154,27 +154,27 @@ export default class Base extends EventTarget {
      *
      * @private
      * @param  {string} event The event's name.
-     * @return {boolean}      Wether the given event has been bound or not.
+     * @returns {boolean}      Wether the given event has been bound or not.
      */
     private __hasEvent;
     /**
      * Trigger the `mounted` callback.
-     * @return {this}
+     * @returns {this}
      */
     $mount(): this;
     /**
      * Update the instance children.
-     * @return {this}
+     * @returns {this}
      */
     $update(): this;
     /**
      * Trigger the `destroyed` callback.
-     * @return {this}
+     * @returns {this}
      */
     $destroy(): this;
     /**
      * Terminate a child instance when it is not needed anymore.
-     * @return {void}
+     * @returns {void}
      */
     $terminate(): void;
     /**
@@ -217,7 +217,7 @@ export default class Base extends EventTarget {
      *   Function to be called.
      * @param {boolean|AddEventListenerOptions} [options]
      *   Options for the `removeEventListener` method.
-     * @return {() => void}
+     * @returns {() => void}
      *   A function to unbind the listener.
      */
     $on(event: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): () => void;
@@ -230,8 +230,7 @@ export default class Base extends EventTarget {
      *   Function to be removed.
      * @param {boolean|EventListenerOptions} [options]
      *   Options for the `removeEventListener` method.
-     *
-     * @return {void}
+     * @returns {void}
      */
     $off(event: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
     /**
@@ -240,7 +239,7 @@ export default class Base extends EventTarget {
      * @param  {string} event
      *   Name of the event.
      * @param  {any[]}        args  The arguments to apply to the functions bound to this event.
-     * @return {void}
+     * @returns {void}
      */
     $emit(event: string, ...args: any[]): void;
 }

package/Base/index.js

@@ -49,7 +49,6 @@ class Base extends EventTarget {
     if (isDev) {
       this.__debug("constructor", this);
     }
-    return this;
   }
   get $root() {
     if (!this.$parent) {
@@ -188,7 +187,7 @@ class Base extends EventTarget {
   }
   __removeEmits(event) {
     const ctor = this.__ctor;
-    const index = ctor.config.emits.findIndex((value) => value === event);
+    const index = ctor.config.emits.indexOf(event);
     ctor.config.emits.splice(index, 1);
   }
   get __ctor() {

package/Base/managers/ChildrenManager.d.ts

@@ -49,7 +49,7 @@ export default class ChildrenManager {
      */
     private __asyncComponentPromises;
     /**
-     * @return {string[]}
+     * @returns {string[]}
      */
     get registeredNames(): string[];
     /**
@@ -75,7 +75,7 @@ export default class ChildrenManager {
      *   A Base class or a Promise for async components.
      * @param {string} name
      *   The name of the child component.
-     * @return {Base|Promise|'terminated'}
+     * @returns {Base|Promise|'terminated'}
      *   A Base instance or a Promise resolving to a Base instance.
      * @private
      */

package/Base/managers/EventsManager.d.ts

@@ -26,14 +26,14 @@ export default class EventsManager {
      * ```
      *
      * @param {string} name
-     * @return {string}
+     * @returns {string}
      */
     static normalizeName(name: string): string;
     /**
      * Normalize the event names from PascalCase to kebab-case.
      *
      * @param {string} name
-     * @return {string}
+     * @returns {string}
      */
     static normalizeEventName(name: string): string;
     /**
@@ -85,8 +85,7 @@ export default class EventsManager {
      *   The elements of the ref.
      * @param  {'add'|'remove'} [mode]
      *   The action to perform: add or remove the event listeners.
-     *
-     * @return {void}
+     * @returns {void}
      * @private
      */
     private __manageRef;
@@ -97,8 +96,7 @@ export default class EventsManager {
      *   The name of the ref.
      * @param {HTMLElement[]} elements
      *   The elements of the ref.
-     *
-     * @return {void}
+     * @returns {void}
      */
     bindRef(name: string, elements: HTMLElement[]): void;
     /**
@@ -108,8 +106,7 @@ export default class EventsManager {
      *   The name of the ref.
      * @param {HTMLElement[]} elements
      *   The elements of the ref.
-     *
-     * @return {void}
+     * @returns {void}
      */
     unbindRef(name: string, elements: HTMLElement[]): void;
     /**
@@ -121,8 +118,7 @@ export default class EventsManager {
      *   A base instance.
      * @param {'add'|'remove'} [mode]
      *   The action to perform: add or remove the event listeners.
-     *
-     * @return {void}
+     * @returns {void}
      * @private
      */
     private __manageChild;
@@ -133,8 +129,7 @@ export default class EventsManager {
      *   The name of the ref.
      * @param {Base} instance
      *   A base instance.
-     *
-     * @return {void}
+     * @returns {void}
      */
     bindChild(name: string, instance: Base): void;
     /**
@@ -144,8 +139,7 @@ export default class EventsManager {
      *   The name of the ref.
      * @param {Base} instance
      *   A base instance.
-     *
-     * @return {void}
+     * @returns {void}
      */
     unbindChild(name: string, instance: Base): void;
     /**
@@ -153,21 +147,20 @@ export default class EventsManager {
      *
      * @param {'add'|'remove'} [mode]
      *   The action to perform: add or remove the event listeners, defaults to 'add'.
-     *
-     * @return {void}
+     * @returns {void}
      * @private
      */
     private __manageRootElement;
     /**
      * Bind event methods on the root element.
      *
-     * @return {void}
+     * @returns {void}
      */
     bindRootElement(): void;
     /**
      * Unbind event method from the root element.
      *
-     * @return {void}
+     * @returns {void}
      */
     unbindRootElement(): void;
     /**
@@ -175,7 +168,7 @@ export default class EventsManager {
      *
      * @param {string} method
      * @param {string} name
-     * @return {string}
+     * @returns {string}
      * @private
      */
     private __getEventNameByMethod;
@@ -183,7 +176,7 @@ export default class EventsManager {
      * Get the base instance methods matching the `onSomething` pattern.
      *
      * @param {string} [name]
-     * @return {string[]}
+     * @returns {string[]}
      * @private
      */
     private __getEventMethodsByName;

package/Base/managers/OptionsManager.cjs

@@ -76,7 +76,6 @@ var _OptionsManager = class {
     Object.entries(schema).forEach(([name, config]) => {
       this.__register(name, config);
     });
-    return this;
   }
   __register(name, config) {
     const isObjectConfig = typeof config === "object";

package/Base/managers/OptionsManager.d.ts

@@ -2,7 +2,7 @@
  * @typedef {import('deepmerge').Options} DeepmergeOptions
  * @typedef {import('../index.js').BaseConfig} BaseConfig
  * @typedef {StringConstructor|NumberConstructor|BooleanConstructor|ArrayConstructor|ObjectConstructor} OptionType
- * @typedef {{ type: OptionType, default: String|Number|Boolean|(() => Array|Object), merge?: boolean|DeepmergeOptions }} OptionObject
+ * @typedef {{type: OptionType, default: string | number | boolean | (() => Array | Object), merge?: boolean | DeepmergeOptions}} OptionObject
  * @typedef {OptionType | OptionObject} OptionValue
  * @typedef {{ [name:string]: OptionValue }} OptionsSchema
  * @typedef {{ [optionName:string]: any }} OptionsInterface
@@ -30,7 +30,8 @@ export default class OptionsManager {
      * Get a property name.
      *
      * @param  {string} name
-     * @return {string}
+     * @param  {string} [prefix]
+     * @returns {string}
      * @private
      */
     private static __getPropertyName;
@@ -72,7 +73,7 @@ export default class OptionsManager {
     debug: boolean;
     /**
      * Default value for the log property.
-     * @type {Boolean}
+     * @type {boolean}
      */
     log: boolean;
     /**
@@ -80,32 +81,34 @@ export default class OptionsManager {
      *
      * @param  {string} name
      * @param  {OptionValue} config
-     * @return {void}
+     * @returns {void}
      * @private
      */
     private __register;
     /**
      * Get an option value.
      *
-     * @param {String} name The option name.
-     * @param {OptionType} type The option data's type.
-     * @param {any} defaultValue The default value for this option.
-     * @param {boolean|DeepmergeOptions} [merge] Wether to merge the value with the default or not.
+     * @param   {string} name The option name.
+     * @param   {OptionType} type The option data's type.
+     * @param   {any} defaultValue The default value for this option.
+     * @param   {boolean|DeepmergeOptions} [merge] Wether to merge the value with the default or not.
+     * @returns {any}
      */
     get(name: string, type: OptionType, defaultValue: any, merge?: boolean | DeepmergeOptions): any;
     /**
      * Set an option value.
      *
-     * @param {String} name The option name.
+     * @param {string} name The option name.
      * @param {OptionType} type The option data's type.
      * @param {any} value The new value for this option.
+     * @param {any} defaultValue The default value for this option.
      */
     set(name: string, type: OptionType, value: any, defaultValue: any): void;
     /**
      * Test if the element has a given property.
      *
      * @param  {string} prop
-     * @return {boolean}
+     * @returns {boolean}
      */
     __hasProperty(prop: string): boolean;
 }

package/Base/managers/OptionsManager.js

@@ -50,7 +50,6 @@ const _OptionsManager = class {
     Object.entries(schema).forEach(([name, config]) => {
       this.__register(name, config);
     });
-    return this;
   }
   __register(name, config) {
     const isObjectConfig = typeof config === "object";

package/Base/managers/RefsManager.d.ts

@@ -12,7 +12,7 @@ export default class RefsManager {
      * Normalize the name of ref.
      *
      * @param {string} name The original name.
-     * @return {string}     The normalized name.
+     * @returns {string}     The normalized name.
      */
     static normalizeRefName(name: string): string;
     /**
@@ -50,13 +50,13 @@ export default class RefsManager {
     /**
      * Register all refs.
      *
-     * @return {void}
+     * @returns {void}
      */
     registerAll(): void;
     /**
      * Unregister all refs.
      *
-     * @return {void}
+     * @returns {void}
      */
     unregisterAll(): void;
     /**
@@ -77,7 +77,7 @@ export default class RefsManager {
      * Filter refs belonging to the related Base instance.
      *
      * @param {HTMLElement} ref The ref to test.
-     * @return {boolean}
+     * @returns {boolean}
      * @private
      */
     private __filterRefsBelongingToInstance;

package/Base/managers/ServicesManager.cjs

@@ -71,6 +71,9 @@ var ServicesManager = class {
     const { has } = this.__services[service]();
     return has(this.__base.$id);
   }
+  get(service) {
+    return this.__services[service]().props();
+  }
   enable(service) {
     if (this.has(service)) {
       return this.disable.bind(this, service);

package/Base/managers/ServicesManager.d.ts

@@ -23,47 +23,53 @@ export default class ServicesManager {
      */
     __customServices: Record<string, () => ServiceInterface>;
     /**
-     * @return {Record<string, () => ServiceInterface>}
+     * @returns {Record<string, () => ServiceInterface>}
      */
     get __services(): Record<string, () => ServiceInterface>;
     /**
      * Test if the given service is registered.
      *
      * @param  {ServiceName} service The name of the service.
-     * @return {Boolean}
+     * @returns {boolean}
      */
     has(service: ServiceName): boolean;
+    /**
+     * Get a service props by name.
+     * @param   {ServiceName} service The name of the service.
+     * @returns {ReturnType<ServiceInterface['props']>}
+     */
+    get(service: ServiceName): ReturnType<ServiceInterface['props']>;
     /**
      * Init the given service and bind it to the given instance.
      *
      * @param  {ServiceName} service The name of the service.
-     * @return {() => void}          A function to unbind the service.
+     * @returns {() => void}          A function to unbind the service.
      */
     enable(service: ServiceName): () => void;
     /**
      * Enable all services and return methods to disable them.
      *
-     * @return {Function[]}
+     * @returns {Function[]}
      */
     enableAll(): Function[];
     /**
      * Disable all services.
      *
-     * @return {void}
+     * @returns {void}
      */
     disableAll(): void;
     /**
      * Disable a service.
      *
-     * @param  {String} service  The name of the service.
-     * @return {void}
+     * @param  {string} service  The name of the service.
+     * @returns {void}
      */
     disable(service: string): void;
     /**
      * Toggle a service.
      * @param  {string}  service    The name of the service.
      * @param  {boolean} [force] The state to force.
-     * @return {void}
+     * @returns {void}
      */
     toggle(service: string, force?: boolean): void;
     /**

package/Base/managers/ServicesManager.js

@@ -45,6 +45,9 @@ class ServicesManager {
     const { has } = this.__services[service]();
     return has(this.__base.$id);
   }
+  get(service) {
+    return this.__services[service]().props();
+  }
   enable(service) {
     if (this.has(service)) {
       return this.disable.bind(this, service);

package/Base/utils.d.ts

@@ -5,18 +5,18 @@
  * Test if an object has a method.
  *
  * @param  {Object}  obj  The object to test
- * @param  {String}  name The method's name
- * @return {Boolean}
+ * @param  {string}  name The method's name
+ * @returns {boolean}
  */
 export function hasMethod(obj: any, name: string): boolean;
 /**
  * Get a list of elements based on the name of a component.
  *
- * @param {String} nameOrSelector
+ * @param {string} nameOrSelector
  *   The name or selector to used for this component.
  * @param {HTMLElement|Document} element
  *   The root element on which to query the selector, defaults to `document`.
- * @return {Array<HTMLElement>}
+ * @returns {Array<HTMLElement>}
  *   A list of elements on which the component should be mounted.
  */
 export function getComponentElements(nameOrSelector: string, element?: HTMLElement | Document): Array<HTMLElement>;

package/decorators/withBreakpointManager.cjs

@@ -65,7 +65,6 @@ function withBreakpointManager(BaseClass, breakpoints) {
         testBreakpoints(instances.get(this));
       });
       this.instances = instances.get(this);
-      return this;
     }
     $mount() {
       super.$mount();

package/decorators/withBreakpointManager.d.ts

@@ -2,8 +2,8 @@
  * BreakpointManager class.
  * @template {BaseConstructor} T
  * @param {T} BaseClass
- * @param {Array<[String, BaseConstructor]>} breakpoints
- * @return {T}
+ * @param {Array<[string, BaseConstructor]>} breakpoints
+ * @returns {T}
  */
 export default function withBreakpointManager<T extends typeof import("../Base").default>(BaseClass: T, breakpoints: Array<[string, BaseConstructor]>): T;
 export type Base = import('../Base').default;

package/decorators/withBreakpointManager.js

@@ -38,7 +38,6 @@ function withBreakpointManager(BaseClass, breakpoints) {
         testBreakpoints(instances.get(this));
       });
       this.instances = instances.get(this);
-      return this;
     }
     $mount() {
       super.$mount();

package/decorators/withBreakpointObserver.cjs

@@ -87,10 +87,9 @@ function withBreakpointObserver(BaseClass) {
       });
       mutationObserver.observe(this.$el, { attributes: true });
       if (!hasBreakpointConfiguration(this)) {
-        return this;
+        return;
       }
       addToResize(key, this);
-      return this;
     }
     $mount() {
       if (!hasBreakpointConfiguration(this)) {

package/decorators/withBreakpointObserver.d.ts

@@ -3,7 +3,7 @@
  *
  * @template {BaseConstructor} T
  * @param {T} BaseClass The Base class to extend from.
- * @return {T}
+ * @returns {T}
  */
 export default function withBreakpointObserver<T extends typeof import("../Base").default>(BaseClass: T): T;
 export type Base = import('../Base').default;

package/decorators/withBreakpointObserver.js

@@ -61,10 +61,9 @@ function withBreakpointObserver(BaseClass) {
       });
       mutationObserver.observe(this.$el, { attributes: true });
       if (!hasBreakpointConfiguration(this)) {
-        return this;
+        return;
       }
       addToResize(key, this);
-      return this;
     }
     $mount() {
       if (!hasBreakpointConfiguration(this)) {

package/decorators/withDrag.d.ts

@@ -12,7 +12,7 @@
  * @template {BaseConstructor} T
  * @param {T} BaseClass
  * @param {DragDecoratorOptions} options
- * @return {T}
+ * @returns {T}
  */
 export default function withDrag<T extends typeof import("../Base").default>(BaseClass: T, { target, ...options }?: DragDecoratorOptions): T;
 export type Base = import('../Base').default;

package/decorators/withExtraConfig.d.ts

@@ -10,7 +10,7 @@
  * @param {T} BaseClass The Base class to extend.
  * @param {Partial<BaseConfig>} config Extra configuration to merge.
  * @param {DeepmergeOptions} options Options for the `deepmerge` function. {@link https://github.com/TehShrike/deepmerge#options}
- * @return {T}
+ * @returns {T}
  */
 export default function withExtraConfig<T extends typeof import("../Base").default>(BaseClass: T, config: Partial<BaseConfig>, options?: DeepmergeOptions): T;
 export type DeepmergeOptions = import('deepmerge').Options;