@vnejs/shared 0.0.9 → 0.0.10

package/index.d.ts

@@ -1,12 +1,28 @@
-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;
+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.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/index.ts

@@ -0,0 +1,56 @@
+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/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@vnejs/shared",
-  "version": "0.0.9",
+  "version": "0.0.10",
   "main": "index.js",
+  "types": "index.d.ts",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsc ./index.ts",
+    "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"

package/tsconfig.json

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