@ensembleapp/client-sdk 0.0.1

package/README.md

@@ -0,0 +1,90 @@
+# Client SDK
+
+A simple React library for chat functionality with built-in AI SDK integration.
+
+## Installation
+
+```bash
+npm install @repo/client-sdk
+```
+
+## Usage
+
+### Option 1: Use the pre-built ChatWidget
+
+```tsx
+import { ChatWidget } from '@repo/client-sdk'
+
+function App() {
+  return (
+    <ChatWidget
+      api={{
+        baseUrl: '/api',
+        token: 'your-jwt-token',
+      }}
+      threadId="user-123"
+      agentId="agent-234"
+      onMessage={(message) => console.log('New message:', message)}
+      onError={(error) => console.error('Chat error:', error)}
+      placeholder="Ask me anything..."
+      welcomeMessage="Hello! How can I help you today?"
+    />
+  )
+}
+```
+
+### Option 2: Build your own UI with the useChat hook
+
+```tsx
+import { useChat } from '@repo/client-sdk'
+
+function CustomChat() {
+  const { messages, isLoading, sendMessage } = useChat({
+    api: {
+      baseUrl: '/api',
+      token: 'your-jwt-token',
+    },
+    threadId: 'user-123',
+    agentId="agent-234",
+  })
+
+  return (
+    <div>
+      {messages.map(message => (
+        <div key={message.id}>
+          <strong>{message.role}:</strong> {message.content}
+        </div>
+      ))}
+      <button onClick={() => sendMessage({ text: 'Hello!' })}>
+        Send Message
+      </button>
+    </div>
+  )
+}
+```
+
+## API Reference
+
+### ChatWidget Props
+
+- `api` ({ baseUrl: string; token: string; headers? }): Base URL for the chat API, required auth token (sent as `Authorization: Bearer <token>`), and optional extra headers
+- `threadId` (string): Thread/session ID (required)
+- `onMessage?` (function): Callback when a new message is received
+- `onError?` (function): Callback when an error occurs
+- `onFinish?` (function): Callback when a conversation finishes
+- `className?` (string): Additional CSS classes
+- `placeholder?` (string): Input placeholder text
+- `welcomeMessage?` (string): Initial welcome message
+
+### useChat Hook
+
+```tsx
+const {
+  messages,      // Array of chat messages
+  isLoading,     // Boolean indicating if request is in progress
+  isError,       // Boolean indicating if there's an error
+  sendMessage,   // Function to send a message
+  stop,          // Function to stop current request
+  setMessages,   // Function to manually set messages
+} = useChat(config)
+```

package/dist/index.d.ts

@@ -0,0 +1,193 @@
+import * as ai from 'ai';
+import { UIMessage } from 'ai';
+import { U as UIWidget, a as UIWidgetDefinition } from './schemas-Esi_eGx3.js';
+export { W as WidgetDefinition, c as createWidget } from './schemas-Esi_eGx3.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React from 'react';
+import { ClassValue } from 'clsx';
+import 'json-schema';
+import 'zod';
+
+interface ApiConfig {
+    /** The base URL where /chat and /chat/messages are hosted */
+    baseUrl: string;
+    /** JWT token generated from Secret */
+    token: string;
+    headers?: Record<string, string>;
+}
+interface UseChatConfig {
+    /** The server API configuration */
+    api: ApiConfig;
+    /** Thread ID for keeping conversation history */
+    threadId: string;
+    /** The Agent ID that this chat connects to. Either agentId or agentExecutionId must be provided */
+    agentId?: string;
+    /** The Agent Orchestration ID that this chat connects to. Either agentId or agentExecutionId must be provided */
+    agentExecutionId?: string;
+    /** additional context (anything) that needs to be passed to the LLM */
+    dataContext?: unknown;
+    onError?: (error: Error) => void;
+    /** Called when API returns 401/unauthorized (e.g., token expiry) */
+    onAuthError?: () => void;
+    onFinish?: (message: any) => void;
+    onData?: (data: any) => void;
+    onMessage?: (message: UIMessage) => void;
+}
+interface ChatMessage {
+    id: string;
+    role: 'user' | 'assistant';
+    content: (string | UIWidget)[];
+    thoughts?: (string | UIWidget)[];
+    createdAt?: Date;
+}
+declare function useChat({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onData, onMessage, }: UseChatConfig): {
+    messages: ChatMessage[];
+    status: ai.ChatStatus;
+    isLoadingInitial: boolean;
+    sendMessage: (message?: (Omit<UIMessage<unknown, ai.UIDataTypes, ai.UITools>, "id" | "role"> & {
+        id?: string | undefined;
+        role?: "user" | "assistant" | "system" | undefined;
+    } & {
+        text?: never;
+        files?: never;
+        messageId?: string;
+    }) | {
+        text: string;
+        files?: FileList | ai.FileUIPart[];
+        metadata?: unknown;
+        parts?: never;
+        messageId?: string;
+    } | {
+        files: FileList | ai.FileUIPart[];
+        metadata?: unknown;
+        parts?: never;
+        messageId?: string;
+    } | undefined, options?: ai.ChatRequestOptions) => Promise<void>;
+    stop: () => Promise<void>;
+    setMessages: (messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[] | ((messages: UIMessage<unknown, ai.UIDataTypes, ai.UITools>[]) => UIMessage<unknown, ai.UIDataTypes, ai.UITools>[])) => void;
+};
+
+interface ChatWidgetStyles {
+    primaryColor?: string;
+    primaryTextColor?: string;
+    backgroundColor?: string;
+    borderColor?: string;
+    headerTextColor?: string;
+    userBubbleTextColor?: string;
+    assistantBubbleBackground?: string;
+    assistantBubbleTextColor?: string;
+    fontFamily?: string;
+    borderRadius?: string;
+    inputBackground?: string;
+    inputTextColor?: string;
+    inputPlaceholderColor?: string;
+    thoughtsBorderColor?: string;
+}
+interface ChatWidgetVoiceOptions {
+    url: string;
+    enabled?: boolean;
+    method?: string;
+    headers?: Record<string, string>;
+    payload?: Record<string, unknown> | ((text: string) => Record<string, unknown>);
+    autoplayLatest?: boolean;
+}
+interface ChatWidgetSpeechToTextOptions {
+    enabled?: boolean;
+    silenceTimeout?: number;
+    language?: string;
+    onError?: (message: string) => void;
+    finalDelay?: number;
+}
+interface ChatWidgetConfig extends UseChatConfig {
+    /** Title for the Chat window */
+    title?: string;
+    /** Introductory message displayed at the start of the chat for brand new threads */
+    introMessage?: string;
+    /** Placeholder text for the input box */
+    inputPlaceholder?: string;
+    className?: string;
+    styles?: ChatWidgetStyles;
+    voice?: ChatWidgetVoiceOptions;
+    speechToText?: ChatWidgetSpeechToTextOptions;
+    widgets?: UIWidgetDefinition[];
+}
+declare function ChatWidget({ api, threadId, agentId, agentExecutionId, dataContext, onError, onAuthError, onFinish, onMessage, title, introMessage, inputPlaceholder, className, styles: styleProps, voice, speechToText, widgets, }: ChatWidgetConfig): react_jsx_runtime.JSX.Element;
+
+interface PopupAnchorConfig {
+    enabled?: boolean;
+    label?: string;
+    position?: 'bottom-end' | 'bottom-start';
+    initiallyOpen?: boolean;
+    render?: (options: {
+        isOpen: boolean;
+        toggle: () => void;
+    }) => React.ReactNode;
+    closeButton?: PopupCloseConfig;
+}
+interface PopupCloseConfig {
+    render?: (options: {
+        toggle: () => void;
+    }) => React.ReactNode;
+    position?: 'top-end' | 'top-start';
+    show?: boolean;
+}
+interface PopupChatWidgetProps extends ChatWidgetConfig {
+    anchor?: PopupAnchorConfig;
+    closeButton?: PopupCloseConfig;
+    popupSize?: {
+        width?: string;
+        height?: string;
+        maxWidth?: string;
+        maxHeight?: string;
+    };
+    /** When provided, overrides the open/closed state */
+    openOverride?: boolean;
+    /** Callback when open state should change (used when openOverride is controlled) */
+    onToggleOpen?: (nextOpen: boolean) => void;
+}
+declare function PopupChatWidget({ anchor, ...props }: PopupChatWidgetProps): react_jsx_runtime.JSX.Element;
+
+interface ChatWidgetInstance {
+    updateProps: (props: Partial<ChatWidgetConfig>) => void;
+    updateTheme: (styles: ChatWidgetStyles) => void;
+    unmount: () => void;
+}
+declare const createChatWidget: (target: HTMLElement, props: ChatWidgetConfig) => ChatWidgetInstance;
+
+type RegisterChatWidgetsParams = {
+    api: ApiConfig;
+    threadId: string;
+    widgets: UIWidgetDefinition[];
+};
+/**
+ * Registers widget definitions for a specific thread so the server can render them.
+ */
+declare function registerChatWidgets({ api, threadId, widgets, }: RegisterChatWidgetsParams): Promise<void>;
+
+/**
+ * Embeddable Chat Widget
+ *
+ * This file creates a standalone chat widget that can be embedded in any website
+ * without requiring React in the host application. Uses Shadow DOM for style isolation.
+ */
+interface EmbeddableChatWidgetConfig extends PopupChatWidgetProps {
+    containerId?: string;
+}
+declare global {
+    interface Window {
+        ChatWidget: {
+            init: (config: EmbeddableChatWidgetConfig) => Promise<void>;
+            destroy: () => void;
+            hide: () => void;
+            show: () => void;
+            updateConfig: (config: Partial<EmbeddableChatWidgetConfig>) => void;
+            updateToken: (token: string) => void;
+        };
+    }
+}
+
+declare const defaultChatWidgets: UIWidgetDefinition[];
+
+declare function cn(...inputs: ClassValue[]): string;
+
+export { type ApiConfig, type ChatMessage, ChatWidget, type ChatWidgetInstance, type ChatWidgetConfig as ChatWidgetProps, type ChatWidgetSpeechToTextOptions, type ChatWidgetStyles, type ChatWidgetVoiceOptions, type EmbeddableChatWidgetConfig, type PopupAnchorConfig, PopupChatWidget, type PopupChatWidgetProps, UIWidget, UIWidgetDefinition, type UseChatConfig, cn, createChatWidget, defaultChatWidgets, registerChatWidgets, useChat };