@openreplay/tracker 16.0.2-beta.0 → 16.0.2

package/dist/cjs/main/app/index.d.ts

@@ -194,8 +194,6 @@ export default class App {
     startTimeout: ReturnType<typeof setTimeout> | null;
     allowAppStart(): void;
     private checkNodeId;
-    heartbeatInterval: ReturnType<typeof setInterval> | null;
-    restartTimeout: ReturnType<typeof setTimeout> | null;
     private initWorker;
     private handleWorkerMsg;
     private _debug;

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

@@ -27,9 +27,6 @@ export declare function UserAnonymousID(id: string): Messages.UserAnonymousID;
 export declare function Metadata(key: string, value: string): Messages.Metadata;
 export declare function StringDictGlobal(key: number, value: string): Messages.StringDictGlobal;
 export declare function SetNodeAttributeDictGlobal(id: number, name: number, value: number): Messages.SetNodeAttributeDictGlobal;
-export declare function CSSInsertRule(id: number, rule: string, index: number): Messages.CSSInsertRule;
-export declare function CSSDeleteRule(id: number, index: number): Messages.CSSDeleteRule;
-export declare function Fetch(method: string, url: string, request: string, response: string, status: number, timestamp: number, duration: number): Messages.Fetch;
 export declare function Profiler(name: string, duration: number, args: string, result: string): Messages.Profiler;
 export declare function OTable(key: string, value: string): Messages.OTable;
 export declare function StateAction(type: string): Messages.StateAction;
@@ -48,12 +45,10 @@ export declare function ConnectionInformation(downlink: number, type: string): M
 export declare function SetPageVisibility(hidden: boolean): Messages.SetPageVisibility;
 export declare function LoadFontFace(parentID: number, family: string, source: string, descriptors: string): Messages.LoadFontFace;
 export declare function SetNodeFocus(id: number): Messages.SetNodeFocus;
-export declare function LongTask(timestamp: number, duration: number, context: number, containerType: number, containerSrc: string, containerId: string, containerName: string): Messages.LongTask;
 export declare function SetNodeAttributeURLBased(id: number, name: string, value: string, baseURL: string): Messages.SetNodeAttributeURLBased;
 export declare function SetCSSDataURLBased(id: number, data: string, baseURL: string): Messages.SetCSSDataURLBased;
 export declare function TechnicalInfo(type: string, value: string): Messages.TechnicalInfo;
 export declare function CustomIssue(name: string, payload: string): Messages.CustomIssue;
-export declare function CSSInsertRuleURLBased(id: number, rule: string, index: number, baseURL: string): Messages.CSSInsertRuleURLBased;
 export declare function MouseClick(id: number, hesitationTime: number, label: string, selector: string, normalizedX: number, normalizedY: number): Messages.MouseClick;
 export declare function MouseClickDeprecated(id: number, hesitationTime: number, label: string, selector: string): Messages.MouseClickDeprecated;
 export declare function CreateIFrameDocument(frameID: number, id: number): Messages.CreateIFrameDocument;

package/dist/cjs/main/app/observer/observer.d.ts

@@ -8,7 +8,11 @@ export default abstract class Observer {
     private readonly indexes;
     private readonly attributesMap;
     private readonly textSet;
-    constructor(app: App, isTopContext?: boolean);
+    private readonly disableSprites;
+    private readonly domParser;
+    constructor(app: App, isTopContext?: boolean, options?: {
+        disableSprites: boolean;
+    });
     private clear;
     /**
      * EXPERIMENTAL: Unbinds the removed nodes in case of iframe src change.

package/dist/cjs/main/app/observer/top_observer.d.ts

@@ -3,6 +3,7 @@ import { Offset } from './iframe_offsets.js';
 import App from '../index.js';
 export interface Options {
     captureIFrames: boolean;
+    disableSprites: boolean;
 }
 type Context = Window & typeof globalThis;
 type ContextCallback = (context: Context) => void;

package/dist/cjs/main/entry.d.ts

@@ -0,0 +1,5 @@
+import TrackerClass from './index.js';
+export { default as App } from './app/index.js';
+export { SanitizeLevel, Messages, Options } from './index.js';
+export { default as tracker } from './singleton.js';
+export default TrackerClass;

package/dist/cjs/main/index.d.ts

@@ -30,11 +30,11 @@ export type Options = Partial<AppOptions & ConsoleOptions & ExceptionOptions & I
     __DISABLE_SECURE_MODE?: boolean;
 };
 export default class API {
-    private readonly options;
+    readonly options: Partial<Options>;
     featureFlags: FeatureFlags;
     private readonly app;
     private readonly crossdomainMode;
-    constructor(options: Options);
+    constructor(options: Partial<Options>);
     checkDoNotTrack: () => boolean | undefined;
     signalStartIssue: (reason: string, missingApi: string[]) => void;
     isFlagEnabled(flagName: string): boolean;
@@ -44,7 +44,7 @@ export default class API {
     getFeatureFlag(flagName: string): IFeatureFlag | undefined;
     getAllFeatureFlags(): IFeatureFlag[] | undefined;
     restartCanvasTracking: () => void;
-    use<T>(fn: (app: App | null, options?: Options) => T): T;
+    use<T>(fn: (app: App | null, options?: Partial<Options>) => T): T;
     isActive(): boolean;
     /**
      * Creates a named hook that expects event name, data string and msg direction (up/down),

package/dist/cjs/main/modules/attributeSender.d.ts

@@ -5,11 +5,11 @@ export declare class StringDictionary {
     /** backwards dictionary of
      * [repeated str:key]
      * */
-    private backDict;
+    backDict: Record<string, number>;
     getKey: (str: string) => [number, boolean];
 }
 export default class AttributeSender {
-    private dict;
+    dict: StringDictionary;
     private readonly app;
     private readonly isDictDisabled;
     constructor(options: {

package/dist/cjs/main/singleton.d.ts

@@ -0,0 +1,108 @@
+import Tracker, { App, Options } from './index.js';
+import type { StartOptions, StartPromiseReturn } from './app/index.js';
+declare class TrackerSingleton {
+    private instance;
+    private isConfigured;
+    /**
+     * Call this method once to create tracker configuration
+     * @param options {Object} Check available options:
+     * https://docs.openreplay.com/en/sdk/constructor/#initialization-options
+     */
+    configure(options: Partial<Options>): void;
+    get options(): Partial<Options> | null;
+    start(startOpts?: Partial<StartOptions>): Promise<StartPromiseReturn>;
+    /**
+     * Stop the session and return sessionHash
+     * (which can be used to stitch sessions together)
+     * */
+    stop(): string | undefined;
+    setUserID(id: string): void;
+    /**
+     * Set metadata for the current session
+     *
+     * Make sure that its configured in project settings first
+     *
+     * Read more: https://docs.openreplay.com/en/installation/metadata/
+     */
+    setMetadata(key: string, value: string): void;
+    /**
+     * Returns full URL for the current session
+     */
+    getSessionURL(options?: {
+        withCurrentTime?: boolean;
+    }): string | undefined;
+    getSessionID(): string | null | undefined;
+    getSessionToken(): string | null | undefined;
+    event(key: string, payload?: any, issue?: boolean): void;
+    issue(key: string, payload?: any): void;
+    handleError(e: Error | ErrorEvent | PromiseRejectionEvent, metadata?: Record<string, any>): void;
+    isFlagEnabled(flagName: string): boolean;
+    onFlagsLoad(...args: Parameters<Tracker['onFlagsLoad']>): void;
+    clearPersistFlags(): void;
+    reloadFlags(): Promise<void> | undefined;
+    getFeatureFlag(flagName: string): import("./modules/featureFlags.js").IFeatureFlag | undefined;
+    getAllFeatureFlags(): import("./modules/featureFlags.js").IFeatureFlag[] | undefined;
+    restartCanvasTracking(): void;
+    /**
+     * Set the anonymous user ID
+     */
+    setUserAnonymousID(id: string): void;
+    /**
+     * Check if the tracker is active
+     */
+    isActive(): boolean;
+    /**
+     * Get the underlying Tracker instance
+     *
+     * Use when you need access to methods not exposed by the singleton
+     */
+    getInstance(): Tracker | null;
+    /**
+     * 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;
+    /**
+     * 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;
+    private ensureConfigured;
+    use<T>(fn: (app: App | null, options?: Partial<Options>) => T): T;
+    /**
+     * 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(...args: Parameters<Tracker['startOfflineRecording']>): Promise<never> | {
+        saveBuffer: () => void;
+        getBuffer: () => import("./app/messages.gen.js").default[];
+        setBuffer: (buffer: import("./app/messages.gen.js").default[]) => void;
+    } | undefined;
+    /**
+     * 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;
+    forceFlushBatch(): void;
+    getSessionInfo(): import("./app/session.js").SessionInfo | null;
+    getTabId(): string | null;
+    getUxId(): number | null;
+}
+declare const tracker: TrackerSingleton;
+export default tracker;

package/dist/lib/common/interaction.d.ts

@@ -22,7 +22,7 @@ export type ToWorkerData = null | 'stop' | Start | Auth | Array<Message> | {
 } | {
     type: 'uncompressed';
     batch: Uint8Array;
-} | 'forceFlushBatch' | 'check_queue' | 'heartbeat_q';
+} | 'forceFlushBatch' | 'check_queue';
 type Failure = {
     type: 'failure';
     reason: string;
@@ -33,5 +33,5 @@ type QEmpty = {
 export type FromWorkerData = 'a_stop' | 'a_start' | Failure | 'not_init' | {
     type: 'compress';
     batch: Uint8Array;
-} | QEmpty | 'heartbeat_a';
+} | QEmpty;
 export {};

package/dist/lib/common/messages.gen.d.ts

@@ -26,9 +26,6 @@ export declare const enum Type {
     Metadata = 30,
     StringDictGlobal = 34,
     SetNodeAttributeDictGlobal = 35,
-    CSSInsertRule = 37,
-    CSSDeleteRule = 38,
-    Fetch = 39,
     Profiler = 40,
     OTable = 41,
     StateAction = 42,
@@ -47,12 +44,10 @@ export declare const enum Type {
     SetPageVisibility = 55,
     LoadFontFace = 57,
     SetNodeFocus = 58,
-    LongTask = 59,
     SetNodeAttributeURLBased = 60,
     SetCSSDataURLBased = 61,
     TechnicalInfo = 63,
     CustomIssue = 64,
-    CSSInsertRuleURLBased = 67,
     MouseClick = 68,
     MouseClickDeprecated = 69,
     CreateIFrameDocument = 70,
@@ -234,27 +229,6 @@ export type SetNodeAttributeDictGlobal = [
     number,
     number
 ];
-export type CSSInsertRule = [
-    Type.CSSInsertRule,
-    number,
-    string,
-    number
-];
-export type CSSDeleteRule = [
-    Type.CSSDeleteRule,
-    number,
-    number
-];
-export type Fetch = [
-    Type.Fetch,
-    string,
-    string,
-    string,
-    string,
-    number,
-    number,
-    number
-];
 export type Profiler = [
     Type.Profiler,
     string,
@@ -361,16 +335,6 @@ export type SetNodeFocus = [
     Type.SetNodeFocus,
     number
 ];
-export type LongTask = [
-    Type.LongTask,
-    number,
-    number,
-    number,
-    number,
-    string,
-    string,
-    string
-];
 export type SetNodeAttributeURLBased = [
     Type.SetNodeAttributeURLBased,
     number,
@@ -394,13 +358,6 @@ export type CustomIssue = [
     string,
     string
 ];
-export type CSSInsertRuleURLBased = [
-    Type.CSSInsertRuleURLBased,
-    number,
-    string,
-    number,
-    string
-];
 export type MouseClick = [
     Type.MouseClick,
     number,
@@ -576,5 +533,5 @@ export type WebVitals = [
     string,
     string
 ];
-type Message = Timestamp | SetPageLocationDeprecated | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | NetworkRequestDeprecated | ConsoleLog | PageLoadTiming | PageRenderTiming | CustomEvent | UserID | UserAnonymousID | Metadata | StringDictGlobal | SetNodeAttributeDictGlobal | CSSInsertRule | CSSDeleteRule | Fetch | Profiler | OTable | StateAction | ReduxDeprecated | Vuex | MobX | NgRx | GraphQLDeprecated | PerformanceTrack | StringDictDeprecated | SetNodeAttributeDictDeprecated | StringDict | SetNodeAttributeDict | ResourceTimingDeprecated | ConnectionInformation | SetPageVisibility | LoadFontFace | SetNodeFocus | LongTask | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | CSSInsertRuleURLBased | MouseClick | MouseClickDeprecated | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner | JSException | Zustand | BatchMetadata | PartitionedMessage | NetworkRequest | WSChannel | InputChange | SelectionChange | MouseThrashing | UnbindNodes | ResourceTiming | TabChange | TabData | CanvasNode | TagTrigger | Redux | SetPageLocation | GraphQL | WebVitals;
+type Message = Timestamp | SetPageLocationDeprecated | SetViewportSize | SetViewportScroll | CreateDocument | CreateElementNode | CreateTextNode | MoveNode | RemoveNode | SetNodeAttribute | RemoveNodeAttribute | SetNodeData | SetNodeScroll | SetInputTarget | SetInputValue | SetInputChecked | MouseMove | NetworkRequestDeprecated | ConsoleLog | PageLoadTiming | PageRenderTiming | CustomEvent | UserID | UserAnonymousID | Metadata | StringDictGlobal | SetNodeAttributeDictGlobal | Profiler | OTable | StateAction | ReduxDeprecated | Vuex | MobX | NgRx | GraphQLDeprecated | PerformanceTrack | StringDictDeprecated | SetNodeAttributeDictDeprecated | StringDict | SetNodeAttributeDict | ResourceTimingDeprecated | ConnectionInformation | SetPageVisibility | LoadFontFace | SetNodeFocus | SetNodeAttributeURLBased | SetCSSDataURLBased | TechnicalInfo | CustomIssue | MouseClick | MouseClickDeprecated | CreateIFrameDocument | AdoptedSSReplaceURLBased | AdoptedSSInsertRuleURLBased | AdoptedSSDeleteRule | AdoptedSSAddOwner | AdoptedSSRemoveOwner | JSException | Zustand | BatchMetadata | PartitionedMessage | NetworkRequest | WSChannel | InputChange | SelectionChange | MouseThrashing | UnbindNodes | ResourceTiming | TabChange | TabData | CanvasNode | TagTrigger | Redux | SetPageLocation | GraphQL | WebVitals;
 export default Message;