@coveo/relay-event-types 0.0.0 → 6.24.1

package/package.json

@@ -1,11 +1,25 @@
 {
   "name": "@coveo/relay-event-types",
-  "version": "0.0.0",
-  "description": "",
+  "version": "6.24.1",
+  "description": "Typescript types for Coveo Events, intended to be used with the Relay package.",
+  "types": "./relay-event-types.d.ts",
+  "author": "Coveo",
+  "license": "Apache-2.0",
+  "keywords": [
+    "Coveo",
+    "analytics",
+    "relay",
+    "event",
+    "types"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coveo/analytics_schema.git"
+  },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "Apache-2.0"
+  }
 }

package/relay-event-types.d.ts

@@ -0,0 +1,161 @@
+/**
+ * Copyright (c) Coveo Solutions Inc. These types are automatically generated. Do not modify manually!
+ */
+
+/**
+ * List of supported currencies.
+ */
+type CurrencyCodeISO4217 = "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTC" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLF" | "CLP" | "CNH" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRU" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SRD" | "SSP" | "STD" | "STN" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VES" | "VND" | "VUV" | "WST" | "XAF" | "XAG" | "XAU" | "XCD" | "XDR" | "XOF" | "XPD" | "XPF" | "XPT" | "YER" | "ZAR" | "ZMW" | "ZWL";
+
+/**
+ * A UUID which cannot be null.
+ */
+type UuidNotNull = string;
+
+interface Base {
+}
+
+/**
+ * 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 final amount.
+     */
+    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.
+     */
+    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;
+    };
+}
+
+/**
+ * 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 {
+    /**
+     * A unique identifier identifying the query made to a search system.
+     */
+    searchUid: string;
+    position: number;
+    itemMetadata: ItemMetaData;
+}
+
+interface ItemMetaData {
+    /**
+     * The index field name used to uniquely identify the item.
+     */
+    uniqueFieldName: string;
+    /**
+     * The index field value used to uniquely identify the item.
+     */
+    uniqueFieldValue: string;
+    /**
+     * The title of the clicked item.
+     */
+    title?: string;
+    /**
+     * The author of the clicked item.
+     */
+    author?: string;
+    /**
+     * The URL identifying the clicked item.
+     */
+    url?: string;
+}
+
+/**
+ * Represents the Coveo Analytics Item View Event. This should be sent when landing on a page dedicated to an item.
+ */
+export interface ItemView extends Base {
+    itemMetadata: ItemMetaData;
+}
+
+interface Product {
+    /**
+     * A unique identifier for the product. The value must match the product id field configured in the catalog.
+     */
+    productId: string;
+    /**
+     * The product name.
+     */
+    name: string;
+    price: number;
+}
+
+interface ProductQuantity {
+    product: Product;
+    quantity: number;
+}
+
+/**
+ * Represents the Coveo Analytics Search Event. Send this schema exclusively when conducting A/B tests against a competitor's search solution.
+ */
+export interface Search extends Base {
+    /**
+     * A unique identifier identifying the query made to a search system.
+     */
+    searchUid: string;
+    queryText: string;
+    numberOfResults?: number;
+    responseTimeInMs?: number;
+}
+
+interface User {
+    /**
+     * User ID serves as a unique identifier for the user. As the user performs actions, this is enriched on the resulting events. For authenticated users, this typically appears as their email address, making it easily readable.
+     */
+    id: string;
+}
+
+/**
+ * Represents the Coveo Analytics User Login Event. This should be sent when a user logs in to a website.
+ */
+export interface UserLogin extends Base {
+    user: User;
+}
+