@vnejs/plugins.views.screens.credits 0.2.0 → 0.2.2

package/dist/index.js

@@ -2,6 +2,16 @@ import "@vnejs/contracts.views.screens.credits";
 import { regPlugin } from "@vnejs/shared";
 import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.credits";
 import { CreditsController } from "./modules/controller.js";
+import { CreditsAccept } from "./modules/accept.js";
+import { CreditsHideOnControls } from "./modules/hide.controls.js";
+import { CreditsHideOnState } from "./modules/hide.state.js";
 import { Credits } from "./modules/credits.js";
 import { CreditsView } from "./modules/view.js";
-regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [CreditsController, Credits, CreditsView]);
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [
+    CreditsController,
+    CreditsAccept,
+    CreditsHideOnControls,
+    CreditsHideOnState,
+    Credits,
+    CreditsView,
+]);

package/dist/modules/accept.d.ts

@@ -0,0 +1,11 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+import type { CreditsPluginState } from "../utils/credits.js";
+export declare class CreditsAccept extends ModuleControllerAccept<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams, CreditsPluginState> {
+    name: string;
+    EVENT_SHOW: "vne:credits:show";
+    EVENT_HIDE: "vne:credits:hide";
+    EVENT_ACCEPT: "vne:credits:hide";
+    CONTROLS_ZINDEX: number;
+    onAccept: () => undefined;
+}

package/dist/modules/accept.js

@@ -0,0 +1,9 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+export class CreditsAccept extends ModuleControllerAccept {
+    name = "credits.controller.accept";
+    EVENT_SHOW = this.EVENTS.CREDITS.SHOW;
+    EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+    EVENT_ACCEPT = this.EVENTS.CREDITS.HIDE;
+    CONTROLS_ZINDEX = this.PARAMS.CREDITS.ZINDEX;
+    onAccept = () => undefined;
+}

package/dist/modules/controller.d.ts

@@ -3,13 +3,8 @@ import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams,
 import type { CreditsPluginState } from "../utils/credits.js";
 export declare class CreditsController extends ModuleController<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams, CreditsPluginState> {
     name: string;
-    onInteract: () => undefined;
     updateEvent: "vne:credits:update";
-    controls: {
-        abstract_accept: () => undefined;
-        abstract_interact: () => undefined;
-        abstract_menu: () => undefined;
-    };
+    controls: {};
     controlsIndex: number;
     subscribe: () => void;
     afterHide: () => undefined;

package/dist/modules/controller.js

@@ -1,18 +1,12 @@
 import { ModuleController } from "@vnejs/module.components";
 export class CreditsController extends ModuleController {
     name = "credits.controller";
-    onInteract = () => void this.emit(this.EVENTS.CREDITS.HIDE);
     updateEvent = this.EVENTS.CREDITS.UPDATE;
-    controls = {
-        [this.CONST.CONTROLS.BUTTONS.ACCEPT]: this.onInteract,
-        [this.CONST.CONTROLS.BUTTONS.INTERACT]: this.onInteract,
-        [this.CONST.CONTROLS.BUTTONS.MENU]: this.onInteract,
-    };
+    controls = {};
     controlsIndex = this.PARAMS.CREDITS.ZINDEX;
     subscribe = () => {
         this.on(this.EVENTS.CREDITS.SHOW, this.onShow);
         this.on(this.EVENTS.CREDITS.HIDE, this.onHide);
-        this.on(this.EVENTS.STATE.CLEAR, this.onHide);
     };
     afterHide = () => void this.emitNext();
 }

package/dist/modules/hide.controls.d.ts

@@ -0,0 +1,8 @@
+import { ModuleControllerHideOnControls } from "@vnejs/module.controller.hide.on.controls";
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+export declare class CreditsHideOnControls extends ModuleControllerHideOnControls<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams> {
+    name: string;
+    EVENT_SHOW: "vne:credits:show";
+    EVENT_HIDE: "vne:credits:hide";
+    CONTROLS_ZINDEX: number;
+}

package/dist/modules/hide.controls.js

@@ -0,0 +1,7 @@
+import { ModuleControllerHideOnControls } from "@vnejs/module.controller.hide.on.controls";
+export class CreditsHideOnControls extends ModuleControllerHideOnControls {
+    name = "credits.hide.controls";
+    EVENT_SHOW = this.EVENTS.CREDITS.SHOW;
+    EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+    CONTROLS_ZINDEX = this.PARAMS.CREDITS.ZINDEX;
+}

package/dist/modules/hide.state.d.ts

@@ -0,0 +1,6 @@
+import { ModuleControllerHideOnState } from "@vnejs/module.controller.hide.on.state";
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+export declare class CreditsHideOnState extends ModuleControllerHideOnState<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams> {
+    name: string;
+    EVENT_HIDE: "vne:credits:hide";
+}

package/dist/modules/hide.state.js

@@ -0,0 +1,5 @@
+import { ModuleControllerHideOnState } from "@vnejs/module.controller.hide.on.state";
+export class CreditsHideOnState extends ModuleControllerHideOnState {
+    name = "credits.hide.state";
+    EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/plugins.views.screens.credits",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -36,6 +36,9 @@
     "@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/module.controller.hide.on.controls": "~0.2.0",
+    "@vnejs/module.controller.hide.on.state": "~0.2.0",
     "@vnejs/contracts.controls": "~0.2.0",
     "@vnejs/shared": "~0.2.0",
     "@vnejs/uis.react": "~0.2.0"
@@ -49,6 +52,9 @@
     "@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/module.controller.hide.on.controls": "~0.2.0",
+    "@vnejs/module.controller.hide.on.state": "~0.2.0",
     "@vnejs/shared": "~0.2.0",
     "@vnejs/uis.react": "~0.2.0"
   }

package/src/index.ts

@@ -4,7 +4,17 @@ import { regPlugin } from "@vnejs/shared";
 import { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.credits";
 
 import { CreditsController } from "./modules/controller.js";
+import { CreditsAccept } from "./modules/accept.js";
+import { CreditsHideOnControls } from "./modules/hide.controls.js";
+import { CreditsHideOnState } from "./modules/hide.state.js";
 import { Credits } from "./modules/credits.js";
 import { CreditsView } from "./modules/view.js";
 
-regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [CreditsController, Credits, CreditsView]);
+regPlugin(PLUGIN_NAME, { events: SUBSCRIBE_EVENTS, params: PARAMS }, [
+  CreditsController,
+  CreditsAccept,
+  CreditsHideOnControls,
+  CreditsHideOnState,
+  Credits,
+  CreditsView,
+]);

package/src/modules/accept.ts

@@ -0,0 +1,22 @@
+import { ModuleControllerAccept } from "@vnejs/module.controller.accept";
+
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+import type { CreditsPluginState } from "../utils/credits.js";
+
+export class CreditsAccept extends ModuleControllerAccept<
+  CreditsPluginEvents,
+  CreditsPluginConstants,
+  CreditsPluginSettings,
+  CreditsPluginParams,
+  CreditsPluginState
+> {
+  name = "credits.controller.accept";
+
+  EVENT_SHOW = this.EVENTS.CREDITS.SHOW;
+  EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+  EVENT_ACCEPT = this.EVENTS.CREDITS.HIDE;
+
+  CONTROLS_ZINDEX = this.PARAMS.CREDITS.ZINDEX;
+
+  onAccept = () => undefined;
+}

package/src/modules/controller.ts

@@ -12,21 +12,13 @@ export class CreditsController extends ModuleController<
 > {
   name = "credits.controller";
 
-  onInteract = () => void this.emit(this.EVENTS.CREDITS.HIDE);
-
   updateEvent = this.EVENTS.CREDITS.UPDATE;
-  controls = {
-    [this.CONST.CONTROLS.BUTTONS.ACCEPT]: this.onInteract,
-    [this.CONST.CONTROLS.BUTTONS.INTERACT]: this.onInteract,
-    [this.CONST.CONTROLS.BUTTONS.MENU]: this.onInteract,
-  };
+  controls = {};
   controlsIndex = this.PARAMS.CREDITS.ZINDEX;
 
   subscribe = () => {
     this.on(this.EVENTS.CREDITS.SHOW, this.onShow);
     this.on(this.EVENTS.CREDITS.HIDE, this.onHide);
-
-    this.on(this.EVENTS.STATE.CLEAR, this.onHide);
   };
 
   afterHide = () => void this.emitNext();

package/src/modules/hide.controls.ts

@@ -0,0 +1,17 @@
+import { ModuleControllerHideOnControls } from "@vnejs/module.controller.hide.on.controls";
+
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+
+export class CreditsHideOnControls extends ModuleControllerHideOnControls<
+  CreditsPluginEvents,
+  CreditsPluginConstants,
+  CreditsPluginSettings,
+  CreditsPluginParams
+> {
+  name = "credits.hide.controls";
+
+  EVENT_SHOW = this.EVENTS.CREDITS.SHOW;
+  EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+
+  CONTROLS_ZINDEX = this.PARAMS.CREDITS.ZINDEX;
+}

package/src/modules/hide.state.ts

@@ -0,0 +1,9 @@
+import { ModuleControllerHideOnState } from "@vnejs/module.controller.hide.on.state";
+
+import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
+
+export class CreditsHideOnState extends ModuleControllerHideOnState<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams> {
+  name = "credits.hide.state";
+
+  EVENT_HIDE = this.EVENTS.CREDITS.HIDE;
+}

package/src/modules/view.ts

@@ -4,13 +4,7 @@ import { render } from "../view/index.js";
 import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
 import type { CreditsPluginState } from "../utils/credits.js";
 
-export class CreditsView extends ModuleView<
-  CreditsPluginEvents,
-  CreditsPluginConstants,
-  CreditsPluginSettings,
-  CreditsPluginParams,
-  CreditsPluginState
-> {
+export class CreditsView extends ModuleView<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams, CreditsPluginState> {
   name = "credits.view";
 
   animationTime = this.PARAMS.CREDITS.TRANSITION;

package/src/tests/accept.test.ts

@@ -0,0 +1,52 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { spyEvent } from "@vnejs/test-utils";
+
+import { CreditsAccept } from "../modules/accept.js";
+import { CONTROLS_EVENTS, createCreditsTestModule, registerCreditsPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("CreditsAccept", () => {
+  beforeEach(() => {
+    registerCreditsPluginVne();
+  });
+
+  it("SHOW pushes ACCEPT and INTERACT controls", async () => {
+    const { module, observer } = createCreditsTestModule(CreditsAccept);
+    const accept = module as CreditsAccept;
+    const push = spyEvent(observer, CONTROLS_EVENTS.PUSH);
+
+    await observer.emit(SUBSCRIBE_EVENTS.SHOW);
+
+    expect(push).toHaveBeenCalledExactlyOnceWith(
+      expect.objectContaining({
+        key: "credits.controller.accept",
+        checkNext: true,
+        index: accept.PARAMS.CREDITS.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 } = createCreditsTestModule(CreditsAccept);
+    const pop = spyEvent(observer, CONTROLS_EVENTS.POP);
+
+    await observer.emit(SUBSCRIBE_EVENTS.HIDE);
+
+    expect(pop).toHaveBeenCalledExactlyOnceWith({ key: "credits.controller.accept" });
+  });
+
+  it("ACCEPT and INTERACT emit CREDITS.HIDE", async () => {
+    const { module, observer } = createCreditsTestModule(CreditsAccept);
+    const accept = module as CreditsAccept;
+    const hide = spyEvent(observer, SUBSCRIBE_EVENTS.HIDE);
+
+    accept.controls[accept.CONST.CONTROLS.BUTTONS.ACCEPT]();
+    accept.controls[accept.CONST.CONTROLS.BUTTONS.INTERACT]();
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(hide).toHaveBeenCalledTimes(2);
+  });
+});

package/src/tests/hide.controls.test.ts

@@ -0,0 +1,55 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { spyEvent } from "@vnejs/test-utils";
+
+import { CreditsHideOnControls } from "../modules/hide.controls.js";
+import { CONTROLS_EVENTS, createCreditsTestModule, registerCreditsPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("CreditsHideOnControls", () => {
+  beforeEach(() => {
+    registerCreditsPluginVne();
+  });
+
+  it("SHOW pushes BACK, MENU and GAMEMENU controls", async () => {
+    const { module, observer } = createCreditsTestModule(CreditsHideOnControls);
+    const hide = module as CreditsHideOnControls;
+    const push = spyEvent(observer, CONTROLS_EVENTS.PUSH);
+
+    await observer.emit(SUBSCRIBE_EVENTS.SHOW);
+
+    expect(push).toHaveBeenCalledExactlyOnceWith(
+      expect.objectContaining({
+        key: "credits.hide.controls",
+        checkNext: true,
+        index: hide.PARAMS.CREDITS.ZINDEX + 1,
+      }),
+    );
+    expect(push.mock.calls[0][0].controls).toHaveProperty(hide.CONST.CONTROLS.BUTTONS.BACK);
+    expect(push.mock.calls[0][0].controls).toHaveProperty(hide.CONST.CONTROLS.BUTTONS.MENU);
+    expect(push.mock.calls[0][0].controls).toHaveProperty(hide.CONST.CONTROLS.BUTTONS.GAMEMENU);
+  });
+
+  it("HIDE pops hide.controls", async () => {
+    const { observer } = createCreditsTestModule(CreditsHideOnControls);
+    const pop = spyEvent(observer, CONTROLS_EVENTS.POP);
+
+    await observer.emit(SUBSCRIBE_EVENTS.HIDE);
+
+    expect(pop).toHaveBeenCalledExactlyOnceWith({ key: "credits.hide.controls" });
+  });
+
+  it("BACK, MENU and GAMEMENU emit CREDITS.HIDE", async () => {
+    const { module, observer } = createCreditsTestModule(CreditsHideOnControls);
+    const hide = module as CreditsHideOnControls;
+    const hideEvent = spyEvent(observer, SUBSCRIBE_EVENTS.HIDE);
+
+    hide.controls[hide.CONST.CONTROLS.BUTTONS.BACK]();
+    hide.controls[hide.CONST.CONTROLS.BUTTONS.MENU]();
+    hide.controls[hide.CONST.CONTROLS.BUTTONS.GAMEMENU]();
+    await Promise.resolve();
+    await Promise.resolve();
+    await Promise.resolve();
+
+    expect(hideEvent).toHaveBeenCalledTimes(3);
+  });
+});

package/src/tests/hide.state.test.ts

@@ -0,0 +1,25 @@
+import { beforeEach, describe, expect, it } from "vitest";
+
+import { SUBSCRIBE_EVENTS as STATE_EVENTS } from "@vnejs/contracts.core.state";
+import { spyEvent } from "@vnejs/test-utils";
+
+import { CreditsHideOnState } from "../modules/hide.state.js";
+import { createCreditsTestModule, registerCreditsPluginVne, SUBSCRIBE_EVENTS } from "./setup.js";
+
+describe("CreditsHideOnState", () => {
+  beforeEach(() => {
+    registerCreditsPluginVne();
+  });
+
+  it("STATE.SET and STATE.CLEAR emit HIDE with isForce", async () => {
+    const { observer } = createCreditsTestModule(CreditsHideOnState);
+    const hide = spyEvent(observer, SUBSCRIBE_EVENTS.HIDE);
+
+    await observer.emit(STATE_EVENTS.SET);
+    await observer.emit(STATE_EVENTS.CLEAR);
+
+    expect(hide).toHaveBeenCalledTimes(2);
+    expect(hide).toHaveBeenNthCalledWith(1, { isForce: true });
+    expect(hide).toHaveBeenNthCalledWith(2, { isForce: true });
+  });
+});

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 { PARAMS, PLUGIN_NAME, SUBSCRIBE_EVENTS } from "@vnejs/contracts.views.screens.credits";
-import {
-  createTestModule as baseCreateTestModule,
-  registerCoreVne,
-  registerVnePlugin,
-  stubSilentEvent,
-} from "@vnejs/test-utils";
+import { createTestModule as baseCreateTestModule, registerCoreVne, registerVnePlugin, stubSilentEvent } from "@vnejs/test-utils";
 
 export const registerCreditsPluginVne = () => {
   registerCoreVne();
@@ -32,4 +27,4 @@ export const createCreditsTestModule = <T extends Parameters<typeof baseCreateTe
   return result;
 };
 
-export { SUBSCRIBE_EVENTS, PARAMS, PLUGIN_NAME };
+export { SUBSCRIBE_EVENTS, PARAMS, PLUGIN_NAME, CONTROLS_EVENTS };

package/src/view/index.tsx

@@ -5,13 +5,7 @@ import { Flex, Screen, ScrollContent, Text, createRenderFunc, useCallback, useMe
 import type { CreditsPluginConstants, CreditsPluginEvents, CreditsPluginParams, CreditsPluginSettings } from "../types.js";
 import type { CreditsPluginState } from "../utils/credits.js";
 
-type CreditsComponentProps = ReactComponentProps<
-  CreditsPluginEvents,
-  CreditsPluginConstants,
-  CreditsPluginSettings,
-  CreditsPluginParams,
-  CreditsPluginState
->;
+type CreditsComponentProps = ReactComponentProps<CreditsPluginEvents, CreditsPluginConstants, CreditsPluginSettings, CreditsPluginParams, CreditsPluginState>;
 
 const renderLine = ({ text, props }: { text: string; props: Record<string, unknown> }, i: number) => (
   <Text