@openreplay/tracker 3.4.17-beta.1 → 3.5.2

package/cjs/index.js

@@ -81,7 +81,7 @@ class API {
             (navigator.doNotTrack == '1'
                 // @ts-ignore
                 || window.doNotTrack == '1');
-        this.app = doNotTrack ||
+        const app = this.app = doNotTrack ||
             !('Map' in window) ||
             !('Set' in window) ||
             !('MutationObserver' in window) ||
@@ -92,20 +92,34 @@ class API {
             !('Worker' in window)
             ? null
             : new index_js_1.default(options.projectKey, options.sessionToken, options);
-        if (this.app !== null) {
-            (0, viewport_js_1.default)(this.app);
-            (0, cssrules_js_1.default)(this.app);
-            (0, connection_js_1.default)(this.app);
-            (0, console_js_1.default)(this.app, options);
-            (0, exception_js_1.default)(this.app, options);
-            (0, img_js_1.default)(this.app);
-            (0, input_js_1.default)(this.app, options);
-            (0, mouse_js_1.default)(this.app);
-            (0, timing_js_1.default)(this.app, options);
-            (0, performance_js_1.default)(this.app, options);
-            (0, scroll_js_1.default)(this.app);
-            (0, longtasks_js_1.default)(this.app);
+        if (app !== null) {
+            (0, viewport_js_1.default)(app);
+            (0, cssrules_js_1.default)(app);
+            (0, connection_js_1.default)(app);
+            (0, console_js_1.default)(app, options);
+            (0, exception_js_1.default)(app, options);
+            (0, img_js_1.default)(app);
+            (0, input_js_1.default)(app, options);
+            (0, mouse_js_1.default)(app);
+            (0, timing_js_1.default)(app, options);
+            (0, performance_js_1.default)(app, options);
+            (0, scroll_js_1.default)(app);
+            (0, longtasks_js_1.default)(app);
             window.__OPENREPLAY__ = this;
+            if (options.autoResetOnWindowOpen) {
+                const wOpen = window.open;
+                app.attachStartCallback(() => {
+                    // @ts-ignore ?
+                    window.open = function (...args) {
+                        app.resetNextPageSession(true);
+                        wOpen.call(window, ...args);
+                        app.resetNextPageSession(false);
+                    };
+                });
+                app.attachStopCallback(() => {
+                    window.open = wOpen;
+                });
+            }
         }
         else {
             console.log("OpenReplay: browser doesn't support API required for tracking or doNotTrack is set to 1.");
@@ -115,7 +129,7 @@ class API {
             // 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.4.17-beta.1',
+                trackerVersion: '3.5.2',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)
@@ -131,11 +145,7 @@ class API {
         }
         return this.app.active();
     }
-    active() {
-        (0, utils_js_1.deprecationWarn)("'active' method", "'isActive' method", "/");
-        return this.isActive();
-    }
-    start() {
+    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.");
@@ -143,7 +153,8 @@ class API {
         if (this.app === null) {
             return Promise.reject("Browser doesn't support required api, or doNotTrack is active.");
         }
-        return this.app.start();
+        // TODO: check argument typing
+        return this.app.start(startOpts);
     }
     stop() {
         if (this.app === null) {
@@ -223,11 +234,5 @@ class API {
             this.app.send(new index_js_3.CustomIssue(key, payload));
         }
     }
-    resetNextPageSession(flag) {
-        if (typeof flag !== 'boolean' || !this.app) {
-            return;
-        }
-        this.app.resetNextPageSession(flag);
-    }
 }
 exports.default = API;

package/cjs/modules/console.js

@@ -18,7 +18,7 @@ function printString(arg) {
     if (Array.isArray(arg)) {
         return `Array(${arg.length})`;
     }
-    return arg.toString();
+    return String(arg);
 }
 function printFloat(arg) {
     if (typeof arg !== 'number')

package/cjs/modules/mouse.js

@@ -57,6 +57,7 @@ function _getTarget(target) {
         if (tag === 'BUTTON' ||
             tag === 'A' ||
             tag === 'LI' ||
+            tag === 'SELECT' ||
             element.onclick != null ||
             element.getAttribute('role') === 'button' ||
             (0, utils_js_1.getLabelAttribute)(element) !== null) {
@@ -83,6 +84,7 @@ function default_1(app) {
         if (tag === 'BUTTON' ||
             tag === 'A' ||
             tag === 'LI' ||
+            tag === 'SELECT' ||
             target.onclick != null ||
             target.getAttribute('role') === 'button') {
             const label = app.sanitizer.getInnerTextSecure(target);

package/cjs/utils.d.ts

@@ -3,14 +3,6 @@ export declare const stars: (str: string) => string;
 export declare function normSpaces(str: string): string;
 export declare function isURL(s: string): boolean;
 export declare const IN_BROWSER: boolean;
-export declare const log: {
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-};
-export declare const warn: {
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-};
 export declare const DOCS_HOST = "https://docs.openreplay.com";
 export declare function deprecationWarn(nameOfFeature: string, useInstead: string, docsPath?: string): void;
 export declare function getLabelAttribute(e: Element): string | null;

package/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.warn = exports.log = exports.IN_BROWSER = exports.isURL = exports.normSpaces = exports.stars = exports.timestamp = void 0;
+exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.IN_BROWSER = exports.isURL = exports.normSpaces = exports.stars = exports.timestamp = void 0;
 function timestamp() {
     return Math.round(performance.now()) + performance.timing.navigationStart;
 }
@@ -18,15 +18,14 @@ function isURL(s) {
 }
 exports.isURL = isURL;
 exports.IN_BROWSER = !(typeof window === "undefined");
-exports.log = console.log;
-exports.warn = console.warn;
+// TODO: JOIN IT WITH LOGGER somehow (use logging decorators?); Don't forget about index.js loggin when there is no logger instance.
 exports.DOCS_HOST = 'https://docs.openreplay.com';
 const warnedFeatures = {};
 function deprecationWarn(nameOfFeature, useInstead, docsPath = "/") {
     if (warnedFeatures[nameOfFeature]) {
         return;
     }
-    (0, exports.warn)(`OpenReplay: ${nameOfFeature} is deprecated. ${useInstead ? `Please, use ${useInstead} instead.` : ""} Visit ${exports.DOCS_HOST}${docsPath} for more information.`);
+    console.warn(`OpenReplay: ${nameOfFeature} is deprecated. ${useInstead ? `Please, use ${useInstead} instead.` : ""} Visit ${exports.DOCS_HOST}${docsPath} for more information.`);
     warnedFeatures[nameOfFeature] = true;
 }
 exports.deprecationWarn = deprecationWarn;

package/lib/app/index.d.ts

@@ -2,14 +2,21 @@ import Message from "../messages/message.js";
 import Nodes from "./nodes.js";
 import Sanitizer from "./sanitizer.js";
 import Ticker from "./ticker.js";
+import Logger from "./logger.js";
 import type { Options as ObserverOptions } from "./observer/top_observer.js";
 import type { Options as SanitizerOptions } from "./sanitizer.js";
+import type { Options as LoggerOptions } from "./logger.js";
 import type { Options as WebworkerOptions } from "../messages/webworker.js";
 export interface OnStartInfo {
     sessionID: string;
     sessionToken: string;
     userUUID: string;
 }
+export interface StartOptions {
+    userID?: string;
+    metadata?: Record<string, string>;
+    forceNew: boolean;
+}
 declare type AppOptions = {
     revID: string;
     node_id: string;
@@ -19,20 +26,24 @@ declare type AppOptions = {
     local_uuid_key: string;
     ingestPoint: string;
     resourceBaseHref: string | null;
+    verbose: boolean;
     __is_snippet: boolean;
     __debug_report_edp: string | null;
-    __debug_log: boolean;
+    __debug__?: LoggerOptions;
     onStart?: (info: OnStartInfo) => void;
 } & WebworkerOptions;
 export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
 declare type Callback = () => void;
 declare type CommitCallback = (messages: Array<Message>) => void;
+export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     readonly nodes: Nodes;
     readonly ticker: Ticker;
     readonly projectKey: string;
     readonly sanitizer: Sanitizer;
+    readonly debug: Logger;
+    readonly notify: Logger;
     private readonly messages;
     private readonly observer;
     private readonly startCallbacks;
@@ -41,19 +52,34 @@ export default class App {
     private readonly options;
     private readonly revID;
     private _sessionID;
-    private isActive;
+    private _userID;
+    private _metadata;
+    private activityState;
     private version;
     private readonly worker?;
     constructor(projectKey: string, sessionToken: string | null | undefined, options: Partial<Options>);
     private _debug;
+    private readonly preStartMessages;
     send(message: Message, urgent?: boolean): void;
     private commit;
     attachCommitCallback(cb: CommitCallback): void;
-    addCommitCallback(cb: CommitCallback): void;
     safe<T extends (...args: any[]) => void>(fn: T): T;
     attachStartCallback(cb: Callback): void;
     attachStopCallback(cb: Callback): void;
     attachEventListener(target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean): void;
+    checkRequiredVersion(version: string): boolean;
+    private getStartInfo;
+    getSessionInfo(): {
+        userUUID: string | null;
+        projectKey: string;
+        revID: string;
+        timestamp: number;
+        trackerVersion: string;
+        userID: string | null;
+        isSnippet: boolean;
+        sessionID: string | null;
+        metadata: Record<string, string>;
+    };
     getSessionToken(): string | undefined;
     getSessionID(): string | undefined;
     getHost(): string;
@@ -64,7 +90,7 @@ export default class App {
     active(): boolean;
     resetNextPageSession(flag: boolean): void;
     private _start;
-    start(reset?: boolean): Promise<OnStartInfo>;
+    start(options?: StartOptions): Promise<OnStartInfo>;
     stop(): void;
 }
 export {};