@coveo/thermidor-schema 1.0.0-beta.2 → 1.0.0-beta.21

package/schema/components/sort.schema.json

@@ -9,18 +9,27 @@
     }
   ],
   "properties": {
-    "componentType": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
       "type": "string",
-      "const": "sort"
+      "const": "Sort"
+    },
+    "appliedSort": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The currently applied sort criterion, bound to /state/<id>/appliedSort."
+    },
+    "availableSorts": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The available sort options, bound to /state/<id>/availableSorts."
     },
     "state": {
       "$ref": "#/$defs/SortState"
     },
     "actions": {
       "type": "object",
-      "required": [
-        "selectSort"
-      ],
+      "required": ["selectSort"],
       "properties": {
         "selectSort": {
           "$ref": "#/$defs/SelectSortAction"
@@ -35,10 +44,7 @@
       "title": "SortState",
       "description": "The current sort state. Owned exclusively by the backend.",
       "type": "object",
-      "required": [
-        "appliedSort",
-        "availableSorts"
-      ],
+      "required": ["appliedSort", "availableSorts"],
       "properties": {
         "appliedSort": {
           "$ref": "#/$defs/SortCriterion",
@@ -58,10 +64,7 @@
       "title": "SortCriterion",
       "description": "A sort criterion consisting of a named criteria and field definitions.",
       "type": "object",
-      "required": [
-        "sortCriteria",
-        "fields"
-      ],
+      "required": ["sortCriteria", "fields"],
       "properties": {
         "sortCriteria": {
           "type": "string",
@@ -85,10 +88,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "sortCriteria",
-            "fields"
-          ],
+          "required": ["sortCriteria", "fields"],
           "properties": {
             "sortCriteria": {
               "type": "string",
@@ -104,4 +104,4 @@
       }
     }
   }
-}
+}

package/schema/definitions/action-item.schema.json

@@ -2,19 +2,16 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/definitions/action-item.schema.json",
   "title": "ActionItem",
-  "description": "A suggested action the assistant offers the user, such as a follow-up question or a search query.",
-  "type": "object",
-  "required": ["text", "type"],
-  "properties": {
-    "text": {
-      "type": "string",
-      "description": "The display text of the action shown to the user."
+  "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.",
+  "oneOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/followup-action-item.schema.json"
     },
-    "type": {
-      "type": "string",
-      "enum": ["followup", "search"],
-      "description": "The kind of action: \"followup\" triggers a conversational follow-up, \"search\" triggers a standalone search."
+    {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/search-action-item.schema.json"
+    },
+    {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/search-option-action-item.schema.json"
     }
-  },
-  "additionalProperties": false
+  ]
 }

package/schema/definitions/bundle-tier.schema.json

@@ -4,7 +4,7 @@
   "title": "BundleTier",
   "description": "A tier in a product bundle, grouping product slots by price/quality level.",
   "type": "object",
-  "required": ["label", "description", "slots"],
+  "required": ["label", "description", "total", "slots"],
   "properties": {
     "label": {
       "type": "string",
@@ -14,6 +14,11 @@
       "type": "string",
       "description": "Brief description of what the tier includes."
     },
+    "total": {
+      "type": "number",
+      "minimum": 0,
+      "description": "Backend-computed total price for this tier's slots, in the request currency."
+    },
     "slots": {
       "type": "array",
       "description": "Product category slots within this tier.",
@@ -27,15 +32,15 @@
     "BundleSlot": {
       "title": "BundleSlot",
       "type": "object",
-      "required": ["categoryLabel", "surfaceRef"],
+      "required": ["categoryLabel", "childId"],
       "properties": {
         "categoryLabel": {
           "type": "string",
           "description": "Display name of the product category for this slot."
         },
-        "surfaceRef": {
+        "childId": {
           "type": "string",
-          "description": "Surface ID where this slot's products are rendered via a ProductCarousel."
+          "description": "Id of the bundle-display child product-list node that renders this slot's products. Associates the slot with its child on the A2-UI composition plane; the renderer mounts the child via children(id)."
         }
       },
       "additionalProperties": false

package/schema/definitions/child-list.schema.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/child-list.schema.json",
+  "title": "ChildList",
+  "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.",
+  "$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.",
+  "oneOf": [
+    {
+      "type": "array",
+      "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.",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json"
+      }
+    },
+    {
+      "type": "object",
+      "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.",
+      "required": ["componentId", "path"],
+      "properties": {
+        "componentId": {
+          "$ref": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json"
+        },
+        "path": {
+          "type": "string",
+          "description": "An RFC 6901 JSON Pointer to the list of component property objects in the A2-UI data model."
+        }
+      },
+      "additionalProperties": false
+    }
+  ]
+}

package/schema/definitions/comparison-attribute.schema.json

@@ -2,13 +2,13 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/definitions/comparison-attribute.schema.json",
   "title": "ComparisonAttribute",
-  "description": "Defines an attribute (column) used in a ComparisonTable. The key is the programmatic identifier that maps to values in ComparisonProduct.values, and label is the human-readable column heading.",
+  "description": "Defines an attribute (row) used in a ComparisonTable. The key is the programmatic identifier that maps to values in each compared product's values record, and label is the human-readable row heading.",
   "type": "object",
   "required": ["key", "label"],
   "properties": {
     "key": {
       "type": "string",
-      "description": "The programmatic identifier for this attribute, used as a key in ComparisonProduct.values."
+      "description": "The programmatic identifier for this attribute, used as a key in each compared product's values record."
     },
     "label": {
       "type": "string",

package/schema/definitions/comparison-product.schema.json

@@ -2,9 +2,9 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/definitions/comparison-product.schema.json",
   "title": "ComparisonProduct",
-  "description": "A product entry in a comparison table, containing required identifiers and a values record mapping attribute keys to display strings.",
+  "description": "A product entry (column) in a ComparisonTable, containing required identifiers and a values record mapping attribute keys to display strings.",
   "type": "object",
-  "required": ["productId", "name", "values"],
+  "required": ["productId", "name"],
   "properties": {
     "productId": {
       "type": "string",
@@ -21,7 +21,6 @@
     },
     "imageUrl": {
       "type": "string",
-      "format": "uri",
       "description": "Product image URL."
     },
     "price": {
@@ -31,7 +30,6 @@
     "rating": {
       "type": "number",
       "minimum": 0,
-      "maximum": 5,
       "description": "Product rating on a 0-5 scale."
     }
   },

package/schema/definitions/component-id.schema.json

@@ -0,0 +1,9 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/component-id.schema.json",
+  "title": "ComponentId",
+  "type": "string",
+  "pattern": "^[a-z][a-z0-9-]*$",
+  "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.",
+  "$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."
+}

package/schema/definitions/data-binding.schema.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+  "title": "DataBinding",
+  "type": "object",
+  "required": ["path"],
+  "properties": {
+    "path": {
+      "type": "string",
+      "description": "An RFC 6901 JSON Pointer resolving a value in the A2-UI data model, at or beneath statePath(id)."
+    }
+  },
+  "additionalProperties": false,
+  "description": "A standard A2-UI Data_Binding object { \"path\": <RFC 6901 JSON Pointer> } pointing at or beneath statePath(id) = /state/<id>.",
+  "$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)."
+}

package/schema/definitions/followup-action-item.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/followup-action-item.schema.json",
+  "title": "FollowupActionItem",
+  "description": "An ActionItem that triggers a conversational follow-up.",
+  "type": "object",
+  "required": ["text", "type"],
+  "properties": {
+    "text": {
+      "type": "string",
+      "description": "The display text of the action shown to the user."
+    },
+    "type": {
+      "type": "string",
+      "const": "followup",
+      "description": "The ActionItem discriminator."
+    }
+  },
+  "additionalProperties": false
+}

package/schema/definitions/product.schema.json

@@ -41,12 +41,12 @@
     },
     "ec_images": {
       "type": "array",
-      "items": {"type": "string", "format": "uri"},
+      "items": {"type": "string"},
       "description": "Full-resolution image URLs, in display order."
     },
     "ec_thumbnails": {
       "type": "array",
-      "items": {"type": "string", "format": "uri"},
+      "items": {"type": "string"},
       "description": "Thumbnail image URLs, in display order."
     },
     "ec_in_stock": {
@@ -56,7 +56,6 @@
     "ec_rating": {
       "type": ["number", "null"],
       "minimum": 0,
-      "maximum": 5,
       "description": "Average customer rating on a 0-5 scale. Null when no ratings exist."
     },
     "ec_color": {
@@ -73,9 +72,7 @@
     },
     "clickUri": {
       "type": "string",
-      "format": "uri",
-      "$comment": "TODO(quicktype): Restore format: uri-reference when quicktype-core preserves that JSON Schema format through its TypeGraph.",
-      "description": "Absolute URL to the product detail page."
+      "description": "URL of the product detail page."
     },
     "additionalFields": {
       "type": "object",

package/schema/definitions/search-action-item.schema.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/search-action-item.schema.json",
+  "title": "SearchActionItem",
+  "description": "An ActionItem that triggers a standalone search.",
+  "type": "object",
+  "required": ["text", "type"],
+  "properties": {
+    "text": {
+      "type": "string",
+      "description": "The display text of the action shown to the user."
+    },
+    "type": {
+      "type": "string",
+      "const": "search",
+      "description": "The ActionItem discriminator."
+    }
+  },
+  "additionalProperties": false
+}

package/schema/definitions/search-option-action-item.schema.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/definitions/search-option-action-item.schema.json",
+  "title": "SearchOptionActionItem",
+  "description": "An ActionItem that opens a search the backend saved behind it. Selecting it dispatches selectSearchOption with its optionId.",
+  "type": "object",
+  "required": ["text", "type", "optionId"],
+  "properties": {
+    "text": {
+      "type": "string",
+      "description": "The display text of the action shown to the user."
+    },
+    "type": {
+      "type": "string",
+      "const": "searchOption",
+      "description": "The ActionItem discriminator."
+    },
+    "optionId": {
+      "type": "string",
+      "minLength": 1,
+      "description": "Opaque identifier of the search the backend saved behind the action. Set only by the backend; the frontend sends it back unchanged in the selectSearchOption payload so the backend can run that search."
+    }
+  },
+  "additionalProperties": false
+}

package/schema/components/search-box.schema.json

@@ -1,74 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://schema.thermidor.coveo.com/components/search-box.schema.json",
-  "title": "SearchBox",
-  "description": "Provides a search input for a commerce search surface. Renders the current query and dispatches submitQuery when the user submits a new query.",
-  "allOf": [
-    {
-      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
-    }
-  ],
-  "properties": {
-    "componentType": {
-      "type": "string",
-      "const": "search-box"
-    },
-    "state": {
-      "$ref": "#/$defs/SearchBoxState"
-    },
-    "actions": {
-      "type": "object",
-      "required": [
-        "submitQuery"
-      ],
-      "properties": {
-        "submitQuery": {
-          "$ref": "#/$defs/SubmitQueryAction"
-        }
-      },
-      "additionalProperties": false
-    }
-  },
-  "additionalProperties": false,
-  "$defs": {
-    "SearchBoxState": {
-      "title": "SearchBoxState",
-      "description": "The current search box state. Owned exclusively by the backend.",
-      "type": "object",
-      "required": [
-        "query"
-      ],
-      "properties": {
-        "query": {
-          "type": "string",
-          "description": "The current search query string."
-        }
-      },
-      "additionalProperties": false
-    },
-    "SubmitQueryAction": {
-      "title": "submitQuery",
-      "description": "Submits a new search query.",
-      "allOf": [
-        {
-          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
-        }
-      ],
-      "properties": {
-        "payload": {
-          "type": "object",
-          "required": [
-            "query"
-          ],
-          "properties": {
-            "query": {
-              "type": "string",
-              "description": "The query string to submit."
-            }
-          },
-          "additionalProperties": false
-        }
-      }
-    }
-  }
-}

package/schema/definitions/cart-item.schema.json

@@ -1,29 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://schema.thermidor.coveo.com/definitions/cart-item.schema.json",
-  "title": "CartItem",
-  "description": "A single line item in the cart, as exposed by the CartController state and used in cart action payloads.",
-  "type": "object",
-  "required": ["productId", "name", "price", "quantity"],
-  "properties": {
-    "productId": {
-      "type": "string",
-      "description": "The unique product identifier. Corresponds to the Product's permanentid field."
-    },
-    "name": {
-      "type": "string",
-      "description": "The display name of the product at the time it was added to the cart."
-    },
-    "price": {
-      "type": "number",
-      "minimum": 0,
-      "description": "The non-negative unit price at the time the item was added, in the session currency."
-    },
-    "quantity": {
-      "type": "integer",
-      "minimum": 1,
-      "description": "The number of units of this product in the cart."
-    }
-  },
-  "additionalProperties": false
-}