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

package/dist/zod3/index.d.ts

@@ -0,0 +1,3 @@
+export declare const THERMIDOR_CATALOG_ID = "https://schema.thermidor.coveo.com/a2-ui/catalog.json";
+export { ActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, OverrideCorrectionSchema, OverrideCorrectionPayloadSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, LayoutStackPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductSummaryPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, LayoutStackActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from '../generated/zod3/schemas.js';
+export type { ActionItem, Cart, CartActions, CartState, UpdateCart, UpdateCartPayload, CartUpdateOperation, Purchase, PurchasePayload, PurchaseProduct, Transaction, QuerySuggestions, QuerySuggestionsActions, QuerySuggestionsState, QueryCompletion, FetchSuggestions, FetchSuggestionsPayload, RestoreState, RestoreStatePayload, FacetRestore, NumericRangeRestore, OverrideCorrection, OverrideCorrectionPayload, ShowMore, ShowMorePayload, SelectProducts, SelectProductsPayload, ProductClick, ProductClickPayload, BundleDisplay, BundleDisplayState, BundleSlot, BundleTier, CategoryFacet, CategoryFacetActions, CategoryFacetValue, CategoryFacetSearch, CategoryFacetSearchPayload, CategoryFacetSelectPathPayload, CategoryFacetState, CategoryFacetValues, CommerceSearch, CommerceSearchActions, CommerceSearchState, SubmitQuery, SubmitQueryPayload, ComparisonAttribute, ComparisonProduct, ComparisonTable, ComparisonTableState, ComponentContracts, DateFacet, DateFacetActions, DateFacetApplyCustomRangePayload, DateFacetCustomRange, DateFacetState, DateFacetToggleSelectPayload, DateFacetToggleSingleSelectPayload, DateFacetValue, FacetManager, FacetManagerActions, FacetManagerState, FacetValueState, SelectableFacetValueState, LayoutStack, LayoutStackState, NextActionsBar, NextActionsState, NumericFacet, NumericFacetActions, NumericFacetCustomRange, NumericFacetDomain, NumericFacetApplyCustomRangePayload, NumericFacetState, NumericFacetToggleSelectPayload, NumericFacetToggleSingleSelectPayload, NumericFacetValue, PageSize, PageSizeActions, PageSizeState, Pagination, PaginationActions, PaginationState, Product, ProductCarousel, ProductCarouselState, ProductList, ProductListActions, ProductListState, ProductSummary, ProductSummaryActions, ProductSummaryState, QuerySummary, QuerySummaryState, RegularFacet, RegularFacetActions, RegularFacetSearch, RegularFacetSearchResult, RegularFacetState, RegularFacetToggleExcludePayload, RegularFacetToggleSelectPayload, RegularFacetToggleSingleExcludePayload, RegularFacetToggleSingleSelectPayload, RegularFacetValue, SelectActionPayload, SelectPagePayload, SelectSortPayload, SetPageSizePayload, Sort, SortActions, SortCriterion, SortState, DataBinding, FunctionCall, DynamicNumber, DynamicString, DynamicBoolean, DynamicStringList, DynamicValue, DynamicAction, BundleDisplayAction, CategoryFacetAction, CommerceSearchAction, ComparisonTableAction, DateFacetAction, FacetManagerAction, LayoutStackAction, NextActionsBarAction, NumericFacetAction, PageSizeAction, PaginationAction, ProductCarouselAction, ProductListAction, ProductSummaryAction, QuerySummaryAction, RegularFacetAction, SortAction, BundleDisplayProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, LayoutStackProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductSummaryProps, QuerySummaryProps, RegularFacetProps, SortProps, } from '../generated/zod3/schemas.js';

package/dist/zod3/index.js

@@ -0,0 +1,5 @@
+// This file is generated from src/index.ts; it mirrors the curated public surface
+// of the default entry point against the Zod 3 schema build.
+// Do not edit it directly; run `mise run generate` from the repository root.
+export const THERMIDOR_CATALOG_ID = 'https://schema.thermidor.coveo.com/a2-ui/catalog.json';
+export { ActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, OverrideCorrectionSchema, OverrideCorrectionPayloadSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, LayoutStackPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductSummaryPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, LayoutStackActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from '../generated/zod3/schemas.js';

package/dist/zod3-compat.d.ts

@@ -0,0 +1,79 @@
+/**
+ * Zod 3 compatibility layer for the `./zod3` schema build.
+ *
+ * ## Why this exists
+ *
+ * The canonical generated schemas (`src/generated/schemas.ts`) are emitted in the
+ * Zod 4 dialect and import `zod/v4`. Some consumers are pinned to Zod 3 by a
+ * dependency they do not control — most notably the frozen A2-UI renderer, whose
+ * binder (`@a2ui/web_core`) resolves `{ path }` data bindings by reading **Zod 3**
+ * runtime internals. Handing such a consumer a Zod 4 schema means every field is
+ * misclassified and bindings leak to the renderer unresolved.
+ *
+ * Rather than ask those consumers to rebuild our schemas at runtime, the package
+ * ships a second, pre-built entry point (`@coveo/thermidor-schema/zod3`) whose
+ * schemas are real Zod 3 objects. That build reuses the SAME generated source and
+ * only swaps its Zod import for this module.
+ *
+ * ## How it works
+ *
+ * `import * as z from 'zod/v3'` already exposes every builder the generated source
+ * uses (`string`, `number`, `object`, `array`, `union`, `discriminatedUnion`,
+ * `literal`, `enum`, `record`, `unknown`, `null`, `never`, the `infer` type, and the
+ * `.min/.max/.int/.regex/.optional` refinements) with identical call signatures.
+ *
+ * Exactly three constructors in the generated output have no Zod 3 counterpart under
+ * the same name. They are defined here in terms of their Zod 3 equivalents:
+ *
+ * | Zod 4 (generated)     | Zod 3 equivalent                 |
+ * | --------------------- | -------------------------------- |
+ * | `z.strictObject(s)`   | `z.object(s).strict()`           |
+ * | `z.looseObject(s)`    | `z.object(s).passthrough()`      |
+ * | `z.url()`             | `z.string().url()`               |
+ *
+ * `z.union` needs one further accommodation: Zod 4 accepts a single-member union,
+ * Zod 3 requires at least two. A one-member union is semantically the member
+ * itself, so the override below unwraps it — preserving the inferred type exactly
+ * (see the overloads).
+ *
+ * `z.record(key, value)` is emitted in its two-argument form, which Zod 3 accepts
+ * unchanged, so it needs no shim.
+ *
+ * Because this module is a superset of `zod/v3`, the generated source compiles and
+ * runs against it verbatim — the dialect difference is confined to these functions,
+ * and adding a component to the canonical JSON Schema requires no change here.
+ * (Explicit exports below take precedence over the `export *`, which is how
+ * `union` overrides the Zod 3 original.)
+ *
+ * ## Stability
+ *
+ * This is a build-time dialect adapter, not a runtime schema rewriter: the schemas
+ * it produces ARE Zod 3 schemas, constructed by Zod 3 itself. There is no
+ * reflection over Zod internals and nothing to keep in sync with a Zod release.
+ */
+export * from 'zod/v3';
+import * as z3 from 'zod/v3';
+/**
+ * Zod 4's `z.strictObject(shape)` — an object schema that rejects unknown keys.
+ * Zod 3 spells the same thing `z.object(shape).strict()`.
+ */
+export declare function strictObject<T extends z3.ZodRawShape>(shape: T): z3.ZodObject<T, "strict", z3.ZodTypeAny, z3.objectUtil.addQuestionMarks<z3.baseObjectOutputType<T>, any> extends infer T_1 ? { [k in keyof T_1]: T_1[k]; } : never, z3.baseObjectInputType<T> extends infer T_2 ? { [k in keyof T_2]: T_2[k]; } : never>;
+/**
+ * Zod 4's `z.looseObject(shape)` — an object schema that preserves unknown keys.
+ * Zod 3 spells the same thing `z.object(shape).passthrough()`.
+ */
+export declare function looseObject<T extends z3.ZodRawShape>(shape: T): z3.ZodObject<T, "passthrough", z3.ZodTypeAny, z3.objectOutputType<T, z3.ZodTypeAny, "passthrough">, z3.objectInputType<T, z3.ZodTypeAny, "passthrough">>;
+/**
+ * Zod 4's top-level `z.url()` string format. In Zod 3 the URL check is a
+ * refinement on the string schema: `z.string().url()`.
+ */
+export declare function url(): z3.ZodString;
+/**
+ * `z.union`, widened to accept the single-member unions Zod 4 permits (the
+ * generated action unions use one member for a component that declares exactly one
+ * action). Zod 3's `union` requires a two-element tuple, so a one-member union is
+ * unwrapped to the member itself — semantically identical, and the overload keeps
+ * `z.infer` precise instead of degrading to `any`.
+ */
+export declare function union<T extends z3.ZodTypeAny>(options: readonly [T]): T;
+export declare function union<T extends readonly [z3.ZodTypeAny, z3.ZodTypeAny, ...z3.ZodTypeAny[]]>(options: T): z3.ZodUnion<T>;

package/dist/zod3-compat.js

@@ -0,0 +1,82 @@
+/**
+ * Zod 3 compatibility layer for the `./zod3` schema build.
+ *
+ * ## Why this exists
+ *
+ * The canonical generated schemas (`src/generated/schemas.ts`) are emitted in the
+ * Zod 4 dialect and import `zod/v4`. Some consumers are pinned to Zod 3 by a
+ * dependency they do not control — most notably the frozen A2-UI renderer, whose
+ * binder (`@a2ui/web_core`) resolves `{ path }` data bindings by reading **Zod 3**
+ * runtime internals. Handing such a consumer a Zod 4 schema means every field is
+ * misclassified and bindings leak to the renderer unresolved.
+ *
+ * Rather than ask those consumers to rebuild our schemas at runtime, the package
+ * ships a second, pre-built entry point (`@coveo/thermidor-schema/zod3`) whose
+ * schemas are real Zod 3 objects. That build reuses the SAME generated source and
+ * only swaps its Zod import for this module.
+ *
+ * ## How it works
+ *
+ * `import * as z from 'zod/v3'` already exposes every builder the generated source
+ * uses (`string`, `number`, `object`, `array`, `union`, `discriminatedUnion`,
+ * `literal`, `enum`, `record`, `unknown`, `null`, `never`, the `infer` type, and the
+ * `.min/.max/.int/.regex/.optional` refinements) with identical call signatures.
+ *
+ * Exactly three constructors in the generated output have no Zod 3 counterpart under
+ * the same name. They are defined here in terms of their Zod 3 equivalents:
+ *
+ * | Zod 4 (generated)     | Zod 3 equivalent                 |
+ * | --------------------- | -------------------------------- |
+ * | `z.strictObject(s)`   | `z.object(s).strict()`           |
+ * | `z.looseObject(s)`    | `z.object(s).passthrough()`      |
+ * | `z.url()`             | `z.string().url()`               |
+ *
+ * `z.union` needs one further accommodation: Zod 4 accepts a single-member union,
+ * Zod 3 requires at least two. A one-member union is semantically the member
+ * itself, so the override below unwraps it — preserving the inferred type exactly
+ * (see the overloads).
+ *
+ * `z.record(key, value)` is emitted in its two-argument form, which Zod 3 accepts
+ * unchanged, so it needs no shim.
+ *
+ * Because this module is a superset of `zod/v3`, the generated source compiles and
+ * runs against it verbatim — the dialect difference is confined to these functions,
+ * and adding a component to the canonical JSON Schema requires no change here.
+ * (Explicit exports below take precedence over the `export *`, which is how
+ * `union` overrides the Zod 3 original.)
+ *
+ * ## Stability
+ *
+ * This is a build-time dialect adapter, not a runtime schema rewriter: the schemas
+ * it produces ARE Zod 3 schemas, constructed by Zod 3 itself. There is no
+ * reflection over Zod internals and nothing to keep in sync with a Zod release.
+ */
+export * from 'zod/v3';
+import * as z3 from 'zod/v3';
+/**
+ * Zod 4's `z.strictObject(shape)` — an object schema that rejects unknown keys.
+ * Zod 3 spells the same thing `z.object(shape).strict()`.
+ */
+export function strictObject(shape) {
+    return z3.object(shape).strict();
+}
+/**
+ * Zod 4's `z.looseObject(shape)` — an object schema that preserves unknown keys.
+ * Zod 3 spells the same thing `z.object(shape).passthrough()`.
+ */
+export function looseObject(shape) {
+    return z3.object(shape).passthrough();
+}
+/**
+ * Zod 4's top-level `z.url()` string format. In Zod 3 the URL check is a
+ * refinement on the string schema: `z.string().url()`.
+ */
+export function url() {
+    return z3.string().url();
+}
+export function union(options) {
+    if (options.length === 1) {
+        return options[0];
+    }
+    return z3.union(options);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.7",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
   "bugs": {
@@ -26,6 +26,10 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js"
     },
+    "./zod3": {
+      "types": "./dist/zod3/index.d.ts",
+      "import": "./dist/zod3/index.js"
+    },
     "./schema/*": "./schema/*"
   },
   "publishConfig": {
@@ -38,7 +42,7 @@
     "zod": "4.4.3"
   },
   "peerDependencies": {
-    "zod": "^4.4.3"
+    "zod": "^3.25 || ^4.4.3"
   },
   "engines": {
     "node": ">=22.14.0"