@nimbusai/webchat-sdk 1.0.0 → 1.0.2

package/README.md

@@ -89,7 +89,7 @@ pnpm add @nimbusai/webchat-sdk
 import { NimbusChat } from "@nimbusai/webchat-sdk";
 
 const chat = new NimbusChat({
-  agent_id: "550e8400-e29b-41d4-a716-446655440000",
+  agent_version_id: "550e8400-e29b-41d4-a716-446655440000",
 });
 
 chat.open();
@@ -101,7 +101,7 @@ chat.open();
 <script src="https://cdn.nimbus.ai/sdk/nimbus-chat.umd.global.js"></script>
 <script>
   NimbusChat.init({
-    agent_id: "550e8400-e29b-41d4-a716-446655440000",
+    agent_version_id: "550e8400-e29b-41d4-a716-446655440000",
   });
 </script>
 ```
@@ -112,7 +112,7 @@ The CDN bundle exposes a global `NimbusChat` object with a singleton `init()` me
 
 ```typescript
 const chat = new NimbusChat({
-  agent_id: "550e8400-e29b-41d4-a716-446655440000",
+  agent_version_id: "550e8400-e29b-41d4-a716-446655440000",
   style: { position: "bottom-right" }
 });
 ```
@@ -144,13 +144,13 @@ const chat = NimbusChat.init(config);
 
 ## Configuration Reference
 
-The SDK provides extensive configuration options to customize every aspect of the chat widget. All properties are optional except `agent_id`.
+The SDK provides extensive configuration options to customize every aspect of the chat widget. All properties are optional except `agent_version_id`.
 
 ### Required Configuration
 
 | Property | Type | Description |
 |----------|------|-------------|
-| `agent_id` | `string` | **Required** - Your agent ID (UUID) |
+| `agent_version_id` | `string` | **Required** - Your agent ID (UUID) |
 
 ### Core Settings
 
@@ -522,7 +522,7 @@ interface ColorPair {
 ```javascript
 const chat = new NimbusChat({
   // Required
-  agent_id: "550e8400-e29b-41d4-a716-446655440000",
+  agent_version_id: "550e8400-e29b-41d4-a716-446655440000",
 
   // Core Settings
   dns: "api.nimbus.ai/api/v1/chat/ws",
@@ -694,7 +694,7 @@ Enable comprehensive logging for development and troubleshooting:
 
 ```javascript
 const chat = new NimbusChat({
-  agent_id: "your-uuid-here",
+  agent_version_id: "your-uuid-here",
   debug: true
 });
 ```
@@ -853,7 +853,7 @@ NimbusChat (orchestrator)
 
 ### Connection Lifecycle
 
-1. **Initial Connection**: Client opens WebSocket with `agent_id` (and `flow_id` if available from localStorage)
+1. **Initial Connection**: Client opens WebSocket with `agent_version_id` (and `flow_id` if available from localStorage)
 2. **Connected**: Server responds with `{ "type": "connected", "flow_id": "uuid" }`
 3. **Persistence**: `flow_id` is always stored in localStorage and reused on reconnect
 4. **History Loading**: If `resumeConversation: true`, fetches message history via REST API after connection

package/dist/index.d.mts

@@ -165,34 +165,6 @@ interface SendButtonConfig {
     /** If true, align input and send button horizontally on the same row. Default: false */
     align?: boolean;
 }
-interface ErrorButtonConfig {
-    /** Background color of the button */
-    background?: string;
-    /** Text configuration for the button */
-    text?: TextConfig;
-    /** Icon configuration for the button. Pass null to hide. */
-    icon?: IconConfig | null;
-}
-interface ErrorStyleConfig {
-    /** Background color for the error message */
-    background?: string;
-    /** Title configuration for the error message. Pass null to use default. */
-    title?: TextElement | null;
-    /** Subtitle configuration for the error message. Pass null to use default. */
-    subtitle?: TextElement | null;
-    /** Button configuration for the error */
-    button?: ErrorButtonConfig;
-}
-interface ErrorConfig {
-    /** Styling for inactivity timeout errors */
-    inactivity?: ErrorStyleConfig;
-    /** Styling for session conflict errors */
-    conflict?: ErrorStyleConfig;
-    /** Styling for session TTL expiration errors */
-    session_ttl?: ErrorStyleConfig;
-    /** Styling for unauthorized access errors */
-    unauthorized?: ErrorStyleConfig;
-}
 interface BubbleConfig {
     /** Position of the floating bubble. Default: "bottom-right" */
     position?: BubblePosition;
@@ -202,8 +174,8 @@ interface BubbleConfig {
     icon?: IconConfig | null;
 }
 interface NimbusChatConfig {
-    /** Required — the agent ID (UUID) for this chat instance */
-    agent_id: string;
+    /** Required — the agent version ID (UUID) for this chat instance */
+    agent_version_id: string;
     /** DNS endpoint for chat services. Default: "api.nimbus.ai/api/v1/webchat" */
     dns?: string;
     /** Whether to resume previous conversation on reconnect. Default: false */
@@ -228,8 +200,8 @@ interface NimbusChatConfig {
     sendButton?: SendButtonConfig;
     /** Welcome message configuration shown when chat is empty. */
     welcome?: WelcomeConfig;
-    /** Error styling configuration for conflict and inactivity errors */
-    error?: ErrorConfig;
+    /** Enable test mode. When true, appends ?test=True to WebSocket connection. Default: false */
+    test?: boolean;
     /** Enable debug logging to console. Default: false */
     debug?: boolean;
     /** Reconnection configuration for unexpected disconnections */
@@ -244,7 +216,7 @@ interface NimbusChatConfig {
     showMore?: ShowMoreConfig;
 }
 interface ResolvedConfig {
-    agent_id: string;
+    agent_version_id: string;
     dns: string;
     resumeConversation: boolean;
     style: {
@@ -284,7 +256,7 @@ interface ResolvedConfig {
     };
     sendButton: Required<Pick<SendButtonConfig, "align">> & Pick<SendButtonConfig, "icon">;
     welcome: WelcomeConfig;
-    error: Required<ErrorConfig>;
+    test: boolean;
     debug: boolean;
     reconnect: ReconnectConfig;
     allowNewChat: boolean;
@@ -314,11 +286,11 @@ declare const ICON_SIZES: {
  * Main SDK orchestrator.
  *
  * Usage (npm):
- *   const chat = new NimbusChat({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   const chat = new NimbusChat({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  *   chat.open();
  *
  * Usage (CDN):
- *   NimbusChat.init({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   NimbusChat.init({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  */
 declare class NimbusChat {
     private config;
@@ -389,7 +361,7 @@ type ConnectionState = "idle" | "connecting" | "connected" | "disconnected";
  * Initialize the NimbusChat widget (singleton pattern).
  * Use this when loading via CDN <script> tag.
  *
- *   NimbusChat.init({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   NimbusChat.init({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  */
 declare function init(config: NimbusChatConfig): NimbusChat;
 /**
@@ -403,4 +375,4 @@ declare const _default: {
     getInstance: typeof getInstance;
 };
 
-export { type BubbleConfig, type BubblePosition, type ChatMessage, type ChatPosition, type ColorPair, type ConnectionState, type ErrorButtonConfig, type ErrorConfig, type ErrorStyleConfig, type HeaderConfig, ICON_NAMES, ICON_SIZES, type IconConfig, type InputConfig, type MessageConfig, type MessageType, NimbusChat, type NimbusChatConfig, type ResolvedConfig, type SendButtonConfig, type ServerMessage, type TextConfig, type TextElement, type ThemeConfig, type UserMessage, type WelcomeConfig, _default as default, getInstance, init };
+export { type BubbleConfig, type BubblePosition, type ChatMessage, type ChatPosition, type ColorPair, type ConnectionState, type HeaderConfig, ICON_NAMES, ICON_SIZES, type IconConfig, type InputConfig, type MessageConfig, type MessageType, NimbusChat, type NimbusChatConfig, type ResolvedConfig, type SendButtonConfig, type ServerMessage, type TextConfig, type TextElement, type ThemeConfig, type UserMessage, type WelcomeConfig, _default as default, getInstance, init };

package/dist/index.d.ts

@@ -165,34 +165,6 @@ interface SendButtonConfig {
     /** If true, align input and send button horizontally on the same row. Default: false */
     align?: boolean;
 }
-interface ErrorButtonConfig {
-    /** Background color of the button */
-    background?: string;
-    /** Text configuration for the button */
-    text?: TextConfig;
-    /** Icon configuration for the button. Pass null to hide. */
-    icon?: IconConfig | null;
-}
-interface ErrorStyleConfig {
-    /** Background color for the error message */
-    background?: string;
-    /** Title configuration for the error message. Pass null to use default. */
-    title?: TextElement | null;
-    /** Subtitle configuration for the error message. Pass null to use default. */
-    subtitle?: TextElement | null;
-    /** Button configuration for the error */
-    button?: ErrorButtonConfig;
-}
-interface ErrorConfig {
-    /** Styling for inactivity timeout errors */
-    inactivity?: ErrorStyleConfig;
-    /** Styling for session conflict errors */
-    conflict?: ErrorStyleConfig;
-    /** Styling for session TTL expiration errors */
-    session_ttl?: ErrorStyleConfig;
-    /** Styling for unauthorized access errors */
-    unauthorized?: ErrorStyleConfig;
-}
 interface BubbleConfig {
     /** Position of the floating bubble. Default: "bottom-right" */
     position?: BubblePosition;
@@ -202,8 +174,8 @@ interface BubbleConfig {
     icon?: IconConfig | null;
 }
 interface NimbusChatConfig {
-    /** Required — the agent ID (UUID) for this chat instance */
-    agent_id: string;
+    /** Required — the agent version ID (UUID) for this chat instance */
+    agent_version_id: string;
     /** DNS endpoint for chat services. Default: "api.nimbus.ai/api/v1/webchat" */
     dns?: string;
     /** Whether to resume previous conversation on reconnect. Default: false */
@@ -228,8 +200,8 @@ interface NimbusChatConfig {
     sendButton?: SendButtonConfig;
     /** Welcome message configuration shown when chat is empty. */
     welcome?: WelcomeConfig;
-    /** Error styling configuration for conflict and inactivity errors */
-    error?: ErrorConfig;
+    /** Enable test mode. When true, appends ?test=True to WebSocket connection. Default: false */
+    test?: boolean;
     /** Enable debug logging to console. Default: false */
     debug?: boolean;
     /** Reconnection configuration for unexpected disconnections */
@@ -244,7 +216,7 @@ interface NimbusChatConfig {
     showMore?: ShowMoreConfig;
 }
 interface ResolvedConfig {
-    agent_id: string;
+    agent_version_id: string;
     dns: string;
     resumeConversation: boolean;
     style: {
@@ -284,7 +256,7 @@ interface ResolvedConfig {
     };
     sendButton: Required<Pick<SendButtonConfig, "align">> & Pick<SendButtonConfig, "icon">;
     welcome: WelcomeConfig;
-    error: Required<ErrorConfig>;
+    test: boolean;
     debug: boolean;
     reconnect: ReconnectConfig;
     allowNewChat: boolean;
@@ -314,11 +286,11 @@ declare const ICON_SIZES: {
  * Main SDK orchestrator.
  *
  * Usage (npm):
- *   const chat = new NimbusChat({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   const chat = new NimbusChat({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  *   chat.open();
  *
  * Usage (CDN):
- *   NimbusChat.init({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   NimbusChat.init({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  */
 declare class NimbusChat {
     private config;
@@ -389,7 +361,7 @@ type ConnectionState = "idle" | "connecting" | "connected" | "disconnected";
  * Initialize the NimbusChat widget (singleton pattern).
  * Use this when loading via CDN <script> tag.
  *
- *   NimbusChat.init({ agent_id: "550e8400-e29b-41d4-a716-446655440000" });
+ *   NimbusChat.init({ agent_version_id: "550e8400-e29b-41d4-a716-446655440000" });
  */
 declare function init(config: NimbusChatConfig): NimbusChat;
 /**
@@ -403,4 +375,4 @@ declare const _default: {
     getInstance: typeof getInstance;
 };
 
-export { type BubbleConfig, type BubblePosition, type ChatMessage, type ChatPosition, type ColorPair, type ConnectionState, type ErrorButtonConfig, type ErrorConfig, type ErrorStyleConfig, type HeaderConfig, ICON_NAMES, ICON_SIZES, type IconConfig, type InputConfig, type MessageConfig, type MessageType, NimbusChat, type NimbusChatConfig, type ResolvedConfig, type SendButtonConfig, type ServerMessage, type TextConfig, type TextElement, type ThemeConfig, type UserMessage, type WelcomeConfig, _default as default, getInstance, init };
+export { type BubbleConfig, type BubblePosition, type ChatMessage, type ChatPosition, type ColorPair, type ConnectionState, type HeaderConfig, ICON_NAMES, ICON_SIZES, type IconConfig, type InputConfig, type MessageConfig, type MessageType, NimbusChat, type NimbusChatConfig, type ResolvedConfig, type SendButtonConfig, type ServerMessage, type TextConfig, type TextElement, type ThemeConfig, type UserMessage, type WelcomeConfig, _default as default, getInstance, init };