clarity-js 0.8.42 → 0.8.44

package/src/data/baseline.ts

@@ -1,162 +1,162 @@
-import { Event, BooleanFlag } from "@clarity-types/data";
-import { BaselineData, BaselineState } from "@clarity-types/data";
-import { time } from "@src/core/time";
-import encode from "@src/data/encode";
-
-export let state: BaselineState = null;
-let buffer: BaselineData = null;
-let update: boolean = false;
-
-export function start(): void {
-    update = false;
-    reset();
-}
-
-export function reset(): void {
-    // Baseline state holds the previous values - if it is updated in the current payload,
-    // reset the state to current value after sending the previous state
-    if (update) {
-        state = { time: time(), event: Event.Baseline, data: {
-            visible: buffer.visible,
-            docWidth: buffer.docWidth,
-            docHeight: buffer.docHeight,
-            screenWidth: buffer.screenWidth,
-            screenHeight: buffer.screenHeight,
-            scrollX: buffer.scrollX,
-            scrollY: buffer.scrollY,
-            pointerX: buffer.pointerX,
-            pointerY: buffer.pointerY,
-            activityTime: buffer.activityTime,
-            scrollTime: buffer.scrollTime,
-            pointerTime: buffer.pointerTime,
-            moveX: buffer.moveX,
-            moveY: buffer.moveY,
-            moveTime: buffer.moveTime,
-            downX: buffer.downX,
-            downY: buffer.downY,
-            downTime: buffer.downTime,
-            upX: buffer.upX,
-            upY: buffer.upY,
-            upTime: buffer.upTime,
-            pointerPrevX: buffer.pointerPrevX,
-            pointerPrevY: buffer.pointerPrevY,
-            pointerPrevTime: buffer.pointerPrevTime,
-            modules: buffer.modules,
-          }
-        };
-    }
-    buffer = buffer ? buffer : {
-        visible: BooleanFlag.True,
-        docWidth: 0,
-        docHeight: 0,
-        screenWidth: 0,
-        screenHeight: 0,
-        scrollX: 0,
-        scrollY: 0,
-        pointerX: 0,
-        pointerY: 0,
-        activityTime: 0,
-        scrollTime: 0,
-        pointerTime: undefined,
-        moveX: undefined,
-        moveY: undefined,
-        moveTime: undefined,
-        downX: undefined,
-        downY: undefined,
-        downTime: undefined,
-        upX: undefined,
-        upY: undefined,
-        upTime: undefined,
-        pointerPrevX: undefined,
-        pointerPrevY: undefined,
-        pointerPrevTime: undefined,
-        modules: null,
-    };
-}
-
-export function track(event: Event, x: number, y: number, time?: number): void {
-    switch (event) {
-        case Event.Document:
-            buffer.docWidth = x;
-            buffer.docHeight = y;
-            break;
-        case Event.Resize:
-            buffer.screenWidth = x;
-            buffer.screenHeight = y;
-            break;
-        case Event.Scroll:
-            buffer.scrollX = x;
-            buffer.scrollY = y;
-            buffer.scrollTime = time;
-            break;
-        case Event.MouseMove:
-            buffer.moveX = x;
-            buffer.moveY = y;
-            buffer.moveTime = time;
-            buffer.pointerPrevX = buffer.pointerX;
-            buffer.pointerPrevY = buffer.pointerY;
-            buffer.pointerPrevTime = buffer.pointerTime;
-            buffer.pointerX = x;
-            buffer.pointerY = y;
-            buffer.pointerTime = time;
-            break;
-        case Event.MouseDown:
-            buffer.downX = x;
-            buffer.downY = y;
-            buffer.downTime = time;
-            buffer.pointerPrevX = buffer.pointerX;
-            buffer.pointerPrevY = buffer.pointerY;
-            buffer.pointerPrevTime = buffer.pointerTime;
-            buffer.pointerX = x;
-            buffer.pointerY = y;
-            buffer.pointerTime = time;
-            break;
-        case Event.MouseUp:
-            buffer.upX = x;
-            buffer.upY = y;
-            buffer.upTime = time;
-            buffer.pointerPrevX = buffer.pointerX;
-            buffer.pointerPrevY = buffer.pointerY;
-            buffer.pointerPrevTime = buffer.pointerTime;
-            buffer.pointerX = x;
-            buffer.pointerY = y;
-            buffer.pointerTime = time;
-            break;
-        default:
-            buffer.pointerPrevX = buffer.pointerX;
-            buffer.pointerPrevY = buffer.pointerY;
-            buffer.pointerPrevTime = buffer.pointerTime;
-            buffer.pointerX = x;
-            buffer.pointerY = y;
-            buffer.pointerTime = time;
-            break;
-    }
-    update = true;
-}
-
-export function activity(t: number): void {
-    buffer.activityTime = t;
-}
-
-export function visibility(t: number, visible: BooleanFlag): void {
-    buffer.visible = visible;
-    if (!buffer.visible) {
-        activity(t);
-    }
-    update = true;
-}
-
-export function dynamic(modules: Set<number>): void {
-    buffer.modules = Array.from(modules);
-    update = true;
-}
-
-export function compute(): void {
-    if (update) {
-        encode(Event.Baseline);
-    }
-}
-
-export function stop(): void {
-    reset();
-}
+import { Event, BooleanFlag } from "@clarity-types/data";
+import { BaselineData, BaselineState } from "@clarity-types/data";
+import { time } from "@src/core/time";
+import encode from "@src/data/encode";
+
+export let state: BaselineState = null;
+let buffer: BaselineData = null;
+let update: boolean = false;
+
+export function start(): void {
+    update = false;
+    reset();
+}
+
+export function reset(): void {
+    // Baseline state holds the previous values - if it is updated in the current payload,
+    // reset the state to current value after sending the previous state
+    if (update) {
+        state = { time: time(), event: Event.Baseline, data: {
+            visible: buffer.visible,
+            docWidth: buffer.docWidth,
+            docHeight: buffer.docHeight,
+            screenWidth: buffer.screenWidth,
+            screenHeight: buffer.screenHeight,
+            scrollX: buffer.scrollX,
+            scrollY: buffer.scrollY,
+            pointerX: buffer.pointerX,
+            pointerY: buffer.pointerY,
+            activityTime: buffer.activityTime,
+            scrollTime: buffer.scrollTime,
+            pointerTime: buffer.pointerTime,
+            moveX: buffer.moveX,
+            moveY: buffer.moveY,
+            moveTime: buffer.moveTime,
+            downX: buffer.downX,
+            downY: buffer.downY,
+            downTime: buffer.downTime,
+            upX: buffer.upX,
+            upY: buffer.upY,
+            upTime: buffer.upTime,
+            pointerPrevX: buffer.pointerPrevX,
+            pointerPrevY: buffer.pointerPrevY,
+            pointerPrevTime: buffer.pointerPrevTime,
+            modules: buffer.modules,
+          }
+        };
+    }
+    buffer = buffer ? buffer : {
+        visible: BooleanFlag.True,
+        docWidth: 0,
+        docHeight: 0,
+        screenWidth: 0,
+        screenHeight: 0,
+        scrollX: 0,
+        scrollY: 0,
+        pointerX: 0,
+        pointerY: 0,
+        activityTime: 0,
+        scrollTime: 0,
+        pointerTime: undefined,
+        moveX: undefined,
+        moveY: undefined,
+        moveTime: undefined,
+        downX: undefined,
+        downY: undefined,
+        downTime: undefined,
+        upX: undefined,
+        upY: undefined,
+        upTime: undefined,
+        pointerPrevX: undefined,
+        pointerPrevY: undefined,
+        pointerPrevTime: undefined,
+        modules: null,
+    };
+}
+
+export function track(event: Event, x: number, y: number, time?: number): void {
+    switch (event) {
+        case Event.Document:
+            buffer.docWidth = x;
+            buffer.docHeight = y;
+            break;
+        case Event.Resize:
+            buffer.screenWidth = x;
+            buffer.screenHeight = y;
+            break;
+        case Event.Scroll:
+            buffer.scrollX = x;
+            buffer.scrollY = y;
+            buffer.scrollTime = time;
+            break;
+        case Event.MouseMove:
+            buffer.moveX = x;
+            buffer.moveY = y;
+            buffer.moveTime = time;
+            buffer.pointerPrevX = buffer.pointerX;
+            buffer.pointerPrevY = buffer.pointerY;
+            buffer.pointerPrevTime = buffer.pointerTime;
+            buffer.pointerX = x;
+            buffer.pointerY = y;
+            buffer.pointerTime = time;
+            break;
+        case Event.MouseDown:
+            buffer.downX = x;
+            buffer.downY = y;
+            buffer.downTime = time;
+            buffer.pointerPrevX = buffer.pointerX;
+            buffer.pointerPrevY = buffer.pointerY;
+            buffer.pointerPrevTime = buffer.pointerTime;
+            buffer.pointerX = x;
+            buffer.pointerY = y;
+            buffer.pointerTime = time;
+            break;
+        case Event.MouseUp:
+            buffer.upX = x;
+            buffer.upY = y;
+            buffer.upTime = time;
+            buffer.pointerPrevX = buffer.pointerX;
+            buffer.pointerPrevY = buffer.pointerY;
+            buffer.pointerPrevTime = buffer.pointerTime;
+            buffer.pointerX = x;
+            buffer.pointerY = y;
+            buffer.pointerTime = time;
+            break;
+        default:
+            buffer.pointerPrevX = buffer.pointerX;
+            buffer.pointerPrevY = buffer.pointerY;
+            buffer.pointerPrevTime = buffer.pointerTime;
+            buffer.pointerX = x;
+            buffer.pointerY = y;
+            buffer.pointerTime = time;
+            break;
+    }
+    update = true;
+}
+
+export function activity(t: number): void {
+    buffer.activityTime = t;
+}
+
+export function visibility(t: number, visible: BooleanFlag): void {
+    buffer.visible = visible;
+    if (!buffer.visible) {
+        activity(t);
+    }
+    update = true;
+}
+
+export function dynamic(modules: Set<number>): void {
+    buffer.modules = Array.from(modules);
+    update = true;
+}
+
+export function compute(): void {
+    if (update) {
+        encode(Event.Baseline);
+    }
+}
+
+export function stop(): void {
+    reset();
+}

package/src/data/compress.ts

@@ -1,31 +1,31 @@
-import { Constant } from "@clarity-types/data";
-
-const supported = Constant.CompressionStream in window;
-
-export default async function(input: string): Promise<Uint8Array> {
-    try {
-        if (supported) {
-            // Create a readable stream from given input string and
-            // pipe it through text encoder and compression stream to gzip it
-            const stream = new ReadableStream({async start(controller) {
-                controller.enqueue(input);
-                controller.close();
-            }}).pipeThrough(new TextEncoderStream()).pipeThrough(new window[Constant.CompressionStream]("gzip"));
-            return new Uint8Array(await read(stream));
-        }
-    } catch { /* do nothing */ }
-    return null;
-}
-
-async function read(stream: ReadableStream): Promise<number[]> {
-    const reader = stream.getReader();
-    const chunks:number[] = [];
-    let done = false;
-    let value: number[] = [];
-    while (!done) {
-      ({ done, value } = await reader.read());
-      if (done) { return chunks; }
-      chunks.push(...value);
-    }
-    return chunks;
-}
+import { Constant } from "@clarity-types/data";
+
+const supported = Constant.CompressionStream in window;
+
+export default async function(input: string): Promise<Uint8Array> {
+    try {
+        if (supported) {
+            // Create a readable stream from given input string and
+            // pipe it through text encoder and compression stream to gzip it
+            const stream = new ReadableStream({async start(controller) {
+                controller.enqueue(input);
+                controller.close();
+            }}).pipeThrough(new TextEncoderStream()).pipeThrough(new window[Constant.CompressionStream]("gzip"));
+            return new Uint8Array(await read(stream));
+        }
+    } catch { /* do nothing */ }
+    return null;
+}
+
+async function read(stream: ReadableStream): Promise<number[]> {
+    const reader = stream.getReader();
+    const chunks:number[] = [];
+    let done = false;
+    let value: number[] = [];
+    while (!done) {
+      ({ done, value } = await reader.read());
+      if (done) { return chunks; }
+      chunks.push(...value);
+    }
+    return chunks;
+}

package/src/data/consent.ts

@@ -1,78 +1,78 @@
-import { ConsentData, ConsentSource, ConsentState, ConsentType, Constant, Dimension, Event, GCMConsent, GCMConsentState } from "@clarity-types/data";
-import * as dimension from "@src/data/dimension";
-import encode from "./encode";
-import { consentv2 } from "@src/data/metadata";
-import coreConfig from "@src/core/config";
-
-export let data: ConsentData = null;
-let updateConsent: boolean = true;
-
-export function start(): void {
-    const ics = window.google_tag_data?.ics;
-    updateConsent = true;
-    if (ics?.addListener) {
-        ics.addListener(
-            [Constant.AdStorage, Constant.AnalyticsStorage],
-            processConsent
-        );
-    }
-}
-
-export function stop(): void {
-    updateConsent = true;
-}
-
-function processConsent(): void {
-    const ics = window.google_tag_data?.ics;
-    if (!ics?.getConsentState) {
-        return;
-    }
-
-    const analytics_storage = ics.getConsentState(Constant.AnalyticsStorage);
-    const ad_storage = ics.getConsentState(Constant.AdStorage);
-    const consentState = getConsentState({ ad_Storage: ad_storage, analytics_Storage: analytics_storage });
-    consentv2(consentState, ConsentSource.GCM);
-}
-
-function getConsentState(googleConsent: GCMConsentState): ConsentState {
-    const consentState: ConsentState = {
-        ad_Storage: googleConsent.ad_Storage === GCMConsent.Granted ? Constant.Granted : Constant.Denied,
-        analytics_Storage: googleConsent.analytics_Storage === GCMConsent.Granted ? Constant.Granted : Constant.Denied,
-    };
-
-    return consentState;
-}
-
-
-export function config(consent: ConsentData): void {
-    trackConsent(consent.analytics_Storage ? ConsentType.Implicit : ConsentType.None);
-    data = consent;
-}
-
-// When we get consent signal as false, we restart the service and track config as false.
-export function consent(): void {
-    trackConsent(ConsentType.General);
-}
-
-function trackConsent(consent: ConsentType): void {
-    dimension.log(Dimension.Consent, consent.toString());
-}
-
-export function trackConsentv2(consent: ConsentData): void {
-    data = consent;
-    encode(Event.Consent);
-}
-
-// Compute function is called every upload, but we only want to send consent data once.
-export function compute(): void {
-    if (updateConsent) {
-        encode(Event.Consent);
-        updateConsent = false;
-        if (!coreConfig.track) {
-            const ics = window.google_tag_data?.ics;
-            if (ics?.usedUpdate) {
-                processConsent();
-            }
-        }
-    }
+import { ConsentData, ConsentSource, ConsentState, ConsentType, Constant, Dimension, Event, GCMConsent, GCMConsentState } from "@clarity-types/data";
+import * as dimension from "@src/data/dimension";
+import encode from "./encode";
+import { consentv2 } from "@src/data/metadata";
+import coreConfig from "@src/core/config";
+
+export let data: ConsentData = null;
+let updateConsent: boolean = true;
+
+export function start(): void {
+    const ics = window.google_tag_data?.ics;
+    updateConsent = true;
+    if (ics?.addListener) {
+        ics.addListener(
+            [Constant.AdStorage, Constant.AnalyticsStorage],
+            processConsent
+        );
+    }
+}
+
+export function stop(): void {
+    updateConsent = true;
+}
+
+function processConsent(): void {
+    const ics = window.google_tag_data?.ics;
+    if (!ics?.getConsentState) {
+        return;
+    }
+
+    const analytics_storage = ics.getConsentState(Constant.AnalyticsStorage);
+    const ad_storage = ics.getConsentState(Constant.AdStorage);
+    const consentState = getConsentState({ ad_Storage: ad_storage, analytics_Storage: analytics_storage });
+    consentv2(consentState, ConsentSource.GCM);
+}
+
+function getConsentState(googleConsent: GCMConsentState): ConsentState {
+    const consentState: ConsentState = {
+        ad_Storage: googleConsent.ad_Storage === GCMConsent.Granted ? Constant.Granted : Constant.Denied,
+        analytics_Storage: googleConsent.analytics_Storage === GCMConsent.Granted ? Constant.Granted : Constant.Denied,
+    };
+
+    return consentState;
+}
+
+
+export function config(consent: ConsentData): void {
+    trackConsent(consent.analytics_Storage ? ConsentType.Implicit : ConsentType.None);
+    data = consent;
+}
+
+// When we get consent signal as false, we restart the service and track config as false.
+export function consent(): void {
+    trackConsent(ConsentType.General);
+}
+
+function trackConsent(consent: ConsentType): void {
+    dimension.log(Dimension.Consent, consent.toString());
+}
+
+export function trackConsentv2(consent: ConsentData): void {
+    data = consent;
+    encode(Event.Consent);
+}
+
+// Compute function is called every upload, but we only want to send consent data once.
+export function compute(): void {
+    if (updateConsent) {
+        encode(Event.Consent);
+        updateConsent = false;
+        if (!coreConfig.track) {
+            const ics = window.google_tag_data?.ics;
+            if (ics?.usedUpdate) {
+                processConsent();
+            }
+        }
+    }
 }

package/src/data/cookie.ts

@@ -0,0 +1,90 @@
+import { Constant } from "@clarity-types/data";
+import config from "@src/core/config";
+import { decodeCookieValue, encodeCookieValue, supported } from "@src/data/util";
+
+let rootDomain = null;
+export const COOKIE_SEP = Constant.Caret;
+
+export function start() {
+  rootDomain = null;
+}
+
+export function stop() {
+  rootDomain = null;
+}
+
+export function getCookie(key: string, limit = false): string {
+  if (supported(document, Constant.Cookie)) {
+    let cookies: string[] = document.cookie.split(Constant.Semicolon);
+    if (cookies) {
+      for (let i = 0; i < cookies.length; i++) {
+        let pair: string[] = cookies[i].split(Constant.Equals);
+        if (pair.length > 1 && pair[0] && pair[0].trim() === key) {
+          // Some browsers automatically url encode cookie values if they are not url encoded.
+          // We therefore encode and decode cookie values ourselves.
+          // For backwards compatability we need to consider 3 cases:
+          // * Cookie was previously not encoded by Clarity and browser did not encode it
+          // * Cookie was previously not encoded by Clarity and browser encoded it once or more
+          // * Cookie was previously encoded by Clarity and browser did not encode it
+          let [isEncoded, decodedValue] = decodeCookieValue(pair[1]);
+
+          while (isEncoded) {
+            [isEncoded, decodedValue] = decodeCookieValue(decodedValue);
+          }
+
+          // If we are limiting cookies, check if the cookie value is limited
+          if (limit) {
+            return decodedValue.endsWith(`${Constant.Tilde}1`) ? decodedValue.substring(0, decodedValue.length - 2) : null;
+          }
+
+          return decodedValue;
+        }
+      }
+    }
+  }
+  return null;
+}
+
+export function setCookie(key: string, value: string, time: number): void {
+  // 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.track || value == Constant.Empty) && ((navigator && navigator.cookieEnabled) || supported(document, Constant.Cookie))) {
+    // Some browsers automatically url encode cookie values if they are not url encoded.
+    // We therefore encode and decode cookie values ourselves.
+    let encodedValue = encodeCookieValue(value);
+
+    let expiry = new Date();
+    expiry.setDate(expiry.getDate() + time);
+    let expires = expiry ? Constant.Expires + expiry.toUTCString() : Constant.Empty;
+    let cookie = `${key}=${encodedValue}${Constant.Semicolon}${expires}${Constant.Path}`;
+    try {
+      // Attempt to get the root domain only once and fall back to writing cookie on the current domain.
+      if (rootDomain === null) {
+        let hostname = location.hostname ? location.hostname.split(Constant.Dot) : [];
+        // Walk backwards on a domain and attempt to set a cookie, until successful
+        for (let i = hostname.length - 1; i >= 0; i--) {
+          rootDomain = `.${hostname[i]}${rootDomain ? rootDomain : Constant.Empty}`;
+          // We do not wish to attempt writing a cookie on the absolute last part of the domain, e.g. .com or .net.
+          // So we start attempting after second-last part, e.g. .domain.com (PASS) or .co.uk (FAIL)
+          if (i < hostname.length - 1) {
+            // Write the cookie on the current computed top level domain
+            document.cookie = `${cookie}${Constant.Semicolon}${Constant.Domain}${rootDomain}`;
+            // Once written, check if the cookie exists and its value matches exactly with what we intended to set
+            // Checking for exact value match helps us eliminate a corner case where the cookie may already be present with a different value
+            // If the check is successful, no more action is required and we can return from the function since rootDomain cookie is already set
+            // If the check fails, continue with the for loop until we can successfully set and verify the cookie
+            if (getCookie(key) === value) {
+              return;
+            }
+          }
+        }
+        // Finally, if we were not successful and gone through all the options, play it safe and reset rootDomain to be empty
+        // This forces our code to fall back to always writing cookie to the current domain
+        rootDomain = Constant.Empty;
+      }
+    } catch {
+      rootDomain = Constant.Empty;
+    }
+    document.cookie = rootDomain ? `${cookie}${Constant.Semicolon}${Constant.Domain}${rootDomain}` : cookie;
+  }
+}