@aikaara/chat-sdk 0.3.0 → 0.3.3

package/dist/index.d.ts

@@ -49,15 +49,21 @@ export declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
     private config;
     private mode;
     private uploadAdapter;
+    private historyAdapter;
     private tiledeskUnsubs;
     constructor(config: ChatClientConfig, opts?: {
         uploadAdapter?: UploadAdapter;
+        historyAdapter?: ConversationHistoryAdapter;
     });
     private usesAikaara;
     private usesTiledesk;
     private initTiledeskTransport;
     connect(): Promise<void>;
-    sendMessage(content: string): Promise<void>;
+    private hydrateTiledeskHistory;
+    sendMessage(content: string, opts?: {
+        attributes?: Record<string, unknown>;
+        metadata?: Record<string, unknown>;
+    }): 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
@@ -121,17 +127,38 @@ export declare class AikaaraChatHeader extends HTMLElement {
     setStatus(status: string): void;
 }
 
+/**
+ * Chat input box. Composes a textarea + send button + optional attach button.
+ *
+ * Events fired (composed:true so they cross shadow boundaries):
+ *   - `send`      `{ content: string }`           — user pressed enter / clicked send
+ *   - `file-pick` `{ file: File }`                — user selected a file to upload
+ *
+ * Attributes:
+ *   - `placeholder`     placeholder text
+ *   - `disable-attach`  hides the attach button (set when host has no uploadAdapter)
+ *   - `accept`          forwarded to the hidden <input type="file">
+ *   - `multiple`        allow selecting multiple files
+ */
 export declare class AikaaraChatInput extends HTMLElement {
     private shadow;
     private textarea;
     private sendBtn;
+    private attachBtn;
+    private fileInput;
     private _disabled;
+    private _uploading;
     constructor();
+    static get observedAttributes(): string[];
     connectedCallback(): void;
     set disabled(val: boolean);
     get disabled(): boolean;
+    /** Toggle the attach button into a "uploading…" spinner state. */
+    set uploading(val: boolean);
+    get uploading(): boolean;
     focus(): void;
     clear(): void;
+    private refreshSendDisabled;
     private handleSend;
     private autoGrow;
 }
@@ -148,6 +175,7 @@ export declare class AikaaraChatWidget extends HTMLElement {
     configure(config: Partial<WidgetConfig>): void;
     private getConfig;
     setUploadAdapter(adapter: UploadAdapter): void;
+    setHistoryAdapter(adapter: ConversationHistoryAdapter): void;
     private render;
     private initController;
     sendUserEvent(eventKey: string, value?: Record<string, unknown>, source?: string): void;
@@ -300,6 +328,13 @@ export declare interface ChatClientConfig extends ConnectionConfig {
         departmentId?: string;
         senderFullname?: string;
     };
+    /**
+     * Tenant-level defaults merged into the `action` object of every template
+     * postback (e.g. submit-action click). Useful for app-specific keys like
+     * `serviceType: 'ITR'` that the bot expects on every form submission.
+     * Per-submit values from the form take precedence over these defaults.
+     */
+    templateActionAttributes?: Record<string, unknown>;
     onMessage?: (message: Message) => void;
     onStatusChange?: (status: string) => void;
     onError?: (error: Error) => void;
@@ -346,6 +381,8 @@ export declare interface ChatEvents {
     };
 }
 
+export declare function clearPersistedConversationId(userId: string, projectId: string): void;
+
 export declare interface ConnectionConfig {
     baseUrl: string;
     wsUrl?: string;
@@ -377,6 +414,19 @@ export declare class ConnectionManager extends EventEmitter<ChatEvents> {
 
 export declare type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 'reconnecting';
 
+/**
+ * Pluggable adapter that hydrates prior conversation messages on connect.
+ * The SDK calls this once after MQTT subscribes so the user sees existing
+ * history before any new live messages arrive.
+ */
+export declare interface ConversationHistoryAdapter {
+    fetchMessages(conversationId: string, ctx: {
+        userId: string;
+        appId?: string;
+        projectId?: string;
+    }): Promise<TiledeskMessage[]>;
+}
+
 export declare class ConversationManager {
     private _conversationId;
     private persist;
@@ -395,6 +445,8 @@ declare interface CreateConversationResponse {
 
 export declare function createFetchUploadAdapter(config: FetchUploadAdapterConfig): UploadAdapter;
 
+export declare function createTiledeskHistoryAdapter(config: TiledeskHistoryAdapterConfig): ConversationHistoryAdapter;
+
 export declare interface EditEntityAction {
     action: 'edit_entity';
     entity_type: string;
@@ -616,6 +668,20 @@ export declare class MessageStore {
 
 export declare function mount(config: WidgetConfig): AikaaraChatWidget;
 
+export declare interface MountedTenantWidget {
+    widget: AikaaraChatWidget;
+    requestId: string;
+    config: WidgetConfig;
+    destroy: () => void;
+}
+
+/**
+ * Standard tenant mount. Fetches the descriptor (when `configUrl` is set),
+ * merges per-mount overrides, builds default adapters from the descriptor's
+ * endpoint URLs (when no override is supplied), and mounts the widget.
+ */
+export declare function mountTenantWidget(opts: TenantMountOptions): Promise<MountedTenantWidget>;
+
 export declare interface NavigateAction {
     navigate_to: string;
 }
@@ -641,6 +707,43 @@ declare interface TemplateMessageEvent {
     raw: unknown;
 }
 
+export declare interface TenantMountOptions {
+    container: HTMLElement;
+    /** Fetched from this URL when `config` is omitted. */
+    configUrl?: string;
+    /** Pre-resolved descriptor — skip the fetch. */
+    config?: WidgetConfigDescriptor;
+    /** Headers attached when fetching `configUrl` (e.g. tenant-API auth). */
+    configHeaders?: Record<string, string>;
+    identity: {
+        userId: string;
+        userName?: string;
+        departmentId?: string;
+        senderFullname?: string;
+    };
+    /** Returns a raw Tiledesk JWT (no Bearer/JWT prefix) for MQTT password. */
+    tokenProvider: () => Promise<string>;
+    /** Authorization value for the history fetch. Defaults to `tokenProvider()`. */
+    historyTokenProvider?: () => Promise<string>;
+    /**
+     * Optional override adapters. If omitted and the descriptor specifies the
+     * matching endpoint, the SDK builds default fetch-based adapters.
+     */
+    uploadAdapter?: UploadAdapter;
+    historyAdapter?: ConversationHistoryAdapter;
+    /**
+     * Pin a conversationId. When omitted we look up
+     * `aikaara_chat:requestId:{userId}:{projectId}` in localStorage and reuse
+     * any persisted value; only mint a fresh `requestId` when nothing is stored.
+     */
+    conversationId?: string;
+    forceNewConversation?: boolean;
+    /** Per-mount overrides that take precedence over the descriptor. */
+    overrides?: Partial<WidgetConfigDescriptor>;
+    /** Surfaced from the SDK. */
+    onError?: (err: Error) => void;
+}
+
 export declare interface TestToolAction {
     action: 'test_tool';
     tool_id: number;
@@ -674,6 +777,32 @@ export declare interface TiledeskFileTemplateConfig {
     isDeepLink?: boolean;
 }
 
+export declare interface TiledeskHistoryAdapterConfig {
+    /**
+     * Base URL of the Tiledesk chat API, e.g. `https://uat-tiledesk.taxbuddy.com/chatapi/api`
+     * (no trailing slash). Final URL is composed as
+     *   `{apiBase}/tilechat/{userId}/conversations/{conversationId}/messages?pageSize={pageSize}`
+     */
+    apiBase: string;
+    pageSize?: number;
+    /**
+     * Async getter for the bearer token. Most Tiledesk-fronted gateways accept
+     * the same JWT used for the MQTT connection. Return `null` to omit the
+     * `Authorization` header.
+     */
+    getToken?: () => string | null | Promise<string | null>;
+    /** Override the path template. Default mirrors bandhan's chatapi route. */
+    pathTemplate?: string;
+    /** Extra static headers to attach (e.g. `partnerid`, `environment`). */
+    extraHeaders?: Record<string, string>;
+    /**
+     * Optional response shape mapper. Default expects
+     *   `{ success: true, result: TiledeskMessage[] }`
+     * which matches the bandhan `/chatapi/api/tilechat/.../messages` response.
+     */
+    parseResponse?: (raw: unknown) => TiledeskMessage[];
+}
+
 export declare interface TiledeskMessage {
     text?: string;
     type?: string;
@@ -760,6 +889,7 @@ export declare class TiledeskTransport {
     private inboundUpdateRegex;
     constructor(config: TiledeskTransportConfig);
     connect(): Promise<void>;
+    private debugLog;
     subscribeWildcard(): void;
     subscribeToConversation(conversationId: string): void;
     unsubscribeFromConversation(conversationId: string): void;
@@ -821,6 +951,20 @@ export declare interface TiledeskTransportConfig {
     fileTemplate?: TiledeskFileTemplateConfig;
     recipientFullnameResolver?: (conversationId: string) => string | undefined;
     senderFullname?: string;
+    /**
+     * If true (default), AikaaraChatClient publishes a `CHAT_INITIATED` event
+     * to the conversation's outbound topic on first connect — but only when
+     * the conversation history is empty (so reload of an in-flight chat
+     * doesn't replay the kickoff).
+     */
+    autoInitiateOnEmpty?: boolean;
+    /** Extra attributes merged into the auto-fired CHAT_INITIATED envelope. */
+    chatInitiatedAttributes?: Record<string, unknown>;
+    /**
+     * Log decoded MQTT frames to console as they're sent/received.
+     * Off by default — set true for debugging Tiledesk wire traffic.
+     */
+    debug?: boolean;
 }
 
 export declare interface ToolCall {
@@ -891,6 +1035,70 @@ export declare interface WidgetConfig extends ChatClientConfig {
     bubbleText?: string;
     bubbleIcon?: string;
     uploadAdapter?: UploadAdapter;
+    historyAdapter?: ConversationHistoryAdapter;
+    /**
+     * Display mode:
+     *   - `popup` (default): floating bubble in the corner, click to open panel.
+     *   - `embed`: render the chat panel inline at the host element's location,
+     *     filling its container. Bubble + open/close animation are skipped.
+     */
+    display?: 'popup' | 'embed';
+}
+
+export declare interface WidgetConfigDescriptor {
+    /** Visuals */
+    display?: 'popup' | 'embed';
+    position?: 'bottom-right' | 'bottom-left';
+    primaryColor?: string;
+    title?: string;
+    subtitle?: string;
+    avatarUrl?: string;
+    width?: number;
+    height?: number;
+    borderRadius?: number;
+    fontFamily?: string;
+    welcomeMessage?: string;
+    placeholder?: string;
+    showTimestamps?: boolean;
+    persistConversation?: boolean;
+    /** Transport selection */
+    transport?: TransportMode;
+    /** Tiledesk wire config (JSON-serializable subset of TiledeskTransportConfig) */
+    tiledesk?: {
+        mqttEndpoint: string;
+        appId?: string;
+        projectId: string;
+        mqttUsername?: string;
+        protocolId?: 'MQIsdp' | 'MQTT';
+        protocolVersion?: 3 | 4 | 5;
+        keepAliveSec?: number;
+        connectTimeoutMs?: number;
+        maxReconnectAttempts?: number;
+        reconnectMaxDelayMs?: number;
+        wildcardSubscribe?: boolean;
+        enablePresence?: boolean;
+        autoInitiateOnEmpty?: boolean;
+        chatInitiatedAttributes?: Record<string, unknown>;
+        messageDefaults?: TiledeskMessageDefaults;
+        fileTemplate?: TiledeskFileTemplateConfig;
+        topicTemplates?: TiledeskTopicTemplates;
+        debug?: boolean;
+        /**
+         * Pattern for `support-group-…` requestId minted on first chat. Use
+         * `{projectId}` and `{uuid}` placeholders. Defaults to bandhan's
+         * `support-group-{projectId}-{uuid}`.
+         */
+        requestIdTemplate?: string;
+    };
+    /** Defaults merged into every form-action postback */
+    templateActionAttributes?: Record<string, unknown>;
+    /** Adapter endpoints — SDK builds the actual fetch calls */
+    uploadEndpoint?: string;
+    uploadFieldName?: string;
+    uploadExtraFields?: Record<string, string>;
+    historyApiBase?: string;
+    historyPageSize?: number;
+    historyPathTemplate?: string;
 }
 
 export { }

package/dist/index.mjs

@@ -1,9 +1,8 @@
-import { A as m, a as u, b as h, C as k, c as g, d as C, E as A, M as b, T as f, e as T, i as M, f as v, p as w } from "./AikaaraChatClient-Cqbcd1jb.mjs";
-import { FormBridge as E, createFetchUploadAdapter as S } from "./headless.mjs";
-import { registerComponents as s } from "./ui.mjs";
-import { AikaaraChatBubble as B, AikaaraChatHeader as F, AikaaraChatInput as U, AikaaraChatWidget as I, AikaaraErrorBanner as j, AikaaraMessageBubble as q, AikaaraMessageList as H, AikaaraStreamingMessage as K, AikaaraTypingIndicator as L } from "./ui.mjs";
+import { r as o } from "./ui-BMGa0gZH.mjs";
+import { A as m, a as u, b as k, c as g, d as h, e as C, f as A, g as b, h as f, i as T, j as v, k as y, C as M, l as w, m as E, E as S, M as x, T as B, n as F, o as I, p as U, q as j } from "./ui-BMGa0gZH.mjs";
+import { FormBridge as H, clearPersistedConversationId as W, createFetchUploadAdapter as K, createTiledeskHistoryAdapter as L, mountTenantWidget as O } from "./headless.mjs";
 function l(e) {
-  s();
+  o();
   const a = document.createElement("aikaara-chat-widget"), r = {
     baseUrl: "base-url",
     userToken: "user-token",
@@ -19,42 +18,45 @@ function l(e) {
     welcomeMessage: "welcome-message",
     avatarUrl: "avatar-url"
   };
-  for (const [i, o] of Object.entries(r)) {
+  for (const [i, s] of Object.entries(r)) {
     const t = e[i];
-    t != null && a.setAttribute(o, String(t));
+    t != null && a.setAttribute(s, String(t));
   }
   return a.configure(e), document.body.appendChild(a), a;
 }
-function c() {
+function d() {
   const e = document.querySelector("aikaara-chat-widget");
   e && e.remove();
 }
 export {
   m as ActionCableClient,
-  B as AikaaraChatBubble,
-  u as AikaaraChatClient,
-  F as AikaaraChatHeader,
-  U as AikaaraChatInput,
-  I as AikaaraChatWidget,
-  j as AikaaraErrorBanner,
-  q as AikaaraMessageBubble,
-  H as AikaaraMessageList,
-  K as AikaaraStreamingMessage,
-  L as AikaaraTypingIndicator,
-  h as ApiClient,
-  k as ChannelSubscription,
-  g as ConnectionManager,
-  C as ConversationManager,
-  A as EventEmitter,
-  E as FormBridge,
-  b as MessageStore,
-  f as TiledeskTransport,
-  S as createFetchUploadAdapter,
-  T as extractTiledeskFileEnvelope,
-  M as inferTiledeskRole,
-  v as isTiledeskSelfEcho,
+  u as AikaaraChatBubble,
+  k as AikaaraChatClient,
+  g as AikaaraChatHeader,
+  h as AikaaraChatInput,
+  C as AikaaraChatWidget,
+  A as AikaaraErrorBanner,
+  b as AikaaraMessageBubble,
+  f as AikaaraMessageList,
+  T as AikaaraStreamingMessage,
+  v as AikaaraTypingIndicator,
+  y as ApiClient,
+  M as ChannelSubscription,
+  w as ConnectionManager,
+  E as ConversationManager,
+  S as EventEmitter,
+  H as FormBridge,
+  x as MessageStore,
+  B as TiledeskTransport,
+  W as clearPersistedConversationId,
+  K as createFetchUploadAdapter,
+  L as createTiledeskHistoryAdapter,
+  F as extractTiledeskFileEnvelope,
+  I as inferTiledeskRole,
+  U as isTiledeskSelfEcho,
   l as mount,
-  w as parseTiledeskTemplate,
-  s as registerComponents,
-  c as unmount
+  O as mountTenantWidget,
+  j as parseTiledeskTemplate,
+  o as registerComponents,
+  d as unmount
 };