clarity-js 0.8.1 → 0.8.3

package/src/data/baseline.ts

@@ -1,155 +1,155 @@
-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,
-          }
-        };
-    }
-    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,
-    };
-}
-
-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: string): void {
-    buffer.visible = visible === "visible" ? BooleanFlag.True : BooleanFlag.False;
-    if (!buffer.visible) {
-        activity(t);
-    }
-    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,
+          }
+        };
+    }
+    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,
+    };
+}
+
+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: string): void {
+    buffer.visible = visible === "visible" ? BooleanFlag.True : BooleanFlag.False;
+    if (!buffer.visible) {
+        activity(t);
+    }
+    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,21 +1,21 @@
-import { Dimension } from "@clarity-types/data";
-import * as dimension from "@src/data/dimension";
-
-const enum ConsentType {
-    None = 0,
-    Implicit = 1,
-    General = 2
-}
-
-export function config(track: boolean): void {
-    trackConsent(track ? ConsentType.Implicit : ConsentType.None);
-}
-
-// 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());
+import { Dimension } from "@clarity-types/data";
+import * as dimension from "@src/data/dimension";
+
+const enum ConsentType {
+    None = 0,
+    Implicit = 1,
+    General = 2
+}
+
+export function config(track: boolean): void {
+    trackConsent(track ? ConsentType.Implicit : ConsentType.None);
+}
+
+// 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());
 }

package/src/data/custom.ts

@@ -1,23 +1,23 @@
-import { Constant, CustomData, Event } from "@clarity-types/data";
-import * as core from "@src/core";
-import encode from "./encode";
-
-export let data: CustomData = null;
-
-// custom events allow 2 parameters or 1 parameter to be passed. If 2 are passed we
-// consider it a key value pair. If only 1 is passed we only consider the event to have a value.
-export function event(a: string, b: string): void {
-    if (core.active() &&
-        a &&
-        typeof a === Constant.String &&
-        a.length < 255
-        ) {
-            if (b && typeof b === Constant.String && b.length < 255) {
-                data = { key: a, value: b};
-            } else {
-                data = { value: a }
-            }
-            encode(Event.Custom);
-        
-    }
-}
+import { Constant, CustomData, Event } from "@clarity-types/data";
+import * as core from "@src/core";
+import encode from "./encode";
+
+export let data: CustomData = null;
+
+// custom events allow 2 parameters or 1 parameter to be passed. If 2 are passed we
+// consider it a key value pair. If only 1 is passed we only consider the event to have a value.
+export function event(a: string, b: string): void {
+    if (core.active() &&
+        a &&
+        typeof a === Constant.String &&
+        a.length < 255
+        ) {
+            if (b && typeof b === Constant.String && b.length < 255) {
+                data = { key: a, value: b};
+            } else {
+                data = { value: a }
+            }
+            encode(Event.Custom);
+        
+    }
+}

package/src/data/dimension.ts

@@ -1,53 +1,53 @@
-import { Check, Event, Dimension, DimensionData, Setting } from "@clarity-types/data";
-import * as limit from "@src/data/limit";
-import encode from "./encode";
-
-export let data: DimensionData = null;
-export let updates: DimensionData = null;
-let limited = false;
-
-export function start(): void {
-    data = {};
-    updates = {};
-    limited = false;
-}
-
-export function stop(): void {
-    data = {};
-    updates = {};
-    limited = false;
-}
-
-export function log(dimension: Dimension, value: string): void {
-    // Check valid value before moving ahead
-    if (value) {
-        // Ensure received value is casted into a string if it wasn't a string to begin with
-        value = `${value}`;
-        if (!(dimension in data)) { data[dimension] = []; }
-        if (data[dimension].indexOf(value) < 0) {
-            // Limit check to ensure we have a cap on number of dimensions we can collect
-            if (data[dimension].length > Setting.CollectionLimit) {
-                if (!limited) {
-                    limited = true;
-                    limit.trigger(Check.Collection); 
-                }
-                return;
-            }
-
-            data[dimension].push(value);
-            // If this is a new value, track it as part of updates object
-            // This allows us to only send back new values in subsequent payloads
-            if (!(dimension in updates)) { updates[dimension] = []; }
-            updates[dimension].push(value);
-        }
-    }
-}
-
-export function compute(): void {
-    encode(Event.Dimension);
-}
-
-export function reset(): void {
-    updates = {};
-    limited = false;
-}
+import { Check, Event, Dimension, DimensionData, Setting } from "@clarity-types/data";
+import * as limit from "@src/data/limit";
+import encode from "./encode";
+
+export let data: DimensionData = null;
+export let updates: DimensionData = null;
+let limited = false;
+
+export function start(): void {
+    data = {};
+    updates = {};
+    limited = false;
+}
+
+export function stop(): void {
+    data = {};
+    updates = {};
+    limited = false;
+}
+
+export function log(dimension: Dimension, value: string): void {
+    // Check valid value before moving ahead
+    if (value) {
+        // Ensure received value is casted into a string if it wasn't a string to begin with
+        value = `${value}`;
+        if (!(dimension in data)) { data[dimension] = []; }
+        if (data[dimension].indexOf(value) < 0) {
+            // Limit check to ensure we have a cap on number of dimensions we can collect
+            if (data[dimension].length > Setting.CollectionLimit) {
+                if (!limited) {
+                    limited = true;
+                    limit.trigger(Check.Collection); 
+                }
+                return;
+            }
+
+            data[dimension].push(value);
+            // If this is a new value, track it as part of updates object
+            // This allows us to only send back new values in subsequent payloads
+            if (!(dimension in updates)) { updates[dimension] = []; }
+            updates[dimension].push(value);
+        }
+    }
+}
+
+export function compute(): void {
+    encode(Event.Dimension);
+}
+
+export function reset(): void {
+    updates = {};
+    limited = false;
+}