@plushanalytics/react-native-session-replay 1.2.6 → 3.0.2

package/src/index.tsx

@@ -1,79 +1,25 @@
-import { NativeModules, Platform } from 'react-native';
-
-const LINKING_ERROR =
-  `The package '@plushanalytics/react-native-session-replay' doesn't seem to be linked. Make sure: \n\n` +
-  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
-  '- You rebuilt the app after installing the package\n' +
-  '- You are not using Expo Go\n';
-
-const PosthogReactNativeSessionReplay =
-  NativeModules.PosthogReactNativeSessionReplay
-    ? NativeModules.PosthogReactNativeSessionReplay
-    : new Proxy(
-        {},
-        {
-          get() {
-            throw new Error(LINKING_ERROR);
-          },
-        }
-      );
-
-export function start(
-  sessionId: string,
-  sdkOptions: { [key: string]: any },
-  sdkReplayConfig: { [key: string]: any },
-  decideReplayConfig: { [key: string]: any }
-): Promise<void> {
-  return PosthogReactNativeSessionReplay.start(
-    sessionId,
-    sdkOptions,
-    sdkReplayConfig,
-    decideReplayConfig
-  );
-}
-
-export function startSession(sessionId: string): Promise<void> {
-  return PosthogReactNativeSessionReplay.startSession(sessionId);
-}
-
-export function endSession(): Promise<void> {
-  return PosthogReactNativeSessionReplay.endSession();
-}
-
-export function isEnabled(): Promise<boolean> {
-  return PosthogReactNativeSessionReplay.isEnabled();
-}
-
-export function identify(
-  distinctId: string,
-  anonymousId: string
-): Promise<void> {
-  return PosthogReactNativeSessionReplay.identify(distinctId, anonymousId);
-}
-
-export interface PostHogReactNativeSessionReplayModule {
-  start: (
-    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
-  ) => Promise<void>;
-
-  startSession: (sessionId: string) => Promise<void>;
-
-  endSession: () => Promise<void>;
-
-  isEnabled: () => Promise<boolean>;
-
-  identify: (distinctId: string, anonymousId: string) => Promise<void>;
-}
-
-const PostHogReactNativeSessionReplay: PostHogReactNativeSessionReplayModule = {
-  start,
-  startSession,
-  endSession,
-  isEnabled,
-  identify,
-};
-
-export default PostHogReactNativeSessionReplay;
+export { createPlushAnalyticsClient, PlushAnalyticsClient } from "./client";
+export { createMobileReplayRecorderAdapter } from "./adapters/mobileReplayAdapter";
+export { PlushAnalyticsProvider, usePlushAnalytics } from "./provider";
+export type {
+  EventEnvelope,
+  EventType,
+  FlushResult,
+  GroupOptions,
+  IdentifyOptions,
+  JsonValue,
+  MobileReplayConfig,
+  PlushAnalytics,
+  PlushAnalyticsConfig,
+  ReplayChunkEnvelope,
+  ReplayRecordEmission,
+  ReplayRecorderAdapter,
+  RetryOptions,
+  ScreenOptions,
+  SessionRecordingOptions,
+  SessionReplayConfig,
+  SessionReplayMaskingConfig,
+  StorageAdapter,
+  TrackOptions,
+  UnifiedBatchPayload
+} from "./types";

package/src/nativeBridge.ts

@@ -0,0 +1,86 @@
+import { NativeModules, Platform } from 'react-native';
+
+const LINKING_ERROR =
+  `The package '@plushanalytics/react-native-session-replay' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n';
+
+const PosthogReactNativeSessionReplay =
+  NativeModules.PosthogReactNativeSessionReplay
+    ? NativeModules.PosthogReactNativeSessionReplay
+    : new Proxy(
+        {},
+        {
+          get() {
+            throw new Error(LINKING_ERROR);
+          },
+        }
+      );
+
+export function start(
+  sessionId: string,
+  sdkOptions: { [key: string]: any },
+  sdkReplayConfig: { [key: string]: any },
+  decideReplayConfig: { [key: string]: any }
+): Promise<void> {
+  return PosthogReactNativeSessionReplay.start(
+    sessionId,
+    sdkOptions,
+    sdkReplayConfig,
+    decideReplayConfig
+  );
+}
+
+export function startSession(sessionId: string): Promise<void> {
+  return PosthogReactNativeSessionReplay.startSession(sessionId);
+}
+
+export function endSession(): Promise<void> {
+  return PosthogReactNativeSessionReplay.endSession();
+}
+
+export function flush(): Promise<void> {
+  return PosthogReactNativeSessionReplay.flush();
+}
+
+export function isEnabled(): Promise<boolean> {
+  return PosthogReactNativeSessionReplay.isEnabled();
+}
+
+export function identify(
+  distinctId: string,
+  anonymousId: string
+): Promise<void> {
+  return PosthogReactNativeSessionReplay.identify(distinctId, anonymousId);
+}
+
+export interface PostHogReactNativeSessionReplayModule {
+  start: (
+    sessionId: string,
+    sdkOptions: { [key: string]: any }, // options from SDK such as apiKey
+    sdkReplayConfig: { [key: string]: any }, // config from SDK
+    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>;
+}
+
+const PostHogReactNativeSessionReplay: PostHogReactNativeSessionReplayModule = {
+  start,
+  startSession,
+  endSession,
+  flush,
+  isEnabled,
+  identify,
+};
+
+export default PostHogReactNativeSessionReplay;

package/src/provider.tsx

@@ -0,0 +1,46 @@
+import React, { createContext, useContext, useEffect, useRef } from "react";
+import { createPlushAnalyticsClient, type PlushAnalyticsClient } from "./client";
+import type { PlushAnalytics, PlushAnalyticsConfig } from "./types";
+
+type PlushAnalyticsProviderProps = {
+  children: React.ReactNode;
+  config?: PlushAnalyticsConfig;
+  client?: PlushAnalyticsClient;
+};
+
+const PlushAnalyticsContext = createContext<PlushAnalytics | null>(null);
+
+export function PlushAnalyticsProvider({
+  children,
+  config,
+  client
+}: PlushAnalyticsProviderProps): React.ReactElement {
+  const clientRef = useRef<PlushAnalyticsClient | null>(null);
+
+  if (!clientRef.current) {
+    if (client) {
+      clientRef.current = client;
+    } else if (config) {
+      clientRef.current = createPlushAnalyticsClient(config);
+    } else {
+      throw new Error("PlushAnalyticsProvider requires either a `client` or `config` prop.");
+    }
+  }
+
+  useEffect(() => {
+    return () => {
+      void clientRef.current?.shutdown();
+    };
+  }, []);
+
+  return <PlushAnalyticsContext.Provider value={clientRef.current}>{children}</PlushAnalyticsContext.Provider>;
+}
+
+export function usePlushAnalytics(): PlushAnalytics {
+  const context = useContext(PlushAnalyticsContext);
+  if (!context) {
+    throw new Error("usePlushAnalytics must be used inside PlushAnalyticsProvider.");
+  }
+
+  return context;
+}

package/src/types.ts

@@ -0,0 +1,73 @@
+import type {
+  EventEnvelope,
+  EventType,
+  FlushResult,
+  GroupOptions,
+  IdentifyOptions,
+  JsonValue,
+  PlushAnalytics as CorePlushAnalytics,
+  PlushAnalyticsConfig as CoreConfig,
+  ReplayChunkEnvelope,
+  ReplayRecordEmission,
+  ReplayRecorderAdapter,
+  RetryOptions,
+  ScreenOptions,
+  SessionRecordingOptions as CoreSessionRecordingOptions,
+  StorageAdapter,
+  TrackOptions,
+  UnifiedBatchPayload
+} from "@plushanalytics/javascript";
+
+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;
+  replaySnapshotPath?: string;
+  replayConfig?: MobileReplayConfig;
+};
+
+export type PlushAnalyticsConfig = CoreConfig & {
+  sessionReplayConfig?: SessionReplayConfig;
+};
+
+export type {
+  EventEnvelope,
+  EventType,
+  FlushResult,
+  GroupOptions,
+  IdentifyOptions,
+  JsonValue,
+  ReplayChunkEnvelope,
+  ReplayRecordEmission,
+  ReplayRecorderAdapter,
+  RetryOptions,
+  ScreenOptions,
+  StorageAdapter,
+  TrackOptions,
+  UnifiedBatchPayload
+};
+
+export type PlushAnalytics = Omit<CorePlushAnalytics, "startSessionRecording" | "startReplay"> & {
+  startSessionRecording: (options?: SessionRecordingOptions) => Promise<void>;
+  startReplay: (options?: SessionRecordingOptions) => Promise<void>;
+};