@coveo/thermidor-schema 1.0.0-beta.3 → 1.0.0-beta.30

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.
Files changed (59) hide show
  1. package/README.md +32 -5
  2. package/dist/generated/schemas.d.ts +3346 -400
  3. package/dist/generated/schemas.js +843 -238
  4. package/dist/generated/zod3/index.d.ts +3 -0
  5. package/dist/generated/zod3/index.js +5 -0
  6. package/dist/generated/zod3/schemas.d.ts +31378 -0
  7. package/dist/generated/zod3/schemas.js +1252 -0
  8. package/dist/index.d.ts +2 -2
  9. package/dist/index.js +1 -1
  10. package/dist/zod3-compat.d.ts +79 -0
  11. package/dist/zod3-compat.js +82 -0
  12. package/package.json +26 -20
  13. package/schema/base/catalog.schema.json +5 -4
  14. package/schema/base/component.schema.json +22 -33
  15. package/schema/{components/component-contracts.schema.json → component-contracts.schema.json} +14 -2
  16. package/schema/components/breadbox.schema.json +82 -0
  17. package/schema/components/bundle-display.schema.json +17 -13
  18. package/schema/components/cart.schema.json +147 -0
  19. package/schema/components/category-facet.schema.json +29 -15
  20. package/schema/components/commerce-search.schema.json +156 -15
  21. package/schema/components/comparison-table.schema.json +21 -13
  22. package/schema/components/date-facet.schema.json +33 -13
  23. package/schema/components/facet-manager.schema.json +12 -14
  24. package/schema/components/layout-stack.schema.json +18 -15
  25. package/schema/components/next-actions-bar.schema.json +40 -17
  26. package/schema/components/numeric-facet.schema.json +37 -15
  27. package/schema/components/page-size.schema.json +13 -15
  28. package/schema/components/pagination.schema.json +41 -14
  29. package/schema/components/product-carousel.schema.json +13 -13
  30. package/schema/components/product-list.schema.json +75 -14
  31. package/schema/components/product-research-card.schema.json +107 -0
  32. package/schema/components/product-summary.schema.json +15 -14
  33. package/schema/components/query-suggestions.schema.json +113 -0
  34. package/schema/components/query-summary.schema.json +23 -14
  35. package/schema/components/regular-facet.schema.json +33 -32
  36. package/schema/components/sort.schema.json +13 -13
  37. package/schema/definitions/action-item.schema.json +10 -13
  38. package/schema/definitions/badge-placement.schema.json +22 -0
  39. package/schema/definitions/badge.schema.json +27 -0
  40. package/schema/definitions/breadbox-date-range-facet.schema.json +56 -0
  41. package/schema/definitions/breadbox-deselect-date-range.schema.json +28 -0
  42. package/schema/definitions/breadbox-deselect-hierarchical-path.schema.json +28 -0
  43. package/schema/definitions/breadbox-deselect-numerical-range.schema.json +28 -0
  44. package/schema/definitions/breadbox-deselect-payload.schema.json +20 -0
  45. package/schema/definitions/breadbox-deselect-regular-value.schema.json +25 -0
  46. package/schema/definitions/breadbox-facet.schema.json +20 -0
  47. package/schema/definitions/breadbox-hierarchical-facet.schema.json +37 -0
  48. package/schema/definitions/breadbox-numerical-range-facet.schema.json +56 -0
  49. package/schema/definitions/breadbox-regular-facet.schema.json +59 -0
  50. package/schema/definitions/bundle-tier.schema.json +6 -1
  51. package/schema/definitions/child-list.schema.json +31 -0
  52. package/schema/definitions/comparison-product.schema.json +7 -2
  53. package/schema/definitions/component-id.schema.json +9 -0
  54. package/schema/definitions/data-binding.schema.json +16 -0
  55. package/schema/definitions/followup-action-item.schema.json +20 -0
  56. package/schema/definitions/product.schema.json +10 -6
  57. package/schema/definitions/search-action-item.schema.json +20 -0
  58. package/schema/definitions/search-option-action-item.schema.json +25 -0
  59. package/schema/definitions/child-ref.schema.json +0 -8
@@ -0,0 +1,113 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/components/query-suggestions.schema.json",
4
+ "title": "QuerySuggestions",
5
+ "description": "Requests and renders backend-provided query completions and product suggestions for the active search input.",
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": "QuerySuggestions"
18
+ },
19
+ "query": {
20
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
21
+ "description": "The input query these suggestions were requested for, bound to /state/<id>/query."
22
+ },
23
+ "completions": {
24
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
25
+ "description": "The query completions, bound to /state/<id>/completions."
26
+ },
27
+ "products": {
28
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
29
+ "description": "The product suggestions, bound to /state/<id>/products."
30
+ },
31
+ "state": {
32
+ "$ref": "#/$defs/QuerySuggestionsState"
33
+ },
34
+ "actions": {
35
+ "type": "object",
36
+ "required": ["fetchSuggestions"],
37
+ "properties": {
38
+ "fetchSuggestions": {
39
+ "$ref": "#/$defs/FetchSuggestionsAction"
40
+ }
41
+ },
42
+ "additionalProperties": false
43
+ }
44
+ },
45
+ "additionalProperties": false,
46
+ "$defs": {
47
+ "QuerySuggestionsState": {
48
+ "title": "QuerySuggestionsState",
49
+ "description": "The suggestion result for one query. Owned exclusively by the backend.",
50
+ "type": "object",
51
+ "required": ["query", "completions", "products"],
52
+ "properties": {
53
+ "query": {
54
+ "type": "string",
55
+ "description": "The input query for which these suggestions were requested."
56
+ },
57
+ "completions": {
58
+ "type": "array",
59
+ "description": "Query completions returned by the commerce service.",
60
+ "items": {
61
+ "$ref": "#/$defs/QueryCompletion"
62
+ }
63
+ },
64
+ "products": {
65
+ "type": "array",
66
+ "description": "Product suggestions returned by the commerce service.",
67
+ "items": {
68
+ "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
69
+ }
70
+ }
71
+ },
72
+ "additionalProperties": false
73
+ },
74
+ "FetchSuggestionsAction": {
75
+ "title": "fetchSuggestions",
76
+ "description": "Fetches query completions and product suggestions for the current input.",
77
+ "allOf": [
78
+ {
79
+ "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
80
+ }
81
+ ],
82
+ "properties": {
83
+ "payload": {
84
+ "type": "object",
85
+ "required": ["query"],
86
+ "properties": {
87
+ "query": {
88
+ "type": "string"
89
+ }
90
+ },
91
+ "additionalProperties": false
92
+ }
93
+ }
94
+ },
95
+ "QueryCompletion": {
96
+ "title": "QueryCompletion",
97
+ "description": "One query completion returned by the commerce service.",
98
+ "type": "object",
99
+ "required": ["expression"],
100
+ "properties": {
101
+ "expression": {
102
+ "type": "string",
103
+ "description": "The suggested query text."
104
+ },
105
+ "score": {
106
+ "type": "number",
107
+ "description": "The relevance score returned by the commerce service, when available."
108
+ }
109
+ },
110
+ "additionalProperties": false
111
+ }
112
+ }
113
+ }
@@ -2,16 +2,36 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.thermidor.coveo.com/components/query-summary.schema.json",
4
4
  "title": "QuerySummary",
5
- "description": "Summarizes the current result window for a search surface (e.g. 'Products 1-12 of 43 for Water Sports'). Read-only from the frontend. Rather than reading three sibling components' state (search-box query, pagination page/pageSize/totalEntries, product-list count), it carries its own backend-computed aggregate so it has no cross-component coupling.",
5
+ "description": "Summarizes the current result window for a search surface (e.g. 'Products 1-12 of 43 for Water Sports'). Read-only from the frontend.",
6
+ "$comment": "Carries its own backend-computed aggregate instead of reading sibling state (search box, pagination, product-list), so it has no cross-component coupling.",
6
7
  "allOf": [
7
8
  {
8
9
  "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
9
10
  }
10
11
  ],
11
12
  "properties": {
12
- "componentType": {
13
+ "id": {
14
+ "type": "string"
15
+ },
16
+ "component": {
13
17
  "type": "string",
14
- "const": "query-summary"
18
+ "const": "QuerySummary"
19
+ },
20
+ "query": {
21
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
22
+ "description": "The current query string, bound to /state/<id>/query."
23
+ },
24
+ "firstIndex": {
25
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
26
+ "description": "The 1-based index of the first result on the page, bound to /state/<id>/firstIndex."
27
+ },
28
+ "lastIndex": {
29
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
30
+ "description": "The 1-based index of the last result on the page, bound to /state/<id>/lastIndex."
31
+ },
32
+ "totalEntries": {
33
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
34
+ "description": "The total number of results, bound to /state/<id>/totalEntries."
15
35
  },
16
36
  "state": {
17
37
  "$ref": "#/$defs/QuerySummaryState"
@@ -20,17 +40,6 @@
20
40
  "type": "object",
21
41
  "properties": {},
22
42
  "additionalProperties": false
23
- },
24
- "children": {
25
- "type": "array",
26
- "items": {
27
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
28
- },
29
- "maxItems": 1000,
30
- "default": []
31
- },
32
- "child": {
33
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
34
43
  }
35
44
  },
36
45
  "additionalProperties": false,
@@ -9,9 +9,40 @@
9
9
  }
10
10
  ],
11
11
  "properties": {
12
- "componentType": {
12
+ "component": {
13
13
  "type": "string",
14
- "const": "regular-facet"
14
+ "const": "RegularFacet"
15
+ },
16
+ "id": {
17
+ "type": "string"
18
+ },
19
+ "field": {
20
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
21
+ "description": "The index field the facet is built on, bound to /state/<id>/field."
22
+ },
23
+ "displayName": {
24
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
25
+ "description": "The facet's human-readable label, bound to /state/<id>/displayName."
26
+ },
27
+ "values": {
28
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
29
+ "description": "The facet values, bound to /state/<id>/values."
30
+ },
31
+ "hasActiveValues": {
32
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
33
+ "description": "Whether at least one facet value is active, bound to /state/<id>/hasActiveValues."
34
+ },
35
+ "canShowMoreValues": {
36
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
37
+ "description": "Whether more facet values can be shown, bound to /state/<id>/canShowMoreValues."
38
+ },
39
+ "canShowLessValues": {
40
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
41
+ "description": "Whether fewer facet values can be shown, bound to /state/<id>/canShowLessValues."
42
+ },
43
+ "facetSearch": {
44
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
45
+ "description": "The facet search state, bound to /state/<id>/facetSearch."
15
46
  },
16
47
  "state": {
17
48
  "$ref": "#/$defs/RegularFacetState"
@@ -63,17 +94,6 @@
63
94
  }
64
95
  },
65
96
  "additionalProperties": false
66
- },
67
- "children": {
68
- "type": "array",
69
- "items": {
70
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
71
- },
72
- "maxItems": 1000,
73
- "default": []
74
- },
75
- "child": {
76
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
77
97
  }
78
98
  },
79
99
  "additionalProperties": false,
@@ -95,19 +115,14 @@
95
115
  "field": {
96
116
  "type": "string",
97
117
  "minLength": 1,
98
- "maxLength": 255,
99
118
  "description": "The index field the facet is built on."
100
119
  },
101
120
  "displayName": {
102
121
  "type": "string",
103
- "minLength": 1,
104
- "maxLength": 255,
105
122
  "description": "Human-readable name for the facet."
106
123
  },
107
124
  "values": {
108
125
  "type": "array",
109
- "minItems": 0,
110
- "maxItems": 1000,
111
126
  "description": "The facet values available for selection.",
112
127
  "items": {
113
128
  "$ref": "#/$defs/RegularFacetValue"
@@ -141,13 +156,11 @@
141
156
  "value": {
142
157
  "type": "string",
143
158
  "minLength": 1,
144
- "maxLength": 1024,
145
159
  "description": "The raw facet value."
146
160
  },
147
161
  "numberOfResults": {
148
162
  "type": "integer",
149
163
  "minimum": 0,
150
- "maximum": 999999999,
151
164
  "description": "The number of results matching this facet value."
152
165
  },
153
166
  "state": {
@@ -165,8 +178,6 @@
165
178
  "properties": {
166
179
  "query": {
167
180
  "type": "string",
168
- "minLength": 0,
169
- "maxLength": 1024,
170
181
  "description": "The current facet search query."
171
182
  },
172
183
  "canShowMoreResults": {
@@ -175,8 +186,6 @@
175
186
  },
176
187
  "results": {
177
188
  "type": "array",
178
- "minItems": 0,
179
- "maxItems": 1000,
180
189
  "description": "The current facet search results.",
181
190
  "items": {
182
191
  "$ref": "#/$defs/RegularFacetSearchResult"
@@ -194,13 +203,11 @@
194
203
  "value": {
195
204
  "type": "string",
196
205
  "minLength": 1,
197
- "maxLength": 1024,
198
206
  "description": "The raw facet value. Pass this to toggleSelect/toggleExclude to act on it."
199
207
  },
200
208
  "numberOfResults": {
201
209
  "type": "integer",
202
210
  "minimum": 0,
203
- "maximum": 999999999,
204
211
  "description": "The number of results matching this facet search value."
205
212
  }
206
213
  },
@@ -222,7 +229,6 @@
222
229
  "value": {
223
230
  "type": "string",
224
231
  "minLength": 1,
225
- "maxLength": 1024,
226
232
  "description": "The raw facet value to toggle selection for."
227
233
  }
228
234
  },
@@ -246,7 +252,6 @@
246
252
  "value": {
247
253
  "type": "string",
248
254
  "minLength": 1,
249
- "maxLength": 1024,
250
255
  "description": "The raw facet value to toggle exclusion for."
251
256
  }
252
257
  },
@@ -270,7 +275,6 @@
270
275
  "value": {
271
276
  "type": "string",
272
277
  "minLength": 1,
273
- "maxLength": 1024,
274
278
  "description": "The raw facet value to single-select."
275
279
  }
276
280
  },
@@ -294,7 +298,6 @@
294
298
  "value": {
295
299
  "type": "string",
296
300
  "minLength": 1,
297
- "maxLength": 1024,
298
301
  "description": "The raw facet value to single-exclude."
299
302
  }
300
303
  },
@@ -326,8 +329,6 @@
326
329
  "properties": {
327
330
  "query": {
328
331
  "type": "string",
329
- "minLength": 0,
330
- "maxLength": 1024,
331
332
  "description": "The facet search query to run."
332
333
  }
333
334
  },
@@ -9,9 +9,20 @@
9
9
  }
10
10
  ],
11
11
  "properties": {
12
- "componentType": {
12
+ "id": {
13
+ "type": "string"
14
+ },
15
+ "component": {
13
16
  "type": "string",
14
- "const": "sort"
17
+ "const": "Sort"
18
+ },
19
+ "appliedSort": {
20
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
21
+ "description": "The currently applied sort criterion, bound to /state/<id>/appliedSort."
22
+ },
23
+ "availableSorts": {
24
+ "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
25
+ "description": "The available sort options, bound to /state/<id>/availableSorts."
15
26
  },
16
27
  "state": {
17
28
  "$ref": "#/$defs/SortState"
@@ -25,17 +36,6 @@
25
36
  }
26
37
  },
27
38
  "additionalProperties": false
28
- },
29
- "children": {
30
- "type": "array",
31
- "items": {
32
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
33
- },
34
- "maxItems": 1000,
35
- "default": []
36
- },
37
- "child": {
38
- "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
39
39
  }
40
40
  },
41
41
  "additionalProperties": false,
@@ -2,19 +2,16 @@
2
2
  "$schema": "https://json-schema.org/draft/2020-12/schema",
3
3
  "$id": "https://schema.thermidor.coveo.com/definitions/action-item.schema.json",
4
4
  "title": "ActionItem",
5
- "description": "A suggested action the assistant offers the user, such as a follow-up question or a search query.",
6
- "type": "object",
7
- "required": ["text", "type"],
8
- "properties": {
9
- "text": {
10
- "type": "string",
11
- "description": "The display text of the action shown to the user."
5
+ "description": "A suggested action the assistant offers the user: a follow-up question, a search query, or a search the backend saved. Discriminated by type.",
6
+ "oneOf": [
7
+ {
8
+ "$ref": "https://schema.thermidor.coveo.com/definitions/followup-action-item.schema.json"
12
9
  },
13
- "type": {
14
- "type": "string",
15
- "enum": ["followup", "search"],
16
- "description": "The kind of action: \"followup\" triggers a conversational follow-up, \"search\" triggers a standalone search."
10
+ {
11
+ "$ref": "https://schema.thermidor.coveo.com/definitions/search-action-item.schema.json"
12
+ },
13
+ {
14
+ "$ref": "https://schema.thermidor.coveo.com/definitions/search-option-action-item.schema.json"
17
15
  }
18
- },
19
- "additionalProperties": false
16
+ ]
20
17
  }
@@ -0,0 +1,22 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/badge-placement.schema.json",
4
+ "title": "BadgePlacement",
5
+ "description": "The badges a product earned for one badge placement configured on the tracking ID. Mirrors the Commerce API BadgePlacementViewModel.",
6
+ "type": "object",
7
+ "required": ["placementId", "badges"],
8
+ "properties": {
9
+ "placementId": {
10
+ "type": "string",
11
+ "description": "The unique identifier of the badge placement."
12
+ },
13
+ "badges": {
14
+ "type": "array",
15
+ "description": "The badges to render for this placement, in display order.",
16
+ "items": {
17
+ "$ref": "https://schema.thermidor.coveo.com/definitions/badge.schema.json"
18
+ }
19
+ }
20
+ },
21
+ "additionalProperties": false
22
+ }
@@ -0,0 +1,27 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/badge.schema.json",
4
+ "title": "Badge",
5
+ "description": "A merchandising badge displayed on a product (e.g. 'Bestseller!'). Mirrors the Commerce API BadgeViewModel.",
6
+ "type": "object",
7
+ "required": ["text"],
8
+ "properties": {
9
+ "text": {
10
+ "type": "string",
11
+ "description": "The localized text displayed on the badge."
12
+ },
13
+ "backgroundColor": {
14
+ "type": "string",
15
+ "description": "The badge background color in the format #RRGGBB."
16
+ },
17
+ "textColor": {
18
+ "type": "string",
19
+ "description": "The badge text color in the format #RRGGBB."
20
+ },
21
+ "iconUrl": {
22
+ "type": "string",
23
+ "description": "The URL of an icon to render with the badge text."
24
+ }
25
+ },
26
+ "additionalProperties": false
27
+ }
@@ -0,0 +1,56 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-date-range-facet.schema.json",
4
+ "title": "BreadboxDateRangeFacet",
5
+ "description": "A Breadbox entry for a date facet: its selected ranges.",
6
+ "type": "object",
7
+ "required": ["facetId", "field", "displayName", "type", "values"],
8
+ "properties": {
9
+ "facetId": {
10
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
11
+ "description": "The id of the facet component the entry reflects."
12
+ },
13
+ "field": {
14
+ "type": "string",
15
+ "minLength": 1,
16
+ "description": "The commerce index field the facet operates on."
17
+ },
18
+ "displayName": {
19
+ "type": "string",
20
+ "description": "Human-readable label for the facet."
21
+ },
22
+ "type": {
23
+ "type": "string",
24
+ "const": "dateRange",
25
+ "description": "The BreadboxFacet discriminator."
26
+ },
27
+ "values": {
28
+ "type": "array",
29
+ "minItems": 1,
30
+ "description": "The selected ranges of the facet, in the facet order.",
31
+ "items": {
32
+ "$ref": "#/$defs/BreadboxDateRangeFacetValue"
33
+ }
34
+ }
35
+ },
36
+ "additionalProperties": false,
37
+ "$defs": {
38
+ "BreadboxDateRangeFacetValue": {
39
+ "title": "BreadboxDateRangeFacetValue",
40
+ "description": "A selected date range.",
41
+ "type": "object",
42
+ "required": ["start", "end"],
43
+ "properties": {
44
+ "start": {
45
+ "type": "string",
46
+ "description": "The inclusive start of the date range, as a Commerce API date string (YYYY/MM/DD@HH:mm:ss)."
47
+ },
48
+ "end": {
49
+ "type": "string",
50
+ "description": "The end of the date range, as a Commerce API date string (YYYY/MM/DD@HH:mm:ss)."
51
+ }
52
+ },
53
+ "additionalProperties": false
54
+ }
55
+ }
56
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-date-range.schema.json",
4
+ "title": "BreadboxDeselectDateRange",
5
+ "description": "Deselects a date facet range.",
6
+ "type": "object",
7
+ "required": ["facetId", "type", "start", "end"],
8
+ "properties": {
9
+ "facetId": {
10
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
11
+ "description": "The id of the facet component to remove the value from."
12
+ },
13
+ "type": {
14
+ "type": "string",
15
+ "const": "dateRange",
16
+ "description": "The BreadboxDeselectPayload discriminator."
17
+ },
18
+ "start": {
19
+ "type": "string",
20
+ "description": "The inclusive start of the date range, as a Commerce API date string (YYYY/MM/DD@HH:mm:ss)."
21
+ },
22
+ "end": {
23
+ "type": "string",
24
+ "description": "The end of the date range, as a Commerce API date string (YYYY/MM/DD@HH:mm:ss)."
25
+ }
26
+ },
27
+ "additionalProperties": false
28
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-hierarchical-path.schema.json",
4
+ "title": "BreadboxDeselectHierarchicalPath",
5
+ "description": "Clears the selected path of a category facet: the whole path is cleared, not only its last value.",
6
+ "type": "object",
7
+ "required": ["facetId", "type", "path"],
8
+ "properties": {
9
+ "facetId": {
10
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
11
+ "description": "The id of the facet component to remove the value from."
12
+ },
13
+ "type": {
14
+ "type": "string",
15
+ "const": "hierarchical",
16
+ "description": "The BreadboxDeselectPayload discriminator."
17
+ },
18
+ "path": {
19
+ "type": "array",
20
+ "minItems": 1,
21
+ "description": "The selected path to clear, as shown in the Breadbox entry.",
22
+ "items": {
23
+ "type": "string"
24
+ }
25
+ }
26
+ },
27
+ "additionalProperties": false
28
+ }
@@ -0,0 +1,28 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-numerical-range.schema.json",
4
+ "title": "BreadboxDeselectNumericalRange",
5
+ "description": "Deselects a numeric facet range.",
6
+ "type": "object",
7
+ "required": ["facetId", "type", "start", "end"],
8
+ "properties": {
9
+ "facetId": {
10
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
11
+ "description": "The id of the facet component to remove the value from."
12
+ },
13
+ "type": {
14
+ "type": "string",
15
+ "const": "numericalRange",
16
+ "description": "The BreadboxDeselectPayload discriminator."
17
+ },
18
+ "start": {
19
+ "type": "number",
20
+ "description": "The inclusive start of the range to deselect."
21
+ },
22
+ "end": {
23
+ "type": "number",
24
+ "description": "The end of the range to deselect."
25
+ }
26
+ },
27
+ "additionalProperties": false
28
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-payload.schema.json",
4
+ "title": "BreadboxDeselectPayload",
5
+ "description": "The facet component id and the value to remove, in the shape of the facet type. Discriminated by type.",
6
+ "oneOf": [
7
+ {
8
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-regular-value.schema.json"
9
+ },
10
+ {
11
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-numerical-range.schema.json"
12
+ },
13
+ {
14
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-date-range.schema.json"
15
+ },
16
+ {
17
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-hierarchical-path.schema.json"
18
+ }
19
+ ]
20
+ }
@@ -0,0 +1,25 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-deselect-regular-value.schema.json",
4
+ "title": "BreadboxDeselectRegularValue",
5
+ "description": "Removes a regular facet value: a selected value is deselected, and an excluded value has its exclusion removed.",
6
+ "type": "object",
7
+ "required": ["facetId", "type", "value"],
8
+ "properties": {
9
+ "facetId": {
10
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
11
+ "description": "The id of the facet component to remove the value from."
12
+ },
13
+ "type": {
14
+ "type": "string",
15
+ "const": "regular",
16
+ "description": "The BreadboxDeselectPayload discriminator."
17
+ },
18
+ "value": {
19
+ "type": "string",
20
+ "minLength": 1,
21
+ "description": "The facet value to remove."
22
+ }
23
+ },
24
+ "additionalProperties": false
25
+ }