@statsig/session-replay 3.30.2 → 3.31.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statsig/session-replay",
-  "version": "3.30.2",
+  "version": "3.31.0",
   "license": "ISC",
   "homepage": "https://github.com/statsig-io/js-client-monorepo",
   "repository": {
@@ -11,7 +11,7 @@
   "dependencies": {
     "rrweb": "2.0.0-alpha.17",
     "@rrweb/record": "2.0.0-alpha.17",
-    "@statsig/client-core": "3.30.2"
+    "@statsig/client-core": "3.31.0"
   },
   "devDependencies": {
     "@rrweb/types": "2.0.0-alpha.16"

package/src/SessionReplay.js

@@ -24,15 +24,20 @@ function runStatsigSessionReplay(client, options) {
 exports.runStatsigSessionReplay = runStatsigSessionReplay;
 class SessionReplay extends SessionReplayBase_1.SessionReplayBase {
     constructor(client, options) {
-        var _a;
-        super(client, options);
+        var _a, _b;
+        let newOptions = options;
+        const privacySettings = (_a = client.getContext().values) === null || _a === void 0 ? void 0 : _a.session_recording_privacy_settings;
+        if (privacySettings) {
+            newOptions = (0, SessionReplayUtils_1.getNewOptionsWithPrivacySettings)(newOptions !== null && newOptions !== void 0 ? newOptions : {}, privacySettings);
+        }
+        super(client, newOptions);
         this._client.$on('values_updated', () => {
             var _a;
             if (!this._wasStopped) {
                 this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
             }
         });
-        this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+        this._attemptToStartRecording((_b = this._options) === null || _b === void 0 ? void 0 : _b.forceRecording);
     }
     _shutdown(endReason) {
         super._shutdownImpl(endReason);

package/src/SessionReplayUtils.d.ts

@@ -1,5 +1,6 @@
-import { StatsigEvent } from '@statsig/client-core';
+import { SessionReplayPrivacySettings, StatsigEvent } from '@statsig/client-core';
 import { ReplaySessionData } from './SessionReplayClient';
+import { SessionReplayOptions } from './TriggeredSessionReplay';
 export type RRWebPayload = {
     session_start_ts: string;
     session_end_ts: string;
@@ -23,3 +24,4 @@ export declare function _makeLoggableRrwebEvent(slice: string, payload: string,
 };
 export declare function _slicePayload(payload: string): string[];
 export declare function _appendSlicedMetadata(metadata: RRWebPayload, slicedID: string, sliceIndex: number, sliceCount: number, sliceByteSize: number): void;
+export declare function getNewOptionsWithPrivacySettings(originalOptions: SessionReplayOptions, privacySettings: SessionReplayPrivacySettings): SessionReplayOptions;

package/src/SessionReplayUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports._appendSlicedMetadata = exports._slicePayload = exports._makeLoggableRrwebEvent = exports.MAX_LOGS = exports.MAX_INDIVIDUAL_EVENT_BYTES = exports.REPLAY_ENQUEUE_TRIGGER_BYTES = void 0;
+exports.getNewOptionsWithPrivacySettings = exports._appendSlicedMetadata = exports._slicePayload = exports._makeLoggableRrwebEvent = exports.MAX_LOGS = exports.MAX_INDIVIDUAL_EVENT_BYTES = exports.REPLAY_ENQUEUE_TRIGGER_BYTES = void 0;
 const client_core_1 = require("@statsig/client-core");
 const REPLAY_SLICE_BYTES = 1024 * 1024; // 1 MB
 exports.REPLAY_ENQUEUE_TRIGGER_BYTES = 1024 * 10; // 10 KB
@@ -38,3 +38,30 @@ function _appendSlicedMetadata(metadata, slicedID, sliceIndex, sliceCount, slice
     metadata.slice_byte_size = String(sliceByteSize);
 }
 exports._appendSlicedMetadata = _appendSlicedMetadata;
+function getNewOptionsWithPrivacySettings(originalOptions, privacySettings) {
+    const maskValue = (value) => {
+        return value.replace(/./g, '*');
+    };
+    const blockSelector = privacySettings.blocked_elements
+        ? privacySettings.blocked_elements.join(', ')
+        : undefined;
+    const maskTextSelector = privacySettings.masked_elements
+        ? privacySettings.masked_elements.join(', ')
+        : undefined;
+    const maskInputFn = (value, element) => {
+        var _a, _b;
+        if ((_a = privacySettings.masked_elements) === null || _a === void 0 ? void 0 : _a.some((sel) => element.closest(sel))) {
+            return maskValue(value);
+        }
+        if ((_b = privacySettings.unmasked_elements) === null || _b === void 0 ? void 0 : _b.some((sel) => element.closest(sel))) {
+            return value;
+        }
+        return privacySettings.privacy_mode === 'max' ||
+            privacySettings.privacy_mode === 'input'
+            ? maskValue(value)
+            : value;
+    };
+    return Object.assign(Object.assign({}, originalOptions), { rrwebConfig: Object.assign(Object.assign({}, originalOptions === null || originalOptions === void 0 ? void 0 : originalOptions.rrwebConfig), { maskTextFn: maskValue, maskInputFn,
+            maskTextSelector, maskAllInputs: true, maskInputOptions: undefined, blockSelector }) });
+}
+exports.getNewOptionsWithPrivacySettings = getNewOptionsWithPrivacySettings;

package/src/TriggeredSessionReplay.d.ts

@@ -1,7 +1,7 @@
 import { PrecomputedEvaluationsInterface, StatsigPlugin } from '@statsig/client-core';
 import { EndReason, SessionReplayBase } from './SessionReplayBase';
 import { RRWebConfig, ReplayEvent, ReplaySessionData } from './SessionReplayClient';
-type SessionReplayOptions = {
+export type SessionReplayOptions = {
     rrwebConfig?: RRWebConfig;
     forceRecording?: boolean;
 };
@@ -15,7 +15,7 @@ export declare class StatsigTriggeredSessionReplayPlugin implements StatsigPlugi
     constructor(options?: TriggeredSessionReplayOptions | undefined);
     bind(client: PrecomputedEvaluationsInterface): void;
 }
-export declare function runStatsigTriggeredSessionReplay(client: PrecomputedEvaluationsInterface, options?: SessionReplayOptions): void;
+export declare function runStatsigTriggeredSessionReplay(client: PrecomputedEvaluationsInterface, options?: TriggeredSessionReplayOptions): void;
 export declare class TriggeredSessionReplay extends SessionReplayBase {
     private _runningEventData;
     private _isActiveRecording;
@@ -34,4 +34,3 @@ export declare class TriggeredSessionReplay extends SessionReplayBase {
     protected _attemptToStartRollingWindow(): void;
     protected _attemptToStartRecording(force?: boolean): void;
 }
-export {};

package/src/TriggeredSessionReplay.js

@@ -22,15 +22,20 @@ function runStatsigTriggeredSessionReplay(client, options) {
 exports.runStatsigTriggeredSessionReplay = runStatsigTriggeredSessionReplay;
 class TriggeredSessionReplay extends SessionReplayBase_1.SessionReplayBase {
     constructor(client, options) {
-        var _a;
-        super(client, options);
+        var _a, _b;
+        let newOptions = options;
+        const privacySettings = (_a = client.getContext().values) === null || _a === void 0 ? void 0 : _a.session_recording_privacy_settings;
+        if (privacySettings) {
+            newOptions = (0, SessionReplayUtils_1.getNewOptionsWithPrivacySettings)(newOptions !== null && newOptions !== void 0 ? newOptions : {}, privacySettings);
+        }
+        super(client, newOptions);
         this._runningEventData = [];
         this._isActiveRecording = false;
-        this._subscribeToClientEvents(options);
-        if (options === null || options === void 0 ? void 0 : options.autoStartRecording) {
-            this._attemptToStartRecording((_a = this._options) === null || _a === void 0 ? void 0 : _a.forceRecording);
+        this._subscribeToClientEvents(newOptions);
+        if (newOptions === null || newOptions === void 0 ? void 0 : newOptions.autoStartRecording) {
+            this._attemptToStartRecording((_b = this._options) === null || _b === void 0 ? void 0 : _b.forceRecording);
         }
-        else if (options === null || options === void 0 ? void 0 : options.keepRollingWindow) {
+        else if (newOptions === null || newOptions === void 0 ? void 0 : newOptions.keepRollingWindow) {
             this._attemptToStartRollingWindow();
         }
     }