@personaliai/react-widget 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -1,28 +1,84 @@
-import * as react from 'react';
-
-interface ChatWidgetCoreProps {
+interface ChattyWidgetProps {
+    /**
+     * Your bot's unique UUID from the Chatty dashboard.
+     */
     botId: string;
-    originToken: string | null;
-    isPreview?: boolean;
-    paramColor?: string | null;
-    paramStyle?: string | null;
-    paramName?: string | null;
-    paramWelcome?: string | null;
-    paramAvatarIcon?: string | null;
-    paramAvatarUrl?: string | null;
-    paramLogoUrl?: string | null;
-    paramLogoBgColor?: string | null;
-    paramShowSenderTag?: string | null;
-    paramCsatEnabled?: string | null;
-    paramColorScheme?: string | null;
-    onWidgetReady?: () => void;
-    onWidgetClose?: () => void;
-    onAssistantMessage?: () => void;
-    onRequestNotificationPermission?: (botName: string, avatarUrl?: string | null) => void;
-    onTriggerNotification?: (botName: string, bodyText: string, avatarUrl?: string | null) => void;
-    forceFullscreen?: boolean;
-    notificationGranted?: boolean;
+    /**
+     * Host URL for widget.js (defaults to "https://chatty.personaliai.com/widget.js").
+     */
+    widgetUrl?: string;
+    /**
+     * Corner anchor for the launcher button ("right" | "left"). Defaults to "right".
+     */
+    position?: "right" | "left";
+    /**
+     * Hex color override for launcher button (e.g. "#4F46E5").
+     */
+    color?: string;
+    /**
+     * Widget visual style preset ("minimal", "playful", "corporate", etc.).
+     */
+    style?: string;
+    /**
+     * Whether to preserve desktop floating panel layout on mobile (defaults to true).
+     */
+    mobileFullscreen?: boolean;
+    /**
+     * Whether to display the proactive greeting teaser bubble (defaults to true).
+     */
+    teaser?: boolean;
+    /**
+     * Whether to play notification audio chimes on new AI replies (defaults to true).
+     */
+    sound?: boolean;
+}
+interface ChattyAPI {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+}
+declare global {
+    interface Window {
+        Chatty?: ChattyAPI;
+        __chattyWidgetLoaded?: boolean;
+        CHATTY_BOT_ID?: string;
+    }
 }
-declare function ChatWidgetCore({ botId, originToken, isPreview, paramColor, paramStyle, paramName, paramWelcome, paramAvatarIcon, paramAvatarUrl, paramLogoUrl, paramLogoBgColor, paramShowSenderTag, paramCsatEnabled, paramColorScheme, onWidgetReady, onWidgetClose, onAssistantMessage, onRequestNotificationPermission, onTriggerNotification, forceFullscreen, notificationGranted, }: ChatWidgetCoreProps): react.JSX.Element;
+/**
+ * Official React component for Chatty.
+ *
+ * Mounts the Chatty AI chat assistant into your application using the lightweight
+ * script method into an isolated Shadow DOM container.
+ *
+ * @example
+ * ```tsx
+ * import { ChattyWidget } from "@personaliai/react-widget";
+ *
+ * export default function App() {
+ *   return <ChattyWidget botId="your-bot-uuid" position="right" color="#4F46E5" />;
+ * }
+ * ```
+ */
+declare function ChattyWidget({ botId, widgetUrl, position, color, style, mobileFullscreen, teaser, sound, }: ChattyWidgetProps): null;
+declare const ChatWidget: typeof ChattyWidget;
+type ChatWidgetProps = ChattyWidgetProps;
+/**
+ * Hook to programmatically open, close, or toggle the Chatty chat drawer.
+ *
+ * @example
+ * ```tsx
+ * import { useChatty } from "@personaliai/react-widget";
+ *
+ * export function HelpButton() {
+ *   const { open, close, toggle } = useChatty();
+ *   return <button onClick={open}>Chat with Support</button>;
+ * }
+ * ```
+ */
+declare function useChatty(): {
+    open: () => void;
+    close: () => void;
+    toggle: () => void;
+};
 
-export { ChatWidgetCore as ChattyWidget, type ChatWidgetCoreProps as ChattyWidgetProps };
+export { ChatWidget, type ChatWidgetProps, type ChattyAPI, ChattyWidget, type ChattyWidgetProps, ChattyWidget as default, useChatty };