@vnejs/plugins.views.screens.disclaimer 0.2.1 → 0.2.3

package/dist/index.js

@@ -2,6 +2,12 @@ import "@vnejs/contracts.views.screens.disclaimer";
 import { regPlugin } from "@vnejs/shared";
 import { CONSTANTS, PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.disclaimer";
 import { DisclaimerController } from "./modules/controller.js";
+import { DisclaimerAccept } from "./modules/accept.js";
 import { Disclaimer } from "./modules/disclaimer.js";
 import { DisclaimerView } from "./modules/view.js";
-regPlugin(PLUGIN_NAME, { constants: CONSTANTS, events: SUBSCRIBE_EVENTS, params: PARAMS }, [DisclaimerController, Disclaimer, DisclaimerView]);
+regPlugin(PLUGIN_NAME, { constants: CONSTANTS, events: SUBSCRIBE_EVENTS, params: PARAMS }, [
+    DisclaimerController,
+    DisclaimerAccept,
+    Disclaimer,
+    DisclaimerView,
+]);

package/dist/modules/accept.d.ts

@@ -0,0 +1,11 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+import type { DisclaimerPluginConstants, DisclaimerPluginEvents, DisclaimerPluginParams, DisclaimerPluginSettings } from "../types.js";
+import type { DisclaimerPluginState } from "../utils/disclaimer.js";
+export declare class DisclaimerAccept extends ModuleControllerAccept<DisclaimerPluginEvents, DisclaimerPluginConstants, DisclaimerPluginSettings, DisclaimerPluginParams, DisclaimerPluginState> {
+    name: string;
+    EVENT_SHOW: "vne:disclaimer:show";
+    EVENT_HIDE: "vne:disclaimer:hide";
+    EVENT_ACCEPT: "vne:disclaimer:accept";
+    CONTROLS_ZINDEX: number;
+    onAccept: () => Promise<void>;
+}

package/dist/modules/accept.js

@@ -0,0 +1,13 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+export class DisclaimerAccept extends ModuleControllerAccept {
+    name = "disclaimer.controller.accept";
+    EVENT_SHOW = this.EVENTS.DISCLAIMER.SHOW;
+    EVENT_HIDE = this.EVENTS.DISCLAIMER.HIDE;
+    EVENT_ACCEPT = this.EVENTS.DISCLAIMER.ACCEPT;
+    CONTROLS_ZINDEX = this.PARAMS.DISCLAIMER.ZINDEX;
+    onAccept = async () => {
+        this.emitLog({ action: "accept" });
+        await this.emit(this.EVENTS.DISCLAIMER.HIDE);
+        this.emitNext();
+    };
+}

package/dist/modules/controller.d.ts

@@ -3,12 +3,8 @@ import type { DisclaimerPluginConstants, DisclaimerPluginEvents, DisclaimerPlugi
 import type { DisclaimerPluginState } from "../utils/disclaimer.js";
 export declare class DisclaimerController extends ModuleController<DisclaimerPluginEvents, DisclaimerPluginConstants, DisclaimerPluginSettings, DisclaimerPluginParams, DisclaimerPluginState> {
     name: string;
-    emitAccept: () => undefined;
     updateEvent: "vne:disclaimer:update";
-    controls: {
-        abstract_accept: () => undefined;
-        abstract_interact: () => undefined;
-    };
+    controls: {};
     controlsIndex: number;
     subscribe: () => void;
     beforeShow: (args?: {}) => void;

package/dist/modules/controller.js

@@ -1,12 +1,8 @@
 import { ModuleController } from "@vnejs/module.components";
 export class DisclaimerController extends ModuleController {
     name = "disclaimer.controller";
-    emitAccept = () => void this.emit(this.EVENTS.DISCLAIMER.ACCEPT);
     updateEvent = this.EVENTS.DISCLAIMER.UPDATE;
-    controls = {
-        [this.CONST.CONTROLS.BUTTONS.ACCEPT]: this.emitAccept,
-        [this.CONST.CONTROLS.BUTTONS.INTERACT]: this.emitAccept,
-    };
+    controls = {};
     controlsIndex = this.PARAMS.DISCLAIMER.ZINDEX;
     subscribe = () => {
         this.on(this.EVENTS.DISCLAIMER.SHOW, this.onShow);

package/dist/modules/disclaimer.d.ts

@@ -3,8 +3,6 @@ import type { LineExecHandlerArg } from "@vnejs/module.core";
 import type { DisclaimerPluginConstants, DisclaimerPluginEvents, DisclaimerPluginParams, DisclaimerPluginSettings } from "../types.js";
 export declare class Disclaimer extends ModuleCore<DisclaimerPluginEvents, DisclaimerPluginConstants, DisclaimerPluginSettings, DisclaimerPluginParams> {
     name: string;
-    subscribe: () => void;
     init: () => Promise<unknown[]> | undefined;
     onLineExec: ({ line }?: LineExecHandlerArg) => Promise<unknown[]> | undefined;
-    onAccept: () => Promise<void>;
 }

package/dist/modules/disclaimer.js

@@ -2,9 +2,6 @@ import { tokenizeExecLine } from "@vnejs/helpers";
 import { ModuleCore } from "@vnejs/module.core";
 export class Disclaimer extends ModuleCore {
     name = "disclaimer";
-    subscribe = () => {
-        this.on(this.EVENTS.DISCLAIMER.ACCEPT, this.onAccept);
-    };
     init = () => this.emit(this.EVENTS.SCENARIO.LINE_EXEC_REG, { module: this.name, handler: this.onLineExec });
     onLineExec = ({ line = "" } = {}) => {
         const [action = "", id = ""] = tokenizeExecLine(line).map(String);
@@ -13,9 +10,4 @@ export class Disclaimer extends ModuleCore {
         this.emitLog({ action, id });
         return this.emit(this.EVENTS.DISCLAIMER.SHOW, { id });
     };
-    onAccept = async () => {
-        this.emitLog({ action: "accept" });
-        await this.emit(this.EVENTS.DISCLAIMER.HIDE);
-        this.emitNext();
-    };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.views.screens.disclaimer",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,6 +36,7 @@
     "@vnejs/helpers": "~0.2.0",
     "@vnejs/module.core": "~0.2.0",
     "@vnejs/module.components": "~0.2.0",
+    "@vnejs/module.controller.accept": "~0.2.0",
     "@vnejs/contracts.controls": "~0.2.0",
     "@vnejs/contracts.text.locs": "~0.2.0",
     "@vnejs/shared": "~0.2.0",
@@ -51,6 +52,7 @@
     "@vnejs/helpers": "~0.2.0",
     "@vnejs/module.core": "~0.2.0",
     "@vnejs/module.components": "~0.2.0",
+    "@vnejs/module.controller.accept": "~0.2.0",
     "@vnejs/shared": "~0.2.0",
     "@vnejs/uis.react": "~0.2.0"
   }

package/src/index.ts

@@ -4,7 +4,13 @@ import { regPlugin } from "@vnejs/shared";
 import { CONSTANTS, PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.disclaimer";
 
 import { DisclaimerController } from "./modules/controller.js";
+import { DisclaimerAccept } from "./modules/accept.js";
 import { Disclaimer } from "./modules/disclaimer.js";
 import { DisclaimerView } from "./modules/view.js";
 
-regPlugin(PLUGIN_NAME, { constants: CONSTANTS, events: SUBSCRIBE_EVENTS, params: PARAMS }, [DisclaimerController, Disclaimer, DisclaimerView]);
+regPlugin(PLUGIN_NAME, { constants: CONSTANTS, events: SUBSCRIBE_EVENTS, params: PARAMS }, [
+  DisclaimerController,
+  DisclaimerAccept,
+  Disclaimer,
+  DisclaimerView,
+]);

package/src/modules/accept.ts

@@ -0,0 +1,26 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+
+import type { DisclaimerPluginConstants, DisclaimerPluginEvents, DisclaimerPluginParams, DisclaimerPluginSettings } from "../types.js";
+import type { DisclaimerPluginState } from "../utils/disclaimer.js";
+
+export class DisclaimerAccept extends ModuleControllerAccept<
+  DisclaimerPluginEvents,
+  DisclaimerPluginConstants,
+  DisclaimerPluginSettings,
+  DisclaimerPluginParams,
+  DisclaimerPluginState
+> {
+  name = "disclaimer.controller.accept";
+
+  EVENT_SHOW = this.EVENTS.DISCLAIMER.SHOW;
+  EVENT_HIDE = this.EVENTS.DISCLAIMER.HIDE;
+  EVENT_ACCEPT = this.EVENTS.DISCLAIMER.ACCEPT;
+
+  CONTROLS_ZINDEX = this.PARAMS.DISCLAIMER.ZINDEX;
+
+  onAccept = async () => {
+    this.emitLog({ action: "accept" });
+    await this.emit(this.EVENTS.DISCLAIMER.HIDE);
+    this.emitNext();
+  };
+}

package/src/modules/controller.ts

@@ -12,13 +12,8 @@ export class DisclaimerController extends ModuleController<
 > {
   name = "disclaimer.controller";
 
-  emitAccept = () => void this.emit(this.EVENTS.DISCLAIMER.ACCEPT);
-
   updateEvent = this.EVENTS.DISCLAIMER.UPDATE;
-  controls = {
-    [this.CONST.CONTROLS.BUTTONS.ACCEPT]: this.emitAccept,
-    [this.CONST.CONTROLS.BUTTONS.INTERACT]: this.emitAccept,
-  };
+  controls = {};
   controlsIndex = this.PARAMS.DISCLAIMER.ZINDEX;
 
   subscribe = () => {

package/src/modules/disclaimer.ts

@@ -9,10 +9,6 @@ import type { DisclaimerShowPayload } from "../utils/disclaimer.js";
 export class Disclaimer extends ModuleCore<DisclaimerPluginEvents, DisclaimerPluginConstants, DisclaimerPluginSettings, DisclaimerPluginParams> {
   name = "disclaimer";
 
-  subscribe = () => {
-    this.on(this.EVENTS.DISCLAIMER.ACCEPT, this.onAccept);
-  };
-
   init = () => this.emit(this.EVENTS.SCENARIO.LINE_EXEC_REG, { module: this.name, handler: this.onLineExec });
 
   onLineExec = ({ line = "" }: LineExecHandlerArg = {}) => {
@@ -24,10 +20,4 @@ export class Disclaimer extends ModuleCore<DisclaimerPluginEvents, DisclaimerPlu
 
     return this.emit(this.EVENTS.DISCLAIMER.SHOW, { id } satisfies DisclaimerShowPayload);
   };
-
-  onAccept = async () => {
-    this.emitLog({ action: "accept" });
-    await this.emit(this.EVENTS.DISCLAIMER.HIDE);
-    this.emitNext();
-  };
 }

package/src/tests/accept.test.ts

@@ -0,0 +1,65 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+
+import { spyEvent } from "@vnejs/test-utils";
+
+import { DisclaimerAccept } from "../modules/accept.js";
+import { CONTROLS_EVENTS, createDisclaimerTestModule, registerDisclaimerPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("DisclaimerAccept", () => {
+  beforeEach(() => {
+    registerDisclaimerPluginVne();
+  });
+
+  it("SHOW pushes ACCEPT and INTERACT controls", async () => {
+    const { module, observer } = createDisclaimerTestModule(DisclaimerAccept);
+    const accept = module as DisclaimerAccept;
+    const push = spyEvent(observer, CONTROLS_EVENTS.PUSH);
+
+    await observer.emit(SUBSCRIBE_EVENTS.SHOW);
+
+    expect(push).toHaveBeenCalledExactlyOnceWith(
+      expect.objectContaining({
+        key: "disclaimer.controller.accept",
+        checkNext: true,
+        index: accept.PARAMS.DISCLAIMER.ZINDEX + 1,
+      }),
+    );
+    expect(push.mock.calls[0][0].controls).toHaveProperty(accept.CONST.CONTROLS.BUTTONS.ACCEPT);
+    expect(push.mock.calls[0][0].controls).toHaveProperty(accept.CONST.CONTROLS.BUTTONS.INTERACT);
+  });
+
+  it("HIDE pops ACCEPT controls", async () => {
+    const { observer } = createDisclaimerTestModule(DisclaimerAccept);
+    const pop = spyEvent(observer, CONTROLS_EVENTS.POP);
+
+    await observer.emit(SUBSCRIBE_EVENTS.HIDE);
+
+    expect(pop).toHaveBeenCalledExactlyOnceWith({ key: "disclaimer.controller.accept" });
+  });
+
+  it("ACCEPT and INTERACT emit DISCLAIMER.ACCEPT", async () => {
+    const { module, observer } = createDisclaimerTestModule(DisclaimerAccept);
+    const accept = module as DisclaimerAccept;
+    const acceptEvent = spyEvent(observer, SUBSCRIBE_EVENTS.ACCEPT);
+
+    accept.controls[accept.CONST.CONTROLS.BUTTONS.ACCEPT]();
+    accept.controls[accept.CONST.CONTROLS.BUTTONS.INTERACT]();
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(acceptEvent).toHaveBeenCalledTimes(2);
+  });
+
+  it("ACCEPT hides and emits next", async () => {
+    const { observer } = createDisclaimerTestModule(DisclaimerAccept);
+    const hide = spyEvent(observer, SUBSCRIBE_EVENTS.HIDE);
+    const next = vi.fn();
+
+    observer.subscribe("vne:scenario:next", next);
+
+    await observer.emit(SUBSCRIBE_EVENTS.ACCEPT);
+
+    expect(hide).toHaveBeenCalledOnce();
+    expect(next).toHaveBeenCalledOnce();
+  });
+});

package/src/tests/disclaimer.test.ts

@@ -1,4 +1,4 @@
-import { beforeEach, describe, expect, it, vi } from "vitest";
+import { beforeEach, describe, expect, it } from "vitest";
 
 import { spyEvent } from "@vnejs/test-utils";
 
@@ -30,17 +30,4 @@ describe("Disclaimer", () => {
 
     expect(show).not.toHaveBeenCalled();
   });
-
-  it("ACCEPT hides and emits next", async () => {
-    const { observer } = createDisclaimerTestModule(Disclaimer);
-    const hide = spyEvent(observer, SUBSCRIBE_EVENTS.HIDE);
-    const next = vi.fn();
-
-    observer.subscribe("vne:scenario:next", next);
-
-    await observer.emit(SUBSCRIBE_EVENTS.ACCEPT);
-
-    expect(hide).toHaveBeenCalledOnce();
-    expect(next).toHaveBeenCalledOnce();
-  });
 });

package/src/tests/setup.ts

@@ -1,11 +1,6 @@
 import { CONSTANTS as CONTROLS_CONST, PLUGIN_NAME as CONTROLS, SUBSCRIBE_EVENTS as CONTROLS_EVENTS } from "@vnejs/contracts.controls";
 import { CONSTANTS, PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.disclaimer";
-import {
-  createTestModule as baseCreateTestModule,
-  registerCoreVne,
-  registerVnePlugin,
-  stubSilentEvent,
-} from "@vnejs/test-utils";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin, stubSilentEvent } from "@vnejs/test-utils";
 
 export const registerDisclaimerPluginVne = () => {
   registerCoreVne();
@@ -32,4 +27,4 @@ export const createDisclaimerTestModule = <T extends Parameters<typeof baseCreat
   return result;
 };
 
-export { SUBSCRIBE_EVENTS, PARAMS, PLUGIN_NAME };
+export { SUBSCRIBE_EVENTS, PARAMS, PLUGIN_NAME, CONTROLS_EVENTS };

package/src/types.ts

@@ -1,6 +1,10 @@
 import type { ModuleComponentsConstants, ModuleComponentsEvents, ModuleComponentsParams, ModuleComponentsSettings } from "@vnejs/module.components";
 import type { Constants as ControlsConstants, PluginName as ControlsPluginName } from "@vnejs/contracts.controls";
-import type { Constants as ScenarioConstants, PluginName as ScenarioPluginName, SubscribeEvents as ScenarioSubscribeEvents } from "@vnejs/contracts.core.scenario";
+import type {
+  Constants as ScenarioConstants,
+  PluginName as ScenarioPluginName,
+  SubscribeEvents as ScenarioSubscribeEvents,
+} from "@vnejs/contracts.core.scenario";
 import type { PluginName as LogsPluginName, SubscribeEvents as LogsSubscribeEvents } from "@vnejs/contracts.core.logs";
 import type { PluginName as LocsPluginName, SubscribeEvents as LocsSubscribeEvents } from "@vnejs/contracts.text.locs";
 import type { Constants, Params, PluginName, SubscribeEvents } from "@vnejs/contracts.views.screens.disclaimer";

package/src/view/index.tsx

@@ -41,10 +41,7 @@ const DisclaimerScreen = ({ store, onMount, PARAMS, emit, EVENTS }: DisclaimerCo
 
   const propsScreen = useMemo(() => ({ ...propsByView.screen, isShow, isForce }), [isShow, isForce, propsByView.screen]);
   const propsTitle = useMemo(() => ({ ...propsByView.title, text: title }), [title, propsByView.title]);
-  const propsControls = useMemo(
-    () => ({ ...propsByView.controls, texts: buttonTexts, onClick }),
-    [propsByView.controls, buttonTexts, onClick],
-  );
+  const propsControls = useMemo(() => ({ ...propsByView.controls, texts: buttonTexts, onClick }), [propsByView.controls, buttonTexts, onClick]);
 
   return (
     <Screen {...propsScreen}>