@checkflow/sdk 1.1.3 → 1.1.5

package/dist/react.d.ts

@@ -1,10 +1,27 @@
-import { a as FeedbackResponse, H as HighlightAnnotation, C as CheckflowConfig } from './highlighter-Dx2zURb6.js';
+import { H as HighlightAnnotation } from './highlighter-D0FpwCSU.js';
+import { B as ButtonConfig, U as UserProfile, a as FeedbackResponse, C as CheckflowConfig } from './types-fCeePy5c.js';
 
 /**
  * Initialize Checkflow in a React/Next.js app.
  * Call this in your root layout or _app file.
+ *
+ * @param config - SDK configuration including apiKey, user profile, and widget options
  */
 declare function useCheckflowInit(config: CheckflowConfig): void;
+/**
+ * Update the user profile after initialization.
+ * Useful when user logs in/out.
+ */
+declare function setUser(user: UserProfile | undefined): Promise<void>;
+/**
+ * Clear the user profile.
+ */
+declare function clearUser(): Promise<void>;
+/**
+ * Open the feedback modal programmatically.
+ * Use this when you want to trigger the modal from a custom button.
+ */
+declare function openFeedbackModal(): Promise<void>;
 /**
  * Hook to send feedback programmatically from React components.
  */
@@ -19,10 +36,39 @@ declare function useCheckflowFeedback(): {
     highlight: () => Promise<HighlightAnnotation[]>;
     show: () => Promise<void>;
     hide: () => Promise<void>;
+    openModal: typeof openFeedbackModal;
+    setUser: typeof setUser;
+    clearUser: typeof clearUser;
 };
 /**
  * Cleanup function for React useEffect.
  */
 declare function destroyCheckflow(): void;
+/**
+ * Props for the FeedbackButton component.
+ * All button styling can be customized via className, style, or button config.
+ */
+interface FeedbackButtonProps {
+    /** Button text content */
+    children?: string;
+    /** Custom CSS class */
+    className?: string;
+    /** Inline styles */
+    style?: Record<string, string | number>;
+    /** Button configuration for SDK styling */
+    buttonConfig?: ButtonConfig;
+    /** Click handler (called before opening modal) */
+    onClick?: () => void;
+}
+/**
+ * Get the onClick handler for a feedback button.
+ * Use this to create your own custom button that opens the feedback modal.
+ *
+ * @example
+ * ```tsx
+ * <button onClick={getFeedbackButtonHandler()}>Report Bug</button>
+ * ```
+ */
+declare function getFeedbackButtonHandler(onClick?: () => void): () => void;
 
-export { destroyCheckflow, useCheckflowFeedback, useCheckflowInit };
+export { type FeedbackButtonProps, clearUser, destroyCheckflow, getFeedbackButtonHandler, openFeedbackModal, setUser, useCheckflowFeedback, useCheckflowInit };