@openreplay/tracker 13.0.2 → 14.0.0

package/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 15.0.0
+
+- updated graphql plugin and messages
+
+# 14.0.0
+
+- titles for tabs
+- new `MouseClick` message to introduce heatmaps instead of clickmaps
+- crossdomain iframe tracking functionality
+
 # 13.0.2
 
 - more file extensions for canvas

package/cjs/app/index.d.ts

@@ -1,17 +1,17 @@
+import type { Options as WebworkerOptions } from '../common/interaction.js';
+import AttributeSender from '../modules/attributeSender.js';
 import FeatureFlags from '../modules/featureFlags.js';
+import type { Options as NetworkOptions } from '../modules/network.js';
+import Logger, { ILogLevel } from './logger.js';
 import Message from './messages.gen.js';
 import Nodes from './nodes.js';
-import Observer from './observer/top_observer.js';
-import Sanitizer from './sanitizer.js';
-import Ticker from './ticker.js';
-import Logger, { ILogLevel } from './logger.js';
-import Session from './session.js';
-import AttributeSender from '../modules/attributeSender.js';
 import type { Options as ObserverOptions } from './observer/top_observer.js';
+import Observer from './observer/top_observer.js';
 import type { Options as SanitizerOptions } from './sanitizer.js';
+import Sanitizer from './sanitizer.js';
 import type { Options as SessOptions } from './session.js';
-import type { Options as NetworkOptions } from '../modules/network.js';
-import type { Options as WebworkerOptions } from '../common/interaction.js';
+import Session from './session.js';
+import Ticker from './ticker.js';
 export interface StartOptions {
     userID?: string;
     metadata?: Record<string, string>;
@@ -81,14 +81,25 @@ type AppOptions = {
          * */
         fileExt?: 'webp' | 'png' | 'jpeg' | 'avif';
     };
-    /** @deprecated */
-    onStart?: StartCallback;
+    crossdomain?: {
+        /**
+         * @default false
+         * */
+        enabled?: boolean;
+        /**
+         * used to send message up, will be '*' by default
+         * (check your CSP settings)
+         * @default '*'
+         * */
+        parentDomain?: string;
+    };
     network?: NetworkOptions;
 } & WebworkerOptions & SessOptions;
 export type Options = AppOptions & ObserverOptions & SanitizerOptions;
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     private readonly signalError;
+    private readonly insideIframe;
     readonly nodes: Nodes;
     readonly ticker: Ticker;
     readonly projectKey: string;
@@ -114,21 +125,29 @@ export default class App {
     private readonly revID;
     private activityState;
     private readonly version;
-    private readonly worker?;
+    private worker?;
     attributeSender: AttributeSender;
     featureFlags: FeatureFlags;
     socketMode: boolean;
     private compressionThreshold;
-    private restartAttempts;
     private readonly bc;
     private readonly contextId;
     private canvasRecorder;
     private uxtManager;
     private conditionsManager;
     private readonly tagWatcher;
-    constructor(projectKey: string, sessionToken: string | undefined, options: Partial<Options>, signalError: (error: string, apis: string[]) => void);
+    private canStart;
+    private rootId;
+    private pageFrames;
+    private frameOderNumber;
+    private readonly initialHostName;
+    constructor(projectKey: string, sessionToken: string | undefined, options: Partial<Options>, signalError: (error: string, apis: string[]) => void, insideIframe: boolean);
+    startTimeout: ReturnType<typeof setTimeout> | null;
+    private allowAppStart;
+    private checkNodeId;
+    private initWorker;
+    private handleWorkerMsg;
     private _debug;
-    private _usingOldFetchPlugin;
     send(message: Message, urgent?: boolean): void;
     /**
      * Normal workflow: add timestamp and tab data to batch, then commit it
@@ -185,10 +204,11 @@ export default class App {
     private checkSessionToken;
     /**
      * start buffering messages without starting the actual session, which gives
-     * user 30 seconds to "activate" and record session by calling `start()` on conditional trigger
+     * 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?: StartOptions, conditional?: boolean): Promise<void>;
+    private setupConditionalStart;
     onSessionSent: () => void;
     /**
      * Starts offline session recording
@@ -203,7 +223,7 @@ export default class App {
     /**
      * Saves the captured messages in localStorage (or whatever is used in its place)
      *
-     * Then when this.offlineRecording is called, it will preload this messages and clear the storage item
+     * Then, when this.offlineRecording is called, it will preload this messages and clear the storage item
      *
      * Keeping the size of local storage reasonable is up to the end users of this library
      * */
@@ -230,6 +250,8 @@ export default class App {
     onUxtCb: never[];
     addOnUxtCb(cb: (id: number) => void): void;
     getUxtId(): number | null;
+    waitStart(): Promise<unknown>;
+    waitStarted(): Promise<unknown>;
     /**
      * basically we ask other tabs during constructor
      * and here we just apply 10ms delay just in case