@elqnt/chat 2.0.8 → 3.0.0

package/dist/hooks/index.d.mts

@@ -0,0 +1,78 @@
+import { ChatEvent, Chat, ChatMessage } from '../models/index.mjs';
+import { C as ChatTransport, e as TransportError, g as TransportState, R as RetryConfig, b as ConnectionMetrics, U as Unsubscribe } from '../types-BB5nRdZs.mjs';
+import '@elqnt/types';
+
+/**
+ * Chat hook options
+ */
+interface UseChatOptions {
+    /** Base URL for the chat server (e.g., "https://api.example.com/chat") */
+    baseUrl: string;
+    /** Organization ID */
+    orgId: string;
+    /** User ID */
+    userId: string;
+    /** Client type for routing */
+    clientType?: "customer" | "humanAgent" | "observer";
+    /** Transport instance or type */
+    transport?: ChatTransport | "sse" | "sse-fetch";
+    /** Callback for all incoming events */
+    onMessage?: (event: ChatEvent) => void;
+    /** Callback for errors */
+    onError?: (error: TransportError) => void;
+    /** Callback when connection state changes */
+    onConnectionChange?: (state: TransportState) => void;
+    /** Auto-connect on mount */
+    autoConnect?: boolean;
+    /** Retry configuration */
+    retryConfig?: RetryConfig;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Chat hook return type
+ */
+interface UseChatReturn {
+    /** Connect to the chat server */
+    connect: () => Promise<void>;
+    /** Disconnect from the server */
+    disconnect: () => void;
+    /** Current connection state */
+    connectionState: TransportState;
+    /** Whether currently connected */
+    isConnected: boolean;
+    /** Start a new chat session */
+    startChat: (metadata?: Record<string, unknown>) => Promise<string>;
+    /** Load an existing chat */
+    loadChat: (chatKey: string) => Promise<void>;
+    /** Send a text message */
+    sendMessage: (content: string, attachments?: unknown[]) => Promise<void>;
+    /** End the current chat */
+    endChat: (reason?: string) => Promise<void>;
+    /** Signal that user is typing */
+    startTyping: () => void;
+    /** Signal that user stopped typing */
+    stopTyping: () => void;
+    /** Current chat object */
+    currentChat: Chat | null;
+    /** Current chat key */
+    chatKey: string | null;
+    /** Chat messages */
+    messages: ChatMessage[];
+    /** Current error */
+    error: TransportError | null;
+    /** Connection metrics */
+    metrics: ConnectionMetrics;
+    /** Subscribe to specific event type */
+    on: (eventType: string, handler: (event: ChatEvent) => void) => Unsubscribe;
+    /** Clear current error */
+    clearError: () => void;
+}
+/**
+ * useChat Hook
+ *
+ * Platform-agnostic chat hook with SSE transport support.
+ */
+declare function useChat(options: UseChatOptions): UseChatReturn;
+
+export { type UseChatOptions, type UseChatReturn, useChat };

package/dist/hooks/index.d.ts

@@ -0,0 +1,78 @@
+import { ChatEvent, Chat, ChatMessage } from '../models/index.js';
+import { C as ChatTransport, e as TransportError, g as TransportState, R as RetryConfig, b as ConnectionMetrics, U as Unsubscribe } from '../types-CNvuxtcv.js';
+import '@elqnt/types';
+
+/**
+ * Chat hook options
+ */
+interface UseChatOptions {
+    /** Base URL for the chat server (e.g., "https://api.example.com/chat") */
+    baseUrl: string;
+    /** Organization ID */
+    orgId: string;
+    /** User ID */
+    userId: string;
+    /** Client type for routing */
+    clientType?: "customer" | "humanAgent" | "observer";
+    /** Transport instance or type */
+    transport?: ChatTransport | "sse" | "sse-fetch";
+    /** Callback for all incoming events */
+    onMessage?: (event: ChatEvent) => void;
+    /** Callback for errors */
+    onError?: (error: TransportError) => void;
+    /** Callback when connection state changes */
+    onConnectionChange?: (state: TransportState) => void;
+    /** Auto-connect on mount */
+    autoConnect?: boolean;
+    /** Retry configuration */
+    retryConfig?: RetryConfig;
+    /** Enable debug logging */
+    debug?: boolean;
+}
+/**
+ * Chat hook return type
+ */
+interface UseChatReturn {
+    /** Connect to the chat server */
+    connect: () => Promise<void>;
+    /** Disconnect from the server */
+    disconnect: () => void;
+    /** Current connection state */
+    connectionState: TransportState;
+    /** Whether currently connected */
+    isConnected: boolean;
+    /** Start a new chat session */
+    startChat: (metadata?: Record<string, unknown>) => Promise<string>;
+    /** Load an existing chat */
+    loadChat: (chatKey: string) => Promise<void>;
+    /** Send a text message */
+    sendMessage: (content: string, attachments?: unknown[]) => Promise<void>;
+    /** End the current chat */
+    endChat: (reason?: string) => Promise<void>;
+    /** Signal that user is typing */
+    startTyping: () => void;
+    /** Signal that user stopped typing */
+    stopTyping: () => void;
+    /** Current chat object */
+    currentChat: Chat | null;
+    /** Current chat key */
+    chatKey: string | null;
+    /** Chat messages */
+    messages: ChatMessage[];
+    /** Current error */
+    error: TransportError | null;
+    /** Connection metrics */
+    metrics: ConnectionMetrics;
+    /** Subscribe to specific event type */
+    on: (eventType: string, handler: (event: ChatEvent) => void) => Unsubscribe;
+    /** Clear current error */
+    clearError: () => void;
+}
+/**
+ * useChat Hook
+ *
+ * Platform-agnostic chat hook with SSE transport support.
+ */
+declare function useChat(options: UseChatOptions): UseChatReturn;
+
+export { type UseChatOptions, type UseChatReturn, useChat };