@mushi-mushi/core 1.2.0 → 1.6.0

package/dist/index.d.cts

@@ -21,6 +21,10 @@ interface MushiConfig {
     rewards?: MushiRewardsConfig;
     debug?: boolean;
     enabled?: boolean;
+    /** Hook called before a report is sent. Return null to cancel, or return the (possibly modified) report. */
+    beforeSendFeedback?: (report: MushiReport) => MushiReport | null | Promise<MushiReport | null>;
+    /** Called once if the app crashed during the previous session. */
+    onCrashedLastRun?: (crashed: boolean) => void;
 }
 interface MushiSentryConfig {
     dsn?: string;
@@ -73,6 +77,38 @@ interface MushiWidgetConfig {
      * actively inviting feedback.
      */
     betaMode?: MushiBetaModeConfig;
+    /**
+     * Absolute base URL of the Mushi admin console (e.g. `https://mushi.example.com`).
+     * When set, the success step surfaces a one-tap link to the user's own report
+     * on the console so they can watch the status change in real time. Without
+     * this the success step still confirms submission but cannot deep-link.
+     *
+     * This is intentionally separate from the API endpoint — production apps
+     * usually have the API on `api.mushi.example.com` and the console on
+     * `app.mushi.example.com`.
+     */
+    dashboardUrl?: string;
+    /**
+     * Override the SLA copy shown in the success step's "what happens next"
+     * line. Defaults to "We aim to review within 48h". Set to an empty string
+     * to hide the line entirely (e.g. internal-only deployments where SLA
+     * messaging would be over-promising).
+     */
+    responseSlaLabel?: string;
+    /**
+     * Show a first-class "Feature request" card at the top of the category
+     * step. Defaults to true. Set to false for production-only deployments
+     * where you don't want to invite feature ideas through the widget.
+     * Internally this maps to `category='other'` with
+     * `user_category='Feature request'` so no DB migration is needed.
+     */
+    featureRequestCard?: boolean;
+    /** Override the localised label for the feature-request card. */
+    featureRequestLabel?: string;
+    /** Override the helper text shown under the feature-request card. */
+    featureRequestDescription?: string;
+    /** Minimum description character count before the submit button enables. */
+    minDescriptionLength?: number;
 }
 interface MushiBetaModeConfig {
     enabled?: boolean;
@@ -198,6 +234,17 @@ interface MushiPrivacyConfig {
     maskSelectors?: string[];
     /** DOM subtrees to remove from screenshots before upload. */
     blockSelectors?: string[];
+    /**
+     * CSS selectors whose matching elements are blacked-out (filled with an
+     * opaque black rectangle) in screenshots before upload. Intended for
+     * sensitive fields that should never appear in any form — passwords, PII,
+     * financial data. Applied in addition to `maskSelectors`.
+     *
+     * Default: `['input[type="password"]', '[data-mushi-redact]']`
+     *
+     * To disable the default redaction, pass an empty array.
+     */
+    redactSelectors?: string[];
     /** Let reporters remove an attached screenshot before submitting. Defaults to true. */
     allowUserRemoveScreenshot?: boolean;
 }
@@ -207,6 +254,38 @@ interface MushiProactiveConfig {
     longTask?: boolean;
     apiCascade?: boolean | MushiApiCascadeConfig;
     cooldown?: MushiCooldownConfig;
+    /**
+     * Beta-mode nudge: fire after the user has been on the same route for
+     * `thresholdMs` continuous milliseconds (default 5min). Pass `true` to
+     * accept the default threshold, or a config object to override. Use
+     * conservatively — set the per-session cap in `cooldown` to avoid
+     * nag fatigue.
+     */
+    pageDwell?: boolean | MushiPageDwellConfig;
+    /**
+     * One-shot welcome prompt for first-time visitors. Fires `delayMs` after
+     * `Mushi.init` (default 45s) and is suppressed permanently after the
+     * first fire via localStorage. Recommended for beta deployments.
+     */
+    firstSession?: boolean | MushiFirstSessionConfig;
+}
+interface MushiPageDwellConfig {
+    /** Continuous dwell time before firing. Defaults to 5 minutes. */
+    thresholdMs?: number;
+    /**
+     * Route path prefixes (or glob-style patterns with `*`) that suppress the
+     * dwell nudge. Auth routes are excluded by default so users aren't prompted
+     * during login/signup flows.
+     *
+     * Default: `['/login', '/logout', '/signup', '/sso/*', '/auth/*']`
+     */
+    excludeRoutes?: string[];
+}
+interface MushiFirstSessionConfig {
+    /** Delay before firing the welcome nudge. Defaults to 45 seconds. */
+    delayMs?: number;
+    /** Override the localStorage key used to mark the user as welcomed. */
+    storageKey?: string;
 }
 type MushiUrlMatcher = string | RegExp;
 interface MushiApiCascadeConfig {
@@ -665,6 +744,13 @@ interface MushiPerformanceMetrics {
     inp?: number;
     ttfb?: number;
     longTasks?: number;
+    inpAttribution?: {
+        eventType?: string;
+        targetSelector?: string;
+        inputDelay?: number;
+        processingDuration?: number;
+        presentationDelay?: number;
+    };
 }
 interface MushiSelectedElement {
     tagName: string;
@@ -697,7 +783,7 @@ interface MushiTimelineEntry {
     kind: MushiTimelineKind;
     payload: Record<string, unknown>;
 }
-type MushiEventType = 'report:submitted' | 'report:queued' | 'report:sent' | 'report:failed' | 'widget:opened' | 'widget:closed' | 'proactive:triggered' | 'proactive:dismissed';
+type MushiEventType = 'report:submitted' | 'report:queued' | 'report:sent' | 'report:failed' | 'widget:opened' | 'widget:closed' | 'proactive:triggered' | 'proactive:dismissed' | 'report:dispatched';
 type MushiEventHandler = (event: {
     type: MushiEventType;
     data?: unknown;
@@ -714,8 +800,16 @@ interface MushiDiagnosticsResult {
     sdkVersion: string;
 }
 interface MushiSDKInstance {
+    /**
+     * Open the reporter widget. With no options, opens to the category
+     * picker so the user can choose between bug categories and the
+     * feature-request shortcut. Pass `{ category }` to deep-link into a
+     * specific bug intent, or `{ featureRequest: true }` to deep-link into
+     * the feature-request description step (skips intent picker).
+     */
     report(options?: {
         category?: MushiReportCategory;
+        featureRequest?: boolean;
     }): void;
     on(event: MushiEventType, handler: MushiEventHandler): () => void;
     setUser(user: {
@@ -816,6 +910,12 @@ interface MushiSDKInstance {
      * No-op when rewards are disabled or the user has not opted in.
      */
     recordActivity(action: string, metadata?: Record<string, unknown>): void;
+    /**
+     * Briefly animate the bug-report trigger button to draw the user's
+     * attention without opening the full widget. Ideal for subtle "feedback
+     * welcome" nudges (first-session, beta-onboarding).
+     */
+    pulseTrigger(): void;
 }
 interface MushiCaptureExceptionOptions {
     /** Override the default `'bug'` category (e.g. `'slow'` for timeouts). */

package/dist/index.d.ts

@@ -21,6 +21,10 @@ interface MushiConfig {
     rewards?: MushiRewardsConfig;
     debug?: boolean;
     enabled?: boolean;
+    /** Hook called before a report is sent. Return null to cancel, or return the (possibly modified) report. */
+    beforeSendFeedback?: (report: MushiReport) => MushiReport | null | Promise<MushiReport | null>;
+    /** Called once if the app crashed during the previous session. */
+    onCrashedLastRun?: (crashed: boolean) => void;
 }
 interface MushiSentryConfig {
     dsn?: string;
@@ -73,6 +77,38 @@ interface MushiWidgetConfig {
      * actively inviting feedback.
      */
     betaMode?: MushiBetaModeConfig;
+    /**
+     * Absolute base URL of the Mushi admin console (e.g. `https://mushi.example.com`).
+     * When set, the success step surfaces a one-tap link to the user's own report
+     * on the console so they can watch the status change in real time. Without
+     * this the success step still confirms submission but cannot deep-link.
+     *
+     * This is intentionally separate from the API endpoint — production apps
+     * usually have the API on `api.mushi.example.com` and the console on
+     * `app.mushi.example.com`.
+     */
+    dashboardUrl?: string;
+    /**
+     * Override the SLA copy shown in the success step's "what happens next"
+     * line. Defaults to "We aim to review within 48h". Set to an empty string
+     * to hide the line entirely (e.g. internal-only deployments where SLA
+     * messaging would be over-promising).
+     */
+    responseSlaLabel?: string;
+    /**
+     * Show a first-class "Feature request" card at the top of the category
+     * step. Defaults to true. Set to false for production-only deployments
+     * where you don't want to invite feature ideas through the widget.
+     * Internally this maps to `category='other'` with
+     * `user_category='Feature request'` so no DB migration is needed.
+     */
+    featureRequestCard?: boolean;
+    /** Override the localised label for the feature-request card. */
+    featureRequestLabel?: string;
+    /** Override the helper text shown under the feature-request card. */
+    featureRequestDescription?: string;
+    /** Minimum description character count before the submit button enables. */
+    minDescriptionLength?: number;
 }
 interface MushiBetaModeConfig {
     enabled?: boolean;
@@ -198,6 +234,17 @@ interface MushiPrivacyConfig {
     maskSelectors?: string[];
     /** DOM subtrees to remove from screenshots before upload. */
     blockSelectors?: string[];
+    /**
+     * CSS selectors whose matching elements are blacked-out (filled with an
+     * opaque black rectangle) in screenshots before upload. Intended for
+     * sensitive fields that should never appear in any form — passwords, PII,
+     * financial data. Applied in addition to `maskSelectors`.
+     *
+     * Default: `['input[type="password"]', '[data-mushi-redact]']`
+     *
+     * To disable the default redaction, pass an empty array.
+     */
+    redactSelectors?: string[];
     /** Let reporters remove an attached screenshot before submitting. Defaults to true. */
     allowUserRemoveScreenshot?: boolean;
 }
@@ -207,6 +254,38 @@ interface MushiProactiveConfig {
     longTask?: boolean;
     apiCascade?: boolean | MushiApiCascadeConfig;
     cooldown?: MushiCooldownConfig;
+    /**
+     * Beta-mode nudge: fire after the user has been on the same route for
+     * `thresholdMs` continuous milliseconds (default 5min). Pass `true` to
+     * accept the default threshold, or a config object to override. Use
+     * conservatively — set the per-session cap in `cooldown` to avoid
+     * nag fatigue.
+     */
+    pageDwell?: boolean | MushiPageDwellConfig;
+    /**
+     * One-shot welcome prompt for first-time visitors. Fires `delayMs` after
+     * `Mushi.init` (default 45s) and is suppressed permanently after the
+     * first fire via localStorage. Recommended for beta deployments.
+     */
+    firstSession?: boolean | MushiFirstSessionConfig;
+}
+interface MushiPageDwellConfig {
+    /** Continuous dwell time before firing. Defaults to 5 minutes. */
+    thresholdMs?: number;
+    /**
+     * Route path prefixes (or glob-style patterns with `*`) that suppress the
+     * dwell nudge. Auth routes are excluded by default so users aren't prompted
+     * during login/signup flows.
+     *
+     * Default: `['/login', '/logout', '/signup', '/sso/*', '/auth/*']`
+     */
+    excludeRoutes?: string[];
+}
+interface MushiFirstSessionConfig {
+    /** Delay before firing the welcome nudge. Defaults to 45 seconds. */
+    delayMs?: number;
+    /** Override the localStorage key used to mark the user as welcomed. */
+    storageKey?: string;
 }
 type MushiUrlMatcher = string | RegExp;
 interface MushiApiCascadeConfig {
@@ -665,6 +744,13 @@ interface MushiPerformanceMetrics {
     inp?: number;
     ttfb?: number;
     longTasks?: number;
+    inpAttribution?: {
+        eventType?: string;
+        targetSelector?: string;
+        inputDelay?: number;
+        processingDuration?: number;
+        presentationDelay?: number;
+    };
 }
 interface MushiSelectedElement {
     tagName: string;
@@ -697,7 +783,7 @@ interface MushiTimelineEntry {
     kind: MushiTimelineKind;
     payload: Record<string, unknown>;
 }
-type MushiEventType = 'report:submitted' | 'report:queued' | 'report:sent' | 'report:failed' | 'widget:opened' | 'widget:closed' | 'proactive:triggered' | 'proactive:dismissed';
+type MushiEventType = 'report:submitted' | 'report:queued' | 'report:sent' | 'report:failed' | 'widget:opened' | 'widget:closed' | 'proactive:triggered' | 'proactive:dismissed' | 'report:dispatched';
 type MushiEventHandler = (event: {
     type: MushiEventType;
     data?: unknown;
@@ -714,8 +800,16 @@ interface MushiDiagnosticsResult {
     sdkVersion: string;
 }
 interface MushiSDKInstance {
+    /**
+     * Open the reporter widget. With no options, opens to the category
+     * picker so the user can choose between bug categories and the
+     * feature-request shortcut. Pass `{ category }` to deep-link into a
+     * specific bug intent, or `{ featureRequest: true }` to deep-link into
+     * the feature-request description step (skips intent picker).
+     */
     report(options?: {
         category?: MushiReportCategory;
+        featureRequest?: boolean;
     }): void;
     on(event: MushiEventType, handler: MushiEventHandler): () => void;
     setUser(user: {
@@ -816,6 +910,12 @@ interface MushiSDKInstance {
      * No-op when rewards are disabled or the user has not opted in.
      */
     recordActivity(action: string, metadata?: Record<string, unknown>): void;
+    /**
+     * Briefly animate the bug-report trigger button to draw the user's
+     * attention without opening the full widget. Ideal for subtle "feedback
+     * welcome" nudges (first-session, beta-onboarding).
+     */
+    pulseTrigger(): void;
 }
 interface MushiCaptureExceptionOptions {
     /** Override the default `'bug'` category (e.g. `'slow'` for timeouts). */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mushi-mushi/core",
-  "version": "1.2.0",
+  "version": "1.6.0",
   "description": "Core types, API client, and pre-filter for Mushi Mushi SDK",
   "license": "MIT",
   "type": "module",
@@ -62,6 +62,15 @@
     "provenance": true
   },
   "sideEffects": false,
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "clean": "rm -rf dist .turbo",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "size": "size-limit"
+  },
   "size-limit": [
     {
       "path": "dist/index.js",
@@ -69,27 +78,18 @@
     }
   ],
   "devDependencies": {
+    "@mushi-mushi/eslint-config": "workspace:*",
+    "@mushi-mushi/tsconfig": "workspace:*",
     "@size-limit/file": "^12.1.0",
     "eslint": "^10.3.0",
     "jsdom": "^29.1.1",
     "size-limit": "^12.1.0",
     "tsup": "^8.5.1",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.5",
-    "@mushi-mushi/eslint-config": "0.0.0",
-    "@mushi-mushi/tsconfig": "0.0.0"
+    "vitest": "^4.1.5"
   },
   "author": "Kenji Sakuramoto",
   "engines": {
     "node": ">=20"
-  },
-  "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
-    "clean": "rm -rf dist .turbo",
-    "lint": "eslint src/",
-    "typecheck": "tsc --noEmit",
-    "test": "vitest run",
-    "size": "size-limit"
   }
-}
+}