coveo.analytics 2.25.2 → 2.26.1

package/dist/react-native.es.js

@@ -70,7 +70,7 @@ var nodePonyfill = {exports: {}};
 
 var publicApi = {};
 
-var URL$2 = {exports: {}};
+var URL$3 = {exports: {}};
 
 var conversions = {};
 var lib$1 = conversions;
@@ -79825,9 +79825,9 @@ module.exports = {
     Worker: { URL: URL }
   }
 };
-}(URL$2));
+}(URL$3));
 
-publicApi.URL = URL$2.exports.interface;
+publicApi.URL = URL$3.exports.interface;
 publicApi.serializeURL = urlStateMachine.exports.serializeURL;
 publicApi.serializeURLOrigin = urlStateMachine.exports.serializeURLOrigin;
 publicApi.basicURLParse = urlStateMachine.exports.basicURLParse;
@@ -80968,7 +80968,7 @@ Object.defineProperty(Response.prototype, Symbol.toStringTag, {
 });
 
 const INTERNALS$2 = Symbol('Request internals');
-const URL$1 = Url.URL || publicApi.URL;
+const URL$2 = Url.URL || publicApi.URL;
 
 // fix an issue where "format", "parse" aren't a named export for node <10
 const parse_url = Url.parse;
@@ -80987,7 +80987,7 @@ function parseURL(urlStr) {
  	Absolute URL: https://tools.ietf.org/html/rfc3986#section-4.3
  */
 	if (/^[a-zA-Z][a-zA-Z\d+\-.]*:/.exec(urlStr)) {
-		urlStr = new URL$1(urlStr).toString();
+		urlStr = new URL$2(urlStr).toString();
 	}
 
 	// Fallback to old implementation for arbitrary URLs
@@ -81696,7 +81696,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;
@@ -81743,7 +81743,7 @@ function v35(name, version, hashfunc) {
 
 
   generateUUID.DNS = DNS;
-  generateUUID.URL = URL;
+  generateUUID.URL = URL$1;
   return generateUUID;
 }
 
@@ -82158,7 +82158,197 @@ const addPageViewToHistory = (pageViewValue) => __awaiter(void 0, void 0, void 0
     yield store.addElementAsync(historyElement);
 });
 
-const libVersion = "2.25.2" ;
+const libVersion = "2.26.1" ;
+
+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) {
@@ -82522,6 +82712,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');
         }
@@ -82574,7 +82765,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);
@@ -82632,6 +82825,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] || {};
@@ -82799,6 +83011,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++) {
@@ -83833,90 +84051,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 {
@@ -83924,6 +84058,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();

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "coveo.analytics",
-    "version": "2.25.2",
+    "version": "2.26.1",
     "description": "📈 Coveo analytics client (node and browser compatible) ",
     "main": "dist/library.js",
     "module": "dist/library.es.js",

package/src/client/analytics.spec.ts

@@ -7,6 +7,8 @@ import {mockFetch} from '../../tests/fetchMock';
 import {BrowserRuntime} from './runtimeEnvironment';
 import * as doNotTrack from '../donottrack';
 import {Cookie} from '../cookieutils';
+import {v4 as uuidv4} from 'uuid';
+import {CoveoLinkParam} from '../plugins/link';
 
 const aVisitorId = '123';
 jest.mock('uuid', () => ({
@@ -483,3 +485,123 @@ describe('custom clientId', () => {
         //uuid v5 specific uuid generation
     });
 });
+
+describe('clientId from link', () => {
+    // note: referrer is set as http://somewhere.over/thereferrer in setup.js
+    let client: CoveoAnalyticsClient;
+    const forcedUUID: string = 'c0b48880-743e-484f-8044-d7c37910c55b';
+
+    function navigateTo(url: string) {
+        // @ts-ignore
+        delete window.location;
+        // @ts-ignore
+        window.location = new URL(url);
+    }
+
+    beforeEach(() => {
+        client = new CoveoAnalyticsClient({});
+        // need to clear existing clientIds
+        client.clear();
+        jest.spyOn(doNotTrack, 'doNotTrack').mockImplementation(() => false);
+    });
+
+    it('will extract a clientId from a query param if the referrer matches all and it is not expired', async () => {
+        client.setAcceptedLinkReferrers(['*']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).toBe(forcedUUID);
+    });
+
+    it('will extract a clientId from a query param if the referrer matches the current referrer exactly and it is not expired', async () => {
+        client.setAcceptedLinkReferrers(['somewhere.over']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).toBe(forcedUUID);
+    });
+
+    it('will extract a clientId from a query param if the referrer matches the current referrer with wildcard and it is not expired', async () => {
+        client.setAcceptedLinkReferrers(['*.over']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).toBe(forcedUUID);
+    });
+
+    it('will extract a clientId from a query param if one of the referrer matches the current referrer and it is not expired', async () => {
+        client.setAcceptedLinkReferrers(['*.mydomain.com', '*.over']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).toBe(forcedUUID);
+    });
+
+    it('will not extract a clientId from a query param if the referrer matches and it is expired', async () => {
+        client.setAcceptedLinkReferrers(['*']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now() - 180000);
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if there is no accept list specified', async () => {
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if there is an empty accept list', async () => {
+        client.setAcceptedLinkReferrers([]);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if the referrer list does not match', async () => {
+        client.setAcceptedLinkReferrers(['*.mydomain.com']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if the referrer list does not match the exact port', async () => {
+        client.setAcceptedLinkReferrers(['*.over:9000']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if the multi referrer list does not match', async () => {
+        client.setAcceptedLinkReferrers(['*.mydomain.com', 'www.example.com']);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if it is not a UUID', async () => {
+        client.setAcceptedLinkReferrers(['*']);
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=notauuid.' + Math.floor(Date.now() / 1000));
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will not extract a clientId from a query param if DNT is enabled', async () => {
+        client.setAcceptedLinkReferrers(['*']);
+        jest.spyOn(doNotTrack, 'doNotTrack').mockImplementation(() => true);
+        const linkString = new CoveoLinkParam(forcedUUID, Date.now());
+        navigateTo('http://my.receivingdomain.com/?cvo_cid=' + linkString.toString());
+        expect(await client.getCurrentVisitorId()).not.toBe(null);
+        expect(await client.getCurrentVisitorId()).toBe(aVisitorId);
+    });
+
+    it('will throw when specifying invalid hosts list', async () => {
+        //@ts-ignore
+        expect(() => client.setAcceptedLinkReferrers('*')).toThrow('Parameter should be an array of domain strings');
+        //@ts-ignore
+        expect(() => client.setAcceptedLinkReferrers({})).toThrow('Parameter should be an array of domain strings');
+        //@ts-ignore
+        expect(() => client.setAcceptedLinkReferrers([{}])).toThrow('Parameter should be an array of domain strings');
+    });
+});

package/src/client/analytics.ts

@@ -24,6 +24,7 @@ import {addDefaultValues} from '../hook/addDefaultValues';
 import {enhanceViewEvent} from '../hook/enhanceViewEvent';
 import {v4 as uuidv4, v5 as uuidv5, validate as uuidValidate} from 'uuid';
 import {libVersion} from '../version';
+import {CoveoLinkParam} from '../plugins/link';
 import {
     convertKeysToMeasurementProtocol,
     isMeasurementProtocolKey,
@@ -105,6 +106,7 @@ export interface AnalyticsClient {
      */
     readonly currentVisitorId: string;
     getCurrentVisitorId?(): Promise<string>; // TODO: v3 make required
+    setAcceptedLinkReferrers?(hosts: string[]): void;
 }
 
 export interface BufferedRequest {
@@ -146,6 +148,7 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
     private afterSendHooks: AnalyticsClientSendEventHook[];
     private eventTypeMapping: {[name: string]: EventTypeConfig};
     private options: ClientOptions;
+    private acceptedLinkReferrers: string[] = [];
 
     constructor(opts: Partial<ClientOptions>) {
         if (!opts) {
@@ -196,7 +199,11 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
 
     private async determineVisitorId() {
         try {
-            return (await this.storage.getItem('visitorId')) || uuidv4();
+            return (
+                this.extractClientIdFromLink(window.location.href) ||
+                (await this.storage.getItem('visitorId')) ||
+                uuidv4()
+            );
         } catch (err) {
             console.log(
                 'Could not get visitor ID from the current runtime environment storage. Using a random ID instead.',
@@ -258,6 +265,26 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         this.storage.setItem('visitorId', visitorId);
     }
 
+    private extractClientIdFromLink(urlString: string): string | null {
+        if (doNotTrack()) {
+            return null;
+        }
+        try {
+            const linkParam: string | null = new URL(urlString).searchParams.get(CoveoLinkParam.cvo_cid);
+            if (linkParam == null) {
+                return null;
+            }
+            const linker: CoveoLinkParam | null = CoveoLinkParam.fromString(linkParam);
+            if (!linker || !hasDocument() || !linker.validate(document.referrer, this.acceptedLinkReferrers)) {
+                return null;
+            }
+            return linker.clientId;
+        } catch (error) {
+            // Ignore any parsing errors
+        }
+        return null;
+    }
+
     async resolveParameters(eventType: EventType | string, ...payload: VariableArgumentsPayload) {
         const {
             variableLengthArgumentsNames = [],
@@ -453,6 +480,11 @@ export class CoveoAnalyticsClient implements AnalyticsClient, VisitorIdProvider
         this.eventTypeMapping[eventType] = eventConfig;
     }
 
+    setAcceptedLinkReferrers(hosts: string[]): void {
+        if (Array.isArray(hosts) && hosts.every((host) => typeof host == 'string')) this.acceptedLinkReferrers = hosts;
+        else throw Error('Parameter should be an array of domain strings');
+    }
+
     private parseVariableArgumentsPayload(fieldsOrder: string[], payload: VariableArgumentsPayload) {
         const parsedArguments: {[name: string]: any} = {};
         for (let i = 0, length = payload.length; i < length; i++) {

package/src/coveoua/plugins.ts

@@ -1,15 +1,14 @@
-import {PluginClass, PluginOptions, BasePlugin} from '../plugins/BasePlugin';
+import {PluginClass, PluginOptions, BasePlugin, Plugin} from '../plugins/BasePlugin';
 import {EC} from '../plugins/ec';
+import {Link} from '../plugins/link';
 import {SVC} from '../plugins/svc';
 
-export type UAPluginOptions = any[];
-export type Plugin = BasePlugin & {[propName: string]: unknown};
-
 export class Plugins {
-    public static readonly DefaultPlugins: string[] = [EC.Id, SVC.Id];
+    public static readonly DefaultPlugins: string[] = [EC.Id, SVC.Id, Link.Id];
     private registeredPluginsMap: Record<string, PluginClass> = {
         [EC.Id]: EC,
         [SVC.Id]: SVC,
+        [Link.Id]: Link,
     };
     private requiredPlugins: Record<string, BasePlugin> = {};
 
@@ -31,18 +30,18 @@ export class Plugins {
         this.requiredPlugins = {};
     }
 
-    execute(name: string, fn: string, ...pluginOptions: UAPluginOptions) {
+    execute(name: string, fn: string, ...args: any[]): any {
         const plugin = this.requiredPlugins[name] as Plugin;
         if (!plugin) {
             throw new Error(`The plugin "${name}" is not required. Check that you required it on initialization.`);
         }
-        const actionFunction = plugin[fn];
+        const actionFunction = plugin.getApi(fn);
         if (!actionFunction) {
             throw new Error(`The function "${fn}" does not exist on the plugin "${name}".`);
         }
         if (typeof actionFunction !== 'function') {
             throw new Error(`"${fn}" of the plugin "${name}" is not a function.`);
         }
-        return actionFunction.apply(plugin, pluginOptions);
+        return actionFunction.apply(plugin, args);
     }
 }