@coveo/thermidor-schema 1.0.0-beta.37 → 1.0.0-beta.39
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.
- package/dist/generated/schemas.d.ts +20 -156
- package/dist/generated/schemas.js +15 -61
- package/dist/generated/zod3/index.d.ts +2 -2
- package/dist/generated/zod3/index.js +1 -1
- package/dist/generated/zod3/schemas.d.ts +155 -909
- package/dist/generated/zod3/schemas.js +15 -61
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/schema/components/breadbox.schema.json +1 -1
- package/schema/components/category-facet.schema.json +1 -1
- package/schema/components/date-facet.schema.json +2 -2
- package/schema/components/layout-stack.schema.json +1 -0
- package/schema/components/numeric-facet.schema.json +2 -2
- package/schema/components/pagination.schema.json +1 -27
- package/schema/components/regular-facet.schema.json +7 -61
- package/schema/definitions/breadbox-deselect-regular-value.schema.json +1 -1
- package/schema/definitions/breadbox-regular-facet.schema.json +3 -3
- package/schema/definitions/child-list.schema.json +1 -0
- package/schema/definitions/facet-value-state.schema.json +1 -1
- package/schema/definitions/selectable-facet-value-state.schema.json +0 -8
|
@@ -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(['
|
|
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',
|
|
@@ -65,12 +58,12 @@ export const SearchOptionActionItemSchema = z.strictObject({
|
|
|
65
58
|
text: z.string(),
|
|
66
59
|
type: z.literal('searchOption'),
|
|
67
60
|
});
|
|
68
|
-
export const
|
|
61
|
+
export const ChildListTemplateSchema = z.strictObject({
|
|
69
62
|
componentId: z.string().regex(new RegExp('^[a-z][a-z0-9-]*$')),
|
|
70
63
|
path: z.string(),
|
|
71
64
|
});
|
|
72
65
|
export const BreadboxRegularFacetValueSchema = z.strictObject({
|
|
73
|
-
state: z.
|
|
66
|
+
state: z.literal('selected'),
|
|
74
67
|
value: z.string().min(1),
|
|
75
68
|
});
|
|
76
69
|
export const BreadboxNumericalRangeFacetValueSchema = z.strictObject({
|
|
@@ -214,9 +207,6 @@ export const ProductSummaryStateSchema = z.strictObject({
|
|
|
214
207
|
export const SelectPagePayloadSchema = z.strictObject({
|
|
215
208
|
page: z.number().int().min(0),
|
|
216
209
|
});
|
|
217
|
-
export const PayloadSchema = z.strictObject({
|
|
218
|
-
pageSize: z.number().int().min(1),
|
|
219
|
-
});
|
|
220
210
|
export const ShowMorePayloadSchema = z.strictObject({});
|
|
221
211
|
export const PaginationStateSchema = z.strictObject({
|
|
222
212
|
page: z.number().int().min(0),
|
|
@@ -235,18 +225,12 @@ export const SortCriterionSchema = z.strictObject({
|
|
|
235
225
|
export const ActionSchema = z.strictObject({
|
|
236
226
|
payload: z.unknown(),
|
|
237
227
|
});
|
|
238
|
-
export const
|
|
228
|
+
export const RegularFacetSearchPayloadSchema = z.strictObject({
|
|
239
229
|
query: z.string(),
|
|
240
230
|
});
|
|
241
|
-
export const RegularFacetToggleExcludePayloadSchema = z.strictObject({
|
|
242
|
-
value: z.string().min(1),
|
|
243
|
-
});
|
|
244
231
|
export const RegularFacetToggleSelectPayloadSchema = z.strictObject({
|
|
245
232
|
value: z.string().min(1),
|
|
246
233
|
});
|
|
247
|
-
export const RegularFacetToggleSingleExcludePayloadSchema = z.strictObject({
|
|
248
|
-
value: z.string().min(1),
|
|
249
|
-
});
|
|
250
234
|
export const RegularFacetToggleSingleSelectPayloadSchema = z.strictObject({
|
|
251
235
|
value: z.string().min(1),
|
|
252
236
|
});
|
|
@@ -256,7 +240,7 @@ export const RegularFacetSearchResultSchema = z.strictObject({
|
|
|
256
240
|
});
|
|
257
241
|
export const RegularFacetValueSchema = z.strictObject({
|
|
258
242
|
numberOfResults: z.number().int().min(0),
|
|
259
|
-
state: z.enum(['idle', 'selected'
|
|
243
|
+
state: z.enum(['idle', 'selected']),
|
|
260
244
|
value: z.string().min(1),
|
|
261
245
|
});
|
|
262
246
|
export const NumericFacetApplyCustomRangePayloadSchema = z.strictObject({
|
|
@@ -334,7 +318,7 @@ export const BreadboxDeselectPayloadSchema = z.discriminatedUnion('type', [
|
|
|
334
318
|
BreadboxDeselectHierarchicalPathSchema,
|
|
335
319
|
]);
|
|
336
320
|
export const BreadboxFacetValueSchema = z.strictObject({
|
|
337
|
-
state: z.
|
|
321
|
+
state: z.literal('selected').optional(),
|
|
338
322
|
value: z.string().min(1).optional(),
|
|
339
323
|
end: z.union([z.number(), z.string()]).optional(),
|
|
340
324
|
start: z.union([z.number(), z.string()]).optional(),
|
|
@@ -464,9 +448,6 @@ export const ProductSummarySchema = z.looseObject({
|
|
|
464
448
|
export const SelectPageSchema = z.strictObject({
|
|
465
449
|
payload: SelectPagePayloadSchema,
|
|
466
450
|
});
|
|
467
|
-
export const PurpleSetPageSizeSchema = z.strictObject({
|
|
468
|
-
payload: PayloadSchema,
|
|
469
|
-
});
|
|
470
451
|
export const ShowMoreSchema = z.strictObject({
|
|
471
452
|
payload: ShowMorePayloadSchema,
|
|
472
453
|
});
|
|
@@ -477,22 +458,16 @@ export const SortStateSchema = z.strictObject({
|
|
|
477
458
|
appliedSort: SortCriterionSchema,
|
|
478
459
|
availableSorts: z.array(SortCriterionSchema),
|
|
479
460
|
});
|
|
480
|
-
export const
|
|
481
|
-
payload:
|
|
482
|
-
});
|
|
483
|
-
export const RegularFacetToggleExcludeSchema = z.strictObject({
|
|
484
|
-
payload: RegularFacetToggleExcludePayloadSchema,
|
|
461
|
+
export const RegularFacetSearchSchema = z.strictObject({
|
|
462
|
+
payload: RegularFacetSearchPayloadSchema,
|
|
485
463
|
});
|
|
486
464
|
export const RegularFacetToggleSelectSchema = z.strictObject({
|
|
487
465
|
payload: RegularFacetToggleSelectPayloadSchema,
|
|
488
466
|
});
|
|
489
|
-
export const RegularFacetToggleSingleExcludeSchema = z.strictObject({
|
|
490
|
-
payload: RegularFacetToggleSingleExcludePayloadSchema,
|
|
491
|
-
});
|
|
492
467
|
export const RegularFacetToggleSingleSelectSchema = z.strictObject({
|
|
493
468
|
payload: RegularFacetToggleSingleSelectPayloadSchema,
|
|
494
469
|
});
|
|
495
|
-
export const
|
|
470
|
+
export const RegularFacetSearchStateSchema = z.strictObject({
|
|
496
471
|
canShowMoreResults: z.boolean(),
|
|
497
472
|
query: z.string(),
|
|
498
473
|
results: z.array(RegularFacetSearchResultSchema),
|
|
@@ -540,7 +515,7 @@ export const CategoryFacetSearchSchema = z.strictObject({
|
|
|
540
515
|
export const CategoryFacetSelectPathSchema = z.strictObject({
|
|
541
516
|
payload: CategoryFacetSelectPathPayloadSchema,
|
|
542
517
|
});
|
|
543
|
-
export const
|
|
518
|
+
export const CategoryFacetSearchStateSchema = z.strictObject({
|
|
544
519
|
canShowMoreResults: z.boolean(),
|
|
545
520
|
query: z.string(),
|
|
546
521
|
results: z.array(CategoryFacetValueSchema),
|
|
@@ -587,7 +562,7 @@ export const QuerySummarySchema = z.looseObject({
|
|
|
587
562
|
id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
|
|
588
563
|
state: QuerySummaryStateSchema.optional(),
|
|
589
564
|
});
|
|
590
|
-
export const
|
|
565
|
+
export const SetPageSizeSchema = z.strictObject({
|
|
591
566
|
payload: SetPageSizePayloadSchema,
|
|
592
567
|
});
|
|
593
568
|
export const PurchaseSchema = z.strictObject({
|
|
@@ -625,7 +600,6 @@ export const ProductListActionsSchema = z.strictObject({
|
|
|
625
600
|
});
|
|
626
601
|
export const PaginationActionsSchema = z.strictObject({
|
|
627
602
|
selectPage: SelectPageSchema,
|
|
628
|
-
setPageSize: PurpleSetPageSizeSchema,
|
|
629
603
|
showMore: ShowMoreSchema,
|
|
630
604
|
});
|
|
631
605
|
export const SortActionsSchema = z.strictObject({
|
|
@@ -634,20 +608,18 @@ export const SortActionsSchema = z.strictObject({
|
|
|
634
608
|
export const RegularFacetActionsSchema = z.strictObject({
|
|
635
609
|
clearAllActiveValues: ActionSchema,
|
|
636
610
|
clearSearch: ActionSchema,
|
|
637
|
-
search:
|
|
611
|
+
search: RegularFacetSearchSchema,
|
|
638
612
|
showLessValues: ActionSchema,
|
|
639
613
|
showMoreSearchResults: ActionSchema,
|
|
640
614
|
showMoreValues: ActionSchema,
|
|
641
|
-
toggleExclude: RegularFacetToggleExcludeSchema,
|
|
642
615
|
toggleSelect: RegularFacetToggleSelectSchema,
|
|
643
|
-
toggleSingleExclude: RegularFacetToggleSingleExcludeSchema,
|
|
644
616
|
toggleSingleSelect: RegularFacetToggleSingleSelectSchema,
|
|
645
617
|
});
|
|
646
618
|
export const RegularFacetStateSchema = z.strictObject({
|
|
647
619
|
canShowLessValues: z.boolean(),
|
|
648
620
|
canShowMoreValues: z.boolean(),
|
|
649
621
|
displayName: z.string(),
|
|
650
|
-
facetSearch:
|
|
622
|
+
facetSearch: RegularFacetSearchStateSchema,
|
|
651
623
|
field: z.string().min(1),
|
|
652
624
|
hasActiveValues: z.boolean(),
|
|
653
625
|
values: z.array(RegularFacetValueSchema),
|
|
@@ -681,7 +653,7 @@ export const CategoryFacetStateSchema = z.strictObject({
|
|
|
681
653
|
canShowLessValues: z.boolean(),
|
|
682
654
|
canShowMoreValues: z.boolean(),
|
|
683
655
|
displayName: z.string(),
|
|
684
|
-
facetSearch:
|
|
656
|
+
facetSearch: CategoryFacetSearchStateSchema,
|
|
685
657
|
field: z.string(),
|
|
686
658
|
values: CategoryFacetValuesSchema,
|
|
687
659
|
});
|
|
@@ -704,7 +676,7 @@ export const RestoreStatePayloadSchema = z.strictObject({
|
|
|
704
676
|
sortCriteria: z.string().optional(),
|
|
705
677
|
});
|
|
706
678
|
export const PageSizeActionsSchema = z.strictObject({
|
|
707
|
-
setPageSize:
|
|
679
|
+
setPageSize: SetPageSizeSchema,
|
|
708
680
|
});
|
|
709
681
|
export const CartActionsSchema = z.strictObject({
|
|
710
682
|
purchase: PurchaseSchema,
|
|
@@ -1232,12 +1204,6 @@ export const PaginationActionSchema = z.union([
|
|
|
1232
1204
|
context: z.strictObject({ page: z.number().int().min(0) }),
|
|
1233
1205
|
}),
|
|
1234
1206
|
}),
|
|
1235
|
-
z.object({
|
|
1236
|
-
event: z.object({
|
|
1237
|
-
name: z.literal('setPageSize'),
|
|
1238
|
-
context: z.strictObject({ pageSize: z.number().int().min(1) }),
|
|
1239
|
-
}),
|
|
1240
|
-
}),
|
|
1241
1207
|
z.object({ event: z.object({ name: z.literal('showMore'), context: z.strictObject({}) }) }),
|
|
1242
1208
|
]);
|
|
1243
1209
|
export const ProductCarouselActionSchema = z.never();
|
|
@@ -1278,24 +1244,12 @@ export const RegularFacetActionSchema = z.union([
|
|
|
1278
1244
|
context: z.strictObject({ value: z.string() }),
|
|
1279
1245
|
}),
|
|
1280
1246
|
}),
|
|
1281
|
-
z.object({
|
|
1282
|
-
event: z.object({
|
|
1283
|
-
name: z.literal('toggleExclude'),
|
|
1284
|
-
context: z.strictObject({ value: z.string() }),
|
|
1285
|
-
}),
|
|
1286
|
-
}),
|
|
1287
1247
|
z.object({
|
|
1288
1248
|
event: z.object({
|
|
1289
1249
|
name: z.literal('toggleSingleSelect'),
|
|
1290
1250
|
context: z.strictObject({ value: z.string() }),
|
|
1291
1251
|
}),
|
|
1292
1252
|
}),
|
|
1293
|
-
z.object({
|
|
1294
|
-
event: z.object({
|
|
1295
|
-
name: z.literal('toggleSingleExclude'),
|
|
1296
|
-
context: z.strictObject({ value: z.string() }),
|
|
1297
|
-
}),
|
|
1298
|
-
}),
|
|
1299
1253
|
z.object({ event: z.object({ name: z.literal('clearAllActiveValues'), context: z.unknown() }) }),
|
|
1300
1254
|
z.object({
|
|
1301
1255
|
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, 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,
|
|
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,
|
|
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, 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';
|
|
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, 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';
|
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, 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,
|
|
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, 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';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@coveo/thermidor-schema",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.39",
|
|
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": {
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
},
|
|
58
58
|
"BreadboxDeselectAction": {
|
|
59
59
|
"title": "breadboxDeselect",
|
|
60
|
-
"description": "Removes one active value from a facet. Deselecting
|
|
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,7 +157,7 @@
|
|
|
157
157
|
"additionalProperties": false
|
|
158
158
|
},
|
|
159
159
|
"CategoryFacetSearch": {
|
|
160
|
-
"title": "
|
|
160
|
+
"title": "CategoryFacetSearchState",
|
|
161
161
|
"description": "The current category facet search state.",
|
|
162
162
|
"type": "object",
|
|
163
163
|
"required": ["query", "canShowMoreResults", "results"],
|
|
@@ -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/
|
|
161
|
-
"description": "The selection state of this facet value
|
|
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
|
|
@@ -18,6 +18,7 @@
|
|
|
18
18
|
"const": "LayoutStack"
|
|
19
19
|
},
|
|
20
20
|
"direction": {
|
|
21
|
+
"title": "LayoutStackDirection",
|
|
21
22
|
"type": "string",
|
|
22
23
|
"enum": ["column", "row"],
|
|
23
24
|
"description": "The axis along which children are stacked. A plain presentation value at the node top level, never server state."
|
|
@@ -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/
|
|
169
|
-
"description": "The selection state of this facet value
|
|
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
|
|
@@ -37,14 +37,11 @@
|
|
|
37
37
|
},
|
|
38
38
|
"actions": {
|
|
39
39
|
"type": "object",
|
|
40
|
-
"required": ["selectPage", "
|
|
40
|
+
"required": ["selectPage", "showMore"],
|
|
41
41
|
"properties": {
|
|
42
42
|
"selectPage": {
|
|
43
43
|
"$ref": "#/$defs/SelectPageAction"
|
|
44
44
|
},
|
|
45
|
-
"setPageSize": {
|
|
46
|
-
"$ref": "#/$defs/SetPageSizeAction"
|
|
47
|
-
},
|
|
48
45
|
"showMore": {
|
|
49
46
|
"$ref": "#/$defs/ShowMoreAction"
|
|
50
47
|
}
|
|
@@ -106,29 +103,6 @@
|
|
|
106
103
|
}
|
|
107
104
|
}
|
|
108
105
|
},
|
|
109
|
-
"SetPageSizeAction": {
|
|
110
|
-
"title": "setPageSize",
|
|
111
|
-
"description": "Changes the number of items displayed per page.",
|
|
112
|
-
"allOf": [
|
|
113
|
-
{
|
|
114
|
-
"$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
|
|
115
|
-
}
|
|
116
|
-
],
|
|
117
|
-
"properties": {
|
|
118
|
-
"payload": {
|
|
119
|
-
"type": "object",
|
|
120
|
-
"required": ["pageSize"],
|
|
121
|
-
"properties": {
|
|
122
|
-
"pageSize": {
|
|
123
|
-
"type": "integer",
|
|
124
|
-
"minimum": 1,
|
|
125
|
-
"description": "The number of items to display per page."
|
|
126
|
-
}
|
|
127
|
-
},
|
|
128
|
-
"additionalProperties": false
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
},
|
|
132
106
|
"ShowMoreAction": {
|
|
133
107
|
"title": "showMore",
|
|
134
108
|
"description": "Advances to the next page while preserving backend ownership of pagination state.",
|
|
@@ -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
|
|
125
|
+
"description": "Whether at least one facet value is selected."
|
|
134
126
|
},
|
|
135
127
|
"canShowMoreValues": {
|
|
136
128
|
"type": "boolean",
|
|
@@ -171,7 +163,7 @@
|
|
|
171
163
|
"additionalProperties": false
|
|
172
164
|
},
|
|
173
165
|
"RegularFacetSearch": {
|
|
174
|
-
"title": "
|
|
166
|
+
"title": "RegularFacetSearchState",
|
|
175
167
|
"description": "The facet search state for a regular facet.",
|
|
176
168
|
"type": "object",
|
|
177
169
|
"required": ["query", "canShowMoreResults", "results"],
|
|
@@ -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
|
|
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
|
|
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"
|
|
@@ -315,7 +261,7 @@
|
|
|
315
261
|
]
|
|
316
262
|
},
|
|
317
263
|
"RegularFacetSearchAction": {
|
|
318
|
-
"title": "
|
|
264
|
+
"title": "regularFacetSearch",
|
|
319
265
|
"description": "Runs a facet search with the given query.",
|
|
320
266
|
"allOf": [
|
|
321
267
|
{
|
|
@@ -355,7 +301,7 @@
|
|
|
355
301
|
]
|
|
356
302
|
},
|
|
357
303
|
"RegularFacetShowMoreValuesAction": {
|
|
358
|
-
"title": "
|
|
304
|
+
"title": "regularFacetShowMoreValues",
|
|
359
305
|
"description": "Increases the number of facet values shown.",
|
|
360
306
|
"allOf": [
|
|
361
307
|
{
|
|
@@ -364,7 +310,7 @@
|
|
|
364
310
|
]
|
|
365
311
|
},
|
|
366
312
|
"RegularFacetShowLessValuesAction": {
|
|
367
|
-
"title": "
|
|
313
|
+
"title": "regularFacetShowLessValues",
|
|
368
314
|
"description": "Decreases the number of facet values shown.",
|
|
369
315
|
"allOf": [
|
|
370
316
|
{
|
|
@@ -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": "
|
|
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
|
|
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"
|
|
53
|
-
"description": "
|
|
52
|
+
"enum": ["selected"],
|
|
53
|
+
"description": "The state of the value, which is always selected."
|
|
54
54
|
}
|
|
55
55
|
},
|
|
56
56
|
"additionalProperties": false
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
}
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
|
+
"title": "ChildListTemplate",
|
|
16
17
|
"type": "object",
|
|
17
18
|
"description": "A template for generating a dynamic list of children from a data-model list. The componentId is the component used as the template; path is the JSON Pointer to the list of component property objects in the data model.",
|
|
18
19
|
"required": ["componentId", "path"],
|
|
@@ -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
|
-
}
|