@aikaara/chat-sdk 0.1.4 → 0.3.0

package/dist/index.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;
@@ -39,20 +41,72 @@ export declare class AikaaraChatBubble extends HTMLElement {
 
 export declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
     private connection;
+    private tiledesk;
     private api;
     private messageStore;
     private conversationManager;
     private subscription;
     private config;
-    constructor(config: ChatClientConfig);
+    private mode;
+    private uploadAdapter;
+    private tiledeskUnsubs;
+    constructor(config: ChatClientConfig, opts?: {
+        uploadAdapter?: UploadAdapter;
+    });
+    private usesAikaara;
+    private usesTiledesk;
+    private initTiledeskTransport;
     connect(): Promise<void>;
     sendMessage(content: string): Promise<void>;
+    /**
+     * Upload a file via the configured UploadAdapter (client-side: file goes
+     * to the tenant's own backend, never through Aikaara). Then publish the
+     * Tiledesk file-message envelope so hooks_controller picks it up.
+     */
+    sendFile(file: File | Blob, opts?: {
+        caption?: string;
+    }): Promise<void>;
+    /**
+     * Trigger Tiledesk's CHAT_INITIATED event — required to kick off a bot flow
+     * for newly-created Tiledesk request groups.
+     */
+    initiateTiledeskChat(extraAttributes?: Record<string, unknown>): void;
+    /** Mark a Tiledesk message as read (publishes status=300 update). */
+    markTiledeskRead(messageId: string): void;
+    setUploadAdapter(adapter: UploadAdapter): void;
     sendUserEvent(eventKey: string, value?: object, source?: string): Promise<void>;
     loadHistory(): Promise<Message[]>;
     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>;
+    private handleTiledeskMessage;
+    private handleTiledeskStatusUpdate;
+    /**
+     * 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;
 }
 
@@ -93,8 +147,11 @@ export declare class AikaaraChatWidget extends HTMLElement {
     attributeChangedCallback(_name: string, oldVal: string, newVal: string): void;
     configure(config: Partial<WidgetConfig>): void;
     private getConfig;
+    setUploadAdapter(adapter: UploadAdapter): void;
     private render;
     private initController;
+    sendUserEvent(eventKey: string, value?: Record<string, unknown>, source?: string): void;
+    getClient(): AikaaraChatClient | null;
     private darkenColor;
 }
 
@@ -110,11 +167,19 @@ export declare class AikaaraErrorBanner extends HTMLElement {
 
 export declare class AikaaraMessageBubble extends HTMLElement {
     private shadow;
+    private templatePayload;
+    private attachments;
     static get observedAttributes(): string[];
     constructor();
     connectedCallback(): void;
     attributeChangedCallback(): void;
+    setTemplatePayload(payload: unknown): void;
+    setAttachments(attachments: Array<{
+        fileName: string;
+        fileUrl: string;
+    }>): void;
     private render;
+    private renderAttachments;
 }
 
 export declare class AikaaraMessageList extends HTMLElement {
@@ -133,6 +198,13 @@ export declare class AikaaraMessageList extends HTMLElement {
     showTypingIndicator(): void;
     removeTypingIndicator(): void;
     private appendMessageElement;
+    /**
+     * Replace an existing rendered message (matched by id or externalId) in place.
+     * Used when a Tiledesk self-echo reconciles with an optimistic bubble or when
+     * a status update flips delivered → read.
+     */
+    upsertMessage(message: Message): void;
+    private findRenderedMessage;
     private scrollToBottom;
     private formatTime;
 }
@@ -157,19 +229,36 @@ export declare class AikaaraTypingIndicator extends HTMLElement {
 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;
@@ -188,15 +277,35 @@ 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';
+    /**
+     * Transport selection.
+     * - `aikaara` (default): ActionCable to Aikaara Rails (AI streaming).
+     * - `tiledesk`: MQTT direct to a self-hosted Tiledesk + chat21 stack.
+     * - `dual`: both — Aikaara cable for AI, Tiledesk MQTT for live-agent + file events.
+     */
+    transport?: TransportMode;
+    /**
+     * Tiledesk-side identity. Required when `transport` is `tiledesk` or `dual`.
+     * `userId` here is the Tiledesk user `_id` and is also used as the SDK conversation
+     * subject — Aikaara conversations bound to this user via ext_uid mapping.
+     */
+    tiledeskIdentity?: {
+        userId: string;
+        userName?: string;
+        departmentId?: string;
+        senderFullname?: string;
+    };
     onMessage?: (message: Message) => void;
     onStatusChange?: (status: string) => void;
     onError?: (error: Error) => void;
     onStreamUpdate?: (delta: string, fullContent: string) => void;
     onConnectionStateChange?: (state: ConnectionState) => void;
+    onTemplateMessage?: (template: TemplateMessageEvent) => void;
 }
 
 export declare interface ChatEvents {
@@ -222,12 +331,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;
@@ -270,6 +393,15 @@ declare interface CreateConversationResponse {
     status: string;
 }
 
+export declare function createFetchUploadAdapter(config: FetchUploadAdapterConfig): UploadAdapter;
+
+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;
@@ -278,10 +410,153 @@ export declare class EventEmitter<Events extends Record<string, any>> {
     removeAllListeners(): void;
 }
 
+export declare function extractTiledeskFileEnvelope(message: TiledeskMessage): TiledeskFileEnvelope | null;
+
+export declare interface FetchUploadAdapterConfig {
+    endpoint: string;
+    method?: 'POST' | 'PUT';
+    fieldName?: string;
+    headers?: Record<string, string> | (() => Record<string, string> | Promise<Record<string, string>>);
+    credentials?: RequestCredentials;
+    extraFields?: Record<string, string> | ((ctx: UploadAdapterContext) => Record<string, string>);
+    parseResponse?: (raw: unknown, ctx: UploadAdapterContext) => UploadAdapterResult;
+}
+
+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 function inferTiledeskRole(message: TiledeskMessage, cfg: TiledeskRoleConfig): TiledeskRole;
+
+/**
+ * Self-echo detector — Tiledesk fans the user's outgoing publish back
+ * as a `clientadded` event on the same connection. UI must dedupe against
+ * the optimistic local message rather than rendering twice.
+ */
+export declare function isTiledeskSelfEcho(message: TiledeskMessage, userId: string): boolean;
+
 export declare interface Message {
     id: string;
     conversationId: string;
-    role: 'user' | 'assistant' | 'system' | 'tool';
+    role: 'user' | 'assistant' | 'system' | 'tool' | 'agent';
     content: string;
     toolCalls?: ToolCall[];
     toolCallResults?: ToolCallResult;
@@ -289,7 +564,19 @@ export declare interface Message {
     tokensOutput?: number;
     metadata?: Record<string, unknown>;
     createdAt: string;
-    status?: 'sending' | 'sent' | 'streaming' | 'complete' | 'error';
+    status?: 'sending' | 'sent' | 'delivered' | 'read' | 'streaming' | 'complete' | 'error';
+    externalId?: string;
+    template?: {
+        contentType?: string;
+        templateId?: string;
+        payload?: unknown;
+    };
+    attachments?: Array<{
+        fileName: string;
+        fileUrl: string;
+        cloudFileId?: string;
+        contentType?: string;
+    }>;
 }
 
 export declare class MessageStore {
@@ -297,6 +584,22 @@ export declare class MessageStore {
     private optimisticCounter;
     get messages(): Message[];
     addOptimistic(role: 'user', content: string, conversationId: string): Message;
+    /**
+     * Reconcile a remote message against an outstanding optimistic message.
+     * Tiledesk fans the user's outgoing publish back as an inbound clientadded —
+     * dedupe by exact content + recency window so the optimistic bubble keeps
+     * its position and we don't render duplicates.
+     */
+    reconcileOptimistic(remote: Message, recencyMs?: number): Message | null;
+    /**
+     * Append a remote-originated message (e.g. from Tiledesk MQTT). If a matching
+     * optimistic message exists it is reconciled in place; otherwise appended.
+     */
+    upsertRemoteMessage(remote: Message): {
+        message: Message;
+        deduped: boolean;
+    };
+    updateMessageStatus(externalId: string, status: Message['status']): Message | undefined;
     confirmOptimistic(tempId: string): void;
     addStreamingMessage(conversationId: string): Message;
     updateStreaming(content: string): void;
@@ -313,10 +616,213 @@ export declare class MessageStore {
 
 export declare function mount(config: WidgetConfig): AikaaraChatWidget;
 
+export declare interface NavigateAction {
+    navigate_to: string;
+}
+
+export declare function parseTiledeskTemplate(message: TiledeskMessage): TiledeskParsedTemplate;
+
 export declare function registerComponents(): void;
 
+export declare interface SaveEntityAction {
+    action: 'save_entity';
+}
+
 declare type SubscriptionCallback = (data: unknown) => void;
 
+declare interface TemplateMessageEvent {
+    messageId: string;
+    conversationId: string;
+    role: 'user' | 'assistant' | 'system' | 'agent';
+    contentType?: string;
+    templateId?: string;
+    payload?: unknown;
+    innerMessage?: string;
+    raw: unknown;
+}
+
+export declare interface TestToolAction {
+    action: 'test_tool';
+    tool_id: number;
+    parameters: Record<string, unknown>;
+}
+
+export declare interface TiledeskFileEnvelope {
+    fileName?: string;
+    fileUrl?: string;
+    cloudFileId?: string;
+    templateId?: string;
+}
+
+export declare interface TiledeskFileMessageInput {
+    fileName: string;
+    fileUrl: string;
+    cloudFileId?: string;
+    templateId?: string;
+    headerImgSrc?: string;
+    type?: 'link' | 'image';
+    isDeepLink?: boolean;
+    description?: string;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+}
+
+export declare interface TiledeskFileTemplateConfig {
+    templateId: string;
+    headerImgSrc?: string;
+    type?: 'link' | 'image';
+    isDeepLink?: boolean;
+}
+
+export declare interface TiledeskMessage {
+    text?: string;
+    type?: string;
+    sender?: string;
+    senderFullname?: string;
+    sender_fullname?: string;
+    recipient?: string;
+    recipient_fullname?: string;
+    channel_type?: string;
+    timestamp?: number;
+    app_id?: string;
+    message_id?: string;
+    status?: number;
+    attributes?: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+    [key: string]: unknown;
+}
+
+export declare interface TiledeskMessageContext {
+    topic: string;
+    conversationId?: string;
+    messageId?: string;
+    kind: 'clientadded' | 'update' | 'unknown';
+}
+
+export declare interface TiledeskMessageDefaults {
+    channelType?: string;
+    channel?: string;
+    requestChannel?: string;
+    platform?: string;
+    medium?: string;
+    departmentId?: string;
+    attributes?: Record<string, unknown>;
+}
+
+export declare interface TiledeskParsedTemplate {
+    contentType?: string;
+    templateId?: string;
+    payload?: unknown;
+    innerMessage?: string;
+    raw: TiledeskMessage;
+}
+
+export declare type TiledeskRole = 'user' | 'assistant' | 'system' | 'agent';
+
+export declare interface TiledeskRoleConfig {
+    userId: string;
+    systemSenders?: string[];
+    botSenderPrefix?: string;
+}
+
+export declare interface TiledeskStatusUpdate {
+    conversationId: string;
+    messageId: string;
+    status: number;
+    raw: Record<string, unknown>;
+}
+
+export declare interface TiledeskTopicTemplates {
+    inbound?: string;
+    inboundUpdate?: string;
+    outbound?: string;
+    presence?: string;
+    wildcardSubscribe?: string;
+}
+
+export declare class TiledeskTransport {
+    private client;
+    private config;
+    private currentToken;
+    private clientId;
+    private appId;
+    private topics;
+    private messageHandlers;
+    private stateHandlers;
+    private statusUpdateHandlers;
+    private subscribedTopics;
+    private reconnectAttempt;
+    private maxReconnectAttempts;
+    private reconnectMaxDelayMs;
+    private disposed;
+    private reconnectTimer;
+    private inboundRegex;
+    private inboundUpdateRegex;
+    constructor(config: TiledeskTransportConfig);
+    connect(): Promise<void>;
+    subscribeWildcard(): void;
+    subscribeToConversation(conversationId: string): void;
+    unsubscribeFromConversation(conversationId: string): void;
+    publishMessage(conversationId: string, text: string, overrides?: Partial<TiledeskMessage>): void;
+    publishFileMessage(conversationId: string, file: TiledeskFileMessageInput): void;
+    publishRaw(conversationId: string, message: TiledeskMessage): void;
+    /**
+     * Send a read receipt for a message. Tiledesk widgets publish
+     * `{"status":300}` to apps/{appId}/users/{userId}/messages/{convId}/{msgId}/update.
+     */
+    publishReadReceipt(conversationId: string, messageId: string, status?: number): void;
+    /**
+     * Trigger conversation kickoff. Tiledesk bot routing waits for the
+     * widget to publish a CHAT_INITIATED event before the bot replies.
+     */
+    publishChatInitiated(conversationId: string, extraAttributes?: Record<string, unknown>): void;
+    onMessage(handler: TransportMessageHandler): () => void;
+    onStateChange(handler: TransportStateHandler): () => void;
+    onStatusUpdate(handler: TransportStatusUpdateHandler): () => void;
+    disconnect(): void;
+    get isConnected(): boolean;
+    private scheduleReconnect;
+    private notifyStateChange;
+    private dispatchInbound;
+    private buildOutgoingEnvelope;
+    private publishEnvelope;
+    private renderInboundTopic;
+    private renderOutboundTopic;
+    private renderPresenceTopic;
+    private renderTemplate;
+    private buildTopicRegex;
+}
+
+export declare interface TiledeskTransportConfig {
+    mqttEndpoint: string;
+    jwtToken: string;
+    userId: string;
+    userName?: string;
+    projectId: string;
+    appId?: string;
+    clientId?: string;
+    protocolVersion?: 3 | 4 | 5;
+    protocolId?: 'MQIsdp' | 'MQTT';
+    mqttUsername?: string;
+    connectTimeoutMs?: number;
+    keepAliveSec?: number;
+    maxReconnectAttempts?: number;
+    reconnectMaxDelayMs?: number;
+    tokenProvider?: () => Promise<string>;
+    wildcardSubscribe?: boolean;
+    subscribeQos?: 0 | 1 | 2;
+    publishQos?: 0 | 1 | 2;
+    publishRetain?: boolean;
+    enablePresence?: boolean;
+    presencePayloadConnected?: Record<string, unknown>;
+    presencePayloadDisconnected?: Record<string, unknown>;
+    topicTemplates?: TiledeskTopicTemplates;
+    messageDefaults?: TiledeskMessageDefaults;
+    fileTemplate?: TiledeskFileTemplateConfig;
+    recipientFullnameResolver?: (conversationId: string) => string | undefined;
+    senderFullname?: string;
+}
+
 export declare interface ToolCall {
     id: string;
     type: 'function';
@@ -331,8 +837,37 @@ export declare interface ToolCallResult {
     content: string;
 }
 
+export declare type TransportMessageHandler = (message: TiledeskMessage, ctx: TiledeskMessageContext) => void;
+
+declare type TransportMode = 'aikaara' | 'tiledesk' | 'dual';
+
+export declare type TransportStateHandler = (connected: boolean) => void;
+
+export declare type TransportStatusUpdateHandler = (update: TiledeskStatusUpdate) => void;
+
 export declare function unmount(): void;
 
+export declare interface UploadAdapter {
+    upload(file: File | Blob, ctx: UploadAdapterContext): Promise<UploadAdapterResult>;
+}
+
+export declare interface UploadAdapterContext {
+    conversationId: string;
+    userId: string;
+    projectId?: string;
+    appId?: string;
+}
+
+export declare interface UploadAdapterResult {
+    url: string;
+    fileName: string;
+    cloudFileId?: string;
+    relativePath?: string;
+    contentType?: string;
+    byteSize?: number;
+    meta?: Record<string, unknown>;
+}
+
 export declare interface WidgetConfig extends ChatClientConfig {
     position?: 'bottom-right' | 'bottom-left';
     offset?: {
@@ -355,6 +890,7 @@ export declare interface WidgetConfig extends ChatClientConfig {
     showBubble?: boolean;
     bubbleText?: string;
     bubbleIcon?: string;
+    uploadAdapter?: UploadAdapter;
 }
 
 export { }