@aikaara/chat-sdk 0.2.0 → 0.3.0

package/dist/headless.d.ts

@@ -33,14 +33,39 @@ export declare type AgentEventType = 'status' | 'error' | 'agent_start' | 'agent
 
 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[];
@@ -65,6 +90,8 @@ export 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`,
@@ -131,11 +158,30 @@ export 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;
 }
 
 export declare interface ChatEvents {
@@ -223,6 +269,8 @@ declare interface CreateConversationResponse {
     status: string;
 }
 
+export declare function createFetchUploadAdapter(config: FetchUploadAdapterConfig): UploadAdapter;
+
 export declare interface EditEntityAction {
     action: 'edit_entity';
     entity_type: string;
@@ -238,6 +286,18 @@ 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;
@@ -360,10 +420,19 @@ export declare interface FormRegistration {
     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;
@@ -371,7 +440,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 {
@@ -379,6 +460,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;
@@ -397,50 +494,175 @@ export declare interface NavigateAction {
     navigate_to: string;
 }
 
+export declare function parseTiledeskTemplate(message: TiledeskMessage): TiledeskParsedTemplate;
+
 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): 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 {
@@ -449,6 +671,28 @@ export declare interface TiledeskTransportConfig {
     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 {
@@ -465,10 +709,35 @@ export declare interface ToolCallResult {
     content: string;
 }
 
-export declare type TransportMessageHandler = (message: TiledeskMessage) => void;
+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 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?: {
@@ -491,6 +760,7 @@ export declare interface WidgetConfig extends ChatClientConfig {
     showBubble?: boolean;
     bubbleText?: string;
     bubbleIcon?: string;
+    uploadAdapter?: UploadAdapter;
 }
 
 export { }