@coveo/relay-event-types 13.1.2 → 14.0.0

package/package.json

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

@@ -334,23 +334,37 @@ export namespace Rga {
      */
     export interface AnswerAction extends Base {
         /**
-         * The id of the response associated with the service that delivered the answer.
+         * The unique identifier of the generated answer.
          */
-        responseId: string;
+        answerId: UuidNotNull;
         /**
          * The action taken on the answer.
          */
         action: "copyToClipboard" | "hide" | "show" | "expand" | "collapse" | "like" | "dislike";
     }
     
+    /**
+     * Event to emit when a generated answer has been fully received.
+     */
+    export interface AnswerReceived extends Base {
+        /**
+         * The unique identifier of the generated answer.
+         */
+        answerId: UuidNotNull;
+        /**
+         * Indicates if the answer was generated or not.
+         */
+        answerGenerated: boolean;
+    }
+    
     /**
      * Event to emit when a generated answer citation item has been clicked.
      */
     export interface CitationClick extends Base {
         /**
-         * The id of the response associated with the service that delivered the answer.
+         * The unique identifier of the generated answer.
          */
-        responseId: string;
+        answerId: UuidNotNull;
         /**
          * The citation id. This value needs to match the unique identifier of the answer's citation.
          */
@@ -363,9 +377,9 @@ export namespace Rga {
      */
     export interface CitationHover extends Base {
         /**
-         * The id of the response associated with the service that delivered the answer.
+         * The unique identifier of the generated answer.
          */
-        responseId: string;
+        answerId: UuidNotNull;
         /**
          * The citation id. This value needs to match the unique identifier of the answer's citation.
          */
@@ -378,17 +392,17 @@ export namespace Rga {
     }
     
     /**
-     * Event to emit when a generated answer stream has ended.
+     * Event to emit to signal that an particular answer is linked to another API response (ex: a search).
      */
-    export interface StreamEnd extends Base {
+    export interface ResponseLinked extends Base {
         /**
-         * The id of the response associated with the service that delivered the answer.
+         * The unique identifier of the generated answer.
          */
-        responseId: string;
+        answerId: UuidNotNull;
         /**
-         * Indicates if the answer was generated or not.
+         * The unique identifier of the response (ex: a search) that needs to be linked to the answer.
          */
-        answerGenerated: boolean;
+        responseId: UuidNotNull;
     }
     
     /**
@@ -396,9 +410,9 @@ export namespace Rga {
      */
     export interface SubmitFeedback extends Base {
         /**
-         * The id of the response associated with the service that delivered the answer.
+         * The unique identifier of the generated answer.
          */
-        responseId: string;
+        answerId: UuidNotNull;
         /**
          * Whether or not the answer is helpful.
          */