coveo.analytics 2.23.9 → 2.23.10

package/dist/definitions/insight/insightClient.d.ts

@@ -1,7 +1,7 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
 import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents } from '../searchPage/searchPageEvents';
-import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata } from './insightEvents';
+import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -47,6 +47,11 @@ export declare class CoveoInsightClient {
     logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
     logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenUserActions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logShowPrecedingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logShowFollowingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
     logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
     logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;

package/dist/definitions/insight/insightEvents.d.ts

@@ -1,7 +1,12 @@
 import { CategoryFacetMetadata, FacetBaseMeta, FacetMetadata, FacetRangeMetadata, FacetSortMeta, InterfaceChangeMetadata, PagerMetadata, QueryErrorMeta, ResultsSortMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
 export declare enum InsightEvents {
     contextChanged = "contextChanged",
-    expandToFullUI = "expandToFullUI"
+    expandToFullUI = "expandToFullUI",
+    openUserActions = "openUserActions",
+    showPrecedingSessions = "showPrecedingSessions",
+    showFollowingSessions = "showFollowingSessions",
+    clickViewedDocument = "clickViewedDocument",
+    clickPageView = "clickPageView"
 }
 export interface CaseMetadata {
     caseId?: string;
@@ -12,6 +17,17 @@ export interface ExpandToFullUIMetadata extends CaseMetadata {
     fullSearchComponentName: string;
     triggeredBy: string;
 }
+export interface UserActionsDocumentMetadata {
+    title: string;
+    uri: string;
+    uriHash?: string;
+    permanentId?: string;
+}
+export interface UserActionsPageViewMetadata {
+    title: string;
+    contentIdKey: string;
+    contentIdValue: string;
+}
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
 }
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {

package/dist/library.es.js

@@ -1136,6 +1136,11 @@ var InsightEvents;
 (function (InsightEvents) {
     InsightEvents["contextChanged"] = "contextChanged";
     InsightEvents["expandToFullUI"] = "expandToFullUI";
+    InsightEvents["openUserActions"] = "openUserActions";
+    InsightEvents["showPrecedingSessions"] = "showPrecedingSessions";
+    InsightEvents["showFollowingSessions"] = "showFollowingSessions";
+    InsightEvents["clickViewedDocument"] = "clickViewedDocument";
+    InsightEvents["clickPageView"] = "clickPageView";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1245,6 +1250,11 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
 };
 
@@ -2441,6 +2451,24 @@ class CoveoInsightClient {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
+    logOpenUserActions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.openUserActions, metadataToSend);
+    }
+    logShowPrecedingSessions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showPrecedingSessions, metadataToSend);
+    }
+    logShowFollowingSessions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showFollowingSessions, metadataToSend);
+    }
+    logViewedDocumentClick(document, metadata) {
+        return this.logCustomEvent(InsightEvents.clickViewedDocument, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { document }));
+    }
+    logPageViewClick(pageView, metadata) {
+        return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/dist/library.js

@@ -83640,6 +83640,11 @@ var InsightEvents;
 (function (InsightEvents) {
     InsightEvents["contextChanged"] = "contextChanged";
     InsightEvents["expandToFullUI"] = "expandToFullUI";
+    InsightEvents["openUserActions"] = "openUserActions";
+    InsightEvents["showPrecedingSessions"] = "showPrecedingSessions";
+    InsightEvents["showFollowingSessions"] = "showFollowingSessions";
+    InsightEvents["clickViewedDocument"] = "clickViewedDocument";
+    InsightEvents["clickPageView"] = "clickPageView";
 })(InsightEvents || (InsightEvents = {}));
 
 var _a;
@@ -83750,6 +83755,11 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
     _a[InsightEvents.expandToFullUI] = 'interface',
+    _a[InsightEvents.openUserActions] = 'User Actions',
+    _a[InsightEvents.showPrecedingSessions] = 'User Actions',
+    _a[InsightEvents.showFollowingSessions] = 'User Actions',
+    _a[InsightEvents.clickViewedDocument] = 'User Actions',
+    _a[InsightEvents.clickPageView] = 'User Actions',
     _a[SearchPageEvents.caseDetach] = 'case',
     _a);
 
@@ -85288,6 +85298,24 @@ var CoveoInsightClient = (function () {
         var metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     };
+    CoveoInsightClient.prototype.logOpenUserActions = function (metadata) {
+        var metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.openUserActions, metadataToSend);
+    };
+    CoveoInsightClient.prototype.logShowPrecedingSessions = function (metadata) {
+        var metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showPrecedingSessions, metadataToSend);
+    };
+    CoveoInsightClient.prototype.logShowFollowingSessions = function (metadata) {
+        var metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showFollowingSessions, metadataToSend);
+    };
+    CoveoInsightClient.prototype.logViewedDocumentClick = function (document, metadata) {
+        return this.logCustomEvent(InsightEvents.clickViewedDocument, __assign(__assign({}, generateMetadataToSend(metadata, false)), { document: document }));
+    };
+    CoveoInsightClient.prototype.logPageViewClick = function (pageView, metadata) {
+        return this.logCustomEvent(InsightEvents.clickPageView, __assign(__assign({}, generateMetadataToSend(metadata, false)), { pageView: pageView }));
+    };
     CoveoInsightClient.prototype.logDocumentOpen = function (info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     };

package/dist/react-native.es.js

@@ -1153,6 +1153,11 @@ var InsightEvents;
 (function (InsightEvents) {
     InsightEvents["contextChanged"] = "contextChanged";
     InsightEvents["expandToFullUI"] = "expandToFullUI";
+    InsightEvents["openUserActions"] = "openUserActions";
+    InsightEvents["showPrecedingSessions"] = "showPrecedingSessions";
+    InsightEvents["showFollowingSessions"] = "showFollowingSessions";
+    InsightEvents["clickViewedDocument"] = "clickViewedDocument";
+    InsightEvents["clickPageView"] = "clickPageView";
 })(InsightEvents || (InsightEvents = {}));
 
 var SearchPageEvents;
@@ -1262,6 +1267,11 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
 };
 
@@ -2458,6 +2468,24 @@ class CoveoInsightClient {
         const metadataToSend = generateMetadataToSend(metadata);
         return this.logCustomEvent(InsightEvents.expandToFullUI, metadataToSend);
     }
+    logOpenUserActions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.openUserActions, metadataToSend);
+    }
+    logShowPrecedingSessions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showPrecedingSessions, metadataToSend);
+    }
+    logShowFollowingSessions(metadata) {
+        const metadataToSend = generateMetadataToSend(metadata, false);
+        return this.logCustomEvent(InsightEvents.showFollowingSessions, metadataToSend);
+    }
+    logViewedDocumentClick(document, metadata) {
+        return this.logCustomEvent(InsightEvents.clickViewedDocument, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { document }));
+    }
+    logPageViewClick(pageView, metadata) {
+        return this.logCustomEvent(InsightEvents.clickPageView, Object.assign(Object.assign({}, generateMetadataToSend(metadata, false)), { pageView }));
+    }
     logDocumentOpen(info, identifier, metadata) {
         return this.logClickEvent(SearchPageEvents.documentOpen, info, identifier, metadata ? generateMetadataToSend(metadata, false) : undefined);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.23.9",
+    "version": "2.23.10",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/insight/insightClient.spec.ts

@@ -829,4 +829,46 @@ describe('InsightClient', () => {
         await client.logExpandToFullUI(meta);
         expectMatchCustomEventPayload(InsightEvents.expandToFullUI, expectedMeta);
     });
+
+    it('should send proper payload for #logOpenUserActions', async () => {
+        await client.logOpenUserActions(baseCaseMetadata);
+        expectMatchCustomEventPayload(InsightEvents.openUserActions, expectedBaseCaseMetadata);
+    });
+
+    it('should send proper payload for #logShowPrecedingSession', async () => {
+        await client.logShowPrecedingSessions(baseCaseMetadata);
+        expectMatchCustomEventPayload(InsightEvents.showPrecedingSessions, expectedBaseCaseMetadata);
+    });
+
+    it('should send proper payload for #logShowFollowingSession', async () => {
+        await client.logShowFollowingSessions(baseCaseMetadata);
+        expectMatchCustomEventPayload(InsightEvents.showFollowingSessions, expectedBaseCaseMetadata);
+    });
+
+    it('should send proper payload for #logViewedDocumentClick', async () => {
+        const document = {
+            title: 'Some Title',
+            uri: 'https://www.some-uri.com',
+            uriHash: 'Acp8NfEWi0DeðeZU',
+            permanentId: '8c88cd894t2767a96fa4f109041bb62bb54ca21ff31c1d760814b60cbcf2',
+        };
+        await client.logViewedDocumentClick(document, baseCaseMetadata);
+        expectMatchCustomEventPayload(InsightEvents.clickViewedDocument, {
+            ...expectedBaseCaseMetadata,
+            document,
+        });
+    });
+
+    it('should send proper payload for #logPageViewClick', async () => {
+        const pageView = {
+            title: 'Some Title',
+            contentIdKey: 'someKey',
+            contentIdValue: 'some-content-id-value',
+        };
+        await client.logPageViewClick(pageView, baseCaseMetadata);
+        expectMatchCustomEventPayload(InsightEvents.clickPageView, {
+            ...expectedBaseCaseMetadata,
+            pageView,
+        });
+    });
 });

package/src/insight/insightClient.ts

@@ -23,6 +23,8 @@ import {
     InsightQueryErrorMeta,
     InsightPagerMetadata,
     InsightResultsSortMetadata,
+    UserActionsDocumentMetadata,
+    UserActionsPageViewMetadata,
 } from './insightEvents';
 
 export interface InsightClientProvider {
@@ -219,6 +221,35 @@ export class CoveoInsightClient {
         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 logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata) {
         return this.logClickEvent(
             SearchPageEvents.documentOpen,

package/src/insight/insightEvents.ts

@@ -20,6 +20,26 @@ export enum InsightEvents {
      * Identifies the event that gets logged when the user opens the full search page from the insight panel.
      */
     expandToFullUI = 'expandToFullUI',
+    /**
+     * Identifies the event that gets logged when the user opens the user actions section.
+     */
+    openUserActions = 'openUserActions',
+    /**
+     * Identifies the event that gets logged when the user clicks to view user action sessions preceding the ticket creation.
+     */
+    showPrecedingSessions = 'showPrecedingSessions',
+    /**
+     * Identifies the event that gets logged when the user clicks to view user action sessions following the ticket creation.
+     */
+    showFollowingSessions = 'showFollowingSessions',
+    /**
+     * Identifies the event that gets logged when the user clicks a viewed document link on the user actions timeline.
+     */
+    clickViewedDocument = 'clickViewedDocument',
+    /**
+     * Identifies the event that gets logged when the user clicks a viewed page link on the user actions timeline.
+     */
+    clickPageView = 'clickPageView',
 }
 
 export interface CaseMetadata {
@@ -33,6 +53,19 @@ export interface ExpandToFullUIMetadata extends CaseMetadata {
     triggeredBy: string;
 }
 
+export interface UserActionsDocumentMetadata {
+    title: string;
+    uri: string;
+    uriHash?: string;
+    permanentId?: string;
+}
+
+export interface UserActionsPageViewMetadata {
+    title: string;
+    contentIdKey: string;
+    contentIdValue: string;
+}
+
 export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {}
 
 export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {}

package/src/searchPage/searchPageEvents.ts

@@ -322,6 +322,11 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents,
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
     [InsightEvents.expandToFullUI]: 'interface',
+    [InsightEvents.openUserActions]: 'User Actions',
+    [InsightEvents.showPrecedingSessions]: 'User Actions',
+    [InsightEvents.showFollowingSessions]: 'User Actions',
+    [InsightEvents.clickViewedDocument]: 'User Actions',
+    [InsightEvents.clickPageView]: 'User Actions',
     [SearchPageEvents.caseDetach]: 'case',
 };