@snf/access-qa-bot 0.3.1 → 1.1.0-rc.1

package/index.d.ts

@@ -1,17 +1,31 @@
 interface QABotProps {
-  isLoggedIn?: boolean;
-  isOpen?: boolean;
   apiKey?: string;
+  /** Whether the chat window is open by default (floating mode only, ignored for embedded) */
+  defaultOpen?: boolean;
+  disabled?: boolean;
+  /** Whether the bot is embedded in the page (always open when embedded) */
   embedded?: boolean;
-  welcome?: string;
+  isLoggedIn?: boolean;
+  loginUrl?: string;
   prompt?: string;
-  disabled?: boolean;
-  onClose?: () => void;
+  welcome?: string;
   [key: string]: any; // Allow additional props
 }
 
+// Note: To control the chat window externally, use the useChatWindow hook from react-chatbotify:
+// import { useChatWindow } from 'react-chatbotify';
+// const { toggleChatWindow } = useChatWindow();
+
 // React component
-export const QABot: (props: QABotProps) => JSX.Element;
+export const QABot: React.ForwardRefExoticComponent<
+  QABotProps & React.RefAttributes<{
+    addMessage: (message: string) => void;
+    setBotIsLoggedIn: (status: boolean) => void;
+    openChat: () => void;
+    closeChat: () => void;
+    toggleChat: () => void;
+  }>
+>;
 
 // Web Component class (available in the standalone build)
 export class WebComponentQABot extends HTMLElement {
@@ -22,15 +36,22 @@ export class WebComponentQABot extends HTMLElement {
 }
 
 // Function for non-React integration
-interface QAndAToolConfig extends QABotProps {
+interface AccessQABotConfig extends QABotProps {
   target: HTMLElement;
 }
 
 // Main function for programmatic usage (works with React or Web Component)
-export function qAndATool(config: QAndAToolConfig): () => void;
+export function accessQABot(config: AccessQABotConfig): {
+  addMessage: (message: string) => void;
+  setBotIsLoggedIn: (status: boolean) => void;
+  openChat: () => void;
+  closeChat: () => void;
+  toggleChat: () => void;
+  destroy: () => void;
+};
 
 // Web Component specific function (exposed in the standalone bundle)
-export function webComponentQAndATool(config: QAndAToolConfig): () => void;
+export function webComponentAccessQABot(config: AccessQABotConfig): () => void;
 
 // Default export (React component)
 export default QABot;
@@ -43,9 +64,9 @@ declare global {
 
   // Global object for standalone usage
   interface Window {
-    accessQABot?: {
-      WebComponentQABot: typeof WebComponentQABot;
-      qAndATool: typeof webComponentQAndATool;
-    }
+    accessQABot?: typeof webComponentAccessQABot;
   }
+
+  // Global function available without window prefix
+  var accessQABot: typeof webComponentAccessQABot;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snf/access-qa-bot",
-  "version": "0.3.1",
+  "version": "1.1.0-rc.1",
   "private": false,
   "homepage": ".",
   "description": "ACCESS Q&A Bot React Component and Web Component",
@@ -21,7 +21,7 @@
     "index.d.ts"
   ],
   "dependencies": {
-    "react-chatbotify": "^2.0.0-beta.32"
+    "react-chatbotify": "^2.0.0-beta.38"
   },
   "peerDependencies": {
     "preact": "^10.0.0",