@studiometa/js-toolkit 2.4.4-alpha.1 → 2.4.4-alpha.2

package/Base/index.d.ts

@@ -36,9 +36,9 @@
  */
 /**
  * Base class.
- * @template {BaseTypeParameter} [BaseInterface={ $el: HTMLElement, $options: BaseOptions, $refs: BaseRefs, $children: { [name:string]: Base | Promise<Base> } }]
+ * @template {BaseTypeParameter} [T={ $el: HTMLElement, $options: BaseOptions, $refs: BaseRefs, $children: { [name:string]: Base | Promise<Base> } }]
  */
-export default class Base<BaseInterface extends BaseTypeParameter = {
+export default class Base<T extends BaseTypeParameter = {
     $el: HTMLElement;
     $options: BaseOptions;
     $refs: BaseRefs;
@@ -81,9 +81,9 @@ export default class Base<BaseInterface extends BaseTypeParameter = {
     $id: string;
     /**
      * The root element.
-     * @type {BaseInterface['$el'] & HTMLElement & { __base__?: WeakMap<BaseConstructor, Base | 'terminated'> }}
+     * @type {T['$el'] & HTMLElement & { __base__?: WeakMap<BaseConstructor, Base | 'terminated'> }}
      */
-    $el: BaseInterface['$el'] & HTMLElement & {
+    $el: T['$el'] & HTMLElement & {
         __base__?: WeakMap<BaseConstructor, Base | 'terminated'>;
     };
     /**
@@ -124,29 +124,29 @@ export default class Base<BaseInterface extends BaseTypeParameter = {
      */
     get $services(): ServicesManager;
     /**
-     * @type {RefsManager & BaseInterface['$refs'] & BaseRefs}
+     * @type {RefsManager & T['$refs'] & BaseRefs}
      */
-    __refs: RefsManager & BaseInterface['$refs'] & BaseRefs;
+    __refs: RefsManager & T['$refs'] & BaseRefs;
     /**
-     * @returns {RefsManager & BaseInterface['$refs'] & BaseRefs}
+     * @returns {RefsManager & T['$refs'] & BaseRefs}
      */
-    get $refs(): RefsManager & BaseInterface["$refs"] & BaseRefs;
+    get $refs(): RefsManager & T["$refs"] & BaseRefs;
     /**
-     * @type {OptionsManager & BaseInterface['$options'] & BaseOptions}
+     * @type {OptionsManager & T['$options'] & BaseOptions}
      */
-    __options: OptionsManager & BaseInterface['$options'] & BaseOptions;
+    __options: OptionsManager & T['$options'] & BaseOptions;
     /**
-     * @returns {OptionsManager & BaseInterface['$options'] & BaseOptions}
+     * @returns {OptionsManager & T['$options'] & BaseOptions}
      */
-    get $options(): OptionsManager & BaseInterface["$options"] & BaseOptions;
+    get $options(): OptionsManager & T["$options"] & BaseOptions;
     /**
-     * @type {ChildrenManager & { [key in keyof BaseInterface['$children']]: Array<BaseInterface['$children'][key]> } & BaseChildren}
+     * @type {ChildrenManager & { [key in keyof T['$children']]: Array<T['$children'][key]> } & BaseChildren}
      */
-    __children: ChildrenManager & (BaseInterface["$children"] extends infer T ? { [key in keyof T]: BaseInterface["$children"][key][]; } : never) & BaseChildren;
+    __children: ChildrenManager & (T["$children"] extends infer T_1 ? { [key in keyof T_1]: T["$children"][key][]; } : never) & BaseChildren;
     /**
-     * @returns {ChildrenManager & { [key in keyof BaseInterface['$children']]: Array<BaseInterface['$children'][key]> } & BaseChildren}
+     * @returns {ChildrenManager & { [key in keyof T['$children']]: Array<T['$children'][key]> } & BaseChildren}
      */
-    get $children(): ChildrenManager & (BaseInterface["$children"] extends infer T_1 ? { [key_1 in keyof T_1]: BaseInterface["$children"][key_1][]; } : never) & BaseChildren;
+    get $children(): ChildrenManager & (T["$children"] extends infer T_2 ? { [key_1 in keyof T_2]: T["$children"][key_1][]; } : never) & BaseChildren;
     /**
      * @type {EventsManager}
      */

package/Base/types.cjs

@@ -0,0 +1,18 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// packages/js-toolkit/Base/types.ts
+var types_exports = {};
+module.exports = __toCommonJS(types_exports);
+if (module.exports.default) module.exports = module.exports.default;

package/Base/types.d.ts

@@ -0,0 +1,43 @@
+import { KeyServiceProps, LoadServiceProps, PointerServiceProps, RafServiceProps, ResizeServiceProps, ScrollServiceProps } from '../services/index.js';
+export interface BaseInterface {
+    /**
+     * Mounted hook.
+     */
+    mounted?(): void;
+    /**
+     * Updated hook.
+     */
+    updated?(): void;
+    /**
+     * Destroyed hook.
+     */
+    destroyed?(): void;
+    /**
+     * Terminated hook.
+     */
+    terminated?(): void;
+    /**
+     * Key service, executed when a keyboard key is pressed or released.
+     */
+    keyed?(props: KeyServiceProps): void;
+    /**
+     * Load service, executed when the window `load` event is fired.
+     */
+    loaded?(props: LoadServiceProps): void;
+    /**
+     * Pointer service, executed when the pointer is moving, pressed or released.
+     */
+    moved?(props: PointerServiceProps): void;
+    /**
+     * Raf service, executed on each rendered frame.
+     */
+    ticked?(props: RafServiceProps): void;
+    /**
+     * Resize service, executed when the window is resized.
+     */
+    resized?(props: ResizeServiceProps): void;
+    /**
+     * Scroll service, executed when the document is scrolled.
+     */
+    scrolled?(props: ScrollServiceProps): void;
+}

package/decorators/withScrolledInView.d.ts

@@ -139,11 +139,7 @@ export default function withScrolledInView<T extends BaseTypeParameter = BaseTyp
             $options: {
                 intersectionObserver: IntersectionObserverInit;
             };
-        } & T & U)["$options"] & import("../Base/index.js").BaseOptions; /**
-         * Set the decorator props.
-         *
-         * @returns {void}
-         */
+        } & T & U)["$options"] & import("../Base/index.js").BaseOptions;
         __children: import("../Base/managers/ChildrenManager.js").default & (({
             $options: {
                 intersectionObserver: IntersectionObserverInit;

package/index.d.ts

@@ -3,3 +3,4 @@ export * from './decorators/index.js';
 export * from './helpers/index.js';
 export * from './services/index.js';
 export type { BaseTypeParameter, BaseConstructor, BaseAsyncConstructor, BaseConfig, } from './Base/index.js';
+export type { BaseInterface } from './Base/types.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@studiometa/js-toolkit",
-  "version": "2.4.4-alpha.1",
+  "version": "2.4.4-alpha.2",
   "description": "A set of useful little bits of JavaScript to boost your project! 🚀",
   "publishConfig": {
     "access": "public"