@jchaffin/voicekit 0.2.0

package/dist/types-uLnzb8NE.d.ts

@@ -0,0 +1,150 @@
+type VoiceStatus$1 = 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED';
+interface TranscriptMessage {
+    id: string;
+    role: 'user' | 'assistant';
+    text: string;
+    timestamp: Date;
+    status: 'pending' | 'complete';
+}
+type ToolParamType = 'string' | 'number' | 'boolean' | 'array' | 'object';
+interface ToolParamDefinition {
+    type: ToolParamType;
+    description?: string;
+    enum?: string[];
+    default?: unknown;
+}
+interface ToolDefinition<TParams = Record<string, unknown>, TResult = unknown> {
+    name: string;
+    description: string;
+    parameters: {
+        type: 'object';
+        properties: Record<string, ToolParamDefinition>;
+        required?: string[];
+    };
+    execute: (params: TParams) => Promise<TResult> | TResult;
+}
+interface AgentConfig {
+    name: string;
+    instructions: string;
+    tools?: ToolDefinition[];
+    voice?: string;
+}
+interface VoiceConfig {
+    /** API endpoint that returns session token */
+    sessionEndpoint?: string;
+    /** Model identifier (provider-specific) */
+    model?: string;
+    /** Audio codec preference */
+    codec?: 'opus' | 'pcmu' | 'pcma';
+    /** Language for transcription */
+    language?: string;
+    onStatusChange?: (status: VoiceStatus$1) => void;
+    onTranscriptUpdate?: (messages: TranscriptMessage[]) => void;
+    onToolCall?: (toolName: string, params: unknown, result: unknown) => void;
+    onError?: (error: Error) => void;
+}
+interface VoiceProviderProps extends VoiceConfig {
+    /** Provider adapter (e.g. openai(), livekit(), deepgram()) */
+    adapter: VoiceAdapter;
+    /** Agent configuration */
+    agent: VoiceAgentConfig;
+    children: React.ReactNode;
+}
+interface VoiceContextValue {
+    status: VoiceStatus$1;
+    connect: () => Promise<void>;
+    disconnect: () => Promise<void>;
+    transcript: TranscriptMessage[];
+    clearTranscript: () => void;
+    sendMessage: (text: string) => void;
+    interrupt: () => void;
+    mute: (muted: boolean) => void;
+    isMuted: boolean;
+    agent: VoiceAgentConfig;
+}
+
+type VoiceStatus = 'DISCONNECTED' | 'CONNECTING' | 'CONNECTED';
+interface VoiceAgentConfig {
+    name: string;
+    instructions: string;
+    tools?: ToolDefinition[];
+    voice?: string;
+    handoffs?: VoiceAgentConfig[];
+}
+interface SessionEvents {
+    [event: string]: (...args: any[]) => void;
+    status_change: (status: VoiceStatus) => void;
+    user_speech_started: () => void;
+    user_transcript: (data: TranscriptData) => void;
+    assistant_transcript: (data: TranscriptData) => void;
+    tool_call_start: (name: string, input: unknown) => void;
+    tool_call_end: (name: string, input: unknown, output: unknown) => void;
+    agent_handoff: (from: string, to: string) => void;
+    guardrail_tripped: (info: unknown) => void;
+    audio_delta: (itemId: string, delta: string) => void;
+    error: (error: Error) => void;
+    /** Escape hatch for provider-specific events not covered by normalized types */
+    raw_event: (event: unknown) => void;
+}
+interface TranscriptData {
+    itemId: string;
+    delta?: string;
+    text?: string;
+    isFinal: boolean;
+}
+interface VoiceSession {
+    connect(config: ConnectConfig): Promise<void>;
+    disconnect(): Promise<void>;
+    sendMessage(text: string): void;
+    interrupt(): void;
+    mute(muted: boolean): void;
+    sendRawEvent?(event: Record<string, unknown>): void;
+    on<E extends string & keyof SessionEvents>(event: E, handler: SessionEvents[E]): void;
+    off<E extends string & keyof SessionEvents>(event: E, handler: SessionEvents[E]): void;
+}
+interface ConnectConfig {
+    /** Authentication token/key obtained from server handler */
+    authToken: string;
+    /** HTML audio element for playback */
+    audioElement?: HTMLAudioElement;
+    /** Extra context passed to the session */
+    context?: Record<string, unknown>;
+    /** Output guardrails */
+    outputGuardrails?: unknown[];
+}
+interface SessionOptions {
+    model?: string;
+    language?: string;
+    codec?: string;
+    voice?: string;
+    /** Provider-specific options */
+    [key: string]: unknown;
+}
+interface VoiceAdapter {
+    /** Unique name for this adapter (e.g. 'openai', 'livekit') */
+    readonly name: string;
+    /** Create a session for the given agent */
+    createSession(agent: VoiceAgentConfig, options?: SessionOptions): VoiceSession;
+}
+interface ServerSessionConfig {
+    /** Provider-specific API key */
+    apiKey?: string;
+    model?: string;
+    voice?: string;
+    instructions?: string;
+    expiresIn?: number;
+    /** Provider-specific options */
+    [key: string]: unknown;
+}
+interface ServerAdapter {
+    createSessionHandler(config?: ServerSessionConfig): (request?: Request) => Promise<Response>;
+    getSessionToken(config?: ServerSessionConfig): Promise<{
+        token: string;
+        error?: never;
+    } | {
+        token?: never;
+        error: string;
+    }>;
+}
+
+export type { AgentConfig as A, ConnectConfig as C, ServerAdapter as S, TranscriptMessage as T, VoiceProviderProps as V, VoiceContextValue as a, VoiceAgentConfig as b, ToolDefinition as c, ToolParamDefinition as d, VoiceAdapter as e, VoiceStatus$1 as f, ServerSessionConfig as g, SessionEvents as h, SessionOptions as i, TranscriptData as j, VoiceConfig as k, VoiceSession as l };

package/package.json

@@ -0,0 +1,100 @@
+{
+  "name": "@jchaffin/voicekit",
+  "version": "0.2.0",
+  "description": "A provider-agnostic React library for building voice-enabled AI agents",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    },
+    "./openai": {
+      "types": "./dist/adapters/openai.d.ts",
+      "import": "./dist/adapters/openai.mjs",
+      "require": "./dist/adapters/openai.js"
+    },
+    "./livekit": {
+      "types": "./dist/adapters/livekit.d.ts",
+      "import": "./dist/adapters/livekit.mjs",
+      "require": "./dist/adapters/livekit.js"
+    },
+    "./deepgram": {
+      "types": "./dist/adapters/deepgram.d.ts",
+      "import": "./dist/adapters/deepgram.mjs",
+      "require": "./dist/adapters/deepgram.js"
+    },
+    "./elevenlabs": {
+      "types": "./dist/adapters/elevenlabs.d.ts",
+      "import": "./dist/adapters/elevenlabs.mjs",
+      "require": "./dist/adapters/elevenlabs.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "import": "./dist/server.mjs",
+      "require": "./dist/server.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts src/server.ts src/adapters/openai.ts src/adapters/livekit.ts src/adapters/deepgram.ts src/adapters/elevenlabs.ts --format cjs,esm --dts --external react --external react-dom --external @openai/agents --external livekit-client --external livekit-server-sdk --external @deepgram/sdk",
+    "dev": "tsup src/index.ts src/server.ts src/adapters/openai.ts src/adapters/livekit.ts src/adapters/deepgram.ts src/adapters/elevenlabs.ts --format cjs,esm --dts --watch --external react --external react-dom --external @openai/agents --external livekit-client --external livekit-server-sdk --external @deepgram/sdk",
+    "lint": "eslint src/",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "voice",
+    "ai",
+    "openai",
+    "livekit",
+    "deepgram",
+    "elevenlabs",
+    "realtime",
+    "react",
+    "agent",
+    "webrtc",
+    "speech",
+    "provider-agnostic"
+  ],
+  "author": "Jacob Chaffin",
+  "license": "MIT",
+  "peerDependencies": {
+    "react": ">=18.0.0",
+    "react-dom": ">=18.0.0",
+    "zod": ">=3.0.0 || >=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@openai/agents": {
+      "optional": true
+    },
+    "livekit-client": {
+      "optional": true
+    },
+    "livekit-server-sdk": {
+      "optional": true
+    },
+    "@deepgram/sdk": {
+      "optional": true
+    },
+    "zod": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@openai/agents": ">=0.0.15",
+    "@types/react": "^18.2.0",
+    "@types/react-dom": "^18.2.0",
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jchaffin/voicekit"
+  }
+}