@openreplay/tracker 3.6.0-beta.0 → 3.6.2

package/cjs/common/types.d.ts

@@ -0,0 +1,9 @@
+export interface Writer {
+    uint(n: number): boolean;
+    int(n: number): boolean;
+    string(s: string): boolean;
+    boolean(b: boolean): boolean;
+}
+export interface Message {
+    encode(w: Writer): boolean;
+}

package/cjs/common/{interaction.d.ts → webworker.d.ts}

@@ -1,19 +1,19 @@
-import Message from './messages.gen.js';
 export interface Options {
     connAttemptCount?: number;
     connAttemptGap?: number;
 }
 declare type Start = {
-    type: 'start';
+    type: "start";
     ingestPoint: string;
     pageNo: number;
     timestamp: number;
-    url: string;
 } & Options;
 declare type Auth = {
-    type: 'auth';
+    type: "auth";
     token: string;
     beaconSizeLimit?: number;
 };
-export declare type WorkerMessageData = null | 'stop' | Start | Auth | Array<Message>;
+export declare type WorkerMessageData = null | "stop" | Start | Auth | Array<{
+    _id: number;
+}>;
 export {};

package/cjs/common/webworker.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/index.d.ts

@@ -1,19 +1,19 @@
-import App from './app/index.js';
+import App from "./app/index.js";
 export { default as App } from './app/index.js';
-import * as _Messages from './app/messages.gen.js';
+import * as _Messages from "./common/messages.js";
 export declare const Messages: typeof _Messages;
-import type { Options as AppOptions } from './app/index.js';
-import type { Options as ConsoleOptions } from './modules/console.js';
-import type { Options as ExceptionOptions } from './modules/exception.js';
-import type { Options as InputOptions } from './modules/input.js';
-import type { Options as PerformanceOptions } from './modules/performance.js';
-import type { Options as TimingOptions } from './modules/timing.js';
+import type { Options as AppOptions } from "./app/index.js";
+import type { Options as ConsoleOptions } from "./modules/console.js";
+import type { Options as ExceptionOptions } from "./modules/exception.js";
+import type { Options as InputOptions } from "./modules/input.js";
+import type { Options as PerformanceOptions } from "./modules/performance.js";
+import type { Options as TimingOptions } from "./modules/timing.js";
 import type { StartOptions } from './app/index.js';
 import type { StartPromiseReturn } from './app/index.js';
 export declare type Options = Partial<AppOptions & ConsoleOptions & ExceptionOptions & InputOptions & PerformanceOptions & TimingOptions> & {
     projectID?: number;
     projectKey: string;
-    sessionHash?: string;
+    sessionToken?: string;
     respectDoNotTrack?: boolean;
     autoResetOnWindowOpen?: boolean;
     __DISABLE_SECURE_MODE?: boolean;
@@ -25,7 +25,7 @@ export default class API {
     use<T>(fn: (app: App | null, options?: Options) => T): T;
     isActive(): boolean;
     start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
-    stop(): string | null;
+    stop(): void;
     getSessionToken(): string | null | undefined;
     getSessionID(): string | null | undefined;
     sessionID(): string | null | undefined;

package/cjs/index.js

@@ -4,8 +4,8 @@ exports.Messages = exports.App = void 0;
 const index_js_1 = require("./app/index.js");
 var index_js_2 = require("./app/index.js");
 Object.defineProperty(exports, "App", { enumerable: true, get: function () { return index_js_2.default; } });
-const messages_gen_js_1 = require("./app/messages.gen.js");
-const _Messages = require("./app/messages.gen.js");
+const messages_js_1 = require("./common/messages.js");
+const _Messages = require("./common/messages.js");
 exports.Messages = _Messages;
 const connection_js_1 = require("./modules/connection.js");
 const console_js_1 = require("./modules/console.js");
@@ -18,7 +18,6 @@ const performance_js_1 = require("./modules/performance.js");
 const scroll_js_1 = require("./modules/scroll.js");
 const viewport_js_1 = require("./modules/viewport.js");
 const cssrules_js_1 = require("./modules/cssrules.js");
-const adoptedStyleSheets_js_1 = require("./modules/adoptedStyleSheets.js");
 const utils_js_1 = require("./utils.js");
 const DOCS_SETUP = '/installation/setup-or';
 function processOptions(obj) {
@@ -28,23 +27,22 @@ function processOptions(obj) {
     }
     if (typeof obj.projectKey !== 'string') {
         if (typeof obj.projectKey !== 'number') {
-            if (typeof obj.projectID !== 'number') {
-                // Back compatability
+            if (typeof obj.projectID !== 'number') { // Back compatability
                 console.error(`OpenReplay: projectKey is missing or wrong type (string is expected). Please, check ${utils_js_1.DOCS_HOST}${DOCS_SETUP} for more information.`);
                 return false;
             }
             else {
                 obj.projectKey = obj.projectID.toString();
-                (0, utils_js_1.deprecationWarn)('`projectID` option', '`projectKey` option', DOCS_SETUP);
+                (0, utils_js_1.deprecationWarn)("`projectID` option", "`projectKey` option", DOCS_SETUP);
             }
         }
         else {
-            console.warn('OpenReplay: projectKey is expected to have a string type.');
+            console.warn("OpenReplay: projectKey is expected to have a string type.");
             obj.projectKey = obj.projectKey.toString();
         }
     }
-    if (typeof obj.sessionHash !== 'string' && obj.sessionHash != null) {
-        console.warn(`OpenReplay: invalid 'sessionHash' option type. Please, check documentation on ${utils_js_1.DOCS_HOST}${DOCS_SETUP}`);
+    if (typeof obj.sessionToken !== 'string' && obj.sessionToken != null) {
+        console.warn(`OpenReplay: invalid options argument type. Please, check documentation on ${utils_js_1.DOCS_HOST}${DOCS_SETUP}`);
     }
     return true;
 }
@@ -71,33 +69,31 @@ class API {
             return;
         }
         if (window.__OPENREPLAY__) {
-            console.error('OpenReplay: one tracker instance has been initialised already');
+            console.error("OpenReplay: one tracker instance has been initialised already");
             return;
         }
         if (!options.__DISABLE_SECURE_MODE && location.protocol !== 'https:') {
-            console.error('OpenReplay: Your website must be publicly accessible and running on SSL in order for OpenReplay to properly capture and replay the user session. You can disable this check by setting `__DISABLE_SECURE_MODE` option to `true` if you are testing in localhost. Keep in mind, that asset files on a local machine are not available to the outside world. This might affect tracking if you use css files.');
+            console.error("OpenReplay: Your website must be publicly accessible and running on SSL in order for OpenReplay to properly capture and replay the user session. You can disable this check by setting `__DISABLE_SECURE_MODE` option to `true` if you are testing in localhost. Keep in mind, that asset files on a local machine are not available to the outside world. This might affect tracking if you use css files.");
             return;
         }
         const doNotTrack = options.respectDoNotTrack &&
-            (navigator.doNotTrack == '1' ||
+            (navigator.doNotTrack == '1'
                 // @ts-ignore
-                window.doNotTrack == '1');
-        const app = (this.app =
-            doNotTrack ||
-                !('Map' in window) ||
-                !('Set' in window) ||
-                !('MutationObserver' in window) ||
-                !('performance' in window) ||
-                !('timing' in performance) ||
-                !('startsWith' in String.prototype) ||
-                !('Blob' in window) ||
-                !('Worker' in window)
-                ? null
-                : new index_js_1.default(options.projectKey, options.sessionHash, options));
+                || window.doNotTrack == '1');
+        const app = this.app = doNotTrack ||
+            !('Map' in window) ||
+            !('Set' in window) ||
+            !('MutationObserver' in window) ||
+            !('performance' in window) ||
+            !('timing' in performance) ||
+            !('startsWith' in String.prototype) ||
+            !('Blob' in window) ||
+            !('Worker' in window)
+            ? null
+            : new index_js_1.default(options.projectKey, options.sessionToken, options);
         if (app !== null) {
             (0, viewport_js_1.default)(app);
             (0, cssrules_js_1.default)(app);
-            (0, adoptedStyleSheets_js_1.default)(app);
             (0, connection_js_1.default)(app);
             (0, console_js_1.default)(app, options);
             (0, exception_js_1.default)(app, options);
@@ -127,11 +123,11 @@ class API {
             console.log("OpenReplay: browser doesn't support API required for tracking or doNotTrack is set to 1.");
             const req = new XMLHttpRequest();
             const orig = options.ingestPoint || index_js_1.DEFAULT_INGEST_POINT;
-            req.open('POST', orig + '/v1/web/not-started');
+            req.open("POST", orig + "/v1/web/not-started");
             // no-cors issue only with text/plain or not-set Content-Type
             // req.setRequestHeader("Content-Type", "application/json;charset=UTF-8");
             req.send(JSON.stringify({
-                trackerVersion: '3.5.16',
+                trackerVersion: '3.6.2',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)
@@ -150,7 +146,7 @@ class API {
     start(startOpts) {
         if (!utils_js_1.IN_BROWSER) {
             console.error(`OpenReplay: you are trying to start Tracker on a node.js environment. If you want to use OpenReplay with SSR, please, use componentDidMount or useEffect API for placing the \`tracker.start()\` line. Check documentation on ${utils_js_1.DOCS_HOST}${DOCS_SETUP}`);
-            return Promise.reject('Trying to start not in browser.');
+            return Promise.reject("Trying to start not in browser.");
         }
         if (this.app === null) {
             return Promise.reject("Browser doesn't support required api, or doNotTrack is active.");
@@ -160,12 +156,9 @@ class API {
     }
     stop() {
         if (this.app === null) {
-            return null;
+            return;
         }
-        this.app.stop();
-        const sessionHash = this.app.session.getSessionHash();
-        this.app.session.reset();
-        return sessionHash;
+        this.app.stop(true);
     }
     getSessionToken() {
         if (this.app === null) {
@@ -180,7 +173,7 @@ class API {
         return this.app.getSessionID();
     }
     sessionID() {
-        (0, utils_js_1.deprecationWarn)("'sessionID' method", "'getSessionID' method", '/');
+        (0, utils_js_1.deprecationWarn)("'sessionID' method", "'getSessionID' method", "/");
         return this.getSessionID();
     }
     setUserID(id) {
@@ -189,25 +182,27 @@ class API {
         }
     }
     userID(id) {
-        (0, utils_js_1.deprecationWarn)("'userID' method", "'setUserID' method", '/');
+        (0, utils_js_1.deprecationWarn)("'userID' method", "'setUserID' method", "/");
         this.setUserID(id);
     }
     setUserAnonymousID(id) {
         if (typeof id === 'string' && this.app !== null) {
-            this.app.send((0, messages_gen_js_1.UserAnonymousID)(id));
+            this.app.send(new messages_js_1.UserAnonymousID(id));
         }
     }
     userAnonymousID(id) {
-        (0, utils_js_1.deprecationWarn)("'userAnonymousID' method", "'setUserAnonymousID' method", '/');
+        (0, utils_js_1.deprecationWarn)("'userAnonymousID' method", "'setUserAnonymousID' method", "/");
         this.setUserAnonymousID(id);
     }
     setMetadata(key, value) {
-        if (typeof key === 'string' && typeof value === 'string' && this.app !== null) {
+        if (typeof key === 'string' &&
+            typeof value === 'string' &&
+            this.app !== null) {
             this.app.session.setMetadata(key, value);
         }
     }
     metadata(key, value) {
-        (0, utils_js_1.deprecationWarn)("'metadata' method", "'setMetadata' method", '/');
+        (0, utils_js_1.deprecationWarn)("'metadata' method", "'setMetadata' method", "/");
         this.setMetadata(key, value);
     }
     event(key, payload, issue = false) {
@@ -222,7 +217,7 @@ class API {
                 catch (e) {
                     return;
                 }
-                this.app.send((0, messages_gen_js_1.RawCustomEvent)(key, payload));
+                this.app.send(new messages_js_1.RawCustomEvent(key, payload));
             }
         }
     }
@@ -234,7 +229,7 @@ class API {
             catch (e) {
                 return;
             }
-            this.app.send((0, messages_gen_js_1.CustomIssue)(key, payload));
+            this.app.send(new messages_js_1.CustomIssue(key, payload));
         }
     }
 }

package/cjs/modules/connection.d.ts

@@ -1,2 +1,2 @@
-import App from '../app/index.js';
+import App from "../app/index.js";
 export default function (app: App): void;

package/cjs/modules/connection.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const messages_gen_js_1 = require("../app/messages.gen.js");
+const messages_js_1 = require("../common/messages.js");
 function default_1(app) {
     const connection = navigator.connection ||
         navigator.mozConnection ||
@@ -8,7 +8,7 @@ function default_1(app) {
     if (connection === undefined) {
         return;
     }
-    const sendConnectionInformation = () => app.send((0, messages_gen_js_1.ConnectionInformation)(Math.round(connection.downlink * 1000), connection.type || 'unknown'));
+    const sendConnectionInformation = () => app.send(new messages_js_1.ConnectionInformation(Math.round(connection.downlink * 1000), connection.type || 'unknown'));
     sendConnectionInformation();
     connection.addEventListener('change', sendConnectionInformation);
 }

package/cjs/modules/console.d.ts

@@ -1,4 +1,4 @@
-import type App from '../app/index.js';
+import type App from "../app/index.js";
 export interface Options {
     consoleMethods: Array<string> | null;
     consoleThrottling: number;

package/cjs/modules/console.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const guards_js_1 = require("../app/guards.js");
 const utils_js_1 = require("../utils.js");
-const messages_gen_js_1 = require("../app/messages.gen.js");
+const messages_js_1 = require("../common/messages.js");
 const printError = utils_js_1.IN_BROWSER && 'InstallTrigger' in window // detect Firefox
     ? (e) => e.message + '\n' + e.stack
     : (e) => e.stack || e.message;
@@ -88,10 +89,11 @@ function default_1(app, opts) {
         consoleMethods,
         consoleThrottling: 30,
     }, opts);
-    if (!Array.isArray(options.consoleMethods) || options.consoleMethods.length === 0) {
+    if (!Array.isArray(options.consoleMethods) ||
+        options.consoleMethods.length === 0) {
         return;
     }
-    const sendConsoleLog = app.safe((level, args) => app.send((0, messages_gen_js_1.ConsoleLog)(level, printf(args))));
+    const sendConsoleLog = app.safe((level, args) => app.send(new messages_js_1.ConsoleLog(level, printf(args))));
     let n;
     const reset = () => {
         n = 0;
@@ -100,7 +102,7 @@ function default_1(app, opts) {
     app.ticker.attach(reset, 33, false);
     const patchConsole = (console) => options.consoleMethods.forEach((method) => {
         if (consoleMethods.indexOf(method) === -1) {
-            app.debug.error(`OpenReplay: unsupported console method "${method}"`);
+            console.error(`OpenReplay: unsupported console method "${method}"`);
             return;
         }
         const fn = console[method];
@@ -112,8 +114,20 @@ function default_1(app, opts) {
             sendConsoleLog(method, args);
         };
     });
-    const patchContext = app.safe((context) => patchConsole(context.console));
-    patchContext(window);
-    app.observer.attachContextCallback(patchContext);
+    patchConsole(window.console);
+    app.nodes.attachNodeCallback(app.safe(node => {
+        if ((0, guards_js_1.hasTag)(node, "IFRAME")) { // TODO: newContextCallback
+            let context = node.contentWindow;
+            if (context) {
+                patchConsole(context.console);
+            }
+            app.attachEventListener(node, "load", () => {
+                if (node.contentWindow !== context) {
+                    context = node.contentWindow;
+                    patchConsole(context.console);
+                }
+            });
+        }
+    }));
 }
 exports.default = default_1;

package/cjs/modules/cssrules.d.ts

@@ -1,2 +1,2 @@
-import type App from '../app/index.js';
+import type App from "../app/index.js";
 export default function (app: App | null): void;

package/cjs/modules/cssrules.js

@@ -1,43 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const messages_gen_js_1 = require("../app/messages.gen.js");
+const messages_js_1 = require("../common/messages.js");
 const guards_js_1 = require("../app/guards.js");
 function default_1(app) {
     if (app === null) {
         return;
     }
     if (!window.CSSStyleSheet) {
-        app.send((0, messages_gen_js_1.TechnicalInfo)('no_stylesheet_prototype_in_window', ''));
+        app.send(new messages_js_1.TechnicalInfo("no_stylesheet_prototype_in_window", ""));
         return;
     }
     const processOperation = app.safe((stylesheet, index, rule) => {
         const sendMessage = typeof rule === 'string'
-            ? (nodeID) => app.send((0, messages_gen_js_1.CSSInsertRuleURLBased)(nodeID, rule, index, app.getBaseHref()))
-            : (nodeID) => app.send((0, messages_gen_js_1.CSSDeleteRule)(nodeID, index));
+            ? (nodeID) => app.send(new messages_js_1.CSSInsertRuleURLBased(nodeID, rule, index, app.getBaseHref()))
+            : (nodeID) => app.send(new messages_js_1.CSSDeleteRule(nodeID, index));
         // TODO: Extend messages to maintain nested rules (CSSGroupingRule prototype, as well as CSSKeyframesRule)
         if (stylesheet.ownerNode == null) {
-            throw new Error('Owner Node not found');
+            throw new Error("Owner Node not found");
         }
         const nodeID = app.nodes.getID(stylesheet.ownerNode);
         if (nodeID !== undefined) {
             sendMessage(nodeID);
         } // else error?
     });
-    const patchContext = (context) => {
-        const { insertRule, deleteRule } = context.CSSStyleSheet.prototype;
-        context.CSSStyleSheet.prototype.insertRule = function (rule, index = 0) {
-            processOperation(this, index, rule);
-            return insertRule.call(this, rule, index);
-        };
-        context.CSSStyleSheet.prototype.deleteRule = function (index) {
-            processOperation(this, index);
-            return deleteRule.call(this, index);
-        };
+    const { insertRule, deleteRule } = CSSStyleSheet.prototype;
+    CSSStyleSheet.prototype.insertRule = function (rule, index = 0) {
+        processOperation(this, index, rule);
+        return insertRule.call(this, rule, index);
+    };
+    CSSStyleSheet.prototype.deleteRule = function (index) {
+        processOperation(this, index);
+        return deleteRule.call(this, index);
     };
-    patchContext(window);
-    app.observer.attachContextCallback(patchContext);
     app.nodes.attachNodeCallback((node) => {
-        if (!(0, guards_js_1.hasTag)(node, 'STYLE') || !node.sheet) {
+        if (!(0, guards_js_1.hasTag)(node, "STYLE") || !node.sheet) {
             return;
         }
         if (node.textContent !== null && node.textContent.trim().length > 0) {

package/cjs/modules/exception.d.ts

@@ -1,5 +1,5 @@
-import type App from '../app/index.js';
-import type Message from '../app/messages.gen.js';
+import type App from "../app/index.js";
+import type Message from "../common/messages.js";
 export interface Options {
     captureExceptions: boolean;
 }
@@ -11,6 +11,6 @@ interface StackFrame {
     source?: string;
 }
 export declare function getExceptionMessage(error: Error, fallbackStack: Array<StackFrame>): Message;
-export declare function getExceptionMessageFromEvent(e: ErrorEvent | PromiseRejectionEvent, context?: typeof globalThis): Message | null;
+export declare function getExceptionMessageFromEvent(e: ErrorEvent | PromiseRejectionEvent): Message | null;
 export default function (app: App, opts: Partial<Options>): void;
 export {};

package/cjs/modules/exception.js

@@ -1,29 +1,28 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getExceptionMessageFromEvent = exports.getExceptionMessage = void 0;
-const messages_gen_js_1 = require("../app/messages.gen.js");
+const messages_js_1 = require("../common/messages.js");
 const error_stack_parser_1 = require("error-stack-parser");
 function getDefaultStack(e) {
-    return [
-        {
+    return [{
             columnNumber: e.colno,
             lineNumber: e.lineno,
             fileName: e.filename,
-            functionName: '',
-            source: '',
-        },
-    ];
+            functionName: "",
+            source: "",
+        }];
 }
 function getExceptionMessage(error, fallbackStack) {
     let stack = fallbackStack;
     try {
         stack = error_stack_parser_1.default.parse(error);
     }
-    catch (e) { }
-    return (0, messages_gen_js_1.JSException)(error.name, error.message, JSON.stringify(stack));
+    catch (e) {
+    }
+    return new messages_js_1.JSException(error.name, error.message, JSON.stringify(stack));
 }
 exports.getExceptionMessage = getExceptionMessage;
-function getExceptionMessageFromEvent(e, context = window) {
+function getExceptionMessageFromEvent(e) {
     if (e instanceof ErrorEvent) {
         if (e.error instanceof Error) {
             return getExceptionMessage(e.error, getDefaultStack(e));
@@ -34,10 +33,10 @@ function getExceptionMessageFromEvent(e, context = window) {
                 name = 'Error';
                 message = e.message;
             }
-            return (0, messages_gen_js_1.JSException)(name, message, JSON.stringify(getDefaultStack(e)));
+            return new messages_js_1.JSException(name, message, JSON.stringify(getDefaultStack(e)));
         }
     }
-    else if ('PromiseRejectionEvent' in context && e instanceof context.PromiseRejectionEvent) {
+    else if ('PromiseRejectionEvent' in window && e instanceof PromiseRejectionEvent) {
         if (e.reason instanceof Error) {
             return getExceptionMessage(e.reason, []);
         }
@@ -49,7 +48,7 @@ function getExceptionMessageFromEvent(e, context = window) {
             catch (_) {
                 message = String(e.reason);
             }
-            return (0, messages_gen_js_1.JSException)('Unhandled Promise Rejection', message, '[]');
+            return new messages_js_1.JSException('Unhandled Promise Rejection', message, '[]');
         }
     }
     return null;
@@ -60,18 +59,14 @@ function default_1(app, opts) {
         captureExceptions: true,
     }, opts);
     if (options.captureExceptions) {
-        function patchContext(context) {
-            const handler = (e) => {
-                const msg = getExceptionMessageFromEvent(e, context);
-                if (msg != null) {
-                    app.send(msg);
-                }
-            };
-            app.attachEventListener(context, 'unhandledrejection', handler);
-            app.attachEventListener(context, 'error', handler);
-        }
-        app.observer.attachContextCallback(patchContext);
-        patchContext(window);
+        const handler = (e) => {
+            const msg = getExceptionMessageFromEvent(e);
+            if (msg != null) {
+                app.send(msg);
+            }
+        };
+        app.attachEventListener(window, 'unhandledrejection', (e) => handler(e));
+        app.attachEventListener(window, 'error', (e) => handler(e));
     }
 }
 exports.default = default_1;

package/cjs/modules/img.d.ts

@@ -1,2 +1,2 @@
-import type App from '../app/index.js';
+import type App from "../app/index.js";
 export default function (app: App): void;