@docgenlab.com/chat-widget 0.2.4 → 0.5.1

package/dist/api.d.ts

@@ -6,7 +6,7 @@
  *   X-DocGenLab-Key         — the publishable key (server resolves to agent)
  *   X-DocGenLab-Visitor-Id  — a stable UUID minted in localStorage
  */
-import type { AgentInfo, StreamEvent } from './types';
+import type { AgentInfo, StreamEvent, TicketRef } from './types';
 export interface ClientOptions {
     agentKey: string;
     apiBaseUrl: string;
@@ -27,10 +27,60 @@ export declare class WidgetClient {
     constructor(opts: ClientOptions);
     private headers;
     getAgent(): Promise<AgentInfo>;
+    /** List all conversations this visitor has had with this agent.
+     *  Used by the "All chats" modal to let users browse + jump back
+     *  to previous threads. Lightweight payload — message bodies are
+     *  fetched on demand via getConversation when the user opens one. */
+    listConversations(): Promise<Array<{
+        id: string;
+        title: string | null;
+        preview: string | null;
+        message_count: number;
+        created_at: string | null;
+        updated_at: string | null;
+    }>>;
+    /** Load a previous conversation's messages so the widget can show
+     *  history after a refresh / re-open. The visitor-id header is the
+     *  authorization — the backend only returns conversations owned by
+     *  the requesting visitor on this agent. */
+    getConversation(conversationId: string): Promise<any>;
+    /** Reconstruct the ticket card that SHOULD currently be on the
+     *  conversation, based on persisted state. Lets the widget restore
+     *  raise-ticket / "already on it" / created cards after refresh.
+     *  Returns kind=null when nothing should show. */
+    getTicketCardState(conversationId: string): Promise<{
+        kind: 'offer' | 'existing' | 'created' | null;
+        conversation_id: string | null;
+        connector_type?: string | null;
+        connector_name?: string | null;
+        ticket_id?: string | null;
+        external_ticket_number?: string | null;
+        external_url?: string | null;
+        status?: string | null;
+    }>;
     uploadImage(file: File): Promise<string>;
     /** Fetch a previously-uploaded image as a blob URL. Caller must
      *  URL.revokeObjectURL() when done to avoid memory leaks. */
     fetchImage(imagePath: string): Promise<string>;
+    /** Raise a support ticket from a conversation. Requires explicit user
+     *  consent — the widget only calls this after the user clicks the
+     *  in-chat "Raise a ticket" chip. */
+    raiseTicket(conversationId: string, body: {
+        consent: boolean;
+        end_user_email?: string;
+        end_user_phone?: string;
+        priority?: 'low' | 'medium' | 'high' | 'urgent';
+        /** Escape hatch from the "We're already on it" card — bypasses
+         *  the duplicate guard so the user can raise a fresh ticket
+         *  for a different issue even when a recent one is still open. */
+        force_new?: boolean;
+    }): Promise<TicketRef>;
+    /** List all tickets for THIS visitor on THIS agent. Used by the widget
+     *  to hydrate ticket cards on conversation reload and to power the
+     *  "Manage tickets" modal. Optionally filtered by conversation. */
+    listTickets(conversationId?: string): Promise<TicketRef[]>;
+    /** Fetch the latest status of a ticket the user raised. */
+    getTicket(ticketId: string, refresh?: boolean): Promise<TicketRef>;
     /** Fetch a video-source frame attached to a citation chunk.
      *  Same auth pattern as fetchImage. */
     fetchSourceFrame(sourceId: string, framePath: string): Promise<string>;