@openreplay/tracker 3.6.3 → 3.6.6

package/lib/common/webworker.d.ts

@@ -3,17 +3,17 @@ export interface Options {
     connAttemptGap?: number;
 }
 declare type Start = {
-    type: "start";
+    type: 'start';
     ingestPoint: string;
     pageNo: number;
     timestamp: number;
 } & Options;
 declare type Auth = {
-    type: "auth";
+    type: 'auth';
     token: string;
     beaconSizeLimit?: number;
 };
-export declare type WorkerMessageData = null | "stop" | Start | Auth | Array<{
+export declare type WorkerMessageData = null | 'stop' | Start | Auth | Array<{
     _id: number;
 }>;
 export {};

package/lib/index.d.ts

@@ -1,13 +1,13 @@
-import App from "./app/index.js";
+import App from './app/index.js';
 export { default as App } from './app/index.js';
-import * as _Messages from "./common/messages.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> & {
@@ -29,6 +29,7 @@ export default class API {
     getSessionToken(): string | null | undefined;
     getSessionID(): string | null | undefined;
     sessionID(): string | null | undefined;
+    getSessionURL(): string | undefined;
     setUserID(id: string): void;
     userID(id: string): void;
     setUserAnonymousID(id: string): void;

package/lib/index.js

@@ -1,20 +1,20 @@
-import App, { DEFAULT_INGEST_POINT } from "./app/index.js";
+import App, { DEFAULT_INGEST_POINT } from './app/index.js';
 export { default as App } from './app/index.js';
-import { UserAnonymousID, RawCustomEvent, CustomIssue } from "./common/messages.js";
-import * as _Messages from "./common/messages.js";
+import { UserAnonymousID, RawCustomEvent, CustomIssue, } from './common/messages.js';
+import * as _Messages from './common/messages.js';
 export const Messages = _Messages;
-import Connection from "./modules/connection.js";
-import Console from "./modules/console.js";
-import Exception, { getExceptionMessageFromEvent, getExceptionMessage } from "./modules/exception.js";
-import Img from "./modules/img.js";
-import Input from "./modules/input.js";
-import Mouse from "./modules/mouse.js";
-import Timing from "./modules/timing.js";
-import Performance from "./modules/performance.js";
-import Scroll from "./modules/scroll.js";
-import Viewport from "./modules/viewport.js";
-import CSSRules from "./modules/cssrules.js";
-import { IN_BROWSER, deprecationWarn, DOCS_HOST } from "./utils.js";
+import Connection from './modules/connection.js';
+import Console from './modules/console.js';
+import Exception, { getExceptionMessageFromEvent, getExceptionMessage, } from './modules/exception.js';
+import Img from './modules/img.js';
+import Input from './modules/input.js';
+import Mouse from './modules/mouse.js';
+import Timing from './modules/timing.js';
+import Performance from './modules/performance.js';
+import Scroll from './modules/scroll.js';
+import Viewport from './modules/viewport.js';
+import CSSRules from './modules/cssrules.js';
+import { IN_BROWSER, deprecationWarn, DOCS_HOST } from './utils.js';
 const DOCS_SETUP = '/installation/setup-or';
 function processOptions(obj) {
     if (obj == null) {
@@ -23,17 +23,18 @@ 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 ${DOCS_HOST}${DOCS_SETUP} for more information.`);
                 return false;
             }
             else {
                 obj.projectKey = obj.projectID.toString();
-                deprecationWarn("`projectID` option", "`projectKey` option", DOCS_SETUP);
+                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();
         }
     }
@@ -65,28 +66,29 @@ export default 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 App(options.projectKey, options.sessionToken, 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 App(options.projectKey, options.sessionToken, options));
         if (app !== null) {
             Viewport(app);
             CSSRules(app);
@@ -119,11 +121,11 @@ export default 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 || 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.6.3',
+                trackerVersion: '3.6.6',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)
@@ -142,7 +144,7 @@ export default class API {
     start(startOpts) {
         if (!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 ${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.");
@@ -169,16 +171,22 @@ export default class API {
         return this.app.getSessionID();
     }
     sessionID() {
-        deprecationWarn("'sessionID' method", "'getSessionID' method", "/");
+        deprecationWarn("'sessionID' method", "'getSessionID' method", '/');
         return this.getSessionID();
     }
+    getSessionURL() {
+        if (this.app === null) {
+            return undefined;
+        }
+        return this.app.getSessionURL();
+    }
     setUserID(id) {
         if (typeof id === 'string' && this.app !== null) {
             this.app.session.setUserID(id);
         }
     }
     userID(id) {
-        deprecationWarn("'userID' method", "'setUserID' method", "/");
+        deprecationWarn("'userID' method", "'setUserID' method", '/');
         this.setUserID(id);
     }
     setUserAnonymousID(id) {
@@ -187,18 +195,16 @@ export default class API {
         }
     }
     userAnonymousID(id) {
-        deprecationWarn("'userAnonymousID' method", "'setUserAnonymousID' method", "/");
+        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) {
-        deprecationWarn("'metadata' method", "'setMetadata' method", "/");
+        deprecationWarn("'metadata' method", "'setMetadata' method", '/');
         this.setMetadata(key, value);
     }
     event(key, payload, issue = false) {

package/lib/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/lib/modules/connection.js

@@ -1,4 +1,4 @@
-import { ConnectionInformation } from "../common/messages.js";
+import { ConnectionInformation } from '../common/messages.js';
 export default function (app) {
     const connection = navigator.connection ||
         navigator.mozConnection ||

package/lib/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/lib/modules/console.js

@@ -1,6 +1,6 @@
-import { hasTag } from "../app/guards.js";
-import { IN_BROWSER } from "../utils.js";
-import { ConsoleLog } from "../common/messages.js";
+import { hasTag } from '../app/guards.js';
+import { IN_BROWSER } from '../utils.js';
+import { ConsoleLog } from '../common/messages.js';
 const printError = IN_BROWSER && 'InstallTrigger' in window // detect Firefox
     ? (e) => e.message + '\n' + e.stack
     : (e) => e.stack || e.message;
@@ -87,8 +87,7 @@ export default function (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(new ConsoleLog(level, printf(args))));
@@ -113,13 +112,14 @@ export default function (app, opts) {
         };
     });
     patchConsole(window.console);
-    app.nodes.attachNodeCallback(app.safe(node => {
-        if (hasTag(node, "IFRAME")) { // TODO: newContextCallback
+    app.nodes.attachNodeCallback(app.safe((node) => {
+        if (hasTag(node, 'IFRAME')) {
+            // TODO: newContextCallback
             let context = node.contentWindow;
             if (context) {
                 patchConsole(context.console);
             }
-            app.attachEventListener(node, "load", () => {
+            app.attachEventListener(node, 'load', () => {
                 if (node.contentWindow !== context) {
                     context = node.contentWindow;
                     patchConsole(context.console);

package/lib/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/lib/modules/cssrules.js

@@ -1,11 +1,11 @@
-import { CSSInsertRuleURLBased, CSSDeleteRule, TechnicalInfo } from "../common/messages.js";
-import { hasTag } from "../app/guards.js";
+import { CSSInsertRuleURLBased, CSSDeleteRule, TechnicalInfo } from '../common/messages.js';
+import { hasTag } from '../app/guards.js';
 export default function (app) {
     if (app === null) {
         return;
     }
     if (!window.CSSStyleSheet) {
-        app.send(new TechnicalInfo("no_stylesheet_prototype_in_window", ""));
+        app.send(new TechnicalInfo('no_stylesheet_prototype_in_window', ''));
         return;
     }
     const processOperation = app.safe((stylesheet, index, rule) => {
@@ -14,7 +14,7 @@ export default function (app) {
             : (nodeID) => app.send(new 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) {
@@ -31,7 +31,7 @@ export default function (app) {
         return deleteRule.call(this, index);
     };
     app.nodes.attachNodeCallback((node) => {
-        if (!hasTag(node, "STYLE") || !node.sheet) {
+        if (!hasTag(node, 'STYLE') || !node.sheet) {
             return;
         }
         if (node.textContent !== null && node.textContent.trim().length > 0) {

package/lib/modules/exception.d.ts

@@ -1,5 +1,5 @@
-import type App from "../app/index.js";
-import type Message from "../common/messages.js";
+import type App from '../app/index.js';
+import type Message from '../common/messages.js';
 export interface Options {
     captureExceptions: boolean;
 }

package/lib/modules/exception.js

@@ -1,21 +1,22 @@
-import { JSException } from "../common/messages.js";
+import { JSException } from '../common/messages.js';
 import ErrorStackParser from 'error-stack-parser';
 function getDefaultStack(e) {
-    return [{
+    return [
+        {
             columnNumber: e.colno,
             lineNumber: e.lineno,
             fileName: e.filename,
-            functionName: "",
-            source: "",
-        }];
+            functionName: '',
+            source: '',
+        },
+    ];
 }
 export function getExceptionMessage(error, fallbackStack) {
     let stack = fallbackStack;
     try {
         stack = ErrorStackParser.parse(error);
     }
-    catch (e) {
-    }
+    catch (e) { }
     return new JSException(error.name, error.message, JSON.stringify(stack));
 }
 export function getExceptionMessageFromEvent(e) {

package/lib/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;

package/lib/modules/img.js

@@ -1,6 +1,6 @@
-import { timestamp, isURL } from "../utils.js";
-import { ResourceTiming, SetNodeAttributeURLBased, SetNodeAttribute } from "../common/messages.js";
-import { hasTag } from "../app/guards.js";
+import { timestamp, isURL } from '../utils.js';
+import { ResourceTiming, SetNodeAttributeURLBased, SetNodeAttribute, } from '../common/messages.js';
+import { hasTag } from '../app/guards.js';
 function resolveURL(url, location = document.location) {
     url = url.trim();
     if (url.startsWith('/')) {
@@ -16,16 +16,16 @@ function resolveURL(url, location = document.location) {
         return location.origin + location.pathname + url;
     }
 }
-const PLACEHOLDER_SRC = "https://static.openreplay.com/tracker/placeholder.jpeg";
+const PLACEHOLDER_SRC = 'https://static.openreplay.com/tracker/placeholder.jpeg';
 export default function (app) {
     function sendPlaceholder(id, node) {
-        app.send(new SetNodeAttribute(id, "src", PLACEHOLDER_SRC));
+        app.send(new SetNodeAttribute(id, 'src', PLACEHOLDER_SRC));
         const { width, height } = node.getBoundingClientRect();
-        if (!node.hasAttribute("width")) {
-            app.send(new SetNodeAttribute(id, "width", String(width)));
+        if (!node.hasAttribute('width')) {
+            app.send(new SetNodeAttribute(id, 'width', String(width)));
         }
-        if (!node.hasAttribute("height")) {
-            app.send(new SetNodeAttribute(id, "height", String(height)));
+        if (!node.hasAttribute('height')) {
+            app.send(new SetNodeAttribute(id, 'height', String(height)));
         }
     }
     const sendImgSrc = app.safe(function () {
@@ -49,24 +49,27 @@ export default function (app) {
         else {
             app.send(new SetNodeAttribute(id, 'src', resolvedSrc));
             if (srcset) {
-                const resolvedSrcset = srcset.split(',').map(str => resolveURL(str)).join(',');
+                const resolvedSrcset = srcset
+                    .split(',')
+                    .map((str) => resolveURL(str))
+                    .join(',');
                 app.send(new SetNodeAttribute(id, 'srcset', resolvedSrcset));
             }
         }
     });
     const observer = new MutationObserver((mutations) => {
         for (const mutation of mutations) {
-            if (mutation.type === "attributes") {
+            if (mutation.type === 'attributes') {
                 const target = mutation.target;
                 const id = app.nodes.getID(target);
                 if (id === undefined) {
                     return;
                 }
-                if (mutation.attributeName === "src") {
+                if (mutation.attributeName === 'src') {
                     const src = target.src;
                     app.send(new SetNodeAttributeURLBased(id, 'src', src, app.getBaseHref()));
                 }
-                if (mutation.attributeName === "srcset") {
+                if (mutation.attributeName === 'srcset') {
                     const srcset = target.srcset;
                     app.send(new SetNodeAttribute(id, 'srcset', srcset));
                 }
@@ -74,12 +77,12 @@ export default function (app) {
         }
     });
     app.nodes.attachNodeCallback((node) => {
-        if (!hasTag(node, "IMG")) {
+        if (!hasTag(node, 'IMG')) {
             return;
         }
         app.nodes.attachElementListener('error', node, sendImgSrc);
         app.nodes.attachElementListener('load', node, sendImgSrc);
         sendImgSrc.call(node);
-        observer.observe(node, { attributes: true, attributeFilter: ["src", "srcset"] });
+        observer.observe(node, { attributes: true, attributeFilter: ['src', 'srcset'] });
     });
 }

package/lib/modules/input.d.ts

@@ -1,4 +1,4 @@
-import type App from "../app/index.js";
+import type App from '../app/index.js';
 declare type TextEditableElement = HTMLInputElement | HTMLTextAreaElement;
 export declare function getInputLabel(node: TextEditableElement): string;
 export declare const enum InputMode {

package/lib/modules/input.js

@@ -1,18 +1,18 @@
-import { normSpaces, IN_BROWSER, getLabelAttribute, hasOpenreplayAttribute, } from "../utils.js";
-import { hasTag } from "../app/guards.js";
-import { SetInputTarget, SetInputValue, SetInputChecked } from "../common/messages.js";
+import { normSpaces, IN_BROWSER, getLabelAttribute, hasOpenreplayAttribute } from '../utils.js';
+import { hasTag } from '../app/guards.js';
+import { SetInputTarget, SetInputValue, SetInputChecked } from '../common/messages.js';
 const INPUT_TYPES = ['text', 'password', 'email', 'search', 'number', 'range', 'date'];
 function isTextEditable(node) {
-    if (hasTag(node, "TEXTAREA")) {
+    if (hasTag(node, 'TEXTAREA')) {
         return true;
     }
-    if (!hasTag(node, "INPUT")) {
+    if (!hasTag(node, 'INPUT')) {
         return false;
     }
     return INPUT_TYPES.includes(node.type);
 }
 function isCheckable(node) {
-    if (!hasTag(node, "INPUT")) {
+    if (!hasTag(node, 'INPUT')) {
         return false;
     }
     const type = node.type;
@@ -22,7 +22,7 @@ const labelElementFor = IN_BROWSER && 'labels' in HTMLInputElement.prototype
     ? (node) => {
         let p = node;
         while ((p = p.parentNode) !== null) {
-            if (hasTag(p, "LABEL")) {
+            if (hasTag(p, 'LABEL')) {
                 return p;
             }
         }
@@ -34,7 +34,7 @@ const labelElementFor = IN_BROWSER && 'labels' in HTMLInputElement.prototype
     : (node) => {
         let p = node;
         while ((p = p.parentNode) !== null) {
-            if (hasTag(p, "LABEL")) {
+            if (hasTag(p, 'LABEL')) {
                 return p;
             }
         }
@@ -50,12 +50,13 @@ export function getInputLabel(node) {
     let label = getLabelAttribute(node);
     if (label === null) {
         const labelElement = labelElementFor(node);
-        label = (labelElement && labelElement.innerText)
-            || node.placeholder
-            || node.name
-            || node.id
-            || node.className
-            || node.type;
+        label =
+            (labelElement && labelElement.innerText) ||
+                node.placeholder ||
+                node.name ||
+                node.id ||
+                node.className ||
+                node.type;
     }
     return normSpaces(label).slice(0, 100);
 }
@@ -82,8 +83,7 @@ export default function (app, opts) {
             (inputMode === 0 /* Plain */ &&
                 ((options.obscureInputNumbers && node.type !== 'date' && /\d\d\d\d/.test(value)) ||
                     (options.obscureInputDates && node.type === 'date') ||
-                    (options.obscureInputEmails &&
-                        (node.type === 'email' || !!~value.indexOf('@')))))) {
+                    (options.obscureInputEmails && (node.type === 'email' || !!~value.indexOf('@')))))) {
             inputMode = 1 /* Obscured */;
         }
         let mask = 0;
@@ -146,9 +146,9 @@ export default function (app, opts) {
             return;
         }
         // TODO: support multiple select (?): use selectedOptions; Need send target?
-        if (hasTag(node, "SELECT")) {
+        if (hasTag(node, 'SELECT')) {
             sendInputValue(id, node);
-            app.attachEventListener(node, "change", () => {
+            app.attachEventListener(node, 'change', () => {
                 sendInputValue(id, node);
             });
         }

package/lib/modules/longtasks.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;

package/lib/modules/longtasks.js

@@ -1,14 +1,22 @@
-import { LongTask } from "../common/messages.js";
-;
-;
+import { LongTask } from '../common/messages.js';
 export default function (app) {
     if (!('PerformanceObserver' in window) || !('PerformanceLongTaskTiming' in window)) {
         return;
     }
-    const contexts = ["unknown", "self", "same-origin-ancestor", "same-origin-descendant", "same-origin", "cross-origin-ancestor", "cross-origin-descendant", "cross-origin-unreachable", "multiple-contexts"];
-    const containerTypes = ["window", "iframe", "embed", "object"];
+    const contexts = [
+        'unknown',
+        'self',
+        'same-origin-ancestor',
+        'same-origin-descendant',
+        'same-origin',
+        'cross-origin-ancestor',
+        'cross-origin-descendant',
+        'cross-origin-unreachable',
+        'multiple-contexts',
+    ];
+    const containerTypes = ['window', 'iframe', 'embed', 'object'];
     function longTask(entry) {
-        let type = "", src = "", id = "", name = "";
+        let type = '', src = '', id = '', name = '';
         const container = entry.attribution[0];
         if (container != null) {
             type = container.containerType;

package/lib/modules/mouse.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;