quick-bug-reporter-react 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,331 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+declare const DEFAULT_MAX_RECORDING_MS: number;
+type BugTrackerProvider = "linear" | "jira";
+type ReportCaptureMode = "video" | "screenshot";
+type RecordingStopReason = "manual" | "time_limit" | "screen_ended";
+type NetworkLogEntry = {
+    method: string;
+    url: string;
+    status: number | null;
+    durationMs: number;
+    timestamp: string;
+};
+type ScreenshotHighlightRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+type BugClientMetadata = {
+    locale: string | null;
+    timezone: string | null;
+    language: string | null;
+    languages: string[];
+    platform: string | null;
+    referrer: string | null;
+    colorScheme: "light" | "dark" | "unknown";
+    viewport: {
+        width: number | null;
+        height: number | null;
+        pixelRatio: number | null;
+    };
+    screen: {
+        width: number | null;
+        height: number | null;
+        availWidth: number | null;
+        availHeight: number | null;
+        colorDepth: number | null;
+    };
+    device: {
+        hardwareConcurrency: number | null;
+        deviceMemoryGb: number | null;
+        maxTouchPoints: number | null;
+        online: boolean | null;
+        cookieEnabled: boolean | null;
+    };
+    connection: {
+        effectiveType: string | null;
+        downlinkMbps: number | null;
+        rttMs: number | null;
+        saveData: boolean | null;
+    };
+    captureMode: ReportCaptureMode;
+    capture: {
+        startedAt: string;
+        stoppedAt: string;
+        elapsedMs: number;
+    };
+    annotation?: {
+        imageWidth: number;
+        imageHeight: number;
+        highlights: ScreenshotHighlightRegion[];
+    };
+};
+type BugSessionArtifacts = {
+    videoBlob: Blob | null;
+    screenshotBlob: Blob | null;
+    networkLogs: NetworkLogEntry[];
+    captureMode: ReportCaptureMode;
+    startedAt: string;
+    stoppedAt: string;
+    elapsedMs: number;
+    stopReason: RecordingStopReason;
+};
+type BugReportPayload = {
+    title: string;
+    description: string;
+    videoBlob: Blob | null;
+    screenshotBlob: Blob | null;
+    networkLogs: NetworkLogEntry[];
+    captureMode: ReportCaptureMode;
+    pageUrl: string;
+    userAgent: string;
+    startedAt: string;
+    stoppedAt: string;
+    elapsedMs: number;
+    metadata: BugClientMetadata;
+};
+type BugSubmitResult = {
+    provider: BugTrackerProvider;
+    issueId: string;
+    issueKey: string;
+    issueUrl: string | null;
+    warnings: string[];
+};
+type SubmitProgressCallback = (message: string) => void;
+interface BugReporterIntegration {
+    readonly provider: BugTrackerProvider;
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+}
+declare function formatNetworkLogs(logs: NetworkLogEntry[]): string;
+declare function toErrorMessage(error: unknown): string;
+declare function collectClientEnvironmentMetadata(): Omit<BugClientMetadata, "captureMode" | "capture">;
+
+declare class NetworkLogger {
+    private originalFetch;
+    private logs;
+    private recording;
+    start(): void;
+    stop(): NetworkLogEntry[];
+    clear(): void;
+    getLogs(): NetworkLogEntry[];
+    isRecording(): boolean;
+}
+
+type ScreenRecorderStartOptions = {
+    onEnded?: () => void;
+};
+declare class ScreenRecorder {
+    private mediaRecorder;
+    private displayStream;
+    private microphoneStream;
+    private mixedStream;
+    private audioContext;
+    private displayAudioStream;
+    private microphoneAudioStream;
+    private chunks;
+    private recording;
+    private stopPromise;
+    private stopResolver;
+    private lastBlob;
+    private onEnded;
+    start(options?: ScreenRecorderStartOptions): Promise<void>;
+    stop(): Promise<Blob | null>;
+    isRecording(): boolean;
+    getLastBlob(): Blob | null;
+    clearLastBlob(): void;
+    dispose(): void;
+    private cleanupStreams;
+    private resetStopPromise;
+    private buildMixedAudioTracks;
+}
+
+type CaptureRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+declare class ScreenshotCapturer {
+    capture(): Promise<Blob>;
+    private captureViaDomSnapshot;
+    captureRegion(region: CaptureRegion): Promise<Blob>;
+    private cropBlob;
+}
+
+type BugSessionOptions = {
+    maxDurationMs?: number;
+    screenRecorder?: ScreenRecorder;
+    screenshotCapturer?: ScreenshotCapturer;
+    networkLogger?: NetworkLogger;
+    onAutoStop?: (artifacts: BugSessionArtifacts) => void;
+};
+declare class BugSession {
+    private readonly maxDurationMs;
+    private readonly screenRecorder;
+    private readonly screenshotCapturer;
+    private readonly networkLogger;
+    private readonly onAutoStop?;
+    private recording;
+    private startedAtMs;
+    private autoStopTimeout;
+    private stopInFlight;
+    private lastArtifacts;
+    constructor(options?: BugSessionOptions);
+    start(): Promise<void>;
+    captureScreenshot(region?: CaptureRegion): Promise<BugSessionArtifacts>;
+    stop(reason?: RecordingStopReason): Promise<BugSessionArtifacts | null>;
+    isRecording(): boolean;
+    getElapsedMs(): number;
+    getMaxDurationMs(): number;
+    getLastArtifacts(): BugSessionArtifacts | null;
+    getLastCaptureMode(): ReportCaptureMode | null;
+    resetArtifacts(): void;
+    dispose(): Promise<void>;
+    private stopInternal;
+    private handleForcedStop;
+    private clearAutoStopTimer;
+}
+
+type BugReporterOptions = {
+    integration: BugReporterIntegration;
+    maxDurationMs?: number;
+    onAutoStop?: (artifacts: BugSessionArtifacts) => void;
+    session?: BugSession;
+};
+type BugReporterSubmitOptions = {
+    screenshotBlob?: Blob | null;
+    metadata?: Partial<BugClientMetadata>;
+    onProgress?: SubmitProgressCallback;
+};
+declare class BugReporter {
+    private integration;
+    private readonly session;
+    constructor(options: BugReporterOptions);
+    start(): Promise<void>;
+    captureScreenshot(region?: CaptureRegion): Promise<BugSessionArtifacts>;
+    stop(): Promise<BugSessionArtifacts | null>;
+    submit(title: string, description: string, options?: BugReporterSubmitOptions): Promise<BugSubmitResult>;
+    isRecording(): boolean;
+    getElapsedMs(): number;
+    getMaxDurationMs(): number;
+    getLastArtifacts(): BugSessionArtifacts | null;
+    clearDraft(): void;
+    setIntegration(integration: BugReporterIntegration): void;
+    getSelectedProvider(): BugTrackerProvider;
+    dispose(): Promise<void>;
+}
+
+type LinearIntegrationOptions = {
+    apiKey?: string;
+    teamId?: string;
+    projectId?: string;
+    graphqlEndpoint?: string;
+    submitProxyEndpoint?: string;
+    createIssueProxyEndpoint?: string;
+    uploadProxyEndpoint?: string;
+    fetchImpl?: typeof fetch;
+};
+declare class LinearIntegration implements BugReporterIntegration {
+    readonly provider: "linear";
+    private readonly apiKey?;
+    private readonly teamId?;
+    private readonly projectId?;
+    private readonly graphqlEndpoint;
+    private readonly submitProxyEndpoint?;
+    private readonly createIssueProxyEndpoint?;
+    private readonly uploadProxyEndpoint?;
+    private readonly fetchImpl;
+    constructor(options: LinearIntegrationOptions);
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+    private submitViaProxy;
+    private createIssue;
+    private addComment;
+    private uploadAsset;
+    private requestUploadTarget;
+}
+
+type JiraIntegrationOptions = {
+    baseUrl?: string;
+    email?: string;
+    apiToken?: string;
+    projectKey?: string;
+    issueType?: string;
+    submitProxyEndpoint?: string;
+    createIssueProxyEndpoint?: string;
+    uploadAttachmentProxyEndpoint?: string;
+    fetchImpl?: typeof fetch;
+};
+declare class JiraIntegration implements BugReporterIntegration {
+    readonly provider: "jira";
+    private readonly baseUrl?;
+    private readonly email?;
+    private readonly apiToken?;
+    private readonly projectKey?;
+    private readonly issueType;
+    private readonly submitProxyEndpoint?;
+    private readonly createIssueProxyEndpoint?;
+    private readonly uploadAttachmentProxyEndpoint?;
+    private readonly fetchImpl;
+    constructor(options: JiraIntegrationOptions);
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+    private submitViaProxy;
+    private createIssue;
+    private uploadAttachment;
+}
+
+type BugReporterIntegrations = Partial<Record<"linear" | "jira", BugReporterIntegration>>;
+
+type BugReporterProviderProps = {
+    children: ReactNode;
+    integrations: BugReporterIntegrations;
+    defaultProvider?: BugTrackerProvider;
+    maxDurationMs?: number;
+};
+type ScreenshotAnnotationState = {
+    annotatedBlob: Blob | null;
+    highlights: ScreenshotHighlightRegion[];
+    imageWidth: number;
+    imageHeight: number;
+};
+type BugReporterContextValue = {
+    isOpen: boolean;
+    openModal: () => void;
+    closeModal: () => void;
+    draftMode: ReportCaptureMode | null;
+    hasDraft: boolean;
+    isRecording: boolean;
+    elapsedMs: number;
+    maxDurationMs: number;
+    isSubmitting: boolean;
+    submissionProgress: string | null;
+    isCapturingScreenshot: boolean;
+    isSelectingRegion: boolean;
+    error: string | null;
+    success: string | null;
+    autoStopNotice: string | null;
+    availableProviders: BugTrackerProvider[];
+    selectedProvider: BugTrackerProvider | null;
+    setSelectedProvider: (provider: BugTrackerProvider) => void;
+    startRecording: () => Promise<boolean>;
+    stopRecording: () => Promise<boolean>;
+    captureQuickScreenshot: () => Promise<boolean>;
+    startRegionSelection: () => void;
+    videoPreviewUrl: string | null;
+    screenshotPreviewUrl: string | null;
+    screenshotHighlightCount: number;
+    updateScreenshotAnnotation: (annotation: ScreenshotAnnotationState) => void;
+    clearDraft: () => void;
+    submitReport: (title: string, description: string) => Promise<BugSubmitResult | null>;
+    resetMessages: () => void;
+};
+declare function BugReporterProvider({ children, integrations, defaultProvider, maxDurationMs, }: BugReporterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useBugReporter(): BugReporterContextValue;
+
+declare function FloatingBugButton(): react_jsx_runtime.JSX.Element | null;
+
+declare function BugReporterModal(): react_jsx_runtime.JSX.Element;
+
+export { type BugClientMetadata, type BugReportPayload, BugReporter, type BugReporterIntegration, type BugReporterIntegrations, BugReporterModal, BugReporterProvider, BugSession, type BugSessionArtifacts, type BugSubmitResult, type BugTrackerProvider, type CaptureRegion, DEFAULT_MAX_RECORDING_MS, FloatingBugButton, JiraIntegration, type JiraIntegrationOptions, LinearIntegration, type LinearIntegrationOptions, type NetworkLogEntry, NetworkLogger, type RecordingStopReason, type ReportCaptureMode, ScreenRecorder, ScreenshotCapturer, type ScreenshotHighlightRegion, type SubmitProgressCallback, collectClientEnvironmentMetadata, formatNetworkLogs, toErrorMessage, useBugReporter };

package/dist/index.d.ts

@@ -0,0 +1,331 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { ReactNode } from 'react';
+
+declare const DEFAULT_MAX_RECORDING_MS: number;
+type BugTrackerProvider = "linear" | "jira";
+type ReportCaptureMode = "video" | "screenshot";
+type RecordingStopReason = "manual" | "time_limit" | "screen_ended";
+type NetworkLogEntry = {
+    method: string;
+    url: string;
+    status: number | null;
+    durationMs: number;
+    timestamp: string;
+};
+type ScreenshotHighlightRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+type BugClientMetadata = {
+    locale: string | null;
+    timezone: string | null;
+    language: string | null;
+    languages: string[];
+    platform: string | null;
+    referrer: string | null;
+    colorScheme: "light" | "dark" | "unknown";
+    viewport: {
+        width: number | null;
+        height: number | null;
+        pixelRatio: number | null;
+    };
+    screen: {
+        width: number | null;
+        height: number | null;
+        availWidth: number | null;
+        availHeight: number | null;
+        colorDepth: number | null;
+    };
+    device: {
+        hardwareConcurrency: number | null;
+        deviceMemoryGb: number | null;
+        maxTouchPoints: number | null;
+        online: boolean | null;
+        cookieEnabled: boolean | null;
+    };
+    connection: {
+        effectiveType: string | null;
+        downlinkMbps: number | null;
+        rttMs: number | null;
+        saveData: boolean | null;
+    };
+    captureMode: ReportCaptureMode;
+    capture: {
+        startedAt: string;
+        stoppedAt: string;
+        elapsedMs: number;
+    };
+    annotation?: {
+        imageWidth: number;
+        imageHeight: number;
+        highlights: ScreenshotHighlightRegion[];
+    };
+};
+type BugSessionArtifacts = {
+    videoBlob: Blob | null;
+    screenshotBlob: Blob | null;
+    networkLogs: NetworkLogEntry[];
+    captureMode: ReportCaptureMode;
+    startedAt: string;
+    stoppedAt: string;
+    elapsedMs: number;
+    stopReason: RecordingStopReason;
+};
+type BugReportPayload = {
+    title: string;
+    description: string;
+    videoBlob: Blob | null;
+    screenshotBlob: Blob | null;
+    networkLogs: NetworkLogEntry[];
+    captureMode: ReportCaptureMode;
+    pageUrl: string;
+    userAgent: string;
+    startedAt: string;
+    stoppedAt: string;
+    elapsedMs: number;
+    metadata: BugClientMetadata;
+};
+type BugSubmitResult = {
+    provider: BugTrackerProvider;
+    issueId: string;
+    issueKey: string;
+    issueUrl: string | null;
+    warnings: string[];
+};
+type SubmitProgressCallback = (message: string) => void;
+interface BugReporterIntegration {
+    readonly provider: BugTrackerProvider;
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+}
+declare function formatNetworkLogs(logs: NetworkLogEntry[]): string;
+declare function toErrorMessage(error: unknown): string;
+declare function collectClientEnvironmentMetadata(): Omit<BugClientMetadata, "captureMode" | "capture">;
+
+declare class NetworkLogger {
+    private originalFetch;
+    private logs;
+    private recording;
+    start(): void;
+    stop(): NetworkLogEntry[];
+    clear(): void;
+    getLogs(): NetworkLogEntry[];
+    isRecording(): boolean;
+}
+
+type ScreenRecorderStartOptions = {
+    onEnded?: () => void;
+};
+declare class ScreenRecorder {
+    private mediaRecorder;
+    private displayStream;
+    private microphoneStream;
+    private mixedStream;
+    private audioContext;
+    private displayAudioStream;
+    private microphoneAudioStream;
+    private chunks;
+    private recording;
+    private stopPromise;
+    private stopResolver;
+    private lastBlob;
+    private onEnded;
+    start(options?: ScreenRecorderStartOptions): Promise<void>;
+    stop(): Promise<Blob | null>;
+    isRecording(): boolean;
+    getLastBlob(): Blob | null;
+    clearLastBlob(): void;
+    dispose(): void;
+    private cleanupStreams;
+    private resetStopPromise;
+    private buildMixedAudioTracks;
+}
+
+type CaptureRegion = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+declare class ScreenshotCapturer {
+    capture(): Promise<Blob>;
+    private captureViaDomSnapshot;
+    captureRegion(region: CaptureRegion): Promise<Blob>;
+    private cropBlob;
+}
+
+type BugSessionOptions = {
+    maxDurationMs?: number;
+    screenRecorder?: ScreenRecorder;
+    screenshotCapturer?: ScreenshotCapturer;
+    networkLogger?: NetworkLogger;
+    onAutoStop?: (artifacts: BugSessionArtifacts) => void;
+};
+declare class BugSession {
+    private readonly maxDurationMs;
+    private readonly screenRecorder;
+    private readonly screenshotCapturer;
+    private readonly networkLogger;
+    private readonly onAutoStop?;
+    private recording;
+    private startedAtMs;
+    private autoStopTimeout;
+    private stopInFlight;
+    private lastArtifacts;
+    constructor(options?: BugSessionOptions);
+    start(): Promise<void>;
+    captureScreenshot(region?: CaptureRegion): Promise<BugSessionArtifacts>;
+    stop(reason?: RecordingStopReason): Promise<BugSessionArtifacts | null>;
+    isRecording(): boolean;
+    getElapsedMs(): number;
+    getMaxDurationMs(): number;
+    getLastArtifacts(): BugSessionArtifacts | null;
+    getLastCaptureMode(): ReportCaptureMode | null;
+    resetArtifacts(): void;
+    dispose(): Promise<void>;
+    private stopInternal;
+    private handleForcedStop;
+    private clearAutoStopTimer;
+}
+
+type BugReporterOptions = {
+    integration: BugReporterIntegration;
+    maxDurationMs?: number;
+    onAutoStop?: (artifacts: BugSessionArtifacts) => void;
+    session?: BugSession;
+};
+type BugReporterSubmitOptions = {
+    screenshotBlob?: Blob | null;
+    metadata?: Partial<BugClientMetadata>;
+    onProgress?: SubmitProgressCallback;
+};
+declare class BugReporter {
+    private integration;
+    private readonly session;
+    constructor(options: BugReporterOptions);
+    start(): Promise<void>;
+    captureScreenshot(region?: CaptureRegion): Promise<BugSessionArtifacts>;
+    stop(): Promise<BugSessionArtifacts | null>;
+    submit(title: string, description: string, options?: BugReporterSubmitOptions): Promise<BugSubmitResult>;
+    isRecording(): boolean;
+    getElapsedMs(): number;
+    getMaxDurationMs(): number;
+    getLastArtifacts(): BugSessionArtifacts | null;
+    clearDraft(): void;
+    setIntegration(integration: BugReporterIntegration): void;
+    getSelectedProvider(): BugTrackerProvider;
+    dispose(): Promise<void>;
+}
+
+type LinearIntegrationOptions = {
+    apiKey?: string;
+    teamId?: string;
+    projectId?: string;
+    graphqlEndpoint?: string;
+    submitProxyEndpoint?: string;
+    createIssueProxyEndpoint?: string;
+    uploadProxyEndpoint?: string;
+    fetchImpl?: typeof fetch;
+};
+declare class LinearIntegration implements BugReporterIntegration {
+    readonly provider: "linear";
+    private readonly apiKey?;
+    private readonly teamId?;
+    private readonly projectId?;
+    private readonly graphqlEndpoint;
+    private readonly submitProxyEndpoint?;
+    private readonly createIssueProxyEndpoint?;
+    private readonly uploadProxyEndpoint?;
+    private readonly fetchImpl;
+    constructor(options: LinearIntegrationOptions);
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+    private submitViaProxy;
+    private createIssue;
+    private addComment;
+    private uploadAsset;
+    private requestUploadTarget;
+}
+
+type JiraIntegrationOptions = {
+    baseUrl?: string;
+    email?: string;
+    apiToken?: string;
+    projectKey?: string;
+    issueType?: string;
+    submitProxyEndpoint?: string;
+    createIssueProxyEndpoint?: string;
+    uploadAttachmentProxyEndpoint?: string;
+    fetchImpl?: typeof fetch;
+};
+declare class JiraIntegration implements BugReporterIntegration {
+    readonly provider: "jira";
+    private readonly baseUrl?;
+    private readonly email?;
+    private readonly apiToken?;
+    private readonly projectKey?;
+    private readonly issueType;
+    private readonly submitProxyEndpoint?;
+    private readonly createIssueProxyEndpoint?;
+    private readonly uploadAttachmentProxyEndpoint?;
+    private readonly fetchImpl;
+    constructor(options: JiraIntegrationOptions);
+    submit(payload: BugReportPayload, onProgress?: SubmitProgressCallback): Promise<BugSubmitResult>;
+    private submitViaProxy;
+    private createIssue;
+    private uploadAttachment;
+}
+
+type BugReporterIntegrations = Partial<Record<"linear" | "jira", BugReporterIntegration>>;
+
+type BugReporterProviderProps = {
+    children: ReactNode;
+    integrations: BugReporterIntegrations;
+    defaultProvider?: BugTrackerProvider;
+    maxDurationMs?: number;
+};
+type ScreenshotAnnotationState = {
+    annotatedBlob: Blob | null;
+    highlights: ScreenshotHighlightRegion[];
+    imageWidth: number;
+    imageHeight: number;
+};
+type BugReporterContextValue = {
+    isOpen: boolean;
+    openModal: () => void;
+    closeModal: () => void;
+    draftMode: ReportCaptureMode | null;
+    hasDraft: boolean;
+    isRecording: boolean;
+    elapsedMs: number;
+    maxDurationMs: number;
+    isSubmitting: boolean;
+    submissionProgress: string | null;
+    isCapturingScreenshot: boolean;
+    isSelectingRegion: boolean;
+    error: string | null;
+    success: string | null;
+    autoStopNotice: string | null;
+    availableProviders: BugTrackerProvider[];
+    selectedProvider: BugTrackerProvider | null;
+    setSelectedProvider: (provider: BugTrackerProvider) => void;
+    startRecording: () => Promise<boolean>;
+    stopRecording: () => Promise<boolean>;
+    captureQuickScreenshot: () => Promise<boolean>;
+    startRegionSelection: () => void;
+    videoPreviewUrl: string | null;
+    screenshotPreviewUrl: string | null;
+    screenshotHighlightCount: number;
+    updateScreenshotAnnotation: (annotation: ScreenshotAnnotationState) => void;
+    clearDraft: () => void;
+    submitReport: (title: string, description: string) => Promise<BugSubmitResult | null>;
+    resetMessages: () => void;
+};
+declare function BugReporterProvider({ children, integrations, defaultProvider, maxDurationMs, }: BugReporterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useBugReporter(): BugReporterContextValue;
+
+declare function FloatingBugButton(): react_jsx_runtime.JSX.Element | null;
+
+declare function BugReporterModal(): react_jsx_runtime.JSX.Element;
+
+export { type BugClientMetadata, type BugReportPayload, BugReporter, type BugReporterIntegration, type BugReporterIntegrations, BugReporterModal, BugReporterProvider, BugSession, type BugSessionArtifacts, type BugSubmitResult, type BugTrackerProvider, type CaptureRegion, DEFAULT_MAX_RECORDING_MS, FloatingBugButton, JiraIntegration, type JiraIntegrationOptions, LinearIntegration, type LinearIntegrationOptions, type NetworkLogEntry, NetworkLogger, type RecordingStopReason, type ReportCaptureMode, ScreenRecorder, ScreenshotCapturer, type ScreenshotHighlightRegion, type SubmitProgressCallback, collectClientEnvironmentMetadata, formatNetworkLogs, toErrorMessage, useBugReporter };