@checkflow/sdk 1.1.1 → 1.1.3

package/dist/index.d.mts

@@ -0,0 +1,46 @@
+import { C as CheckflowConfig, F as FeedbackPayload, H as HighlightAnnotation, a as FeedbackResponse } from './highlighter-Dx2zURb6.mjs';
+export { W as WidgetConfig, s as startHighlighting } from './highlighter-Dx2zURb6.mjs';
+
+/**
+ * Screenshot capture using the browser's native getDisplayMedia API.
+ * This prompts the user for permission to capture their tab/screen,
+ * producing a real screenshot of the visible page.
+ */
+/**
+ * Capture a screenshot using getDisplayMedia (browser permission dialog).
+ * Returns a base64 data URL of the captured image, or null on failure/cancel.
+ */
+declare function captureScreenshot(): Promise<string | null>;
+
+/**
+ * Initialize the Checkflow SDK.
+ *
+ * @example
+ * ```js
+ * import { init } from '@checkflow/sdk';
+ * init({ apiKey: 'ck_live_...', widget: { position: 'bottom-right' } });
+ * ```
+ */
+declare function init(cfg: CheckflowConfig): void;
+/**
+ * Send feedback programmatically.
+ */
+declare function sendFeedback(data: Pick<FeedbackPayload, 'title' | 'description' | 'type' | 'priority' | 'screenshot_url' | 'reporter_name' | 'reporter_email'> & {
+    screenshot_data?: string;
+    annotations?: HighlightAnnotation[];
+}): Promise<FeedbackResponse>;
+
+/**
+ * Show the feedback widget.
+ */
+declare function showWidget(): void;
+/**
+ * Hide and remove the feedback widget.
+ */
+declare function hideWidget(): void;
+/**
+ * Destroy the SDK instance.
+ */
+declare function destroy(): void;
+
+export { CheckflowConfig, FeedbackPayload, FeedbackResponse, HighlightAnnotation, captureScreenshot, destroy, hideWidget, init, sendFeedback, showWidget };

package/dist/index.d.ts

@@ -1,23 +1,46 @@
+import { C as CheckflowConfig, F as FeedbackPayload, H as HighlightAnnotation, a as FeedbackResponse } from './highlighter-Dx2zURb6.js';
+export { W as WidgetConfig, s as startHighlighting } from './highlighter-Dx2zURb6.js';
+
 /**
- * CheckFlow SDK
- * User feedback collection with automatic context capture
+ * Screenshot capture using the browser's native getDisplayMedia API.
+ * This prompts the user for permission to capture their tab/screen,
+ * producing a real screenshot of the visible page.
+ */
+/**
+ * Capture a screenshot using getDisplayMedia (browser permission dialog).
+ * Returns a base64 data URL of the captured image, or null on failure/cancel.
+ */
+declare function captureScreenshot(): Promise<string | null>;
+
+/**
+ * Initialize the Checkflow SDK.
  *
- * @packageDocumentation
+ * @example
+ * ```js
+ * import { init } from '@checkflow/sdk';
+ * init({ apiKey: 'ck_live_...', widget: { position: 'bottom-right' } });
+ * ```
+ */
+declare function init(cfg: CheckflowConfig): void;
+/**
+ * Send feedback programmatically.
+ */
+declare function sendFeedback(data: Pick<FeedbackPayload, 'title' | 'description' | 'type' | 'priority' | 'screenshot_url' | 'reporter_name' | 'reporter_email'> & {
+    screenshot_data?: string;
+    annotations?: HighlightAnnotation[];
+}): Promise<FeedbackResponse>;
+
+/**
+ * Show the feedback widget.
+ */
+declare function showWidget(): void;
+/**
+ * Hide and remove the feedback widget.
+ */
+declare function hideWidget(): void;
+/**
+ * Destroy the SDK instance.
  */
-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;
+declare function destroy(): void;
+
+export { CheckflowConfig, FeedbackPayload, FeedbackResponse, HighlightAnnotation, captureScreenshot, destroy, hideWidget, init, sendFeedback, showWidget };