@coveo/thermidor-schema 1.0.0-beta.34 → 1.0.0-beta.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3,8 +3,6 @@
3
3
  // The Zod 3 dialect of this file. Generated from the same canonical JSON Schema
4
4
  // documents as ../schemas.ts; see ../../zod3-compat.ts.
5
5
  import * as z from '../../zod3-compat.js';
6
- // Whether the value is selected or excluded.
7
- export const BreadboxRegularFacetValueStateSchema = z.enum(['excluded', 'selected']);
8
6
  export const CartUpdateOperationSchema = z.enum(['add', 'remove', 'setQuantity']);
9
7
  // The kind of action selected: "followup" or "search".
10
8
  export const SelectActionPayloadTypeSchema = z.enum(['followup', 'search']);
@@ -12,12 +10,7 @@ export const ActionItemTypeSchema = z.enum(['followup', 'search', 'searchOption'
12
10
  // The selection state of a facet value, shared across all commerce facet components.
13
11
  //
14
12
  // The selection state of this facet value.
15
- export const FacetValueStateSchema = z.enum(['excluded', 'idle', 'selected']);
16
- // The selection state of a facet value that supports selection but not exclusion (e.g.
17
- // numeric and date facets). Constrained to 'idle' or 'selected'.
18
- //
19
- // The selection state of this facet value (idle or selected; exclusion is not supported).
20
- export const SelectableFacetValueStateSchema = z.enum(['idle', 'selected']);
13
+ export const FacetValueStateSchema = z.enum(['idle', 'selected']);
21
14
  export const BreadboxFacetTypeSchema = z.enum([
22
15
  'dateRange',
23
16
  'hierarchical',
@@ -70,7 +63,7 @@ export const ChildListClassSchema = z.strictObject({
70
63
  path: z.string(),
71
64
  });
72
65
  export const BreadboxRegularFacetValueSchema = z.strictObject({
73
- state: z.enum(['selected', 'excluded']),
66
+ state: z.literal('selected'),
74
67
  value: z.string().min(1),
75
68
  });
76
69
  export const BreadboxNumericalRangeFacetValueSchema = z.strictObject({
@@ -148,6 +141,13 @@ export const QueryCompletionSchema = z.strictObject({
148
141
  expression: z.string(),
149
142
  score: z.number().optional(),
150
143
  });
144
+ export const FetchInstantProductsPayloadSchema = z.strictObject({
145
+ query: z.string(),
146
+ });
147
+ export const InstantProductsStateSchema = z.strictObject({
148
+ products: z.array(ProductSchema),
149
+ query: z.string(),
150
+ });
151
151
  export const SelectActionPayloadSchema = z.strictObject({
152
152
  text: z.string(),
153
153
  type: z.enum(['followup', 'search']),
@@ -231,15 +231,9 @@ export const ActionSchema = z.strictObject({
231
231
  export const SearchPayloadSchema = z.strictObject({
232
232
  query: z.string(),
233
233
  });
234
- export const RegularFacetToggleExcludePayloadSchema = z.strictObject({
235
- value: z.string().min(1),
236
- });
237
234
  export const RegularFacetToggleSelectPayloadSchema = z.strictObject({
238
235
  value: z.string().min(1),
239
236
  });
240
- export const RegularFacetToggleSingleExcludePayloadSchema = z.strictObject({
241
- value: z.string().min(1),
242
- });
243
237
  export const RegularFacetToggleSingleSelectPayloadSchema = z.strictObject({
244
238
  value: z.string().min(1),
245
239
  });
@@ -249,7 +243,7 @@ export const RegularFacetSearchResultSchema = z.strictObject({
249
243
  });
250
244
  export const RegularFacetValueSchema = z.strictObject({
251
245
  numberOfResults: z.number().int().min(0),
252
- state: z.enum(['idle', 'selected', 'excluded']),
246
+ state: z.enum(['idle', 'selected']),
253
247
  value: z.string().min(1),
254
248
  });
255
249
  export const NumericFacetApplyCustomRangePayloadSchema = z.strictObject({
@@ -327,7 +321,7 @@ export const BreadboxDeselectPayloadSchema = z.discriminatedUnion('type', [
327
321
  BreadboxDeselectHierarchicalPathSchema,
328
322
  ]);
329
323
  export const BreadboxFacetValueSchema = z.strictObject({
330
- state: z.enum(['selected', 'excluded']).optional(),
324
+ state: z.literal('selected').optional(),
331
325
  value: z.string().min(1).optional(),
332
326
  end: z.union([z.number(), z.string()]).optional(),
333
327
  start: z.union([z.number(), z.string()]).optional(),
@@ -412,6 +406,9 @@ export const QuerySuggestionsStateSchema = z.strictObject({
412
406
  completions: z.array(QueryCompletionSchema),
413
407
  query: z.string(),
414
408
  });
409
+ export const FetchInstantProductsSchema = z.strictObject({
410
+ payload: FetchInstantProductsPayloadSchema,
411
+ });
415
412
  export const SelectActionSchema = z.strictObject({
416
413
  payload: SelectActionPayloadSchema,
417
414
  });
@@ -470,15 +467,9 @@ export const SortStateSchema = z.strictObject({
470
467
  export const SearchSchema = z.strictObject({
471
468
  payload: SearchPayloadSchema,
472
469
  });
473
- export const RegularFacetToggleExcludeSchema = z.strictObject({
474
- payload: RegularFacetToggleExcludePayloadSchema,
475
- });
476
470
  export const RegularFacetToggleSelectSchema = z.strictObject({
477
471
  payload: RegularFacetToggleSelectPayloadSchema,
478
472
  });
479
- export const RegularFacetToggleSingleExcludeSchema = z.strictObject({
480
- payload: RegularFacetToggleSingleExcludePayloadSchema,
481
- });
482
473
  export const RegularFacetToggleSingleSelectSchema = z.strictObject({
483
474
  payload: RegularFacetToggleSingleSelectPayloadSchema,
484
475
  });
@@ -586,6 +577,9 @@ export const PurchaseSchema = z.strictObject({
586
577
  export const QuerySuggestionsActionsSchema = z.strictObject({
587
578
  fetchSuggestions: FetchSuggestionsSchema,
588
579
  });
580
+ export const InstantProductsActionsSchema = z.strictObject({
581
+ fetchInstantProducts: FetchInstantProductsSchema,
582
+ });
589
583
  export const NextActionsBarActionsSchema = z.strictObject({
590
584
  selectAction: SelectActionSchema,
591
585
  selectSearchOption: SelectSearchOptionSchema,
@@ -625,9 +619,7 @@ export const RegularFacetActionsSchema = z.strictObject({
625
619
  showLessValues: ActionSchema,
626
620
  showMoreSearchResults: ActionSchema,
627
621
  showMoreValues: ActionSchema,
628
- toggleExclude: RegularFacetToggleExcludeSchema,
629
622
  toggleSelect: RegularFacetToggleSelectSchema,
630
- toggleSingleExclude: RegularFacetToggleSingleExcludeSchema,
631
623
  toggleSingleSelect: RegularFacetToggleSingleSelectSchema,
632
624
  });
633
625
  export const RegularFacetStateSchema = z.strictObject({
@@ -703,6 +695,12 @@ export const QuerySuggestionsSchema = z.looseObject({
703
695
  id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
704
696
  state: QuerySuggestionsStateSchema.optional(),
705
697
  });
698
+ export const InstantProductsSchema = z.looseObject({
699
+ actions: InstantProductsActionsSchema.optional(),
700
+ component: z.literal('InstantProducts'),
701
+ id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
702
+ state: InstantProductsStateSchema.optional(),
703
+ });
706
704
  export const NextActionsBarSchema = z.looseObject({
707
705
  actions: NextActionsBarActionsSchema.optional(),
708
706
  component: z.literal('NextActionsBar'),
@@ -800,6 +798,7 @@ export const ComponentContractsSchema = z.discriminatedUnion('component', [
800
798
  CartSchema,
801
799
  SearchBoxSchema,
802
800
  QuerySuggestionsSchema,
801
+ InstantProductsSchema,
803
802
  NextActionsBarSchema,
804
803
  BundleDisplaySchema,
805
804
  ProductResearchCardSchema,
@@ -922,6 +921,14 @@ export const DateFacetPropsSchema = z.object({
922
921
  export const FacetManagerPropsSchema = z.object({
923
922
  children: z.array(z.string()).optional(),
924
923
  });
924
+ export const InstantProductsPropsSchema = z.object({
925
+ query: DynamicStringSchema,
926
+ products: z.union([
927
+ InstantProductsStateSchema.shape['products'],
928
+ DataBindingSchema,
929
+ FunctionCallSchema,
930
+ ]),
931
+ });
925
932
  export const LayoutStackPropsSchema = z.object({
926
933
  direction: z.string().optional(),
927
934
  children: z.array(z.string()).optional(),
@@ -1026,6 +1033,7 @@ export const RegularFacetPropsSchema = z.object({
1026
1033
  });
1027
1034
  export const SearchBoxPropsSchema = z.object({
1028
1035
  suggestionsChild: z.string().optional(),
1036
+ instantProductsChild: z.string().optional(),
1029
1037
  });
1030
1038
  export const SessionShellPropsSchema = z.object({
1031
1039
  children: z.array(z.string()).optional(),
@@ -1142,6 +1150,14 @@ export const DateFacetActionSchema = z.union([
1142
1150
  z.object({ event: z.object({ name: z.literal('showLessValues'), context: z.unknown() }) }),
1143
1151
  ]);
1144
1152
  export const FacetManagerActionSchema = z.never();
1153
+ export const InstantProductsActionSchema = z.union([
1154
+ z.object({
1155
+ event: z.object({
1156
+ name: z.literal('fetchInstantProducts'),
1157
+ context: z.strictObject({ query: z.string() }),
1158
+ }),
1159
+ }),
1160
+ ]);
1145
1161
  export const LayoutStackActionSchema = z.never();
1146
1162
  export const NextActionsBarActionSchema = z.union([
1147
1163
  z.object({
@@ -1241,24 +1257,12 @@ export const RegularFacetActionSchema = z.union([
1241
1257
  context: z.strictObject({ value: z.string() }),
1242
1258
  }),
1243
1259
  }),
1244
- z.object({
1245
- event: z.object({
1246
- name: z.literal('toggleExclude'),
1247
- context: z.strictObject({ value: z.string() }),
1248
- }),
1249
- }),
1250
1260
  z.object({
1251
1261
  event: z.object({
1252
1262
  name: z.literal('toggleSingleSelect'),
1253
1263
  context: z.strictObject({ value: z.string() }),
1254
1264
  }),
1255
1265
  }),
1256
- z.object({
1257
- event: z.object({
1258
- name: z.literal('toggleSingleExclude'),
1259
- context: z.strictObject({ value: z.string() }),
1260
- }),
1261
- }),
1262
1266
  z.object({ event: z.object({ name: z.literal('clearAllActiveValues'), context: z.unknown() }) }),
1263
1267
  z.object({
1264
1268
  event: z.object({ name: z.literal('search'), context: z.strictObject({ query: z.string() }) }),
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
1
  export declare const THERMIDOR_CATALOG_ID = "https://schema.thermidor.coveo.com/a2-ui/catalog.json";
2
- export { ActionItemSchema, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, 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, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, 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, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, 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, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';
3
- export type { ActionItem, FollowupActionItem, SearchActionItem, SearchOptionActionItem, 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, Breadbox, BreadboxActions, BreadboxState, BreadboxFacet, BreadboxRegularFacet, BreadboxRegularFacetValue, BreadboxNumericalRangeFacet, BreadboxNumericalRangeFacetValue, BreadboxDateRangeFacet, BreadboxDateRangeFacetValue, BreadboxHierarchicalFacet, BreadboxDeselectPayload, BreadboxDeselectRegularValue, BreadboxDeselectNumericalRange, BreadboxDeselectDateRange, BreadboxDeselectHierarchicalPath, FacetValueState, SelectableFacetValueState, 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, RegularFacetSearchResult, RegularFacetState, RegularFacetToggleExcludePayload, RegularFacetToggleSelectPayload, RegularFacetToggleSingleExcludePayload, 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, LayoutStackAction, SearchBoxAction, SessionShellAction, NextActionsBarAction, NumericFacetAction, PageSizeAction, PaginationAction, ProductCarouselAction, ProductListAction, ProductResearchCardAction, ProductSummaryAction, QuerySummaryAction, RegularFacetAction, SortAction, BundleDisplayProps, CartProps, CategoryFacetProps, CommerceSearchProps, ComparisonTableProps, DateFacetProps, FacetManagerProps, BreadboxProps, LayoutStackProps, SearchBoxProps, SessionShellProps, NextActionsBarProps, NumericFacetProps, PageSizeProps, PaginationProps, ProductCarouselProps, ProductListProps, ProductResearchCardProps, ProductSummaryProps, QuerySuggestionsProps, QuerySummaryProps, RegularFacetProps, SortProps, } from './generated/schemas.js';
2
+ 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, 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, RegularFacetSearchResultSchema, 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';
3
+ 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, 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, RegularFacetSearchResult, 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 CHANGED
@@ -1,2 +1,2 @@
1
1
  export const THERMIDOR_CATALOG_ID = 'https://schema.thermidor.coveo.com/a2-ui/catalog.json';
2
- export { ActionItemSchema, FollowupActionItemSchema, SearchActionItemSchema, SearchOptionActionItemSchema, 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, BreadboxSchema, BreadboxActionsSchema, BreadboxStateSchema, BreadboxFacetSchema, BreadboxRegularFacetSchema, BreadboxRegularFacetValueSchema, BreadboxNumericalRangeFacetSchema, BreadboxNumericalRangeFacetValueSchema, BreadboxDateRangeFacetSchema, BreadboxDateRangeFacetValueSchema, BreadboxHierarchicalFacetSchema, BreadboxDeselectPayloadSchema, BreadboxDeselectRegularValueSchema, BreadboxDeselectNumericalRangeSchema, BreadboxDeselectDateRangeSchema, BreadboxDeselectHierarchicalPathSchema, FacetValueStateSchema, SelectableFacetValueStateSchema, 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, RegularFacetSearchResultSchema, RegularFacetStateSchema, RegularFacetToggleExcludePayloadSchema, RegularFacetToggleSelectPayloadSchema, RegularFacetToggleSingleExcludePayloadSchema, RegularFacetToggleSingleSelectPayloadSchema, RegularFacetValueSchema, SelectActionPayloadSchema, SelectSearchOptionPayloadSchema, SelectPagePayloadSchema, SelectSortPayloadSchema, SetPageSizePayloadSchema, SortSchema, SortActionsSchema, SortCriterionSchema, SortStateSchema, BundleDisplayPropsSchema, CartPropsSchema, CategoryFacetPropsSchema, CommerceSearchPropsSchema, ComparisonTablePropsSchema, DateFacetPropsSchema, FacetManagerPropsSchema, BreadboxPropsSchema, 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, LayoutStackActionSchema, SearchBoxActionSchema, SessionShellActionSchema, NextActionsBarActionSchema, NumericFacetActionSchema, PageSizeActionSchema, PaginationActionSchema, ProductCarouselActionSchema, ProductListActionSchema, ProductResearchCardActionSchema, ProductSummaryActionSchema, QuerySummaryActionSchema, RegularFacetActionSchema, SortActionSchema, } from './generated/schemas.js';
2
+ 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, 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, RegularFacetSearchResultSchema, 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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@coveo/thermidor-schema",
3
- "version": "1.0.0-beta.34",
3
+ "version": "1.0.0-beta.38",
4
4
  "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
5
5
  "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
6
6
  "bugs": {
@@ -36,10 +36,10 @@
36
36
  "access": "public"
37
37
  },
38
38
  "devDependencies": {
39
- "@types/node": "24.13.6",
39
+ "@types/node": "24.19.2",
40
40
  "fast-check": "4.10.2",
41
41
  "typescript": "7.0.2",
42
- "vitest": "4.1.11",
42
+ "vitest": "4.1.12",
43
43
  "zod": "4.6.7"
44
44
  },
45
45
  "peerDependencies": {
@@ -19,6 +19,9 @@
19
19
  {
20
20
  "$ref": "https://schema.thermidor.coveo.com/components/query-suggestions.schema.json"
21
21
  },
22
+ {
23
+ "$ref": "https://schema.thermidor.coveo.com/components/instant-products.schema.json"
24
+ },
22
25
  {
23
26
  "$ref": "https://schema.thermidor.coveo.com/components/next-actions-bar.schema.json"
24
27
  },
@@ -57,7 +57,7 @@
57
57
  },
58
58
  "BreadboxDeselectAction": {
59
59
  "title": "breadboxDeselect",
60
- "description": "Removes one active value from a facet. Deselecting an excluded regular value removes the exclusion; deselecting a category value clears its whole path.",
60
+ "description": "Removes one active value from a facet. Deselecting a category value clears its whole path.",
61
61
  "allOf": [
62
62
  {
63
63
  "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
@@ -157,8 +157,8 @@
157
157
  "description": "The number of results matching this range."
158
158
  },
159
159
  "state": {
160
- "$ref": "https://schema.thermidor.coveo.com/definitions/selectable-facet-value-state.schema.json",
161
- "description": "The selection state of this facet value (idle or selected; exclusion is not supported)."
160
+ "$ref": "https://schema.thermidor.coveo.com/definitions/facet-value-state.schema.json",
161
+ "description": "The selection state of this facet value."
162
162
  }
163
163
  },
164
164
  "additionalProperties": false
@@ -0,0 +1,85 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/components/instant-products.schema.json",
4
+ "title": "InstantProducts",
5
+ "description": "Requests and renders the products for the query highlighted in the search box. The renderer owns the highlight, and shows the products only while their query equals the highlighted query.",
6
+ "allOf": [
7
+ {
8
+ "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
9
+ }
10
+ ],
11
+ "properties": {
12
+ "id": {
13
+ "type": "string"
14
+ },
15
+ "component": {
16
+ "type": "string",
17
+ "const": "InstantProducts"
18
+ },
19
+ "query": {
20
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
21
+ "description": "The highlighted query these products were requested for, bound to /state/<id>/query."
22
+ },
23
+ "products": {
24
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
25
+ "description": "The products for the query, bound to /state/<id>/products."
26
+ },
27
+ "state": {
28
+ "$ref": "#/$defs/InstantProductsState"
29
+ },
30
+ "actions": {
31
+ "type": "object",
32
+ "required": ["fetchInstantProducts"],
33
+ "properties": {
34
+ "fetchInstantProducts": {
35
+ "$ref": "#/$defs/FetchInstantProductsAction"
36
+ }
37
+ },
38
+ "additionalProperties": false
39
+ }
40
+ },
41
+ "additionalProperties": false,
42
+ "$defs": {
43
+ "InstantProductsState": {
44
+ "title": "InstantProductsState",
45
+ "description": "The products for one query. Owned exclusively by the backend, which writes the whole state on every answer.",
46
+ "type": "object",
47
+ "required": ["query", "products"],
48
+ "properties": {
49
+ "query": {
50
+ "type": "string",
51
+ "description": "The highlighted query for which these products were requested."
52
+ },
53
+ "products": {
54
+ "type": "array",
55
+ "description": "Products returned by the commerce service for the query.",
56
+ "items": {
57
+ "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
58
+ }
59
+ }
60
+ },
61
+ "additionalProperties": false
62
+ },
63
+ "FetchInstantProductsAction": {
64
+ "title": "fetchInstantProducts",
65
+ "description": "Fetches the products for the highlighted query.",
66
+ "allOf": [
67
+ {
68
+ "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
69
+ }
70
+ ],
71
+ "properties": {
72
+ "payload": {
73
+ "type": "object",
74
+ "required": ["query"],
75
+ "properties": {
76
+ "query": {
77
+ "type": "string"
78
+ }
79
+ },
80
+ "additionalProperties": false
81
+ }
82
+ }
83
+ }
84
+ }
85
+ }
@@ -165,8 +165,8 @@
165
165
  "description": "The number of results matching this range."
166
166
  },
167
167
  "state": {
168
- "$ref": "https://schema.thermidor.coveo.com/definitions/selectable-facet-value-state.schema.json",
169
- "description": "The selection state of this facet value (idle or selected; exclusion is not supported)."
168
+ "$ref": "https://schema.thermidor.coveo.com/definitions/facet-value-state.schema.json",
169
+ "description": "The selection state of this facet value."
170
170
  }
171
171
  },
172
172
  "additionalProperties": false
@@ -51,9 +51,7 @@
51
51
  "type": "object",
52
52
  "required": [
53
53
  "toggleSelect",
54
- "toggleExclude",
55
54
  "toggleSingleSelect",
56
- "toggleSingleExclude",
57
55
  "clearAllActiveValues",
58
56
  "search",
59
57
  "showMoreSearchResults",
@@ -65,15 +63,9 @@
65
63
  "toggleSelect": {
66
64
  "$ref": "#/$defs/RegularFacetToggleSelectAction"
67
65
  },
68
- "toggleExclude": {
69
- "$ref": "#/$defs/RegularFacetToggleExcludeAction"
70
- },
71
66
  "toggleSingleSelect": {
72
67
  "$ref": "#/$defs/RegularFacetToggleSingleSelectAction"
73
68
  },
74
- "toggleSingleExclude": {
75
- "$ref": "#/$defs/RegularFacetToggleSingleExcludeAction"
76
- },
77
69
  "clearAllActiveValues": {
78
70
  "$ref": "#/$defs/RegularFacetClearAllActiveValuesAction"
79
71
  },
@@ -130,7 +122,7 @@
130
122
  },
131
123
  "hasActiveValues": {
132
124
  "type": "boolean",
133
- "description": "Whether at least one facet value is not in the idle state (i.e. selected or excluded)."
125
+ "description": "Whether at least one facet value is selected."
134
126
  },
135
127
  "canShowMoreValues": {
136
128
  "type": "boolean",
@@ -203,7 +195,7 @@
203
195
  "value": {
204
196
  "type": "string",
205
197
  "minLength": 1,
206
- "description": "The raw facet value. Pass this to toggleSelect/toggleExclude to act on it."
198
+ "description": "The raw facet value. Pass this to toggleSelect to act on it."
207
199
  },
208
200
  "numberOfResults": {
209
201
  "type": "integer",
@@ -236,29 +228,6 @@
236
228
  }
237
229
  }
238
230
  },
239
- "RegularFacetToggleExcludeAction": {
240
- "title": "regularFacetToggleExclude",
241
- "description": "Toggles the excluded state of a facet value.",
242
- "allOf": [
243
- {
244
- "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
245
- }
246
- ],
247
- "properties": {
248
- "payload": {
249
- "type": "object",
250
- "required": ["value"],
251
- "properties": {
252
- "value": {
253
- "type": "string",
254
- "minLength": 1,
255
- "description": "The raw facet value to toggle exclusion for."
256
- }
257
- },
258
- "additionalProperties": false
259
- }
260
- }
261
- },
262
231
  "RegularFacetToggleSingleSelectAction": {
263
232
  "title": "regularFacetToggleSingleSelect",
264
233
  "description": "Toggles the selected state of a facet value, deselecting all other values (single-select behavior).",
@@ -282,32 +251,9 @@
282
251
  }
283
252
  }
284
253
  },
285
- "RegularFacetToggleSingleExcludeAction": {
286
- "title": "regularFacetToggleSingleExclude",
287
- "description": "Toggles the excluded state of a facet value, clearing all other selections/exclusions (single-exclude behavior).",
288
- "allOf": [
289
- {
290
- "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
291
- }
292
- ],
293
- "properties": {
294
- "payload": {
295
- "type": "object",
296
- "required": ["value"],
297
- "properties": {
298
- "value": {
299
- "type": "string",
300
- "minLength": 1,
301
- "description": "The raw facet value to single-exclude."
302
- }
303
- },
304
- "additionalProperties": false
305
- }
306
- }
307
- },
308
254
  "RegularFacetClearAllActiveValuesAction": {
309
255
  "title": "regularFacetClearAllActiveValues",
310
- "description": "Resets all facet values to the idle state, clearing every selection and exclusion.",
256
+ "description": "Resets all facet values to the idle state, clearing every selection.",
311
257
  "allOf": [
312
258
  {
313
259
  "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
@@ -2,7 +2,7 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.thermidor.coveo.com/components/search-box.schema.json",
4
4
  "title": "SearchBox",
5
- "description": "Draws the search input. What is typed stays on the renderer side, which passes it to the search box's children; what submitting does is the application's.",
5
+ "description": "Draws the search input. What is typed and which suggestion is highlighted stay on the renderer side, which passes them to the search box's children; what submitting does is the application's.",
6
6
  "allOf": [
7
7
  {
8
8
  "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
@@ -20,6 +20,10 @@
20
20
  "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
21
21
  "description": "The suggestions named slot: a static ComponentId of the QuerySuggestions node that draws the completions, mounted by name via children(suggestionsChild)."
22
22
  },
23
+ "instantProductsChild": {
24
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
25
+ "description": "The instant products named slot: a static ComponentId of the InstantProducts node that draws the products for the highlighted query, mounted by name via children(instantProductsChild)."
26
+ },
23
27
  "state": {
24
28
  "$ref": "#/$defs/SearchBoxState"
25
29
  },
@@ -33,7 +37,7 @@
33
37
  "$defs": {
34
38
  "SearchBoxState": {
35
39
  "title": "SearchBoxState",
36
- "description": "Empty: what is typed stays on the renderer side.",
40
+ "description": "Empty: what is typed and the highlight stay on the renderer side.",
37
41
  "type": "object",
38
42
  "required": [],
39
43
  "properties": {},
@@ -2,7 +2,7 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-regular-value.schema.json",
4
4
  "title": "BreadboxDeselectRegularValue",
5
- "description": "Removes a regular facet value: a selected value is deselected, and an excluded value has its exclusion removed.",
5
+ "description": "Deselects a regular facet value.",
6
6
  "type": "object",
7
7
  "required": ["facetId", "type", "value"],
8
8
  "properties": {
@@ -2,7 +2,7 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-regular-facet.schema.json",
4
4
  "title": "BreadboxRegularFacet",
5
- "description": "A Breadbox entry for a regular facet: its selected and excluded values.",
5
+ "description": "A Breadbox entry for a regular facet: its selected values.",
6
6
  "type": "object",
7
7
  "required": ["facetId", "field", "displayName", "type", "values"],
8
8
  "properties": {
@@ -49,8 +49,8 @@
49
49
  "state": {
50
50
  "title": "BreadboxRegularFacetValueState",
51
51
  "type": "string",
52
- "enum": ["selected", "excluded"],
53
- "description": "Whether the value is selected or excluded."
52
+ "enum": ["selected"],
53
+ "description": "The state of the value, which is always selected."
54
54
  }
55
55
  },
56
56
  "additionalProperties": false
@@ -4,5 +4,5 @@
4
4
  "title": "FacetValueState",
5
5
  "description": "The selection state of a facet value, shared across all commerce facet components.",
6
6
  "type": "string",
7
- "enum": ["idle", "selected", "excluded"]
7
+ "enum": ["idle", "selected"]
8
8
  }
@@ -1,8 +0,0 @@
1
- {
2
- "$schema": "https://json-schema.org/draft/2020-12/schema",
3
- "$id": "https://schema.thermidor.coveo.com/definitions/selectable-facet-value-state.schema.json",
4
- "title": "SelectableFacetValueState",
5
- "description": "The selection state of a facet value that supports selection but not exclusion (e.g. numeric and date facets). Constrained to 'idle' or 'selected'.",
6
- "type": "string",
7
- "enum": ["idle", "selected"]
8
- }