@elevenlabs/client 0.11.2 → 0.12.0

package/dist/scribe/connection.d.ts

@@ -1,6 +1,6 @@
-import type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage } from "@elevenlabs/types";
-export type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, };
-export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage | ScribeErrorMessage | ScribeAuthErrorMessage | ScribeQuotaExceededErrorMessage;
+import type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, ScribeCommitThrottledErrorMessage, ScribeTranscriberErrorMessage, ScribeUnacceptedTermsErrorMessage, ScribeRateLimitedErrorMessage, ScribeInputErrorMessage, ScribeQueueOverflowErrorMessage, ScribeResourceExhaustedErrorMessage, ScribeSessionTimeLimitExceededErrorMessage, ScribeChunkSizeExceededErrorMessage, ScribeInsufficientAudioActivityErrorMessage } from "@elevenlabs/types";
+export type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, ScribeCommitThrottledErrorMessage, ScribeTranscriberErrorMessage, ScribeUnacceptedTermsErrorMessage, ScribeRateLimitedErrorMessage, ScribeInputErrorMessage, ScribeQueueOverflowErrorMessage, ScribeResourceExhaustedErrorMessage, ScribeSessionTimeLimitExceededErrorMessage, ScribeChunkSizeExceededErrorMessage, ScribeInsufficientAudioActivityErrorMessage, };
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage | ScribeErrorMessage | ScribeAuthErrorMessage | ScribeQuotaExceededErrorMessage | ScribeCommitThrottledErrorMessage | ScribeTranscriberErrorMessage | ScribeUnacceptedTermsErrorMessage | ScribeRateLimitedErrorMessage | ScribeInputErrorMessage | ScribeQueueOverflowErrorMessage | ScribeResourceExhaustedErrorMessage | ScribeSessionTimeLimitExceededErrorMessage | ScribeChunkSizeExceededErrorMessage | ScribeInsufficientAudioActivityErrorMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -15,14 +15,58 @@ export declare enum RealtimeEvents {
     COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an authentication error occurs */
     AUTH_ERROR = "auth_error",
-    /** Emitted when an error occurs */
+    /** Emitted when an error occurs (also emitted for all specific error types) */
     ERROR = "error",
     /** Emitted when the WebSocket connection is opened */
     OPEN = "open",
     /** Emitted when the WebSocket connection is closed */
     CLOSE = "close",
     /** Emitted when a quota exceeded error occurs */
-    QUOTA_EXCEEDED = "quota_exceeded"
+    QUOTA_EXCEEDED = "quota_exceeded",
+    /** Emitted when commit is throttled */
+    COMMIT_THROTTLED = "commit_throttled",
+    /** Emitted when a transcriber error occurs */
+    TRANSCRIBER_ERROR = "transcriber_error",
+    /** Emitted when terms have not been accepted */
+    UNACCEPTED_TERMS = "unaccepted_terms",
+    /** Emitted when rate limited */
+    RATE_LIMITED = "rate_limited",
+    /** Emitted when there's an input error */
+    INPUT_ERROR = "input_error",
+    /** Emitted when the queue overflows */
+    QUEUE_OVERFLOW = "queue_overflow",
+    /** Emitted when resources are exhausted */
+    RESOURCE_EXHAUSTED = "resource_exhausted",
+    /** Emitted when session time limit is exceeded */
+    SESSION_TIME_LIMIT_EXCEEDED = "session_time_limit_exceeded",
+    /** Emitted when chunk size is exceeded */
+    CHUNK_SIZE_EXCEEDED = "chunk_size_exceeded",
+    /** Emitted when there's insufficient audio activity */
+    INSUFFICIENT_AUDIO_ACTIVITY = "insufficient_audio_activity"
+}
+/**
+ * Map of event types to their payload types.
+ */
+export interface RealtimeEventMap {
+    [RealtimeEvents.SESSION_STARTED]: SessionStartedMessage;
+    [RealtimeEvents.PARTIAL_TRANSCRIPT]: PartialTranscriptMessage;
+    [RealtimeEvents.COMMITTED_TRANSCRIPT]: CommittedTranscriptMessage;
+    [RealtimeEvents.COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS]: CommittedTranscriptWithTimestampsMessage;
+    [RealtimeEvents.ERROR]: ScribeErrorMessage;
+    [RealtimeEvents.AUTH_ERROR]: ScribeAuthErrorMessage;
+    [RealtimeEvents.QUOTA_EXCEEDED]: ScribeQuotaExceededErrorMessage;
+    [RealtimeEvents.COMMIT_THROTTLED]: ScribeCommitThrottledErrorMessage;
+    [RealtimeEvents.TRANSCRIBER_ERROR]: ScribeTranscriberErrorMessage;
+    [RealtimeEvents.UNACCEPTED_TERMS]: ScribeUnacceptedTermsErrorMessage;
+    [RealtimeEvents.RATE_LIMITED]: ScribeRateLimitedErrorMessage;
+    [RealtimeEvents.INPUT_ERROR]: ScribeInputErrorMessage;
+    [RealtimeEvents.QUEUE_OVERFLOW]: ScribeQueueOverflowErrorMessage;
+    [RealtimeEvents.RESOURCE_EXHAUSTED]: ScribeResourceExhaustedErrorMessage;
+    [RealtimeEvents.SESSION_TIME_LIMIT_EXCEEDED]: ScribeSessionTimeLimitExceededErrorMessage;
+    [RealtimeEvents.CHUNK_SIZE_EXCEEDED]: ScribeChunkSizeExceededErrorMessage;
+    [RealtimeEvents.INSUFFICIENT_AUDIO_ACTIVITY]: ScribeInsufficientAudioActivityErrorMessage;
+    [RealtimeEvents.OPEN]: undefined;
+    [RealtimeEvents.CLOSE]: CloseEvent;
 }
 /**
  * Manages a real-time transcription WebSocket connection.
@@ -76,19 +120,19 @@ export declare class RealtimeConnection {
      * @example
      * ```typescript
      * connection.on(RealtimeEvents.SESSION_STARTED, (data) => {
-     *     console.log("Session started", data);
+     *     console.log("Session started", data.session_id);
      * });
      *
      * connection.on(RealtimeEvents.PARTIAL_TRANSCRIPT, (data) => {
-     *     console.log("Partial:", data.transcript);
+     *     console.log("Partial:", data.text);
      * });
      *
      * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
-     *     console.log("Final:", data.transcript);
+     *     console.log("Final:", data.text);
      * });
      * ```
      */
-    on(event: RealtimeEvents, listener: (...args: unknown[]) => void): void;
+    on<E extends RealtimeEvents>(event: E, listener: RealtimeEventMap[E] extends undefined ? () => void : (data: RealtimeEventMap[E]) => void): void;
     /**
      * Removes an event listener for the specified event.
      *
@@ -97,14 +141,14 @@ export declare class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * const handler = (data) => console.log(data);
+     * const handler = (data: PartialTranscriptMessage) => console.log(data.text);
      * connection.on(RealtimeEvents.PARTIAL_TRANSCRIPT, handler);
      *
      * // Later, remove the listener
      * connection.off(RealtimeEvents.PARTIAL_TRANSCRIPT, handler);
      * ```
      */
-    off(event: RealtimeEvents, listener: (...args: unknown[]) => void): void;
+    off<E extends RealtimeEvents>(event: E, listener: RealtimeEventMap[E] extends undefined ? () => void : (data: RealtimeEventMap[E]) => void): void;
     /**
      * Sends audio data to the transcription service.
      *
@@ -112,6 +156,7 @@ export declare class RealtimeConnection {
      * @param data.audioBase64 - Base64-encoded audio data
      * @param data.commit - Whether to commit the transcription after this chunk. You likely want to use connection.commit() instead (default: false)
      * @param data.sampleRate - Sample rate of the audio (default: configured sample rate)
+     * @param data.previousText - Send context to the model via base64 encoded audio or text from a previous transcription. Can only be sent alongside the first audio chunk. If sent in a subsequent chunk, an error will be returned.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -122,10 +167,11 @@ export declare class RealtimeConnection {
      *     audioBase64: base64EncodedAudio,
      * });
      *
-     * // Send audio chunk with custom sample rate
+     * // Send audio chunk with custom sample rate and previous text
      * connection.send({
      *     audioBase64: base64EncodedAudio,
      *     sampleRate: 16000,
+     *     previousText: "Previous transcription text",
      * });
      * ```
      */
@@ -133,6 +179,7 @@ export declare class RealtimeConnection {
         audioBase64: string;
         commit?: boolean;
         sampleRate?: number;
+        previousText?: string;
     }): void;
     /**
      * Commits the transcription, signaling that a segment of audio has been sent. This clears the buffer and triggers a COMMITTED_TRANSCRIPT event. Context from previous segments is kept.

package/dist/scribe/index.d.ts

@@ -2,5 +2,6 @@ export { ScribeRealtime as Scribe } from "./scribe";
 export { RealtimeConnection } from "./connection";
 export { AudioFormat, CommitStrategy } from "./scribe";
 export { RealtimeEvents } from "./connection";
+export type { RealtimeEventMap } from "./connection";
 export type { AudioOptions, MicrophoneOptions } from "./scribe";
-export type { WebSocketMessage, SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, } from "./connection";
+export type { WebSocketMessage, SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, ScribeCommitThrottledErrorMessage, ScribeTranscriberErrorMessage, ScribeUnacceptedTermsErrorMessage, ScribeRateLimitedErrorMessage, ScribeInputErrorMessage, ScribeQueueOverflowErrorMessage, ScribeResourceExhaustedErrorMessage, ScribeSessionTimeLimitExceededErrorMessage, ScribeChunkSizeExceededErrorMessage, ScribeInsufficientAudioActivityErrorMessage, } from "./connection";

package/dist/utils/events.d.ts

@@ -1,5 +1,5 @@
 import { Outgoing } from "@elevenlabs/types";
-import { AgentChatResponsePartClientEvent, AgentResponse, AgentResponseCorrection, AgentToolResponseClientEvent, AsrInitiationMetadataEvent as AsrMetadataEvent, Audio, ClientToolCallMessage, ConversationMetadata, ErrorMessage, Interruption, McpConnectionStatusClientEvent, McpToolCall, Ping, InternalTentativeAgentResponse as TentativeAgentResponseInternal, UserTranscript, VadScore } from "@elevenlabs/types/generated/types/asyncapi-types";
+import { AgentChatResponsePartClientEvent, AgentResponse, AgentResponseCorrection, AgentToolResponseClientEvent, AsrInitiationMetadataEvent as AsrMetadataEvent, Audio, AgentToolRequestClientEvent, ClientToolCallMessage, ConversationMetadata, ErrorMessage, Interruption, McpConnectionStatusClientEvent, McpToolCall, Ping, InternalTentativeAgentResponse as TentativeAgentResponseInternal, UserTranscript, VadScore } from "@elevenlabs/types/generated/types/asyncapi-types";
 export type UserTranscriptionEvent = UserTranscript;
 export type AgentResponseEvent = AgentResponse;
 export type AgentAudioEvent = Audio;
@@ -11,13 +11,14 @@ export type ClientToolCallEvent = ClientToolCallMessage;
 export type VadScoreEvent = VadScore;
 export type MCPToolCallClientEvent = McpToolCall;
 export type AgentResponseCorrectionEvent = AgentResponseCorrection;
+export type AgentToolRequestEvent = AgentToolRequestClientEvent;
 export type AgentToolResponseEvent = AgentToolResponseClientEvent;
 export type ConversationMetadataEvent = ConversationMetadata;
 export type AsrInitiationMetadataEvent = AsrMetadataEvent;
 export type MCPConnectionStatusEvent = McpConnectionStatusClientEvent;
 export type AgentChatResponsePartEvent = AgentChatResponsePartClientEvent;
 export type ErrorMessageEvent = ErrorMessage;
-export type IncomingSocketEvent = UserTranscriptionEvent | AgentResponseEvent | AgentResponseCorrectionEvent | AgentAudioEvent | InterruptionEvent | InternalTentativeAgentResponseEvent | ConfigEvent | PingEvent | ClientToolCallEvent | VadScoreEvent | MCPToolCallClientEvent | AgentToolResponseEvent | ConversationMetadataEvent | AsrInitiationMetadataEvent | MCPConnectionStatusEvent | AgentChatResponsePartEvent | ErrorMessageEvent;
+export type IncomingSocketEvent = UserTranscriptionEvent | AgentResponseEvent | AgentResponseCorrectionEvent | AgentAudioEvent | InterruptionEvent | InternalTentativeAgentResponseEvent | ConfigEvent | PingEvent | ClientToolCallEvent | VadScoreEvent | MCPToolCallClientEvent | AgentToolRequestEvent | AgentToolResponseEvent | ConversationMetadataEvent | AsrInitiationMetadataEvent | MCPConnectionStatusEvent | AgentChatResponsePartEvent | ErrorMessageEvent;
 export type PongEvent = Outgoing.PongClientToOrchestratorEvent;
 export type UserAudioEvent = Outgoing.UserAudio;
 export type UserFeedbackEvent = Outgoing.UserFeedbackClientToOrchestratorEvent;

package/dist/utils/input.d.ts

@@ -11,6 +11,7 @@ export declare class Input {
     inputStream: MediaStream;
     private mediaStreamSource;
     static create({ sampleRate, format, preferHeadphonesForIosDevices, inputDeviceId, workletPaths, libsampleratePath, }: FormatConfig & InputConfig & AudioWorkletConfig): Promise<Input>;
+    private static getDeviceIdConstraint;
     private constructor();
     close(): Promise<void>;
     setMuted(isMuted: boolean): void;

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "0.11.2";
+export declare const PACKAGE_VERSION = "0.12.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elevenlabs/client",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "description": "ElevenLabs JavaScript Client Library",
   "main": "./dist/lib.umd.js",
   "module": "./dist/lib.module.js",
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "livekit-client": "^2.11.4",
-    "@elevenlabs/types": "0.3.0"
+    "@elevenlabs/types": "0.4.0"
   },
   "scripts": {
     "generate-version": "printf \"// This file is auto-generated during build\\nexport const PACKAGE_VERSION = \\\"%s\\\";\\n\" \"$npm_package_version\" > src/version.ts",