@checkflow/sdk 1.0.1

package/dist/checkflow.d.ts

@@ -0,0 +1,112 @@
+/**
+ * CheckFlow SDK Main Class
+ * Entry point for the CheckFlow feedback SDK
+ */
+import { CheckFlowOptions, FeedbackData, CaptureOptions, CaptureResult, SubmitResult, UserInfo, ErrorInfo } from './types';
+import { PrivacyMasker } from './privacy';
+export declare class CheckFlow {
+    private static instance;
+    private apiKey;
+    private options;
+    private apiClient;
+    private contextCapture;
+    private errorCapture;
+    private sessionRecording;
+    private widget;
+    private privacyMasker;
+    private analyticsTracker;
+    private isInitialized;
+    constructor(apiKey: string, options?: CheckFlowOptions);
+    /**
+     * Initialize the SDK
+     */
+    init(): this;
+    /**
+     * Show the feedback widget
+     */
+    showWidget(): void;
+    /**
+     * Hide the feedback widget
+     */
+    hideWidget(): void;
+    /**
+     * Open the feedback form
+     */
+    open(): void;
+    /**
+     * Close the feedback form
+     */
+    close(): void;
+    /**
+     * Capture current page context
+     */
+    capture(options?: CaptureOptions): Promise<CaptureResult>;
+    /**
+     * Submit feedback
+     */
+    submitFeedback(feedback: FeedbackData): Promise<SubmitResult>;
+    /**
+     * Capture and report an error
+     */
+    captureException(error: Error, context?: Record<string, any>): void;
+    /**
+     * Set user information
+     */
+    setUser(user: UserInfo): void;
+    /**
+     * Clear user information
+     */
+    clearUser(): void;
+    /**
+     * Add custom metadata
+     */
+    setMetadata(metadata: Record<string, any>): void;
+    /**
+     * Get console logs
+     */
+    getConsoleLogs(): import("./types").ConsoleEntry[];
+    /**
+     * Get network logs
+     */
+    getNetworkLogs(): import("./types").NetworkEntry[];
+    /**
+     * Get captured errors
+     */
+    getErrors(): ErrorInfo[];
+    /**
+     * Configure privacy settings
+     */
+    configurePrivacy(config: {
+        enabled?: boolean;
+        autoMask?: {
+            emails?: boolean;
+            creditCards?: boolean;
+            phoneNumbers?: boolean;
+            passwords?: boolean;
+        };
+        excludeSelectors?: string[];
+    }): void;
+    /**
+     * Mask text using privacy rules
+     */
+    maskText(text: string): import("./privacy").MaskResult;
+    /**
+     * Get privacy masker instance
+     */
+    getPrivacyMasker(): PrivacyMasker;
+    /**
+     * Destroy the SDK instance
+     */
+    destroy(): void;
+    /**
+     * Get the singleton instance
+     */
+    static getInstance(): CheckFlow | null;
+    private handleWidgetSubmit;
+    private handleError;
+    private log;
+}
+/**
+ * Factory function for creating CheckFlow instance
+ */
+export declare function createCheckFlow(apiKey: string, options?: CheckFlowOptions): CheckFlow;

package/dist/context-capture.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Context Capture Module
+ * Handles screenshot capture, console logs, network logs, and performance metrics
+ */
+import { CaptureOptions, CaptureResult, ConsoleEntry, NetworkEntry, PerformanceMetrics, PageContext } from './types';
+declare function capturePerformance(): PerformanceMetrics;
+declare function capturePageContext(): PageContext;
+declare function captureScreenshot(options?: CaptureOptions): Promise<string | null>;
+export declare class ContextCapture {
+    private consoleCapture;
+    private networkCapture;
+    private isCapturing;
+    constructor(options?: {
+        maxConsoleEntries?: number;
+        maxNetworkEntries?: number;
+    });
+    /**
+     * Start capturing console and network logs
+     */
+    startCapture(): void;
+    /**
+     * Stop capturing
+     */
+    stopCapture(): void;
+    /**
+     * Capture current page context with optional screenshot
+     */
+    capture(options?: CaptureOptions): Promise<CaptureResult>;
+    /**
+     * Get current console entries
+     */
+    getConsoleLogs(): ConsoleEntry[];
+    /**
+     * Get current network entries
+     */
+    getNetworkLogs(): NetworkEntry[];
+    /**
+     * Clear all captured data
+     */
+    clear(): void;
+}
+export { captureScreenshot, capturePageContext, capturePerformance };

package/dist/error-capture.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Error Capture Module
+ * Automatic error capture and reporting
+ */
+import { ErrorInfo } from './types';
+export type ErrorHandler = (error: ErrorInfo) => void | Promise<void>;
+export declare class ErrorCapture {
+    private handler?;
+    private isCapturing;
+    private capturedErrors;
+    private maxErrors;
+    private originalOnError?;
+    private originalOnUnhandledRejection?;
+    constructor(handler?: ErrorHandler);
+    /**
+     * Start capturing errors
+     */
+    start(): void;
+    /**
+     * Stop capturing errors
+     */
+    stop(): void;
+    /**
+     * Set error handler
+     */
+    setHandler(handler: ErrorHandler): void;
+    /**
+     * Manually capture an error
+     */
+    captureError(error: Partial<ErrorInfo>): void;
+    /**
+     * Capture an exception (try/catch style)
+     */
+    captureException(error: Error, context?: Record<string, any>): void;
+    /**
+     * Get captured errors
+     */
+    getErrors(): ErrorInfo[];
+    /**
+     * Clear captured errors
+     */
+    clear(): void;
+}
+/**
+ * React Error Boundary wrapper
+ * Usage:
+ * ```tsx
+ * import { withErrorBoundary } from '@checkflow/sdk';
+ *
+ * const App = withErrorBoundary(MyApp, {
+ *   fallback: <ErrorFallback />,
+ *   onError: (error, errorInfo) => console.log(error),
+ * });
+ * ```
+ */
+export interface ErrorBoundaryOptions {
+    fallback?: React.ReactNode | ((error: Error, reset: () => void) => React.ReactNode);
+    onError?: (error: Error, errorInfo: React.ErrorInfo) => void;
+    onReset?: () => void;
+}

package/dist/index.d.ts

@@ -0,0 +1,23 @@
+/**
+ * CheckFlow SDK
+ * User feedback collection with automatic context capture
+ *
+ * @packageDocumentation
+ */
+export { CheckFlow, createCheckFlow } from './checkflow';
+export { APIClient } from './api-client';
+export { ContextCapture, captureScreenshot, capturePageContext, capturePerformance } from './context-capture';
+export { ErrorCapture } from './error-capture';
+export { FeedbackWidget } from './widget';
+export { SessionRecording } from './session-recording';
+export { AnnotationEditor, AnnotationToolbar, injectAnnotationStyles, removeAnnotationStyles, } from './annotation';
+export { PrivacyMasker, PrivacyDetector, PATTERNS as PRIVACY_PATTERNS, DEFAULT_PRIVACY_CONFIG, } from './privacy';
+export type { PrivacyConfig, AutoMaskConfig, CustomPattern, MaskResult, Detection as PrivacyDetection, DetectionType, DOMPrivacyResult, DOMDetection, } from './privacy';
+export type { AnnotationToolType, Point, Bounds, AnnotationStyle, Annotation as AnnotationData, RectangleAnnotation, EllipseAnnotation, ArrowAnnotation, LineAnnotation, HighlightAnnotation, BlurAnnotation, TextAnnotation, FreehandAnnotation, AnnotationEditorConfig, } from './annotation';
+export { DEFAULT_STYLE, HIGHLIGHT_STYLE, BLUR_STYLE, COLOR_PALETTE, STROKE_WIDTHS, } from './annotation';
+export type { CheckFlowOptions, UserInfo, FeedbackData, FeedbackType, FeedbackPriority, Annotation, CaptureOptions, CaptureResult, ConsoleEntry, NetworkEntry, PerformanceMetrics, PageContext, ErrorInfo, SubmitResult, APIResponse, WidgetConfig, WidgetState, Translations, } from './types';
+export { DEFAULT_TRANSLATIONS, TRANSLATIONS } from './types';
+export { CheckFlowProvider, useCheckFlow, useFeedbackForm, CheckFlowErrorBoundary, withCheckFlow, withErrorBoundary, FeedbackButton, } from './react';
+export declare const VERSION = "1.0.0";
+import { CheckFlow } from './checkflow';
+export default CheckFlow;