@plushanalytics/react-native-session-replay 3.0.0 → 3.0.4

package/lib/typescript/module/src/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,SAAS,EACT,cAAc,IAAI,kBAAkB,EACpC,oBAAoB,IAAI,UAAU,EAClC,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,uBAAuB,IAAI,2BAA2B,EACtD,cAAc,EACd,YAAY,EACZ,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,GAAG;IAElE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,UAAU,CAAC;AAE9C,YAAY,EACV,aAAa,EACb,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,YAAY,EACZ,mBAAmB,EACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,uBAAuB,GAAG,aAAa,CAAC,GAAG;IAC/F,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EACb,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,SAAS,EACT,cAAc,IAAI,kBAAkB,EACpC,oBAAoB,IAAI,UAAU,EAClC,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,uBAAuB,IAAI,2BAA2B,EACtD,cAAc,EACd,YAAY,EACZ,mBAAmB,EACpB,MAAM,4BAA4B,CAAC;AAEpC,MAAM,MAAM,0BAA0B,GAAG;IACvC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,0BAA0B,CAAC;IACrC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG,mBAAmB,GAAG;IAErD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG,2BAA2B,GAAG;IAElE,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,YAAY,CAAC,EAAE,kBAAkB,CAAC;CACnC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,UAAU,GAAG;IAC9C,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;CAC3C,CAAC;AAEF,YAAY,EACV,aAAa,EACb,SAAS,EACT,WAAW,EACX,YAAY,EACZ,eAAe,EACf,SAAS,EACT,mBAAmB,EACnB,oBAAoB,EACpB,qBAAqB,EACrB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,YAAY,EACZ,mBAAmB,EACpB,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,kBAAkB,EAAE,uBAAuB,GAAG,aAAa,CAAC,GAAG;IAC/F,qBAAqB,EAAE,CAAC,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,WAAW,EAAE,CAAC,OAAO,CAAC,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;CACnE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plushanalytics/react-native-session-replay",
-  "version": "3.0.0",
+  "version": "3.0.4",
   "description": "React Native SDK for Plush Analytics events + session replay ingestion.",
   "source": "./src/index.tsx",
   "main": "./lib/commonjs/index.js",

package/src/adapters/mobileReplayAdapter.ts

@@ -1,12 +1,34 @@
-import type { MobileReplayConfig, ReplayRecorderAdapter, SessionRecordingOptions } from "../types";
+import type {
+  MobileReplayConfig,
+  ReplayRecorderAdapter,
+  SessionRecordingOptions,
+  SessionReplayConfig,
+} from "../types";
 import * as replayModule from "../nativeBridge";
 
 type AdapterDefaults = {
   apiKey: string;
   endpoint: string;
+  replayConfigDefaults?: SessionReplayConfig;
+};
+
+type StartArgs = {
+  onSessionId?: (sessionId: string) => void;
+  options?: SessionRecordingOptions;
+};
+
+type NormalizedReplayConfig = {
+  enabled: boolean;
+  maskAllTextInputs: boolean;
+  maskAllImages: boolean;
+  maskAllSandboxedViews: boolean;
+  captureLog: boolean;
+  captureNetworkTelemetry: boolean;
+  throttleDelayMs: number;
 };
 
 const DEFAULT_SNAPSHOT_PATH = "/v1/events/batch";
+const DEFAULT_THROTTLE_DELAY_MS = 1000;
 const UUID_PATTERN =
   /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/;
 
@@ -36,22 +58,11 @@ function generateUuid(): string {
 
   return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, (char) => {
     const random = Math.floor(Math.random() * 16);
-    const value = char === "x" ? random : (random & 0x3) | 0x8;
-    return value.toString(16);
+    const resolved = char === "x" ? random : (random & 0x3) | 0x8;
+    return resolved.toString(16);
   });
 }
 
-function normalizeReplayConfig(config: MobileReplayConfig | undefined): Record<string, unknown> {
-  return {
-    maskAllTextInputs: config?.maskAllTextInputs ?? true,
-    maskAllImages: config?.maskAllImages ?? true,
-    maskAllSandboxedViews: config?.maskAllSandboxedViews ?? true,
-    captureLog: config?.captureLog ?? true,
-    captureNetworkTelemetry: config?.captureNetworkTelemetry ?? true,
-    throttleDelayMs: config?.throttleDelayMs ?? 1000
-  };
-}
-
 function resolveSessionId(options?: SessionRecordingOptions): string {
   const requestedSessionId = options?.sessionId?.trim();
   if (requestedSessionId && isUuid(requestedSessionId)) {
@@ -75,14 +86,93 @@ function assertNoPosthogDotCom(host: string): void {
   }
 }
 
+function resolveMaskingValue(
+  overrideConfig: MobileReplayConfig | undefined,
+  defaultConfig: SessionReplayConfig | undefined,
+  maskingKey: keyof NonNullable<SessionReplayConfig["masking"]>,
+  legacyKey: "maskAllTextInputs" | "maskAllImages" | "maskAllSandboxedViews"
+): boolean {
+  const overrideMaskingValue = overrideConfig?.masking?.[maskingKey];
+  if (typeof overrideMaskingValue === "boolean") {
+    return overrideMaskingValue;
+  }
+
+  const overrideLegacyValue = overrideConfig?.[legacyKey];
+  if (typeof overrideLegacyValue === "boolean") {
+    return overrideLegacyValue;
+  }
+
+  const defaultMaskingValue = defaultConfig?.masking?.[maskingKey];
+  if (typeof defaultMaskingValue === "boolean") {
+    return defaultMaskingValue;
+  }
+
+  return true;
+}
+
+function resolveReplayConfig(
+  defaultConfig: SessionReplayConfig | undefined,
+  overrideConfig: MobileReplayConfig | undefined
+): NormalizedReplayConfig {
+  const enabled = overrideConfig?.enabled ?? defaultConfig?.enabled ?? true;
+  const captureLog = overrideConfig?.captureLog ?? defaultConfig?.captureLog ?? true;
+  const captureNetworkTelemetry =
+    overrideConfig?.captureNetworkTelemetry ?? defaultConfig?.captureNetworkTelemetry ?? true;
+
+  const requestedThrottleDelayMs =
+    overrideConfig?.throttleDelayMs ?? defaultConfig?.throttleDelayMs ?? DEFAULT_THROTTLE_DELAY_MS;
+  const throttleDelayMs =
+    Number.isFinite(requestedThrottleDelayMs) && requestedThrottleDelayMs >= 0
+      ? requestedThrottleDelayMs
+      : DEFAULT_THROTTLE_DELAY_MS;
+
+  return {
+    enabled,
+    maskAllTextInputs: resolveMaskingValue(
+      overrideConfig,
+      defaultConfig,
+      "textInputs",
+      "maskAllTextInputs"
+    ),
+    maskAllImages: resolveMaskingValue(overrideConfig, defaultConfig, "images", "maskAllImages"),
+    maskAllSandboxedViews: resolveMaskingValue(
+      overrideConfig,
+      defaultConfig,
+      "sandboxedViews",
+      "maskAllSandboxedViews"
+    ),
+    captureLog,
+    captureNetworkTelemetry,
+    throttleDelayMs,
+  };
+}
+
+function toNativeReplayConfig(config: NormalizedReplayConfig): Record<string, unknown> {
+  return {
+    maskAllTextInputs: config.maskAllTextInputs,
+    maskAllImages: config.maskAllImages,
+    maskAllSandboxedViews: config.maskAllSandboxedViews,
+    captureLog: config.captureLog,
+    captureNetworkTelemetry: config.captureNetworkTelemetry,
+    throttleDelayMs: config.throttleDelayMs,
+  };
+}
+
 export function createMobileReplayRecorderAdapter(defaults: AdapterDefaults): ReplayRecorderAdapter {
   assertNonEmpty(defaults.apiKey, "apiKey");
   assertNonEmpty(defaults.endpoint, "endpoint");
 
   return {
-    start: async ({ onSessionId, options }) => {
+    start: async (args: StartArgs) => {
+      const options = args.options;
+      const resolvedReplayConfig = resolveReplayConfig(defaults.replayConfigDefaults, options?.replayConfig);
+      if (!resolvedReplayConfig.enabled) {
+        return () => {};
+      }
+
       const host = normalizeHost(options?.replayHost?.trim() || defaults.endpoint);
       assertNoPosthogDotCom(host);
+
       const snapshotPath = normalizeSnapshotPath(options?.replaySnapshotPath);
       const activeSessionId = resolveSessionId(options);
 
@@ -93,21 +183,24 @@ export function createMobileReplayRecorderAdapter(defaults: AdapterDefaults): Re
         distinctId: options?.userId?.trim() || "",
         anonymousId: "",
         sdkVersion: "plushanalytics-react-native",
-        flushAt: 20
+        flushAt: 20,
       };
 
       await replayModule.start(
         activeSessionId,
         sdkOptions,
-        normalizeReplayConfig(options?.replayConfig),
+        toNativeReplayConfig(resolvedReplayConfig),
         { endpoint: snapshotPath }
       );
       await replayModule.startSession(activeSessionId);
-      onSessionId?.(activeSessionId);
+      args.onSessionId?.(activeSessionId);
 
       return () => {
         void replayModule.endSession();
       };
-    }
+    },
+    flush: async () => {
+      await replayModule.flush();
+    },
   };
 }

package/src/client.ts

@@ -30,7 +30,8 @@ export function createPlushAnalyticsClient(config: PlushAnalyticsConfig): PlushA
         config.replay?.defaultRecorder ??
         createMobileReplayRecorderAdapter({
           apiKey: config.apiKey,
-          endpoint
+          endpoint,
+          replayConfigDefaults: config.sessionReplayConfig
         })
     }
   };

package/src/index.tsx

@@ -17,6 +17,8 @@ export type {
   RetryOptions,
   ScreenOptions,
   SessionRecordingOptions,
+  SessionReplayConfig,
+  SessionReplayMaskingConfig,
   StorageAdapter,
   TrackOptions,
   UnifiedBatchPayload

package/src/nativeBridge.ts

@@ -40,6 +40,10 @@ export function endSession(): Promise<void> {
   return PosthogReactNativeSessionReplay.endSession();
 }
 
+export function flush(): Promise<void> {
+  return PosthogReactNativeSessionReplay.flush();
+}
+
 export function isEnabled(): Promise<boolean> {
   return PosthogReactNativeSessionReplay.isEnabled();
 }
@@ -56,13 +60,15 @@ export interface PostHogReactNativeSessionReplayModule {
     sessionId: string,
     sdkOptions: { [key: string]: any }, // options from SDK such as apiKey
     sdkReplayConfig: { [key: string]: any }, // config from SDK
-    decideReplayConfig: { [key: string]: any } // config from Decide API
+    decideReplayConfig: { [key: string]: any } // replay runtime config
   ) => Promise<void>;
 
   startSession: (sessionId: string) => Promise<void>;
 
   endSession: () => Promise<void>;
 
+  flush: () => Promise<void>;
+
   isEnabled: () => Promise<boolean>;
 
   identify: (distinctId: string, anonymousId: string) => Promise<void>;
@@ -72,6 +78,7 @@ const PostHogReactNativeSessionReplay: PostHogReactNativeSessionReplayModule = {
   start,
   startSession,
   endSession,
+  flush,
   isEnabled,
   identify,
 };

package/src/types.ts

@@ -18,15 +18,27 @@ import type {
   UnifiedBatchPayload
 } from "@plushanalytics/javascript";
 
-export type MobileReplayConfig = {
-  maskAllTextInputs?: boolean;
-  maskAllImages?: boolean;
-  maskAllSandboxedViews?: boolean;
+export type SessionReplayMaskingConfig = {
+  textInputs?: boolean;
+  images?: boolean;
+  sandboxedViews?: boolean;
+};
+
+export type SessionReplayConfig = {
+  enabled?: boolean;
+  masking?: SessionReplayMaskingConfig;
   captureLog?: boolean;
   captureNetworkTelemetry?: boolean;
   throttleDelayMs?: number;
 };
 
+export type MobileReplayConfig = SessionReplayConfig & {
+  // Legacy flat options are still supported for backward compatibility.
+  maskAllTextInputs?: boolean;
+  maskAllImages?: boolean;
+  maskAllSandboxedViews?: boolean;
+};
+
 export type SessionRecordingOptions = CoreSessionRecordingOptions & {
   // Used by the bundled replay adapter (optional, replay still works without these when you pass a custom recorder).
   replayHost?: string;
@@ -34,7 +46,9 @@ export type SessionRecordingOptions = CoreSessionRecordingOptions & {
   replayConfig?: MobileReplayConfig;
 };
 
-export type PlushAnalyticsConfig = CoreConfig;
+export type PlushAnalyticsConfig = CoreConfig & {
+  sessionReplayConfig?: SessionReplayConfig;
+};
 
 export type {
   EventEnvelope,