clarity-js 0.7.6 → 0.7.8

package/build/clarity.js

@@ -80,6 +80,8 @@ function setup() {
     if (typeof w !== "undefined") {
         w[c] = function () {
             (w[c].q = w[c].q || []).push(arguments);
+            // if the start function was called, don't queue it and instead process the queue
+            arguments[0] === "start" && w[c].q.unshift(w[c].q.pop()) && process$7();
         };
     }
 }
@@ -126,7 +128,8 @@ var config$1 = {
     upload: null,
     fallback: null,
     upgrade: null,
-    action: null
+    action: null,
+    dob: null
 };
 
 function api(method) {
@@ -149,7 +152,7 @@ function stop$D() {
     startTime = 0;
 }
 
-var version$1 = "0.7.6";
+var version$1 = "0.7.8";
 
 // tslint:disable: no-bitwise
 function hash (input, precision) {
@@ -189,7 +192,7 @@ function text$1(value, hint, privacy, mangle) {
                     case "value":
                     case "placeholder":
                     case "click":
-                        return redact(value);
+                        return redact$1(value);
                     case "input":
                     case "change":
                         return mangleToken(value);
@@ -233,7 +236,7 @@ function text$1(value, hint, privacy, mangle) {
                 switch (hint) {
                     case "*T" /* Layout.Constant.TextTag */:
                     case "data-" /* Layout.Constant.DataAttribute */:
-                        return scrub(value);
+                        return scrub(value, "\u25AA" /* Data.Constant.Letter */, "\u25AB" /* Data.Constant.Digit */);
                     case "value":
                     case "input":
                     case "click":
@@ -251,7 +254,12 @@ function text$1(value, hint, privacy, mangle) {
     }
     return value;
 }
-function url$1(input) {
+function url$1(input, electron) {
+    if (electron === void 0) { electron = false; }
+    // Replace the URL for Electron apps so we don't send back file:/// URL
+    if (electron) {
+        return "".concat("https://" /* Data.Constant.HTTPS */).concat("Electron" /* Data.Constant.Electron */);
+    }
     var drop = config$1.drop;
     if (drop && drop.length > 0 && input && input.indexOf("?") > 0) {
         var _a = input.split("?"), path = _a[0], query = _a[1];
@@ -274,9 +282,9 @@ function mangleText(value) {
 function mask(value) {
     return value.replace(catchallRegex, "\u2022" /* Data.Constant.Mask */);
 }
-function scrub(value) {
+function scrub(value, letter, digit) {
     regex(); // Initialize regular expressions
-    return value.replace(letterRegex, "\u25AA" /* Data.Constant.Letter */).replace(digitRegex, "\u25AB" /* Data.Constant.Digit */);
+    return value ? value.replace(letterRegex, letter).replace(digitRegex, digit) : value;
 }
 function mangleToken(value) {
     var length = ((Math.floor(value.length / 5 /* Data.Setting.WordLength */) + 1) * 5 /* Data.Setting.WordLength */);
@@ -300,7 +308,7 @@ function regex() {
         }
     }
 }
-function redact(value) {
+function redact$1(value) {
     var spaceIndex = -1;
     var gap = 0;
     var hasDigit = false;
@@ -325,7 +333,7 @@ function redact(value) {
                 // Check if unicode regex is supported, otherwise fallback to calling mask function on this token
                 if (unicodeRegex && currencyRegex !== null) {
                     // Do not redact information if the token contains a currency symbol
-                    token = token.match(currencyRegex) ? token : token.replace(letterRegex, "\u25AA" /* Data.Constant.Letter */).replace(digitRegex, "\u25AB" /* Data.Constant.Digit */);
+                    token = token.match(currencyRegex) ? token : scrub(token, "\u25AA" /* Data.Constant.Letter */, "\u25AB" /* Data.Constant.Digit */);
                 }
                 else {
                     token = mask(token);
@@ -626,57 +634,6 @@ var upgrade$1 = /*#__PURE__*/Object.freeze({
     upgrade: upgrade
 });
 
-var data$e = null;
-function start$A() {
-    reset$m();
-}
-function set(variable, value) {
-    var values = typeof value === "string" /* Constant.String */ ? [value] : value;
-    log$2(variable, values);
-}
-function identify(userId, sessionId, pageId) {
-    if (sessionId === void 0) { sessionId = null; }
-    if (pageId === void 0) { pageId = null; }
-    log$2("userId" /* Constant.UserId */, [userId]);
-    log$2("sessionId" /* Constant.SessionId */, [sessionId]);
-    log$2("pageId" /* Constant.PageId */, [pageId]);
-}
-function log$2(variable, value) {
-    if (active() &&
-        variable &&
-        value &&
-        typeof variable === "string" /* Constant.String */ &&
-        variable.length < 255) {
-        var validValues = variable in data$e ? data$e[variable] : [];
-        for (var i = 0; i < value.length; i++) {
-            if (typeof value[i] === "string" /* Constant.String */ && value[i].length < 255) {
-                validValues.push(value[i]);
-            }
-        }
-        data$e[variable] = validValues;
-    }
-}
-function compute$9() {
-    encode$1(34 /* Event.Variable */);
-}
-function reset$m() {
-    data$e = {};
-}
-function stop$x() {
-    reset$m();
-}
-
-var variable = /*#__PURE__*/Object.freeze({
-    __proto__: null,
-    compute: compute$9,
-    get data () { return data$e; },
-    identify: identify,
-    reset: reset$m,
-    set: set,
-    start: start$A,
-    stop: stop$x
-});
-
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -730,6 +687,113 @@ function __generator(thisArg, body) {
     }
 }
 
+var data$e = null;
+function start$A() {
+    reset$m();
+}
+function set(variable, value) {
+    var values = typeof value === "string" /* Constant.String */ ? [value] : value;
+    log$2(variable, values);
+}
+function identify(userId, sessionId, pageId, userHint) {
+    if (sessionId === void 0) { sessionId = null; }
+    if (pageId === void 0) { pageId = null; }
+    if (userHint === void 0) { userHint = null; }
+    return __awaiter(this, void 0, void 0, function () {
+        var output;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _a = {};
+                    return [4 /*yield*/, sha256(userId)];
+                case 1:
+                    output = (_a.userId = _b.sent(), _a.userHint = userHint || redact(userId), _a);
+                    // By default, hash custom userId using SHA256 algorithm on the client to preserve privacy
+                    log$2("userId" /* Constant.UserId */, [output.userId]);
+                    // Optional non-identifying name for the user
+                    // If name is not explicitly provided, we automatically generate a redacted version of the userId
+                    log$2("userHint" /* Constant.UserHint */, [output.userHint]);
+                    log$2("userType" /* Constant.UserType */, [detect(userId)]);
+                    // Log sessionId and pageId if provided
+                    if (sessionId) {
+                        log$2("sessionId" /* Constant.SessionId */, [sessionId]);
+                        output.sessionId = sessionId;
+                    }
+                    if (pageId) {
+                        log$2("pageId" /* Constant.PageId */, [pageId]);
+                        output.pageId = pageId;
+                    }
+                    return [2 /*return*/, output];
+            }
+        });
+    });
+}
+function log$2(variable, value) {
+    if (active() &&
+        variable &&
+        value &&
+        typeof variable === "string" /* Constant.String */ &&
+        variable.length < 255) {
+        var validValues = variable in data$e ? data$e[variable] : [];
+        for (var i = 0; i < value.length; i++) {
+            if (typeof value[i] === "string" /* Constant.String */ && value[i].length < 255) {
+                validValues.push(value[i]);
+            }
+        }
+        data$e[variable] = validValues;
+    }
+}
+function compute$9() {
+    encode$1(34 /* Event.Variable */);
+}
+function reset$m() {
+    data$e = {};
+}
+function stop$x() {
+    reset$m();
+}
+function redact(input) {
+    return input && input.length >= 5 /* Setting.WordLength */ ?
+        "".concat(input.substring(0, 2)).concat(scrub(input.substring(2), "*" /* Constant.Asterix */, "*" /* Constant.Asterix */)) : scrub(input, "*" /* Constant.Asterix */, "*" /* Constant.Asterix */);
+}
+function sha256(input) {
+    return __awaiter(this, void 0, void 0, function () {
+        var buffer;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    _b.trys.push([0, 4, , 5]);
+                    if (!(crypto && input)) return [3 /*break*/, 2];
+                    return [4 /*yield*/, crypto.subtle.digest("SHA-256" /* Constant.SHA256 */, new TextEncoder().encode(input))];
+                case 1:
+                    buffer = _b.sent();
+                    return [2 /*return*/, Array.prototype.map.call(new Uint8Array(buffer), function (x) { return (('00' + x.toString(16)).slice(-2)); }).join('')];
+                case 2: return [2 /*return*/, "" /* Constant.Empty */];
+                case 3: return [3 /*break*/, 5];
+                case 4:
+                    _b.sent();
+                    return [2 /*return*/, "" /* Constant.Empty */];
+                case 5: return [2 /*return*/];
+            }
+        });
+    });
+}
+function detect(input) {
+    return input && input.indexOf("@" /* Constant.At */) > 0 ? "email" /* Constant.Email */ : "string" /* Constant.String */;
+}
+
+var variable = /*#__PURE__*/Object.freeze({
+    __proto__: null,
+    compute: compute$9,
+    get data () { return data$e; },
+    identify: identify,
+    reset: reset$m,
+    set: set,
+    start: start$A,
+    stop: stop$x
+});
+
 var supported$1 = "CompressionStream" /* Constant.CompressionStream */ in window;
 function compress (input) {
     return __awaiter(this, void 0, void 0, function () {
@@ -1970,10 +2034,10 @@ function text(element) {
         // Grab text using "textContent" for most HTMLElements, however, use "value" for HTMLInputElements and "alt" for HTMLImageElement.
         var t = element.textContent || element.value || element.alt;
         if (t) {
-            // Trim any spaces at the beginning or at the end of string
-            // Also, replace multiple occurrence of space characters with a single white space
+            // Replace multiple occurrence of space characters with a single white space
+            // Also, trim any spaces at the beginning or at the end of string
             // Finally, send only first few characters as specified by the Setting
-            output = t.trim().replace(/\s+/g, " " /* Constant.Space */).substr(0, 25 /* Setting.ClickText */);
+            output = t.replace(/\s+/g, " " /* Constant.Space */).trim().substr(0, 25 /* Setting.ClickText */);
         }
     }
     return output;
@@ -3659,12 +3723,18 @@ function stop$c() {
 }
 
 var data$5 = {};
-var keys = [];
+var keys = new Set();
 var variables = {};
 var selectors = {};
+var hashes = {};
 function start$c() {
     reset$4();
 }
+// Input string is of the following form:
+// EXTRACT 101 { "1": ".class1", "2": "~window.a.b", "3": "!abc"}
+// Which will set up event 101 to grab the contents of the class1 selector into component 1,
+// the javascript evaluated contents of window.a.b into component 2,
+// and the contents of Clarity's hash abc into component 3
 function trigger$1(input) {
     try {
         var parts = input && input.length > 0 ? input.split(/ (.*)/) : ["" /* Constant.Empty */];
@@ -3672,10 +3742,19 @@ function trigger$1(input) {
         var values = parts.length > 1 ? JSON.parse(parts[1]) : {};
         variables[key] = {};
         selectors[key] = {};
+        hashes[key] = {};
         for (var v in values) {
+            // values is a set of strings for proper JSON parsing, but it's more efficient 
+            // to interact with them as numbers
             var id = parseInt(v);
             var value = values[v];
-            var source = value.startsWith("~" /* Constant.Tilde */) ? 0 /* ExtractSource.Javascript */ : 2 /* ExtractSource.Text */;
+            var source = 2 /* ExtractSource.Text */;
+            if (value.startsWith("~" /* Constant.Tilde */)) {
+                source = 0 /* ExtractSource.Javascript */;
+            }
+            else if (value.startsWith("!" /* Constant.Bang */)) {
+                source = 4 /* ExtractSource.Hash */;
+            }
             switch (source) {
                 case 0 /* ExtractSource.Javascript */:
                     var variable = value.substring(1, value.length);
@@ -3684,6 +3763,10 @@ function trigger$1(input) {
                 case 2 /* ExtractSource.Text */:
                     selectors[key][id] = value;
                     break;
+                case 4 /* ExtractSource.Hash */:
+                    var hash = value.substring(1, value.length);
+                    hashes[key][id] = hash;
+                    break;
             }
         }
     }
@@ -3698,44 +3781,56 @@ function compute$4() {
     try {
         for (var v in variables) {
             var key = parseInt(v);
-            if (!(key in keys)) {
-                var variableData = variables[key];
-                for (var v_1 in variableData) {
-                    var variableKey = parseInt(v_1);
-                    var value = str(evaluate(clone(variableData[variableKey])));
-                    if (value) {
-                        update(key, variableKey, value);
-                    }
+            var variableData = variables[key];
+            for (var v_1 in variableData) {
+                var variableKey = parseInt(v_1);
+                var value = str(evaluate(clone(variableData[variableKey])));
+                if (value) {
+                    update(key, variableKey, value);
                 }
-                var selectorData = selectors[key];
-                for (var s in selectorData) {
-                    var selectorKey = parseInt(s);
-                    var nodes = document.querySelectorAll(selectorData[selectorKey]);
-                    if (nodes) {
-                        var text = Array.from(nodes).map(function (e) { return e.innerText; });
-                        update(key, selectorKey, text.join("<SEP>" /* Constant.Seperator */).substring(0, 10000 /* Setting.ExtractLimit */));
-                    }
+            }
+            var selectorData = selectors[key];
+            for (var s in selectorData) {
+                var selectorKey = parseInt(s);
+                var nodes = document.querySelectorAll(selectorData[selectorKey]);
+                if (nodes) {
+                    var text = Array.from(nodes).map(function (e) { return e.textContent; });
+                    update(key, selectorKey, text.join("<SEP>" /* Constant.Seperator */).substring(0, 10000 /* Setting.ExtractLimit */));
                 }
             }
+            var hashData = hashes[key];
+            for (var h in hashData) {
+                var hashKey = parseInt(h);
+                var content = hashText(hashData[hashKey]).trim().substring(0, 10000 /* Setting.ExtractLimit */);
+                update(key, hashKey, content);
+            }
+        }
+        if (keys.size > 0) {
+            encode$1(40 /* Event.Extract */);
         }
     }
     catch (e) {
         log$1(5 /* Code.Selector */, 1 /* Severity.Warning */, e ? e.name : null);
     }
-    encode$1(40 /* Event.Extract */);
 }
 function reset$4() {
-    data$5 = {};
-    keys = [];
-    variables = {};
-    selectors = {};
+    keys.clear();
 }
 function update(key, subkey, value) {
+    var update = false;
     if (!(key in data$5)) {
-        data$5[key] = [];
-        keys.push(key);
+        data$5[key] = {};
+        update = true;
+    }
+    if (!isEmpty(hashes[key])
+        && (!(subkey in data$5[key]) || data$5[key][subkey] != value)) {
+        update = true;
+    }
+    data$5[key][subkey] = value;
+    if (update) {
+        keys.add(key);
     }
-    data$5[key].push([subkey, value]);
+    return;
 }
 function stop$b() {
     reset$4();
@@ -3798,6 +3893,9 @@ function match(base, condition) {
         return prop.length > 1 ? base[prop[0]] == prop[1] : base[prop[0]];
     }
     return true;
+}
+function isEmpty(obj) {
+    return Object.keys(obj).length == 0;
 }
 
 function encode$1 (event) {
@@ -3900,11 +3998,16 @@ function encode$1 (event) {
             break;
         case 40 /* Event.Extract */:
             var extractKeys = keys;
-            for (var _d = 0, extractKeys_1 = extractKeys; _d < extractKeys_1.length; _d++) {
-                var e = extractKeys_1[_d];
+            extractKeys.forEach((function (e) {
                 tokens.push(e);
-                tokens.push([].concat.apply([], data$5[e]));
-            }
+                var token = [];
+                for (var d in data$5[e]) {
+                    var key = parseInt(d, 10);
+                    token.push(key);
+                    token.push(data$5[e][d]);
+                }
+                tokens.push(token);
+            }));
             reset$4();
             queue(tokens, false);
     }
@@ -3918,6 +4021,7 @@ function check$2(bytes) {
     if (data$4.check === 0 /* Check.None */) {
         var reason = data$4.check;
         reason = data$1.sequence >= 128 /* Setting.PayloadLimit */ ? 1 /* Check.Payload */ : reason;
+        reason = data$1.pageNum >= 128 /* Setting.PageLimit */ ? 7 /* Check.Page */ : reason;
         reason = time() > 7200000 /* Setting.ShutdownLimit */ ? 2 /* Check.Shutdown */ : reason;
         reason = bytes > 10485760 /* Setting.PlaybackBytesLimit */ ? 2 /* Check.Shutdown */ : reason;
         if (reason !== data$4.check) {
@@ -3986,6 +4090,7 @@ function start$9() {
     rootDomain = null;
     var ua = navigator && "userAgent" in navigator ? navigator.userAgent : "" /* Constant.Empty */;
     var title = document && document.title ? document.title : "" /* Constant.Empty */;
+    var electron = ua.indexOf("Electron" /* Constant.Electron */) > 0 ? 1 /* BooleanFlag.True */ : 0 /* BooleanFlag.False */;
     // Populate ids for this page
     var s = session();
     var u = user();
@@ -3997,15 +4102,18 @@ function start$9() {
     // Log page metadata as dimensions
     log(0 /* Dimension.UserAgent */, ua);
     log(3 /* Dimension.PageTitle */, title);
-    log(1 /* Dimension.Url */, url$1(location.href));
+    log(1 /* Dimension.Url */, url$1(location.href, !!electron));
     log(2 /* Dimension.Referrer */, document.referrer);
     log(15 /* Dimension.TabId */, tab());
     log(16 /* Dimension.PageLanguage */, document.documentElement.lang);
     log(17 /* Dimension.DocumentDirection */, document.dir);
     log(26 /* Dimension.DevicePixelRatio */, "".concat(window.devicePixelRatio));
+    log(28 /* Dimension.Dob */, u.dob.toString());
+    log(29 /* Dimension.CookieVersion */, u.version.toString());
     // Capture additional metadata as metrics
     max(0 /* Metric.ClientTimestamp */, s.ts);
     max(1 /* Metric.Playback */, 0 /* BooleanFlag.False */);
+    max(35 /* Metric.Electron */, electron);
     // Capture navigator specific dimensions
     if (navigator) {
         log(9 /* Dimension.Language */, navigator.language);
@@ -4052,11 +4160,17 @@ function stop$8() {
 }
 function metadata(cb, wait) {
     if (wait === void 0) { wait = true; }
-    if (data$2 && wait === false) {
+    var upgraded = config$1.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
+    // if caller hasn't specified that they want to skip waiting for upgrade but we've already upgraded, we need to
+    // directly execute the callback rather than adding to our list as we only process callbacks at the moment
+    // we go through the upgrading flow.
+    if (data$2 && (upgraded || wait === false)) {
         // Immediately invoke the callback if the caller explicitly doesn't want to wait for the upgrade confirmation
         cb(data$2, !config$1.lean);
     }
-    callbacks.push({ callback: cb, wait: wait });
+    else {
+        callbacks.push({ callback: cb, wait: wait });
+    }
 }
 function id() {
     return data$2 ? [data$2.userId, data$2.sessionId, data$2.pageNum].join("." /* Constant.Dot */) : "" /* Constant.Empty */;
@@ -4111,9 +4225,12 @@ function track(u, consent) {
     // Convert time precision into days to reduce number of bytes we have to write in a cookie
     // E.g. Math.ceil(1628735962643 / (24*60*60*1000)) => 18852 (days) => ejo in base36 (13 bytes => 3 bytes)
     var end = Math.ceil((Date.now() + (365 /* Setting.Expire */ * 86400000 /* Time.Day */)) / 86400000 /* Time.Day */);
+    // If DOB is not set in the user object, use the date set in the config as a DOB
+    var dob = u.dob === 0 ? (config$1.dob === null ? 0 : config$1.dob) : u.dob;
     // To avoid cookie churn, write user id cookie only once every day
-    if (u.expiry === null || Math.abs(end - u.expiry) >= 1 /* Setting.CookieInterval */ || u.consent !== consent) {
-        setCookie("_clck" /* Constant.CookieKey */, [data$2.userId, 1 /* Setting.CookieVersion */, end.toString(36), consent].join("|" /* Constant.Pipe */), 365 /* Setting.Expire */);
+    if (u.expiry === null || Math.abs(end - u.expiry) >= 1 /* Setting.CookieInterval */ || u.consent !== consent || u.dob !== dob) {
+        var cookieParts = [data$2.userId, 2 /* Setting.CookieVersion */, end.toString(36), consent, dob];
+        setCookie("_clck" /* Constant.CookieKey */, cookieParts.join("|" /* Constant.Pipe */), 365 /* Setting.Expire */);
     }
 }
 function shortid() {
@@ -4144,7 +4261,7 @@ function num(string, base) {
     return parseInt(string, base);
 }
 function user() {
-    var output = { id: shortid(), expiry: null, consent: 0 /* BooleanFlag.False */ };
+    var output = { id: shortid(), version: 0, expiry: null, consent: 0 /* BooleanFlag.False */, dob: 0 };
     var cookie = getCookie("_clck" /* Constant.CookieKey */);
     if (cookie && cookie.length > 0) {
         // Splitting and looking up first part for forward compatibility, in case we wish to store additional information in a cookie
@@ -4167,6 +4284,9 @@ function user() {
         }
         // End code for backward compatibility
         // Read version information and timestamp from cookie, if available
+        if (parts.length > 1) {
+            output.version = num(parts[1]);
+        }
         if (parts.length > 2) {
             output.expiry = num(parts[2], 36);
         }
@@ -4174,6 +4294,9 @@ function user() {
         if (parts.length > 3 && num(parts[3]) === 1) {
             output.consent = 1 /* BooleanFlag.True */;
         }
+        if (parts.length > 4 && num(parts[1]) > 1) {
+            output.dob = num(parts[4]);
+        }
         // Set track configuration to true for this user if we have explicit consent, regardless of project setting
         config$1.track = config$1.track || output.consent === 1 /* BooleanFlag.True */;
         // Get user id from cookie only if we tracking is enabled, otherwise fallback to a random id