@mushi-mushi/core 1.8.0 → 1.10.0

package/dist/index.d.cts

@@ -263,6 +263,39 @@ interface MushiCaptureConfig {
      * Nothing else. No DOM beyond the summary, no query values, no PII.
      */
     discoverInventory?: boolean | MushiDiscoverInventoryConfig;
+    /**
+     * W3C trace-context propagation for OTel-style frontend→backend correlation.
+     *
+     * When enabled, the SDK injects a W3C `traceparent` header and an
+     * `x-mushi-session` header into every fetch/XHR request whose URL matches
+     * the `corsUrls` allowlist. The generated trace_id is recorded on each
+     * captured network entry so a bug report can be correlated with the
+     * backend span that handled the failing request.
+     *
+     * Default: disabled. Enable only for origins you control to avoid CORS issues.
+     * The backend (node SDK or Supabase edge function) must include
+     * `traceparent` and `x-mushi-session` in `Access-Control-Allow-Headers`.
+     *
+     * @example
+     * capture: {
+     *   tracePropagation: {
+     *     enabled: true,
+     *     corsUrls: [/api\.myapp\.com/, /localhost:3000/],
+     *   }
+     * }
+     */
+    tracePropagation?: MushiTracePropagationConfig;
+}
+interface MushiTracePropagationConfig {
+    /** Enable W3C traceparent injection. Defaults to false. */
+    enabled?: boolean;
+    /**
+     * URL patterns for which the SDK injects `traceparent` + `x-mushi-session`
+     * headers. Only requests matching at least one pattern are instrumented.
+     * Strings are substring-matched; RegExp values are tested against the full URL.
+     * Required when `enabled` is true — an empty allowlist silently disables propagation.
+     */
+    corsUrls?: Array<string | RegExp>;
 }
 /**
  * Fine-grained controls for `discoverInventory`. Defaults are tuned
@@ -816,6 +849,13 @@ interface MushiNetworkEntry {
     requestHeaders?: Record<string, string>;
     responseHeaders?: Record<string, string>;
     error?: string;
+    /**
+     * W3C trace ID (32-char lowercase hex) injected by the SDK's trace propagation
+     * feature. Present only when `capture.tracePropagation.enabled` is true AND
+     * the request URL matched the `corsUrls` allowlist.
+     * Used to correlate this network entry with a backend span in the admin console.
+     */
+    traceId?: string;
 }
 interface MushiPerformanceMetrics {
     fcp?: number;
@@ -1025,6 +1065,28 @@ interface MushiSDKInstance {
      * welcome" nudges (first-session, beta-onboarding).
      */
     pulseTrigger(): void;
+    /**
+     * Returns the signed-in reporter's own report history.
+     * Keyed to the persistent `reporterToken` stored in localStorage /
+     * AsyncStorage. Returns an empty array when no token exists yet.
+     */
+    listMyReports(): Promise<MushiReporterReport[]>;
+    /**
+     * Returns the comment thread for a given report. Only returns comments
+     * visible to the reporter (their own comments + team replies).
+     */
+    listMyComments(reportId: string): Promise<MushiReporterComment[]>;
+    /**
+     * Post a follow-up comment on one of the reporter's own reports.
+     * Returns the newly created comment, or null on failure.
+     */
+    replyToReport(reportId: string, body: string): Promise<MushiReporterComment | null>;
+    /**
+     * Returns the global contributor hall-of-fame ranked by total points.
+     * Safe to call without an authenticated user; uses public endpoint.
+     * @param limit Maximum entries to return (default 20).
+     */
+    getHallOfFame(limit?: number): Promise<MushiHallOfFameEntry[]>;
 }
 interface MushiCaptureExceptionOptions {
     /** Override the default `'bug'` category (e.g. `'slow'` for timeouts). */
@@ -1124,6 +1186,20 @@ interface MushiApiClient {
         items: unknown[];
         total: number;
     }>>;
+    /** Fetch the project's public leaderboard (top contributors). */
+    getHallOfFame(limit?: number): Promise<MushiApiResponse<{
+        data: Array<{
+            display_name: string;
+            email_hash: string | null;
+            tier_slug: string | null;
+            tier_name: string | null;
+            points_30d: number;
+            total_points: number;
+        }>;
+        meta: {
+            project_name: string;
+        };
+    }>>;
 }
 /**
  * Wire shape of a single discovery event sent by the SDK to
@@ -1187,6 +1263,14 @@ interface MushiReporterComment {
     visible_to_reporter?: boolean;
     created_at: string;
 }
+interface MushiHallOfFameEntry {
+    display_name: string;
+    email_hash: string | null;
+    tier_slug: string | null;
+    tier_name: string | null;
+    points_30d: number;
+    total_points: number;
+}
 
 interface ApiClientOptions {
     projectId: string;
@@ -1497,4 +1581,4 @@ declare function createLogger(options: LoggerOptions): Logger;
  */
 declare const noopLogger: Logger;
 
-export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, type MushiActivityEvent, type MushiApiCascadeConfig, type MushiApiClient, type MushiApiResponse, type MushiBannerConfig, type MushiBannerLink, type MushiBetaChangelogEntry, type MushiBetaModeConfig, type MushiBreadcrumb, type MushiCaptureConfig, type MushiCaptureEventInput, type MushiCaptureExceptionOptions, type MushiConfig, type MushiConsoleEntry, type MushiCooldownConfig, type MushiDiagnosticsResult, type MushiDiscoverInventoryConfig, type MushiDiscoveryEventPayload, type MushiEnvironment, type MushiEventHandler, type MushiEventType, type MushiIntegrationsConfig, type MushiInternalRequestKind, type MushiNetworkEntry, type MushiOfflineConfig, type MushiOnDeviceClassifier, type MushiOnDeviceClassifierInput, type MushiOnDeviceClassifierResult, type MushiPerformanceMetrics, type MushiPreFilterConfig, type MushiPreset, type MushiPrivacyConfig, type MushiProactiveConfig, type MushiRegion, type MushiReport, type MushiReportBuilder, type MushiReportCategory, type MushiReportStatus, type MushiReporterComment, type MushiReporterReport, type MushiReputationResult, type MushiRewardsConfig, type MushiRuntimeSdkConfig, type MushiSDKInstance, type MushiSdkVersionInfo, type MushiSelectedElement, type MushiSentryConfig, type MushiSentryContext, type MushiTierResult, type MushiTimelineEntry, type MushiTimelineKind, type MushiUrlMatcher, type MushiWidgetAnchor, type MushiWidgetConfig, type NormalisedException, type OfflineQueue, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };
+export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, type MushiActivityEvent, type MushiApiCascadeConfig, type MushiApiClient, type MushiApiResponse, type MushiBannerConfig, type MushiBannerLink, type MushiBetaChangelogEntry, type MushiBetaModeConfig, type MushiBreadcrumb, type MushiCaptureConfig, type MushiCaptureEventInput, type MushiCaptureExceptionOptions, type MushiConfig, type MushiConsoleEntry, type MushiCooldownConfig, type MushiDiagnosticsResult, type MushiDiscoverInventoryConfig, type MushiDiscoveryEventPayload, type MushiEnvironment, type MushiEventHandler, type MushiEventType, type MushiHallOfFameEntry, type MushiIntegrationsConfig, type MushiInternalRequestKind, type MushiNetworkEntry, type MushiOfflineConfig, type MushiOnDeviceClassifier, type MushiOnDeviceClassifierInput, type MushiOnDeviceClassifierResult, type MushiPerformanceMetrics, type MushiPreFilterConfig, type MushiPreset, type MushiPrivacyConfig, type MushiProactiveConfig, type MushiRegion, type MushiReport, type MushiReportBuilder, type MushiReportCategory, type MushiReportStatus, type MushiReporterComment, type MushiReporterReport, type MushiReputationResult, type MushiRewardsConfig, type MushiRuntimeSdkConfig, type MushiSDKInstance, type MushiSdkVersionInfo, type MushiSelectedElement, type MushiSentryConfig, type MushiSentryContext, type MushiTierResult, type MushiTimelineEntry, type MushiTimelineKind, type MushiTracePropagationConfig, type MushiUrlMatcher, type MushiWidgetAnchor, type MushiWidgetConfig, type NormalisedException, type OfflineQueue, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };

package/dist/index.d.ts

@@ -263,6 +263,39 @@ interface MushiCaptureConfig {
      * Nothing else. No DOM beyond the summary, no query values, no PII.
      */
     discoverInventory?: boolean | MushiDiscoverInventoryConfig;
+    /**
+     * W3C trace-context propagation for OTel-style frontend→backend correlation.
+     *
+     * When enabled, the SDK injects a W3C `traceparent` header and an
+     * `x-mushi-session` header into every fetch/XHR request whose URL matches
+     * the `corsUrls` allowlist. The generated trace_id is recorded on each
+     * captured network entry so a bug report can be correlated with the
+     * backend span that handled the failing request.
+     *
+     * Default: disabled. Enable only for origins you control to avoid CORS issues.
+     * The backend (node SDK or Supabase edge function) must include
+     * `traceparent` and `x-mushi-session` in `Access-Control-Allow-Headers`.
+     *
+     * @example
+     * capture: {
+     *   tracePropagation: {
+     *     enabled: true,
+     *     corsUrls: [/api\.myapp\.com/, /localhost:3000/],
+     *   }
+     * }
+     */
+    tracePropagation?: MushiTracePropagationConfig;
+}
+interface MushiTracePropagationConfig {
+    /** Enable W3C traceparent injection. Defaults to false. */
+    enabled?: boolean;
+    /**
+     * URL patterns for which the SDK injects `traceparent` + `x-mushi-session`
+     * headers. Only requests matching at least one pattern are instrumented.
+     * Strings are substring-matched; RegExp values are tested against the full URL.
+     * Required when `enabled` is true — an empty allowlist silently disables propagation.
+     */
+    corsUrls?: Array<string | RegExp>;
 }
 /**
  * Fine-grained controls for `discoverInventory`. Defaults are tuned
@@ -816,6 +849,13 @@ interface MushiNetworkEntry {
     requestHeaders?: Record<string, string>;
     responseHeaders?: Record<string, string>;
     error?: string;
+    /**
+     * W3C trace ID (32-char lowercase hex) injected by the SDK's trace propagation
+     * feature. Present only when `capture.tracePropagation.enabled` is true AND
+     * the request URL matched the `corsUrls` allowlist.
+     * Used to correlate this network entry with a backend span in the admin console.
+     */
+    traceId?: string;
 }
 interface MushiPerformanceMetrics {
     fcp?: number;
@@ -1025,6 +1065,28 @@ interface MushiSDKInstance {
      * welcome" nudges (first-session, beta-onboarding).
      */
     pulseTrigger(): void;
+    /**
+     * Returns the signed-in reporter's own report history.
+     * Keyed to the persistent `reporterToken` stored in localStorage /
+     * AsyncStorage. Returns an empty array when no token exists yet.
+     */
+    listMyReports(): Promise<MushiReporterReport[]>;
+    /**
+     * Returns the comment thread for a given report. Only returns comments
+     * visible to the reporter (their own comments + team replies).
+     */
+    listMyComments(reportId: string): Promise<MushiReporterComment[]>;
+    /**
+     * Post a follow-up comment on one of the reporter's own reports.
+     * Returns the newly created comment, or null on failure.
+     */
+    replyToReport(reportId: string, body: string): Promise<MushiReporterComment | null>;
+    /**
+     * Returns the global contributor hall-of-fame ranked by total points.
+     * Safe to call without an authenticated user; uses public endpoint.
+     * @param limit Maximum entries to return (default 20).
+     */
+    getHallOfFame(limit?: number): Promise<MushiHallOfFameEntry[]>;
 }
 interface MushiCaptureExceptionOptions {
     /** Override the default `'bug'` category (e.g. `'slow'` for timeouts). */
@@ -1124,6 +1186,20 @@ interface MushiApiClient {
         items: unknown[];
         total: number;
     }>>;
+    /** Fetch the project's public leaderboard (top contributors). */
+    getHallOfFame(limit?: number): Promise<MushiApiResponse<{
+        data: Array<{
+            display_name: string;
+            email_hash: string | null;
+            tier_slug: string | null;
+            tier_name: string | null;
+            points_30d: number;
+            total_points: number;
+        }>;
+        meta: {
+            project_name: string;
+        };
+    }>>;
 }
 /**
  * Wire shape of a single discovery event sent by the SDK to
@@ -1187,6 +1263,14 @@ interface MushiReporterComment {
     visible_to_reporter?: boolean;
     created_at: string;
 }
+interface MushiHallOfFameEntry {
+    display_name: string;
+    email_hash: string | null;
+    tier_slug: string | null;
+    tier_name: string | null;
+    points_30d: number;
+    total_points: number;
+}
 
 interface ApiClientOptions {
     projectId: string;
@@ -1497,4 +1581,4 @@ declare function createLogger(options: LoggerOptions): Logger;
  */
 declare const noopLogger: Logger;
 
-export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, type MushiActivityEvent, type MushiApiCascadeConfig, type MushiApiClient, type MushiApiResponse, type MushiBannerConfig, type MushiBannerLink, type MushiBetaChangelogEntry, type MushiBetaModeConfig, type MushiBreadcrumb, type MushiCaptureConfig, type MushiCaptureEventInput, type MushiCaptureExceptionOptions, type MushiConfig, type MushiConsoleEntry, type MushiCooldownConfig, type MushiDiagnosticsResult, type MushiDiscoverInventoryConfig, type MushiDiscoveryEventPayload, type MushiEnvironment, type MushiEventHandler, type MushiEventType, type MushiIntegrationsConfig, type MushiInternalRequestKind, type MushiNetworkEntry, type MushiOfflineConfig, type MushiOnDeviceClassifier, type MushiOnDeviceClassifierInput, type MushiOnDeviceClassifierResult, type MushiPerformanceMetrics, type MushiPreFilterConfig, type MushiPreset, type MushiPrivacyConfig, type MushiProactiveConfig, type MushiRegion, type MushiReport, type MushiReportBuilder, type MushiReportCategory, type MushiReportStatus, type MushiReporterComment, type MushiReporterReport, type MushiReputationResult, type MushiRewardsConfig, type MushiRuntimeSdkConfig, type MushiSDKInstance, type MushiSdkVersionInfo, type MushiSelectedElement, type MushiSentryConfig, type MushiSentryContext, type MushiTierResult, type MushiTimelineEntry, type MushiTimelineKind, type MushiUrlMatcher, type MushiWidgetAnchor, type MushiWidgetConfig, type NormalisedException, type OfflineQueue, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };
+export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, type MushiActivityEvent, type MushiApiCascadeConfig, type MushiApiClient, type MushiApiResponse, type MushiBannerConfig, type MushiBannerLink, type MushiBetaChangelogEntry, type MushiBetaModeConfig, type MushiBreadcrumb, type MushiCaptureConfig, type MushiCaptureEventInput, type MushiCaptureExceptionOptions, type MushiConfig, type MushiConsoleEntry, type MushiCooldownConfig, type MushiDiagnosticsResult, type MushiDiscoverInventoryConfig, type MushiDiscoveryEventPayload, type MushiEnvironment, type MushiEventHandler, type MushiEventType, type MushiHallOfFameEntry, type MushiIntegrationsConfig, type MushiInternalRequestKind, type MushiNetworkEntry, type MushiOfflineConfig, type MushiOnDeviceClassifier, type MushiOnDeviceClassifierInput, type MushiOnDeviceClassifierResult, type MushiPerformanceMetrics, type MushiPreFilterConfig, type MushiPreset, type MushiPrivacyConfig, type MushiProactiveConfig, type MushiRegion, type MushiReport, type MushiReportBuilder, type MushiReportCategory, type MushiReportStatus, type MushiReporterComment, type MushiReporterReport, type MushiReputationResult, type MushiRewardsConfig, type MushiRuntimeSdkConfig, type MushiSDKInstance, type MushiSdkVersionInfo, type MushiSelectedElement, type MushiSentryConfig, type MushiSentryContext, type MushiTierResult, type MushiTimelineEntry, type MushiTimelineKind, type MushiTracePropagationConfig, type MushiUrlMatcher, type MushiWidgetAnchor, type MushiWidgetConfig, type NormalisedException, type OfflineQueue, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };

package/dist/index.js

@@ -192,6 +192,15 @@ function createApiClient(options) {
         1,
         "reporter-poll"
       );
+    },
+    async getHallOfFame(limit = 10) {
+      return request(
+        "GET",
+        `/v1/sdk/hall-of-fame?limit=${limit}`,
+        void 0,
+        1,
+        "reporter-poll"
+      );
     }
   };
 }
@@ -290,8 +299,10 @@ var SPAM_PATTERNS = [
   // numbers only
   /^[^a-zA-Z\u00C0-\u024F\u4E00-\u9FFF\u3040-\u309F\u30A0-\u30FF]{10,}$/,
   // no real letters
-  /\b(test|asdf|qwerty|lorem ipsum)\b/i
-  // common test strings
+  // "test" removed — users legitimately write "I was testing…" in real reports.
+  // Keep clearly-nonsense patterns that are never real sentences.
+  /^(asdf|qwerty|lorem ipsum)[.,!?\s]*$/i
+  // standalone keyboard-mash or placeholder
 ];
 var GIBBERISH_PATTERN = /^[bcdfghjklmnpqrstvwxz]{6,}/i;
 function createPreFilter(config = {}) {
@@ -581,9 +592,11 @@ var DB_VERSION = 1;
 var LS_KEY = "mushi_offline_queue";
 var BATCH_SIZE = 10;
 var MAX_BACKOFF_MS = 6e4;
+var AUTO_FLUSH_INTERVAL_MS = 3e4;
 function createOfflineQueue(config = {}) {
   const { enabled = true, maxQueueSize = 50, syncOnReconnect = true, encryptAtRest = true } = config;
   let syncCleanup = null;
+  let flushInterval = null;
   let backendType = null;
   async function wrapForStorage(report) {
     const queuedAt = (/* @__PURE__ */ new Date()).toISOString();
@@ -778,6 +791,7 @@ function createOfflineQueue(config = {}) {
         const permanent = result.error?.code === "HTTP_400" || result.error?.code === "HTTP_422" || result.error?.code === "INGEST_ERROR" || result.error?.code === "VALIDATION_ERROR" || typeof result.error?.message === "string" && /invalid payload|description must be at least|validation/i.test(
           result.error.message
         );
+        const transient = !permanent && (result.error?.code === "NETWORK_ERROR" || result.error?.code === "HTTP_403" || result.error?.code === "HTTP_429" || result.error?.code === "HTTP_502" || result.error?.code === "HTTP_503" || result.error?.code === "HTTP_504" || typeof result.error?.code === "string" && result.error.code.startsWith("HTTP_5"));
         if (permanent) {
           try {
             if (backend === "indexeddb") await idbDelete(rowId);
@@ -785,6 +799,11 @@ function createOfflineQueue(config = {}) {
           } catch {
             lsDelete(rowId);
           }
+        } else if (transient) {
+          queueLog.debug("Offline queue: transient failure, will retry", {
+            id: rowId,
+            code: result.error?.code
+          });
         }
         failed++;
         if (i < batch.length - 1) {
@@ -820,14 +839,25 @@ function createOfflineQueue(config = {}) {
   }
   function startAutoSync(client) {
     if (!enabled || !syncOnReconnect || typeof window === "undefined") return;
-    const handler = () => {
+    const tryFlush = () => {
       if (navigator.onLine) {
         flush(client).catch(() => {
         });
       }
     };
-    window.addEventListener("online", handler);
-    syncCleanup = () => window.removeEventListener("online", handler);
+    window.addEventListener("online", tryFlush);
+    flushInterval = setInterval(() => {
+      void size().then((n) => {
+        if (n > 0) tryFlush();
+      });
+    }, AUTO_FLUSH_INTERVAL_MS);
+    syncCleanup = () => {
+      window.removeEventListener("online", tryFlush);
+      if (flushInterval) {
+        clearInterval(flushInterval);
+        flushInterval = null;
+      }
+    };
   }
   function stopAutoSync() {
     syncCleanup?.();