@coveo/relay-event-types 6.28.2 → 6.30.0

package/package.json

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

@@ -73,6 +73,18 @@ export interface EcPurchase extends Base {
     };
 }
 
+interface Feedback {
+    liked: boolean;
+    /**
+     * The reason for the feedback.
+     */
+    reason?: "irrelevant" | "notAccurate" | "outOfDate" | "harmful" | "other";
+    /**
+     * Additional details written in free text.
+     */
+    details?: string;
+}
+
 /**
  * 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.
  */
@@ -135,6 +147,53 @@ interface ProductQuantity {
     quantity: number;
 }
 
+interface QnaAnswer {
+    /**
+     * The answer id. This value needs to match the unique identifier of a Q&A answer.
+     */
+    id: string;
+}
+
+/**
+ * Event to emit when interacting with a Q&A answer.
+ */
+export interface QnaAnswerAction extends Base {
+    answer: QnaAnswer;
+    action: "copyToClipboard" | "hide" | "show" | "expand" | "collapse";
+}
+
+interface QnaCitation {
+    /**
+     * The citation id. This value needs to match the unique identifier of the answer's citation.
+     */
+    id: string;
+}
+
+/**
+ * Event to emit when a Q&A answer citation has been hovered.
+ */
+export interface QnaCitationHover extends Base {
+    answer: QnaAnswer;
+    citation: QnaCitation;
+    citationHoverTimeInMs?: number;
+}
+
+/**
+ * Event to emit when a Q&A answer citation item has been clicked.
+ */
+export interface QnaCitationItemClick extends Base {
+    answer: QnaAnswer;
+    citation: QnaCitation;
+}
+
+/**
+ * Event to emit when submitting feedback for a Q&A answer.
+ */
+export interface QnaFeedback extends Base {
+    answer: QnaAnswer;
+    feedback: Feedback;
+}
+
 /**
  * Represents the Coveo Analytics Search Event. Send this schema exclusively when conducting A/B tests against a competitor's search solution.
  */