@verba-ai/chat-sdk 1.0.5 → 1.0.6

package/README.md

@@ -11,30 +11,33 @@ The SDK acts as a secure, high-performance orchestration layer that manages the
 The easiest way to integrate the chat. It creates a fixed-position action button in the bottom corner of your screen that toggles the chat window.
 
 ```typescript
-import { ChatSDK } from "@verba-ai/chat-sdk";
+import { ChatSDK } from '@verba-ai/chat-sdk'
 
 const chat = new ChatSDK({
-  // Required: Your unique Verba tenant ID
-  tenant: "your-tenant-id",
-
-  // Optional
-  theme: {
-    primaryColor: "#6366f1",
-    backgroundColor: "#080b14",
-    textColor: "#f1f5f9",
-  },
-
-  // Optional: Configuration for the floating bubble
-  bubble: {
-    position: "bottom-right",
-    color: "#8b5cf6", // custom background gradient/color
-    size: 56, // size in pixels
-    icon: "<link>", // src to <img> tag
-  },
-});
+    // Required: Your unique Verba tagId
+    tagId: 'your-tag-id',
+
+    // Optional
+    theme: {
+        primaryColor: '#6366f1',
+        backgroundColor: '#080b14',
+        textColor: '#f1f5f9',
+    },
+
+    // You can also our default theme presets
+    // theme: 'light' | 'dark',
+
+    // Optional: Configuration for the floating bubble
+    bubble: {
+        position: 'bottom-right',
+        color: '#8b5cf6', // custom background gradient/color
+        size: 56, // size in pixels
+        icon: '<link>', // src to <img> tag
+    },
+})
 
 // Inject the bubble into the DOM
-chat.init();
+chat.init()
 
 // Optional programmatic controls
 // chat.show();
@@ -47,26 +50,26 @@ chat.init();
 If you want to render the chat inside a specific part of your page (like a dashboard panel or a dedicated contact page).
 
 ```typescript
-import { ChatSDK } from "@verba-ai/chat-sdk";
+import { ChatSDK } from '@verba-ai/chat-sdk'
 
 // Ensure the container exists in your DOM
 // <div id="my-chat-container" style="height: 600px;"></div>
 
 const chat = new ChatSDK({
-  tenant: "your-tenant-id",
+    tagId: 'your-tag-id',
 
-  // Target a CSS selector or pass an HTMLElement directly
-  container: "#my-chat-container",
+    // Target a CSS selector or pass an HTMLElement directly
+    container: '#my-chat-container',
 
-  // Optional: Advanced visual theming
-  theme: {
-    primaryColor: "#6366f1",
-    backgroundColor: "#080b14",
-    textColor: "#f1f5f9",
-  },
-});
+    // Optional: Advanced visual theming
+    theme: {
+        primaryColor: '#6366f1',
+        backgroundColor: '#080b14',
+        textColor: '#f1f5f9',
+    },
+})
 
-chat.init();
+chat.init()
 ```
 
 ### 3. Usage via CDN (UMD)
@@ -76,9 +79,9 @@ If you aren't using a bundler (Webpack/Vite/Rollup), you can load the SDK direct
 ```html
 <script src="https://unpkg.com/@verba-ai/chat-sdk@latest/dist/chat-sdk.umd.cjs"></script>
 <script>
-  const { ChatSDK } = window.VerbaChatSDK;
+    const { ChatSDK } = window.VerbaChatSDK
 
-  new ChatSDK({ tenant: "your-tenant-id" }).init();
+    new ChatSDK({ tagId: 'your-tag-id' }).init()
 </script>
 ```
 
@@ -107,17 +110,17 @@ The main entry point for the widget.
 
 ```typescript
 interface ChatSDKConfig {
-  /** Your Verba tenant ID (Required) */
-  tenant: string;
+    /** Your Verba tag ID (Required) */
+    tagId: string
 
-  /** Where to mount the widget. Omit for floating bubble. */
-  container?: string | HTMLElement;
+    /** Where to mount the widget. Omit for floating bubble. */
+    container?: string | HTMLElement
 
-  /** Visual theme. String preset or detailed config. */
-  theme?: "light" | "dark" | ThemeConfig;
+    /** Visual theme. String preset or detailed config. */
+    theme?: 'light' | 'dark' | ThemeConfig
 
-  /** Configuration for the floating bubble. */
-  bubble?: ChatBubbleConfig;
+    /** Configuration for the floating bubble. */
+    bubble?: ChatBubbleConfig
 }
 ```
 
@@ -125,20 +128,20 @@ interface ChatSDKConfig {
 
 ```typescript
 interface ChatBubbleConfig {
-  /** Corner position of the floating bubble (Default: 'bottom-right') */
-  position?: "bottom-right" | "bottom-left";
+    /** Corner position of the floating bubble (Default: 'bottom-right') */
+    position?: 'bottom-right' | 'bottom-left'
 
-  /** Background color of the bubble (Default: '#ffffff') */
-  color?: string;
+    /** Background color of the bubble (Default: '#ffffff') */
+    color?: string
 
-  /** Size of the bubble in pixels (Default: 56) */
-  size?: number;
+    /** Size of the bubble in pixels (Default: 56) */
+    size?: number
 
-  /** SVG string for a custom open (chat) icon */
-  icon?: string;
+    /** SVG string for a custom open (chat) icon */
+    icon?: string
 
-  /** Color of the close (X) icon (Default: '#ffffff') */
-  closeIconColor?: string;
+    /** Color of the close (X) icon (Default: '#ffffff') */
+    closeIconColor?: string
 }
 ```
 
@@ -146,9 +149,9 @@ interface ChatBubbleConfig {
 
 ```typescript
 interface ThemeConfig {
-  primaryColor?: string;
-  textColor?: string;
-  backgroundColor?: string;
-  fontFamily?: string;
+    primaryColor?: string
+    textColor?: string
+    backgroundColor?: string
+    fontFamily?: string
 }
 ```