@coveo/thermidor-schema 0.0.0 → 1.0.0-beta.10

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

@@ -0,0 +1,116 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/product-list.schema.json",
+  "title": "ProductList",
+  "description": "Renders an ordered list of commerce products from a decomposed commerce search surface. Read-only from the frontend: the backend is the sole source of truth for which products are displayed and in what order.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
+      "type": "string",
+      "const": "ProductList"
+    },
+    "products": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The ordered list of products, bound to /state/<id>/products via a { \"path\": ... } Data_Binding."
+    },
+    "state": {
+      "$ref": "#/$defs/ProductListState"
+    },
+    "actions": {
+      "type": "object",
+      "required": ["selectProducts", "productClick"],
+      "properties": {
+        "selectProducts": {
+          "$ref": "#/$defs/SelectProductsAction"
+        },
+        "productClick": {
+          "$ref": "#/$defs/ProductClickAction"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "ProductListState": {
+      "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"],
+      "properties": {
+        "products": {
+          "type": "array",
+          "description": "Ordered list of products to render.",
+          "items": {
+            "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "SelectProductsAction": {
+      "title": "selectProducts",
+      "description": "Persists the set of products selected by the shopper.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["productIds"],
+          "properties": {
+            "productIds": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "minLength": 1
+              }
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "ProductClickAction": {
+      "title": "productClick",
+      "description": "Records a shopper clicking a product result.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["productId", "position"],
+          "properties": {
+            "productId": {
+              "type": "string",
+              "minLength": 1
+            },
+            "name": {
+              "type": "string"
+            },
+            "price": {
+              "type": ["number", "null"]
+            },
+            "position": {
+              "type": "integer",
+              "minimum": 0
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    }
+  }
+}

package/schema/components/product-research-card.schema.json

@@ -0,0 +1,70 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/product-research-card.schema.json",
+  "title": "ProductResearchCard",
+  "description": "Renders a research card for a single known product: the product details alongside a short research summary and a list of concise product-education bullets. Read-only from the frontend: the backend is the sole source of truth for the product and the research content.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
+      "type": "string",
+      "const": "ProductResearchCard"
+    },
+    "product": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The researched product, bound to /state/<id>/product."
+    },
+    "summary": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The research summary, bound to /state/<id>/summary."
+    },
+    "bullets": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The product-education bullets, bound to /state/<id>/bullets."
+    },
+    "state": {
+      "$ref": "#/$defs/ProductResearchCardState"
+    },
+    "actions": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "ProductResearchCardState": {
+      "title": "ProductResearchCardState",
+      "description": "The researched product and its research content. 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": ["product", "summary", "bullets"],
+      "properties": {
+        "product": {
+          "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
+        },
+        "summary": {
+          "type": "string",
+          "minLength": 1,
+          "description": "Short research paragraph about the product."
+        },
+        "bullets": {
+          "type": "array",
+          "minItems": 1,
+          "description": "Concise product-education bullets, in display order. Producers currently emit at most 5 bullets.",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          }
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

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

@@ -0,0 +1,64 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/product-summary.schema.json",
+  "title": "ProductSummary",
+  "description": "Renders a single commerce product as a compact summary row (thumbnail, name, short description, price) for a category slot. Read-only from the frontend.",
+  "$comment": "Compact-row presentation is expressed by this component type on the A2-UI plane, never as data in AG-UI state.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
+      "type": "string",
+      "const": "ProductSummary"
+    },
+    "categoryLabel": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The product category label, bound to /state/<id>/categoryLabel."
+    },
+    "product": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The single summarized product, bound to /state/<id>/product."
+    },
+    "state": {
+      "$ref": "#/$defs/ProductSummaryState"
+    },
+    "actions": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "ProductSummaryState": {
+      "title": "ProductSummaryState",
+      "description": "The single product to summarize for a category slot. Owned exclusively by the backend; the frontend must not mutate this directly.",
+      "type": "object",
+      "required": ["categoryLabel", "product"],
+      "properties": {
+        "categoryLabel": {
+          "type": "string",
+          "description": "Display label of the product category this summary represents (e.g. 'Surfboard')."
+        },
+        "product": {
+          "description": "The single product to summarize, or null when no product is available for this slot.",
+          "oneOf": [
+            {
+              "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
+            },
+            {
+              "type": "null"
+            }
+          ]
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schema/components/query-suggestions.schema.json

@@ -0,0 +1,113 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/query-suggestions.schema.json",
+  "title": "QuerySuggestions",
+  "description": "Requests and renders backend-provided query completions and product suggestions for the active search input.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
+      "type": "string",
+      "const": "QuerySuggestions"
+    },
+    "query": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The input query these suggestions were requested for, bound to /state/<id>/query."
+    },
+    "completions": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The query completions, bound to /state/<id>/completions."
+    },
+    "products": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The product suggestions, bound to /state/<id>/products."
+    },
+    "state": {
+      "$ref": "#/$defs/QuerySuggestionsState"
+    },
+    "actions": {
+      "type": "object",
+      "required": ["fetchSuggestions"],
+      "properties": {
+        "fetchSuggestions": {
+          "$ref": "#/$defs/FetchSuggestionsAction"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "QuerySuggestionsState": {
+      "title": "QuerySuggestionsState",
+      "description": "The suggestion result for one query. Owned exclusively by the backend.",
+      "type": "object",
+      "required": ["query", "completions", "products"],
+      "properties": {
+        "query": {
+          "type": "string",
+          "description": "The input query for which these suggestions were requested."
+        },
+        "completions": {
+          "type": "array",
+          "description": "Query completions returned by the commerce service.",
+          "items": {
+            "$ref": "#/$defs/QueryCompletion"
+          }
+        },
+        "products": {
+          "type": "array",
+          "description": "Product suggestions returned by the commerce service.",
+          "items": {
+            "$ref": "https://schema.thermidor.coveo.com/definitions/product.schema.json"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "FetchSuggestionsAction": {
+      "title": "fetchSuggestions",
+      "description": "Fetches query completions and product suggestions for the current input.",
+      "allOf": [
+        {
+          "$ref": "https://schema.thermidor.coveo.com/base/action.schema.json"
+        }
+      ],
+      "properties": {
+        "payload": {
+          "type": "object",
+          "required": ["query"],
+          "properties": {
+            "query": {
+              "type": "string"
+            }
+          },
+          "additionalProperties": false
+        }
+      }
+    },
+    "QueryCompletion": {
+      "title": "QueryCompletion",
+      "description": "One query completion returned by the commerce service.",
+      "type": "object",
+      "required": ["expression"],
+      "properties": {
+        "expression": {
+          "type": "string",
+          "description": "The suggested query text."
+        },
+        "score": {
+          "type": "number",
+          "description": "The relevance score returned by the commerce service, when available."
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}

package/schema/components/query-summary.schema.json

@@ -0,0 +1,76 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://schema.thermidor.coveo.com/components/query-summary.schema.json",
+  "title": "QuerySummary",
+  "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.",
+  "$comment": "Carries its own backend-computed aggregate instead of reading sibling state (search box, pagination, product-list), so it has no cross-component coupling.",
+  "allOf": [
+    {
+      "$ref": "https://schema.thermidor.coveo.com/base/component.schema.json"
+    }
+  ],
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "component": {
+      "type": "string",
+      "const": "QuerySummary"
+    },
+    "query": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The current query string, bound to /state/<id>/query."
+    },
+    "firstIndex": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The 1-based index of the first result on the page, bound to /state/<id>/firstIndex."
+    },
+    "lastIndex": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The 1-based index of the last result on the page, bound to /state/<id>/lastIndex."
+    },
+    "totalEntries": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The total number of results, bound to /state/<id>/totalEntries."
+    },
+    "state": {
+      "$ref": "#/$defs/QuerySummaryState"
+    },
+    "actions": {
+      "type": "object",
+      "properties": {},
+      "additionalProperties": false
+    }
+  },
+  "additionalProperties": false,
+  "$defs": {
+    "QuerySummaryState": {
+      "title": "QuerySummaryState",
+      "description": "The backend-computed aggregate for the current result window. Owned exclusively by the backend; the frontend must not mutate this directly.",
+      "type": "object",
+      "required": ["query", "firstIndex", "lastIndex", "totalEntries"],
+      "properties": {
+        "query": {
+          "type": "string",
+          "description": "The current query string. May be empty when the surface has no active query."
+        },
+        "firstIndex": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The 1-based index of the first result on the current page."
+        },
+        "lastIndex": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The 1-based index of the last result on the current page."
+        },
+        "totalEntries": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The total number of results across all pages."
+        }
+      },
+      "additionalProperties": false
+    }
+  }
+}