@coveo/relay-event-types 7.2.0 → 7.4.0

package/package.json

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

@@ -23,64 +23,6 @@ interface DocumentSuggestion {
     responseId: string;
 }
 
-/**
- * The ecCartAction event is emitted when a user adds or removes a product from the cart or changes a product's quantity.
- */
-export interface EcCartAction extends Base {
-    /**
-     * Specifies the action. Use "add" to increase quantity and "remove" to decrease it.
-     */
-    action: "add" | "remove";
-    currency: CurrencyCodeISO4217;
-    product: Product;
-    /**
-     * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
-     */
-    quantity: number;
-}
-
-/**
- * The ecProductClick event is emitted when a user clicks a product, be it on a search page, listing page, or recommendation carousel.
- */
-export interface EcProductClick extends Base {
-    /**
-     * Indicates the product's position using a 1-based index. Maximum possible value is 32767.
-     */
-    position: number;
-    /**
-     * Response ID linked to the commerce API request that returned the clicked item.
-     */
-    responseId: UuidNotNull;
-    currency: CurrencyCodeISO4217;
-    product: Product;
-}
-
-/**
- * The ecProductView event is emitted when a user explores a product's details on a Product Detail Page (PDP) or previews the item in a modal from a Product Listing Page (PLP).
- */
-export interface EcProductView extends Base {
-    currency: CurrencyCodeISO4217;
-    product: Product;
-}
-
-/**
- * The ecPurchase event is emitted when the user completes a purchase.
- */
-export interface EcPurchase extends Base {
-    currency: CurrencyCodeISO4217;
-    products: ProductQuantity[];
-    transaction: {
-        /**
-         * The transaction ID. You can use it to cross-reference any orders you've exported from Coveo against records in your own system.
-         */
-        id: string;
-        /**
-         * Total revenue from the transaction, including tax, shipping, and discounts.
-         */
-        revenue: number;
-    };
-}
-
 interface Feedback {
     liked: boolean;
     /**
@@ -97,6 +39,10 @@ interface Feedback {
  * Represents the Coveo Analytics Item Click Event. Use this schema when sending data related to a user's click on an item returned by Coveo.
  */
 export interface ItemClick extends Base {
+    /**
+     * The type of operation that triggered this event.
+     */
+    actionCause?: "preview" | "open";
     /**
      * A unique identifier identifying the query made to a search system.
      */
@@ -315,4 +261,64 @@ export namespace CaseAssist {
          */
         fieldValue: string;
     }
+}
+
+export namespace Ec {
+    /**
+     * The ec.cartAction event is emitted when a user adds or removes a product from the cart or changes a product's quantity.
+     */
+    export interface CartAction extends Base {
+        /**
+         * Specifies the action. Use "add" to increase quantity and "remove" to decrease it.
+         */
+        action: "add" | "remove";
+        currency: CurrencyCodeISO4217;
+        product: Product;
+        /**
+         * Represents the change in product quantity, not the total quantity. Can be decimal. Must be greater than 0.
+         */
+        quantity: number;
+    }
+    
+    /**
+     * The ec.productClick event is emitted when a user clicks a product, be it on a search page, listing page, or recommendation carousel.
+     */
+    export interface ProductClick extends Base {
+        /**
+         * Indicates the product's position using a 1-based index. Maximum possible value is 32767.
+         */
+        position: number;
+        /**
+         * Response ID linked to the commerce API request that returned the clicked item.
+         */
+        responseId: UuidNotNull;
+        currency: CurrencyCodeISO4217;
+        product: Product;
+    }
+    
+    /**
+     * The ec.productView event is emitted when a user explores a product's details on a Product Detail Page (PDP) or previews the item in a modal from a Product Listing Page (PLP).
+     */
+    export interface ProductView extends Base {
+        currency: CurrencyCodeISO4217;
+        product: Product;
+    }
+    
+    /**
+     * The ec.purchase event is emitted when the user completes a purchase.
+     */
+    export interface Purchase extends Base {
+        currency: CurrencyCodeISO4217;
+        products: ProductQuantity[];
+        transaction: {
+            /**
+             * The transaction ID. You can use it to cross-reference any orders you've exported from Coveo against records in your own system.
+             */
+            id: string;
+            /**
+             * Total revenue from the transaction, including tax, shipping, and discounts.
+             */
+            revenue: number;
+        };
+    }
 }