@bugdump/sdk 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,270 @@
+import { eventWithTime } from '@rrweb/types';
+
+interface BugdumpConfig {
+    projectKey: string;
+    endpoint?: string;
+}
+interface BugdumpUserContext {
+    id?: string;
+    email?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+interface ReportPayload {
+    description: string;
+    priority?: 'low' | 'medium' | 'high' | 'critical';
+    reporterName?: string;
+    reporterEmail?: string;
+    reporterExternalId?: string;
+    pageUrl?: string;
+    referrerUrl?: string;
+    userAgent?: string;
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    consoleLogs?: Record<string, unknown>[];
+    networkRequests?: Record<string, unknown>[];
+    performance?: Record<string, unknown>;
+    customContext?: Record<string, unknown>;
+    annotations?: Record<string, unknown>[];
+    attachments?: Array<{
+        fileId: string;
+        type: 'screenshot' | 'recording' | 'voice_note' | 'session_replay';
+        metadata?: Record<string, unknown>;
+    }>;
+}
+interface ReportResponse {
+    id: string;
+    publicId: string;
+}
+interface UploadRequest {
+    originalName: string;
+    mimeType: string;
+    size: number;
+}
+interface UploadResponse {
+    fileId: string;
+    url: string;
+    fields: Record<string, string>;
+}
+
+declare class HttpClient {
+    private endpoint;
+    private apiKey;
+    constructor(endpoint: string, apiKey: string);
+    submitReport(payload: ReportPayload): Promise<ReportResponse>;
+    requestUpload(request: UploadRequest): Promise<UploadResponse>;
+    uploadFileToS3(presignedUrl: string, fields: Record<string, string>, file: Blob): Promise<void>;
+    private post;
+}
+declare class BugdumpApiError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly details: unknown;
+    constructor(code: string, statusCode: number, details?: unknown);
+}
+
+interface ConsoleLogEntry {
+    level: 'log' | 'warn' | 'error' | 'info' | 'debug';
+    args: unknown[];
+    timestamp: number;
+}
+
+interface NetworkRequestEntry {
+    method: string;
+    url: string;
+    status: number | null;
+    statusText: string | null;
+    requestHeaders: Record<string, string>;
+    responseHeaders: Record<string, string>;
+    duration: number | null;
+    startedAt: number;
+    error: string | null;
+}
+
+interface PerformanceSnapshot {
+    timing: PerformanceTimingData | null;
+    memory: PerformanceMemoryData | null;
+    resources: PerformanceResourceData[];
+}
+interface PerformanceTimingData {
+    domContentLoaded: number | null;
+    loadComplete: number | null;
+    firstPaint: number | null;
+    firstContentfulPaint: number | null;
+    ttfb: number | null;
+}
+interface PerformanceMemoryData {
+    usedJSHeapSize: number;
+    totalJSHeapSize: number;
+    jsHeapSizeLimit: number;
+}
+interface PerformanceResourceData {
+    name: string;
+    type: string;
+    duration: number;
+    size: number;
+}
+
+interface MetadataSnapshot {
+    userAgent: string;
+    language: string;
+    platform: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    screenResolution: {
+        width: number;
+        height: number;
+    };
+    devicePixelRatio: number;
+    url: string;
+    referrer: string;
+    timestamp: number;
+}
+
+interface TelemetrySnapshot {
+    consoleLogs: ConsoleLogEntry[];
+    networkRequests: NetworkRequestEntry[];
+    sessionReplayEvents: eventWithTime[];
+    performance: PerformanceSnapshot;
+    metadata: MetadataSnapshot;
+}
+declare class Bugdump {
+    private static instance;
+    private state;
+    private httpClient;
+    private consoleCollector;
+    private networkCollector;
+    private sessionReplayCollector;
+    private widget;
+    private constructor();
+    static init(config: BugdumpConfig): Bugdump;
+    static getInstance(): Bugdump | null;
+    identify(user: BugdumpUserContext): void;
+    setContext(context: Record<string, unknown>): void;
+    open(): void;
+    close(): void;
+    collectTelemetry(): TelemetrySnapshot;
+    destroy(): void;
+    getConfig(): Required<BugdumpConfig> | null;
+    getUser(): BugdumpUserContext | null;
+    getContext(): Record<string, unknown>;
+    getHttpClient(): HttpClient;
+    isWidgetOpen(): boolean;
+    private mountWidget;
+    private handleSubmit;
+    private ensureInitialized;
+}
+
+interface ScreenshotOptions {
+    quality?: number;
+    target?: HTMLElement;
+    filter?: (node: HTMLElement) => boolean;
+}
+interface ScreenshotResult {
+    blob: Blob;
+    width: number;
+    height: number;
+}
+declare function captureScreenshot(options?: ScreenshotOptions): Promise<ScreenshotResult>;
+
+type AnnotationTool = 'arrow' | 'box' | 'text' | 'blur' | 'freehand';
+interface Point {
+    x: number;
+    y: number;
+}
+interface BaseDrawOperation {
+    id: string;
+    tool: AnnotationTool;
+    color: string;
+    lineWidth: number;
+    timestamp: number;
+}
+interface ArrowOperation extends BaseDrawOperation {
+    tool: 'arrow';
+    start: Point;
+    end: Point;
+}
+interface BoxOperation extends BaseDrawOperation {
+    tool: 'box';
+    start: Point;
+    end: Point;
+}
+interface TextOperation extends BaseDrawOperation {
+    tool: 'text';
+    position: Point;
+    text: string;
+    fontSize: number;
+}
+interface BlurOperation extends BaseDrawOperation {
+    tool: 'blur';
+    start: Point;
+    end: Point;
+    blurRadius: number;
+}
+interface FreehandOperation extends BaseDrawOperation {
+    tool: 'freehand';
+    points: Point[];
+}
+type DrawOperation = ArrowOperation | BoxOperation | TextOperation | BlurOperation | FreehandOperation;
+declare function renderOperationsToCanvas(ctx: CanvasRenderingContext2D, operations: DrawOperation[]): void;
+declare class AnnotationOverlay {
+    private container;
+    private width;
+    private height;
+    private canvas;
+    private ctx;
+    private operations;
+    private currentTool;
+    private color;
+    private lineWidth;
+    private fontSize;
+    private blurRadius;
+    private isDrawing;
+    private startPoint;
+    private currentPoints;
+    private screenshotImage;
+    private onPointerDownBound;
+    private onPointerMoveBound;
+    private onPointerUpBound;
+    constructor(container: HTMLElement, width: number, height: number);
+    setScreenshotImage(image: HTMLImageElement): void;
+    setTool(tool: AnnotationTool): void;
+    getTool(): AnnotationTool;
+    setColor(color: string): void;
+    setLineWidth(lineWidth: number): void;
+    setFontSize(fontSize: number): void;
+    setBlurRadius(radius: number): void;
+    getOperations(): DrawOperation[];
+    undo(): void;
+    clear(): void;
+    addTextAtPosition(position: Point, text: string): void;
+    destroy(): void;
+    private getCanvasPoint;
+    private onPointerDown;
+    private onPointerMove;
+    private onPointerUp;
+    private promptTextInput;
+    private drawPreview;
+    private redraw;
+}
+
+interface Attachment {
+    id: string;
+    type: 'screenshot' | 'recording' | 'voice_note' | 'file';
+    blob: Blob;
+    name: string;
+    thumbnailUrl?: string;
+    annotations?: DrawOperation[];
+}
+interface PanelSubmitData {
+    description: string;
+    reporterName: string;
+    reporterEmail: string;
+    attachments: Attachment[];
+}
+
+export { AnnotationOverlay, type AnnotationTool, type ArrowOperation, type Attachment, type BlurOperation, type BoxOperation, Bugdump, BugdumpApiError, type BugdumpConfig, type BugdumpUserContext, type ConsoleLogEntry, type DrawOperation, type FreehandOperation, HttpClient, type MetadataSnapshot, type NetworkRequestEntry, type PanelSubmitData, type PerformanceSnapshot, type Point, type ReportPayload, type ReportResponse, type ScreenshotOptions, type ScreenshotResult, type TelemetrySnapshot, type TextOperation, type UploadRequest, type UploadResponse, captureScreenshot, renderOperationsToCanvas };

package/dist/index.d.ts

@@ -0,0 +1,270 @@
+import { eventWithTime } from '@rrweb/types';
+
+interface BugdumpConfig {
+    projectKey: string;
+    endpoint?: string;
+}
+interface BugdumpUserContext {
+    id?: string;
+    email?: string;
+    name?: string;
+    [key: string]: unknown;
+}
+interface ReportPayload {
+    description: string;
+    priority?: 'low' | 'medium' | 'high' | 'critical';
+    reporterName?: string;
+    reporterEmail?: string;
+    reporterExternalId?: string;
+    pageUrl?: string;
+    referrerUrl?: string;
+    userAgent?: string;
+    viewport?: {
+        width: number;
+        height: number;
+    };
+    consoleLogs?: Record<string, unknown>[];
+    networkRequests?: Record<string, unknown>[];
+    performance?: Record<string, unknown>;
+    customContext?: Record<string, unknown>;
+    annotations?: Record<string, unknown>[];
+    attachments?: Array<{
+        fileId: string;
+        type: 'screenshot' | 'recording' | 'voice_note' | 'session_replay';
+        metadata?: Record<string, unknown>;
+    }>;
+}
+interface ReportResponse {
+    id: string;
+    publicId: string;
+}
+interface UploadRequest {
+    originalName: string;
+    mimeType: string;
+    size: number;
+}
+interface UploadResponse {
+    fileId: string;
+    url: string;
+    fields: Record<string, string>;
+}
+
+declare class HttpClient {
+    private endpoint;
+    private apiKey;
+    constructor(endpoint: string, apiKey: string);
+    submitReport(payload: ReportPayload): Promise<ReportResponse>;
+    requestUpload(request: UploadRequest): Promise<UploadResponse>;
+    uploadFileToS3(presignedUrl: string, fields: Record<string, string>, file: Blob): Promise<void>;
+    private post;
+}
+declare class BugdumpApiError extends Error {
+    readonly code: string;
+    readonly statusCode: number;
+    readonly details: unknown;
+    constructor(code: string, statusCode: number, details?: unknown);
+}
+
+interface ConsoleLogEntry {
+    level: 'log' | 'warn' | 'error' | 'info' | 'debug';
+    args: unknown[];
+    timestamp: number;
+}
+
+interface NetworkRequestEntry {
+    method: string;
+    url: string;
+    status: number | null;
+    statusText: string | null;
+    requestHeaders: Record<string, string>;
+    responseHeaders: Record<string, string>;
+    duration: number | null;
+    startedAt: number;
+    error: string | null;
+}
+
+interface PerformanceSnapshot {
+    timing: PerformanceTimingData | null;
+    memory: PerformanceMemoryData | null;
+    resources: PerformanceResourceData[];
+}
+interface PerformanceTimingData {
+    domContentLoaded: number | null;
+    loadComplete: number | null;
+    firstPaint: number | null;
+    firstContentfulPaint: number | null;
+    ttfb: number | null;
+}
+interface PerformanceMemoryData {
+    usedJSHeapSize: number;
+    totalJSHeapSize: number;
+    jsHeapSizeLimit: number;
+}
+interface PerformanceResourceData {
+    name: string;
+    type: string;
+    duration: number;
+    size: number;
+}
+
+interface MetadataSnapshot {
+    userAgent: string;
+    language: string;
+    platform: string;
+    viewport: {
+        width: number;
+        height: number;
+    };
+    screenResolution: {
+        width: number;
+        height: number;
+    };
+    devicePixelRatio: number;
+    url: string;
+    referrer: string;
+    timestamp: number;
+}
+
+interface TelemetrySnapshot {
+    consoleLogs: ConsoleLogEntry[];
+    networkRequests: NetworkRequestEntry[];
+    sessionReplayEvents: eventWithTime[];
+    performance: PerformanceSnapshot;
+    metadata: MetadataSnapshot;
+}
+declare class Bugdump {
+    private static instance;
+    private state;
+    private httpClient;
+    private consoleCollector;
+    private networkCollector;
+    private sessionReplayCollector;
+    private widget;
+    private constructor();
+    static init(config: BugdumpConfig): Bugdump;
+    static getInstance(): Bugdump | null;
+    identify(user: BugdumpUserContext): void;
+    setContext(context: Record<string, unknown>): void;
+    open(): void;
+    close(): void;
+    collectTelemetry(): TelemetrySnapshot;
+    destroy(): void;
+    getConfig(): Required<BugdumpConfig> | null;
+    getUser(): BugdumpUserContext | null;
+    getContext(): Record<string, unknown>;
+    getHttpClient(): HttpClient;
+    isWidgetOpen(): boolean;
+    private mountWidget;
+    private handleSubmit;
+    private ensureInitialized;
+}
+
+interface ScreenshotOptions {
+    quality?: number;
+    target?: HTMLElement;
+    filter?: (node: HTMLElement) => boolean;
+}
+interface ScreenshotResult {
+    blob: Blob;
+    width: number;
+    height: number;
+}
+declare function captureScreenshot(options?: ScreenshotOptions): Promise<ScreenshotResult>;
+
+type AnnotationTool = 'arrow' | 'box' | 'text' | 'blur' | 'freehand';
+interface Point {
+    x: number;
+    y: number;
+}
+interface BaseDrawOperation {
+    id: string;
+    tool: AnnotationTool;
+    color: string;
+    lineWidth: number;
+    timestamp: number;
+}
+interface ArrowOperation extends BaseDrawOperation {
+    tool: 'arrow';
+    start: Point;
+    end: Point;
+}
+interface BoxOperation extends BaseDrawOperation {
+    tool: 'box';
+    start: Point;
+    end: Point;
+}
+interface TextOperation extends BaseDrawOperation {
+    tool: 'text';
+    position: Point;
+    text: string;
+    fontSize: number;
+}
+interface BlurOperation extends BaseDrawOperation {
+    tool: 'blur';
+    start: Point;
+    end: Point;
+    blurRadius: number;
+}
+interface FreehandOperation extends BaseDrawOperation {
+    tool: 'freehand';
+    points: Point[];
+}
+type DrawOperation = ArrowOperation | BoxOperation | TextOperation | BlurOperation | FreehandOperation;
+declare function renderOperationsToCanvas(ctx: CanvasRenderingContext2D, operations: DrawOperation[]): void;
+declare class AnnotationOverlay {
+    private container;
+    private width;
+    private height;
+    private canvas;
+    private ctx;
+    private operations;
+    private currentTool;
+    private color;
+    private lineWidth;
+    private fontSize;
+    private blurRadius;
+    private isDrawing;
+    private startPoint;
+    private currentPoints;
+    private screenshotImage;
+    private onPointerDownBound;
+    private onPointerMoveBound;
+    private onPointerUpBound;
+    constructor(container: HTMLElement, width: number, height: number);
+    setScreenshotImage(image: HTMLImageElement): void;
+    setTool(tool: AnnotationTool): void;
+    getTool(): AnnotationTool;
+    setColor(color: string): void;
+    setLineWidth(lineWidth: number): void;
+    setFontSize(fontSize: number): void;
+    setBlurRadius(radius: number): void;
+    getOperations(): DrawOperation[];
+    undo(): void;
+    clear(): void;
+    addTextAtPosition(position: Point, text: string): void;
+    destroy(): void;
+    private getCanvasPoint;
+    private onPointerDown;
+    private onPointerMove;
+    private onPointerUp;
+    private promptTextInput;
+    private drawPreview;
+    private redraw;
+}
+
+interface Attachment {
+    id: string;
+    type: 'screenshot' | 'recording' | 'voice_note' | 'file';
+    blob: Blob;
+    name: string;
+    thumbnailUrl?: string;
+    annotations?: DrawOperation[];
+}
+interface PanelSubmitData {
+    description: string;
+    reporterName: string;
+    reporterEmail: string;
+    attachments: Attachment[];
+}
+
+export { AnnotationOverlay, type AnnotationTool, type ArrowOperation, type Attachment, type BlurOperation, type BoxOperation, Bugdump, BugdumpApiError, type BugdumpConfig, type BugdumpUserContext, type ConsoleLogEntry, type DrawOperation, type FreehandOperation, HttpClient, type MetadataSnapshot, type NetworkRequestEntry, type PanelSubmitData, type PerformanceSnapshot, type Point, type ReportPayload, type ReportResponse, type ScreenshotOptions, type ScreenshotResult, type TelemetrySnapshot, type TextOperation, type UploadRequest, type UploadResponse, captureScreenshot, renderOperationsToCanvas };