@coveo/relay-event-types 17.1.0 → 18.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "17.1.0",
+  "version": "18.0.2",
   "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

@@ -17,7 +17,7 @@ interface Base {
 
 interface BaseItemClick extends Base {
     /**
-     * A unique identifier for the response of a service which returned the list of relevant items. E.g. a searchId or similar.
+     * A unique identifier for the response of a service which returned the list of relevant items. For example, a searchId or similar.
      */
     responseId?: UuidNotNull;
     /**
@@ -32,7 +32,7 @@ interface BaseItemClick extends Base {
 }
 
 /**
- * The itemClick event is emitted when sending data related to a user's click on an item returned by Coveo.
+ * The itemClick event is emitted when a user clicks an item returned by Coveo.
  */
 export interface ItemClick extends BaseItemClick {
 }
@@ -80,35 +80,20 @@ interface Product {
      * The product price. If the price is not available, set the value to 0.
      */
     price: number;
+    /**
+     * The (optional) unique identifier for the specific variant of the product. The identifier should correspond to a variant in your Coveo catalog.
+     */
+    variantId?: string;
 }
 
 interface ProductQuantity {
-    product: ProductVariant;
+    product: Product;
     /**
      * 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.
  */
@@ -154,7 +139,7 @@ export namespace CaseAssist {
     }
     
     /**
-     * The caseAssist.documentSuggestionClick event is emitted when a user clicks on a Case Assist document suggestion.
+     * The caseAssist.documentSuggestionClick event is emitted when a user clicks a Case Assist document suggestion.
      */
     export interface DocumentSuggestionClick extends Base {
         /**
@@ -232,7 +217,7 @@ export namespace Ec {
          */
         action: "add" | "remove";
         currency: CurrencyCodeISO4217;
-        product: ProductVariant;
+        product: Product;
         /**
          * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
          */
@@ -345,7 +330,7 @@ export namespace InsightPanel {
          */
         context: Context;
         /**
-         * The id of the item in the source repository (ex: A knowledge article record ID in Saleforce).
+         * The id of the item in the source repository (ex: A knowledge article record ID in Salesforce).
          */
         sourceEntityId?: string;
     }