@aikaara/chat-sdk 0.3.0 → 0.4.0

package/dist/ui.d.ts

@@ -1,3 +1,37 @@
+/**
+ * `<aikaara-chat>` declarative web component — the framework-agnostic entry.
+ *
+ * Use any framework / template engine / static HTML:
+ *
+ *   <aikaara-chat
+ *     slug="bandhan-itr"
+ *     user-id="33568"
+ *     user-name="G. Iyer"
+ *     user-token="eyJhbGc..."
+ *   ></aikaara-chat>
+ *
+ * For dynamic tokens (refresh on expiry), set the `tokenGetter` property
+ * instead of the attribute:
+ *
+ *   document.querySelector('aikaara-chat').tokenGetter = () => getJwt();
+ *
+ * The element calls `mountFromSlug()` internally — host code is reduced to
+ * a single tag.
+ */
+export declare class AikaaraChat extends HTMLElement {
+    static get observedAttributes(): string[];
+    /** Set programmatically when the session token must be refreshed dynamically. */
+    tokenGetter?: () => string | Promise<string>;
+    private mounted;
+    private mountInflight;
+    connectedCallback(): void;
+    disconnectedCallback(): void;
+    attributeChangedCallback(): void;
+    /** Force a fresh /chatbuddy/auth-style refetch. */
+    refreshAuth(): Promise<void>;
+    private tryMount;
+}
+
 export declare class AikaaraChatBubble extends HTMLElement {
     private shadow;
     constructor();
@@ -16,15 +50,21 @@ declare class AikaaraChatClient extends EventEmitter<ChatEvents> {
     private config;
     private mode;
     private uploadAdapter;
+    private historyAdapter;
     private tiledeskUnsubs;
     constructor(config: ChatClientConfig_2, opts?: {
         uploadAdapter?: UploadAdapter_2;
+        historyAdapter?: ConversationHistoryAdapter_2;
     });
     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
@@ -88,17 +128,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;
 }
@@ -115,6 +176,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;
@@ -176,6 +238,35 @@ export declare class AikaaraMessageList extends HTMLElement {
     private formatTime;
 }
 
+export declare class AikaaraModalAction extends HTMLElement {
+    private shadow;
+    private data;
+    private dismissed;
+    constructor();
+    connectedCallback(): void;
+    setPayload(payload: ModalActionPayload): void;
+    dismiss(): void;
+    private handleOk;
+    private render;
+}
+
+export declare class AikaaraOptionList extends HTMLElement {
+    private shadow;
+    private data;
+    private selected;
+    constructor();
+    connectedCallback(): void;
+    setPayload(payload: OptionListPayload): void;
+    /** Read selected values — used by parent submit action to collect form state. */
+    getValues(): {
+        name: string;
+        values: string[];
+        type: string;
+    };
+    private toggle;
+    private render;
+}
+
 export declare class AikaaraStreamingMessage extends HTMLElement {
     private shadow;
     private bubble;
@@ -185,14 +276,49 @@ export declare class AikaaraStreamingMessage extends HTMLElement {
     finalize(): void;
 }
 
+export declare class AikaaraSubmitAction extends HTMLElement {
+    private shadow;
+    private data;
+    constructor();
+    connectedCallback(): void;
+    setPayload(payload: SubmitActionPayload): void;
+    private collectFormValues;
+    private handleClick;
+    private render;
+}
+
 /**
- * Renders Tiledesk contentType=300 template payloads.
+ * Centered grey pill used for system / metadata messages
+ * (e.g. "Group created", "Assigned to Taxbuddy AI").
  *
- * 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.
+ * Theming knobs (CSS custom properties on :host or any ancestor):
+ *   --aikaara-system-pill-bg
+ *   --aikaara-system-pill-color
+ *   --aikaara-system-pill-radius
+ *   --aikaara-system-pill-padding
+ *   --aikaara-system-pill-font-size
+ *   --aikaara-system-pill-font-weight
+ *   --aikaara-system-pill-border
+ */
+export declare class AikaaraSystemPill extends HTMLElement {
+    private shadow;
+    static get observedAttributes(): string[];
+    constructor();
+    connectedCallback(): void;
+    attributeChangedCallback(): void;
+    private render;
+}
+
+/**
+ * Renders the payload of a contentType=300 Tiledesk template. Walks the
+ * payload structure and mounts the right child component(s):
+ *   - { type: 'checkbox' | 'radio' | 'button' }     → <aikaara-option-list>
+ *   - { type: 'submit' }                            → <aikaara-submit-action>
+ *   - { type: 'modal' } / single object with `message + ok`  → <aikaara-modal-action>
+ *
+ * Tenants can override per-template UI by registering a custom element named
+ * `aikaara-template-{templateId}` (or by templateId-based slot). The renderer
+ * checks for that first; if present, it delegates the whole payload there.
  */
 export declare class AikaaraTemplateRenderer extends HTMLElement {
     private shadow;
@@ -204,6 +330,8 @@ export declare class AikaaraTemplateRenderer extends HTMLElement {
     attributeChangedCallback(): void;
     setPayload(payload: unknown, innerMessage?: string): void;
     private render;
+    private mountField;
+    private mountModal;
 }
 
 export declare class AikaaraTypingIndicator extends HTMLElement {
@@ -254,6 +382,13 @@ 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;
@@ -287,6 +422,13 @@ declare interface ChatClientConfig_2 extends ConnectionConfig_2 {
         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_2) => void;
     onStatusChange?: (status: string) => void;
     onError?: (error: Error) => void;
@@ -357,6 +499,32 @@ declare type ConnectionState = 'disconnected' | 'connecting' | 'connected' | 're
 
 declare type ConnectionState_2 = '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.
+ */
+declare interface ConversationHistoryAdapter {
+    fetchMessages(conversationId: string, ctx: {
+        userId: string;
+        appId?: string;
+        projectId?: string;
+    }): Promise<TiledeskMessage[]>;
+}
+
+/**
+ * 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.
+ */
+declare interface ConversationHistoryAdapter_2 {
+    fetchMessages(conversationId: string, ctx: {
+        userId: string;
+        appId?: string;
+        projectId?: string;
+    }): Promise<TiledeskMessage_2[]>;
+}
+
 declare interface EditEntityAction {
     action: 'edit_entity';
     entity_type: string;
@@ -430,16 +598,103 @@ declare interface Message_2 {
     }>;
 }
 
+/**
+ * Modal-style action dialog. Bandhan uses these for blocking confirms
+ * (e.g. "Please tick the checkbox to proceed" with an Ok button).
+ *
+ * Payload shape (flexible — matches several bandhan modal templates):
+ *   { message: 'Please tick…', okLabel?: 'Ok', cancelLabel?: 'Cancel',
+ *     action?: { message, requestType } }
+ *
+ * On Ok the component fires `template-action` with the configured message
+ * (or the modal text itself) and dismisses. Cancel just dismisses.
+ *
+ * Theming:
+ *   --aikaara-modal-overlay-bg, --aikaara-modal-bg, --aikaara-modal-color,
+ *   --aikaara-modal-radius, --aikaara-modal-padding, --aikaara-modal-shadow,
+ *   --aikaara-modal-button-bg, --aikaara-modal-button-color,
+ *   --aikaara-modal-button-radius, --aikaara-modal-cancel-color
+ */
+declare interface ModalActionPayload {
+    message: string;
+    okLabel?: string;
+    cancelLabel?: string;
+    action?: {
+        message?: string;
+        requestType?: string;
+    };
+}
+
 declare interface NavigateAction {
     navigate_to: string;
 }
 
+/**
+ * Rendering for contentType=300 form fields with `type: 'checkbox' | 'radio' | 'button'`.
+ *
+ * Bandhan envelope:
+ *   { data: { name: 'IncomeSources', title: 'Income Sources',
+ *             options: [{ label, value }, ...] },
+ *     type: 'checkbox' | 'radio' | 'button' }
+ *
+ * Emits a `template-action` CustomEvent on selection. For `button` type the
+ * action fires immediately on click. For `checkbox`/`radio` the parent submit
+ * action collects values via `getValues()`.
+ *
+ * Theming:
+ *   --aikaara-option-bg, --aikaara-option-color, --aikaara-option-border,
+ *   --aikaara-option-radius, --aikaara-option-padding, --aikaara-option-gap,
+ *   --aikaara-option-selected-bg, --aikaara-option-selected-color,
+ *   --aikaara-option-selected-border, --aikaara-option-title-color,
+ *   --aikaara-option-title-font-size, --aikaara-option-title-font-weight
+ */
+declare interface OptionItem {
+    label: string;
+    value: string;
+}
+
+declare interface OptionListPayload {
+    name: string;
+    title?: string;
+    options: OptionItem[];
+    type: 'checkbox' | 'radio' | 'button';
+}
+
 export declare function registerComponents(): void;
 
 declare interface SaveEntityAction {
     action: 'save_entity';
 }
 
+/**
+ * Primary CTA submit button for contentType=300 forms.
+ *
+ * Bandhan envelope:
+ *   { data: { name: 'Confirm Income Sources', type: 'submit',
+ *             action: { message, formAction, requestType } },
+ *     type: 'submit' }
+ *
+ * On click, collects values from sibling AikaaraOptionList components
+ * (queried by walking up to the parent template renderer's children) and
+ * fires `template-action` with the action message + collected attributes.
+ *
+ * Theming:
+ *   --aikaara-submit-bg, --aikaara-submit-color, --aikaara-submit-border,
+ *   --aikaara-submit-radius, --aikaara-submit-padding,
+ *   --aikaara-submit-hover-bg, --aikaara-submit-disabled-opacity,
+ *   --aikaara-submit-font-size, --aikaara-submit-font-weight
+ */
+declare interface SubmitActionPayload {
+    name: string;
+    action: {
+        message: string;
+        formAction?: string;
+        requestType?: string;
+    };
+    /** id of the bot prompt that triggered this form, stamped on the postback */
+    messageId?: string;
+}
+
 declare interface TemplateMessageEvent {
     messageId: string;
     conversationId: string;
@@ -482,6 +737,42 @@ declare interface TiledeskFileTemplateConfig_2 {
     isDeepLink?: boolean;
 }
 
+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;
+}
+
+declare interface TiledeskMessage_2 {
+    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;
+}
+
 declare interface TiledeskMessageDefaults {
     channelType?: string;
     channel?: string;
@@ -546,6 +837,20 @@ 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;
 }
 
 declare interface TiledeskTransportConfig_2 {
@@ -576,6 +881,20 @@ declare interface TiledeskTransportConfig_2 {
     fileTemplate?: TiledeskFileTemplateConfig_2;
     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;
 }
 
 declare interface ToolCall {
@@ -675,6 +994,14 @@ 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 { }