@vnejs/shared 0.0.11 → 0.0.13

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export type { VneNamespace, VnePluginConstants, VnePluginConstantsMap, VnePluginEvents, VnePluginEventsMap, VnePluginParams, VnePluginParamsMap, VnePluginSettings, VnePluginSettingsMap, VnePluginShape, } from "./types.js";
-import type { VneNamespace, VnePluginShape, VneRegistry } from "./types.js";
-export declare const VNE_MODULES: unknown[];
+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: unknown) => unknown;
-export declare const regPlugin: (namespace?: VneNamespace, { constants, events, settings, params }?: VnePluginShape, modules?: unknown[]) => void;
+export declare const regModule: (Module: VneModuleClass) => VneModuleClass;
+export declare const regPlugin: (namespace?: VneNamespace, { constants, events, settings, params }?: VnePluginShape, modules?: VneModuleClass[]) => void;

package/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

@@ -9,7 +9,13 @@
  *   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 {
 }
@@ -19,7 +25,15 @@ export interface VnePluginSettingsMap {
 }
 export interface VnePluginParamsMap {
 }
-/** Fallback shape for namespaces not listed in *Map interfaces. */
+/** 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 {
@@ -28,16 +42,26 @@ 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: VnePluginConstantsMap & Record<VneNamespace, VnePluginConstants>;
-    EVENTS: VnePluginEventsMap & Record<VneNamespace, VnePluginEvents>;
-    SETTINGS: VnePluginSettingsMap & Record<VneNamespace, VnePluginSettings>;
-    PARAMS: VnePluginParamsMap & Record<VneNamespace, VnePluginParams>;
+    CONST: VnePluginConstantsMapRegistry;
+    EVENTS: VnePluginEventsMapRegistry;
+    SETTINGS: VnePluginSettingsMapRegistry;
+    PARAMS: VnePluginParamsMapRegistry;
 };
 export interface VnePluginShape {
-    constants?: VnePluginConstants;
-    events?: VnePluginEvents;
-    settings?: VnePluginSettings;
-    params?: VnePluginParams;
+    constants?: VnePluginConstantsRegistry;
+    events?: VnePluginEventsRegistry;
+    settings?: VnePluginSettingsRegistry;
+    params?: VnePluginParamsRegistry;
+}
+export interface VneModule {
+    name: string;
+    isReady: boolean;
 }
+export type VneModuleClass = new () => VneModule;
+export {};

package/package.json

@@ -1,22 +1,21 @@
 {
   "name": "@vnejs/shared",
-  "version": "0.0.11",
+  "version": "0.0.13",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "src",
+    "tsconfig.json"
   ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "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"
+    "build": "npx @vnejs/monorepo package",
+    "publish:major": "npx @vnejs/monorepo publish major --access public",
+    "publish:minor": "npx @vnejs/monorepo publish minor --access public",
+    "publish:patch": "npx @vnejs/monorepo publish patch --access public"
   },
   "author": "",
-  "license": "ISC",
-  "devDependencies": {
-    "typescript": "^6.0.3"
-  }
+  "license": "ISC"
 }

package/src/index.ts

@@ -0,0 +1,49 @@
+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 const VNE_MODULES: VneModuleClass[] = [];
+
+export const VNE: VneRegistry = { CONST: {}, EVENTS: {}, SETTINGS: {}, PARAMS: {} } as VneRegistry;
+
+export const regModule = (Module: VneModuleClass) => {
+  if (Module) VNE_MODULES.push(Module);
+  return Module;
+};
+
+export const regPlugin = (
+  namespace: VneNamespace = "",
+  { constants = {}, events = {}, settings = {}, params = {} }: VnePluginShape = {},
+  modules: VneModuleClass[] = [],
+) => {
+  if (!namespace) return;
+
+  VNE.EVENTS[namespace] = events;
+  VNE.PARAMS[namespace] = params;
+  VNE.CONST[namespace] = constants;
+  VNE.SETTINGS[namespace] = settings;
+
+  modules.forEach(regModule);
+};

package/src/types.ts

@@ -0,0 +1,76 @@
+/**
+ * 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;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "noEmitOnError": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}