@vnejs/module 0.0.13 → 0.0.15

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+import type { Observer } from "@vnejs/observer";
+import type { VnePluginConstantsMapRegistry, VnePluginEventsMapRegistry, VnePluginParamsMapRegistry, VnePluginSettingsMapRegistry } from "@vnejs/shared";
+export type { ModuleGlobalState, ModuleGlobalStateRegistry, ModuleInject, ModuleMedia, ModuleShared } from "./types.js";
+import type { ModuleGlobalStateRegistry, ModuleInject, ModuleMedia, ModuleShared } from "./types.js";
+export declare class Module {
+    isReady: boolean;
+    isOnlyLocalState: boolean;
+    EVENTS: VnePluginEventsMapRegistry;
+    CONST: VnePluginConstantsMapRegistry;
+    SETTINGS: VnePluginSettingsMapRegistry;
+    PARAMS: VnePluginParamsMapRegistry;
+    observer?: Observer;
+    on: (...args: Parameters<Observer["subscribe"]>) => undefined;
+    emit: (...args: Parameters<Observer["emit"]>) => Promise<unknown[]> | undefined;
+    emitOne: (...args: Parameters<Observer["emitOne"]>) => Promise<unknown> | undefined;
+    emitReal: (...args: Parameters<Observer["emitReal"]>) => Promise<unknown> | undefined;
+    shared?: ModuleShared;
+    media?: ModuleMedia;
+    name: string;
+    globalState: ModuleGlobalStateRegistry;
+    state: unknown;
+    inject: ({ observer, state, shared, media }?: ModuleInject) => void;
+    subscribe: () => void;
+    init: () => Promise<void>;
+    setState: (state?: unknown) => void;
+    updateState: (state?: Record<string, unknown>) => void;
+    setDefaultState: () => void;
+    setStateFromGlobalState: ({ [this.name]: state }: ModuleGlobalStateRegistry) => void;
+    getState: () => unknown;
+    getDefaultState: () => {};
+    waitCheck: (checkFunc: () => boolean) => Promise<void>;
+    waitRerenderCheck: (checkFunc: () => boolean) => Promise<void>;
+    waitIsReady: () => Promise<void>;
+    waitTimeout: (time: number) => Promise<void>;
+    waitImmediate: () => Promise<void>;
+    waitRender: () => Promise<number>;
+    waitRerender: () => Promise<void>;
+    getIsReady: () => boolean;
+}

package/dist/index.js

@@ -0,0 +1,62 @@
+import { VNE } from "@vnejs/shared";
+export class Module {
+    isReady = false;
+    isOnlyLocalState = false;
+    EVENTS = VNE.EVENTS;
+    CONST = VNE.CONST;
+    SETTINGS = VNE.SETTINGS;
+    PARAMS = VNE.PARAMS;
+    observer;
+    on = (...args) => this.observer?.subscribe(...args);
+    emit = (...args) => this.observer?.emit(...args);
+    emitOne = (...args) => this.observer?.emitOne(...args);
+    emitReal = (...args) => this.observer?.emitReal(...args);
+    shared;
+    media;
+    name;
+    globalState;
+    state;
+    inject = ({ observer, state, shared, media } = {}) => {
+        this.observer = observer;
+        this.globalState = state ?? {};
+        this.setState(this.getDefaultState() || {});
+        this.shared = shared;
+        this.media = media;
+    }; // abstract
+    subscribe = () => { }; // implement
+    init = async () => { }; // implement
+    setState = (state = {}) => {
+        if (this.isOnlyLocalState) {
+            this.state = state;
+        }
+        else {
+            this.globalState[this.name] = state;
+            this.state = this.globalState[this.name];
+        }
+    }; // abstract
+    updateState = (state = {}) => this.setState({ ...this.state, ...state });
+    setDefaultState = () => this.setState(this.getDefaultState());
+    setStateFromGlobalState = ({ [this.name]: state }) => this.setState(state);
+    getState = () => this.state;
+    getDefaultState = () => ({}); // implement
+    waitCheck = async (checkFunc) => {
+        while (!checkFunc())
+            await this.waitTimeout(0);
+    };
+    waitRerenderCheck = async (checkFunc) => {
+        while (!checkFunc())
+            await this.waitRerender();
+    };
+    waitIsReady = () => this.waitCheck(this.getIsReady);
+    waitTimeout = (time) => new Promise((resolve) => setTimeout(resolve, time));
+    waitImmediate = () => new Promise((resolve) => {
+        const maybeSetImmediate = globalThis.setImmediate;
+        if (typeof maybeSetImmediate === "function")
+            maybeSetImmediate(resolve);
+        else
+            setTimeout(resolve, 0);
+    });
+    waitRender = () => new Promise((resolve) => requestAnimationFrame(resolve));
+    waitRerender = () => new Promise((resolve) => requestAnimationFrame(() => setTimeout(resolve, 0)));
+    getIsReady = () => this.isReady;
+}

package/dist/types.d.ts

@@ -0,0 +1,29 @@
+import type { Observer } from "@vnejs/observer";
+/**
+ * Extend in consumer packages via module augmentation:
+ *
+ * @example
+ * declare module "@vnejs/module" {
+ *   interface ModuleShared {
+ *     settings: Record<string, unknown>;
+ *     lang: string;
+ *   }
+ *   interface ModuleGlobalState {
+ *     text: { tokens: string[] };
+ *   }
+ * }
+ */
+export interface ModuleShared {
+}
+/** Global module state registry; defaults to string-keyed records per module name. */
+export interface ModuleGlobalState {
+}
+export type ModuleGlobalStateRegistry = ModuleGlobalState & Record<string, unknown>;
+/** Media bucket id → path/key → url or asset path. */
+export type ModuleMedia = Record<string, Record<string, string>>;
+export type ModuleInject = {
+    observer?: Observer;
+    state?: ModuleGlobalStateRegistry;
+    shared?: ModuleShared;
+    media?: ModuleMedia;
+};

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,17 +1,26 @@
 {
   "name": "@vnejs/module",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "publish:major": "npm version major && npm publish --access public",
-    "publish:minor": "npm version minor && npm publish --access public",
-    "publish:patch": "npm version patch && npm publish --access public"
+    "build": "rm -rf dist && tsc -p tsconfig.json",
+    "publish:major": "npm run build && npm version major && npm publish --access public --legacy-peer-deps",
+    "publish:minor": "npm run build && npm version minor && npm publish --access public --legacy-peer-deps",
+    "publish:patch": "npm run build && npm version patch && npm publish --access public --legacy-peer-deps"
   },
   "author": "",
   "license": "ISC",
   "peerDependencies": {
-    "@vnejs/shared": "~0.0.8"
+    "@vnejs/observer": "~0.0.1",
+    "@vnejs/shared": "~0.0.9"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.3"
   }
 }

package/index.d.ts

@@ -1,72 +0,0 @@
-import { CONST, EVENTS, PARAMS, SETTINGS } from "@vnejs/shared";
-
-declare type GlobalState = {};
-
-declare type SHARED = {};
-
-type OnFunc = (event: string, func: (arg: any) => Promise<any>) => void;
-type EmitFunc = (event: string, arg: any) => Promise<any[]>;
-type EmitOneFunc = (event: string, arg: any) => Promise<any>;
-
-type InjectArg = {
-  on: OnFunc;
-  emit: EmitFunc;
-  emitOne: EmitOneFunc;
-
-  state: GlobalState;
-
-  shared: SHARED;
-  media: Record<string, Record<string, string>>;
-  options: any;
-};
-
-declare type StateType = {};
-
-export class Module {
-  isReady: Boolean;
-
-  CONST: CONST;
-  EVENTS: EVENTS;
-  PARAMS: PARAMS;
-  SETTINGS: SETTINGS;
-
-  on: OnFunc;
-  emit: EmitFunc;
-  emitOne: EmitOneFunc;
-  emitReal: EmitOneFunc;
-
-  globalState: GlobalState;
-  state: StateType;
-
-  shared: SHARED;
-  media: Record<string, Record<string, string>>;
-  options: any;
-
-  inject: (arg: InjectArg) => void; // abstract
-
-  subscribe: () => void;
-  init: () => Promise<void>; // implement
-
-  setState: (state: StateType) => void; // abstract
-  updateState: (state: Partial<StateType>) => void; // abstract
-  setDefaultState: () => void;
-  setStateFromGlobalState: (state: GlobalState) => void;
-  getState: () => StateType;
-  getDefaultState: () => StateType; // implement
-
-  waitCheck: (checkFunc: () => Boolean) => Promise<void>;
-  waitRerenderCheck: (checkFunc: () => Boolean) => Promise<void>;
-  waitIsReady: () => Promise<void>;
-  waitTimeout: (time: number) => Promise<void>;
-  waitImmediate: () => Promise<void>;
-  waitRender: () => Promise<void>;
-  waitRerender: () => Promise<void>;
-
-  getIsReady: () => Boolean;
-}
-
-declare module "@vnejs/shared" {
-  export const VNE_MODULES: Module[];
-
-  export const regModule: (m: Module) => void;
-}

package/index.js

@@ -1 +0,0 @@
-export * from "./modules/module";

package/modules/module.js

@@ -1,62 +0,0 @@
-import { VNE } from "@vnejs/shared";
-
-export class Module {
-  isReady = false;
-  isOnlyLocalState = false;
-
-  EVENTS = VNE.EVENTS;
-  CONST = VNE.CONST;
-  SETTINGS = VNE.SETTINGS;
-  PARAMS = VNE.PARAMS;
-
-  inject = ({ on, emit, emitOne, emitReal, state, shared, media } = {}) => {
-    // observer
-    this.on = on;
-    this.emit = emit;
-    this.emitOne = emitOne;
-    this.emitReal = emitReal;
-
-    // state
-    this.globalState = state;
-    this.setState(this.getDefaultState() || {});
-
-    this.shared = shared;
-    this.media = media;
-  }; // abstract
-  subscribe = () => {}; // implement
-
-  init = async () => {}; // implement
-
-  setState = (state = {}) => {
-    if (this.isOnlyLocalState) {
-      this.state = state;
-    } else {
-      this.globalState[this.name] = state;
-      this.state = this.globalState[this.name];
-    }
-  }; // abstract
-
-  updateState = (state = {}) => this.setState({ ...this.state, ...state });
-
-  setDefaultState = () => this.setState(this.getDefaultState());
-
-  setStateFromGlobalState = ({ [this.name]: state }) => this.setState(state);
-
-  getState = () => this.state;
-
-  getDefaultState = () => ({}); // implement
-
-  waitCheck = async (checkFunc) => {
-    while (!checkFunc()) await this.waitTimeout(0);
-  };
-  waitRerenderCheck = async (checkFunc) => {
-    while (!checkFunc()) await this.waitRerender();
-  };
-  waitIsReady = () => this.waitCheck(this.getIsReady);
-  waitTimeout = (time) => new Promise((resolve) => setTimeout(resolve, time));
-  waitImmediate = () => new Promise(setImmediate);
-  waitRender = () => new Promise(requestAnimationFrame);
-  waitRerender = () => new Promise((resolve) => requestAnimationFrame(() => setTimeout(resolve, 0)));
-
-  getIsReady = () => this.isReady;
-}

package/shared.d.ts

@@ -1,7 +0,0 @@
-import { Module } from ".";
-
-declare module "@vnejs/shared" {
-  export const VNE_MODULES: Module[];
-
-  export const regModule: (m: Module) => void;
-}