@aigentyc/chat-sdk 0.1.0

package/dist/types-DKJ_-nbG.d.cts

@@ -0,0 +1,349 @@
+import { ComponentType } from 'react';
+
+/**
+ * UI language code.
+ *
+ * `"en"` and `"he"` are first-class supported locales.
+ * Any other BCP-47 string is accepted for custom translation overrides.
+ */
+type Language = "en" | "he" | (string & {});
+/**
+ * Full theme configuration for the chat UI.
+ *
+ * All values are CSS color/font strings (e.g. `"#eb1d22"`, `"Inter, sans-serif"`).
+ */
+interface ThemeConfig {
+    /** Primary brand color (buttons, links, accents) */
+    primaryColor?: string;
+    /** Secondary accent color (highlights, badges) */
+    accentColor?: string;
+    /** Main background color of the chat panel */
+    backgroundColor?: string;
+    /** Primary text color */
+    textColor?: string;
+    /** Color used for links inside chat messages */
+    linkColor?: string;
+    /** Loader / spinner color */
+    loaderColor?: string;
+    /** Background color of user message bubbles */
+    userBubbleColor?: string;
+    /** Background color of assistant message bubbles */
+    assistantBubbleColor?: string;
+    /** Text color inside assistant message bubbles */
+    assistantBubbleTextColor?: string;
+    /** Secondary / muted background (input bar, hover states) */
+    secondaryColor?: string;
+    /** Border color throughout the UI */
+    borderColor?: string;
+    /** Placeholder text color (inputs, search) */
+    placeholderColor?: string;
+    /** CSS padding for assistant bubbles (e.g. `"20px"`, `"16px 24px"`) */
+    assistantBubblePadding?: string;
+    /** Max width of assistant messages (e.g. `"100%"`, `"800px"`). Default: `"95%"` */
+    assistantMaxWidth?: string;
+    /** Background color for the floating button (overrides primaryColor) */
+    buttonBgColor?: string;
+    /** Border-radius for the floating button (e.g. `"50%"`, `"12px"`) */
+    buttonBorderRadius?: string;
+    /** Primary font-family for the widget (e.g. `"Inter, sans-serif"`) */
+    fontFamily?: string;
+    /** Font-family for headings inside chat responses */
+    headingFontFamily?: string;
+}
+/**
+ * A single quick-action question shown on the welcome page or as a
+ * contextual suggestion during a conversation.
+ */
+interface QuestionConfig {
+    /** Unique identifier */
+    id: string;
+    /** Display label (button text) */
+    label: string;
+    /** Short description shown below the label */
+    description: string;
+    /** The actual query sent to the AI when the user clicks */
+    query: string;
+    /** Optional icon name (e.g. `"Shield"`, `"MessageSquare"`, `"Zap"`) */
+    icon?: string;
+    /** Background color for this question button */
+    bgColor?: string;
+    /** Text color for this question button */
+    textColor?: string;
+    /** Icon color (e.g. `"#f5a623"`) */
+    iconColor?: string;
+    /** Icon container background color (e.g. `"#fef3cd"`) */
+    iconBgColor?: string;
+}
+/**
+ * Minimal configuration required to connect to the chat backend.
+ */
+interface ChatConfig {
+    /** Project identifier on the Aigentyc platform */
+    projectId: string;
+    /** Base URL of the API (e.g. `"https://api.aigentyc.com"`) */
+    apiEndpoint: string;
+    /** Bearer API key for authentication (alternative to session cookies) */
+    apiKey?: string;
+    /** Human-readable client / brand name shown in the header */
+    clientName?: string;
+}
+/**
+ * Props passed to every slot component so it can delegate to the default.
+ */
+interface SlotProps<P = Record<string, unknown>> {
+    /** Props the default implementation expects */
+    props: P;
+    /** The SDK-provided default component — call it to render the built-in UI */
+    DefaultComponent: ComponentType<P>;
+}
+/**
+ * Typed map of all replaceable UI slots.
+ *
+ * Each value is a React component that receives `SlotProps<T>` where `T`
+ * contains the props the default slot implementation expects.
+ */
+interface SlotMap {
+    /** Custom header component */
+    header?: ComponentType<SlotProps>;
+    /** Custom footer component */
+    footer?: ComponentType<SlotProps>;
+    /** Custom chat input component */
+    input?: ComponentType<SlotProps>;
+    /** Custom welcome page component */
+    welcomePage?: ComponentType<SlotProps>;
+    /** Custom user message bubble */
+    userMessage?: ComponentType<SlotProps>;
+    /** Custom assistant message bubble */
+    assistantMessage?: ComponentType<SlotProps>;
+    /** Custom system message component */
+    systemMessage?: ComponentType<SlotProps>;
+    /** Custom loading indicator */
+    loader?: ComponentType<SlotProps>;
+    /** Custom feedback (thumbs up/down) component */
+    feedback?: ComponentType<SlotProps>;
+    /** Per-tool-name component overrides (keyed by tool name) */
+    tools?: Record<string, ComponentType<ToolRendererProps>>;
+    /**
+     * Per-tool render-mode overrides.
+     *
+     * Keys are tool names, values are components that receive `ToolRendererProps`.
+     */
+    toolRenderers?: Record<string, ComponentType<ToolRendererProps>>;
+    /** Custom live-chat panel */
+    liveChatPanel?: ComponentType<SlotProps>;
+    /** Custom satisfaction rating component */
+    satisfactionRating?: ComponentType<SlotProps>;
+    /** Custom visitor identity form (shown before live-chat handoff) */
+    visitorIdentityForm?: ComponentType<SlotProps>;
+    /** Custom floating action button */
+    floatingButton?: ComponentType<SlotProps>;
+    /** Custom empty-state shown when no messages exist */
+    emptyState?: ComponentType<SlotProps>;
+}
+/**
+ * Describes a follow-up action attached to a tool invocation result.
+ *
+ * When the user clicks the action, the SDK fires the target tool with
+ * mapped parameters.
+ */
+interface ComponentAction {
+    /** Unique action identifier */
+    id: string;
+    /** Human-readable action name */
+    name: string;
+    /** The tool to invoke when this action fires */
+    targetToolName: string;
+    /** ID of the target tool invocation (if reusing an existing call) */
+    targetToolId?: string;
+    /** Map of parameter names from action context to target tool args */
+    parameterMappings?: Record<string, string>;
+    /** CSS selector for the trigger element (when embedded in tool UI) */
+    triggerSelector?: string;
+    /** Label for the action button */
+    buttonLabel?: string;
+}
+/**
+ * Structured result returned by the API for a single tool invocation.
+ */
+interface ToolResult {
+    /** Arbitrary JSON payload returned by the tool */
+    data?: unknown;
+    /**
+     * Hint for how the UI should render this result.
+     *
+     * `"display"` — full custom component, `"json"` — raw JSON tree,
+     * `"text"` — plain text, `"hidden"` — not shown to user.
+     */
+    uiRenderMode?: "display" | "json" | "text" | "hidden";
+    /** JSON-render specification for schema-driven rendering */
+    jsonRenderSpec?: Record<string, unknown>;
+    /** Name of a registered custom component to render this result */
+    customComponent?: string;
+    /** Inline React component (rare — usually `customComponent` is preferred) */
+    uiComponent?: ComponentType<unknown>;
+    /** Follow-up actions the user can trigger from this result */
+    componentActions?: ComponentAction[];
+    /** Text shown in the loading indicator while the tool runs */
+    loadingText?: string;
+    /** Whether to offer a "show more" toggle for long results */
+    enableShowMore?: boolean;
+    /** Number of items to show before the "show more" fold */
+    initialRenderLimit?: number;
+    /** Label for the "show more" button */
+    showMoreText?: string;
+    /** Display data for the UI — stripped before sending back to LLM */
+    _displayData?: unknown;
+}
+/**
+ * Props passed to custom tool renderer components.
+ */
+interface ToolRendererProps {
+    /** Name of the invoked tool */
+    toolName: string;
+    /** Lifecycle state: `"partial-call"`, `"call"`, `"output-available"` */
+    state: string;
+    /** Arguments the LLM passed to the tool */
+    args: Record<string, unknown>;
+    /** Structured result (available when `state === "output-available"`) */
+    result?: ToolResult;
+    /** Whether the chat is currently streaming / processing */
+    isProcessing?: boolean;
+    /** Current UI language */
+    language?: Language;
+    /** Send a follow-up message on behalf of the user */
+    onSendMessage?: (text: string) => void;
+    /** Fire a component action */
+    onAction?: (action: ComponentAction) => void;
+}
+/**
+ * State machine for live-chat sessions.
+ *
+ * `"ai"` → normal AI conversation
+ * `"requesting"` → handoff request sent, waiting for queue
+ * `"queued"` → in operator queue
+ * `"live"` → connected to a human operator
+ * `"ended"` → session ended
+ */
+type LiveChatState = "ai" | "requesting" | "queued" | "live" | "ended";
+/**
+ * A single message in a live-chat session.
+ */
+interface LiveChatMessage {
+    /** Server-assigned message ID */
+    id: number;
+    /** Message body (plain text or HTML) */
+    content: string;
+    /** Who sent the message */
+    senderType: "visitor" | "operator" | "system";
+    /** ISO-8601 timestamp */
+    timestamp: string;
+    /** Optional system-message sub-type (e.g. `"transfer"`, `"rating_request"`) */
+    systemMessageType?: string;
+}
+/**
+ * All lifecycle event callbacks the SDK exposes.
+ *
+ * Consumers attach these via `ChatProviderProps` to hook into chat events
+ * without reaching into internals.
+ */
+interface ChatEventCallbacks {
+    /** Fired when the chat UI is mounted and ready */
+    onReady?: () => void;
+    /** Fired when a brand-new session starts */
+    onSessionStart?: (sessionId: string) => void;
+    /** Fired when an existing session is restored from storage */
+    onSessionRestore?: (sessionId: string) => void;
+    /** Fired after the user sends a message */
+    onMessageSent?: (message: ChatMessage) => void;
+    /** Fired when an assistant message is received (after streaming completes) */
+    onMessageReceived?: (message: ChatMessage) => void;
+    /** Fired when streaming of a new assistant message begins */
+    onStreamStart?: () => void;
+    /** Fired when streaming of an assistant message ends */
+    onStreamEnd?: () => void;
+    /** Fired when the LLM invokes a tool */
+    onToolCall?: (toolName: string, args: Record<string, unknown>) => void;
+    /** Fired when a tool invocation produces a result */
+    onToolResult?: (toolName: string, result: ToolResult) => void;
+    /** Fired when the user clicks a component action inside a tool result */
+    onToolAction?: (action: ComponentAction) => void;
+    /** Fired when the user (or AI) requests a live-chat handoff */
+    onLiveChatRequested?: () => void;
+    /** Fired when a live-chat session is connected to an operator */
+    onLiveChatConnected?: (operatorName: string) => void;
+    /** Fired when a live-chat session ends */
+    onLiveChatEnded?: (endedBy: string) => void;
+    /** Fired on any error (network, auth, etc.) */
+    onError?: (error: Error) => void;
+    /**
+     * Generic interaction event (link click, copy, feedback, etc.).
+     * Useful for external analytics pipelines.
+     */
+    onInteraction?: (type: string, metadata?: Record<string, unknown>) => void;
+}
+/**
+ * Represents a single message in the conversation (user, assistant, or system).
+ */
+interface ChatMessage {
+    /** Unique message identifier */
+    id: string;
+    /** Who produced this message */
+    role: "user" | "assistant" | "system";
+    /** Plain-text content of the message */
+    content: string;
+    /** When the message was created */
+    createdAt?: Date;
+    /**
+     * Structured parts array (text parts, tool invocation parts, etc.).
+     * Mirrors the AI SDK `UIMessage.parts` shape.
+     */
+    parts?: Array<{
+        /** Discriminator */
+        type: string;
+        /** Text content (when `type === "text"`) */
+        text?: string;
+        /** Tool call ID (when type starts with `"tool-"`) */
+        toolCallId?: string;
+        /** Tool invocation state */
+        state?: string;
+        /** Tool input arguments */
+        input?: Record<string, unknown>;
+        /** Tool output */
+        output?: unknown;
+    }>;
+}
+/**
+ * Full configuration for the `<ChatProvider>` context wrapper.
+ *
+ * Extends `ChatConfig` with all optional customisation knobs.
+ */
+interface ChatProviderProps extends ChatConfig, ChatEventCallbacks {
+    /** UI language (default `"en"`) */
+    language?: Language;
+    /** Theme customisation */
+    theme?: ThemeConfig;
+    /** Quick-action questions for the welcome page */
+    questions?: QuestionConfig[];
+    /** Persist messages across page navigations via localStorage (default `true`) */
+    persistMessages?: boolean;
+    /** Max messages to send to the API in a single request (default `20`) */
+    maxMessages?: number;
+    /** Enable the live-chat handoff feature */
+    enableLiveChat?: boolean;
+    /** Socket.IO endpoint for live chat (defaults to `apiEndpoint` if omitted) */
+    chatServiceUrl?: string;
+    /**
+     * Custom translation overrides keyed by language code, then by translation key.
+     *
+     * ```ts
+     * translations: { en: { thinking: "Pondering..." } }
+     * ```
+     */
+    translations?: Record<string, Record<string, string>>;
+    /** Replaceable UI slot components */
+    slots?: SlotMap;
+    /** React children to render inside the provider */
+    children?: React.ReactNode;
+}
+
+export type { ChatProviderProps as C, Language as L, QuestionConfig as Q, SlotMap as S, ThemeConfig as T, ChatConfig as a, ChatEventCallbacks as b, ChatMessage as c, ComponentAction as d, LiveChatMessage as e, LiveChatState as f, ToolRendererProps as g, ToolResult as h, SlotProps as i };

package/dist/types-DKJ_-nbG.d.ts

@@ -0,0 +1,349 @@
+import { ComponentType } from 'react';
+
+/**
+ * UI language code.
+ *
+ * `"en"` and `"he"` are first-class supported locales.
+ * Any other BCP-47 string is accepted for custom translation overrides.
+ */
+type Language = "en" | "he" | (string & {});
+/**
+ * Full theme configuration for the chat UI.
+ *
+ * All values are CSS color/font strings (e.g. `"#eb1d22"`, `"Inter, sans-serif"`).
+ */
+interface ThemeConfig {
+    /** Primary brand color (buttons, links, accents) */
+    primaryColor?: string;
+    /** Secondary accent color (highlights, badges) */
+    accentColor?: string;
+    /** Main background color of the chat panel */
+    backgroundColor?: string;
+    /** Primary text color */
+    textColor?: string;
+    /** Color used for links inside chat messages */
+    linkColor?: string;
+    /** Loader / spinner color */
+    loaderColor?: string;
+    /** Background color of user message bubbles */
+    userBubbleColor?: string;
+    /** Background color of assistant message bubbles */
+    assistantBubbleColor?: string;
+    /** Text color inside assistant message bubbles */
+    assistantBubbleTextColor?: string;
+    /** Secondary / muted background (input bar, hover states) */
+    secondaryColor?: string;
+    /** Border color throughout the UI */
+    borderColor?: string;
+    /** Placeholder text color (inputs, search) */
+    placeholderColor?: string;
+    /** CSS padding for assistant bubbles (e.g. `"20px"`, `"16px 24px"`) */
+    assistantBubblePadding?: string;
+    /** Max width of assistant messages (e.g. `"100%"`, `"800px"`). Default: `"95%"` */
+    assistantMaxWidth?: string;
+    /** Background color for the floating button (overrides primaryColor) */
+    buttonBgColor?: string;
+    /** Border-radius for the floating button (e.g. `"50%"`, `"12px"`) */
+    buttonBorderRadius?: string;
+    /** Primary font-family for the widget (e.g. `"Inter, sans-serif"`) */
+    fontFamily?: string;
+    /** Font-family for headings inside chat responses */
+    headingFontFamily?: string;
+}
+/**
+ * A single quick-action question shown on the welcome page or as a
+ * contextual suggestion during a conversation.
+ */
+interface QuestionConfig {
+    /** Unique identifier */
+    id: string;
+    /** Display label (button text) */
+    label: string;
+    /** Short description shown below the label */
+    description: string;
+    /** The actual query sent to the AI when the user clicks */
+    query: string;
+    /** Optional icon name (e.g. `"Shield"`, `"MessageSquare"`, `"Zap"`) */
+    icon?: string;
+    /** Background color for this question button */
+    bgColor?: string;
+    /** Text color for this question button */
+    textColor?: string;
+    /** Icon color (e.g. `"#f5a623"`) */
+    iconColor?: string;
+    /** Icon container background color (e.g. `"#fef3cd"`) */
+    iconBgColor?: string;
+}
+/**
+ * Minimal configuration required to connect to the chat backend.
+ */
+interface ChatConfig {
+    /** Project identifier on the Aigentyc platform */
+    projectId: string;
+    /** Base URL of the API (e.g. `"https://api.aigentyc.com"`) */
+    apiEndpoint: string;
+    /** Bearer API key for authentication (alternative to session cookies) */
+    apiKey?: string;
+    /** Human-readable client / brand name shown in the header */
+    clientName?: string;
+}
+/**
+ * Props passed to every slot component so it can delegate to the default.
+ */
+interface SlotProps<P = Record<string, unknown>> {
+    /** Props the default implementation expects */
+    props: P;
+    /** The SDK-provided default component — call it to render the built-in UI */
+    DefaultComponent: ComponentType<P>;
+}
+/**
+ * Typed map of all replaceable UI slots.
+ *
+ * Each value is a React component that receives `SlotProps<T>` where `T`
+ * contains the props the default slot implementation expects.
+ */
+interface SlotMap {
+    /** Custom header component */
+    header?: ComponentType<SlotProps>;
+    /** Custom footer component */
+    footer?: ComponentType<SlotProps>;
+    /** Custom chat input component */
+    input?: ComponentType<SlotProps>;
+    /** Custom welcome page component */
+    welcomePage?: ComponentType<SlotProps>;
+    /** Custom user message bubble */
+    userMessage?: ComponentType<SlotProps>;
+    /** Custom assistant message bubble */
+    assistantMessage?: ComponentType<SlotProps>;
+    /** Custom system message component */
+    systemMessage?: ComponentType<SlotProps>;
+    /** Custom loading indicator */
+    loader?: ComponentType<SlotProps>;
+    /** Custom feedback (thumbs up/down) component */
+    feedback?: ComponentType<SlotProps>;
+    /** Per-tool-name component overrides (keyed by tool name) */
+    tools?: Record<string, ComponentType<ToolRendererProps>>;
+    /**
+     * Per-tool render-mode overrides.
+     *
+     * Keys are tool names, values are components that receive `ToolRendererProps`.
+     */
+    toolRenderers?: Record<string, ComponentType<ToolRendererProps>>;
+    /** Custom live-chat panel */
+    liveChatPanel?: ComponentType<SlotProps>;
+    /** Custom satisfaction rating component */
+    satisfactionRating?: ComponentType<SlotProps>;
+    /** Custom visitor identity form (shown before live-chat handoff) */
+    visitorIdentityForm?: ComponentType<SlotProps>;
+    /** Custom floating action button */
+    floatingButton?: ComponentType<SlotProps>;
+    /** Custom empty-state shown when no messages exist */
+    emptyState?: ComponentType<SlotProps>;
+}
+/**
+ * Describes a follow-up action attached to a tool invocation result.
+ *
+ * When the user clicks the action, the SDK fires the target tool with
+ * mapped parameters.
+ */
+interface ComponentAction {
+    /** Unique action identifier */
+    id: string;
+    /** Human-readable action name */
+    name: string;
+    /** The tool to invoke when this action fires */
+    targetToolName: string;
+    /** ID of the target tool invocation (if reusing an existing call) */
+    targetToolId?: string;
+    /** Map of parameter names from action context to target tool args */
+    parameterMappings?: Record<string, string>;
+    /** CSS selector for the trigger element (when embedded in tool UI) */
+    triggerSelector?: string;
+    /** Label for the action button */
+    buttonLabel?: string;
+}
+/**
+ * Structured result returned by the API for a single tool invocation.
+ */
+interface ToolResult {
+    /** Arbitrary JSON payload returned by the tool */
+    data?: unknown;
+    /**
+     * Hint for how the UI should render this result.
+     *
+     * `"display"` — full custom component, `"json"` — raw JSON tree,
+     * `"text"` — plain text, `"hidden"` — not shown to user.
+     */
+    uiRenderMode?: "display" | "json" | "text" | "hidden";
+    /** JSON-render specification for schema-driven rendering */
+    jsonRenderSpec?: Record<string, unknown>;
+    /** Name of a registered custom component to render this result */
+    customComponent?: string;
+    /** Inline React component (rare — usually `customComponent` is preferred) */
+    uiComponent?: ComponentType<unknown>;
+    /** Follow-up actions the user can trigger from this result */
+    componentActions?: ComponentAction[];
+    /** Text shown in the loading indicator while the tool runs */
+    loadingText?: string;
+    /** Whether to offer a "show more" toggle for long results */
+    enableShowMore?: boolean;
+    /** Number of items to show before the "show more" fold */
+    initialRenderLimit?: number;
+    /** Label for the "show more" button */
+    showMoreText?: string;
+    /** Display data for the UI — stripped before sending back to LLM */
+    _displayData?: unknown;
+}
+/**
+ * Props passed to custom tool renderer components.
+ */
+interface ToolRendererProps {
+    /** Name of the invoked tool */
+    toolName: string;
+    /** Lifecycle state: `"partial-call"`, `"call"`, `"output-available"` */
+    state: string;
+    /** Arguments the LLM passed to the tool */
+    args: Record<string, unknown>;
+    /** Structured result (available when `state === "output-available"`) */
+    result?: ToolResult;
+    /** Whether the chat is currently streaming / processing */
+    isProcessing?: boolean;
+    /** Current UI language */
+    language?: Language;
+    /** Send a follow-up message on behalf of the user */
+    onSendMessage?: (text: string) => void;
+    /** Fire a component action */
+    onAction?: (action: ComponentAction) => void;
+}
+/**
+ * State machine for live-chat sessions.
+ *
+ * `"ai"` → normal AI conversation
+ * `"requesting"` → handoff request sent, waiting for queue
+ * `"queued"` → in operator queue
+ * `"live"` → connected to a human operator
+ * `"ended"` → session ended
+ */
+type LiveChatState = "ai" | "requesting" | "queued" | "live" | "ended";
+/**
+ * A single message in a live-chat session.
+ */
+interface LiveChatMessage {
+    /** Server-assigned message ID */
+    id: number;
+    /** Message body (plain text or HTML) */
+    content: string;
+    /** Who sent the message */
+    senderType: "visitor" | "operator" | "system";
+    /** ISO-8601 timestamp */
+    timestamp: string;
+    /** Optional system-message sub-type (e.g. `"transfer"`, `"rating_request"`) */
+    systemMessageType?: string;
+}
+/**
+ * All lifecycle event callbacks the SDK exposes.
+ *
+ * Consumers attach these via `ChatProviderProps` to hook into chat events
+ * without reaching into internals.
+ */
+interface ChatEventCallbacks {
+    /** Fired when the chat UI is mounted and ready */
+    onReady?: () => void;
+    /** Fired when a brand-new session starts */
+    onSessionStart?: (sessionId: string) => void;
+    /** Fired when an existing session is restored from storage */
+    onSessionRestore?: (sessionId: string) => void;
+    /** Fired after the user sends a message */
+    onMessageSent?: (message: ChatMessage) => void;
+    /** Fired when an assistant message is received (after streaming completes) */
+    onMessageReceived?: (message: ChatMessage) => void;
+    /** Fired when streaming of a new assistant message begins */
+    onStreamStart?: () => void;
+    /** Fired when streaming of an assistant message ends */
+    onStreamEnd?: () => void;
+    /** Fired when the LLM invokes a tool */
+    onToolCall?: (toolName: string, args: Record<string, unknown>) => void;
+    /** Fired when a tool invocation produces a result */
+    onToolResult?: (toolName: string, result: ToolResult) => void;
+    /** Fired when the user clicks a component action inside a tool result */
+    onToolAction?: (action: ComponentAction) => void;
+    /** Fired when the user (or AI) requests a live-chat handoff */
+    onLiveChatRequested?: () => void;
+    /** Fired when a live-chat session is connected to an operator */
+    onLiveChatConnected?: (operatorName: string) => void;
+    /** Fired when a live-chat session ends */
+    onLiveChatEnded?: (endedBy: string) => void;
+    /** Fired on any error (network, auth, etc.) */
+    onError?: (error: Error) => void;
+    /**
+     * Generic interaction event (link click, copy, feedback, etc.).
+     * Useful for external analytics pipelines.
+     */
+    onInteraction?: (type: string, metadata?: Record<string, unknown>) => void;
+}
+/**
+ * Represents a single message in the conversation (user, assistant, or system).
+ */
+interface ChatMessage {
+    /** Unique message identifier */
+    id: string;
+    /** Who produced this message */
+    role: "user" | "assistant" | "system";
+    /** Plain-text content of the message */
+    content: string;
+    /** When the message was created */
+    createdAt?: Date;
+    /**
+     * Structured parts array (text parts, tool invocation parts, etc.).
+     * Mirrors the AI SDK `UIMessage.parts` shape.
+     */
+    parts?: Array<{
+        /** Discriminator */
+        type: string;
+        /** Text content (when `type === "text"`) */
+        text?: string;
+        /** Tool call ID (when type starts with `"tool-"`) */
+        toolCallId?: string;
+        /** Tool invocation state */
+        state?: string;
+        /** Tool input arguments */
+        input?: Record<string, unknown>;
+        /** Tool output */
+        output?: unknown;
+    }>;
+}
+/**
+ * Full configuration for the `<ChatProvider>` context wrapper.
+ *
+ * Extends `ChatConfig` with all optional customisation knobs.
+ */
+interface ChatProviderProps extends ChatConfig, ChatEventCallbacks {
+    /** UI language (default `"en"`) */
+    language?: Language;
+    /** Theme customisation */
+    theme?: ThemeConfig;
+    /** Quick-action questions for the welcome page */
+    questions?: QuestionConfig[];
+    /** Persist messages across page navigations via localStorage (default `true`) */
+    persistMessages?: boolean;
+    /** Max messages to send to the API in a single request (default `20`) */
+    maxMessages?: number;
+    /** Enable the live-chat handoff feature */
+    enableLiveChat?: boolean;
+    /** Socket.IO endpoint for live chat (defaults to `apiEndpoint` if omitted) */
+    chatServiceUrl?: string;
+    /**
+     * Custom translation overrides keyed by language code, then by translation key.
+     *
+     * ```ts
+     * translations: { en: { thinking: "Pondering..." } }
+     * ```
+     */
+    translations?: Record<string, Record<string, string>>;
+    /** Replaceable UI slot components */
+    slots?: SlotMap;
+    /** React children to render inside the provider */
+    children?: React.ReactNode;
+}
+
+export type { ChatProviderProps as C, Language as L, QuestionConfig as Q, SlotMap as S, ThemeConfig as T, ChatConfig as a, ChatEventCallbacks as b, ChatMessage as c, ComponentAction as d, LiveChatMessage as e, LiveChatState as f, ToolRendererProps as g, ToolResult as h, SlotProps as i };