coveo.analytics 2.19.5 → 2.19.8

package/dist/definitions/caseAssist/caseAssistActions.d.ts

@@ -40,6 +40,7 @@ export interface RateDocumentSuggestionMetadata {
 }
 export interface MoveToNextCaseStepMetadata {
     ticket: TicketProperties;
+    stage?: string;
 }
 export interface CaseCancelledMetadata {
     ticket: TicketProperties;

package/dist/definitions/caseAssist/caseAssistClient.d.ts

@@ -1,13 +1,17 @@
 import { AnalyticsClient, ClientOptions } from '../client/analytics';
 import { CaseCancelledMetadata, CaseCreatedMetadata, CaseSolvedMetadata, EnterInterfaceMetadata, MoveToNextCaseStepMetadata, RateDocumentSuggestionMetadata, SelectDocumentSuggestionMetadata, SelectFieldSuggestionMetadata, UpdateCaseFieldMetadata } from './caseAssistActions';
+export interface CaseAssistClientProvider {
+    getOriginLevel1: () => string;
+}
 export interface CaseAssistClientOptions extends ClientOptions {
     enableAnalytics?: boolean;
 }
 export declare class CaseAssistClient {
     private options;
+    private provider?;
     coveoAnalyticsClient: AnalyticsClient;
     private svc;
-    constructor(options: Partial<CaseAssistClientOptions>);
+    constructor(options: Partial<CaseAssistClientOptions>, provider?: CaseAssistClientProvider | undefined);
     disable(): void;
     enable(): void;
     logEnterInterface(meta: EnterInterfaceMetadata): Promise<void | import("../events").SearchEventResponse | import("../events").ClickEventResponse | import("../events").CustomEventResponse | import("../events").ViewEventResponse>;

package/dist/definitions/coveoua/headless.d.ts

@@ -1,5 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/analytics';
 export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export * as history from '../history';

package/dist/definitions/coveoua/library.d.ts

@@ -8,5 +8,5 @@ export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
 export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { analytics, donottrack, history, SimpleAnalytics, storage };

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

@@ -84,6 +84,8 @@ export declare class CoveoSearchPageClient {
     logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").CustomEventResponse>;
     logClearRecentResults(): Promise<void | import("../events").CustomEventResponse>;
     logNoResultsBack(): Promise<void | import("../events").SearchEventResponse>;
+    logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
+    logShowLessFoldedResults(): Promise<void | import("../events").CustomEventResponse>;
     logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logCustomEventWithType(eventValue: string, eventType: string, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
     logSearchEvent(event: SearchPageEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;

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

@@ -58,7 +58,9 @@ export declare enum SearchPageEvents {
     clearRecentQueries = "clearRecentQueries",
     recentResultClick = "recentResultClick",
     clearRecentResults = "clearRecentResults",
-    noResultsBack = "noResultsBack"
+    noResultsBack = "noResultsBack",
+    showMoreFoldedResults = "showMoreFoldedResults",
+    showLessFoldedResults = "showLessFoldedResults"
 }
 export declare const CustomEventsTypes: Partial<Record<SearchPageEvents, string>>;
 export interface StaticFilterMetadata {

package/dist/definitions/src/coveoua/headless.d.ts

@@ -1,5 +1,5 @@
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { CoveoAnalyticsClient, AnalyticsClientSendEventHook } from '../client/analytics';
 export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export * as history from '../history';

package/dist/definitions/src/coveoua/library.d.ts

@@ -8,5 +8,5 @@ export { PreprocessAnalyticsRequest } from '../client/analyticsRequestClient';
 export { IRuntimeEnvironment } from '../client/runtimeEnvironment';
 export { CoveoUA, getCurrentClient, handleOneAnalyticsEvent } from './simpleanalytics';
 export { CoveoSearchPageClient, SearchPageClientProvider } from '../searchPage/searchPageClient';
-export { CaseAssistClient } from '../caseAssist/caseAssistClient';
+export { CaseAssistClient, CaseAssistClientProvider } from '../caseAssist/caseAssistClient';
 export { analytics, donottrack, history, SimpleAnalytics, storage };

package/dist/library.es.js

@@ -1117,6 +1117,8 @@ var SearchPageEvents;
     SearchPageEvents["recentResultClick"] = "recentResultClick";
     SearchPageEvents["clearRecentResults"] = "clearRecentResults";
     SearchPageEvents["noResultsBack"] = "noResultsBack";
+    SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
+    SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
 })(SearchPageEvents || (SearchPageEvents = {}));
 const CustomEventsTypes = {
     [SearchPageEvents.triggerNotify]: 'queryPipelineTriggers',
@@ -1148,6 +1150,7 @@ const CustomEventsTypes = {
     [SearchPageEvents.clearRecentQueries]: 'recentQueries',
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
+    [SearchPageEvents.showLessFoldedResults]: 'folding',
 };
 
 class NoopAnalytics {
@@ -1430,6 +1433,12 @@ class CoveoSearchPageClient {
     logNoResultsBack() {
         return this.logSearchEvent(SearchPageEvents.noResultsBack);
     }
+    logShowMoreFoldedResults(info, identifier) {
+        return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier);
+    }
+    logShowLessFoldedResults() {
+        return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
+    }
     logCustomEvent(event, metadata) {
         return __awaiter(this, void 0, void 0, function* () {
             const customData = Object.assign(Object.assign({}, this.provider.getBaseMetadata()), metadata);
@@ -1654,9 +1663,10 @@ var CaseCancelledReasons;
 })(CaseCancelledReasons || (CaseCancelledReasons = {}));
 
 class CaseAssistClient {
-    constructor(options) {
+    constructor(options, provider) {
         var _a;
         this.options = options;
+        this.provider = provider;
         const analyticsEnabled = (_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true;
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
@@ -1700,7 +1710,9 @@ class CaseAssistClient {
         return this.sendClickEvent();
     }
     logMoveToNextCaseStep(meta) {
-        this.svc.setAction(CaseAssistActions.nextCaseStep);
+        this.svc.setAction(CaseAssistActions.nextCaseStep, {
+            stage: meta === null || meta === void 0 ? void 0 : meta.stage,
+        });
         this.svc.setTicket(meta.ticket);
         return this.sendClickEvent();
     }
@@ -1724,10 +1736,18 @@ class CaseAssistClient {
         return this.sendClickEvent();
     }
     sendFlowStartEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     }
     sendClickEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     }
 }
 

package/dist/library.js

@@ -83559,6 +83559,8 @@ var SearchPageEvents;
     SearchPageEvents["recentResultClick"] = "recentResultClick";
     SearchPageEvents["clearRecentResults"] = "clearRecentResults";
     SearchPageEvents["noResultsBack"] = "noResultsBack";
+    SearchPageEvents["showMoreFoldedResults"] = "showMoreFoldedResults";
+    SearchPageEvents["showLessFoldedResults"] = "showLessFoldedResults";
 })(SearchPageEvents || (SearchPageEvents = {}));
 var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.triggerNotify] = 'queryPipelineTriggers',
@@ -83590,6 +83592,7 @@ var CustomEventsTypes = (_a = {},
     _a[SearchPageEvents.clearRecentQueries] = 'recentQueries',
     _a[SearchPageEvents.recentResultClick] = 'recentlyClickedDocuments',
     _a[SearchPageEvents.clearRecentResults] = 'recentlyClickedDocuments',
+    _a[SearchPageEvents.showLessFoldedResults] = 'folding',
     _a);
 
 var NoopAnalytics = (function () {
@@ -83891,6 +83894,12 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logNoResultsBack = function () {
         return this.logSearchEvent(SearchPageEvents.noResultsBack);
     };
+    CoveoSearchPageClient.prototype.logShowMoreFoldedResults = function (info, identifier) {
+        return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier);
+    };
+    CoveoSearchPageClient.prototype.logShowLessFoldedResults = function () {
+        return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
+    };
     CoveoSearchPageClient.prototype.logCustomEvent = function (event, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             var customData, payload, _a;
@@ -84034,9 +84043,10 @@ var CaseCancelledReasons;
 })(CaseCancelledReasons || (CaseCancelledReasons = {}));
 
 var CaseAssistClient = (function () {
-    function CaseAssistClient(options) {
+    function CaseAssistClient(options, provider) {
         var _a;
         this.options = options;
+        this.provider = provider;
         var analyticsEnabled = (_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true;
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
@@ -84080,7 +84090,9 @@ var CaseAssistClient = (function () {
         return this.sendClickEvent();
     };
     CaseAssistClient.prototype.logMoveToNextCaseStep = function (meta) {
-        this.svc.setAction(CaseAssistActions.nextCaseStep);
+        this.svc.setAction(CaseAssistActions.nextCaseStep, {
+            stage: meta === null || meta === void 0 ? void 0 : meta.stage,
+        });
         this.svc.setTicket(meta.ticket);
         return this.sendClickEvent();
     };
@@ -84104,10 +84116,18 @@ var CaseAssistClient = (function () {
         return this.sendClickEvent();
     };
     CaseAssistClient.prototype.sendFlowStartEvent = function () {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     };
     CaseAssistClient.prototype.sendClickEvent = function () {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click, this.provider
+            ? {
+                searchHub: this.provider.getOriginLevel1(),
+            }
+            : null);
     };
     return CaseAssistClient;
 }());

package/package.json

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

package/src/caseAssist/caseAssistActions.ts

@@ -49,6 +49,7 @@ export interface RateDocumentSuggestionMetadata {
 
 export interface MoveToNextCaseStepMetadata {
     ticket: TicketProperties;
+    stage?: string;
 }
 
 export interface CaseCancelledMetadata {

package/src/caseAssist/caseAssistClient.spec.ts

@@ -1,4 +1,4 @@
-import {CaseAssistClient} from './caseAssistClient';
+import {CaseAssistClient, CaseAssistClientProvider} from './caseAssistClient';
 import {
     CaseAssistActions,
     CaseAssistEvents,
@@ -13,8 +13,13 @@ import {TicketProperties} from '../plugins/svc';
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 
 describe('CaseAssistClient', () => {
+    const defaultSearchHub = 'origin-level-1';
     let client: CaseAssistClient;
 
+    const provider: CaseAssistClientProvider = {
+        getOriginLevel1: () => defaultSearchHub,
+    };
+
     beforeEach(() => {
         fetchMockBeforeEach();
 
@@ -29,9 +34,12 @@ describe('CaseAssistClient', () => {
     });
 
     const initClient = () => {
-        return new CaseAssistClient({
-            enableAnalytics: true,
-        });
+        return new CaseAssistClient(
+            {
+                enableAnalytics: true,
+            },
+            provider
+        );
     };
 
     const noTicket: Record<string, unknown> = undefined;
@@ -82,6 +90,7 @@ describe('CaseAssistClient', () => {
 
         expectMatchActionPayload(content, actionName, actionData);
         expectMatchTicketPayload(content, ticket);
+        expectMatchProperty(content, 'searchHub', defaultSearchHub);
     };
 
     const expectMatchActionPayload = (
@@ -254,11 +263,14 @@ describe('CaseAssistClient', () => {
     });
 
     it('should send proper payload for #logMoveToNextCaseStep', async () => {
+        const stageName = 'stage 1';
+
         await client.logMoveToNextCaseStep({
             ticket: fakeTicket,
+            stage: stageName,
         });
 
-        expectMatchPayload(CaseAssistActions.nextCaseStep, noActionData, fakeTicket);
+        expectMatchPayload(CaseAssistActions.nextCaseStep, {stage: stageName}, fakeTicket);
     });
 
     it('should send proper payload for #logCaseCancelled', async () => {

package/src/caseAssist/caseAssistClient.ts

@@ -16,6 +16,10 @@ import {
     UpdateCaseFieldMetadata,
 } from './caseAssistActions';
 
+export interface CaseAssistClientProvider {
+    getOriginLevel1: () => string;
+}
+
 export interface CaseAssistClientOptions extends ClientOptions {
     enableAnalytics?: boolean;
 }
@@ -24,7 +28,7 @@ export class CaseAssistClient {
     public coveoAnalyticsClient: AnalyticsClient;
     private svc: SVCPlugin;
 
-    constructor(private options: Partial<CaseAssistClientOptions>) {
+    constructor(private options: Partial<CaseAssistClientOptions>, private provider?: CaseAssistClientProvider) {
         const analyticsEnabled = options.enableAnalytics ?? true;
 
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
@@ -80,7 +84,9 @@ export class CaseAssistClient {
     }
 
     public logMoveToNextCaseStep(meta: MoveToNextCaseStepMetadata) {
-        this.svc.setAction(CaseAssistActions.nextCaseStep);
+        this.svc.setAction(CaseAssistActions.nextCaseStep, {
+            stage: meta?.stage,
+        });
         this.svc.setTicket(meta.ticket);
         return this.sendClickEvent();
     }
@@ -108,10 +114,28 @@ export class CaseAssistClient {
     }
 
     private sendFlowStartEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.flowStart);
+        return this.coveoAnalyticsClient.sendEvent(
+            'event',
+            'svc',
+            CaseAssistEvents.flowStart,
+            this.provider
+                ? {
+                      searchHub: this.provider.getOriginLevel1(),
+                  }
+                : null
+        );
     }
 
     private sendClickEvent() {
-        return this.coveoAnalyticsClient.sendEvent('event', 'svc', CaseAssistEvents.click);
+        return this.coveoAnalyticsClient.sendEvent(
+            'event',
+            'svc',
+            CaseAssistEvents.click,
+            this.provider
+                ? {
+                      searchHub: this.provider.getOriginLevel1(),
+                  }
+                : null
+        );
     }
 }

package/src/coveoua/headless.ts

@@ -1,5 +1,5 @@
 export {CoveoSearchPageClient, SearchPageClientProvider} from '../searchPage/searchPageClient';
-export {CaseAssistClient} from '../caseAssist/caseAssistClient';
+export {CaseAssistClient, CaseAssistClientProvider} from '../caseAssist/caseAssistClient';
 export {CoveoAnalyticsClient, AnalyticsClientSendEventHook} from '../client/analytics';
 export {PreprocessAnalyticsRequest} from '../client/analyticsRequestClient';
 export * as history from '../history';

package/src/coveoua/library.ts

@@ -8,6 +8,6 @@ export {PreprocessAnalyticsRequest} from '../client/analyticsRequestClient';
 export {IRuntimeEnvironment} from '../client/runtimeEnvironment';
 export {CoveoUA, getCurrentClient, handleOneAnalyticsEvent} from './simpleanalytics';
 export {CoveoSearchPageClient, SearchPageClientProvider} from '../searchPage/searchPageClient';
-export {CaseAssistClient} from '../caseAssist/caseAssistClient';
+export {CaseAssistClient, CaseAssistClientProvider} from '../caseAssist/caseAssistClient';
 
 export {analytics, donottrack, history, SimpleAnalytics, storage};

package/src/searchPage/searchPageClient.spec.ts

@@ -205,6 +205,16 @@ describe('SearchPageClient', () => {
         expectMatchDocumentPayload(SearchPageEvents.documentOpen, fakeDocInfo, fakeDocID);
     });
 
+    it('should send proper payload for #showMoreFoldedResults', async () => {
+        await client.logShowMoreFoldedResults(fakeDocInfo, fakeDocID);
+        expectMatchDocumentPayload(SearchPageEvents.showMoreFoldedResults, fakeDocInfo, fakeDocID);
+    });
+
+    it('should send proper payload for #showLessFoldedResults', async () => {
+        await client.logShowLessFoldedResults();
+        expectMatchCustomEventPayload(SearchPageEvents.showLessFoldedResults);
+    });
+
     it('should send proper payload for #omniboxAnalytics', async () => {
         const meta: OmniboxSuggestionsMetadata = {
             partialQueries: 'a;b;c',

package/src/searchPage/searchPageClient.ts

@@ -310,6 +310,14 @@ export class CoveoSearchPageClient {
         return this.logSearchEvent(SearchPageEvents.noResultsBack);
     }
 
+    public logShowMoreFoldedResults(info: PartialDocumentInformation, identifier: DocumentIdentifier) {
+        return this.logClickEvent(SearchPageEvents.showMoreFoldedResults, info, identifier);
+    }
+
+    public logShowLessFoldedResults() {
+        return this.logCustomEvent(SearchPageEvents.showLessFoldedResults);
+    }
+
     public async logCustomEvent(event: SearchPageEvents, metadata?: Record<string, any>) {
         const customData = {...this.provider.getBaseMetadata(), ...metadata};
 

package/src/searchPage/searchPageEvents.ts

@@ -237,6 +237,14 @@ export enum SearchPageEvents {
      * Identifies the search event that gets logged when a user clicks the Cancel last action link when no results are returned following their last action.
      */
     noResultsBack = 'noResultsBack',
+    /**
+     * Identifies the click event that gets logged when a user clicks the Show More link under a search result that support the folding component.
+     */
+    showMoreFoldedResults = 'showMoreFoldedResults',
+    /**
+     * Identifies the custom event that gets logged when a user clicks the Show Less link under a search result that support the folding component.
+     */
+    showLessFoldedResults = 'showLessFoldedResults',
 }
 
 export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
@@ -269,6 +277,7 @@ export const CustomEventsTypes: Partial<Record<SearchPageEvents, string>> = {
     [SearchPageEvents.clearRecentQueries]: 'recentQueries',
     [SearchPageEvents.recentResultClick]: 'recentlyClickedDocuments',
     [SearchPageEvents.clearRecentResults]: 'recentlyClickedDocuments',
+    [SearchPageEvents.showLessFoldedResults]: 'folding',
 };
 
 export interface StaticFilterMetadata {