@coveo/quantic 3.36.6 → 3.36.7

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/core/generated-answer/headless-core-generated-answer.d.ts

@@ -21,12 +21,24 @@ export interface GeneratedAnswer extends Controller {
     retry(): void;
     /**
      * Indicates that the generated answer met the user expectations.
+     * @deprecated The no-argument `like` method is deprecated and will be removed in a future major version. The method will now take a required `answerId` parameter to specify which answer is being liked, and will log the like action with the provided `answerId` for analytics.
      */
     like(): void;
+    /**
+     * Indicates that the generated answer met the user expectations.
+     * @param answerId - Answer Id of the liked answer.
+     */
+    like(answerId: string): void;
     /**
      * Marks the generated answer as not relevant to the end user.
+     * @deprecated The no-argument `dislike` method is deprecated and will be removed in a future major version. The method will now take a required `answerId` parameter to specify which answer is being disliked, and will log the dislike action with the provided `answerId` for analytics.
      */
     dislike(): void;
+    /**
+     * Marks the generated answer as not relevant to the end user.
+     * @param answerId - Answer Id of the disliked answer.
+     */
+    dislike(answerId: string): void;
     /**
      * Opens the modal to provide feedback about why the generated answer was not relevant.
      */
@@ -40,11 +52,6 @@ export interface GeneratedAnswer extends Controller {
      * @param feedback - The feedback that the end user wishes to send.
      */
     sendFeedback(feedback: GeneratedAnswerFeedback): void;
-    /**
-     * Logs a custom event indicating a cited source link was clicked.
-     * @param id - The ID of the clicked citation.
-     */
-    logCitationClick(id: string): void;
     /**
      * Displays the generated answer.
      */
@@ -71,24 +78,60 @@ export interface GeneratedAnswer extends Controller {
     disable(): void;
     /**
      * Logs a custom event indicating the generated answer was copied to the clipboard.
+     * @deprecated The `logCopyToClipboard` method is deprecated and will be removed in a future major version. The method will now take a required `answerId` parameter to specify which answer is being copied, and will log the copy action with the provided `answerId` for analytics.
      */
     logCopyToClipboard(): void;
     /**
-     * Logs a custom event indicating a cited source link was hovered.
+     * Logs a custom event indicating the generated answer was copied to the clipboard.
+     * @param answerId - Answer Id of the copied answer.
+     */
+    logCopyToClipboard(answerId: string): void;
+    /**
+     * Logs a custom event indicating a cited source link was clicked.
+     * @param citationId - The ID of the clicked citation.
+     * @deprecated The `logCitationClick` method is deprecated and will be removed in a future major version. The method will now take a required `answerId` parameter to specify which answer is being clicked, and will log the click action with the provided `answerId` for analytics.
+     */
+    logCitationClick(citationId: string): void;
+    /**
+     * Logs a custom event indicating a cited source link was clicked.
      * @param citationId - The ID of the clicked citation.
+     * @param answerId - Answer Id of the clicked citation's answer.
+     */
+    logCitationClick(citationId: string, answerId: string): void;
+    /**
+     * Logs a custom event indicating a cited source link was hovered.
+     * @param citationId - The ID of the hovered citation.
      * @param citationHoverTimeMs - The number of milliseconds spent hovering over the citation.
+     * @deprecated The `logCitationHover` method is deprecated and will be removed in a future major version. The method will now take a required `answerId` parameter to specify which answer is being hovered, and will log the hover action with the provided `answerId` for analytics.
      */
     logCitationHover(citationId: string, citationHoverTimeMs: number): void;
+    /**
+     * Logs a custom event indicating a cited source link was hovered.
+     * @param citationId - The ID of the hovered citation.
+     * @param citationHoverTimeMs - The number of milliseconds spent hovering over the citation.
+     * @param answerId - Answer Id of the hovered citation's answer.
+     */
+    logCitationHover(citationId: string, citationHoverTimeMs: number, answerId: string): void;
 }
 export interface GeneratedAnswerAnalyticsClient {
-    logLikeGeneratedAnswer: () => CustomAction;
-    logDislikeGeneratedAnswer: () => CustomAction;
+    /** @deprecated */
+    logLikeGeneratedAnswer(): CustomAction;
+    logLikeGeneratedAnswer(answerId?: string): CustomAction;
+    /** @deprecated */
+    logDislikeGeneratedAnswer(): CustomAction;
+    logDislikeGeneratedAnswer(answerId?: string): CustomAction;
     logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
-    logOpenGeneratedAnswerSource: (citationId: string) => CustomAction;
-    logHoverCitation: (citationId: string, citationHoverTimeMs: number) => CustomAction;
+    /** @deprecated */
+    logOpenGeneratedAnswerSource(citationId: string): CustomAction;
+    logOpenGeneratedAnswerSource(citationId: string, answerId?: string): CustomAction;
+    /** @deprecated */
+    logHoverCitation(citationId: string, citationHoverTimeMs: number): CustomAction;
+    logHoverCitation(citationId: string, citationHoverTimeMs: number, answerId?: string): CustomAction;
     logGeneratedAnswerShowAnswers: () => CustomAction;
     logGeneratedAnswerHideAnswers: () => CustomAction;
-    logCopyGeneratedAnswer: () => CustomAction;
+    /** @deprecated */
+    logCopyGeneratedAnswer(): CustomAction;
+    logCopyGeneratedAnswer(answerId?: string): CustomAction;
     logRetryGeneratedAnswer: () => LegacySearchAction;
     logGeneratedAnswerExpand: () => CustomAction;
     logGeneratedAnswerCollapse: () => CustomAction;

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/generated-answer/headless-generated-answer.d.ts

@@ -1,10 +1,10 @@
 import type { GeneratedAnswerCitation } from '../../api/generated-answer/generated-answer-event-payload.js';
 import type { SearchEngine } from '../../app/search-engine/search-engine.js';
-import type { GeneratedAnswerBase, GeneratedAnswerState, GenerationStep } from '../../features/generated-answer/generated-answer-state.js';
+import type { GeneratedAnswerBase, GeneratedAnswerState, GenerationStep, GenerationStepName } from '../../features/generated-answer/generated-answer-state.js';
 import type { GeneratedResponseFormat } from '../../features/generated-answer/generated-response-format.js';
 import type { GeneratedAnswer, GeneratedAnswerProps, GeneratedAnswerPropsInitialState } from '../core/generated-answer/headless-core-generated-answer.js';
 import { type GeneratedAnswerWithFollowUps, type GeneratedAnswerWithFollowUpsState } from '../knowledge/generated-answer/headless-generated-answer-with-follow-ups.js';
-export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedAnswerBase, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GenerationStep, };
+export type { GeneratedAnswerCitation, GeneratedResponseFormat, GeneratedAnswerState, GeneratedAnswer, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedAnswerBase, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GenerationStep, GenerationStepName, };
 /**
  * Creates a `GeneratedAnswer` controller instance.
 

package/force-app/main/default/staticresources/coveoheadless/definitions/controllers/knowledge/generated-answer/headless-generated-answer-with-follow-ups.d.ts

@@ -13,17 +13,30 @@ export interface GeneratedAnswerWithFollowUps extends GeneratedAnswer {
     state: GeneratedAnswerWithFollowUpsState;
     /**
      * Marks the answer as liked.
-     * @param answerId - Optional ID of the answer to like. Defaults to the head answer.
+     * @param answerId - Optional ID of the answer to like. Defaults to the first answer.
      */
     like(answerId?: string): void;
     /**
      * Marks the answer as disliked.
-     * @param answerId - Optional ID of the answer to dislike. Defaults to the head answer.
+     * @param answerId - Optional ID of the answer to dislike. Defaults to the first answer.
      */
     dislike(answerId?: string): void;
+    /**
+     * Logs a custom event indicating a cited source link was hovered.
+     * @param citationId - The ID of the hovered citation.
+     * @param citationHoverTimeMs - The number of milliseconds spent hovering over the citation.
+     * @param answerId - Optional ID of the answer for which the citation was hovered. Defaults to the first answer.
+     */
+    logCitationHover(citationId: string, citationHoverTimeMs: number, answerId?: string): void;
+    /**
+     * Logs a click on a cited source link for analytics.
+     * @param citationId - The ID of the clicked citation.
+     * @param answerId - Optional ID of the answer for which the citation was clicked. Defaults to the first answer.
+     */
+    logCitationClick(citationId: string, answerId?: string): void;
     /**
      * Logs a copy-to-clipboard interaction for analytics.
-     * @param answerId - Optional ID of the copied answer. Defaults to the current answer.
+     * @param answerId - Optional ID of the copied answer. Defaults to the first answer.
      */
     logCopyToClipboard(answerId?: string): void;
     /**

package/force-app/main/default/staticresources/coveoheadless/definitions/features/generated-answer/generated-answer-analytics-actions.d.ts

@@ -12,10 +12,14 @@ export type GeneratedAnswerFeedback = {
 };
 export declare const parseEvaluationDetails: (detail: "yes" | "no" | "unknown") => boolean | undefined;
 export declare const logRetryGeneratedAnswer: () => LegacySearchAction;
-export declare const logOpenGeneratedAnswerSource: (citationId: string) => CustomAction;
-export declare const logHoverCitation: (citationId: string, citationHoverTimeInMs: number) => CustomAction;
-export declare const logLikeGeneratedAnswer: () => CustomAction;
-export declare const logDislikeGeneratedAnswer: () => CustomAction;
+export declare function logOpenGeneratedAnswerSource(citationId: string): CustomAction;
+export declare function logOpenGeneratedAnswerSource(citationId: string, answerId: string): CustomAction;
+export declare function logHoverCitation(citationId: string, citationHoverTimeInMs: number): CustomAction;
+export declare function logHoverCitation(citationId: string, citationHoverTimeInMs: number, answerId: string): CustomAction;
+export declare function logLikeGeneratedAnswer(): CustomAction;
+export declare function logLikeGeneratedAnswer(answerId: string): CustomAction;
+export declare function logDislikeGeneratedAnswer(): CustomAction;
+export declare function logDislikeGeneratedAnswer(answerId: string): CustomAction;
 export declare const logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
 export declare const logGeneratedAnswerStreamEnd: (answerGenerated: boolean) => CustomAction;
 export declare const logGeneratedAnswerResponseLinked: () => CustomAction;
@@ -23,18 +27,19 @@ export declare const logGeneratedAnswerShowAnswers: () => CustomAction;
 export declare const logGeneratedAnswerHideAnswers: () => CustomAction;
 export declare const logGeneratedAnswerExpand: () => CustomAction;
 export declare const logGeneratedAnswerCollapse: () => CustomAction;
-export declare const logCopyGeneratedAnswer: () => CustomAction;
+export declare function logCopyGeneratedAnswer(): CustomAction;
+export declare function logCopyGeneratedAnswer(answerId: string): CustomAction;
 export declare const retryGeneratedAnswer: () => SearchAction;
 export declare const generatedAnswerAnalyticsClient: {
-    logCopyGeneratedAnswer: () => CustomAction;
+    logCopyGeneratedAnswer: typeof logCopyGeneratedAnswer;
     logGeneratedAnswerHideAnswers: () => CustomAction;
     logGeneratedAnswerShowAnswers: () => CustomAction;
     logGeneratedAnswerStreamEnd: (answerGenerated: boolean) => CustomAction;
     logGeneratedAnswerFeedback: (feedback: GeneratedAnswerFeedback) => CustomAction;
-    logDislikeGeneratedAnswer: () => CustomAction;
-    logLikeGeneratedAnswer: () => CustomAction;
-    logHoverCitation: (citationId: string, citationHoverTimeInMs: number) => CustomAction;
-    logOpenGeneratedAnswerSource: (citationId: string) => CustomAction;
+    logDislikeGeneratedAnswer: typeof logDislikeGeneratedAnswer;
+    logLikeGeneratedAnswer: typeof logLikeGeneratedAnswer;
+    logHoverCitation: typeof logHoverCitation;
+    logOpenGeneratedAnswerSource: typeof logOpenGeneratedAnswerSource;
     logRetryGeneratedAnswer: () => LegacySearchAction;
     logGeneratedAnswerExpand: () => CustomAction;
     logGeneratedAnswerCollapse: () => CustomAction;

package/force-app/main/default/staticresources/coveoheadless/definitions/index.d.ts

@@ -63,7 +63,7 @@ export type { FieldSuggestions, FieldSuggestionsOptions, FieldSuggestionsProps,
 export { buildFieldSuggestions } from './controllers/field-suggestions/facet/headless-field-suggestions.js';
 export type { FoldedCollection, FoldedResult, FoldedResultList, FoldedResultListOptions, FoldedResultListProps, FoldedResultListState, FoldingOptions, } from './controllers/folded-result-list/headless-folded-result-list.js';
 export { buildFoldedResultList } from './controllers/folded-result-list/headless-folded-result-list.js';
-export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, } from './controllers/generated-answer/headless-generated-answer.js';
+export type { GeneratedAnswer, GeneratedAnswerBase, GeneratedAnswerCitation, GeneratedAnswerProps, GeneratedAnswerPropsInitialState, GeneratedAnswerState, GeneratedAnswerWithFollowUps, GeneratedAnswerWithFollowUpsState, GeneratedResponseFormat, GenerationStep, GenerationStepName, } from './controllers/generated-answer/headless-generated-answer.js';
 export { buildGeneratedAnswer } from './controllers/generated-answer/headless-generated-answer.js';
 export type { InteractiveCitation, InteractiveCitationOptions, InteractiveCitationProps, } from './controllers/generated-answer/headless-interactive-citation.js';
 export { buildInteractiveCitation } from './controllers/generated-answer/headless-interactive-citation.js';