clarity-js 0.8.49 → 0.8.50-beta

package/src/interaction/index.ts

@@ -11,6 +11,7 @@ import * as timeline from "@src/interaction/timeline";
 import * as unload from "@src/interaction/unload";
 import * as visibility from "@src/interaction/visibility";
 import * as focus from "@src/interaction/focus";
+import * as pageshow from "@src/interaction/pageshow";
 
 export function start(): void {
     timeline.start();
@@ -21,6 +22,7 @@ export function start(): void {
     resize.start();
     visibility.start();
     focus.start();
+    pageshow.start();
     scroll.start();
     selection.start();
     change.start();
@@ -37,6 +39,7 @@ export function stop(): void {
     resize.stop();
     visibility.stop();
     focus.stop();
+    pageshow.stop();
     scroll.stop();
     selection.stop();
     change.stop();

package/src/interaction/pageshow.ts

@@ -0,0 +1,35 @@
+import { Constant } from "@clarity-types/core";
+import { Code, Severity } from "@clarity-types/data";
+import * as clarity from "@src/clarity";
+import api from "@src/core/api";
+import measure from "@src/core/measure";
+import * as internal from "@src/diagnostic/internal";
+
+let bound = false;
+
+export function start(): void {
+    // Only bind once - this listener must persist even when Clarity stops
+    // to detect when the page is restored from bfcache
+    if (!bound) {
+        try {
+            window[api(Constant.AddEventListener)]("pageshow", measure(handler) as EventListener, { capture: false, passive: true });
+            bound = true;
+        } catch {
+            /* do nothing */
+        }
+    }
+}
+
+function handler(evt: PageTransitionEvent): void {
+    // The persisted property indicates if the page was loaded from bfcache
+    if (evt && evt.persisted) {
+        // Restart Clarity since it was stopped when the page entered bfcache
+        clarity.start();
+        internal.log(Code.BFCache, Severity.Info);
+    }
+}
+
+export function stop(): void {
+    // Intentionally don't remove the listener or reset 'bound' flag
+    // We need the listener to persist to detect bfcache restoration
+}

package/types/data.d.ts

@@ -212,6 +212,7 @@ export const enum Code {
     Config = 8,
     FunctionExecutionTime = 9,
     LeanLimit = 10,
+    BFCache = 11,
 }
 
 export const enum Severity {

package/types/interaction.d.ts

@@ -11,6 +11,14 @@ export const enum BrowsingContext {
     Top = 3
 }
 
+export const enum ClickSource {
+    Undefined = 0,
+    FirstParty = 1,
+    ThirdParty = 2,
+    Eval = 3,
+    Unknown = 4
+}
+
 export const enum Setting {
     LookAhead = 500, // 500ms
     InputLookAhead = 1000, // 1s
@@ -131,6 +139,7 @@ export interface ClickData {
     tag: string;
     class: string;
     id: string;
+    source: ClickSource;
 }
 
 export interface TextInfo {