coveo.analytics 2.26.6 → 2.27.1

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.26.6",
+    "version": "2.27.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",
@@ -28,38 +28,37 @@
         "react-native-get-random-values": "^1.8.0"
     },
     "devDependencies": {
-        "@rollup/plugin-alias": "^3.1.2",
-        "@rollup/plugin-commonjs": "^19.0.0",
-        "@rollup/plugin-json": "^4.1.0",
-        "@rollup/plugin-node-resolve": "^13.0.0",
+        "@rollup/plugin-alias": "^5.0.0",
+        "@rollup/plugin-commonjs": "^24.1.0",
+        "@rollup/plugin-json": "^6.0.0",
+        "@rollup/plugin-node-resolve": "^15.0.2",
         "@rollup/plugin-replace": "^5.0.2",
-        "@types/fetch-mock": "^7.3.2",
-        "@types/jest": "^25.1.1",
-        "@types/jsdom": "^12.2.4",
+        "@rollup/plugin-terser": "^0.4.1",
+        "@types/fetch-mock": "^7.3.5",
+        "@types/jest": "^29.1.0",
+        "@types/jsdom": "^21.1.1",
         "@types/mime": "0.0.29",
         "@types/node": "^6.0.45",
         "@types/uuid": "^9.0.0",
-        "babel-core": "^6.17.0",
-        "babel-loader": "^7.1.4",
-        "babel-preset-es2015": "^6.16.0",
-        "babel-register": "^6.24.1",
-        "coveralls": "^3.0.3",
-        "exports-loader": "0.6.3",
-        "fetch-mock": "^9.0.0-beta.2",
+        "@babel/core": "^7.19.6",
+        "@babel/register": "^7.21.0",
+        "@babel/preset-env": "7.21.4",
+        "coveralls": "^3.1.1",
+        "exports-loader": "0.6.4",
+        "fetch-mock": "^9.11.0",
         "husky": "^4.3.0",
-        "jest": "^25.1.0",
-        "jsdom": "^15.0.0",
-        "lint-staged": "^10.5.1",
-        "prettier": "2.1.2",
+        "jest": "^29.1.0",
+        "jsdom": "^21.1.1",
+        "jest-environment-jsdom": "^29.5.0",
+        "lint-staged": "^13.2.1",
+        "prettier": "^2.8.7",
         "rimraf": "^3.0.2",
-        "rollup": "^2.50.6",
+        "rollup": "^3.20.2",
         "rollup-plugin-serve": "^1.0.1",
-        "rollup-plugin-terser": "^7.0.2",
-        "rollup-plugin-typescript2": "^0.27.0",
+        "rollup-plugin-typescript2": "^0.34.0",
         "stylelint": "^13.6.1",
-        "ts-jest": "^25.2.0",
-        "tsjs": "4.2.1",
-        "typescript": "^3.8.3"
+        "ts-jest": "^29.1.0",
+        "typescript": "^5.0.4"
     },
     "overrides": {
         "plist": "3.0.5"

package/src/client/analyticsBeaconClient.spec.ts

@@ -39,7 +39,7 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/custom?access_token=👛&visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            jasmine.anything()
+            expect.anything()
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(`customEvent=${encodeURIComponent(`{"wow":"ok"}`)}`);
     });
@@ -63,7 +63,7 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/collect?visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            jasmine.anything()
+            expect.anything()
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
             'access_token=%F0%9F%91%9B&pr1a=value&to%20encode=to%20encode'
@@ -92,7 +92,7 @@ describe('AnalyticsBeaconClient', () => {
 
         expect(sendBeaconMock).toHaveBeenCalledWith(
             `${baseUrl}/analytics/collect?visitorId=${currentVisitorId}&discardVisitInfo=true`,
-            jasmine.anything()
+            expect.anything()
         );
         expect(await getSendBeaconFirstCallBlobArgument()).toBe(
             `access_token=%F0%9F%91%9B&value=${encodeURIComponent(JSON.stringify({subvalue: 'ok'}))}`

package/src/client/utils.ts

@@ -4,3 +4,14 @@ export const keysOf = Object.keys as <T>(o: T) => Extract<keyof T, string>[];
 export function isObject(o: any): boolean {
     return o !== null && typeof o === 'object' && !Array.isArray(o);
 }
+
+/**
+ * Attempt to coerce strings to number values.
+ * Any non-number characters will fail parsing, in which case the input string is returned.
+ *
+ * @param input The input to possibly coerce to a number, if it is a string and parses to a number.
+ * @returns The input, possibly coerced to a number.
+ */
+export function coerceToNumber(input: any): any {
+    return typeof input === 'string' && input != '' && !Number.isNaN(+input) ? +input : input;
+}

package/src/coveoua/library.ts

@@ -16,4 +16,9 @@ export {
 export {CaseAssistClient, CaseAssistClientProvider} from '../caseAssist/caseAssistClient';
 export {CoveoInsightClient, InsightClientProvider} from '../insight/insightClient';
 
+export * from '../searchPage/searchPageEvents';
+export * from '../caseAssist/caseAssistActions';
+export * from '../insight/insightEvents';
+export * from '../events';
+
 export {analytics, donottrack, history, SimpleAnalytics, storage};

package/src/coveoua/simpleanalytics.ts

@@ -130,6 +130,9 @@ export class CoveoUA {
     }
 
     callPlugin(pluginName: string, fn: string, ...args: any): any {
+        if (!this.client) {
+            throw new Error(`You must call init before calling a plugin function`);
+        }
         return this.plugins.execute(pluginName, fn, ...args);
     }
 

package/src/plugins/ec.spec.ts

@@ -1,4 +1,4 @@
-import {ECPlugin, ECPluginEventTypes} from './ec';
+import {ECPlugin, ECPluginEventTypes, Product} from './ec';
 import {createAnalyticsClientMock} from '../../tests/analyticsClientMock';
 
 describe('EC plugin', () => {
@@ -119,6 +119,58 @@ describe('EC plugin', () => {
             expect(secondResult).toEqual({...defaultResult});
         });
 
+        it('should convert position to number if possible', () => {
+            const validValues = ['13', '5.5'];
+            for (const value of validValues) {
+                // @ts-ignore
+                ec.addProduct({name: 'product', position: value});
+
+                const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+                const expected: Record<string, any> = {...defaultResult, pr1nm: 'product', pr1ps: +value};
+
+                expect(result).toEqual(expected);
+            }
+        });
+
+        it('should keep original value if position is not a number', () => {
+            const invalidValues = ['1-2-3', '.', '-', '123abc'];
+            for (const value of invalidValues) {
+                // @ts-ignore
+                ec.addProduct({name: 'product', position: value});
+
+                const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+                const expected: Record<string, unknown> = {...defaultResult, pr1nm: 'product', pr1ps: value};
+
+                expect(result).toEqual(expected);
+            }
+        });
+
+        it('should convert quantity to number if possible', () => {
+            const validValues = ['13', '0', '.0', '-10', '5.0', '-1.1', '3.124e7'];
+            for (const value of validValues) {
+                // @ts-ignore
+                ec.addProduct({name: 'product', quantity: value});
+
+                const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+                const expected: Record<string, any> = {...defaultResult, pr1nm: 'product', pr1qt: +value};
+
+                expect(result).toEqual(expected);
+            }
+        });
+
+        it('should keep original value if quantity is not a number', () => {
+            const invalidValues = ['1-2-3', '', '.', '5..', '-', '123abc', 'abc123'];
+            for (const value of invalidValues) {
+                // @ts-ignore
+                ec.addProduct({name: 'product', quantity: value});
+
+                const result = executeRegisteredHook(ECPluginEventTypes.event, {});
+                const expected: Record<string, unknown> = {...defaultResult, pr1nm: 'product', pr1qt: value};
+
+                expect(result).toEqual(expected);
+            }
+        });
+
         describe('when the position is invalid', () => {
             it('should warn when executing hook on added product', () => {
                 jest.spyOn(console, 'warn').mockImplementation();
@@ -182,28 +234,23 @@ describe('EC plugin', () => {
                 );
             });
 
-            it('should tolerate an absent position', () => {
+            it('should tolerate an absent or undefined position', () => {
                 jest.spyOn(console, 'warn').mockImplementation();
 
                 ec.addProduct({
                     name: 'A product with no position',
                 });
 
-                const undefinedPosition = undefined as any;
                 ec.addProduct({
                     name: 'A product with an undefined position',
-                    position: undefinedPosition,
+                    position: undefined,
                 });
 
                 const result = executeRegisteredHook(ECPluginEventTypes.event, {});
 
                 expect(console.warn).not.toHaveBeenCalled();
-
-                const firstPositionProperty = 'il1pi1ps';
-                expect(result).not.toHaveProperty(firstPositionProperty);
-
-                const secondPositionProperty = 'il1pi2ps';
-                expect(result).toHaveProperty(secondPositionProperty, undefinedPosition);
+                expect(result).not.toHaveProperty('pr1ps');
+                expect(result).toHaveProperty('pr2ps', undefined);
             });
         });
     });
@@ -401,28 +448,23 @@ describe('EC plugin', () => {
                 );
             });
 
-            it('should tolerate an absent position', () => {
+            it('should tolerate an absent or undefined position', () => {
                 jest.spyOn(console, 'warn').mockImplementation();
 
                 ec.addImpression({
                     name: 'An impression with no position',
                 });
 
-                const undefinedPosition = undefined as any;
                 ec.addImpression({
                     name: 'An impression with an undefined position',
-                    position: undefinedPosition,
+                    position: undefined,
                 });
 
                 const result = executeRegisteredHook(ECPluginEventTypes.event, {});
 
                 expect(console.warn).not.toHaveBeenCalled();
-
-                const firstPositionProperty = 'il1pi1ps';
-                expect(result).not.toHaveProperty(firstPositionProperty);
-
-                const secondPositionProperty = 'il1pi2ps';
-                expect(result).toHaveProperty(secondPositionProperty, undefinedPosition);
+                expect(result).not.toHaveProperty('il1pi1ps');
+                expect(result).toHaveProperty('il1pi2ps', undefined);
             });
         });
     });

package/src/plugins/ec.ts

@@ -5,6 +5,7 @@ import {
     convertImpressionListToMeasurementProtocol,
 } from '../client/measurementProtocolMapping/commerceMeasurementProtocolMapper';
 import {BasePlugin, BasePluginEventTypes, PluginClass, PluginOptions} from './BasePlugin';
+import {coerceToNumber} from '../client/utils';
 
 export const ECPluginEventTypes = {
     ...BasePluginEventTypes,
@@ -160,11 +161,22 @@ export class ECPlugin extends BasePlugin {
             .reduce((newPayload, product, index) => {
                 return {
                     ...newPayload,
-                    ...convertProductToMeasurementProtocol(product, index),
+                    ...convertProductToMeasurementProtocol(this.convertNumberTypes(product), index),
                 };
             }, {});
     }
 
+    private convertNumberTypes(product: Product): Product {
+        let updatedProduct: Product = {...product};
+        if ('quantity' in updatedProduct) {
+            updatedProduct.quantity = coerceToNumber(updatedProduct.quantity);
+        }
+        if ('position' in updatedProduct) {
+            updatedProduct.position = coerceToNumber(updatedProduct.position);
+        }
+        return updatedProduct;
+    }
+
     private getImpressionPayload() {
         const impressionsByList = this.getImpressionsByList();
         return impressionsByList

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

@@ -17,13 +17,13 @@ describe('ReactNativeRuntime', () => {
     });
 
     it('should call "storage.getItem" when getting the visitor ID', async () => {
-        spyOn(runtimeEnvironment.storage, 'getItem');
+        jest.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');
+        jest.spyOn(runtimeEnvironment.storage, 'setItem');
         await client.setCurrentVisitorId('myid');
         expect(runtimeEnvironment.storage.setItem).toHaveBeenCalled();
     });

package/dist/definitions/src/plugins/ec.d.ts

@@ -1,66 +0,0 @@
-import { BasePlugin, PluginClass, PluginOptions } from './BasePlugin';
-export declare const ECPluginEventTypes: {
-    pageview: string;
-    event: string;
-};
-declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];
-export declare type CustomValues = {
-    [key: string]: string | number | boolean;
-};
-export interface CoveoExtensionProperties {
-    group?: string;
-}
-export interface ProductProperties extends CoveoExtensionProperties {
-    id?: string;
-    name?: string;
-    brand?: string;
-    category?: string;
-    variant?: string;
-    price?: number;
-    quantity?: number;
-    coupon?: string;
-    position?: number;
-    custom?: CustomValues;
-}
-export declare type Product = RequireAtLeastOne<ProductProperties, 'id' | 'name'>;
-export interface ImpressionProperties extends CoveoExtensionProperties {
-    id?: string;
-    name?: string;
-    list?: string;
-    brand?: string;
-    category?: string;
-    variant?: string;
-    position?: number;
-    price?: number;
-    custom?: CustomValues;
-}
-export declare type Impression = RequireAtLeastOne<ImpressionProperties, 'id' | 'name'>;
-export declare type BaseImpression = Omit<Impression, 'list'>;
-export interface ImpressionList {
-    listName?: string;
-    impressions: BaseImpression[];
-}
-export declare class ECPlugin extends BasePlugin {
-    static readonly Id = "ec";
-    private products;
-    private impressions;
-    constructor({ client, uuidGenerator }: PluginOptions);
-    getApi(name: string): Function | null;
-    protected addHooks(): void;
-    addProduct(product: Product): void;
-    addImpression(impression: Impression): void;
-    protected clearPluginData(): void;
-    private addHooksForECEvents;
-    private addHooksForPageView;
-    private addHooksForEvent;
-    private addECDataToPayload;
-    private getProductPayload;
-    private getImpressionPayload;
-    private assureProductValidity;
-    private assureBaseImpressionValidity;
-    private getImpressionsByList;
-}
-export declare const EC: PluginClass;
-export {};