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

package/decorators/withVue2.d.ts

@@ -1,7 +1,98 @@
-declare function _default<T extends typeof import("../Base").default>(BaseClass: T, Vue: import('vue').VueConstructor): T;
-export default _default;
-export type Base = import("../Base").default<any>;
-export type BaseConstructor = import('../Base').BaseConstructor;
-export type WithVue2Refs = {
-    vue: HTMLElement;
+import type Vue from 'vue';
+import type { ComponentOptions, VueConstructor } from 'vue';
+import type { BaseConstructor, BaseTypeParameter } from '../Base/index.js';
+interface WithVue2Interface {
+    $refs: {
+        vue: HTMLElement;
+    };
+}
+/**
+ * withVue decorator.
+ */
+export default function withVue2<T extends BaseTypeParameter = BaseTypeParameter, VueTypeParameter extends Vue = Vue>(BaseClass: BaseConstructor, VueCtor: VueConstructor): {
+    new <U extends BaseTypeParameter = BaseTypeParameter>(element: HTMLElement): {
+        $vue: Vue;
+        $parent: import("../Base/index.js").default<{
+            $el: HTMLElement;
+            $options: import("../Base/index.js").BaseOptions;
+            $refs: import("../Base/index.js").BaseRefs;
+            $children: {
+                [name: string]: import("../Base/index.js").default<any> | Promise<import("../Base/index.js").default<any>>;
+            };
+        }>;
+        $id: string;
+        $el: (WithVue2Interface & T & U)["$el"] & HTMLElement & {
+            __base__?: WeakMap<typeof import("../Base/index.js").default, import("../Base/index.js").default<{
+                $el: HTMLElement;
+                $options: import("../Base/index.js").BaseOptions;
+                $refs: import("../Base/index.js").BaseRefs;
+                $children: {
+                    [name: string]: import("../Base/index.js").default<any> | Promise<import("../Base/index.js").default<any>>;
+                };
+            }> | "terminated">;
+        };
+        $isMounted: boolean;
+        __eventHandlers: Map<string, Set<EventListenerOrEventListenerObject>>;
+        readonly $root: import("../Base/index.js").default<{
+            $el: HTMLElement;
+            $options: import("../Base/index.js").BaseOptions;
+            $refs: import("../Base/index.js").BaseRefs;
+            $children: {
+                [name: string]: import("../Base/index.js").default<any> | Promise<import("../Base/index.js").default<any>>;
+            };
+        }>;
+        readonly __config: import("../Base/index.js").BaseConfig;
+        __services: import("../Base/managers/ServicesManager.js").default;
+        readonly $services: import("../Base/managers/ServicesManager.js").default;
+        __refs: import("../Base/managers/RefsManager.js").default & (WithVue2Interface & T & U)["$refs"] & import("../Base/index.js").BaseRefs;
+        readonly $refs: import("../Base/managers/RefsManager.js").default & (WithVue2Interface & T & U)["$refs"] & import("../Base/index.js").BaseRefs;
+        __options: import("../Base/managers/OptionsManager.js").default & (WithVue2Interface & T & U)["$options"] & import("../Base/index.js").BaseOptions;
+        readonly $options: import("../Base/managers/OptionsManager.js").default & (WithVue2Interface & T & U)["$options"] & import("../Base/index.js").BaseOptions;
+        __children: import("../Base/managers/ChildrenManager.js").default & ((WithVue2Interface & T & U)["$children"] extends infer T_1 ? { [key in keyof T_1]: (WithVue2Interface & T & U)["$children"][key][]; } : never) & import("../Base/index.js").BaseChildren;
+        readonly $children: import("../Base/managers/ChildrenManager.js").default & ((WithVue2Interface & T & U)["$children"] extends infer T_2 ? { [key_1 in keyof T_2]: (WithVue2Interface & T & U)["$children"][key_1][]; } : never) & import("../Base/index.js").BaseChildren;
+        __events: import("../Base/managers/EventsManager.js").default;
+        readonly $log: (...args: any) => void;
+        readonly __debug: (...args: any) => void;
+        readonly __managers: import("../Base/index.js").Managers;
+        __callMethod(method: string, ...args: any[]): any;
+        __hasEvent(event: string): boolean;
+        $mount(): any;
+        $update(): any;
+        $destroy(): any;
+        $terminate(): void;
+        __addEmits(event: string): void;
+        __removeEmits(event: string): void;
+        readonly __ctor: typeof import("../Base/index.js").default;
+        $on(event: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): () => void;
+        $off(event: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+        $emit(event: string, ...args: any[]): void;
+        addEventListener(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
+        dispatchEvent(event: Event): boolean;
+        removeEventListener(type: string, callback: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void;
+    };
+    config: {
+        name: string;
+        refs: string[];
+        debug?: boolean;
+        log?: boolean;
+        emits?: string[];
+        components?: import("../Base/index.js").BaseConfigComponents;
+        options?: import("../Base/managers/OptionsManager.js").OptionsSchema;
+    };
+    /**
+     * Vue app configuration.
+     */
+    vueConfig: ComponentOptions<VueTypeParameter, import("vue/types/options.js").DefaultData<VueTypeParameter>, import("vue/types/options.js").DefaultMethods<VueTypeParameter>, import("vue/types/options.js").DefaultComputed, import("vue/types/options.js").PropsDefinition<import("vue/types/options.js").DefaultProps>, import("vue/types/options.js").DefaultProps> & {
+        render: ComponentOptions<VueTypeParameter>['render'];
+    };
+    readonly $isBase: boolean;
+    $factory(nameOrSelector: string): import("../Base/index.js").default<{
+        $el: HTMLElement;
+        $options: import("../Base/index.js").BaseOptions;
+        $refs: import("../Base/index.js").BaseRefs;
+        $children: {
+            [name: string]: import("../Base/index.js").default<any> | Promise<import("../Base/index.js").default<any>>;
+        };
+    }>[];
 };
+export {};

package/decorators/withVue2.js

@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => {
   return value;
 };
 import { isDev, isFunction } from "../utils/index.js";
-var withVue2_default = (BaseClass, Vue) => {
+function withVue2(BaseClass, VueCtor) {
   var _a, _b, _c;
   return _c = class extends BaseClass {
     constructor(element) {
@@ -25,7 +25,7 @@ var withVue2_default = (BaseClass, Vue) => {
         }
         return;
       }
-      this.$vue = new Vue(vueConfig);
+      this.$vue = new VueCtor(vueConfig);
       this.$on("mounted", () => {
         if (!(this.$refs.vue instanceof HTMLElement)) {
           throw new Error("[withVue] The `vue` refs must be a single HTMLElement.");
@@ -41,7 +41,7 @@ var withVue2_default = (BaseClass, Vue) => {
     name: `${BaseClass.config.name}WithVue`,
     refs: [...(_b = (_a = BaseClass.config) == null ? void 0 : _a.refs) != null ? _b : [], "vue"]
   }), __publicField(_c, "vueConfig"), _c;
-};
+}
 export {
-  withVue2_default as default
+  withVue2 as default
 };

package/helpers/getDirectChildren.d.ts

@@ -8,9 +8,16 @@
  * @param   {Base} parentInstance
  * @param   {string} parentName
  * @param   {string} childrenName
- * @returns {Array<T>}
+ * @returns {T[]}
  */
-export function getDirectChildren<T extends import("../Base/index.js").default<any>>(parentInstance: import("../Base/index.js").default<any>, parentName: string, childrenName: string): T[];
+export function getDirectChildren<T extends import("../Base/index.js").default<{
+    $el: HTMLElement;
+    $options: import("../Base/index.js").BaseOptions;
+    $refs: import("../Base/index.js").BaseRefs;
+    $children: {
+        [name: string]: import("../Base/index.js").default<any> | Promise<import("../Base/index.js").default<any>>;
+    };
+}>>(parentInstance: Base, parentName: string, childrenName: string): T[];
 /**
  * Test if a component instance is a direct child from the given component.
  *
@@ -20,5 +27,5 @@ export function getDirectChildren<T extends import("../Base/index.js").default<a
  * @param   {Base}    childInstance
  * @returns {boolean}
  */
-export function isDirectChild(parentInstance: import("../Base/index.js").default<any>, parentName: string, childrenName: string, childInstance: import("../Base/index.js").default<any>): boolean;
-export type Base = import("../Base/index.js").default<any>;
+export function isDirectChild(parentInstance: Base, parentName: string, childrenName: string, childInstance: Base): boolean;
+export type Base = import('../Base/index.js').default;

package/helpers/importOnInteraction.d.ts

@@ -18,6 +18,6 @@
  */
 export default function importOnInteraction<T extends typeof import("../Base/index.js").default>(fn: () => Promise<T | {
     default: T;
-}>, nameOrSelectorOrElement: string | HTMLElement | HTMLElement[], events: string | string[], parent?: import("../Base/index.js").default<any>): Promise<T>;
+}>, nameOrSelectorOrElement: string | HTMLElement | HTMLElement[], events: string | string[], parent?: Base): Promise<T>;
 export type BaseConstructor = import('../Base/index.js').BaseConstructor;
-export type Base = import("../Base/index.js").default<any>;
+export type Base = import('../Base/index.js').default;

package/helpers/importWhenVisible.d.ts

@@ -18,6 +18,6 @@
  */
 export default function importWhenVisible<T extends typeof import("../Base/index.js").default>(fn: () => Promise<T | {
     default: T;
-}>, nameOrSelectorOrElement: string | HTMLElement | HTMLElement[], parent?: import("../Base/index.js").default<any>, observerOptions?: IntersectionObserverInit): Promise<T>;
-export type Base = import("../Base/index.js").default<any>;
+}>, nameOrSelectorOrElement: string | HTMLElement | HTMLElement[], parent?: Base, observerOptions?: IntersectionObserverInit): Promise<T>;
+export type Base = import('../Base/index.js').default;
 export type BaseConstructor = import('../Base/index.js').BaseConstructor;

package/index.cjs

@@ -23,7 +23,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/js-toolkit/index.js
+// packages/js-toolkit/index.ts
 var js_toolkit_exports = {};
 __export(js_toolkit_exports, {
   Base: () => import_Base.default

package/index.d.ts

@@ -1,4 +1,5 @@
-export { default as Base } from "./Base/index.js";
-export * from "./decorators/index.js";
-export * from "./helpers/index.js";
-export * from "./services/index.js";
+export { default as Base } from './Base/index.js';
+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';

package/package.json

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

package/services/drag.d.ts

@@ -14,7 +14,7 @@
  * @param {DragServiceOptions} options
  * @returns {DragService}
  */
-export default function useDrag(target: HTMLElement, options: DragServiceOptions): DragService;
+export default function useDrag(target: HTMLElement, options: DragServiceOptions): import("./index").ServiceInterface<DragServiceProps>;
 export type DragService = import('./index').ServiceInterface<DragServiceProps>;
 export type PointerServiceProps = import('./pointer.js').PointerServiceProps;
 export type DragLifecycle = 'start' | 'drag' | 'drop' | 'inertia' | 'stop';

package/services/index.cjs

@@ -22,7 +22,7 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// packages/js-toolkit/services/index.js
+// packages/js-toolkit/services/index.ts
 var services_exports = {};
 __export(services_exports, {
   useDrag: () => import_drag.default,

package/services/index.d.ts

@@ -1,33 +1,41 @@
-export { default as useDrag } from "./drag.js";
-export { default as useKey } from "./key.js";
-export { default as useLoad } from "./load.js";
-export { default as usePointer } from "./pointer.js";
-export { default as useRaf } from "./raf.js";
-export { default as useResize } from "./resize.js";
-export { default as useScroll } from "./scroll.js";
-export { useService } from "./service.js";
-export type ServiceInterface<T> = {
+import type { DragServiceProps } from './drag.js';
+import type { KeyServiceProps } from './key.js';
+import type { LoadServiceProps } from './load.js';
+import type { PointerServiceProps } from './pointer.js';
+import type { RafServiceProps } from './raf.js';
+import type { ResizeServiceProps } from './resize.js';
+import type { ScrollServiceProps } from './scroll.js';
+export interface ServiceInterface<T> {
     /**
-     *   Remove a function from the resize service by its key.
+     * Remove a function from the resize service by its key.
      */
-    remove: (key: string) => void;
+    remove(key: string): void;
     /**
-     *   Add a callback to the service. The callback will receive the current service props as parameter.
+     * Add a callback to the service. The callback will receive the current service props as parameter.
      */
-    add: (key: string, cb: (props: T) => void) => void;
+    add(key: string, callback: (props: T) => void): void;
     /**
-     *   Test if the service has alreaydy a callback for the given key.
+     * Test if the service has alreaydy a callback for the given key.
      */
-    has: (key: string) => boolean;
+    has(key: string): boolean;
     /**
-     *   Get the service's props.
+     * Get the service's props.
      */
-    props: () => T;
-};
-export type DragServiceProps = import('./drag').DragServiceProps;
-export type KeyServiceProps = import('./key').KeyServiceProps;
-export type LoadServiceProps = import('./load').LoadServiceProps;
-export type PointerServiceProps = import('./pointer').PointerServiceProps;
-export type RafServiceProps = import('./raf').RafServiceProps;
-export type ResizeServiceProps = import('./resize').ResizeServiceProps;
-export type ScrollServiceProps = import('./scroll').ScrollServiceProps;
+    props(): T;
+}
+export declare type DragServiceInterface = ServiceInterface<DragServiceProps>;
+export declare type KeyServiceInterface = ServiceInterface<KeyServiceProps>;
+export declare type LoadServiceInterface = ServiceInterface<LoadServiceProps>;
+export declare type PointerServiceInterface = ServiceInterface<PointerServiceProps>;
+export declare type RafServiceInterface = ServiceInterface<RafServiceProps>;
+export declare type ResizeServiceInterface = ServiceInterface<ResizeServiceProps>;
+export declare type ScrollServiceInterface = ServiceInterface<ScrollServiceProps>;
+export type { DragServiceProps, KeyServiceProps, LoadServiceProps, PointerServiceProps, RafServiceProps, ResizeServiceProps, ScrollServiceProps, };
+export { default as useDrag } from './drag.js';
+export { default as useKey } from './key.js';
+export { default as useLoad } from './load.js';
+export { default as usePointer } from './pointer.js';
+export { default as useRaf } from './raf.js';
+export { default as useResize } from './resize.js';
+export { default as useScroll } from './scroll.js';
+export { useService } from './service.js';

package/services/key.d.ts

@@ -3,7 +3,7 @@
  *
  * @returns {KeyService}
  */
-export default function useKey(): KeyService;
+export default function useKey(): import("./index").ServiceInterface<KeyServiceProps>;
 export type KeyService = import('./index').ServiceInterface<KeyServiceProps>;
 export type KeyServiceProps = {
     event: KeyboardEvent;

package/services/load.d.ts

@@ -3,7 +3,7 @@
  *
  * @returns {LoadService}
  */
-export default function useLoad(): LoadService;
+export default function useLoad(): import("./index").ServiceInterface<LoadServiceProps>;
 export type LoadService = import('./index').ServiceInterface<LoadServiceProps>;
 export type LoadServiceProps = {
     time: DOMHighResTimeStamp;

package/services/pointer.d.ts

@@ -4,7 +4,7 @@
  * @todo Add element as parameter to get the pointer position relatively from.
  * @returns {PointerService}
  */
-export default function usePointer(): PointerService;
+export default function usePointer(): import("./index").ServiceInterface<PointerServiceProps>;
 export type PointerService = import('./index').ServiceInterface<PointerServiceProps>;
 export type PointerServiceProps = {
     event: MouseEvent | TouchEvent;

package/services/raf.d.ts

@@ -3,7 +3,7 @@
  *
  * @returns {RafService}
  */
-export default function useRaf(): RafService;
+export default function useRaf(): import("./index").ServiceInterface<RafServiceProps>;
 export type RafService = import('./index').ServiceInterface<RafServiceProps>;
 export type RafServiceProps = {
     time: DOMHighResTimeStamp;

package/services/resize.d.ts

@@ -3,7 +3,7 @@
  *
  * @returns {ResizeService}
  */
-export default function useResize(): ResizeService;
+export default function useResize(): import("./index").ServiceInterface<ResizeServiceProps>;
 export type ResizeService = import('./index').ServiceInterface<ResizeServiceProps>;
 export type ResizeServiceProps = {
     width: number;

package/services/scroll.d.ts

@@ -11,7 +11,7 @@
  *
  * @returns {ScrollService}
  */
-export default function useScroll(): ScrollService;
+export default function useScroll(): import("./index").ServiceInterface<ScrollServiceProps>;
 export type ScrollService = import('./index').ServiceInterface<ScrollServiceProps>;
 export type ScrollServiceProps = {
     x: number;