@vnejs/plugins.text.wall 0.1.3 → 0.1.5

package/dist/modules/wall.d.ts

@@ -6,13 +6,14 @@ import type { LineExecHandlerArg } from "@vnejs/module.core";
 import type { TextWallPluginConstants, TextWallPluginEvents, TextWallPluginParams, TextWallPluginSettings } from "../types.js";
 export declare class TextWall extends ModuleCore<TextWallPluginEvents, TextWallPluginConstants, TextWallPluginSettings, TextWallPluginParams, ModuleGlobalStateTextWall> {
     name: string;
+    isSetStateInProcess: boolean;
     subscribe: () => void;
     init: () => Promise<[unknown[] | undefined, unknown[] | undefined]>;
     emitWallChanged: () => Promise<unknown[]> | undefined;
     onLineExec: ({ line }?: LineExecHandlerArg) => Promise<void>;
     onTextEmitBefore: ({ isExtend }?: TextEmitBeforePayload) => Promise<void>;
     onTextRecalc: () => Promise<unknown[] | undefined>;
-    onStateSet: (payload: ModuleGlobalStateRegistry) => Promise<unknown[] | undefined>;
+    onStateSet: (payload: ModuleGlobalStateRegistry) => Promise<void>;
     onStateClear: () => Promise<unknown[] | undefined>;
     getRealText: (text: string, args: Record<string, unknown>) => Promise<string>;
     recalcWallObjToken: (wallObj: WallElement) => Promise<{

package/dist/modules/wall.js

@@ -3,6 +3,7 @@ import { tokenizeExecLine, tokenizeText } from "@vnejs/helpers";
 import { getTextSpeakerInfo } from "@vnejs/contracts.text";
 export class TextWall extends ModuleCore {
     name = "text.wall";
+    isSetStateInProcess = false;
     subscribe = () => {
         this.on(this.EVENTS.TEXT.RECALC, this.onTextRecalc);
         this.on(this.EVENTS.STATE.CLEAR, this.onStateClear);
@@ -25,7 +26,7 @@ export class TextWall extends ModuleCore {
         this.emitNext();
     };
     onTextEmitBefore = async ({ isExtend = false } = {}) => {
-        if (isExtend || !this.state.isStarted)
+        if (isExtend || !this.state.isStarted || this.isSetStateInProcess)
             return;
         if (this.state.shouldSkip)
             return this.updateState({ shouldSkip: false });
@@ -45,8 +46,10 @@ export class TextWall extends ModuleCore {
         return this.emitWallChanged();
     };
     onStateSet = async (payload) => {
+        this.isSetStateInProcess = true;
         await this.onSetStateClone(payload);
-        return this.emitWallChanged();
+        await this.emitWallChanged();
+        this.isSetStateInProcess = false;
     };
     onStateClear = async () => {
         this.setDefaultState();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.text.wall",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "tsconfig.json"
   ],
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "npx @vnejs/monorepo test",
     "build": "npx @vnejs/monorepo package",
     "publish:major:plugin": "npm run publish:major",
     "publish:minor:plugin": "npm run publish:minor",
@@ -39,6 +39,9 @@
     "@vnejs/shared": "~0.1.0"
   },
   "devDependencies": {
-    "@vnejs/configs.ts-common": "~0.1.0"
+    "@vnejs/configs.ts-common": "~0.1.0",
+    "@vnejs/configs.vitest": "~0.1.0",
+    "@vnejs/test-utils": "~0.1.0",
+    "@vnejs/contracts.text": "~0.1.0"
   }
 }

package/src/modules/wall.ts

@@ -18,6 +18,8 @@ export class TextWall extends ModuleCore<
 > {
   name = "text.wall";
 
+  isSetStateInProcess = false;
+
   subscribe = () => {
     this.on(this.EVENTS.TEXT.RECALC, this.onTextRecalc);
 
@@ -46,7 +48,7 @@ export class TextWall extends ModuleCore<
   };
 
   onTextEmitBefore = async ({ isExtend = false }: TextEmitBeforePayload = {}) => {
-    if (isExtend || !this.state.isStarted) return;
+    if (isExtend || !this.state.isStarted || this.isSetStateInProcess) return;
     if (this.state.shouldSkip) return this.updateState({ shouldSkip: false });
 
     const { texts, tokens, uid } = this.globalState.text;
@@ -71,9 +73,12 @@ export class TextWall extends ModuleCore<
   };
 
   onStateSet = async (payload: ModuleGlobalStateRegistry) => {
+    this.isSetStateInProcess = true;
+
     await this.onSetStateClone(payload);
+    await this.emitWallChanged();
 
-    return this.emitWallChanged();
+    this.isSetStateInProcess = false;
   };
 
   onStateClear = async () => {

package/src/tests/setup.ts

@@ -0,0 +1,29 @@
+import { CONSTANTS as TEXT_CONST, PLUGIN_NAME as TEXT, SUBSCRIBE_EVENTS as TEXT_EVENTS } from "@vnejs/contracts.text";
+import { PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.text.wall";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin, stubSilentEvent } from "@vnejs/test-utils";
+
+export const registerTextWallPluginVne = () => {
+  registerCoreVne();
+  registerVnePlugin(TEXT, { events: TEXT_EVENTS });
+  registerVnePlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS });
+};
+
+export const createTextWallTestModule = <T extends Parameters<typeof baseCreateTestModule>[0]>(
+  ModuleClass: T,
+  options: Parameters<typeof baseCreateTestModule>[1] = {},
+) => {
+  const result = baseCreateTestModule(ModuleClass, {
+    state: {
+      text: { uid: "1", texts: [{ text: "line", args: {} }], tokens: [], speaker: "hero" },
+      "text.speaker": { speakers: { hero: {} }, speaker: "hero" },
+      ...(options.state ?? {}),
+    },
+    ...options,
+  });
+
+  stubSilentEvent(result.observer, SUBSCRIBE_EVENTS.CHANGED);
+
+  return result;
+};
+
+export { SUBSCRIBE_EVENTS, PLUGIN_NAME };

package/src/tests/wall.test.ts

@@ -0,0 +1,36 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { SUBSCRIBE_EVENTS as SCENARIO_EVENTS } from "@vnejs/contracts.core.scenario";
+import { spyEvent } from "@vnejs/test-utils";
+
+import { TextWall } from "../modules/wall.js";
+import { createTextWallTestModule, registerTextWallPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("TextWall", () => {
+  beforeEach(() => {
+    registerTextWallPluginVne();
+  });
+
+  it("start command enables wall capture", async () => {
+    const { module, observer } = createTextWallTestModule(TextWall, { subscribe: false });
+    const changed = spyEvent(observer, SUBSCRIBE_EVENTS.CHANGED);
+    const next = spyEvent(observer, SCENARIO_EVENTS.NEXT);
+
+    await (module as TextWall).onLineExec({ line: "start" });
+
+    expect((module as TextWall).state.isStarted).toBe(true);
+    expect(changed).toHaveBeenCalledOnce();
+    expect(next).toHaveBeenCalledOnce();
+  });
+
+  it("clear command resets wall", async () => {
+    const { module, observer } = createTextWallTestModule(TextWall, { subscribe: false });
+
+    (module as TextWall).setState({ wall: [{ texts: [], tokens: [], uid: "1", speaker: "hero", speakerInfo: {} }], isStarted: true, shouldSkip: false });
+
+    await (module as TextWall).onLineExec({ line: "clear" });
+
+    expect((module as TextWall).state.wall).toEqual([]);
+    expect((module as TextWall).state.shouldSkip).toBe(true);
+  });
+});

package/tsconfig.json

@@ -5,5 +5,5 @@
     "outDir": "dist"
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "node_modules", "src/tests"]
 }