clarity-js 0.7.49 → 0.7.51

package/build/clarity.js

@@ -40,6 +40,7 @@ var dimension = /*#__PURE__*/Object.freeze({
 });
 var metadata$1 = /*#__PURE__*/Object.freeze({
     __proto__: null,
+    get callback () { return callback; },
     get callbacks () { return callbacks; },
     get clear () { return clear; },
     get consent () { return consent; },
@@ -114,7 +115,7 @@ function process$7() {
     }
 }
 
-var config$1 = {
+var config$2 = {
     projectId: null,
     delay: 1 * 1000 /* Time.Second */,
     lean: false,
@@ -164,7 +165,7 @@ function stop$F() {
     startTime = 0;
 }
 
-var version$1 = "0.7.49";
+var version$1 = "0.7.51";
 
 // tslint:disable: no-bitwise
 function hash (input, precision) {
@@ -275,7 +276,7 @@ function url$1(input, electron) {
     if (electron) {
         return "".concat("https://" /* Data.Constant.HTTPS */).concat("Electron" /* Data.Constant.Electron */);
     }
-    var drop = config$1.drop;
+    var drop = config$2.drop;
     if (drop && drop.length > 0 && input && input.indexOf("?") > 0) {
         var _a = input.split("?"), path = _a[0], query = _a[1];
         var swap_1 = "*na*" /* Data.Constant.Dropped */;
@@ -621,8 +622,8 @@ var summary = /*#__PURE__*/Object.freeze({
 
 var data$f = null;
 function start$D() {
-    if (!config$1.lean && config$1.upgrade) {
-        config$1.upgrade("Config" /* Constant.Config */);
+    if (!config$2.lean && config$2.upgrade) {
+        config$2.upgrade("Config" /* Constant.Config */);
     }
     data$f = null;
 }
@@ -632,14 +633,15 @@ function start$D() {
 // and send all backed up layout events to the server.
 function upgrade(key) {
     // Upgrade only if Clarity was successfully activated on the page
-    if (active() && config$1.lean) {
-        config$1.lean = false;
+    if (active() && config$2.lean) {
+        config$2.lean = false;
         data$f = { key: key };
         // Update metadata to track we have upgraded this session
+        callback();
         save();
         // Callback upgrade handler, if configured
-        if (config$1.upgrade) {
-            config$1.upgrade(key);
+        if (config$2.upgrade) {
+            config$2.upgrade(key);
         }
         encode$1(3 /* Event.Upgrade */);
     }
@@ -941,7 +943,7 @@ function start$A() {
 }
 function check$4(id, target, input) {
     // Compute hash for fraud detection, if enabled. Hash is computed only if input meets the minimum length criteria
-    if (config$1.fraud && id !== null && input && input.length >= 5 /* Setting.WordLength */) {
+    if (config$2.fraud && id !== null && input && input.length >= 5 /* Setting.WordLength */) {
         data$d = { id: id, target: target, checksum: hash(input, 28 /* Setting.ChecksumPrecision */) };
         // Only encode this event if we haven't already reported this hash
         if (history$5.indexOf(data$d.checksum) < 0) {
@@ -1095,14 +1097,14 @@ function parse$1(root, init) {
     try {
         // Parse unmask configuration into separate query selectors and override tokens as part of initialization
         if (init) {
-            config$1.unmask.forEach(function (x) { return x.indexOf("!" /* Constant.Bang */) < 0 ? unmask.push(x) : override.push(x.substr(1)); });
+            config$2.unmask.forEach(function (x) { return x.indexOf("!" /* Constant.Bang */) < 0 ? unmask.push(x) : override.push(x.substr(1)); });
         }
         // Since mutations may happen on leaf nodes too, e.g. text nodes, which may not support all selector APIs.
         // We ensure that the root note supports querySelectorAll API before executing the code below to identify new regions.
         if ("querySelectorAll" in root) {
-            config$1.regions.forEach(function (x) { return root.querySelectorAll(x[1]).forEach(function (e) { return observe$1(e, "".concat(x[0])); }); }); // Regions
-            config$1.mask.forEach(function (x) { return root.querySelectorAll(x).forEach(function (e) { return privacyMap.set(e, 3 /* Privacy.TextImage */); }); }); // Masked Elements
-            config$1.checksum.forEach(function (x) { return root.querySelectorAll(x[1]).forEach(function (e) { return fraudMap.set(e, x[0]); }); }); // Fraud Checksum Check
+            config$2.regions.forEach(function (x) { return root.querySelectorAll(x[1]).forEach(function (e) { return observe$1(e, "".concat(x[0])); }); }); // Regions
+            config$2.mask.forEach(function (x) { return root.querySelectorAll(x).forEach(function (e) { return privacyMap.set(e, 3 /* Privacy.TextImage */); }); }); // Masked Elements
+            config$2.checksum.forEach(function (x) { return root.querySelectorAll(x[1]).forEach(function (e) { return fraudMap.set(e, x[0]); }); }); // Fraud Checksum Check
             unmask.forEach(function (x) { return root.querySelectorAll(x).forEach(function (e) { return privacyMap.set(e, 0 /* Privacy.None */); }); }); // Unmasked Elements
         }
     }
@@ -1129,7 +1131,7 @@ function add(node, parent, data, source) {
     var parentValue = null;
     var regionId = exists(node) ? id : null;
     var fraudId = fraudMap.has(node) ? fraudMap.get(node) : null;
-    var privacyId = config$1.content ? 1 /* Privacy.Sensitive */ : 3 /* Privacy.TextImage */;
+    var privacyId = config$2.content ? 1 /* Privacy.Sensitive */ : 3 /* Privacy.TextImage */;
     if (parentId >= 0 && values[parentId]) {
         parentValue = values[parentId];
         parentValue.children.push(id);
@@ -1528,7 +1530,7 @@ function state$a(timer) {
     return 2 /* Task.Stop */;
 }
 function start$y(timer) {
-    tracker[key(timer)] = { start: performance.now(), calls: 0, yield: config$1.longTask };
+    tracker[key(timer)] = { start: performance.now(), calls: 0, yield: config$2.longTask };
 }
 function restart$2(timer) {
     var id = key(timer);
@@ -1614,14 +1616,14 @@ function requestIdleCallbackPolyfill(callback, options) {
         var currentTime = performance.now();
         var elapsed = currentTime - startTime;
         var duration = currentTime - event.data;
-        if (duration > config$1.longTask && elapsed < options.timeout) {
+        if (duration > config$2.longTask && elapsed < options.timeout) {
             requestAnimationFrame(function () { outgoing.postMessage(currentTime); });
         }
         else {
             var didTimeout_1 = elapsed > options.timeout;
             callback({
                 didTimeout: didTimeout_1,
-                timeRemaining: function () { return didTimeout_1 ? config$1.longTask : Math.max(0, config$1.longTask - duration); }
+                timeRemaining: function () { return didTimeout_1 ? config$2.longTask : Math.max(0, config$2.longTask - duration); }
             });
         }
     };
@@ -1718,7 +1720,7 @@ function recompute$8(evt) {
     var element = target(evt);
     if (element) {
         var value = element.value;
-        var checksum = value && value.length >= 5 /* Setting.WordLength */ && config$1.fraud && "password,secret,pass,social,ssn,code,hidden" /* Mask.Exclude */.indexOf(element.type) === -1 ? hash(value, 28 /* Setting.ChecksumPrecision */) : "" /* Constant.Empty */;
+        var checksum = value && value.length >= 5 /* Setting.WordLength */ && config$2.fraud && "password,secret,pass,social,ssn,code,hidden" /* Mask.Exclude */.indexOf(element.type) === -1 ? hash(value, 28 /* Setting.ChecksumPrecision */) : "" /* Constant.Empty */;
         state$9.push({ time: time(evt), event: 42 /* Event.Change */, data: { target: target(evt), type: element.type, value: value, checksum: checksum } });
         schedule$1(encode$3.bind(this, 42 /* Event.Change */));
     }
@@ -2505,7 +2507,7 @@ function process$2() {
                         return [3 /*break*/, 6];
                     }
                     target = mutation.target;
-                    type = config$1.throttleDom ? track$5(mutation, timer, instance, record.time) : mutation.type;
+                    type = config$2.throttleDom ? track$5(mutation, timer, instance, record.time) : mutation.type;
                     if (type && target && target.ownerDocument) {
                         parse$1(target.ownerDocument);
                     }
@@ -3365,7 +3367,7 @@ function encode$4 (type, timer, ts) {
                     if (type === 6 /* Event.Mutation */) {
                         activity(eventTime);
                     }
-                    queue(tokenize(tokens), !config$1.lean);
+                    queue(tokenize(tokens), !config$2.lean);
                     _l.label = 11;
                 case 11: return [3 /*break*/, 12];
                 case 12: return [2 /*return*/];
@@ -3885,7 +3887,7 @@ function upload(final) {
             switch (_b.label) {
                 case 0:
                     timeout = null;
-                    sendPlaybackBytes = config$1.lean === false && playbackBytes > 0 && (playbackBytes < 1048576 /* Setting.MaxFirstPayloadBytes */ || data$1.sequence > 0);
+                    sendPlaybackBytes = config$2.lean === false && playbackBytes > 0 && (playbackBytes < 1048576 /* Setting.MaxFirstPayloadBytes */ || data$1.sequence > 0);
                     if (sendPlaybackBytes) {
                         max(1 /* Metric.Playback */, 1 /* BooleanFlag.True */);
                     }
@@ -3930,8 +3932,8 @@ function stringify(encoded) {
 function send(payload, zipped, sequence, beacon) {
     if (beacon === void 0) { beacon = false; }
     // Upload data if a valid URL is defined in the config
-    if (typeof config$1.upload === "string" /* Constant.String */) {
-        var url_1 = config$1.upload;
+    if (typeof config$2.upload === "string" /* Constant.String */) {
+        var url_1 = config$2.upload;
         var dispatched = false;
         // If it's the last payload, attempt to upload using sendBeacon first.
         // The advantage to using sendBeacon is that browser can decide to upload asynchronously, improving chances of success
@@ -3980,8 +3982,8 @@ function send(payload, zipped, sequence, beacon) {
             }
         }
     }
-    else if (config$1.upload) {
-        var callback = config$1.upload;
+    else if (config$2.upload) {
+        var callback = config$2.upload;
         callback(payload);
         done(sequence);
     }
@@ -4003,7 +4005,7 @@ function check$3(xhr, sequence) {
                 //    2: Safari will terminate pending XHR requests with status code 0 if the user navigates away from the page
                 // In any case, we switch the upload URL to fallback configuration (if available) before re-trying one more time
                 if (xhr.status === 0) {
-                    config$1.upload = config$1.fallback ? config$1.fallback : config$1.upload;
+                    config$2.upload = config$2.fallback ? config$2.fallback : config$2.upload;
                 }
                 // In all other cases, re-attempt sending the same data
                 // For retry we always fallback to string payload, even though we may have attempted
@@ -4041,13 +4043,14 @@ function done(sequence) {
     // If we everything went successfully, and it is the first sequence, save this session for future reference
     if (sequence === 1) {
         save();
+        callback();
     }
 }
 function delay() {
     // Progressively increase delay as we continue to send more payloads from the client to the server
     // If we are not uploading data to a server, and instead invoking UploadCallback, in that case keep returning configured value
-    var gap = config$1.lean === false && discoverBytes > 0 ? 100 /* Setting.MinUploadDelay */ : data$1.sequence * config$1.delay;
-    return typeof config$1.upload === "string" /* Constant.String */ ? Math.max(Math.min(gap, 30000 /* Setting.MaxUploadDelay */), 100 /* Setting.MinUploadDelay */) : config$1.delay;
+    var gap = config$2.lean === false && discoverBytes > 0 ? 100 /* Setting.MinUploadDelay */ : data$1.sequence * config$2.delay;
+    return typeof config$2.upload === "string" /* Constant.String */ ? Math.max(Math.min(gap, 30000 /* Setting.MaxUploadDelay */), 100 /* Setting.MinUploadDelay */) : config$2.delay;
 }
 function response(payload) {
     var lines = payload && payload.length > 0 ? payload.split("\n") : [];
@@ -4065,8 +4068,8 @@ function response(payload) {
                 break;
             case "ACTION" /* Constant.Action */:
                 // Invoke action callback, if configured and has a valid value
-                if (config$1.action && parts.length > 1) {
-                    config$1.action(parts[1]);
+                if (config$2.action && parts.length > 1) {
+                    config$2.action(parts[1]);
                 }
                 break;
             case "EXTRACT" /* Constant.Extract */:
@@ -4549,6 +4552,17 @@ function reset$3() {
     updates = {};
 }
 
+function config$1(track) {
+    trackConsent(track ? 1 /* ConsentType.Implicit */ : 0 /* ConsentType.None */);
+}
+// When we get consent signal as false, we restart the service and track config as false.
+function consent$1() {
+    trackConsent(2 /* ConsentType.General */);
+}
+function trackConsent(consent) {
+    log(36 /* Dimension.Consent */, consent.toString());
+}
+
 var data$2 = null;
 var callbacks = [];
 var electron = 0 /* BooleanFlag.False */;
@@ -4565,11 +4579,11 @@ function start$9() {
     // Populate ids for this page
     var s = session();
     var u = user();
-    var projectId = config$1.projectId || hash(location.host);
+    var projectId = config$2.projectId || hash(location.host);
     data$2 = { projectId: projectId, userId: u.id, sessionId: s.session, pageNum: s.count };
     // Override configuration based on what's in the session storage, unless it is blank (e.g. using upload callback, like in devtools)
-    config$1.lean = config$1.track && s.upgrade !== null ? s.upgrade === 0 /* BooleanFlag.False */ : config$1.lean;
-    config$1.upload = config$1.track && typeof config$1.upload === "string" /* Constant.String */ && s.upload && s.upload.length > "https://" /* Constant.HTTPS */.length ? s.upload : config$1.upload;
+    config$2.lean = config$2.track && s.upgrade !== null ? s.upgrade === 0 /* BooleanFlag.False */ : config$2.lean;
+    config$2.upload = config$2.track && typeof config$2.upload === "string" /* Constant.String */ && s.upload && s.upload.length > "https://" /* Constant.HTTPS */.length ? s.upload : config$2.upload;
     // Log page metadata as dimensions
     log(0 /* Dimension.UserAgent */, ua);
     log(3 /* Dimension.PageTitle */, title);
@@ -4602,13 +4616,15 @@ function start$9() {
         max(16 /* Metric.ColorDepth */, Math.round(screen.colorDepth));
     }
     // Read cookies specified in configuration
-    for (var _i = 0, _d = config$1.cookies; _i < _d.length; _i++) {
+    for (var _i = 0, _d = config$2.cookies; _i < _d.length; _i++) {
         var key = _d[_i];
         var value = getCookie(key);
         if (value) {
             set(key, value);
         }
     }
+    // Track consent config
+    config$1(config$2.track);
     // Track ids using a cookie if configuration allows it
     track(u);
 }
@@ -4636,14 +4652,14 @@ function stop$8() {
 function metadata(cb, wait, recall) {
     if (wait === void 0) { wait = true; }
     if (recall === void 0) { recall = false; }
-    var upgraded = config$1.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
+    var upgraded = config$2.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
     var called = false;
     // 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 in addition to 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);
+        cb(data$2, !config$2.lean);
         called = true;
     }
     if (recall || !called) {
@@ -4656,7 +4672,7 @@ function id() {
 function consent(status) {
     if (status === void 0) { status = true; }
     if (!status) {
-        config$1.track = false;
+        config$2.track = false;
         setCookie("_clsk" /* Constant.SessionKey */, "" /* Constant.Empty */, -Number.MAX_VALUE);
         setCookie("_clck" /* Constant.CookieKey */, "" /* Constant.Empty */, -Number.MAX_VALUE);
         stop();
@@ -4664,8 +4680,10 @@ function consent(status) {
         return;
     }
     if (active()) {
-        config$1.track = true;
+        config$2.track = true;
         track(user(), 1 /* BooleanFlag.True */);
+        save();
+        consent$1();
     }
 }
 function clear() {
@@ -4674,20 +4692,23 @@ function clear() {
 }
 function tab() {
     var id = shortid();
-    if (config$1.track && supported(window, "sessionStorage" /* Constant.SessionStorage */)) {
+    if (config$2.track && supported(window, "sessionStorage" /* Constant.SessionStorage */)) {
         var value = sessionStorage.getItem("_cltk" /* Constant.TabKey */);
         id = value ? value : id;
         sessionStorage.setItem("_cltk" /* Constant.TabKey */, id);
     }
     return id;
 }
+function callback() {
+    var upgrade = config$2.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
+    processCallback(upgrade);
+}
 function save() {
     if (!data$2)
         return;
     var ts = Math.round(Date.now());
-    var upload = config$1.upload && typeof config$1.upload === "string" /* Constant.String */ ? config$1.upload.replace("https://" /* Constant.HTTPS */, "" /* Constant.Empty */) : "" /* Constant.Empty */;
-    var upgrade = config$1.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
-    processCallback(upgrade);
+    var upload = config$2.upload && typeof config$2.upload === "string" /* Constant.String */ ? config$2.upload.replace("https://" /* Constant.HTTPS */, "" /* Constant.Empty */) : "" /* Constant.Empty */;
+    var upgrade = config$2.lean ? 0 /* BooleanFlag.False */ : 1 /* BooleanFlag.True */;
     setCookie("_clsk" /* Constant.SessionKey */, [data$2.sessionId, ts, data$2.pageNum, upgrade, upload].join("|" /* Constant.Pipe */), 1 /* Setting.SessionExpire */);
 }
 function processCallback(upgrade) {
@@ -4695,7 +4716,7 @@ function processCallback(upgrade) {
         for (var i = 0; i < callbacks.length; i++) {
             var cb = callbacks[i];
             if (cb.callback && !cb.called && (!cb.wait || upgrade)) {
-                cb.callback(data$2, !config$1.lean);
+                cb.callback(data$2, !config$2.lean);
                 cb.called = true;
                 if (!cb.recall) {
                     callbacks.splice(i, 1);
@@ -4721,7 +4742,7 @@ function track(u, consent) {
     // 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;
+    var dob = u.dob === 0 ? (config$2.dob === null ? 0 : config$2.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 || u.dob !== dob) {
         var cookieParts = [data$2.userId, 2 /* Setting.CookieVersion */, end.toString(36), consent, dob];
@@ -4793,9 +4814,9 @@ function user() {
             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 */;
+        config$2.track = config$2.track || output.consent === 1 /* BooleanFlag.True */;
         // Get user id from cookie only if we tracking is enabled, otherwise fallback to a random id
-        output.id = config$1.track ? parts[0] : output.id;
+        output.id = config$2.track ? parts[0] : output.id;
     }
     return output;
 }
@@ -4839,7 +4860,7 @@ function encodeCookieValue(value) {
 function setCookie(key, value, time) {
     // only write cookies if we are currently in a cookie writing mode (and they are supported)
     // OR if we are trying to write an empty cookie (i.e. clear the cookie value out)
-    if ((config$1.track || value == "" /* Constant.Empty */) && ((navigator && navigator.cookieEnabled) || supported(document, "cookie" /* Constant.Cookie */))) {
+    if ((config$2.track || value == "" /* Constant.Empty */) && ((navigator && navigator.cookieEnabled) || supported(document, "cookie" /* Constant.Cookie */))) {
         // Some browsers automatically url encode cookie values if they are not url encoded.
         // We therefore encode and decode cookie values ourselves.
         var encodedValue = encodeCookieValue(value);
@@ -4926,7 +4947,7 @@ function reset$2() {
 function report(e) {
     // Do not report the same message twice for the same page
     if (history$1 && history$1.indexOf(e.message) === -1) {
-        var url = config$1.report;
+        var url = config$2.report;
         if (url && url.length > 0) {
             var payload = { v: data$1.version, p: data$1.projectId, u: data$1.userId, s: data$1.sessionId, n: data$1.pageNum };
             if (e.message) {
@@ -4958,7 +4979,7 @@ function measure (method) {
         }
         var duration = performance.now() - start;
         sum(4 /* Metric.TotalCost */, duration);
-        if (duration > config$1.longTask) {
+        if (duration > config$2.longTask) {
             count$1(7 /* Metric.LongTaskCount */);
             max(6 /* Metric.ThreadBlockedTime */, duration);
         }
@@ -5088,8 +5109,8 @@ function config(override) {
         return false;
     }
     for (var key in override) {
-        if (key in config$1) {
-            config$1[key] = override[key];
+        if (key in config$2) {
+            config$2[key] = override[key];
         }
     }
     return true;
@@ -5166,7 +5187,7 @@ function start$3() {
     start$x();
     start$h();
     start$z();
-    if (config$1.delayDom) {
+    if (config$2.delayDom) {
         // Lazy load layout module as part of page load time performance improvements experiment 
         bind(window, 'load', function () {
             start$k();
@@ -5319,7 +5340,7 @@ function process(entries) {
             case "resource" /* Constant.Resource */:
                 var name_1 = entry.name;
                 log(4 /* Dimension.NetworkHosts */, host(name_1));
-                if (name_1 === config$1.upload || name_1 === config$1.fallback) {
+                if (name_1 === config$2.upload || name_1 === config$2.fallback) {
                     max(28 /* Metric.UploadTime */, entry.duration);
                 }
                 break;