@openreplay/tracker 16.4.11-beta.0 → 16.4.11-beta.1

package/dist/types/main/modules/conditionsManager.d.ts

@@ -1,6 +1,11 @@
 import Message, { CustomEvent, JSException, MouseClick, NetworkRequest, SetPageLocation } from '../../common/messages.gen.js';
 import App, { StartOptions } from '../app/index.js';
-import { IFeatureFlag } from './featureFlags.js';
+export interface IFeatureFlag {
+    key: string;
+    is_persist: boolean;
+    value: string | boolean;
+    payload: string;
+}
 interface Filter {
     filters: {
         operator: string;

package/dist/types/main/modules/input.d.ts

@@ -1,6 +1,6 @@
 import type App from '../app/index.js';
 type TextFieldElement = HTMLInputElement | HTMLTextAreaElement;
-export declare function getInputLabel(node: TextFieldElement): string;
+export declare function getInputLabel(node: TextFieldElement, customAttributes?: string[]): string;
 export declare const InputMode: {
     readonly Plain: 0;
     readonly Obscured: 1;
@@ -29,6 +29,7 @@ export interface Options {
      * will override other settings.
      * */
     defaultInputMode: InputModeT;
+    customAttributes?: string[];
 }
 export default function (app: App, opts: Partial<Options>): void;
 export {};

package/dist/types/main/modules/mouse.d.ts

@@ -8,6 +8,7 @@ export interface MouseHandlerOptions {
      * default 7 = 210ms
      * */
     trackingOffset?: number;
+    customAttributes?: string[];
 }
 export default function (app: App, options?: MouseHandlerOptions): void;
 export declare function getCSSPath(el: any): string | false;

package/dist/types/main/modules/viewport.d.ts

@@ -2,5 +2,12 @@ import type App from '../app/index.js';
 export interface Options {
     urlSanitizer?: (url: string) => string;
     titleSanitizer?: (title: string) => string;
+    /** if present, tracker will remove hash symbol to present url as regular router url on replay level;
+     *
+     * applied BEFORE sanitizers.
+     *
+     * @example 'site.com/#/path' -> 'site.com/path'
+     */
+    replaceHashSymbol?: boolean;
 }
 export default function (app: App, options?: Options): void;

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

@@ -17,6 +17,11 @@ declare class TrackerSingleton {
      * */
     stop(): string | undefined;
     setUserID(id: string): void;
+    get analytics(): import("./entry.js").Analytics | null;
+    identify: (id: string) => void;
+    track: (eventName: string, properties?: Record<string, any>, options?: {
+        send_immediately: boolean;
+    }) => void;
     /**
      * Set metadata for the current session
      *
@@ -36,12 +41,6 @@ declare class TrackerSingleton {
     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
@@ -102,7 +101,6 @@ declare class TrackerSingleton {
     forceFlushBatch(): void;
     getSessionInfo(): import("./app/session.js").SessionInfo | null;
     getTabId(): string | null;
-    getUxId(): number | null;
 }
 declare const tracker: TrackerSingleton;
 export default tracker;

package/dist/types/main/utils.d.ts

@@ -9,6 +9,8 @@ export declare function normSpaces(str: string): string;
 export declare function isURL(s: string): boolean;
 export declare const DOCS_HOST = "https://docs.openreplay.com";
 export declare function deprecationWarn(nameOfFeature: string, useInstead: string, docsPath?: string): void;
+export declare function getCustomAttributeLabel(e: Element, customAttributes?: string[]): string;
+export declare function getClassSelector(e: Element): string;
 export declare function getLabelAttribute(e: Element): string | null;
 export declare function hasOpenreplayAttribute(e: Element, attr: string): boolean;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@openreplay/tracker",
   "description": "The OpenReplay tracker main package",
-  "version": "16.4.11-beta.0",
+  "version": "16.4.11-beta.1",
   "keywords": [
     "logging",
     "replay"

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

@@ -1,25 +0,0 @@
-import App from '../app/index.js';
-export interface IFeatureFlag {
-    key: string;
-    is_persist: boolean;
-    value: string | boolean;
-    payload: string;
-}
-export interface FetchPersistFlagsData {
-    key: string;
-    value: string | boolean;
-}
-export default class FeatureFlags {
-    private readonly app;
-    flags: IFeatureFlag[];
-    storageKey: string;
-    onFlagsCb: (flags: IFeatureFlag[]) => void;
-    constructor(app: App);
-    getFeatureFlag(flagName: string): IFeatureFlag | undefined;
-    isFlagEnabled(flagName: string): boolean;
-    onFlagsLoad(cb: (flags: IFeatureFlag[]) => void): void;
-    reloadFlags(token?: string): Promise<void>;
-    handleFlags(flags: IFeatureFlag[]): void;
-    clearPersistFlags(): void;
-    diffPersist(flags: IFeatureFlag[]): IFeatureFlag[];
-}

package/dist/cjs/main/modules/userTesting/SignalManager.d.ts

@@ -1,29 +0,0 @@
-export default class SignalManager {
-    private readonly ingestPoint;
-    private readonly getTimestamp;
-    private readonly token;
-    private readonly testId;
-    private readonly storageKey;
-    private readonly setStorageKey;
-    private readonly removeStorageKey;
-    private readonly getStorageKey;
-    private readonly getSessionId;
-    private readonly durations;
-    constructor(ingestPoint: string, getTimestamp: () => number, token: string, testId: number, storageKey: string, setStorageKey: (key: string, value: string) => void, removeStorageKey: (key: string) => void, getStorageKey: (key: string) => string | null, getSessionId: () => string | undefined);
-    getDurations: () => {
-        testStart: number;
-        tasks: {
-            taskId: number;
-            started: number;
-        }[];
-    };
-    setDurations: (durations: {
-        testStart: number;
-        tasks: {
-            taskId: number;
-            started: number;
-        }[];
-    }) => void;
-    signalTask: (taskId: number, status: "begin" | "done" | "skipped", taskAnswer?: string) => void | Promise<Response>;
-    signalTest: (status: "begin" | "done" | "skipped") => Promise<Response>;
-}

package/dist/cjs/main/modules/userTesting/dnd.d.ts

@@ -1 +0,0 @@
-export default function attachDND(element: any, dragTarget: any): void;

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

@@ -1,45 +0,0 @@
-import App from '../../app/index.js';
-export default class UserTestManager {
-    private readonly app;
-    private readonly storageKey;
-    private readonly userRecorder;
-    private readonly bg;
-    private readonly container;
-    private widgetGuidelinesVisible;
-    private widgetTasksVisible;
-    private widgetVisible;
-    isActive: boolean;
-    private descriptionSection;
-    private taskSection;
-    private endSection;
-    private stopButton;
-    private stopButtonContainer;
-    private test;
-    private testId;
-    private signalManager;
-    constructor(app: App, storageKey: string);
-    getTestId(): number | null;
-    getTest: (id: number, token: string, inProgress?: boolean) => Promise<number | void>;
-    hideTaskSection: () => boolean;
-    showTaskSection: () => boolean;
-    collapseWidget: () => boolean;
-    removeGreeting: () => boolean;
-    createGreeting(title: string, micRequired: boolean, cameraRequired: boolean): void;
-    showWidget(guidelines: string, tasks: {
-        title: string;
-        description: string;
-        task_id: number;
-        allow_typing: boolean;
-    }[], inProgress?: boolean): void;
-    createTitleSection(): HTMLElement;
-    toggleDescriptionVisibility: () => void;
-    createDescriptionSection(guidelines: string): HTMLElement;
-    currentTaskIndex: number;
-    createTasksSection(tasks: {
-        title: string;
-        description: string;
-        task_id: number;
-        allow_typing: boolean;
-    }[]): HTMLElement;
-    showEndSection(): void;
-}

package/dist/cjs/main/modules/userTesting/recorder.d.ts

@@ -1,24 +0,0 @@
-import App from '../../app/index.js';
-export declare const Quality: {
-    Standard: {
-        width: number;
-        height: number;
-    };
-    High: {
-        width: number;
-        height: number;
-    };
-};
-export default class Recorder {
-    private readonly app;
-    private mediaRecorder;
-    private recordedChunks;
-    private stream;
-    private recStartTs;
-    constructor(app: App);
-    startRecording(fps: number, quality: (typeof Quality)[keyof typeof Quality], micReq: boolean, camReq: boolean): Promise<void>;
-    stopRecording(): Promise<Blob>;
-    sendToAPI(): Promise<void | Response>;
-    saveToFile(fileName?: string): Promise<void>;
-    discard(): void;
-}

package/dist/cjs/main/modules/userTesting/styles.d.ts

@@ -1,277 +0,0 @@
-export declare const bgStyle: {
-    position: string;
-    top: number;
-    left: number;
-    width: string;
-    height: string;
-    background: string;
-    display: string;
-    alignItems: string;
-    justifyContent: string;
-    zIndex: number;
-    fontFamily: string;
-};
-export declare const containerStyle: {
-    display: string;
-    flexDirection: string;
-    gap: string;
-    alignItems: string;
-    padding: string;
-    borderRadius: string;
-    border: string;
-    background: string;
-    width: string;
-};
-export declare const containerWidgetStyle: {
-    display: string;
-    'flex-direction': string;
-    gap: string;
-    'align-items': string;
-    padding: string;
-    fontFamily: string;
-    'border-radius': string;
-    border: string;
-    background: string;
-    width: string;
-};
-export declare const titleStyle: {
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-    color: string;
-};
-export declare const descriptionStyle: {
-    borderTop: string;
-    borderBottom: string;
-    padding: string;
-    color: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-    whiteSpace: string;
-};
-export declare const noticeStyle: {
-    color: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-};
-export declare const buttonStyle: {
-    display: string;
-    padding: string;
-    justifyContent: string;
-    alignItems: string;
-    gap: string;
-    borderRadius: string;
-    border: string;
-    background: string;
-    boxShadow: string;
-    color: string;
-    textAlign: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-    cursor: string;
-};
-export declare const sectionTitleStyle: {
-    fontFamily: string;
-    fontSize: string;
-    fontWeight: string;
-    lineHeight: string;
-    display: string;
-    justifyContent: string;
-    width: string;
-    cursor: string;
-};
-export declare const contentStyle: {
-    display: string;
-    flexDirection: string;
-    alignItems: string;
-    gap: string;
-    fontSize: string;
-    lineHeight: string;
-};
-export declare const titleWidgetStyle: {
-    padding: string;
-    gap: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-    color: string;
-    display: string;
-    alignItems: string;
-    width: string;
-    borderRadius: string;
-    background: string;
-    boxSizing: string;
-};
-export declare const descriptionWidgetStyle: {
-    boxSizing: string;
-    display: string;
-    width: string;
-    borderBottom: string;
-    background: string;
-    padding: string;
-    alignSelf: string;
-    color: string;
-    fontFamily: string;
-    fontStyle: string;
-    fontWeight: string;
-};
-export declare const endSectionStyle: {
-    display: string;
-    flexDirection: string;
-    alignItems: string;
-    gap: string;
-    boxSizing: string;
-    width: string;
-    borderBottom: string;
-    background: string;
-    padding: string;
-    alignSelf: string;
-    color: string;
-    fontFamily: string;
-    fontStyle: string;
-    fontWeight: string;
-};
-export declare const symbolIcon: {
-    fontSize: string;
-    fontWeight: string;
-    cursor: string;
-    color: string;
-};
-export declare const buttonWidgetStyle: {
-    display: string;
-    padding: string;
-    justifyContent: string;
-    alignItems: string;
-    gap: string;
-    borderRadius: string;
-    border: string;
-    background: string;
-    boxShadow: string;
-    color: string;
-    textAlign: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-    width: string;
-    boxSizing: string;
-    cursor: string;
-};
-export declare const stopWidgetStyle: {
-    marginTop: string;
-    marginBottom: string;
-    cursor: string;
-    display: string;
-    fontWeight: string;
-    fontSize: string;
-    lineHeight: string;
-};
-export declare const paginationStyle: {
-    display: string;
-    justifyContent: string;
-    alignItems: string;
-    gap: string;
-    padding: string;
-    width: string;
-    boxSizing: string;
-};
-export declare const taskNumberActive: {
-    display: string;
-    flexDirection: string;
-    alignItems: string;
-    justifyContent: string;
-    borderRadius: string;
-    outline: string;
-    fontSize: string;
-    height: string;
-    width: string;
-};
-export declare const taskNumberDone: {
-    display: string;
-    flexDirection: string;
-    alignItems: string;
-    justifyContent: string;
-    borderRadius: string;
-    outline: string;
-    boxShadow: string;
-    background: string;
-    fontSize: string;
-    height: string;
-    width: string;
-};
-export declare const taskDescriptionCard: {
-    borderRadius: string;
-    border: string;
-    background: string;
-    boxShadow: string;
-    display: string;
-    flexDirection: string;
-    padding: string;
-    gap: string;
-    alignSelf: string;
-};
-export declare const taskTextStyle: {
-    fontWeight: string;
-};
-export declare const taskDescriptionStyle: {
-    fontSize: string;
-    lineHeight: string;
-};
-export declare const taskButtonStyle: {
-    marginRight: string;
-    cursor: string;
-    color: string;
-    textAlign: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-};
-export declare const taskButtonBorderedStyle: {
-    display: string;
-    padding: string;
-    justifyContent: string;
-    alignItems: string;
-    gap: string;
-    borderRadius: string;
-    border: string;
-    marginRight: string;
-    cursor: string;
-    color: string;
-    textAlign: string;
-    fontFamily: string;
-    fontSize: string;
-    fontStyle: string;
-    fontWeight: string;
-    lineHeight: string;
-};
-export declare const taskButtonsRow: {
-    display: string;
-    justifyContent: string;
-    alignItems: string;
-    width: string;
-    boxSizing: string;
-};
-export declare const spinnerStyles: {
-    border: string;
-    width: string;
-    height: string;
-    borderRadius: string;
-    borderLeftColor: string;
-    animation: string;
-};

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

@@ -1,9 +0,0 @@
-export declare function generateGrid(): HTMLDivElement;
-export declare function generateChevron(): HTMLDivElement;
-export declare function addKeyframes(): void;
-export declare function createSpinner(): HTMLDivElement;
-export declare function createElement(tag: string, className: string, styles: any, textContent?: string, id?: string): HTMLElement;
-export declare const TEST_START = "or_uxt_test_start";
-export declare const TASK_IND = "or_uxt_task_index";
-export declare const SESSION_ID = "or_uxt_session_id";
-export declare const TEST_ID = "or_uxt_test_id";

package/dist/lib/main/modules/featureFlags.d.ts

@@ -1,25 +0,0 @@
-import App from '../app/index.js';
-export interface IFeatureFlag {
-    key: string;
-    is_persist: boolean;
-    value: string | boolean;
-    payload: string;
-}
-export interface FetchPersistFlagsData {
-    key: string;
-    value: string | boolean;
-}
-export default class FeatureFlags {
-    private readonly app;
-    flags: IFeatureFlag[];
-    storageKey: string;
-    onFlagsCb: (flags: IFeatureFlag[]) => void;
-    constructor(app: App);
-    getFeatureFlag(flagName: string): IFeatureFlag | undefined;
-    isFlagEnabled(flagName: string): boolean;
-    onFlagsLoad(cb: (flags: IFeatureFlag[]) => void): void;
-    reloadFlags(token?: string): Promise<void>;
-    handleFlags(flags: IFeatureFlag[]): void;
-    clearPersistFlags(): void;
-    diffPersist(flags: IFeatureFlag[]): IFeatureFlag[];
-}

package/dist/lib/main/modules/userTesting/SignalManager.d.ts

@@ -1,29 +0,0 @@
-export default class SignalManager {
-    private readonly ingestPoint;
-    private readonly getTimestamp;
-    private readonly token;
-    private readonly testId;
-    private readonly storageKey;
-    private readonly setStorageKey;
-    private readonly removeStorageKey;
-    private readonly getStorageKey;
-    private readonly getSessionId;
-    private readonly durations;
-    constructor(ingestPoint: string, getTimestamp: () => number, token: string, testId: number, storageKey: string, setStorageKey: (key: string, value: string) => void, removeStorageKey: (key: string) => void, getStorageKey: (key: string) => string | null, getSessionId: () => string | undefined);
-    getDurations: () => {
-        testStart: number;
-        tasks: {
-            taskId: number;
-            started: number;
-        }[];
-    };
-    setDurations: (durations: {
-        testStart: number;
-        tasks: {
-            taskId: number;
-            started: number;
-        }[];
-    }) => void;
-    signalTask: (taskId: number, status: "begin" | "done" | "skipped", taskAnswer?: string) => void | Promise<Response>;
-    signalTest: (status: "begin" | "done" | "skipped") => Promise<Response>;
-}

package/dist/lib/main/modules/userTesting/dnd.d.ts

@@ -1 +0,0 @@
-export default function attachDND(element: any, dragTarget: any): void;

package/dist/lib/main/modules/userTesting/index.d.ts

@@ -1,45 +0,0 @@
-import App from '../../app/index.js';
-export default class UserTestManager {
-    private readonly app;
-    private readonly storageKey;
-    private readonly userRecorder;
-    private readonly bg;
-    private readonly container;
-    private widgetGuidelinesVisible;
-    private widgetTasksVisible;
-    private widgetVisible;
-    isActive: boolean;
-    private descriptionSection;
-    private taskSection;
-    private endSection;
-    private stopButton;
-    private stopButtonContainer;
-    private test;
-    private testId;
-    private signalManager;
-    constructor(app: App, storageKey: string);
-    getTestId(): number | null;
-    getTest: (id: number, token: string, inProgress?: boolean) => Promise<number | void>;
-    hideTaskSection: () => boolean;
-    showTaskSection: () => boolean;
-    collapseWidget: () => boolean;
-    removeGreeting: () => boolean;
-    createGreeting(title: string, micRequired: boolean, cameraRequired: boolean): void;
-    showWidget(guidelines: string, tasks: {
-        title: string;
-        description: string;
-        task_id: number;
-        allow_typing: boolean;
-    }[], inProgress?: boolean): void;
-    createTitleSection(): HTMLElement;
-    toggleDescriptionVisibility: () => void;
-    createDescriptionSection(guidelines: string): HTMLElement;
-    currentTaskIndex: number;
-    createTasksSection(tasks: {
-        title: string;
-        description: string;
-        task_id: number;
-        allow_typing: boolean;
-    }[]): HTMLElement;
-    showEndSection(): void;
-}

package/dist/lib/main/modules/userTesting/recorder.d.ts

@@ -1,24 +0,0 @@
-import App from '../../app/index.js';
-export declare const Quality: {
-    Standard: {
-        width: number;
-        height: number;
-    };
-    High: {
-        width: number;
-        height: number;
-    };
-};
-export default class Recorder {
-    private readonly app;
-    private mediaRecorder;
-    private recordedChunks;
-    private stream;
-    private recStartTs;
-    constructor(app: App);
-    startRecording(fps: number, quality: (typeof Quality)[keyof typeof Quality], micReq: boolean, camReq: boolean): Promise<void>;
-    stopRecording(): Promise<Blob>;
-    sendToAPI(): Promise<void | Response>;
-    saveToFile(fileName?: string): Promise<void>;
-    discard(): void;
-}