@aikaara/chat-sdk 0.2.0 → 0.3.0

package/dist/ui.d.ts

@@ -8,14 +8,39 @@ export declare class AikaaraChatBubble extends HTMLElement {
 
 declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
     private connection;
+    private tiledesk;
     private api;
     private messageStore;
     private conversationManager;
     private subscription;
     private config;
-    constructor(config: ChatClientConfig_2);
+    private mode;
+    private uploadAdapter;
+    private tiledeskUnsubs;
+    constructor(config: ChatClientConfig_2, opts?: {
+        uploadAdapter?: UploadAdapter_2;
+    });
+    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_2): void;
     sendUserEvent(eventKey: string, value?: object, source?: string): Promise<void>;
     loadHistory(): Promise<Message_2[]>;
     get messages(): Message_2[];
@@ -40,6 +65,8 @@ declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
      */
     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`,
@@ -87,6 +114,7 @@ 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;
@@ -106,11 +134,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 {
@@ -129,6 +165,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;
 }
@@ -142,6 +185,27 @@ export declare class AikaaraStreamingMessage extends HTMLElement {
     finalize(): void;
 }
 
+/**
+ * Renders Tiledesk contentType=300 template payloads.
+ *
+ * Slot-based override system — tenants ship a cloud-hosted bundle that
+ * registers `<aikaara-template-{templateId}>` custom elements; this component
+ * looks one up by `template-id` attribute and mounts it as a child. If no
+ * tenant override is registered, a no-op fallback renders the inner message
+ * (TaxBuddy-style nested envelope) so the chat at least shows readable text.
+ */
+export declare class AikaaraTemplateRenderer extends HTMLElement {
+    private shadow;
+    private payloadData;
+    private innerMessage;
+    static get observedAttributes(): string[];
+    constructor();
+    connectedCallback(): void;
+    attributeChangedCallback(): void;
+    setPayload(payload: unknown, innerMessage?: string): void;
+    private render;
+}
+
 export declare class AikaaraTypingIndicator extends HTMLElement {
     private shadow;
     constructor();
@@ -172,11 +236,30 @@ declare interface ChatClientConfig extends ConnectionConfig {
     conversationId?: string;
     systemPromptId?: number;
     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;
 }
 
 declare interface ChatClientConfig_2 extends ConnectionConfig_2 {
@@ -186,11 +269,30 @@ declare interface ChatClientConfig_2 extends ConnectionConfig_2 {
     conversationId?: string;
     systemPromptId?: number;
     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_2;
+    /**
+     * 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_2) => void;
     onStatusChange?: (status: string) => void;
     onError?: (error: Error) => void;
     onStreamUpdate?: (delta: string, fullContent: string) => void;
     onConnectionStateChange?: (state: ConnectionState_2) => void;
+    onTemplateMessage?: (template: TemplateMessageEvent_2) => void;
 }
 
 declare interface ChatEvents {
@@ -279,7 +381,7 @@ declare interface FieldUpdate {
 declare interface Message {
     id: string;
     conversationId: string;
-    role: 'user' | 'assistant' | 'system' | 'tool';
+    role: 'user' | 'assistant' | 'system' | 'tool' | 'agent';
     content: string;
     toolCalls?: ToolCall[];
     toolCallResults?: ToolCallResult;
@@ -287,13 +389,25 @@ 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;
+    }>;
 }
 
 declare interface Message_2 {
     id: string;
     conversationId: string;
-    role: 'user' | 'assistant' | 'system' | 'tool';
+    role: 'user' | 'assistant' | 'system' | 'tool' | 'agent';
     content: string;
     toolCalls?: ToolCall_2[];
     toolCallResults?: ToolCallResult_2;
@@ -301,7 +415,19 @@ declare interface Message_2 {
     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;
+    }>;
 }
 
 declare interface NavigateAction {
@@ -314,18 +440,112 @@ declare interface SaveEntityAction {
     action: 'save_entity';
 }
 
+declare interface TemplateMessageEvent {
+    messageId: string;
+    conversationId: string;
+    role: 'user' | 'assistant' | 'system' | 'agent';
+    contentType?: string;
+    templateId?: string;
+    payload?: unknown;
+    innerMessage?: string;
+    raw: unknown;
+}
+
+declare interface TemplateMessageEvent_2 {
+    messageId: string;
+    conversationId: string;
+    role: 'user' | 'assistant' | 'system' | 'agent';
+    contentType?: string;
+    templateId?: string;
+    payload?: unknown;
+    innerMessage?: string;
+    raw: unknown;
+}
+
 declare interface TestToolAction {
     action: 'test_tool';
     tool_id: number;
     parameters: Record<string, unknown>;
 }
 
+declare interface TiledeskFileTemplateConfig {
+    templateId: string;
+    headerImgSrc?: string;
+    type?: 'link' | 'image';
+    isDeepLink?: boolean;
+}
+
+declare interface TiledeskFileTemplateConfig_2 {
+    templateId: string;
+    headerImgSrc?: string;
+    type?: 'link' | 'image';
+    isDeepLink?: boolean;
+}
+
+declare interface TiledeskMessageDefaults {
+    channelType?: string;
+    channel?: string;
+    requestChannel?: string;
+    platform?: string;
+    medium?: string;
+    departmentId?: string;
+    attributes?: Record<string, unknown>;
+}
+
+declare interface TiledeskMessageDefaults_2 {
+    channelType?: string;
+    channel?: string;
+    requestChannel?: string;
+    platform?: string;
+    medium?: string;
+    departmentId?: string;
+    attributes?: Record<string, unknown>;
+}
+
+declare interface TiledeskTopicTemplates {
+    inbound?: string;
+    inboundUpdate?: string;
+    outbound?: string;
+    presence?: string;
+    wildcardSubscribe?: string;
+}
+
+declare interface TiledeskTopicTemplates_2 {
+    inbound?: string;
+    inboundUpdate?: string;
+    outbound?: string;
+    presence?: string;
+    wildcardSubscribe?: string;
+}
+
 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;
 }
 
 declare interface TiledeskTransportConfig_2 {
@@ -334,6 +554,28 @@ declare interface TiledeskTransportConfig_2 {
     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_2;
+    messageDefaults?: TiledeskMessageDefaults_2;
+    fileTemplate?: TiledeskFileTemplateConfig_2;
+    recipientFullnameResolver?: (conversationId: string) => string | undefined;
+    senderFullname?: string;
 }
 
 declare interface ToolCall {
@@ -364,6 +606,52 @@ declare interface ToolCallResult_2 {
     content: string;
 }
 
+declare type TransportMode = 'aikaara' | 'tiledesk' | 'dual';
+
+declare type TransportMode_2 = 'aikaara' | 'tiledesk' | 'dual';
+
+declare interface UploadAdapter {
+    upload(file: File | Blob, ctx: UploadAdapterContext): Promise<UploadAdapterResult>;
+}
+
+declare interface UploadAdapter_2 {
+    upload(file: File | Blob, ctx: UploadAdapterContext_2): Promise<UploadAdapterResult_2>;
+}
+
+declare interface UploadAdapterContext {
+    conversationId: string;
+    userId: string;
+    projectId?: string;
+    appId?: string;
+}
+
+declare interface UploadAdapterContext_2 {
+    conversationId: string;
+    userId: string;
+    projectId?: string;
+    appId?: string;
+}
+
+declare interface UploadAdapterResult {
+    url: string;
+    fileName: string;
+    cloudFileId?: string;
+    relativePath?: string;
+    contentType?: string;
+    byteSize?: number;
+    meta?: Record<string, unknown>;
+}
+
+declare interface UploadAdapterResult_2 {
+    url: string;
+    fileName: string;
+    cloudFileId?: string;
+    relativePath?: string;
+    contentType?: string;
+    byteSize?: number;
+    meta?: Record<string, unknown>;
+}
+
 declare interface WidgetConfig extends ChatClientConfig {
     position?: 'bottom-right' | 'bottom-left';
     offset?: {
@@ -386,6 +674,7 @@ declare interface WidgetConfig extends ChatClientConfig {
     showBubble?: boolean;
     bubbleText?: string;
     bubbleIcon?: string;
+    uploadAdapter?: UploadAdapter;
 }
 
 export { }