@mixpanel/react-native-session-replay 1.3.0 → 1.4.1

package/src/index.tsx

@@ -1,4 +1,11 @@
-import { Platform, processColor, type ColorValue } from 'react-native';
+import {
+  NativeEventEmitter,
+  Platform,
+  processColor,
+  type ColorValue,
+  type EmitterSubscription,
+  type NativeModule,
+} from 'react-native';
 import MixpanelReactNativeSessionReplay from './NativeMixpanelReactNativeSessionReplay';
 
 export enum MPSessionReplayMask {
@@ -30,6 +37,94 @@ export const MPDataResidency: Readonly<Record<'US' | 'EU' | 'IN', string>> = {
   IN: 'https://api-in.mixpanel.com',
 };
 
+/**
+ * Why a wireframe element's text was kept, rewritten, or dropped.
+ *
+ * Reported through {@link MPDebugOptions.wireframeEmitter} for local inspection only.
+ * These are the same `SCREAMING_SNAKE_CASE` tokens Android, iOS and Flutter report, so
+ * the same decision reads identically on every platform.
+ *
+ * ⚠️ **Not a stable contract.** Values may be added or renamed; treat an unrecognized
+ * one as "some kind of masking" rather than matching exhaustively. That is also why
+ * {@link MPWireframeElement.maskDecision} is typed `string` rather than a closed union —
+ * a new native value should not become a type error.
+ */
+export const MPMaskDecision = {
+  /** Text emitted as-is. */
+  None: 'NONE',
+  /** Text you declared with the `wireframeText` prop. Sent even when masked. */
+  Declared: 'DECLARED',
+  /** Explicitly masked — `<MPSessionReplayView sensitive>` or a registered class. */
+  Explicit: 'EXPLICIT',
+  /** Auto-masked by an `autoMaskedViews` category. */
+  Auto: 'AUTO',
+  /** A text-entry field. Always masked, cannot be overridden. */
+  TextEntry: 'TEXT_ENTRY',
+  /** Bounds intersected a mask rect the screenshot painted over. */
+  Geometric: 'GEOMETRIC',
+  /** Matched a strip rule; text was dropped. */
+  RuleStrip: 'RULE_STRIP',
+  /** Matched a redact rule; text was rewritten. */
+  RuleRedact: 'RULE_REDACT',
+} as const;
+
+/** One element of a captured wireframe. See {@link MPWireframeSnapshot}. */
+export interface MPWireframeElement {
+  /** `text`, `button`, `input` or `image`. */
+  role: string;
+  /** The text this element ships with, or `null` for a textless shell. */
+  text: string | null;
+  /** `[x, y, width, height]`, in the same units the wireframe event carries. */
+  bounds: number[];
+  /** One of {@link MPMaskDecision}'s values — see the note there about matching. */
+  maskDecision: string;
+}
+
+/**
+ * One captured wireframe, exactly as the SDK built it.
+ *
+ * ⚠️ **Not a stable contract** — a debugging aid, not a schema to build tooling on.
+ */
+export interface MPWireframeSnapshot {
+  /** Capture instant in milliseconds, matching the screenshot it accompanies. */
+  timestamp: number;
+  /** `[width, height]` of the captured viewport. */
+  viewport: number[];
+  elements: MPWireframeElement[];
+}
+
+/**
+ * Native event carrying one wireframe snapshot as JSON.
+ *
+ * The payload crosses as a *string* rather than a structured map on purpose: both SDKs
+ * already own a `toJson()` for their debug snapshot, so forwarding it verbatim keeps the
+ * bridge from becoming a third place where the shape can drift.
+ */
+const WIREFRAME_EVENT = 'MixpanelSessionReplayWireframe';
+
+let wireframeEventEmitter: NativeEventEmitter | null = null;
+
+// The one live subscription, owned by `initialize`. Replaced on every initialize so a
+// re-init cannot leave the previous config's callback attached.
+let wireframeSubscription: EmitterSubscription | null = null;
+
+// Which `initialize` call the live subscription belongs to. Bumped on every attach, so a
+// call that fails can tell whether the subscription still in place is its own — see
+// `attachWireframeEmitter`.
+let wireframeGeneration = 0;
+
+function getWireframeEventEmitter(): NativeEventEmitter {
+  if (wireframeEventEmitter === null) {
+    // Constructed lazily: importing this module must not create an emitter for an app
+    // that never listens. The module is passed on both platforms because a TurboModule
+    // has to supply `addListener`/`removeListeners` itself.
+    wireframeEventEmitter = new NativeEventEmitter(
+      MixpanelReactNativeSessionReplay as unknown as NativeModule
+    );
+  }
+  return wireframeEventEmitter;
+}
+
 /**
  * Color configuration for the on-device debug mask overlay.
  *
@@ -38,8 +133,8 @@ export const MPDataResidency: Readonly<Record<'US' | 'EU' | 'IN', string>> = {
  * Setting any of `maskColor`, `autoMaskColor`, or `unmaskColor` to `null` hides that
  * category from the overlay.
  *
- * The overlay only renders when `__DEV__` is `true` — `debugOptions` is ignored in
- * production bundles regardless of what is passed.
+ * The overlay only renders in a debuggable build. That is enforced by the native SDKs
+ * themselves, so it is safe to leave `overlayColors` set unconditionally.
  */
 export class MPDebugOverlayColors {
   /**
@@ -94,9 +189,10 @@ export class MPDebugOverlayColors {
  * `overlayColors` to `null` to disable the overlay while keeping `MPDebugOptions`
  * available for future debug features.
  *
- * Debug features only render when `__DEV__` is `true`. In production bundles
- * (`__DEV__ === false`), `debugOptions` is dropped before reaching the native SDK so
- * the overlay never ships to end users.
+ * `debugOptions` reaches the native SDK in every bundle, exactly as it would if you
+ * configured it natively. Each feature decides for itself what a release build may do:
+ * the overlay is restricted to debuggable builds by the native SDKs, while
+ * {@link MPDebugOptions.wireframeEmitter} runs wherever you configure it.
  */
 export class MPDebugOptions {
   /**
@@ -106,10 +202,48 @@ export class MPDebugOptions {
    */
   overlayColors: MPDebugOverlayColors | null;
 
+  /**
+   * Hands each captured wireframe back to JavaScript as it is captured, so you can check
+   * what you are sending while you develop.
+   *
+   * You get exactly the elements that go to Mixpanel, plus the reason each one's text was
+   * kept or removed. Nothing delivered here leaves the device.
+   *
+   * This *observes* wireframe capture; it does not enable it. Wireframes are only captured
+   * when {@link MPSessionReplayConfig.wireframesOptions} is set, so a callback on its own is
+   * harmless but never fires.
+   *
+   * It runs in whichever bundle you configure it in, matching the native SDKs. Nothing it
+   * delivers leaves the device, but building each snapshot is work the SDK otherwise skips
+   * and every frame crosses the bridge — so leave it unset once you are done checking.
+   *
+   * Configuration only, and deliberately so: declaring the callback is what turns snapshot
+   * building on, so there is no way to pay for the work with nothing listening. Set it before
+   * {@link MPSessionReplay.initialize}, which is where the destination is attached — a later
+   * `initialize` replaces it, and there is no runtime subscribe.
+   *
+   * Snapshots arrive on a background thread natively and are delivered one per frame, so a
+   * slow callback queues work on the bridge. Keep it cheap.
+   *
+   * ```ts
+   * config.debugOptions = new MPDebugOptions({
+   *   wireframeEmitter: (frame) => {
+   *     const withText = frame.elements.filter((e) => e.text !== null).length;
+   *     console.log(`[wireframe] ${frame.elements.length} elements, ${withText} with text`);
+   *   },
+   * });
+   * ```
+   *
+   * - **Default:** `null` (no snapshots are built)
+   */
+  wireframeEmitter: ((snapshot: MPWireframeSnapshot) => void) | null;
+
   constructor({
     overlayColors = new MPDebugOverlayColors(),
+    wireframeEmitter = null,
   }: Partial<MPDebugOptions> = {}) {
     this.overlayColors = overlayColors;
+    this.wireframeEmitter = wireframeEmitter;
   }
 }
 
@@ -137,18 +271,11 @@ function serializeDebugOptions(
   if (debugOptions === null) {
     return null;
   }
-  // Hard-gate debug features on `__DEV__` so they are never sent to native in
-  // production bundles. The Android SDK already restricts the overlay to debuggable
-  // builds, but the iOS SDK ships as a release XCFramework and would otherwise
-  // render the overlay in production if a customer forgot to gate the call site.
-  if (!__DEV__) {
-    if (debugOptions.overlayColors !== null) {
-      console.warn(
-        'MixpanelSessionReplay: `debugOptions` is ignored in production builds (__DEV__ is false).'
-      );
-    }
-    return null;
-  }
+  // No `__DEV__` gate: `debugOptions` is passed through in every bundle, the same as
+  // configuring it natively. Each SDK decides for itself what a release build may do —
+  // the overlay is restricted to debuggable builds by the native SDKs (`FLAG_DEBUGGABLE`
+  // on Android, `#if DEBUG` on iOS, which holds because the pod ships source, not a
+  // prebuilt binary) — so JavaScript does not need a second, differently-shaped opinion.
   const overlayColors = debugOptions.overlayColors;
   return {
     overlayColors:
@@ -160,6 +287,241 @@ function serializeDebugOptions(
             unmaskColor: processOverlayColor(overlayColors.unmaskColor),
             alpha: overlayColors.alpha,
           },
+    // This package's own debug switch, not SDK configuration: neither SDK models the key, and
+    // both ignore it when they decode this payload. Their `wireframeEmitter` is a callback and
+    // cannot travel here, so each bridge reads the flag and attaches the destination itself.
+    // Keeping it out of the SDKs' public `DebugOptions` keeps an RN-only knob off their native
+    // API surface, where it would do nothing.
+    //
+    // Derived rather than declared: a caller who wants snapshots supplies a callback, and the
+    // flag follows from that. It is never possible to ask the SDKs to build snapshots that
+    // nothing in JavaScript is waiting for.
+    emitWireframes: debugOptions.wireframeEmitter !== null,
+  };
+}
+
+/**
+ * A rule that rewrites or drops the text of a wireframe element when it matches.
+ *
+ * Build rules with the {@link MPSensitiveRule} factories rather than by hand — the object
+ * shape below is the wire format the native SDKs decode, not an API to write literals
+ * against.
+ *
+ * Rules run in the order you list them in {@link MPWireframesOptions.sensitiveRules},
+ * after the SDK's own masking, over whatever text is left — including text you declared
+ * with the `wireframeText` prop on {@link MPSessionReplayView}. A matching strip rule
+ * drops the text and stops immediately; a matching redact rule rewrites the text, and any
+ * rule after it sees the rewritten value.
+ */
+export type MPSensitiveRule =
+  | { type: 'redact'; text: string; replacement: string }
+  | { type: 'strip'; text: string }
+  | { type: 'redactRegex'; regex: RegExp; replacement: string }
+  | { type: 'stripRegex'; regex: RegExp };
+
+/** Replacement used by the redact rules when you do not supply one. */
+export const MP_DEFAULT_REPLACEMENT = '[REDACTED]';
+
+/**
+ * Factories for the four {@link MPSensitiveRule} variants.
+ *
+ * ```ts
+ * new MPWireframesOptions({
+ *   sensitiveRules: [
+ *     MPSensitiveRule.strip('password'),
+ *     MPSensitiveRule.redactRegex(/[\w.+-]+@[\w-]+\.[\w.]+/g, '[EMAIL]'),
+ *   ],
+ * });
+ * ```
+ */
+export const MPSensitiveRule = {
+  /**
+   * Replaces case-insensitive substring matches of `text` with `replacement`, leaving the
+   * surrounding text intact.
+   */
+  redact(
+    text: string,
+    replacement: string = MP_DEFAULT_REPLACEMENT
+  ): MPSensitiveRule {
+    return { type: 'redact', text, replacement };
+  },
+
+  /** Drops the element's text entirely if it contains `text` (case-insensitive). */
+  strip(text: string): MPSensitiveRule {
+    return { type: 'strip', text };
+  },
+
+  /**
+   * Replaces matches of `regex` with `replacement`, leaving surrounding text intact.
+   *
+   * Only the `i`, `m` and `s` flags carry over to native; see
+   * {@link MPWireframesOptions} for what the regex itself is subject to.
+   */
+  redactRegex(
+    regex: RegExp,
+    replacement: string = MP_DEFAULT_REPLACEMENT
+  ): MPSensitiveRule {
+    return { type: 'redactRegex', regex, replacement };
+  },
+
+  /** Drops the element's text entirely if `regex` finds a match anywhere in the text. */
+  stripRegex(regex: RegExp): MPSensitiveRule {
+    return { type: 'stripRegex', regex };
+  },
+};
+
+/**
+ * Enables wireframe capture for Session Replay.
+ *
+ * **Beta.** Wireframes are in beta. Before shipping to production, inspect the wireframes
+ * your app produces with {@link MPDebugOptions.wireframeEmitter} and confirm that no
+ * sensitive information is captured.
+ *
+ * A wireframe is a lightweight text outline of a screen: the visible elements, what kind
+ * each one is (text, button, input, image), what it says, and where it sits. One is
+ * captured alongside each screenshot, which lets Mixpanel summarize what your users saw
+ * and did without anyone having to watch the replay.
+ *
+ * Pass one to {@link MPSessionReplayConfig.wireframesOptions} to turn wireframes on.
+ * Leave it `null` — the default — and none are captured.
+ *
+ * Mixpanel can also turn wireframe capture off for a project from the server. The native
+ * SDKs honor that switch: the rest of session replay keeps recording, only the wireframe
+ * payload is dropped, and the reason is logged at init.
+ *
+ * ### Your masking settings are respected
+ *
+ * Anything hidden in the replay video is also removed from the wireframe. The element is
+ * still listed so the shape of the screen is preserved, but its text is dropped. That
+ * includes anything inside a `<MPSessionReplayView sensitive>`, anything covered by
+ * {@link MPSessionReplayConfig.autoMaskedViews}, every `TextInput`, and anything sitting
+ * underneath a masked area even if it was never marked sensitive itself.
+ *
+ * Note what this means for the defaults: `autoMaskedViews` masks `Text` out of the box, so
+ * with the default configuration every element ships as a textless shell. Narrow
+ * `autoMaskedViews` (and mask what matters with `<MPSessionReplayView sensitive>`) for
+ * wireframes to carry readable copy.
+ *
+ * ### Describing an element yourself
+ *
+ * The `wireframeText` prop on {@link MPSessionReplayView} supplies the text for an element
+ * — useful for custom-drawn content, or anywhere the text picked up automatically isn't
+ * meaningful. Because you authored it rather than the SDK scraping it off the screen, it is
+ * sent even for an element you've masked in the video.
+ *
+ * ### Catching sensitive content by pattern
+ *
+ * {@link sensitiveRules} match on the text itself and run last, over everything above,
+ * including text you supplied with `wireframeText`.
+ */
+export class MPWireframesOptions {
+  /**
+   * Rules applied to each element's text before it is sent, in the order you declare them.
+   * Elements are always kept; only their text is affected.
+   *
+   * - A matching strip rule drops the text and stops — no later rule runs.
+   * - Redact rules build on one another: a rule declared later sees the result of the ones
+   *   before it, not the original text.
+   *
+   * A `RegExp` is compiled by the platform's own engine — `java.util.regex` on Android,
+   * ICU on iOS — not by JavaScript. A pattern that is valid JS may behave differently, or
+   * be rejected outright, on one of them; a rejected pattern fails `initialize` rather
+   * than silently matching nothing. Only the `i`, `m` and `s` flags cross the bridge (they
+   * are the three that mean the same thing in all three engines); `g` is implied, since
+   * every match is replaced, and any other flag is ignored with a warning. Replacement
+   * strings are literal — `$1` is emitted verbatim, not as a back-reference.
+   *
+   * - **Default:** `[]`
+   */
+  sensitiveRules: MPSensitiveRule[];
+
+  /**
+   * Whether an element with no text of its own may fall back to its accessibility label
+   * (React Native's `accessibilityLabel` prop). Off by default: a label is not drawn on
+   * screen, so unlike visible text you cannot confirm what it contains by watching the
+   * replay, and labels sometimes hold more than what is shown.
+   *
+   * Turn it on if you want icons and image buttons named. For an icon-only control the
+   * label is usually the only description of what the element is for, and with the fallback
+   * off it is sent as a bare shell instead — `wireframeText` is then the only way to
+   * describe it.
+   *
+   * The label is only ever a fallback. Text you set with `wireframeText` wins over it, an
+   * element's own visible text wins over it, and a masked element stays textless either way.
+   *
+   * - **Default:** `false`
+   */
+  useAccessibilityLabelFallback: boolean;
+
+  constructor({
+    sensitiveRules = [],
+    useAccessibilityLabelFallback = false,
+  }: Partial<MPWireframesOptions> = {}) {
+    this.sensitiveRules = sensitiveRules;
+    this.useAccessibilityLabelFallback = useAccessibilityLabelFallback;
+  }
+}
+
+/**
+ * Flags a `RegExp` carries that mean the same thing in JavaScript, `java.util.regex` and
+ * ICU. `g` is deliberately accepted and dropped: the native rules always replace every
+ * match, so a global regex is what a caller means either way.
+ */
+const SUPPORTED_REGEX_FLAGS = 'imsg';
+
+function serializeRegex(regex: RegExp, ruleType: string): object {
+  const unsupported = [...regex.flags].filter(
+    (flag) => !SUPPORTED_REGEX_FLAGS.includes(flag)
+  );
+  if (unsupported.length > 0) {
+    console.warn(
+      `MixpanelSessionReplay: the ${unsupported.join('')} flag(s) on ${regex} (${ruleType}) are not supported by the native regex engines and will be ignored.`
+    );
+  }
+  return {
+    pattern: regex.source,
+    caseInsensitive: regex.flags.includes('i'),
+    multiline: regex.flags.includes('m'),
+    dotMatchesAll: regex.flags.includes('s'),
+  };
+}
+
+/**
+ * The `wireframesOptions` payload, in the one shape both native SDKs decode.
+ *
+ * Unlike `autoMaskedViews` and `remoteSettingsMode`, this needs no per-platform
+ * transformation: Android's `SensitiveRuleSerializer` and iOS's `MPSensitiveRule`
+ * decoder were written against the same field names and `type` tokens, and each
+ * platform's suite pins them as literal text.
+ */
+function serializeWireframesOptions(
+  options: MPWireframesOptions | null
+): object | null {
+  if (options === null || options === undefined) {
+    return null;
+  }
+  return {
+    sensitiveRules: options.sensitiveRules.map((rule) => {
+      switch (rule.type) {
+        case 'redact':
+          return {
+            type: rule.type,
+            text: rule.text,
+            replacement: rule.replacement,
+          };
+        case 'strip':
+          return { type: rule.type, text: rule.text };
+        case 'redactRegex':
+          return {
+            type: rule.type,
+            ...serializeRegex(rule.regex, rule.type),
+            replacement: rule.replacement,
+          };
+        case 'stripRegex':
+          return { type: rule.type, ...serializeRegex(rule.regex, rule.type) };
+      }
+    }),
+    useAccessibilityLabelFallback: options.useAccessibilityLabelFallback,
   };
 }
 
@@ -251,9 +613,10 @@ export class MPSessionReplayConfig {
    * masking coverage during development. Pass `new MPDebugOptions()` to enable the
    * overlay with default colors, or customize via `MPDebugOverlayColors`.
    *
-   * `debugOptions` is only honored when `__DEV__` is `true`. In production bundles
-   * it is dropped before reaching the native SDK, so it is safe to leave the option
-   * set unconditionally — the overlay will not render for end users.
+   * The overlay only renders in a debuggable build — the native SDKs enforce that, so it
+   * is safe to leave the option set unconditionally and the overlay will not reach end
+   * users. {@link MPDebugOptions.wireframeEmitter}, the other member, has no such
+   * restriction and runs wherever you configure it.
    *
    * - **Default:** `null` (disabled)
    */
@@ -275,6 +638,23 @@ export class MPSessionReplayConfig {
    */
   serverURL: string;
 
+  /**
+   * Enables wireframe capture: a text outline of each captured screen — the visible
+   * elements, what they say, and where they sit — recorded alongside the replay so
+   * sessions can be summarized without watching them.
+   *
+   * Pass `new MPWireframesOptions()` to turn it on with the defaults, or customize the
+   * content rules and the accessibility-label fallback. Your masking settings apply to
+   * it; see {@link MPWireframesOptions}.
+   *
+   * **Beta.** Wireframes are in beta. Before shipping to production, inspect the wireframes
+   * your app produces and confirm that no sensitive information is captured; see
+   * {@link MPWireframesOptions}.
+   *
+   * - **Default:** `null` (wireframe capture disabled)
+   */
+  wireframesOptions: MPWireframesOptions | null;
+
   constructor({
     wifiOnly = true,
     autoStartRecording = true,
@@ -290,6 +670,7 @@ export class MPSessionReplayConfig {
     remoteSettingsMode = MPSessionReplayRemoteSettingsMode.Disabled,
     debugOptions = null,
     serverURL = MPDataResidency.US,
+    wireframesOptions = null,
   }: Partial<MPSessionReplayConfig> = {}) {
     this.wifiOnly = wifiOnly;
     this.autoStartRecording = autoStartRecording;
@@ -300,6 +681,7 @@ export class MPSessionReplayConfig {
     this.remoteSettingsMode = remoteSettingsMode;
     this.debugOptions = debugOptions;
     this.serverURL = serverURL;
+    this.wireframesOptions = wireframesOptions;
   }
 
   private transformMaskValueForPlatform(value: string): string {
@@ -333,6 +715,7 @@ export class MPSessionReplayConfig {
       enableLogging: this.enableLogging,
       remoteSettingsMode: transformedRemoteSettingsMode,
       debugOptions: serializeDebugOptions(this.debugOptions),
+      wireframesOptions: serializeWireframesOptions(this.wireframesOptions),
       // The native SDKs spell the server URL field differently — Android's
       // kotlinx.serialization expects `serverUrl`, iOS's Codable expects `serverURL`.
       ...Platform.select({
@@ -385,7 +768,34 @@ async function initialize(
     throw new Error('recordingSessionsPercent must be between 0 and 100');
   }
   const json = config.toJSON();
-  return MixpanelReactNativeSessionReplay.initialize(token, distinctId, json);
+  // Attached before the native call so no frame can be emitted before the destination
+  // exists, then reconciled once the call settles.
+  //
+  // `initialize` is async and nothing stops an app calling it twice, so the two paths
+  // below hold one invariant between them: a call that succeeds ends up owning the
+  // subscription, and a call that fails never leaves one behind that outlives it.
+  // Without both halves an overlap silently ends with no destination attached at all —
+  // the newer call tears its own down on failure, while the older one has already had
+  // its callback replaced and would never restore it.
+  const generation = attachWireframeEmitter(
+    config.debugOptions?.wireframeEmitter
+  );
+  try {
+    const result = await MixpanelReactNativeSessionReplay.initialize(
+      token,
+      distinctId,
+      json
+    );
+    if (generation !== wireframeGeneration) {
+      // Another initialize attached after this one started. This call is the one that
+      // succeeded, so its configuration is the one that should be delivering.
+      attachWireframeEmitter(config.debugOptions?.wireframeEmitter);
+    }
+    return result;
+  } catch (error) {
+    detachWireframeEmitterIfCurrent(generation);
+    throw error;
+  }
 }
 
 /**
@@ -466,6 +876,89 @@ async function flush(): Promise<void> {
   return MixpanelReactNativeSessionReplay.flush();
 }
 
+/**
+ * Presents one shape to JavaScript regardless of which SDK produced the payload.
+ *
+ * A textless element is `"text": null` on both platforms now, but iOS used to *omit* the
+ * key — Swift's synthesized `Encodable` uses `encodeIfPresent` for optionals — which
+ * reached JS as `undefined` and printed as the string `"undefined"` in anything that only
+ * checked for `null`. The SDK is fixed; this keeps the declared
+ * `text: string | null` contract true against an older one too.
+ */
+function normalizeSnapshot(raw: MPWireframeSnapshot): MPWireframeSnapshot {
+  return {
+    ...raw,
+    elements: (raw.elements ?? []).map((element) => ({
+      ...element,
+      text: element.text ?? null,
+    })),
+  };
+}
+
+/**
+ * Points the native wireframe event at {@link MPDebugOptions.wireframeEmitter}, replacing
+ * whatever a previous `initialize` attached.
+ *
+ * There is no public subscribe. The callback is declared on the config beside the switch that
+ * turns wireframes on, which is how Android, iOS and Flutter spell it too, and it means the
+ * one-callback lifetime is the instance's rather than something a caller has to remember to
+ * tear down.
+ */
+function attachWireframeEmitter(
+  listener: ((snapshot: MPWireframeSnapshot) => void) | null | undefined
+): number {
+  wireframeSubscription?.remove();
+  wireframeSubscription = null;
+  const generation = ++wireframeGeneration;
+
+  if (!listener) {
+    return generation;
+  }
+
+  wireframeSubscription = getWireframeEventEmitter().addListener(
+    WIREFRAME_EVENT,
+    (payload: string) => {
+      let snapshot: MPWireframeSnapshot;
+      try {
+        snapshot = normalizeSnapshot(JSON.parse(payload));
+      } catch (error) {
+        // The payload is whichever SDK's `toJson()` produced it. Report and drop the
+        // frame rather than throwing out of the emitter callback, which would take the
+        // subscription down with it.
+        console.warn(
+          `MixpanelSessionReplay: could not parse a wireframe snapshot: ${error}`
+        );
+        return;
+      }
+      try {
+        listener(snapshot);
+      } catch (error) {
+        // A consumer callback is application code. Keep it from escaping through React
+        // Native's synchronous EventEmitter and destabilizing the host app or later frames.
+        console.warn(
+          `MixpanelSessionReplay: wireframe callback threw: ${error}`
+        );
+      }
+    }
+  );
+  return generation;
+}
+
+/**
+ * Detaches only if the live subscription is still the one `generation` installed.
+ *
+ * `initialize` is async and nothing stops an app calling it twice. Without this check, an
+ * earlier call that rejects would tear down the subscription a *later*, successful call had
+ * already installed, and that configuration would silently stop receiving snapshots.
+ */
+function detachWireframeEmitterIfCurrent(generation: number): void {
+  if (generation !== wireframeGeneration) {
+    return;
+  }
+  wireframeSubscription?.remove();
+  wireframeSubscription = null;
+}
+
 export { MPSessionReplayView } from './MixpanelSessionReplayView';
 
 export const MPSessionReplay = {