@coveo/thermidor-schema 1.0.0-beta.39 → 1.0.0-beta.40

package/dist/generated/zod3/schemas.js

@@ -17,6 +17,8 @@ export const BreadboxFacetTypeSchema = z.enum([
     'numericalRange',
     'regular',
 ]);
+// What replaced the shopper's query: an automatic query correction, or a query trigger.
+export const QueryCorrectionCauseSchema = z.enum(['correction', 'trigger']);
 export const ProductSchema = z.strictObject({
     additionalFields: z.record(z.string(), z.unknown()),
     get badgePlacements() {
@@ -325,9 +327,6 @@ export const BreadboxFacetValueSchema = z.strictObject({
 });
 export const InitializePayloadSchema = z.strictObject({});
 export const SessionShellStateSchema = z.strictObject({});
-export const OverrideCorrectionPayloadSchema = z.strictObject({
-    originalQuery: z.string().min(1),
-});
 export const NumericRangeRestoreSchema = z.strictObject({
     end: z.number(),
     endInclusive: z.boolean().optional(),
@@ -339,12 +338,13 @@ export const SubmitQueryPayloadSchema = z.strictObject({
 export const CommerceSearchStateSchema = z.strictObject({});
 export const LayoutStackActionsSchema = z.strictObject({});
 export const LayoutStackStateSchema = z.strictObject({});
-export const QuerySummaryActionsSchema = z.strictObject({});
-export const QuerySummaryStateSchema = z.strictObject({
-    firstIndex: z.number().int().min(0),
-    lastIndex: z.number().int().min(0),
-    query: z.string(),
-    totalEntries: z.number().int().min(0),
+export const QuerySummaryActionsSchema = z.strictObject({
+    overrideCorrection: ActionSchema,
+});
+export const QueryCorrectionSchema = z.strictObject({
+    canOverride: z.boolean(),
+    cause: z.enum(['correction', 'trigger']),
+    originalQuery: z.string().min(1),
 });
 export const SetPageSizePayloadSchema = z.strictObject({
     pageSize: z.number().int().min(1),
@@ -538,9 +538,6 @@ export const BreadboxFacetSchema = z.discriminatedUnion('type', [
 export const InitializeSchema = z.strictObject({
     payload: InitializePayloadSchema,
 });
-export const OverrideCorrectionSchema = z.strictObject({
-    payload: OverrideCorrectionPayloadSchema,
-});
 export const FacetRestoreSchema = z.strictObject({
     facetId: z.string().min(1),
     numericRanges: z.array(NumericRangeRestoreSchema).optional(),
@@ -556,11 +553,12 @@ export const LayoutStackSchema = z.looseObject({
     id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
     state: LayoutStackStateSchema.optional(),
 });
-export const QuerySummarySchema = z.looseObject({
-    actions: QuerySummaryActionsSchema.optional(),
-    component: z.literal('QuerySummary'),
-    id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
-    state: QuerySummaryStateSchema.optional(),
+export const QuerySummaryStateSchema = z.strictObject({
+    correction: QueryCorrectionSchema.optional(),
+    firstIndex: z.number().int().min(0),
+    lastIndex: z.number().int().min(0),
+    query: z.string(),
+    totalEntries: z.number().int().min(0),
 });
 export const SetPageSizeSchema = z.strictObject({
     payload: SetPageSizePayloadSchema,
@@ -675,6 +673,12 @@ export const RestoreStatePayloadSchema = z.strictObject({
     query: z.string(),
     sortCriteria: z.string().optional(),
 });
+export const QuerySummarySchema = z.looseObject({
+    actions: QuerySummaryActionsSchema.optional(),
+    component: z.literal('QuerySummary'),
+    id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
+    state: QuerySummaryStateSchema.optional(),
+});
 export const PageSizeActionsSchema = z.strictObject({
     setPageSize: SetPageSizeSchema,
 });
@@ -776,7 +780,6 @@ export const CartSchema = z.looseObject({
     state: CartStateSchema.optional(),
 });
 export const CommerceSearchActionsSchema = z.strictObject({
-    overrideCorrection: OverrideCorrectionSchema,
     restoreState: RestoreStateSchema,
     submitQuery: SubmitQuerySchema,
 });
@@ -1010,6 +1013,9 @@ export const QuerySummaryPropsSchema = z.object({
     firstIndex: DynamicNumberSchema,
     lastIndex: DynamicNumberSchema,
     totalEntries: DynamicNumberSchema,
+    correction: z
+        .union([QuerySummaryStateSchema.shape['correction'], DataBindingSchema, FunctionCallSchema])
+        .optional(),
 });
 export const RegularFacetPropsSchema = z.object({
     field: DynamicStringSchema,
@@ -1111,12 +1117,6 @@ export const CommerceSearchActionSchema = z.union([
             }),
         }),
     }),
-    z.object({
-        event: z.object({
-            name: z.literal('overrideCorrection'),
-            context: z.strictObject({ originalQuery: z.string() }),
-        }),
-    }),
 ]);
 export const ComparisonTableActionSchema = z.never();
 export const DateFacetActionSchema = z.union([
@@ -1236,7 +1236,9 @@ export const QuerySuggestionsActionSchema = z.union([
         }),
     }),
 ]);
-export const QuerySummaryActionSchema = z.never();
+export const QuerySummaryActionSchema = z.union([
+    z.object({ event: z.object({ name: z.literal('overrideCorrection'), context: z.unknown() }) }),
+]);
 export const RegularFacetActionSchema = z.union([
     z.object({
         event: z.object({

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, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, InstantProductsSchema, InstantProductsActionsSchema, InstantProductsStateSchema, FetchInstantProductsSchema, FetchInstantProductsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, OverrideCorrectionSchema, OverrideCorrectionPayloadSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSearchStateSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, SearchBoxSchema, SearchBoxStateSchema, SessionShellSchema, SessionShellActionsSchema, SessionShellStateSchema, InitializeSchema, InitializePayloadSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductResearchCardSchema, ProductResearchCardActionsSchema, ProductResearchCardStateSchema, ProductResearchRelatedDocumentSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, BadgeSchema, BadgePlacementSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchPayloadSchema, RegularFacetSearchResultSchema, RegularFacetSearchStateSchema, RegularFacetStateSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, InstantProductsPropsSchema, LayoutStackPropsSchema, SearchBoxPropsSchema, SessionShellPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductResearchCardPropsSchema, ProductSummaryPropsSchema, QuerySuggestionsPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, BreadboxActionSchema, InstantProductsActionSchema, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';
-export type { ActionItem, FollowupActionItem, SearchActionItem, SearchOptionActionItem, Cart, CartActions, CartState, UpdateCart, UpdateCartPayload, CartUpdateOperation, Purchase, PurchasePayload, PurchaseProduct, Transaction, QuerySuggestions, QuerySuggestionsActions, QuerySuggestionsState, QueryCompletion, FetchSuggestions, FetchSuggestionsPayload, InstantProducts, InstantProductsActions, InstantProductsState, FetchInstantProducts, FetchInstantProductsPayload, RestoreState, RestoreStatePayload, FacetRestore, NumericRangeRestore, OverrideCorrection, OverrideCorrectionPayload, ShowMore, ShowMorePayload, SelectProducts, SelectProductsPayload, ProductClick, ProductClickPayload, BundleDisplay, BundleDisplayState, BundleSlot, BundleTier, CategoryFacet, CategoryFacetActions, CategoryFacetValue, CategoryFacetSearch, CategoryFacetSearchPayload, CategoryFacetSearchState, CategoryFacetSelectPathPayload, CategoryFacetState, CategoryFacetValues, CommerceSearch, CommerceSearchActions, CommerceSearchState, SubmitQuery, SubmitQueryPayload, ComparisonAttribute, ComparisonProduct, ComparisonTable, ComparisonTableState, ComponentContracts, DateFacet, DateFacetActions, DateFacetApplyCustomRangePayload, DateFacetCustomRange, DateFacetState, DateFacetToggleSelectPayload, DateFacetToggleSingleSelectPayload, DateFacetValue, FacetManager, FacetManagerActions, FacetManagerState, Breadbox, BreadboxActions, BreadboxState, BreadboxFacet, BreadboxRegularFacet, BreadboxRegularFacetValue, BreadboxNumericalRangeFacet, BreadboxNumericalRangeFacetValue, BreadboxDateRangeFacet, BreadboxDateRangeFacetValue, BreadboxHierarchicalFacet, BreadboxDeselectPayload, BreadboxDeselectRegularValue, BreadboxDeselectNumericalRange, BreadboxDeselectDateRange, BreadboxDeselectHierarchicalPath, FacetValueState, LayoutStack, LayoutStackState, SearchBox, SearchBoxState, SessionShell, SessionShellActions, SessionShellState, Initialize, InitializePayload, NextActionsBar, NextActionsState, NumericFacet, NumericFacetActions, NumericFacetCustomRange, NumericFacetDomain, NumericFacetApplyCustomRangePayload, NumericFacetState, NumericFacetToggleSelectPayload, NumericFacetToggleSingleSelectPayload, NumericFacetValue, PageSize, PageSizeActions, PageSizeState, Pagination, PaginationActions, PaginationState, Badge, BadgePlacement, Product, ProductCarousel, ProductCarouselState, ProductList, ProductListActions, ProductListState, ProductResearchCard, ProductResearchCardActions, ProductResearchCardState, ProductResearchRelatedDocument, ProductSummary, ProductSummaryActions, ProductSummaryState, QuerySummary, QuerySummaryState, RegularFacet, RegularFacetActions, RegularFacetSearch, RegularFacetSearchPayload, RegularFacetSearchResult, RegularFacetSearchState, RegularFacetState, RegularFacetToggleSelectPayload, RegularFacetToggleSingleSelectPayload, RegularFacetValue, SelectActionPayload, SelectSearchOptionPayload, SelectPagePayload, SelectSortPayload, SetPageSizePayload, Sort, SortActions, SortCriterion, SortState, DataBinding, FunctionCall, DynamicNumber, DynamicString, DynamicBoolean, DynamicStringList, DynamicValue, DynamicAction, BundleDisplayAction, CategoryFacetAction, CommerceSearchAction, ComparisonTableAction, DateFacetAction, FacetManagerAction, BreadboxAction, InstantProductsAction, LayoutStackAction, SearchBoxAction, SessionShellAction, NextActionsBarAction, NumericFacetAction, PageSizeAction, PaginationAction, ProductCarouselAction, ProductListAction, ProductResearchCardAction, ProductSummaryAction, QuerySummaryAction, RegularFacetAction, SortAction, BundleDisplayProps, CartProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, BreadboxProps, InstantProductsProps, LayoutStackProps, SearchBoxProps, SessionShellProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductResearchCardProps, ProductSummaryProps, QuerySuggestionsProps, QuerySummaryProps, RegularFacetProps, SortProps, } from './generated/schemas.js';
+export { ActionItemSchema, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, InstantProductsSchema, InstantProductsActionsSchema, InstantProductsStateSchema, FetchInstantProductsSchema, FetchInstantProductsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSearchStateSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, SearchBoxSchema, SearchBoxStateSchema, SessionShellSchema, SessionShellActionsSchema, SessionShellStateSchema, InitializeSchema, InitializePayloadSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductResearchCardSchema, ProductResearchCardActionsSchema, ProductResearchCardStateSchema, ProductResearchRelatedDocumentSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryActionsSchema, QuerySummaryStateSchema, QueryCorrectionSchema, QueryCorrectionCauseSchema, BadgeSchema, BadgePlacementSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchPayloadSchema, RegularFacetSearchResultSchema, RegularFacetSearchStateSchema, RegularFacetStateSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, InstantProductsPropsSchema, LayoutStackPropsSchema, SearchBoxPropsSchema, SessionShellPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductResearchCardPropsSchema, ProductSummaryPropsSchema, QuerySuggestionsPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, BreadboxActionSchema, InstantProductsActionSchema, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';
+export type { ActionItem, FollowupActionItem, SearchActionItem, SearchOptionActionItem, Cart, CartActions, CartState, UpdateCart, UpdateCartPayload, CartUpdateOperation, Purchase, PurchasePayload, PurchaseProduct, Transaction, QuerySuggestions, QuerySuggestionsActions, QuerySuggestionsState, QueryCompletion, FetchSuggestions, FetchSuggestionsPayload, InstantProducts, InstantProductsActions, InstantProductsState, FetchInstantProducts, FetchInstantProductsPayload, RestoreState, RestoreStatePayload, FacetRestore, NumericRangeRestore, ShowMore, ShowMorePayload, SelectProducts, SelectProductsPayload, ProductClick, ProductClickPayload, BundleDisplay, BundleDisplayState, BundleSlot, BundleTier, CategoryFacet, CategoryFacetActions, CategoryFacetValue, CategoryFacetSearch, CategoryFacetSearchPayload, CategoryFacetSearchState, CategoryFacetSelectPathPayload, CategoryFacetState, CategoryFacetValues, CommerceSearch, CommerceSearchActions, CommerceSearchState, SubmitQuery, SubmitQueryPayload, ComparisonAttribute, ComparisonProduct, ComparisonTable, ComparisonTableState, ComponentContracts, DateFacet, DateFacetActions, DateFacetApplyCustomRangePayload, DateFacetCustomRange, DateFacetState, DateFacetToggleSelectPayload, DateFacetToggleSingleSelectPayload, DateFacetValue, FacetManager, FacetManagerActions, FacetManagerState, Breadbox, BreadboxActions, BreadboxState, BreadboxFacet, BreadboxRegularFacet, BreadboxRegularFacetValue, BreadboxNumericalRangeFacet, BreadboxNumericalRangeFacetValue, BreadboxDateRangeFacet, BreadboxDateRangeFacetValue, BreadboxHierarchicalFacet, BreadboxDeselectPayload, BreadboxDeselectRegularValue, BreadboxDeselectNumericalRange, BreadboxDeselectDateRange, BreadboxDeselectHierarchicalPath, FacetValueState, LayoutStack, LayoutStackState, SearchBox, SearchBoxState, SessionShell, SessionShellActions, SessionShellState, Initialize, InitializePayload, NextActionsBar, NextActionsState, NumericFacet, NumericFacetActions, NumericFacetCustomRange, NumericFacetDomain, NumericFacetApplyCustomRangePayload, NumericFacetState, NumericFacetToggleSelectPayload, NumericFacetToggleSingleSelectPayload, NumericFacetValue, PageSize, PageSizeActions, PageSizeState, Pagination, PaginationActions, PaginationState, Badge, BadgePlacement, Product, ProductCarousel, ProductCarouselState, ProductList, ProductListActions, ProductListState, ProductResearchCard, ProductResearchCardActions, ProductResearchCardState, ProductResearchRelatedDocument, ProductSummary, ProductSummaryActions, ProductSummaryState, QuerySummary, QuerySummaryActions, QuerySummaryState, QueryCorrection, QueryCorrectionCause, RegularFacet, RegularFacetActions, RegularFacetSearch, RegularFacetSearchPayload, RegularFacetSearchResult, RegularFacetSearchState, RegularFacetState, RegularFacetToggleSelectPayload, RegularFacetToggleSingleSelectPayload, RegularFacetValue, SelectActionPayload, SelectSearchOptionPayload, SelectPagePayload, SelectSortPayload, SetPageSizePayload, Sort, SortActions, SortCriterion, SortState, DataBinding, FunctionCall, DynamicNumber, DynamicString, DynamicBoolean, DynamicStringList, DynamicValue, DynamicAction, BundleDisplayAction, CategoryFacetAction, CommerceSearchAction, ComparisonTableAction, DateFacetAction, FacetManagerAction, BreadboxAction, InstantProductsAction, LayoutStackAction, SearchBoxAction, SessionShellAction, NextActionsBarAction, NumericFacetAction, PageSizeAction, PaginationAction, ProductCarouselAction, ProductListAction, ProductResearchCardAction, ProductSummaryAction, QuerySummaryAction, RegularFacetAction, SortAction, BundleDisplayProps, CartProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, BreadboxProps, InstantProductsProps, LayoutStackProps, SearchBoxProps, SessionShellProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductResearchCardProps, ProductSummaryProps, QuerySuggestionsProps, 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, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, InstantProductsSchema, InstantProductsActionsSchema, InstantProductsStateSchema, FetchInstantProductsSchema, FetchInstantProductsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, OverrideCorrectionSchema, OverrideCorrectionPayloadSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSearchStateSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, SearchBoxSchema, SearchBoxStateSchema, SessionShellSchema, SessionShellActionsSchema, SessionShellStateSchema, InitializeSchema, InitializePayloadSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductResearchCardSchema, ProductResearchCardActionsSchema, ProductResearchCardStateSchema, ProductResearchRelatedDocumentSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryStateSchema, BadgeSchema, BadgePlacementSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchPayloadSchema, RegularFacetSearchResultSchema, RegularFacetSearchStateSchema, RegularFacetStateSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, InstantProductsPropsSchema, LayoutStackPropsSchema, SearchBoxPropsSchema, SessionShellPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductResearchCardPropsSchema, ProductSummaryPropsSchema, QuerySuggestionsPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, BreadboxActionSchema, InstantProductsActionSchema, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';
+export { ActionItemSchema, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, CartSchema, CartActionsSchema, CartStateSchema, UpdateCartSchema, UpdateCartPayloadSchema, CartUpdateOperationSchema, PurchaseSchema, PurchasePayloadSchema, PurchaseProductSchema, TransactionSchema, QuerySuggestionsSchema, QuerySuggestionsActionsSchema, QuerySuggestionsStateSchema, QueryCompletionSchema, FetchSuggestionsSchema, FetchSuggestionsPayloadSchema, InstantProductsSchema, InstantProductsActionsSchema, InstantProductsStateSchema, FetchInstantProductsSchema, FetchInstantProductsPayloadSchema, RestoreStateSchema, RestoreStatePayloadSchema, FacetRestoreSchema, NumericRangeRestoreSchema, ShowMoreSchema, ShowMorePayloadSchema, SelectProductsSchema, SelectProductsPayloadSchema, ProductClickSchema, ProductClickPayloadSchema, BundleDisplaySchema, BundleDisplayStateSchema, BundleSlotSchema, BundleTierSchema, CategoryFacetSchema, CategoryFacetActionsSchema, CategoryFacetValueSchema, CategoryFacetSearchSchema, CategoryFacetSearchPayloadSchema, CategoryFacetSearchStateSchema, CategoryFacetSelectPathPayloadSchema, CategoryFacetStateSchema, CategoryFacetValuesSchema, CommerceSearchSchema, CommerceSearchActionsSchema, CommerceSearchStateSchema, SubmitQuerySchema, SubmitQueryPayloadSchema, ComparisonAttributeSchema, ComparisonProductSchema, ComparisonTableSchema, ComparisonTableStateSchema, ComponentContractsSchema, DateFacetSchema, DateFacetActionsSchema, DateFacetApplyCustomRangePayloadSchema, DateFacetCustomRangeSchema, DateFacetStateSchema, DateFacetToggleSelectPayloadSchema, DateFacetToggleSingleSelectPayloadSchema, DateFacetValueSchema, FacetManagerSchema, FacetManagerActionsSchema, FacetManagerStateSchema, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, LayoutStackSchema, LayoutStackStateSchema, SearchBoxSchema, SearchBoxStateSchema, SessionShellSchema, SessionShellActionsSchema, SessionShellStateSchema, InitializeSchema, InitializePayloadSchema, NextActionsBarSchema, NextActionsStateSchema, NumericFacetSchema, NumericFacetActionsSchema, NumericFacetCustomRangeSchema, NumericFacetDomainSchema, NumericFacetApplyCustomRangePayloadSchema, NumericFacetStateSchema, NumericFacetToggleSelectPayloadSchema, NumericFacetToggleSingleSelectPayloadSchema, NumericFacetValueSchema, PageSizeSchema, PageSizeActionsSchema, PageSizeStateSchema, PaginationSchema, PaginationActionsSchema, PaginationStateSchema, ProductCarouselSchema, ProductCarouselStateSchema, ProductListSchema, ProductListActionsSchema, ProductListStateSchema, ProductResearchCardSchema, ProductResearchCardActionsSchema, ProductResearchCardStateSchema, ProductResearchRelatedDocumentSchema, ProductSummarySchema, ProductSummaryActionsSchema, ProductSummaryStateSchema, QuerySummarySchema, QuerySummaryActionsSchema, QuerySummaryStateSchema, QueryCorrectionSchema, QueryCorrectionCauseSchema, BadgeSchema, BadgePlacementSchema, ProductSchema, RegularFacetSchema, RegularFacetActionsSchema, RegularFacetSearchSchema, RegularFacetSearchPayloadSchema, RegularFacetSearchResultSchema, RegularFacetSearchStateSchema, RegularFacetStateSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, InstantProductsPropsSchema, LayoutStackPropsSchema, SearchBoxPropsSchema, SessionShellPropsSchema, NextActionsBarPropsSchema, NumericFacetPropsSchema, PageSizePropsSchema, PaginationPropsSchema, ProductCarouselPropsSchema, ProductListPropsSchema, ProductResearchCardPropsSchema, ProductSummaryPropsSchema, QuerySuggestionsPropsSchema, QuerySummaryPropsSchema, RegularFacetPropsSchema, SortPropsSchema, DataBindingSchema, FunctionCallSchema, DynamicNumberSchema, DynamicStringSchema, DynamicBooleanSchema, DynamicStringListSchema, DynamicValueSchema, DynamicActionSchema, BundleDisplayActionSchema, CategoryFacetActionSchema, CommerceSearchActionSchema, ComparisonTableActionSchema, DateFacetActionSchema, FacetManagerActionSchema, BreadboxActionSchema, InstantProductsActionSchema, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.39",
+  "version": "1.0.0-beta.40",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
   "bugs": {

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 component discriminant carries the surface intent; it owns the surface's top-level components via named child slots and dispatches search lifecycle actions (submitQuery, restoreState, overrideCorrection).",
+  "description": "Surface-root component for a commerce search surface. Its component discriminant carries the surface intent; it owns the surface's top-level components via named child slots and dispatches search lifecycle actions (submitQuery, restoreState).",
   "allOf": [
     {
       "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
@@ -30,16 +30,13 @@
     },
     "actions": {
       "type": "object",
-      "required": ["submitQuery", "restoreState", "overrideCorrection"],
+      "required": ["submitQuery", "restoreState"],
       "properties": {
         "submitQuery": {
           "$ref": "#/$defs/SubmitQueryAction"
         },
         "restoreState": {
           "$ref": "#/$defs/RestoreStateAction"
-        },
-        "overrideCorrection": {
-          "$ref": "#/$defs/OverrideCorrectionAction"
         }
       },
       "additionalProperties": false
@@ -119,28 +116,6 @@
         }
       }
     },
-    "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",

package/schema/components/query-summary.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/components/query-summary.schema.json",
   "title": "QuerySummary",
-  "description": "Summarizes the current result window for a search surface (e.g. 'Products 1-12 of 43 for Water Sports'). Read-only from the frontend.",
+  "description": "Summarizes the current result window for a search surface (e.g. 'Products 1-12 of 43 for Water Sports'), says when the backend replaced the shopper's query, and dispatches the action that searches the shopper's query instead when the backend allows it.",
   "$comment": "Carries its own backend-computed aggregate instead of reading sibling state (search box, pagination, product-list), so it has no cross-component coupling.",
   "allOf": [
     {
@@ -33,12 +33,21 @@
       "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
       "description": "The total number of results, bound to /state/<id>/totalEntries."
     },
+    "correction": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The replacement of the shopper's query, bound to /state/<id>/correction."
+    },
     "state": {
       "$ref": "#/$defs/QuerySummaryState"
     },
     "actions": {
       "type": "object",
-      "properties": {},
+      "required": ["overrideCorrection"],
+      "properties": {
+        "overrideCorrection": {
+          "$ref": "#/$defs/OverrideCorrectionAction"
+        }
+      },
       "additionalProperties": false
     }
   },
@@ -52,7 +61,7 @@
       "properties": {
         "query": {
           "type": "string",
-          "description": "The current query string. May be empty when the surface has no active query."
+          "description": "The query whose results are shown. May be empty when the surface has no active query."
         },
         "firstIndex": {
           "type": "integer",
@@ -68,9 +77,45 @@
           "type": "integer",
           "minimum": 0,
           "description": "The total number of results across all pages."
+        },
+        "correction": {
+          "$ref": "#/$defs/QueryCorrection"
+        }
+      },
+      "additionalProperties": false
+    },
+    "QueryCorrection": {
+      "title": "QueryCorrection",
+      "description": "Says that the backend searched another query than the shopper's. Absent when the shopper's query was searched as typed.",
+      "type": "object",
+      "required": ["originalQuery", "cause", "canOverride"],
+      "properties": {
+        "originalQuery": {
+          "type": "string",
+          "minLength": 1,
+          "description": "The query the shopper submitted."
+        },
+        "cause": {
+          "title": "QueryCorrectionCause",
+          "type": "string",
+          "enum": ["correction", "trigger"],
+          "description": "What replaced the shopper's query: an automatic query correction, or a query trigger."
+        },
+        "canOverride": {
+          "type": "boolean",
+          "description": "Whether overrideCorrection can search the original query instead. False when searching it would replace it again, as for an automatic correction the search service applies on every search."
         }
       },
       "additionalProperties": false
+    },
+    "OverrideCorrectionAction": {
+      "title": "overrideCorrection",
+      "description": "Searches the shopper's original query instead of the query that replaced it, for this search only: a later query can be replaced again. The backend reads the original query from its state and applies the action only when the correction's canOverride is true.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ]
     }
   }
 }