@vnejs/shared 0.0.9 → 0.0.11

package/dist/index.d.ts

@@ -0,0 +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 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;

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

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

package/dist/types.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Extend in consumer packages via module augmentation:
+ *
+ * @example
+ * declare module "@vnejs/shared" {
+ *   interface VnePluginEventsMap {
+ *     SCENARIO: typeof SUBSCRIBE_EVENTS;
+ *   }
+ *   interface VnePluginConstantsMap {
+ *     SCENARIO: typeof constants;
+ *   }
+ * }
+ */
+export interface VnePluginConstantsMap {
+}
+export interface VnePluginEventsMap {
+}
+export interface VnePluginSettingsMap {
+}
+export interface VnePluginParamsMap {
+}
+/** Fallback shape for namespaces not listed in *Map interfaces. */
+export interface VnePluginConstants {
+}
+export interface VnePluginEvents {
+}
+export interface VnePluginSettings {
+}
+export interface VnePluginParams {
+}
+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>;
+};
+export interface VnePluginShape {
+    constants?: VnePluginConstants;
+    events?: VnePluginEvents;
+    settings?: VnePluginSettings;
+    params?: VnePluginParams;
+}

package/dist/types.js

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

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "@vnejs/shared",
-  "version": "0.0.9",
-  "main": "index.js",
+  "version": "0.0.11",
+  "description": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc ./index.ts",
-    "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": "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,12 +0,0 @@
-declare interface CONST {}
-declare interface EVENTS {}
-declare interface PARAMS {}
-declare interface SETTINGS {}
-declare interface MODULE_EXTENSIONS {}
-
-export const VNE: {
-  CONST: CONST;
-  EVENTS: EVENTS;
-  PARAMS: PARAMS;
-  SETTINGS: SETTINGS;
-};