@aikaara/chat-sdk 0.3.3 → 0.4.1

package/dist/index.d.ts

@@ -445,6 +445,8 @@ declare interface CreateConversationResponse {
 
 export declare function createFetchUploadAdapter(config: FetchUploadAdapterConfig): UploadAdapter;
 
+export declare function createPresigned3StepUploadAdapter(config: Presigned3StepAdapterConfig): UploadAdapter;
+
 export declare function createTiledeskHistoryAdapter(config: TiledeskHistoryAdapterConfig): ConversationHistoryAdapter;
 
 export declare interface EditEntityAction {
@@ -675,6 +677,22 @@ export declare interface MountedTenantWidget {
     destroy: () => void;
 }
 
+/**
+ * Single-call mount. Pulls the descriptor from `widget_configs/:slug`, runs
+ * descriptor.auth to mint chat JWT + requestId, builds upload + history
+ * adapters from descriptor.upload, and mounts the web component. Host app
+ * supplies only the user id + their session JWT.
+ *
+ *   import { mountFromSlug } from '@aikaara/chat-sdk';
+ *
+ *   await mountFromSlug({
+ *     container: '#chat',
+ *     slug: 'bandhan-itr',
+ *     user: { id: '33568', token: () => getCognitoJwt() },
+ *   });
+ */
+export declare function mountFromSlug(opts: SlugMountOptions): Promise<SlugMountedWidget>;
+
 /**
  * Standard tenant mount. Fetches the descriptor (when `configUrl` is set),
  * merges per-mount overrides, builds default adapters from the descriptor's
@@ -688,12 +706,147 @@ export declare interface NavigateAction {
 
 export declare function parseTiledeskTemplate(message: TiledeskMessage): TiledeskParsedTemplate;
 
+/**
+ * Three-step presigned-S3 upload (sign → PUT → register). Driven entirely
+ * by descriptor — no tenant-specific code in host apps.
+ */
+export declare interface Presigned3StepAdapterConfig {
+    /** GET endpoint that returns a presigned URL. `{fileName}` placeholder. */
+    signEndpoint: string;
+    signMethod?: 'GET' | 'POST';
+    /** Dot path into the response JSON for the presigned URL. Default `data.s3SignedUrl`. */
+    signedUrlPath?: string;
+    /** Optional POST registering the upload (e.g. `/chatbuddy/file-upload`). */
+    registerEndpoint?: string;
+    /**
+     * Body JSON for the register POST. Tokens: `{fileName}`, `{userId}`,
+     * `{requestId}` (alias `{conversationId}`).
+     */
+    registerBody?: Record<string, unknown>;
+    /**
+     * Final URL the chat message will carry. Tokens: `{fileName}`, `{userId}`,
+     * `{requestId}`. When omitted the presigned URL itself is used.
+     */
+    viewerTemplate?: string;
+    /**
+     * Rewrite the host portion of the presigned URL before PUTting (used for
+     * dev proxies). E.g. `/s3-upload`. Leave empty for direct.
+     */
+    s3HostRewrite?: string;
+    /** Bearer token getter for sign + register calls. */
+    authHeader?: () => string | Promise<string>;
+    /** Static extra headers for sign + register. */
+    extraHeaders?: Record<string, string>;
+}
+
 export declare function registerComponents(): void;
 
 export declare interface SaveEntityAction {
     action: 'save_entity';
 }
 
+export declare class SessionAuthAdapter {
+    private readonly descriptor;
+    private readonly sessionToken;
+    private cache;
+    private inflight;
+    constructor(descriptor: SessionAuthDescriptor, sessionToken: SessionTokenProvider);
+    /** Force-refresh by clearing cache. Next `get()` call refetches. */
+    reset(): void;
+    get(): Promise<SessionAuthData>;
+    private fetchOnce;
+}
+
+export declare interface SessionAuthData {
+    token: string;
+    requestId: string;
+    fullName: string;
+    expiresAt: number;
+}
+
+/**
+ * Descriptor-driven session auth.
+ *
+ * The host app supplies a "session token" — typically a JWT issued by their
+ * own auth (Cognito/Auth0/firebase/etc) — and the descriptor declares how to
+ * exchange it for a chat-platform JWT + conversation requestId. The SDK runs
+ * the exchange itself, caches the result, and refreshes when the chat JWT
+ * approaches expiry. The original requestId is preserved across refreshes so
+ * the conversation thread is stable.
+ */
+export declare interface SessionAuthDescriptor {
+    /** Absolute or same-origin URL — POSTed with the session token as bearer. */
+    endpoint: string;
+    method?: 'POST' | 'GET';
+    /** JSON body for the request. POST only. */
+    body?: Record<string, unknown>;
+    /** Extra static headers (e.g. partnerid). */
+    headers?: Record<string, string>;
+    /** Header carrying the session token. Default `Authorization`. */
+    authHeader?: string;
+    /**
+     * Template for the session-token header value. `{token}` is replaced.
+     * Default: `Bearer {token}`. Use `JWT {token}` etc. when required.
+     */
+    authHeaderTemplate?: string;
+    /** Dot path into the response JSON for the chat JWT. Default `data.token`. */
+    tokenPath?: string;
+    /** Stripped from the extracted token before use (e.g. `JWT `). */
+    tokenStripPrefix?: string;
+    /** Dot path for the conversation requestId. Default `data.requestId`. */
+    requestIdPath?: string;
+    /** Dot path for the user display name. Default `data.fullName`. */
+    fullNamePath?: string;
+    /** Refetch when the JWT is within this many ms of expiry. Default 60_000. */
+    expiryBufferMs?: number;
+}
+
+export declare type SessionTokenProvider = string | (() => string | Promise<string>);
+
+export declare interface SlugMountedWidget extends MountedTenantWidget {
+    fullName: string;
+    /** Force a fresh /chatbuddy/auth-style refetch (clears cached requestId). */
+    refreshAuth(): Promise<void>;
+}
+
+export declare interface SlugMountOptions {
+    /** Container element or CSS selector (e.g. `#chat`). */
+    container: HTMLElement | string;
+    /** Tenant identifier — the SDK fetches `${configBase}/widget_configs/${slug}`. */
+    slug: string;
+    /** Defaults to `https://api.aikaara.com`. Override for self-hosted aikaara. */
+    configBase?: string;
+    /** Additional headers for the descriptor fetch. */
+    configHeaders?: Record<string, string>;
+    user: {
+        id: string;
+        /** Display name fallback when descriptor.auth doesn't return one. */
+        name?: string;
+        departmentId?: string;
+        /**
+         * Session JWT (Cognito/Auth0/firebase/etc) — passed as bearer to
+         * `descriptor.auth.endpoint`. Can be a string (static for the session)
+         * or a getter that re-resolves on each refresh.
+         */
+        token: SessionTokenProvider;
+    };
+    /** Optional escape hatches; merge over descriptor-driven defaults. */
+    hooks?: {
+        upload?: UploadAdapter;
+        history?: ConversationHistoryAdapter;
+        onError?: (err: Error) => void;
+    };
+    /** Per-mount visual overrides. */
+    overrides?: Partial<WidgetConfigDescriptor>;
+    /**
+     * Inline descriptor used when the slug fetch fails (e.g. 404, network
+     * error). Lets host apps ship without requiring the aikaara backend to be
+     * seeded — useful for demos / first-run / offline dev. When the fetch
+     * succeeds the response wins; this is purely a safety net.
+     */
+    fallbackConfig?: WidgetConfigDescriptor;
+}
+
 declare type SubscriptionCallback = (data: unknown) => void;
 
 declare interface TemplateMessageEvent {
@@ -1099,6 +1252,28 @@ export declare interface WidgetConfigDescriptor {
     historyApiBase?: string;
     historyPageSize?: number;
     historyPathTemplate?: string;
+    /**
+     * Server-side session-token exchange. When set, the SDK exchanges the
+     * caller-supplied `sessionToken` for a chat JWT + conversation requestId
+     * itself — the host app no longer needs a `tokenProvider` callback.
+     */
+    auth?: SessionAuthDescriptor;
+    /**
+     * Built-in upload strategy. `mode: "presigned-3step"` runs sign → PUT →
+     * register entirely from descriptor config; `mode: "direct"` POSTs as
+     * multipart to a single endpoint; `mode: "none"` disables uploads. Host
+     * apps can still override with `opts.uploadAdapter`.
+     */
+    upload?: {
+        mode: 'none';
+    } | {
+        mode: 'direct';
+        endpoint: string;
+        fieldName?: string;
+        extraFields?: Record<string, string>;
+    } | ({
+        mode: 'presigned-3step';
+    } & Presigned3StepAdapterConfig);
 }
 
 export { }

package/dist/index.mjs

@@ -1,6 +1,6 @@
-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";
+import { r as o } from "./MountTenant-DT5Vr6Yr.mjs";
+import { A as u, a as m, b as g, c as h, d as k, e as A, f as C, g as b, h as f, i as T, j as v, k as S, C as w, l as y, m as M, E, M as x, S as B, T as F, n as U, o as I, p as j, q, s as H, t as P, u as W, v as K, w as L, x as O } from "./MountTenant-DT5Vr6Yr.mjs";
+import { FormBridge as z } from "./headless.mjs";
 function l(e) {
   o();
   const a = document.createElement("aikaara-chat-widget"), r = {
@@ -18,9 +18,9 @@ function l(e) {
     welcomeMessage: "welcome-message",
     avatarUrl: "avatar-url"
   };
-  for (const [i, s] of Object.entries(r)) {
-    const t = e[i];
-    t != null && a.setAttribute(s, String(t));
+  for (const [s, i] of Object.entries(r)) {
+    const t = e[s];
+    t != null && a.setAttribute(i, String(t));
   }
   return a.configure(e), document.body.appendChild(a), a;
 }
@@ -29,34 +29,37 @@ function d() {
   e && e.remove();
 }
 export {
-  m as ActionCableClient,
-  u as AikaaraChatBubble,
-  k as AikaaraChatClient,
-  g as AikaaraChatHeader,
-  h as AikaaraChatInput,
-  C as AikaaraChatWidget,
-  A as AikaaraErrorBanner,
+  u as ActionCableClient,
+  m as AikaaraChatBubble,
+  g as AikaaraChatClient,
+  h as AikaaraChatHeader,
+  k as AikaaraChatInput,
+  A as AikaaraChatWidget,
+  C 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,
+  S as ApiClient,
+  w as ChannelSubscription,
+  y as ConnectionManager,
+  M as ConversationManager,
+  E as EventEmitter,
+  z 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,
+  B as SessionAuthAdapter,
+  F as TiledeskTransport,
+  U as clearPersistedConversationId,
+  I as createFetchUploadAdapter,
+  j as createPresigned3StepUploadAdapter,
+  q as createTiledeskHistoryAdapter,
+  H as extractTiledeskFileEnvelope,
+  P as inferTiledeskRole,
+  W as isTiledeskSelfEcho,
   l as mount,
-  O as mountTenantWidget,
-  j as parseTiledeskTemplate,
+  K as mountFromSlug,
+  L as mountTenantWidget,
+  O as parseTiledeskTemplate,
   o as registerComponents,
   d as unmount
 };

package/dist/ui.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./ui-B0-Np9Dn.cjs");exports.AikaaraChatBubble=a.AikaaraChatBubble;exports.AikaaraChatHeader=a.AikaaraChatHeader;exports.AikaaraChatInput=a.AikaaraChatInput;exports.AikaaraChatWidget=a.AikaaraChatWidget;exports.AikaaraErrorBanner=a.AikaaraErrorBanner;exports.AikaaraMessageBubble=a.AikaaraMessageBubble;exports.AikaaraMessageList=a.AikaaraMessageList;exports.AikaaraModalAction=a.AikaaraModalAction;exports.AikaaraOptionList=a.AikaaraOptionList;exports.AikaaraStreamingMessage=a.AikaaraStreamingMessage;exports.AikaaraSubmitAction=a.AikaaraSubmitAction;exports.AikaaraSystemPill=a.AikaaraSystemPill;exports.AikaaraTemplateRenderer=a.AikaaraTemplateRenderer;exports.AikaaraTypingIndicator=a.AikaaraTypingIndicator;exports.registerComponents=a.registerComponents;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./MountTenant-B4Py61gI.cjs");exports.AikaaraChat=a.AikaaraChat;exports.AikaaraChatBubble=a.AikaaraChatBubble;exports.AikaaraChatHeader=a.AikaaraChatHeader;exports.AikaaraChatInput=a.AikaaraChatInput;exports.AikaaraChatWidget=a.AikaaraChatWidget;exports.AikaaraErrorBanner=a.AikaaraErrorBanner;exports.AikaaraMessageBubble=a.AikaaraMessageBubble;exports.AikaaraMessageList=a.AikaaraMessageList;exports.AikaaraModalAction=a.AikaaraModalAction;exports.AikaaraOptionList=a.AikaaraOptionList;exports.AikaaraStreamingMessage=a.AikaaraStreamingMessage;exports.AikaaraSubmitAction=a.AikaaraSubmitAction;exports.AikaaraSystemPill=a.AikaaraSystemPill;exports.AikaaraTemplateRenderer=a.AikaaraTemplateRenderer;exports.AikaaraTypingIndicator=a.AikaaraTypingIndicator;exports.registerComponents=a.registerComponents;

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();

package/dist/ui.mjs

@@ -1,18 +1,19 @@
-import { a as i, c as s, d as e, e as t, f as A, g as k, h as n, s as o, t as g, i as d, u as l, v as m, w as p, j as b, r as h } from "./ui-BMGa0gZH.mjs";
+import { y as i, a as s, c as e, d as t, e as A, f as k, g as n, h as o, z as g, B as d, i as h, D as l, F as m, G as p, j as C, r as b } from "./MountTenant-DT5Vr6Yr.mjs";
 export {
-  i as AikaaraChatBubble,
-  s as AikaaraChatHeader,
-  e as AikaaraChatInput,
-  t as AikaaraChatWidget,
-  A as AikaaraErrorBanner,
-  k as AikaaraMessageBubble,
-  n as AikaaraMessageList,
-  o as AikaaraModalAction,
-  g as AikaaraOptionList,
-  d as AikaaraStreamingMessage,
+  i as AikaaraChat,
+  s as AikaaraChatBubble,
+  e as AikaaraChatHeader,
+  t as AikaaraChatInput,
+  A as AikaaraChatWidget,
+  k as AikaaraErrorBanner,
+  n as AikaaraMessageBubble,
+  o as AikaaraMessageList,
+  g as AikaaraModalAction,
+  d as AikaaraOptionList,
+  h as AikaaraStreamingMessage,
   l as AikaaraSubmitAction,
   m as AikaaraSystemPill,
   p as AikaaraTemplateRenderer,
-  b as AikaaraTypingIndicator,
-  h as registerComponents
+  C as AikaaraTypingIndicator,
+  b as registerComponents
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aikaara/chat-sdk",
-  "version": "0.3.3",
+  "version": "0.4.1",
   "type": "module",
   "description": "Aikaara Chat SDK — embeddable chat widget and headless client",
   "license": "MIT",