@chatwidgetai/chat-widget 0.1.5 → 0.1.6

package/README.md

@@ -12,6 +12,7 @@ Embeddable AI assistant widget for React applications. The package wraps the AI
 - **Agent support** – seamlessly handles widgets with custom actions and follow-up approvals.
 - **Hook-first API** for building bespoke chat surfaces while reusing the data flows.
 - **Browser friendly** UMD bundle (`window.AIChatWidget.mount`) for non-React hosts.
+- **No API key required** – widget ID acts as the access token for simplified integration.
 
 ---
 
@@ -40,7 +41,6 @@ export function SupportChat() {
   return (
     <ChatWidget
       widgetId="64f6e3e4d12b4a9c8f3c1234"
-      apiKey="sk_live_example-key"
       apiUrl="https://api.my-rag-backend.com"
       position="bottom-right"
       theme="auto"
@@ -51,7 +51,9 @@ export function SupportChat() {
 }
 ```
 
-The widget automatically pulls its configuration (branding, behavior, suggestions, etc.) from your backend. Only `widgetId` and `apiKey` are required; `apiUrl` defaults to `window.location.origin`.
+The widget automatically pulls its configuration (branding, behavior, suggestions, etc.) from your backend. Only `widgetId` is required; `apiUrl` defaults to `window.location.origin`.
+
+> **Security Note**: Keep your Widget ID confidential. It acts as the access token for your widget and should not be exposed in public repositories.
 
 ---
 
@@ -59,15 +61,14 @@ The widget automatically pulls its configuration (branding, behavior, suggestion
 
 | Prop           | Type                                                            | Required | Description                                                                                      |
 | -------------- | --------------------------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------ |
-| `widgetId`     | `string`                                                        | ✅       | Widget identifier created in the AI Console.                                                     |
-| `apiKey`       | `string`                                                        | ✅       | Public API key with `widget:*` access.                                                           |
+| `widgetId`     | `string`                                                        | ✅       | Widget identifier created in the AI Console. Keep this confidential.                             |
 | `apiUrl`       | `string`                                                        | ❌       | Base URL of your widget API. Defaults to `window.location.origin`.                               |
 | `position`     | `'bottom-right' \| 'bottom-left' \| 'top-right' \| 'top-left'`  | ❌       | Launcher position (overridden by backend appearance settings).                                   |
 | `theme`        | `'light' \| 'dark' \| 'auto'`                                   | ❌       | Force a theme instead of the configured one.                                                     |
 | `primaryColor` | `string`                                                        | ❌       | Override the accent color (CSS color string).                                                    |
 | `onOpen`       | `() => void`                                                    | ❌       | Fired when the chat window opens.                                                                |
 | `onClose`      | `() => void`                                                    | ❌       | Fired when the chat window closes.                                                               |
-| `onMessage`    | `(message: ConversationMessage) => void`                        | ❌       | Called for every new message, including the user’s own messages.                                 |
+| `onMessage`    | `(message: ConversationMessage) => void`                        | ❌       | Called for every new message, including the user's own messages.                                 |
 | `onError`      | `(error: Error) => void`                                        | ❌       | Called when an API error or transport failure occurs.                                            |
 
 ---
@@ -77,7 +78,7 @@ The widget automatically pulls its configuration (branding, behavior, suggestion
 ```tsx
 import { useChat } from '@chatwidgetai/chat-widget';
 
-export function CustomChat({ widgetId, apiKey }: { widgetId: string; apiKey: string }) {
+export function CustomChat({ widgetId }: { widgetId: string }) {
   const {
     messages,
     isLoading,
@@ -90,7 +91,6 @@ export function CustomChat({ widgetId, apiKey }: { widgetId: string; apiKey: str
     submitFeedback,
   } = useChat({
     widgetId,
-    apiKey,
     apiUrl: 'https://api.my-rag-backend.com',
   });
 
@@ -111,7 +111,6 @@ A bundled UMD build is published as `dist/ai-chat-widget.umd.js`. After includin
 <script>
   window.AIChatWidget.mount({
     widgetId: '64f6e3e4d12b4a9c8f3c1234',
-    apiKey: 'sk_live_example-key',
     apiUrl: 'https://api.my-rag-backend.com',
     position: 'bottom-right',
     theme: 'auto',