@elevenlabs/elevenlabs-js 2.24.0 → 2.24.1

package/README.md

@@ -99,7 +99,7 @@ stream(audioStream);
 ## Retries
 
 This Node SDK is instrumented with automatic retries with exponential backoff. A request will be
-retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+retried as long as the request is deemed retry-able and the number of retry attempts has not grown larger
 than the configured retry limit (default: 2).
 
 A request is deemed able to retry when any of the following HTTP status codes is returned:
@@ -122,7 +122,7 @@ const response = await elevenlabs.voices.search(
 
 ## Timeouts
 
-The SDK defaults to a 60 second timout. Use the `timeoutInSeconds` option to
+The SDK defaults to a 60 second timeout. Use the `timeoutInSeconds` option to
 configure this behavior.
 
 ```ts
@@ -134,7 +134,7 @@ const response = await elevenlabs.voices.search(
 );
 ```
 
-## Runtime compatiblity
+## Runtime compatibility
 
 The SDK defaults to `node-fetch` but will use the global fetch client if present. The SDK
 works in the following runtimes:

package/dist/wrapper/realtime/connection.d.ts

@@ -28,6 +28,7 @@ export interface Config {
     min_silence_duration_ms?: number;
     model_id?: string;
     disable_logging?: boolean;
+    include_timestamps?: boolean;
 }
 export interface SessionStartedMessage {
     message_type: "session_started";
@@ -48,7 +49,19 @@ export interface CommittedTranscriptWithTimestampsMessage {
     language_code?: string;
     words?: WordsItem[];
 }
-export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage;
+export interface ErrorMessage {
+    message_type: "error";
+    error: string;
+}
+export interface AuthErrorMessage {
+    message_type: "auth_error";
+    error: string;
+}
+export interface QuotaExceededErrorMessage {
+    message_type: "quota_exceeded";
+    error: string;
+}
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage | ErrorMessage | AuthErrorMessage | QuotaExceededErrorMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -63,6 +76,10 @@ export declare enum RealtimeEvents {
     COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an error occurs */
     ERROR = "error",
+    /** Emitted when an auth error occurs */
+    AUTH_ERROR = "auth_error",
+    /** Emitted when a quota exceeded error occurs */
+    QUOTA_EXCEEDED = "quota_exceeded",
     /** Emitted when the WebSocket connection is opened */
     OPEN = "open",
     /** Emitted when the WebSocket connection is closed */

package/dist/wrapper/realtime/connection.js

@@ -21,6 +21,10 @@ var RealtimeEvents;
     RealtimeEvents["COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS"] = "committed_transcript_with_timestamps";
     /** Emitted when an error occurs */
     RealtimeEvents["ERROR"] = "error";
+    /** Emitted when an auth error occurs */
+    RealtimeEvents["AUTH_ERROR"] = "auth_error";
+    /** Emitted when a quota exceeded error occurs */
+    RealtimeEvents["QUOTA_EXCEEDED"] = "quota_exceeded";
     /** Emitted when the WebSocket connection is opened */
     RealtimeEvents["OPEN"] = "open";
     /** Emitted when the WebSocket connection is closed */
@@ -99,6 +103,15 @@ class RealtimeConnection {
                 case "committed_transcript_with_timestamps":
                     this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS, data);
                     break;
+                case "error":
+                    this.eventEmitter.emit(RealtimeEvents.ERROR, data);
+                    break;
+                case "auth_error":
+                    this.eventEmitter.emit(RealtimeEvents.AUTH_ERROR, data);
+                    break;
+                case "quota_exceeded":
+                    this.eventEmitter.emit(RealtimeEvents.QUOTA_EXCEEDED, data);
+                    break;
             }
         });
         this.websocket.on("error", (error) => {

package/dist/wrapper/realtime/scribe.d.ts

@@ -49,6 +49,11 @@ interface BaseOptions {
      * Can sometimes improve transcription performance if known beforehand.
      */
     languageCode?: string;
+    /**
+     * Whether to receive a committed_transcript_with_timestamps event which includes word-level timestamps.
+     * @default false
+     */
+    includeTimestamps?: boolean;
 }
 export interface AudioOptions extends BaseOptions {
     audioFormat: AudioFormat;

package/dist/wrapper/realtime/scribe.js

@@ -136,6 +136,9 @@ class ScribeRealtime {
             if (options.languageCode !== undefined) {
                 params.append("language_code", options.languageCode);
             }
+            if (options.includeTimestamps !== undefined) {
+                params.append("include_timestamps", options.includeTimestamps.toString());
+            }
             const queryString = params.toString();
             return queryString ? `${baseUri}?${queryString}` : baseUri;
         });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@elevenlabs/elevenlabs-js",
-    "version": "v2.24.0",
+    "version": "v2.24.1",
     "private": false,
     "repository": "github:elevenlabs/elevenlabs-js",
     "license": "MIT",

package/wrapper/realtime/connection.d.ts

@@ -28,6 +28,7 @@ export interface Config {
     min_silence_duration_ms?: number;
     model_id?: string;
     disable_logging?: boolean;
+    include_timestamps?: boolean;
 }
 export interface SessionStartedMessage {
     message_type: "session_started";
@@ -48,7 +49,19 @@ export interface CommittedTranscriptWithTimestampsMessage {
     language_code?: string;
     words?: WordsItem[];
 }
-export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage;
+export interface ErrorMessage {
+    message_type: "error";
+    error: string;
+}
+export interface AuthErrorMessage {
+    message_type: "auth_error";
+    error: string;
+}
+export interface QuotaExceededErrorMessage {
+    message_type: "quota_exceeded";
+    error: string;
+}
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage | ErrorMessage | AuthErrorMessage | QuotaExceededErrorMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -63,6 +76,10 @@ export declare enum RealtimeEvents {
     COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an error occurs */
     ERROR = "error",
+    /** Emitted when an auth error occurs */
+    AUTH_ERROR = "auth_error",
+    /** Emitted when a quota exceeded error occurs */
+    QUOTA_EXCEEDED = "quota_exceeded",
     /** Emitted when the WebSocket connection is opened */
     OPEN = "open",
     /** Emitted when the WebSocket connection is closed */

package/wrapper/realtime/connection.js

@@ -21,6 +21,10 @@ var RealtimeEvents;
     RealtimeEvents["COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS"] = "committed_transcript_with_timestamps";
     /** Emitted when an error occurs */
     RealtimeEvents["ERROR"] = "error";
+    /** Emitted when an auth error occurs */
+    RealtimeEvents["AUTH_ERROR"] = "auth_error";
+    /** Emitted when a quota exceeded error occurs */
+    RealtimeEvents["QUOTA_EXCEEDED"] = "quota_exceeded";
     /** Emitted when the WebSocket connection is opened */
     RealtimeEvents["OPEN"] = "open";
     /** Emitted when the WebSocket connection is closed */
@@ -99,6 +103,15 @@ class RealtimeConnection {
                 case "committed_transcript_with_timestamps":
                     this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS, data);
                     break;
+                case "error":
+                    this.eventEmitter.emit(RealtimeEvents.ERROR, data);
+                    break;
+                case "auth_error":
+                    this.eventEmitter.emit(RealtimeEvents.AUTH_ERROR, data);
+                    break;
+                case "quota_exceeded":
+                    this.eventEmitter.emit(RealtimeEvents.QUOTA_EXCEEDED, data);
+                    break;
             }
         });
         this.websocket.on("error", (error) => {

package/wrapper/realtime/scribe.d.ts

@@ -49,6 +49,11 @@ interface BaseOptions {
      * Can sometimes improve transcription performance if known beforehand.
      */
     languageCode?: string;
+    /**
+     * Whether to receive a committed_transcript_with_timestamps event which includes word-level timestamps.
+     * @default false
+     */
+    includeTimestamps?: boolean;
 }
 export interface AudioOptions extends BaseOptions {
     audioFormat: AudioFormat;

package/wrapper/realtime/scribe.js

@@ -136,6 +136,9 @@ class ScribeRealtime {
             if (options.languageCode !== undefined) {
                 params.append("language_code", options.languageCode);
             }
+            if (options.includeTimestamps !== undefined) {
+                params.append("include_timestamps", options.includeTimestamps.toString());
+            }
             const queryString = params.toString();
             return queryString ? `${baseUri}?${queryString}` : baseUri;
         });