@mushi-mushi/web 0.7.0 → 0.9.0

package/dist/index.d.cts

@@ -1,11 +1,12 @@
-import { MushiConfig, MushiSDKInstance, MushiWidgetConfig, MushiReportCategory, MushiConsoleEntry, MushiNetworkEntry, MushiPerformanceMetrics, MushiSelectedElement } from '@mushi-mushi/core';
-export { MushiConfig, MushiConsoleEntry, MushiEnvironment, MushiEventHandler, MushiEventType, MushiNetworkEntry, MushiPerformanceMetrics, MushiReport, MushiReportCategory, MushiSDKInstance, MushiWidgetConfig } from '@mushi-mushi/core';
+import { MushiConfig, MushiSDKInstance, MushiDiagnosticsResult, MushiWidgetConfig, MushiReportCategory, MushiReporterReport, MushiReporterComment, MushiConsoleEntry, MushiNetworkEntry, MushiUrlMatcher, MushiPrivacyConfig, MushiPerformanceMetrics, MushiSelectedElement, MushiTimelineEntry, MushiApiCascadeConfig } from '@mushi-mushi/core';
+export { MushiApiCascadeConfig, MushiConfig, MushiConsoleEntry, MushiDiagnosticsResult, MushiEnvironment, MushiEventHandler, MushiEventType, MushiNetworkEntry, MushiPerformanceMetrics, MushiReport, MushiReportCategory, MushiSDKInstance, MushiTimelineEntry, MushiTimelineKind, MushiUrlMatcher, MushiWidgetConfig } from '@mushi-mushi/core';
 
 declare class Mushi {
     private constructor();
     static init(config: MushiConfig): MushiSDKInstance;
     static getInstance(): MushiSDKInstance | null;
     static destroy(): void;
+    static diagnose(): Promise<MushiDiagnosticsResult>;
 }
 
 /**
@@ -29,9 +30,14 @@ interface WidgetCallbacks {
     onOpen(): void;
     onClose(): void;
     onScreenshotRequest(): void;
+    onScreenshotRemove?(): void;
     onElementSelectorRequest?(): void;
+    onReporterReportsRequest?(): Promise<MushiReporterReport[]>;
+    onReporterCommentsRequest?(reportId: string): Promise<MushiReporterComment[]>;
+    onReporterReply?(reportId: string, body: string): Promise<void>;
 }
 declare class MushiWidget {
+    private readonly sdkVersion;
     private host;
     private shadow;
     private config;
@@ -42,11 +48,18 @@ declare class MushiWidget {
     private selectedCategory;
     private selectedIntent;
     private screenshotAttached;
+    private allowScreenshotRemove;
     private elementSelected;
     private submitting;
     private triggerVisible;
     private triggerShrunk;
     private triggerHiddenByScroll;
+    private sdkFreshness;
+    private reporterReports;
+    private reporterComments;
+    private selectedReportId;
+    private reporterLoading;
+    private reporterError;
     private attachedLaunchers;
     private smartHideCleanup;
     private smartHideTimer;
@@ -60,8 +73,9 @@ declare class MushiWidget {
      *  root) for up to ~3.3s after destroy. */
     private successTimer;
     private autoCloseTimer;
-    constructor(config: MushiWidgetConfig | undefined, callbacks: WidgetCallbacks);
+    constructor(config: MushiWidgetConfig | undefined, callbacks: WidgetCallbacks, sdkVersion?: string);
     mount(): void;
+    getIsMounted(): boolean;
     updateConfig(config?: MushiWidgetConfig): void;
     open(options?: {
         category?: MushiReportCategory;
@@ -73,7 +87,14 @@ declare class MushiWidget {
     setTrigger(trigger: NonNullable<MushiWidgetConfig['trigger']>): void;
     attachTo(selectorOrElement: string | Element, options?: MushiWidgetConfig): () => void;
     setScreenshotAttached(attached: boolean): void;
+    setAllowScreenshotRemove(allow: boolean): void;
     setElementSelected(selected: boolean): void;
+    setSdkFreshness(info: {
+        latest: string | null;
+        current: string;
+        deprecated: boolean;
+        message?: string | null;
+    }): void;
     destroy(): void;
     private syncAttachedLaunchers;
     private syncSmartHide;
@@ -86,6 +107,8 @@ declare class MushiWidget {
     private render;
     private applyInsetVars;
     private renderStep;
+    private renderOutdatedBanner;
+    private renderBrandFooter;
     /**
      * Editorial masthead. Always carries:
      *   • the brand mark (虫 kanji on vermillion, "MUSHI" in mono above)
@@ -104,6 +127,8 @@ declare class MushiWidget {
      */
     private renderStepIndicator;
     private renderCategoryStep;
+    private renderReportsStep;
+    private renderReportDetailStep;
     private renderIntentStep;
     private renderDetailsStep;
     /**
@@ -117,6 +142,10 @@ declare class MushiWidget {
     private renderSuccessStep;
     private attachHandlers;
     private trapFocus;
+    private unreadCount;
+    private loadReporterReports;
+    private loadReporterComments;
+    private submitReporterReply;
 }
 
 interface ConsoleCapture {
@@ -129,14 +158,23 @@ declare function createConsoleCapture(): ConsoleCapture;
 interface NetworkCapture {
     getEntries(): MushiNetworkEntry[];
     clear(): void;
+    updateOptions(options: NetworkCaptureOptions): void;
     destroy(): void;
 }
-declare function createNetworkCapture(): NetworkCapture;
+interface NetworkCaptureOptions {
+    apiEndpoint?: string;
+    ignoreUrls?: MushiUrlMatcher[];
+}
+declare function createNetworkCapture(options?: NetworkCaptureOptions): NetworkCapture;
 
 interface ScreenshotCapture {
     take(): Promise<string | null>;
+    updateOptions(options: ScreenshotCaptureOptions): void;
 }
-declare function createScreenshotCapture(): ScreenshotCapture;
+interface ScreenshotCaptureOptions {
+    privacy?: MushiPrivacyConfig;
+}
+declare function createScreenshotCapture(options?: ScreenshotCaptureOptions): ScreenshotCapture;
 
 interface PerformanceCapture {
     getMetrics(): MushiPerformanceMetrics;
@@ -151,6 +189,21 @@ interface ElementSelector {
 }
 declare function createElementSelector(): ElementSelector;
 
+interface TimelineCapture {
+    setScreen(screen: {
+        name: string;
+        route?: string;
+        feature?: string;
+    }): void;
+    getEntries(input?: {
+        consoleLogs?: MushiConsoleEntry[] | null;
+        networkLogs?: MushiNetworkEntry[] | null;
+    }): MushiTimelineEntry[];
+    clear(): void;
+    destroy(): void;
+}
+declare function createTimelineCapture(): TimelineCapture;
+
 interface MushiLocale {
     widget: {
         trigger: string;
@@ -201,7 +254,8 @@ declare function createProactiveManager(config?: Partial<ProactiveConfig>): Proa
 interface ProactiveTriggerConfig {
     rageClick?: boolean;
     longTask?: boolean;
-    apiCascade?: boolean;
+    apiCascade?: boolean | MushiApiCascadeConfig;
+    apiEndpoint?: string;
     errorBoundary?: boolean;
 }
 interface ProactiveTriggerCallbacks {
@@ -212,4 +266,4 @@ interface ProactiveTriggerCleanup {
 }
 declare function setupProactiveTriggers(callbacks: ProactiveTriggerCallbacks, config?: ProactiveTriggerConfig): ProactiveTriggerCleanup;
 
-export { type ConsoleCapture, type ElementSelector, Mushi, type MushiLocale, MushiWidget, type NetworkCapture, type PerformanceCapture, type ProactiveConfig, type ProactiveManager, type ProactiveTriggerCallbacks, type ProactiveTriggerCleanup, type ScreenshotCapture, createConsoleCapture, createElementSelector, createNetworkCapture, createPerformanceCapture, createProactiveManager, createScreenshotCapture, getAvailableLocales, getLocale, setupProactiveTriggers };
+export { type ConsoleCapture, type ElementSelector, Mushi, type MushiLocale, MushiWidget, type NetworkCapture, type PerformanceCapture, type ProactiveConfig, type ProactiveManager, type ProactiveTriggerCallbacks, type ProactiveTriggerCleanup, type ScreenshotCapture, type TimelineCapture, createConsoleCapture, createElementSelector, createNetworkCapture, createPerformanceCapture, createProactiveManager, createScreenshotCapture, createTimelineCapture, getAvailableLocales, getLocale, setupProactiveTriggers };

package/dist/index.d.ts

@@ -1,11 +1,12 @@
-import { MushiConfig, MushiSDKInstance, MushiWidgetConfig, MushiReportCategory, MushiConsoleEntry, MushiNetworkEntry, MushiPerformanceMetrics, MushiSelectedElement } from '@mushi-mushi/core';
-export { MushiConfig, MushiConsoleEntry, MushiEnvironment, MushiEventHandler, MushiEventType, MushiNetworkEntry, MushiPerformanceMetrics, MushiReport, MushiReportCategory, MushiSDKInstance, MushiWidgetConfig } from '@mushi-mushi/core';
+import { MushiConfig, MushiSDKInstance, MushiDiagnosticsResult, MushiWidgetConfig, MushiReportCategory, MushiReporterReport, MushiReporterComment, MushiConsoleEntry, MushiNetworkEntry, MushiUrlMatcher, MushiPrivacyConfig, MushiPerformanceMetrics, MushiSelectedElement, MushiTimelineEntry, MushiApiCascadeConfig } from '@mushi-mushi/core';
+export { MushiApiCascadeConfig, MushiConfig, MushiConsoleEntry, MushiDiagnosticsResult, MushiEnvironment, MushiEventHandler, MushiEventType, MushiNetworkEntry, MushiPerformanceMetrics, MushiReport, MushiReportCategory, MushiSDKInstance, MushiTimelineEntry, MushiTimelineKind, MushiUrlMatcher, MushiWidgetConfig } from '@mushi-mushi/core';
 
 declare class Mushi {
     private constructor();
     static init(config: MushiConfig): MushiSDKInstance;
     static getInstance(): MushiSDKInstance | null;
     static destroy(): void;
+    static diagnose(): Promise<MushiDiagnosticsResult>;
 }
 
 /**
@@ -29,9 +30,14 @@ interface WidgetCallbacks {
     onOpen(): void;
     onClose(): void;
     onScreenshotRequest(): void;
+    onScreenshotRemove?(): void;
     onElementSelectorRequest?(): void;
+    onReporterReportsRequest?(): Promise<MushiReporterReport[]>;
+    onReporterCommentsRequest?(reportId: string): Promise<MushiReporterComment[]>;
+    onReporterReply?(reportId: string, body: string): Promise<void>;
 }
 declare class MushiWidget {
+    private readonly sdkVersion;
     private host;
     private shadow;
     private config;
@@ -42,11 +48,18 @@ declare class MushiWidget {
     private selectedCategory;
     private selectedIntent;
     private screenshotAttached;
+    private allowScreenshotRemove;
     private elementSelected;
     private submitting;
     private triggerVisible;
     private triggerShrunk;
     private triggerHiddenByScroll;
+    private sdkFreshness;
+    private reporterReports;
+    private reporterComments;
+    private selectedReportId;
+    private reporterLoading;
+    private reporterError;
     private attachedLaunchers;
     private smartHideCleanup;
     private smartHideTimer;
@@ -60,8 +73,9 @@ declare class MushiWidget {
      *  root) for up to ~3.3s after destroy. */
     private successTimer;
     private autoCloseTimer;
-    constructor(config: MushiWidgetConfig | undefined, callbacks: WidgetCallbacks);
+    constructor(config: MushiWidgetConfig | undefined, callbacks: WidgetCallbacks, sdkVersion?: string);
     mount(): void;
+    getIsMounted(): boolean;
     updateConfig(config?: MushiWidgetConfig): void;
     open(options?: {
         category?: MushiReportCategory;
@@ -73,7 +87,14 @@ declare class MushiWidget {
     setTrigger(trigger: NonNullable<MushiWidgetConfig['trigger']>): void;
     attachTo(selectorOrElement: string | Element, options?: MushiWidgetConfig): () => void;
     setScreenshotAttached(attached: boolean): void;
+    setAllowScreenshotRemove(allow: boolean): void;
     setElementSelected(selected: boolean): void;
+    setSdkFreshness(info: {
+        latest: string | null;
+        current: string;
+        deprecated: boolean;
+        message?: string | null;
+    }): void;
     destroy(): void;
     private syncAttachedLaunchers;
     private syncSmartHide;
@@ -86,6 +107,8 @@ declare class MushiWidget {
     private render;
     private applyInsetVars;
     private renderStep;
+    private renderOutdatedBanner;
+    private renderBrandFooter;
     /**
      * Editorial masthead. Always carries:
      *   • the brand mark (虫 kanji on vermillion, "MUSHI" in mono above)
@@ -104,6 +127,8 @@ declare class MushiWidget {
      */
     private renderStepIndicator;
     private renderCategoryStep;
+    private renderReportsStep;
+    private renderReportDetailStep;
     private renderIntentStep;
     private renderDetailsStep;
     /**
@@ -117,6 +142,10 @@ declare class MushiWidget {
     private renderSuccessStep;
     private attachHandlers;
     private trapFocus;
+    private unreadCount;
+    private loadReporterReports;
+    private loadReporterComments;
+    private submitReporterReply;
 }
 
 interface ConsoleCapture {
@@ -129,14 +158,23 @@ declare function createConsoleCapture(): ConsoleCapture;
 interface NetworkCapture {
     getEntries(): MushiNetworkEntry[];
     clear(): void;
+    updateOptions(options: NetworkCaptureOptions): void;
     destroy(): void;
 }
-declare function createNetworkCapture(): NetworkCapture;
+interface NetworkCaptureOptions {
+    apiEndpoint?: string;
+    ignoreUrls?: MushiUrlMatcher[];
+}
+declare function createNetworkCapture(options?: NetworkCaptureOptions): NetworkCapture;
 
 interface ScreenshotCapture {
     take(): Promise<string | null>;
+    updateOptions(options: ScreenshotCaptureOptions): void;
 }
-declare function createScreenshotCapture(): ScreenshotCapture;
+interface ScreenshotCaptureOptions {
+    privacy?: MushiPrivacyConfig;
+}
+declare function createScreenshotCapture(options?: ScreenshotCaptureOptions): ScreenshotCapture;
 
 interface PerformanceCapture {
     getMetrics(): MushiPerformanceMetrics;
@@ -151,6 +189,21 @@ interface ElementSelector {
 }
 declare function createElementSelector(): ElementSelector;
 
+interface TimelineCapture {
+    setScreen(screen: {
+        name: string;
+        route?: string;
+        feature?: string;
+    }): void;
+    getEntries(input?: {
+        consoleLogs?: MushiConsoleEntry[] | null;
+        networkLogs?: MushiNetworkEntry[] | null;
+    }): MushiTimelineEntry[];
+    clear(): void;
+    destroy(): void;
+}
+declare function createTimelineCapture(): TimelineCapture;
+
 interface MushiLocale {
     widget: {
         trigger: string;
@@ -201,7 +254,8 @@ declare function createProactiveManager(config?: Partial<ProactiveConfig>): Proa
 interface ProactiveTriggerConfig {
     rageClick?: boolean;
     longTask?: boolean;
-    apiCascade?: boolean;
+    apiCascade?: boolean | MushiApiCascadeConfig;
+    apiEndpoint?: string;
     errorBoundary?: boolean;
 }
 interface ProactiveTriggerCallbacks {
@@ -212,4 +266,4 @@ interface ProactiveTriggerCleanup {
 }
 declare function setupProactiveTriggers(callbacks: ProactiveTriggerCallbacks, config?: ProactiveTriggerConfig): ProactiveTriggerCleanup;
 
-export { type ConsoleCapture, type ElementSelector, Mushi, type MushiLocale, MushiWidget, type NetworkCapture, type PerformanceCapture, type ProactiveConfig, type ProactiveManager, type ProactiveTriggerCallbacks, type ProactiveTriggerCleanup, type ScreenshotCapture, createConsoleCapture, createElementSelector, createNetworkCapture, createPerformanceCapture, createProactiveManager, createScreenshotCapture, getAvailableLocales, getLocale, setupProactiveTriggers };
+export { type ConsoleCapture, type ElementSelector, Mushi, type MushiLocale, MushiWidget, type NetworkCapture, type PerformanceCapture, type ProactiveConfig, type ProactiveManager, type ProactiveTriggerCallbacks, type ProactiveTriggerCleanup, type ScreenshotCapture, type TimelineCapture, createConsoleCapture, createElementSelector, createNetworkCapture, createPerformanceCapture, createProactiveManager, createScreenshotCapture, createTimelineCapture, getAvailableLocales, getLocale, setupProactiveTriggers };