@mushi-mushi/react-native 0.23.0 → 0.24.0

package/dist/index.d.cts

@@ -1,7 +1,8 @@
 import * as react from 'react';
 import { ReactNode, FC, ReactElement } from 'react';
-import { MushiAnalyticsConfig, MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiPropertyValue, MushiTierResult, MushiReputationResult, MushiAssistantReply } from '@mushi-mushi/core';
+import { MushiAnalyticsConfig, MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiApiResponse, MushiHallOfFameEntry, MushiPropertyValue, MushiTierResult, MushiReputationResult, MushiAssistantReply } from '@mushi-mushi/core';
 export { MushiHallOfFameEntry, MushiReporterComment, MushiReporterReport } from '@mushi-mushi/core';
+import { MushiReporterUpdates, MushiReporterNotificationPrefs, MushiReporterPrefsUpdate, MushiReporterReportDetail } from '@mushi-mushi/core/reporter-channels';
 
 interface ConsoleEntry {
     level: 'log' | 'warn' | 'error';
@@ -158,6 +159,32 @@ interface MushiRNConfig {
          * `accent` is set, the text on it is chosen for contrast.
          */
         theme?: Partial<MushiRNTheme>;
+        /**
+         * Characters needed before Send enables. Default 8 (Plan 018 §1.1); an
+         * attached screenshot lowers it to 0.
+         */
+        minDescriptionLength?: number;
+    };
+    /**
+     * Optional native modules, passed in instead of loaded. When set, the SDK
+     * uses them and never loads that package itself — the safest option for
+     * Metro configs that disallow optional requires. Each one is also picked up
+     * automatically when installed.
+     * - `netInfo`: `@react-native-community/netinfo` — resend queued reports when the network returns.
+     * - `viewShot`: `react-native-view-shot` — attach a screenshot.
+     * - `expoSensors`: `expo-sensors` — shake to report.
+     */
+    netInfo?: unknown;
+    viewShot?: unknown;
+    expoSensors?: unknown;
+    /** How reporters hear back outside the sheet (Plan 018 §4). No native push. */
+    notifications?: {
+        /** One "the developer replied" / "your bug is fixed" toast when the app returns to the foreground. Default true. */
+        toast?: boolean;
+        /** Offer "Get updates by email" after sending, when the project offers email. Default true. */
+        email?: boolean;
+        /** Prefill that email box from `setUser({ email })`. Default false; the box is never pre-ticked. */
+        emailFromIdentity?: boolean;
     };
     assistant?: {
         enabled?: boolean;
@@ -218,6 +245,8 @@ interface MushiRNInstance {
     submitReport(data: {
         description: string;
         category: string;
+        /** Host / chip sub-label, e.g. 'feature' for the Idea chip. */
+        userCategory?: string;
         screenshotDataUrl?: string;
     }): Promise<{
         ok: boolean;
@@ -275,6 +304,33 @@ interface MushiRNInstance {
     loadMyThread(reportId: string): Promise<MushiReporterComment[] | null>;
     /** Mark this device's unread notifications for a report as read. Resolves the number marked (0 on failure). */
     markReportRead(reportId: string): Promise<number>;
+    /** Unread count and the newest unread updates on this device's reports (null on failure). */
+    getReporterUpdates(): Promise<MushiReporterUpdates | null>;
+    /**
+     * Fires with the unread count and newest updates when you subscribe and
+     * each time the app comes back to the foreground, so the host can draw its
+     * own badge (a feedback band, a tab dot). Returns an unsubscribe function.
+     */
+    onReporterUpdate(cb: (updates: MushiReporterUpdates) => void): () => void;
+    /** This reporter's email choices; the address comes back masked (null on failure). */
+    getNotificationPrefs(): Promise<MushiReporterNotificationPrefs | null>;
+    /**
+     * Ask for email updates (`{ email }` sends a confirmation email first) or
+     * change channels. Only when the reporter asked — never pre-tick an opt-in.
+     * Resolves the server's answer, including `EMAIL_NOT_AVAILABLE` when this
+     * app does not offer email. (No native push on React Native.)
+     */
+    setNotificationPrefs(update: MushiReporterPrefsUpdate): Promise<MushiApiResponse<MushiReporterNotificationPrefs>>;
+    /**
+     * One report with its timeline (GET /v1/reporter/reports/:id). Resolves
+     * null when it could not be loaded (show Retry) and 'unsupported' when the
+     * server predates the route (fall back to `loadMyThread`).
+     */
+    loadMyReportDetail(reportId: string): Promise<MushiReporterReportDetail | null | 'unsupported'>;
+    /** The address to prefill in the email opt-in box, only with `notifications.emailFromIdentity`. */
+    emailPrefill(): string | null;
+    /** Open the sheet on "Your reports". */
+    openMyReports(): void;
     /** Post a reporter reply on a report thread. Returns the new comment or null on failure. */
     replyToReport(reportId: string, body: string): Promise<MushiReporterComment | null>;
     /** Record a reporter feedback signal (e.g. `confirms`, `not_fixed`) on a report. Returns the outcome or null. */
@@ -328,7 +384,9 @@ declare function useMushiWidget(): {
  *
  * OVERVIEW:
  * - Slide-up modal built entirely on RN built-ins (Modal, Animated, PanResponder)
- * - Conversational flow: category → description → submit → confirmation
+ * - One screen, free text first: optional type chips, Send once there are a
+ *   few words (8 by default) or a screenshot, then a receipt in place with
+ *   Track it / Done and an optional, never pre-ticked email opt-in
  * - Drag-to-dismiss via PanResponder on the handle area
  * - Host-adaptive theme (`widget.theme`, see ../theme.ts) over light/dark
  * - "Your reports": statuses come from the shared core table
@@ -345,13 +403,17 @@ declare function useMushiWidget(): {
  * TECHNICAL DETAILS:
  * - PanResponder threshold: 80 px downward drag dismisses
  * - Animated.spring for slide-up, Animated.timing for backdrop
- * - Success confirmation auto-closes after 1.4 s
- * - Thread loads show a skeleton, then Retry on failure; a failed reply keeps
- *   its text and offers Retry. Opening a thread marks it read.
+ * - Reduce Motion (AccessibilityInfo) makes open / close instant
+ * - The thread is the report's v2 timeline (GET /v1/reporter/reports/:id):
+ *   pipeline events render from the shared core templates in the reporter's
+ *   locale, replies as bubbles. Loads show a skeleton, then Retry on failure;
+ *   a failed reply keeps its text and offers Retry. Opening a thread marks it
+ *   read. An older server without the route falls back to the comment list.
  *
  * NOTES:
  * - KeyboardAvoidingView wraps the sheet so the text input stays visible
- * - Categories match the web SDK: bug, slow, visual, confusing, other
+ * - Chips come from core's REPORTER_CATEGORIES (bug, slow, visual, confusing,
+ *   idea); "Idea" files a feature request
  * - accessibilityViewIsModal is iOS-only; RN's Modal is its own window on
  *   Android, which keeps TalkBack focus inside the sheet there.
  */
@@ -379,6 +441,10 @@ interface MushiBottomSheetProps {
     inboxPollIntervalMs?: number;
     /** Theme tokens (`widget.theme`); unset tokens use the neutral defaults. */
     theme?: Partial<MushiRNTheme>;
+    /** Characters needed before Send enables (`widget.minDescriptionLength`, default 8). */
+    minDescriptionLength?: number;
+    /** Offer "Get updates by email" on the receipt when the project offers email (`notifications.email`). */
+    emailOptIn?: boolean;
 }
 declare const MushiBottomSheet: FC<MushiBottomSheetProps>;
 
@@ -502,4 +568,46 @@ declare class AsyncStorageQueue {
     private getAsyncStorage;
 }
 
-export { AsyncStorageQueue, type ConsoleEntry, type DeviceInfo, MUSHI_BANNER_DEFAULT_HEIGHT, MushiBanner, type MushiBannerProps, MushiBottomSheet, type MushiBottomSheetProps, MushiFloatingButton, type MushiFloatingButtonProps, MushiProvider, type MushiRNConfig, type MushiRNInstance, MushiTrigger, type MushiTriggerProps, type NavigationEntry, type NetworkEntry, type RNAnalyticsConfig, getDeviceInfo, setupConsoleCapture, setupNetworkCapture, useMushi, useMushiReport, useMushiWidget, useNavigationCapture };
+/**
+ * FILE: optional-modules.ts
+ * PURPOSE: The SDK's three optional native peers (network-aware delivery,
+ *          screenshots, shake-to-report), loaded without crashing the app.
+ *
+ * Order for each one:
+ * 1. A module the host passed in config (`netInfo`, `viewShot`, `expoSensors`).
+ *    No dynamic loading at all — the safest path.
+ * 2. A literal `require('<module>')` inside try/catch. Metro resolves a literal
+ *    require at bundle time and treats one inside try/catch as optional
+ *    (`transformer.allowOptionalDependencies`, on in Expo and React Native's
+ *    default Metro config).
+ *
+ * Why the build matters: esbuild's ESM output rewrites `require('x')` to its
+ * `__require('x')` interop shim. Metro can't resolve a module name handed to
+ * the shim, so it called its own require with a string at runtime and crashed
+ * the app (reportFatalError) — the try/catch never saw it (0.21–0.23).
+ * tsup.config.ts restores literal `require(...)` in dist and fails the build
+ * if any `__require(` is left (src/bundling/preserve-optional-requires.ts).
+ */
+interface MushiNetInfoModule {
+    addEventListener(listener: (state: {
+        isConnected: boolean | null;
+        isInternetReachable: boolean | null;
+    }) => void): () => void;
+}
+interface MushiViewShotModule {
+    captureScreen(options: Record<string, unknown>): Promise<string>;
+}
+interface MushiExpoSensorsModule {
+    Accelerometer: {
+        setUpdateInterval(ms: number): void;
+        addListener(listener: (event: {
+            x: number;
+            y: number;
+            z: number;
+        }) => void): {
+            remove(): void;
+        };
+    };
+}
+
+export { AsyncStorageQueue, type ConsoleEntry, type DeviceInfo, MUSHI_BANNER_DEFAULT_HEIGHT, MushiBanner, type MushiBannerProps, MushiBottomSheet, type MushiBottomSheetProps, type MushiExpoSensorsModule, MushiFloatingButton, type MushiFloatingButtonProps, type MushiNetInfoModule, MushiProvider, type MushiRNConfig, type MushiRNInstance, MushiTrigger, type MushiTriggerProps, type MushiViewShotModule, type NavigationEntry, type NetworkEntry, type RNAnalyticsConfig, getDeviceInfo, setupConsoleCapture, setupNetworkCapture, useMushi, useMushiReport, useMushiWidget, useNavigationCapture };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import * as react from 'react';
 import { ReactNode, FC, ReactElement } from 'react';
-import { MushiAnalyticsConfig, MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiHallOfFameEntry, MushiPropertyValue, MushiTierResult, MushiReputationResult, MushiAssistantReply } from '@mushi-mushi/core';
+import { MushiAnalyticsConfig, MushiRewardsConfig, MushiPageContext, MushiBreadcrumb, MushiReporterReport, MushiReporterComment, MushiApiResponse, MushiHallOfFameEntry, MushiPropertyValue, MushiTierResult, MushiReputationResult, MushiAssistantReply } from '@mushi-mushi/core';
 export { MushiHallOfFameEntry, MushiReporterComment, MushiReporterReport } from '@mushi-mushi/core';
+import { MushiReporterUpdates, MushiReporterNotificationPrefs, MushiReporterPrefsUpdate, MushiReporterReportDetail } from '@mushi-mushi/core/reporter-channels';
 
 interface ConsoleEntry {
     level: 'log' | 'warn' | 'error';
@@ -158,6 +159,32 @@ interface MushiRNConfig {
          * `accent` is set, the text on it is chosen for contrast.
          */
         theme?: Partial<MushiRNTheme>;
+        /**
+         * Characters needed before Send enables. Default 8 (Plan 018 §1.1); an
+         * attached screenshot lowers it to 0.
+         */
+        minDescriptionLength?: number;
+    };
+    /**
+     * Optional native modules, passed in instead of loaded. When set, the SDK
+     * uses them and never loads that package itself — the safest option for
+     * Metro configs that disallow optional requires. Each one is also picked up
+     * automatically when installed.
+     * - `netInfo`: `@react-native-community/netinfo` — resend queued reports when the network returns.
+     * - `viewShot`: `react-native-view-shot` — attach a screenshot.
+     * - `expoSensors`: `expo-sensors` — shake to report.
+     */
+    netInfo?: unknown;
+    viewShot?: unknown;
+    expoSensors?: unknown;
+    /** How reporters hear back outside the sheet (Plan 018 §4). No native push. */
+    notifications?: {
+        /** One "the developer replied" / "your bug is fixed" toast when the app returns to the foreground. Default true. */
+        toast?: boolean;
+        /** Offer "Get updates by email" after sending, when the project offers email. Default true. */
+        email?: boolean;
+        /** Prefill that email box from `setUser({ email })`. Default false; the box is never pre-ticked. */
+        emailFromIdentity?: boolean;
     };
     assistant?: {
         enabled?: boolean;
@@ -218,6 +245,8 @@ interface MushiRNInstance {
     submitReport(data: {
         description: string;
         category: string;
+        /** Host / chip sub-label, e.g. 'feature' for the Idea chip. */
+        userCategory?: string;
         screenshotDataUrl?: string;
     }): Promise<{
         ok: boolean;
@@ -275,6 +304,33 @@ interface MushiRNInstance {
     loadMyThread(reportId: string): Promise<MushiReporterComment[] | null>;
     /** Mark this device's unread notifications for a report as read. Resolves the number marked (0 on failure). */
     markReportRead(reportId: string): Promise<number>;
+    /** Unread count and the newest unread updates on this device's reports (null on failure). */
+    getReporterUpdates(): Promise<MushiReporterUpdates | null>;
+    /**
+     * Fires with the unread count and newest updates when you subscribe and
+     * each time the app comes back to the foreground, so the host can draw its
+     * own badge (a feedback band, a tab dot). Returns an unsubscribe function.
+     */
+    onReporterUpdate(cb: (updates: MushiReporterUpdates) => void): () => void;
+    /** This reporter's email choices; the address comes back masked (null on failure). */
+    getNotificationPrefs(): Promise<MushiReporterNotificationPrefs | null>;
+    /**
+     * Ask for email updates (`{ email }` sends a confirmation email first) or
+     * change channels. Only when the reporter asked — never pre-tick an opt-in.
+     * Resolves the server's answer, including `EMAIL_NOT_AVAILABLE` when this
+     * app does not offer email. (No native push on React Native.)
+     */
+    setNotificationPrefs(update: MushiReporterPrefsUpdate): Promise<MushiApiResponse<MushiReporterNotificationPrefs>>;
+    /**
+     * One report with its timeline (GET /v1/reporter/reports/:id). Resolves
+     * null when it could not be loaded (show Retry) and 'unsupported' when the
+     * server predates the route (fall back to `loadMyThread`).
+     */
+    loadMyReportDetail(reportId: string): Promise<MushiReporterReportDetail | null | 'unsupported'>;
+    /** The address to prefill in the email opt-in box, only with `notifications.emailFromIdentity`. */
+    emailPrefill(): string | null;
+    /** Open the sheet on "Your reports". */
+    openMyReports(): void;
     /** Post a reporter reply on a report thread. Returns the new comment or null on failure. */
     replyToReport(reportId: string, body: string): Promise<MushiReporterComment | null>;
     /** Record a reporter feedback signal (e.g. `confirms`, `not_fixed`) on a report. Returns the outcome or null. */
@@ -328,7 +384,9 @@ declare function useMushiWidget(): {
  *
  * OVERVIEW:
  * - Slide-up modal built entirely on RN built-ins (Modal, Animated, PanResponder)
- * - Conversational flow: category → description → submit → confirmation
+ * - One screen, free text first: optional type chips, Send once there are a
+ *   few words (8 by default) or a screenshot, then a receipt in place with
+ *   Track it / Done and an optional, never pre-ticked email opt-in
  * - Drag-to-dismiss via PanResponder on the handle area
  * - Host-adaptive theme (`widget.theme`, see ../theme.ts) over light/dark
  * - "Your reports": statuses come from the shared core table
@@ -345,13 +403,17 @@ declare function useMushiWidget(): {
  * TECHNICAL DETAILS:
  * - PanResponder threshold: 80 px downward drag dismisses
  * - Animated.spring for slide-up, Animated.timing for backdrop
- * - Success confirmation auto-closes after 1.4 s
- * - Thread loads show a skeleton, then Retry on failure; a failed reply keeps
- *   its text and offers Retry. Opening a thread marks it read.
+ * - Reduce Motion (AccessibilityInfo) makes open / close instant
+ * - The thread is the report's v2 timeline (GET /v1/reporter/reports/:id):
+ *   pipeline events render from the shared core templates in the reporter's
+ *   locale, replies as bubbles. Loads show a skeleton, then Retry on failure;
+ *   a failed reply keeps its text and offers Retry. Opening a thread marks it
+ *   read. An older server without the route falls back to the comment list.
  *
  * NOTES:
  * - KeyboardAvoidingView wraps the sheet so the text input stays visible
- * - Categories match the web SDK: bug, slow, visual, confusing, other
+ * - Chips come from core's REPORTER_CATEGORIES (bug, slow, visual, confusing,
+ *   idea); "Idea" files a feature request
  * - accessibilityViewIsModal is iOS-only; RN's Modal is its own window on
  *   Android, which keeps TalkBack focus inside the sheet there.
  */
@@ -379,6 +441,10 @@ interface MushiBottomSheetProps {
     inboxPollIntervalMs?: number;
     /** Theme tokens (`widget.theme`); unset tokens use the neutral defaults. */
     theme?: Partial<MushiRNTheme>;
+    /** Characters needed before Send enables (`widget.minDescriptionLength`, default 8). */
+    minDescriptionLength?: number;
+    /** Offer "Get updates by email" on the receipt when the project offers email (`notifications.email`). */
+    emailOptIn?: boolean;
 }
 declare const MushiBottomSheet: FC<MushiBottomSheetProps>;
 
@@ -502,4 +568,46 @@ declare class AsyncStorageQueue {
     private getAsyncStorage;
 }
 
-export { AsyncStorageQueue, type ConsoleEntry, type DeviceInfo, MUSHI_BANNER_DEFAULT_HEIGHT, MushiBanner, type MushiBannerProps, MushiBottomSheet, type MushiBottomSheetProps, MushiFloatingButton, type MushiFloatingButtonProps, MushiProvider, type MushiRNConfig, type MushiRNInstance, MushiTrigger, type MushiTriggerProps, type NavigationEntry, type NetworkEntry, type RNAnalyticsConfig, getDeviceInfo, setupConsoleCapture, setupNetworkCapture, useMushi, useMushiReport, useMushiWidget, useNavigationCapture };
+/**
+ * FILE: optional-modules.ts
+ * PURPOSE: The SDK's three optional native peers (network-aware delivery,
+ *          screenshots, shake-to-report), loaded without crashing the app.
+ *
+ * Order for each one:
+ * 1. A module the host passed in config (`netInfo`, `viewShot`, `expoSensors`).
+ *    No dynamic loading at all — the safest path.
+ * 2. A literal `require('<module>')` inside try/catch. Metro resolves a literal
+ *    require at bundle time and treats one inside try/catch as optional
+ *    (`transformer.allowOptionalDependencies`, on in Expo and React Native's
+ *    default Metro config).
+ *
+ * Why the build matters: esbuild's ESM output rewrites `require('x')` to its
+ * `__require('x')` interop shim. Metro can't resolve a module name handed to
+ * the shim, so it called its own require with a string at runtime and crashed
+ * the app (reportFatalError) — the try/catch never saw it (0.21–0.23).
+ * tsup.config.ts restores literal `require(...)` in dist and fails the build
+ * if any `__require(` is left (src/bundling/preserve-optional-requires.ts).
+ */
+interface MushiNetInfoModule {
+    addEventListener(listener: (state: {
+        isConnected: boolean | null;
+        isInternetReachable: boolean | null;
+    }) => void): () => void;
+}
+interface MushiViewShotModule {
+    captureScreen(options: Record<string, unknown>): Promise<string>;
+}
+interface MushiExpoSensorsModule {
+    Accelerometer: {
+        setUpdateInterval(ms: number): void;
+        addListener(listener: (event: {
+            x: number;
+            y: number;
+            z: number;
+        }) => void): {
+            remove(): void;
+        };
+    };
+}
+
+export { AsyncStorageQueue, type ConsoleEntry, type DeviceInfo, MUSHI_BANNER_DEFAULT_HEIGHT, MushiBanner, type MushiBannerProps, MushiBottomSheet, type MushiBottomSheetProps, type MushiExpoSensorsModule, MushiFloatingButton, type MushiFloatingButtonProps, type MushiNetInfoModule, MushiProvider, type MushiRNConfig, type MushiRNInstance, MushiTrigger, type MushiTriggerProps, type MushiViewShotModule, type NavigationEntry, type NetworkEntry, type RNAnalyticsConfig, getDeviceInfo, setupConsoleCapture, setupNetworkCapture, useMushi, useMushiReport, useMushiWidget, useNavigationCapture };