@olbrain/js-sdk 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,250 @@
+/**
+ * Core Types for Olbrain JavaScript SDK
+ * Matches Python SDK data models for consistency
+ */
+/**
+ * Configuration for AgentClient
+ */
+interface AgentConfig {
+    agentId: string;
+    apiKey: string;
+    baseUrl?: string;
+}
+/**
+ * Options for creating a new session
+ */
+interface CreateSessionOptions {
+    title?: string;
+    userId?: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Options for updating a session
+ */
+interface SessionUpdates {
+    title?: string;
+    metadata?: Record<string, any>;
+    status?: 'active' | 'archived';
+}
+/**
+ * Options for sending messages
+ */
+interface SendOptions {
+    metadata?: Record<string, any>;
+    timeout?: number;
+}
+/**
+ * Token usage statistics
+ */
+interface TokenUsage {
+    promptTokens: number;
+    completionTokens: number;
+    totalTokens: number;
+    cost?: number;
+}
+/**
+ * Session information
+ */
+interface SessionInfo {
+    sessionId: string;
+    title: string;
+    status: 'active' | 'archived';
+    createdAt: string;
+    messageCount: number;
+    userId?: string;
+    metadata: Record<string, any>;
+}
+/**
+ * Session statistics
+ */
+interface SessionStats {
+    sessionId: string;
+    messageCount: number;
+    totalTokens: number;
+    createdAt: string;
+    lastMessageAt?: string;
+}
+/**
+ * Chat response from the agent
+ */
+interface ChatResponse {
+    text: string;
+    sessionId: string;
+    success: boolean;
+    tokenUsage?: TokenUsage;
+    modelUsed?: string;
+    responseTimeMs?: number;
+    error?: string;
+}
+/**
+ * Message in a conversation
+ */
+interface Message {
+    role: 'user' | 'assistant';
+    content: string;
+    timestamp: string;
+    metadata?: Record<string, any>;
+}
+/**
+ * Callback for message events
+ */
+type MessageCallback = (message: Message) => void;
+/**
+ * Callback for error events
+ */
+type ErrorCallback = (error: Error) => void;
+/**
+ * Configuration for streaming
+ */
+interface StreamConfig {
+    sessionId: string;
+    apiKey: string;
+    agentId: string;
+    baseUrl: string;
+}
+/**
+ * Widget configuration
+ */
+interface WidgetConfig {
+    agentId: string;
+    apiKey: string;
+    position?: 'bottom-right' | 'bottom-left' | 'custom';
+    theme?: 'light' | 'dark' | 'auto';
+    primaryColor?: string;
+    title?: string;
+    greeting?: string;
+    placeholder?: string;
+    autoOpen?: boolean;
+    persistSession?: boolean;
+    target?: string | HTMLElement;
+    onMessage?: MessageCallback;
+    baseUrl?: string;
+}
+
+/**
+ * Main AgentClient class for communicating with Olbrain agents
+ */
+
+/**
+ * Main API client for interacting with Olbrain agents
+ */
+declare class AgentClient {
+    private config;
+    private streamManager;
+    constructor(config: AgentConfig);
+    /**
+     * Create a new session
+     */
+    createSession(options?: CreateSessionOptions): Promise<string>;
+    /**
+     * Get session information
+     * @note May not be implemented on all backends
+     */
+    getSession(sessionId: string): Promise<SessionInfo>;
+    /**
+     * Update session information
+     * @note May not be implemented on all backends
+     */
+    updateSession(sessionId: string, updates: SessionUpdates): Promise<SessionInfo>;
+    /**
+     * Delete a session
+     * @note May not be implemented on all backends
+     */
+    deleteSession(sessionId: string): Promise<void>;
+    /**
+     * Get messages from a session
+     * @note May not be implemented on all backends
+     */
+    getMessages(sessionId: string, limit?: number): Promise<Message[]>;
+    /**
+     * Get session statistics
+     * @note May not be implemented on all backends
+     */
+    getSessionStats(sessionId: string): Promise<SessionStats>;
+    /**
+     * Send a message and wait for response
+     */
+    sendAndWait(sessionId: string, message: string, options?: SendOptions): Promise<ChatResponse>;
+    /**
+     * Send a message (fire and forget)
+     */
+    send(sessionId: string, message: string): Promise<void>;
+    /**
+     * Start listening for messages via SSE streaming
+     */
+    listen(sessionId: string, onMessage: MessageCallback, onError?: ErrorCallback): Promise<void>;
+    /**
+     * Stop listening for messages
+     */
+    stopListening(sessionId: string): void;
+    /**
+     * Close client and clean up resources
+     */
+    close(): void;
+    /**
+     * Helper method to make HTTP requests
+     */
+    private _request;
+    /**
+     * Helper to parse session info from response
+     */
+    private _parseSessionInfo;
+}
+
+/**
+ * Error classes for Olbrain SDK
+ */
+/**
+ * Base error class for all Olbrain errors
+ */
+declare class OlbrainError extends Error {
+    constructor(message: string);
+}
+/**
+ * Raised when authentication fails (invalid API key, missing auth header, etc.)
+ */
+declare class AuthenticationError extends OlbrainError {
+    constructor(message?: string);
+}
+/**
+ * Raised when a session is not found
+ */
+declare class SessionNotFoundError extends OlbrainError {
+    sessionId: string;
+    constructor(sessionId: string);
+}
+/**
+ * Raised when rate limit is exceeded
+ */
+declare class RateLimitError extends OlbrainError {
+    retryAfter?: number;
+    constructor(message?: string, retryAfter?: number);
+}
+/**
+ * Raised when a network error occurs
+ */
+declare class NetworkError extends OlbrainError {
+    statusCode?: number;
+    constructor(message?: string, statusCode?: number);
+}
+/**
+ * Raised when input validation fails
+ */
+declare class ValidationError extends OlbrainError {
+    constructor(message?: string);
+}
+/**
+ * Raised when streaming connection fails
+ */
+declare class StreamingError extends OlbrainError {
+    constructor(message?: string);
+}
+
+/**
+ * Olbrain JavaScript SDK
+ * Main entry point for core API exports
+ */
+
+declare const VERSION = "1.0.0";
+
+export { AgentClient, type AgentConfig, AuthenticationError, type ChatResponse, type CreateSessionOptions, type ErrorCallback, type Message, type MessageCallback, NetworkError, OlbrainError, RateLimitError, type SendOptions, type SessionInfo, SessionNotFoundError, type SessionStats, type SessionUpdates, type StreamConfig, StreamingError, type TokenUsage, VERSION, ValidationError, type WidgetConfig };