@openreplay/tracker 3.6.0-beta.0 → 3.6.0

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

@@ -1,4 +1,4 @@
-export declare enum Type {
+export declare const enum Type {
     BatchMetadata = 81,
     PartitionedMessage = 82,
     Timestamp = 0,
@@ -56,327 +56,327 @@ export declare enum Type {
     AdoptedSSRemoveOwner = 77
 }
 export declare type BatchMetadata = [
-    type: Type.BatchMetadata,
-    version: number,
-    pageNo: number,
-    firstIndex: number,
-    timestamp: number,
-    location: string
+    Type.BatchMetadata,
+    number,
+    number,
+    number,
+    number,
+    string
 ];
 export declare type PartitionedMessage = [
-    type: Type.PartitionedMessage,
-    partNo: number,
-    partTotal: number
+    Type.PartitionedMessage,
+    number,
+    number
 ];
 export declare type Timestamp = [
-    type: Type.Timestamp,
-    timestamp: number
+    Type.Timestamp,
+    number
 ];
 export declare type SetPageLocation = [
-    type: Type.SetPageLocation,
-    url: string,
-    referrer: string,
-    navigationStart: number
+    Type.SetPageLocation,
+    string,
+    string,
+    number
 ];
 export declare type SetViewportSize = [
-    type: Type.SetViewportSize,
-    width: number,
-    height: number
+    Type.SetViewportSize,
+    number,
+    number
 ];
 export declare type SetViewportScroll = [
-    type: Type.SetViewportScroll,
-    x: number,
-    y: number
+    Type.SetViewportScroll,
+    number,
+    number
 ];
 export declare type CreateDocument = [
-    type: Type.CreateDocument
+    Type.CreateDocument
 ];
 export declare type CreateElementNode = [
-    type: Type.CreateElementNode,
-    id: number,
-    parentID: number,
-    index: number,
-    tag: string,
-    svg: boolean
+    Type.CreateElementNode,
+    number,
+    number,
+    number,
+    string,
+    boolean
 ];
 export declare type CreateTextNode = [
-    type: Type.CreateTextNode,
-    id: number,
-    parentID: number,
-    index: number
+    Type.CreateTextNode,
+    number,
+    number,
+    number
 ];
 export declare type MoveNode = [
-    type: Type.MoveNode,
-    id: number,
-    parentID: number,
-    index: number
+    Type.MoveNode,
+    number,
+    number,
+    number
 ];
 export declare type RemoveNode = [
-    type: Type.RemoveNode,
-    id: number
+    Type.RemoveNode,
+    number
 ];
 export declare type SetNodeAttribute = [
-    type: Type.SetNodeAttribute,
-    id: number,
-    name: string,
-    value: string
+    Type.SetNodeAttribute,
+    number,
+    string,
+    string
 ];
 export declare type RemoveNodeAttribute = [
-    type: Type.RemoveNodeAttribute,
-    id: number,
-    name: string
+    Type.RemoveNodeAttribute,
+    number,
+    string
 ];
 export declare type SetNodeData = [
-    type: Type.SetNodeData,
-    id: number,
-    data: string
+    Type.SetNodeData,
+    number,
+    string
 ];
 export declare type SetNodeScroll = [
-    type: Type.SetNodeScroll,
-    id: number,
-    x: number,
-    y: number
+    Type.SetNodeScroll,
+    number,
+    number,
+    number
 ];
 export declare type SetInputTarget = [
-    type: Type.SetInputTarget,
-    id: number,
-    label: string
+    Type.SetInputTarget,
+    number,
+    string
 ];
 export declare type SetInputValue = [
-    type: Type.SetInputValue,
-    id: number,
-    value: string,
-    mask: number
+    Type.SetInputValue,
+    number,
+    string,
+    number
 ];
 export declare type SetInputChecked = [
-    type: Type.SetInputChecked,
-    id: number,
-    checked: boolean
+    Type.SetInputChecked,
+    number,
+    boolean
 ];
 export declare type MouseMove = [
-    type: Type.MouseMove,
-    x: number,
-    y: number
+    Type.MouseMove,
+    number,
+    number
 ];
 export declare type ConsoleLog = [
-    type: Type.ConsoleLog,
-    level: string,
-    value: string
+    Type.ConsoleLog,
+    string,
+    string
 ];
 export declare type PageLoadTiming = [
-    type: Type.PageLoadTiming,
-    requestStart: number,
-    responseStart: number,
-    responseEnd: number,
-    domContentLoadedEventStart: number,
-    domContentLoadedEventEnd: number,
-    loadEventStart: number,
-    loadEventEnd: number,
-    firstPaint: number,
-    firstContentfulPaint: number
+    Type.PageLoadTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
 ];
 export declare type PageRenderTiming = [
-    type: Type.PageRenderTiming,
-    speedIndex: number,
-    visuallyComplete: number,
-    timeToInteractive: number
+    Type.PageRenderTiming,
+    number,
+    number,
+    number
 ];
 export declare type JSException = [
-    type: Type.JSException,
-    name: string,
-    message: string,
-    payload: string
+    Type.JSException,
+    string,
+    string,
+    string
 ];
 export declare type RawCustomEvent = [
-    type: Type.RawCustomEvent,
-    name: string,
-    payload: string
+    Type.RawCustomEvent,
+    string,
+    string
 ];
 export declare type UserID = [
-    type: Type.UserID,
-    id: string
+    Type.UserID,
+    string
 ];
 export declare type UserAnonymousID = [
-    type: Type.UserAnonymousID,
-    id: string
+    Type.UserAnonymousID,
+    string
 ];
 export declare type Metadata = [
-    type: Type.Metadata,
-    key: string,
-    value: string
+    Type.Metadata,
+    string,
+    string
 ];
 export declare type CSSInsertRule = [
-    type: Type.CSSInsertRule,
-    id: number,
-    rule: string,
-    index: number
+    Type.CSSInsertRule,
+    number,
+    string,
+    number
 ];
 export declare type CSSDeleteRule = [
-    type: Type.CSSDeleteRule,
-    id: number,
-    index: number
+    Type.CSSDeleteRule,
+    number,
+    number
 ];
 export declare type Fetch = [
-    type: Type.Fetch,
-    method: string,
-    url: string,
-    request: string,
-    response: string,
-    status: number,
-    timestamp: number,
-    duration: number
+    Type.Fetch,
+    string,
+    string,
+    string,
+    string,
+    number,
+    number,
+    number
 ];
 export declare type Profiler = [
-    type: Type.Profiler,
-    name: string,
-    duration: number,
-    args: string,
-    result: string
+    Type.Profiler,
+    string,
+    number,
+    string,
+    string
 ];
 export declare type OTable = [
-    type: Type.OTable,
-    key: string,
-    value: string
+    Type.OTable,
+    string,
+    string
 ];
 export declare type StateAction = [
-    type: Type.StateAction,
-    type: string
+    Type.StateAction,
+    string
 ];
 export declare type Redux = [
-    type: Type.Redux,
-    action: string,
-    state: string,
-    duration: number
+    Type.Redux,
+    string,
+    string,
+    number
 ];
 export declare type Vuex = [
-    type: Type.Vuex,
-    mutation: string,
-    state: string
+    Type.Vuex,
+    string,
+    string
 ];
 export declare type MobX = [
-    type: Type.MobX,
-    type: string,
-    payload: string
+    Type.MobX,
+    string,
+    string
 ];
 export declare type NgRx = [
-    type: Type.NgRx,
-    action: string,
-    state: string,
-    duration: number
+    Type.NgRx,
+    string,
+    string,
+    number
 ];
 export declare type GraphQL = [
-    type: Type.GraphQL,
-    operationKind: string,
-    operationName: string,
-    variables: string,
-    response: string
+    Type.GraphQL,
+    string,
+    string,
+    string,
+    string
 ];
 export declare type PerformanceTrack = [
-    type: Type.PerformanceTrack,
-    frames: number,
-    ticks: number,
-    totalJSHeapSize: number,
-    usedJSHeapSize: number
+    Type.PerformanceTrack,
+    number,
+    number,
+    number,
+    number
 ];
 export declare type ResourceTiming = [
-    type: Type.ResourceTiming,
-    timestamp: number,
-    duration: number,
-    ttfb: number,
-    headerSize: number,
-    encodedBodySize: number,
-    decodedBodySize: number,
-    url: string,
-    initiator: string
+    Type.ResourceTiming,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string
 ];
 export declare type ConnectionInformation = [
-    type: Type.ConnectionInformation,
-    downlink: number,
-    type: string
+    Type.ConnectionInformation,
+    number,
+    string
 ];
 export declare type SetPageVisibility = [
-    type: Type.SetPageVisibility,
-    hidden: boolean
+    Type.SetPageVisibility,
+    boolean
 ];
 export declare type LongTask = [
-    type: Type.LongTask,
-    timestamp: number,
-    duration: number,
-    context: number,
-    containerType: number,
-    containerSrc: string,
-    containerId: string,
-    containerName: string
+    Type.LongTask,
+    number,
+    number,
+    number,
+    number,
+    string,
+    string,
+    string
 ];
 export declare type SetNodeAttributeURLBased = [
-    type: Type.SetNodeAttributeURLBased,
-    id: number,
-    name: string,
-    value: string,
-    baseURL: string
+    Type.SetNodeAttributeURLBased,
+    number,
+    string,
+    string,
+    string
 ];
 export declare type SetCSSDataURLBased = [
-    type: Type.SetCSSDataURLBased,
-    id: number,
-    data: string,
-    baseURL: string
+    Type.SetCSSDataURLBased,
+    number,
+    string,
+    string
 ];
 export declare type TechnicalInfo = [
-    type: Type.TechnicalInfo,
-    type: string,
-    value: string
+    Type.TechnicalInfo,
+    string,
+    string
 ];
 export declare type CustomIssue = [
-    type: Type.CustomIssue,
-    name: string,
-    payload: string
+    Type.CustomIssue,
+    string,
+    string
 ];
 export declare type CSSInsertRuleURLBased = [
-    type: Type.CSSInsertRuleURLBased,
-    id: number,
-    rule: string,
-    index: number,
-    baseURL: string
+    Type.CSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
 ];
 export declare type MouseClick = [
-    type: Type.MouseClick,
-    id: number,
-    hesitationTime: number,
-    label: string,
-    selector: string
+    Type.MouseClick,
+    number,
+    number,
+    string,
+    string
 ];
 export declare type CreateIFrameDocument = [
-    type: Type.CreateIFrameDocument,
-    frameID: number,
-    id: number
+    Type.CreateIFrameDocument,
+    number,
+    number
 ];
 export declare type AdoptedSSReplaceURLBased = [
-    type: Type.AdoptedSSReplaceURLBased,
-    sheetID: number,
-    text: string,
-    baseURL: string
+    Type.AdoptedSSReplaceURLBased,
+    number,
+    string,
+    string
 ];
 export declare type AdoptedSSInsertRuleURLBased = [
-    type: Type.AdoptedSSInsertRuleURLBased,
-    sheetID: number,
-    rule: string,
-    index: number,
-    baseURL: string
+    Type.AdoptedSSInsertRuleURLBased,
+    number,
+    string,
+    number,
+    string
 ];
 export declare type AdoptedSSDeleteRule = [
-    type: Type.AdoptedSSDeleteRule,
-    sheetID: number,
-    index: number
+    Type.AdoptedSSDeleteRule,
+    number,
+    number
 ];
 export declare type AdoptedSSAddOwner = [
-    type: Type.AdoptedSSAddOwner,
-    sheetID: number,
-    id: number
+    Type.AdoptedSSAddOwner,
+    number,
+    number
 ];
 export declare type AdoptedSSRemoveOwner = [
-    type: Type.AdoptedSSRemoveOwner,
-    sheetID: number,
-    id: number
+    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/messages.gen.js

@@ -1,62 +1,3 @@
 "use strict";
 // Auto-generated, do not edit
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Type = void 0;
-var Type;
-(function (Type) {
-    Type[Type["BatchMetadata"] = 81] = "BatchMetadata";
-    Type[Type["PartitionedMessage"] = 82] = "PartitionedMessage";
-    Type[Type["Timestamp"] = 0] = "Timestamp";
-    Type[Type["SetPageLocation"] = 4] = "SetPageLocation";
-    Type[Type["SetViewportSize"] = 5] = "SetViewportSize";
-    Type[Type["SetViewportScroll"] = 6] = "SetViewportScroll";
-    Type[Type["CreateDocument"] = 7] = "CreateDocument";
-    Type[Type["CreateElementNode"] = 8] = "CreateElementNode";
-    Type[Type["CreateTextNode"] = 9] = "CreateTextNode";
-    Type[Type["MoveNode"] = 10] = "MoveNode";
-    Type[Type["RemoveNode"] = 11] = "RemoveNode";
-    Type[Type["SetNodeAttribute"] = 12] = "SetNodeAttribute";
-    Type[Type["RemoveNodeAttribute"] = 13] = "RemoveNodeAttribute";
-    Type[Type["SetNodeData"] = 14] = "SetNodeData";
-    Type[Type["SetNodeScroll"] = 16] = "SetNodeScroll";
-    Type[Type["SetInputTarget"] = 17] = "SetInputTarget";
-    Type[Type["SetInputValue"] = 18] = "SetInputValue";
-    Type[Type["SetInputChecked"] = 19] = "SetInputChecked";
-    Type[Type["MouseMove"] = 20] = "MouseMove";
-    Type[Type["ConsoleLog"] = 22] = "ConsoleLog";
-    Type[Type["PageLoadTiming"] = 23] = "PageLoadTiming";
-    Type[Type["PageRenderTiming"] = 24] = "PageRenderTiming";
-    Type[Type["JSException"] = 25] = "JSException";
-    Type[Type["RawCustomEvent"] = 27] = "RawCustomEvent";
-    Type[Type["UserID"] = 28] = "UserID";
-    Type[Type["UserAnonymousID"] = 29] = "UserAnonymousID";
-    Type[Type["Metadata"] = 30] = "Metadata";
-    Type[Type["CSSInsertRule"] = 37] = "CSSInsertRule";
-    Type[Type["CSSDeleteRule"] = 38] = "CSSDeleteRule";
-    Type[Type["Fetch"] = 39] = "Fetch";
-    Type[Type["Profiler"] = 40] = "Profiler";
-    Type[Type["OTable"] = 41] = "OTable";
-    Type[Type["StateAction"] = 42] = "StateAction";
-    Type[Type["Redux"] = 44] = "Redux";
-    Type[Type["Vuex"] = 45] = "Vuex";
-    Type[Type["MobX"] = 46] = "MobX";
-    Type[Type["NgRx"] = 47] = "NgRx";
-    Type[Type["GraphQL"] = 48] = "GraphQL";
-    Type[Type["PerformanceTrack"] = 49] = "PerformanceTrack";
-    Type[Type["ResourceTiming"] = 53] = "ResourceTiming";
-    Type[Type["ConnectionInformation"] = 54] = "ConnectionInformation";
-    Type[Type["SetPageVisibility"] = 55] = "SetPageVisibility";
-    Type[Type["LongTask"] = 59] = "LongTask";
-    Type[Type["SetNodeAttributeURLBased"] = 60] = "SetNodeAttributeURLBased";
-    Type[Type["SetCSSDataURLBased"] = 61] = "SetCSSDataURLBased";
-    Type[Type["TechnicalInfo"] = 63] = "TechnicalInfo";
-    Type[Type["CustomIssue"] = 64] = "CustomIssue";
-    Type[Type["CSSInsertRuleURLBased"] = 67] = "CSSInsertRuleURLBased";
-    Type[Type["MouseClick"] = 69] = "MouseClick";
-    Type[Type["CreateIFrameDocument"] = 70] = "CreateIFrameDocument";
-    Type[Type["AdoptedSSReplaceURLBased"] = 71] = "AdoptedSSReplaceURLBased";
-    Type[Type["AdoptedSSInsertRuleURLBased"] = 73] = "AdoptedSSInsertRuleURLBased";
-    Type[Type["AdoptedSSDeleteRule"] = 75] = "AdoptedSSDeleteRule";
-    Type[Type["AdoptedSSAddOwner"] = 76] = "AdoptedSSAddOwner";
-    Type[Type["AdoptedSSRemoveOwner"] = 77] = "AdoptedSSRemoveOwner";
-})(Type = exports.Type || (exports.Type = {}));

package/cjs/index.d.ts

@@ -13,7 +13,7 @@ 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,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(): string | null;
+    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

@@ -43,8 +43,8 @@ function processOptions(obj) {
             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 (obj.sessionToken != null) {
+        (0, utils_js_1.deprecationWarn)('`sessionToken` option', '`sessionHash` start() option', '/');
     }
     return true;
 }
@@ -93,7 +93,7 @@ class API {
                 !('Blob' in window) ||
                 !('Worker' in window)
                 ? null
-                : new index_js_1.default(options.projectKey, options.sessionHash, options));
+                : 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);
@@ -131,7 +131,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.5.16',
+                trackerVersion: '3.6.0',
                 projectKey: options.projectKey,
                 doNotTrack,
                 // TODO: add precise reason (an exact API missing)
@@ -160,7 +160,7 @@ class API {
     }
     stop() {
         if (this.app === null) {
-            return null;
+            return;
         }
         this.app.stop();
         const sessionHash = this.app.session.getSessionHash();
@@ -183,6 +183,12 @@ class API {
         (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);