@vnejs/contracts.scales 0.1.1

package/dist/const.d.ts

@@ -0,0 +1,2 @@
+export declare const CONSTANTS: {};
+export type Constants = typeof CONSTANTS;

package/dist/const.js

@@ -0,0 +1 @@
+export const CONSTANTS = {};

package/dist/events.d.ts

@@ -0,0 +1,12 @@
+export declare const SUBSCRIBE_EVENTS: {
+    readonly SPAWN: "vne:scales:spawn";
+    readonly DESTROY: "vne:scales:destroy";
+    readonly SET: "vne:scales:set";
+    readonly RESET: "vne:scales:reset";
+    readonly CHANGE: "vne:scales:change";
+    readonly CHANGED: "vne:scales:changed";
+    readonly CHECK: "vne:scales:check";
+    readonly OVERFLOW: "vne:scales:overflow";
+    readonly UNDERFLOW: "vne:scales:underflow";
+};
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/dist/events.js

@@ -0,0 +1,11 @@
+export const SUBSCRIBE_EVENTS = {
+    SPAWN: "vne:scales:spawn",
+    DESTROY: "vne:scales:destroy",
+    SET: "vne:scales:set",
+    RESET: "vne:scales:reset",
+    CHANGE: "vne:scales:change",
+    CHANGED: "vne:scales:changed",
+    CHECK: "vne:scales:check",
+    OVERFLOW: "vne:scales:overflow",
+    UNDERFLOW: "vne:scales:underflow",
+};

package/dist/index.d.ts

@@ -0,0 +1,54 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateScales, ScaleEntry } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+export declare const PLUGIN_NAME: "SCALES";
+export type PluginName = typeof PLUGIN_NAME;
+export { CONSTANTS } from "./const.js";
+export type { Constants } from "./const.js";
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { getScaleKey } from "./keys.js";
+export type { ScaleType } from "./keys.js";
+export type { ModuleGlobalStateScales, ScaleEntry } from "./module-global-state.js";
+export { PARAMS, TYPES, ENTITIES } from "./params.js";
+export type { Params } from "./params.js";
+export type { ScaleTypes, ScaleEntities } from "./params.js";
+export type ScaleState = ScaleEntry;
+declare module "@vnejs/module" {
+    interface ModuleGlobalState {
+        scales: ModuleGlobalStateScales;
+    }
+}
+export type ScalesKeyPayload = {
+    key?: string;
+};
+export type ScalesSpawnPayload = ScalesKeyPayload & ScaleState;
+export type ScalesChangePayload = ScalesKeyPayload & {
+    shift?: number;
+};
+export type ScalesSetPayload = ScalesKeyPayload & {
+    value?: number;
+};
+export type ScalesChangedPayload = ScalesKeyPayload & {
+    value?: number;
+    type?: string;
+};
+export type ScalesCheckPayload = ScalesKeyPayload & {
+    value?: number;
+};
+export type ScalesDestroyPayload = ScalesKeyPayload;
+export type ScalesBoundaryPayload = ScalesKeyPayload & {
+    value?: number;
+    type?: string;
+};
+declare module "@vnejs/shared" {
+    interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {
+    }
+    interface VnePluginConstantsMap extends Record<typeof PLUGIN_NAME, typeof CONSTANTS> {
+    }
+    interface VnePluginParamsMap extends Record<typeof PLUGIN_NAME, typeof PARAMS> {
+    }
+}

package/dist/index.js

@@ -0,0 +1,8 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+export const PLUGIN_NAME = "SCALES";
+export { CONSTANTS } from "./const.js";
+export { SUBSCRIBE_EVENTS };
+export { getScaleKey } from "./keys.js";
+export { PARAMS, TYPES, ENTITIES } from "./params.js";

package/dist/keys.d.ts

@@ -0,0 +1,6 @@
+import type { ScaleEntry } from "./module-global-state.js";
+import type { ScaleTypes } from "./params.js";
+type ScaleTypeKeys = keyof ScaleTypes;
+export type ScaleType = [ScaleTypeKeys] extends [never] ? ScaleEntry["type"] : ScaleTypes[ScaleTypeKeys];
+export declare const getScaleKey: (entityType: string, entityId: string, scaleType: ScaleType) => string;
+export {};

package/dist/keys.js

@@ -0,0 +1 @@
+export const getScaleKey = (entityType, entityId, scaleType) => `${entityType}:${entityId}:${scaleType}`;

package/dist/module-global-state.d.ts

@@ -0,0 +1,6 @@
+export type ScaleEntry = {
+    type: string;
+    current: number;
+    max: number;
+};
+export type ModuleGlobalStateScales = Record<string, ScaleEntry>;

package/dist/module-global-state.js

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

package/dist/params.d.ts

@@ -0,0 +1,14 @@
+import type { Widen } from "@vnejs/shared";
+export interface ScaleTypes {
+}
+export interface ScaleEntities {
+}
+export declare const TYPES: ScaleTypes;
+export declare const ENTITIES: ScaleEntities;
+declare const PARAMS_DEFAULT: {
+    TYPES: ScaleTypes;
+    ENTITIES: ScaleEntities;
+};
+export type Params = Widen<typeof PARAMS_DEFAULT>;
+export declare const PARAMS: Params;
+export {};

package/dist/params.js

@@ -0,0 +1,7 @@
+export const TYPES = {};
+export const ENTITIES = {};
+const PARAMS_DEFAULT = {
+    TYPES,
+    ENTITIES,
+};
+export const PARAMS = PARAMS_DEFAULT;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@vnejs/contracts.scales",
+  "version": "0.1.1",
+  "description": "Contracts for @vnejs/plugins.scales",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src",
+    "tsconfig.json"
+  ],
+  "scripts": {
+    "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",
+  "peerDependencies": {
+    "@vnejs/module": "~0.1.0",
+    "@vnejs/shared": "~0.1.0"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.1.0"
+  }
+}

package/src/const.ts

@@ -0,0 +1,3 @@
+export const CONSTANTS = {} as const;
+
+export type Constants = typeof CONSTANTS;

package/src/events.ts

@@ -0,0 +1,13 @@
+export const SUBSCRIBE_EVENTS = {
+  SPAWN: "vne:scales:spawn",
+  DESTROY: "vne:scales:destroy",
+  SET: "vne:scales:set",
+  RESET: "vne:scales:reset",
+  CHANGE: "vne:scales:change",
+  CHANGED: "vne:scales:changed",
+  CHECK: "vne:scales:check",
+  OVERFLOW: "vne:scales:overflow",
+  UNDERFLOW: "vne:scales:underflow",
+} as const;
+
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/src/index.ts

@@ -0,0 +1,67 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateScales, ScaleEntry } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+
+export const PLUGIN_NAME = "SCALES" as const;
+export type PluginName = typeof PLUGIN_NAME;
+
+export { CONSTANTS } from "./const.js";
+export type { Constants } from "./const.js";
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { getScaleKey } from "./keys.js";
+export type { ScaleType } from "./keys.js";
+export type { ModuleGlobalStateScales, ScaleEntry } from "./module-global-state.js";
+export { PARAMS, TYPES, ENTITIES } from "./params.js";
+export type { Params } from "./params.js";
+export type { ScaleTypes, ScaleEntities } from "./params.js";
+
+export type ScaleState = ScaleEntry;
+
+declare module "@vnejs/module" {
+  interface ModuleGlobalState {
+    scales: ModuleGlobalStateScales;
+  }
+}
+
+export type ScalesKeyPayload = {
+  key?: string;
+};
+
+export type ScalesSpawnPayload = ScalesKeyPayload & ScaleState;
+
+export type ScalesChangePayload = ScalesKeyPayload & {
+  shift?: number;
+};
+
+export type ScalesSetPayload = ScalesKeyPayload & {
+  value?: number;
+};
+
+export type ScalesChangedPayload = ScalesKeyPayload & {
+  value?: number;
+  type?: string;
+};
+
+export type ScalesCheckPayload = ScalesKeyPayload & {
+  value?: number;
+};
+
+export type ScalesDestroyPayload = ScalesKeyPayload;
+
+export type ScalesBoundaryPayload = ScalesKeyPayload & {
+  value?: number;
+  type?: string;
+};
+
+declare module "@vnejs/shared" {
+  interface VnePluginEventsMap extends Record<typeof PLUGIN_NAME, typeof SUBSCRIBE_EVENTS> {}
+
+  interface VnePluginConstantsMap extends Record<typeof PLUGIN_NAME, typeof CONSTANTS> {}
+
+  interface VnePluginParamsMap extends Record<typeof PLUGIN_NAME, typeof PARAMS> {}
+}

package/src/keys.ts

@@ -0,0 +1,8 @@
+import type { ScaleEntry } from "./module-global-state.js";
+import type { ScaleTypes } from "./params.js";
+
+type ScaleTypeKeys = keyof ScaleTypes;
+
+export type ScaleType = [ScaleTypeKeys] extends [never] ? ScaleEntry["type"] : ScaleTypes[ScaleTypeKeys];
+
+export const getScaleKey = (entityType: string, entityId: string, scaleType: ScaleType) => `${entityType}:${entityId}:${scaleType}`;

package/src/module-global-state.ts

@@ -0,0 +1,3 @@
+export type ScaleEntry = { type: string; current: number; max: number };
+
+export type ModuleGlobalStateScales = Record<string, ScaleEntry>;

package/src/params.ts

@@ -0,0 +1,17 @@
+import type { Widen } from "@vnejs/shared";
+
+export interface ScaleTypes {}
+
+export interface ScaleEntities {}
+
+export const TYPES = {} as ScaleTypes;
+
+export const ENTITIES = {} as ScaleEntities;
+
+const PARAMS_DEFAULT = {
+  TYPES,
+  ENTITIES,
+};
+
+export type Params = Widen<typeof PARAMS_DEFAULT>;
+export const PARAMS: Params = PARAMS_DEFAULT;

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@vnejs/configs.ts-common/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*.ts"],
+  "exclude": ["dist", "node_modules"]
+}