clarity-js 0.8.15 → 0.8.16

package/src/data/metadata.ts

@@ -1,5 +1,5 @@
 import { Time } from "@clarity-types/core";
-import { BooleanFlag, Constant, Dimension, Metadata, MetadataCallback, MetadataCallbackOptions, Metric, Session, User, Setting } from "@clarity-types/data";
+import { BooleanFlag, Constant, Dimension, Metadata, MetadataCallback, MetadataCallbackOptions, Metric, Session, User, Setting, ConsentState, ConsentSource, ConsentData } from "@clarity-types/data";
 import * as clarity from "@src/clarity";
 import * as core from "@src/core";
 import config from "@src/core/config";
@@ -15,6 +15,8 @@ export let data: Metadata = null;
 export let callbacks: MetadataCallbackOptions[] = [];
 export let electron = BooleanFlag.False;
 let rootDomain = null;
+let consentStatus: ConsentState = null;
+let defaultStatus: ConsentState = {ad_Storage: Constant.Denied, analytics_Storage: Constant.Denied};
 
 export function start(): void {
   rootDomain = null;
@@ -84,8 +86,12 @@ export function start(): void {
   }
 
   // Track consent config
-  trackConsent.config(config.track);
-
+  consentStatus = {
+    ad_Storage: config.track ? Constant.Granted : Constant.Denied,
+    analytics_Storage: config.track ? Constant.Granted : Constant.Denied,
+  }      
+  const consent = getConsentData(consentStatus, ConsentSource.Implicit);
+  trackConsent.config(consent);      
   // Track ids using a cookie if configuration allows it
   track(u);
 }
@@ -106,10 +112,11 @@ function userAgentData(): void {
 export function stop(): void {
   rootDomain = null;
   data = null;
+  consentStatus = null;
   callbacks.forEach(cb => { cb.called = false; });
 }
 
-export function metadata(cb: MetadataCallback, wait: boolean = true, recall: boolean = false): void {
+export function metadata(cb: MetadataCallback, wait: boolean = true, recall: boolean = false, consentInfo: boolean = false): void {
   let upgraded = config.lean ? BooleanFlag.False : BooleanFlag.True;
   let called = false;
   // if caller hasn't specified that they want to skip waiting for upgrade but we've already upgraded, we need to
@@ -117,11 +124,11 @@ export function metadata(cb: MetadataCallback, wait: boolean = true, recall: boo
   // we go through the upgrading flow.
   if (data && (upgraded || wait === false)) {
     // Immediately invoke the callback if the caller explicitly doesn't want to wait for the upgrade confirmation
-    cb(data, !config.lean);
+    cb(data, !config.lean, consentInfo? consentStatus : undefined);
     called = true;
   }
   if (recall || !called) {
-    callbacks.push({ callback: cb, wait, recall, called });
+    callbacks.push({ callback: cb, wait, recall, called, consentInfo });
   }
 }
 
@@ -129,8 +136,27 @@ export function id(): string {
   return data ? [data.userId, data.sessionId, data.pageNum].join(Constant.Dot) : Constant.Empty;
 }
 
-export function consent(status: boolean = true): void {
+//TODO: Remove this function once consentv2 is fully released
+export function consent(status = true): void {
   if (!status) {
+    consentv2();
+    return;
+  }
+  
+  consentv2({ ad_Storage: Constant.Granted, analytics_Storage: Constant.Granted });
+  trackConsent.consent();
+}
+
+export function consentv2(consentState: ConsentState = defaultStatus, source: number = ConsentSource.API): void {
+  consentStatus = {
+    ad_Storage: normalizeConsent(consentState.ad_Storage),
+    analytics_Storage: normalizeConsent(consentState.analytics_Storage)
+  };
+
+  callback(true);
+  const consentData = getConsentData(consentStatus, source);
+  
+  if (!consentData.analytics_Storage) {
     config.track = false;
     setCookie(Constant.SessionKey, Constant.Empty, -Number.MAX_VALUE);
     setCookie(Constant.CookieKey, Constant.Empty, -Number.MAX_VALUE);
@@ -143,10 +169,25 @@ export function consent(status: boolean = true): void {
     config.track = true;
     track(user(), BooleanFlag.True);
     save();
+    trackConsent.consentv2(consentData);
     trackConsent.consent();
   }
 }
 
+function getConsentData(consentState: ConsentState, source : ConsentSource): ConsentData {
+  let consent: ConsentData = {
+    source: source,
+    ad_Storage: consentState.ad_Storage === Constant.Granted ? BooleanFlag.True : BooleanFlag.False,
+    analytics_Storage: consentState.analytics_Storage === Constant.Granted ? BooleanFlag.True : BooleanFlag.False,
+  };
+
+  return consent;
+}
+
+function normalizeConsent(value: unknown): string {
+  return typeof value === 'string' ? value.toLowerCase() : Constant.Denied;
+}
+
 export function clear(): void {
   // Clear any stored information in the cookie that tracks session information so we can restart fresh the next time
   setCookie(Constant.SessionKey, Constant.Empty, 0);
@@ -162,9 +203,9 @@ function tab(): string {
   return id;
 }
 
-export function callback(): void {
+export function callback(consentUpdate:boolean = false): void {
   let upgrade = config.lean ? BooleanFlag.False : BooleanFlag.True;
-  processCallback(upgrade);
+  processCallback(upgrade, consentUpdate);
 }
 
 export function save(): void {
@@ -175,12 +216,16 @@ export function save(): void {
   setCookie(Constant.SessionKey, [data.sessionId, ts, data.pageNum, upgrade, upload].join(Constant.Pipe), Setting.SessionExpire);
 }
 
-function processCallback(upgrade: BooleanFlag) {
+function processCallback(upgrade: BooleanFlag, consentUpdate: boolean = false): void {
   if (callbacks.length > 0) {
     for (let i = 0; i < callbacks.length; i++) {
       const cb = callbacks[i];
-      if (cb.callback && !cb.called && (!cb.wait || upgrade)) {
-        cb.callback(data, !config.lean);
+      if (
+        cb.callback && 
+        ((!cb.called && !consentUpdate) || (cb.consentInfo && consentUpdate)) && //If consentUpdate is true, we only call the callback if it has consentInfo
+        (!cb.wait || upgrade)       
+      ) {
+        cb.callback(data, !config.lean, cb.consentInfo ? consentStatus : undefined);
         cb.called = true;
         if (!cb.recall) {
           callbacks.splice(i, 1);

package/src/data/upload.ts

@@ -134,6 +134,10 @@ async function upload(final: boolean = false): Promise<void> {
     // could inject function arguments for internal tracking (likely stack traces for script errors).
     // For these edge cases, we want to ensure that an injected object (e.g. {"key": "value"}) isn't mistaken to be true.
     let last = final === true;
+    
+    // In some cases envelope has null data because it's part of the shutdown process while there's one upload call queued which might introduce runtime error
+    if(!envelope.data) return;
+
     let e = JSON.stringify(envelope.envelope(last));
     let a = `[${analysis.join()}]`;
 

package/src/interaction/scroll.ts

@@ -33,6 +33,10 @@ function recompute(event: UIEvent = null): void {
     let de = document.documentElement;
     let element = event ? target(event) : de;
 
+    // In some edge cases, it's possible for target to be null.
+    // In those cases, we cannot proceed with scroll event instrumentation.
+    if (!element) { return; }
+
     // If the target is a Document node, then identify corresponding documentElement and window for this document
     if (element && element.nodeType === Node.DOCUMENT_NODE) {
         let frame = iframe(element);

package/src/layout/style.ts

@@ -1,4 +1,4 @@
-import { Event, Metric } from "@clarity-types/data";
+import { Event } from "@clarity-types/data";
 import { StyleSheetOperation, StyleSheetState } from "@clarity-types/layout";
 import { time } from "@src/core/time";
 import { shortid } from "@src/data/metadata";

package/src/performance/observer.ts

@@ -99,10 +99,17 @@ export function stop(): void {
     if (observer) { observer.disconnect(); }
     observer = null;
     interaction.resetInteractions();
+    anchorCache = null;
 }
 
+// Cached anchor element for optimal performance & memory management
+let anchorCache: HTMLAnchorElement | null = null;
+
 function host(url: string): string {
-    let a = document.createElement("a");
-    a.href = url;
-    return a.host;
+    if (!anchorCache) {
+        anchorCache = document.createElement("a");
+    }
+
+    anchorCache.href = url;
+    return anchorCache.host;
 }

package/types/data.d.ts

@@ -3,12 +3,13 @@ export type Target = (number | Node);
 export type Token = (string | number | number[] | string[] | (string | number)[]);
 export type DecodedToken = (any | any[]);
 
-export type MetadataCallback = (data: Metadata, playback: boolean) => void;
+export type MetadataCallback = (data: Metadata, playback: boolean, consentStatus?: ConsentState) => void;
 export interface MetadataCallbackOptions {
     callback: MetadataCallback,
     wait: boolean,
     recall: boolean,
-    called: boolean
+    called: boolean,
+    consentInfo: boolean
 }
 export type SignalCallback = (data: ClaritySignal) => void
 
@@ -71,6 +72,7 @@ export const enum Event {
     Animation = 44,
     StyleSheetAdoption = 45,
     StyleSheetUpdate = 46,
+    Consent = 47,
 
     // Apps specific events
     WebViewDiscover = 100,
@@ -347,6 +349,8 @@ export const enum Constant {
     SHA256 = "SHA-256",
     Electron = "Electron",
     Caret = "^",
+    Granted = "granted",
+    Denied = "denied",
 }
 
 export const enum XMLReadyState {
@@ -357,6 +361,10 @@ export const enum XMLReadyState {
     Done = 4
 }
 
+export const enum ConsentSource{
+    Implicit = 0,
+    API = 1
+}
 
 /* Helper Interfaces */
 
@@ -514,4 +522,15 @@ export interface PerformanceEventTiming extends PerformanceEntry {
 export interface Interaction {
     id: number;
     latency: number;
-}
+}
+
+export interface ConsentState {
+    ad_Storage?: string;
+    analytics_Storage?: string;
+}
+
+export interface ConsentData {
+    source: ConsentSource;
+    ad_Storage: BooleanFlag;
+    analytics_Storage: BooleanFlag;
+}

package/types/index.d.ts

@@ -12,6 +12,7 @@ interface Clarity {
   resume: () => void;
   upgrade: (key: string) => void;
   consent: () => void;
+  consentv2: () => void;
   event: (name: string, value: string) => void;
   set: (variable: string, value: string | string[]) => void;
   identify: (userId: string, sessionId?: string, pageId?: string, userHint?: string) => void;