@vnejs/compatibility.text-with-scenario.history 0.2.1

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import "@vnejs/contracts.scenario.history";
+import "@vnejs/contracts.text";
+import { ModuleCore } from "@vnejs/module.core";
+import type { PluginConstants, PluginEvents, PluginParams, PluginSettings } from "./types.js";
+export declare class CompatibilityTextWithScenarioHistory extends ModuleCore<PluginEvents, PluginConstants, PluginSettings, PluginParams> {
+    name: string;
+    init: () => Promise<unknown[]> | undefined;
+    onTextEmitNext: () => Promise<unknown[] | undefined>;
+}

package/dist/index.js

@@ -0,0 +1,23 @@
+import "@vnejs/contracts.scenario.history";
+import "@vnejs/contracts.text";
+import { ModuleCore } from "@vnejs/module.core";
+import { regModule } from "@vnejs/shared";
+import { getTextSpeakerInfo } from "@vnejs/contracts.text";
+const MARK_REG = /\{.*?\}/g;
+export class CompatibilityTextWithScenarioHistory extends ModuleCore {
+    name = "compatibility.text-with-scenario.history";
+    init = () => this.emit(this.EVENTS.TEXT.EMIT_NEXT_REG, { handler: this.onTextEmitNext });
+    onTextEmitNext = async () => {
+        const texts = this.globalState.text.texts;
+        if (!texts.length)
+            return;
+        const label = this.globalState.scenario.label;
+        const text = texts[texts.length - 1].text.replace(MARK_REG, "");
+        const args = texts[texts.length - 1].args;
+        const speakerState = this.globalState["text.speaker"];
+        const speaker = speakerState.speaker;
+        const speakerInfo = await this.emitClone(getTextSpeakerInfo(speakerState, speaker));
+        return this.emit(this.EVENTS.HISTORY.ADD, { label, text, args, speaker, speakerInfo });
+    };
+}
+regModule(CompatibilityTextWithScenarioHistory);

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+import "@vnejs/contracts.scenario.history";
+import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
+import type { Constants as TextConstants, PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/contracts.text";
+import type { PluginName as HistoryPluginName, SubscribeEvents as HistorySubscribeEvents } from "@vnejs/contracts.scenario.history";
+export type PluginEvents = ModuleCoreEvents & Record<TextPluginName, TextSubscribeEvents> & Record<HistoryPluginName, HistorySubscribeEvents>;
+export type PluginConstants = ModuleCoreConstants & Record<TextPluginName, TextConstants>;
+export type PluginSettings = ModuleCoreSettings;
+export type PluginParams = ModuleCoreParams;

package/dist/types.js

@@ -0,0 +1 @@
+import "@vnejs/contracts.scenario.history";

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@vnejs/compatibility.text-with-scenario.history",
+  "version": "0.2.1",
+  "description": "",
+  "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": {
+    "test": "npx @vnejs/monorepo test",
+    "build": "npx @vnejs/monorepo package",
+    "publish:major:plugin": "npm run publish:major",
+    "publish:minor:plugin": "npm run publish:minor",
+    "publish:patch:plugin": "npm run publish:patch",
+    "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.core": "~0.2.0",
+    "@vnejs/contracts.text": "~0.2.0",
+    "@vnejs/contracts.scenario.history": "~0.2.0",
+    "@vnejs/shared": "~0.2.0"
+  },
+  "devDependencies": {
+    "@vnejs/configs.ts-common": "~0.2.0",
+    "@vnejs/configs.vitest": "~0.2.0",
+    "@vnejs/test-utils": "~0.2.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,34 @@
+import "@vnejs/contracts.scenario.history";
+import "@vnejs/contracts.text";
+
+import { ModuleCore } from "@vnejs/module.core";
+import { regModule } from "@vnejs/shared";
+
+import { getTextSpeakerInfo } from "@vnejs/contracts.text";
+
+import type { PluginConstants, PluginEvents, PluginParams, PluginSettings } from "./types.js";
+
+const MARK_REG = /\{.*?\}/g;
+
+export class CompatibilityTextWithScenarioHistory extends ModuleCore<PluginEvents, PluginConstants, PluginSettings, PluginParams> {
+  name = "compatibility.text-with-scenario.history";
+
+  init = () => this.emit(this.EVENTS.TEXT.EMIT_NEXT_REG, { handler: this.onTextEmitNext });
+
+  onTextEmitNext = async () => {
+    const texts = this.globalState.text.texts;
+
+    if (!texts.length) return;
+
+    const label = this.globalState.scenario.label;
+    const text = texts[texts.length - 1].text.replace(MARK_REG, "");
+    const args = texts[texts.length - 1].args;
+    const speakerState = this.globalState["text.speaker"];
+    const speaker = speakerState.speaker;
+    const speakerInfo = await this.emitClone(getTextSpeakerInfo(speakerState, speaker));
+
+    return this.emit(this.EVENTS.HISTORY.ADD, { label, text, args, speaker, speakerInfo });
+  };
+}
+
+regModule(CompatibilityTextWithScenarioHistory);

package/src/tests/history.test.ts

@@ -0,0 +1,41 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { spyEvent } from "@vnejs/test-utils";
+
+import { CompatibilityTextWithScenarioHistory } from "../index.js";
+import { createCompatibilityTestModule, HISTORY_EVENTS, registerCompatibilityVne, TEXT_EVENTS } from "./setup.js";
+
+describe("CompatibilityTextWithScenarioHistory", () => {
+  beforeEach(() => registerCompatibilityVne());
+
+  it("init registers TEXT.EMIT_NEXT handler", async () => {
+    const { module, observer } = createCompatibilityTestModule(CompatibilityTextWithScenarioHistory, { subscribe: false });
+    const reg = spyEvent(observer, TEXT_EVENTS.EMIT_NEXT_REG);
+
+    await (module as CompatibilityTextWithScenarioHistory).init();
+
+    expect(reg).toHaveBeenCalledOnce();
+    expect(reg.mock.calls[0]?.[0]?.handler).toEqual(expect.any(Function));
+  });
+
+  it("handler emits HISTORY.ADD with stripped text", async () => {
+    const { module, observer } = createCompatibilityTestModule(CompatibilityTextWithScenarioHistory, {
+      subscribe: false,
+      state: {
+        "text": { uid: "u1", texts: [{ text: "Hello {mark}", args: { a: 1 } }], tokens: [], speaker: "hero" },
+        "text.speaker": { speaker: "hero", args: {}, speakersInfo: {} },
+        "scenario": { curLine: 1, label: "scene" },
+      },
+    });
+    const reg = spyEvent(observer, TEXT_EVENTS.EMIT_NEXT_REG);
+    const add = spyEvent(observer, HISTORY_EVENTS.ADD);
+
+    await (module as CompatibilityTextWithScenarioHistory).init();
+
+    const handler = reg.mock.calls[0]?.[0]?.handler as () => Promise<unknown>;
+    await handler();
+
+    expect(add).toHaveBeenCalledOnce();
+    expect(add.mock.calls[0]?.[0]).toMatchObject({ label: "scene", text: "Hello ", speaker: "hero", args: { a: 1 } });
+  });
+});

package/src/tests/setup.ts

@@ -0,0 +1,25 @@
+import { PARAMS as TEXT_PARAMS, PLUGIN_NAME as TEXT, SETTINGS_KEYS as TEXT_SETTINGS, SUBSCRIBE_EVENTS as TEXT_EVENTS } from "@vnejs/contracts.text";
+import { SUBSCRIBE_EVENTS as HISTORY_EVENTS, PLUGIN_NAME as HISTORY } from "@vnejs/contracts.scenario.history";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin } from "@vnejs/test-utils";
+
+export const registerCompatibilityVne = () => {
+  registerCoreVne();
+  registerVnePlugin(TEXT, { events: TEXT_EVENTS, params: TEXT_PARAMS, settings: TEXT_SETTINGS });
+  registerVnePlugin(HISTORY, { events: HISTORY_EVENTS });
+};
+
+export const createCompatibilityTestModule = <T extends Parameters<typeof baseCreateTestModule>[0]>(
+  ModuleClass: T,
+  options: Parameters<typeof baseCreateTestModule>[1] = {},
+) =>
+  baseCreateTestModule(ModuleClass, {
+    state: {
+      "text": { uid: "", texts: [], tokens: [], speaker: "" },
+      "text.speaker": { speakers: {} },
+      "scenario": { curLine: 0, label: "start" },
+      ...(options.state ?? {}),
+    },
+    ...options,
+  });
+
+export { HISTORY_EVENTS, TEXT_EVENTS };

package/src/types.ts

@@ -0,0 +1,13 @@
+import "@vnejs/contracts.scenario.history";
+
+import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
+import type { Constants as TextConstants, PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/contracts.text";
+import type { PluginName as HistoryPluginName, SubscribeEvents as HistorySubscribeEvents } from "@vnejs/contracts.scenario.history";
+
+export type PluginEvents = ModuleCoreEvents & Record<TextPluginName, TextSubscribeEvents> & Record<HistoryPluginName, HistorySubscribeEvents>;
+
+export type PluginConstants = ModuleCoreConstants & Record<TextPluginName, TextConstants>;
+
+export type PluginSettings = ModuleCoreSettings;
+
+export type PluginParams = ModuleCoreParams;

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", "src/tests"]
+}