posthog-js 1.297.2 → 1.297.4

package/lib/src/extensions/replay/sessionrecording-wrapper.d.ts

@@ -0,0 +1,75 @@
+import { PostHog } from '../../posthog-core';
+import { Properties, RemoteConfig, SessionStartReason } from '../../types';
+import { type eventWithTime } from '@rrweb/types';
+import { SessionRecordingStatus, TriggerType } from './triggerMatching';
+/**
+ * This only exists to let us test changes to sessionrecording.ts before rolling them out to everyone
+ * it should not be depended on in other ways, since i'm going to delete it long before the end of September 2025
+ */
+export declare class SessionRecordingWrapper {
+    private readonly _instance;
+    _forceAllowLocalhostNetworkCapture: boolean;
+    private _receivedFlags;
+    private _persistFlagsOnSessionListener;
+    private _lazyLoadedSessionRecording;
+    get started(): boolean;
+    /**
+     * defaults to buffering mode until a flags response is received
+     * once a flags response is received status can be disabled, active or sampled
+     */
+    get status(): SessionRecordingStatus;
+    constructor(_instance: PostHog);
+    private get _isRecordingEnabled();
+    startIfEnabledOrStop(startReason?: SessionStartReason): void;
+    /**
+     * session recording waits until it receives remote config before loading the script
+     * this is to ensure we can control the script name remotely
+     * and because we wait until we have local and remote config to determine if we should start at all
+     * if start is called and there is no remote config then we wait until there is
+     */
+    private _lazyLoadAndStart;
+    stopRecording(): void;
+    private _resetSampling;
+    private _persistRemoteConfig;
+    onRemoteConfig(response: RemoteConfig): void;
+    log(message: string, level?: 'log' | 'warn' | 'error'): void;
+    private get _scriptName();
+    private _onScriptLoaded;
+    /**
+     * this is maintained on the public API only because it has always been on the public API
+     * if you are calling this directly you are certainly doing something wrong
+     * @deprecated
+     */
+    onRRwebEmit(rawEvent: eventWithTime): void;
+    /**
+     * this ignores the linked flag config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({linked_flag: true})`
+     * */
+    overrideLinkedFlag(): void;
+    /**
+     * this ignores the sampling config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({sampling: true})`
+     * */
+    overrideSampling(): void;
+    /**
+     * this ignores the URL/Event trigger config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({trigger: 'url' | 'event'})`
+     * */
+    overrideTrigger(triggerType: TriggerType): void;
+    get sdkDebugProperties(): Properties;
+    /**
+     * This adds a custom event to the session recording
+     *
+     * It is not intended for arbitrary public use - playback only displays known custom events
+     * And is exposed on the public interface only so that other parts of the SDK are able to use it
+     *
+     * if you are calling this from client code, you're probably looking for `posthog.capture('$custom_event', {...})`
+     */
+    tryAddCustomEvent(tag: string, payload: any): boolean;
+}

package/lib/src/extensions/replay/sessionrecording-wrapper.js

@@ -0,0 +1,285 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SessionRecordingWrapper = void 0;
+var constants_1 = require("../../constants");
+var core_1 = require("@posthog/core");
+var logger_1 = require("../../utils/logger");
+var globals_1 = require("../../utils/globals");
+var triggerMatching_1 = require("./triggerMatching");
+var LOGGER_PREFIX = '[SessionRecording]';
+var logger = (0, logger_1.createLogger)(LOGGER_PREFIX);
+/**
+ * This only exists to let us test changes to sessionrecording.ts before rolling them out to everyone
+ * it should not be depended on in other ways, since i'm going to delete it long before the end of September 2025
+ */
+var SessionRecordingWrapper = /** @class */ (function () {
+    function SessionRecordingWrapper(_instance) {
+        this._instance = _instance;
+        this._forceAllowLocalhostNetworkCapture = false;
+        this._receivedFlags = false;
+        this._persistFlagsOnSessionListener = undefined;
+        if (!this._instance.sessionManager) {
+            logger.error('started without valid sessionManager');
+            throw new Error(LOGGER_PREFIX + ' started without valid sessionManager. This is a bug.');
+        }
+        if (this._instance.config.cookieless_mode === 'always') {
+            throw new Error(LOGGER_PREFIX + ' cannot be used with cookieless_mode="always"');
+        }
+    }
+    Object.defineProperty(SessionRecordingWrapper.prototype, "started", {
+        get: function () {
+            var _a;
+            return !!((_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.isStarted);
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SessionRecordingWrapper.prototype, "status", {
+        /**
+         * defaults to buffering mode until a flags response is received
+         * once a flags response is received status can be disabled, active or sampled
+         */
+        get: function () {
+            if (this._lazyLoadedSessionRecording) {
+                return this._lazyLoadedSessionRecording.status;
+            }
+            if (this._receivedFlags && !this._isRecordingEnabled) {
+                return triggerMatching_1.DISABLED;
+            }
+            return triggerMatching_1.LAZY_LOADING;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(SessionRecordingWrapper.prototype, "_isRecordingEnabled", {
+        get: function () {
+            var _a;
+            var enabled_server_side = !!((_a = this._instance.get_property(constants_1.SESSION_RECORDING_REMOTE_CONFIG)) === null || _a === void 0 ? void 0 : _a.enabled);
+            var enabled_client_side = !this._instance.config.disable_session_recording;
+            var isDisabled = this._instance.config.disable_session_recording || this._instance.consent.isOptedOut();
+            return globals_1.window && enabled_server_side && enabled_client_side && !isDisabled;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SessionRecordingWrapper.prototype.startIfEnabledOrStop = function (startReason) {
+        var _a;
+        if (this._isRecordingEnabled && ((_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.isStarted)) {
+            return;
+        }
+        // According to the rrweb docs, rrweb is not supported on IE11 and below:
+        // "rrweb does not support IE11 and below because it uses the MutationObserver API, which was supported by these browsers."
+        // https://github.com/rrweb-io/rrweb/blob/master/guide.md#compatibility-note
+        //
+        // However, MutationObserver does exist on IE11, it just doesn't work well and does not detect all changes.
+        // Instead, when we load "recorder.js", the first JS error is about "Object.assign" and "Array.from" being undefined.
+        // Thus instead of MutationObserver, we look for this function and block recording if it's undefined.
+        var canRunReplay = !(0, core_1.isUndefined)(Object.assign) && !(0, core_1.isUndefined)(Array.from);
+        if (this._isRecordingEnabled && canRunReplay) {
+            this._lazyLoadAndStart(startReason);
+            logger.info('starting');
+        }
+        else {
+            this.stopRecording();
+        }
+    };
+    /**
+     * session recording waits until it receives remote config before loading the script
+     * this is to ensure we can control the script name remotely
+     * and because we wait until we have local and remote config to determine if we should start at all
+     * if start is called and there is no remote config then we wait until there is
+     */
+    SessionRecordingWrapper.prototype._lazyLoadAndStart = function (startReason) {
+        var _this = this;
+        var _a, _b, _c, _d, _e;
+        // by checking `_isRecordingEnabled` here we know that
+        // we have stored remote config and client config to read
+        // replay waits for both local and remote config before starting
+        if (!this._isRecordingEnabled) {
+            return;
+        }
+        // If recorder.js is already loaded (if array.full.js snippet is used or posthog-js/dist/recorder is
+        // imported), don't load the script. Otherwise, remotely import recorder.js from cdn since it hasn't been loaded.
+        if (!((_b = (_a = globals_1.assignableWindow === null || globals_1.assignableWindow === void 0 ? void 0 : globals_1.assignableWindow.__PosthogExtensions__) === null || _a === void 0 ? void 0 : _a.rrweb) === null || _b === void 0 ? void 0 : _b.record) ||
+            !((_c = globals_1.assignableWindow.__PosthogExtensions__) === null || _c === void 0 ? void 0 : _c.initSessionRecording)) {
+            (_e = (_d = globals_1.assignableWindow.__PosthogExtensions__) === null || _d === void 0 ? void 0 : _d.loadExternalDependency) === null || _e === void 0 ? void 0 : _e.call(_d, this._instance, this._scriptName, function (err) {
+                if (err) {
+                    return logger.error('could not load recorder', err);
+                }
+                _this._onScriptLoaded(startReason);
+            });
+        }
+        else {
+            this._onScriptLoaded(startReason);
+        }
+    };
+    SessionRecordingWrapper.prototype.stopRecording = function () {
+        var _a;
+        (_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.stop();
+    };
+    SessionRecordingWrapper.prototype._resetSampling = function () {
+        var _a;
+        (_a = this._instance.persistence) === null || _a === void 0 ? void 0 : _a.unregister(constants_1.SESSION_RECORDING_IS_SAMPLED);
+    };
+    SessionRecordingWrapper.prototype._persistRemoteConfig = function (response) {
+        var _this = this;
+        var _a, _b;
+        if (this._instance.persistence) {
+            var persistence_1 = this._instance.persistence;
+            var persistResponse = function () {
+                var _a;
+                var sessionRecordingConfigResponse = response.sessionRecording === false ? undefined : response.sessionRecording;
+                var receivedSampleRate = sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.sampleRate;
+                var parsedSampleRate = (0, core_1.isNullish)(receivedSampleRate) ? null : parseFloat(receivedSampleRate);
+                if ((0, core_1.isNullish)(parsedSampleRate)) {
+                    _this._resetSampling();
+                }
+                var receivedMinimumDuration = sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.minimumDurationMilliseconds;
+                persistence_1.register((_a = {},
+                    _a[constants_1.SESSION_RECORDING_REMOTE_CONFIG] = __assign(__assign({ enabled: !!sessionRecordingConfigResponse }, sessionRecordingConfigResponse), { networkPayloadCapture: __assign({ capturePerformance: response.capturePerformance }, sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.networkPayloadCapture), canvasRecording: {
+                            enabled: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.recordCanvas,
+                            fps: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.canvasFps,
+                            quality: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.canvasQuality,
+                        }, sampleRate: parsedSampleRate, minimumDurationMilliseconds: (0, core_1.isUndefined)(receivedMinimumDuration)
+                            ? null
+                            : receivedMinimumDuration, endpoint: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.endpoint, triggerMatchType: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.triggerMatchType, masking: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.masking, urlTriggers: sessionRecordingConfigResponse === null || sessionRecordingConfigResponse === void 0 ? void 0 : sessionRecordingConfigResponse.urlTriggers }),
+                    _a));
+            };
+            persistResponse();
+            // in case we see multiple flags responses, we should only use the response from the most recent one
+            (_a = this._persistFlagsOnSessionListener) === null || _a === void 0 ? void 0 : _a.call(this);
+            // we 100% know there is a session manager by this point
+            this._persistFlagsOnSessionListener = (_b = this._instance.sessionManager) === null || _b === void 0 ? void 0 : _b.onSessionId(persistResponse);
+        }
+    };
+    SessionRecordingWrapper.prototype.onRemoteConfig = function (response) {
+        if (!('sessionRecording' in response)) {
+            // if sessionRecording is not in the response, we do nothing
+            logger.info('skipping remote config with no sessionRecording', response);
+            return;
+        }
+        if (response.sessionRecording === false) {
+            // remotely disabled
+            this._receivedFlags = true;
+            return;
+        }
+        this._persistRemoteConfig(response);
+        this._receivedFlags = true;
+        // TODO how do we send a custom message with the received remote config like we used to for debug
+        this.startIfEnabledOrStop();
+    };
+    SessionRecordingWrapper.prototype.log = function (message, level) {
+        var _a;
+        if (level === void 0) { level = 'log'; }
+        if ((_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.log) {
+            this._lazyLoadedSessionRecording.log(message, level);
+        }
+        else {
+            logger.warn('log called before recorder was ready');
+        }
+    };
+    Object.defineProperty(SessionRecordingWrapper.prototype, "_scriptName", {
+        get: function () {
+            var _a, _b, _c;
+            var remoteConfig = (_b = (_a = this._instance) === null || _a === void 0 ? void 0 : _a.persistence) === null || _b === void 0 ? void 0 : _b.get_property(constants_1.SESSION_RECORDING_REMOTE_CONFIG);
+            return ((_c = remoteConfig === null || remoteConfig === void 0 ? void 0 : remoteConfig.scriptConfig) === null || _c === void 0 ? void 0 : _c.script) || 'lazy-recorder';
+        },
+        enumerable: false,
+        configurable: true
+    });
+    SessionRecordingWrapper.prototype._onScriptLoaded = function (startReason) {
+        var _a, _b;
+        if (!((_a = globals_1.assignableWindow.__PosthogExtensions__) === null || _a === void 0 ? void 0 : _a.initSessionRecording)) {
+            throw Error('Called on script loaded before session recording is available');
+        }
+        if (!this._lazyLoadedSessionRecording) {
+            this._lazyLoadedSessionRecording = (_b = globals_1.assignableWindow.__PosthogExtensions__) === null || _b === void 0 ? void 0 : _b.initSessionRecording(this._instance);
+            this._lazyLoadedSessionRecording._forceAllowLocalhostNetworkCapture =
+                this._forceAllowLocalhostNetworkCapture;
+        }
+        this._lazyLoadedSessionRecording.start(startReason);
+    };
+    /**
+     * this is maintained on the public API only because it has always been on the public API
+     * if you are calling this directly you are certainly doing something wrong
+     * @deprecated
+     */
+    SessionRecordingWrapper.prototype.onRRwebEmit = function (rawEvent) {
+        var _a, _b;
+        (_b = (_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.onRRwebEmit) === null || _b === void 0 ? void 0 : _b.call(_a, rawEvent);
+    };
+    /**
+     * this ignores the linked flag config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({linked_flag: true})`
+     * */
+    SessionRecordingWrapper.prototype.overrideLinkedFlag = function () {
+        var _a;
+        // TODO what if this gets called before lazy loading is done
+        (_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.overrideLinkedFlag();
+    };
+    /**
+     * this ignores the sampling config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({sampling: true})`
+     * */
+    SessionRecordingWrapper.prototype.overrideSampling = function () {
+        var _a;
+        // TODO what if this gets called before lazy loading is done
+        (_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.overrideSampling();
+    };
+    /**
+     * this ignores the URL/Event trigger config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({trigger: 'url' | 'event'})`
+     * */
+    SessionRecordingWrapper.prototype.overrideTrigger = function (triggerType) {
+        var _a;
+        // TODO what if this gets called before lazy loading is done
+        (_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.overrideTrigger(triggerType);
+    };
+    Object.defineProperty(SessionRecordingWrapper.prototype, "sdkDebugProperties", {
+        /*
+         * whenever we capture an event, we add these properties to the event
+         * these are used to debug issues with the session recording
+         * when looking at the event feed for a session
+         */
+        get: function () {
+            var _a;
+            return (((_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.sdkDebugProperties) || {
+                $recording_status: this.status,
+            });
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * This adds a custom event to the session recording
+     *
+     * It is not intended for arbitrary public use - playback only displays known custom events
+     * And is exposed on the public interface only so that other parts of the SDK are able to use it
+     *
+     * if you are calling this from client code, you're probably looking for `posthog.capture('$custom_event', {...})`
+     */
+    SessionRecordingWrapper.prototype.tryAddCustomEvent = function (tag, payload) {
+        var _a;
+        return !!((_a = this._lazyLoadedSessionRecording) === null || _a === void 0 ? void 0 : _a.tryAddCustomEvent(tag, payload));
+    };
+    return SessionRecordingWrapper;
+}());
+exports.SessionRecordingWrapper = SessionRecordingWrapper;
+//# sourceMappingURL=sessionrecording-wrapper.js.map

package/lib/src/extensions/replay/sessionrecording-wrapper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sessionrecording-wrapper.js","sourceRoot":"","sources":["../../../../src/extensions/replay/sessionrecording-wrapper.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,6CAA+F;AAK/F,sCAAsD;AACtD,6CAAiD;AACjD,+CAK4B;AAC5B,qDAA+F;AAE/F,IAAM,aAAa,GAAG,oBAAoB,CAAA;AAC1C,IAAM,MAAM,GAAG,IAAA,qBAAY,EAAC,aAAa,CAAC,CAAA;AAE1C;;;GAGG;AACH;IA4BI,iCAA6B,SAAkB;QAAlB,cAAS,GAAT,SAAS,CAAS;QA3B/C,uCAAkC,GAAY,KAAK,CAAA;QAE3C,mBAAc,GAAY,KAAK,CAAA;QAE/B,mCAA8B,GAA6B,SAAS,CAAA;QAwBxE,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,cAAc,EAAE,CAAC;YACjC,MAAM,CAAC,KAAK,CAAC,sCAAsC,CAAC,CAAA;YACpD,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,uDAAuD,CAAC,CAAA;QAC5F,CAAC;QAED,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,eAAe,KAAK,QAAQ,EAAE,CAAC;YACrD,MAAM,IAAI,KAAK,CAAC,aAAa,GAAG,+CAA+C,CAAC,CAAA;QACpF,CAAC;IACL,CAAC;IA7BD,sBAAW,4CAAO;aAAlB;;YACI,OAAO,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,2BAA2B,0CAAE,SAAS,CAAA,CAAA;QACxD,CAAC;;;OAAA;IAMD,sBAAI,2CAAM;QAJV;;;WAGG;aACH;YACI,IAAI,IAAI,CAAC,2BAA2B,EAAE,CAAC;gBACnC,OAAO,IAAI,CAAC,2BAA2B,CAAC,MAAM,CAAA;YAClD,CAAC;YAED,IAAI,IAAI,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACnD,OAAO,0BAAQ,CAAA;YACnB,CAAC;YAED,OAAO,8BAAY,CAAA;QACvB,CAAC;;;OAAA;IAaD,sBAAY,wDAAmB;aAA/B;;YACI,IAAM,mBAAmB,GAAG,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,2CAA+B,CAAC,0CAAE,OAAO,CAAA,CAAA;YACnG,IAAM,mBAAmB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAyB,CAAA;YAC5E,IAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,yBAAyB,IAAI,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,CAAA;YACzG,OAAO,gBAAM,IAAI,mBAAmB,IAAI,mBAAmB,IAAI,CAAC,UAAU,CAAA;QAC9E,CAAC;;;OAAA;IAED,sDAAoB,GAApB,UAAqB,WAAgC;;QACjD,IAAI,IAAI,CAAC,mBAAmB,KAAI,MAAA,IAAI,CAAC,2BAA2B,0CAAE,SAAS,CAAA,EAAE,CAAC;YAC1E,OAAM;QACV,CAAC;QAED,yEAAyE;QACzE,2HAA2H;QAC3H,4EAA4E;QAC5E,EAAE;QACF,2GAA2G;QAC3G,qHAAqH;QACrH,qGAAqG;QACrG,IAAM,YAAY,GAAG,CAAC,IAAA,kBAAW,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAA,kBAAW,EAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAC5E,IAAI,IAAI,CAAC,mBAAmB,IAAI,YAAY,EAAE,CAAC;YAC3C,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAA;YACnC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;QAC3B,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,aAAa,EAAE,CAAA;QACxB,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,mDAAiB,GAAzB,UAA0B,WAAgC;QAA1D,iBA2BC;;QA1BG,sDAAsD;QACtD,yDAAyD;QACzD,gEAAgE;QAChE,IAAI,CAAC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5B,OAAM;QACV,CAAC;QAED,oGAAoG;QACpG,iHAAiH;QACjH,IACI,CAAC,CAAA,MAAA,MAAA,0BAAgB,aAAhB,0BAAgB,uBAAhB,0BAAgB,CAAE,qBAAqB,0CAAE,KAAK,0CAAE,MAAM,CAAA;YACvD,CAAC,CAAA,MAAA,0BAAgB,CAAC,qBAAqB,0CAAE,oBAAoB,CAAA,EAC/D,CAAC;YACC,MAAA,MAAA,0BAAgB,CAAC,qBAAqB,0CAAE,sBAAsB,mDAC1D,IAAI,CAAC,SAAS,EACd,IAAI,CAAC,WAAW,EAChB,UAAC,GAAG;gBACA,IAAI,GAAG,EAAE,CAAC;oBACN,OAAO,MAAM,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,CAAC,CAAA;gBACvD,CAAC;gBACD,KAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;YACrC,CAAC,CACJ,CAAA;QACL,CAAC;aAAM,CAAC;YACJ,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,CAAA;QACrC,CAAC;IACL,CAAC;IAED,+CAAa,GAAb;;QACI,MAAA,IAAI,CAAC,2BAA2B,0CAAE,IAAI,EAAE,CAAA;IAC5C,CAAC;IAEO,gDAAc,GAAtB;;QACI,MAAA,IAAI,CAAC,SAAS,CAAC,WAAW,0CAAE,UAAU,CAAC,wCAA4B,CAAC,CAAA;IACxE,CAAC;IAEO,sDAAoB,GAA5B,UAA6B,QAAsB;QAAnD,iBAiDC;;QAhDG,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;YAC7B,IAAM,aAAW,GAAG,IAAI,CAAC,SAAS,CAAC,WAAW,CAAA;YAE9C,IAAM,eAAe,GAAG;;gBACpB,IAAM,8BAA8B,GAChC,QAAQ,CAAC,gBAAgB,KAAK,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAA;gBAE/E,IAAM,kBAAkB,GAAG,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,UAAU,CAAA;gBAErE,IAAM,gBAAgB,GAAG,IAAA,gBAAS,EAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,UAAU,CAAC,kBAAkB,CAAC,CAAA;gBAC9F,IAAI,IAAA,gBAAS,EAAC,gBAAgB,CAAC,EAAE,CAAC;oBAC9B,KAAI,CAAC,cAAc,EAAE,CAAA;gBACzB,CAAC;gBAED,IAAM,uBAAuB,GAAG,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,2BAA2B,CAAA;gBAE3F,aAAW,CAAC,QAAQ;oBAChB,GAAC,2CAA+B,IAAG,oBAC/B,OAAO,EAAE,CAAC,CAAC,8BAA8B,IACtC,8BAA8B,KACjC,qBAAqB,aACjB,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,IAC5C,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,qBAAqB,GAE5D,eAAe,EAAE;4BACb,OAAO,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,YAAY;4BACrD,GAAG,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,SAAS;4BAC9C,OAAO,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,aAAa;yBACzD,EACD,UAAU,EAAE,gBAAgB,EAC5B,2BAA2B,EAAE,IAAA,kBAAW,EAAC,uBAAuB,CAAC;4BAC7D,CAAC,CAAC,IAAI;4BACN,CAAC,CAAC,uBAAuB,EAC7B,QAAQ,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,QAAQ,EAClD,gBAAgB,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,gBAAgB,EAClE,OAAO,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,OAAO,EAChD,WAAW,EAAE,8BAA8B,aAA9B,8BAA8B,uBAA9B,8BAA8B,CAAE,WAAW,GACjB;wBAC7C,CAAA;YACN,CAAC,CAAA;YAED,eAAe,EAAE,CAAA;YAEjB,oGAAoG;YACpG,MAAA,IAAI,CAAC,8BAA8B,oDAAI,CAAA;YACvC,wDAAwD;YACxD,IAAI,CAAC,8BAA8B,GAAG,MAAA,IAAI,CAAC,SAAS,CAAC,cAAc,0CAAE,WAAW,CAAC,eAAe,CAAC,CAAA;QACrG,CAAC;IACL,CAAC;IAED,gDAAc,GAAd,UAAe,QAAsB;QACjC,IAAI,CAAC,CAAC,kBAAkB,IAAI,QAAQ,CAAC,EAAE,CAAC;YACpC,4DAA4D;YAC5D,MAAM,CAAC,IAAI,CAAC,iDAAiD,EAAE,QAAQ,CAAC,CAAA;YACxE,OAAM;QACV,CAAC;QACD,IAAI,QAAQ,CAAC,gBAAgB,KAAK,KAAK,EAAE,CAAC;YACtC,oBAAoB;YACpB,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;YAC1B,OAAM;QACV,CAAC;QAED,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAA;QACnC,IAAI,CAAC,cAAc,GAAG,IAAI,CAAA;QAC1B,iGAAiG;QACjG,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC/B,CAAC;IAED,qCAAG,GAAH,UAAI,OAAe,EAAE,KAAuC;;QAAvC,sBAAA,EAAA,aAAuC;QACxD,IAAI,MAAA,IAAI,CAAC,2BAA2B,0CAAE,GAAG,EAAE,CAAC;YACxC,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QACxD,CAAC;aAAM,CAAC;YACJ,MAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAA;QACvD,CAAC;IACL,CAAC;IAED,sBAAY,gDAAW;aAAvB;;YACI,IAAM,YAAY,GAAgD,MAAA,MAAA,IAAI,CAAC,SAAS,0CAAE,WAAW,0CAAE,YAAY,CACvG,2CAA+B,CAClC,CAAA;YACD,OAAO,CAAC,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,YAAY,0CAAE,MAA+B,KAAI,eAAe,CAAA;QAC1F,CAAC;;;OAAA;IAEO,iDAAe,GAAvB,UAAwB,WAAgC;;QACpD,IAAI,CAAC,CAAA,MAAA,0BAAgB,CAAC,qBAAqB,0CAAE,oBAAoB,CAAA,EAAE,CAAC;YAChE,MAAM,KAAK,CAAC,+DAA+D,CAAC,CAAA;QAChF,CAAC;QAED,IAAI,CAAC,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACpC,IAAI,CAAC,2BAA2B,GAAG,MAAA,0BAAgB,CAAC,qBAAqB,0CAAE,oBAAoB,CAC3F,IAAI,CAAC,SAAS,CACjB,CACA;YAAC,IAAI,CAAC,2BAAmC,CAAC,kCAAkC;gBACzE,IAAI,CAAC,kCAAkC,CAAA;QAC/C,CAAC;QAED,IAAI,CAAC,2BAA2B,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;IACvD,CAAC;IAED;;;;OAIG;IACH,6CAAW,GAAX,UAAY,QAAuB;;QAC/B,MAAA,MAAA,IAAI,CAAC,2BAA2B,0CAAE,WAAW,mDAAG,QAAQ,CAAC,CAAA;IAC7D,CAAC;IAED;;;;;SAKK;IACE,oDAAkB,GAAzB;;QACI,4DAA4D;QAC5D,MAAA,IAAI,CAAC,2BAA2B,0CAAE,kBAAkB,EAAE,CAAA;IAC1D,CAAC;IAED;;;;;SAKK;IACE,kDAAgB,GAAvB;;QACI,4DAA4D;QAC5D,MAAA,IAAI,CAAC,2BAA2B,0CAAE,gBAAgB,EAAE,CAAA;IACxD,CAAC;IAED;;;;;SAKK;IACE,iDAAe,GAAtB,UAAuB,WAAwB;;QAC3C,4DAA4D;QAC5D,MAAA,IAAI,CAAC,2BAA2B,0CAAE,eAAe,CAAC,WAAW,CAAC,CAAA;IAClE,CAAC;IAOD,sBAAI,uDAAkB;QALtB;;;;WAIG;aACH;;YACI,OAAO,CACH,CAAA,MAAA,IAAI,CAAC,2BAA2B,0CAAE,kBAAkB,KAAI;gBACpD,iBAAiB,EAAE,IAAI,CAAC,MAAM;aACjC,CACJ,CAAA;QACL,CAAC;;;OAAA;IAED;;;;;;;OAOG;IACH,mDAAiB,GAAjB,UAAkB,GAAW,EAAE,OAAY;;QACvC,OAAO,CAAC,CAAC,CAAA,MAAA,IAAI,CAAC,2BAA2B,0CAAE,iBAAiB,CAAC,GAAG,EAAE,OAAO,CAAC,CAAA,CAAA;IAC9E,CAAC;IACL,8BAAC;AAAD,CAAC,AApRD,IAoRC;AApRY,0DAAuB","sourcesContent":["import { SESSION_RECORDING_IS_SAMPLED, SESSION_RECORDING_REMOTE_CONFIG } from '../../constants'\nimport { PostHog } from '../../posthog-core'\nimport { Properties, RemoteConfig, SessionRecordingPersistedConfig, SessionStartReason } from '../../types'\nimport { type eventWithTime } from '@rrweb/types'\n\nimport { isNullish, isUndefined } from '@posthog/core'\nimport { createLogger } from '../../utils/logger'\nimport {\n    assignableWindow,\n    LazyLoadedSessionRecordingInterface,\n    PostHogExtensionKind,\n    window,\n} from '../../utils/globals'\nimport { DISABLED, LAZY_LOADING, SessionRecordingStatus, TriggerType } from './triggerMatching'\n\nconst LOGGER_PREFIX = '[SessionRecording]'\nconst logger = createLogger(LOGGER_PREFIX)\n\n/**\n * This only exists to let us test changes to sessionrecording.ts before rolling them out to everyone\n * it should not be depended on in other ways, since i'm going to delete it long before the end of September 2025\n */\nexport class SessionRecordingWrapper {\n    _forceAllowLocalhostNetworkCapture: boolean = false\n\n    private _receivedFlags: boolean = false\n\n    private _persistFlagsOnSessionListener: (() => void) | undefined = undefined\n    private _lazyLoadedSessionRecording: LazyLoadedSessionRecordingInterface | undefined\n\n    public get started(): boolean {\n        return !!this._lazyLoadedSessionRecording?.isStarted\n    }\n\n    /**\n     * defaults to buffering mode until a flags response is received\n     * once a flags response is received status can be disabled, active or sampled\n     */\n    get status(): SessionRecordingStatus {\n        if (this._lazyLoadedSessionRecording) {\n            return this._lazyLoadedSessionRecording.status\n        }\n\n        if (this._receivedFlags && !this._isRecordingEnabled) {\n            return DISABLED\n        }\n\n        return LAZY_LOADING\n    }\n\n    constructor(private readonly _instance: PostHog) {\n        if (!this._instance.sessionManager) {\n            logger.error('started without valid sessionManager')\n            throw new Error(LOGGER_PREFIX + ' started without valid sessionManager. This is a bug.')\n        }\n\n        if (this._instance.config.cookieless_mode === 'always') {\n            throw new Error(LOGGER_PREFIX + ' cannot be used with cookieless_mode=\"always\"')\n        }\n    }\n\n    private get _isRecordingEnabled() {\n        const enabled_server_side = !!this._instance.get_property(SESSION_RECORDING_REMOTE_CONFIG)?.enabled\n        const enabled_client_side = !this._instance.config.disable_session_recording\n        const isDisabled = this._instance.config.disable_session_recording || this._instance.consent.isOptedOut()\n        return window && enabled_server_side && enabled_client_side && !isDisabled\n    }\n\n    startIfEnabledOrStop(startReason?: SessionStartReason) {\n        if (this._isRecordingEnabled && this._lazyLoadedSessionRecording?.isStarted) {\n            return\n        }\n\n        // According to the rrweb docs, rrweb is not supported on IE11 and below:\n        // \"rrweb does not support IE11 and below because it uses the MutationObserver API, which was supported by these browsers.\"\n        // https://github.com/rrweb-io/rrweb/blob/master/guide.md#compatibility-note\n        //\n        // However, MutationObserver does exist on IE11, it just doesn't work well and does not detect all changes.\n        // Instead, when we load \"recorder.js\", the first JS error is about \"Object.assign\" and \"Array.from\" being undefined.\n        // Thus instead of MutationObserver, we look for this function and block recording if it's undefined.\n        const canRunReplay = !isUndefined(Object.assign) && !isUndefined(Array.from)\n        if (this._isRecordingEnabled && canRunReplay) {\n            this._lazyLoadAndStart(startReason)\n            logger.info('starting')\n        } else {\n            this.stopRecording()\n        }\n    }\n\n    /**\n     * session recording waits until it receives remote config before loading the script\n     * this is to ensure we can control the script name remotely\n     * and because we wait until we have local and remote config to determine if we should start at all\n     * if start is called and there is no remote config then we wait until there is\n     */\n    private _lazyLoadAndStart(startReason?: SessionStartReason) {\n        // by checking `_isRecordingEnabled` here we know that\n        // we have stored remote config and client config to read\n        // replay waits for both local and remote config before starting\n        if (!this._isRecordingEnabled) {\n            return\n        }\n\n        // If recorder.js is already loaded (if array.full.js snippet is used or posthog-js/dist/recorder is\n        // imported), don't load the script. Otherwise, remotely import recorder.js from cdn since it hasn't been loaded.\n        if (\n            !assignableWindow?.__PosthogExtensions__?.rrweb?.record ||\n            !assignableWindow.__PosthogExtensions__?.initSessionRecording\n        ) {\n            assignableWindow.__PosthogExtensions__?.loadExternalDependency?.(\n                this._instance,\n                this._scriptName,\n                (err) => {\n                    if (err) {\n                        return logger.error('could not load recorder', err)\n                    }\n                    this._onScriptLoaded(startReason)\n                }\n            )\n        } else {\n            this._onScriptLoaded(startReason)\n        }\n    }\n\n    stopRecording() {\n        this._lazyLoadedSessionRecording?.stop()\n    }\n\n    private _resetSampling() {\n        this._instance.persistence?.unregister(SESSION_RECORDING_IS_SAMPLED)\n    }\n\n    private _persistRemoteConfig(response: RemoteConfig): void {\n        if (this._instance.persistence) {\n            const persistence = this._instance.persistence\n\n            const persistResponse = () => {\n                const sessionRecordingConfigResponse =\n                    response.sessionRecording === false ? undefined : response.sessionRecording\n\n                const receivedSampleRate = sessionRecordingConfigResponse?.sampleRate\n\n                const parsedSampleRate = isNullish(receivedSampleRate) ? null : parseFloat(receivedSampleRate)\n                if (isNullish(parsedSampleRate)) {\n                    this._resetSampling()\n                }\n\n                const receivedMinimumDuration = sessionRecordingConfigResponse?.minimumDurationMilliseconds\n\n                persistence.register({\n                    [SESSION_RECORDING_REMOTE_CONFIG]: {\n                        enabled: !!sessionRecordingConfigResponse,\n                        ...sessionRecordingConfigResponse,\n                        networkPayloadCapture: {\n                            capturePerformance: response.capturePerformance,\n                            ...sessionRecordingConfigResponse?.networkPayloadCapture,\n                        },\n                        canvasRecording: {\n                            enabled: sessionRecordingConfigResponse?.recordCanvas,\n                            fps: sessionRecordingConfigResponse?.canvasFps,\n                            quality: sessionRecordingConfigResponse?.canvasQuality,\n                        },\n                        sampleRate: parsedSampleRate,\n                        minimumDurationMilliseconds: isUndefined(receivedMinimumDuration)\n                            ? null\n                            : receivedMinimumDuration,\n                        endpoint: sessionRecordingConfigResponse?.endpoint,\n                        triggerMatchType: sessionRecordingConfigResponse?.triggerMatchType,\n                        masking: sessionRecordingConfigResponse?.masking,\n                        urlTriggers: sessionRecordingConfigResponse?.urlTriggers,\n                    } satisfies SessionRecordingPersistedConfig,\n                })\n            }\n\n            persistResponse()\n\n            // in case we see multiple flags responses, we should only use the response from the most recent one\n            this._persistFlagsOnSessionListener?.()\n            // we 100% know there is a session manager by this point\n            this._persistFlagsOnSessionListener = this._instance.sessionManager?.onSessionId(persistResponse)\n        }\n    }\n\n    onRemoteConfig(response: RemoteConfig) {\n        if (!('sessionRecording' in response)) {\n            // if sessionRecording is not in the response, we do nothing\n            logger.info('skipping remote config with no sessionRecording', response)\n            return\n        }\n        if (response.sessionRecording === false) {\n            // remotely disabled\n            this._receivedFlags = true\n            return\n        }\n\n        this._persistRemoteConfig(response)\n        this._receivedFlags = true\n        // TODO how do we send a custom message with the received remote config like we used to for debug\n        this.startIfEnabledOrStop()\n    }\n\n    log(message: string, level: 'log' | 'warn' | 'error' = 'log') {\n        if (this._lazyLoadedSessionRecording?.log) {\n            this._lazyLoadedSessionRecording.log(message, level)\n        } else {\n            logger.warn('log called before recorder was ready')\n        }\n    }\n\n    private get _scriptName(): PostHogExtensionKind {\n        const remoteConfig: SessionRecordingPersistedConfig | undefined = this._instance?.persistence?.get_property(\n            SESSION_RECORDING_REMOTE_CONFIG\n        )\n        return (remoteConfig?.scriptConfig?.script as PostHogExtensionKind) || 'lazy-recorder'\n    }\n\n    private _onScriptLoaded(startReason?: SessionStartReason) {\n        if (!assignableWindow.__PosthogExtensions__?.initSessionRecording) {\n            throw Error('Called on script loaded before session recording is available')\n        }\n\n        if (!this._lazyLoadedSessionRecording) {\n            this._lazyLoadedSessionRecording = assignableWindow.__PosthogExtensions__?.initSessionRecording(\n                this._instance\n            )\n            ;(this._lazyLoadedSessionRecording as any)._forceAllowLocalhostNetworkCapture =\n                this._forceAllowLocalhostNetworkCapture\n        }\n\n        this._lazyLoadedSessionRecording.start(startReason)\n    }\n\n    /**\n     * this is maintained on the public API only because it has always been on the public API\n     * if you are calling this directly you are certainly doing something wrong\n     * @deprecated\n     */\n    onRRwebEmit(rawEvent: eventWithTime) {\n        this._lazyLoadedSessionRecording?.onRRwebEmit?.(rawEvent)\n    }\n\n    /**\n     * this ignores the linked flag config and (if other conditions are met) causes capture to start\n     *\n     * It is not usual to call this directly,\n     * instead call `posthog.startSessionRecording({linked_flag: true})`\n     * */\n    public overrideLinkedFlag() {\n        // TODO what if this gets called before lazy loading is done\n        this._lazyLoadedSessionRecording?.overrideLinkedFlag()\n    }\n\n    /**\n     * this ignores the sampling config and (if other conditions are met) causes capture to start\n     *\n     * It is not usual to call this directly,\n     * instead call `posthog.startSessionRecording({sampling: true})`\n     * */\n    public overrideSampling() {\n        // TODO what if this gets called before lazy loading is done\n        this._lazyLoadedSessionRecording?.overrideSampling()\n    }\n\n    /**\n     * this ignores the URL/Event trigger config and (if other conditions are met) causes capture to start\n     *\n     * It is not usual to call this directly,\n     * instead call `posthog.startSessionRecording({trigger: 'url' | 'event'})`\n     * */\n    public overrideTrigger(triggerType: TriggerType) {\n        // TODO what if this gets called before lazy loading is done\n        this._lazyLoadedSessionRecording?.overrideTrigger(triggerType)\n    }\n\n    /*\n     * whenever we capture an event, we add these properties to the event\n     * these are used to debug issues with the session recording\n     * when looking at the event feed for a session\n     */\n    get sdkDebugProperties(): Properties {\n        return (\n            this._lazyLoadedSessionRecording?.sdkDebugProperties || {\n                $recording_status: this.status,\n            }\n        )\n    }\n\n    /**\n     * This adds a custom event to the session recording\n     *\n     * It is not intended for arbitrary public use - playback only displays known custom events\n     * And is exposed on the public interface only so that other parts of the SDK are able to use it\n     *\n     * if you are calling this from client code, you're probably looking for `posthog.capture('$custom_event', {...})`\n     */\n    tryAddCustomEvent(tag: string, payload: any): boolean {\n        return !!this._lazyLoadedSessionRecording?.tryAddCustomEvent(tag, payload)\n    }\n}\n"]}

package/lib/src/extensions/replay/sessionrecording.d.ts

@@ -0,0 +1,163 @@
+import { PostHog } from '../../posthog-core';
+import { Properties, RemoteConfig, SessionStartReason } from '../../types';
+import { EventType, type eventWithTime, IncrementalSource } from '@rrweb/types';
+import { SessionRecordingStatus, TriggerType } from './triggerMatching';
+export declare const RECORDING_IDLE_THRESHOLD_MS: number;
+export declare const RECORDING_MAX_EVENT_SIZE: number;
+export declare const RECORDING_BUFFER_TIMEOUT = 2000;
+export declare const SESSION_RECORDING_BATCH_KEY = "recordings";
+export interface SnapshotBuffer {
+    size: number;
+    data: any[];
+    sessionId: string;
+    windowId: string;
+}
+export type compressedFullSnapshotEvent = {
+    type: EventType.FullSnapshot;
+    data: string;
+};
+export type compressedIncrementalSnapshotEvent = {
+    type: EventType.IncrementalSnapshot;
+    data: {
+        source: IncrementalSource;
+        texts: string;
+        attributes: string;
+        removes: string;
+        adds: string;
+    };
+};
+export type compressedIncrementalStyleSnapshotEvent = {
+    type: EventType.IncrementalSnapshot;
+    data: {
+        source: IncrementalSource.StyleSheetRule;
+        id?: number;
+        styleId?: number;
+        replace?: string;
+        replaceSync?: string;
+        adds?: string;
+        removes?: string;
+    };
+};
+export type compressedEvent = compressedIncrementalStyleSnapshotEvent | compressedFullSnapshotEvent | compressedIncrementalSnapshotEvent;
+export type compressedEventWithTime = compressedEvent & {
+    timestamp: number;
+    delay?: number;
+    cv: '2024-10';
+};
+export declare class SessionRecording {
+    private readonly _instance;
+    private _endpoint;
+    private _flushBufferTimer?;
+    private _statusMatcher;
+    private _receivedFlags;
+    private _buffer;
+    private _queuedRRWebEvents;
+    private _mutationThrottler?;
+    private _captureStarted;
+    private _stopRrweb;
+    private _isIdle;
+    private _lastActivityTimestamp;
+    private _windowId;
+    private _sessionId;
+    get sessionId(): string;
+    private _linkedFlagMatching;
+    private _urlTriggerMatching;
+    private _eventTriggerMatching;
+    private _triggerMatching;
+    private _fullSnapshotTimer?;
+    private _removePageViewCaptureHook;
+    private _onSessionIdListener;
+    private _persistFlagsOnSessionListener;
+    private _samplingSessionListener;
+    private _lastHref?;
+    private _removeEventTriggerCaptureHook;
+    _forceAllowLocalhostNetworkCapture: boolean;
+    private get _sessionIdleThresholdMilliseconds();
+    get started(): boolean;
+    private get _sessionManager();
+    private get _fullSnapshotIntervalMillis();
+    private get _isSampled();
+    private get _sessionDuration();
+    private get _isRecordingEnabled();
+    private get _isConsoleLogCaptureEnabled();
+    private get _canvasRecording();
+    private get _networkPayloadCapture();
+    private get _masking();
+    private get _sampleRate();
+    private get _minimumDuration();
+    /**
+     * defaults to buffering mode until a flags response is received
+     * once a flags response is received status can be disabled, active or sampled
+     */
+    get status(): SessionRecordingStatus;
+    constructor(_instance: PostHog);
+    private _onBeforeUnload;
+    private _onOffline;
+    private _onOnline;
+    private _onVisibilityChange;
+    startIfEnabledOrStop(startReason?: SessionStartReason): void;
+    stopRecording(): void;
+    private _resetSampling;
+    private _makeSamplingDecision;
+    onRemoteConfig(response: RemoteConfig): void;
+    /**
+     * This might be called more than once so needs to be idempotent
+     */
+    private _setupSampling;
+    private _persistRemoteConfig;
+    log(message: string, level?: 'log' | 'warn' | 'error'): void;
+    private _startCapture;
+    private get _scriptName();
+    private _isInteractiveEvent;
+    private _updateWindowAndSessionIds;
+    private _tryRRWebMethod;
+    /**
+     * This adds a custom event to the session recording
+     *
+     * It is not intended for arbitrary public use - playback only displays known custom events
+     * And is exposed on the public interface only so that other parts of the SDK are able to use it
+     *
+     * if you are calling this from client code, you're probably looking for `posthog.capture('$custom_event', {...})`
+     */
+    tryAddCustomEvent(tag: string, payload: any): boolean;
+    private _tryTakeFullSnapshot;
+    private _onScriptLoaded;
+    private _scheduleFullSnapshot;
+    private _gatherRRWebPlugins;
+    onRRwebEmit(rawEvent: eventWithTime): void;
+    private _pageViewFallBack;
+    private _processQueuedEvents;
+    private _maskUrl;
+    private _clearBufferBeforeMostRecentMeta;
+    private _clearBuffer;
+    private _flushBuffer;
+    private _captureSnapshotBuffered;
+    private _captureSnapshot;
+    private _activateTrigger;
+    private _pauseRecording;
+    private _resumeRecording;
+    private _addEventTriggerListener;
+    /**
+     * this ignores the linked flag config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({linked_flag: true})`
+     * */
+    overrideLinkedFlag(): void;
+    /**
+     * this ignores the sampling config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({sampling: true})`
+     * */
+    overrideSampling(): void;
+    /**
+     * this ignores the URL/Event trigger config and (if other conditions are met) causes capture to start
+     *
+     * It is not usual to call this directly,
+     * instead call `posthog.startSessionRecording({trigger: 'url' | 'event'})`
+     * */
+    overrideTrigger(triggerType: TriggerType): void;
+    private _reportStarted;
+    get sdkDebugProperties(): Properties;
+}