clarity-js 0.6.26 → 0.6.30

package/types/data.d.ts

@@ -39,14 +39,22 @@ export const enum Event {
     Input = 27,
     Visibility = 28,
     Navigation = 29,
+/**
+ * @deprecated No longer support Network Connection
+ */
     Connection = 30,
     ScriptError = 31,
+/**
+ * @deprecated No longer support Image Error
+ */
     ImageError = 32,
     Log = 33,
     Variable = 34,
     Limit = 35,
     Summary = 36,
     Box = 37,
+    Clipboard = 38,
+    Submit = 39
 }
 
 export const enum Metric {
@@ -74,7 +82,10 @@ export const enum Metric {
     CartShipping = 21,
     CartDiscount = 22,
     CartTax = 23,
-    CartTotal = 24
+    CartTotal = 24,
+    EventCount = 25,
+    Automation = 26,
+    Mobile = 27
 }
 
 export const enum Dimension {
@@ -99,8 +110,11 @@ export const enum Dimension {
     Headline = 18,
     MetaType = 19,
     MetaTitle = 20,
-    Generator = 21
-    
+    Generator = 21,
+    Platform = 22,
+    PlatformVersion = 23,
+    Brand = 24,
+    Model = 25
 }
 
 export const enum Check {
@@ -160,6 +174,7 @@ export const enum Setting {
     BoxPrecision = 100, // Up to 2 decimal points (e.g. 34.56)
     ResizeObserverThreshold = 15, // At least 15 characters before we attach a resize observer for the node
     ScriptErrorLimit = 5, // Do not send the same script error more than 5 times per page
+    DimensionLimit = 256, // Do not extract dimensions which are over 256 characters
     WordLength = 5, // Estimated average size of a word,
     RestartDelay = 250, // Wait for 250ms before starting to wire up again
     CallStackDepth = 20, // Maximum call stack depth before bailing out
@@ -228,7 +243,8 @@ export const enum Constant {
     HTTPS = "https://",
     CompressionStream = "CompressionStream",
     Accept = "Accept",
-    ClarityGzip = "application/x-clarity-gzip"
+    ClarityGzip = "application/x-clarity-gzip",
+    Tilde = "~",
 }
 
 export const enum XMLReadyState {

package/types/diagnostic.d.ts

@@ -9,12 +9,6 @@ export interface ScriptErrorData {
     stack: string;
 }
 
-export interface ImageErrorData {
-    source: string;
-    target: Target;
-    region?: number;
-}
-
 export interface LogData {
     code: Code;
     name: string;

package/types/index.d.ts

@@ -15,7 +15,7 @@ interface Clarity {
   event: (name: string, value: string) => void;
   set: (variable: string, value: string | string[]) => void;
   identify: (userId: string, sessionId?: string, pageId?: string) => void;
-  metadata: (callback: Data.MetadataCallback) => void;
+  metadata: (callback: Data.MetadataCallback, wait?: boolean) => void;
 }
 
 interface Helper {

package/types/interaction.d.ts

@@ -17,6 +17,12 @@ export const enum Setting {
     TimelineSpan = 2 * Time.Second, // 2 seconds
 }
 
+export const enum Clipboard {
+    Cut = 0,
+    Copy = 1,
+    Paste = 2
+}
+
 /* Helper Interfaces */
 export interface PointerState {
     time: number;
@@ -30,12 +36,24 @@ export interface ClickState {
     data: ClickData;
 }
 
+export interface ClipboardState {
+    time: number;
+    event: number;
+    data: ClipboardData;
+}
+
 export interface ScrollState {
     time: number;
     event: number;
     data: ScrollData;
 }
 
+export interface SubmitState {
+    time: number;
+    event: number;
+    data: SubmitData;
+}
+
 export interface InputState {
     time: number;
     event: number;
@@ -63,6 +81,10 @@ export interface InputData {
     value: string;
 }
 
+export interface SubmitData {
+    target: Target;
+}
+
 export interface PointerData {
     target: Target;
     x: number;
@@ -83,6 +105,11 @@ export interface ClickData {
     hash: string;
 }
 
+export interface ClipboardData {
+    target: Target;
+    action: Clipboard;
+}
+
 export interface ResizeData {
     width: number;
     height: number;

package/src/diagnostic/image.ts

@@ -1,23 +0,0 @@
-import { Event } from "@clarity-types/data";
-import { ImageErrorData } from "@clarity-types/diagnostic";
-import { bind } from "@src/core/event";
-import { schedule } from "@src/core/task";
-import encode from "./encode";
-
-export let data: ImageErrorData;
-
-export function start(): void {
-    bind(document, "error", handler, true);
-}
-
-function handler(error: ErrorEvent): void {
-    let element = error.target as HTMLElement;
-    if (element && element.tagName === "IMG") {
-        data = { source: (element as HTMLImageElement).src, target: element };
-        schedule(encode.bind(this, Event.ImageError));
-    }
-}
-
-export function stop(): void {
-    data = null;
-}

package/src/performance/connection.ts

@@ -1,37 +0,0 @@
-import { BooleanFlag, Event } from "@clarity-types/data";
-import { ConnectionData, NavigatorConnection } from "@clarity-types/performance";
-import encode from "./encode";
-
-// Reference: https://wicg.github.io/netinfo/
-export let data: ConnectionData;
-
-export function start(): void {
-    // Check if the client supports Navigator.Connection: https://developer.mozilla.org/en-US/docs/Web/API/Navigator/connection
-    // This is an experimental API so we go a bit deeper in our check and ensure that values returned are valid
-    if (navigator &&
-        "connection" in navigator &&
-        "downlink" in navigator["connection"] &&
-        typeof navigator["connection"]["downlink"] === "number") {
-        (navigator["connection"] as NavigatorConnection).addEventListener("change", recompute);
-        recompute();
-    }
-}
-
-function recompute(): void {
-    let connection = navigator["connection"] as NavigatorConnection;
-    data = {
-        downlink: connection.downlink,
-        rtt: connection.rtt,
-        saveData: connection.saveData ? BooleanFlag.True : BooleanFlag.False,
-        type: connection.effectiveType
-    };
-    encode(Event.Connection);
-}
-
-export function reset(): void {
-    data = null;
-}
-
-export function stop(): void {
-    reset();
-}