@openreplay/tracker 14.0.10-beta.1 → 14.0.10

package/lib/index.js

@@ -1,423 +0,0 @@
-import App, { DEFAULT_INGEST_POINT } from './app/index.js';
-export { default as App } from './app/index.js';
-import { UserAnonymousID, CustomEvent, CustomIssue } from './app/messages.gen.js';
-import * as _Messages from './app/messages.gen.js';
-export const Messages = _Messages;
-export { SanitizeLevel } from './app/sanitizer.js';
-import Connection from './modules/connection.js';
-import Console from './modules/console.js';
-import Exception, { getExceptionMessageFromEvent, getExceptionMessage, } from './modules/exception.js';
-import Img from './modules/img.js';
-import Input from './modules/input.js';
-import Mouse from './modules/mouse.js';
-import Timing from './modules/timing.js';
-import Performance from './modules/performance.js';
-import Scroll from './modules/scroll.js';
-import Viewport from './modules/viewport.js';
-import CSSRules from './modules/cssrules.js';
-import Focus from './modules/focus.js';
-import Fonts from './modules/fonts.js';
-import Network from './modules/network.js';
-import ConstructedStyleSheets from './modules/constructedStyleSheets.js';
-import Selection from './modules/selection.js';
-import Tabs from './modules/tabs.js';
-import { IN_BROWSER, deprecationWarn, DOCS_HOST, inIframe } from './utils.js';
-const DOCS_SETUP = '/installation/javascript-sdk';
-function processOptions(obj) {
-    if (obj == null) {
-        console.error(`OpenReplay: invalid options argument type. Please, check documentation on ${DOCS_HOST}${DOCS_SETUP}`);
-        return false;
-    }
-    if (typeof obj.projectKey !== 'string') {
-        if (typeof obj.projectKey !== 'number') {
-            if (typeof obj.projectID !== 'number') {
-                // Back compatability
-                console.error(`OpenReplay: projectKey is missing or wrong type (string is expected). Please, check ${DOCS_HOST}${DOCS_SETUP} for more information.`);
-                return false;
-            }
-            else {
-                obj.projectKey = obj.projectID.toString();
-                deprecationWarn('`projectID` option', '`projectKey` option', DOCS_SETUP);
-            }
-        }
-        else {
-            console.warn('OpenReplay: projectKey is expected to have a string type.');
-            obj.projectKey = obj.projectKey.toString();
-        }
-    }
-    if (obj.sessionToken != null) {
-        deprecationWarn('`sessionToken` option', '`sessionHash` start() option', '/');
-    }
-    return true;
-}
-export default class API {
-    constructor(options) {
-        this.options = options;
-        this.app = null;
-        this.crossdomainMode = false;
-        this.checkDoNotTrack = () => {
-            return (this.options.respectDoNotTrack &&
-                (navigator.doNotTrack == '1' ||
-                    // @ts-ignore
-                    window.doNotTrack == '1'));
-        };
-        this.signalStartIssue = (reason, missingApi) => {
-            const doNotTrack = this.checkDoNotTrack();
-            const req = new XMLHttpRequest();
-            const orig = this.options.ingestPoint || DEFAULT_INGEST_POINT;
-            req.open('POST', orig + '/v1/web/not-started');
-            req.send(JSON.stringify({
-                trackerVersion: '14.0.10-beta.1',
-                projectKey: this.options.projectKey,
-                doNotTrack,
-                reason: missingApi.length ? `missing api: ${missingApi.join(',')}` : reason,
-            }));
-        };
-        this.restartCanvasTracking = () => {
-            if (this.app === null) {
-                return;
-            }
-            this.app.restartCanvasTracking();
-        };
-        this.handleError = (e, metadata = {}) => {
-            if (this.app === null) {
-                return;
-            }
-            if (e instanceof Error) {
-                const msg = getExceptionMessage(e, [], metadata);
-                this.app.send(msg);
-            }
-            else if (e instanceof ErrorEvent ||
-                ('PromiseRejectionEvent' in window && e instanceof PromiseRejectionEvent)) {
-                const msg = getExceptionMessageFromEvent(e, undefined, metadata);
-                if (msg != null) {
-                    this.app.send(msg);
-                }
-            }
-        };
-        this.crossdomainMode = Boolean(inIframe() && options.crossdomain?.enabled);
-        if (!IN_BROWSER || !processOptions(options)) {
-            return;
-        }
-        if (window.__OPENREPLAY__) {
-            console.error('OpenReplay: one tracker instance has been initialised already');
-            return;
-        }
-        if (!options.__DISABLE_SECURE_MODE && location.protocol !== 'https:') {
-            console.error('OpenReplay: Your website must be publicly accessible and running on SSL in order for OpenReplay to properly capture and replay the user session. You can disable this check by setting `__DISABLE_SECURE_MODE` option to `true` if you are testing in localhost. Keep in mind, that asset files on a local machine are not available to the outside world. This might affect tracking if you use css files.');
-            return;
-        }
-        const doNotTrack = this.checkDoNotTrack();
-        const failReason = [];
-        const conditions = [
-            'Map',
-            'Set',
-            'MutationObserver',
-            'performance',
-            'timing',
-            'startsWith',
-            'Blob',
-            'Worker',
-        ];
-        if (doNotTrack) {
-            failReason.push('doNotTrack');
-        }
-        else {
-            for (const condition of conditions) {
-                if (condition === 'timing') {
-                    if ('performance' in window && !(condition in performance)) {
-                        failReason.push(condition);
-                        break;
-                    }
-                }
-                else if (condition === 'startsWith') {
-                    if (!(condition in String.prototype)) {
-                        failReason.push(condition);
-                        break;
-                    }
-                }
-                else {
-                    if (!(condition in window)) {
-                        failReason.push(condition);
-                        break;
-                    }
-                }
-            }
-        }
-        if (failReason.length > 0) {
-            const missingApi = failReason.join(',');
-            console.error(`OpenReplay: browser doesn't support API required for tracking or doNotTrack is set to 1. Reason: ${missingApi}`);
-            this.signalStartIssue('missing_api', failReason);
-            return;
-        }
-        const app = new App(options.projectKey, options.sessionToken, options, this.signalStartIssue, this.crossdomainMode);
-        this.app = app;
-        if (!this.crossdomainMode) {
-            // no need to send iframe viewport data since its a node for us
-            Viewport(app);
-            // calculated in main window
-            Connection(app);
-            // while we can calculate it here, trying to compute it for all parts is hard
-            Performance(app, options);
-            // no tabs in iframes yet
-            Tabs(app);
-        }
-        Mouse(app, options.mouse);
-        // inside iframe, we ignore viewport scroll
-        Scroll(app, this.crossdomainMode);
-        CSSRules(app);
-        ConstructedStyleSheets(app);
-        Console(app, options);
-        Exception(app, options);
-        Img(app);
-        Input(app, options);
-        Timing(app, options);
-        Focus(app);
-        Fonts(app);
-        Network(app, options.network);
-        Selection(app);
-        window.__OPENREPLAY__ = this;
-        if (options.flags && options.flags.onFlagsLoad) {
-            this.onFlagsLoad(options.flags.onFlagsLoad);
-        }
-        const wOpen = window.open;
-        if (options.autoResetOnWindowOpen || options.resetTabOnWindowOpen) {
-            app.attachStartCallback(() => {
-                const tabId = app.getTabId();
-                const sessStorage = app.sessionStorage ?? window.sessionStorage;
-                window.open = function (...args) {
-                    if (options.autoResetOnWindowOpen) {
-                        app.resetNextPageSession(true);
-                    }
-                    if (options.resetTabOnWindowOpen) {
-                        sessStorage.removeItem(options.session_tabid_key || '__openreplay_tabid');
-                    }
-                    app.resetNextPageSession(false);
-                    sessStorage.setItem(options.session_tabid_key || '__openreplay_tabid', tabId);
-                    return wOpen.call(window, ...args);
-                };
-            });
-            app.attachStopCallback(() => {
-                window.open = wOpen;
-            });
-        }
-    }
-    isFlagEnabled(flagName) {
-        return this.featureFlags.isFlagEnabled(flagName);
-    }
-    onFlagsLoad(callback) {
-        this.app?.featureFlags.onFlagsLoad(callback);
-    }
-    clearPersistFlags() {
-        this.app?.featureFlags.clearPersistFlags();
-    }
-    reloadFlags() {
-        return this.app?.featureFlags.reloadFlags();
-    }
-    getFeatureFlag(flagName) {
-        return this.app?.featureFlags.getFeatureFlag(flagName);
-    }
-    getAllFeatureFlags() {
-        return this.app?.featureFlags.flags;
-    }
-    use(fn) {
-        return fn(this.app, this.options);
-    }
-    isActive() {
-        if (this.app === null) {
-            return false;
-        }
-        return this.app.active();
-    }
-    /**
-     * Creates a named hook that expects event name, data string and msg direction (up/down),
-     * it will skip any message bigger than 5 mb or event name bigger than 255 symbols
-     * msg direction is "down" (incoming) by default
-     *
-     * @returns {(msgType: string, data: string, dir: 'up' | 'down') => void}
-     * */
-    trackWs(channelName) {
-        if (this.app === null) {
-            return;
-        }
-        return this.app.trackWs(channelName);
-    }
-    start(startOpts) {
-        if (this.browserEnvCheck()) {
-            if (this.app === null) {
-                return Promise.reject("Browser doesn't support required api, or doNotTrack is active.");
-            }
-            return this.app.start(startOpts);
-        }
-        else {
-            return Promise.reject('Trying to start not in browser.');
-        }
-    }
-    browserEnvCheck() {
-        if (!IN_BROWSER) {
-            console.error(`OpenReplay: you are trying to start Tracker on a node.js environment. If you want to use OpenReplay with SSR, please, use componentDidMount or useEffect API for placing the \`tracker.start()\` line. Check documentation on ${DOCS_HOST}${DOCS_SETUP}`);
-            return false;
-        }
-        return true;
-    }
-    /**
-     * start buffering messages without starting the actual session, which gives 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, conditional) {
-        if (this.browserEnvCheck()) {
-            if (this.app === null) {
-                return Promise.reject('Tracker not initialized');
-            }
-            void this.app.coldStart(startOpts, conditional);
-        }
-        else {
-            return Promise.reject('Trying to start not in browser.');
-        }
-    }
-    /**
-     * Starts offline session recording. Keep in mind that only user device time will be used for timestamps.
-     * (no backend delay sync)
-     *
-     * @param {Object} startOpts - options for session start, same as .start()
-     * @param {Function} onSessionSent - callback that will be called once session is fully sent
-     * @returns methods to manipulate buffer:
-     *
-     * saveBuffer - to save it in localStorage
-     *
-     * getBuffer - returns current buffer
-     *
-     * setBuffer - replaces current buffer with given
-     * */
-    startOfflineRecording(startOpts, onSessionSent) {
-        if (this.browserEnvCheck()) {
-            if (this.app === null) {
-                return Promise.reject('Tracker not initialized');
-            }
-            return this.app.offlineRecording(startOpts, onSessionSent);
-        }
-        else {
-            return Promise.reject('Trying to start not in browser.');
-        }
-    }
-    /**
-     * Uploads the stored session buffer to backend
-     * @returns promise that resolves once messages are loaded, it has to be awaited
-     * so the session can be uploaded properly
-     * @resolve - if messages were loaded into service worker successfully
-     * @reject {string} - error message
-     * */
-    uploadOfflineRecording() {
-        if (this.app === null) {
-            return;
-        }
-        return this.app.uploadOfflineRecording();
-    }
-    stop() {
-        if (this.app === null) {
-            return;
-        }
-        this.app.stop();
-        return this.app.session.getSessionHash();
-    }
-    forceFlushBatch() {
-        if (this.app === null) {
-            return;
-        }
-        this.app.forceFlushBatch();
-    }
-    getSessionToken() {
-        if (this.app === null) {
-            return null;
-        }
-        return this.app.getSessionToken();
-    }
-    getSessionInfo() {
-        if (this.app === null) {
-            return null;
-        }
-        return this.app.session.getInfo();
-    }
-    getSessionID() {
-        if (this.app === null) {
-            return null;
-        }
-        return this.app.getSessionID();
-    }
-    getTabId() {
-        if (this.app === null) {
-            return null;
-        }
-        return this.app.getTabId();
-    }
-    getUxId() {
-        if (this.app === null) {
-            return null;
-        }
-        return this.app.getUxtId();
-    }
-    sessionID() {
-        deprecationWarn("'sessionID' method", "'getSessionID' method", '/');
-        return this.getSessionID();
-    }
-    getSessionURL(options) {
-        if (this.app === null) {
-            return undefined;
-        }
-        return this.app.getSessionURL(options);
-    }
-    setUserID(id) {
-        if (typeof id === 'string' && this.app !== null) {
-            this.app.session.setUserID(id);
-        }
-    }
-    userID(id) {
-        deprecationWarn("'userID' method", "'setUserID' method", '/');
-        this.setUserID(id);
-    }
-    setUserAnonymousID(id) {
-        if (typeof id === 'string' && this.app !== null) {
-            this.app.send(UserAnonymousID(id));
-        }
-    }
-    userAnonymousID(id) {
-        deprecationWarn("'userAnonymousID' method", "'setUserAnonymousID' method", '/');
-        this.setUserAnonymousID(id);
-    }
-    setMetadata(key, value) {
-        if (typeof key === 'string' && typeof value === 'string' && this.app !== null) {
-            this.app.session.setMetadata(key, value);
-        }
-    }
-    metadata(key, value) {
-        deprecationWarn("'metadata' method", "'setMetadata' method", '/');
-        this.setMetadata(key, value);
-    }
-    event(key, payload = null, issue = false) {
-        if (typeof key === 'string' && this.app !== null) {
-            if (issue) {
-                return this.issue(key, payload);
-            }
-            else {
-                try {
-                    payload = JSON.stringify(payload);
-                }
-                catch (e) {
-                    return;
-                }
-                this.app.send(CustomEvent(key, payload));
-            }
-        }
-    }
-    issue(key, payload = null) {
-        if (typeof key === 'string' && this.app !== null) {
-            try {
-                payload = JSON.stringify(payload);
-            }
-            catch (e) {
-                return;
-            }
-            this.app.send(CustomIssue(key, payload));
-        }
-    }
-}

package/lib/modules/attributeSender.js

@@ -1,46 +0,0 @@
-export class StringDictionary {
-    constructor() {
-        this.idx = 1;
-        this.backDict = {};
-    }
-    getKey(str) {
-        let isNew = false;
-        if (!this.backDict[str]) {
-            isNew = true;
-            this.backDict[str] = this.idx++;
-        }
-        return [this.backDict[str], isNew];
-    }
-}
-export default class AttributeSender {
-    constructor(app, isDictDisabled) {
-        this.app = app;
-        this.isDictDisabled = isDictDisabled;
-        this.dict = new StringDictionary();
-    }
-    sendSetAttribute(id, name, value) {
-        if (this.isDictDisabled) {
-            const msg = [12 /* Type.SetNodeAttribute */, id, name, value];
-            return this.app.send(msg);
-        }
-        else {
-            const message = [
-                51 /* Type.SetNodeAttributeDict */,
-                id,
-                this.applyDict(name),
-                this.applyDict(value),
-            ];
-            return this.app.send(message);
-        }
-    }
-    applyDict(str) {
-        const [key, isNew] = this.dict.getKey(str);
-        if (isNew) {
-            this.app.send([50 /* Type.StringDict */, key, str]);
-        }
-        return key;
-    }
-    clear() {
-        this.dict = new StringDictionary();
-    }
-}

package/lib/modules/axiosSpy.js

@@ -1,119 +0,0 @@
-import { NetworkRequest } from '../app/messages.gen.js';
-import { getTimeOrigin } from '../utils.js';
-import { getExceptionMessage } from './exception.js';
-export default function (app, instance, opts, sanitize, stringify) {
-    app.debug.log('Openreplay: attaching axios spy to instance', instance);
-    function captureResponseData(axiosResponseObj) {
-        app.debug.log('Openreplay: capturing axios response data', axiosResponseObj);
-        const { headers: reqHs, data: reqData, method, url, baseURL } = axiosResponseObj.config;
-        const { data: rData, headers: rHs, status: globStatus, response } = axiosResponseObj;
-        const { data: resData, headers: resHs, status: resStatus } = response || {};
-        const ihOpt = opts.ignoreHeaders;
-        const isHIgnoring = Array.isArray(ihOpt) ? (name) => ihOpt.includes(name) : () => ihOpt;
-        function writeHeader(hsObj, header) {
-            if (!isHIgnoring(header[0])) {
-                hsObj[header[0]] = header[1];
-            }
-        }
-        let requestHs = {};
-        let responseHs = {};
-        if (reqHs.toJSON) {
-            requestHs = reqHs.toJSON();
-        }
-        else if (reqHs instanceof Headers) {
-            reqHs.forEach((v, n) => writeHeader(requestHs, [n, v]));
-        }
-        else if (Array.isArray(reqHs)) {
-            reqHs.forEach((h) => writeHeader(requestHs, h));
-        }
-        else if (typeof reqHs === 'object') {
-            Object.entries(reqHs).forEach((h) => writeHeader(requestHs, h));
-        }
-        const usedResHeader = resHs ? resHs : rHs;
-        if (usedResHeader.toJSON) {
-            responseHs = usedResHeader.toJSON();
-        }
-        else if (usedResHeader instanceof Headers) {
-            usedResHeader.forEach((v, n) => writeHeader(responseHs, [n, v]));
-        }
-        else if (Array.isArray(usedResHeader)) {
-            usedResHeader.forEach((h) => writeHeader(responseHs, h));
-        }
-        else if (typeof usedResHeader === 'object') {
-            Object.entries(usedResHeader).forEach(([n, v]) => {
-                if (!isHIgnoring(n))
-                    responseHs[n] = v;
-            });
-        }
-        const reqResInfo = sanitize({
-            url,
-            method: method || '',
-            status: globStatus || resStatus || 0,
-            request: {
-                headers: requestHs,
-                body: reqData,
-            },
-            response: {
-                headers: responseHs,
-                body: resData || rData,
-            },
-        });
-        if (!reqResInfo) {
-            app.debug.log('Openreplay: empty request/response info, skipping');
-            return;
-        }
-        const requestStart = axiosResponseObj.config.__openreplay_timing;
-        const duration = performance.now() - requestStart;
-        app.debug.log('Openreplay: final req object', reqResInfo);
-        app.send(NetworkRequest('xhr', String(method), String(reqResInfo.url), stringify(reqResInfo.request), stringify(reqResInfo.response), reqResInfo.status, requestStart + getTimeOrigin(), duration, 0));
-    }
-    function getStartTime(config) {
-        app.debug.log('Openreplay: capturing API request', config);
-        config.__openreplay_timing = performance.now();
-        if (opts.sessionTokenHeader) {
-            const header = typeof opts.sessionTokenHeader === 'string'
-                ? opts.sessionTokenHeader
-                : 'X-OpenReplay-Session-Token';
-            const headerValue = app.getSessionToken();
-            if (headerValue) {
-                config.headers.set(header, headerValue);
-            }
-        }
-        return config;
-    }
-    function captureNetworkRequest(response) {
-        if (opts.failuresOnly)
-            return response;
-        captureResponseData(response);
-        return response;
-    }
-    function captureNetworkError(error) {
-        app.debug.log('Openreplay: capturing API request error', error);
-        if (isAxiosError(error) && Boolean(error.response)) {
-            captureResponseData(error.response);
-        }
-        else if (error instanceof Error) {
-            app.send(getExceptionMessage(error, []));
-        }
-        return Promise.reject(error);
-    }
-    function logRequestError(ev) {
-        app.debug.log('Openreplay: failed API request, skipping', ev);
-    }
-    const reqInt = instance.interceptors.request.use(getStartTime, logRequestError, {
-        synchronous: true,
-    });
-    const resInt = instance.interceptors.response.use(captureNetworkRequest, captureNetworkError, {
-        synchronous: true,
-    });
-    app.attachStopCallback(() => {
-        instance.interceptors.request.eject?.(reqInt);
-        instance.interceptors.response.eject?.(resInt);
-    });
-}
-function isAxiosError(payload) {
-    return isObject(payload) && payload.isAxiosError === true;
-}
-function isObject(thing) {
-    return thing !== null && typeof thing === 'object';
-}