coveo.analytics 2.19.3 → 2.19.6

package/dist/react-native.es.js

@@ -2,18 +2,18 @@ import { fetch } from 'cross-fetch';
 import AsyncStorage from '@react-native-async-storage/async-storage';
 
 /*! *****************************************************************************
-Copyright (c) Microsoft Corporation. All rights reserved.
-Licensed under the Apache License, Version 2.0 (the "License"); you may not use
-this file except in compliance with the License. You may obtain a copy of the
-License at http://www.apache.org/licenses/LICENSE-2.0
+Copyright (c) Microsoft Corporation.
 
-THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
-WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
-MERCHANTABLITY OR NON-INFRINGEMENT.
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
 
-See the Apache Version 2.0 License for specific language governing permissions
-and limitations under the License.
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
 
 function __rest(s, e) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.19.3",
+    "version": "2.19.6",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -57,6 +57,9 @@
         "tsjs": "1.0.3",
         "typescript": "^3.8.3"
     },
+    "overrides": {
+        "plist": "3.0.5"
+    },
     "files": [
         "dist/**/*.d.ts",
         "dist/**/*.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};

package/src/searchPage/searchPageClient.spec.ts

@@ -527,6 +527,11 @@ describe('SearchPageClient', () => {
         });
     });
 
+    it('should send proper payload for #logOpenSmartSnippetSource', async () => {
+        await client.logOpenSmartSnippetSource(fakeDocInfo, fakeDocID);
+        expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
+    });
+
     it('should send proper payload for #logRecentQueryClick', async () => {
         await client.logRecentQueryClick();
         expectMatchPayload(SearchPageEvents.recentQueryClick);

package/src/searchPage/searchPageClient.ts

@@ -286,6 +286,10 @@ export class CoveoSearchPageClient {
         return this.logCustomEvent(SearchPageEvents.collapseSmartSnippetSuggestion, {documentId});
     }
 
+    public logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
+    }
+
     public logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }

package/src/searchPage/searchPageEvents.ts

@@ -213,6 +213,10 @@ export enum SearchPageEvents {
      * Identifies the custom event that gets logged when a snippet suggestion for a related question is collapsed.
      */
     collapseSmartSnippetSuggestion = 'collapseSmartSnippetSuggestion',
+    /**
+     * Identifies the custom event that gets logged when a user clicks on the source of an answer in a smart snippet.
+     */
+    openSmartSnippetSource = 'openSmartSnippetSource',
     /**
      * Identifies the search event that gets logged when a recent queries list item gets clicked.
      */

package/dist/definitions/src/client/location.d.ts

@@ -1 +0,0 @@
-export declare const getFormattedLocation: (location: Location) => string;