coveo.analytics 2.20.13 → 2.20.16

package/dist/definitions/insight/insightClient.d.ts

@@ -43,7 +43,10 @@ export declare class CoveoInsightClient {
     logPagerNumber(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerNext(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
     logPagerPrevious(meta: PagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDidYouMeanAutomatic(): Promise<void | import("../events").SearchEventResponse>;
+    logDidYouMeanClick(): Promise<void | import("../events").SearchEventResponse>;
     logResultsSort(metadata: ResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logSearchboxSubmit(): Promise<void | import("../events").SearchEventResponse>;
     logContextChanged(meta: ContextChangedMetadata): Promise<void | import("../events").SearchEventResponse>;
     logExpandToFullUI(meta: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
     private getBaseCustomEventRequest;

package/dist/definitions/react-native/react-native-utils.d.ts

@@ -1,2 +1,2 @@
-export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/react-native';\n        \n        const analytics = new CoveoAnalytics({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime();\n        })\n    ";
+export declare const ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';\n        \n        const analytics = new CoveoAnalyticsClient({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime({\n                baseUrl: '...',\n            });\n        })\n    ";
 export declare function isReactNative(): boolean;

package/dist/library.es.js

@@ -751,11 +751,13 @@ const ReactNativeRuntimeWarning = `
         for an optimal experience please install @react-native-async-storage/async-storage and instantiate 
         your analytics client as follows:
         
-        import {ReactNativeRuntime} from 'coveo.analytics/react-native';
+        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';
         
-        const analytics = new CoveoAnalytics({
+        const analytics = new CoveoAnalyticsClient({
             ...your options,
-            runtimeEnvironment: new ReactNativeRuntime();
+            runtimeEnvironment: new ReactNativeRuntime({
+                baseUrl: '...',
+            });
         })
     `;
 function isReactNative() {
@@ -1879,9 +1881,18 @@ class CoveoInsightClient {
     logPagerPrevious(meta) {
         return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
     }
+    logDidYouMeanAutomatic() {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
+    }
+    logDidYouMeanClick() {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
+    }
     logResultsSort(metadata) {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     }
+    logSearchboxSubmit() {
+        return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
+    }
     logContextChanged(meta) {
         const context = extractContextFromMetadata(meta);
         const { caseId, caseNumber } = meta;

package/dist/library.js

@@ -82507,7 +82507,7 @@ var NoopRuntime = (function () {
 var API_KEY_PREFIX = 'xx';
 var isApiKey = function (token) { return (token === null || token === void 0 ? void 0 : token.startsWith(API_KEY_PREFIX)) || false; };
 
-var ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/react-native';\n        \n        const analytics = new CoveoAnalytics({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime();\n        })\n    ";
+var ReactNativeRuntimeWarning = "\n        We've detected you're using React Native but have not provided the corresponding runtime, \n        for an optimal experience please install @react-native-async-storage/async-storage and instantiate \n        your analytics client as follows:\n        \n        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';\n        \n        const analytics = new CoveoAnalyticsClient({\n            ...your options,\n            runtimeEnvironment: new ReactNativeRuntime({\n                baseUrl: '...',\n            });\n        })\n    ";
 function isReactNative() {
     return typeof navigator != 'undefined' && navigator.product == 'ReactNative';
 }
@@ -84288,9 +84288,18 @@ var CoveoInsightClient = (function () {
     CoveoInsightClient.prototype.logPagerPrevious = function (meta) {
         return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
     };
+    CoveoInsightClient.prototype.logDidYouMeanAutomatic = function () {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
+    };
+    CoveoInsightClient.prototype.logDidYouMeanClick = function () {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
+    };
     CoveoInsightClient.prototype.logResultsSort = function (metadata) {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     };
+    CoveoInsightClient.prototype.logSearchboxSubmit = function () {
+        return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
+    };
     CoveoInsightClient.prototype.logContextChanged = function (meta) {
         var context = extractContextFromMetadata(meta);
         var caseId = meta.caseId, caseNumber = meta.caseNumber;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.20.13",
+    "version": "2.20.16",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -12,7 +12,7 @@
         "build": "rollup -c",
         "start": "rollup -c -w --environment SERVE",
         "test": "jest --clearCache && jest --coverage",
-        "test:watch": "jest --watch",
+        "test:watch": "jest --clearCache && jest --watch",
         "prepare-deploy": "mkdir -p deploy && cp dist/coveoua*.js dist/coveoua*.js.map deploy",
         "clean": "rimraf -rf dist dist_test coverage"
     },

package/src/client/analytics.spec.ts

@@ -4,7 +4,7 @@ import {IAnalyticsRequestOptions} from './analyticsRequestClient';
 import {CookieAndLocalStorage, CookieStorage, NullStorage} from '../storage';
 import HistoryStore from '../history';
 import {mockFetch} from '../../tests/fetchMock';
-import {BrowserRuntime, NoopRuntime} from './runtimeEnvironment';
+import {BrowserRuntime} from './runtimeEnvironment';
 import * as doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
 

package/src/insight/insightClient.spec.ts

@@ -261,11 +261,26 @@ describe('InsightClient', () => {
         expectMatchCustomEventPayload(SearchPageEvents.pagerPrevious, meta);
     });
 
+    it('should send proper payload for #didyoumeanAutomatic', async () => {
+        await client.logDidYouMeanAutomatic();
+        expectMatchPayload(SearchPageEvents.didyoumeanAutomatic);
+    });
+
+    it('should send proper payload for #didyoumeanClick', async () => {
+        await client.logDidYouMeanClick();
+        expectMatchPayload(SearchPageEvents.didyoumeanClick);
+    });
+
     it('should send proper payload for #resultsSort', async () => {
         await client.logResultsSort({resultsSortBy: 'date ascending'});
         expectMatchPayload(SearchPageEvents.resultsSort, {resultsSortBy: 'date ascending'});
     });
 
+    it('should send proper payload for #searchboxSubmit', async () => {
+        await client.logSearchboxSubmit();
+        expectMatchPayload(SearchPageEvents.searchboxSubmit);
+    });
+
     it('should enable analytics tracking by default', () => {
         const c = new CoveoInsightClient({}, provider);
         expect(c.coveoAnalyticsClient instanceof CoveoAnalyticsClient).toBe(true);

package/src/insight/insightClient.ts

@@ -146,10 +146,22 @@ export class CoveoInsightClient {
         return this.logCustomEvent(SearchPageEvents.pagerPrevious, meta);
     }
 
+    public logDidYouMeanAutomatic() {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanAutomatic);
+    }
+
+    public logDidYouMeanClick() {
+        return this.logSearchEvent(SearchPageEvents.didyoumeanClick);
+    }
+
     public logResultsSort(metadata: ResultsSortMetadata) {
         return this.logSearchEvent(SearchPageEvents.resultsSort, metadata);
     }
 
+    public logSearchboxSubmit() {
+        return this.logSearchEvent(SearchPageEvents.searchboxSubmit);
+    }
+
     public logContextChanged(meta: ContextChangedMetadata) {
         const context = extractContextFromMetadata(meta);
 

package/src/react-native/index.ts

@@ -1,2 +1,3 @@
+// TODO: v3 add in "coveo.analytics/react-native" subpackage
 export {ReactNativeRuntime} from './react-native-runtime';
 export {ReactNativeStorage} from './react-native-storage';

package/src/react-native/react-native-runtime.ts

@@ -8,6 +8,8 @@ export class ReactNativeRuntime implements IRuntimeEnvironment {
     public storage: WebStorage;
     public client: AnalyticsFetchClient;
 
+    // TODO: v3 switch to ClientOptions type, add default options
+    // TODO: v3 reuse own ReactNativeStorage to implement VisitorIdProvider's getCurrentVisitorId, setCurrentVisitorId
     constructor(clientOptions: IAnalyticsClientOptions) {
         this.storage = new ReactNativeStorage();
         this.client = new AnalyticsFetchClient(clientOptions);

package/src/react-native/react-native-utils.ts

@@ -3,11 +3,13 @@ export const ReactNativeRuntimeWarning = `
         for an optimal experience please install @react-native-async-storage/async-storage and instantiate 
         your analytics client as follows:
         
-        import {ReactNativeRuntime} from 'coveo.analytics/react-native';
+        import {ReactNativeRuntime} from 'coveo.analytics/src/react-native';
         
-        const analytics = new CoveoAnalytics({
+        const analytics = new CoveoAnalyticsClient({
             ...your options,
-            runtimeEnvironment: new ReactNativeRuntime();
+            runtimeEnvironment: new ReactNativeRuntime({
+                baseUrl: '...',
+            });
         })
     `;
 

package/src/react-native/react-native.spec.ts

@@ -0,0 +1,27 @@
+import CoveoAnalyticsClient from '../client/analytics';
+import {ReactNativeRuntime} from './index';
+
+describe('ReactNativeRuntime', () => {
+    let runtimeEnvironment: ReactNativeRuntime;
+    let client: CoveoAnalyticsClient;
+
+    beforeEach(() => {
+        runtimeEnvironment = new ReactNativeRuntime({
+            baseUrl: 'https://www.coveo.com',
+            visitorIdProvider: {getCurrentVisitorId: jest.fn(), setCurrentVisitorId: jest.fn()},
+        });
+        client = new CoveoAnalyticsClient({runtimeEnvironment});
+    });
+
+    it('should call "storage.getItem" when getting the visitor ID', async () => {
+        spyOn(runtimeEnvironment.storage, 'getItem');
+        await client.getCurrentVisitorId();
+        expect(runtimeEnvironment.storage.getItem).toHaveBeenCalled();
+    });
+
+    it('should call "storage.getItem" when getting the visitor ID', async () => {
+        spyOn(runtimeEnvironment.storage, 'setItem');
+        await client.setCurrentVisitorId('myid');
+        expect(runtimeEnvironment.storage.setItem).toHaveBeenCalled();
+    });
+});