@vnejs/plugins.save.contract 0.0.2

package/dist/const.d.ts

@@ -0,0 +1,27 @@
+export declare const EXEC_ACTIONS: {
+    readonly KEY: "key";
+};
+export declare const LOGS_ACTIONS: {
+    readonly GET: "GET";
+    readonly SAVE: "save";
+    readonly LOAD: "load";
+    readonly DELETE: "delete";
+    readonly PRELOAD: "preload";
+    readonly CLEAR: "clear";
+    readonly KEY: "key";
+};
+export declare const CONSTANTS: {
+    readonly EXEC_ACTIONS: {
+        readonly KEY: "key";
+    };
+    readonly LOGS_ACTIONS: {
+        readonly GET: "GET";
+        readonly SAVE: "save";
+        readonly LOAD: "load";
+        readonly DELETE: "delete";
+        readonly PRELOAD: "preload";
+        readonly CLEAR: "clear";
+        readonly KEY: "key";
+    };
+};
+export type Constants = typeof CONSTANTS;

package/dist/const.js

@@ -0,0 +1,16 @@
+export const EXEC_ACTIONS = {
+    KEY: "key",
+};
+export const LOGS_ACTIONS = {
+    GET: "GET",
+    SAVE: "save",
+    LOAD: "load",
+    DELETE: "delete",
+    PRELOAD: "preload",
+    CLEAR: "clear",
+    KEY: "key",
+};
+export const CONSTANTS = {
+    EXEC_ACTIONS,
+    LOGS_ACTIONS,
+};

package/dist/events.d.ts

@@ -0,0 +1,11 @@
+export declare const SUBSCRIBE_EVENTS: {
+    readonly GET: "vne:save:get";
+    readonly CLEAR: "vne:save:clear";
+    readonly DELETE: "vne:save:delete";
+    readonly CREATE: "vne:save:create";
+    readonly KEY: "vne:save:key";
+    readonly SCREENSHOT: "vne:save:screenshot";
+    readonly LOAD: "vne:save:load";
+    readonly PRELOAD: "vne:save:preload";
+};
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/dist/events.js

@@ -0,0 +1,10 @@
+export const SUBSCRIBE_EVENTS = {
+    GET: "vne:save:get",
+    CLEAR: "vne:save:clear",
+    DELETE: "vne:save:delete",
+    CREATE: "vne:save:create",
+    KEY: "vne:save:key",
+    SCREENSHOT: "vne:save:screenshot",
+    LOAD: "vne:save:load",
+    PRELOAD: "vne:save:preload",
+};

package/dist/index.d.ts

@@ -0,0 +1,45 @@
+import type { ModuleGlobalState } from "@vnejs/module";
+import { CONSTANTS as StateConstants } from "@vnejs/plugins.core.state.contract";
+import "@vnejs/module";
+import "@vnejs/shared";
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateSaveKey } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+export declare const PLUGIN_NAME: "SAVE";
+export type PluginName = typeof PLUGIN_NAME;
+export type { ModuleGlobalStateSaveKey } from "./module-global-state.js";
+export { CONSTANTS };
+export type { Constants } from "./const.js";
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { PARAMS };
+export type { Params } from "./params.js";
+export type SaveMigrateStatus = (typeof StateConstants.MIGRATE_STATUS)[keyof typeof StateConstants.MIGRATE_STATUS];
+export type SaveRecord = {
+    state: ModuleGlobalState;
+    ts: number;
+    key?: string;
+    screen?: string;
+    migrateStatus?: SaveMigrateStatus;
+};
+export type SaveKeyPayload = {
+    key?: string;
+};
+export type SaveCreatePayload = {
+    key?: string;
+    withScreenshot?: boolean;
+};
+declare module "@vnejs/module" {
+    interface ModuleGlobalState {
+        "save.key": ModuleGlobalStateSaveKey;
+    }
+}
+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,9 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import { PARAMS } from "./params.js";
+export const PLUGIN_NAME = "SAVE";
+export { CONSTANTS };
+export { SUBSCRIBE_EVENTS };
+export { PARAMS };

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

@@ -0,0 +1,3 @@
+export type ModuleGlobalStateSaveKey = {
+    key: string;
+};

package/dist/module-global-state.js

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

package/dist/params.d.ts

@@ -0,0 +1,5 @@
+export declare const SCREENSHOT_QUALITY: 0.5;
+export declare const PARAMS: {
+    readonly SCREENSHOT_QUALITY: 0.5;
+};
+export type Params = typeof PARAMS;

package/dist/params.js

@@ -0,0 +1,4 @@
+export const SCREENSHOT_QUALITY = 0.5;
+export const PARAMS = {
+    SCREENSHOT_QUALITY,
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@vnejs/plugins.save.contract",
+  "version": "0.0.2",
+  "description": "Contracts for @vnejs/plugins.save",
+  "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.0.1",
+    "@vnejs/plugins.core.state.contract": "~0.0.1",
+    "@vnejs/shared": "~0.0.9"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.0.1"
+  }
+}

package/src/const.ts

@@ -0,0 +1,20 @@
+export const EXEC_ACTIONS = {
+  KEY: "key",
+} as const;
+
+export const LOGS_ACTIONS = {
+  GET: "GET",
+  SAVE: "save",
+  LOAD: "load",
+  DELETE: "delete",
+  PRELOAD: "preload",
+  CLEAR: "clear",
+  KEY: "key",
+} as const;
+
+export const CONSTANTS = {
+  EXEC_ACTIONS,
+  LOGS_ACTIONS,
+} as const;
+
+export type Constants = typeof CONSTANTS;

package/src/events.ts

@@ -0,0 +1,15 @@
+export const SUBSCRIBE_EVENTS = {
+  GET: "vne:save:get",
+  CLEAR: "vne:save:clear",
+  DELETE: "vne:save:delete",
+  CREATE: "vne:save:create",
+
+  KEY: "vne:save:key",
+
+  SCREENSHOT: "vne:save:screenshot",
+
+  LOAD: "vne:save:load",
+  PRELOAD: "vne:save:preload",
+} as const;
+
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/src/index.ts

@@ -0,0 +1,54 @@
+import type { ModuleGlobalState } from "@vnejs/module";
+import { CONSTANTS as StateConstants } from "@vnejs/plugins.core.state.contract";
+
+import "@vnejs/module";
+import "@vnejs/shared";
+
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateSaveKey } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+
+export const PLUGIN_NAME = "SAVE" as const;
+export type PluginName = typeof PLUGIN_NAME;
+
+export type { ModuleGlobalStateSaveKey } from "./module-global-state.js";
+export { CONSTANTS };
+export type { Constants } from "./const.js";
+export { SUBSCRIBE_EVENTS };
+export type { SubscribeEvents } from "./events.js";
+export { PARAMS };
+export type { Params } from "./params.js";
+
+export type SaveMigrateStatus = (typeof StateConstants.MIGRATE_STATUS)[keyof typeof StateConstants.MIGRATE_STATUS];
+
+export type SaveRecord = {
+  state: ModuleGlobalState;
+  ts: number;
+  key?: string;
+  screen?: string;
+  migrateStatus?: SaveMigrateStatus;
+};
+
+export type SaveKeyPayload = {
+  key?: string;
+};
+
+export type SaveCreatePayload = {
+  key?: string;
+  withScreenshot?: boolean;
+};
+
+declare module "@vnejs/module" {
+  interface ModuleGlobalState {
+    "save.key": ModuleGlobalStateSaveKey;
+  }
+}
+
+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/module-global-state.ts

@@ -0,0 +1,3 @@
+export type ModuleGlobalStateSaveKey = {
+  key: string;
+};

package/src/params.ts

@@ -0,0 +1,7 @@
+export const SCREENSHOT_QUALITY = 0.5 as const;
+
+export const PARAMS = {
+  SCREENSHOT_QUALITY,
+} as const;
+
+export type Params = typeof PARAMS;

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"]
+}