@mushi-mushi/core 1.32.2 → 1.33.0

package/dist/reporter-channels.d.cts

@@ -1 +1 @@
-export { T as MushiPushSubscriptionJSON, X as MushiReporterChannelUnavailable, ak as MushiReporterChannels, Z as MushiReporterNotificationPrefs, _ as MushiReporterPrefsUpdate, a0 as MushiReporterReportDetail, a1 as MushiReporterTimelineItem, a2 as MushiReporterUpdates, al as reporterChannels, am as subscribeBrowserPush } from './types-CWa7T4bx.cjs';
+export { U as MushiPushSubscriptionJSON, Y as MushiReporterChannelUnavailable, am as MushiReporterChannels, _ as MushiReporterNotificationPrefs, $ as MushiReporterPrefsUpdate, a1 as MushiReporterReportDetail, a2 as MushiReporterTimelineItem, a3 as MushiReporterUpdates, an as reporterChannels, ao as subscribeBrowserPush } from './types-DkC08B8U.cjs';

package/dist/reporter-channels.d.ts

@@ -1 +1 @@
-export { T as MushiPushSubscriptionJSON, X as MushiReporterChannelUnavailable, ak as MushiReporterChannels, Z as MushiReporterNotificationPrefs, _ as MushiReporterPrefsUpdate, a0 as MushiReporterReportDetail, a1 as MushiReporterTimelineItem, a2 as MushiReporterUpdates, al as reporterChannels, am as subscribeBrowserPush } from './types-CWa7T4bx.js';
+export { U as MushiPushSubscriptionJSON, Y as MushiReporterChannelUnavailable, am as MushiReporterChannels, _ as MushiReporterNotificationPrefs, $ as MushiReporterPrefsUpdate, a1 as MushiReporterReportDetail, a2 as MushiReporterTimelineItem, a3 as MushiReporterUpdates, an as reporterChannels, ao as subscribeBrowserPush } from './types-DkC08B8U.js';

package/dist/{types-CWa7T4bx.d.cts → types-DkC08B8U.d.cts}

@@ -133,6 +133,12 @@ declare function subscribeBrowserPush(channels: Pick<MushiReporterChannels, 'sub
     reason: string;
 }>;
 
+/**
+ * What `Mushi.init()` and `<MushiProvider config>` accept: a {@link MushiConfig}
+ * whose `projectId` / `apiKey` may instead come from the NEXT_PUBLIC_MUSHI_* /
+ * VITE_MUSHI_* / MUSHI_* env vars. Init still throws if neither supplies them.
+ */
+type MushiInitConfig = Omit<MushiConfig, 'projectId' | 'apiKey'> & Partial<Pick<MushiConfig, 'projectId' | 'apiKey'>>;
 interface MushiConfig {
     projectId: string;
     apiKey: string;
@@ -311,15 +317,51 @@ interface MushiWidgetConfig {
     expandedTitle?: string;
     mode?: 'simple' | 'conversational';
     locale?: string;
+    /**
+     * Page-level z-index of the launcher (default `99999`). The panel and toasts
+     * sit at `zIndex + 1`. Each surface carries its own z-index and the widget's
+     * host element forms no stacking context, so these numbers compare directly
+     * with the host page's own layers. The banner has its own setting,
+     * `bannerConfig.zIndex`.
+     */
     zIndex?: number;
     /**
      * Controls how, or whether, the default trigger is injected.
-     * `auto`   — historical floating stamp FAB.
-     * `banner` — slim full-width header strip (recommended default; less obtrusive
-     *            than a FAB and visible even when the SDK launcher is `hide()`'d).
-     *            Pair with `bannerConfig` to customise appearance.
+     * `auto`     — floating stamp FAB; on phones it becomes an edge tab (see `mobileTrigger`).
+     * `edge-tab` — a slim tab flush with the screen edge: 22×48px drawn, 44×48px to tap.
+     * `banner`   — slim full-width header strip (recommended default; less obtrusive
+     *              than a FAB and visible even when the SDK launcher is `hide()`'d).
+     *              Pair with `bannerConfig` to customise appearance.
      */
     trigger?: 'auto' | 'banner' | 'edge-tab' | 'attach' | 'manual' | 'hidden';
+    /**
+     * What `trigger: 'auto'` draws at phone widths (≤ 768px). `'edge-tab'`
+     * draws the slim edge tab; `'auto'` keeps the round FAB. Default
+     * `'edge-tab'`, or `'auto'` when the host shaped the FAB itself (a left or
+     * right `anchor` / `inset`, `draggable`, or a word `triggerText`).
+     */
+    mobileTrigger?: 'edge-tab' | 'auto';
+    /**
+     * Lift the launcher, panel and toast above fixed or sticky host bars that
+     * touch the bottom of the viewport (tab bars, cookie strips, chat composers).
+     * Default `true`. The lift is a floor: an explicit `inset.bottom` or
+     * `anchor.bottom` that is already higher wins. Set `false` to keep the
+     * launcher exactly where `inset` / `anchor` puts it.
+     */
+    avoidFixedBars?: boolean;
+    /**
+     * Tuck the launcher toward its edge and fade it while the page scrolls,
+     * then bring it back when scrolling stops. Default `true`. Never tucks while
+     * the launcher has focus or the panel is open. Ignored when
+     * `smartHide.onScroll` is set.
+     */
+    tuckOnScroll?: boolean;
+    /**
+     * Show a "Hide the bug button for this visit" action in the report panel.
+     * The choice lasts until the tab closes (sessionStorage), including through
+     * `Mushi.show()`; `Mushi.open()` still opens the panel. Default `true`.
+     */
+    dismissible?: boolean;
     /**
      * Configuration for the header-banner launcher mode.
      * Only applies when `trigger === 'banner'`.
@@ -343,7 +385,9 @@ interface MushiWidgetConfig {
     /**
      * Allow the FAB to be dragged and repositioned by the user.
      * - `true`  — drag enabled, persisted to localStorage, snaps to nearest edge on release.
-     * - `false` — fixed position (default).
+     * - `false` — fixed position (default for the FAB).
+     * - Unset   — the edge tab can still be dragged up and down its edge (persisted per site).
+     * The edge tab always moves along its edge only (`axis: 'y'`).
      * - Object — fine-grained control:
      *   - `persist`     save position per projectId (default true when draggable).
      *   - `snapToEdge`  snap to the nearest left/right edge on release (default true).
@@ -440,10 +484,13 @@ interface MushiWidgetConfig {
     /**
      * CSS selectors of host-app elements that the widget trigger and panel must
      * never visually overlap. At render time the widget queries each selector,
-     * measures the union bounding rect, and nudges `--mushi-top` / `--mushi-bottom`
-     * so the panel clears every avoided element by at least 8px.
+     * measures its bounding rect, and moves the widget's anchored edge
+     * (`--mushi-bottom` for bottom positions, the default; `--mushi-top` for top
+     * positions) so it clears every avoided element in that half of the viewport
+     * by at least 8px. Elements in the other half are left alone.
      *
-     * Typical use: avoid a sticky mobile header or a fixed sign-in CTA.
+     * Typical use: a sticky mobile header for a top position, or a bottom tab
+     * bar or fixed sign-in CTA for a bottom position.
      *
      * @example
      * avoidSelectors: ['[data-mobile-header]', '#sign-in-cta']
@@ -522,14 +569,17 @@ interface MushiBannerConfig {
     /** 'top' pins the banner below any existing sticky headers; 'bottom' pins above bottom navs. Defaults to 'top'. */
     position?: 'top' | 'bottom';
     /**
-     * Body copy on the strip — the lime "Beta" announcement line users see in
+     * Body copy on the strip — the lime announcement line users see in
      * the Mushi admin console. When set, the banner switches to the rich layout
      * (pill + message + flat text actions) instead of button-only CTAs.
      */
     message?: string;
     /**
-     * Pill label shown before `message` (e.g. "Beta"). Defaults to `"Beta"` when
+     * Pill label shown before `message`. Defaults to `"Feedback"` when
      * `message` is set. Pass `false` to hide the pill.
+     *
+     * Do not set `"Beta"` in a production App Store or Google Play build: Apple
+     * can reject the app under guideline 2.2 (beta testing belongs in TestFlight).
      */
     label?: string | false;
     /** Override the call-to-action text in the banner. Defaults to '🐛 Report a bug'. */
@@ -540,7 +590,11 @@ interface MushiBannerConfig {
     featureCtaLabel?: string;
     /** Extra flat links after the bug/feature CTAs (e.g. "My submissions"). */
     links?: MushiBannerLink[];
-    /** CSS z-index of the banner element. Defaults to the widget's configured zIndex. */
+    /**
+     * Page-level z-index of the banner strip. Defaults to the widget's `zIndex`
+     * minus one, just under the launcher. Set it below your own overlays (sheets,
+     * drawers, dialogs) so they cover the banner, e.g. `130` under a `200` sheet.
+     */
     zIndex?: number;
 }
 interface MushiBetaModeConfig {
@@ -598,9 +652,12 @@ interface MushiCaptureConfig {
     screenshot?: 'on-report' | 'auto' | 'off';
     /**
      * Custom screenshot capture function. When provided, the SDK calls this
-     * instead of its built-in DOM-snapshot capturer. Return a JPEG/PNG data URI
-     * on success, or `null` to skip attachment. If the function throws the SDK
-     * falls back to the built-in capturer.
+     * instead of its built-in DOM-snapshot capturer. Resolve to a
+     * `data:image/jpeg` or `data:image/png` URL on success, or `null` to skip
+     * attachment. Any other string (a `file://` or `https://` URI) is ignored
+     * with a warning, so a native plugin's file must be read and returned as a
+     * data URL. If the function throws the SDK falls back to the built-in
+     * capturer.
      *
      * Primary use-case: Capacitor / WebView hosts that route through a native
      * plugin (e.g. `@capawesome/capacitor-screenshot`) to obtain a real pixel-
@@ -610,9 +667,9 @@ interface MushiCaptureConfig {
      * capture: {
      *   screenshot: 'auto',
      *   screenshotProvider: async () => {
-     *     const { Screenshot } = await import('@capawesome/capacitor-screenshot');
-     *     const { uri } = await Screenshot.take();
-     *     return uri; // data URI on web, file:// on native (SDK handles both)
+     *     // Base64 PNG from your native screenshot plugin.
+     *     const base64 = await takeNativeScreenshot();
+     *     return base64 ? `data:image/png;base64,${base64}` : null;
      *   },
      * }
      */
@@ -1910,7 +1967,8 @@ interface MushiDiscoveryEventPayload {
 }
 /** Payload for /v1/sdk/session — lightweight session lifecycle tracking.
  *  Best-effort, no offline queue. Privacy-safe: no PII by default;
- *  `user_id_hash` is the same device-fingerprint hash used elsewhere. */
+ *  `user_id_hash` is a one-way SHA-256 hex of the host's user id, never the
+ *  id itself, and stays null until the host identifies the user. */
 interface MushiSessionEventPayload {
     /** Lifecycle event kind. */
     kind: 'session_start' | 'session_heartbeat' | 'session_end' | 'page_view';
@@ -1925,7 +1983,7 @@ interface MushiSessionEventPayload {
     page_view_count?: number;
     /** Device fingerprint hash — same token used in reports. */
     reporter_token_hash?: string | null;
-    /** user_id_hash when the host app called Mushi.identify(). */
+    /** SHA-256 hex of the host user id, set after Mushi.identifyWithToken(). */
     user_id_hash?: string | null;
     user_agent?: string | null;
     sdk_version?: string;
@@ -1982,10 +2040,14 @@ interface MushiApiResponse<T> {
         status?: number;
     };
 }
+/** Widget block of the runtime config: older edge functions send `triggerText: null` for "use the SDK default". */
+type MushiRuntimeWidgetConfig = Omit<MushiWidgetConfig, 'triggerText'> & {
+    triggerText?: string | null;
+};
 interface MushiRuntimeSdkConfig {
     enabled?: boolean;
     version?: string | null;
-    widget?: MushiWidgetConfig;
+    widget?: MushiRuntimeWidgetConfig;
     capture?: MushiCaptureConfig;
     native?: {
         triggerMode?: 'shake' | 'button' | 'both' | 'none';
@@ -2100,4 +2162,4 @@ interface MushiTesterReputation {
     total_points: number;
 }
 
-export { type MushiReporterReport as $, type MushiDiscoverInventoryConfig as A, type MushiDiscoveryEventPayload as B, type MushiEventHandler as C, type MushiEventType as D, type MushiHallOfFameEntry as E, type MushiIntegrationsConfig as F, type MushiLeaderboardEntry as G, type MushiNetworkEntry as H, type MushiNotificationsConfig as I, type MushiOnDeviceClassifier as J, type MushiOnDeviceClassifierInput as K, type MushiOnDeviceClassifierResult as L, type MushiApiClient as M, type MushiPageContext as N, type MushiPerformanceMetrics as O, type MushiPreset as P, type MushiPrivacyConfig as Q, type MushiProactiveConfig as R, type MushiProductEventPayload as S, type MushiPushSubscriptionJSON as T, type MushiReportBuilder as U, type MushiReportCategory as V, type MushiReportStatus as W, type MushiReporterChannelUnavailable as X, type MushiReporterComment as Y, type MushiReporterNotificationPrefs as Z, type MushiReporterPrefsUpdate as _, type MushiConfig as a, type MushiReporterReportDetail as a0, type MushiReporterTimelineItem as a1, type MushiReporterUpdates as a2, type MushiReputationResult as a3, type MushiRewardsConfig as a4, type MushiRuntimeSdkConfig as a5, type MushiSDKInstance as a6, type MushiSdkVersionInfo as a7, type MushiSelectedElement as a8, type MushiSentryConfig as a9, type MushiSentryContext as aa, type MushiSessionEventPayload as ab, type MushiTesterReputation as ac, type MushiTierResult as ad, type MushiTimelineEntry as ae, type MushiTimelineKind as af, type MushiTracePropagationConfig as ag, type MushiUrlMatcher as ah, type MushiWidgetAnchor as ai, type MushiWidgetConfig as aj, type MushiReporterChannels as ak, reporterChannels as al, subscribeBrowserPush as am, type MushiPreFilterConfig as b, type MushiReport as c, type MushiOfflineConfig as d, type MushiEnvironment as e, type MushiAnalyticsConfig as f, type MushiPropertyValue as g, type MushiBreadcrumb as h, type MushiActivityEvent as i, type MushiApiCascadeConfig as j, type MushiApiResponse as k, type MushiAssistantConfig as l, type MushiAssistantReply as m, type MushiAssistantStep as n, type MushiBannerConfig as o, type MushiBannerLink as p, type MushiBetaChangelogEntry as q, type MushiBetaModeConfig as r, type MushiCaptureConfig as s, type MushiCaptureEventInput as t, type MushiCaptureExceptionOptions as u, type MushiConsoleEntry as v, type MushiCooldownConfig as w, type MushiCrossAppReport as x, type MushiCustomCategory as y, type MushiDiagnosticsResult as z };
+export { type MushiReporterPrefsUpdate as $, type MushiDiscoverInventoryConfig as A, type MushiDiscoveryEventPayload as B, type MushiEventHandler as C, type MushiEventType as D, type MushiHallOfFameEntry as E, type MushiInitConfig as F, type MushiIntegrationsConfig as G, type MushiLeaderboardEntry as H, type MushiNetworkEntry as I, type MushiNotificationsConfig as J, type MushiOnDeviceClassifier as K, type MushiOnDeviceClassifierInput as L, type MushiApiClient as M, type MushiOnDeviceClassifierResult as N, type MushiPageContext as O, type MushiPerformanceMetrics as P, type MushiPreset as Q, type MushiPrivacyConfig as R, type MushiProactiveConfig as S, type MushiProductEventPayload as T, type MushiPushSubscriptionJSON as U, type MushiReportBuilder as V, type MushiReportCategory as W, type MushiReportStatus as X, type MushiReporterChannelUnavailable as Y, type MushiReporterComment as Z, type MushiReporterNotificationPrefs as _, type MushiConfig as a, type MushiReporterReport as a0, type MushiReporterReportDetail as a1, type MushiReporterTimelineItem as a2, type MushiReporterUpdates as a3, type MushiReputationResult as a4, type MushiRewardsConfig as a5, type MushiRuntimeSdkConfig as a6, type MushiRuntimeWidgetConfig as a7, type MushiSDKInstance as a8, type MushiSdkVersionInfo as a9, type MushiSelectedElement as aa, type MushiSentryConfig as ab, type MushiSentryContext as ac, type MushiSessionEventPayload as ad, type MushiTesterReputation as ae, type MushiTierResult as af, type MushiTimelineEntry as ag, type MushiTimelineKind as ah, type MushiTracePropagationConfig as ai, type MushiUrlMatcher as aj, type MushiWidgetAnchor as ak, type MushiWidgetConfig as al, type MushiReporterChannels as am, reporterChannels as an, subscribeBrowserPush as ao, type MushiPreFilterConfig as b, type MushiReport as c, type MushiOfflineConfig as d, type MushiEnvironment as e, type MushiAnalyticsConfig as f, type MushiPropertyValue as g, type MushiBreadcrumb as h, type MushiActivityEvent as i, type MushiApiCascadeConfig as j, type MushiApiResponse as k, type MushiAssistantConfig as l, type MushiAssistantReply as m, type MushiAssistantStep as n, type MushiBannerConfig as o, type MushiBannerLink as p, type MushiBetaChangelogEntry as q, type MushiBetaModeConfig as r, type MushiCaptureConfig as s, type MushiCaptureEventInput as t, type MushiCaptureExceptionOptions as u, type MushiConsoleEntry as v, type MushiCooldownConfig as w, type MushiCrossAppReport as x, type MushiCustomCategory as y, type MushiDiagnosticsResult as z };

package/dist/{types-CWa7T4bx.d.ts → types-DkC08B8U.d.ts}

@@ -133,6 +133,12 @@ declare function subscribeBrowserPush(channels: Pick<MushiReporterChannels, 'sub
     reason: string;
 }>;
 
+/**
+ * What `Mushi.init()` and `<MushiProvider config>` accept: a {@link MushiConfig}
+ * whose `projectId` / `apiKey` may instead come from the NEXT_PUBLIC_MUSHI_* /
+ * VITE_MUSHI_* / MUSHI_* env vars. Init still throws if neither supplies them.
+ */
+type MushiInitConfig = Omit<MushiConfig, 'projectId' | 'apiKey'> & Partial<Pick<MushiConfig, 'projectId' | 'apiKey'>>;
 interface MushiConfig {
     projectId: string;
     apiKey: string;
@@ -311,15 +317,51 @@ interface MushiWidgetConfig {
     expandedTitle?: string;
     mode?: 'simple' | 'conversational';
     locale?: string;
+    /**
+     * Page-level z-index of the launcher (default `99999`). The panel and toasts
+     * sit at `zIndex + 1`. Each surface carries its own z-index and the widget's
+     * host element forms no stacking context, so these numbers compare directly
+     * with the host page's own layers. The banner has its own setting,
+     * `bannerConfig.zIndex`.
+     */
     zIndex?: number;
     /**
      * Controls how, or whether, the default trigger is injected.
-     * `auto`   — historical floating stamp FAB.
-     * `banner` — slim full-width header strip (recommended default; less obtrusive
-     *            than a FAB and visible even when the SDK launcher is `hide()`'d).
-     *            Pair with `bannerConfig` to customise appearance.
+     * `auto`     — floating stamp FAB; on phones it becomes an edge tab (see `mobileTrigger`).
+     * `edge-tab` — a slim tab flush with the screen edge: 22×48px drawn, 44×48px to tap.
+     * `banner`   — slim full-width header strip (recommended default; less obtrusive
+     *              than a FAB and visible even when the SDK launcher is `hide()`'d).
+     *              Pair with `bannerConfig` to customise appearance.
      */
     trigger?: 'auto' | 'banner' | 'edge-tab' | 'attach' | 'manual' | 'hidden';
+    /**
+     * What `trigger: 'auto'` draws at phone widths (≤ 768px). `'edge-tab'`
+     * draws the slim edge tab; `'auto'` keeps the round FAB. Default
+     * `'edge-tab'`, or `'auto'` when the host shaped the FAB itself (a left or
+     * right `anchor` / `inset`, `draggable`, or a word `triggerText`).
+     */
+    mobileTrigger?: 'edge-tab' | 'auto';
+    /**
+     * Lift the launcher, panel and toast above fixed or sticky host bars that
+     * touch the bottom of the viewport (tab bars, cookie strips, chat composers).
+     * Default `true`. The lift is a floor: an explicit `inset.bottom` or
+     * `anchor.bottom` that is already higher wins. Set `false` to keep the
+     * launcher exactly where `inset` / `anchor` puts it.
+     */
+    avoidFixedBars?: boolean;
+    /**
+     * Tuck the launcher toward its edge and fade it while the page scrolls,
+     * then bring it back when scrolling stops. Default `true`. Never tucks while
+     * the launcher has focus or the panel is open. Ignored when
+     * `smartHide.onScroll` is set.
+     */
+    tuckOnScroll?: boolean;
+    /**
+     * Show a "Hide the bug button for this visit" action in the report panel.
+     * The choice lasts until the tab closes (sessionStorage), including through
+     * `Mushi.show()`; `Mushi.open()` still opens the panel. Default `true`.
+     */
+    dismissible?: boolean;
     /**
      * Configuration for the header-banner launcher mode.
      * Only applies when `trigger === 'banner'`.
@@ -343,7 +385,9 @@ interface MushiWidgetConfig {
     /**
      * Allow the FAB to be dragged and repositioned by the user.
      * - `true`  — drag enabled, persisted to localStorage, snaps to nearest edge on release.
-     * - `false` — fixed position (default).
+     * - `false` — fixed position (default for the FAB).
+     * - Unset   — the edge tab can still be dragged up and down its edge (persisted per site).
+     * The edge tab always moves along its edge only (`axis: 'y'`).
      * - Object — fine-grained control:
      *   - `persist`     save position per projectId (default true when draggable).
      *   - `snapToEdge`  snap to the nearest left/right edge on release (default true).
@@ -440,10 +484,13 @@ interface MushiWidgetConfig {
     /**
      * CSS selectors of host-app elements that the widget trigger and panel must
      * never visually overlap. At render time the widget queries each selector,
-     * measures the union bounding rect, and nudges `--mushi-top` / `--mushi-bottom`
-     * so the panel clears every avoided element by at least 8px.
+     * measures its bounding rect, and moves the widget's anchored edge
+     * (`--mushi-bottom` for bottom positions, the default; `--mushi-top` for top
+     * positions) so it clears every avoided element in that half of the viewport
+     * by at least 8px. Elements in the other half are left alone.
      *
-     * Typical use: avoid a sticky mobile header or a fixed sign-in CTA.
+     * Typical use: a sticky mobile header for a top position, or a bottom tab
+     * bar or fixed sign-in CTA for a bottom position.
      *
      * @example
      * avoidSelectors: ['[data-mobile-header]', '#sign-in-cta']
@@ -522,14 +569,17 @@ interface MushiBannerConfig {
     /** 'top' pins the banner below any existing sticky headers; 'bottom' pins above bottom navs. Defaults to 'top'. */
     position?: 'top' | 'bottom';
     /**
-     * Body copy on the strip — the lime "Beta" announcement line users see in
+     * Body copy on the strip — the lime announcement line users see in
      * the Mushi admin console. When set, the banner switches to the rich layout
      * (pill + message + flat text actions) instead of button-only CTAs.
      */
     message?: string;
     /**
-     * Pill label shown before `message` (e.g. "Beta"). Defaults to `"Beta"` when
+     * Pill label shown before `message`. Defaults to `"Feedback"` when
      * `message` is set. Pass `false` to hide the pill.
+     *
+     * Do not set `"Beta"` in a production App Store or Google Play build: Apple
+     * can reject the app under guideline 2.2 (beta testing belongs in TestFlight).
      */
     label?: string | false;
     /** Override the call-to-action text in the banner. Defaults to '🐛 Report a bug'. */
@@ -540,7 +590,11 @@ interface MushiBannerConfig {
     featureCtaLabel?: string;
     /** Extra flat links after the bug/feature CTAs (e.g. "My submissions"). */
     links?: MushiBannerLink[];
-    /** CSS z-index of the banner element. Defaults to the widget's configured zIndex. */
+    /**
+     * Page-level z-index of the banner strip. Defaults to the widget's `zIndex`
+     * minus one, just under the launcher. Set it below your own overlays (sheets,
+     * drawers, dialogs) so they cover the banner, e.g. `130` under a `200` sheet.
+     */
     zIndex?: number;
 }
 interface MushiBetaModeConfig {
@@ -598,9 +652,12 @@ interface MushiCaptureConfig {
     screenshot?: 'on-report' | 'auto' | 'off';
     /**
      * Custom screenshot capture function. When provided, the SDK calls this
-     * instead of its built-in DOM-snapshot capturer. Return a JPEG/PNG data URI
-     * on success, or `null` to skip attachment. If the function throws the SDK
-     * falls back to the built-in capturer.
+     * instead of its built-in DOM-snapshot capturer. Resolve to a
+     * `data:image/jpeg` or `data:image/png` URL on success, or `null` to skip
+     * attachment. Any other string (a `file://` or `https://` URI) is ignored
+     * with a warning, so a native plugin's file must be read and returned as a
+     * data URL. If the function throws the SDK falls back to the built-in
+     * capturer.
      *
      * Primary use-case: Capacitor / WebView hosts that route through a native
      * plugin (e.g. `@capawesome/capacitor-screenshot`) to obtain a real pixel-
@@ -610,9 +667,9 @@ interface MushiCaptureConfig {
      * capture: {
      *   screenshot: 'auto',
      *   screenshotProvider: async () => {
-     *     const { Screenshot } = await import('@capawesome/capacitor-screenshot');
-     *     const { uri } = await Screenshot.take();
-     *     return uri; // data URI on web, file:// on native (SDK handles both)
+     *     // Base64 PNG from your native screenshot plugin.
+     *     const base64 = await takeNativeScreenshot();
+     *     return base64 ? `data:image/png;base64,${base64}` : null;
      *   },
      * }
      */
@@ -1910,7 +1967,8 @@ interface MushiDiscoveryEventPayload {
 }
 /** Payload for /v1/sdk/session — lightweight session lifecycle tracking.
  *  Best-effort, no offline queue. Privacy-safe: no PII by default;
- *  `user_id_hash` is the same device-fingerprint hash used elsewhere. */
+ *  `user_id_hash` is a one-way SHA-256 hex of the host's user id, never the
+ *  id itself, and stays null until the host identifies the user. */
 interface MushiSessionEventPayload {
     /** Lifecycle event kind. */
     kind: 'session_start' | 'session_heartbeat' | 'session_end' | 'page_view';
@@ -1925,7 +1983,7 @@ interface MushiSessionEventPayload {
     page_view_count?: number;
     /** Device fingerprint hash — same token used in reports. */
     reporter_token_hash?: string | null;
-    /** user_id_hash when the host app called Mushi.identify(). */
+    /** SHA-256 hex of the host user id, set after Mushi.identifyWithToken(). */
     user_id_hash?: string | null;
     user_agent?: string | null;
     sdk_version?: string;
@@ -1982,10 +2040,14 @@ interface MushiApiResponse<T> {
         status?: number;
     };
 }
+/** Widget block of the runtime config: older edge functions send `triggerText: null` for "use the SDK default". */
+type MushiRuntimeWidgetConfig = Omit<MushiWidgetConfig, 'triggerText'> & {
+    triggerText?: string | null;
+};
 interface MushiRuntimeSdkConfig {
     enabled?: boolean;
     version?: string | null;
-    widget?: MushiWidgetConfig;
+    widget?: MushiRuntimeWidgetConfig;
     capture?: MushiCaptureConfig;
     native?: {
         triggerMode?: 'shake' | 'button' | 'both' | 'none';
@@ -2100,4 +2162,4 @@ interface MushiTesterReputation {
     total_points: number;
 }
 
-export { type MushiReporterReport as $, type MushiDiscoverInventoryConfig as A, type MushiDiscoveryEventPayload as B, type MushiEventHandler as C, type MushiEventType as D, type MushiHallOfFameEntry as E, type MushiIntegrationsConfig as F, type MushiLeaderboardEntry as G, type MushiNetworkEntry as H, type MushiNotificationsConfig as I, type MushiOnDeviceClassifier as J, type MushiOnDeviceClassifierInput as K, type MushiOnDeviceClassifierResult as L, type MushiApiClient as M, type MushiPageContext as N, type MushiPerformanceMetrics as O, type MushiPreset as P, type MushiPrivacyConfig as Q, type MushiProactiveConfig as R, type MushiProductEventPayload as S, type MushiPushSubscriptionJSON as T, type MushiReportBuilder as U, type MushiReportCategory as V, type MushiReportStatus as W, type MushiReporterChannelUnavailable as X, type MushiReporterComment as Y, type MushiReporterNotificationPrefs as Z, type MushiReporterPrefsUpdate as _, type MushiConfig as a, type MushiReporterReportDetail as a0, type MushiReporterTimelineItem as a1, type MushiReporterUpdates as a2, type MushiReputationResult as a3, type MushiRewardsConfig as a4, type MushiRuntimeSdkConfig as a5, type MushiSDKInstance as a6, type MushiSdkVersionInfo as a7, type MushiSelectedElement as a8, type MushiSentryConfig as a9, type MushiSentryContext as aa, type MushiSessionEventPayload as ab, type MushiTesterReputation as ac, type MushiTierResult as ad, type MushiTimelineEntry as ae, type MushiTimelineKind as af, type MushiTracePropagationConfig as ag, type MushiUrlMatcher as ah, type MushiWidgetAnchor as ai, type MushiWidgetConfig as aj, type MushiReporterChannels as ak, reporterChannels as al, subscribeBrowserPush as am, type MushiPreFilterConfig as b, type MushiReport as c, type MushiOfflineConfig as d, type MushiEnvironment as e, type MushiAnalyticsConfig as f, type MushiPropertyValue as g, type MushiBreadcrumb as h, type MushiActivityEvent as i, type MushiApiCascadeConfig as j, type MushiApiResponse as k, type MushiAssistantConfig as l, type MushiAssistantReply as m, type MushiAssistantStep as n, type MushiBannerConfig as o, type MushiBannerLink as p, type MushiBetaChangelogEntry as q, type MushiBetaModeConfig as r, type MushiCaptureConfig as s, type MushiCaptureEventInput as t, type MushiCaptureExceptionOptions as u, type MushiConsoleEntry as v, type MushiCooldownConfig as w, type MushiCrossAppReport as x, type MushiCustomCategory as y, type MushiDiagnosticsResult as z };
+export { type MushiReporterPrefsUpdate as $, type MushiDiscoverInventoryConfig as A, type MushiDiscoveryEventPayload as B, type MushiEventHandler as C, type MushiEventType as D, type MushiHallOfFameEntry as E, type MushiInitConfig as F, type MushiIntegrationsConfig as G, type MushiLeaderboardEntry as H, type MushiNetworkEntry as I, type MushiNotificationsConfig as J, type MushiOnDeviceClassifier as K, type MushiOnDeviceClassifierInput as L, type MushiApiClient as M, type MushiOnDeviceClassifierResult as N, type MushiPageContext as O, type MushiPerformanceMetrics as P, type MushiPreset as Q, type MushiPrivacyConfig as R, type MushiProactiveConfig as S, type MushiProductEventPayload as T, type MushiPushSubscriptionJSON as U, type MushiReportBuilder as V, type MushiReportCategory as W, type MushiReportStatus as X, type MushiReporterChannelUnavailable as Y, type MushiReporterComment as Z, type MushiReporterNotificationPrefs as _, type MushiConfig as a, type MushiReporterReport as a0, type MushiReporterReportDetail as a1, type MushiReporterTimelineItem as a2, type MushiReporterUpdates as a3, type MushiReputationResult as a4, type MushiRewardsConfig as a5, type MushiRuntimeSdkConfig as a6, type MushiRuntimeWidgetConfig as a7, type MushiSDKInstance as a8, type MushiSdkVersionInfo as a9, type MushiSelectedElement as aa, type MushiSentryConfig as ab, type MushiSentryContext as ac, type MushiSessionEventPayload as ad, type MushiTesterReputation as ae, type MushiTierResult as af, type MushiTimelineEntry as ag, type MushiTimelineKind as ah, type MushiTracePropagationConfig as ai, type MushiUrlMatcher as aj, type MushiWidgetAnchor as ak, type MushiWidgetConfig as al, type MushiReporterChannels as am, reporterChannels as an, subscribeBrowserPush as ao, type MushiPreFilterConfig as b, type MushiReport as c, type MushiOfflineConfig as d, type MushiEnvironment as e, type MushiAnalyticsConfig as f, type MushiPropertyValue as g, type MushiBreadcrumb as h, type MushiActivityEvent as i, type MushiApiCascadeConfig as j, type MushiApiResponse as k, type MushiAssistantConfig as l, type MushiAssistantReply as m, type MushiAssistantStep as n, type MushiBannerConfig as o, type MushiBannerLink as p, type MushiBetaChangelogEntry as q, type MushiBetaModeConfig as r, type MushiCaptureConfig as s, type MushiCaptureEventInput as t, type MushiCaptureExceptionOptions as u, type MushiConsoleEntry as v, type MushiCooldownConfig as w, type MushiCrossAppReport as x, type MushiCustomCategory as y, type MushiDiagnosticsResult as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mushi-mushi/core",
-  "version": "1.32.2",
+  "version": "1.33.0",
   "description": "Types, API client and pre-filter for Mushi SDKs. The bug mediator for AI-built apps: plain-English diagnosis + a ready fix, in your editor.",
   "license": "MIT",
   "type": "module",