@coveo/thermidor-schema 1.0.0-beta.6 → 1.0.0-beta.7

package/README.md

@@ -7,11 +7,7 @@ pnpm add @coveo/thermidor-schema zod
 ```
 
 ```ts
-import {
-  CartStateSchema,
-  ProductListStateSchema,
-  type CartState,
-} from '@coveo/thermidor-schema';
+import {CartStateSchema, ProductListStateSchema, type CartState} from '@coveo/thermidor-schema';
 
 const cartState: CartState = CartStateSchema.parse({items: []});
 const productList = ProductListStateSchema.parse({products: []});
@@ -19,6 +15,37 @@ const productList = ProductListStateSchema.parse({products: []});
 
 This ESM-only package currently exports renderer-neutral domain values, controller state, and action payloads. JSON Schema remains the canonical contract.
 
+## Choosing a Zod major
+
+The default entry point is built with **Zod 4**. A second, pre-built entry point ships the
+same schemas constructed with **Zod 3**:
+
+```ts
+// Zod 4 (default)
+import {PaginationStateSchema} from '@coveo/thermidor-schema';
+
+// Zod 3
+import {PaginationStateSchema} from '@coveo/thermidor-schema/zod3';
+```
+
+Use `./zod3` when something in your dependency tree is pinned to Zod 3 and inspects schema
+internals. The A2-UI renderers are the common case: their binder resolves `{ "path": ... }`
+data bindings by reading Zod 3 internals (`_def.typeName`, `_def.shape()`), which a Zod 4
+schema does not expose — handing it a Zod 4 schema leaves every binding unresolved. The
+`./zod3` build removes the need to rebuild schemas at runtime to work around that.
+
+Both entry points are generated from the same canonical JSON Schema documents and expose an
+identical public surface; only the Zod dialect differs. The `zod` peer range
+(`^3.25 || ^4.4.3`) spans both, so install the major that matches the entry point you import
+— a single Zod install is enough, since Zod 4 also ships the classic API under `zod/v3`.
+
+> One caveat: in the `./zod3` build the _recursive_ `Product.children` field is typed
+> loosely, because Zod 3 cannot infer through a self-referential schema. Runtime validation
+> is unaffected, and the default Zod 4 build keeps the precise recursive type.
+
+`@coveo/thermidor` accepts a contract from either build: its injected-contract seam reads
+only Zod API that behaves identically across both majors.
+
 ## Status
 
 This package is in **beta**: the contract is unstable and may change, including breaking changes, between releases. Beta versions are published to the npm `beta` dist-tag, so install them explicitly:

package/dist/generated/schemas.js

@@ -820,10 +820,7 @@ export const CategoryFacetActionSchema = z.union([
 ]);
 export const CommerceSearchActionSchema = z.union([
     z.object({
-        event: z.object({
-            name: z.literal('submitQuery'),
-            context: z.strictObject({ query: z.string() }),
-        }),
+        event: z.object({ name: z.literal('submitQuery'), context: z.strictObject({ query: z.string() }) }),
     }),
     z.object({
         event: z.object({