@openreplay/tracker 11.0.6 → 12.0.0

package/cjs/app/logger.d.ts

@@ -5,22 +5,12 @@ export declare const LogLevel: {
     readonly Errors: 2;
     readonly Silent: 0;
 };
-type LogLevel = (typeof LogLevel)[keyof typeof LogLevel];
-type CustomLevel = {
-    error: boolean;
-    warn: boolean;
-    log: boolean;
-};
-interface _Options {
-    level: LogLevel | CustomLevel;
-    messages?: number[];
-}
-export type Options = true | _Options | LogLevel;
+export type ILogLevel = (typeof LogLevel)[keyof typeof LogLevel];
 export default class Logger {
-    private readonly options;
-    constructor(options?: Options);
-    log(...args: any): void;
-    warn(...args: any): void;
-    error(...args: any): void;
+    private readonly level;
+    constructor(debugLevel?: ILogLevel);
+    private shouldLog;
+    log(...args: any[]): void;
+    warn(...args: any[]): void;
+    error(...args: any[]): void;
 }
-export {};

package/cjs/app/logger.js

@@ -8,36 +8,28 @@ exports.LogLevel = {
     Errors: 2,
     Silent: 0,
 };
-function IsCustomLevel(l) {
-    return typeof l === 'object';
-}
 class Logger {
-    constructor(options = exports.LogLevel.Silent) {
-        this.options =
-            options === true
-                ? { level: exports.LogLevel.Verbose }
-                : typeof options === 'number'
-                    ? { level: options }
-                    : options;
+    constructor(debugLevel = exports.LogLevel.Silent) {
+        this.level = debugLevel;
+    }
+    shouldLog(level) {
+        return this.level >= level;
     }
     log(...args) {
-        if (IsCustomLevel(this.options.level)
-            ? this.options.level.log
-            : this.options.level >= exports.LogLevel.Log) {
+        if (this.shouldLog(exports.LogLevel.Log)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             console.log(...args);
         }
     }
     warn(...args) {
-        if (IsCustomLevel(this.options.level)
-            ? this.options.level.warn
-            : this.options.level >= exports.LogLevel.Warnings) {
+        if (this.shouldLog(exports.LogLevel.Warnings)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             console.warn(...args);
         }
     }
     error(...args) {
-        if (IsCustomLevel(this.options.level)
-            ? this.options.level.error
-            : this.options.level >= exports.LogLevel.Errors) {
+        if (this.shouldLog(exports.LogLevel.Errors)) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
             console.error(...args);
         }
     }

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

@@ -62,6 +62,7 @@ export declare function Zustand(mutation: string, state: string): Messages.Zusta
 export declare function BatchMetadata(version: number, pageNo: number, firstIndex: number, timestamp: number, location: string): Messages.BatchMetadata;
 export declare function PartitionedMessage(partNo: number, partTotal: number): Messages.PartitionedMessage;
 export declare function NetworkRequest(type: string, method: string, url: string, request: string, response: string, status: number, timestamp: number, duration: number, transferredBodySize: number): Messages.NetworkRequest;
+export declare function WSChannel(chType: string, channelName: string, data: string, timestamp: number, dir: string, messageType: string): Messages.WSChannel;
 export declare function InputChange(id: number, value: string, valueMasked: boolean, label: string, hesitationTime: number, inputDuration: number): Messages.InputChange;
 export declare function SelectionChange(selectionStart: number, selectionEnd: number, selection: string): Messages.SelectionChange;
 export declare function MouseThrashing(timestamp: number): Messages.MouseThrashing;
@@ -70,3 +71,4 @@ export declare function ResourceTiming(timestamp: number, duration: number, ttfb
 export declare function TabChange(tabId: string): Messages.TabChange;
 export declare function TabData(tabId: string): Messages.TabData;
 export declare function CanvasNode(nodeId: string, timestamp: number): Messages.CanvasNode;
+export declare function TagTrigger(tagId: number): Messages.TagTrigger;

package/cjs/app/messages.gen.js

@@ -3,7 +3,7 @@
 /* eslint-disable */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CSSInsertRuleURLBased = exports.CustomIssue = exports.TechnicalInfo = exports.SetCSSDataURLBased = exports.SetNodeAttributeURLBased = exports.LongTask = exports.SetNodeFocus = exports.LoadFontFace = exports.SetPageVisibility = exports.ConnectionInformation = exports.ResourceTimingDeprecated = exports.SetNodeAttributeDict = exports.StringDict = exports.PerformanceTrack = exports.GraphQL = exports.NgRx = exports.MobX = exports.Vuex = exports.Redux = exports.StateAction = exports.OTable = exports.Profiler = exports.Fetch = exports.CSSDeleteRule = exports.CSSInsertRule = exports.Metadata = exports.UserAnonymousID = exports.UserID = exports.CustomEvent = exports.PageRenderTiming = exports.PageLoadTiming = exports.ConsoleLog = exports.NetworkRequestDeprecated = exports.MouseMove = exports.SetInputChecked = exports.SetInputValue = exports.SetInputTarget = exports.SetNodeScroll = exports.SetNodeData = exports.RemoveNodeAttribute = exports.SetNodeAttribute = exports.RemoveNode = exports.MoveNode = exports.CreateTextNode = exports.CreateElementNode = exports.CreateDocument = exports.SetViewportScroll = exports.SetViewportSize = exports.SetPageLocation = exports.Timestamp = void 0;
-exports.CanvasNode = exports.TabData = exports.TabChange = exports.ResourceTiming = exports.UnbindNodes = exports.MouseThrashing = exports.SelectionChange = exports.InputChange = exports.NetworkRequest = exports.PartitionedMessage = exports.BatchMetadata = exports.Zustand = exports.JSException = exports.AdoptedSSRemoveOwner = exports.AdoptedSSAddOwner = exports.AdoptedSSDeleteRule = exports.AdoptedSSInsertRuleURLBased = exports.AdoptedSSReplaceURLBased = exports.CreateIFrameDocument = exports.MouseClick = void 0;
+exports.TagTrigger = exports.CanvasNode = exports.TabData = exports.TabChange = exports.ResourceTiming = exports.UnbindNodes = exports.MouseThrashing = exports.SelectionChange = exports.InputChange = exports.WSChannel = exports.NetworkRequest = exports.PartitionedMessage = exports.BatchMetadata = exports.Zustand = exports.JSException = exports.AdoptedSSRemoveOwner = exports.AdoptedSSAddOwner = exports.AdoptedSSDeleteRule = exports.AdoptedSSInsertRuleURLBased = exports.AdoptedSSReplaceURLBased = exports.CreateIFrameDocument = exports.MouseClick = void 0;
 function Timestamp(timestamp) {
     return [
         0 /* Messages.Type.Timestamp */,
@@ -564,6 +564,18 @@ function NetworkRequest(type, method, url, request, response, status, timestamp,
     ];
 }
 exports.NetworkRequest = NetworkRequest;
+function WSChannel(chType, channelName, data, timestamp, dir, messageType) {
+    return [
+        84 /* Messages.Type.WSChannel */,
+        chType,
+        channelName,
+        data,
+        timestamp,
+        dir,
+        messageType,
+    ];
+}
+exports.WSChannel = WSChannel;
 function InputChange(id, value, valueMasked, label, hesitationTime, inputDuration) {
     return [
         112 /* Messages.Type.InputChange */,
@@ -637,3 +649,10 @@ function CanvasNode(nodeId, timestamp) {
     ];
 }
 exports.CanvasNode = CanvasNode;
+function TagTrigger(tagId) {
+    return [
+        120 /* Messages.Type.TagTrigger */,
+        tagId,
+    ];
+}
+exports.TagTrigger = TagTrigger;

package/cjs/app/observer/iframe_observer.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const observer_js_1 = require("./observer.js");
+const observer_js_1 = __importDefault(require("./observer.js"));
 const messages_gen_js_1 = require("../messages.gen.js");
 class IFrameObserver extends observer_js_1.default {
     observe(iframe) {

package/cjs/app/observer/shadow_root_observer.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const observer_js_1 = require("./observer.js");
+const observer_js_1 = __importDefault(require("./observer.js"));
 const messages_gen_js_1 = require("../messages.gen.js");
 class ShadowRootObserver extends observer_js_1.default {
     observe(el) {

package/cjs/app/observer/top_observer.js

@@ -1,10 +1,13 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const observer_js_1 = require("./observer.js");
+const observer_js_1 = __importDefault(require("./observer.js"));
 const guards_js_1 = require("../guards.js");
-const iframe_observer_js_1 = require("./iframe_observer.js");
-const shadow_root_observer_js_1 = require("./shadow_root_observer.js");
-const iframe_offsets_js_1 = require("./iframe_offsets.js");
+const iframe_observer_js_1 = __importDefault(require("./iframe_observer.js"));
+const shadow_root_observer_js_1 = __importDefault(require("./shadow_root_observer.js"));
+const iframe_offsets_js_1 = __importDefault(require("./iframe_offsets.js"));
 const messages_gen_js_1 = require("../messages.gen.js");
 const utils_js_1 = require("../../utils.js");
 const attachShadowNativeFn = utils_js_1.IN_BROWSER ? Element.prototype.attachShadow : () => new ShadowRoot();

package/cjs/common/interaction.d.ts

@@ -22,13 +22,16 @@ export type ToWorkerData = null | 'stop' | Start | Auth | Array<Message> | {
 } | {
     type: 'uncompressed';
     batch: Uint8Array;
-} | 'forceFlushBatch';
+} | 'forceFlushBatch' | 'check_queue';
 type Failure = {
     type: 'failure';
     reason: string;
 };
+type QEmpty = {
+    type: 'queue_empty';
+};
 export type FromWorkerData = 'restart' | Failure | 'not_init' | {
     type: 'compress';
     batch: Uint8Array;
-};
+} | QEmpty;
 export {};

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

@@ -61,6 +61,7 @@ export declare const enum Type {
     BatchMetadata = 81,
     PartitionedMessage = 82,
     NetworkRequest = 83,
+    WSChannel = 84,
     InputChange = 112,
     SelectionChange = 113,
     MouseThrashing = 114,
@@ -68,7 +69,8 @@ export declare const enum Type {
     ResourceTiming = 116,
     TabChange = 117,
     TabData = 118,
-    CanvasNode = 119
+    CanvasNode = 119,
+    TagTrigger = 120
 }
 export type Timestamp = [
     Type.Timestamp,
@@ -444,6 +446,15 @@ export type NetworkRequest = [
     number,
     number
 ];
+export type WSChannel = [
+    Type.WSChannel,
+    string,
+    string,
+    string,
+    number,
+    string,
+    string
+];
 export type InputChange = [
     Type.InputChange,
     number,
@@ -493,5 +504,9 @@ export type CanvasNode = [
     string,
     number
 ];
-type Message = Timestamp | SetPageLocation | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | NetworkRequestDeprecated | ConsoleLog | PageLoadTiming | PageRenderTiming | CustomEvent | UserID | UserAnonymousID | Metadata | CSSInsertRule | CSSDeleteRule | Fetch | Profiler | OTable | StateAction | Redux | Vuex | MobX | NgRx | GraphQL | PerformanceTrack | StringDict | SetNodeAttributeDict | ResourceTimingDeprecated | ConnectionInformation | SetPageVisibility | LoadFontFace | SetNodeFocus | LongTask | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | CSSInsertRuleURLBased | MouseClick | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner | JSException | Zustand | BatchMetadata | PartitionedMessage | NetworkRequest | InputChange | SelectionChange | MouseThrashing | UnbindNodes | ResourceTiming | TabChange | TabData | CanvasNode;
+export type TagTrigger = [
+    Type.TagTrigger,
+    number
+];
+type Message = Timestamp | SetPageLocation | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | NetworkRequestDeprecated | ConsoleLog | PageLoadTiming | PageRenderTiming | CustomEvent | UserID | UserAnonymousID | Metadata | CSSInsertRule | CSSDeleteRule | Fetch | Profiler | OTable | StateAction | Redux | Vuex | MobX | NgRx | GraphQL | PerformanceTrack | StringDict | SetNodeAttributeDict | ResourceTimingDeprecated | ConnectionInformation | SetPageVisibility | LoadFontFace | SetNodeFocus | LongTask | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | CSSInsertRuleURLBased | MouseClick | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner | JSException | Zustand | BatchMetadata | PartitionedMessage | NetworkRequest | WSChannel | InputChange | SelectionChange | MouseThrashing | UnbindNodes | ResourceTiming | TabChange | TabData | CanvasNode | TagTrigger;
 export default Message;

package/cjs/index.d.ts

@@ -33,16 +33,59 @@ export default class API {
     featureFlags: FeatureFlags;
     private readonly app;
     constructor(options: Options);
+    checkDoNotTrack: () => boolean | undefined;
+    signalStartIssue: (reason: string, missingApi: string[]) => void;
     isFlagEnabled(flagName: string): boolean;
     onFlagsLoad(callback: (flags: IFeatureFlag[]) => void): void;
     clearPersistFlags(): void;
-    reloadFlags(): Promise<void>;
+    reloadFlags(): Promise<void> | undefined;
     getFeatureFlag(flagName: string): IFeatureFlag | undefined;
-    getAllFeatureFlags(): IFeatureFlag[];
+    getAllFeatureFlags(): IFeatureFlag[] | undefined;
     restartCanvasTracking: () => void;
     use<T>(fn: (app: App | null, options?: Options) => T): T;
     isActive(): boolean;
+    /**
+     * Creates a named hook that expects event name, data string and msg direction (up/down),
+     * it will skip any message bigger than 5 mb or event name bigger than 255 symbols
+     * msg direction is "down" (incoming) by default
+     *
+     * @returns {(msgType: string, data: string, dir: 'up' | 'down') => void}
+     * */
+    trackWs(channelName: string): ((msgType: string, data: string, dir: "up" | "down") => void) | undefined;
     start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
+    browserEnvCheck(): boolean;
+    /**
+     * start buffering messages without starting the actual session, which gives user 30 seconds to "activate" and record
+     * session by calling start() on conditional trigger and we will then send buffered batch, so it won't get lost
+     * */
+    coldStart(startOpts?: Partial<StartOptions>, conditional?: boolean): Promise<never> | undefined;
+    /**
+     * Starts offline session recording. Keep in mind that only user device time will be used for timestamps.
+     * (no backend delay sync)
+     *
+     * @param {Object} startOpts - options for session start, same as .start()
+     * @param {Function} onSessionSent - callback that will be called once session is fully sent
+     * @returns methods to manipulate buffer:
+     *
+     * saveBuffer - to save it in localStorage
+     *
+     * getBuffer - returns current buffer
+     *
+     * setBuffer - replaces current buffer with given
+     * */
+    startOfflineRecording(startOpts: Partial<StartOptions>, onSessionSent: () => void): Promise<never> | {
+        saveBuffer: () => void;
+        getBuffer: () => import("./common/messages.gen.js").default[];
+        setBuffer: (buffer: import("./common/messages.gen.js").default[]) => void;
+    };
+    /**
+     * Uploads the stored session buffer to backend
+     * @returns promise that resolves once messages are loaded, it has to be awaited
+     * so the session can be uploaded properly
+     * @resolve - if messages were loaded into service worker successfully
+     * @reject {string} - error message
+     * */
+    uploadOfflineRecording(): Promise<void> | undefined;
     stop(): string | undefined;
     forceFlushBatch(): void;
     getSessionToken(): string | null | undefined;