@estuary-ai/sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 estuary.ai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,127 @@
+# @estuary-ai/sdk
+
+TypeScript SDK for the [Estuary](https://www.estuary-ai.com) real-time AI conversation platform. Build applications with persistent AI characters that remember, hear, and see.
+
+## Installation
+
+```bash
+npm install @estuary-ai/sdk
+```
+
+For LiveKit voice (optional, lower latency):
+
+```bash
+npm install @estuary-ai/sdk livekit-client
+```
+
+## Quick Start
+
+```typescript
+import { EstuaryClient } from '@estuary-ai/sdk';
+
+const client = new EstuaryClient({
+  serverUrl: 'https://api.estuary-ai.com',
+  apiKey: 'est_your_api_key',
+  characterId: 'your-character-id',
+  playerId: 'user-123',
+});
+
+client.on('botResponse', (response) => {
+  process.stdout.write(response.text);
+  if (response.isFinal) console.log();
+});
+
+await client.connect();
+client.sendText('Hello!');
+```
+
+## Features
+
+### Text Chat
+
+```typescript
+client.sendText('What do you remember about me?');
+client.sendText('Just respond in text', true); // textOnly mode
+```
+
+### Voice (WebSocket)
+
+```typescript
+const client = new EstuaryClient({
+  serverUrl: 'https://api.estuary-ai.com',
+  apiKey: 'est_...',
+  characterId: '...',
+  playerId: '...',
+  voiceTransport: 'websocket',
+});
+
+await client.connect();
+await client.startVoice(); // Requests mic permission
+// ... speak, receive audio responses
+client.stopVoice();
+```
+
+### Voice (LiveKit)
+
+```typescript
+const client = new EstuaryClient({
+  // ...
+  voiceTransport: 'livekit', // or 'auto' to prefer LiveKit
+});
+
+await client.connect();
+await client.startVoice();
+client.toggleMute();
+```
+
+### Memory & Knowledge Graph
+
+```typescript
+const memories = await client.memory.getMemories({ status: 'active', limit: 50 });
+const facts = await client.memory.getCoreFacts();
+const graph = await client.memory.getGraph({ includeEntities: true });
+const results = await client.memory.search('favorite food');
+```
+
+## Events
+
+```typescript
+client.on('connected', (session) => { /* authenticated */ });
+client.on('disconnected', (reason) => { /* lost connection */ });
+client.on('botResponse', (response) => { /* streaming text */ });
+client.on('botVoice', (voice) => { /* audio chunk */ });
+client.on('sttResponse', (stt) => { /* speech-to-text */ });
+client.on('interrupt', (data) => { /* response interrupted */ });
+client.on('error', (error) => { /* EstuaryError */ });
+client.on('quotaExceeded', (data) => { /* rate limited */ });
+```
+
+## Configuration
+
+```typescript
+interface EstuaryConfig {
+  serverUrl: string;           // Server URL
+  apiKey: string;              // API key (est_...)
+  characterId: string;         // Character ID
+  playerId: string;            // End user ID
+  audioSampleRate?: number;    // Default: 16000
+  autoReconnect?: boolean;     // Default: true
+  maxReconnectAttempts?: number; // Default: 5
+  reconnectDelayMs?: number;   // Default: 2000
+  debug?: boolean;             // Default: false
+  voiceTransport?: 'websocket' | 'livekit' | 'auto'; // Default: 'auto'
+}
+```
+
+## Requirements
+
+- Node.js 18+ or modern browser
+- Estuary account with API key and Character ID
+
+## Documentation
+
+Full documentation at [docs.estuary-ai.com](https://docs.estuary-ai.com/docs/typescript-sdk/getting-started).
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,291 @@
+interface EstuaryConfig {
+    /** Base URL of the Estuary server (e.g., "https://api.estuary-ai.com") */
+    serverUrl: string;
+    /** API key (starts with "est_") */
+    apiKey: string;
+    /** Character (agent) ID */
+    characterId: string;
+    /** Unique identifier for the end user */
+    playerId: string;
+    /** Audio sample rate in Hz (default: 16000) */
+    audioSampleRate?: number;
+    /** Auto-reconnect on disconnect (default: true) */
+    autoReconnect?: boolean;
+    /** Max reconnect attempts (default: 5) */
+    maxReconnectAttempts?: number;
+    /** Delay between reconnect attempts in ms (default: 2000) */
+    reconnectDelayMs?: number;
+    /** Enable debug logging (default: false) */
+    debug?: boolean;
+    /** Voice transport: 'websocket' | 'livekit' | 'auto' (default: 'auto') */
+    voiceTransport?: VoiceTransport;
+    /** Enable real-time memory extraction after each response (default: false) */
+    realtimeMemory?: boolean;
+}
+type VoiceTransport = 'websocket' | 'livekit' | 'auto';
+declare enum ConnectionState {
+    Disconnected = "disconnected",
+    Connecting = "connecting",
+    Connected = "connected",
+    Reconnecting = "reconnecting",
+    Error = "error"
+}
+interface SessionInfo {
+    sessionId: string;
+    conversationId: string;
+    characterId: string;
+    playerId: string;
+}
+interface BotResponse {
+    text: string;
+    isFinal: boolean;
+    partial: string;
+    messageId: string;
+    chunkIndex: number;
+    isInterjection: boolean;
+}
+interface BotVoice {
+    audio: string;
+    messageId: string;
+    chunkIndex: number;
+    isFinal: boolean;
+}
+interface SttResponse {
+    text: string;
+    isFinal: boolean;
+}
+interface InterruptData {
+    messageId?: string;
+    reason?: string;
+    interruptedAt?: string;
+}
+interface QuotaExceededData {
+    message: string;
+    current: number;
+    limit: number;
+    remaining: number;
+    tier: string;
+}
+interface LiveKitTokenResponse {
+    token: string;
+    url: string;
+    room: string;
+}
+interface CameraCaptureRequest {
+    requestId: string;
+    text?: string;
+}
+interface MemoryData {
+    id: string;
+    content: string;
+    memoryType: string;
+    confidence: number;
+    status: string;
+    sourceConversationId: string;
+    sourceQuote?: string;
+    topic?: string;
+    createdAt: string;
+}
+interface MemoryUpdatedEvent {
+    agentId: string;
+    playerId: string;
+    memoriesExtracted: number;
+    factsExtracted: number;
+    conversationId: string;
+    newMemories: MemoryData[];
+    timestamp: string;
+}
+type EstuaryEventMap = {
+    connected: (session: SessionInfo) => void;
+    disconnected: (reason: string) => void;
+    reconnecting: (attempt: number) => void;
+    connectionStateChanged: (state: ConnectionState) => void;
+    botResponse: (response: BotResponse) => void;
+    botVoice: (voice: BotVoice) => void;
+    sttResponse: (response: SttResponse) => void;
+    interrupt: (data: InterruptData) => void;
+    error: (error: Error) => void;
+    authError: (error: string) => void;
+    quotaExceeded: (data: QuotaExceededData) => void;
+    cameraCaptureRequest: (request: CameraCaptureRequest) => void;
+    voiceStarted: () => void;
+    voiceStopped: () => void;
+    livekitConnected: (room: string) => void;
+    livekitDisconnected: () => void;
+    audioPlaybackStarted: (messageId: string) => void;
+    audioPlaybackComplete: (messageId: string) => void;
+    memoryUpdated: (event: MemoryUpdatedEvent) => void;
+};
+interface VoiceManager {
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    toggleMute(): void;
+    readonly isMuted: boolean;
+    readonly isActive: boolean;
+    dispose(): void;
+}
+interface MemoryListOptions {
+    memoryType?: string;
+    status?: string;
+    limit?: number;
+    offset?: number;
+    sortBy?: 'created_at' | 'confidence' | 'last_accessed_at';
+    sortOrder?: 'asc' | 'desc';
+}
+interface MemoryTimelineOptions {
+    startDate?: string;
+    endDate?: string;
+    groupBy?: 'day' | 'week' | 'month';
+}
+interface MemoryGraphOptions {
+    includeEntities?: boolean;
+    includeCharacterMemories?: boolean;
+}
+interface MemorySearchOptions {
+    query: string;
+    limit?: number;
+}
+interface MemoryListResponse {
+    memories: Record<string, unknown>[];
+    total: number;
+    limit: number;
+    offset: number;
+}
+interface MemoryTimelineResponse {
+    timeline: {
+        date: string;
+        memories: Record<string, unknown>[];
+    }[];
+    totalMemories: number;
+    groupBy: string;
+}
+interface MemoryStatsResponse {
+    [key: string]: unknown;
+}
+interface MemoryGraphResponse {
+    nodes: Record<string, unknown>[];
+    edges: Record<string, unknown>[];
+    stats: Record<string, unknown>;
+}
+interface MemorySearchResponse {
+    results: {
+        memory: Record<string, unknown>;
+        score: number;
+        similarityScore: number;
+    }[];
+    query: string;
+    total: number;
+}
+interface CoreFactsResponse {
+    coreFacts: Record<string, unknown>[];
+}
+
+declare class RestClient {
+    private baseUrl;
+    private apiKey;
+    constructor(baseUrl: string, apiKey: string);
+    get<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    post<T>(path: string, body?: unknown): Promise<T>;
+    delete<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T>;
+    dispose(): void;
+    private buildUrl;
+    private request;
+}
+
+declare class MemoryClient {
+    private rest;
+    private basePath;
+    constructor(rest: RestClient, agentId: string, playerId: string);
+    getMemories(options?: MemoryListOptions): Promise<MemoryListResponse>;
+    getTimeline(options?: MemoryTimelineOptions): Promise<MemoryTimelineResponse>;
+    getStats(): Promise<MemoryStatsResponse>;
+    getCoreFacts(): Promise<CoreFactsResponse>;
+    getGraph(options?: MemoryGraphOptions): Promise<MemoryGraphResponse>;
+    search(query: string, limit?: number): Promise<MemorySearchResponse>;
+    deleteAll(confirm: boolean): Promise<{
+        message: string;
+        deletedCount: number;
+    }>;
+    dispose(): void;
+}
+
+declare class TypedEventEmitter<T extends Record<string, unknown>> {
+    private listeners;
+    private onceListeners;
+    on<K extends keyof T>(event: K, listener: T[K]): this;
+    off<K extends keyof T>(event: K, listener: T[K]): this;
+    once<K extends keyof T>(event: K, listener: T[K]): this;
+    protected emit<K extends keyof T>(event: K, ...args: T[K] extends (...a: infer A) => void ? A : never[]): boolean;
+    removeAllListeners<K extends keyof T>(event?: K): this;
+    listenerCount<K extends keyof T>(event: K): number;
+}
+
+declare class EstuaryClient extends TypedEventEmitter<EstuaryEventMap> {
+    private config;
+    private logger;
+    private socketManager;
+    private voiceManager;
+    private audioPlayer;
+    private _memory;
+    private _sessionInfo;
+    constructor(config: EstuaryConfig);
+    /** Memory API client for querying memories, graphs, and facts */
+    get memory(): MemoryClient;
+    /** Current session info (null if not connected) */
+    get session(): SessionInfo | null;
+    /** Current connection state */
+    get connectionState(): ConnectionState;
+    /** Whether the client is connected and authenticated */
+    get isConnected(): boolean;
+    /** Connect to the Estuary server and authenticate */
+    connect(): Promise<SessionInfo>;
+    /** Disconnect from the server */
+    disconnect(): void;
+    /** Send a text message to the character */
+    sendText(text: string, textOnly?: boolean): void;
+    /** Interrupt the current bot response */
+    interrupt(messageId?: string): void;
+    /** Send a camera image for vision processing */
+    sendCameraImage(imageBase64: string, mimeType: string, requestId?: string, text?: string): void;
+    /** Update session preferences */
+    updatePreferences(preferences: {
+        enableVisionAcknowledgment?: boolean;
+    }): void;
+    /** Notify server that audio playback completed for a message */
+    notifyAudioPlaybackComplete(messageId?: string): void;
+    /** Start voice input (requests microphone permission) */
+    startVoice(): Promise<void>;
+    /** Stop voice input */
+    stopVoice(): void;
+    /** Toggle microphone mute */
+    toggleMute(): void;
+    /** Whether the microphone is muted */
+    get isMuted(): boolean;
+    /** Whether voice is currently active */
+    get isVoiceActive(): boolean;
+    private ensureConnected;
+    private forwardSocketEvents;
+    private handleBotVoice;
+}
+
+declare enum ErrorCode {
+    CONNECTION_FAILED = "CONNECTION_FAILED",
+    AUTH_FAILED = "AUTH_FAILED",
+    CONNECTION_TIMEOUT = "CONNECTION_TIMEOUT",
+    QUOTA_EXCEEDED = "QUOTA_EXCEEDED",
+    VOICE_NOT_SUPPORTED = "VOICE_NOT_SUPPORTED",
+    VOICE_ALREADY_ACTIVE = "VOICE_ALREADY_ACTIVE",
+    VOICE_NOT_ACTIVE = "VOICE_NOT_ACTIVE",
+    LIVEKIT_UNAVAILABLE = "LIVEKIT_UNAVAILABLE",
+    MICROPHONE_DENIED = "MICROPHONE_DENIED",
+    NOT_CONNECTED = "NOT_CONNECTED",
+    REST_ERROR = "REST_ERROR",
+    UNKNOWN = "UNKNOWN"
+}
+declare class EstuaryError extends Error {
+    readonly code: ErrorCode;
+    readonly details?: unknown;
+    constructor(code: ErrorCode, message: string, details?: unknown);
+}
+
+export { type BotResponse, type BotVoice, type CameraCaptureRequest, ConnectionState, type CoreFactsResponse, ErrorCode, EstuaryClient, type EstuaryConfig, EstuaryError, type EstuaryEventMap, type InterruptData, type LiveKitTokenResponse, MemoryClient, type MemoryData, type MemoryGraphOptions, type MemoryGraphResponse, type MemoryListOptions, type MemoryListResponse, type MemorySearchOptions, type MemorySearchResponse, type MemoryStatsResponse, type MemoryTimelineOptions, type MemoryTimelineResponse, type MemoryUpdatedEvent, type QuotaExceededData, type SessionInfo, type SttResponse, type VoiceManager, type VoiceTransport };