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

package/schema/components/comparison-table.schema.json

@@ -2,7 +2,7 @@
   "$schema": "https://json-schema.org/draft/2020-12/schema",
   "$id": "https://schema.thermidor.coveo.com/components/comparison-table.schema.json",
   "title": "ComparisonTable",
-  "description": "Renders a tabular product comparison with attribute columns. Read-only: the product set and attributes are owned by the backend.",
+  "description": "Renders a tabular product comparison. A leaf component that owns its framing (heading and AI summary), the compared products, and the ordered attribute descriptors defining the comparison rows. Read-only: the product set, attributes, and framing are owned by the backend.",
   "allOf": [
     {
       "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
@@ -20,29 +20,45 @@
       "type": "object",
       "properties": {},
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
   "$defs": {
     "ComparisonTableState": {
       "title": "ComparisonTableState",
-      "description": "The comparison data to render. Contains a list of products with their attribute values and the attribute descriptors defining the columns.",
+      "description": "The comparison content owned by the backend: the table heading, the AI summary text, the compared products, and the ordered attribute descriptors defining the comparison rows.",
       "type": "object",
-      "required": [
-        "products",
-        "attributes"
-      ],
+      "required": ["products", "attributes", "heading", "summary"],
       "properties": {
+        "heading": {
+          "type": "string",
+          "description": "Title displayed above the comparison table."
+        },
+        "summary": {
+          "type": "string",
+          "description": "AI-generated summary text displayed below the comparison table."
+        },
         "products": {
           "type": "array",
-          "description": "Products to compare, each with attribute values keyed by attribute key.",
+          "description": "The compared products shown as columns of the comparison table.",
           "items": {
             "$ref": "https://schema.thermidor.coveo.com/definitions/comparison-product.schema.json"
           }
         },
         "attributes": {
           "type": "array",
-          "description": "Attribute descriptors defining the comparison columns.",
+          "description": "Attribute descriptors defining the comparison rows.",
           "items": {
             "$ref": "https://schema.thermidor.coveo.com/definitions/comparison-attribute.schema.json"
           }
@@ -51,4 +67,4 @@
       "additionalProperties": false
     }
   }
-}
+}

package/schema/components/component-contracts.schema.json

@@ -10,9 +10,6 @@
         {
           "$ref": "https://schema.thermidor.coveo.com/components/product-carousel.schema.json"
         },
-        {
-          "$ref": "https://schema.thermidor.coveo.com/components/cart.schema.json"
-        },
         {
           "$ref": "https://schema.thermidor.coveo.com/components/next-actions-bar.schema.json"
         },
@@ -26,13 +23,13 @@
           "$ref": "https://schema.thermidor.coveo.com/components/product-list.schema.json"
         },
         {
-          "$ref": "https://schema.thermidor.coveo.com/components/pagination.schema.json"
+          "$ref": "https://schema.thermidor.coveo.com/components/product-summary.schema.json"
         },
         {
-          "$ref": "https://schema.thermidor.coveo.com/components/sort.schema.json"
+          "$ref": "https://schema.thermidor.coveo.com/components/pagination.schema.json"
         },
         {
-          "$ref": "https://schema.thermidor.coveo.com/components/search-box.schema.json"
+          "$ref": "https://schema.thermidor.coveo.com/components/sort.schema.json"
         },
         {
           "$ref": "https://schema.thermidor.coveo.com/components/regular-facet.schema.json"
@@ -48,6 +45,18 @@
         },
         {
           "$ref": "https://schema.thermidor.coveo.com/components/facet-manager.schema.json"
+        },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/commerce-search.schema.json"
+        },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/layout-stack.schema.json"
+        },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/query-summary.schema.json"
+        },
+        {
+          "$ref": "https://schema.thermidor.coveo.com/components/page-size.schema.json"
         }
       ]
     }

package/schema/components/date-facet.schema.json

@@ -47,6 +47,17 @@
         }
       },
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -110,12 +121,7 @@
       "title": "DateFacetValue",
       "description": "A single selectable date range within a date facet.",
       "type": "object",
-      "required": [
-        "start",
-        "end",
-        "numberOfResults",
-        "state"
-      ],
+      "required": ["start", "end", "numberOfResults", "state"],
       "properties": {
         "start": {
           "type": "string",
@@ -141,11 +147,7 @@
       "title": "DateFacetCustomRange",
       "description": "A custom date range applied by the user, with its result count.",
       "type": "object",
-      "required": [
-        "start",
-        "end",
-        "numberOfResults"
-      ],
+      "required": ["start", "end", "numberOfResults"],
       "properties": {
         "start": {
           "type": "string",
@@ -174,10 +176,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "string",
@@ -203,10 +202,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "string",
@@ -241,10 +237,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "string",
@@ -278,4 +271,4 @@
       ]
     }
   }
-}
+}

package/schema/components/facet-manager.schema.json

@@ -20,28 +20,28 @@
       "type": "object",
       "properties": {},
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
   "$defs": {
     "FacetManagerState": {
       "title": "FacetManagerState",
-      "description": "The facet manager state. Holds the ordered list of facet component identifiers. Owned exclusively by the backend.",
+      "description": "The facet manager state. Facet ordering is expressed via the facet-manager A2-UI component node's 'children'; this state carries no facet-ordering data.",
       "type": "object",
-      "required": [
-        "facetIds"
-      ],
-      "properties": {
-        "facetIds": {
-          "type": "array",
-          "description": "Ordered facet component identifiers. Position (indexed from 0) determines the facet's rendering rank. Each identifier is expected to match the 'componentId' of a facet component registered in the catalog; referential integrity is enforced outside JSON Schema.",
-          "items": {
-            "type": "string",
-            "pattern": "^[a-z][a-z0-9-]*$"
-          }
-        }
-      },
+      "required": [],
+      "properties": {},
       "additionalProperties": false
     }
   }
-}
+}

package/schema/components/layout-stack.schema.json

@@ -0,0 +1,47 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/layout-stack.schema.json",
+  "title": "LayoutStack",
+  "description": "Generic layout container that stacks its children along a single axis. It carries no business data: its AG-UI state is empty. Layout is a presentation concern and travels as an A2-UI node prop ('direction': 'column' | 'row'), never as AG-UI state. Reused across surfaces (commerce search, knowledge search) to compose columns and rows from the A2-UI composition plane rather than hardcoding layout per parent renderer.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "componentType": {
+      "type": "string",
+      "const": "layout-stack"
+    },
+    "state": {
+      "$ref": "#/$defs/LayoutStackState"
+    },
+    "actions": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "LayoutStackState": {
+      "title": "LayoutStackState",
+      "description": "The layout-stack state. A layout container holds no business data, so its state is always the empty object. The stacking direction is presentation and travels as an A2-UI node prop, never as AG-UI state.",
+      "type": "object",
+      "required": [],
+      "properties": {},
+      "additionalProperties": false
+    }
+  }
+}

package/schema/components/next-actions-bar.schema.json

@@ -18,15 +18,24 @@
     },
     "actions": {
       "type": "object",
-      "required": [
-        "selectAction"
-      ],
+      "required": ["selectAction"],
       "properties": {
         "selectAction": {
           "$ref": "#/$defs/SelectActionAction"
         }
       },
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -36,9 +45,7 @@
       "description": "The list of suggested actions to render. Owned exclusively by the backend; the frontend must not mutate this directly.",
       "$comment": "This schema validates the runtime state value the backend pushes to the frontend.",
       "type": "object",
-      "required": [
-        "actions"
-      ],
+      "required": ["actions"],
       "properties": {
         "actions": {
           "type": "array",
@@ -61,10 +68,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "text",
-            "type"
-          ],
+          "required": ["text", "type"],
           "properties": {
             "text": {
               "type": "string",
@@ -72,10 +76,7 @@
             },
             "type": {
               "type": "string",
-              "enum": [
-                "followup",
-                "search"
-              ],
+              "enum": ["followup", "search"],
               "description": "The kind of action selected: \"followup\" or \"search\"."
             }
           },
@@ -84,4 +85,4 @@
       }
     }
   }
-}
+}

package/schema/components/numeric-facet.schema.json

@@ -47,6 +47,17 @@
         }
       },
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -116,12 +127,7 @@
       "title": "NumericFacetValue",
       "description": "A single numeric range value within a numeric facet.",
       "type": "object",
-      "required": [
-        "start",
-        "end",
-        "numberOfResults",
-        "state"
-      ],
+      "required": ["start", "end", "numberOfResults", "state"],
       "properties": {
         "start": {
           "type": "number",
@@ -147,11 +153,7 @@
       "title": "NumericFacetCustomRange",
       "description": "A custom numeric range applied by the user, with its result count.",
       "type": "object",
-      "required": [
-        "start",
-        "end",
-        "numberOfResults"
-      ],
+      "required": ["start", "end", "numberOfResults"],
       "properties": {
         "start": {
           "type": "number",
@@ -196,10 +198,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "number",
@@ -225,10 +224,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "number",
@@ -263,10 +259,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "start",
-            "end"
-          ],
+          "required": ["start", "end"],
           "properties": {
             "start": {
               "type": "number",
@@ -300,4 +293,4 @@
       ]
     }
   }
-}
+}

package/schema/components/page-size.schema.json

@@ -0,0 +1,81 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/page-size.schema.json",
+  "title": "PageSize",
+  "description": "A 'Products per page' selector for a search surface. Its own componentType lets it be mounted through the A2-UI tree (one renderer per componentType). It owns the current pageSize in its state and dispatches setPageSize; the backend applies the change to the surface's paging so the pagination component re-renders from the shared view.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "componentType": {
+      "type": "string",
+      "const": "page-size"
+    },
+    "state": {
+      "$ref": "#/$defs/PageSizeState"
+    },
+    "actions": {
+      "type": "object",
+      "required": ["setPageSize"],
+      "properties": {
+        "setPageSize": {
+          "$ref": "#/$defs/SetPageSizeAction"
+        }
+      },
+      "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "PageSizeState": {
+      "title": "PageSizeState",
+      "description": "The current page size. Owned exclusively by the backend. Kept as its own entry (keyed by this component's id) so the selector reads exactly the field it needs without depending on the pagination component's state shape.",
+      "type": "object",
+      "required": ["pageSize"],
+      "properties": {
+        "pageSize": {
+          "type": "integer",
+          "minimum": 1,
+          "description": "The number of items displayed per page."
+        }
+      },
+      "additionalProperties": false
+    },
+    "SetPageSizeAction": {
+      "title": "setPageSize",
+      "description": "Changes the number of items displayed per page.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["pageSize"],
+          "properties": {
+            "pageSize": {
+              "type": "integer",
+              "minimum": 1,
+              "description": "The number of items to display per page."
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    }
+  }
+}

package/schema/components/pagination.schema.json

@@ -18,10 +18,7 @@
     },
     "actions": {
       "type": "object",
-      "required": [
-        "selectPage",
-        "setPageSize"
-      ],
+      "required": ["selectPage", "setPageSize"],
       "properties": {
         "selectPage": {
           "$ref": "#/$defs/SelectPageAction"
@@ -31,6 +28,17 @@
         }
       },
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -39,12 +47,7 @@
       "title": "PaginationState",
       "description": "The current pagination state. Owned exclusively by the backend.",
       "type": "object",
-      "required": [
-        "page",
-        "pageSize",
-        "totalEntries",
-        "totalPages"
-      ],
+      "required": ["page", "pageSize", "totalEntries", "totalPages"],
       "properties": {
         "page": {
           "type": "integer",
@@ -80,9 +83,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "page"
-          ],
+          "required": ["page"],
           "properties": {
             "page": {
               "type": "integer",
@@ -105,9 +106,7 @@
       "properties": {
         "payload": {
           "type": "object",
-          "required": [
-            "pageSize"
-          ],
+          "required": ["pageSize"],
           "properties": {
             "pageSize": {
               "type": "integer",
@@ -120,4 +119,4 @@
       }
     }
   }
-}
+}

package/schema/components/product-carousel.schema.json

@@ -20,6 +20,17 @@
       "type": "object",
       "properties": {},
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -29,10 +40,7 @@
       "description": "The ordered list of products to render. Owned exclusively by the backend; the frontend must not mutate this directly.",
       "$comment": "This schema validates the runtime state value the backend pushes to the frontend.",
       "type": "object",
-      "required": [
-        "heading",
-        "products"
-      ],
+      "required": ["heading", "products"],
       "properties": {
         "heading": {
           "type": "string",
@@ -49,4 +57,4 @@
       "additionalProperties": false
     }
   }
-}
+}

package/schema/components/product-list.schema.json

@@ -20,6 +20,17 @@
       "type": "object",
       "properties": {},
       "additionalProperties": false
+    },
+    "children": {
+      "type": "array",
+      "items": {
+        "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
+      },
+      "maxItems": 1000,
+      "default": []
+    },
+    "child": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/child-ref.schema.json"
     }
   },
   "additionalProperties": false,
@@ -28,9 +39,7 @@
       "title": "ProductListState",
       "description": "The ordered list of products to render. Owned exclusively by the backend; the frontend must not mutate this directly.",
       "type": "object",
-      "required": [
-        "products"
-      ],
+      "required": ["products"],
       "properties": {
         "products": {
           "type": "array",
@@ -43,4 +52,4 @@
       "additionalProperties": false
     }
   }
-}
+}