@intentai/react 2.1.2 → 2.3.0

package/dist/index.d.mts

@@ -1,130 +1,379 @@
-import React from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React$1 from 'react';
 
-interface WidgetConfig {
-    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-    primaryColor?: string;
-    accentColor?: string;
-    theme?: 'light' | 'dark' | 'auto';
-    categories?: Category[];
-    allowVoice?: boolean;
-    allowText?: boolean;
-    allowScreenshot?: boolean;
-    maxRecordingDuration?: number;
-    onSubmit?: (feedback: FeedbackData) => Promise<void>;
-    onOpen?: () => void;
-    onClose?: () => void;
-}
-interface Category {
+/**
+ * User identity for feedback attribution
+ */
+interface UserIdentity {
+    /** Unique user identifier */
     id: string;
-    label: string;
-    icon: string;
+    /** User email address */
+    email?: string;
+    /** User display name */
+    name?: string;
+    /** User avatar URL */
+    avatar?: string;
+    /** Subscription plan */
+    plan?: string;
+    /** Company name */
+    company?: string;
+    /** Custom properties */
+    [key: string]: string | number | boolean | undefined;
 }
+/**
+ * Widget position on screen
+ */
+type WidgetPosition = 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+/**
+ * Widget color theme
+ */
+type WidgetTheme = 'light' | 'dark' | 'auto';
+/**
+ * Feedback type categories
+ */
+type FeedbackType = 'bug' | 'feature' | 'question' | 'praise' | 'other';
+/**
+ * Sentiment analysis result
+ */
+type Sentiment = 'positive' | 'neutral' | 'negative';
+/**
+ * Data returned when feedback is submitted
+ */
 interface FeedbackData {
-    type: 'voice' | 'text';
+    /** Feedback ID */
+    id: string;
+    /** Type of feedback */
+    type: FeedbackType;
+    /** Text content */
     content: string;
-    audioBlob?: Blob;
-    transcription?: string;
-    category: string;
+    /** Voice recording URL */
+    voiceUrl?: string;
+    /** Screenshot data URL */
     screenshot?: string;
-    sentiment?: string;
-    metadata?: Record<string, unknown>;
+    /** AI-analyzed sentiment */
+    sentiment?: Sentiment;
+    /** Submission timestamp */
+    createdAt: string;
 }
-declare const PremiumVoiceWidget: React.FC<WidgetConfig>;
-
-interface IntentAIUser {
-    id?: string;
-    email?: string;
-    name?: string;
+/**
+ * Options for opening the widget
+ */
+interface OpenOptions {
+    /** Pre-select feedback type */
+    type?: FeedbackType;
+    /** Prefill text content */
+    prefill?: {
+        text?: string;
+    };
+    /** Additional metadata for this feedback */
+    metadata?: Record<string, unknown>;
 }
+/**
+ * Configuration options for the Intent AI widget
+ */
 interface IntentAIConfig {
-    /** Your Intent AI API key (required) */
-    apiKey: string;
-    /** API URL for feedback submission (required for production) */
-    apiUrl: string;
-    /** Widget script URL (required for production) */
-    widgetUrl: string;
-    /** Widget position on screen */
-    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
-    /** Widget theme */
-    theme?: 'light' | 'dark';
-    /** Primary color for the widget */
+    /**
+     * Your Intent AI public key (pk_live_* or pk_test_*)
+     * Can also be set via environment variables:
+     * - NEXT_PUBLIC_INTENT_AI_KEY
+     * - REACT_APP_INTENT_AI_KEY
+     * - VITE_INTENT_AI_KEY
+     */
+    apiKey?: string;
+    /**
+     * Widget position on screen
+     * @default "bottom-right"
+     */
+    position?: WidgetPosition;
+    /**
+     * Color theme
+     * @default "auto"
+     */
+    theme?: WidgetTheme;
+    /**
+     * Primary brand color (hex)
+     * @default "#6366f1"
+     */
     primaryColor?: string;
-    /** Enable/disable voice feedback */
-    allowVoice?: boolean;
-    /** Enable/disable text feedback */
-    allowText?: boolean;
-    /** Enable/disable screenshot capture */
-    allowScreenshot?: boolean;
-    /** Custom metadata to attach to feedback */
-    customMetadata?: Record<string, any>;
-    /** User information */
-    user?: IntentAIUser;
-}
-interface IntentAIProps extends IntentAIConfig {
-    /** Called when widget is opened */
+    /**
+     * Show widget button automatically
+     * @default true
+     */
+    autoShow?: boolean;
+    /**
+     * Initial user identification
+     */
+    user?: UserIdentity;
+    /**
+     * Custom metadata attached to all feedback
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Callback when widget is ready
+     */
+    onReady?: () => void;
+    /**
+     * Callback when widget opens
+     */
     onOpen?: () => void;
-    /** Called when widget is closed */
+    /**
+     * Callback when widget closes
+     */
     onClose?: () => void;
-    /** Called when feedback is submitted successfully */
-    onFeedbackSubmitted?: () => void;
-    /** Called when there's an error */
+    /**
+     * Callback when feedback is submitted
+     */
+    onSubmit?: (feedback: FeedbackData) => void;
+    /**
+     * Callback when an error occurs
+     */
     onError?: (error: Error) => void;
 }
-interface FeedbackIQInstance {
-    open: () => void;
+/**
+ * Props for IntentAIProvider component
+ */
+interface IntentAIProviderProps extends IntentAIConfig {
+    children: React.ReactNode;
+}
+/**
+ * Context value for IntentAI provider
+ */
+interface IntentAIContextValue {
+    /** Whether the widget is loaded and ready */
+    isReady: boolean;
+    /** Error if widget failed to load */
+    error: Error | null;
+    /** Open the feedback widget */
+    open: (options?: OpenOptions) => void;
+    /** Close the feedback widget */
     close: () => void;
-    identify: (user: IntentAIUser) => void;
-    setMetadata: (metadata: Record<string, any>) => void;
+    /** Identify a user */
+    identify: (user: UserIdentity) => void;
+    /** Track a custom event */
+    track: (event: string, properties?: Record<string, unknown>) => void;
+    /** Set custom metadata */
+    setMetadata: (metadata: Record<string, unknown>) => void;
+}
+/**
+ * Intent AI widget instance methods
+ */
+interface IntentAIInstance {
+    open: (options?: OpenOptions) => void;
+    close: () => void;
+    identify: (user: UserIdentity) => void;
+    track: (event: string, properties?: Record<string, unknown>) => void;
+    setMetadata: (metadata: Record<string, unknown>) => void;
     destroy: () => void;
 }
+/**
+ * Window augmentation for Intent AI global
+ */
 declare global {
     interface Window {
-        FeedbackIQ: new (config: IntentAIConfig) => FeedbackIQInstance;
+        IntentAI?: IntentAIInstance;
+        IntentAIConfig?: IntentAIConfig;
+    }
+    interface WindowEventMap {
+        'intentai:ready': CustomEvent;
+        'intentai:open': CustomEvent;
+        'intentai:close': CustomEvent;
+        'intentai:submit': CustomEvent<FeedbackData>;
+        'intentai:error': CustomEvent<Error>;
     }
 }
+
 /**
- * Intent AI Feedback Widget for React
+ * Provider component for Intent AI widget
  *
  * @example
  * ```tsx
- * import { IntentAIWidget } from '@intent-ai/react';
+ * import { IntentAIProvider } from '@intentai/react';
  *
  * function App() {
  *   return (
- *     <IntentAIWidget
- *       apiKey="your-api-key"
- *       position="bottom-right"
- *       theme="dark"
- *     />
+ *     <IntentAIProvider apiKey="pk_live_xxxxx">
+ *       <YourApp />
+ *     </IntentAIProvider>
+ *   );
+ * }
+ * ```
+ */
+declare function IntentAIProvider({ children, apiKey, user, position, theme, primaryColor, autoShow, metadata, onReady, onOpen, onClose, onSubmit, onError, }: IntentAIProviderProps): react_jsx_runtime.JSX.Element;
+/**
+ * Hook to access Intent AI widget controls
+ *
+ * @example
+ * ```tsx
+ * import { useIntentAI } from '@intentai/react';
+ *
+ * function FeedbackButton() {
+ *   const { open, isReady } = useIntentAI();
+ *
+ *   return (
+ *     <button onClick={() => open()} disabled={!isReady}>
+ *       Give Feedback
+ *     </button>
  *   );
  * }
  * ```
  */
-declare function IntentAIWidget({ apiKey, apiUrl, widgetUrl, position, theme, primaryColor, allowVoice, allowText, allowScreenshot, customMetadata, user, onOpen: _onOpen, onClose: _onClose, onFeedbackSubmitted: _onFeedbackSubmitted, onError, }: IntentAIProps): null;
+declare function useIntentAI(): IntentAIContextValue;
 /**
- * Hook to control the Intent AI widget programmatically
+ * Hook to automatically identify a user when they're available
  *
  * @example
  * ```tsx
- * import { IntentAIWidget, useIntentAI } from '@intent-ai/react';
+ * import { useIdentify } from '@intentai/react';
+ *
+ * function Profile({ user }) {
+ *   useIdentify(user ? { id: user.id, email: user.email } : null);
+ *   return <div>...</div>;
+ * }
+ * ```
+ */
+declare function useIdentify(user: UserIdentity | null | undefined): void;
+
+/**
+ * Props for FeedbackButton component
+ */
+interface FeedbackButtonProps extends React$1.ButtonHTMLAttributes<HTMLButtonElement> {
+    /** Options to pass when opening the widget */
+    openOptions?: OpenOptions;
+    /** Custom children to render */
+    children?: React$1.ReactNode;
+}
+/**
+ * Pre-built button component to open the feedback widget
+ *
+ * @example
+ * ```tsx
+ * import { FeedbackButton } from '@intentai/react';
  *
  * function App() {
- *   const { open, close, identify } = useIntentAI();
+ *   return (
+ *     <FeedbackButton className="my-custom-class">
+ *       Send Feedback
+ *     </FeedbackButton>
+ *   );
+ * }
+ * ```
+ */
+declare const FeedbackButton: React$1.ForwardRefExoticComponent<FeedbackButtonProps & React$1.RefAttributes<HTMLButtonElement>>;
+/**
+ * Props for FeedbackTrigger component
+ */
+interface FeedbackTriggerProps {
+    /** Render function or element */
+    children: React$1.ReactElement | ((props: {
+        open: (options?: OpenOptions) => void;
+        isReady: boolean;
+        error: Error | null;
+    }) => React$1.ReactElement);
+    /** Options to pass when opening */
+    openOptions?: OpenOptions;
+}
+/**
+ * Headless component for custom feedback triggers
  *
+ * @example
+ * ```tsx
+ * import { FeedbackTrigger } from '@intentai/react';
+ *
+ * function App() {
  *   return (
- *     <>
- *       <IntentAIWidget apiKey="your-api-key" />
- *       <button onClick={open}>Open Feedback</button>
- *     </>
+ *     <FeedbackTrigger>
+ *       {({ open, isReady }) => (
+ *         <MyCustomButton onClick={() => open()} disabled={!isReady}>
+ *           Feedback
+ *         </MyCustomButton>
+ *       )}
+ *     </FeedbackTrigger>
  *   );
  * }
  * ```
  */
-declare function useIntentAI(): {
-    open: () => void;
-    close: () => void;
-    identify: (user: IntentAIUser) => void;
-    setMetadata: (metadata: Record<string, any>) => void;
-};
+declare function FeedbackTrigger({ children, openOptions }: FeedbackTriggerProps): React$1.ReactElement<any, string | React$1.JSXElementConstructor<any>>;
+/**
+ * Props for IdentifyUser component
+ */
+interface IdentifyUserProps {
+    /** User to identify */
+    user: UserIdentity | null | undefined;
+    /** Children to render */
+    children?: React$1.ReactNode;
+}
+/**
+ * Component to identify a user declaratively
+ *
+ * @example
+ * ```tsx
+ * import { IdentifyUser } from '@intentai/react';
+ *
+ * function App({ user }) {
+ *   return (
+ *     <IdentifyUser user={user ? { id: user.id, email: user.email } : null}>
+ *       <YourApp />
+ *     </IdentifyUser>
+ *   );
+ * }
+ * ```
+ */
+declare function IdentifyUser({ user, children }: IdentifyUserProps): react_jsx_runtime.JSX.Element;
+/**
+ * Props for SetMetadata component
+ */
+interface SetMetadataProps {
+    /** Metadata to set */
+    metadata: Record<string, unknown>;
+    /** Children to render */
+    children?: React$1.ReactNode;
+}
+/**
+ * Component to set metadata declaratively
+ *
+ * @example
+ * ```tsx
+ * import { SetMetadata } from '@intentai/react';
+ *
+ * function PricingPage() {
+ *   return (
+ *     <SetMetadata metadata={{ page: 'pricing', plan: 'pro' }}>
+ *       <PricingContent />
+ *     </SetMetadata>
+ *   );
+ * }
+ * ```
+ */
+declare function SetMetadata({ metadata, children }: SetMetadataProps): react_jsx_runtime.JSX.Element;
+/**
+ * Props for TrackEvent component
+ */
+interface TrackEventProps {
+    /** Event name to track */
+    event: string;
+    /** Event properties */
+    properties?: Record<string, unknown>;
+    /** When to track: 'mount' (default) or 'render' */
+    trigger?: 'mount' | 'render';
+    /** Children to render */
+    children?: React$1.ReactNode;
+}
+/**
+ * Component to track events declaratively
+ *
+ * @example
+ * ```tsx
+ * import { TrackEvent } from '@intentai/react';
+ *
+ * function CheckoutPage() {
+ *   return (
+ *     <TrackEvent event="checkout_viewed" properties={{ items: 3 }}>
+ *       <CheckoutContent />
+ *     </TrackEvent>
+ *   );
+ * }
+ * ```
+ */
+declare function TrackEvent({ event, properties, trigger, children, }: TrackEventProps): react_jsx_runtime.JSX.Element;
 
-export { type IntentAIConfig, type IntentAIProps, type IntentAIUser, IntentAIWidget, PremiumVoiceWidget, type WidgetConfig as PremiumWidgetConfig, IntentAIWidget as default, useIntentAI };
+export { FeedbackButton, type FeedbackButtonProps, type FeedbackData, FeedbackTrigger, type FeedbackTriggerProps, type FeedbackType, IdentifyUser, type IdentifyUserProps, type IntentAIConfig, type IntentAIContextValue, type IntentAIInstance, IntentAIProvider, type IntentAIProviderProps, type OpenOptions, type Sentiment, SetMetadata, type SetMetadataProps, TrackEvent, type TrackEventProps, type UserIdentity, type WidgetPosition, type WidgetTheme, useIdentify, useIntentAI };