@coveo/thermidor-schema 1.0.0-beta.24 → 1.0.0-beta.26
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 +685 -0
- package/dist/generated/schemas.js +127 -0
- package/dist/generated/zod3/index.d.ts +2 -2
- package/dist/generated/zod3/index.js +1 -1
- package/dist/generated/zod3/schemas.d.ts +10115 -3820
- package/dist/generated/zod3/schemas.js +127 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +1 -1
- package/package.json +1 -1
- package/schema/component-contracts.schema.json +3 -0
- package/schema/components/breadbox.schema.json +82 -0
- package/schema/definitions/badge-placement.schema.json +22 -0
- package/schema/definitions/badge.schema.json +27 -0
- package/schema/definitions/breadbox-date-range-facet.schema.json +56 -0
- package/schema/definitions/breadbox-deselect-date-range.schema.json +28 -0
- package/schema/definitions/breadbox-deselect-hierarchical-path.schema.json +28 -0
- package/schema/definitions/breadbox-deselect-numerical-range.schema.json +28 -0
- package/schema/definitions/breadbox-deselect-payload.schema.json +20 -0
- package/schema/definitions/breadbox-deselect-regular-value.schema.json +25 -0
- package/schema/definitions/breadbox-facet.schema.json +20 -0
- package/schema/definitions/breadbox-hierarchical-facet.schema.json +37 -0
- package/schema/definitions/breadbox-numerical-range-facet.schema.json +56 -0
- package/schema/definitions/breadbox-regular-facet.schema.json +59 -0
- package/schema/definitions/product.schema.json +7 -0
|
@@ -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 and excluded 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", "excluded"],
|
|
53
|
+
"description": "Whether the value is selected or excluded."
|
|
54
|
+
}
|
|
55
|
+
},
|
|
56
|
+
"additionalProperties": false
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
@@ -79,6 +79,13 @@
|
|
|
79
79
|
"description": "Catch-all bag for any extra fields returned by the index that are not part of the standard schema.",
|
|
80
80
|
"additionalProperties": true
|
|
81
81
|
},
|
|
82
|
+
"badgePlacements": {
|
|
83
|
+
"type": "array",
|
|
84
|
+
"items": {
|
|
85
|
+
"$ref": "https://schema.thermidor.coveo.com/definitions/badge-placement.schema.json"
|
|
86
|
+
},
|
|
87
|
+
"description": "Badges the product earned, grouped by badge placement. Absent or empty when the product has no badges."
|
|
88
|
+
},
|
|
82
89
|
"children": {
|
|
83
90
|
"type": "array",
|
|
84
91
|
"items": {"$ref": "#"},
|