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

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 (65) hide show
  1. package/README.md +32 -5
  2. package/dist/generated/schemas.d.ts +3668 -560
  3. package/dist/generated/schemas.js +912 -285
  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 +32331 -0
  7. package/dist/generated/zod3/schemas.js +1282 -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 +28 -22
  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} +23 -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 +30 -16
  20. package/schema/components/commerce-search.schema.json +111 -15
  21. package/schema/components/comparison-table.schema.json +21 -13
  22. package/schema/components/date-facet.schema.json +35 -15
  23. package/schema/components/facet-manager.schema.json +12 -14
  24. package/schema/components/instant-products.schema.json +85 -0
  25. package/schema/components/layout-stack.schema.json +19 -15
  26. package/schema/components/next-actions-bar.schema.json +44 -17
  27. package/schema/components/numeric-facet.schema.json +39 -17
  28. package/schema/components/page-size.schema.json +13 -15
  29. package/schema/components/pagination.schema.json +28 -27
  30. package/schema/components/product-carousel.schema.json +13 -13
  31. package/schema/components/product-list.schema.json +75 -14
  32. package/schema/components/product-research-card.schema.json +107 -0
  33. package/schema/components/product-summary.schema.json +15 -14
  34. package/schema/components/query-suggestions.schema.json +102 -0
  35. package/schema/components/query-summary.schema.json +70 -16
  36. package/schema/components/regular-facet.schema.json +40 -93
  37. package/schema/components/search-box.schema.json +47 -0
  38. package/schema/components/session-shell.schema.json +65 -0
  39. package/schema/components/sort.schema.json +22 -16
  40. package/schema/definitions/action-item.schema.json +10 -13
  41. package/schema/definitions/badge-placement.schema.json +22 -0
  42. package/schema/definitions/badge.schema.json +27 -0
  43. package/schema/definitions/breadbox-date-range-facet.schema.json +56 -0
  44. package/schema/definitions/breadbox-deselect-date-range.schema.json +28 -0
  45. package/schema/definitions/breadbox-deselect-hierarchical-path.schema.json +28 -0
  46. package/schema/definitions/breadbox-deselect-numerical-range.schema.json +28 -0
  47. package/schema/definitions/breadbox-deselect-payload.schema.json +20 -0
  48. package/schema/definitions/breadbox-deselect-regular-value.schema.json +25 -0
  49. package/schema/definitions/breadbox-facet.schema.json +20 -0
  50. package/schema/definitions/breadbox-hierarchical-facet.schema.json +37 -0
  51. package/schema/definitions/breadbox-numerical-range-facet.schema.json +56 -0
  52. package/schema/definitions/breadbox-regular-facet.schema.json +59 -0
  53. package/schema/definitions/bundle-tier.schema.json +6 -1
  54. package/schema/definitions/child-list.schema.json +32 -0
  55. package/schema/definitions/comparison-product.schema.json +7 -2
  56. package/schema/definitions/component-id.schema.json +9 -0
  57. package/schema/definitions/data-binding.schema.json +16 -0
  58. package/schema/definitions/facet-value-state.schema.json +1 -1
  59. package/schema/definitions/followup-action-item.schema.json +20 -0
  60. package/schema/definitions/product.schema.json +10 -6
  61. package/schema/definitions/search-action-item.schema.json +20 -0
  62. package/schema/definitions/search-option-action-item.schema.json +25 -0
  63. package/schema/definitions/sort-field.schema.json +26 -0
  64. package/schema/definitions/child-ref.schema.json +0 -8
  65. package/schema/definitions/selectable-facet-value-state.schema.json +0 -8
@@ -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,
@@ -68,11 +68,14 @@
68
68
  "properties": {
69
69
  "sortCriteria": {
70
70
  "type": "string",
71
- "description": "The name of the sort criterion (e.g. 'relevance', 'price asc')."
71
+ "description": "The name of the sort criterion (e.g. 'relevance' or 'fields'). A 'fields' criterion lists the fields it sorts on in fields."
72
72
  },
73
73
  "fields": {
74
74
  "type": "array",
75
- "description": "The fields involved in this sort criterion."
75
+ "description": "The fields this sort criterion sorts on, in priority order. Empty for a criterion that sorts on no field, such as relevance.",
76
+ "items": {
77
+ "$ref": "https://schema.thermidor.coveo.com/definitions/sort-field.schema.json"
78
+ }
76
79
  }
77
80
  },
78
81
  "additionalProperties": false
@@ -96,7 +99,10 @@
96
99
  },
97
100
  "fields": {
98
101
  "type": "array",
99
- "description": "The fields involved in the sort criterion."
102
+ "description": "The fields the sort criterion sorts on, in priority order, as listed in the selected available sort. Empty for a criterion that sorts on no field, such as relevance.",
103
+ "items": {
104
+ "$ref": "https://schema.thermidor.coveo.com/definitions/sort-field.schema.json"
105
+ }
100
106
  }
101
107
  },
102
108
  "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": "Deselects a regular facet value.",
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
+ }
@@ -0,0 +1,20 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-facet.schema.json",
4
+ "title": "BreadboxFacet",
5
+ "description": "An active facet shown in the Breadbox, with its active values in the shape of its facet type. Discriminated by type.",
6
+ "oneOf": [
7
+ {
8
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-regular-facet.schema.json"
9
+ },
10
+ {
11
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-numerical-range-facet.schema.json"
12
+ },
13
+ {
14
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-date-range-facet.schema.json"
15
+ },
16
+ {
17
+ "$ref": "https://schema.thermidor.coveo.com/definitions/breadbox-hierarchical-facet.schema.json"
18
+ }
19
+ ]
20
+ }
@@ -0,0 +1,37 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-hierarchical-facet.schema.json",
4
+ "title": "BreadboxHierarchicalFacet",
5
+ "description": "A Breadbox entry for a category facet: the path to its selected value.",
6
+ "type": "object",
7
+ "required": ["facetId", "field", "displayName", "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 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": "hierarchical",
25
+ "description": "The BreadboxFacet discriminator."
26
+ },
27
+ "path": {
28
+ "type": "array",
29
+ "minItems": 1,
30
+ "description": "The path from the root to the selected value, the selected value last.",
31
+ "items": {
32
+ "type": "string"
33
+ }
34
+ }
35
+ },
36
+ "additionalProperties": false
37
+ }
@@ -0,0 +1,56 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-numerical-range-facet.schema.json",
4
+ "title": "BreadboxNumericalRangeFacet",
5
+ "description": "A Breadbox entry for a numeric 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": "numericalRange",
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/BreadboxNumericalRangeFacetValue"
33
+ }
34
+ }
35
+ },
36
+ "additionalProperties": false,
37
+ "$defs": {
38
+ "BreadboxNumericalRangeFacetValue": {
39
+ "title": "BreadboxNumericalRangeFacetValue",
40
+ "description": "A selected numeric range.",
41
+ "type": "object",
42
+ "required": ["start", "end"],
43
+ "properties": {
44
+ "start": {
45
+ "type": "number",
46
+ "description": "The inclusive start of the range."
47
+ },
48
+ "end": {
49
+ "type": "number",
50
+ "description": "The end of the range."
51
+ }
52
+ },
53
+ "additionalProperties": false
54
+ }
55
+ }
56
+ }
@@ -0,0 +1,59 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/breadbox-regular-facet.schema.json",
4
+ "title": "BreadboxRegularFacet",
5
+ "description": "A Breadbox entry for a regular facet: its selected values.",
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": "regular",
25
+ "description": "The BreadboxFacet discriminator."
26
+ },
27
+ "values": {
28
+ "type": "array",
29
+ "minItems": 1,
30
+ "description": "The active values of the facet, in the facet order.",
31
+ "items": {
32
+ "$ref": "#/$defs/BreadboxRegularFacetValue"
33
+ }
34
+ }
35
+ },
36
+ "additionalProperties": false,
37
+ "$defs": {
38
+ "BreadboxRegularFacetValue": {
39
+ "title": "BreadboxRegularFacetValue",
40
+ "description": "An active regular facet value.",
41
+ "type": "object",
42
+ "required": ["value", "state"],
43
+ "properties": {
44
+ "value": {
45
+ "type": "string",
46
+ "minLength": 1,
47
+ "description": "The facet value."
48
+ },
49
+ "state": {
50
+ "title": "BreadboxRegularFacetValueState",
51
+ "type": "string",
52
+ "enum": ["selected"],
53
+ "description": "The state of the value, which is always selected."
54
+ }
55
+ },
56
+ "additionalProperties": false
57
+ }
58
+ }
59
+ }
@@ -4,7 +4,7 @@
4
4
  "title": "BundleTier",
5
5
  "description": "A tier in a product bundle, grouping product slots by price/quality level.",
6
6
  "type": "object",
7
- "required": ["label", "description", "slots"],
7
+ "required": ["label", "description", "total", "slots"],
8
8
  "properties": {
9
9
  "label": {
10
10
  "type": "string",
@@ -14,6 +14,11 @@
14
14
  "type": "string",
15
15
  "description": "Brief description of what the tier includes."
16
16
  },
17
+ "total": {
18
+ "type": "number",
19
+ "minimum": 0,
20
+ "description": "Backend-computed total price for this tier's slots, in the request currency."
21
+ },
17
22
  "slots": {
18
23
  "type": "array",
19
24
  "description": "Product category slots within this tier.",
@@ -0,0 +1,32 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/child-list.schema.json",
4
+ "title": "ChildList",
5
+ "description": "The A2-UI ChildList type: how a container holds its ordered children, as a static array of ComponentId references or a template binding children to a data-model list.",
6
+ "$comment": "A2-UI common_types.json#/$defs/ChildList. Any child-list property MUST use this type so validators treat it as a structural link. Thermidor emits only the static array form.",
7
+ "oneOf": [
8
+ {
9
+ "type": "array",
10
+ "description": "A static, ordered list of child component ids. Order is backend-owned and meaningful for container components (e.g. facet order); referential integrity and uniqueness are owned by the backend and not enforced at parse time.",
11
+ "items": {
12
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json"
13
+ }
14
+ },
15
+ {
16
+ "title": "ChildListTemplate",
17
+ "type": "object",
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.",
19
+ "required": ["componentId", "path"],
20
+ "properties": {
21
+ "componentId": {
22
+ "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json"
23
+ },
24
+ "path": {
25
+ "type": "string",
26
+ "description": "An RFC 6901 JSON Pointer to the list of component property objects in the A2-UI data model."
27
+ }
28
+ },
29
+ "additionalProperties": false
30
+ }
31
+ ]
32
+ }
@@ -21,7 +21,6 @@
21
21
  },
22
22
  "imageUrl": {
23
23
  "type": "string",
24
- "format": "uri",
25
24
  "description": "Product image URL."
26
25
  },
27
26
  "price": {
@@ -31,8 +30,14 @@
31
30
  "rating": {
32
31
  "type": "number",
33
32
  "minimum": 0,
34
- "maximum": 5,
35
33
  "description": "Product rating on a 0-5 scale."
34
+ },
35
+ "relatedDocuments": {
36
+ "type": "array",
37
+ "description": "Documents related to the product, in display order.",
38
+ "items": {
39
+ "$ref": "https://schema.thermidor.coveo.com/components/product-research-card.schema.json#/$defs/ProductResearchRelatedDocument"
40
+ }
36
41
  }
37
42
  },
38
43
  "additionalProperties": false
@@ -0,0 +1,9 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
4
+ "title": "ComponentId",
5
+ "type": "string",
6
+ "pattern": "^[a-z][a-z0-9-]*$",
7
+ "description": "A reference to the unique id of another component within the same surface. Thermidor node ids are kebab-case; the pattern narrows the A2-UI string type to that convention.",
8
+ "$comment": "A2-UI common_types.json#/$defs/ComponentId. Any property holding another component's id MUST use this type so validators treat it as a structural link rather than free text."
9
+ }
@@ -0,0 +1,16 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "$id": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
4
+ "title": "DataBinding",
5
+ "type": "object",
6
+ "required": ["path"],
7
+ "properties": {
8
+ "path": {
9
+ "type": "string",
10
+ "description": "An RFC 6901 JSON Pointer resolving a value in the A2-UI data model, at or beneath statePath(id)."
11
+ }
12
+ },
13
+ "additionalProperties": false,
14
+ "description": "A standard A2-UI Data_Binding object { \"path\": <RFC 6901 JSON Pointer> } pointing at or beneath statePath(id) = /state/<id>.",
15
+ "$comment": "A2-UI common_types.json#/$defs/DataBinding. A bindable prop references this so the Zod generator projects it as a Dynamic_Value union (literal or { path } binding)."
16
+ }
@@ -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
  }