@openreplay/tracker 18.0.14-beta.1 → 18.0.14

package/dist/lib/main/app/canvas.d.ts

@@ -24,6 +24,12 @@ declare class CanvasRecorder {
     private isProcessingQueue;
     constructor(app: App, options: Options);
     startTracking(): void;
+    /**
+     * Reacts to a runtime sanitization change on a canvas: stop capturing if it
+     * just became masked, start if it just became visible. (Already-sent frames
+     * can't be retracted — escalation only stops future capture.)
+     */
+    resanitizeCanvas: (node: Node, id: number) => void;
     restartTracking: () => void;
     captureCanvas: (node: Node) => void;
     recordCanvas: (node: Node, id: number) => void;

package/dist/lib/main/app/index.d.ts

@@ -8,7 +8,7 @@ import Nodes from './nodes/index.js';
 import type { Options as ObserverOptions } from './observer/top_observer.js';
 import Observer from './observer/top_observer.js';
 import type { Options as SanitizerOptions } from './sanitizer.js';
-import Sanitizer from './sanitizer.js';
+import Sanitizer, { SanitizeLevel } from './sanitizer.js';
 import type { Options as SessOptions } from './session.js';
 import Session from './session.js';
 import Ticker from './ticker.js';
@@ -130,6 +130,7 @@ export default class App {
     readonly ticker: Ticker;
     readonly projectKey: string;
     readonly sanitizer: Sanitizer;
+    private readonly resanitizeCallbacks;
     readonly debug: Logger;
     readonly notify: Logger;
     readonly session: Session;
@@ -354,6 +355,10 @@ export default class App {
     private userStartCallback?;
     private _start;
     restartCanvasTracking: () => void;
+    attachResanitizeCallback: (cb: (node: Node, id: number) => void) => void;
+    callResanitizeCallbacks: (node: Node, id: number) => void;
+    resanitize: (el?: Element) => void;
+    checkSanitization: (el: Node) => SanitizeLevel | undefined;
     flushBuffer: (buffer: Message[]) => Promise<unknown>;
     waitStart(): Promise<unknown>;
     waitStarted(): Promise<unknown>;

package/dist/lib/main/app/observer/observer.d.ts

@@ -53,6 +53,16 @@ export default abstract class Observer {
     private commitNode;
     private commitNodes;
     protected observeRoot(node: Node, beforeCommit: (id?: number) => unknown, nodeToBind?: Node): void;
+    /**
+     * Re-evaluates sanitization for every tracked node in `root`'s subtree against
+     * the current DOM and re-emits whatever changed. Pass the highest node you
+     * changed (or the document root) so inherited levels propagate correctly.
+     */
+    resanitizeSubtree(root: Node): void;
+    private resanitizeNode;
+    private recreateSubtree;
+    private clearSubtreeRegistration;
+    private reemitNode;
     disconnect(): void;
     protected resetThrottledSetNodeData(): void;
 }

package/dist/lib/main/app/sanitizer.d.ts

@@ -35,8 +35,7 @@ export interface Options {
 }
 export declare const stringWiper: (input: string) => string;
 export default class Sanitizer {
-    private readonly obscured;
-    private readonly hidden;
+    private readonly levels;
     private readonly options;
     readonly privateMode: boolean;
     private readonly app;
@@ -44,7 +43,10 @@ export default class Sanitizer {
         app: App;
         options?: Partial<Options>;
     });
-    handleNode(id: number, parentID: number, node: Node): Set<number> | undefined;
+    computeLevel(node: Node, parentLevel: SanitizeLevel): SanitizeLevel;
+    getLevel(id: number): SanitizeLevel;
+    setLevel(id: number, level: SanitizeLevel): SanitizeLevel;
+    handleNode(id: number, parentID: number, node: Node): void;
     sanitize(id: number, data: string): string;
     isObscured(id: number): boolean;
     isHidden(id: number): boolean;

package/dist/lib/main/index.d.ts

@@ -47,6 +47,21 @@ export default class API {
     checkDoNotTrack: () => boolean | undefined;
     signalStartIssue: (reason: string, missingApi: string[]) => void;
     restartCanvasTracking: () => void;
+    /**
+     * Re-evaluates sanitization against the current DOM and re-emits whatever
+     * changed, updating already-recorded nodes mid-session. Call after toggling
+     * `data-openreplay-*` attributes or after changing whatever your `domSanitizer`
+     * keys on (class/id/etc).
+     *
+     * @param el - the highest node you changed; omit to re-scan the whole document;
+     * scanning the entire doc is O(dom size)
+     * */
+    resanitize: (el?: Element) => void;
+    /**
+     * Returns the sanitization level the tracker currently has for a node
+     * (0 = Plain, 1 = Obscured, 2 = Hidden), or undefined if it isn't tracked.
+     * */
+    checkSanitization: (el: Node) => import("./app/sanitizer.js").SanitizeLevel | undefined;
     use<T>(fn: (app: App | null, options?: Partial<Options>) => T): T;
     isActive(): boolean;
     /**
@@ -103,9 +118,9 @@ export default class API {
     }) => string | undefined;
     setUserID: (id: string) => void;
     identify: (id: string) => void;
-    track: ((eventName: string, properties?: Record<string, any>, options?: {
+    track: (eventName: string, properties?: Record<string, any>, options?: {
         send_immediately: boolean;
-    }) => void) | undefined;
+    }) => void | undefined;
     userID: (id: string) => void;
     setUserAnonymousID(id: string): void;
     userAnonymousID(id: string): void;

package/dist/lib/main/singleton.d.ts

@@ -16,7 +16,7 @@ declare class TrackerSingleton {
      * (which can be used to stitch sessions together)
      * */
     stop(): string | undefined;
-    setUserID(id: string): void;
+    setUserID: (id: string) => void;
     get analytics(): import("./entry.js").Analytics | null;
     identify: (id: string) => void;
     track: (eventName: string, properties?: Record<string, any>, options?: {
@@ -101,6 +101,30 @@ declare class TrackerSingleton {
     forceFlushBatch(): void;
     getSessionInfo(): import("./app/session.js").SessionInfo | null;
     getTabId(): string | null;
+    /**
+     * Re-evaluates sanitization against the current DOM and re-emits whatever
+     * changed, updating already-recorded nodes mid-session. Call after toggling
+     * `data-openreplay-*` attributes or after changing whatever your `domSanitizer`
+     * keys on (class/id/etc).
+     *
+     * @param el - the highest node you changed; omit to re-scan the whole document.
+     * */
+    resanitize(el?: Element): void;
+    /**
+     * Returns the sanitization level the tracker currently has for a node
+     * (0 = Plain, 1 = Obscured, 2 = Hidden), or undefined if it isn't tracked.
+     * */
+    checkSanitization(el: Node): import("./index.js").SanitizeLevel | undefined;
+    incident(options: {
+        label?: string;
+        startTime: number;
+        endTime?: number;
+    }): void;
+    /**
+     * Use custom token for analytics events without session recording
+     * */
+    setAnalyticsToken(token: string): void;
+    getAnalyticsToken(): string | undefined;
 }
 declare const tracker: TrackerSingleton;
 export default tracker;

package/dist/types/common/interaction.d.ts

@@ -1,5 +1,5 @@
 import Message from './messages.gen.js';
-export type DataType = 'player' | 'assets' | 'devtools' | 'analytics' | 'visual';
+export type DataType = 'player' | 'assets' | 'devtools' | 'analytics';
 export interface Options {
     connAttemptCount?: number;
     connAttemptGap?: number;
@@ -23,12 +23,10 @@ export type ToWorkerData = null | 'stop' | Start | Auth | Array<Message> | {
     type: 'compressed';
     batch: Uint8Array;
     dataType: DataType;
-    split?: number;
 } | {
     type: 'uncompressed';
     batch: Uint8Array;
     dataType: DataType;
-    split?: number;
 } | 'forceFlushBatch' | 'closing' | 'check_queue';
 type Failure = {
     type: 'failure';
@@ -46,6 +44,5 @@ export type FromWorkerData = 'a_stop' | 'a_start' | Failure | 'not_init' | {
     type: 'compress';
     batch: Uint8Array;
     dataType: DataType;
-    split?: number;
 } | QEmpty | LocalSave;
 export {};

package/dist/types/main/app/canvas.d.ts

@@ -24,6 +24,12 @@ declare class CanvasRecorder {
     private isProcessingQueue;
     constructor(app: App, options: Options);
     startTracking(): void;
+    /**
+     * Reacts to a runtime sanitization change on a canvas: stop capturing if it
+     * just became masked, start if it just became visible. (Already-sent frames
+     * can't be retracted — escalation only stops future capture.)
+     */
+    resanitizeCanvas: (node: Node, id: number) => void;
     restartTracking: () => void;
     captureCanvas: (node: Node) => void;
     recordCanvas: (node: Node, id: number) => void;

package/dist/types/main/app/index.d.ts

@@ -8,7 +8,7 @@ import Nodes from './nodes/index.js';
 import type { Options as ObserverOptions } from './observer/top_observer.js';
 import Observer from './observer/top_observer.js';
 import type { Options as SanitizerOptions } from './sanitizer.js';
-import Sanitizer from './sanitizer.js';
+import Sanitizer, { SanitizeLevel } from './sanitizer.js';
 import type { Options as SessOptions } from './session.js';
 import Session from './session.js';
 import Ticker from './ticker.js';
@@ -130,6 +130,7 @@ export default class App {
     readonly ticker: Ticker;
     readonly projectKey: string;
     readonly sanitizer: Sanitizer;
+    private readonly resanitizeCallbacks;
     readonly debug: Logger;
     readonly notify: Logger;
     readonly session: Session;
@@ -354,6 +355,10 @@ export default class App {
     private userStartCallback?;
     private _start;
     restartCanvasTracking: () => void;
+    attachResanitizeCallback: (cb: (node: Node, id: number) => void) => void;
+    callResanitizeCallbacks: (node: Node, id: number) => void;
+    resanitize: (el?: Element) => void;
+    checkSanitization: (el: Node) => SanitizeLevel | undefined;
     flushBuffer: (buffer: Message[]) => Promise<unknown>;
     waitStart(): Promise<unknown>;
     waitStarted(): Promise<unknown>;

package/dist/types/main/app/observer/observer.d.ts

@@ -53,6 +53,16 @@ export default abstract class Observer {
     private commitNode;
     private commitNodes;
     protected observeRoot(node: Node, beforeCommit: (id?: number) => unknown, nodeToBind?: Node): void;
+    /**
+     * Re-evaluates sanitization for every tracked node in `root`'s subtree against
+     * the current DOM and re-emits whatever changed. Pass the highest node you
+     * changed (or the document root) so inherited levels propagate correctly.
+     */
+    resanitizeSubtree(root: Node): void;
+    private resanitizeNode;
+    private recreateSubtree;
+    private clearSubtreeRegistration;
+    private reemitNode;
     disconnect(): void;
     protected resetThrottledSetNodeData(): void;
 }

package/dist/types/main/app/sanitizer.d.ts

@@ -35,8 +35,7 @@ export interface Options {
 }
 export declare const stringWiper: (input: string) => string;
 export default class Sanitizer {
-    private readonly obscured;
-    private readonly hidden;
+    private readonly levels;
     private readonly options;
     readonly privateMode: boolean;
     private readonly app;
@@ -44,7 +43,10 @@ export default class Sanitizer {
         app: App;
         options?: Partial<Options>;
     });
-    handleNode(id: number, parentID: number, node: Node): Set<number> | undefined;
+    computeLevel(node: Node, parentLevel: SanitizeLevel): SanitizeLevel;
+    getLevel(id: number): SanitizeLevel;
+    setLevel(id: number, level: SanitizeLevel): SanitizeLevel;
+    handleNode(id: number, parentID: number, node: Node): void;
     sanitize(id: number, data: string): string;
     isObscured(id: number): boolean;
     isHidden(id: number): boolean;

package/dist/types/main/index.d.ts

@@ -47,6 +47,21 @@ export default class API {
     checkDoNotTrack: () => boolean | undefined;
     signalStartIssue: (reason: string, missingApi: string[]) => void;
     restartCanvasTracking: () => void;
+    /**
+     * Re-evaluates sanitization against the current DOM and re-emits whatever
+     * changed, updating already-recorded nodes mid-session. Call after toggling
+     * `data-openreplay-*` attributes or after changing whatever your `domSanitizer`
+     * keys on (class/id/etc).
+     *
+     * @param el - the highest node you changed; omit to re-scan the whole document;
+     * scanning the entire doc is O(dom size)
+     * */
+    resanitize: (el?: Element) => void;
+    /**
+     * Returns the sanitization level the tracker currently has for a node
+     * (0 = Plain, 1 = Obscured, 2 = Hidden), or undefined if it isn't tracked.
+     * */
+    checkSanitization: (el: Node) => import("./app/sanitizer.js").SanitizeLevel | undefined;
     use<T>(fn: (app: App | null, options?: Partial<Options>) => T): T;
     isActive(): boolean;
     /**
@@ -103,9 +118,9 @@ export default class API {
     }) => string | undefined;
     setUserID: (id: string) => void;
     identify: (id: string) => void;
-    track: ((eventName: string, properties?: Record<string, any>, options?: {
+    track: (eventName: string, properties?: Record<string, any>, options?: {
         send_immediately: boolean;
-    }) => void) | undefined;
+    }) => void | undefined;
     userID: (id: string) => void;
     setUserAnonymousID(id: string): void;
     userAnonymousID(id: string): void;

package/dist/types/main/singleton.d.ts

@@ -16,7 +16,7 @@ declare class TrackerSingleton {
      * (which can be used to stitch sessions together)
      * */
     stop(): string | undefined;
-    setUserID(id: string): void;
+    setUserID: (id: string) => void;
     get analytics(): import("./entry.js").Analytics | null;
     identify: (id: string) => void;
     track: (eventName: string, properties?: Record<string, any>, options?: {
@@ -101,6 +101,30 @@ declare class TrackerSingleton {
     forceFlushBatch(): void;
     getSessionInfo(): import("./app/session.js").SessionInfo | null;
     getTabId(): string | null;
+    /**
+     * Re-evaluates sanitization against the current DOM and re-emits whatever
+     * changed, updating already-recorded nodes mid-session. Call after toggling
+     * `data-openreplay-*` attributes or after changing whatever your `domSanitizer`
+     * keys on (class/id/etc).
+     *
+     * @param el - the highest node you changed; omit to re-scan the whole document.
+     * */
+    resanitize(el?: Element): void;
+    /**
+     * Returns the sanitization level the tracker currently has for a node
+     * (0 = Plain, 1 = Obscured, 2 = Hidden), or undefined if it isn't tracked.
+     * */
+    checkSanitization(el: Node): import("./index.js").SanitizeLevel | undefined;
+    incident(options: {
+        label?: string;
+        startTime: number;
+        endTime?: number;
+    }): void;
+    /**
+     * Use custom token for analytics events without session recording
+     * */
+    setAnalyticsToken(token: string): void;
+    getAnalyticsToken(): string | undefined;
 }
 declare const tracker: TrackerSingleton;
 export default tracker;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "18.0.14-beta.1",
+  "version": "18.0.14",
   "keywords": [
     "logging",
     "replay"