@mushi-mushi/core 1.12.0 → 1.13.0

package/dist/index.d.cts

@@ -129,6 +129,51 @@ interface MushiWidgetConfig {
      * avoidSelectors: ['[data-mobile-header]', '#sign-in-cta']
      */
     avoidSelectors?: string[];
+    /**
+     * Override the default five-category picker with a custom category list.
+     * When set, the widget renders these categories instead of the built-in
+     * `bug / slow / visual / confusing / other` set.
+     *
+     * Each custom category maps onto one of the five built-in `MushiReportCategory`
+     * values via `baseCategory` (defaults to `'other'`). The custom id is
+     * preserved as `userCategory` on the report so the Mushi console can filter
+     * by it independently of the LLM-assigned `category`.
+     *
+     * Deep-link helpers (`open`, `openWith`, `report`) accept the custom `id`
+     * in addition to the built-in enum values when this option is set.
+     *
+     * When absent, behaviour is identical to the historical defaults (backward-compatible).
+     */
+    categories?: MushiCustomCategory[];
+}
+/**
+ * Descriptor for a single entry in a host-app custom category list.
+ * Passed as `widget.categories` to `Mushi.init()`.
+ */
+interface MushiCustomCategory {
+    /** Unique identifier used in `openWith(id)` / `report({ category: id })`. */
+    id: string;
+    /** Human-readable label shown in the category picker step. */
+    label: string;
+    /** Optional helper text shown beneath the label. */
+    description?: string;
+    /**
+     * Localised intent options displayed on the second step ("What happened?").
+     * When omitted, the widget skips the intent step and goes straight to
+     * the description.
+     */
+    intents?: string[];
+    /**
+     * Emoji or single-character icon rendered next to the label in the picker.
+     * Falls back to a neutral bubble when absent.
+     */
+    icon?: string;
+    /**
+     * Which built-in `MushiReportCategory` value this custom category maps to
+     * for server-side classification. Defaults to `'other'`.
+     * The custom `id` is always preserved in `report.userCategory`.
+     */
+    baseCategory?: MushiReportCategory;
 }
 /** Optional flat link in the rich banner action row (admin-console BetaBanner style). */
 interface MushiBannerLink {
@@ -543,6 +588,13 @@ interface MushiReport {
     id: string;
     projectId: string;
     category: MushiReportCategory;
+    /**
+     * Custom category identifier set by the host app via `widget.categories`.
+     * Preserved as `reports.user_category` on the server so the Mushi console
+     * can filter by it independently of the LLM-assigned `category`.
+     * Not set when the host uses the default built-in category set.
+     */
+    userCategory?: string;
     description: string;
     userIntent?: string;
     environment: MushiEnvironment;
@@ -957,9 +1009,12 @@ interface MushiSDKInstance {
      * 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).
+     *
+     * When `widget.categories` is configured, `category` also accepts a
+     * custom category `id` from that list.
      */
     report(options?: {
-        category?: MushiReportCategory;
+        category?: MushiReportCategory | string;
         featureRequest?: boolean;
     }): void;
     on(event: MushiEventType, handler: MushiEventHandler): () => void;
@@ -976,7 +1031,12 @@ interface MushiSDKInstance {
     }): void;
     isOpen(): boolean;
     open(): void;
-    openWith(category: MushiReportCategory): void;
+    /**
+     * Open the widget deep-linked to a specific category. Accepts a built-in
+     * `MushiReportCategory` value or a custom category `id` when
+     * `widget.categories` is configured.
+     */
+    openWith(category: MushiReportCategory | string): void;
     show(): void;
     hide(): void;
     attachTo(selectorOrElement: string | Element, options?: MushiWidgetConfig): () => void;
@@ -1649,4 +1709,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, 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 };
+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 MushiCustomCategory, 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

@@ -129,6 +129,51 @@ interface MushiWidgetConfig {
      * avoidSelectors: ['[data-mobile-header]', '#sign-in-cta']
      */
     avoidSelectors?: string[];
+    /**
+     * Override the default five-category picker with a custom category list.
+     * When set, the widget renders these categories instead of the built-in
+     * `bug / slow / visual / confusing / other` set.
+     *
+     * Each custom category maps onto one of the five built-in `MushiReportCategory`
+     * values via `baseCategory` (defaults to `'other'`). The custom id is
+     * preserved as `userCategory` on the report so the Mushi console can filter
+     * by it independently of the LLM-assigned `category`.
+     *
+     * Deep-link helpers (`open`, `openWith`, `report`) accept the custom `id`
+     * in addition to the built-in enum values when this option is set.
+     *
+     * When absent, behaviour is identical to the historical defaults (backward-compatible).
+     */
+    categories?: MushiCustomCategory[];
+}
+/**
+ * Descriptor for a single entry in a host-app custom category list.
+ * Passed as `widget.categories` to `Mushi.init()`.
+ */
+interface MushiCustomCategory {
+    /** Unique identifier used in `openWith(id)` / `report({ category: id })`. */
+    id: string;
+    /** Human-readable label shown in the category picker step. */
+    label: string;
+    /** Optional helper text shown beneath the label. */
+    description?: string;
+    /**
+     * Localised intent options displayed on the second step ("What happened?").
+     * When omitted, the widget skips the intent step and goes straight to
+     * the description.
+     */
+    intents?: string[];
+    /**
+     * Emoji or single-character icon rendered next to the label in the picker.
+     * Falls back to a neutral bubble when absent.
+     */
+    icon?: string;
+    /**
+     * Which built-in `MushiReportCategory` value this custom category maps to
+     * for server-side classification. Defaults to `'other'`.
+     * The custom `id` is always preserved in `report.userCategory`.
+     */
+    baseCategory?: MushiReportCategory;
 }
 /** Optional flat link in the rich banner action row (admin-console BetaBanner style). */
 interface MushiBannerLink {
@@ -543,6 +588,13 @@ interface MushiReport {
     id: string;
     projectId: string;
     category: MushiReportCategory;
+    /**
+     * Custom category identifier set by the host app via `widget.categories`.
+     * Preserved as `reports.user_category` on the server so the Mushi console
+     * can filter by it independently of the LLM-assigned `category`.
+     * Not set when the host uses the default built-in category set.
+     */
+    userCategory?: string;
     description: string;
     userIntent?: string;
     environment: MushiEnvironment;
@@ -957,9 +1009,12 @@ interface MushiSDKInstance {
      * 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).
+     *
+     * When `widget.categories` is configured, `category` also accepts a
+     * custom category `id` from that list.
      */
     report(options?: {
-        category?: MushiReportCategory;
+        category?: MushiReportCategory | string;
         featureRequest?: boolean;
     }): void;
     on(event: MushiEventType, handler: MushiEventHandler): () => void;
@@ -976,7 +1031,12 @@ interface MushiSDKInstance {
     }): void;
     isOpen(): boolean;
     open(): void;
-    openWith(category: MushiReportCategory): void;
+    /**
+     * Open the widget deep-linked to a specific category. Accepts a built-in
+     * `MushiReportCategory` value or a custom category `id` when
+     * `widget.categories` is configured.
+     */
+    openWith(category: MushiReportCategory | string): void;
     show(): void;
     hide(): void;
     attachTo(selectorOrElement: string | Element, options?: MushiWidgetConfig): () => void;
@@ -1649,4 +1709,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, 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 };
+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 MushiCustomCategory, 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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mushi-mushi/core",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Core types, API client, and pre-filter for Mushi Mushi SDK",
   "license": "MIT",
   "type": "module",