@openreplay/tracker 14.0.10-beta.1 → 14.0.10

package/{lib → dist/lib/main}/app/index.d.ts

@@ -1,10 +1,10 @@
-import type { Options as WebworkerOptions } from '../common/interaction.js';
+import type { Options as WebworkerOptions } from '../../common/interaction.js';
 import AttributeSender from '../modules/attributeSender.js';
 import FeatureFlags from '../modules/featureFlags.js';
 import type { Options as NetworkOptions } from '../modules/network.js';
 import Logger, { ILogLevel } from './logger.js';
 import Message from './messages.gen.js';
-import Nodes from './nodes.js';
+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';
@@ -12,12 +12,19 @@ import Sanitizer from './sanitizer.js';
 import type { Options as SessOptions } from './session.js';
 import Session from './session.js';
 import Ticker from './ticker.js';
+import { MaintainerOptions } from './nodes/maintainer.js';
 export interface StartOptions {
     userID?: string;
     metadata?: Record<string, string>;
     forceNew?: boolean;
     sessionHash?: string;
     assistOnly?: boolean;
+    /**
+     * @deprecated We strongly advise to use .start().then instead.
+     *
+     * This method is kept for snippet compatibility only
+     * */
+    startCallback?: (result: StartPromiseReturn) => void;
 }
 interface OnStartInfo {
     sessionID: string;
@@ -100,6 +107,23 @@ type AppOptions = {
         parentDomain?: string;
     };
     network?: NetworkOptions;
+    /**
+     * use this flag to force angular detection to be offline
+     *
+     * basically goes around window.Zone api changes to mutation observer
+     * and event listeners
+     * */
+    forceNgOff?: boolean;
+    /**
+     * This option is used to change how tracker handles potentially detached nodes
+     *
+     * defaults here are tested and proven to be lightweight and easy on cpu
+     *
+     * consult the docs before changing it
+     * */
+    nodes?: {
+        maintainer: Partial<MaintainerOptions>;
+    };
 } & WebworkerOptions & SessOptions;
 export type Options = AppOptions & ObserverOptions & SanitizerOptions;
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
@@ -146,16 +170,24 @@ export default class App {
     private rootId;
     private pageFrames;
     private frameOderNumber;
-    private readonly initialHostName;
     private features;
     constructor(projectKey: string, sessionToken: string | undefined, options: Partial<Options>, signalError: (error: string, apis: string[]) => void, insideIframe: boolean);
     /** used by child iframes for crossdomain only */
     parentActive: boolean;
     checkStatus: () => boolean;
     parentCrossDomainFrameListener: (event: MessageEvent) => void;
-    trackedFrames: number[];
+    /**
+     * context ids for iframes,
+     * order is not so important as long as its consistent
+     * */
+    trackedFrames: string[];
     crossDomainIframeListener: (event: MessageEvent) => void;
-    pollingQueue: string[];
+    /**
+     * { command : [remaining iframes] }
+     * + order of commands
+     **/
+    pollingQueue: Record<string, any>;
+    private readonly addCommand;
     bootChildrenFrames: () => Promise<void>;
     killChildrenFrames: () => void;
     signalIframeTracker: () => void;
@@ -200,7 +232,7 @@ export default class App {
         metadata: Record<string, string>;
         userID: string | null;
         timestamp: number;
-        projectID?: string | undefined;
+        projectID?: string;
     };
     getSessionToken(): string | undefined;
     getSessionID(): string | undefined;

package/{cjs → dist/lib/main}/app/messages.gen.d.ts

@@ -1,5 +1,5 @@
-import * as Messages from '../common/messages.gen.js';
-export { default, Type } from '../common/messages.gen.js';
+import * as Messages from '../../common/messages.gen.js';
+export { default, Type } from '../../common/messages.gen.js';
 export declare function Timestamp(timestamp: number): Messages.Timestamp;
 export declare function SetPageLocationDeprecated(url: string, referrer: string, navigationStart: number): Messages.SetPageLocationDeprecated;
 export declare function SetViewportSize(width: number, height: number): Messages.SetViewportSize;

package/{cjs/app/nodes.d.ts → dist/lib/main/app/nodes/index.d.ts}

@@ -1,22 +1,30 @@
+import { MaintainerOptions } from './maintainer.js';
 type NodeCallback = (node: Node, isStart: boolean) => void;
+export interface NodesOptions {
+    node_id: string;
+    forceNgOff: boolean;
+    maintainer?: Partial<MaintainerOptions>;
+}
 export default class Nodes {
-    private readonly node_id;
-    private nodes;
+    private readonly nodes;
     private totalNodeAmount;
     private readonly nodeCallbacks;
     private readonly elementListeners;
     private nextNodeId;
-    constructor(node_id: string);
+    private readonly node_id;
+    private readonly forceNgOff;
+    private readonly maintainer;
+    constructor(params: NodesOptions);
     syntheticMode(frameOrder: number): void;
-    attachNodeCallback(nodeCallback: NodeCallback): void;
+    attachNodeCallback(nodeCallback: NodeCallback): number;
     scanTree: (cb: (node: Node | void) => void) => void;
-    attachNodeListener(node: Node, type: string, listener: EventListener, useCapture?: boolean): void;
+    attachNodeListener: (node: Node, type: string, listener: EventListener, useCapture?: boolean) => void;
     registerNode(node: Node): [/*id:*/ number, /*isNew:*/ boolean];
-    unregisterNode(node: Node): number | undefined;
+    unregisterNode: (node: Node) => number | undefined;
     cleanTree(): void;
     callNodeCallbacks(node: Node, isStart: boolean): void;
     getID(node: Node): number | undefined;
-    getNode(id: number): void | Node;
+    getNode(id: number): void | Node | undefined;
     getNodeCount(): number;
     clear(): void;
 }

package/dist/lib/main/app/nodes/maintainer.d.ts

@@ -0,0 +1,28 @@
+export interface MaintainerOptions {
+    /**
+     * Run cleanup each X ms
+     *
+     * @default 30 * 1000
+     * */
+    interval: number;
+    /**
+     * Maintainer checks nodes in small batches over 50ms timeouts
+     *
+     * @default 2500
+     * */
+    batchSize: number;
+    /**
+     * @default true
+     * */
+    enabled: boolean;
+}
+declare class Maintainer {
+    private readonly nodes;
+    private readonly unregisterNode;
+    private interval;
+    private readonly options;
+    constructor(nodes: Map<number, Node | void>, unregisterNode: (node: Node) => void, options?: Partial<MaintainerOptions>);
+    start: () => void;
+    stop: () => void;
+}
+export default Maintainer;

package/{lib → dist/lib/main}/app/observer/iframe_observer.d.ts

@@ -1,5 +1,5 @@
 import Observer from './observer.js';
 export default class IFrameObserver extends Observer {
     observe(iframe: HTMLIFrameElement): void;
-    syntheticObserve(selfId: number, doc: Document): void;
+    syntheticObserve(rootNodeId: number, doc: Document): void;
 }

package/{cjs → dist/lib/main}/app/observer/iframe_offsets.d.ts

@@ -1,6 +1,6 @@
 export type Offset = [/*left:*/ number, /*top: */ number];
 export default class IFrameOffsets {
-    private readonly states;
+    private states;
     private calcOffset;
     getDocumentOffset(doc: Document): Offset;
     observe(iFrame: HTMLIFrameElement): void;

package/{cjs → dist/lib/main}/app/observer/observer.d.ts

@@ -10,6 +10,12 @@ export default abstract class Observer {
     private readonly textSet;
     constructor(app: App, isTopContext?: boolean);
     private clear;
+    /**
+     * EXPERIMENTAL: Unbinds the removed nodes in case of iframe src change.
+     *
+     * right now, we're relying on nodes.maintainer
+     */
+    private handleIframeSrcChange;
     private sendNodeAttribute;
     private sendNodeData;
     private bindNode;

package/{cjs → dist/lib/main}/app/observer/top_observer.d.ts

@@ -9,7 +9,11 @@ type ContextCallback = (context: Context) => void;
 export default class TopObserver extends Observer {
     private readonly options;
     private readonly iframeOffsets;
-    constructor(app: App, options: Partial<Options>);
+    readonly app: App;
+    constructor(params: {
+        app: App;
+        options: Partial<Options>;
+    });
     private readonly contextCallbacks;
     private readonly contextsSet;
     attachContextCallback(cb: ContextCallback): void;
@@ -19,7 +23,7 @@ export default class TopObserver extends Observer {
     private shadowRootObservers;
     private handleShadowRoot;
     observe(): void;
-    crossdomainObserve(selfId: number, frameOder: number): void;
+    crossdomainObserve(rootNodeId: number, frameOder: number): void;
     disconnect(): void;
 }
 export {};

package/{lib → dist/lib/main}/app/sanitizer.d.ts

@@ -11,11 +11,14 @@ export interface Options {
 }
 export declare const stringWiper: (input: string) => string;
 export default class Sanitizer {
-    private readonly app;
     private readonly obscured;
     private readonly hidden;
     private readonly options;
-    constructor(app: App, options: Partial<Options>);
+    private readonly app;
+    constructor(params: {
+        app: App;
+        options?: Partial<Options>;
+    });
     handleNode(id: number, parentID: number, node: Node): void;
     sanitize(id: number, data: string): string;
     isObscured(id: number): boolean;

package/{lib → dist/lib/main}/app/session.d.ts

@@ -21,8 +21,6 @@ export type Options = {
     session_tabid_key: string;
 };
 export default class Session {
-    private readonly app;
-    private readonly options;
     private metadata;
     private userID;
     private sessionID;
@@ -32,7 +30,12 @@ export default class Session {
     private tabId;
     userInfo: UserInfo;
     private token;
-    constructor(app: App, options: Options);
+    private readonly app;
+    private readonly options;
+    constructor(params: {
+        app: App;
+        options: Options;
+    });
     attachUpdateCallback(cb: OnUpdateCallback): void;
     private handleUpdate;
     assign(newInfo: Partial<SessionInfo>): void;

package/{cjs → dist/lib/main}/index.d.ts

@@ -77,8 +77,8 @@ export default class API {
      * */
     startOfflineRecording(startOpts: Partial<StartOptions>, onSessionSent: () => void): Promise<never> | {
         saveBuffer: () => void;
-        getBuffer: () => import("./common/messages.gen.js").default[];
-        setBuffer: (buffer: import("./common/messages.gen.js").default[]) => void;
+        getBuffer: () => _Messages.default[];
+        setBuffer: (buffer: _Messages.default[]) => void;
     };
     /**
      * Uploads the stored session buffer to backend

package/{cjs → dist/lib/main}/modules/attributeSender.d.ts

@@ -5,10 +5,13 @@ export declare class StringDictionary {
     getKey(str: string): [number, boolean];
 }
 export default class AttributeSender {
+    private dict;
     private readonly app;
     private readonly isDictDisabled;
-    private dict;
-    constructor(app: App, isDictDisabled: boolean);
+    constructor(options: {
+        app: App;
+        isDictDisabled: boolean;
+    });
     sendSetAttribute(id: number, name: string, value: string): void;
     private applyDict;
     clear(): void;

package/{lib → dist/lib/main}/modules/conditionsManager.d.ts

@@ -1,4 +1,4 @@
-import Message, { CustomEvent, JSException, MouseClick, NetworkRequest, SetPageLocation } from '../common/messages.gen.js';
+import Message, { CustomEvent, JSException, MouseClick, NetworkRequest, SetPageLocation } from '../../common/messages.gen.js';
 import App, { StartOptions } from '../app/index.js';
 import { IFeatureFlag } from './featureFlags.js';
 interface Filter {

package/{lib → dist/lib/main}/modules/tagWatcher.d.ts

@@ -1,15 +1,19 @@
 export declare const WATCHED_TAGS_KEY = "__or__watched_tags__";
 declare class TagWatcher {
-    private readonly sessionStorage;
-    private readonly errLog;
-    private readonly onTag;
     intervals: Record<string, ReturnType<typeof setInterval>>;
     tags: {
         id: number;
         selector: string;
     }[];
     observer: IntersectionObserver;
-    constructor(sessionStorage: Storage, errLog: (args: any[]) => void, onTag: (tag: number) => void);
+    private readonly sessionStorage;
+    private readonly errLog;
+    private readonly onTag;
+    constructor(params: {
+        sessionStorage: Storage;
+        errLog: (args: any[]) => void;
+        onTag: (tag: number) => void;
+    });
     fetchTags(ingest: string, token: string): Promise<void>;
     setTags(tags: {
         id: number;

package/{cjs → dist/lib/main}/modules/userTesting/SignalManager.d.ts

@@ -24,6 +24,6 @@ export default class SignalManager {
             started: number;
         }[];
     }) => void;
-    signalTask: (taskId: number, status: 'begin' | 'done' | 'skipped', taskAnswer?: string) => void | Promise<Response>;
-    signalTest: (status: 'begin' | 'done' | 'skipped') => Promise<Response>;
+    signalTask: (taskId: number, status: "begin" | "done" | "skipped", taskAnswer?: string) => void | Promise<Response>;
+    signalTest: (status: "begin" | "done" | "skipped") => Promise<Response>;
 }

package/{cjs → dist/lib/main}/utils.d.ts

@@ -15,6 +15,7 @@ export declare function hasOpenreplayAttribute(e: Element, attr: string): boolea
  * checks if iframe is accessible
  **/
 export declare function canAccessIframe(iframe: HTMLIFrameElement): boolean;
+export declare function canAccessTarget(target: EventTarget): boolean;
 export declare function generateRandomId(len?: number): string;
 export declare function inIframe(): boolean | null;
 /**
@@ -22,8 +23,8 @@ export declare function inIframe(): boolean | null;
  * we need to use this to achieve safe behavior
  * */
 export declare function ngSafeBrowserMethod(method: string): string;
-export declare function createMutationObserver(cb: MutationCallback): MutationObserver;
-export declare function createEventListener(target: EventTarget, event: string, cb: EventListenerOrEventListenerObject, capture?: boolean): void;
-export declare function deleteEventListener(target: EventTarget, event: string, cb: EventListenerOrEventListenerObject, capture?: boolean): void;
+export declare function createMutationObserver(cb: MutationCallback, forceNgOff?: boolean): MutationObserver;
+export declare function createEventListener(target: EventTarget, event: string, cb: EventListenerOrEventListenerObject, capture?: boolean, forceNgOff?: boolean): void;
+export declare function deleteEventListener(target: EventTarget, event: string, cb: EventListenerOrEventListenerObject, capture?: boolean, forceNgOff?: boolean): void;
 export declare function requestIdleCb(callback: () => void): void;
 export declare function simpleMerge<T>(defaultObj: T, givenObj: Partial<T>): T;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "14.0.10-beta.1",
+  "version": "14.0.10",
   "keywords": [
     "logging",
     "replay"
@@ -13,14 +13,29 @@
   ],
   "license": "MIT",
   "type": "module",
-  "main": "./lib/index.js",
+  "exports": {
+    ".": {
+      "require": "./dist/cjs/index.js",
+      "import": "./dist/lib/index.js",
+      "types": "./dist/lib/main/index.d.ts"
+    },
+    "./cjs": {
+      "require": "./dist/cjs/index.js",
+      "types": "./dist/cjs/main/index.d.ts"
+    }
+  },
+  "files": [
+    "dist/lib/**/*",
+    "dist/cjs/**/*"
+  ],
+  "main": "./dist/cjs/index.js",
+  "module": "./dist/lib/index.js",
+  "types": "./dist/lib/main/index.d.ts",
   "scripts": {
     "lint": "eslint src --ext .ts,.js --fix --quiet",
     "clean": "rm -Rf build && rm -Rf lib && rm -Rf cjs",
-    "tscRun": "tsc -b src/main && tsc -b src/webworker && tsc --project src/main/tsconfig-cjs.json",
-    "rollup": "rollup --config rollup.config.js",
-    "compile": "node --experimental-modules --experimental-json-modules scripts/compile.cjs",
-    "build": "bun run clean && bun run tscRun && bun run rollup && bun run compile",
+    "build:common": "tsc -b src/common",
+    "build": "yarn run clean && yarn build:common && rollup --config rollup.config.js",
     "lint-front": "lint-staged",
     "test": "jest --coverage=false",
     "test:ci": "jest --coverage=true",
@@ -32,9 +47,12 @@
     "@jest/globals": "^29.3.1",
     "@rollup/plugin-babel": "^6.0.4",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^6.0.1",
+    "@rollup/plugin-terser": "0.4.4",
+    "@rollup/plugin-typescript": "^12.1.1",
     "@typescript-eslint/eslint-plugin": "^5.30.0",
     "@typescript-eslint/parser": "^5.30.0",
-    "eslint": "^7.8.0",
+    "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-prettier": "^5.0.1",
     "jest": "^29.3.1",
@@ -43,15 +61,15 @@
     "prettier": "^3.0.3",
     "replace-in-files": "^2.0.3",
     "rollup": "^4.1.4",
-    "rollup-plugin-terser": "^7.0.2",
     "semver": "^6.3.0",
     "ts-jest": "^29.0.3",
-    "typescript": "^4.9.4"
+    "typescript": "^5.6.3"
   },
   "dependencies": {
     "@medv/finder": "^3.2.0",
     "@openreplay/network-proxy": "^1.0.3",
     "error-stack-parser": "^2.0.6",
+    "error-stack-parser-es": "^0.1.5",
     "fflate": "^0.8.2"
   },
   "engines": {
@@ -64,5 +82,6 @@
     "*.{json,md,html,js,jsx,ts,tsx}": [
       "prettier --write"
     ]
-  }
+  },
+  "packageManager": "yarn@4.5.0"
 }

package/.eslintignore

@@ -1,11 +0,0 @@
-node_modules
-npm-debug.log
-lib
-cjs
-build
-.cache
-.eslintrc.cjs
-*.gen.ts
-
-**/*.test.ts
-src/main/plugin.ts

package/.nvmrc

@@ -1 +0,0 @@
-18

package/.prettierignore

@@ -1 +0,0 @@
-*.gen.ts