@openreplay/tracker 3.4.16 → 3.5.0

package/cjs/modules/mouse.js

@@ -57,6 +57,7 @@ function _getTarget(target) {
         if (tag === 'BUTTON' ||
             tag === 'A' ||
             tag === 'LI' ||
+            tag === 'SELECT' ||
             element.onclick != null ||
             element.getAttribute('role') === 'button' ||
             (0, utils_js_1.getLabelAttribute)(element) !== null) {
@@ -83,9 +84,10 @@ function default_1(app) {
         if (tag === 'BUTTON' ||
             tag === 'A' ||
             tag === 'LI' ||
+            tag === 'SELECT' ||
             target.onclick != null ||
             target.getAttribute('role') === 'button') {
-            const label = app.observer.getInnerTextSecure(target);
+            const label = app.sanitizer.getInnerTextSecure(target);
             return (0, utils_js_1.normSpaces)(label).slice(0, 100);
         }
         return '';

package/cjs/utils.d.ts

@@ -3,14 +3,6 @@ export declare const stars: (str: string) => string;
 export declare function normSpaces(str: string): string;
 export declare function isURL(s: string): boolean;
 export declare const IN_BROWSER: boolean;
-export declare const log: {
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-};
-export declare const warn: {
-    (...data: any[]): void;
-    (message?: any, ...optionalParams: any[]): void;
-};
 export declare const DOCS_HOST = "https://docs.openreplay.com";
 export declare function deprecationWarn(nameOfFeature: string, useInstead: string, docsPath?: string): void;
 export declare function getLabelAttribute(e: Element): string | null;

package/cjs/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.warn = exports.log = exports.IN_BROWSER = exports.isURL = exports.normSpaces = exports.stars = exports.timestamp = void 0;
+exports.hasOpenreplayAttribute = exports.getLabelAttribute = exports.deprecationWarn = exports.DOCS_HOST = exports.IN_BROWSER = exports.isURL = exports.normSpaces = exports.stars = exports.timestamp = void 0;
 function timestamp() {
     return Math.round(performance.now()) + performance.timing.navigationStart;
 }
@@ -18,15 +18,14 @@ function isURL(s) {
 }
 exports.isURL = isURL;
 exports.IN_BROWSER = !(typeof window === "undefined");
-exports.log = console.log;
-exports.warn = console.warn;
+// TODO: JOIN IT WITH LOGGER somehow (use logging decorators?); Don't forget about index.js loggin when there is no logger instance.
 exports.DOCS_HOST = 'https://docs.openreplay.com';
 const warnedFeatures = {};
 function deprecationWarn(nameOfFeature, useInstead, docsPath = "/") {
     if (warnedFeatures[nameOfFeature]) {
         return;
     }
-    (0, exports.warn)(`OpenReplay: ${nameOfFeature} is deprecated. ${useInstead ? `Please, use ${useInstead} instead.` : ""} Visit ${exports.DOCS_HOST}${docsPath} for more information.`);
+    console.warn(`OpenReplay: ${nameOfFeature} is deprecated. ${useInstead ? `Please, use ${useInstead} instead.` : ""} Visit ${exports.DOCS_HOST}${docsPath} for more information.`);
     warnedFeatures[nameOfFeature] = true;
 }
 exports.deprecationWarn = deprecationWarn;

package/lib/app/context.d.ts

@@ -0,0 +1,18 @@
+export interface Window extends globalThis.Window {
+    HTMLInputElement: typeof HTMLInputElement;
+    HTMLLinkElement: typeof HTMLLinkElement;
+    HTMLStyleElement: typeof HTMLStyleElement;
+    SVGStyleElement: typeof SVGStyleElement;
+    HTMLIFrameElement: typeof HTMLIFrameElement;
+    Text: typeof Text;
+    Element: typeof Element;
+    ShadowRoot: typeof ShadowRoot;
+}
+declare type WindowConstructor = Document | Element | Text | ShadowRoot | HTMLInputElement | HTMLLinkElement | HTMLStyleElement | HTMLIFrameElement;
+declare type Constructor<T> = {
+    new (...args: any[]): T;
+    name: string;
+};
+export declare function isInstance<T extends WindowConstructor>(node: Node, constr: Constructor<T>): node is T;
+export declare function inDocument(node: Node): boolean;
+export {};

package/lib/app/context.js

@@ -0,0 +1,43 @@
+// TODO: we need a type expert here so we won't have to ignore the lines
+// TODO: use it everywhere (static function; export from which file? <-- global Window typing required)
+export function isInstance(node, constr) {
+    const doc = node.ownerDocument;
+    if (!doc) { // null if Document
+        return constr.name === 'Document';
+    }
+    let context = 
+    // @ts-ignore (for EI, Safary)
+    doc.parentWindow ||
+        doc.defaultView; // TODO: smart global typing for Window object
+    while (context.parent && context.parent !== context) {
+        // @ts-ignore
+        if (node instanceof context[constr.name]) {
+            return true;
+        }
+        // @ts-ignore
+        context = context.parent;
+    }
+    // @ts-ignore
+    return node instanceof context[constr.name];
+}
+export function inDocument(node) {
+    const doc = node.ownerDocument;
+    if (!doc) {
+        return false;
+    }
+    if (doc.contains(node)) {
+        return true;
+    }
+    let context = 
+    // @ts-ignore (for EI, Safary)
+    doc.parentWindow ||
+        doc.defaultView;
+    while (context.parent && context.parent !== context) {
+        if (context.document.contains(node)) {
+            return true;
+        }
+        // @ts-ignore
+        context = context.parent;
+    }
+    return false;
+}

package/lib/app/index.d.ts

@@ -1,55 +1,84 @@
 import Message from "../messages/message.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 from "./logger.js";
 import type { Options as ObserverOptions } from "./observer/top_observer.js";
+import type { Options as SanitizerOptions } from "./sanitizer.js";
+import type { Options as LoggerOptions } from "./logger.js";
 import type { Options as WebworkerOptions } from "../messages/webworker.js";
 export interface OnStartInfo {
     sessionID: string;
     sessionToken: string;
     userUUID: string;
 }
-export declare type Options = {
+export interface StartOptions {
+    userID?: string;
+    metadata?: Record<string, string>;
+    forceNew: boolean;
+}
+declare type AppOptions = {
     revID: string;
     node_id: string;
     session_token_key: string;
     session_pageno_key: string;
+    session_reset_key: string;
     local_uuid_key: string;
     ingestPoint: string;
     resourceBaseHref: string | null;
+    verbose: boolean;
     __is_snippet: boolean;
     __debug_report_edp: string | null;
-    __debug_log: boolean;
+    __debug__?: LoggerOptions;
     onStart?: (info: OnStartInfo) => void;
-} & ObserverOptions & WebworkerOptions;
+} & WebworkerOptions;
+export declare type Options = AppOptions & ObserverOptions & SanitizerOptions;
 declare type Callback = () => void;
 declare type CommitCallback = (messages: Array<Message>) => void;
+export declare const CANCELED = "canceled";
 export declare const DEFAULT_INGEST_POINT = "https://api.openreplay.com/ingest";
 export default class App {
     readonly nodes: Nodes;
     readonly ticker: Ticker;
     readonly projectKey: string;
+    readonly sanitizer: Sanitizer;
+    readonly debug: Logger;
+    readonly notify: Logger;
     private readonly messages;
-    readonly observer: Observer;
+    private readonly observer;
     private readonly startCallbacks;
     private readonly stopCallbacks;
     private readonly commitCallbacks;
     private readonly options;
     private readonly revID;
     private _sessionID;
-    private isActive;
+    private _userID;
+    private _metadata;
+    private activityState;
     private version;
     private readonly worker?;
-    constructor(projectKey: string, sessionToken: string | null | undefined, opts: Partial<Options>);
+    constructor(projectKey: string, sessionToken: string | null | undefined, options: Partial<Options>);
     private _debug;
     send(message: Message, urgent?: boolean): void;
     private commit;
     attachCommitCallback(cb: CommitCallback): void;
-    addCommitCallback(cb: CommitCallback): void;
     safe<T extends (...args: any[]) => void>(fn: T): T;
     attachStartCallback(cb: Callback): void;
     attachStopCallback(cb: Callback): void;
     attachEventListener(target: EventTarget, type: string, listener: EventListener, useSafe?: boolean, useCapture?: boolean): void;
+    checkRequiredVersion(version: string): boolean;
+    private getStartInfo;
+    getSessionInfo(): {
+        userUUID: string | null;
+        projectKey: string;
+        revID: string;
+        timestamp: number;
+        trackerVersion: string;
+        userID: string | null;
+        isSnippet: boolean;
+        sessionID: string | null;
+        metadata: Record<string, string>;
+    };
     getSessionToken(): string | undefined;
     getSessionID(): string | undefined;
     getHost(): string;
@@ -58,8 +87,9 @@ export default class App {
     resolveResourceURL(resourceURL: string): string;
     isServiceURL(url: string): boolean;
     active(): boolean;
+    resetNextPageSession(flag: boolean): void;
     private _start;
-    start(reset?: boolean): Promise<OnStartInfo>;
+    start(options?: StartOptions): Promise<OnStartInfo>;
     stop(): void;
 }
 export {};