openai 7.3.0 → 7.5.0

package/realtime/websocket.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.d.mts","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAiB;AAE/C,OAAO,KAAK,EAAE,mBAAmB,EAAuB,2CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAIrB,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC9B,4BAAwB;AAOzB,KAAK,UAAU,GACb,OAAO,UAAU,SAAS,CACxB;IACE,SAAS,EAAE,MAAM,EAAE,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;CAChE,CACF,GAEC,YAAY,CAAC,EAAE,CAAC,GAChB,GAAG,CAAC;AAER,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,UAAU,CAAC;gBAGjB,KAAK,EAAE,wBAAwB,GAAG;QAChC,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC;;;WAGG;QACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;QAC3B,wFAAwF;QACxF,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;WAqEhC,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GACtE,OAAO,CAAC,uBAAuB,CAAC;WAItB,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,OAAO,GAAE,6BAA6B,GAAG;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAO,GAClF,OAAO,CAAC,uBAAuB,CAAC;IA2BnC,IAAI,CAAC,KAAK,EAAE,mBAAmB;IAQ/B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAO/C"}
+{"version":3,"file":"websocket.d.mts","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAiB;AAE5C,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAuB,2CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAItB,4BAAwB;AACzB,OAAO,KAAK,EAAE,6BAA6B,EAAE,wBAAwB,EAAE,4BAAwB;AAO/F,4EAA4E;AAC5E,KAAK,UAAU,GAAG,OAAO,UAAU,SAAS;IAC1C,mFAAmF;IACnF,SAAS,EAAE,MAAM,EAAE,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;CAChE,GAEG,YAAY,CAAC,EAAE,CAAC,GAChB,GAAG,CAAC;AAaR;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,yFAAyF;IACzF,GAAG,EAAE,GAAG,CAAC;IAET,oFAAoF;IACpF,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,wBAAwB,GAAG;QAChC,6FAA6F;QAC7F,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAElC;;;WAGG;QACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;QAC3B,wFAAwF;QACxF,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAkE7C;;;;;;;OAOG;WACU,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAChC,qFAAqF;QACrF,uBAAuB,CAAC,EAAE,OAAO,CAAC;KACnC,GACA,OAAO,CAAC,uBAAuB,CAAC;IAcnC;;;;;;;;;OASG;WACU,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,OAAO,GAAE,6BAA6B,GAAG;QACvC,2FAA2F;QAC3F,uBAAuB,CAAC,EAAE,OAAO,CAAC;KAC9B,GACL,OAAO,CAAC,uBAAuB,CAAC;IA2BnC;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAQtC;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE;QACZ,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;CAOT"}

package/realtime/websocket.d.ts

@@ -1,13 +1,41 @@
-import { AzureOpenAI, OpenAI } from "../index.js";
+import type { AzureOpenAI } from "../index.js";
+import { OpenAI } from "../index.js";
 import type { RealtimeClientEvent } from "../resources/realtime/realtime.js";
-import { OpenAIRealtimeEmitter, type AzureRealtimeConnectionConfig, type RealtimeConnectionConfig } from "./internal-base.js";
-type _WebSocket = typeof globalThis extends ({
+import { OpenAIRealtimeEmitter } from "./internal-base.js";
+import type { AzureRealtimeConnectionConfig, RealtimeConnectionConfig } from "./internal-base.js";
+/** Native WebSocket instance supplied by the current JavaScript runtime. */
+type _WebSocket = typeof globalThis extends {
+    /** Runtime-provided WebSocket constructor used for native Realtime connections. */
     WebSocket: infer ws extends abstract new (...args: any) => any;
-}) ? InstanceType<ws> : any;
+} ? InstanceType<ws> : any;
+/**
+ * Connects to the Realtime API using the runtime's native `WebSocket` implementation.
+ *
+ * Browser use is blocked by default to prevent secret API-key exposure. Use an
+ * ephemeral Realtime credential in browser clients; set
+ * `dangerouslyAllowBrowser` only after independently securing the credential.
+ * Register an SDK `error` listener and wait for `socket`'s `open` event before
+ * sending Realtime client events.
+ */
 export declare class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
+    /** Secure Realtime WebSocket URL; Azure authentication query parameters are redacted. */
     url: URL;
+    /** Underlying runtime-native WebSocket instance for connection lifecycle events. */
     socket: _WebSocket;
+    /**
+     * Immediately opens a native WebSocket session or attaches to an existing call.
+     *
+     * Clients with function-based credentials must use
+     * {@link OpenAIRealtimeWebSocket.create}; Azure clients should use
+     * {@link OpenAIRealtimeWebSocket.azure}. An ephemeral credential whose value
+     * starts with `ek_` is permitted in browser runtimes automatically.
+     *
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     * @param client Existing client whose endpoint and API key should be reused.
+     * @throws {OpenAIError} If browser access would expose an unapproved credential.
+     */
     constructor(props: RealtimeConnectionConfig & {
+        /** Allows browser execution; use only when the credential cannot expose a secret API key. */
         dangerouslyAllowBrowser?: boolean;
         /**
          * Callback to mutate the URL, needed for Azure.
@@ -17,15 +45,45 @@ export declare class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
         /** Indicates the token was resolved by the factory just before connecting. @internal */
         __resolvedApiKey?: boolean;
     }, client?: Pick<OpenAI, 'apiKey' | 'baseURL'>);
+    /**
+     * Resolves a client's current API credential before opening a native Realtime WebSocket.
+     *
+     * Use this factory instead of the constructor when the client's `apiKey` is a function.
+     *
+     * @param client OpenAI client that owns the endpoint and refreshable or static credential.
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     */
     static create(client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_callApiKey'>, props: RealtimeConnectionConfig & {
+        /** Allows browser execution after the caller has secured the supplied credential. */
         dangerouslyAllowBrowser?: boolean;
     }): Promise<OpenAIRealtimeWebSocket>;
+    /**
+     * Opens a native Azure deployment or transcription session, or an existing sideband call.
+     *
+     * Azure credentials are included only in the initial connection URL and are
+     * redacted from the exposed `url` property immediately after connection setup.
+     *
+     * @param client Azure OpenAI client that supplies the endpoint and credential.
+     * @param options Deployment, transcription intent, or call ID, plus browser-safety settings.
+     * @throws {Error} If the Azure credential or required deployment is unavailable.
+     */
     static azure(client: Pick<AzureOpenAI, '_callApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>, options?: AzureRealtimeConnectionConfig & {
+        /** Allows browser execution after the caller has secured the supplied Azure credential. */
         dangerouslyAllowBrowser?: boolean;
     }): Promise<OpenAIRealtimeWebSocket>;
+    /**
+     * Serializes and sends a Realtime client event after the native WebSocket has opened.
+     * Serialization and transport failures are delivered to the SDK `error` event.
+     */
     send(event: RealtimeClientEvent): void;
+    /**
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the SDK `error` event.
+     */
     close(props?: {
+        /** WebSocket close status code; defaults to `1000`. */
         code: number;
+        /** WebSocket close reason; defaults to `OK`. */
         reason: string;
     }): void;
 }

package/realtime/websocket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAiB;AAE/C,OAAO,KAAK,EAAE,mBAAmB,EAAuB,0CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAIrB,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC9B,2BAAwB;AAOzB,KAAK,UAAU,GACb,OAAO,UAAU,SAAS,CACxB;IACE,SAAS,EAAE,MAAM,EAAE,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;CAChE,CACF,GAEC,YAAY,CAAC,EAAE,CAAC,GAChB,GAAG,CAAC;AAER,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,UAAU,CAAC;gBAGjB,KAAK,EAAE,wBAAwB,GAAG;QAChC,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAClC;;;WAGG;QACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;QAC3B,wFAAwF;QACxF,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;WAqEhC,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAE,GACtE,OAAO,CAAC,uBAAuB,CAAC;WAItB,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,OAAO,GAAE,6BAA6B,GAAG;QAAE,uBAAuB,CAAC,EAAE,OAAO,CAAA;KAAO,GAClF,OAAO,CAAC,uBAAuB,CAAC;IA2BnC,IAAI,CAAC,KAAK,EAAE,mBAAmB;IAQ/B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAO/C"}
+{"version":3,"file":"websocket.d.ts","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAiB;AAE5C,OAAO,EAAE,MAAM,EAAE,oBAAiB;AAElC,OAAO,KAAK,EAAE,mBAAmB,EAAuB,0CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAItB,2BAAwB;AACzB,OAAO,KAAK,EAAE,6BAA6B,EAAE,wBAAwB,EAAE,2BAAwB;AAO/F,4EAA4E;AAC5E,KAAK,UAAU,GAAG,OAAO,UAAU,SAAS;IAC1C,mFAAmF;IACnF,SAAS,EAAE,MAAM,EAAE,SAAS,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,CAAC;CAChE,GAEG,YAAY,CAAC,EAAE,CAAC,GAChB,GAAG,CAAC;AAaR;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,yFAAyF;IACzF,GAAG,EAAE,GAAG,CAAC;IAET,oFAAoF;IACpF,MAAM,EAAE,UAAU,CAAC;IAEnB;;;;;;;;;;;OAWG;gBAED,KAAK,EAAE,wBAAwB,GAAG;QAChC,6FAA6F;QAC7F,uBAAuB,CAAC,EAAE,OAAO,CAAC;QAElC;;;WAGG;QACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,IAAI,CAAC;QAC3B,wFAAwF;QACxF,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAkE7C;;;;;;;OAOG;WACU,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAChC,qFAAqF;QACrF,uBAAuB,CAAC,EAAE,OAAO,CAAC;KACnC,GACA,OAAO,CAAC,uBAAuB,CAAC;IAcnC;;;;;;;;;OASG;WACU,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,OAAO,GAAE,6BAA6B,GAAG;QACvC,2FAA2F;QAC3F,uBAAuB,CAAC,EAAE,OAAO,CAAC;KAC9B,GACL,OAAO,CAAC,uBAAuB,CAAC;IA2BnC;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAQtC;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE;QACZ,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;CAOT"}

package/realtime/websocket.js

@@ -1,11 +1,43 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIRealtimeWebSocket = void 0;
+const bedrock_1 = require("../internal/bedrock.js");
 const index_1 = require("../index.js");
 const error_1 = require("../error.js");
 const internal_base_1 = require("./internal-base.js");
 const detect_platform_1 = require("../internal/detect-platform.js");
+/** Removes Azure credential query values from the publicly exposed connection URL. */
+function redactAzureCredentials(url) {
+    const hasAuthorization = url.searchParams.has('Authorization');
+    if (url.searchParams.has('api-key') || !hasAuthorization) {
+        url.searchParams.set('api-key', '<REDACTED>');
+    }
+    if (hasAuthorization) {
+        url.searchParams.set('Authorization', '<REDACTED>');
+    }
+}
+/**
+ * Connects to the Realtime API using the runtime's native `WebSocket` implementation.
+ *
+ * Browser use is blocked by default to prevent secret API-key exposure. Use an
+ * ephemeral Realtime credential in browser clients; set
+ * `dangerouslyAllowBrowser` only after independently securing the credential.
+ * Register an SDK `error` listener and wait for `socket`'s `open` event before
+ * sending Realtime client events.
+ */
 class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
+    /**
+     * Immediately opens a native WebSocket session or attaches to an existing call.
+     *
+     * Clients with function-based credentials must use
+     * {@link OpenAIRealtimeWebSocket.create}; Azure clients should use
+     * {@link OpenAIRealtimeWebSocket.azure}. An ephemeral credential whose value
+     * starts with `ek_` is permitted in browser runtimes automatically.
+     *
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     * @param client Existing client whose endpoint and API key should be reused.
+     * @throws {OpenAIError} If browser access would expose an unapproved credential.
+     */
     constructor(props, client) {
         super();
         const hasProvider = typeof client?._options?.apiKey === 'function';
@@ -24,6 +56,7 @@ class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
         }
         this.url = (0, internal_base_1.buildRealtimeURL)(client, props);
         props.onURL?.(this.url);
+        (0, bedrock_1.assertBedrockWebSocketOrigin)(client, this.url);
         // @ts-ignore
         this.socket = new WebSocket(this.url.toString(), [
             'realtime',
@@ -54,17 +87,37 @@ class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
             this._onError(null, event.message, null);
         });
         if ((0, internal_base_1.isAzure)(client)) {
-            if (this.url.searchParams.get('Authorization') !== null) {
-                this.url.searchParams.set('Authorization', '<REDACTED>');
-            }
-            else {
-                this.url.searchParams.set('api-key', '<REDACTED>');
-            }
+            redactAzureCredentials(this.url);
         }
     }
+    /**
+     * Resolves a client's current API credential before opening a native Realtime WebSocket.
+     *
+     * Use this factory instead of the constructor when the client's `apiKey` is a function.
+     *
+     * @param client OpenAI client that owns the endpoint and refreshable or static credential.
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     */
     static async create(client, props) {
-        return new OpenAIRealtimeWebSocket({ ...props, __resolvedApiKey: await client._callApiKey() }, client);
+        const resolvedApiKey = await client._callApiKey();
+        const url = (0, internal_base_1.buildRealtimeURL)(client, props);
+        (0, bedrock_1.assertBedrockWebSocketOrigin)(client, url);
+        return new OpenAIRealtimeWebSocket({
+            ...props,
+            buildRealtimeURL: () => url,
+            __resolvedApiKey: resolvedApiKey,
+        }, client);
     }
+    /**
+     * Opens a native Azure deployment or transcription session, or an existing sideband call.
+     *
+     * Azure credentials are included only in the initial connection URL and are
+     * redacted from the exposed `url` property immediately after connection setup.
+     *
+     * @param client Azure OpenAI client that supplies the endpoint and credential.
+     * @param options Deployment, transcription intent, or call ID, plus browser-safety settings.
+     * @throws {Error} If the Azure credential or required deployment is unavailable.
+     */
     static async azure(client, options = {}) {
         const connection = (0, internal_base_1.getAzureRealtimeConnection)(client, options);
         const isApiKeyProvider = await client._callApiKey();
@@ -85,10 +138,14 @@ class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
         return new OpenAIRealtimeWebSocket({
             ...connection,
             onURL,
-            ...(dangerouslyAllowBrowser ? { dangerouslyAllowBrowser } : {}),
+            ...(dangerouslyAllowBrowser === undefined ? {} : { dangerouslyAllowBrowser }),
             __resolvedApiKey: isApiKeyProvider,
         }, client);
     }
+    /**
+     * Serializes and sends a Realtime client event after the native WebSocket has opened.
+     * Serialization and transport failures are delivered to the SDK `error` event.
+     */
     send(event) {
         try {
             this.socket.send(JSON.stringify(event));
@@ -97,6 +154,10 @@ class OpenAIRealtimeWebSocket extends internal_base_1.OpenAIRealtimeEmitter {
             this._onError(null, 'could not send data', err);
         }
     }
+    /**
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the SDK `error` event.
+     */
     close(props) {
         try {
             this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');

package/realtime/websocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":";;;AAAA,uCAA+C;AAC/C,uCAAuC;AAEvC,sDAOyB;AACzB,oEAAiE;AAgBjE,MAAa,uBAAwB,SAAQ,qCAAqB;IAIhE,YACE,KASC,EACD,MAA2C;QAE3C,KAAK,EAAE,CAAC;QACR,MAAM,WAAW,GAAG,OAAQ,MAAc,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;QAC5E,MAAM,uBAAuB,GAC3B,KAAK,CAAC,uBAAuB;YAC5B,MAAc,EAAE,QAAQ,EAAE,uBAAuB;YAClD,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,uBAAuB,IAAI,IAAA,oCAAkB,GAAE,EAAE,CAAC;YACrD,MAAM,IAAI,mBAAW,CACnB,oSAAoS,CACrS,CAAC;QACJ,CAAC;QAED,MAAM,KAAN,MAAM,GAAK,IAAI,cAAM,CAAC,EAAE,uBAAuB,EAAE,CAAC,EAAC;QAEnD,IAAI,WAAW,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CACb;gBACE,8DAA8D;gBAC9D,yEAAyE;aAC1E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,IAAA,gCAAgB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3C,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExB,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC/C,UAAU;YACV,GAAG,CAAC,IAAA,uBAAO,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,2BAA2B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACzE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,cAA4B,EAAE,EAAE;YACvE,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAwB,CAAC;gBAC3E,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,iCAAiC,EAAE,GAAG,CAAC,CAAC;oBAC5D,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,4EAA4E;oBAC5E,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAA,uBAAO,EAAC,MAAM,CAAC,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC;gBACxD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,MAA0D,EAC1D,KAAuE;QAEvE,OAAO,IAAI,uBAAuB,CAAC,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,MAAiG,EACjG,UAAiF,EAAE;QAEnF,MAAM,UAAU,GAAG,IAAA,0CAA0B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,CAAC;QAC3B,SAAS,KAAK,CAAC,GAAQ;YACrB,IAAI,gBAAgB,EAAE,CAAC;gBACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;QAC5C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,UAAU;YACb,KAAK;YACL,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,gBAAgB,EAAE,gBAAgB;SACnC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,KAA0B;QAC7B,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAwC;QAC5C,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;CACF;AAxID,0DAwIC"}
+{"version":3,"file":"websocket.js","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":";;;AACA,oDAAmE;AACnE,uCAAkC;AAClC,uCAAuC;AAEvC,sDAKyB;AAEzB,oEAAiE;AAejE,sFAAsF;AACtF,SAAS,sBAAsB,CAAC,GAAQ;IACtC,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC/D,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACzD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,gBAAgB,EAAE,CAAC;QACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAa,uBAAwB,SAAQ,qCAAqB;IAOhE;;;;;;;;;;;OAWG;IACH,YACE,KAWC,EACD,MAA2C;QAE3C,KAAK,EAAE,CAAC;QACR,MAAM,WAAW,GAAG,OAAQ,MAAc,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;QAC5E,MAAM,uBAAuB,GAC3B,KAAK,CAAC,uBAAuB;YAC5B,MAAc,EAAE,QAAQ,EAAE,uBAAuB;YAClD,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,uBAAuB,IAAI,IAAA,oCAAkB,GAAE,EAAE,CAAC;YACrD,MAAM,IAAI,mBAAW,CACnB,oSAAoS,CACrS,CAAC;QACJ,CAAC;QAED,MAAM,KAAN,MAAM,GAAK,IAAI,cAAM,CAAC,EAAE,uBAAuB,EAAE,CAAC,EAAC;QAEnD,IAAI,WAAW,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CACb;gBACE,8DAA8D;gBAC9D,yEAAyE;aAC1E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,IAAA,gCAAgB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3C,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,IAAA,sCAA4B,EAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAE/C,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC/C,UAAU;YACV,GAAG,CAAC,IAAA,uBAAO,EAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,2BAA2B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACzE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,cAA4B,EAAE,EAAE;YACvE,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAwB,CAAC;gBAC3E,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,iCAAiC,EAAE,GAAG,CAAC,CAAC;oBAC5D,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,4EAA4E;oBAC5E,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,IAAA,uBAAO,EAAC,MAAM,CAAC,EAAE,CAAC;YACpB,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,MAA0D,EAC1D,KAGC;QAED,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QAClD,MAAM,GAAG,GAAG,IAAA,gCAAgB,EAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAA,sCAA4B,EAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,KAAK;YACR,gBAAgB,EAAE,GAAG,EAAE,CAAC,GAAG;YAC3B,gBAAgB,EAAE,cAAc;SACjC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,MAAiG,EACjG,UAGI,EAAE;QAEN,MAAM,UAAU,GAAG,IAAA,0CAA0B,EAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,CAAC;QAC3B,SAAS,KAAK,CAAC,GAAQ;YACrB,IAAI,gBAAgB,EAAE,CAAC;gBACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;QAC5C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,UAAU;YACb,KAAK;YACL,GAAG,CAAC,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,CAAC;YAC7E,gBAAgB,EAAE,gBAAgB;SACnC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,KAA0B;QAC7B,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAML;QACC,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;CACF;AAtMD,0DAsMC"}

package/realtime/websocket.mjs

@@ -1,8 +1,40 @@
+import { assertBedrockWebSocketOrigin } from "../internal/bedrock.mjs";
 import { OpenAI } from "../index.mjs";
 import { OpenAIError } from "../error.mjs";
 import { OpenAIRealtimeEmitter, buildRealtimeURL, getAzureRealtimeConnection, isAzure, } from "./internal-base.mjs";
 import { isRunningInBrowser } from "../internal/detect-platform.mjs";
+/** Removes Azure credential query values from the publicly exposed connection URL. */
+function redactAzureCredentials(url) {
+    const hasAuthorization = url.searchParams.has('Authorization');
+    if (url.searchParams.has('api-key') || !hasAuthorization) {
+        url.searchParams.set('api-key', '<REDACTED>');
+    }
+    if (hasAuthorization) {
+        url.searchParams.set('Authorization', '<REDACTED>');
+    }
+}
+/**
+ * Connects to the Realtime API using the runtime's native `WebSocket` implementation.
+ *
+ * Browser use is blocked by default to prevent secret API-key exposure. Use an
+ * ephemeral Realtime credential in browser clients; set
+ * `dangerouslyAllowBrowser` only after independently securing the credential.
+ * Register an SDK `error` listener and wait for `socket`'s `open` event before
+ * sending Realtime client events.
+ */
 export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
+    /**
+     * Immediately opens a native WebSocket session or attaches to an existing call.
+     *
+     * Clients with function-based credentials must use
+     * {@link OpenAIRealtimeWebSocket.create}; Azure clients should use
+     * {@link OpenAIRealtimeWebSocket.azure}. An ephemeral credential whose value
+     * starts with `ek_` is permitted in browser runtimes automatically.
+     *
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     * @param client Existing client whose endpoint and API key should be reused.
+     * @throws {OpenAIError} If browser access would expose an unapproved credential.
+     */
     constructor(props, client) {
         super();
         const hasProvider = typeof client?._options?.apiKey === 'function';
@@ -21,6 +53,7 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
         }
         this.url = buildRealtimeURL(client, props);
         props.onURL?.(this.url);
+        assertBedrockWebSocketOrigin(client, this.url);
         // @ts-ignore
         this.socket = new WebSocket(this.url.toString(), [
             'realtime',
@@ -51,17 +84,37 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
             this._onError(null, event.message, null);
         });
         if (isAzure(client)) {
-            if (this.url.searchParams.get('Authorization') !== null) {
-                this.url.searchParams.set('Authorization', '<REDACTED>');
-            }
-            else {
-                this.url.searchParams.set('api-key', '<REDACTED>');
-            }
+            redactAzureCredentials(this.url);
         }
     }
+    /**
+     * Resolves a client's current API credential before opening a native Realtime WebSocket.
+     *
+     * Use this factory instead of the constructor when the client's `apiKey` is a function.
+     *
+     * @param client OpenAI client that owns the endpoint and refreshable or static credential.
+     * @param props Exactly one model, transcription intent, or call ID, plus browser-safety settings.
+     */
     static async create(client, props) {
-        return new OpenAIRealtimeWebSocket({ ...props, __resolvedApiKey: await client._callApiKey() }, client);
+        const resolvedApiKey = await client._callApiKey();
+        const url = buildRealtimeURL(client, props);
+        assertBedrockWebSocketOrigin(client, url);
+        return new OpenAIRealtimeWebSocket({
+            ...props,
+            buildRealtimeURL: () => url,
+            __resolvedApiKey: resolvedApiKey,
+        }, client);
     }
+    /**
+     * Opens a native Azure deployment or transcription session, or an existing sideband call.
+     *
+     * Azure credentials are included only in the initial connection URL and are
+     * redacted from the exposed `url` property immediately after connection setup.
+     *
+     * @param client Azure OpenAI client that supplies the endpoint and credential.
+     * @param options Deployment, transcription intent, or call ID, plus browser-safety settings.
+     * @throws {Error} If the Azure credential or required deployment is unavailable.
+     */
     static async azure(client, options = {}) {
         const connection = getAzureRealtimeConnection(client, options);
         const isApiKeyProvider = await client._callApiKey();
@@ -82,10 +135,14 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
         return new OpenAIRealtimeWebSocket({
             ...connection,
             onURL,
-            ...(dangerouslyAllowBrowser ? { dangerouslyAllowBrowser } : {}),
+            ...(dangerouslyAllowBrowser === undefined ? {} : { dangerouslyAllowBrowser }),
             __resolvedApiKey: isApiKeyProvider,
         }, client);
     }
+    /**
+     * Serializes and sends a Realtime client event after the native WebSocket has opened.
+     * Serialization and transport failures are delivered to the SDK `error` event.
+     */
     send(event) {
         try {
             this.socket.send(JSON.stringify(event));
@@ -94,6 +151,10 @@ export class OpenAIRealtimeWebSocket extends OpenAIRealtimeEmitter {
             this._onError(null, 'could not send data', err);
         }
     }
+    /**
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the SDK `error` event.
+     */
     close(props) {
         try {
             this.socket.close(props?.code ?? 1000, props?.reason ?? 'OK');

package/realtime/websocket.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"websocket.mjs","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,MAAM,EAAE,qBAAiB;AAC/C,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAEvC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,OAAO,GAGR,4BAAwB;AACzB,OAAO,EAAE,kBAAkB,EAAE,wCAAoC;AAgBjE,MAAM,OAAO,uBAAwB,SAAQ,qBAAqB;IAIhE,YACE,KASC,EACD,MAA2C;QAE3C,KAAK,EAAE,CAAC;QACR,MAAM,WAAW,GAAG,OAAQ,MAAc,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;QAC5E,MAAM,uBAAuB,GAC3B,KAAK,CAAC,uBAAuB;YAC5B,MAAc,EAAE,QAAQ,EAAE,uBAAuB;YAClD,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,uBAAuB,IAAI,kBAAkB,EAAE,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CACnB,oSAAoS,CACrS,CAAC;QACJ,CAAC;QAED,MAAM,KAAN,MAAM,GAAK,IAAI,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAC,EAAC;QAEnD,IAAI,WAAW,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CACb;gBACE,8DAA8D;gBAC9D,yEAAyE;aAC1E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3C,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAExB,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC/C,UAAU;YACV,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,2BAA2B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACzE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,cAA4B,EAAE,EAAE;YACvE,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAwB,CAAC;gBAC3E,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,iCAAiC,EAAE,GAAG,CAAC,CAAC;oBAC5D,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,4EAA4E;oBAC5E,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,IAAI,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,KAAK,IAAI,EAAE,CAAC;gBACxD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;YAC3D,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;YACrD,CAAC;QACH,CAAC;IACH,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,MAA0D,EAC1D,KAAuE;QAEvE,OAAO,IAAI,uBAAuB,CAAC,EAAE,GAAG,KAAK,EAAE,gBAAgB,EAAE,MAAM,MAAM,CAAC,WAAW,EAAE,EAAE,EAAE,MAAM,CAAC,CAAC;IACzG,CAAC;IAED,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,MAAiG,EACjG,UAAiF,EAAE;QAEnF,MAAM,UAAU,GAAG,0BAA0B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,CAAC;QAC3B,SAAS,KAAK,CAAC,GAAQ;YACrB,IAAI,gBAAgB,EAAE,CAAC;gBACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;QAC5C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,UAAU;YACb,KAAK;YACL,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC/D,gBAAgB,EAAE,gBAAgB;SACnC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,KAA0B;QAC7B,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAwC;QAC5C,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"websocket.mjs","sourceRoot":"","sources":["../src/realtime/websocket.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,4BAA4B,EAAE,gCAA4B;AACnE,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAClC,OAAO,EAAE,WAAW,EAAE,qBAAiB;AAEvC,OAAO,EACL,qBAAqB,EACrB,gBAAgB,EAChB,0BAA0B,EAC1B,OAAO,GACR,4BAAwB;AAEzB,OAAO,EAAE,kBAAkB,EAAE,wCAAoC;AAejE,sFAAsF;AACtF,SAAS,sBAAsB,CAAC,GAAQ;IACtC,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IAC/D,IAAI,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACzD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChD,CAAC;IACD,IAAI,gBAAgB,EAAE,CAAC;QACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC;IACtD,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,OAAO,uBAAwB,SAAQ,qBAAqB;IAOhE;;;;;;;;;;;OAWG;IACH,YACE,KAWC,EACD,MAA2C;QAE3C,KAAK,EAAE,CAAC;QACR,MAAM,WAAW,GAAG,OAAQ,MAAc,EAAE,QAAQ,EAAE,MAAM,KAAK,UAAU,CAAC;QAC5E,MAAM,uBAAuB,GAC3B,KAAK,CAAC,uBAAuB;YAC5B,MAAc,EAAE,QAAQ,EAAE,uBAAuB;YAClD,CAAC,MAAM,EAAE,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,uBAAuB,IAAI,kBAAkB,EAAE,EAAE,CAAC;YACrD,MAAM,IAAI,WAAW,CACnB,oSAAoS,CACrS,CAAC;QACJ,CAAC;QAED,MAAM,KAAN,MAAM,GAAK,IAAI,MAAM,CAAC,EAAE,uBAAuB,EAAE,CAAC,EAAC;QAEnD,IAAI,WAAW,IAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CACb;gBACE,8DAA8D;gBAC9D,yEAAyE;aAC1E,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,GAAG,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC3C,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACxB,4BAA4B,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;QAE/C,aAAa;QACb,IAAI,CAAC,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE;YAC/C,UAAU;YACV,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,2BAA2B,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;SACzE,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,cAA4B,EAAE,EAAE;YACvE,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE;gBAClB,IAAI,CAAC;oBACH,OAAO,IAAI,CAAC,KAAK,CAAC,cAAc,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAwB,CAAC;gBAC3E,CAAC;gBAAC,OAAO,GAAG,EAAE,CAAC;oBACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,iCAAiC,EAAE,GAAG,CAAC,CAAC;oBAC5D,OAAO,IAAI,CAAC;gBACd,CAAC;YACH,CAAC,CAAC,EAAE,CAAC;YAEL,IAAI,KAAK,EAAE,CAAC;gBACV,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAE3B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;oBAC3B,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;qBAAM,CAAC;oBACN,4EAA4E;oBAC5E,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAAU,EAAE,EAAE;YACnD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACpB,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnC,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,KAAK,CAAC,MAAM,CACjB,MAA0D,EAC1D,KAGC;QAED,MAAM,cAAc,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QAClD,MAAM,GAAG,GAAG,gBAAgB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAC5C,4BAA4B,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,KAAK;YACR,gBAAgB,EAAE,GAAG,EAAE,CAAC,GAAG;YAC3B,gBAAgB,EAAE,cAAc;SACjC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,CAAC,KAAK,CAChB,MAAiG,EACjG,UAGI,EAAE;QAEN,MAAM,UAAU,GAAG,0BAA0B,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC/D,MAAM,gBAAgB,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC7B,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;QAC/D,CAAC;QACD,MAAM,WAAW,GAAG,MAAM,CAAC;QAC3B,SAAS,KAAK,CAAC,GAAQ;YACrB,IAAI,gBAAgB,EAAE,CAAC;gBACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,UAAU,WAAW,EAAE,CAAC,CAAC;YACjE,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;YAC/C,CAAC;QACH,CAAC;QACD,MAAM,EAAE,uBAAuB,EAAE,GAAG,OAAO,CAAC;QAC5C,OAAO,IAAI,uBAAuB,CAChC;YACE,GAAG,UAAU;YACb,KAAK;YACL,GAAG,CAAC,uBAAuB,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,uBAAuB,EAAE,CAAC;YAC7E,gBAAgB,EAAE,gBAAgB;SACnC,EACD,MAAM,CACP,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,KAA0B;QAC7B,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QAC1C,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAClD,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAML;QACC,IAAI,CAAC;YACH,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,EAAE,IAAI,IAAI,IAAI,EAAE,KAAK,EAAE,MAAM,IAAI,IAAI,CAAC,CAAC;QAChE,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,gCAAgC,EAAE,GAAG,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;CACF"}

package/realtime/ws.d.mts

@@ -1,23 +1,78 @@
 import * as WS from 'ws';
-import { AzureOpenAI, OpenAI } from "../index.mjs";
+import type { AzureOpenAI } from "../index.mjs";
+import { OpenAI } from "../index.mjs";
 import type { RealtimeClientEvent } from "../resources/realtime/realtime.mjs";
-import { OpenAIRealtimeEmitter, type AzureRealtimeConnectionConfig, type RealtimeConnectionConfig } from "./internal-base.mjs";
+import { OpenAIRealtimeEmitter } from "./internal-base.mjs";
+import type { AzureRealtimeConnectionConfig, RealtimeConnectionConfig } from "./internal-base.mjs";
+/**
+ * Connects to the Realtime API using the Node.js `ws` WebSocket implementation.
+ *
+ * Install the optional `ws` peer dependency before importing this entrypoint.
+ * Subscribe to `socket`'s `open` and `close` events for connection lifecycle,
+ * and register an SDK `error` listener for API or transport failures.
+ */
 export declare class OpenAIRealtimeWS extends OpenAIRealtimeEmitter {
+    /** Secure Realtime WebSocket URL with its model, transcription intent, or call ID. */
     url: URL;
+    /** Underlying `ws.WebSocket` instance for connection lifecycle and transport events. */
     socket: WS.WebSocket;
+    /**
+     * Immediately opens a model or transcription session, or attaches to an existing call.
+     *
+     * Pass an existing OpenAI client as the second argument to reuse its endpoint
+     * and static credentials. Clients with function-based credentials must use
+     * {@link OpenAIRealtimeWS.create}; Azure clients should use
+     * {@link OpenAIRealtimeWS.azure}.
+     *
+     * @param props Exactly one model, transcription intent, or call ID, plus `ws` client settings.
+     * @param client Existing client whose endpoint and API key should be reused.
+     */
     constructor(props: RealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
-        /** @internal */ __resolvedApiKey?: boolean;
+        /** Indicates that a function-based credential was resolved by an async factory. @internal */
+        __resolvedApiKey?: boolean;
     }, client?: Pick<OpenAI, 'apiKey' | 'baseURL'>);
+    /**
+     * Resolves a client's current API credential before opening a Realtime connection.
+     *
+     * Use this factory instead of the constructor when the client's `apiKey` is a function.
+     *
+     * @param client OpenAI client that owns the endpoint and refreshable or static credential.
+     * @param props Exactly one model, transcription intent, or call ID, plus `ws` client settings.
+     */
     static create(client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_callApiKey'>, props: RealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
     }): Promise<OpenAIRealtimeWS>;
+    /**
+     * Opens an Azure deployment or transcription session, or an existing sideband call.
+     *
+     * Static Azure API keys are sent in the `api-key` header; function-based
+     * credentials are resolved first and sent as bearer credentials. The client's
+     * configured deployment is used unless a deployment, transcription intent, or call ID is supplied.
+     *
+     * @param client Azure OpenAI client that supplies the endpoint and credential.
+     * @param props Deployment, transcription intent, or call ID, plus `ws` connection settings.
+     * @throws {Error} If the Azure credential or required deployment is unavailable.
+     */
     static azure(client: Pick<AzureOpenAI, '_callApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>, props?: AzureRealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
     }): Promise<OpenAIRealtimeWS>;
+    /**
+     * Serializes and sends a Realtime client event after the WebSocket has opened.
+     * Serialization and transport failures are delivered to the SDK `error` event.
+     */
     send(event: RealtimeClientEvent): void;
+    /**
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the SDK `error` event.
+     */
     close(props?: {
+        /** WebSocket close status code; defaults to `1000`. */
         code: number;
+        /** WebSocket close reason; defaults to `OK`. */
         reason: string;
     }): void;
 }

package/realtime/ws.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ws.d.mts","sourceRoot":"","sources":["../src/realtime/ws.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,qBAAiB;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAuB,2CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAIrB,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC9B,4BAAwB;AAEzB,qBAAa,gBAAiB,SAAQ,qBAAqB;IACzD,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC;gBAGnB,KAAK,EAAE,wBAAwB,GAAG;QAChC,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;QACvC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC7C,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;WAiDhC,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAAE,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAE,GAC3E,OAAO,CAAC,gBAAgB,CAAC;WAIf,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,KAAK,GAAE,6BAA6B,GAAG;QAAE,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAO,GACrF,OAAO,CAAC,gBAAgB,CAAC;IAuB5B,IAAI,CAAC,KAAK,EAAE,mBAAmB;IAQ/B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAO/C"}
+{"version":3,"file":"ws.d.mts","sourceRoot":"","sources":["../src/realtime/ws.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB,OAAO,KAAK,EAAE,WAAW,EAAE,qBAAiB;AAC5C,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAuB,2CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAItB,4BAAwB;AACzB,OAAO,KAAK,EAAE,6BAA6B,EAAE,wBAAwB,EAAE,4BAAwB;AAE/F;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAAqB;IACzD,sFAAsF;IACtF,GAAG,EAAE,GAAG,CAAC;IAET,wFAAwF;IACxF,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC;IAErB;;;;;;;;;;OAUG;gBAED,KAAK,EAAE,wBAAwB,GAAG;QAChC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;QAEvC,6FAA6F;QAC7F,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAuD7C;;;;;;;OAOG;WACU,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAChC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;KACxC,GACA,OAAO,CAAC,gBAAgB,CAAC;IAc5B;;;;;;;;;;OAUG;WACU,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,KAAK,GAAE,6BAA6B,GAAG;QACrC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;KACnC,GACL,OAAO,CAAC,gBAAgB,CAAC;IAuB5B;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAQtC;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE;QACZ,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;CAOT"}

package/realtime/ws.d.ts

@@ -1,23 +1,78 @@
 import * as WS from 'ws';
-import { AzureOpenAI, OpenAI } from "../index.js";
+import type { AzureOpenAI } from "../index.js";
+import { OpenAI } from "../index.js";
 import type { RealtimeClientEvent } from "../resources/realtime/realtime.js";
-import { OpenAIRealtimeEmitter, type AzureRealtimeConnectionConfig, type RealtimeConnectionConfig } from "./internal-base.js";
+import { OpenAIRealtimeEmitter } from "./internal-base.js";
+import type { AzureRealtimeConnectionConfig, RealtimeConnectionConfig } from "./internal-base.js";
+/**
+ * Connects to the Realtime API using the Node.js `ws` WebSocket implementation.
+ *
+ * Install the optional `ws` peer dependency before importing this entrypoint.
+ * Subscribe to `socket`'s `open` and `close` events for connection lifecycle,
+ * and register an SDK `error` listener for API or transport failures.
+ */
 export declare class OpenAIRealtimeWS extends OpenAIRealtimeEmitter {
+    /** Secure Realtime WebSocket URL with its model, transcription intent, or call ID. */
     url: URL;
+    /** Underlying `ws.WebSocket` instance for connection lifecycle and transport events. */
     socket: WS.WebSocket;
+    /**
+     * Immediately opens a model or transcription session, or attaches to an existing call.
+     *
+     * Pass an existing OpenAI client as the second argument to reuse its endpoint
+     * and static credentials. Clients with function-based credentials must use
+     * {@link OpenAIRealtimeWS.create}; Azure clients should use
+     * {@link OpenAIRealtimeWS.azure}.
+     *
+     * @param props Exactly one model, transcription intent, or call ID, plus `ws` client settings.
+     * @param client Existing client whose endpoint and API key should be reused.
+     */
     constructor(props: RealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
-        /** @internal */ __resolvedApiKey?: boolean;
+        /** Indicates that a function-based credential was resolved by an async factory. @internal */
+        __resolvedApiKey?: boolean;
     }, client?: Pick<OpenAI, 'apiKey' | 'baseURL'>);
+    /**
+     * Resolves a client's current API credential before opening a Realtime connection.
+     *
+     * Use this factory instead of the constructor when the client's `apiKey` is a function.
+     *
+     * @param client OpenAI client that owns the endpoint and refreshable or static credential.
+     * @param props Exactly one model, transcription intent, or call ID, plus `ws` client settings.
+     */
     static create(client: Pick<OpenAI, 'apiKey' | 'baseURL' | '_callApiKey'>, props: RealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
     }): Promise<OpenAIRealtimeWS>;
+    /**
+     * Opens an Azure deployment or transcription session, or an existing sideband call.
+     *
+     * Static Azure API keys are sent in the `api-key` header; function-based
+     * credentials are resolved first and sent as bearer credentials. The client's
+     * configured deployment is used unless a deployment, transcription intent, or call ID is supplied.
+     *
+     * @param client Azure OpenAI client that supplies the endpoint and credential.
+     * @param props Deployment, transcription intent, or call ID, plus `ws` connection settings.
+     * @throws {Error} If the Azure credential or required deployment is unavailable.
+     */
     static azure(client: Pick<AzureOpenAI, '_callApiKey' | 'apiVersion' | 'apiKey' | 'baseURL' | 'deploymentName'>, props?: AzureRealtimeConnectionConfig & {
+        /** Options passed directly to the underlying `ws.WebSocket` constructor. */
         options?: WS.ClientOptions | undefined;
     }): Promise<OpenAIRealtimeWS>;
+    /**
+     * Serializes and sends a Realtime client event after the WebSocket has opened.
+     * Serialization and transport failures are delivered to the SDK `error` event.
+     */
     send(event: RealtimeClientEvent): void;
+    /**
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the SDK `error` event.
+     */
     close(props?: {
+        /** WebSocket close status code; defaults to `1000`. */
         code: number;
+        /** WebSocket close reason; defaults to `OK`. */
         reason: string;
     }): void;
 }

package/realtime/ws.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../src/realtime/ws.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AACzB,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,oBAAiB;AAC/C,OAAO,KAAK,EAAE,mBAAmB,EAAuB,0CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAIrB,KAAK,6BAA6B,EAClC,KAAK,wBAAwB,EAC9B,2BAAwB;AAEzB,qBAAa,gBAAiB,SAAQ,qBAAqB;IACzD,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC;gBAGnB,KAAK,EAAE,wBAAwB,GAAG;QAChC,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;QACvC,gBAAgB,CAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC7C,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;WAiDhC,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAAE,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAE,GAC3E,OAAO,CAAC,gBAAgB,CAAC;WAIf,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,KAAK,GAAE,6BAA6B,GAAG;QAAE,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAA;KAAO,GACrF,OAAO,CAAC,gBAAgB,CAAC;IAuB5B,IAAI,CAAC,KAAK,EAAE,mBAAmB;IAQ/B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;CAO/C"}
+{"version":3,"file":"ws.d.ts","sourceRoot":"","sources":["../src/realtime/ws.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAGzB,OAAO,KAAK,EAAE,WAAW,EAAE,oBAAiB;AAC5C,OAAO,EAAE,MAAM,EAAE,oBAAiB;AAClC,OAAO,KAAK,EAAE,mBAAmB,EAAuB,0CAAuC;AAC/F,OAAO,EACL,qBAAqB,EAItB,2BAAwB;AACzB,OAAO,KAAK,EAAE,6BAA6B,EAAE,wBAAwB,EAAE,2BAAwB;AAE/F;;;;;;GAMG;AACH,qBAAa,gBAAiB,SAAQ,qBAAqB;IACzD,sFAAsF;IACtF,GAAG,EAAE,GAAG,CAAC;IAET,wFAAwF;IACxF,MAAM,EAAE,EAAE,CAAC,SAAS,CAAC;IAErB;;;;;;;;;;OAUG;gBAED,KAAK,EAAE,wBAAwB,GAAG;QAChC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;QAEvC,6FAA6F;QAC7F,gBAAgB,CAAC,EAAE,OAAO,CAAC;KAC5B,EACD,MAAM,CAAC,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC;IAuD7C;;;;;;;OAOG;WACU,MAAM,CACjB,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,aAAa,CAAC,EAC1D,KAAK,EAAE,wBAAwB,GAAG;QAChC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;KACxC,GACA,OAAO,CAAC,gBAAgB,CAAC;IAc5B;;;;;;;;;;OAUG;WACU,KAAK,CAChB,MAAM,EAAE,IAAI,CAAC,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,QAAQ,GAAG,SAAS,GAAG,gBAAgB,CAAC,EACjG,KAAK,GAAE,6BAA6B,GAAG;QACrC,4EAA4E;QAC5E,OAAO,CAAC,EAAE,EAAE,CAAC,aAAa,GAAG,SAAS,CAAC;KACnC,GACL,OAAO,CAAC,gBAAgB,CAAC;IAuB5B;;;OAGG;IACH,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAQtC;;;OAGG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE;QACZ,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;CAOT"}