@coveo/relay-event-types 16.2.3 → 17.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "16.2.3",
+  "version": "17.0.1",
   "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
   "types": "./relay-event-types.d.ts",
   "author": "Coveo",

package/relay-event-types.d.ts

@@ -83,13 +83,32 @@ interface Product {
 }
 
 interface ProductQuantity {
-    product: Product;
+    product: ProductVariant;
     /**
      * Purchased product quantity. Can be decimal. Must be greater than 0.
      */
     quantity: number;
 }
 
+interface ProductVariant {
+    /**
+     * The unique identifier of the product. The value must match exactly, including case, the values of the link:{site-baseurl}/n73f0502#define-a-unique-product-identifier[product identifier] and `permanentid` fields configured in the catalog.
+     */
+    productId: string;
+    /**
+     * The product name.
+     */
+    name: string;
+    /**
+     * The product price. If the price is not available, set the value to 0.
+     */
+    price: number;
+    /**
+     * The unique identifier for the specific variant of the product, if applicable. The identifier should correspond to a variant in your Coveo catalog.
+     */
+    variantId?: string;
+}
+
 /**
  * A support ticket.
  */
@@ -213,7 +232,7 @@ export namespace Ec {
          */
         action: "add" | "remove";
         currency: CurrencyCodeISO4217;
-        product: Product;
+        product: ProductVariant;
         /**
          * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
          */