coveo.analytics 2.19.5 → 2.19.6

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/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

@@ -1654,9 +1654,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 });
@@ -1724,10 +1725,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

@@ -84034,9 +84034,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 });
@@ -84104,10 +84105,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.6",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

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 = (

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();
@@ -108,10 +112,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};