@openreplay/tracker 17.0.1 → 17.1.1

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

@@ -188,6 +188,7 @@ export default class App {
     allowAppStart(): void;
     private checkNodeId;
     private initWorker;
+    private restart;
     private handleWorkerMsg;
     private _debug;
     send: (message: Message, urgent?: boolean) => void;

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

@@ -1,5 +1,6 @@
-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';
+import TrackerClass from './index';
+export { default as App } from './app/index';
+export { default as tracker, default as openReplay } from './singleton';
+export { SanitizeLevel, Messages, Options } from './index';
+export { default as Analytics } from './modules/analytics/index';
 export default TrackerClass;

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

@@ -1,8 +1,9 @@
-import App from './app/index.js';
+import App from './app/index';
 export { default as App } from './app/index.js';
 import * as _Messages from './app/messages.gen.js';
 export declare const Messages: typeof _Messages;
 export { SanitizeLevel } from './app/sanitizer.js';
+import AnalyticsSDK from './modules/analytics/index.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';
@@ -31,10 +32,15 @@ export type Options = Partial<AppOptions & ConsoleOptions & ExceptionOptions & I
     css: CssRulesOptions;
     webAnimations?: WapOptions;
     urls?: Partial<ViewportOptions>;
+    analytics?: {
+        ingestPoint?: string;
+        active?: boolean;
+    };
 };
 export default class API {
     readonly options: Partial<Options>;
     private readonly app;
+    readonly analytics: AnalyticsSDK | null;
     private readonly crossdomainMode;
     constructor(options: Partial<Options>);
     checkDoNotTrack: () => boolean | undefined;
@@ -91,11 +97,11 @@ export default class API {
     getSessionID(): string | null | undefined;
     getTabId(): string | null;
     sessionID(): string | null | undefined;
-    getSessionURL(options?: {
+    getSessionURL: (options?: {
         withCurrentTime?: boolean;
-    }): string | undefined;
-    setUserID(id: string): void;
-    userID(id: string): void;
+    }) => string | undefined;
+    setUserID: (id: string) => void;
+    userID: (id: string) => void;
     setUserAnonymousID(id: string): void;
     userAnonymousID(id: string): void;
     setMetadata(key: string, value: string): void;
@@ -108,4 +114,10 @@ export default class API {
         startTime: number;
         endTime?: number;
     }) => void;
+    private analyticsToken;
+    /**
+     * Use custom token for analytics events without session recording
+     * */
+    setAnalyticsToken: (token: string) => void;
+    getAnalyticsToken: () => string;
 }

package/dist/cjs/main/modules/analytics/batcher.d.ts

@@ -0,0 +1,45 @@
+interface PeopleEvent {
+    type: string;
+    timestamp: number;
+    payload: Record<string, any>;
+}
+interface Event {
+    name: string;
+    payload: Record<string, any>;
+    timestamp: number;
+}
+/**
+ * Creates batches of events, then sends them at intervals.
+ */
+declare class Batcher {
+    private readonly backendUrl;
+    private readonly getToken;
+    private readonly init;
+    private readonly autosendInterval;
+    private readonly retryTimeout;
+    private readonly retryLimit;
+    private readonly apiEdp;
+    private batch;
+    private intervalId;
+    constructor(backendUrl: string, getToken: () => string | null, init: () => Promise<void>);
+    getBatches(): {
+        data: {
+            user_actions: PeopleEvent[];
+            events: Event[];
+        };
+    };
+    addEvent(event: any): void;
+    sendImmediately(event: any): void;
+    /**
+     *
+     * Essentially we're dividing the batch by identify events and squash all same category events into one in each part,
+     * taking priority to the last one
+     */
+    dedupePeopleEvents(): PeopleEvent[];
+    private squashPeopleEvents;
+    private sendBatch;
+    startAutosend(): void;
+    flush(): void;
+    stop(): void;
+}
+export default Batcher;

package/dist/cjs/main/modules/analytics/constantProperties.d.ts

@@ -0,0 +1,53 @@
+export interface StorageLike {
+    getItem: (key: string) => string | null;
+    setItem: (key: string, value: string) => void;
+}
+export default class ConstantProperties {
+    private readonly localStorage;
+    private readonly sessionStorage;
+    os: string;
+    osVersion: string;
+    browser: string;
+    browserVersion: string;
+    platform: string;
+    screenHeight: number;
+    screenWidth: number;
+    initialReferrer: string;
+    utmSource: string | null;
+    utmMedium: string | null;
+    utmCampaign: string | null;
+    deviceId: string;
+    searchEngine: string | null;
+    user_id: string | null;
+    constructor(localStorage: StorageLike, sessionStorage: StorageLike);
+    get all(): {
+        os: string;
+        os_version: string;
+        browser: string;
+        browser_version: string;
+        platform: string;
+        screen_height: number;
+        screen_width: number;
+        initial_referrer: string;
+        utm_source: string | null;
+        utm_medium: string | null;
+        utm_campaign: string | null;
+        user_id: string | null;
+        distinct_id: string;
+        sdk_edition: string;
+        sdk_version: string;
+        timezone: string;
+        search_engine: string | null;
+    };
+    setUserId: (user_id: string | null) => void;
+    resetUserId: (hard?: boolean) => void;
+    get defaultPropertyKeys(): string[];
+    get distinctId(): string;
+    private getDistinctDeviceId;
+    private getReferrer;
+    private parseUTM;
+    private getSearchEngine;
+    getSuperProperties: () => Record<string, any>;
+    saveSuperProperties: (props: Record<string, any>) => void;
+    clearSuperProperties: () => void;
+}

package/dist/cjs/main/modules/analytics/events.d.ts

@@ -0,0 +1,37 @@
+import Batcher from './batcher.js';
+import ConstantProperties from './constantProperties.js';
+export default class Events {
+    private readonly constantProperties;
+    private readonly getTimestamp;
+    private readonly batcher;
+    ownProperties: Record<string, any>;
+    constructor(constantProperties: ConstantProperties, getTimestamp: () => number, batcher: Batcher);
+    /**
+     * Add event to batch with option to send it immediately,
+     * properties are optional and will not be saved as super prop
+     * */
+    sendEvent: (eventName: string, properties?: Record<string, any>, options?: {
+        send_immediately: boolean;
+    }) => void;
+    /**
+     * creates super property for all events
+     * */
+    setProperty: (nameOrProperties: Record<string, any> | string, value?: any) => void;
+    /**
+     * set super property only if it doesn't exist yet
+     * */
+    setPropertiesOnce: (nameOrProperties: Record<string, any> | string, value?: any) => void;
+    /**
+     * removes properties from list of super properties
+     * */
+    unsetProperties: (properties: string | string[]) => void;
+    /** clears all super properties */
+    reset: () => void;
+    /** mixpanel compatibility */
+    register: (nameOrProperties: Record<string, any> | string, value?: any) => void;
+    register_once: (nameOrProperties: Record<string, any> | string, value?: any) => void;
+    unregister: (properties: string | string[]) => void;
+    track: (eventName: string, properties?: Record<string, any>, options?: {
+        send_immediately: boolean;
+    }) => void;
+}

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

@@ -0,0 +1,73 @@
+import ConstantProperties from './constantProperties.js';
+import type { StorageLike } from './constantProperties.js';
+import Events from './events.js';
+import People from './people.js';
+interface Options {
+    ingestPoint: string;
+    projectKey: string;
+    /** Storage class for persistent data */
+    localStorage?: StorageLike;
+    /** Storage class for data on a per-session basis */
+    sessionStorage?: StorageLike;
+    /** Used to request a custom session token when in not-standalone mode */
+    getToken?: () => string;
+    /** Used to get current timestamp when not in standalone mode */
+    getTimestamp?: () => number;
+    /** Callback for people.identify */
+    setUserId?: (user_id: string) => void;
+    /** automatically set when used inside openreplay tracker */
+    notStandalone?: boolean;
+}
+export default class Analytics {
+    readonly events: Events;
+    readonly constantProperties: ConstantProperties;
+    readonly people: People;
+    private token;
+    private readonly batcher;
+    private readonly backendUrl;
+    private readonly projectKey;
+    private readonly localStorage;
+    private readonly sessionStorage;
+    private readonly getToken;
+    private readonly getTimestamp;
+    private readonly setUserId;
+    private readonly standalone;
+    /**
+     * @param localStorage Class or Object that implements Storage-like interface that stores
+     * values persistently like window.localStorage or any other file-based storage
+     *
+     * @param sessionStorage Class or Object that implements Storage-like interface that stores values
+     * on per-session basis like window.sessionStorage or any other in-memory storage
+     *
+     * @param getToken Function that returns token to bind events to a session
+     *
+     * @param getTimestamp returns current timestamp
+     *
+     * @param setUserId callback for people.identify
+     *
+     * @param standalone if true, analytics will manage its own token (instead of using with openreplay tracker session)
+     * */
+    constructor(options: Options);
+    _getToken: () => string | null;
+    _getTimestamp: () => number;
+    init: () => Promise<void>;
+    reset: () => void;
+    /**
+     * COMPATIBILITY LAYER
+     * */
+    /**
+     * Identify a user with an id (e.g. email, username, etc.)
+     * will bind all events and properties (including device_id) to this user
+     *
+     * you will need to manually call people.reset() to clear the id on logout event
+     * */
+    identify: (user_id: string) => void;
+    /**
+     * Add event to batch with option to send it immediately,
+     * properties are optional and will not be saved as super prop
+     * */
+    track: (eventName: string, properties?: Record<string, any>, options?: {
+        send_immediately: boolean;
+    }) => void;
+}
+export {};

package/dist/cjs/main/modules/analytics/people.d.ts

@@ -0,0 +1,51 @@
+import Batcher from './batcher.js';
+import ConstantProperties from './constantProperties.js';
+type Value = string | number;
+export default class People {
+    private readonly constantProperties;
+    private readonly getTimestamp;
+    private readonly onId;
+    private readonly batcher;
+    ownProperties: Record<string, Value | Value[]>;
+    constructor(constantProperties: ConstantProperties, getTimestamp: () => number, onId: (user_id: string) => void, batcher: Batcher);
+    identify: (user_id: string, options?: {
+        fromTracker: boolean;
+    }) => void;
+    /** Resets user id and own properties
+     *
+     * !hard reset will destroy persistent device id!
+     * */
+    reset: (hard?: boolean) => void;
+    get user_id(): string | null;
+    /**
+     *  Will delete user and its data from backend, then reset all local properties
+     */
+    deleteUser: () => void;
+    /**
+     * set user properties, overwriting existing ones
+     * */
+    setProperties: (propertyOrObj: Record<string, string | number> | string, value?: string) => void;
+    /**
+     * Set property if it doesn't exist yet
+     * */
+    setPropertiesOnce: (properties: Record<string, string | number>) => void;
+    /**
+     * Add value to property (will turn string prop into array)
+     * */
+    appendValues: (key: string, value: string | number) => void;
+    /**
+     * Add unique values to property (will turn string prop into array)
+     * */
+    appendUniqueValues: (key: string, value: string | number) => void;
+    /**
+     * Adds value (incl. negative) to existing numerical property
+     * */
+    increment: (key: string, value: number) => void;
+    /** mixpanel compatibility */
+    union: (key: string, value: string | number) => void;
+    set: (propertyOrObj: Record<string, string | number> | string, value?: string) => void;
+    set_once: (properties: Record<string, string | number>) => void;
+    append: (key: string, value: string | number) => void;
+    incrementBy: (key: string, value: number) => void;
+}
+export {};

package/dist/cjs/main/modules/analytics/types.d.ts

@@ -0,0 +1,32 @@
+export declare const mutationTypes: {
+    identity: string;
+    deleteUser: string;
+    setProperty: string;
+    setPropertyOnce: string;
+    appendProperty: string;
+    appendUniqueProperty: string;
+    incrementProperty: string;
+};
+export declare const categories: {
+    readonly people: "user_actions";
+    readonly events: "events";
+};
+export declare const createEvent: (category: (typeof categories)[keyof typeof categories], type?: (typeof mutationTypes)[keyof typeof mutationTypes], timestamp?: number, payload?: Record<string, any>) => {
+    category: "user_actions";
+    data: {
+        type: string | undefined;
+        user_id: any;
+        payload: any;
+        timestamp: number | undefined;
+        name?: undefined;
+    };
+} | {
+    category: "events";
+    data: {
+        name: any;
+        payload: any;
+        timestamp: number | undefined;
+        type?: undefined;
+        user_id?: undefined;
+    };
+};

package/dist/cjs/main/modules/analytics/utils.d.ts

@@ -0,0 +1,19 @@
+interface ClientData {
+    screen: string;
+    width: number;
+    height: number;
+    browser: string;
+    browserVersion: string;
+    browserMajorVersion: number;
+    mobile: boolean;
+    os: string;
+    osVersion: string;
+    cookies: boolean;
+}
+/**
+ * Detects client browser, OS, and device information
+ */
+export declare function uaParse(sWindow: Window & typeof globalThis): ClientData;
+export declare function isObject(item: any): boolean;
+export declare function getUTCOffsetString(): string;
+export {};