@spoosh/test-utils 0.1.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Spoosh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,71 @@
+# @spoosh/test-utils
+
+Test utilities for Spoosh plugins.
+
+## Installation
+
+```bash
+npm install -D @spoosh/test-utils
+```
+
+## Usage
+
+```typescript
+import {
+  createMockContext,
+  createMockResponse,
+  createMockNext,
+  createState,
+  createStateManager,
+  createEventEmitter,
+} from "@spoosh/test-utils";
+
+describe("myPlugin", () => {
+  it("should work", async () => {
+    const plugin = myPlugin();
+    const context = createMockContext({
+      queryKey: "test-key",
+      pluginOptions: { myOption: true },
+    });
+    const next = createMockNext({ data: { id: 1 } });
+
+    const result = await plugin.middleware!(context, next);
+
+    expect(result.data).toEqual({ id: 1 });
+  });
+});
+```
+
+## API
+
+### `createMockContext(options?)`
+
+Creates a mock `PluginContext` for testing plugins.
+
+### `createMockResponse(overrides?)`
+
+Creates a mock `SpooshResponse`.
+
+### `createMockNext(response?)`
+
+Creates a mock next function that returns a successful response.
+
+### `createMockNextError(error)`
+
+Creates a mock next function that throws an error.
+
+### `createMockNextWithError(error, status?)`
+
+Creates a mock next function that returns an error response.
+
+### `createState(overrides?)`
+
+Creates a default `OperationState` with optional overrides.
+
+### `createStateManager()`
+
+Re-exported from `@spoosh/core` for convenience.
+
+### `createEventEmitter()`
+
+Re-exported from `@spoosh/core` for convenience.

package/dist/index.cjs

@@ -0,0 +1,115 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  createEventEmitter: () => import_core.createEventEmitter,
+  createMockContext: () => createMockContext,
+  createMockNext: () => createMockNext,
+  createMockNextError: () => createMockNextError,
+  createMockNextWithError: () => createMockNextWithError,
+  createMockResponse: () => createMockResponse,
+  createState: () => createState,
+  createStateManager: () => import_core.createStateManager
+});
+module.exports = __toCommonJS(src_exports);
+var import_core = require("@spoosh/core");
+var import_vitest = require("vitest");
+function createState(overrides = {}) {
+  return {
+    data: void 0,
+    error: void 0,
+    timestamp: 0,
+    ...overrides
+  };
+}
+function createMockContext(options = {}) {
+  const {
+    stateManager = (0, import_core.createStateManager)(),
+    eventEmitter = (0, import_core.createEventEmitter)(),
+    queryKey = '{"method":"GET","path":["test"]}',
+    path = ["test"],
+    method = "GET",
+    tags = ["test"],
+    operationType = "read",
+    pluginOptions,
+    forceRefetch,
+    hookId,
+    state: stateOverrides,
+    requestOptions = {},
+    metadata = /* @__PURE__ */ new Map(),
+    plugins = { get: import_vitest.vi.fn() }
+  } = options;
+  const state = createState(stateOverrides);
+  return {
+    operationType,
+    path,
+    method,
+    queryKey,
+    tags,
+    requestTimestamp: Date.now(),
+    requestOptions,
+    state,
+    metadata,
+    abort: import_vitest.vi.fn(),
+    stateManager,
+    eventEmitter,
+    headers: {},
+    setHeaders: import_vitest.vi.fn(),
+    plugins,
+    pluginOptions,
+    forceRefetch,
+    hookId
+  };
+}
+function createMockResponse(overrides = {}) {
+  return {
+    status: 200,
+    data: void 0,
+    error: void 0,
+    ...overrides
+  };
+}
+function createMockNext(response) {
+  return import_vitest.vi.fn().mockResolvedValue(createMockResponse(response));
+}
+function createMockNextError(error) {
+  return import_vitest.vi.fn().mockRejectedValue(error);
+}
+function createMockNextWithError(error, status = 500) {
+  return import_vitest.vi.fn().mockResolvedValue(
+    createMockResponse({
+      status,
+      data: void 0,
+      error
+    })
+  );
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  createEventEmitter,
+  createMockContext,
+  createMockNext,
+  createMockNextError,
+  createMockNextWithError,
+  createMockResponse,
+  createState,
+  createStateManager
+});

package/dist/index.d.cts

@@ -0,0 +1,51 @@
+import { OperationState, StateManager, EventEmitter, PluginContext, SpooshResponse } from '@spoosh/core';
+export { createEventEmitter, createStateManager } from '@spoosh/core';
+import { vi, Mock } from 'vitest';
+
+/**
+ * Creates a default OperationState with optional overrides.
+ */
+declare function createState<TData = unknown, TError = unknown>(overrides?: Partial<OperationState<TData, TError>>): OperationState<TData, TError>;
+type MockContextOptions<TData = unknown, TError = unknown> = {
+    stateManager?: StateManager;
+    eventEmitter?: EventEmitter;
+    queryKey?: string;
+    path?: string[];
+    method?: string;
+    tags?: string[];
+    operationType?: "read" | "write" | "infiniteRead";
+    pluginOptions?: unknown;
+    forceRefetch?: boolean;
+    hookId?: string;
+    state?: Partial<OperationState<TData, TError>>;
+    requestOptions?: Record<string, unknown>;
+    /** Custom metadata map for the context */
+    metadata?: Map<string, unknown>;
+    /** Custom plugins object with get function */
+    plugins?: {
+        get: ReturnType<typeof vi.fn>;
+    };
+};
+/**
+ * Creates a mock PluginContext for testing plugins.
+ */
+declare function createMockContext<TData = unknown, TError = unknown>(options?: MockContextOptions<TData, TError>): PluginContext<TData, TError>;
+/**
+ * Creates a mock SpooshResponse.
+ */
+declare function createMockResponse<TData = unknown, TError = unknown>(overrides?: Partial<SpooshResponse<TData, TError>>): SpooshResponse<TData, TError>;
+type MockNextFn<TData = unknown, TError = unknown> = Mock<() => Promise<SpooshResponse<TData, TError>>>;
+/**
+ * Creates a mock next function for middleware testing.
+ */
+declare function createMockNext<TData = unknown, TError = unknown>(response?: Partial<SpooshResponse<TData, TError>>): MockNextFn<TData, TError>;
+/**
+ * Creates a mock next function that throws an error.
+ */
+declare function createMockNextError<TError = Error>(error: TError): MockNextFn<never, TError>;
+/**
+ * Creates a mock next function that returns an error response.
+ */
+declare function createMockNextWithError<TData = unknown, TError = unknown>(error: TError, status?: number): MockNextFn<TData, TError>;
+
+export { type MockContextOptions, type MockNextFn, createMockContext, createMockNext, createMockNextError, createMockNextWithError, createMockResponse, createState };

package/dist/index.d.ts

@@ -0,0 +1,51 @@
+import { OperationState, StateManager, EventEmitter, PluginContext, SpooshResponse } from '@spoosh/core';
+export { createEventEmitter, createStateManager } from '@spoosh/core';
+import { vi, Mock } from 'vitest';
+
+/**
+ * Creates a default OperationState with optional overrides.
+ */
+declare function createState<TData = unknown, TError = unknown>(overrides?: Partial<OperationState<TData, TError>>): OperationState<TData, TError>;
+type MockContextOptions<TData = unknown, TError = unknown> = {
+    stateManager?: StateManager;
+    eventEmitter?: EventEmitter;
+    queryKey?: string;
+    path?: string[];
+    method?: string;
+    tags?: string[];
+    operationType?: "read" | "write" | "infiniteRead";
+    pluginOptions?: unknown;
+    forceRefetch?: boolean;
+    hookId?: string;
+    state?: Partial<OperationState<TData, TError>>;
+    requestOptions?: Record<string, unknown>;
+    /** Custom metadata map for the context */
+    metadata?: Map<string, unknown>;
+    /** Custom plugins object with get function */
+    plugins?: {
+        get: ReturnType<typeof vi.fn>;
+    };
+};
+/**
+ * Creates a mock PluginContext for testing plugins.
+ */
+declare function createMockContext<TData = unknown, TError = unknown>(options?: MockContextOptions<TData, TError>): PluginContext<TData, TError>;
+/**
+ * Creates a mock SpooshResponse.
+ */
+declare function createMockResponse<TData = unknown, TError = unknown>(overrides?: Partial<SpooshResponse<TData, TError>>): SpooshResponse<TData, TError>;
+type MockNextFn<TData = unknown, TError = unknown> = Mock<() => Promise<SpooshResponse<TData, TError>>>;
+/**
+ * Creates a mock next function for middleware testing.
+ */
+declare function createMockNext<TData = unknown, TError = unknown>(response?: Partial<SpooshResponse<TData, TError>>): MockNextFn<TData, TError>;
+/**
+ * Creates a mock next function that throws an error.
+ */
+declare function createMockNextError<TError = Error>(error: TError): MockNextFn<never, TError>;
+/**
+ * Creates a mock next function that returns an error response.
+ */
+declare function createMockNextWithError<TData = unknown, TError = unknown>(error: TError, status?: number): MockNextFn<TData, TError>;
+
+export { type MockContextOptions, type MockNextFn, createMockContext, createMockNext, createMockNextError, createMockNextWithError, createMockResponse, createState };

package/dist/index.js

@@ -0,0 +1,86 @@
+// src/index.ts
+import {
+  createStateManager,
+  createEventEmitter
+} from "@spoosh/core";
+import { vi } from "vitest";
+function createState(overrides = {}) {
+  return {
+    data: void 0,
+    error: void 0,
+    timestamp: 0,
+    ...overrides
+  };
+}
+function createMockContext(options = {}) {
+  const {
+    stateManager = createStateManager(),
+    eventEmitter = createEventEmitter(),
+    queryKey = '{"method":"GET","path":["test"]}',
+    path = ["test"],
+    method = "GET",
+    tags = ["test"],
+    operationType = "read",
+    pluginOptions,
+    forceRefetch,
+    hookId,
+    state: stateOverrides,
+    requestOptions = {},
+    metadata = /* @__PURE__ */ new Map(),
+    plugins = { get: vi.fn() }
+  } = options;
+  const state = createState(stateOverrides);
+  return {
+    operationType,
+    path,
+    method,
+    queryKey,
+    tags,
+    requestTimestamp: Date.now(),
+    requestOptions,
+    state,
+    metadata,
+    abort: vi.fn(),
+    stateManager,
+    eventEmitter,
+    headers: {},
+    setHeaders: vi.fn(),
+    plugins,
+    pluginOptions,
+    forceRefetch,
+    hookId
+  };
+}
+function createMockResponse(overrides = {}) {
+  return {
+    status: 200,
+    data: void 0,
+    error: void 0,
+    ...overrides
+  };
+}
+function createMockNext(response) {
+  return vi.fn().mockResolvedValue(createMockResponse(response));
+}
+function createMockNextError(error) {
+  return vi.fn().mockRejectedValue(error);
+}
+function createMockNextWithError(error, status = 500) {
+  return vi.fn().mockResolvedValue(
+    createMockResponse({
+      status,
+      data: void 0,
+      error
+    })
+  );
+}
+export {
+  createEventEmitter,
+  createMockContext,
+  createMockNext,
+  createMockNextError,
+  createMockNextWithError,
+  createMockResponse,
+  createState,
+  createStateManager
+};

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@spoosh/test-utils",
+  "version": "0.1.0-beta.0",
+  "description": "Test utilities for Spoosh plugins",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nxnom/spoosh.git",
+    "directory": "packages/test-utils"
+  },
+  "bugs": {
+    "url": "https://github.com/nxnom/spoosh/issues"
+  },
+  "homepage": "https://spoosh.dev",
+  "keywords": [
+    "spoosh",
+    "test-utils",
+    "testing",
+    "vitest",
+    "mock"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@spoosh/core": "0.1.0-beta.0"
+  },
+  "peerDependencies": {
+    "vitest": ">=1.0.0"
+  },
+  "devDependencies": {
+    "vitest": "^4.0.17"
+  },
+  "scripts": {
+    "build": "tsup",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src --max-warnings 0"
+  }
+}