@coveo/relay-event-types 7.5.1 → 7.5.3

package/package.json

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

@@ -15,6 +15,18 @@ type UuidNotNull = string;
 interface Base {
 }
 
+interface BaseItemClick extends Base {
+    /**
+     * A unique identifier identifying the query made to a search system.
+     */
+    searchUid: string;
+    /**
+     * Indicates the clicked item's 1-based position within the returned results.
+     */
+    position: number;
+    itemMetadata: ItemMetaData;
+}
+
 /**
  * A document suggestion.
  */
@@ -38,17 +50,11 @@ 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 {
+export interface ItemClick extends BaseItemClick {
     /**
      * The type of operation that triggered this event.
      */
     actionCause?: "preview" | "open";
-    /**
-     * A unique identifier identifying the query made to a search system.
-     */
-    searchUid: string;
-    position: number;
-    itemMetadata: ItemMetaData;
 }
 
 interface ItemMetaData {
@@ -321,4 +327,73 @@ export namespace Ec {
             revenue: number;
         };
     }
+}
+
+export namespace InsightPanel {
+    /**
+     * The context in which the insight panel is used. Generally, this will be a support case.
+     */
+    interface Context {
+        /**
+         * The target's unique id in the original source system. (Example, a Case's id in Salesforce).
+         */
+        targetId: string;
+        /**
+         * The target's type in the original source system. (Example: 'Case').
+         */
+        targetType: "Case";
+    }
+    
+    /**
+     * Insight Panel event signaling that the agent created an article from a case.
+     */
+    export interface CreateArticle extends Base {
+        /**
+         * The context in which the insight panel is used.
+         */
+        context: Context;
+        /**
+         * The type of article the agent started to create.
+         */
+        articleType?: string;
+    }
+    
+    /**
+     * Insight Panel event signaling that an item was detached from a record
+     */
+    export interface DetachItem extends Base {
+        /**
+         * The context in which the insight panel is used.
+         */
+        context: Context;
+        itemMetadata: ItemMetaData;
+    }
+    
+    /**
+     * Insight Panel event signaling that the agent expanded the panel.
+     */
+    export interface ExpandToFullUI extends Base {
+        /**
+         * The context in which the insight panel is used.
+         */
+        context: Context;
+    }
+    
+    /**
+     * Interaction on a search item inside an insight panel.
+     */
+    export interface ItemAction extends BaseItemClick {
+        /**
+         * How the user interacted with the item.
+         */
+        action: "attach" | "open" | "copyToClipboard" | "sendEmail" | "postToFeed";
+        /**
+         * The context in which the insight panel is used.
+         */
+        context: Context;
+        /**
+         * The id of the item in the source repository (ex: A knowledge article record ID in Saleforce).
+         */
+        sourceEntityId?: string;
+    }
 }