@checkflow/sdk 1.1.1 → 1.1.2

package/dist/optimized-recorder.d.ts

@@ -1,94 +0,0 @@
-/**
- * Optimized Session Recorder - Inspired by Mixpanel/LogRocket
- *
- * Features from refactorisation.md:
- * - Adaptive sampling (10-100ms based on activity)
- * - Event batching (50 events per batch)
- * - Compression before sending
- * - Circular buffer for performance
- * - Intelligent event filtering
- */
-import type { eventWithTime } from '@rrweb/types';
-export interface OptimizedRecorderConfig {
-    samplingRate: number;
-    eventBatchSize: number;
-    maxSessionLength: number;
-    quality: 'low' | 'medium' | 'high';
-    compression: boolean;
-    adaptiveSampling: boolean;
-    onBatchReady?: (batch: EventBatch) => void;
-    onError?: (error: Error) => void;
-}
-export interface EventBatch {
-    sessionId: string;
-    events: eventWithTime[];
-    chunkIndex: number;
-    compressed?: boolean;
-    compressedData?: string;
-    timestamp: number;
-}
-export declare class OptimizedRecorder {
-    private config;
-    private eventBuffer;
-    private bufferIndex;
-    private sessionId;
-    private stopRecording?;
-    private batchTimer?;
-    private activityMetrics;
-    private startTime;
-    private chunkIndex;
-    private isRecording;
-    constructor(sessionId: string, config?: Partial<OptimizedRecorderConfig>);
-    /**
-     * Start recording with optimized settings
-     */
-    start(): void;
-    /**
-     * Stop recording and flush remaining events
-     */
-    stop(): void;
-    /**
-     * Handle incoming event from rrweb
-     */
-    private handleEvent;
-    /**
-     * Flush current batch of events
-     */
-    private flushBatch;
-    /**
-     * Start periodic batch flushing
-     */
-    private startBatchTimer;
-    /**
-     * Update activity metrics based on event
-     */
-    private updateActivityMetrics;
-    /**
-     * Calculate activity level (0-1)
-     */
-    private calculateActivityLevel;
-    /**
-     * Adjust sampling rate based on activity
-     */
-    private adjustSamplingRate;
-    /**
-     * Get sampling configuration based on quality
-     */
-    private getSamplingConfig;
-    /**
-     * Get slimDOM options based on quality
-     */
-    private getSlimDOMOptions;
-    /**
-     * Get current recording stats
-     */
-    getStats(): {
-        isRecording: boolean;
-        sessionId: string;
-        duration: number;
-        bufferedEvents: number;
-        chunksSent: number;
-        activityLevel: number;
-        currentSamplingRate: number;
-    };
-}

package/dist/privacy/detector.d.ts

@@ -1,56 +0,0 @@
-/**
- * CheckFlow Privacy Detector
- * Regex patterns for detecting PII (Personally Identifiable Information)
- */
-import { Detection, CustomPattern } from './types';
-export declare const PATTERNS: Record<string, RegExp>;
-export declare class PrivacyDetector {
-    private customPatterns;
-    constructor(customPatterns?: CustomPattern[]);
-    /**
-     * Add a custom pattern
-     */
-    addPattern(pattern: CustomPattern): void;
-    /**
-     * Detect all PII in a text string
-     */
-    detectAll(text: string, options?: {
-        emails?: boolean;
-        creditCards?: boolean;
-        phoneNumbers?: boolean;
-        ssn?: boolean;
-        ipAddresses?: boolean;
-    }): Detection[];
-    /**
-     * Detect email addresses
-     */
-    detectEmails(text: string): Detection[];
-    /**
-     * Detect credit card numbers
-     */
-    detectCreditCards(text: string): Detection[];
-    /**
-     * Detect phone numbers
-     */
-    detectPhoneNumbers(text: string): Detection[];
-    /**
-     * Detect Social Security Numbers
-     */
-    detectSSN(text: string): Detection[];
-    /**
-     * Detect IP addresses
-     */
-    detectIPAddresses(text: string): Detection[];
-    /**
-     * Detect custom pattern
-     */
-    detectCustom(text: string, pattern: CustomPattern): Detection[];
-    /**
-     * Find all matches of a pattern in text
-     */
-    private findMatches;
-    /**
-     * Remove overlapping detections (keep the longer one)
-     */
-    private removeOverlaps;
-}

package/dist/privacy/index.d.ts

@@ -1,8 +0,0 @@
-/**
- * CheckFlow Privacy Module
- * Automatic PII detection and masking for screenshots
- */
-export { PrivacyMasker } from './masker';
-export { PrivacyDetector, PATTERNS } from './detector';
-export type { PrivacyConfig, AutoMaskConfig, CustomPattern, MaskResult, Detection, DetectionType, DOMPrivacyResult, DOMDetection, } from './types';
-export { DEFAULT_PRIVACY_CONFIG, SENSITIVE_INPUT_TYPES, SENSITIVE_AUTOCOMPLETE_VALUES, } from './types';

package/dist/privacy/masker.d.ts

@@ -1,43 +0,0 @@
-/**
- * CheckFlow Privacy Masker
- * Applies masking to detected PII in text and DOM elements
- */
-import { PrivacyConfig, MaskResult, DOMPrivacyResult } from './types';
-export declare class PrivacyMasker {
-    private config;
-    private detector;
-    constructor(config?: Partial<PrivacyConfig>);
-    /**
-     * Update configuration
-     */
-    configure(config: Partial<PrivacyConfig>): void;
-    /**
-     * Mask PII in a text string
-     */
-    maskText(text: string): MaskResult;
-    /**
-     * Generate mask value for a detected PII
-     */
-    private getMaskValue;
-    /**
-     * Process DOM elements for privacy masking
-     * Returns a cloned document with masked content
-     */
-    processDOM(doc: Document): DOMPrivacyResult;
-    /**
-     * Check if element should be excluded from masking
-     */
-    private isExcluded;
-    /**
-     * Check if input is a sensitive type
-     */
-    private isSensitiveInput;
-    /**
-     * Generate CSS selector for element
-     */
-    private getSelector;
-    /**
-     * Get current configuration
-     */
-    getConfig(): PrivacyConfig;
-}

package/dist/privacy/types.d.ts

@@ -1,54 +0,0 @@
-/**
- * CheckFlow Privacy Module Types
- * Configuration and types for automatic PII masking
- */
-export interface PrivacyConfig {
-    enabled: boolean;
-    autoMask: AutoMaskConfig;
-    excludeSelectors: string[];
-    includeSelectors: string[];
-    maskChar: string;
-    maskLength: 'preserve' | 'fixed';
-    fixedMaskLength: number;
-}
-export interface AutoMaskConfig {
-    emails: boolean;
-    creditCards: boolean;
-    phoneNumbers: boolean;
-    passwords: boolean;
-    socialSecurity: boolean;
-    ipAddresses: boolean;
-    customPatterns: CustomPattern[];
-}
-export interface CustomPattern {
-    name: string;
-    pattern: RegExp;
-    replacement?: string;
-}
-export interface MaskResult {
-    original: string;
-    masked: string;
-    detections: Detection[];
-}
-export interface Detection {
-    type: DetectionType;
-    value: string;
-    masked: string;
-    startIndex: number;
-    endIndex: number;
-}
-export type DetectionType = 'email' | 'credit_card' | 'phone' | 'password' | 'ssn' | 'ip_address' | 'custom';
-export interface DOMPrivacyResult {
-    elementsProcessed: number;
-    elementsMasked: number;
-    detections: DOMDetection[];
-}
-export interface DOMDetection {
-    selector: string;
-    type: DetectionType;
-    originalText: string;
-    maskedText: string;
-}
-export declare const DEFAULT_PRIVACY_CONFIG: PrivacyConfig;
-export declare const SENSITIVE_INPUT_TYPES: string[];
-export declare const SENSITIVE_AUTOCOMPLETE_VALUES: string[];

package/dist/react/index.d.ts

@@ -1,77 +0,0 @@
-/**
- * CheckFlow React Integration
- * Provides React hooks, components, and error boundary
- */
-import React, { ReactNode, Component, ErrorInfo as ReactErrorInfo } from 'react';
-import { CheckFlow } from '../checkflow';
-import { CheckFlowOptions, FeedbackData, CaptureResult, SubmitResult, UserInfo, FeedbackType, FeedbackPriority } from '../types';
-interface CheckFlowContextValue {
-    checkflow: CheckFlow | null;
-    isReady: boolean;
-    capture: () => Promise<CaptureResult | null>;
-    submitFeedback: (feedback: FeedbackData) => Promise<SubmitResult>;
-    openWidget: () => void;
-    closeWidget: () => void;
-    setUser: (user: UserInfo) => void;
-    clearUser: () => void;
-}
-interface CheckFlowProviderProps {
-    apiKey: string;
-    options?: Omit<CheckFlowOptions, 'apiKey'>;
-    children: ReactNode;
-}
-export declare function CheckFlowProvider({ apiKey, options, children }: CheckFlowProviderProps): import("react/jsx-runtime").JSX.Element;
-export declare function useCheckFlow(): CheckFlowContextValue;
-interface UseFeedbackFormOptions {
-    onSuccess?: (result: SubmitResult) => void;
-    onError?: (error: Error) => void;
-    defaultType?: FeedbackType;
-    defaultPriority?: FeedbackPriority;
-}
-interface FeedbackFormState {
-    title: string;
-    description: string;
-    type: FeedbackType;
-    priority: FeedbackPriority;
-    includeScreenshot: boolean;
-    includeConsoleLogs: boolean;
-    includeNetworkLogs: boolean;
-}
-export declare function useFeedbackForm(options?: UseFeedbackFormOptions): {
-    formState: FeedbackFormState;
-    updateField: <K extends keyof FeedbackFormState>(field: K, value: FeedbackFormState[K]) => void;
-    screenshot: string | null;
-    captureScreenshot: () => Promise<CaptureResult | null>;
-    submit: () => Promise<SubmitResult | null>;
-    reset: () => void;
-    isSubmitting: boolean;
-    error: string | null;
-};
-interface ErrorBoundaryProps {
-    children: ReactNode;
-    fallback?: ReactNode | ((error: Error, reset: () => void) => ReactNode);
-    onError?: (error: Error, errorInfo: ReactErrorInfo) => void;
-    reportToCheckFlow?: boolean;
-}
-interface ErrorBoundaryState {
-    hasError: boolean;
-    error: Error | null;
-}
-export declare class CheckFlowErrorBoundary extends Component<ErrorBoundaryProps, ErrorBoundaryState> {
-    constructor(props: ErrorBoundaryProps);
-    static getDerivedStateFromError(error: Error): ErrorBoundaryState;
-    componentDidCatch(error: Error, errorInfo: ReactErrorInfo): void;
-    reset: () => void;
-    render(): string | number | boolean | Iterable<React.ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
-}
-export declare function withCheckFlow<P extends object>(WrappedComponent: React.ComponentType<P & {
-    checkflow: CheckFlowContextValue;
-}>): (props: P) => import("react/jsx-runtime").JSX.Element;
-export declare function withErrorBoundary<P extends object>(WrappedComponent: React.ComponentType<P>, errorBoundaryProps?: Omit<ErrorBoundaryProps, 'children'>): (props: P) => import("react/jsx-runtime").JSX.Element;
-interface FeedbackButtonProps {
-    children?: ReactNode;
-    className?: string;
-    style?: React.CSSProperties;
-}
-export declare function FeedbackButton({ children, className, style }: FeedbackButtonProps): import("react/jsx-runtime").JSX.Element;
-export type { CheckFlowOptions, FeedbackData, CaptureResult, SubmitResult, UserInfo, FeedbackType, FeedbackPriority, };

package/dist/session-recording-rrweb.d.ts

@@ -1,100 +0,0 @@
-/**
- * Session Recording Module with RRWeb Integration
- * Records user interactions exactly like Mixpanel does
- */
-import type { eventWithTime } from '@rrweb/types';
-export interface SessionRecordingConfig {
-    enabled: boolean;
-    maskAllInputs: boolean;
-    maskInputOptions: {
-        color: string;
-        textClass: string;
-        colorClass: string;
-    };
-    maskInputFn?: (text: string, element?: HTMLElement) => string;
-    maskTextFn?: (text: string, element?: HTMLElement) => string;
-    blockClass?: string;
-    blockSelector?: string;
-    ignoreClass?: string;
-    maskTextClass?: string;
-    maskTextSelector?: string;
-    maskAllText?: boolean;
-    slimDOMOptions?: {
-        script?: boolean;
-        comment?: boolean;
-        headFavicon?: boolean;
-        headWhitespace?: boolean;
-        headMetaDescKeywords?: boolean;
-        headMetaSocial?: boolean;
-        headMetaRobots?: boolean;
-        headMetaHttpEquiv?: boolean;
-        headMetaAuthorship?: boolean;
-        headMetaVerification?: boolean;
-    };
-    recordCanvas?: boolean;
-    collectFonts?: boolean;
-    plugins?: any[];
-    sampling?: {
-        mousemove?: boolean | number;
-        mouseInteraction?: boolean | number;
-        scroll?: boolean | number;
-        media?: number;
-        input?: 'all' | 'last';
-    };
-}
-export declare class SessionRecordingRRWeb {
-    private config;
-    private events;
-    private sessionId;
-    private startTime;
-    private isRecording;
-    private stopFn;
-    private recordingOptions;
-    constructor(config?: Partial<SessionRecordingConfig>);
-    private generateSessionId;
-    private setupRecordingOptions;
-    /**
-     * Start recording using RRWeb
-     */
-    start(): void;
-    /**
-     * Stop recording
-     */
-    stop(): void;
-    /**
-     * Get session ID
-     */
-    getSessionId(): string;
-    /**
-     * Get recorded events (RRWeb format)
-     */
-    getEvents(): eventWithTime[];
-    /**
-     * Get recording duration in milliseconds
-     */
-    getDurationMs(): number;
-    /**
-     * Get recording duration in seconds
-     */
-    getDuration(): number;
-    /**
-     * Clear events (for chunked uploads)
-     */
-    clearEvents(): void;
-    /**
-     * Get events since last clear (for incremental uploads)
-     */
-    getEventsSinceLast(count?: number): eventWithTime[];
-    /**
-     * Get recording data for submission (compatible with backend)
-     */
-    getRecordingData(): {
-        events: eventWithTime[];
-        sessionId: string;
-        duration: number;
-    } | null;
-    /**
-     * Check if currently recording
-     */
-    isCurrentlyRecording(): boolean;
-}

package/dist/session-recording.d.ts

@@ -1,74 +0,0 @@
-/**
- * Session Recording Module
- * Captures user interactions for replay
- */
-export interface RecordingEvent {
-    type: 'mouse' | 'scroll' | 'input' | 'mutation' | 'navigation' | 'resize';
-    timestamp: number;
-    data: any;
-}
-export interface SessionRecordingConfig {
-    enabled: boolean;
-    recordMouse: boolean;
-    recordScroll: boolean;
-    recordInput: boolean;
-    recordMutations: boolean;
-    maskInputs: boolean;
-    maskSelectors: string[];
-    maxDurationSeconds: number;
-    sampleRate: number;
-}
-export declare class SessionRecording {
-    private config;
-    private events;
-    private sessionId;
-    private startTime;
-    private isRecording;
-    private mutationObserver;
-    private listeners;
-    constructor(config?: Partial<SessionRecordingConfig>);
-    private generateSessionId;
-    /**
-     * Start recording the session
-     */
-    start(): void;
-    /**
-     * Stop recording
-     */
-    stop(): void;
-    /**
-     * Get session ID
-     */
-    getSessionId(): string;
-    /**
-     * Get recorded events
-     */
-    getEvents(): RecordingEvent[];
-    /**
-     * Get recording duration in seconds
-     */
-    getDuration(): number;
-    /**
-     * Clear events (for chunked uploads)
-     */
-    clearEvents(): void;
-    /**
-     * Get recording data for submission
-     */
-    getRecordingData(): {
-        events: RecordingEvent[];
-        sessionId: string;
-        duration: number;
-    } | null;
-    private addEvent;
-    private recordSnapshot;
-    private setupMouseTracking;
-    private setupScrollTracking;
-    private setupInputTracking;
-    private setupMutationObserver;
-    private setupNavigationTracking;
-    private setupResizeTracking;
-    private getElementSelector;
-    private isSensitiveElement;
-    private sanitizeHTML;
-}