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

package/lib/typescript/src/MixpanelSessionReplayView.d.ts

@@ -1,6 +1,38 @@
 import { type ViewProps } from 'react-native';
 interface MixpanelSessionReplayViewProps extends ViewProps {
+    /**
+     * Masks everything inside this view in the replay video, and drops the text of every
+     * wireframe element under it.
+     *
+     * Controls pixels. Orthogonal to {@link wireframeText}, which controls what the
+     * wireframe *says*; the two compose.
+     */
     sensitive?: boolean;
+    /**
+     * Declares the text recorded for this view in the wireframe.
+     *
+     * **Beta.** Wireframes are in beta; see `MPWireframesOptions` for what to check before
+     * shipping to production.
+     *
+     * Use it to describe content the SDK can't read — custom-drawn views, charts, canvases —
+     * or to attach an analytical label. Declared text wins over the view's own visible text
+     * and over its accessibility label.
+     *
+     * **It is sent even when the view is masked.** Masking hides the pixels while the
+     * declared text still describes the view for the summary. Because you authored it rather
+     * than the SDK scraping it off the screen, making sure the text is not itself sensitive
+     * is up to you — if it could be, leave it off.
+     *
+     * ```tsx
+     * <MPSessionReplayView sensitive wireframeText="Card number">
+     *   <CardNumberField />
+     * </MPSessionReplayView>
+     * ```
+     *
+     * Requires `wireframesOptions` on the config; without it no wireframes are captured and
+     * this prop does nothing. Blank strings are ignored.
+     */
+    wireframeText?: string;
 }
 export declare const MPSessionReplayView: import("react-native").HostComponent<MixpanelSessionReplayViewProps>;
 export {};

package/lib/typescript/src/MixpanelSessionReplayView.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"MixpanelSessionReplayView.d.ts","sourceRoot":"","sources":["../../../src/MixpanelSessionReplayView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAEtE,UAAU,8BAA+B,SAAQ,SAAS;IACxD,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,eAAO,MAAM,mBAAmB,sEAG7B,CAAC"}
+{"version":3,"file":"MixpanelSessionReplayView.d.ts","sourceRoot":"","sources":["../../../src/MixpanelSessionReplayView.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,SAAS,EAAE,MAAM,cAAc,CAAC;AAEtE,UAAU,8BAA+B,SAAQ,SAAS;IACxD;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,sEAG7B,CAAC"}

package/lib/typescript/src/NativeMixpanelReactNativeSessionReplay.d.ts

@@ -7,6 +7,8 @@ export interface Spec extends TurboModule {
     identify(distinctId: string): Promise<void>;
     getReplayId(): Promise<string | null>;
     flush(): Promise<void>;
+    addListener(eventName: string): void;
+    removeListeners(count: number): void;
 }
 declare global {
     var __turboModuleProxy: unknown | undefined;

package/lib/typescript/src/NativeMixpanelReactNativeSessionReplay.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"NativeMixpanelReactNativeSessionReplay.d.ts","sourceRoot":"","sources":["../../../src/NativeMixpanelReactNativeSessionReplay.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,UAAU,CACR,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,cAAc,CAAC,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACtC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CACxB;AAGD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7C;wBAyCkD,IAAI;AAAvD,wBAAwD"}
+{"version":3,"file":"NativeMixpanelReactNativeSessionReplay.d.ts","sourceRoot":"","sources":["../../../src/NativeMixpanelReactNativeSessionReplay.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAGhD,MAAM,WAAW,IAAK,SAAQ,WAAW;IACvC,UAAU,CACR,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,cAAc,CAAC,wBAAwB,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/B,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAChC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACtC,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAMvB,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACrC,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtC;AAGD,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,kBAAkB,EAAE,OAAO,GAAG,SAAS,CAAC;CAC7C;wBAyCkD,IAAI;AAAvD,wBAAwD"}

package/lib/typescript/src/index.d.ts

@@ -18,6 +18,59 @@ export declare enum MPSessionReplayRemoteSettingsMode {
  * to send traffic through a custom endpoint (for example, a corporate proxy).
  */
 export declare const MPDataResidency: Readonly<Record<'US' | 'EU' | 'IN', string>>;
+/**
+ * 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 declare const MPMaskDecision: {
+    /** Text emitted as-is. */
+    readonly None: "NONE";
+    /** Text you declared with the `wireframeText` prop. Sent even when masked. */
+    readonly Declared: "DECLARED";
+    /** Explicitly masked — `<MPSessionReplayView sensitive>` or a registered class. */
+    readonly Explicit: "EXPLICIT";
+    /** Auto-masked by an `autoMaskedViews` category. */
+    readonly Auto: "AUTO";
+    /** A text-entry field. Always masked, cannot be overridden. */
+    readonly TextEntry: "TEXT_ENTRY";
+    /** Bounds intersected a mask rect the screenshot painted over. */
+    readonly Geometric: "GEOMETRIC";
+    /** Matched a strip rule; text was dropped. */
+    readonly RuleStrip: "RULE_STRIP";
+    /** Matched a redact rule; text was rewritten. */
+    readonly RuleRedact: "RULE_REDACT";
+};
+/** 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[];
+}
 /**
  * Color configuration for the on-device debug mask overlay.
  *
@@ -26,8 +79,8 @@ export declare 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 declare class MPDebugOverlayColors {
     /**
@@ -67,9 +120,10 @@ export declare 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 declare class MPDebugOptions {
     /**
@@ -78,7 +132,185 @@ export declare class MPDebugOptions {
      * - **Default:** `new MPDebugOverlayColors()` (overlay enabled with default colors)
      */
     overlayColors: MPDebugOverlayColors | null;
-    constructor({ overlayColors, }?: Partial<MPDebugOptions>);
+    /**
+     * 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, wireframeEmitter, }?: Partial<MPDebugOptions>);
+}
+/**
+ * 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 declare 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 declare const MPSensitiveRule: {
+    /**
+     * Replaces case-insensitive substring matches of `text` with `replacement`, leaving the
+     * surrounding text intact.
+     */
+    redact(text: string, replacement?: string): MPSensitiveRule;
+    /** Drops the element's text entirely if it contains `text` (case-insensitive). */
+    strip(text: string): MPSensitiveRule;
+    /**
+     * 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): MPSensitiveRule;
+    /** Drops the element's text entirely if `regex` finds a match anywhere in the text. */
+    stripRegex(regex: RegExp): MPSensitiveRule;
+};
+/**
+ * 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 declare 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, }?: Partial<MPWireframesOptions>);
 }
 export declare class MPSessionReplayConfig {
     /**
@@ -161,9 +393,10 @@ export declare 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)
      */
@@ -183,7 +416,23 @@ export declare class MPSessionReplayConfig {
      * - **Default:** `MPDataResidency.US` (`https://api.mixpanel.com`)
      */
     serverURL: string;
-    constructor({ wifiOnly, autoStartRecording, recordingSessionsPercent, autoMaskedViews, flushInterval, enableLogging, remoteSettingsMode, debugOptions, serverURL, }?: Partial<MPSessionReplayConfig>);
+    /**
+     * 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, autoStartRecording, recordingSessionsPercent, autoMaskedViews, flushInterval, enableLogging, remoteSettingsMode, debugOptions, serverURL, wireframesOptions, }?: Partial<MPSessionReplayConfig>);
     private transformMaskValueForPlatform;
     toJSON(): string;
 }

package/lib/typescript/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAA0B,KAAK,UAAU,EAAE,MAAM,cAAc,CAAC;AAGvE,oBAAY,mBAAmB;IAC7B,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED,oBAAY,iCAAiC;IAC3C,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,MAAM,CAAC,CAOxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,qBAAa,oBAAoB;IAC/B;;;;;OAKG;IACH,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,EAAE,UAAU,GAAG,IAAI,CAAC;IAEjC;;;;;OAKG;IACH,WAAW,EAAE,UAAU,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;gBAEF,EACV,SAAiB,EACjB,aAAwB,EACxB,WAAqB,EACrB,KAAW,GACZ,GAAE,OAAO,CAAC,oBAAoB,CAAM;CAMtC;AAED;;;;;;;;;;;GAWG;AACH,qBAAa,cAAc;IACzB;;;;OAIG;IACH,aAAa,EAAE,oBAAoB,GAAG,IAAI,CAAC;gBAE/B,EACV,aAA0C,GAC3C,GAAE,OAAO,CAAC,cAAc,CAAM;CAGhC;AAoDD,qBAAa,qBAAqB;IAChC;;;;;;;OAOG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;OAUG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,eAAe,EAAE,mBAAmB,EAAE,CAAC;IAEvC;;;;;;;;OAQG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;;;;;OAQG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;;;;;OAaG;IACH,kBAAkB,EAAE,iCAAiC,CAAC;IAEtD;;;;;;;;;;;;;OAaG;IACH,YAAY,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACH,SAAS,EAAE,MAAM,CAAC;gBAEN,EACV,QAAe,EACf,kBAAyB,EACzB,wBAA8B,EAC9B,eAKC,EACD,aAAkB,EAClB,aAAqB,EACrB,kBAA+D,EAC/D,YAAmB,EACnB,SAA8B,GAC/B,GAAE,OAAO,CAAC,qBAAqB,CAAM;IAYtC,OAAO,CAAC,6BAA6B;IASrC,MAAM,IAAI,MAAM;CAyCjB;AAED;;;;;;;;;;;GAWG;AACH,iBAAe,UAAU,CACvB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CAgBf;AAED;;;;;;;;;GASG;AACH,iBAAe,cAAc,CAC3B,wBAAwB,GAAE,MAAY,GACrC,OAAO,CAAC,IAAI,CAAC,CAIf;AAED;;;;GAIG;AACH,iBAAe,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5C;AAED;;;;GAIG;AACH,iBAAe,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,iBAAe,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMzD;AAED;;;;;;;GAOG;AACH,iBAAe,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAEnD;AAED;;;;;;;GAOG;AACH,iBAAe,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEpC;AAED,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,eAAO,MAAM,eAAe;;;;;;;;CAQ3B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.tsx"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,UAAU,EAGhB,MAAM,cAAc,CAAC;AAGtB,oBAAY,mBAAmB;IAC7B,IAAI,SAAS;IACb,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,KAAK,UAAU;CAChB;AAED,oBAAY,iCAAiC;IAC3C,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,QAAQ,aAAa;CACtB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,GAAG,IAAI,GAAG,IAAI,EAAE,MAAM,CAAC,CAOxE,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,cAAc;IACzB,0BAA0B;;IAE1B,8EAA8E;;IAE9E,mFAAmF;;IAEnF,oDAAoD;;IAEpD,+DAA+D;;IAE/D,kEAAkE;;IAElE,8CAA8C;;IAE9C,iDAAiD;;CAEzC,CAAC;AAEX,4EAA4E;AAC5E,MAAM,WAAW,kBAAkB;IACjC,4CAA4C;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,wEAAwE;IACxE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,8EAA8E;IAC9E,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,kFAAkF;IAClF,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,+EAA+E;IAC/E,SAAS,EAAE,MAAM,CAAC;IAClB,kDAAkD;IAClD,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,kBAAkB,EAAE,CAAC;CAChC;AAkCD;;;;;;;;;;GAUG;AACH,qBAAa,oBAAoB;IAC/B;;;;;OAKG;IACH,SAAS,EAAE,UAAU,GAAG,IAAI,CAAC;IAE7B;;;;;OAKG;IACH,aAAa,EAAE,UAAU,GAAG,IAAI,CAAC;IAEjC;;;;;OAKG;IACH,WAAW,EAAE,UAAU,GAAG,IAAI,CAAC;IAE/B;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;gBAEF,EACV,SAAiB,EACjB,aAAwB,EACxB,WAAqB,EACrB,KAAW,GACZ,GAAE,OAAO,CAAC,oBAAoB,CAAM;CAMtC;AAED;;;;;;;;;;;;GAYG;AACH,qBAAa,cAAc;IACzB;;;;OAIG;IACH,aAAa,EAAE,oBAAoB,GAAG,IAAI,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAiCG;IACH,gBAAgB,EAAE,CAAC,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAC,GAAG,IAAI,CAAC;gBAEvD,EACV,aAA0C,EAC1C,gBAAuB,GACxB,GAAE,OAAO,CAAC,cAAc,CAAM;CAIhC;AAuDD;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,eAAe,GACvB;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAC/B;IAAE,IAAI,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,GAC3D;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAE1C,uEAAuE;AACvE,eAAO,MAAM,sBAAsB,eAAe,CAAC;AAEnD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe;IAC1B;;;OAGG;iBAEK,MAAM,gBACC,MAAM,GAClB,eAAe;IAIlB,kFAAkF;gBACtE,MAAM,GAAG,eAAe;IAIpC;;;;;OAKG;uBAEM,MAAM,gBACA,MAAM,GAClB,eAAe;IAIlB,uFAAuF;sBACrE,MAAM,GAAG,eAAe;CAG3C,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2CG;AACH,qBAAa,mBAAmB;IAC9B;;;;;;;;;;;;;;;;;OAiBG;IACH,cAAc,EAAE,eAAe,EAAE,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,6BAA6B,EAAE,OAAO,CAAC;gBAE3B,EACV,cAAmB,EACnB,6BAAqC,GACtC,GAAE,OAAO,CAAC,mBAAmB,CAAM;CAIrC;AAiED,qBAAa,qBAAqB;IAChC;;;;;;;OAOG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;;;;;;OAUG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;;;;OAKG;IACH,eAAe,EAAE,mBAAmB,EAAE,CAAC;IAEvC;;;;;;;;OAQG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;;;;;;;OAQG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;;;OAOG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;;;;;;;;;;;OAaG;IACH,kBAAkB,EAAE,iCAAiC,CAAC;IAEtD;;;;;;;;;;;;;;OAcG;IACH,YAAY,EAAE,cAAc,GAAG,IAAI,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;;;;;;;;;;;OAcG;IACH,iBAAiB,EAAE,mBAAmB,GAAG,IAAI,CAAC;gBAElC,EACV,QAAe,EACf,kBAAyB,EACzB,wBAA8B,EAC9B,eAKC,EACD,aAAkB,EAClB,aAAqB,EACrB,kBAA+D,EAC/D,YAAmB,EACnB,SAA8B,EAC9B,iBAAwB,GACzB,GAAE,OAAO,CAAC,qBAAqB,CAAM;IAatC,OAAO,CAAC,6BAA6B;IASrC,MAAM,IAAI,MAAM;CA0CjB;AAED;;;;;;;;;;;GAWG;AACH,iBAAe,UAAU,CACvB,KAAK,EAAE,MAAM,EACb,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,IAAI,CAAC,CA2Cf;AAED;;;;;;;;;GASG;AACH,iBAAe,cAAc,CAC3B,wBAAwB,GAAE,MAAY,GACrC,OAAO,CAAC,IAAI,CAAC,CAIf;AAED;;;;GAIG;AACH,iBAAe,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAE5C;AAED;;;;GAIG;AACH,iBAAe,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,iBAAe,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAMzD;AAED;;;;;;;GAOG;AACH,iBAAe,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAEnD;AAED;;;;;;;GAOG;AACH,iBAAe,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAEpC;AAqFD,OAAO,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AAElE,eAAO,MAAM,eAAe;;;;;;;;CAQ3B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mixpanel/react-native-session-replay",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Official React Native turbo module for Mixpanel Session Replay",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",

package/src/MixpanelSessionReplayView.tsx

@@ -1,7 +1,40 @@
 import { requireNativeComponent, type ViewProps } from 'react-native';
 
 interface MixpanelSessionReplayViewProps extends ViewProps {
+  /**
+   * Masks everything inside this view in the replay video, and drops the text of every
+   * wireframe element under it.
+   *
+   * Controls pixels. Orthogonal to {@link wireframeText}, which controls what the
+   * wireframe *says*; the two compose.
+   */
   sensitive?: boolean;
+
+  /**
+   * Declares the text recorded for this view in the wireframe.
+   *
+   * **Beta.** Wireframes are in beta; see `MPWireframesOptions` for what to check before
+   * shipping to production.
+   *
+   * Use it to describe content the SDK can't read — custom-drawn views, charts, canvases —
+   * or to attach an analytical label. Declared text wins over the view's own visible text
+   * and over its accessibility label.
+   *
+   * **It is sent even when the view is masked.** Masking hides the pixels while the
+   * declared text still describes the view for the summary. Because you authored it rather
+   * than the SDK scraping it off the screen, making sure the text is not itself sensitive
+   * is up to you — if it could be, leave it off.
+   *
+   * ```tsx
+   * <MPSessionReplayView sensitive wireframeText="Card number">
+   *   <CardNumberField />
+   * </MPSessionReplayView>
+   * ```
+   *
+   * Requires `wireframesOptions` on the config; without it no wireframes are captured and
+   * this prop does nothing. Blank strings are ignored.
+   */
+  wireframeText?: string;
 }
 
 export const MPSessionReplayView =

package/src/NativeMixpanelReactNativeSessionReplay.ts

@@ -14,6 +14,13 @@ export interface Spec extends TurboModule {
   identify(distinctId: string): Promise<void>;
   getReplayId(): Promise<string | null>;
   flush(): Promise<void>;
+
+  // Event-emitter plumbing for the wireframe debug channel. `NativeEventEmitter`
+  // requires both on a TurboModule; on iOS they are inherited from `RCTEventEmitter`,
+  // and on Android they are no-ops because events go out over `RCTDeviceEventEmitter`,
+  // which needs no per-listener registration.
+  addListener(eventName: string): void;
+  removeListeners(count: number): void;
 }
 
 // Type declaration for global to include __turboModuleProxy