coveo.analytics 2.19.16 → 2.20.1

package/dist/library.es.js

@@ -1235,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) {
@@ -1681,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

@@ -83678,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) {
@@ -84061,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.16",
+    "version": "2.20.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

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', () => {
@@ -651,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() {