@openreplay/tracker 17.0.1 → 17.1.1

package/dist/types/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/types/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/types/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/types/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 {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "17.0.1",
+  "version": "17.1.1",
   "keywords": [
     "logging",
     "replay"
@@ -63,8 +63,8 @@
     "eslint": "^9.37.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.5.4",
-    "jest": "^29.7.0",
-    "jest-environment-jsdom": "^29.7.0",
+    "jest": "^30.2.0",
+    "jest-environment-jsdom": "^30.2.0",
     "prettier": "^3.6.2",
     "replace-in-files": "^2.0.3",
     "rollup": "^4.52.4",