@clipboard-health/testing-core 2.9.4 → 2.10.1

package/README.md

@@ -6,6 +6,7 @@ TypeScript-friendly testing utilities.
 
 - [Install](#install)
 - [Usage](#usage)
+  - [Contract fixtures](#contract-fixtures)
   - [Type narrowing `expect` helpers](#type-narrowing-expect-helpers)
 - [Local development commands](#local-development-commands)
 
@@ -17,6 +18,36 @@ npm install @clipboard-health/testing-core
 
 ## Usage
 
+### Contract fixtures
+
+Parse API response fixtures through their producer-owned Zod contract so drift fails when the
+fixture is constructed. Use `buildContractFixture` for one-off fixtures:
+
+```ts
+import { FeatureResponseSchema } from "@clipboard-health/contract-feature";
+import { buildContractFixture } from "@clipboard-health/testing-core";
+
+export const mockFeature = buildContractFixture({
+  schema: FeatureResponseSchema,
+  fixture: { id: "feature-id" },
+});
+```
+
+Use `createContractFixtureBuilder` for fixture families with shallow overrides:
+
+```ts
+import { createContractFixtureBuilder } from "@clipboard-health/testing-core";
+
+const buildFeature = createContractFixtureBuilder({
+  schema: FeatureResponseSchema,
+  defaults: { id: "default-id", name: "Default" },
+});
+
+export const mockRenamedFeature = buildFeature({ name: "Renamed" });
+```
+
+Both helpers accept schema input and return schema output, including Zod transforms.
+
 ### Type narrowing `expect` helpers
 
 Jest's [`expect(...).toBeDefined()`](https://jestjs.io/docs/expect#tobedefined) does not narrow types.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/testing-core",
-  "version": "2.9.4",
+  "version": "2.10.1",
   "description": "TypeScript-friendly testing utilities.",
   "keywords": [
     "expect",
@@ -21,7 +21,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@clipboard-health/util-ts": "5.14.1",
+    "@clipboard-health/util-ts": "5.15.1",
     "tslib": "2.8.1"
   },
   "devDependencies": {

package/src/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./lib/contractFixtures";
 export * from "./lib/expectToBeDefined";
 export * from "./lib/expectToBeFailure";
 export * from "./lib/expectToBeLeft";

package/src/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./lib/contractFixtures"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeDefined"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeFailure"), exports);
 tslib_1.__exportStar(require("./lib/expectToBeLeft"), exports);

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/testing-core/src/index.ts"],"names":[],"mappings":";;;AAAA,kEAAwC;AACxC,kEAAwC;AACxC,+DAAqC;AACrC,gEAAsC;AACtC,yEAA+C;AAC/C,2EAAiD;AACjD,kEAAwC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/testing-core/src/index.ts"],"names":[],"mappings":";;;AAAA,iEAAuC;AACvC,kEAAwC;AACxC,kEAAwC;AACxC,+DAAqC;AACrC,gEAAsC;AACtC,yEAA+C;AAC/C,2EAAiD;AACjD,kEAAwC"}

package/src/lib/contractFixtures.d.ts

@@ -0,0 +1,12 @@
+import type { z } from "zod";
+interface BuildContractFixtureRequest<Input, Output> {
+    fixture: Input;
+    schema: z.ZodType<Output, z.ZodTypeDef, Input>;
+}
+interface CreateContractFixtureBuilderRequest<Input extends object, Output> {
+    defaults: Input;
+    schema: z.ZodType<Output, z.ZodTypeDef, Input>;
+}
+export declare function buildContractFixture<Input, Output>({ fixture, schema, }: BuildContractFixtureRequest<Input, Output>): Output;
+export declare function createContractFixtureBuilder<Input extends object, Output>({ defaults, schema, }: CreateContractFixtureBuilderRequest<Input, Output>): (overrides?: Partial<Input>) => Output;
+export {};

package/src/lib/contractFixtures.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildContractFixture = buildContractFixture;
+exports.createContractFixtureBuilder = createContractFixtureBuilder;
+function buildContractFixture({ fixture, schema, }) {
+    return schema.parse(fixture);
+}
+function createContractFixtureBuilder({ defaults, schema, }) {
+    return (overrides = {}) => buildContractFixture({ fixture: { ...defaults, ...overrides }, schema });
+}
+//# sourceMappingURL=contractFixtures.js.map

package/src/lib/contractFixtures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractFixtures.js","sourceRoot":"","sources":["../../../../../packages/testing-core/src/lib/contractFixtures.ts"],"names":[],"mappings":";;;;AAYA,8BAAoD,EAClD,OAAO,EACP,MAAM,GACqC;IAC3C,OAAO,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,sCAA2E,EACzE,QAAQ,EACR,MAAM,GAC6C;IACnD,OAAO,CAAC,SAAS,GAAG,EAAE,EAAU,EAAE,CAChC,oBAAoB,CAAC,EAAE,OAAO,EAAE,EAAE,GAAG,QAAQ,EAAE,GAAG,SAAS,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AAC7E,CAAC"}