clarity-js 0.8.41 → 0.8.42

package/src/core/index.ts

@@ -1,81 +1,81 @@
-import { Config } from "@clarity-types/core";
-import { Constant } from "@clarity-types/data";
-import configuration from "@src/core/config";
-import * as event from "@src/core/event";
-import * as history from "@src/core/history";
-import * as report from "@src/core/report";
-import * as task from "@src/core/task";
-import * as time from "@src/core/time";
-import * as clarity from "@src/clarity";
-import * as custom from "@src/data/custom";
-
-let status = false;
-
-export function start(): void {
-    status = true;
-    time.start();
-    task.reset();
-    event.reset();
-    report.reset();
-    history.start();
-}
-
-export function stop(): void {
-    history.stop();
-    report.reset();
-    event.reset();
-    task.reset();
-    time.stop();
-    status = false;
-}
-
-export function active(): boolean {
-    return status;
-}
-
-export function check(): boolean {
-    try {
-        let globalPrivacyControlSet = navigator && "globalPrivacyControl" in navigator && navigator['globalPrivacyControl'] == true;
-        return status === false &&
-            typeof Promise !== "undefined" &&
-            window["MutationObserver"] &&
-            document["createTreeWalker"] &&
-            "now" in Date &&
-            "now" in performance &&
-            typeof WeakMap !== "undefined" &&
-            !globalPrivacyControlSet
-    } catch (ex) {
-        return false;
-    }
-}
-
-export function config(override: Config): boolean {
-    // Process custom configuration overrides, if available
-    if (override === null || status) { return false; }
-    for (let key in override) {
-        if (key in configuration) { configuration[key] = override[key]; }
-    }
-    return true;
-}
-
-// Suspend ends the current Clarity instance after a configured timeout period
-// The way it differs from the "end" call is that it starts listening to
-// user interaction events as soon as it terminates existing clarity instance.
-// On the next interaction, it automatically starts another instance under a different page id
-// E.g. if configured timeout is 10m, and user stays inactive for an hour.
-// In this case, we will suspend clarity after 10m of inactivity and after another 50m when user interacts again
-// Clarity will restart and start another instance seamlessly. Effectively not missing any active time, but also
-// not holding the session during inactive time periods.
-export function suspend(): void {
-    if (status) {
-        custom.event(Constant.Clarity, Constant.Suspend);
-        clarity.stop();
-        ["mousemove", "touchstart"].forEach(x => event.bind(document, x, restart));
-        ["resize", "scroll", "pageshow"].forEach(x => event.bind(window, x, restart));
-    }
-}
-
-function restart(): void {
-    clarity.start();
-    custom.event(Constant.Clarity, Constant.Restart);
-}
+import { Config } from "@clarity-types/core";
+import { Constant } from "@clarity-types/data";
+import configuration from "@src/core/config";
+import * as event from "@src/core/event";
+import * as history from "@src/core/history";
+import * as report from "@src/core/report";
+import * as task from "@src/core/task";
+import * as time from "@src/core/time";
+import * as clarity from "@src/clarity";
+import * as custom from "@src/data/custom";
+
+let status = false;
+
+export function start(): void {
+    status = true;
+    time.start();
+    task.reset();
+    event.reset();
+    report.reset();
+    history.start();
+}
+
+export function stop(): void {
+    history.stop();
+    report.reset();
+    event.reset();
+    task.reset();
+    time.stop();
+    status = false;
+}
+
+export function active(): boolean {
+    return status;
+}
+
+export function check(): boolean {
+    try {
+        let globalPrivacyControlSet = navigator && "globalPrivacyControl" in navigator && navigator['globalPrivacyControl'] == true;
+        return status === false &&
+            typeof Promise !== "undefined" &&
+            window["MutationObserver"] &&
+            document["createTreeWalker"] &&
+            "now" in Date &&
+            "now" in performance &&
+            typeof WeakMap !== "undefined" &&
+            !globalPrivacyControlSet
+    } catch (ex) {
+        return false;
+    }
+}
+
+export function config(override: Config): boolean {
+    // Process custom configuration overrides, if available
+    if (override === null || status) { return false; }
+    for (let key in override) {
+        if (key in configuration) { configuration[key] = override[key]; }
+    }
+    return true;
+}
+
+// Suspend ends the current Clarity instance after a configured timeout period
+// The way it differs from the "end" call is that it starts listening to
+// user interaction events as soon as it terminates existing clarity instance.
+// On the next interaction, it automatically starts another instance under a different page id
+// E.g. if configured timeout is 10m, and user stays inactive for an hour.
+// In this case, we will suspend clarity after 10m of inactivity and after another 50m when user interacts again
+// Clarity will restart and start another instance seamlessly. Effectively not missing any active time, but also
+// not holding the session during inactive time periods.
+export function suspend(): void {
+    if (status) {
+        custom.event(Constant.Clarity, Constant.Suspend);
+        clarity.stop();
+        ["mousemove", "touchstart"].forEach(x => event.bind(document, x, restart));
+        ["resize", "scroll", "pageshow"].forEach(x => event.bind(window, x, restart));
+    }
+}
+
+function restart(): void {
+    clarity.start();
+    custom.event(Constant.Clarity, Constant.Restart);
+}

package/src/core/measure.ts

@@ -1,19 +1,19 @@
-import { Code, Metric, Setting, Severity } from "@clarity-types/data";
-import { report } from "@src/core/report";
-import * as metric from "@src/data/metric";
-import * as internal from "@src/diagnostic/internal";
-
-// tslint:disable-next-line: ban-types
-export default function (method: Function): Function {
-    return function (): void {
-        let start = performance.now();
-        try { method.apply(this, arguments); } catch (ex) { throw report(ex); }
-        let duration = performance.now() - start;
-        metric.sum(Metric.TotalCost, duration);
-        if (duration > Setting.LongTask) {
-            metric.count(Metric.LongTaskCount);
-            metric.max(Metric.ThreadBlockedTime, duration);
-            method.dn && internal.log(Code.FunctionExecutionTime, Severity.Info, `${method.dn}-${duration}`);
-        }
-    };
-}
+import { Code, Metric, Setting, Severity } from "@clarity-types/data";
+import { report } from "@src/core/report";
+import * as metric from "@src/data/metric";
+import * as internal from "@src/diagnostic/internal";
+
+// tslint:disable-next-line: ban-types
+export default function (method: Function): Function {
+    return function (): void {
+        let start = performance.now();
+        try { method.apply(this, arguments); } catch (ex) { throw report(ex); }
+        let duration = performance.now() - start;
+        metric.sum(Metric.TotalCost, duration);
+        if (duration > Setting.LongTask) {
+            metric.count(Metric.LongTaskCount);
+            metric.max(Metric.ThreadBlockedTime, duration);
+            method.dn && internal.log(Code.FunctionExecutionTime, Severity.Info, `${method.dn}-${duration}`);
+        }
+    };
+}

package/src/core/report.ts

@@ -1,28 +1,28 @@
-import { Report } from "@clarity-types/core";
-import config from "@src/core/config";
-import { data } from "@src/data/envelope";
-
-let history: string[];
-
-export function reset(): void {
-    history = [];
-}
-
-export function report(e: Error): Error {
-    // Do not report the same message twice for the same page
-    if (history && history.indexOf(e.message) === -1) {
-        const url = config.report;
-        if (url && url.length > 0 && data) {
-            let payload: Report = {v: data.version, p: data.projectId, u: data.userId, s: data.sessionId, n: data.pageNum};
-            if (e.message) { payload.m = e.message; }
-            if (e.stack) { payload.e = e.stack; }
-            // Using POST request instead of a GET request (img-src) to not violate existing CSP rules
-            // Since, Clarity already uses XHR to upload data, we stick with similar POST mechanism for reporting too
-            let xhr = new XMLHttpRequest();
-            xhr.open("POST", url, true);
-            xhr.send(JSON.stringify(payload));
-            history.push(e.message);
-        }
-    }
-    return e;
-}
+import { Report } from "@clarity-types/core";
+import config from "@src/core/config";
+import { data } from "@src/data/envelope";
+
+let history: string[];
+
+export function reset(): void {
+    history = [];
+}
+
+export function report(e: Error): Error {
+    // Do not report the same message twice for the same page
+    if (history && history.indexOf(e.message) === -1) {
+        const url = config.report;
+        if (url && url.length > 0 && data) {
+            let payload: Report = {v: data.version, p: data.projectId, u: data.userId, s: data.sessionId, n: data.pageNum};
+            if (e.message) { payload.m = e.message; }
+            if (e.stack) { payload.e = e.stack; }
+            // Using POST request instead of a GET request (img-src) to not violate existing CSP rules
+            // Since, Clarity already uses XHR to upload data, we stick with similar POST mechanism for reporting too
+            let xhr = new XMLHttpRequest();
+            xhr.open("POST", url, true);
+            xhr.send(JSON.stringify(payload));
+            history.push(e.message);
+        }
+    }
+    return e;
+}