@vnejs/test-utils 0.1.1 → 0.1.3

package/dist/expect-call-sequence.d.ts

@@ -0,0 +1,2 @@
+import type { EventSpy } from "./spy-event.js";
+export declare const expectCallSequence: (spy: EventSpy, ...calls: unknown[]) => void;

package/dist/expect-call-sequence.js

@@ -0,0 +1,7 @@
+import { expect } from "vitest";
+export const expectCallSequence = (spy, ...calls) => {
+    expect(spy).toHaveBeenCalledTimes(calls.length);
+    calls.forEach((expected, index) => {
+        expect(spy.mock.calls[index]?.[0]).toMatchObject(expected);
+    });
+};

package/dist/harness.d.ts

@@ -1,5 +1,5 @@
-import type { ModuleGlobalStateRegistry, ModuleInject } from "@vnejs/module";
-import { Observer } from "@vnejs/observer";
+import type { ModuleGlobalStateRegistry, ModuleInject, ModuleShared } from "@vnejs/module";
+import type { Observer } from "@vnejs/observer";
 export type TestModuleInstance = {
     name: string;
     inject: (arg?: ModuleInject) => void;
@@ -13,4 +13,5 @@ export declare const createTestModule: <T extends TestModuleInstance>(ModuleClas
     module: T;
     observer: Observer;
     state: ModuleGlobalStateRegistry;
+    shared: ModuleShared;
 };

package/dist/harness.js

@@ -1,16 +1,17 @@
-import { Observer } from "@vnejs/observer";
+import { createTestObserver } from "./stub-event.js";
 export const createTestModule = (ModuleClass, { subscribe = true, ...injectArg } = {}) => {
-    const observer = new Observer();
+    const observer = createTestObserver();
     const state = (injectArg.state ?? {});
+    const shared = (injectArg.shared ?? {});
     const module = new ModuleClass();
     module.inject({
         observer,
         state,
-        shared: (injectArg.shared ?? {}),
+        shared,
         media: injectArg.media ?? {},
         ...injectArg,
     });
     if (subscribe)
         module.subscribe();
-    return { module, observer, state };
+    return { module, observer, state, shared };
 };

package/dist/index.d.ts

@@ -3,7 +3,9 @@ export { createTestModule, type CreateTestModuleOptions, type TestModuleInstance
 export { registerCoreVne } from "./register-core-vne.js";
 export { registerVnePlugin } from "./register-vne.js";
 export { resetDom } from "./reset-dom.js";
-export { spyEvent } from "./spy-event.js";
-export { stubEvent, stubLogsEmit, stubVendorEvents } from "./stub-event.js";
+export { expectCallSequence } from "./expect-call-sequence.js";
+export { spyEvent, type EventSpy } from "./spy-event.js";
+export { createTestObserver, stubEvent, stubLogsEmit, stubSilentEvent, stubVendorEvents } from "./stub-event.js";
+export { stubSideEffectEvents } from "./stub-side-effect-events.js";
 export { mockFullscreen } from "./mocks/dom.js";
 export { createLocalforageMock } from "./mocks/localforage.js";

package/dist/index.js

@@ -3,7 +3,9 @@ export { createTestModule } from "./harness.js";
 export { registerCoreVne } from "./register-core-vne.js";
 export { registerVnePlugin } from "./register-vne.js";
 export { resetDom } from "./reset-dom.js";
+export { expectCallSequence } from "./expect-call-sequence.js";
 export { spyEvent } from "./spy-event.js";
-export { stubEvent, stubLogsEmit, stubVendorEvents } from "./stub-event.js";
+export { createTestObserver, stubEvent, stubLogsEmit, stubSilentEvent, stubVendorEvents } from "./stub-event.js";
+export { stubSideEffectEvents } from "./stub-side-effect-events.js";
 export { mockFullscreen } from "./mocks/dom.js";
 export { createLocalforageMock } from "./mocks/localforage.js";

package/dist/mocks/dom.d.ts

@@ -1,9 +1,9 @@
+import { type Mock } from "vitest";
 export type MockFullscreenOptions = {
     fullscreenElement?: Element | null;
 };
-export declare const mockFullscreen: ({ fullscreenElement }?: MockFullscreenOptions) => {
-    requestFullscreen: () => Promise<undefined>;
-    exitFullscreen: () => Promise<undefined>;
-    getRequestCount: () => number;
-    getExitCount: () => number;
+export type MockFullscreen = {
+    requestFullscreen: Mock<() => Promise<void>>;
+    exitFullscreen: Mock<() => Promise<void>>;
 };
+export declare const mockFullscreen: ({ fullscreenElement }?: MockFullscreenOptions) => MockFullscreen;

package/dist/mocks/dom.js

@@ -1,21 +1,12 @@
+import { vi } from "vitest";
 export const mockFullscreen = ({ fullscreenElement = null } = {}) => {
     Object.defineProperty(document, "fullscreenElement", { value: fullscreenElement, configurable: true });
-    let requestCount = 0;
-    let exitCount = 0;
-    const requestFullscreen = () => {
-        requestCount += 1;
-        return Promise.resolve(undefined);
-    };
-    const exitFullscreen = () => {
-        exitCount += 1;
-        return Promise.resolve(undefined);
-    };
+    const requestFullscreen = vi.fn(() => Promise.resolve(undefined));
+    const exitFullscreen = vi.fn(() => Promise.resolve(undefined));
     document.body.requestFullscreen = requestFullscreen;
     document.exitFullscreen = exitFullscreen;
     return {
         requestFullscreen,
         exitFullscreen,
-        getRequestCount: () => requestCount,
-        getExitCount: () => exitCount,
     };
 };

package/dist/spy-event.d.ts

@@ -1,7 +1,4 @@
 import type { Observer } from "@vnejs/observer";
-export declare const spyEvent: (observer: Observer, event: string) => {
-    calls: unknown[][];
-    count: () => number;
-    last: () => unknown[] | undefined;
-    first: () => unknown[];
-};
+import { type Mock } from "vitest";
+export type EventSpy = Mock<(...args: unknown[]) => void>;
+export declare const spyEvent: (observer: Observer, event: string) => EventSpy;

package/dist/spy-event.js

@@ -1,12 +1,8 @@
+import { vi } from "vitest";
 export const spyEvent = (observer, event) => {
-    const calls = [];
+    const spy = vi.fn();
     observer.subscribe(event, (...args) => {
-        calls.push(args);
+        spy(...args);
     });
-    return {
-        calls,
-        count: () => calls.length,
-        last: () => calls.at(-1),
-        first: () => calls[0],
-    };
+    return spy;
 };

package/dist/stub-event.d.ts

@@ -1,4 +1,6 @@
-import type { Observer } from "@vnejs/observer";
+import { Observer } from "@vnejs/observer";
+export declare const stubSilentEvent: (observer: Observer, event: string, handler?: (...args: unknown[]) => unknown) => void;
+export declare const createTestObserver: () => Observer;
 export declare const stubEvent: (observer: Observer, event: string, handler?: (...args: unknown[]) => unknown) => void;
 export declare const stubLogsEmit: (observer: Observer) => void;
 export declare const stubVendorEvents: (observer: Observer) => void;

package/dist/stub-event.js

@@ -1,9 +1,19 @@
 import { SUBSCRIBE_EVENTS as LOGS_EVENTS } from "@vnejs/contracts.core.logs";
 import { SUBSCRIBE_EVENTS as VENDORS_EVENTS } from "@vnejs/contracts.core.vendors";
+import { Observer } from "@vnejs/observer";
+import { stubSideEffectEvents } from "./stub-side-effect-events.js";
+export const stubSilentEvent = (observer, event, handler = () => undefined) => {
+    observer.subscribe(event, handler, { filterFromResult: true });
+};
+export const createTestObserver = () => {
+    const observer = new Observer();
+    stubSideEffectEvents(observer);
+    return observer;
+};
 export const stubEvent = (observer, event, handler = () => undefined) => {
     observer.subscribe(event, handler);
 };
-export const stubLogsEmit = (observer) => stubEvent(observer, LOGS_EVENTS.EMIT);
+export const stubLogsEmit = (observer) => stubSilentEvent(observer, LOGS_EVENTS.EMIT);
 export const stubVendorEvents = (observer) => {
     stubEvent(observer, VENDORS_EVENTS.UID, () => "test-uid");
     stubEvent(observer, VENDORS_EVENTS.CLONE, (value) => structuredClone(value));

package/dist/stub-side-effect-events.d.ts

@@ -0,0 +1,2 @@
+import type { Observer } from "@vnejs/observer";
+export declare const stubSideEffectEvents: (observer: Observer) => void;

package/dist/stub-side-effect-events.js

@@ -0,0 +1,24 @@
+import { SUBSCRIBE_EVENTS as INTERACT_EVENTS } from "@vnejs/contracts.core.interact";
+import { SUBSCRIBE_EVENTS as LOGS_EVENTS } from "@vnejs/contracts.core.logs";
+import { SUBSCRIBE_EVENTS as SCENARIO_EVENTS } from "@vnejs/contracts.core.scenario";
+import { SUBSCRIBE_EVENTS as SETTINGS_EVENTS } from "@vnejs/contracts.core.settings";
+import { SUBSCRIBE_EVENTS as STACK_EVENTS } from "@vnejs/contracts.core.stack";
+import { SUBSCRIBE_EVENTS as SYSTEM_EVENTS } from "@vnejs/contracts.core.system";
+import { stubSilentEvent, stubVendorEvents } from "./stub-event.js";
+const CORE_SIDE_EFFECT_EVENTS = [
+    LOGS_EVENTS.EMIT,
+    INTERACT_EVENTS.EMIT,
+    INTERACT_EVENTS.PUSH,
+    INTERACT_EVENTS.POP,
+    SETTINGS_EVENTS.INIT,
+    SCENARIO_EVENTS.NEXT,
+    SCENARIO_EVENTS.LINE_EXEC_REG,
+    SYSTEM_EVENTS.STARTED,
+    SYSTEM_EVENTS.CLOSE,
+    STACK_EVENTS.EMIT,
+];
+export const stubSideEffectEvents = (observer) => {
+    stubVendorEvents(observer);
+    for (const event of CORE_SIDE_EFFECT_EVENTS)
+        stubSilentEvent(observer, event);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vnejs/test-utils",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Test harness utilities for @vnejs plugin modules",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -30,7 +30,8 @@
     "@vnejs/shared": "~0.1.0"
   },
   "peerDependencies": {
-    "@vnejs/module": "~0.1.0"
+    "@vnejs/module": "~0.1.0",
+    "vitest": ">=3.0.0"
   },
   "devDependencies": {
     "@vnejs/configs.ts-common": "~0.1.0",
@@ -47,6 +48,7 @@
     "@vnejs/contracts.core.storage": "~0.1.0",
     "@vnejs/contracts.core.system": "~0.1.0",
     "@vnejs/contracts.core.vendors": "~0.1.0",
-    "@vnejs/module": "~0.1.0"
+    "@vnejs/module": "~0.1.0",
+    "vitest": "~3.2.0"
   }
 }

package/src/expect-call-sequence.ts

@@ -0,0 +1,11 @@
+import { expect } from "vitest";
+
+import type { EventSpy } from "./spy-event.js";
+
+export const expectCallSequence = (spy: EventSpy, ...calls: unknown[]) => {
+  expect(spy).toHaveBeenCalledTimes(calls.length);
+
+  calls.forEach((expected, index) => {
+    expect(spy.mock.calls[index]?.[0]).toMatchObject(expected as Record<string, unknown>);
+  });
+};

package/src/harness.ts

@@ -1,5 +1,6 @@
 import type { ModuleGlobalStateRegistry, ModuleInject, ModuleShared } from "@vnejs/module";
-import { Observer } from "@vnejs/observer";
+import type { Observer } from "@vnejs/observer";
+import { createTestObserver } from "./stub-event.js";
 
 export type TestModuleInstance = {
   name: string;
@@ -16,18 +17,19 @@ export const createTestModule = <T extends TestModuleInstance>(
   ModuleClass: new () => T,
   { subscribe = true, ...injectArg }: CreateTestModuleOptions = {},
 ) => {
-  const observer = new Observer();
+  const observer = createTestObserver();
   const state = (injectArg.state ?? {}) as ModuleGlobalStateRegistry;
+  const shared = (injectArg.shared ?? {}) as ModuleShared;
   const module = new ModuleClass();
 
   module.inject({
     observer,
     state,
-    shared: (injectArg.shared ?? {}) as ModuleShared,
+    shared,
     media: injectArg.media ?? {},
     ...injectArg,
   });
   if (subscribe) module.subscribe();
 
-  return { module, observer, state };
+  return { module, observer, state, shared };
 };

package/src/index.ts

@@ -3,7 +3,9 @@ export { createTestModule, type CreateTestModuleOptions, type TestModuleInstance
 export { registerCoreVne } from "./register-core-vne.js";
 export { registerVnePlugin } from "./register-vne.js";
 export { resetDom } from "./reset-dom.js";
-export { spyEvent } from "./spy-event.js";
-export { stubEvent, stubLogsEmit, stubVendorEvents } from "./stub-event.js";
+export { expectCallSequence } from "./expect-call-sequence.js";
+export { spyEvent, type EventSpy } from "./spy-event.js";
+export { createTestObserver, stubEvent, stubLogsEmit, stubSilentEvent, stubVendorEvents } from "./stub-event.js";
+export { stubSideEffectEvents } from "./stub-side-effect-events.js";
 export { mockFullscreen } from "./mocks/dom.js";
 export { createLocalforageMock } from "./mocks/localforage.js";

package/src/mocks/dom.ts

@@ -1,22 +1,19 @@
+import { vi, type Mock } from "vitest";
+
 export type MockFullscreenOptions = {
   fullscreenElement?: Element | null;
 };
 
-export const mockFullscreen = ({ fullscreenElement = null }: MockFullscreenOptions = {}) => {
-  Object.defineProperty(document, "fullscreenElement", { value: fullscreenElement, configurable: true });
-
-  let requestCount = 0;
-  let exitCount = 0;
+export type MockFullscreen = {
+  requestFullscreen: Mock<() => Promise<void>>;
+  exitFullscreen: Mock<() => Promise<void>>;
+};
 
-  const requestFullscreen = () => {
-    requestCount += 1;
-    return Promise.resolve(undefined);
-  };
+export const mockFullscreen = ({ fullscreenElement = null }: MockFullscreenOptions = {}): MockFullscreen => {
+  Object.defineProperty(document, "fullscreenElement", { value: fullscreenElement, configurable: true });
 
-  const exitFullscreen = () => {
-    exitCount += 1;
-    return Promise.resolve(undefined);
-  };
+  const requestFullscreen = vi.fn(() => Promise.resolve(undefined));
+  const exitFullscreen = vi.fn(() => Promise.resolve(undefined));
 
   document.body.requestFullscreen = requestFullscreen;
   document.exitFullscreen = exitFullscreen;
@@ -24,7 +21,5 @@ export const mockFullscreen = ({ fullscreenElement = null }: MockFullscreenOptio
   return {
     requestFullscreen,
     exitFullscreen,
-    getRequestCount: () => requestCount,
-    getExitCount: () => exitCount,
   };
 };

package/src/spy-event.ts

@@ -1,16 +1,14 @@
 import type { Observer } from "@vnejs/observer";
+import { vi, type Mock } from "vitest";
 
-export const spyEvent = (observer: Observer, event: string) => {
-  const calls: unknown[][] = [];
+export type EventSpy = Mock<(...args: unknown[]) => void>;
+
+export const spyEvent = (observer: Observer, event: string): EventSpy => {
+  const spy = vi.fn() as EventSpy;
 
   observer.subscribe(event, (...args: unknown[]) => {
-    calls.push(args);
+    spy(...args);
   });
 
-  return {
-    calls,
-    count: () => calls.length,
-    last: () => calls.at(-1),
-    first: () => calls[0],
-  };
+  return spy;
 };

package/src/stub-event.ts

@@ -1,6 +1,24 @@
 import { SUBSCRIBE_EVENTS as LOGS_EVENTS } from "@vnejs/contracts.core.logs";
 import { SUBSCRIBE_EVENTS as VENDORS_EVENTS } from "@vnejs/contracts.core.vendors";
-import type { Observer } from "@vnejs/observer";
+import { Observer } from "@vnejs/observer";
+
+import { stubSideEffectEvents } from "./stub-side-effect-events.js";
+
+export const stubSilentEvent = (
+  observer: Observer,
+  event: string,
+  handler: (...args: unknown[]) => unknown = () => undefined,
+) => {
+  observer.subscribe(event, handler, { filterFromResult: true });
+};
+
+export const createTestObserver = () => {
+  const observer = new Observer();
+
+  stubSideEffectEvents(observer);
+
+  return observer;
+};
 
 export const stubEvent = (
   observer: Observer,
@@ -10,7 +28,7 @@ export const stubEvent = (
   observer.subscribe(event, handler);
 };
 
-export const stubLogsEmit = (observer: Observer) => stubEvent(observer, LOGS_EVENTS.EMIT);
+export const stubLogsEmit = (observer: Observer) => stubSilentEvent(observer, LOGS_EVENTS.EMIT);
 
 export const stubVendorEvents = (observer: Observer) => {
   stubEvent(observer, VENDORS_EVENTS.UID, () => "test-uid");

package/src/stub-side-effect-events.ts

@@ -0,0 +1,28 @@
+import { SUBSCRIBE_EVENTS as INTERACT_EVENTS } from "@vnejs/contracts.core.interact";
+import { SUBSCRIBE_EVENTS as LOGS_EVENTS } from "@vnejs/contracts.core.logs";
+import { SUBSCRIBE_EVENTS as SCENARIO_EVENTS } from "@vnejs/contracts.core.scenario";
+import { SUBSCRIBE_EVENTS as SETTINGS_EVENTS } from "@vnejs/contracts.core.settings";
+import { SUBSCRIBE_EVENTS as STACK_EVENTS } from "@vnejs/contracts.core.stack";
+import { SUBSCRIBE_EVENTS as SYSTEM_EVENTS } from "@vnejs/contracts.core.system";
+import type { Observer } from "@vnejs/observer";
+
+import { stubSilentEvent, stubVendorEvents } from "./stub-event.js";
+
+const CORE_SIDE_EFFECT_EVENTS = [
+  LOGS_EVENTS.EMIT,
+  INTERACT_EVENTS.EMIT,
+  INTERACT_EVENTS.PUSH,
+  INTERACT_EVENTS.POP,
+  SETTINGS_EVENTS.INIT,
+  SCENARIO_EVENTS.NEXT,
+  SCENARIO_EVENTS.LINE_EXEC_REG,
+  SYSTEM_EVENTS.STARTED,
+  SYSTEM_EVENTS.CLOSE,
+  STACK_EVENTS.EMIT,
+] as const;
+
+export const stubSideEffectEvents = (observer: Observer) => {
+  stubVendorEvents(observer);
+
+  for (const event of CORE_SIDE_EFFECT_EVENTS) stubSilentEvent(observer, event);
+};