@estuary-ai/sdk 0.1.20 → 0.1.21

package/README.md

@@ -1,5 +1,7 @@
 # @estuary-ai/sdk
 
+[![npm](https://img.shields.io/npm/v/@estuary-ai/sdk)](https://www.npmjs.com/package/@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
@@ -274,6 +276,40 @@ import type {
 } from '@estuary-ai/sdk';
 ```
 
+## React / Next.js
+
+The SDK uses browser APIs, so it must be used in client components. In Next.js App Router:
+
+```tsx
+"use client";
+
+import { useEffect, useRef } from 'react';
+import { EstuaryClient } from '@estuary-ai/sdk';
+
+export default function Chat() {
+  const clientRef = useRef<EstuaryClient | null>(null);
+
+  useEffect(() => {
+    const client = new EstuaryClient({
+      serverUrl: 'https://api.estuary-ai.com',
+      apiKey: 'est_...',
+      characterId: '...',
+      playerId: 'user-123',
+    });
+    clientRef.current = client;
+    client.connect();
+
+    return () => {
+      client.disconnect();
+    };
+  }, []);
+
+  return <div>...</div>;
+}
+```
+
+If using `next/dynamic` with `ssr: false`, the importing page must also be a client component in Next.js 16+.
+
 ## Requirements
 
 - Node.js 18+ or modern browser

package/dist/{chunk-ZROWZRQD.mjs → chunk-6M5LSBMK.mjs}

@@ -1,9 +1,3 @@
-var __defProp = Object.defineProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-
 // src/errors.ts
 var ErrorCode = /* @__PURE__ */ ((ErrorCode2) => {
   ErrorCode2["CONNECTION_FAILED"] = "CONNECTION_FAILED";
@@ -31,6 +25,6 @@ var EstuaryError = class extends Error {
   }
 };
 
-export { ErrorCode, EstuaryError, __export };
-//# sourceMappingURL=chunk-ZROWZRQD.mjs.map
-//# sourceMappingURL=chunk-ZROWZRQD.mjs.map
+export { ErrorCode, EstuaryError };
+//# sourceMappingURL=chunk-6M5LSBMK.mjs.map
+//# sourceMappingURL=chunk-6M5LSBMK.mjs.map

package/dist/chunk-6M5LSBMK.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/errors.ts"],"names":["ErrorCode"],"mappings":";AAAO,IAAK,SAAA,qBAAAA,UAAAA,KAAL;AACL,EAAAA,WAAA,mBAAA,CAAA,GAAoB,mBAAA;AACpB,EAAAA,WAAA,aAAA,CAAA,GAAc,aAAA;AACd,EAAAA,WAAA,oBAAA,CAAA,GAAqB,oBAAA;AACrB,EAAAA,WAAA,gBAAA,CAAA,GAAiB,gBAAA;AACjB,EAAAA,WAAA,qBAAA,CAAA,GAAsB,qBAAA;AACtB,EAAAA,WAAA,sBAAA,CAAA,GAAuB,sBAAA;AACvB,EAAAA,WAAA,kBAAA,CAAA,GAAmB,kBAAA;AACnB,EAAAA,WAAA,qBAAA,CAAA,GAAsB,qBAAA;AACtB,EAAAA,WAAA,mBAAA,CAAA,GAAoB,mBAAA;AACpB,EAAAA,WAAA,eAAA,CAAA,GAAgB,eAAA;AAChB,EAAAA,WAAA,YAAA,CAAA,GAAa,YAAA;AACb,EAAAA,WAAA,SAAA,CAAA,GAAU,SAAA;AAZA,EAAA,OAAAA,UAAAA;AAAA,CAAA,EAAA,SAAA,IAAA,EAAA;AAeL,IAAM,YAAA,GAAN,cAA2B,KAAA,CAAM;AAAA,EAC7B,IAAA;AAAA,EACA,OAAA;AAAA,EAET,WAAA,CAAY,IAAA,EAAiB,OAAA,EAAiB,OAAA,EAAmB;AAC/D,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,cAAA;AACZ,IAAA,IAAA,CAAK,IAAA,GAAO,IAAA;AACZ,IAAA,IAAA,CAAK,OAAA,GAAU,OAAA;AAAA,EACjB;AACF","file":"chunk-6M5LSBMK.mjs","sourcesContent":["export enum ErrorCode {\r\n  CONNECTION_FAILED = 'CONNECTION_FAILED',\r\n  AUTH_FAILED = 'AUTH_FAILED',\r\n  CONNECTION_TIMEOUT = 'CONNECTION_TIMEOUT',\r\n  QUOTA_EXCEEDED = 'QUOTA_EXCEEDED',\r\n  VOICE_NOT_SUPPORTED = 'VOICE_NOT_SUPPORTED',\r\n  VOICE_ALREADY_ACTIVE = 'VOICE_ALREADY_ACTIVE',\r\n  VOICE_NOT_ACTIVE = 'VOICE_NOT_ACTIVE',\r\n  LIVEKIT_UNAVAILABLE = 'LIVEKIT_UNAVAILABLE',\r\n  MICROPHONE_DENIED = 'MICROPHONE_DENIED',\r\n  NOT_CONNECTED = 'NOT_CONNECTED',\r\n  REST_ERROR = 'REST_ERROR',\r\n  UNKNOWN = 'UNKNOWN',\r\n}\r\n\r\nexport class EstuaryError extends Error {\r\n  readonly code: ErrorCode;\r\n  readonly details?: unknown;\r\n\r\n  constructor(code: ErrorCode, message: string, details?: unknown) {\r\n    super(message);\r\n    this.name = 'EstuaryError';\r\n    this.code = code;\r\n    this.details = details;\r\n  }\r\n}\r\n"]}

package/dist/index.d.ts

@@ -0,0 +1,331 @@
+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;
+    /** Suppress mic during TTS playback (software AEC fallback, disables barge-in). Default: false */
+    suppressMicDuringPlayback?: boolean;
+    /** Proactively interrupt bot audio when user starts speaking (default: true) */
+    autoInterruptOnSpeech?: 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;
+    tokenStream?: 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;
+}
+interface CharacterAction {
+    /** Action name (e.g., "follow_user", "sit", "look_at") */
+    name: string;
+    /** Action parameters as key-value pairs */
+    params: Record<string, string>;
+    /** Message ID of the bot response that contained this action */
+    messageId: 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;
+    characterAction: (action: CharacterAction) => 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;
+    /** Suppress audio sending (software AEC). No-op if not supported. */
+    setSuppressed?(suppressed: boolean): 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;
+    private actionParsers;
+    private _hasAutoInterrupted;
+    private _autoInterruptGraceTimer;
+    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 handleBotResponse;
+    private handleBotVoice;
+    private maybeAutoInterrupt;
+}
+
+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);
+}
+
+/**
+ * Parses `<action name="..." .../>` XML tags from bot response text.
+ *
+ * Designed for streaming: call `parse()` with the accumulated text on each
+ * chunk and it returns only newly-discovered actions since the last call.
+ */
+interface ParsedAction {
+    name: string;
+    params: Record<string, string>;
+}
+/**
+ * One-shot parse: extract all actions and return clean text.
+ * Useful for non-streaming contexts.
+ */
+declare function parseActions(text: string): {
+    actions: ParsedAction[];
+    cleanText: string;
+};
+
+export { type BotResponse, type BotVoice, type CameraCaptureRequest, type CharacterAction, 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 ParsedAction, type QuotaExceededData, type SessionInfo, type SttResponse, type VoiceManager, type VoiceTransport, parseActions };