@vnejs/contracts.core.scenario 0.1.1

package/dist/const.d.ts

@@ -0,0 +1,25 @@
+export declare const OTHER_MODULE: "other";
+export declare const LINE_KEYWORDS: {
+    readonly GLOBAL: "global";
+    readonly SKIP_IF_POSSIBLE: "skip-if-possible";
+    readonly ASYNC: "async";
+    readonly EXTEND: "extend";
+};
+export declare const LINE_PREFIXES: {
+    readonly MODULE: "$";
+    readonly BLOCK: "%";
+};
+export declare const CONSTANTS: {
+    readonly OTHER_MODULE: "other";
+    readonly LINE_KEYWORDS: {
+        readonly GLOBAL: "global";
+        readonly SKIP_IF_POSSIBLE: "skip-if-possible";
+        readonly ASYNC: "async";
+        readonly EXTEND: "extend";
+    };
+    readonly LINE_PREFIXES: {
+        readonly MODULE: "$";
+        readonly BLOCK: "%";
+    };
+};
+export type Constants = typeof CONSTANTS;

package/dist/const.js

@@ -0,0 +1,16 @@
+export const OTHER_MODULE = "other";
+export const LINE_KEYWORDS = {
+    GLOBAL: "global",
+    SKIP_IF_POSSIBLE: "skip-if-possible",
+    ASYNC: "async",
+    EXTEND: "extend",
+};
+export const LINE_PREFIXES = {
+    MODULE: "$",
+    BLOCK: "%",
+};
+export const CONSTANTS = {
+    OTHER_MODULE,
+    LINE_KEYWORDS,
+    LINE_PREFIXES,
+};

package/dist/events.d.ts

@@ -0,0 +1,16 @@
+export declare const SUBSCRIBE_EVENTS: {
+    readonly EXEC: "vne:scenario:exec";
+    readonly EXEC_REG: "vne:scenario:exec_reg";
+    readonly EXEC_DELAY: "vne:scenario:exec_delay";
+    readonly EXEC_AWAIT: "vne:scenario:exec_await";
+    readonly NEXT: "vne:scenario:next";
+    readonly LABEL_GET: "vne:scenario:label_get";
+    readonly LINE_LOAD: "vne:scenario:line_load";
+    readonly LINE_GET: "vne:scenario:line_get";
+    readonly LINE_REG: "vne:scenario:line_reg";
+    readonly LINE_LOAD_REG: "vne:scenario:line_load_reg";
+    readonly LINE_EXEC_REG: "vne:scenario:line_exec_reg";
+    readonly LINE_NEXT_REG: "vne:scenario:line_next_reg";
+    readonly LINES_GET: "vne:scenario:lines_get";
+};
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/dist/events.js

@@ -0,0 +1,15 @@
+export const SUBSCRIBE_EVENTS = {
+    EXEC: "vne:scenario:exec",
+    EXEC_REG: "vne:scenario:exec_reg",
+    EXEC_DELAY: "vne:scenario:exec_delay",
+    EXEC_AWAIT: "vne:scenario:exec_await",
+    NEXT: "vne:scenario:next",
+    LABEL_GET: "vne:scenario:label_get",
+    LINE_LOAD: "vne:scenario:line_load",
+    LINE_GET: "vne:scenario:line_get",
+    LINE_REG: "vne:scenario:line_reg",
+    LINE_LOAD_REG: "vne:scenario:line_load_reg",
+    LINE_EXEC_REG: "vne:scenario:line_exec_reg",
+    LINE_NEXT_REG: "vne:scenario:line_next_reg",
+    LINES_GET: "vne:scenario:lines_get",
+};

package/dist/handlers.d.ts

@@ -0,0 +1,12 @@
+export type LineLoadHandlerArg = {
+    line?: string;
+    args?: Record<string, unknown>;
+    label?: string;
+    deep?: number;
+    priority?: number;
+};
+export type LineExecHandlerArg = {
+    line?: string;
+    args?: Record<string, unknown>;
+    keywords?: string[];
+};

package/dist/handlers.js

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

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateScenario } from "./module-global-state.js";
+import { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+export type { ModuleGlobalStateScenario } from "./module-global-state.js";
+export { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO };
+export declare const PLUGIN_NAME: "SCENARIO";
+export type PluginName = typeof PLUGIN_NAME;
+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 { LineLoadHandlerArg, LineExecHandlerArg } from "./handlers.js";
+declare module "@vnejs/module" {
+    interface ModuleGlobalState {
+        scenario: ModuleGlobalStateScenario;
+    }
+}
+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,11 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+export { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO };
+export const PLUGIN_NAME = "SCENARIO";
+export { CONSTANTS };
+export { SUBSCRIBE_EVENTS };
+export { PARAMS };

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

@@ -0,0 +1,16 @@
+/**
+ * Extend in other contracts via module augmentation:
+ *
+ * @example
+ * declare module "@vnejs/module" {
+ *   interface ModuleGlobalState {
+ *     "my-module": MyModuleGlobalState;
+ *   }
+ * }
+ */
+export interface ModuleGlobalStateScenario {
+    label: string;
+    curLine: number;
+    hash?: string;
+}
+export declare const DEFAULT_MODULE_GLOBAL_STATE_SCENARIO: ModuleGlobalStateScenario;

package/dist/module-global-state.js

@@ -0,0 +1,5 @@
+import { PARAMS } from "./params.js";
+export const DEFAULT_MODULE_GLOBAL_STATE_SCENARIO = {
+    label: PARAMS.INIT_LABEL_NAME,
+    curLine: 0,
+};

package/dist/params.d.ts

@@ -0,0 +1,7 @@
+import type { Widen } from "@vnejs/shared";
+declare const PARAMS_DEFAULT: {
+    INIT_LABEL_NAME: string;
+};
+export type Params = Widen<typeof PARAMS_DEFAULT>;
+export declare const PARAMS: Params;
+export {};

package/dist/params.js

@@ -0,0 +1,4 @@
+const PARAMS_DEFAULT = {
+    INIT_LABEL_NAME: "init",
+};
+export const PARAMS = PARAMS_DEFAULT;

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@vnejs/contracts.core.scenario",
+  "version": "0.1.1",
+  "description": "Contracts for @vnejs/plugins.core.scenario",
+  "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,21 @@
+export const OTHER_MODULE = "other" as const;
+
+export const LINE_KEYWORDS = {
+  GLOBAL: "global",
+  SKIP_IF_POSSIBLE: "skip-if-possible",
+  ASYNC: "async",
+  EXTEND: "extend",
+} as const;
+
+export const LINE_PREFIXES = {
+  MODULE: "$",
+  BLOCK: "%",
+} as const;
+
+export const CONSTANTS = {
+  OTHER_MODULE,
+  LINE_KEYWORDS,
+  LINE_PREFIXES,
+} as const;
+
+export type Constants = typeof CONSTANTS;

package/src/events.ts

@@ -0,0 +1,17 @@
+export const SUBSCRIBE_EVENTS = {
+  EXEC: "vne:scenario:exec",
+  EXEC_REG: "vne:scenario:exec_reg",
+  EXEC_DELAY: "vne:scenario:exec_delay",
+  EXEC_AWAIT: "vne:scenario:exec_await",
+  NEXT: "vne:scenario:next",
+  LABEL_GET: "vne:scenario:label_get",
+  LINE_LOAD: "vne:scenario:line_load",
+  LINE_GET: "vne:scenario:line_get",
+  LINE_REG: "vne:scenario:line_reg",
+  LINE_LOAD_REG: "vne:scenario:line_load_reg",
+  LINE_EXEC_REG: "vne:scenario:line_exec_reg",
+  LINE_NEXT_REG: "vne:scenario:line_next_reg",
+  LINES_GET: "vne:scenario:lines_get",
+} as const;
+
+export type SubscribeEvents = typeof SUBSCRIBE_EVENTS;

package/src/handlers.ts

@@ -0,0 +1,13 @@
+export type LineLoadHandlerArg = {
+  line?: string;
+  args?: Record<string, unknown>;
+  label?: string;
+  deep?: number;
+  priority?: number;
+};
+
+export type LineExecHandlerArg = {
+  line?: string;
+  args?: Record<string, unknown>;
+  keywords?: string[];
+};

package/src/index.ts

@@ -0,0 +1,36 @@
+import "@vnejs/module";
+import "@vnejs/shared";
+
+import { CONSTANTS } from "./const.js";
+import { SUBSCRIBE_EVENTS } from "./events.js";
+import type { ModuleGlobalStateScenario } from "./module-global-state.js";
+import { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO } from "./module-global-state.js";
+import { PARAMS } from "./params.js";
+
+export type { ModuleGlobalStateScenario } from "./module-global-state.js";
+export { DEFAULT_MODULE_GLOBAL_STATE_SCENARIO };
+
+export const PLUGIN_NAME = "SCENARIO" as const;
+export type PluginName = typeof PLUGIN_NAME;
+
+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 { LineLoadHandlerArg, LineExecHandlerArg } from "./handlers.js";
+
+declare module "@vnejs/module" {
+  interface ModuleGlobalState {
+    scenario: ModuleGlobalStateScenario;
+  }
+}
+
+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,22 @@
+import { PARAMS } from "./params.js";
+
+/**
+ * Extend in other contracts via module augmentation:
+ *
+ * @example
+ * declare module "@vnejs/module" {
+ *   interface ModuleGlobalState {
+ *     "my-module": MyModuleGlobalState;
+ *   }
+ * }
+ */
+export interface ModuleGlobalStateScenario {
+  label: string;
+  curLine: number;
+  hash?: string;
+}
+
+export const DEFAULT_MODULE_GLOBAL_STATE_SCENARIO: ModuleGlobalStateScenario = {
+  label: PARAMS.INIT_LABEL_NAME,
+  curLine: 0,
+};

package/src/params.ts

@@ -0,0 +1,8 @@
+import type { Widen } from "@vnejs/shared";
+
+const PARAMS_DEFAULT = {
+  INIT_LABEL_NAME: "init",
+};
+
+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"]
+}