@openreplay/tracker 3.6.3 → 4.0.0

package/cjs/common/messages.gen.d.ts

@@ -0,0 +1,382 @@
+export declare const enum Type {
+    BatchMetadata = 81,
+    PartitionedMessage = 82,
+    Timestamp = 0,
+    SetPageLocation = 4,
+    SetViewportSize = 5,
+    SetViewportScroll = 6,
+    CreateDocument = 7,
+    CreateElementNode = 8,
+    CreateTextNode = 9,
+    MoveNode = 10,
+    RemoveNode = 11,
+    SetNodeAttribute = 12,
+    RemoveNodeAttribute = 13,
+    SetNodeData = 14,
+    SetNodeScroll = 16,
+    SetInputTarget = 17,
+    SetInputValue = 18,
+    SetInputChecked = 19,
+    MouseMove = 20,
+    ConsoleLog = 22,
+    PageLoadTiming = 23,
+    PageRenderTiming = 24,
+    JSException = 25,
+    RawCustomEvent = 27,
+    UserID = 28,
+    UserAnonymousID = 29,
+    Metadata = 30,
+    CSSInsertRule = 37,
+    CSSDeleteRule = 38,
+    Fetch = 39,
+    Profiler = 40,
+    OTable = 41,
+    StateAction = 42,
+    Redux = 44,
+    Vuex = 45,
+    MobX = 46,
+    NgRx = 47,
+    GraphQL = 48,
+    PerformanceTrack = 49,
+    ResourceTiming = 53,
+    ConnectionInformation = 54,
+    SetPageVisibility = 55,
+    LongTask = 59,
+    SetNodeAttributeURLBased = 60,
+    SetCSSDataURLBased = 61,
+    TechnicalInfo = 63,
+    CustomIssue = 64,
+    CSSInsertRuleURLBased = 67,
+    MouseClick = 69,
+    CreateIFrameDocument = 70,
+    AdoptedSSReplaceURLBased = 71,
+    AdoptedSSInsertRuleURLBased = 73,
+    AdoptedSSDeleteRule = 75,
+    AdoptedSSAddOwner = 76,
+    AdoptedSSRemoveOwner = 77
+}
+export declare type BatchMetadata = [
+    Type.BatchMetadata,
+    number,
+    number,
+    number,
+    number,
+    string
+];
+export declare type PartitionedMessage = [
+    Type.PartitionedMessage,
+    number,
+    number
+];
+export declare type Timestamp = [
+    Type.Timestamp,
+    number
+];
+export declare type SetPageLocation = [
+    Type.SetPageLocation,
+    string,
+    string,
+    number
+];
+export declare type SetViewportSize = [
+    Type.SetViewportSize,
+    number,
+    number
+];
+export declare type SetViewportScroll = [
+    Type.SetViewportScroll,
+    number,
+    number
+];
+export declare type CreateDocument = [
+    Type.CreateDocument
+];
+export declare type CreateElementNode = [
+    Type.CreateElementNode,
+    number,
+    number,
+    number,
+    string,
+    boolean
+];
+export declare type CreateTextNode = [
+    Type.CreateTextNode,
+    number,
+    number,
+    number
+];
+export declare type MoveNode = [
+    Type.MoveNode,
+    number,
+    number,
+    number
+];
+export declare type RemoveNode = [
+    Type.RemoveNode,
+    number
+];
+export declare type SetNodeAttribute = [
+    Type.SetNodeAttribute,
+    number,
+    string,
+    string
+];
+export declare type RemoveNodeAttribute = [
+    Type.RemoveNodeAttribute,
+    number,
+    string
+];
+export declare type SetNodeData = [
+    Type.SetNodeData,
+    number,
+    string
+];
+export declare type SetNodeScroll = [
+    Type.SetNodeScroll,
+    number,
+    number,
+    number
+];
+export declare type SetInputTarget = [
+    Type.SetInputTarget,
+    number,
+    string
+];
+export declare type SetInputValue = [
+    Type.SetInputValue,
+    number,
+    string,
+    number
+];
+export declare type SetInputChecked = [
+    Type.SetInputChecked,
+    number,
+    boolean
+];
+export declare type MouseMove = [
+    Type.MouseMove,
+    number,
+    number
+];
+export declare type ConsoleLog = [
+    Type.ConsoleLog,
+    string,
+    string
+];
+export declare type PageLoadTiming = [
+    Type.PageLoadTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+export declare type PageRenderTiming = [
+    Type.PageRenderTiming,
+    number,
+    number,
+    number
+];
+export declare type JSException = [
+    Type.JSException,
+    string,
+    string,
+    string
+];
+export declare type RawCustomEvent = [
+    Type.RawCustomEvent,
+    string,
+    string
+];
+export declare type UserID = [
+    Type.UserID,
+    string
+];
+export declare type UserAnonymousID = [
+    Type.UserAnonymousID,
+    string
+];
+export declare type Metadata = [
+    Type.Metadata,
+    string,
+    string
+];
+export declare type CSSInsertRule = [
+    Type.CSSInsertRule,
+    number,
+    string,
+    number
+];
+export declare type CSSDeleteRule = [
+    Type.CSSDeleteRule,
+    number,
+    number
+];
+export declare type Fetch = [
+    Type.Fetch,
+    string,
+    string,
+    string,
+    string,
+    number,
+    number,
+    number
+];
+export declare type Profiler = [
+    Type.Profiler,
+    string,
+    number,
+    string,
+    string
+];
+export declare type OTable = [
+    Type.OTable,
+    string,
+    string
+];
+export declare type StateAction = [
+    Type.StateAction,
+    string
+];
+export declare type Redux = [
+    Type.Redux,
+    string,
+    string,
+    number
+];
+export declare type Vuex = [
+    Type.Vuex,
+    string,
+    string
+];
+export declare type MobX = [
+    Type.MobX,
+    string,
+    string
+];
+export declare type NgRx = [
+    Type.NgRx,
+    string,
+    string,
+    number
+];
+export declare type GraphQL = [
+    Type.GraphQL,
+    string,
+    string,
+    string,
+    string
+];
+export declare type PerformanceTrack = [
+    Type.PerformanceTrack,
+    number,
+    number,
+    number,
+    number
+];
+export declare type ResourceTiming = [
+    Type.ResourceTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string
+];
+export declare type ConnectionInformation = [
+    Type.ConnectionInformation,
+    number,
+    string
+];
+export declare type SetPageVisibility = [
+    Type.SetPageVisibility,
+    boolean
+];
+export declare type LongTask = [
+    Type.LongTask,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string,
+    string
+];
+export declare type SetNodeAttributeURLBased = [
+    Type.SetNodeAttributeURLBased,
+    number,
+    string,
+    string,
+    string
+];
+export declare type SetCSSDataURLBased = [
+    Type.SetCSSDataURLBased,
+    number,
+    string,
+    string
+];
+export declare type TechnicalInfo = [
+    Type.TechnicalInfo,
+    string,
+    string
+];
+export declare type CustomIssue = [
+    Type.CustomIssue,
+    string,
+    string
+];
+export declare type CSSInsertRuleURLBased = [
+    Type.CSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
+];
+export declare type MouseClick = [
+    Type.MouseClick,
+    number,
+    number,
+    string,
+    string
+];
+export declare type CreateIFrameDocument = [
+    Type.CreateIFrameDocument,
+    number,
+    number
+];
+export declare type AdoptedSSReplaceURLBased = [
+    Type.AdoptedSSReplaceURLBased,
+    number,
+    string,
+    string
+];
+export declare type AdoptedSSInsertRuleURLBased = [
+    Type.AdoptedSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
+];
+export declare type AdoptedSSDeleteRule = [
+    Type.AdoptedSSDeleteRule,
+    number,
+    number
+];
+export declare type AdoptedSSAddOwner = [
+    Type.AdoptedSSAddOwner,
+    number,
+    number
+];
+export declare type AdoptedSSRemoveOwner = [
+    Type.AdoptedSSRemoveOwner,
+    number,
+    number
+];
+declare type Message = BatchMetadata | PartitionedMessage | Timestamp | SetPageLocation | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | ConsoleLog | PageLoadTiming | PageRenderTiming | JSException | RawCustomEvent | UserID | UserAnonymousID | Metadata | CSSInsertRule | CSSDeleteRule | Fetch | Profiler | OTable | StateAction | Redux | Vuex | MobX | NgRx | GraphQL | PerformanceTrack | ResourceTiming | ConnectionInformation | SetPageVisibility | LongTask | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | CSSInsertRuleURLBased | MouseClick | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner;
+export default Message;

package/cjs/common/{webworker.js → messages.gen.js}

@@ -1,2 +1,3 @@
 "use strict";
+// Auto-generated, do not edit
 Object.defineProperty(exports, "__esModule", { value: true });

package/cjs/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 './app/messages.gen.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> & {
@@ -25,10 +25,11 @@ export default class API {
     use<T>(fn: (app: App | null, options?: Options) => T): T;
     isActive(): boolean;
     start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
-    stop(): void;
+    stop(): string | undefined;
     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/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_js_1 = require("./common/messages.js");
-const _Messages = require("./common/messages.js");
+const messages_gen_js_1 = require("./app/messages.gen.js");
+const _Messages = require("./app/messages.gen.js");
 exports.Messages = _Messages;
 const connection_js_1 = require("./modules/connection.js");
 const console_js_1 = require("./modules/console.js");
@@ -18,6 +18,7 @@ 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) {
@@ -27,22 +28,23 @@ 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.sessionToken !== 'string' && obj.sessionToken != null) {
-        console.warn(`OpenReplay: invalid options argument type. Please, check documentation on ${utils_js_1.DOCS_HOST}${DOCS_SETUP}`);
+    if (obj.sessionToken != null) {
+        (0, utils_js_1.deprecationWarn)('`sessionToken` option', '`sessionHash` start() option', '/');
     }
     return true;
 }
@@ -69,31 +71,33 @@ 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.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 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);
@@ -123,11 +127,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.6.3',
+                trackerVersion: '4.0.0',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)
@@ -146,7 +150,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.");
@@ -158,7 +162,10 @@ class API {
         if (this.app === null) {
             return;
         }
-        this.app.stop(true);
+        this.app.stop();
+        const sessionHash = this.app.session.getSessionHash();
+        this.app.session.reset();
+        return sessionHash;
     }
     getSessionToken() {
         if (this.app === null) {
@@ -173,36 +180,40 @@ 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();
     }
+    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) {
-        (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(new messages_js_1.UserAnonymousID(id));
+            this.app.send((0, messages_gen_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) {
@@ -217,7 +228,7 @@ class API {
                 catch (e) {
                     return;
                 }
-                this.app.send(new messages_js_1.RawCustomEvent(key, payload));
+                this.app.send((0, messages_gen_js_1.RawCustomEvent)(key, payload));
             }
         }
     }
@@ -229,7 +240,7 @@ class API {
             catch (e) {
                 return;
             }
-            this.app.send(new messages_js_1.CustomIssue(key, payload));
+            this.app.send((0, messages_gen_js_1.CustomIssue)(key, payload));
         }
     }
 }

package/cjs/modules/adoptedStyleSheets.d.ts

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