coveo.analytics 2.20.12 → 2.20.13

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

@@ -1,6 +1,7 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { SearchEventRequest } from '../events';
 import { FacetBaseMeta, FacetMetadata, FacetSortMeta, FacetStateMetadata, PagerMetadata, InterfaceChangeMetadata, QueryErrorMeta, SearchPageEvents, ResultsSortMetadata, FacetRangeMetadata, CategoryFacetMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
+import { ContextChangedMetadata, ExpandToFullUIMetadata, InsightEvents } from './insightEvents';
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
     getSearchUID: () => string;
@@ -37,12 +38,14 @@ export declare class CoveoInsightClient {
     logFacetShowMore(meta: FacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
     logFacetShowLess(meta: FacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
     logQueryError(meta: QueryErrorMeta): Promise<void | import("../events").CustomEventResponse>;
-    logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
-    logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
+    logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
+    logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
     logPagerNumber(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerNext(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerPrevious(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
     logResultsSort(metadata: ResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logContextChanged(meta: ContextChangedMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logExpandToFullUI(meta: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
     private getBaseCustomEventRequest;
     private getBaseSearchEventRequest;
     private getBaseEventRequest;

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

@@ -0,0 +1,16 @@
+export declare enum InsightEvents {
+    contextChanged = "contextChanged",
+    expandToFullUI = "expandToFullUI"
+}
+interface CaseMetadata {
+    caseId: string;
+    caseNumber: string;
+    caseContext: Record<string, string>;
+}
+export interface ContextChangedMetadata extends CaseMetadata {
+}
+export interface ExpandToFullUIMetadata extends CaseMetadata {
+    fullSearchComponentName: string;
+    triggeredBy: string;
+}
+export {};

package/dist/definitions/searchPage/searchPageEvents.d.ts

@@ -1,4 +1,5 @@
 import { DocumentInformation, FacetStateRequest } from '../events';
+import { InsightEvents } from '../insight/insightEvents';
 export declare enum SearchPageEvents {
     interfaceLoad = "interfaceLoad",
     interfaceChange = "interfaceChange",
@@ -65,7 +66,7 @@ export declare enum SearchPageEvents {
     showMoreFoldedResults = "showMoreFoldedResults",
     showLessFoldedResults = "showLessFoldedResults"
 }
-export declare const CustomEventsTypes: Partial<Record<SearchPageEvents, string>>;
+export declare const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>>;
 export interface StaticFilterMetadata {
     staticFilterId: string;
 }

package/dist/library.es.js

@@ -1074,6 +1074,12 @@ class CoveoAnalyticsClient {
     }
 }
 
+var InsightEvents;
+(function (InsightEvents) {
+    InsightEvents["contextChanged"] = "contextChanged";
+    InsightEvents["expandToFullUI"] = "expandToFullUI";
+})(InsightEvents || (InsightEvents = {}));
+
 var SearchPageEvents;
 (function (SearchPageEvents) {
     SearchPageEvents["interfaceLoad"] = "interfaceLoad";
@@ -1174,6 +1180,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
+    [InsightEvents.expandToFullUI]: 'interface',
 };
 
 class NoopAnalytics {
@@ -1788,6 +1795,14 @@ class CaseAssistClient {
     }
 }
 
+const extractContextFromMetadata = (meta) => {
+    const context = {};
+    Object.keys(meta.caseContext).forEach((contextKey) => {
+        const keyToBeSent = `context_${contextKey}`;
+        context[keyToBeSent] = meta.caseContext[contextKey];
+    });
+    return context;
+};
 class CoveoInsightClient {
     constructor(opts, provider) {
         this.opts = opts;
@@ -1867,6 +1882,19 @@ class CoveoInsightClient {
     logResultsSort(metadata) {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     }
+    logContextChanged(meta) {
+        const context = extractContextFromMetadata(meta);
+        const { caseId, caseNumber } = meta;
+        const metaToBeSent = Object.assign(Object.assign({ CaseId: caseId, CaseNumber: caseNumber }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), context);
+        return this.logSearchEvent(InsightEvents.contextChanged, metaToBeSent);
+    }
+    logExpandToFullUI(meta) {
+        const context = extractContextFromMetadata(meta);
+        const { caseId, caseNumber, triggeredBy, fullSearchComponentName } = meta;
+        const metaToBeSent = Object.assign({ CaseId: caseId, CaseNumber: caseNumber, triggeredBy,
+            fullSearchComponentName }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject }));
+        return this.logCustomEvent(InsightEvents.expandToFullUI, metaToBeSent);
+    }
     getBaseCustomEventRequest(metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             return Object.assign(Object.assign({}, (yield this.getBaseEventRequest(metadata))), { lastSearchQueryUid: this.provider.getSearchUID() });

package/dist/library.js

@@ -83526,6 +83526,12 @@ var simpleanalytics = /*#__PURE__*/Object.freeze({
     'default': handleOneAnalyticsEvent
 });
 
+var InsightEvents;
+(function (InsightEvents) {
+    InsightEvents["contextChanged"] = "contextChanged";
+    InsightEvents["expandToFullUI"] = "expandToFullUI";
+})(InsightEvents || (InsightEvents = {}));
+
 var _a;
 var SearchPageEvents;
 (function (SearchPageEvents) {
@@ -83627,6 +83633,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.showLessFoldedResults] = 'folding',
+    _a[InsightEvents.expandToFullUI] = 'interface',
     _a);
 
 var NoopAnalytics = (function () {
@@ -84180,6 +84187,14 @@ var CaseAssistClient = (function () {
     return CaseAssistClient;
 }());
 
+var extractContextFromMetadata = function (meta) {
+    var context = {};
+    Object.keys(meta.caseContext).forEach(function (contextKey) {
+        var keyToBeSent = "context_" + contextKey;
+        context[keyToBeSent] = meta.caseContext[contextKey];
+    });
+    return context;
+};
 var CoveoInsightClient = (function () {
     function CoveoInsightClient(opts, provider) {
         this.opts = opts;
@@ -84276,6 +84291,19 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logResultsSort = function (metadata) {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     };
+    CoveoInsightClient.prototype.logContextChanged = function (meta) {
+        var context = extractContextFromMetadata(meta);
+        var caseId = meta.caseId, caseNumber = meta.caseNumber;
+        var metaToBeSent = __assign(__assign({ CaseId: caseId, CaseNumber: caseNumber }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject })), context);
+        return this.logSearchEvent(InsightEvents.contextChanged, metaToBeSent);
+    };
+    CoveoInsightClient.prototype.logExpandToFullUI = function (meta) {
+        var context = extractContextFromMetadata(meta);
+        var caseId = meta.caseId, caseNumber = meta.caseNumber, triggeredBy = meta.triggeredBy, fullSearchComponentName = meta.fullSearchComponentName;
+        var metaToBeSent = __assign({ CaseId: caseId, CaseNumber: caseNumber, triggeredBy: triggeredBy,
+            fullSearchComponentName: fullSearchComponentName }, (!!context.context_Case_Subject && { CaseSubject: context.context_Case_Subject }));
+        return this.logCustomEvent(InsightEvents.expandToFullUI, metaToBeSent);
+    };
     CoveoInsightClient.prototype.getBaseCustomEventRequest = function (metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var _a;

package/package.json

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

package/src/insight/insightClient.spec.ts

@@ -4,6 +4,7 @@ import {NoopAnalytics} from '../client/noopAnalytics';
 import {CustomEventsTypes, SearchPageEvents, StaticFilterToggleValueMetadata} from '../searchPage/searchPageEvents';
 import {CoveoInsightClient, InsightClientProvider} from './insightClient';
 import doNotTrack from '../donottrack';
+import {InsightEvents} from './insightEvents';
 
 jest.mock('../donottrack', () => {
     return {
@@ -58,7 +59,7 @@ describe('InsightClient', () => {
         originLevel3: 'origin-level-3',
     });
 
-    const expectMatchPayload = (actionCause: SearchPageEvents, meta = {}) => {
+    const expectMatchPayload = (actionCause: SearchPageEvents | InsightEvents, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
         const customData = {foo: 'bar', ...meta};
         expect(JSON.parse(body.toString())).toMatchObject({
@@ -74,7 +75,7 @@ describe('InsightClient', () => {
         });
     };
 
-    const expectMatchCustomEventPayload = (actionCause: SearchPageEvents, meta = {}) => {
+    const expectMatchCustomEventPayload = (actionCause: SearchPageEvents | InsightEvents, meta = {}) => {
         const [, {body}] = fetchMock.lastCall();
         const customData = {foo: 'bar', ...meta};
         expect(JSON.parse(body.toString())).toMatchObject({
@@ -295,4 +296,43 @@ describe('InsightClient', () => {
         c.enable();
         expect(c.coveoAnalyticsClient instanceof CoveoAnalyticsClient).toBe(true);
     });
+
+    it('should send proper payload for #contextChanged', async () => {
+        const meta = {
+            caseId: '1234',
+            caseNumber: '5678',
+            caseContext: {Case_Subject: 'test subject', Case_Description: 'test description'},
+        };
+
+        const expectedMeta = {
+            CaseId: '1234',
+            CaseNumber: '5678',
+            CaseSubject: 'test subject',
+            context_Case_Subject: 'test subject',
+            context_Case_Description: 'test description',
+        };
+
+        await client.logContextChanged(meta);
+        expectMatchPayload(InsightEvents.contextChanged, expectedMeta);
+    });
+
+    it('should send proper payload for #expandToFullUI', async () => {
+        const meta = {
+            caseId: '1234',
+            caseNumber: '5678',
+            caseContext: {Case_Subject: 'test subject', Case_Description: 'test description'},
+            fullSearchComponentName: 'c__FullSearch',
+            triggeredBy: 'openFullSearchButton',
+        };
+
+        const expectedMeta = {
+            CaseId: '1234',
+            CaseNumber: '5678',
+            CaseSubject: 'test subject',
+            fullSearchComponentName: 'c__FullSearch',
+            triggeredBy: 'openFullSearchButton',
+        };
+        await client.logExpandToFullUI(meta);
+        expectMatchCustomEventPayload(InsightEvents.expandToFullUI, expectedMeta);
+    });
 });

package/src/insight/insightClient.ts

@@ -17,6 +17,7 @@ import {
     CategoryFacetMetadata,
     StaticFilterToggleValueMetadata,
 } from '../searchPage/searchPageEvents';
+import {ContextChangedMetadata, ExpandToFullUIMetadata, InsightEvents} from './insightEvents';
 
 export interface InsightClientProvider {
     getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
@@ -36,6 +37,16 @@ export interface InsightClientOptions extends ClientOptions {
     enableAnalytics: boolean;
 }
 
+const extractContextFromMetadata = (meta: {caseContext: Record<string, string>}) => {
+    const context: Record<string, string> = {};
+    Object.keys(meta.caseContext).forEach((contextKey) => {
+        const keyToBeSent = `context_${contextKey}`;
+        context[keyToBeSent] = meta.caseContext[contextKey];
+    });
+
+    return context;
+};
+
 export class CoveoInsightClient {
     public coveoAnalyticsClient: AnalyticsClient;
 
@@ -107,7 +118,7 @@ export class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.queryError, meta);
     }
 
-    public async logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
+    public async logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 
         const payload: CustomEventRequest = {
@@ -119,7 +130,7 @@ export class CoveoInsightClient {
         return this.coveoAnalyticsClient.sendCustomEvent(payload);
     }
 
-    public async logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
+    public async logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>) {
         return this.coveoAnalyticsClient.sendSearchEvent(await this.getBaseSearchEventRequest(event, metadata));
     }
 
@@ -139,6 +150,33 @@ export class CoveoInsightClient {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     }
 
+    public logContextChanged(meta: ContextChangedMetadata) {
+        const context = extractContextFromMetadata(meta);
+
+        const {caseId, caseNumber} = meta;
+        const metaToBeSent = {
+            CaseId: caseId,
+            CaseNumber: caseNumber,
+            ...(!!context.context_Case_Subject && {CaseSubject: context.context_Case_Subject}),
+            ...context,
+        };
+        return this.logSearchEvent(InsightEvents.contextChanged, metaToBeSent);
+    }
+
+    public logExpandToFullUI(meta: ExpandToFullUIMetadata) {
+        const context = extractContextFromMetadata(meta);
+
+        const {caseId, caseNumber, triggeredBy, fullSearchComponentName} = meta;
+        const metaToBeSent = {
+            CaseId: caseId,
+            CaseNumber: caseNumber,
+            triggeredBy,
+            fullSearchComponentName,
+            ...(!!context.context_Case_Subject && {CaseSubject: context.context_Case_Subject}),
+        };
+        return this.logCustomEvent(InsightEvents.expandToFullUI, metaToBeSent);
+    }
+
     private async getBaseCustomEventRequest(metadata?: Record<string, any>) {
         return {
             ...(await this.getBaseEventRequest(metadata)),
@@ -147,7 +185,7 @@ export class CoveoInsightClient {
     }
 
     private async getBaseSearchEventRequest(
-        event: SearchPageEvents,
+        event: SearchPageEvents | InsightEvents,
         metadata?: Record<string, any>
     ): Promise<SearchEventRequest> {
         return {

package/src/insight/insightEvents.ts

@@ -0,0 +1,23 @@
+export enum InsightEvents {
+    /**
+     * Identifies the search event that gets logged when the query context is updated as a result of updating one of the case context fields.
+     */
+    contextChanged = 'contextChanged',
+    /**
+     * Identifies the event that gets logged when the user opens the full search page from the insight panel.
+     */
+    expandToFullUI = 'expandToFullUI',
+}
+
+interface CaseMetadata {
+    caseId: string;
+    caseNumber: string;
+    caseContext: Record<string, string>;
+}
+
+export interface ContextChangedMetadata extends CaseMetadata {}
+
+export interface ExpandToFullUIMetadata extends CaseMetadata {
+    fullSearchComponentName: string;
+    triggeredBy: string;
+}

package/src/searchPage/searchPageEvents.ts

@@ -1,4 +1,5 @@
 import {DocumentInformation, FacetStateRequest} from '../events';
+import {InsightEvents} from '../insight/insightEvents';
 
 export enum SearchPageEvents {
     /**
@@ -263,7 +264,7 @@ export enum SearchPageEvents {
     showLessFoldedResults = 'showLessFoldedResults',
 }
 
-export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
+export const CustomEventsTypes: Partial<Record<SearchPageEvents | InsightEvents, string>> = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerExecute]: 'queryPipelineTriggers',
     [SearchPageEvents.triggerQuery]: 'queryPipelineTriggers',
@@ -296,6 +297,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
     [SearchPageEvents.showLessFoldedResults]: 'folding',
+    [InsightEvents.expandToFullUI]: 'interface',
 };
 
 export interface StaticFilterMetadata {