@mushi-mushi/react-native 0.15.2 → 0.17.0

package/dist/index.d.cts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode, FC, ReactElement } from 'react';
-import { MushiRewardsConfig, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiTierResult, MushiReputationResult } from '@mushi-mushi/core';
+import { MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiTierResult, MushiReputationResult } from '@mushi-mushi/core';
 export { MushiHallOfFameEntry, MushiReporterComment, MushiReporterReport } from '@mushi-mushi/core';
 
 interface ConsoleEntry {
@@ -72,8 +72,19 @@ interface MushiRNConfig {
         console?: boolean;
         network?: boolean;
         navigation?: boolean;
+        /**
+         * Capture a screenshot of the current screen when the widget opens.
+         * Defaults to `true`. Requires the optional `react-native-view-shot`
+         * peer dependency — when it isn't installed, capture is skipped silently
+         * (the report is still sent without an image). The user always sees a
+         * thumbnail in the sheet and can remove it before submitting, so
+         * sensitive screens (balances, PII) are never sent without consent.
+         */
+        screenshot?: boolean;
         maxConsoleEntries?: number;
         maxNetworkEntries?: number;
+        /** Hard cap on the breadcrumb / repro-timeline ring buffer. Default 50. */
+        maxBreadcrumbs?: number;
     };
     storage?: {
         maxQueueSize?: number;
@@ -104,6 +115,27 @@ interface MushiRNInstance {
         provider?: string;
         [k: string]: unknown;
     }): void;
+    /**
+     * Alias for {@link identify} matching the web SDK's `Mushi.setUser()`.
+     * Accepts an object so hosts can call `setUser({ id, email, name })`.
+     */
+    setUser(user: {
+        id: string;
+        email?: string;
+        name?: string;
+        provider?: string;
+    }): void;
+    /**
+     * Identify the current end user with a signed Mushi identity JWT minted by
+     * the host server. Mirrors the web SDK; the backend verifies the signature
+     * before trusting any claim. Pass `null` on logout to go anonymous.
+     */
+    identifyWithToken(token: string | null): void;
+    /**
+     * Publish the current screen's context so the assistant can answer
+     * page-aware questions. Pass `null` to clear.
+     */
+    publishPageContext(context: MushiPageContext | null): void;
     /** Attach arbitrary key/value metadata to subsequent reports. */
     setMetadata(key: string, value: unknown): void;
     /** Set the current screen context attached to subsequent reports. */
@@ -112,6 +144,10 @@ interface MushiRNInstance {
         route?: string;
         feature?: string;
     }): void;
+    /** Append a breadcrumb to the repro timeline ring buffer. */
+    addBreadcrumb(crumb: Omit<MushiBreadcrumb, 'timestamp'> & {
+        timestamp?: number;
+    }): void;
     /** List this device's reports ordered by most recent. Returns [] on failure. */
     listMyReports(): Promise<MushiReporterReport[]>;
     /** List admin + reporter comments on a specific report. */
@@ -131,8 +167,9 @@ interface MushiRNInstance {
     /** Returns the current user's reputation + point totals. */
     getReputation(): Promise<MushiReputationResult | null>;
 }
-declare function MushiProvider({ children, ...config }: MushiRNConfig & {
+declare function MushiProvider({ children, config: configProp, ...barePropConfig }: MushiRNConfig & {
     children: ReactNode;
+    config?: Partial<MushiRNConfig>;
 }): react_jsx_runtime.JSX.Element;
 
 declare function useMushi(): MushiRNInstance | null;
@@ -188,29 +225,25 @@ interface MushiBottomSheetProps {
 declare const MushiBottomSheet: FC<MushiBottomSheetProps>;
 
 /**
- * FILE: MushiFloatingButton.tsx
- * PURPOSE: Floating action button (FAB) that triggers the Mushi bug-report bottom sheet
- *
- * OVERVIEW:
- * - Renders a persistent 🐛 button at bottom-right or bottom-left
- * - Animated press-scale effect via Animated.spring
- * - Position configurable through `buttonPosition` prop
+ * MushiFloatingButton — draggable, repositionable FAB for the Mushi SDK.
  *
- * DEPENDENCIES:
- * - React Native built-in APIs only
- *
- * USAGE:
- * - Rendered automatically by MushiProvider when widget.trigger is 'button' or 'both'
- * - Can be used standalone: <MushiFloatingButton onPress={…} />
- *
- * TECHNICAL DETAILS:
- * - Uses Animated.Value for scale, driven by onPressIn / onPressOut
- * - Safe-area aware: extra bottom padding on iOS
- *
- * NOTES:
- * - Keeps zIndex high (9999) so it floats above app content
+ * Supports:
+ * - PanResponder drag with tap-vs-drag threshold (6 px)
+ * - Clamp to screen bounds with safe-area respect
+ * - Optional edge-snap on release (`snapToEdge`)
+ * - Persist position to AsyncStorage (opt-in via `persist` config)
+ * - Press-in / press-out spring scale animation
+ * - Dark/light adaptive colours
  */
 
+interface MushiFloatingButtonConfig {
+    /** Allow the FAB to be dragged. Default: false. */
+    draggable?: boolean;
+    /** Snap FAB to the nearest vertical edge on release. Default: true. */
+    snapToEdge?: boolean;
+    /** Persist FAB position across app restarts via AsyncStorage. Default: false. */
+    persist?: boolean;
+}
 interface MushiFloatingButtonProps {
     onPress: () => void;
     position?: 'bottom-right' | 'bottom-left';
@@ -219,6 +252,10 @@ interface MushiFloatingButtonProps {
         left?: number;
         right?: number;
     };
+    /** Draggable + persist config */
+    config?: MushiFloatingButtonConfig;
+    /** Accent color (hex) — falls back to platform blue */
+    accent?: string;
 }
 declare const MushiFloatingButton: FC<MushiFloatingButtonProps>;
 

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode, FC, ReactElement } from 'react';
-import { MushiRewardsConfig, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiTierResult, MushiReputationResult } from '@mushi-mushi/core';
+import { MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiTierResult, MushiReputationResult } from '@mushi-mushi/core';
 export { MushiHallOfFameEntry, MushiReporterComment, MushiReporterReport } from '@mushi-mushi/core';
 
 interface ConsoleEntry {
@@ -72,8 +72,19 @@ interface MushiRNConfig {
         console?: boolean;
         network?: boolean;
         navigation?: boolean;
+        /**
+         * Capture a screenshot of the current screen when the widget opens.
+         * Defaults to `true`. Requires the optional `react-native-view-shot`
+         * peer dependency — when it isn't installed, capture is skipped silently
+         * (the report is still sent without an image). The user always sees a
+         * thumbnail in the sheet and can remove it before submitting, so
+         * sensitive screens (balances, PII) are never sent without consent.
+         */
+        screenshot?: boolean;
         maxConsoleEntries?: number;
         maxNetworkEntries?: number;
+        /** Hard cap on the breadcrumb / repro-timeline ring buffer. Default 50. */
+        maxBreadcrumbs?: number;
     };
     storage?: {
         maxQueueSize?: number;
@@ -104,6 +115,27 @@ interface MushiRNInstance {
         provider?: string;
         [k: string]: unknown;
     }): void;
+    /**
+     * Alias for {@link identify} matching the web SDK's `Mushi.setUser()`.
+     * Accepts an object so hosts can call `setUser({ id, email, name })`.
+     */
+    setUser(user: {
+        id: string;
+        email?: string;
+        name?: string;
+        provider?: string;
+    }): void;
+    /**
+     * Identify the current end user with a signed Mushi identity JWT minted by
+     * the host server. Mirrors the web SDK; the backend verifies the signature
+     * before trusting any claim. Pass `null` on logout to go anonymous.
+     */
+    identifyWithToken(token: string | null): void;
+    /**
+     * Publish the current screen's context so the assistant can answer
+     * page-aware questions. Pass `null` to clear.
+     */
+    publishPageContext(context: MushiPageContext | null): void;
     /** Attach arbitrary key/value metadata to subsequent reports. */
     setMetadata(key: string, value: unknown): void;
     /** Set the current screen context attached to subsequent reports. */
@@ -112,6 +144,10 @@ interface MushiRNInstance {
         route?: string;
         feature?: string;
     }): void;
+    /** Append a breadcrumb to the repro timeline ring buffer. */
+    addBreadcrumb(crumb: Omit<MushiBreadcrumb, 'timestamp'> & {
+        timestamp?: number;
+    }): void;
     /** List this device's reports ordered by most recent. Returns [] on failure. */
     listMyReports(): Promise<MushiReporterReport[]>;
     /** List admin + reporter comments on a specific report. */
@@ -131,8 +167,9 @@ interface MushiRNInstance {
     /** Returns the current user's reputation + point totals. */
     getReputation(): Promise<MushiReputationResult | null>;
 }
-declare function MushiProvider({ children, ...config }: MushiRNConfig & {
+declare function MushiProvider({ children, config: configProp, ...barePropConfig }: MushiRNConfig & {
     children: ReactNode;
+    config?: Partial<MushiRNConfig>;
 }): react_jsx_runtime.JSX.Element;
 
 declare function useMushi(): MushiRNInstance | null;
@@ -188,29 +225,25 @@ interface MushiBottomSheetProps {
 declare const MushiBottomSheet: FC<MushiBottomSheetProps>;
 
 /**
- * FILE: MushiFloatingButton.tsx
- * PURPOSE: Floating action button (FAB) that triggers the Mushi bug-report bottom sheet
- *
- * OVERVIEW:
- * - Renders a persistent 🐛 button at bottom-right or bottom-left
- * - Animated press-scale effect via Animated.spring
- * - Position configurable through `buttonPosition` prop
+ * MushiFloatingButton — draggable, repositionable FAB for the Mushi SDK.
  *
- * DEPENDENCIES:
- * - React Native built-in APIs only
- *
- * USAGE:
- * - Rendered automatically by MushiProvider when widget.trigger is 'button' or 'both'
- * - Can be used standalone: <MushiFloatingButton onPress={…} />
- *
- * TECHNICAL DETAILS:
- * - Uses Animated.Value for scale, driven by onPressIn / onPressOut
- * - Safe-area aware: extra bottom padding on iOS
- *
- * NOTES:
- * - Keeps zIndex high (9999) so it floats above app content
+ * Supports:
+ * - PanResponder drag with tap-vs-drag threshold (6 px)
+ * - Clamp to screen bounds with safe-area respect
+ * - Optional edge-snap on release (`snapToEdge`)
+ * - Persist position to AsyncStorage (opt-in via `persist` config)
+ * - Press-in / press-out spring scale animation
+ * - Dark/light adaptive colours
  */
 
+interface MushiFloatingButtonConfig {
+    /** Allow the FAB to be dragged. Default: false. */
+    draggable?: boolean;
+    /** Snap FAB to the nearest vertical edge on release. Default: true. */
+    snapToEdge?: boolean;
+    /** Persist FAB position across app restarts via AsyncStorage. Default: false. */
+    persist?: boolean;
+}
 interface MushiFloatingButtonProps {
     onPress: () => void;
     position?: 'bottom-right' | 'bottom-left';
@@ -219,6 +252,10 @@ interface MushiFloatingButtonProps {
         left?: number;
         right?: number;
     };
+    /** Draggable + persist config */
+    config?: MushiFloatingButtonConfig;
+    /** Accent color (hex) — falls back to platform blue */
+    accent?: string;
 }
 declare const MushiFloatingButton: FC<MushiFloatingButtonProps>;