@ereo/testing 0.1.6

package/dist/snapshot.d.ts

@@ -0,0 +1,96 @@
+/**
+ * @ereo/testing - Snapshot Testing
+ *
+ * Utilities for snapshot testing loaders and actions.
+ */
+import type { LoaderFunction, ActionFunction, RouteParams } from '@ereo/core';
+import { type LoaderTestOptions } from './loader';
+import { type ActionTestOptions } from './action';
+/**
+ * Snapshot options.
+ */
+export interface SnapshotOptions {
+    /** Fields to exclude from snapshot */
+    exclude?: string[];
+    /** Fields to include in snapshot (if specified, only these are included) */
+    include?: string[];
+    /** Custom serializer */
+    serialize?: (data: unknown) => string;
+    /** Replace dynamic values */
+    replacers?: Record<string, unknown>;
+}
+/**
+ * Create a snapshot of loader data.
+ *
+ * @example
+ * test('loader snapshot', async () => {
+ *   const snapshot = await snapshotLoader(loader, {
+ *     params: { slug: 'test-post' },
+ *   }, {
+ *     exclude: ['createdAt', 'updatedAt'],
+ *     replacers: { id: '[ID]' },
+ *   });
+ *
+ *   expect(snapshot).toMatchSnapshot();
+ * });
+ */
+export declare function snapshotLoader<T = unknown, P = RouteParams>(loader: LoaderFunction<T, P>, testOptions?: LoaderTestOptions<P>, snapshotOptions?: SnapshotOptions): Promise<unknown>;
+/**
+ * Create a snapshot of action result.
+ *
+ * @example
+ * test('action snapshot', async () => {
+ *   const snapshot = await snapshotAction(action, {
+ *     formData: { title: 'Test', content: 'Content' },
+ *   }, {
+ *     exclude: ['id', 'createdAt'],
+ *   });
+ *
+ *   expect(snapshot).toMatchSnapshot();
+ * });
+ */
+export declare function snapshotAction<T = unknown, P = RouteParams>(action: ActionFunction<T | Response, P>, testOptions?: ActionTestOptions<P>, snapshotOptions?: SnapshotOptions): Promise<unknown>;
+/**
+ * Create a snapshot object for multiple test scenarios.
+ *
+ * @example
+ * const snapshots = await createSnapshotMatrix(loader, {
+ *   scenarios: {
+ *     'loads featured posts': { params: { featured: 'true' } },
+ *     'loads recent posts': { params: { sort: 'recent' } },
+ *     'loads by author': { params: { author: 'test-user' } },
+ *   },
+ * });
+ *
+ * expect(snapshots).toMatchSnapshot();
+ */
+export declare function createSnapshotMatrix<T = unknown, P = RouteParams>(loader: LoaderFunction<T, P>, options: {
+    scenarios: Record<string, LoaderTestOptions<P>>;
+    snapshotOptions?: SnapshotOptions;
+}): Promise<Record<string, unknown>>;
+/**
+ * Common replacers for dynamic values.
+ */
+export declare const commonReplacers: {
+    /** Replace ISO date strings */
+    date: RegExp;
+    /** Replace UUIDs */
+    uuid: RegExp;
+    /** Replace numeric IDs */
+    numericId: RegExp;
+};
+/**
+ * Apply string replacements for snapshot stability.
+ *
+ * @example
+ * const stableData = applyReplacements(data, {
+ *   [commonReplacers.date]: '[DATE]',
+ *   [commonReplacers.uuid]: '[UUID]',
+ * });
+ */
+export declare function applyReplacements(data: unknown, replacements: Record<string, string>): unknown;
+/**
+ * Create a deterministic snapshot by sorting object keys.
+ */
+export declare function deterministicSnapshot(data: unknown): string;
+//# sourceMappingURL=snapshot.d.ts.map

package/dist/snapshot.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"snapshot.d.ts","sourceRoot":"","sources":["../src/snapshot.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAC9E,OAAO,EAAc,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAc,KAAK,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,sCAAsC;IACtC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,4EAA4E;IAC5E,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,wBAAwB;IACxB,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC;IACtC,6BAA6B;IAC7B,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACrC;AAgDD;;;;;;;;;;;;;;GAcG;AACH,wBAAsB,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EAC/D,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,WAAW,GAAE,iBAAiB,CAAC,CAAC,CAAM,EACtC,eAAe,GAAE,eAAoB,GACpC,OAAO,CAAC,OAAO,CAAC,CAGlB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,cAAc,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EAC/D,MAAM,EAAE,cAAc,CAAC,CAAC,GAAG,QAAQ,EAAE,CAAC,CAAC,EACvC,WAAW,GAAE,iBAAiB,CAAC,CAAC,CAAM,EACtC,eAAe,GAAE,eAAoB,GACpC,OAAO,CAAC,OAAO,CAAC,CAGlB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,oBAAoB,CAAC,CAAC,GAAG,OAAO,EAAE,CAAC,GAAG,WAAW,EACrE,MAAM,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAC5B,OAAO,EAAE;IACP,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GACA,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAYlC;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;IAC1B,+BAA+B;;IAE/B,oBAAoB;;IAEpB,0BAA0B;;CAE3B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,OAAO,EACb,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GACnC,OAAO,CAST;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,OAAO,GAAG,MAAM,CAY3D"}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@ereo/testing",
+  "version": "0.1.6",
+  "license": "MIT",
+  "author": "Ereo Team",
+  "homepage": "https://ereo.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ereojs/ereo.git",
+    "directory": "packages/testing"
+  },
+  "bugs": {
+    "url": "https://github.com/ereojs/ereo/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun --external @ereo/core --external @ereo/router --external @ereo/data --external @ereo/server --external react && bun run build:types",
+    "build:types": "tsc --emitDeclarationOnly --outDir dist",
+    "dev": "bun build ./src/index.ts --outdir ./dist --target bun --watch",
+    "test": "bun test",
+    "typecheck": "tsc --noEmit --skipLibCheck"
+  },
+  "dependencies": {
+    "@ereo/core": "workspace:*",
+    "@ereo/router": "workspace:*",
+    "@ereo/data": "workspace:*"
+  },
+  "devDependencies": {
+    "@types/bun": "^1.1.0",
+    "typescript": "^5.4.0"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0"
+  }
+}