coveo.analytics 2.30.56 → 2.32.0

package/src/insight/insightClient.ts

@@ -1,792 +1,897 @@
 import CoveoAnalyticsClient, {AnalyticsClient, ClientOptions} from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
-import doNotTrack from '../donottrack';
+import {shouldDisableAnalyticsForPrivacy} from '../donottrack';
 import {ClickEventRequest, CustomEventRequest, SearchEventRequest} from '../events';
 import {
-    CustomEventsTypes,
-    DocumentIdentifier,
-    FacetStateMetadata,
-    GeneratedAnswerBaseMeta,
-    GeneratedAnswerCitationClickMeta,
-    GeneratedAnswerCitationMeta,
-    GeneratedAnswerFeedbackMeta,
-    GeneratedAnswerFeedbackMetaV2,
-    GeneratedAnswerRephraseMeta,
-    GeneratedAnswerSourceHoverMeta,
-    GeneratedAnswerStreamEndMeta,
-    PartialDocumentInformation,
-    SearchPageEvents,
-    SmartSnippetDocumentIdentifier,
-    SmartSnippetFeedbackReason,
-    SmartSnippetLinkMeta,
-    SmartSnippetSuggestionMeta,
-    TriggerNotifyMetadata,
+  CustomEventsTypes,
+  DocumentIdentifier,
+  FacetStateMetadata,
+  GeneratedAnswerBaseMeta,
+  GeneratedAnswerCitationClickMeta,
+  GeneratedAnswerCitationMeta,
+  GeneratedAnswerFeedbackMeta,
+  GeneratedAnswerFeedbackMetaV2,
+  GeneratedAnswerRephraseMeta,
+  GeneratedAnswerSourceHoverMeta,
+  GeneratedAnswerStreamEndMeta,
+  PartialDocumentInformation,
+  SearchPageEvents,
+  SmartSnippetDocumentIdentifier,
+  SmartSnippetFeedbackReason,
+  SmartSnippetLinkMeta,
+  SmartSnippetSuggestionMeta,
+  TriggerNotifyMetadata,
 } from '../searchPage/searchPageEvents';
 import {
-    ExpandToFullUIMetadata,
-    InsightEvents,
-    InsightFacetMetadata,
-    InsightInterfaceChangeMetadata,
-    InsightStaticFilterToggleValueMetadata,
-    InsightFacetRangeMetadata,
-    InsightCategoryFacetMetadata,
-    CaseMetadata,
-    InsightFacetSortMeta,
-    InsightFacetBaseMeta,
-    InsightQueryErrorMeta,
-    InsightPagerMetadata,
-    InsightResultsSortMetadata,
-    UserActionsDocumentMetadata,
-    UserActionsPageViewMetadata,
-    CreateArticleMetadata,
+  ExpandToFullUIMetadata,
+  InsightEvents,
+  InsightFacetMetadata,
+  InsightInterfaceChangeMetadata,
+  InsightStaticFilterToggleValueMetadata,
+  InsightFacetRangeMetadata,
+  InsightCategoryFacetMetadata,
+  CaseMetadata,
+  InsightFacetSortMeta,
+  InsightFacetBaseMeta,
+  InsightQueryErrorMeta,
+  InsightPagerMetadata,
+  InsightResultsSortMetadata,
+  UserActionsDocumentMetadata,
+  UserActionsPageViewMetadata,
+  CreateArticleMetadata,
 } from './insightEvents';
 
 export interface InsightClientProvider {
-    getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
-    getSearchUID: () => string;
-    getBaseMetadata: () => Record<string, any>;
-    getPipeline: () => string;
-    getOriginContext?: () => string;
-    getOriginLevel1: () => string;
-    getOriginLevel2: () => string;
-    getOriginLevel3: () => string;
-    getLanguage: () => string;
-    getIsAnonymous: () => boolean;
-    getFacetState?: () => FacetStateMetadata[];
-    getGeneratedAnswerMetadata?: () => Record<string, any>;
+  getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
+  getSearchUID: () => string;
+  getBaseMetadata: () => Record<string, any>;
+  getPipeline: () => string;
+  getOriginContext?: () => string;
+  getOriginLevel1: () => string;
+  getOriginLevel2: () => string;
+  getOriginLevel3: () => string;
+  getLanguage: () => string;
+  getIsAnonymous: () => boolean;
+  getFacetState?: () => FacetStateMetadata[];
+  getGeneratedAnswerMetadata?: () => Record<string, any>;
 }
 
 export interface InsightClientOptions extends ClientOptions {
-    enableAnalytics: boolean;
+  enableAnalytics: boolean;
 }
 
 const extractContextFromMetadata = (meta: {caseContext?: Record<string, string>}) => {
-    const context: Record<string, string> = {};
-    if (meta.caseContext) {
-        Object.keys(meta.caseContext).forEach((contextKey) => {
-            const value = meta.caseContext?.[contextKey];
-            if (value) {
-                const keyToBeSent = `context_${contextKey}`;
-                context[keyToBeSent] = value;
-            }
-        });
-    }
-    return context;
+  const context: Record<string, string> = {};
+  if (meta.caseContext) {
+    Object.keys(meta.caseContext).forEach((contextKey) => {
+      const value = meta.caseContext?.[contextKey];
+      if (value) {
+        const keyToBeSent = `context_${contextKey}`;
+        context[keyToBeSent] = value;
+      }
+    });
+  }
+  return context;
 };
 
 const generateMetadataToSend = (metadata: CaseMetadata, includeContext = true) => {
-    const {caseContext, caseId, caseNumber, ...metadataWithoutContext} = metadata;
-    const context = extractContextFromMetadata(metadata);
-
-    return {
-        CaseId: caseId,
-        CaseNumber: caseNumber,
-        ...metadataWithoutContext,
-        ...(!!context.context_Case_Subject && {CaseSubject: context.context_Case_Subject}),
-        ...(includeContext && context),
-    };
+  const {caseContext, caseId, caseNumber, ...metadataWithoutContext} = metadata;
+  const context = extractContextFromMetadata(metadata);
+
+  return {
+    CaseId: caseId,
+    CaseNumber: caseNumber,
+    ...metadataWithoutContext,
+    ...(!!context.context_Case_Subject && {
+      CaseSubject: context.context_Case_Subject,
+    }),
+    ...(includeContext && context),
+  };
 };
 
 export class CoveoInsightClient {
-    public coveoAnalyticsClient: AnalyticsClient;
-
-    constructor(
-        private opts: Partial<InsightClientOptions>,
-        private provider: InsightClientProvider,
-    ) {
-        const shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
-        this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
-    }
-
-    public disable() {
-        this.coveoAnalyticsClient = new NoopAnalytics();
-    }
-
-    public enable() {
-        this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
-    }
-
-    public logInterfaceLoad(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.interfaceLoad, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.interfaceLoad);
-    }
-
-    public logRecentQueryClick(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.recentQueryClick, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.recentQueryClick);
-    }
-
-    public logClearRecentQueries(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logCustomEvent(SearchPageEvents.clearRecentQueries, metadataToSend);
-        }
-        return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
-    }
-
-    public logInterfaceChange(metadata: InsightInterfaceChangeMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
-    }
-
-    public logStaticFilterDeselect(metadata: InsightStaticFilterToggleValueMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, metadataToSend);
-    }
-
-    public logFetchMoreResults(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logCustomEvent(SearchPageEvents.pagerScrolling, {...metadataToSend, type: 'getMoreResults'});
-        }
-        return this.logCustomEvent(SearchPageEvents.pagerScrolling, {type: 'getMoreResults'});
-    }
-
-    public logBreadcrumbFacet(
-        metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata,
-    ) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
-    }
-
-    public logBreadcrumbResetAll(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
-    }
-
-    public logFacetSelect(metadata: InsightFacetMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.facetSelect, metadataToSend);
-    }
-
-    public logFacetExclude(metadata: InsightFacetMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.facetExclude, metadataToSend);
-    }
-
-    public logFacetDeselect(metadata: InsightFacetMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.facetDeselect, metadataToSend);
-    }
-
-    public logFacetUpdateSort(metadata: InsightFacetSortMeta) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.facetUpdateSort, metadataToSend);
-    }
-
-    public logFacetClearAll(metadata: InsightFacetBaseMeta) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.facetClearAll, metadataToSend);
-    }
-
-    public logFacetShowMore(metadata: InsightFacetBaseMeta) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.facetShowMore, metadataToSend);
-    }
-
-    public logFacetShowLess(metadata: InsightFacetBaseMeta) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.facetShowLess, metadataToSend);
-    }
-
-    public logQueryError(metadata: InsightQueryErrorMeta) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.queryError, metadataToSend);
-    }
-
-    public logPagerNumber(metadata: InsightPagerMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.pagerNumber, metadataToSend);
-    }
-
-    public logPagerNext(metadata: InsightPagerMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.pagerNext, metadataToSend);
-    }
-
-    public logPagerPrevious(metadata: InsightPagerMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(SearchPageEvents.pagerPrevious, metadataToSend);
-    }
-
-    public logDidYouMeanAutomatic(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
-    }
-
-    public logDidYouMeanClick(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.didyoumeanClick, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
-    }
-
-    public logResultsSort(metadata: InsightResultsSortMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(SearchPageEvents.resultsSort, metadataToSend);
-    }
-
-    public logSearchboxSubmit(metadata?: CaseMetadata) {
-        if (metadata) {
-            const metadataToSend = generateMetadataToSend(metadata);
-            return this.logSearchEvent(SearchPageEvents.searchboxSubmit, metadataToSend);
-        }
-        return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
-    }
-
-    public logContextChanged(metadata: CaseMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logSearchEvent(InsightEvents.contextChanged, metadataToSend);
-    }
-
-    public logExpandToFullUI(metadata: ExpandToFullUIMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata);
-        return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
-    }
-
-    public logOpenUserActions(metadata: CaseMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(InsightEvents.openUserActions, metadataToSend);
-    }
-
-    public logShowPrecedingSessions(metadata: CaseMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(InsightEvents.showPrecedingSessions, metadataToSend);
-    }
-
-    public logShowFollowingSessions(metadata: CaseMetadata) {
-        const metadataToSend = generateMetadataToSend(metadata, false);
-        return this.logCustomEvent(InsightEvents.showFollowingSessions, metadataToSend);
-    }
+  public coveoAnalyticsClient: AnalyticsClient;
+
+  constructor(
+    private opts: Partial<InsightClientOptions>,
+    private provider: InsightClientProvider
+  ) {
+    const shouldDisableAnalytics =
+      opts.enableAnalytics === false ||
+      shouldDisableAnalyticsForPrivacy(opts.disableBrowserPrivacySignals);
+    this.coveoAnalyticsClient = shouldDisableAnalytics
+      ? new NoopAnalytics()
+      : new CoveoAnalyticsClient(opts);
+  }
+
+  public disable() {
+    this.coveoAnalyticsClient = new NoopAnalytics();
+  }
+
+  public enable() {
+    this.coveoAnalyticsClient = new CoveoAnalyticsClient(this.opts);
+  }
+
+  public logInterfaceLoad(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.interfaceLoad, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.interfaceLoad);
+  }
+
+  public logRecentQueryClick(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.recentQueryClick, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.recentQueryClick);
+  }
+
+  public logClearRecentQueries(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logCustomEvent(SearchPageEvents.clearRecentQueries, metadataToSend);
+    }
+    return this.logCustomEvent(SearchPageEvents.clearRecentQueries);
+  }
+
+  public logInterfaceChange(metadata: InsightInterfaceChangeMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.interfaceChange, metadataToSend);
+  }
+
+  public logStaticFilterDeselect(metadata: InsightStaticFilterToggleValueMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.staticFilterDeselect, metadataToSend);
+  }
+
+  public logFetchMoreResults(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logCustomEvent(SearchPageEvents.pagerScrolling, {
+        ...metadataToSend,
+        type: 'getMoreResults',
+      });
+    }
+    return this.logCustomEvent(SearchPageEvents.pagerScrolling, {
+      type: 'getMoreResults',
+    });
+  }
+
+  public logBreadcrumbFacet(
+    metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata
+  ) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.breadcrumbFacet, metadataToSend);
+  }
+
+  public logBreadcrumbResetAll(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.breadcrumbResetAll);
+  }
+
+  public logFacetSelect(metadata: InsightFacetMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.facetSelect, metadataToSend);
+  }
+
+  public logFacetExclude(metadata: InsightFacetMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.facetExclude, metadataToSend);
+  }
+
+  public logFacetDeselect(metadata: InsightFacetMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.facetDeselect, metadataToSend);
+  }
+
+  public logFacetUpdateSort(metadata: InsightFacetSortMeta) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.facetUpdateSort, metadataToSend);
+  }
+
+  public logFacetClearAll(metadata: InsightFacetBaseMeta) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.facetClearAll, metadataToSend);
+  }
+
+  public logFacetShowMore(metadata: InsightFacetBaseMeta) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.facetShowMore, metadataToSend);
+  }
+
+  public logFacetShowLess(metadata: InsightFacetBaseMeta) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.facetShowLess, metadataToSend);
+  }
+
+  public logQueryError(metadata: InsightQueryErrorMeta) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.queryError, metadataToSend);
+  }
+
+  public logPagerNumber(metadata: InsightPagerMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.pagerNumber, metadataToSend);
+  }
+
+  public logPagerNext(metadata: InsightPagerMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.pagerNext, metadataToSend);
+  }
+
+  public logPagerPrevious(metadata: InsightPagerMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(SearchPageEvents.pagerPrevious, metadataToSend);
+  }
+
+  public logDidYouMeanAutomatic(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
+  }
+
+  public logDidYouMeanClick(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.didyoumeanClick, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
+  }
+
+  public logResultsSort(metadata: InsightResultsSortMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(SearchPageEvents.resultsSort, metadataToSend);
+  }
+
+  public logSearchboxSubmit(metadata?: CaseMetadata) {
+    if (metadata) {
+      const metadataToSend = generateMetadataToSend(metadata);
+      return this.logSearchEvent(SearchPageEvents.searchboxSubmit, metadataToSend);
+    }
+    return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
+  }
+
+  public logContextChanged(metadata: CaseMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logSearchEvent(InsightEvents.contextChanged, metadataToSend);
+  }
+
+  public logExpandToFullUI(metadata: ExpandToFullUIMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata);
+    return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
+  }
+
+  public logOpenUserActions(metadata: CaseMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(InsightEvents.openUserActions, metadataToSend);
+  }
+
+  public logShowPrecedingSessions(metadata: CaseMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(InsightEvents.showPrecedingSessions, metadataToSend);
+  }
+
+  public logShowFollowingSessions(metadata: CaseMetadata) {
+    const metadataToSend = generateMetadataToSend(metadata, false);
+    return this.logCustomEvent(InsightEvents.showFollowingSessions, metadataToSend);
+  }
+
+  public logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata) {
+    return this.logCustomEvent(InsightEvents.clickViewedDocument, {
+      ...generateMetadataToSend(metadata, false),
+      document,
+    });
+  }
+
+  public logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata) {
+    return this.logCustomEvent(InsightEvents.clickPageView, {
+      ...generateMetadataToSend(metadata, false),
+      pageView,
+    });
+  }
+
+  public logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      InsightEvents.createArticle,
+      metadata
+        ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata}
+        : createArticleMetadata
+    );
+  }
+
+  public logDocumentOpen(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.documentOpen,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logCopyToClipboard(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.copyToClipboard,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logCaseSendEmail(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.caseSendEmail,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logFeedItemTextPost(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.feedItemTextPost,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logDocumentQuickview(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    caseMetadata?: CaseMetadata
+  ) {
+    const metadata = {
+      documentTitle: info.documentTitle,
+      documentURL: info.documentUrl,
+    };
+    return this.logClickEvent(
+      SearchPageEvents.documentQuickview,
+      info,
+      identifier,
+      caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
+    );
+  }
+
+  public logCaseAttach(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    caseMetadata?: CaseMetadata
+  ) {
+    const metadata = {
+      documentTitle: info.documentTitle,
+      documentURL: info.documentUrl,
+      resultUriHash: info.documentUriHash,
+    };
 
-    public logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata) {
-        return this.logCustomEvent(InsightEvents.clickViewedDocument, {
+    return this.logClickEvent(
+      SearchPageEvents.caseAttach,
+      info,
+      identifier,
+      caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata
+    );
+  }
+
+  public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string) {
+    const generatedMetadata = {
+      ...(metadata && generateMetadataToSend(metadata, false)),
+      ...(permanentId && {permanentId}),
+      resultUriHash,
+    };
+    return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
+  }
+
+  public logLikeSmartSnippet(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.likeSmartSnippet,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logDislikeSmartSnippet(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.dislikeSmartSnippet,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logExpandSmartSnippet(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.expandSmartSnippet,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logCollapseSmartSnippet(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.collapseSmartSnippet,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.openSmartSnippetFeedbackModal,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.closeSmartSnippetFeedbackModal,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logSmartSnippetFeedbackReason(
+    reason: SmartSnippetFeedbackReason,
+    details?: string,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.sendSmartSnippetReason,
+      metadata ? {...generateMetadataToSend(metadata, false), reason, details} : {reason, details}
+    );
+  }
+
+  public logExpandSmartSnippetSuggestion(
+    snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
+    return this.logCustomEvent(
+      SearchPageEvents.expandSmartSnippetSuggestion,
+      metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
+    );
+  }
+
+  public logCollapseSmartSnippetSuggestion(
+    snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
+    return this.logCustomEvent(
+      SearchPageEvents.collapseSmartSnippetSuggestion,
+      metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata
+    );
+  }
+
+  public logOpenSmartSnippetSource(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.openSmartSnippetSource,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logOpenSmartSnippetSuggestionSource(
+    info: PartialDocumentInformation,
+    snippet: SmartSnippetSuggestionMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.openSmartSnippetSuggestionSource,
+      info,
+      {
+        contentIDKey: snippet.documentId.contentIdKey,
+        contentIDValue: snippet.documentId.contentIdValue,
+      },
+      metadata ? {...generateMetadataToSend(metadata, false), ...snippet} : snippet
+    );
+  }
+
+  public logOpenSmartSnippetInlineLink(
+    info: PartialDocumentInformation,
+    identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.openSmartSnippetInlineLink,
+      info,
+      {
+        contentIDKey: identifierAndLink.contentIDKey,
+        contentIDValue: identifierAndLink.contentIDValue,
+      },
+      metadata
+        ? {...generateMetadataToSend(metadata, false), ...identifierAndLink}
+        : identifierAndLink
+    );
+  }
+
+  public logOpenSmartSnippetSuggestionInlineLink(
+    info: PartialDocumentInformation,
+    snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.openSmartSnippetSuggestionInlineLink,
+      info,
+      {
+        contentIDKey: snippetAndLink.documentId.contentIdKey,
+        contentIDValue: snippetAndLink.documentId.contentIdValue,
+      },
+      metadata ? {...generateMetadataToSend(metadata, false), ...snippetAndLink} : snippetAndLink
+    );
+  }
+
+  public logLikeGeneratedAnswer(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.likeGeneratedAnswer,
+      metadata
+        ? {
             ...generateMetadataToSend(metadata, false),
-            document,
-        });
-    }
-
-    public logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata) {
-        return this.logCustomEvent(InsightEvents.clickPageView, {
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logDislikeGeneratedAnswer(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.dislikeGeneratedAnswer,
+      metadata
+        ? {
             ...generateMetadataToSend(metadata, false),
-            pageView,
-        });
-    }
-
-    public logCreateArticle(createArticleMetadata: CreateArticleMetadata, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            InsightEvents.createArticle,
-            metadata ? {...generateMetadataToSend(metadata, false), ...createArticleMetadata} : createArticleMetadata,
-        );
-    }
-
-    public logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
-        return this.logClickEvent(
-            SearchPageEvents.documentOpen,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logCopyToClipboard(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.copyToClipboard,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logCaseSendEmail(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
-        return this.logClickEvent(
-            SearchPageEvents.caseSendEmail,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logFeedItemTextPost(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.feedItemTextPost,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logDocumentQuickview(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        caseMetadata?: CaseMetadata,
-    ) {
-        const metadata = {
-            documentTitle: info.documentTitle,
-            documentURL: info.documentUrl,
-        };
-        return this.logClickEvent(
-            SearchPageEvents.documentQuickview,
-            info,
-            identifier,
-            caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata,
-        );
-    }
-
-    public logCaseAttach(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        caseMetadata?: CaseMetadata,
-    ) {
-        const metadata = {
-            documentTitle: info.documentTitle,
-            documentURL: info.documentUrl,
-            resultUriHash: info.documentUriHash,
-        };
-
-        return this.logClickEvent(
-            SearchPageEvents.caseAttach,
-            info,
-            identifier,
-            caseMetadata ? {...generateMetadataToSend(caseMetadata, false), ...metadata} : metadata,
-        );
-    }
-
-    public logCaseDetach(resultUriHash: string, metadata?: CaseMetadata, permanentId?: string) {
-        const generatedMetadata = {
-            ...(metadata && generateMetadataToSend(metadata, false)),
-            ...(permanentId && {permanentId}),
-            resultUriHash,
-        };
-        return this.logCustomEvent(SearchPageEvents.caseDetach, generatedMetadata);
-    }
-
-    public logLikeSmartSnippet(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.likeSmartSnippet,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logDislikeSmartSnippet(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.dislikeSmartSnippet,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logExpandSmartSnippet(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.expandSmartSnippet,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logCollapseSmartSnippet(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.collapseSmartSnippet,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.openSmartSnippetFeedbackModal,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.closeSmartSnippetFeedbackModal,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logSmartSnippetFeedbackReason(
-        reason: SmartSnippetFeedbackReason,
-        details?: string,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.sendSmartSnippetReason,
-            metadata ? {...generateMetadataToSend(metadata, false), reason, details} : {reason, details},
-        );
-    }
-
-    public logExpandSmartSnippetSuggestion(
-        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
-        return this.logCustomEvent(
-            SearchPageEvents.expandSmartSnippetSuggestion,
-            metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata,
-        );
-    }
-
-    public logCollapseSmartSnippetSuggestion(
-        snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        const snippetMetadata = 'documentId' in snippet ? snippet : {documentId: snippet};
-        return this.logCustomEvent(
-            SearchPageEvents.collapseSmartSnippetSuggestion,
-            metadata ? {...generateMetadataToSend(metadata, false), ...snippetMetadata} : snippetMetadata,
-        );
-    }
-
-    public logOpenSmartSnippetSource(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.openSmartSnippetSource,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public logOpenSmartSnippetSuggestionSource(
-        info: PartialDocumentInformation,
-        snippet: SmartSnippetSuggestionMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.openSmartSnippetSuggestionSource,
-            info,
-            {contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue},
-            metadata ? {...generateMetadataToSend(metadata, false), ...snippet} : snippet,
-        );
-    }
-
-    public logOpenSmartSnippetInlineLink(
-        info: PartialDocumentInformation,
-        identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.openSmartSnippetInlineLink,
-            info,
-            {contentIDKey: identifierAndLink.contentIDKey, contentIDValue: identifierAndLink.contentIDValue},
-            metadata ? {...generateMetadataToSend(metadata, false), ...identifierAndLink} : identifierAndLink,
-        );
-    }
-
-    public logOpenSmartSnippetSuggestionInlineLink(
-        info: PartialDocumentInformation,
-        snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.openSmartSnippetSuggestionInlineLink,
-            info,
-            {
-                contentIDKey: snippetAndLink.documentId.contentIdKey,
-                contentIDValue: snippetAndLink.documentId.contentIdValue,
-            },
-            metadata ? {...generateMetadataToSend(metadata, false), ...snippetAndLink} : snippetAndLink,
-        );
-    }
-
-    public logLikeGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.likeGeneratedAnswer,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logDislikeGeneratedAnswer(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.dislikeGeneratedAnswer,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logOpenGeneratedAnswerSource(
-        generatedAnswerSourceMetadata: GeneratedAnswerCitationMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.openGeneratedAnswerSource,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerSourceMetadata}
-                : generatedAnswerSourceMetadata,
-        );
-    }
-
-    public logGeneratedAnswerCitationClick(
-        info: PartialDocumentInformation,
-        citation: GeneratedAnswerCitationClickMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.generatedAnswerCitationClick,
-            {...info, documentPosition: 1},
-            {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
-            metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation,
-        );
-    }
-
-    public logGeneratedAnswerSourceHover(
-        generatedAnswerSourceMetadata: GeneratedAnswerSourceHoverMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerSourceHover,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerSourceMetadata}
-                : generatedAnswerSourceMetadata,
-        );
-    }
-
-    public logGeneratedAnswerCopyToClipboard(
-        generatedAnswerMetadata: GeneratedAnswerBaseMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerCopyToClipboard,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logGeneratedAnswerHideAnswers(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerHideAnswers,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logGeneratedAnswerShowAnswers(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerShowAnswers,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logGeneratedAnswerExpand(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerExpand,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logGeneratedAnswerCollapse(generatedAnswerMetadata: GeneratedAnswerBaseMeta, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerCollapse,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerMetadata}
-                : generatedAnswerMetadata,
-        );
-    }
-
-    public logGeneratedAnswerFeedbackSubmit(
-        generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerFeedbackSubmit,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerFeedbackMetadata}
-                : generatedAnswerFeedbackMetadata,
-        );
-    }
-
-    public logGeneratedAnswerFeedbackSubmitV2(
-        generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMetaV2,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerFeedbackSubmitV2,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerFeedbackMetadata}
-                : generatedAnswerFeedbackMetadata,
-        );
-    }
-
-    public logRephraseGeneratedAnswer(
-        generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logSearchEvent(
-            SearchPageEvents.rephraseGeneratedAnswer,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerRephraseMetadata}
-                : generatedAnswerRephraseMetadata,
-        );
-    }
-
-    public logRetryGeneratedAnswer(metadata?: CaseMetadata) {
-        return this.logSearchEvent(
-            SearchPageEvents.retryGeneratedAnswer,
-            metadata ? {...generateMetadataToSend(metadata, false)} : {},
-        );
-    }
-
-    public logGeneratedAnswerStreamEnd(
-        generatedAnswerStreamEndMetadata: GeneratedAnswerStreamEndMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logCustomEvent(
-            SearchPageEvents.generatedAnswerStreamEnd,
-            metadata
-                ? {...generateMetadataToSend(metadata, false), ...generatedAnswerStreamEndMetadata}
-                : generatedAnswerStreamEndMetadata,
-        );
-    }
-
-    public logGeneratedAnswerCitationDocumentAttach(
-        info: PartialDocumentInformation,
-        citation: GeneratedAnswerCitationClickMeta,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.generatedAnswerCitationDocumentAttach,
-            {...info, documentPosition: 1},
-            {contentIDKey: citation.documentId.contentIdKey, contentIDValue: citation.documentId.contentIdValue},
-            metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation,
-        );
-    }
-
-    public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
-        const customData = {...this.provider.getBaseMetadata(), ...metadata};
-
-        const payload: CustomEventRequest = {
-            ...(await this.getBaseCustomEventRequest(customData)),
-            eventType: CustomEventsTypes[event]!,
-            eventValue: event,
-        };
-
-        return this.coveoAnalyticsClient.sendCustomEvent(payload);
-    }
-
-    public async logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
-        return this.coveoAnalyticsClient.sendSearchEvent(await this.getBaseSearchEventRequest(event, metadata));
-    }
-
-    public async logClickEvent(
-        event: SearchPageEvents,
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        metadata?: Record<string, any>,
-    ) {
-        const payload: ClickEventRequest = {
-            ...info,
-            ...(await this.getBaseEventRequest({...identifier, ...metadata})),
-            searchQueryUid: this.provider.getSearchUID(),
-            queryPipeline: this.provider.getPipeline(),
-            actionCause: event,
-        };
-
-        return this.coveoAnalyticsClient.sendClickEvent(payload);
-    }
-
-    public async logShowMoreFoldedResults(
-        info: PartialDocumentInformation,
-        identifier: DocumentIdentifier,
-        metadata?: CaseMetadata,
-    ) {
-        return this.logClickEvent(
-            SearchPageEvents.showMoreFoldedResults,
-            info,
-            identifier,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
-
-    public async logShowLessFoldedResults(metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.showLessFoldedResults,
-            metadata ? generateMetadataToSend(metadata, false) : undefined,
-        );
-    }
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logOpenGeneratedAnswerSource(
+    generatedAnswerSourceMetadata: GeneratedAnswerCitationMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.openGeneratedAnswerSource,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerSourceMetadata,
+          }
+        : generatedAnswerSourceMetadata
+    );
+  }
+
+  public logGeneratedAnswerCitationClick(
+    info: PartialDocumentInformation,
+    citation: GeneratedAnswerCitationClickMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.generatedAnswerCitationClick,
+      {...info, documentPosition: 1},
+      {
+        contentIDKey: citation.documentId.contentIdKey,
+        contentIDValue: citation.documentId.contentIdValue,
+      },
+      metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation
+    );
+  }
+
+  public logGeneratedAnswerSourceHover(
+    generatedAnswerSourceMetadata: GeneratedAnswerSourceHoverMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerSourceHover,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerSourceMetadata,
+          }
+        : generatedAnswerSourceMetadata
+    );
+  }
+
+  public logGeneratedAnswerCopyToClipboard(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerCopyToClipboard,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logGeneratedAnswerHideAnswers(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerHideAnswers,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logGeneratedAnswerShowAnswers(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerShowAnswers,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logGeneratedAnswerExpand(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerExpand,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logGeneratedAnswerCollapse(
+    generatedAnswerMetadata: GeneratedAnswerBaseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerCollapse,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerMetadata,
+          }
+        : generatedAnswerMetadata
+    );
+  }
+
+  public logGeneratedAnswerFeedbackSubmit(
+    generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerFeedbackSubmit,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerFeedbackMetadata,
+          }
+        : generatedAnswerFeedbackMetadata
+    );
+  }
+
+  public logGeneratedAnswerFeedbackSubmitV2(
+    generatedAnswerFeedbackMetadata: GeneratedAnswerFeedbackMetaV2,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerFeedbackSubmitV2,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerFeedbackMetadata,
+          }
+        : generatedAnswerFeedbackMetadata
+    );
+  }
+
+  public logRephraseGeneratedAnswer(
+    generatedAnswerRephraseMetadata: GeneratedAnswerRephraseMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logSearchEvent(
+      SearchPageEvents.rephraseGeneratedAnswer,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerRephraseMetadata,
+          }
+        : generatedAnswerRephraseMetadata
+    );
+  }
+
+  public logRetryGeneratedAnswer(metadata?: CaseMetadata) {
+    return this.logSearchEvent(
+      SearchPageEvents.retryGeneratedAnswer,
+      metadata ? {...generateMetadataToSend(metadata, false)} : {}
+    );
+  }
+
+  public logGeneratedAnswerStreamEnd(
+    generatedAnswerStreamEndMetadata: GeneratedAnswerStreamEndMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logCustomEvent(
+      SearchPageEvents.generatedAnswerStreamEnd,
+      metadata
+        ? {
+            ...generateMetadataToSend(metadata, false),
+            ...generatedAnswerStreamEndMetadata,
+          }
+        : generatedAnswerStreamEndMetadata
+    );
+  }
+
+  public logGeneratedAnswerCitationDocumentAttach(
+    info: PartialDocumentInformation,
+    citation: GeneratedAnswerCitationClickMeta,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.generatedAnswerCitationDocumentAttach,
+      {...info, documentPosition: 1},
+      {
+        contentIDKey: citation.documentId.contentIdKey,
+        contentIDValue: citation.documentId.contentIdValue,
+      },
+      metadata ? {...generateMetadataToSend(metadata, false), ...citation} : citation
+    );
+  }
+
+  public async logCustomEvent(
+    event: SearchPageEvents | InsightEvents,
+    metadata?: Record<string, any>
+  ) {
+    const customData = {...this.provider.getBaseMetadata(), ...metadata};
+
+    const payload: CustomEventRequest = {
+      ...(await this.getBaseCustomEventRequest(customData)),
+      eventType: CustomEventsTypes[event]!,
+      eventValue: event,
+    };
 
-    public logTriggerNotify(triggerNotifyMetadata: TriggerNotifyMetadata, metadata?: CaseMetadata) {
-        return this.logCustomEvent(
-            SearchPageEvents.triggerNotify,
-            metadata ? {...generateMetadataToSend(metadata, false), ...triggerNotifyMetadata} : triggerNotifyMetadata,
-        );
-    }
+    return this.coveoAnalyticsClient.sendCustomEvent(payload);
+  }
+
+  public async logSearchEvent(
+    event: SearchPageEvents | InsightEvents,
+    metadata?: Record<string, any>
+  ) {
+    return this.coveoAnalyticsClient.sendSearchEvent(
+      await this.getBaseSearchEventRequest(event, metadata)
+    );
+  }
+
+  public async logClickEvent(
+    event: SearchPageEvents,
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: Record<string, any>
+  ) {
+    const payload: ClickEventRequest = {
+      ...info,
+      ...(await this.getBaseEventRequest({...identifier, ...metadata})),
+      searchQueryUid: this.provider.getSearchUID(),
+      queryPipeline: this.provider.getPipeline(),
+      actionCause: event,
+    };
 
-    private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
-        return {
-            ...(await this.getBaseEventRequest(metadata)),
-            lastSearchQueryUid: this.provider.getSearchUID(),
-        };
-    }
+    return this.coveoAnalyticsClient.sendClickEvent(payload);
+  }
+
+  public async logShowMoreFoldedResults(
+    info: PartialDocumentInformation,
+    identifier: DocumentIdentifier,
+    metadata?: CaseMetadata
+  ) {
+    return this.logClickEvent(
+      SearchPageEvents.showMoreFoldedResults,
+      info,
+      identifier,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public async logShowLessFoldedResults(metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.showLessFoldedResults,
+      metadata ? generateMetadataToSend(metadata, false) : undefined
+    );
+  }
+
+  public logTriggerNotify(triggerNotifyMetadata: TriggerNotifyMetadata, metadata?: CaseMetadata) {
+    return this.logCustomEvent(
+      SearchPageEvents.triggerNotify,
+      metadata
+        ? {...generateMetadataToSend(metadata, false), ...triggerNotifyMetadata}
+        : triggerNotifyMetadata
+    );
+  }
+
+  private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
+    return {
+      ...(await this.getBaseEventRequest(metadata)),
+      lastSearchQueryUid: this.provider.getSearchUID(),
+    };
+  }
 
-    private async getBaseSearchEventRequest(
-        event: SearchPageEvents | InsightEvents,
-        metadata?: Record<string, any>,
-    ): Promise<SearchEventRequest> {
-        return {
-            ...(await this.getBaseEventRequest({...metadata, ...this.provider.getGeneratedAnswerMetadata?.()})),
-            ...this.provider.getSearchEventRequestPayload(),
-            searchQueryUid: this.provider.getSearchUID(),
-            queryPipeline: this.provider.getPipeline(),
-            actionCause: event,
-        };
-    }
+  private async getBaseSearchEventRequest(
+    event: SearchPageEvents | InsightEvents,
+    metadata?: Record<string, any>
+  ): Promise<SearchEventRequest> {
+    return {
+      ...(await this.getBaseEventRequest({
+        ...metadata,
+        ...this.provider.getGeneratedAnswerMetadata?.(),
+      })),
+      ...this.provider.getSearchEventRequestPayload(),
+      searchQueryUid: this.provider.getSearchUID(),
+      queryPipeline: this.provider.getPipeline(),
+      actionCause: event,
+    };
+  }
 
-    private async getBaseEventRequest(metadata?: Record<string, any>) {
-        const customData = {...this.provider.getBaseMetadata(), ...metadata};
-        return {
-            ...this.getOrigins(),
-            customData,
-            language: this.provider.getLanguage(),
-            facetState: this.provider.getFacetState ? this.provider.getFacetState() : [],
-            anonymous: this.provider.getIsAnonymous(),
-            clientId: await this.getClientId(),
-        };
-    }
+  private async getBaseEventRequest(metadata?: Record<string, any>) {
+    const customData = {...this.provider.getBaseMetadata(), ...metadata};
+    return {
+      ...this.getOrigins(),
+      customData,
+      language: this.provider.getLanguage(),
+      facetState: this.provider.getFacetState ? this.provider.getFacetState() : [],
+      anonymous: this.provider.getIsAnonymous(),
+      clientId: await this.getClientId(),
+    };
+  }
 
-    private getOrigins() {
-        return {
-            originContext: this.provider.getOriginContext?.(),
-            originLevel1: this.provider.getOriginLevel1(),
-            originLevel2: this.provider.getOriginLevel2(),
-            originLevel3: this.provider.getOriginLevel3(),
-        };
-    }
+  private getOrigins() {
+    return {
+      originContext: this.provider.getOriginContext?.(),
+      originLevel1: this.provider.getOriginLevel1(),
+      originLevel2: this.provider.getOriginLevel2(),
+      originLevel3: this.provider.getOriginLevel3(),
+    };
+  }
 
-    private getClientId() {
-        return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
-            ? this.coveoAnalyticsClient.getCurrentVisitorId()
-            : undefined;
-    }
+  private getClientId() {
+    return this.coveoAnalyticsClient instanceof CoveoAnalyticsClient
+      ? this.coveoAnalyticsClient.getCurrentVisitorId()
+      : undefined;
+  }
 }