@vnejs/shared 0.0.10 → 0.0.12

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type { VneModule, VneModuleClass, VneNamespace, VnePluginConstants, VnePluginConstantsMap, VnePluginConstantsMapRegistry, VnePluginConstantsRegistry, VnePluginEvents, VnePluginEventsMap, VnePluginEventsMapRegistry, VnePluginEventsRegistry, VnePluginParams, VnePluginParamsMap, VnePluginParamsMapRegistry, VnePluginParamsRegistry, VnePluginSettings, VnePluginSettingsMap, VnePluginSettingsMapRegistry, VnePluginSettingsRegistry, VnePluginShape, VneRegistry, } from "./types.js";
+import type { VneModuleClass, VneNamespace, VnePluginShape, VneRegistry } from "./types.js";
+export declare const VNE_MODULES: VneModuleClass[];
+export declare const VNE: VneRegistry;
+export declare const regModule: (Module: VneModuleClass) => VneModuleClass;
+export declare const regPlugin: (namespace?: VneNamespace, { constants, events, settings, params }?: VnePluginShape, modules?: VneModuleClass[]) => void;

package/{index.js → dist/index.js}

@@ -1,6 +1,10 @@
 export const VNE_MODULES = [];
 export const VNE = { CONST: {}, EVENTS: {}, SETTINGS: {}, PARAMS: {} };
-export const regModule = (Module) => Module && VNE_MODULES.push(Module);
+export const regModule = (Module) => {
+    if (Module)
+        VNE_MODULES.push(Module);
+    return Module;
+};
 export const regPlugin = (namespace = "", { constants = {}, events = {}, settings = {}, params = {} } = {}, modules = []) => {
     if (!namespace)
         return;

package/dist/types.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Extend in consumer packages via module augmentation:
+ *
+ * @example
+ * declare module "@vnejs/shared" {
+ *   interface VnePluginEventsMap {
+ *     SCENARIO: typeof SUBSCRIBE_EVENTS;
+ *   }
+ *   interface VnePluginConstantsMap {
+ *     SCENARIO: typeof constants;
+ *   }
+ *   interface VnePluginEvents {
+ *     CUSTOM: string;
+ *   }
+ * }
+ *
+ * // Namespace and event keys may be unset until regPlugin runs:
+ * VNE.EVENTS.STORAGE?.CLEAR
+ */
+export interface VnePluginConstantsMap {
+}
+export interface VnePluginEventsMap {
+}
+export interface VnePluginSettingsMap {
+}
+export interface VnePluginParamsMap {
+}
+/** Namespace and its fields may be missing until plugins register (use `?.` when needed). */
+type OptionalPluginMapValues<T> = {
+    [K in keyof T]?: T[K] extends object ? Partial<T[K]> & T[K] : T[K];
+};
+export type VnePluginConstantsMapRegistry = OptionalPluginMapValues<VnePluginConstantsMap> & Partial<Record<string, VnePluginConstantsRegistry | undefined>>;
+export type VnePluginEventsMapRegistry = OptionalPluginMapValues<VnePluginEventsMap> & Partial<Record<string, VnePluginEventsRegistry | undefined>>;
+export type VnePluginSettingsMapRegistry = OptionalPluginMapValues<VnePluginSettingsMap> & Partial<Record<string, VnePluginSettingsRegistry | undefined>>;
+export type VnePluginParamsMapRegistry = OptionalPluginMapValues<VnePluginParamsMap> & Partial<Record<string, VnePluginParamsRegistry | undefined>>;
+/** Fallback shape for one plugin namespace not listed in *Map interfaces. */
+export interface VnePluginConstants {
+}
+export interface VnePluginEvents {
+}
+export interface VnePluginSettings {
+}
+export interface VnePluginParams {
+}
+export type VnePluginConstantsRegistry = VnePluginConstants & Partial<Record<string, never>>;
+export type VnePluginEventsRegistry = VnePluginEvents & Partial<Record<string, string>>;
+export type VnePluginSettingsRegistry = VnePluginSettings & Partial<Record<string, string>>;
+export type VnePluginParamsRegistry = VnePluginParams & Partial<Record<string, never>>;
+export type VneNamespace = keyof VnePluginConstantsMap | keyof VnePluginEventsMap | keyof VnePluginSettingsMap | keyof VnePluginParamsMap | (string & {});
+export type VneRegistry = {
+    CONST: VnePluginConstantsMapRegistry;
+    EVENTS: VnePluginEventsMapRegistry;
+    SETTINGS: VnePluginSettingsMapRegistry;
+    PARAMS: VnePluginParamsMapRegistry;
+};
+export interface VnePluginShape {
+    constants?: VnePluginConstantsRegistry;
+    events?: VnePluginEventsRegistry;
+    settings?: VnePluginSettingsRegistry;
+    params?: VnePluginParamsRegistry;
+}
+export interface VneModule {
+    name: string;
+    isReady: boolean;
+}
+export type VneModuleClass = new () => VneModule;
+export {};

package/dist/types.js

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

package/package.json

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

package/index.d.ts

@@ -1,28 +0,0 @@
-export declare const VNE_MODULES: unknown[];
-export type VneNamespace = string;
-export interface VnePluginConstants {
-    [key: string]: unknown;
-}
-export interface VnePluginEvents {
-    [key: string]: unknown;
-}
-export interface VnePluginSettings {
-    [key: string]: unknown;
-}
-export interface VnePluginParams {
-    [key: string]: unknown;
-}
-export interface VnePluginShape {
-    constants?: VnePluginConstants;
-    events?: VnePluginEvents;
-    settings?: VnePluginSettings;
-    params?: VnePluginParams;
-}
-export declare const VNE: {
-    CONST: Record<VneNamespace, VnePluginConstants>;
-    EVENTS: Record<VneNamespace, VnePluginEvents>;
-    SETTINGS: Record<VneNamespace, VnePluginSettings>;
-    PARAMS: Record<VneNamespace, VnePluginParams>;
-};
-export declare const regModule: (Module: unknown) => unknown;
-export declare const regPlugin: (namespace?: VneNamespace, { constants, events, settings, params }?: VnePluginShape, modules?: unknown[]) => void;

package/index.ts

@@ -1,56 +0,0 @@
-export const VNE_MODULES: unknown[] = [];
-
-export type VneNamespace = string;
-
-// These interfaces are intentionally empty and meant to be extended
-// by consumers via module augmentation:
-// declare module "@vnejs/shared-ts" { interface VnePluginEvents { ... } }
-export interface VnePluginConstants {
-  [key: string]: unknown;
-}
-export interface VnePluginEvents {
-  [key: string]: unknown;
-}
-export interface VnePluginSettings {
-  [key: string]: unknown;
-}
-export interface VnePluginParams {
-  [key: string]: unknown;
-}
-
-export interface VnePluginShape {
-  constants?: VnePluginConstants;
-  events?: VnePluginEvents;
-  settings?: VnePluginSettings;
-  params?: VnePluginParams;
-}
-
-export const VNE: {
-  CONST: Record<VneNamespace, VnePluginConstants>;
-  EVENTS: Record<VneNamespace, VnePluginEvents>;
-  SETTINGS: Record<VneNamespace, VnePluginSettings>;
-  PARAMS: Record<VneNamespace, VnePluginParams>;
-} = { CONST: {}, EVENTS: {}, SETTINGS: {}, PARAMS: {} } as unknown as {
-  CONST: Record<VneNamespace, VnePluginConstants>;
-  EVENTS: Record<VneNamespace, VnePluginEvents>;
-  SETTINGS: Record<VneNamespace, VnePluginSettings>;
-  PARAMS: Record<VneNamespace, VnePluginParams>;
-};
-
-export const regModule = (Module: unknown) => Module && VNE_MODULES.push(Module);
-
-export const regPlugin = (
-  namespace: VneNamespace = "",
-  { constants = {}, events = {}, settings = {}, params = {} }: VnePluginShape = {},
-  modules: unknown[] = []
-) => {
-  if (!namespace) return;
-
-  VNE.EVENTS[namespace] = events;
-  VNE.PARAMS[namespace] = params;
-  VNE.CONST[namespace] = constants;
-  VNE.SETTINGS[namespace] = settings;
-
-  modules.forEach(regModule);
-};
-

package/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ES2020",
-    "moduleResolution": "Bundler",
-    "strict": true,
-    "skipLibCheck": true,
-    "declaration": true,
-    "noEmitOnError": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["index.ts"]
-}
-