@mushi-mushi/core 1.29.0 → 1.30.0

package/dist/index.d.cts

@@ -230,7 +230,13 @@ interface MushiWidgetConfig {
      * 3. Default `false`.
      */
     brandFooter?: boolean;
-    /** How the widget should surface SDK freshness warnings. Defaults to auto. */
+    /**
+     * How the widget surfaces the "update @mushi-mushi/web" notice. It is a
+     * developer instruction, so `'auto'` (default) shows it in the widget only on
+     * a dev host (localhost, loopback, `*.localhost`, `*.local`, `file:`) or with
+     * `debug: true` — never to an app's end users. `'banner'` always shows it;
+     * `'console-only'` and `'off'` never render it in the widget.
+     */
     outdatedBanner?: 'auto' | 'banner' | 'console-only' | 'off';
     /**
      * Privacy nudge shown beside an attached screenshot preview, reminding the
@@ -594,9 +600,10 @@ interface MushiPrivacyConfig {
      * 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.
+     * Always redacted, whatever this is set to: `input[type="password"]`,
+     * `input[autocomplete^="cc-"]`, `[data-private]`, `[data-mushi-mask]`.
+     * This list is added on top; it defaults to `['[data-mushi-redact]']`,
+     * and an empty array drops only that default.
      */
     redactSelectors?: string[];
     /** Let reporters remove an attached screenshot before submitting. Defaults to true. */
@@ -1791,8 +1798,30 @@ interface MushiSdkVersionInfo {
 interface MushiReporterReport {
     id: string;
     status: string;
-    category: string;
+    /** @deprecated No longer sent to reporters (Plan 018); internal triage only. */
+    category?: string;
+    /** @deprecated No longer sent to reporters (Plan 018); internal triage only. */
     severity?: string | null;
+    /** Reporter-safe title (the summary, or the first line of the description). */
+    title?: string | null;
+    /** The type the reporter picked (`user_category`), if any. */
+    user_category?: string | null;
+    /** Page path the report was filed on. */
+    page?: string | null;
+    app_version?: string | null;
+    /** Signed, short-lived thumbnail URL; null without a screenshot. */
+    screenshot_thumb_url?: string | null;
+    /** Bucketed duplicate count: never a raw number. */
+    group_bucket?: 'none' | 'few' | 'many';
+    closed_reason?: string | null;
+    fixed_in_version?: string | null;
+    /** The developer asked a question and is waiting on the reporter. */
+    awaiting_reporter?: boolean;
+    /** True when this row is a report the reporter follows (theirs was a duplicate of it). */
+    followed?: boolean;
+    last_event_at?: string | null;
+    /** Template-rendered (or verbatim developer) text of the latest event. */
+    last_event_preview?: string | null;
     summary?: string | null;
     description?: string | null;
     created_at: string;
@@ -2433,6 +2462,10 @@ declare const MUSHI_EVENTS: {
         readonly surface: "console";
         readonly required: readonly ["project_id"];
     };
+    readonly diagnosis_viewed: {
+        readonly surface: "console";
+        readonly required: readonly ["report_id", "project_id", "surface"];
+    };
     readonly project_created: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];
@@ -2445,6 +2478,10 @@ declare const MUSHI_EVENTS: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];
     };
+    readonly first_diagnosis_ready: {
+        readonly surface: "server";
+        readonly required: readonly ["project_id"];
+    };
     readonly fix_merged: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];

package/dist/index.d.ts

@@ -230,7 +230,13 @@ interface MushiWidgetConfig {
      * 3. Default `false`.
      */
     brandFooter?: boolean;
-    /** How the widget should surface SDK freshness warnings. Defaults to auto. */
+    /**
+     * How the widget surfaces the "update @mushi-mushi/web" notice. It is a
+     * developer instruction, so `'auto'` (default) shows it in the widget only on
+     * a dev host (localhost, loopback, `*.localhost`, `*.local`, `file:`) or with
+     * `debug: true` — never to an app's end users. `'banner'` always shows it;
+     * `'console-only'` and `'off'` never render it in the widget.
+     */
     outdatedBanner?: 'auto' | 'banner' | 'console-only' | 'off';
     /**
      * Privacy nudge shown beside an attached screenshot preview, reminding the
@@ -594,9 +600,10 @@ interface MushiPrivacyConfig {
      * 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.
+     * Always redacted, whatever this is set to: `input[type="password"]`,
+     * `input[autocomplete^="cc-"]`, `[data-private]`, `[data-mushi-mask]`.
+     * This list is added on top; it defaults to `['[data-mushi-redact]']`,
+     * and an empty array drops only that default.
      */
     redactSelectors?: string[];
     /** Let reporters remove an attached screenshot before submitting. Defaults to true. */
@@ -1791,8 +1798,30 @@ interface MushiSdkVersionInfo {
 interface MushiReporterReport {
     id: string;
     status: string;
-    category: string;
+    /** @deprecated No longer sent to reporters (Plan 018); internal triage only. */
+    category?: string;
+    /** @deprecated No longer sent to reporters (Plan 018); internal triage only. */
     severity?: string | null;
+    /** Reporter-safe title (the summary, or the first line of the description). */
+    title?: string | null;
+    /** The type the reporter picked (`user_category`), if any. */
+    user_category?: string | null;
+    /** Page path the report was filed on. */
+    page?: string | null;
+    app_version?: string | null;
+    /** Signed, short-lived thumbnail URL; null without a screenshot. */
+    screenshot_thumb_url?: string | null;
+    /** Bucketed duplicate count: never a raw number. */
+    group_bucket?: 'none' | 'few' | 'many';
+    closed_reason?: string | null;
+    fixed_in_version?: string | null;
+    /** The developer asked a question and is waiting on the reporter. */
+    awaiting_reporter?: boolean;
+    /** True when this row is a report the reporter follows (theirs was a duplicate of it). */
+    followed?: boolean;
+    last_event_at?: string | null;
+    /** Template-rendered (or verbatim developer) text of the latest event. */
+    last_event_preview?: string | null;
     summary?: string | null;
     description?: string | null;
     created_at: string;
@@ -2433,6 +2462,10 @@ declare const MUSHI_EVENTS: {
         readonly surface: "console";
         readonly required: readonly ["project_id"];
     };
+    readonly diagnosis_viewed: {
+        readonly surface: "console";
+        readonly required: readonly ["report_id", "project_id", "surface"];
+    };
     readonly project_created: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];
@@ -2445,6 +2478,10 @@ declare const MUSHI_EVENTS: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];
     };
+    readonly first_diagnosis_ready: {
+        readonly surface: "server";
+        readonly required: readonly ["project_id"];
+    };
     readonly fix_merged: {
         readonly surface: "server";
         readonly required: readonly ["project_id"];

package/dist/index.js

@@ -230,7 +230,8 @@ function createApiClient(options) {
     if (cbFailures >= cbThreshold) cbOpenUntil = Date.now() + cbCooldownMs;
   };
   async function request(method, path, body, retries = maxRetries, internalKind, extraHeaders) {
-    if (cbIsOpen()) {
+    const tracked = internalKind !== "reporter-poll";
+    if (tracked && cbIsOpen()) {
       return { ok: false, error: { code: "CIRCUIT_OPEN", message: "Endpoint temporarily unavailable; retrying later." } };
     }
     const url = `${baseUrl}${path}`;
@@ -249,7 +250,7 @@ function createApiClient(options) {
       ...extraHeaders
     };
     const serialized = body ? JSON.stringify(body) : void 0;
-    if (serialized && method !== "GET") {
+    if (serialized && method !== "GET" && internalKind !== "reporter-poll") {
       lastOutbound = { url, headers, body: serialized, path };
     }
     try {
@@ -289,8 +290,10 @@ function createApiClient(options) {
           await sleep(retryAfterMs ?? getBackoffDelay(maxRetries - retries));
           return request(method, path, body, retries - 1, internalKind, extraHeaders);
         }
-        if (unusable) cbRecordUnreachable();
-        else cbRecordReachable();
+        if (tracked) {
+          if (unusable) cbRecordUnreachable();
+          else cbRecordReachable();
+        }
         return {
           ok: false,
           error: {
@@ -302,7 +305,7 @@ function createApiClient(options) {
       }
       const payload = await response.json();
       const data = payload && typeof payload === "object" && "ok" in payload && "data" in payload ? payload.data : payload;
-      cbRecordReachable();
+      if (tracked) cbRecordReachable();
       return { ok: true, data };
     } catch (error) {
       clearTimeout(timer);
@@ -310,7 +313,7 @@ function createApiClient(options) {
         await sleep(getBackoffDelay(maxRetries - retries));
         return request(method, path, body, retries - 1, internalKind, extraHeaders);
       }
-      cbRecordUnreachable();
+      if (tracked) cbRecordUnreachable();
       return {
         ok: false,
         error: {
@@ -321,39 +324,17 @@ function createApiClient(options) {
     }
   }
   async function requestForReporter(method, path, reporterToken, body) {
-    const tokenHash = await sha256Hex(reporterToken);
-    const ts = String(Date.now());
-    const hmac = await hmacSha256Hex(apiKey, `${projectId}.${ts}.${tokenHash}`);
-    const url = `${baseUrl}${path}`;
-    const response = await fetch(url, {
-      method,
-      headers: {
-        "Content-Type": "application/json",
-        "X-Mushi-Api-Key": apiKey,
-        "X-Mushi-Project": projectId,
-        ...sdkPackage ? { [MUSHI_SDK_PACKAGE_HEADER]: sdkPackage } : {},
-        ...sdkVersion ? { [MUSHI_SDK_VERSION_HEADER]: sdkVersion } : {},
-        [MUSHI_INTERNAL_HEADER]: "reporter-poll",
+    try {
+      const tokenHash = await sha256Hex(reporterToken);
+      const ts = String(Date.now());
+      return await request(method, path, body, maxRetries, "reporter-poll", {
         "X-Reporter-Token-Hash": tokenHash,
         "X-Reporter-Ts": ts,
-        "X-Reporter-Hmac": hmac
-      },
-      body: body ? JSON.stringify(body) : void 0,
-      keepalive: isPageUnloading(),
-      [MUSHI_INTERNAL_INIT_MARKER]: "reporter-poll"
-    });
-    if (!response.ok) {
-      const errorBody = await response.json().catch(() => ({}));
-      return {
-        ok: false,
-        error: {
-          code: `HTTP_${response.status}`,
-          message: errorBody.error?.message ?? errorBody.message ?? `HTTP ${response.status} error`
-        }
-      };
+        "X-Reporter-Hmac": await hmacSha256Hex(apiKey, `${projectId}.${ts}.${tokenHash}`)
+      });
+    } catch (error) {
+      return { ok: false, error: { code: "NETWORK_ERROR", message: error instanceof Error ? error.message : "Unknown error" } };
     }
-    const payload = await response.json();
-    return { ok: true, data: payload.data ?? payload };
   }
   return {
     async submitReport(report) {
@@ -2294,10 +2275,12 @@ var MUSHI_EVENTS = {
   invite_sent: { surface: "console", required: [] },
   upgrade_clicked: { surface: "console", required: ["plan"] },
   test_report_sent: { surface: "console", required: ["project_id"] },
+  diagnosis_viewed: { surface: "console", required: ["report_id", "project_id", "surface"] },
   // ── Server-emitted (edge functions) ──────────────────────────────────────
   project_created: { surface: "server", required: ["project_id"] },
   key_minted: { surface: "server", required: ["project_id"] },
   first_report_received: { surface: "server", required: ["project_id"] },
+  first_diagnosis_ready: { surface: "server", required: ["project_id"] },
   fix_merged: { surface: "server", required: ["project_id"] },
   upgrade_completed: { surface: "server", required: ["project_id", "plan"] },
   // ── Growth loop (widget "Bug reports by Mushi" mark) ─────────────────────