coveo.analytics 2.25.3 → 2.26.1

package/dist/library.js

@@ -562,7 +562,7 @@ function stringToBytes(str) {
 }
 
 const DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
-const URL$1 = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
+const URL$2 = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
 function v35(name, version, hashfunc) {
   function generateUUID(value, namespace, buf, offset) {
     var _namespace;
@@ -609,7 +609,7 @@ function v35(name, version, hashfunc) {
 
 
   generateUUID.DNS = DNS;
-  generateUUID.URL = URL$1;
+  generateUUID.URL = URL$2;
   return generateUUID;
 }
 
@@ -740,7 +740,224 @@ function sha1(bytes) {
 const v5 = v35('v5', 0x50, sha1);
 var uuidv5 = v5;
 
-var libVersion = "2.25.3" ;
+var libVersion = "2.26.1" ;
+
+var getFormattedLocation = function (location) {
+    return location.protocol + "//" + location.hostname + (location.pathname.indexOf('/') === 0 ? location.pathname : "/" + location.pathname) + location.search;
+};
+
+var BasePluginEventTypes = {
+    pageview: 'pageview',
+    event: 'event',
+};
+var Plugin = (function () {
+    function Plugin(_a) {
+        var client = _a.client, _b = _a.uuidGenerator, uuidGenerator = _b === void 0 ? v4 : _b;
+        this.client = client;
+        this.uuidGenerator = uuidGenerator;
+    }
+    return Plugin;
+}());
+var BasePlugin = (function (_super) {
+    __extends(BasePlugin, _super);
+    function BasePlugin(_a) {
+        var client = _a.client, _b = _a.uuidGenerator, uuidGenerator = _b === void 0 ? v4 : _b;
+        var _this = _super.call(this, { client: client, uuidGenerator: uuidGenerator }) || this;
+        _this.actionData = {};
+        _this.pageViewId = uuidGenerator();
+        _this.nextPageViewId = _this.pageViewId;
+        _this.currentLocation = getFormattedLocation(window.location);
+        _this.lastReferrer = hasDocument() ? document.referrer : '';
+        _this.addHooks();
+        return _this;
+    }
+    BasePlugin.prototype.getApi = function (name) {
+        switch (name) {
+            case 'setAction':
+                return this.setAction;
+            default:
+                return null;
+        }
+    };
+    BasePlugin.prototype.setAction = function (action, options) {
+        this.action = action;
+        this.actionData = options;
+    };
+    BasePlugin.prototype.clearData = function () {
+        this.clearPluginData();
+        this.action = undefined;
+        this.actionData = {};
+    };
+    BasePlugin.prototype.getLocationInformation = function (eventType, payload) {
+        return __assign({ hitType: eventType }, this.getNextValues(eventType, payload));
+    };
+    BasePlugin.prototype.updateLocationInformation = function (eventType, payload) {
+        this.updateLocationForNextPageView(eventType, payload);
+    };
+    BasePlugin.prototype.getDefaultContextInformation = function (eventType) {
+        var documentContext = {
+            title: hasDocument() ? document.title : '',
+            encoding: hasDocument() ? document.characterSet : 'UTF-8',
+        };
+        var screenContext = {
+            screenResolution: screen.width + "x" + screen.height,
+            screenColor: screen.colorDepth + "-bit",
+        };
+        var navigatorContext = {
+            language: navigator.language,
+            userAgent: navigator.userAgent,
+        };
+        var eventContext = {
+            time: Date.now(),
+            eventId: this.uuidGenerator(),
+        };
+        return __assign(__assign(__assign(__assign({}, eventContext), screenContext), navigatorContext), documentContext);
+    };
+    BasePlugin.prototype.updateLocationForNextPageView = function (eventType, payload) {
+        var _a = this.getNextValues(eventType, payload), pageViewId = _a.pageViewId, referrer = _a.referrer, location = _a.location;
+        this.lastReferrer = referrer;
+        this.pageViewId = pageViewId;
+        this.currentLocation = location;
+        if (eventType === BasePluginEventTypes.pageview) {
+            this.nextPageViewId = this.uuidGenerator();
+            this.hasSentFirstPageView = true;
+        }
+    };
+    BasePlugin.prototype.getNextValues = function (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,
+        };
+    };
+    BasePlugin.prototype.getCurrentLocationFromPayload = function (payload) {
+        if (!!payload.page) {
+            var removeStartingSlash = function (page) { return page.replace(/^\/?(.*)$/, '/$1'); };
+            var extractHostnamePart = function (location) { return location.split('/').slice(0, 3).join('/'); };
+            return "" + extractHostnamePart(this.currentLocation) + removeStartingSlash(payload.page);
+        }
+        else {
+            return getFormattedLocation(window.location);
+        }
+    };
+    return BasePlugin;
+}(Plugin));
+
+var CoveoLinkParam = (function () {
+    function CoveoLinkParam(clientId, timestamp) {
+        if (!validate(clientId))
+            throw Error('Not a valid uuid');
+        this.clientId = clientId;
+        this.creationDate = Math.floor(timestamp / 1000);
+    }
+    CoveoLinkParam.prototype.toString = function () {
+        return this.clientId.replace(/-/g, '') + '.' + this.creationDate.toString();
+    };
+    Object.defineProperty(CoveoLinkParam.prototype, "expired", {
+        get: function () {
+            var age = Math.floor(Date.now() / 1000) - this.creationDate;
+            return age < 0 || age > CoveoLinkParam.expirationTime;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    CoveoLinkParam.prototype.validate = function (referrerString, referrerList) {
+        return !this.expired && this.matchReferrer(referrerString, referrerList);
+    };
+    CoveoLinkParam.prototype.matchReferrer = function (referrerString, referrerList) {
+        try {
+            var url_1 = new URL(referrerString);
+            return referrerList.some(function (value) {
+                var hostRegExp = new RegExp(value.replace(/\\/g, '\\\\').replace(/\./g, '\\.').replace(/\*/g, '.*') + '$');
+                return hostRegExp.test(url_1.host);
+            });
+        }
+        catch (error) {
+            return false;
+        }
+    };
+    CoveoLinkParam.fromString = function (input) {
+        var parts = input.split('.');
+        if (parts.length !== 2) {
+            return null;
+        }
+        var clientIdPart = parts[0], creationDate = parts[1];
+        if (clientIdPart.length !== 32 || isNaN(parseInt(creationDate))) {
+            return null;
+        }
+        var 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;
+    return CoveoLinkParam;
+}());
+var LinkPlugin = (function (_super) {
+    __extends(LinkPlugin, _super);
+    function LinkPlugin(_a) {
+        var client = _a.client, _b = _a.uuidGenerator, uuidGenerator = _b === void 0 ? v4 : _b;
+        return _super.call(this, { client: client, uuidGenerator: uuidGenerator }) || this;
+    }
+    LinkPlugin.prototype.getApi = function (name) {
+        switch (name) {
+            case 'decorate':
+                return this.decorate;
+            case 'acceptFrom':
+                return this.acceptFrom;
+            default:
+                return null;
+        }
+    };
+    LinkPlugin.prototype.decorate = function (urlString) {
+        return __awaiter(this, void 0, void 0, function () {
+            var url, clientId;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this.client.getCurrentVisitorId) {
+                            throw new Error('Could not retrieve current clientId');
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        url = new URL(urlString);
+                        return [4, this.client.getCurrentVisitorId()];
+                    case 2:
+                        clientId = _a.sent();
+                        url.searchParams.set(CoveoLinkParam.cvo_cid, new CoveoLinkParam(clientId, Date.now()).toString());
+                        return [2, url.toString()];
+                    case 3:
+                        _a.sent();
+                        throw new Error('Invalid URL provided');
+                    case 4: return [2];
+                }
+            });
+        });
+    };
+    LinkPlugin.prototype.acceptFrom = function (acceptedReferrers) {
+        this.client.setAcceptedLinkReferrers(acceptedReferrers);
+    };
+    LinkPlugin.Id = 'link';
+    return LinkPlugin;
+}(Plugin));
+var Link = LinkPlugin;
 
 var keysOf = Object.keys;
 function isObject(o) {
@@ -1109,7 +1326,7 @@ var lib$1 = {exports: {}};
 
 var publicApi = {};
 
-var URL = {exports: {}};
+var URL$1 = {exports: {}};
 
 var conversions = {};
 var lib = conversions;
@@ -80864,9 +81081,9 @@ module.exports = {
     Worker: { URL: URL }
   }
 };
-}(URL));
+}(URL$1));
 
-publicApi.URL = URL.exports.interface;
+publicApi.URL = URL$1.exports.interface;
 publicApi.serializeURL = urlStateMachine.exports.serializeURL;
 publicApi.serializeURLOrigin = urlStateMachine.exports.serializeURLOrigin;
 publicApi.basicURLParse = urlStateMachine.exports.basicURLParse;
@@ -82784,6 +83001,7 @@ function buildBaseUrl(endpoint, apiVersion) {
 var COVEO_NAMESPACE = '38824e1f-37f5-42d3-8372-a4b8fa9df946';
 var CoveoAnalyticsClient = (function () {
     function CoveoAnalyticsClient(opts) {
+        this.acceptedLinkReferrers = [];
         if (!opts) {
             throw new Error('You have to pass options to this constructor');
         }
@@ -82848,18 +83066,24 @@ var CoveoAnalyticsClient = (function () {
     });
     CoveoAnalyticsClient.prototype.determineVisitorId = function () {
         return __awaiter(this, void 0, void 0, function () {
-            var err_1;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var _a, err_1;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
+                        _b.trys.push([0, 3, , 4]);
+                        _a = this.extractClientIdFromLink(window.location.href);
+                        if (_a) return [3, 2];
                         return [4, this.storage.getItem('visitorId')];
-                    case 1: return [2, (_a.sent()) || v4()];
-                    case 2:
-                        err_1 = _a.sent();
+                    case 1:
+                        _a = (_b.sent());
+                        _b.label = 2;
+                    case 2: return [2, (_a ||
+                            v4())];
+                    case 3:
+                        err_1 = _b.sent();
                         console.log('Could not get visitor ID from the current runtime environment storage. Using a random ID instead.', err_1);
                         return [2, v4()];
-                    case 3: return [2];
+                    case 4: return [2];
                 }
             });
         });
@@ -82960,6 +83184,25 @@ var CoveoAnalyticsClient = (function () {
         enumerable: false,
         configurable: true
     });
+    CoveoAnalyticsClient.prototype.extractClientIdFromLink = function (urlString) {
+        if (doNotTrack()) {
+            return null;
+        }
+        try {
+            var linkParam = new URL(urlString).searchParams.get(CoveoLinkParam.cvo_cid);
+            if (linkParam == null) {
+                return null;
+            }
+            var linker = CoveoLinkParam.fromString(linkParam);
+            if (!linker || !hasDocument() || !linker.validate(document.referrer, this.acceptedLinkReferrers)) {
+                return null;
+            }
+            return linker.clientId;
+        }
+        catch (error) {
+        }
+        return null;
+    };
     CoveoAnalyticsClient.prototype.resolveParameters = function (eventType) {
         var payload = [];
         for (var _i = 1; _i < arguments.length; _i++) {
@@ -83294,6 +83537,12 @@ var CoveoAnalyticsClient = (function () {
     CoveoAnalyticsClient.prototype.addEventTypeMapping = function (eventType, eventConfig) {
         this.eventTypeMapping[eventType] = eventConfig;
     };
+    CoveoAnalyticsClient.prototype.setAcceptedLinkReferrers = function (hosts) {
+        if (Array.isArray(hosts) && hosts.every(function (host) { return typeof host == 'string'; }))
+            this.acceptedLinkReferrers = hosts;
+        else
+            throw Error('Parameter should be an array of domain strings');
+    };
     CoveoAnalyticsClient.prototype.parseVariableArgumentsPayload = function (fieldsOrder, payload) {
         var parsedArguments = {};
         for (var i = 0, length_1 = payload.length; i < length_1; i++) {
@@ -83406,94 +83655,6 @@ var analytics = /*#__PURE__*/Object.freeze({
     'default': CoveoAnalyticsClient
 });
 
-var getFormattedLocation = function (location) {
-    return location.protocol + "//" + location.hostname + (location.pathname.indexOf('/') === 0 ? location.pathname : "/" + location.pathname) + location.search;
-};
-
-var BasePluginEventTypes = {
-    pageview: 'pageview',
-    event: 'event',
-};
-var BasePlugin = (function () {
-    function BasePlugin(_a) {
-        var client = _a.client, _b = _a.uuidGenerator, uuidGenerator = _b === void 0 ? v4 : _b;
-        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();
-    }
-    BasePlugin.prototype.setAction = function (action, options) {
-        this.action = action;
-        this.actionData = options;
-    };
-    BasePlugin.prototype.clearData = function () {
-        this.clearPluginData();
-        this.action = undefined;
-        this.actionData = {};
-    };
-    BasePlugin.prototype.getLocationInformation = function (eventType, payload) {
-        return __assign({ hitType: eventType }, this.getNextValues(eventType, payload));
-    };
-    BasePlugin.prototype.updateLocationInformation = function (eventType, payload) {
-        this.updateLocationForNextPageView(eventType, payload);
-    };
-    BasePlugin.prototype.getDefaultContextInformation = function (eventType) {
-        var documentContext = {
-            title: hasDocument() ? document.title : '',
-            encoding: hasDocument() ? document.characterSet : 'UTF-8',
-        };
-        var screenContext = {
-            screenResolution: screen.width + "x" + screen.height,
-            screenColor: screen.colorDepth + "-bit",
-        };
-        var navigatorContext = {
-            language: navigator.language,
-            userAgent: navigator.userAgent,
-        };
-        var eventContext = {
-            time: Date.now(),
-            eventId: this.uuidGenerator(),
-        };
-        return __assign(__assign(__assign(__assign({}, eventContext), screenContext), navigatorContext), documentContext);
-    };
-    BasePlugin.prototype.updateLocationForNextPageView = function (eventType, payload) {
-        var _a = this.getNextValues(eventType, payload), pageViewId = _a.pageViewId, referrer = _a.referrer, location = _a.location;
-        this.lastReferrer = referrer;
-        this.pageViewId = pageViewId;
-        this.currentLocation = location;
-        if (eventType === BasePluginEventTypes.pageview) {
-            this.nextPageViewId = this.uuidGenerator();
-            this.hasSentFirstPageView = true;
-        }
-    };
-    BasePlugin.prototype.getNextValues = function (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,
-        };
-    };
-    BasePlugin.prototype.getCurrentLocationFromPayload = function (payload) {
-        if (!!payload.page) {
-            var removeStartingSlash = function (page) { return page.replace(/^\/?(.*)$/, '/$1'); };
-            var extractHostnamePart = function (location) { return location.split('/').slice(0, 3).join('/'); };
-            return "" + extractHostnamePart(this.currentLocation) + removeStartingSlash(payload.page);
-        }
-        else {
-            return getFormattedLocation(window.location);
-        }
-    };
-    return BasePlugin;
-}());
-
 var ECPluginEventTypes = __assign({}, BasePluginEventTypes);
 var allECEventTypes = Object.keys(ECPluginEventTypes).map(function (key) { return ECPluginEventTypes[key]; });
 var ECPlugin = (function (_super) {
@@ -83505,6 +83666,19 @@ var ECPlugin = (function (_super) {
         _this.impressions = [];
         return _this;
     }
+    ECPlugin.prototype.getApi = function (name) {
+        var superCall = _super.prototype.getApi.call(this, name);
+        if (superCall !== null)
+            return superCall;
+        switch (name) {
+            case 'addProduct':
+                return this.addProduct;
+            case 'addImpression':
+                return this.addImpression;
+            default:
+                return null;
+        }
+    };
     ECPlugin.prototype.addHooks = function () {
         this.addHooksForPageView();
         this.addHooksForEvent();
@@ -83632,6 +83806,17 @@ var SVCPlugin = (function (_super) {
         _this.ticket = {};
         return _this;
     }
+    SVCPlugin.prototype.getApi = function (name) {
+        var superCall = _super.prototype.getApi.call(this, name);
+        if (superCall !== null)
+            return superCall;
+        switch (name) {
+            case 'setTicket':
+                return this.setTicket;
+            default:
+                return null;
+        }
+    };
     SVCPlugin.prototype.addHooks = function () {
         this.addHooksForEvent();
         this.addHooksForPageView();
@@ -83702,6 +83887,7 @@ var Plugins = (function () {
         this.registeredPluginsMap = (_a = {},
             _a[EC.Id] = EC,
             _a[SVC.Id] = SVC,
+            _a[Link.Id] = Link,
             _a);
         this.requiredPlugins = {};
     }
@@ -83719,24 +83905,24 @@ var Plugins = (function () {
         this.requiredPlugins = {};
     };
     Plugins.prototype.execute = function (name, fn) {
-        var pluginOptions = [];
+        var args = [];
         for (var _i = 2; _i < arguments.length; _i++) {
-            pluginOptions[_i - 2] = arguments[_i];
+            args[_i - 2] = arguments[_i];
         }
         var plugin = this.requiredPlugins[name];
         if (!plugin) {
             throw new Error("The plugin \"" + name + "\" is not required. Check that you required it on initialization.");
         }
-        var actionFunction = plugin[fn];
+        var 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);
     };
-    Plugins.DefaultPlugins = [EC.Id, SVC.Id];
+    Plugins.DefaultPlugins = [EC.Id, SVC.Id, Link.Id];
     return Plugins;
 }());
 
@@ -83848,7 +84034,7 @@ var CoveoUA = (function () {
         for (var _i = 2; _i < arguments.length; _i++) {
             args[_i - 2] = arguments[_i];
         }
-        (_a = this.plugins).execute.apply(_a, __spreadArrays([pluginName, fn], args));
+        return (_a = this.plugins).execute.apply(_a, __spreadArrays([pluginName, fn], args));
     };
     CoveoUA.prototype.reset = function () {
         this.client = undefined;