@aikaara/chat-sdk 0.1.4 → 0.2.0

package/dist/headless.d.ts

@@ -22,6 +22,8 @@ export declare interface ActionCableMessage {
     message?: unknown;
 }
 
+export declare type AgentAction = EditEntityAction | SaveEntityAction | TestToolAction | NavigateAction;
+
 export declare interface AgentEvent {
     type: AgentEventType;
     [key: string]: unknown;
@@ -44,26 +46,68 @@ export declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
     get messages(): Message[];
     get conversationId(): string | null;
     get isConnected(): boolean;
+    /**
+     * Update the agent's context with information about the host app's current state.
+     * Call this on route changes so the agent knows what page/entity the user is viewing.
+     *
+     * The context is stored in conversation metadata and interpolated into the system prompt.
+     *
+     * @example
+     * ```typescript
+     * // On route change
+     * client.setContext({
+     *   currentPage: '/products/42',
+     *   entityType: 'product',
+     *   entityId: '42',
+     *   availableRoutes: { products: '/products', orders: '/orders' },
+     * });
+     * ```
+     */
+    setContext(context: AppContext): Promise<void>;
     disconnect(): Promise<void>;
+    /**
+     * Parse structured action results from tool execution output.
+     * When the agent calls tools like `edit_current_entity`, `save_current_entity`,
+     * `navigate_to`, or `test_tool_by_id`, the result contains an action payload
+     * that the SDK emits as a typed event for the host app to handle.
+     */
+    private parseActionResult;
     private handleBroadcast;
 }
 
 export declare class ApiClient {
     private baseUrl;
     private apiKey?;
+    private authToken?;
     private userToken;
-    constructor(baseUrl: string, userToken: string, apiKey?: string);
+    constructor(baseUrl: string, userToken: string, apiKey?: string, authToken?: string);
     createConversation(params: {
         systemPromptId?: number;
         channel?: string;
         title?: string;
         extUid?: string;
     }): Promise<CreateConversationResponse>;
+    updateContext(conversationId: string, context: Record<string, unknown>): Promise<void>;
     getMessages(conversationId: string): Promise<Message[]>;
     private mapMessage;
     private request;
 }
 
+export declare interface AppContext {
+    /** Current page/route path in the host app (e.g., '/products/42') */
+    currentPage: string;
+    /** Entity type on the current page (e.g., 'product', 'agent') */
+    entityType?: string;
+    /** Entity ID on the current page */
+    entityId?: string | number;
+    /** Project/workspace ID if applicable */
+    projectId?: string | number;
+    /** Routes the agent can navigate to — map of label → path */
+    availableRoutes?: Record<string, string>;
+    /** Additional context for the agent (e.g., form field names, entity schema) */
+    custom?: Record<string, unknown>;
+}
+
 export declare class ChannelSubscription {
     readonly identifier: string;
     private callbacks;
@@ -82,10 +126,11 @@ export declare class ChannelSubscription {
 
 export declare interface ChatClientConfig extends ConnectionConfig {
     apiKey?: string;
+    authToken?: string;
     extUid?: string;
     conversationId?: string;
     systemPromptId?: number;
-    channel?: 'widget' | 'api';
+    channel?: 'widget' | 'api' | 'sidekick';
     onMessage?: (message: Message) => void;
     onStatusChange?: (status: string) => void;
     onError?: (error: Error) => void;
@@ -116,12 +161,26 @@ export declare interface ChatEvents {
     'typing:stop': void;
     'error': Error;
     'status': string;
+    'action:edit_entity': EditEntityAction;
+    'action:save_entity': SaveEntityAction;
+    'action:test_tool': TestToolAction;
+    'action:navigate': NavigateAction;
+    'tool:start': {
+        toolName: string;
+        args: Record<string, unknown>;
+    };
+    'tool:end': {
+        toolName: string;
+        result: unknown;
+        isError: boolean;
+    };
 }
 
 export declare interface ConnectionConfig {
     baseUrl: string;
     wsUrl?: string;
     userToken: string;
+    tiledesk?: TiledeskTransportConfig;
     reconnect?: boolean;
     maxReconnectAttempts?: number;
     reconnectInterval?: number;
@@ -164,6 +223,13 @@ declare interface CreateConversationResponse {
     status: string;
 }
 
+export declare interface EditEntityAction {
+    action: 'edit_entity';
+    entity_type: string;
+    entity_id: string | number;
+    fields: FieldUpdate[];
+}
+
 export declare class EventEmitter<Events extends Record<string, any>> {
     private handlers;
     on<K extends keyof Events & string>(event: K, handler: (data: Events[K]) => void): () => void;
@@ -172,6 +238,128 @@ export declare class EventEmitter<Events extends Record<string, any>> {
     removeAllListeners(): void;
 }
 
+export declare interface FieldUpdate {
+    field: string;
+    value: unknown;
+    previousValue?: unknown;
+}
+
+export declare class FormBridge extends EventEmitter<FormBridgeEvents> {
+    private registration;
+    private pendingEdits;
+    constructor(client: AikaaraChatClient);
+    /**
+     * Register a form to receive AI-driven edits.
+     * Only one form can be registered at a time (the active page).
+     */
+    registerForm(reg: FormRegistration): void;
+    /**
+     * Unregister the form (call on unmount).
+     */
+    unregisterForm(entityType: string, entityId: string | number): void;
+    /**
+     * Get the current form registration (if any).
+     */
+    get currentForm(): FormRegistration | null;
+    /**
+     * Manually push field updates (for custom tool handling).
+     */
+    pushFieldUpdates(entityType: string, entityId: string | number, fields: FieldUpdate[]): void;
+    /**
+     * Request the current form to save.
+     */
+    requestSave(): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Request the current form to run a test.
+     */
+    requestTest(params?: Record<string, unknown>): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    private setupListeners;
+}
+
+/**
+ * FormBridge — Enables AI agents to visually edit forms in the host application.
+ *
+ * This bridges the gap between AI tool results and UI form state. When the agent
+ * calls tools like `edit_current_entity`, the FormBridge receives the action and
+ * pushes field updates to the registered form.
+ *
+ * ## Usage (any framework)
+ *
+ * ```typescript
+ * import { AikaaraChatClient, FormBridge } from '@aikaara/chat-sdk/headless';
+ *
+ * const client = new AikaaraChatClient({ baseUrl, userToken, authToken });
+ * const bridge = new FormBridge(client);
+ *
+ * // Register a form (call when your form mounts)
+ * bridge.registerForm({
+ *   entityType: 'product',
+ *   entityId: 42,
+ *   onFieldUpdate: (fields) => {
+ *     for (const { field, value } of fields) {
+ *       formState[field] = value; // update your form framework
+ *     }
+ *   },
+ *   onSave: async () => await api.saveProduct(42, formState),
+ *   getCurrentValues: () => ({ ...formState }),
+ * });
+ *
+ * // Unregister when form unmounts
+ * bridge.unregisterForm('product', 42);
+ * ```
+ *
+ * ## React hook (provided by dashboard, but easy to replicate)
+ *
+ * ```tsx
+ * function useFormBridge(bridge, { entityType, entityId, onFieldUpdate, onSave }) {
+ *   useEffect(() => {
+ *     bridge.registerForm({ entityType, entityId, onFieldUpdate, onSave, getCurrentValues });
+ *     return () => bridge.unregisterForm(entityType, entityId);
+ *   }, [entityType, entityId]);
+ * }
+ * ```
+ */
+export declare interface FormBridgeEvents {
+    'edit:applied': {
+        entityType: string;
+        entityId: string | number;
+        fields: FieldUpdate[];
+    };
+    'edit:pending': {
+        entityType: string;
+        entityId: string | number;
+        fields: FieldUpdate[];
+    };
+    'save:success': {
+        entityType: string;
+        entityId: string | number;
+    };
+    'save:error': {
+        entityType: string;
+        entityId: string | number;
+        error: string;
+    };
+    'test:triggered': {
+        toolId: number;
+        parameters: Record<string, unknown>;
+    };
+}
+
+export declare interface FormRegistration {
+    entityType: string;
+    entityId: string | number;
+    onFieldUpdate: (fields: FieldUpdate[]) => void;
+    onSave: () => Promise<void>;
+    onTest?: (params?: Record<string, unknown>) => Promise<void>;
+    getCurrentValues: () => Record<string, unknown>;
+}
+
 export declare interface Message {
     id: string;
     conversationId: string;
@@ -205,8 +393,64 @@ export declare class MessageStore {
     clear(): void;
 }
 
+export declare interface NavigateAction {
+    navigate_to: string;
+}
+
+export declare interface SaveEntityAction {
+    action: 'save_entity';
+}
+
 declare type SubscriptionCallback = (data: unknown) => void;
 
+export declare interface TestToolAction {
+    action: 'test_tool';
+    tool_id: number;
+    parameters: Record<string, unknown>;
+}
+
+export declare interface TiledeskMessage {
+    text?: string;
+    type?: string;
+    sender?: string;
+    senderFullname?: string;
+    recipient?: string;
+    timestamp?: number;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+export declare class TiledeskTransport {
+    private client;
+    private config;
+    private messageHandlers;
+    private stateHandlers;
+    private subscribedTopics;
+    private reconnectAttempt;
+    private maxReconnectAttempts;
+    private disposed;
+    constructor(config: TiledeskTransportConfig);
+    connect(): Promise<void>;
+    subscribeToConversation(conversationId: string): void;
+    unsubscribeFromConversation(conversationId: string): void;
+    publishMessage(conversationId: string, text: string): void;
+    onMessage(handler: TransportMessageHandler): () => void;
+    onStateChange(handler: TransportStateHandler): () => void;
+    disconnect(): void;
+    get isConnected(): boolean;
+    private scheduleReconnect;
+    private notifyStateChange;
+}
+
+export declare interface TiledeskTransportConfig {
+    mqttEndpoint: string;
+    jwtToken: string;
+    userId: string;
+    userName?: string;
+    projectId: string;
+}
+
 export declare interface ToolCall {
     id: string;
     type: 'function';
@@ -221,6 +465,10 @@ export declare interface ToolCallResult {
     content: string;
 }
 
+export declare type TransportMessageHandler = (message: TiledeskMessage) => void;
+
+export declare type TransportStateHandler = (connected: boolean) => void;
+
 export declare interface WidgetConfig extends ChatClientConfig {
     position?: 'bottom-right' | 'bottom-left';
     offset?: {