@coveo/thermidor-schema 1.0.0-beta.26 → 1.0.0-beta.27

package/dist/generated/zod3/schemas.js

@@ -194,10 +194,11 @@ export const ProductSummaryStateSchema = z.strictObject({
     product: z.union([ProductSchema, z.null()]),
 });
 export const ProductResearchCardActionsSchema = z.strictObject({});
-export const ProductResearchCardStateSchema = z.strictObject({
-    bullets: z.array(z.string().min(1)).min(1),
-    product: ProductSchema,
-    summary: z.string().min(1),
+export const ProductResearchRelatedDocumentSchema = z.strictObject({
+    clickUri: z.string().optional(),
+    filetype: z.string().optional(),
+    size: z.number().int().min(0).optional(),
+    title: z.string(),
 });
 export const SelectPagePayloadSchema = z.strictObject({
     page: z.number().int().min(0),
@@ -433,11 +434,11 @@ export const ProductSummarySchema = z.looseObject({
     id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
     state: ProductSummaryStateSchema.optional(),
 });
-export const ProductResearchCardSchema = z.looseObject({
-    actions: ProductResearchCardActionsSchema.optional(),
-    component: z.literal('ProductResearchCard'),
-    id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
-    state: ProductResearchCardStateSchema.optional(),
+export const ProductResearchCardStateSchema = z.strictObject({
+    bullets: z.array(z.string().min(1)).min(1),
+    product: ProductSchema,
+    relatedDocuments: z.array(ProductResearchRelatedDocumentSchema).optional(),
+    summary: z.string().min(1),
 });
 export const SelectPageSchema = z.strictObject({
     payload: SelectPagePayloadSchema,
@@ -588,6 +589,12 @@ export const ProductListActionsSchema = z.strictObject({
     productClick: ProductClickSchema,
     selectProducts: SelectProductsSchema,
 });
+export const ProductResearchCardSchema = z.looseObject({
+    actions: ProductResearchCardActionsSchema.optional(),
+    component: z.literal('ProductResearchCard'),
+    id: z.string().min(1).regex(new RegExp('^[a-z][a-z0-9-]*$')),
+    state: ProductResearchCardStateSchema.optional(),
+});
 export const PaginationActionsSchema = z.strictObject({
     selectPage: SelectPageSchema,
     setPageSize: PurpleSetPageSizeSchema,
@@ -948,6 +955,13 @@ export const ProductResearchCardPropsSchema = z.object({
     ]),
     summary: DynamicStringSchema,
     bullets: DynamicStringListSchema,
+    relatedDocuments: z
+        .union([
+        ProductResearchCardStateSchema.shape['relatedDocuments'],
+        DataBindingSchema,
+        FunctionCallSchema,
+    ])
+        .optional(),
 });
 export const ProductSummaryPropsSchema = z.object({
     categoryLabel: DynamicStringSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/thermidor-schema",
-  "version": "1.0.0-beta.26",
+  "version": "1.0.0-beta.27",
   "description": "Zod and TypeScript projections of the Thermidor JSON Schema contract.",
   "homepage": "https://github.com/coveo-platform/thermidor-schema#readme",
   "bugs": {

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

@@ -28,6 +28,10 @@
       "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
       "description": "The product-education bullets, bound to /state/<id>/bullets."
     },
+    "relatedDocuments": {
+      "$ref": "https://schema.thermidor.coveo.com/definitions/data-binding.schema.json",
+      "description": "The related documents, bound to /state/<id>/relatedDocuments."
+    },
     "state": {
       "$ref": "#/$defs/ProductResearchCardState"
     },
@@ -41,7 +45,7 @@
   "$defs": {
     "ProductResearchCardState": {
       "title": "ProductResearchCardState",
-      "description": "The researched product and its research content. Owned exclusively by the backend; the frontend must not mutate this directly.",
+      "description": "The researched product, its research content, and related documents. 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"],
@@ -62,6 +66,39 @@
             "type": "string",
             "minLength": 1
           }
+        },
+        "relatedDocuments": {
+          "type": "array",
+          "description": "Documents related to the researched product, in display order.",
+          "items": {
+            "$ref": "#/$defs/ProductResearchRelatedDocument"
+          }
+        }
+      },
+      "additionalProperties": false
+    },
+    "ProductResearchRelatedDocument": {
+      "title": "ProductResearchRelatedDocument",
+      "description": "A document related to the researched product.",
+      "type": "object",
+      "required": ["title"],
+      "properties": {
+        "title": {
+          "type": "string",
+          "description": "The display title of the document."
+        },
+        "clickUri": {
+          "type": "string",
+          "description": "The URI used to open the document."
+        },
+        "size": {
+          "type": "integer",
+          "minimum": 0,
+          "description": "The document size in bytes."
+        },
+        "filetype": {
+          "type": "string",
+          "description": "The document file type."
         }
       },
       "additionalProperties": false