coveo.analytics 2.19.14 → 2.20.1

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

@@ -81,6 +81,7 @@ export declare class CoveoSearchPageClient {
     logShowMoreSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
     logShowLessSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").CustomEventResponse>;
     logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta): Promise<void | import("../events").ClickEventResponse>;
     logRecentQueryClick(): Promise<void | import("../events").SearchEventResponse>;
     logClearRecentQueries(): Promise<void | import("../events").CustomEventResponse>;
     logRecentResultClick(info: PartialDocumentInformation, identifier: DocumentIdentifier): Promise<void | import("../events").CustomEventResponse>;

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

@@ -56,6 +56,7 @@ export declare enum SearchPageEvents {
     showMoreSmartSnippetSuggestion = "showMoreSmartSnippetSuggestion",
     showLessSmartSnippetSuggestion = "showLessSmartSnippetSuggestion",
     openSmartSnippetSource = "openSmartSnippetSource",
+    openSmartSnippetSuggestionSource = "openSmartSnippetSuggestionSource",
     recentQueryClick = "recentQueriesClick",
     clearRecentQueries = "clearRecentQueries",
     recentResultClick = "recentResultClick",

package/dist/library.es.js

@@ -1114,6 +1114,7 @@ var SearchPageEvents;
     SearchPageEvents["showMoreSmartSnippetSuggestion"] = "showMoreSmartSnippetSuggestion";
     SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
+    SearchPageEvents["openSmartSnippetSuggestionSource"] = "openSmartSnippetSuggestionSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -1234,8 +1235,8 @@ class CoveoSearchPageClient {
     constructor(opts, provider) {
         this.opts = opts;
         this.provider = provider;
-        this.coveoAnalyticsClient =
-            opts.enableAnalytics === false ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
+        const shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
+        this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
     }
     disable() {
         if (this.coveoAnalyticsClient instanceof CoveoAnalyticsClient) {
@@ -1428,6 +1429,9 @@ class CoveoSearchPageClient {
     logOpenSmartSnippetSource(info, identifier) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
     }
+    logOpenSmartSnippetSuggestionSource(info, snippet) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
+    }
     logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }
@@ -1677,7 +1681,7 @@ class CaseAssistClient {
         var _a;
         this.options = options;
         this.provider = provider;
-        const analyticsEnabled = (_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true;
+        const analyticsEnabled = ((_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true) && !doNotTrack();
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
     }

package/dist/library.js

@@ -83556,6 +83556,7 @@ var SearchPageEvents;
     SearchPageEvents["showMoreSmartSnippetSuggestion"] = "showMoreSmartSnippetSuggestion";
     SearchPageEvents["showLessSmartSnippetSuggestion"] = "showLessSmartSnippetSuggestion";
     SearchPageEvents["openSmartSnippetSource"] = "openSmartSnippetSource";
+    SearchPageEvents["openSmartSnippetSuggestionSource"] = "openSmartSnippetSuggestionSource";
     SearchPageEvents["recentQueryClick"] = "recentQueriesClick";
     SearchPageEvents["clearRecentQueries"] = "clearRecentQueries";
     SearchPageEvents["recentResultClick"] = "recentResultClick";
@@ -83677,8 +83678,8 @@ var CoveoSearchPageClient = (function () {
     function CoveoSearchPageClient(opts, provider) {
         this.opts = opts;
         this.provider = provider;
-        this.coveoAnalyticsClient =
-            opts.enableAnalytics === false ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
+        var shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
+        this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
     }
     CoveoSearchPageClient.prototype.disable = function () {
         if (this.coveoAnalyticsClient instanceof CoveoAnalyticsClient) {
@@ -83889,6 +83890,9 @@ var CoveoSearchPageClient = (function () {
     CoveoSearchPageClient.prototype.logOpenSmartSnippetSource = function (info, identifier) {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
     };
+    CoveoSearchPageClient.prototype.logOpenSmartSnippetSuggestionSource = function (info, snippet) {
+        return this.logClickEvent(SearchPageEvents.openSmartSnippetSuggestionSource, info, { contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue }, snippet);
+    };
     CoveoSearchPageClient.prototype.logRecentQueryClick = function () {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     };
@@ -84057,7 +84061,7 @@ var CaseAssistClient = (function () {
         var _a;
         this.options = options;
         this.provider = provider;
-        var analyticsEnabled = (_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true;
+        var analyticsEnabled = ((_a = options.enableAnalytics) !== null && _a !== void 0 ? _a : true) && !doNotTrack();
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({ client: this.coveoAnalyticsClient });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.19.14",
+    "version": "2.20.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -23,7 +23,7 @@
     },
     "license": "MIT",
     "dependencies": {
-        "@react-native-async-storage/async-storage": "^1.17.3",
+        "@react-native-async-storage/async-storage": "^1.17.5",
         "cross-fetch": "^3.1.5"
     },
     "devDependencies": {

package/src/caseAssist/caseAssistClient.spec.ts

@@ -6,11 +6,16 @@ import {
     DocumentSuggestion,
     FieldSuggestion,
 } from './caseAssistActions';
-
 import {mockFetch} from '../../tests/fetchMock';
 import {TicketProperties} from '../plugins/svc';
-
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
+import doNotTrack from '../donottrack';
+jest.mock('../donottrack', () => {
+    return {
+        default: jest.fn(),
+        doNotTrack: jest.fn(),
+    };
+});
 
 describe('CaseAssistClient', () => {
     const defaultSearchHub = 'origin-level-1';
@@ -151,6 +156,18 @@ describe('CaseAssistClient', () => {
         expect(fetchMock.called()).toBe(false);
     });
 
+    it('should not send events when doNotTrack is enabled', async () => {
+        (doNotTrack as jest.Mock).mockImplementationOnce(() => true);
+
+        client = new CaseAssistClient({});
+
+        await client.logEnterInterface({
+            ticket: emptyTicket,
+        });
+
+        expect(fetchMock.called()).toBe(false);
+    });
+
     it('should not send events after #disable function is called', async () => {
         client.disable();
 

package/src/caseAssist/caseAssistClient.ts

@@ -1,5 +1,6 @@
 import CoveoAnalyticsClient, {AnalyticsClient, ClientOptions} from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
+import doNotTrack from '../donottrack';
 import {SVCPlugin} from '../plugins/svc';
 import {
     CaseAssistActions,
@@ -29,7 +30,7 @@ export class CaseAssistClient {
     private svc: SVCPlugin;
 
     constructor(private options: Partial<CaseAssistClientOptions>, private provider?: CaseAssistClientProvider) {
-        const analyticsEnabled = options.enableAnalytics ?? true;
+        const analyticsEnabled = (options.enableAnalytics ?? true) && !doNotTrack();
 
         this.coveoAnalyticsClient = analyticsEnabled ? new CoveoAnalyticsClient(options) : new NoopAnalytics();
         this.svc = new SVCPlugin({client: this.coveoAnalyticsClient});

package/src/searchPage/searchPageClient.spec.ts

@@ -10,7 +10,13 @@ import {
 import CoveoAnalyticsClient from '../client/analytics';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {mockFetch} from '../../tests/fetchMock';
-
+import doNotTrack from '../donottrack';
+jest.mock('../donottrack', () => {
+    return {
+        default: jest.fn(),
+        doNotTrack: jest.fn(),
+    };
+});
 const {fetchMock, fetchMockBeforeEach} = mockFetch();
 
 describe('SearchPageClient', () => {
@@ -594,6 +600,20 @@ describe('SearchPageClient', () => {
         expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSource, fakeDocInfo, fakeDocID);
     });
 
+    it('should send proper payload for #logOpenSmartSnippetSuggestionSource', async () => {
+        const meta = {
+            question: 'Abc',
+            answerSnippet: 'Def',
+            documentId: {contentIdKey: 'permanentid', contentIdValue: 'foo'},
+        };
+        await client.logOpenSmartSnippetSuggestionSource(fakeDocInfo, meta);
+        expectMatchDocumentPayload(SearchPageEvents.openSmartSnippetSuggestionSource, fakeDocInfo, {
+            ...meta,
+            contentIDKey: meta.documentId.contentIdKey,
+            contentIDValue: meta.documentId.contentIdValue,
+        });
+    });
+
     it('should send proper payload for #logRecentQueryClick', async () => {
         await client.logRecentQueryClick();
         expectMatchPayload(SearchPageEvents.recentQueryClick);
@@ -637,6 +657,13 @@ describe('SearchPageClient', () => {
         expect(c.coveoAnalyticsClient instanceof NoopAnalytics).toBe(true);
     });
 
+    it('should disable analytics when doNotTrack is enabled', async () => {
+        (doNotTrack as jest.Mock).mockImplementationOnce(() => true);
+
+        const c = new CoveoSearchPageClient({}, provider);
+        expect(c.coveoAnalyticsClient instanceof NoopAnalytics).toBe(true);
+    });
+
     it('should allow disabling analytics after initialization', () => {
         const c = new CoveoSearchPageClient({enableAnalytics: true}, provider);
         expect(c.coveoAnalyticsClient instanceof CoveoAnalyticsClient).toBe(true);

package/src/searchPage/searchPageClient.ts

@@ -28,6 +28,7 @@ import {
 } from './searchPageEvents';
 import {NoopAnalytics} from '../client/noopAnalytics';
 import {formatOmniboxMetadata} from '../formatting/format-omnibox-metadata';
+import doNotTrack from '../donottrack';
 
 export interface SearchPageClientProvider {
     getBaseMetadata: () => Record<string, any>;
@@ -51,8 +52,8 @@ export class CoveoSearchPageClient {
     public coveoAnalyticsClient: AnalyticsClient;
 
     constructor(private opts: Partial<SearchPageClientOptions>, private provider: SearchPageClientProvider) {
-        this.coveoAnalyticsClient =
-            opts.enableAnalytics === false ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
+        const shouldDisableAnalytics = opts.enableAnalytics === false || doNotTrack();
+        this.coveoAnalyticsClient = shouldDisableAnalytics ? new NoopAnalytics() : new CoveoAnalyticsClient(opts);
     }
 
     public disable() {
@@ -311,6 +312,15 @@ export class CoveoSearchPageClient {
         return this.logClickEvent(SearchPageEvents.openSmartSnippetSource, info, identifier);
     }
 
+    public logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta) {
+        return this.logClickEvent(
+            SearchPageEvents.openSmartSnippetSuggestionSource,
+            info,
+            {contentIDKey: snippet.documentId.contentIdKey, contentIDValue: snippet.documentId.contentIdValue},
+            snippet
+        );
+    }
+
     public logRecentQueryClick() {
         return this.logSearchEvent(SearchPageEvents.recentQueryClick);
     }

package/src/searchPage/searchPageEvents.ts

@@ -229,6 +229,10 @@ export enum SearchPageEvents {
      * 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 custom event that gets logged when a user clicks on the source of a snippet suggestion for a related question.
+     */
+    openSmartSnippetSuggestionSource = 'openSmartSnippetSuggestionSource',
     /**
      * Identifies the search event that gets logged when a recent queries list item gets clicked.
      */