@mushi-mushi/core 1.11.0 → 1.12.0

package/dist/index.d.cts

@@ -552,6 +552,8 @@ interface MushiReport {
     timeline?: MushiTimelineEntry[];
     screenshotDataUrl?: string;
     selectedElement?: MushiSelectedElement;
+    /** rrweb / lite rolling-buffer events attached on submit when capture.replay is enabled. */
+    replayEvents?: unknown[];
     metadata?: Record<string, unknown>;
     sessionId?: string;
     reporterToken: string;
@@ -1167,6 +1169,26 @@ interface MushiApiClient {
     reopenReporterReport(reportId: string, reporterToken: string, note?: string): Promise<MushiApiResponse<{
         outcome: Record<string, unknown>;
     }>>;
+    /** List in-app notifications for the authenticated reporter. */
+    listNotifications(reporterToken: string, opts?: {
+        since?: string;
+        limit?: number;
+    }): Promise<MushiApiResponse<{
+        notifications: Array<Record<string, unknown>>;
+    }>>;
+    /** Mark a single reporter notification as read. */
+    markNotificationRead(notificationId: string, reporterToken: string): Promise<MushiApiResponse<{
+        ok: boolean;
+    }>>;
+    /** List the reporter-facing feature board (public roadmap tickets). */
+    listReporterFeatureBoard(reporterToken: string): Promise<MushiApiResponse<{
+        tickets: Array<Record<string, unknown>>;
+    }>>;
+    /** Toggle the reporter's vote on a feature-board ticket. */
+    voteReporterFeatureBoard(requestId: string, reporterToken: string): Promise<MushiApiResponse<{
+        voted: boolean;
+        action: string;
+    }>>;
     /**
      * Submit a batch of activity events for the current user.
      * Requires rewards to be enabled on the project.
@@ -1518,6 +1540,31 @@ interface BreadcrumbBufferOptions {
 }
 declare function createBreadcrumbBuffer(options?: BreadcrumbBufferOptions): BreadcrumbBuffer;
 
+/**
+ * Client-side payload size guards — prevents silent edge-function failures
+ * when screenshots or log buffers inflate the report body past gateway limits.
+ */
+/** Supabase edge functions tolerate ~6 MB; stay under 4 MB for headroom. */
+declare const MAX_REPORT_PAYLOAD_BYTES: number;
+/** Screenshot data URLs above this are downscaled or dropped before POST. */
+declare const MAX_SCREENSHOT_DATA_URL_BYTES: number;
+interface PayloadGuardResult {
+    ok: boolean;
+    bytes: number;
+    maxBytes: number;
+    reason?: string;
+    /**
+     * True when the payload could not be serialized at all (e.g. a circular
+     * reference in `metadata`). This is a distinct failure from "too large" —
+     * the caller should surface a `SERIALIZE_FAILED` rather than a misleading
+     * "payload too large" message.
+     */
+    serializeFailed?: boolean;
+}
+declare function estimateJsonBytes(value: unknown): number;
+declare function checkReportPayloadSize(payload: unknown, maxBytes?: number): PayloadGuardResult;
+declare function formatBytes(n: number): string;
+
 /**
  * Normalise *anything* a host might throw — `Error`, string, plain
  * object, `null`, frozen DOMException — into the shape Mushi reports
@@ -1602,4 +1649,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 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 };
+export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MAX_REPORT_PAYLOAD_BYTES, MAX_SCREENSHOT_DATA_URL_BYTES, 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 PayloadGuardResult, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, checkReportPayloadSize, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, estimateJsonBytes, formatBytes, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };

package/dist/index.d.ts

@@ -552,6 +552,8 @@ interface MushiReport {
     timeline?: MushiTimelineEntry[];
     screenshotDataUrl?: string;
     selectedElement?: MushiSelectedElement;
+    /** rrweb / lite rolling-buffer events attached on submit when capture.replay is enabled. */
+    replayEvents?: unknown[];
     metadata?: Record<string, unknown>;
     sessionId?: string;
     reporterToken: string;
@@ -1167,6 +1169,26 @@ interface MushiApiClient {
     reopenReporterReport(reportId: string, reporterToken: string, note?: string): Promise<MushiApiResponse<{
         outcome: Record<string, unknown>;
     }>>;
+    /** List in-app notifications for the authenticated reporter. */
+    listNotifications(reporterToken: string, opts?: {
+        since?: string;
+        limit?: number;
+    }): Promise<MushiApiResponse<{
+        notifications: Array<Record<string, unknown>>;
+    }>>;
+    /** Mark a single reporter notification as read. */
+    markNotificationRead(notificationId: string, reporterToken: string): Promise<MushiApiResponse<{
+        ok: boolean;
+    }>>;
+    /** List the reporter-facing feature board (public roadmap tickets). */
+    listReporterFeatureBoard(reporterToken: string): Promise<MushiApiResponse<{
+        tickets: Array<Record<string, unknown>>;
+    }>>;
+    /** Toggle the reporter's vote on a feature-board ticket. */
+    voteReporterFeatureBoard(requestId: string, reporterToken: string): Promise<MushiApiResponse<{
+        voted: boolean;
+        action: string;
+    }>>;
     /**
      * Submit a batch of activity events for the current user.
      * Requires rewards to be enabled on the project.
@@ -1518,6 +1540,31 @@ interface BreadcrumbBufferOptions {
 }
 declare function createBreadcrumbBuffer(options?: BreadcrumbBufferOptions): BreadcrumbBuffer;
 
+/**
+ * Client-side payload size guards — prevents silent edge-function failures
+ * when screenshots or log buffers inflate the report body past gateway limits.
+ */
+/** Supabase edge functions tolerate ~6 MB; stay under 4 MB for headroom. */
+declare const MAX_REPORT_PAYLOAD_BYTES: number;
+/** Screenshot data URLs above this are downscaled or dropped before POST. */
+declare const MAX_SCREENSHOT_DATA_URL_BYTES: number;
+interface PayloadGuardResult {
+    ok: boolean;
+    bytes: number;
+    maxBytes: number;
+    reason?: string;
+    /**
+     * True when the payload could not be serialized at all (e.g. a circular
+     * reference in `metadata`). This is a distinct failure from "too large" —
+     * the caller should surface a `SERIALIZE_FAILED` rather than a misleading
+     * "payload too large" message.
+     */
+    serializeFailed?: boolean;
+}
+declare function estimateJsonBytes(value: unknown): number;
+declare function checkReportPayloadSize(payload: unknown, maxBytes?: number): PayloadGuardResult;
+declare function formatBytes(n: number): string;
+
 /**
  * Normalise *anything* a host might throw — `Error`, string, plain
  * object, `null`, frozen DOMException — into the shape Mushi reports
@@ -1602,4 +1649,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 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 };
+export { type ApiClientOptions, type BreadcrumbBuffer, type BreadcrumbBufferOptions, DEFAULT_API_ENDPOINT, type LogEntry, type LogFormat, type LogLevel, type Logger, type LoggerOptions, MAX_REPORT_PAYLOAD_BYTES, MAX_SCREENSHOT_DATA_URL_BYTES, 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 PayloadGuardResult, type PiiScrubberConfig, type PreFilterResult, REGION_ENDPOINTS, type RateLimiter, type RateLimiterConfig, captureEnvironment, checkReportPayloadSize, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, estimateJsonBytes, formatBytes, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };

package/dist/index.js

@@ -1,3 +1,45 @@
+// src/payload-guard.ts
+var MAX_REPORT_PAYLOAD_BYTES = 4 * 1024 * 1024;
+var MAX_SCREENSHOT_DATA_URL_BYTES = 1.5 * 1024 * 1024;
+function safeStringify(value) {
+  try {
+    return JSON.stringify(value);
+  } catch {
+    return null;
+  }
+}
+function estimateJsonBytes(value) {
+  const json = safeStringify(value);
+  return json === null ? Number.MAX_SAFE_INTEGER : new TextEncoder().encode(json).length;
+}
+function checkReportPayloadSize(payload, maxBytes = MAX_REPORT_PAYLOAD_BYTES) {
+  const json = safeStringify(payload);
+  if (json === null) {
+    return {
+      ok: false,
+      bytes: 0,
+      maxBytes,
+      serializeFailed: true,
+      reason: "Report could not be serialized (circular reference in metadata?)"
+    };
+  }
+  const bytes = new TextEncoder().encode(json).length;
+  if (bytes <= maxBytes) {
+    return { ok: true, bytes, maxBytes };
+  }
+  return {
+    ok: false,
+    bytes,
+    maxBytes,
+    reason: `Report payload ${formatBytes(bytes)} exceeds limit ${formatBytes(maxBytes)}`
+  };
+}
+function formatBytes(n) {
+  if (n < 1024) return `${n} B`;
+  if (n < 1024 * 1024) return `${(n / 1024).toFixed(1)} KB`;
+  return `${(n / (1024 * 1024)).toFixed(2)} MB`;
+}
+
 // src/api-client.ts
 var DEFAULT_API_ENDPOINT = "https://dxptnwrhwsqckaftyymj.supabase.co/functions/v1/api";
 var MUSHI_INTERNAL_HEADER = "X-Mushi-Internal";
@@ -107,6 +149,16 @@ function createApiClient(options) {
   }
   return {
     async submitReport(report) {
+      const guard = checkReportPayloadSize(report);
+      if (!guard.ok) {
+        return {
+          ok: false,
+          error: {
+            code: guard.serializeFailed ? "SERIALIZE_FAILED" : "PAYLOAD_TOO_LARGE",
+            message: guard.reason ?? "Report payload exceeds size limit"
+          }
+        };
+      }
       return request("POST", "/v1/reports", report, maxRetries, "report-submit");
     },
     async getReportStatus(reportId) {
@@ -154,6 +206,40 @@ function createApiClient(options) {
         { note: note ?? "" }
       );
     },
+    async listNotifications(reporterToken, opts) {
+      const qs = new URLSearchParams();
+      if (opts?.since) qs.set("since", opts.since);
+      if (opts?.limit) qs.set("limit", String(opts.limit));
+      const suffix = qs.size ? `?${qs.toString()}` : "";
+      return requestForReporter(
+        "GET",
+        `/v1/notifications${suffix}`,
+        reporterToken
+      );
+    },
+    async markNotificationRead(notificationId, reporterToken) {
+      return requestForReporter(
+        "POST",
+        `/v1/notifications/${notificationId}/read`,
+        reporterToken,
+        {}
+      );
+    },
+    async listReporterFeatureBoard(reporterToken) {
+      return requestForReporter(
+        "GET",
+        "/v1/reporter/feature-board",
+        reporterToken
+      );
+    },
+    async voteReporterFeatureBoard(requestId, reporterToken) {
+      return requestForReporter(
+        "POST",
+        `/v1/reporter/feature-board/${requestId}/vote`,
+        reporterToken,
+        {}
+      );
+    },
     // ─── Rewards program (P1) ──────────────────────────────────
     async submitActivity(userId, events, opts) {
       return request(
@@ -796,7 +882,11 @@ function createOfflineQueue(config = {}) {
         }
         sent++;
       } else {
-        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(
+        const permanent = result.error?.code === "HTTP_400" || result.error?.code === "HTTP_413" || result.error?.code === "HTTP_422" || result.error?.code === "INGEST_ERROR" || result.error?.code === "VALIDATION_ERROR" || // A payload that exceeds the size guard will never shrink on its own;
+        // retrying re-serialises the multi-MB body every sync tick and wedges
+        // the queue (it matches neither permanent nor transient otherwise).
+        // SERIALIZE_FAILED (circular ref) is likewise unrecoverable on retry.
+        result.error?.code === "PAYLOAD_TOO_LARGE" || result.error?.code === "SERIALIZE_FAILED" || 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"));
@@ -1336,6 +1426,6 @@ function normaliseThrown(thrown) {
   return { name: "Error", message: String(thrown) };
 }
 
-export { DEFAULT_API_ENDPOINT, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, REGION_ENDPOINTS, captureEnvironment, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };
+export { DEFAULT_API_ENDPOINT, MAX_REPORT_PAYLOAD_BYTES, MAX_SCREENSHOT_DATA_URL_BYTES, MUSHI_INTERNAL_HEADER, MUSHI_INTERNAL_INIT_MARKER, REGION_ENDPOINTS, captureEnvironment, checkReportPayloadSize, createApiClient, createBreadcrumbBuffer, createLogger, createOfflineQueue, createPiiScrubber, createPreFilter, createRateLimiter, estimateJsonBytes, formatBytes, getDeviceFingerprintHash, getReporterToken, getSessionId, newUuid, noopLogger, normaliseThrown, resolveRegionEndpoint, scrubPii };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map