@coveo/thermidor-schema 1.0.0-beta.4 → 1.0.0-beta.5

package/dist/generated/schemas.js

@@ -1,6 +1,7 @@
 // This file is generated from the canonical JSON Schema documents.
 // Do not edit it directly; run `mise run generate` from the repository root.
 import * as z from 'zod/v4';
+export const CartUpdateOperationSchema = z.enum(['add', 'remove', 'setQuantity']);
 // The kind of action: "followup" triggers a conversational follow-up, "search" triggers a
 // standalone search.
 //
@@ -42,6 +43,31 @@ export const ProductCarouselStateSchema = z.strictObject({
     heading: z.string(),
     products: z.array(ProductSchema),
 });
+export const PurchaseProductSchema = z.strictObject({
+    name: z.string().optional(),
+    price: z.union([z.number(), z.null()]).optional(),
+    productId: z.string().min(1),
+    quantity: z.number().int().min(1),
+});
+export const TransactionSchema = z.strictObject({
+    id: z.string().min(1),
+    revenue: z.number(),
+});
+export const UpdateCartPayloadSchema = z.strictObject({
+    name: z.string().optional(),
+    operation: z.enum(['add', 'remove', 'setQuantity']),
+    price: z.union([z.number(), z.null()]).optional(),
+    productId: z.string().min(1),
+    quantity: z.number().int().min(1),
+});
+export const CartStateSchema = z.strictObject({});
+export const FetchSuggestionsPayloadSchema = z.strictObject({
+    query: z.string(),
+});
+export const QueryCompletionSchema = z.strictObject({
+    expression: z.string(),
+    score: z.number().optional(),
+});
 export const SelectActionPayloadSchema = z.strictObject({
     text: z.string(),
     type: z.enum(['followup', 'search']),
@@ -68,7 +94,15 @@ export const ComparisonProductSchema = z.strictObject({
     rating: z.number().min(0).max(5).optional(),
     values: z.record(z.string(), z.string()).optional(),
 });
-export const ProductListActionsSchema = z.strictObject({});
+export const ProductClickPayloadSchema = z.strictObject({
+    name: z.string().optional(),
+    position: z.number().int().min(0),
+    price: z.union([z.number(), z.null()]).optional(),
+    productId: z.string().min(1),
+});
+export const SelectProductsPayloadSchema = z.strictObject({
+    productIds: z.array(z.string().min(1)),
+});
 export const ProductListStateSchema = z.strictObject({
     products: z.array(ProductSchema),
 });
@@ -83,6 +117,7 @@ export const SelectPagePayloadSchema = z.strictObject({
 export const PayloadSchema = z.strictObject({
     pageSize: z.number().int().min(1),
 });
+export const ShowMorePayloadSchema = z.strictObject({});
 export const PaginationStateSchema = z.strictObject({
     page: z.number().int().min(0),
     pageSize: z.number().int().min(1),
@@ -192,6 +227,14 @@ export const CategoryFacetValuesSchema = z.strictObject({
 });
 export const FacetManagerActionsSchema = z.strictObject({});
 export const FacetManagerStateSchema = z.strictObject({});
+export const OverrideCorrectionPayloadSchema = z.strictObject({
+    originalQuery: z.string().min(1),
+});
+export const NumericRangeRestoreSchema = z.strictObject({
+    end: z.number(),
+    endInclusive: z.boolean().optional(),
+    start: z.number(),
+});
 export const SubmitQueryPayloadSchema = z.strictObject({
     query: z.string(),
 });
@@ -221,6 +264,21 @@ export const ProductCarouselSchema = z.strictObject({
     componentType: z.literal('product-carousel'),
     state: ProductCarouselStateSchema,
 });
+export const PurchasePayloadSchema = z.strictObject({
+    products: z.array(PurchaseProductSchema),
+    transaction: TransactionSchema,
+});
+export const UpdateCartSchema = z.strictObject({
+    payload: UpdateCartPayloadSchema,
+});
+export const FetchSuggestionsSchema = z.strictObject({
+    payload: FetchSuggestionsPayloadSchema,
+});
+export const QuerySuggestionsStateSchema = z.strictObject({
+    completions: z.array(QueryCompletionSchema),
+    products: z.array(ProductSchema),
+    query: z.string(),
+});
 export const SelectActionSchema = z.strictObject({
     payload: SelectActionPayloadSchema,
 });
@@ -238,15 +296,11 @@ export const ComparisonTableStateSchema = z.strictObject({
     products: z.array(ComparisonProductSchema),
     summary: z.string(),
 });
-export const ProductListSchema = z.strictObject({
-    actions: ProductListActionsSchema,
-    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
-    children: z
-        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
-        .max(1000)
-        .optional(),
-    componentType: z.literal('product-list'),
-    state: ProductListStateSchema,
+export const ProductClickSchema = z.strictObject({
+    payload: ProductClickPayloadSchema,
+});
+export const SelectProductsSchema = z.strictObject({
+    payload: SelectProductsPayloadSchema,
 });
 export const ProductSummarySchema = z.strictObject({
     actions: ProductSummaryActionsSchema,
@@ -264,6 +318,9 @@ export const SelectPageSchema = z.strictObject({
 export const PurpleSetPageSizeSchema = z.strictObject({
     payload: PayloadSchema,
 });
+export const ShowMoreSchema = z.strictObject({
+    payload: ShowMorePayloadSchema,
+});
 export const SelectSortSchema = z.strictObject({
     payload: SelectSortPayloadSchema,
 });
@@ -349,6 +406,14 @@ export const FacetManagerSchema = z.strictObject({
     componentType: z.literal('facet-manager'),
     state: FacetManagerStateSchema,
 });
+export const OverrideCorrectionSchema = z.strictObject({
+    payload: OverrideCorrectionPayloadSchema,
+});
+export const FacetRestoreSchema = z.strictObject({
+    facetId: z.string().min(1),
+    numericRanges: z.array(NumericRangeRestoreSchema).optional(),
+    values: z.array(z.string()).optional(),
+});
 export const SubmitQuerySchema = z.strictObject({
     payload: SubmitQueryPayloadSchema,
 });
@@ -375,6 +440,12 @@ export const QuerySummarySchema = z.strictObject({
 export const FluffySetPageSizeSchema = z.strictObject({
     payload: SetPageSizePayloadSchema,
 });
+export const PurchaseSchema = z.strictObject({
+    payload: PurchasePayloadSchema,
+});
+export const QuerySuggestionsActionsSchema = z.strictObject({
+    fetchSuggestions: FetchSuggestionsSchema,
+});
 export const NextActionsBarActionsSchema = z.strictObject({
     selectAction: SelectActionSchema,
 });
@@ -391,9 +462,14 @@ export const ComparisonTableSchema = z.strictObject({
     componentType: z.literal('comparison-table'),
     state: ComparisonTableStateSchema,
 });
+export const ProductListActionsSchema = z.strictObject({
+    productClick: ProductClickSchema,
+    selectProducts: SelectProductsSchema,
+});
 export const PaginationActionsSchema = z.strictObject({
     selectPage: SelectPageSchema,
     setPageSize: PurpleSetPageSizeSchema,
+    showMore: ShowMoreSchema,
 });
 export const SortActionsSchema = z.strictObject({
     selectSort: SelectSortSchema,
@@ -452,12 +528,31 @@ export const CategoryFacetStateSchema = z.strictObject({
     field: z.string(),
     values: CategoryFacetValuesSchema,
 });
-export const CommerceSearchActionsSchema = z.strictObject({
-    submitQuery: SubmitQuerySchema,
+export const RestoreStatePayloadSchema = z.strictObject({
+    facets: z.array(FacetRestoreSchema).optional(),
+    page: z.number().int().min(0),
+    pageSize: z.number().int().min(1),
+    pinnedProducts: z.array(z.string()).optional(),
+    query: z.string(),
+    sortCriteria: z.string().optional(),
 });
 export const PageSizeActionsSchema = z.strictObject({
     setPageSize: FluffySetPageSizeSchema,
 });
+export const CartActionsSchema = z.strictObject({
+    purchase: PurchaseSchema,
+    updateCart: UpdateCartSchema,
+});
+export const QuerySuggestionsSchema = z.strictObject({
+    actions: QuerySuggestionsActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('query-suggestions'),
+    state: QuerySuggestionsStateSchema,
+});
 export const NextActionsBarSchema = z.strictObject({
     actions: NextActionsBarActionsSchema,
     child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
@@ -478,6 +573,16 @@ export const BundleDisplaySchema = z.strictObject({
     componentType: z.literal('bundle-display'),
     state: BundleDisplayStateSchema,
 });
+export const ProductListSchema = z.strictObject({
+    actions: ProductListActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('product-list'),
+    state: ProductListStateSchema,
+});
 export const PaginationSchema = z.strictObject({
     actions: PaginationActionsSchema,
     child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
@@ -538,28 +643,48 @@ export const CategoryFacetSchema = z.strictObject({
     componentType: z.literal('category-facet'),
     state: CategoryFacetStateSchema,
 });
-export const CommerceSearchSchema = z.strictObject({
-    actions: CommerceSearchActionsSchema,
+export const RestoreStateSchema = z.strictObject({
+    payload: RestoreStatePayloadSchema,
+});
+export const PageSizeSchema = z.strictObject({
+    actions: PageSizeActionsSchema,
     child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
     children: z
         .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
         .max(1000)
         .optional(),
-    componentType: z.literal('commerce-search'),
-    state: CommerceSearchStateSchema,
+    componentType: z.literal('page-size'),
+    state: PageSizeStateSchema,
 });
-export const PageSizeSchema = z.strictObject({
-    actions: PageSizeActionsSchema,
+export const CartSchema = z.strictObject({
+    actions: CartActionsSchema,
     child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
     children: z
         .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
         .max(1000)
         .optional(),
-    componentType: z.literal('page-size'),
-    state: PageSizeStateSchema,
+    componentType: z.literal('cart'),
+    state: CartStateSchema,
+});
+export const CommerceSearchActionsSchema = z.strictObject({
+    overrideCorrection: OverrideCorrectionSchema,
+    restoreState: RestoreStateSchema,
+    submitQuery: SubmitQuerySchema,
+});
+export const CommerceSearchSchema = z.strictObject({
+    actions: CommerceSearchActionsSchema,
+    child: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')).optional(),
+    children: z
+        .array(z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')))
+        .max(1000)
+        .optional(),
+    componentType: z.literal('commerce-search'),
+    state: CommerceSearchStateSchema,
 });
 export const ComponentContractsSchema = z.discriminatedUnion('componentType', [
     ProductCarouselSchema,
+    CartSchema,
+    QuerySuggestionsSchema,
     NextActionsBarSchema,
     BundleDisplaySchema,
     ComparisonTableSchema,
@@ -587,6 +712,10 @@ export const BundleDisplayPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('bundle-display'),
 });
+export const CartPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('cart'),
+});
 export const CategoryFacetPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('category-facet'),
@@ -639,6 +768,10 @@ export const ProductSummaryPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('product-summary'),
 });
+export const QuerySuggestionsPropsSchema = z.object({
+    componentId: z.string(),
+    componentType: z.literal('query-suggestions'),
+});
 export const QuerySummaryPropsSchema = z.object({
     componentId: z.string(),
     componentType: z.literal('query-summary'),

package/dist/index.d.ts

@@ -1,3 +1,3 @@
 export declare const THERMIDOR_CATALOG_ID = "https://schema.thermidor.coveo.com/a2-ui/catalog.json";
-export { ActionItemSchema, 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, } from './generated/schemas.js';
-export type { ActionItem, 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, BundleDisplayProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, LayoutStackProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductSummaryProps, QuerySummaryProps, RegularFacetProps, SortProps, } from './generated/schemas.js';
+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, } from './generated/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, BundleDisplayProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, LayoutStackProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductSummaryProps, QuerySummaryProps, RegularFacetProps, SortProps, } from './generated/schemas.js';

package/dist/index.js

@@ -1,2 +1,2 @@
 export const THERMIDOR_CATALOG_ID = 'https://schema.thermidor.coveo.com/a2-ui/catalog.json';
-export { ActionItemSchema, 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, } from './generated/schemas.js';
+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, } from './generated/schemas.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.4",
+  "version": "1.0.0-beta.5",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "license": "Apache-2.0",
   "type": "module",

package/schema/{components/component-contracts.schema.json → component-contracts.schema.json}

@@ -1,6 +1,6 @@
 {
   "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://schema.thermidor.coveo.com/components/component-contracts.schema.json",
+  "$id": "https://schema.thermidor.coveo.com/component-contracts.schema.json",
   "title": "Component Contracts",
   "description": "Discriminated index of component runtime contracts. componentType is the stable discriminant; componentId identifies a particular instance outside this static contract.",
   "$defs": {
@@ -10,6 +10,12 @@
         {
           "$ref": "https://schema.thermidor.coveo.com/components/product-carousel.schema.json"
         },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/cart.schema.json"
+        },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/query-suggestions.schema.json"
+        },
         {
           "$ref": "https://schema.thermidor.coveo.com/components/next-actions-bar.schema.json"
         },

package/schema/components/cart.schema.json

@@ -0,0 +1,156 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/cart.schema.json",
+  "title": "Cart",
+  "description": "Represents a commerce cart or checkout surface. The backend owns cart state; semantic cart mutations and purchase completion are dispatched through this component.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "componentType": {
+      "type": "string",
+      "const": "cart"
+    },
+    "state": {
+      "$ref": "#/$defs/CartState"
+    },
+    "actions": {
+      "type": "object",
+      "required": ["updateCart", "purchase"],
+      "properties": {
+        "updateCart": {
+          "$ref": "#/$defs/UpdateCartAction"
+        },
+        "purchase": {
+          "$ref": "#/$defs/PurchaseAction"
+        }
+      },
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "$comment": "TODO: Revisit this provisional cart-child limit when the cart composition model is defined.",
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "CartState": {
+      "title": "CartState",
+      "description": "Cart state is backend-owned. This initial contract intentionally carries no presentation fields; it provides the canonical action anchor for cart mutations and checkout completion.",
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "UpdateCartAction": {
+      "title": "updateCart",
+      "description": "Applies a semantic item update to the cart and records the corresponding commerce cart event.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["productId", "quantity", "operation"],
+          "properties": {
+            "productId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "name": {
+              "type": "string"
+            },
+            "price": {
+              "type": ["number", "null"]
+            },
+            "quantity": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "operation": {
+              "title": "CartUpdateOperation",
+              "type": "string",
+              "enum": ["add", "remove", "setQuantity"]
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "PurchaseAction": {
+      "title": "purchase",
+      "description": "Records a completed commerce transaction.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["products", "transaction"],
+          "properties": {
+            "products": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/PurchaseProduct"
+              }
+            },
+            "transaction": {
+              "$ref": "#/$defs/Transaction"
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "PurchaseProduct": {
+      "title": "PurchaseProduct",
+      "type": "object",
+      "required": ["productId", "quantity"],
+      "properties": {
+        "productId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "name": {
+          "type": "string"
+        },
+        "price": {
+          "type": ["number", "null"]
+        },
+        "quantity": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "additionalProperties": false
+    },
+    "Transaction": {
+      "title": "Transaction",
+      "type": "object",
+      "required": ["id", "revenue"],
+      "properties": {
+        "id": {
+          "type": "string",
+          "minLength": 1
+        },
+        "revenue": {
+          "type": "number"
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schema/components/commerce-search.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/components/commerce-search.schema.json",
   "title": "CommerceSearch",
-  "description": "Surface-root component for a commerce search surface. Its componentType carries the surface intent; it owns the surface's top-level components via children and dispatches submitQuery when the user submits a new query.",
+  "description": "Surface-root component for a commerce search surface. Its componentType carries the surface intent; it owns the surface's top-level components via children and dispatches search lifecycle actions.",
   "allOf": [
     {
       "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
@@ -18,10 +18,16 @@
     },
     "actions": {
       "type": "object",
-      "required": ["submitQuery"],
+      "required": ["submitQuery", "restoreState", "overrideCorrection"],
       "properties": {
         "submitQuery": {
           "$ref": "#/$defs/SubmitQueryAction"
+        },
+        "restoreState": {
+          "$ref": "#/$defs/RestoreStateAction"
+        },
+        "overrideCorrection": {
+          "$ref": "#/$defs/OverrideCorrectionAction"
         }
       },
       "additionalProperties": false
@@ -67,6 +73,113 @@
           "additionalProperties": false
         }
       }
+    },
+    "RestoreStateAction": {
+      "title": "restoreState",
+      "description": "Restores a commerce-search surface from externally persisted search state.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["query", "page", "pageSize"],
+          "properties": {
+            "query": {
+              "type": "string"
+            },
+            "page": {
+              "type": "integer",
+              "minimum": 0
+            },
+            "pageSize": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "sortCriteria": {
+              "type": "string"
+            },
+            "facets": {
+              "type": "array",
+              "items": {
+                "$ref": "#/$defs/FacetRestore"
+              }
+            },
+            "pinnedProducts": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "OverrideCorrectionAction": {
+      "title": "overrideCorrection",
+      "description": "Re-runs a search with the shopper's original query instead of an automatic correction.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["originalQuery"],
+          "properties": {
+            "originalQuery": {
+              "type": "string",
+              "minLength": 1
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "FacetRestore": {
+      "title": "FacetRestore",
+      "type": "object",
+      "required": ["facetId"],
+      "properties": {
+        "facetId": {
+          "type": "string",
+          "minLength": 1
+        },
+        "values": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "numericRanges": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/NumericRangeRestore"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "NumericRangeRestore": {
+      "title": "NumericRangeRestore",
+      "type": "object",
+      "required": ["start", "end"],
+      "properties": {
+        "start": {
+          "type": "number"
+        },
+        "end": {
+          "type": "number"
+        },
+        "endInclusive": {
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false
     }
   }
 }