@vnejs/compatibility.views.scenario.interface-with-text 0.2.1

package/dist/index.d.ts

@@ -0,0 +1,13 @@
+import "@vnejs/contracts.text";
+import "@vnejs/contracts.views.scenario.interface";
+import { ModuleCore } from "@vnejs/module.core";
+import type { ModuleGlobalStateText, TextSpeakerChangedPayload } from "@vnejs/contracts.text";
+import type { PluginConstants, PluginEvents, PluginParams, PluginSettings } from "./types.js";
+export declare class CompatibilityViewsScenarioInterfaceWithText extends ModuleCore<PluginEvents, PluginConstants, PluginSettings, PluginParams> {
+    name: string;
+    subscribe: () => void;
+    init: () => Promise<unknown[]> | undefined;
+    onTextChanged: ({ tokens, uid }?: Partial<Pick<ModuleGlobalStateText, "tokens" | "uid">>) => Promise<unknown[]> | undefined;
+    onTextSpeakerChanged: ({ speaker }?: TextSpeakerChangedPayload) => Promise<unknown[]> | undefined;
+    onTextEmitBefore: () => Promise<unknown[]> | undefined;
+}

package/dist/index.js

@@ -0,0 +1,22 @@
+import "@vnejs/contracts.text";
+import "@vnejs/contracts.views.scenario.interface";
+import { ModuleCore } from "@vnejs/module.core";
+import { regModule } from "@vnejs/shared";
+export class CompatibilityViewsScenarioInterfaceWithText extends ModuleCore {
+    name = "compatibility.views.scenario.interface-with-text";
+    subscribe = () => {
+        this.on(this.EVENTS.TEXT.CHANGED, this.onTextChanged);
+        this.on(this.EVENTS.TEXT.SPEAKER_CHANGED, this.onTextSpeakerChanged);
+    };
+    init = () => {
+        this.shared.interfaceTextShowAllTokensOnChange = true;
+        return this.emit(this.EVENTS.TEXT.EMIT_BEFORE_REG, { handler: this.onTextEmitBefore });
+    };
+    onTextChanged = ({ tokens = [], uid = "" } = {}) => {
+        const tokensVisible = this.shared.interfaceTextShowAllTokensOnChange ? tokens.length : 0;
+        return this.emit(this.EVENTS.INTERFACE.TEXT_CHANGED, { tokens, uid, tokensVisible });
+    };
+    onTextSpeakerChanged = ({ speaker } = {}) => this.emit(this.EVENTS.INTERFACE.SPEAKER_CHANGED, { speaker });
+    onTextEmitBefore = () => this.emit(this.EVENTS.INTERFACE.SHOW);
+}
+regModule(CompatibilityViewsScenarioInterfaceWithText);

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
+import type { PluginName as InterfacePluginName, SubscribeEvents as InterfaceSubscribeEvents } from "@vnejs/contracts.views.scenario.interface";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/contracts.text";
+export type PluginEvents = ModuleCoreEvents & Record<TextPluginName, TextSubscribeEvents> & Record<InterfacePluginName, InterfaceSubscribeEvents>;
+export type PluginConstants = ModuleCoreConstants;
+export type PluginSettings = ModuleCoreSettings;
+export type PluginParams = ModuleCoreParams;

package/dist/types.js

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

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@vnejs/compatibility.views.scenario.interface-with-text",
+  "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": "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.views.scenario.interface": "~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,33 @@
+import "@vnejs/contracts.text";
+import "@vnejs/contracts.views.scenario.interface";
+
+import { ModuleCore } from "@vnejs/module.core";
+import type { ModuleGlobalStateText, TextSpeakerChangedPayload } from "@vnejs/contracts.text";
+import { regModule } from "@vnejs/shared";
+
+import type { PluginConstants, PluginEvents, PluginParams, PluginSettings } from "./types.js";
+
+export class CompatibilityViewsScenarioInterfaceWithText extends ModuleCore<PluginEvents, PluginConstants, PluginSettings, PluginParams> {
+  name = "compatibility.views.scenario.interface-with-text";
+
+  subscribe = () => {
+    this.on(this.EVENTS.TEXT.CHANGED, this.onTextChanged);
+    this.on(this.EVENTS.TEXT.SPEAKER_CHANGED, this.onTextSpeakerChanged);
+  };
+
+  init = () => {
+    this.shared.interfaceTextShowAllTokensOnChange = true;
+
+    return this.emit(this.EVENTS.TEXT.EMIT_BEFORE_REG, { handler: this.onTextEmitBefore });
+  };
+
+  onTextChanged = ({ tokens = [], uid = "" }: Partial<Pick<ModuleGlobalStateText, "tokens" | "uid">> = {}) => {
+    const tokensVisible = this.shared.interfaceTextShowAllTokensOnChange ? tokens.length : 0;
+
+    return this.emit(this.EVENTS.INTERFACE.TEXT_CHANGED, { tokens, uid, tokensVisible });
+  };
+  onTextSpeakerChanged = ({ speaker }: TextSpeakerChangedPayload = {}) => this.emit(this.EVENTS.INTERFACE.SPEAKER_CHANGED, { speaker });
+  onTextEmitBefore = () => this.emit(this.EVENTS.INTERFACE.SHOW);
+}
+
+regModule(CompatibilityViewsScenarioInterfaceWithText);

package/src/tests/setup.ts

@@ -0,0 +1,23 @@
+import { SUBSCRIBE_EVENTS as TEXT_EVENTS, PLUGIN_NAME as TEXT } from "@vnejs/contracts.text";
+import { SUBSCRIBE_EVENTS as INTERFACE_EVENTS, PLUGIN_NAME as INTERFACE } from "@vnejs/contracts.views.scenario.interface";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin } from "@vnejs/test-utils";
+
+export const registerCompatibilityVne = () => {
+  registerCoreVne();
+  registerVnePlugin(TEXT, { events: TEXT_EVENTS });
+  registerVnePlugin(INTERFACE, { events: INTERFACE_EVENTS });
+};
+
+export const createCompatibilityTestModule = <T extends Parameters<typeof baseCreateTestModule>[0]>(
+  ModuleClass: T,
+  options: Parameters<typeof baseCreateTestModule>[1] = {},
+) =>
+  baseCreateTestModule(ModuleClass, {
+    shared: {
+      interfaceTextShowAllTokensOnChange: true,
+      ...(options.shared ?? {}),
+    },
+    ...options,
+  });
+
+export { INTERFACE_EVENTS, TEXT_EVENTS };

package/src/tests/text.test.ts

@@ -0,0 +1,70 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { spyEvent } from "@vnejs/test-utils";
+
+import { CompatibilityViewsScenarioInterfaceWithText } from "../index.js";
+import { createCompatibilityTestModule, INTERFACE_EVENTS, registerCompatibilityVne, TEXT_EVENTS } from "./setup.js";
+
+describe("CompatibilityViewsScenarioInterfaceWithText", () => {
+  beforeEach(() => registerCompatibilityVne());
+
+  it("init sets interfaceTextShowAllTokensOnChange and registers TEXT.EMIT_BEFORE", async () => {
+    const { module, observer, shared } = createCompatibilityTestModule(CompatibilityViewsScenarioInterfaceWithText, {
+      subscribe: false,
+      shared: { interfaceTextShowAllTokensOnChange: false },
+    });
+    const emitBeforeReg = spyEvent(observer, TEXT_EVENTS.EMIT_BEFORE_REG);
+
+    await (module as CompatibilityViewsScenarioInterfaceWithText).init();
+
+    expect(shared.interfaceTextShowAllTokensOnChange).toBe(true);
+    expect(emitBeforeReg).toHaveBeenCalledOnce();
+    expect(emitBeforeReg).toHaveBeenCalledWith({ handler: (module as CompatibilityViewsScenarioInterfaceWithText).onTextEmitBefore });
+  });
+
+  it("onTextEmitBefore shows interface", async () => {
+    const { module, observer } = createCompatibilityTestModule(CompatibilityViewsScenarioInterfaceWithText);
+    const show = spyEvent(observer, INTERFACE_EVENTS.SHOW);
+
+    await (module as CompatibilityViewsScenarioInterfaceWithText).onTextEmitBefore();
+
+    expect(show).toHaveBeenCalledOnce();
+  });
+
+  it("TEXT.CHANGED with flag true forwards all tokens as visible", async () => {
+    const { observer } = createCompatibilityTestModule(CompatibilityViewsScenarioInterfaceWithText);
+    const changed = spyEvent(observer, INTERFACE_EVENTS.TEXT_CHANGED);
+    const tokens = [
+      { token: "H", marks: [] },
+      { token: "i", marks: [] },
+    ];
+
+    await observer.emit(TEXT_EVENTS.CHANGED, { tokens, uid: "line-1" });
+
+    expect(changed).toHaveBeenCalledOnce();
+    expect(changed).toHaveBeenCalledWith({ tokens, uid: "line-1", tokensVisible: 2 });
+  });
+
+  it("TEXT.CHANGED with flag false forwards tokensVisible 0", async () => {
+    const { observer } = createCompatibilityTestModule(CompatibilityViewsScenarioInterfaceWithText, {
+      shared: { interfaceTextShowAllTokensOnChange: false },
+    });
+    const changed = spyEvent(observer, INTERFACE_EVENTS.TEXT_CHANGED);
+    const tokens = [{ token: "H", marks: [] }];
+
+    await observer.emit(TEXT_EVENTS.CHANGED, { tokens, uid: "line-2" });
+
+    expect(changed).toHaveBeenCalledOnce();
+    expect(changed).toHaveBeenCalledWith({ tokens, uid: "line-2", tokensVisible: 0 });
+  });
+
+  it("TEXT.SPEAKER_CHANGED forwards speaker to INTERFACE.SPEAKER_CHANGED", async () => {
+    const { observer } = createCompatibilityTestModule(CompatibilityViewsScenarioInterfaceWithText);
+    const speakerChanged = spyEvent(observer, INTERFACE_EVENTS.SPEAKER_CHANGED);
+
+    await observer.emit(TEXT_EVENTS.SPEAKER_CHANGED, { speaker: "hero" });
+
+    expect(speakerChanged).toHaveBeenCalledOnce();
+    expect(speakerChanged).toHaveBeenCalledWith({ speaker: "hero" });
+  });
+});

package/src/types.ts

@@ -0,0 +1,11 @@
+import type { ModuleCoreConstants, ModuleCoreEvents, ModuleCoreParams, ModuleCoreSettings } from "@vnejs/module.core";
+import type { PluginName as InterfacePluginName, SubscribeEvents as InterfaceSubscribeEvents } from "@vnejs/contracts.views.scenario.interface";
+import type { PluginName as TextPluginName, SubscribeEvents as TextSubscribeEvents } from "@vnejs/contracts.text";
+
+export type PluginEvents = ModuleCoreEvents & Record<TextPluginName, TextSubscribeEvents> & Record<InterfacePluginName, InterfaceSubscribeEvents>;
+
+export type PluginConstants = ModuleCoreConstants;
+
+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"]
+}