coveo.analytics 2.25.3 → 2.26.2

package/dist/definitions/client/analytics.d.ts

@@ -49,6 +49,7 @@ export interface AnalyticsClient {
     version: string;
     readonly currentVisitorId: string;
     getCurrentVisitorId?(): Promise<string>;
+    setAcceptedLinkReferrers?(hosts: string[]): void;
 }
 export interface BufferedRequest {
     eventType: EventType;
@@ -65,6 +66,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     private afterSendHooks;
     private eventTypeMapping;
     private options;
+    private acceptedLinkReferrers;
     constructor(opts: Partial<ClientOptions>);
     private initRuntime;
     private get storage();
@@ -76,6 +78,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     getPayload(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<any>;
     get currentVisitorId(): string;
     set currentVisitorId(visitorId: string);
+    private extractClientIdFromLink;
     resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<VariableArgumentsPayload>;
     resolvePayloadForParameters(eventType: EventType | string, parameters: any): Promise<any>;
     makeEvent<TPreparedRequest, TCompleteRequest, TResponse extends AnyEventResponse>(eventType: EventType | string, ...payload: VariableArgumentsPayload): Promise<PreparedEvent<TPreparedRequest, TCompleteRequest, TResponse>>;
@@ -97,6 +100,7 @@ export declare class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdP
     registerBeforeSendEventHook(hook: AnalyticsClientSendEventHook): void;
     registerAfterSendEventHook(hook: AnalyticsClientSendEventHook): void;
     addEventTypeMapping(eventType: string, eventConfig: EventTypeConfig): void;
+    setAcceptedLinkReferrers(hosts: string[]): void;
     private parseVariableArgumentsPayload;
     private isKeyAllowedEmpty;
     private removeEmptyPayloadValues;

package/dist/definitions/coveoua/plugins.d.ts

@@ -1,8 +1,4 @@
-import { PluginClass, PluginOptions, BasePlugin } from '../plugins/BasePlugin';
-export declare type UAPluginOptions = any[];
-export declare type Plugin = BasePlugin & {
-    [propName: string]: unknown;
-};
+import { PluginClass, PluginOptions } from '../plugins/BasePlugin';
 export declare class Plugins {
     static readonly DefaultPlugins: string[];
     private registeredPluginsMap;
@@ -10,5 +6,5 @@ export declare class Plugins {
     require(name: string, options: PluginOptions): void;
     provide(name: string, plugin: PluginClass): void;
     clearRequired(): void;
-    execute(name: string, fn: string, ...pluginOptions: UAPluginOptions): any;
+    execute(name: string, fn: string, ...args: any[]): any;
 }

package/dist/definitions/coveoua/simpleanalytics.d.ts

@@ -21,7 +21,7 @@ export declare class CoveoUA {
     onLoad(callback: Function): void;
     provide(name: string, plugin: PluginClass): void;
     require(name: string, options: Omit<PluginOptions, 'client'>): void;
-    callPlugin(pluginName: string, fn: string, ...args: any): void;
+    callPlugin(pluginName: string, fn: string, ...args: any): any;
     reset(): void;
     version(): string;
 }

package/dist/definitions/plugins/BasePlugin.d.ts

@@ -3,7 +3,7 @@ import { v4 as uuidv4 } from 'uuid';
 declare type PluginWithId = {
     readonly Id: string;
 };
-export declare type PluginClass = typeof BasePlugin & PluginWithId;
+export declare type PluginClass = typeof Plugin & PluginWithId;
 export declare const BasePluginEventTypes: {
     pageview: string;
     event: string;
@@ -12,9 +12,13 @@ export declare type PluginOptions = {
     client: AnalyticsClient;
     uuidGenerator?: typeof uuidv4;
 };
-export declare abstract class BasePlugin {
+export declare abstract class Plugin {
     protected client: AnalyticsClient;
     protected uuidGenerator: typeof uuidv4;
+    constructor({ client, uuidGenerator }: PluginOptions);
+    abstract getApi(name: string): any;
+}
+export declare abstract class BasePlugin extends Plugin {
     protected action?: string;
     protected actionData: {
         [name: string]: string;
@@ -27,6 +31,7 @@ export declare abstract class BasePlugin {
     constructor({ client, uuidGenerator }: PluginOptions);
     protected abstract addHooks(): void;
     protected abstract clearPluginData(): void;
+    getApi(name: string): Function | null;
     setAction(action: string, options?: any): void;
     clearData(): void;
     getLocationInformation(eventType: string, payload: any): {
@@ -35,7 +40,7 @@ export declare abstract class BasePlugin {
         location: string;
         hitType: string;
     };
-    updateLocationInformation(eventType: string, payload: any): void;
+    protected updateLocationInformation(eventType: string, payload: any): void;
     getDefaultContextInformation(eventType: string): {
         title: string;
         encoding: string;

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

@@ -47,6 +47,7 @@ export declare class ECPlugin extends BasePlugin {
     private products;
     private impressions;
     constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
     protected addHooks(): void;
     addProduct(product: Product): void;
     addImpression(impression: Impression): void;

package/dist/definitions/plugins/link.d.ts

@@ -0,0 +1,21 @@
+import { Plugin, PluginOptions, PluginClass } from './BasePlugin';
+export declare class CoveoLinkParam {
+    static readonly cvo_cid: string;
+    private static readonly expirationTime;
+    readonly clientId: string;
+    readonly creationDate: number;
+    constructor(clientId: string, timestamp: number);
+    toString(): string;
+    get expired(): boolean;
+    validate(referrerString: string, referrerList: string[]): boolean;
+    private matchReferrer;
+    static fromString(input: string): CoveoLinkParam | null;
+}
+export declare class LinkPlugin extends Plugin {
+    static readonly Id = "link";
+    constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
+    decorate(urlString: string): Promise<string>;
+    acceptFrom(acceptedReferrers: string[]): void;
+}
+export declare const Link: PluginClass;

package/dist/definitions/plugins/svc.d.ts

@@ -19,6 +19,7 @@ export declare class SVCPlugin extends BasePlugin {
     static readonly Id = "svc";
     private ticket;
     constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
     protected addHooks(): void;
     setTicket(ticket: Ticket): void;
     protected clearPluginData(): void;

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

@@ -1,8 +1,4 @@
-import { PluginClass, PluginOptions, BasePlugin } from '../plugins/BasePlugin';
-export declare type UAPluginOptions = any[];
-export declare type Plugin = BasePlugin & {
-    [propName: string]: unknown;
-};
+import { PluginClass, PluginOptions } from '../plugins/BasePlugin';
 export declare class Plugins {
     static readonly DefaultPlugins: string[];
     private registeredPluginsMap;
@@ -10,5 +6,5 @@ export declare class Plugins {
     require(name: string, options: PluginOptions): void;
     provide(name: string, plugin: PluginClass): void;
     clearRequired(): void;
-    execute(name: string, fn: string, ...pluginOptions: UAPluginOptions): any;
+    execute(name: string, fn: string, ...args: any[]): any;
 }

package/dist/definitions/src/coveoua/simpleanalytics.d.ts

@@ -21,7 +21,7 @@ export declare class CoveoUA {
     onLoad(callback: Function): void;
     provide(name: string, plugin: PluginClass): void;
     require(name: string, options: Omit<PluginOptions, 'client'>): void;
-    callPlugin(pluginName: string, fn: string, ...args: any): void;
+    callPlugin(pluginName: string, fn: string, ...args: any): any;
     reset(): void;
     version(): string;
 }

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

@@ -47,6 +47,7 @@ export declare class ECPlugin extends BasePlugin {
     private products;
     private impressions;
     constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
     protected addHooks(): void;
     addProduct(product: Product): void;
     addImpression(impression: Impression): void;

package/dist/definitions/version.d.ts

@@ -1 +1 @@
-export declare const libVersion = "2.25.3";
+export declare const libVersion = "2.26.2";

package/dist/library.es.js

@@ -415,7 +415,7 @@ function stringToBytes(str) {
 }
 
 const DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
-const URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
+const URL$1 = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
 function v35(name, version, hashfunc) {
   function generateUUID(value, namespace, buf, offset) {
     var _namespace;
@@ -462,7 +462,7 @@ function v35(name, version, hashfunc) {
 
 
   generateUUID.DNS = DNS;
-  generateUUID.URL = URL;
+  generateUUID.URL = URL$1;
   return generateUUID;
 }
 
@@ -593,7 +593,197 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-const libVersion = "2.25.3" ;
+const libVersion = "2.26.2" ;
+
+const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
+
+const BasePluginEventTypes = {
+    pageview: 'pageview',
+    event: 'event',
+};
+class Plugin {
+    constructor({ client, uuidGenerator = v4 }) {
+        this.client = client;
+        this.uuidGenerator = uuidGenerator;
+    }
+}
+class BasePlugin extends Plugin {
+    constructor({ client, uuidGenerator = v4 }) {
+        super({ client, uuidGenerator });
+        this.actionData = {};
+        this.pageViewId = uuidGenerator();
+        this.nextPageViewId = this.pageViewId;
+        this.currentLocation = getFormattedLocation(window.location);
+        this.lastReferrer = hasDocument() ? document.referrer : '';
+        this.addHooks();
+    }
+    getApi(name) {
+        switch (name) {
+            case 'setAction':
+                return this.setAction;
+            default:
+                return null;
+        }
+    }
+    setAction(action, options) {
+        this.action = action;
+        this.actionData = options;
+    }
+    clearData() {
+        this.clearPluginData();
+        this.action = undefined;
+        this.actionData = {};
+    }
+    getLocationInformation(eventType, payload) {
+        return Object.assign({ hitType: eventType }, this.getNextValues(eventType, payload));
+    }
+    updateLocationInformation(eventType, payload) {
+        this.updateLocationForNextPageView(eventType, payload);
+    }
+    getDefaultContextInformation(eventType) {
+        const documentContext = {
+            title: hasDocument() ? document.title : '',
+            encoding: hasDocument() ? document.characterSet : 'UTF-8',
+        };
+        const screenContext = {
+            screenResolution: `${screen.width}x${screen.height}`,
+            screenColor: `${screen.colorDepth}-bit`,
+        };
+        const navigatorContext = {
+            language: navigator.language,
+            userAgent: navigator.userAgent,
+        };
+        const eventContext = {
+            time: Date.now(),
+            eventId: this.uuidGenerator(),
+        };
+        return Object.assign(Object.assign(Object.assign(Object.assign({}, eventContext), screenContext), navigatorContext), documentContext);
+    }
+    updateLocationForNextPageView(eventType, payload) {
+        const { pageViewId, referrer, location } = this.getNextValues(eventType, payload);
+        this.lastReferrer = referrer;
+        this.pageViewId = pageViewId;
+        this.currentLocation = location;
+        if (eventType === BasePluginEventTypes.pageview) {
+            this.nextPageViewId = this.uuidGenerator();
+            this.hasSentFirstPageView = true;
+        }
+    }
+    getNextValues(eventType, payload) {
+        return {
+            pageViewId: eventType === BasePluginEventTypes.pageview ? this.nextPageViewId : this.pageViewId,
+            referrer: eventType === BasePluginEventTypes.pageview && this.hasSentFirstPageView
+                ? this.currentLocation
+                : this.lastReferrer,
+            location: eventType === BasePluginEventTypes.pageview
+                ? this.getCurrentLocationFromPayload(payload)
+                : this.currentLocation,
+        };
+    }
+    getCurrentLocationFromPayload(payload) {
+        if (!!payload.page) {
+            const removeStartingSlash = (page) => page.replace(/^\/?(.*)$/, '/$1');
+            const extractHostnamePart = (location) => location.split('/').slice(0, 3).join('/');
+            return `${extractHostnamePart(this.currentLocation)}${removeStartingSlash(payload.page)}`;
+        }
+        else {
+            return getFormattedLocation(window.location);
+        }
+    }
+}
+
+class CoveoLinkParam {
+    constructor(clientId, timestamp) {
+        if (!validate(clientId))
+            throw Error('Not a valid uuid');
+        this.clientId = clientId;
+        this.creationDate = Math.floor(timestamp / 1000);
+    }
+    toString() {
+        return this.clientId.replace(/-/g, '') + '.' + this.creationDate.toString();
+    }
+    get expired() {
+        const age = Math.floor(Date.now() / 1000) - this.creationDate;
+        return age < 0 || age > CoveoLinkParam.expirationTime;
+    }
+    validate(referrerString, referrerList) {
+        return !this.expired && this.matchReferrer(referrerString, referrerList);
+    }
+    matchReferrer(referrerString, referrerList) {
+        try {
+            const url = new URL(referrerString);
+            return referrerList.some((value) => {
+                const hostRegExp = new RegExp(value.replace(/\\/g, '\\\\').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$');
+                return hostRegExp.test(url.host);
+            });
+        }
+        catch (error) {
+            return false;
+        }
+    }
+    static fromString(input) {
+        const parts = input.split('.');
+        if (parts.length !== 2) {
+            return null;
+        }
+        const [clientIdPart, creationDate] = parts;
+        if (clientIdPart.length !== 32 || isNaN(parseInt(creationDate))) {
+            return null;
+        }
+        const clientId = clientIdPart.substring(0, 8) +
+            '-' +
+            clientIdPart.substring(8, 12) +
+            '-' +
+            clientIdPart.substring(12, 16) +
+            '-' +
+            clientIdPart.substring(16, 20) +
+            '-' +
+            clientIdPart.substring(20, 32);
+        if (validate(clientId)) {
+            return new CoveoLinkParam(clientId, Number.parseInt(creationDate) * 1000);
+        }
+        else {
+            return null;
+        }
+    }
+}
+CoveoLinkParam.cvo_cid = 'cvo_cid';
+CoveoLinkParam.expirationTime = 120;
+class LinkPlugin extends Plugin {
+    constructor({ client, uuidGenerator = v4 }) {
+        super({ client, uuidGenerator });
+    }
+    getApi(name) {
+        switch (name) {
+            case 'decorate':
+                return this.decorate;
+            case 'acceptFrom':
+                return this.acceptFrom;
+            default:
+                return null;
+        }
+    }
+    decorate(urlString) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.client.getCurrentVisitorId) {
+                throw new Error('Could not retrieve current clientId');
+            }
+            try {
+                const url = new URL(urlString);
+                const clientId = yield this.client.getCurrentVisitorId();
+                url.searchParams.set(CoveoLinkParam.cvo_cid, new CoveoLinkParam(clientId, Date.now()).toString());
+                return url.toString();
+            }
+            catch (error) {
+                throw new Error('Invalid URL provided');
+            }
+        });
+    }
+    acceptFrom(acceptedReferrers) {
+        this.client.setAcceptedLinkReferrers(acceptedReferrers);
+    }
+}
+LinkPlugin.Id = 'link';
 
 const keysOf = Object.keys;
 function isObject(o) {
@@ -1018,6 +1208,7 @@ function buildBaseUrl(endpoint = Endpoints.default, apiVersion = Version) {
 const COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
 class CoveoAnalyticsClient {
     constructor(opts) {
+        this.acceptedLinkReferrers = [];
         if (!opts) {
             throw new Error('You have to pass options to this constructor');
         }
@@ -1070,7 +1261,9 @@ class CoveoAnalyticsClient {
     determineVisitorId() {
         return __awaiter(this, void 0, void 0, function* () {
             try {
-                return (yield this.storage.getItem('visitorId')) || v4();
+                return (this.extractClientIdFromLink(window.location.href) ||
+                    (yield this.storage.getItem('visitorId')) ||
+                    v4());
             }
             catch (err) {
                 console.log('Could not get visitor ID from the current runtime environment storage. Using a random ID instead.', err);
@@ -1128,6 +1321,25 @@ class CoveoAnalyticsClient {
         this.visitorId = visitorId;
         this.storage.setItem('visitorId', visitorId);
     }
+    extractClientIdFromLink(urlString) {
+        if (doNotTrack()) {
+            return null;
+        }
+        try {
+            const linkParam = new URL(urlString).searchParams.get(CoveoLinkParam.cvo_cid);
+            if (linkParam == null) {
+                return null;
+            }
+            const linker = CoveoLinkParam.fromString(linkParam);
+            if (!linker || !hasDocument() || !linker.validate(document.referrer, this.acceptedLinkReferrers)) {
+                return null;
+            }
+            return linker.clientId;
+        }
+        catch (error) {
+        }
+        return null;
+    }
     resolveParameters(eventType, ...payload) {
         return __awaiter(this, void 0, void 0, function* () {
             const { variableLengthArgumentsNames = [], addVisitorIdParameter = false, usesMeasurementProtocol = false, addClientIdParameter = false, } = this.eventTypeMapping[eventType] || {};
@@ -1295,6 +1507,12 @@ class CoveoAnalyticsClient {
     addEventTypeMapping(eventType, eventConfig) {
         this.eventTypeMapping[eventType] = eventConfig;
     }
+    setAcceptedLinkReferrers(hosts) {
+        if (Array.isArray(hosts) && hosts.every((host) => typeof host == 'string'))
+            this.acceptedLinkReferrers = hosts;
+        else
+            throw Error('Parameter should be an array of domain strings');
+    }
     parseVariableArgumentsPayload(fieldsOrder, payload) {
         const parsedArguments = {};
         for (let i = 0, length = payload.length; i < length; i++) {
@@ -2312,90 +2530,6 @@ class CoveoSearchPageClient {
     }
 }
 
-const getFormattedLocation = (location) => `${location.protocol}//${location.hostname}${location.pathname.indexOf('/') === 0 ? location.pathname : `/${location.pathname}`}${location.search}`;
-
-const BasePluginEventTypes = {
-    pageview: 'pageview',
-    event: 'event',
-};
-class BasePlugin {
-    constructor({ client, uuidGenerator = v4 }) {
-        this.actionData = {};
-        this.client = client;
-        this.uuidGenerator = uuidGenerator;
-        this.pageViewId = uuidGenerator();
-        this.nextPageViewId = this.pageViewId;
-        this.currentLocation = getFormattedLocation(window.location);
-        this.lastReferrer = hasDocument() ? document.referrer : '';
-        this.addHooks();
-    }
-    setAction(action, options) {
-        this.action = action;
-        this.actionData = options;
-    }
-    clearData() {
-        this.clearPluginData();
-        this.action = undefined;
-        this.actionData = {};
-    }
-    getLocationInformation(eventType, payload) {
-        return Object.assign({ hitType: eventType }, this.getNextValues(eventType, payload));
-    }
-    updateLocationInformation(eventType, payload) {
-        this.updateLocationForNextPageView(eventType, payload);
-    }
-    getDefaultContextInformation(eventType) {
-        const documentContext = {
-            title: hasDocument() ? document.title : '',
-            encoding: hasDocument() ? document.characterSet : 'UTF-8',
-        };
-        const screenContext = {
-            screenResolution: `${screen.width}x${screen.height}`,
-            screenColor: `${screen.colorDepth}-bit`,
-        };
-        const navigatorContext = {
-            language: navigator.language,
-            userAgent: navigator.userAgent,
-        };
-        const eventContext = {
-            time: Date.now(),
-            eventId: this.uuidGenerator(),
-        };
-        return Object.assign(Object.assign(Object.assign(Object.assign({}, eventContext), screenContext), navigatorContext), documentContext);
-    }
-    updateLocationForNextPageView(eventType, payload) {
-        const { pageViewId, referrer, location } = this.getNextValues(eventType, payload);
-        this.lastReferrer = referrer;
-        this.pageViewId = pageViewId;
-        this.currentLocation = location;
-        if (eventType === BasePluginEventTypes.pageview) {
-            this.nextPageViewId = this.uuidGenerator();
-            this.hasSentFirstPageView = true;
-        }
-    }
-    getNextValues(eventType, payload) {
-        return {
-            pageViewId: eventType === BasePluginEventTypes.pageview ? this.nextPageViewId : this.pageViewId,
-            referrer: eventType === BasePluginEventTypes.pageview && this.hasSentFirstPageView
-                ? this.currentLocation
-                : this.lastReferrer,
-            location: eventType === BasePluginEventTypes.pageview
-                ? this.getCurrentLocationFromPayload(payload)
-                : this.currentLocation,
-        };
-    }
-    getCurrentLocationFromPayload(payload) {
-        if (!!payload.page) {
-            const removeStartingSlash = (page) => page.replace(/^\/?(.*)$/, '/$1');
-            const extractHostnamePart = (location) => location.split('/').slice(0, 3).join('/');
-            return `${extractHostnamePart(this.currentLocation)}${removeStartingSlash(payload.page)}`;
-        }
-        else {
-            return getFormattedLocation(window.location);
-        }
-    }
-}
-
 const SVCPluginEventTypes = Object.assign({}, BasePluginEventTypes);
 const allSVCEventTypes = Object.keys(SVCPluginEventTypes).map((key) => SVCPluginEventTypes[key]);
 class SVCPlugin extends BasePlugin {
@@ -2403,6 +2537,17 @@ class SVCPlugin extends BasePlugin {
         super({ client, uuidGenerator });
         this.ticket = {};
     }
+    getApi(name) {
+        const superCall = super.getApi(name);
+        if (superCall !== null)
+            return superCall;
+        switch (name) {
+            case 'setTicket':
+                return this.setTicket;
+            default:
+                return null;
+        }
+    }
     addHooks() {
         this.addHooksForEvent();
         this.addHooksForPageView();