openai 7.4.0 → 7.6.0

package/bedrock.mjs

@@ -1,5 +1,8 @@
+var _a;
 import * as Errors from "./error.mjs";
 import { OpenAI } from "./client.mjs";
+import { assertNoDataResidency } from "./internal/data-residency.mjs";
+import { assertBedrockRequestOrigin, assertValidBedrockBearerCredential, brand_privateBedrockClient, } from "./internal/bedrock.mjs";
 import { buildHeaders } from "./internal/headers.mjs";
 import { readEnv } from "./internal/utils.mjs";
 import { addOutputText } from "./lib/ResponsesParser.mjs";
@@ -10,6 +13,9 @@ function deriveBedrockBaseURL(awsRegion) {
     if (!region) {
         throw new Errors.OpenAIError('Must provide one of the `baseURL` or `awsRegion` arguments, or set the `AWS_BEDROCK_BASE_URL`, `AWS_REGION`, or `AWS_DEFAULT_REGION` environment variable.');
     }
+    if (!/^[a-z]{2,8}(?:-[a-z0-9]+)+-\d+$/u.test(region)) {
+        throw new Errors.OpenAIError('The Bedrock AWS `region` is invalid. Use a standard AWS region such as `us-east-1`.');
+    }
     return `https://bedrock-mantle.${region}.api.aws/openai/v1`;
 }
 /** Normalize a Bedrock Responses URL variant back to the provider API root. */
@@ -44,13 +50,14 @@ export class BedrockOpenAI extends OpenAI {
     /**
      * API Client for interfacing with Amazon Bedrock's OpenAI-compatible endpoint.
      *
-     * @param {string | null | undefined} [opts.apiKey=process.env['AWS_BEARER_TOKEN_BEDROCK'] ?? null]
-     * @param {string | null | undefined} [opts.baseURL=process.env['AWS_BEDROCK_BASE_URL'] ?? derived from opts.awsRegion or AWS_REGION/AWS_DEFAULT_REGION]
-     * @param {string | undefined} [opts.awsRegion=process.env['AWS_REGION'] ?? process.env['AWS_DEFAULT_REGION'] ?? undefined]
+     * @param {string | null | undefined} [opts.apiKey] - Defaults to `process.env['AWS_BEARER_TOKEN_BEDROCK'] ?? null`.
+     * @param {string | null | undefined} [opts.baseURL] - Defaults to `process.env['AWS_BEDROCK_BASE_URL']`, or is derived from `opts.awsRegion`, `AWS_REGION`, or `AWS_DEFAULT_REGION`.
+     * @param {string | undefined} [opts.awsRegion] - Defaults to `process.env['AWS_REGION'] ?? process.env['AWS_DEFAULT_REGION'] ?? undefined`.
      * @param {ApiKeySetter | undefined} opts.bedrockTokenProvider - A function that returns a Bedrock bearer token and is invoked before each request.
      */
-    constructor({ baseURL = readEnv('AWS_BEDROCK_BASE_URL'), apiKey, awsRegion = readEnv('AWS_REGION') ?? readEnv('AWS_DEFAULT_REGION'), bedrockTokenProvider, adminAPIKey, workloadIdentity, ...opts } = {}) {
-        if (adminAPIKey || workloadIdentity) {
+    constructor({ baseURL = readEnv('AWS_BEDROCK_BASE_URL'), apiKey, awsRegion = readEnv('AWS_REGION') ?? readEnv('AWS_DEFAULT_REGION'), bedrockTokenProvider, adminAPIKey, workloadIdentity, x509Transport, dataResidency, ...opts } = {}) {
+        assertNoDataResidency(dataResidency, 'BedrockOpenAI');
+        if (adminAPIKey || workloadIdentity || x509Transport) {
             throw new Errors.OpenAIError('BedrockOpenAI only supports Bedrock bearer token authentication.');
         }
         if (apiKey === undefined && !bedrockTokenProvider) {
@@ -72,29 +79,83 @@ export class BedrockOpenAI extends OpenAI {
             baseURL: normalizeBedrockBaseURL(configuredBaseURL),
             ...opts,
         });
+        /**
+         * Identifies this client to credential-bearing WebSocket helpers.
+         *
+         * @internal
+         */
+        this[_a] = true;
+        let currentApiKey = this.apiKey;
+        Object.defineProperty(this, 'apiKey', {
+            enumerable: true,
+            configurable: true,
+            get() {
+                if (currentApiKey !== null) {
+                    assertValidBedrockBearerCredential(currentApiKey);
+                }
+                return currentApiKey;
+            },
+            set(nextApiKey) {
+                currentApiKey = nextApiKey;
+            },
+        });
+        const trustedBaseURL = this.baseURL;
+        let currentBaseURL = trustedBaseURL;
+        Object.defineProperty(this, 'baseURL', {
+            enumerable: true,
+            configurable: false,
+            get() {
+                return currentBaseURL;
+            },
+            set(nextBaseURL) {
+                assertBedrockRequestOrigin(trustedBaseURL, nextBaseURL);
+                currentBaseURL = nextBaseURL;
+            },
+        });
         this.bedrockTokenProvider = bedrockTokenProvider;
         this.responses = restoreBedrockStreamOutputText(new API.Responses(this));
     }
     async prepareOptions(options) {
+        const configuredBaseURL = this._options.baseURL ?? this.baseURL;
+        assertBedrockRequestOrigin(configuredBaseURL, this.buildURL(options.path, null, options.defaultBaseURL));
         const security = options.__security ?? { bearerAuth: true };
         if (security.adminAPIKeyAuth && !security.bearerAuth) {
             await this._callApiKey();
         }
         await super.prepareOptions(options);
+        assertBedrockRequestOrigin(configuredBaseURL, this.buildURL(options.path, null, options.defaultBaseURL));
+    }
+    async prepareRequest(request, context) {
+        assertBedrockRequestOrigin(this._options.baseURL ?? this.baseURL, context.url);
+        await super.prepareRequest(request, context);
+        request.redirect = 'manual';
     }
     async authHeaders(opts, schemes) {
         const security = schemes ?? { bearerAuth: true, adminAPIKeyAuth: true };
-        if ((security.bearerAuth || security.adminAPIKeyAuth) && this.apiKey !== null) {
-            return buildHeaders([{ Authorization: `Bearer ${this.apiKey}` }]);
+        const credential = this.apiKey;
+        if ((security.bearerAuth || security.adminAPIKeyAuth) && credential !== null) {
+            assertValidBedrockBearerCredential(credential);
+            try {
+                return buildHeaders([{ Authorization: `Bearer ${credential}` }]);
+            }
+            catch (error) {
+                if (error instanceof TypeError) {
+                    // oxlint-disable-next-line eslint/preserve-caught-error -- The original error contains the bearer credential.
+                    throw new TypeError('Bedrock bearer credential contains an invalid HTTP header value.');
+                }
+                throw error;
+            }
         }
         return super.authHeaders(opts, security);
     }
+    /** Clones this client while preserving its refreshable Bedrock token provider when appropriate. */
     withOptions(options) {
-        const bedrockTokenProvider = options.apiKey !== undefined ? undefined : options.bedrockTokenProvider ?? this.bedrockTokenProvider;
+        const bedrockTokenProvider = options.apiKey === undefined ? (options.bedrockTokenProvider ?? this.bedrockTokenProvider) : undefined;
         return super.withOptions({
             ...options,
             ...(bedrockTokenProvider ? { apiKey: undefined, bedrockTokenProvider } : {}),
         });
     }
 }
+_a = brand_privateBedrockClient;
 //# sourceMappingURL=bedrock.mjs.map

package/bedrock.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"bedrock.mjs","sourceRoot":"","sources":["src/bedrock.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,oBAAgB;AAClC,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAGlC,OAAO,EAAE,YAAY,EAAE,+BAA2B;AAElD,OAAO,EAAE,OAAO,EAAE,6BAAyB;AAC3C,OAAO,EAAE,aAAa,EAAE,kCAA8B;AAEtD,OAAO,KAAK,GAAG,8BAA0B;AA4CzC,kFAAkF;AAClF,SAAS,oBAAoB,CAAC,SAA6B;IACzD,MAAM,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC;IACjC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,4JAA4J,CAC7J,CAAC;IACJ,CAAC;IAED,OAAO,0BAA0B,MAAM,oBAAoB,CAAC;AAC9D,CAAC;AAED,+EAA+E;AAC/E,SAAS,uBAAuB,CAAC,OAAe;IAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACnE,IAAI,cAAc,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC;IACpE,CAAC;IAED,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,iGAAiG;AACjG,SAAS,oBAAoB,CAA0C,QAAmB;IACxF,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,CAAC;QAC9D,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,4FAA4F;AAC5F,SAAS,8BAA8B,CAAC,SAAwB;IAC9D,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAEhD,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,IAA0B,EAAE,OAAwB,EAAE,EAAE;QAC3E,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACxE,cAAc,CAAC,aAAa,GAAG,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,MAAM,aAAa,EAAE,CAAC,CAAC;QAEvF,OAAO,cAAc,CAAC;IACxB,CAAC,CAA4B,CAAC;IAE9B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mFAAmF;AACnF,MAAM,OAAO,aAAc,SAAQ,MAAM;IAGvC;;;;;;;OAOG;IACH,YAAY,EACV,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,EACzC,MAAM,EACN,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,oBAAoB,CAAC,EAClE,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,GAAG,IAAI,KACiB,EAAE;QAC1B,IAAI,WAAW,IAAI,gBAAgB,EAAE,CAAC;YACpC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,kEAAkE,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAClD,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,IAAI,IAAI,CAAC;QACvD,CAAC;QAED,IAAI,OAAQ,MAAkB,KAAK,UAAU,EAAE,CAAC;YAC9C,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,gFAAgF,CACjF,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,IAAI,oBAAoB,EAAE,CAAC;YACnC,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,6GAA6G,CAC9G,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACrC,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,qIAAqI,CACtI,CAAC;QACJ,CAAC;QAED,MAAM,iBAAiB,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEtF,KAAK,CAAC;YACJ,MAAM,EAAE,oBAAoB,IAAI,MAAM;YACtC,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC;YACnD,GAAG,IAAI;SACR,CAAC,CAAC;QAEH,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,8BAA8B,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEkB,KAAK,CAAC,cAAc,CAAC,OAA4B;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QAC5D,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACrD,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3B,CAAC;QAED,MAAM,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAEkB,KAAK,CAAC,WAAW,CAClC,IAAyB,EACzB,OAA6D;QAE7D,MAAM,QAAQ,GAAG,OAAO,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;QACxE,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;YAC9E,OAAO,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;QACpE,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAEQ,WAAW,CAAC,OAAsC;QACzD,MAAM,oBAAoB,GACxB,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAAC;QAEvG,OAAO,KAAK,CAAC,WAAW,CAAC;YACvB,GAAG,OAAO;YACV,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnD,CAAC,CAAC;IAC/B,CAAC;CACF"}
+{"version":3,"file":"bedrock.mjs","sourceRoot":"","sources":["src/bedrock.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,MAAM,oBAAgB;AAClC,OAAO,EAAE,MAAM,EAAE,qBAAiB;AAElC,OAAO,EAAE,qBAAqB,EAAE,sCAAkC;AAClE,OAAO,EACL,0BAA0B,EAC1B,kCAAkC,EAClC,0BAA0B,GAC3B,+BAA2B;AAG5B,OAAO,EAAE,YAAY,EAAE,+BAA2B;AAElD,OAAO,EAAE,OAAO,EAAE,6BAAyB;AAC3C,OAAO,EAAE,aAAa,EAAE,kCAA8B;AAEtD,OAAO,KAAK,GAAG,8BAA0B;AAqDzC,kFAAkF;AAClF,SAAS,oBAAoB,CAAC,SAA6B;IACzD,MAAM,MAAM,GAAG,SAAS,EAAE,IAAI,EAAE,CAAC;IACjC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,4JAA4J,CAC7J,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,kCAAkC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,qFAAqF,CACtF,CAAC;IACJ,CAAC;IAED,OAAO,0BAA0B,MAAM,oBAAoB,CAAC;AAC9D,CAAC;AAED,+EAA+E;AAC/E,SAAS,uBAAuB,CAAC,OAAe;IAC9C,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7B,MAAM,cAAc,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,uBAAuB,CAAC,CAAC;IACnE,IAAI,cAAc,EAAE,KAAK,KAAK,SAAS,EAAE,CAAC;QACxC,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,cAAc,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC;IACpE,CAAC;IAED,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;AAC3C,CAAC;AAED,iGAAiG;AACjG,SAAS,oBAAoB,CAA0C,QAAmB;IACxF,IAAI,CAAC,MAAM,CAAC,wBAAwB,CAAC,QAAQ,EAAE,aAAa,CAAC,EAAE,CAAC;QAC9D,aAAa,CAAC,QAAQ,CAAC,CAAC;IAC1B,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,4FAA4F;AAC5F,SAAS,8BAA8B,CAAC,SAAwB;IAC9D,MAAM,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAEhD,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,IAA0B,EAAE,OAAwB,EAAE,EAAE;QAC3E,MAAM,cAAc,GAAG,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC7C,MAAM,aAAa,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACxE,cAAc,CAAC,aAAa,GAAG,KAAK,IAAI,EAAE,CAAC,oBAAoB,CAAC,MAAM,aAAa,EAAE,CAAC,CAAC;QAEvF,OAAO,cAAc,CAAC;IACxB,CAAC,CAA4B,CAAC;IAE9B,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,mFAAmF;AACnF,MAAM,OAAO,aAAc,SAAQ,MAAM;IAUvC;;;;;;;OAOG;IACH,YAAY,EACV,OAAO,GAAG,OAAO,CAAC,sBAAsB,CAAC,EACzC,MAAM,EACN,SAAS,GAAG,OAAO,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,oBAAoB,CAAC,EAClE,oBAAoB,EACpB,WAAW,EACX,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,GAAG,IAAI,KACiB,EAAE;QAC1B,qBAAqB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;QACtD,IAAI,WAAW,IAAI,gBAAgB,IAAI,aAAa,EAAE,CAAC;YACrD,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,kEAAkE,CAAC,CAAC;QACnG,CAAC;QAED,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAClD,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC,IAAI,IAAI,CAAC;QACvD,CAAC;QAED,IAAI,OAAQ,MAAkB,KAAK,UAAU,EAAE,CAAC;YAC9C,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,gFAAgF,CACjF,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,IAAI,oBAAoB,EAAE,CAAC;YACnC,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,6GAA6G,CAC9G,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACrC,MAAM,IAAI,MAAM,CAAC,WAAW,CAC1B,qIAAqI,CACtI,CAAC;QACJ,CAAC;QAED,MAAM,iBAAiB,GAAG,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAEtF,KAAK,CAAC;YACJ,MAAM,EAAE,oBAAoB,IAAI,MAAM;YACtC,WAAW,EAAE,IAAI;YACjB,OAAO,EAAE,uBAAuB,CAAC,iBAAiB,CAAC;YACnD,GAAG,IAAI;SACR,CAAC,CAAC;QA9DL;;;;WAIG;QACM,QAA4B,GAAG,IAAI,CAAC;QA2D3C,IAAI,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC;QAChC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,QAAQ,EAAE;YACpC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,IAAI;YAClB,GAAG;gBACD,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBAC3B,kCAAkC,CAAC,aAAa,CAAC,CAAC;gBACpD,CAAC;gBACD,OAAO,aAAa,CAAC;YACvB,CAAC;YACD,GAAG,CAAC,UAAyB;gBAC3B,aAAa,GAAG,UAAU,CAAC;YAC7B,CAAC;SACF,CAAC,CAAC;QAEH,MAAM,cAAc,GAAG,IAAI,CAAC,OAAO,CAAC;QACpC,IAAI,cAAc,GAAG,cAAc,CAAC;QACpC,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,SAAS,EAAE;YACrC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,GAAG;gBACD,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,GAAG,CAAC,WAAmB;gBACrB,0BAA0B,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;gBACxD,cAAc,GAAG,WAAW,CAAC;YAC/B,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACjD,IAAI,CAAC,SAAS,GAAG,8BAA8B,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3E,CAAC;IAEkB,KAAK,CAAC,cAAc,CAAC,OAA4B;QAClE,MAAM,iBAAiB,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC;QAChE,0BAA0B,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;QAEzG,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC;QAC5D,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;YACrD,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAC3B,CAAC;QAED,MAAM,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QACpC,0BAA0B,CAAC,iBAAiB,EAAE,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;IAC3G,CAAC;IAEkB,KAAK,CAAC,cAAc,CACrC,OAAoB,EACpB,OAAsD;QAEtD,0BAA0B,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,IAAI,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;QAC/E,MAAM,KAAK,CAAC,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;QAC7C,OAAO,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC9B,CAAC;IAEkB,KAAK,CAAC,WAAW,CAClC,IAAyB,EACzB,OAA6D;QAE7D,MAAM,QAAQ,GAAG,OAAO,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,CAAC;QACxE,MAAM,UAAU,GAAG,IAAI,CAAC,MAAM,CAAC;QAC/B,IAAI,CAAC,QAAQ,CAAC,UAAU,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YAC7E,kCAAkC,CAAC,UAAU,CAAC,CAAC;YAC/C,IAAI,CAAC;gBACH,OAAO,YAAY,CAAC,CAAC,EAAE,aAAa,EAAE,UAAU,UAAU,EAAE,EAAE,CAAC,CAAC,CAAC;YACnE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,KAAK,YAAY,SAAS,EAAE,CAAC;oBAC/B,8GAA8G;oBAC9G,MAAM,IAAI,SAAS,CAAC,kEAAkE,CAAC,CAAC;gBAC1F,CAAC;gBACD,MAAM,KAAK,CAAC;YACd,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAC,WAAW,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAED,mGAAmG;IAC1F,WAAW,CAAC,OAAsC;QACzD,MAAM,oBAAoB,GACxB,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,IAAI,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAEzG,OAAO,KAAK,CAAC,WAAW,CAAC;YACvB,GAAG,OAAO;YACV,GAAG,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,oBAAoB,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;SACnD,CAAC,CAAC;IAC/B,CAAC;CACF;KAlJW,0BAA0B"}

package/beta/realtime/internal-base.d.mts

@@ -1,8 +1,14 @@
-import { RealtimeClientEvent, RealtimeServerEvent, ErrorEvent } from "../../resources/beta/realtime/realtime.mjs";
+import type { RealtimeClientEvent, RealtimeServerEvent, ErrorEvent } from "../../resources/beta/realtime/realtime.mjs";
 import { EventEmitter } from "../../lib/EventEmitter.mjs";
 import { OpenAIError } from "../../error.mjs";
-import OpenAI, { AzureOpenAI } from "../../index.mjs";
+import type OpenAI from "../../index.mjs";
+import { AzureOpenAI } from "../../index.mjs";
+/** Parses frame data without exposing malformed payloads through JSON syntax errors. */
+export declare function parseRealtimeEvent(data: string): RealtimeServerEvent;
+/** An API-reported or client-side error encountered by a beta Realtime connection. */
 export declare class OpenAIRealtimeError extends OpenAIError {
+    /** Stable error name used to identify Realtime connection failures. */
+    name: string;
     /**
      * The error data that the API sent back in an `error` event.
      */
@@ -11,48 +17,85 @@ export declare class OpenAIRealtimeError extends OpenAIError {
      * The unique ID of the server event.
      */
     event_id?: string | undefined;
+    /**
+     * Creates a beta Realtime error, preserving server-provided details when available.
+     *
+     * @param message Human-readable API or connection error description.
+     * @param event Server error event, or `null` for a client-side failure.
+     */
     constructor(message: string, event: ErrorEvent | null);
 }
+/** Materializes mapped beta Realtime listener properties without changing their public types. */
 type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
 } & {};
+/**
+ * Maps beta Realtime server event types to their corresponding strongly typed listener callbacks.
+ *
+ * The `event` listener observes every server event, `error` receives normalized
+ * API or transport failures, and other keys match non-error server event types.
+ */
 type RealtimeEvents = Simplify<{
+    /** Receives every server event before its event-specific listener is notified. */
     event: (event: RealtimeServerEvent) => void;
+    /** Receives API-reported errors and client-side WebSocket failures. */
     error: (error: OpenAIRealtimeError) => void;
 } & {
     [EventType in Exclude<RealtimeServerEvent['type'], 'error'>]: (event: Extract<RealtimeServerEvent, {
+        /** Server-event discriminator associated with this specific listener. */
         type: EventType;
     }>) => unknown;
 }>;
+/**
+ * Typed event emitter shared by the beta Realtime WebSocket implementations.
+ *
+ * Listen for `event` to receive all server events, or subscribe to a specific
+ * server event's `type`. Always register an `error` listener; otherwise API and
+ * transport failures are reported as unhandled promise rejections.
+ */
 export declare abstract class OpenAIRealtimeEmitter extends EventEmitter<RealtimeEvents> {
     /**
-     * Send an event to the API.
+     * Serializes and sends a client event after the underlying WebSocket is open.
+     * Serialization and transport failures are delivered to the `error` event.
      */
     abstract send(event: RealtimeClientEvent): void;
     /**
-     * Close the websocket connection.
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the `error` event.
      */
     abstract close(props?: {
+        /** WebSocket close status code; defaults to `1000`. */
         code: number;
+        /** WebSocket close reason; defaults to `OK`. */
         reason: string;
     }): void;
     protected _onError(event: null, message: string, cause: any): void;
     protected _onError(event: ErrorEvent, message?: string | undefined): void;
 }
+/** Reports whether the client is an Azure OpenAI client with Azure-specific Realtime routing. */
 export declare function isAzure(client: Pick<OpenAI, 'apiKey' | 'baseURL'>): client is AzureOpenAI;
+/** Starts a beta Realtime model session or attaches to one existing non-Azure call. */
 export type RealtimeConnectionConfig = {
     /**
      * Start a new Realtime session using the given model.
      */
     model: string;
+    /** Existing call identifier; cannot be supplied when starting a model-backed session. */
     callID?: undefined;
 } | {
+    /** Model name; cannot be supplied when attaching to an existing call. */
     model?: undefined;
     /**
      * Attach to an in-progress Realtime call over a sideband control connection.
      */
     callID: string;
 };
+/**
+ * Builds the secure WebSocket URL for a beta Realtime session or non-Azure sideband call.
+ *
+ * @throws {Error} If both `model` and `callID`, or neither, are supplied, or an
+ * Azure sideband call is requested through the beta helpers.
+ */
 export declare function buildRealtimeURL(client: Pick<OpenAI, 'apiKey' | 'baseURL'>, connection: string | RealtimeConnectionConfig): URL;
 export {};
 //# sourceMappingURL=internal-base.d.mts.map

package/beta/realtime/internal-base.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"internal-base.d.mts","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,UAAU,EAAE,mDAA+C;AAC9G,OAAO,EAAE,YAAY,EAAE,mCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAC1C,OAAO,MAAM,EAAE,EAAE,WAAW,EAAE,wBAAoB;AAElD,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAElB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;CAMtD;AAED,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;CAAE,GAAG,EAAE,CAAC;AAE7D,KAAK,cAAc,GAAG,QAAQ,CAC5B;IACE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC5C,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAC7C,GAAG;KACD,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,CAC5D,KAAK,EAAE,OAAO,CAAC,mBAAmB,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,CAAC,KACrD,OAAO;CACb,CACF,CAAC;AAEF,8BAAsB,qBAAsB,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC9E;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAE/C;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAE9D,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAClE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAyB1E;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,MAAM,IAAI,WAAW,CAEzF;AAED,MAAM,MAAM,wBAAwB,GAChC;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,GACD;IACE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,EAC1C,UAAU,EAAE,MAAM,GAAG,wBAAwB,GAC5C,GAAG,CA+BL"}
+{"version":3,"file":"internal-base.d.mts","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACX,mDAA+C;AAChD,OAAO,EAAE,YAAY,EAAE,mCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAC1C,OAAO,KAAK,MAAM,wBAAoB;AACtC,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAG1C,wFAAwF;AACxF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAUpE;AAUD,sFAAsF;AACtF,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,uEAAuE;IAC9D,IAAI,SAAyB;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;CAMtD;AAED,iGAAiG;AAEjG,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;CAAE,GAAG,EAAE,CAAC;AAE7D;;;;;GAKG;AACH,KAAK,cAAc,GAAG,QAAQ,CAC5B;IACE,kFAAkF;IAClF,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAE5C,uEAAuE;IACvE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAC7C,GAAG;KAED,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,CAC5D,KAAK,EAAE,OAAO,CACZ,mBAAmB,EACnB;QACE,yEAAyE;QACzE,IAAI,EAAE,SAAS,CAAC;KACjB,CACF,KACE,OAAO;CACb,CACF,CAAC;AAEF;;;;;;GAMG;AACH,8BAAsB,qBAAsB,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC9E;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAE/C;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACrB,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;IAER,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAClE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAwB1E;AAED,iGAAiG;AACjG,wBAAgB,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,MAAM,IAAI,WAAW,CAEzF;AAED,uFAAuF;AACvF,MAAM,MAAM,wBAAwB,GAChC;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,yFAAyF;IACzF,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,GACD;IACE,yEAAyE;IACzE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,EAC1C,UAAU,EAAE,MAAM,GAAG,wBAAwB,GAC5C,GAAG,CA8BL"}

package/beta/realtime/internal-base.d.ts

@@ -1,8 +1,14 @@
-import { RealtimeClientEvent, RealtimeServerEvent, ErrorEvent } from "../../resources/beta/realtime/realtime.js";
+import type { RealtimeClientEvent, RealtimeServerEvent, ErrorEvent } from "../../resources/beta/realtime/realtime.js";
 import { EventEmitter } from "../../lib/EventEmitter.js";
 import { OpenAIError } from "../../error.js";
-import OpenAI, { AzureOpenAI } from "../../index.js";
+import type OpenAI from "../../index.js";
+import { AzureOpenAI } from "../../index.js";
+/** Parses frame data without exposing malformed payloads through JSON syntax errors. */
+export declare function parseRealtimeEvent(data: string): RealtimeServerEvent;
+/** An API-reported or client-side error encountered by a beta Realtime connection. */
 export declare class OpenAIRealtimeError extends OpenAIError {
+    /** Stable error name used to identify Realtime connection failures. */
+    name: string;
     /**
      * The error data that the API sent back in an `error` event.
      */
@@ -11,48 +17,85 @@ export declare class OpenAIRealtimeError extends OpenAIError {
      * The unique ID of the server event.
      */
     event_id?: string | undefined;
+    /**
+     * Creates a beta Realtime error, preserving server-provided details when available.
+     *
+     * @param message Human-readable API or connection error description.
+     * @param event Server error event, or `null` for a client-side failure.
+     */
     constructor(message: string, event: ErrorEvent | null);
 }
+/** Materializes mapped beta Realtime listener properties without changing their public types. */
 type Simplify<T> = {
     [KeyType in keyof T]: T[KeyType];
 } & {};
+/**
+ * Maps beta Realtime server event types to their corresponding strongly typed listener callbacks.
+ *
+ * The `event` listener observes every server event, `error` receives normalized
+ * API or transport failures, and other keys match non-error server event types.
+ */
 type RealtimeEvents = Simplify<{
+    /** Receives every server event before its event-specific listener is notified. */
     event: (event: RealtimeServerEvent) => void;
+    /** Receives API-reported errors and client-side WebSocket failures. */
     error: (error: OpenAIRealtimeError) => void;
 } & {
     [EventType in Exclude<RealtimeServerEvent['type'], 'error'>]: (event: Extract<RealtimeServerEvent, {
+        /** Server-event discriminator associated with this specific listener. */
         type: EventType;
     }>) => unknown;
 }>;
+/**
+ * Typed event emitter shared by the beta Realtime WebSocket implementations.
+ *
+ * Listen for `event` to receive all server events, or subscribe to a specific
+ * server event's `type`. Always register an `error` listener; otherwise API and
+ * transport failures are reported as unhandled promise rejections.
+ */
 export declare abstract class OpenAIRealtimeEmitter extends EventEmitter<RealtimeEvents> {
     /**
-     * Send an event to the API.
+     * Serializes and sends a client event after the underlying WebSocket is open.
+     * Serialization and transport failures are delivered to the `error` event.
      */
     abstract send(event: RealtimeClientEvent): void;
     /**
-     * Close the websocket connection.
+     * Closes the WebSocket with status code `1000` and reason `OK` by default.
+     * Connection-closing failures are delivered to the `error` event.
      */
     abstract close(props?: {
+        /** WebSocket close status code; defaults to `1000`. */
         code: number;
+        /** WebSocket close reason; defaults to `OK`. */
         reason: string;
     }): void;
     protected _onError(event: null, message: string, cause: any): void;
     protected _onError(event: ErrorEvent, message?: string | undefined): void;
 }
+/** Reports whether the client is an Azure OpenAI client with Azure-specific Realtime routing. */
 export declare function isAzure(client: Pick<OpenAI, 'apiKey' | 'baseURL'>): client is AzureOpenAI;
+/** Starts a beta Realtime model session or attaches to one existing non-Azure call. */
 export type RealtimeConnectionConfig = {
     /**
      * Start a new Realtime session using the given model.
      */
     model: string;
+    /** Existing call identifier; cannot be supplied when starting a model-backed session. */
     callID?: undefined;
 } | {
+    /** Model name; cannot be supplied when attaching to an existing call. */
     model?: undefined;
     /**
      * Attach to an in-progress Realtime call over a sideband control connection.
      */
     callID: string;
 };
+/**
+ * Builds the secure WebSocket URL for a beta Realtime session or non-Azure sideband call.
+ *
+ * @throws {Error} If both `model` and `callID`, or neither, are supplied, or an
+ * Azure sideband call is requested through the beta helpers.
+ */
 export declare function buildRealtimeURL(client: Pick<OpenAI, 'apiKey' | 'baseURL'>, connection: string | RealtimeConnectionConfig): URL;
 export {};
 //# sourceMappingURL=internal-base.d.ts.map

package/beta/realtime/internal-base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal-base.d.ts","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,UAAU,EAAE,kDAA+C;AAC9G,OAAO,EAAE,YAAY,EAAE,kCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,uBAAoB;AAC1C,OAAO,MAAM,EAAE,EAAE,WAAW,EAAE,uBAAoB;AAElD,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;gBAElB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;CAMtD;AAED,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;CAAE,GAAG,EAAE,CAAC;AAE7D,KAAK,cAAc,GAAG,QAAQ,CAC5B;IACE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC5C,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAC7C,GAAG;KACD,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,CAC5D,KAAK,EAAE,OAAO,CAAC,mBAAmB,EAAE;QAAE,IAAI,EAAE,SAAS,CAAA;KAAE,CAAC,KACrD,OAAO;CACb,CACF,CAAC;AAEF,8BAAsB,qBAAsB,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC9E;;OAEG;IACH,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAE/C;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAE9D,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAClE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAyB1E;AAED,wBAAgB,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,MAAM,IAAI,WAAW,CAEzF;AAED,MAAM,MAAM,wBAAwB,GAChC;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,GACD;IACE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,EAC1C,UAAU,EAAE,MAAM,GAAG,wBAAwB,GAC5C,GAAG,CA+BL"}
+{"version":3,"file":"internal-base.d.ts","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACX,kDAA+C;AAChD,OAAO,EAAE,YAAY,EAAE,kCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,uBAAoB;AAC1C,OAAO,KAAK,MAAM,uBAAoB;AACtC,OAAO,EAAE,WAAW,EAAE,uBAAoB;AAG1C,wFAAwF;AACxF,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,mBAAmB,CAUpE;AAUD,sFAAsF;AACtF,qBAAa,mBAAoB,SAAQ,WAAW;IAClD,uEAAuE;IAC9D,IAAI,SAAyB;IAEtC;;OAEG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC,KAAK,GAAG,SAAS,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9B;;;;;OAKG;gBACS,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,UAAU,GAAG,IAAI;CAMtD;AAED,iGAAiG;AAEjG,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;CAAE,GAAG,EAAE,CAAC;AAE7D;;;;;GAKG;AACH,KAAK,cAAc,GAAG,QAAQ,CAC5B;IACE,kFAAkF;IAClF,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAE5C,uEAAuE;IACvE,KAAK,EAAE,CAAC,KAAK,EAAE,mBAAmB,KAAK,IAAI,CAAC;CAC7C,GAAG;KAED,SAAS,IAAI,OAAO,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,GAAG,CAC5D,KAAK,EAAE,OAAO,CACZ,mBAAmB,EACnB;QACE,yEAAyE;QACzE,IAAI,EAAE,SAAS,CAAC;KACjB,CACF,KACE,OAAO;CACb,CACF,CAAC;AAEF;;;;;;GAMG;AACH,8BAAsB,qBAAsB,SAAQ,YAAY,CAAC,cAAc,CAAC;IAC9E;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,mBAAmB,GAAG,IAAI;IAE/C;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;QACrB,uDAAuD;QACvD,IAAI,EAAE,MAAM,CAAC;QAEb,gDAAgD;QAChD,MAAM,EAAE,MAAM,CAAC;KAChB,GAAG,IAAI;IAER,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IAClE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;CAwB1E;AAED,iGAAiG;AACjG,wBAAgB,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,MAAM,IAAI,WAAW,CAEzF;AAED,uFAAuF;AACvF,MAAM,MAAM,wBAAwB,GAChC;IACE;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd,yFAAyF;IACzF,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB,GACD;IACE,yEAAyE;IACzE,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEN;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,QAAQ,GAAG,SAAS,CAAC,EAC1C,UAAU,EAAE,MAAM,GAAG,wBAAwB,GAC5C,GAAG,CA8BL"}

package/beta/realtime/internal-base.js

@@ -1,25 +1,62 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAIRealtimeEmitter = exports.OpenAIRealtimeError = void 0;
+exports.parseRealtimeEvent = parseRealtimeEvent;
 exports.isAzure = isAzure;
 exports.buildRealtimeURL = buildRealtimeURL;
 const EventEmitter_1 = require("../../lib/EventEmitter.js");
 const error_1 = require("../../error.js");
 const index_1 = require("../../index.js");
+const x509_workload_identity_auth_1 = require("../../internal/auth/x509-workload-identity-auth.js");
+/** Parses frame data without exposing malformed payloads through JSON syntax errors. */
+function parseRealtimeEvent(data) {
+    try {
+        return JSON.parse(data);
+    }
+    catch (error) {
+        if (error instanceof SyntaxError) {
+            throw new SyntaxError('Could not parse Realtime WebSocket event data as JSON.');
+        }
+        throw error;
+    }
+}
+function safeErrorValue(value) {
+    try {
+        return String(value);
+    }
+    catch {
+        return '[unserializable error value]';
+    }
+}
+/** An API-reported or client-side error encountered by a beta Realtime connection. */
 class OpenAIRealtimeError extends error_1.OpenAIError {
+    /**
+     * Creates a beta Realtime error, preserving server-provided details when available.
+     *
+     * @param message Human-readable API or connection error description.
+     * @param event Server error event, or `null` for a client-side failure.
+     */
     constructor(message, event) {
         super(message);
+        /** Stable error name used to identify Realtime connection failures. */
+        this.name = 'OpenAIRealtimeError';
         this.error = event?.error;
         this.event_id = event?.event_id;
     }
 }
 exports.OpenAIRealtimeError = OpenAIRealtimeError;
+/**
+ * Typed event emitter shared by the beta Realtime WebSocket implementations.
+ *
+ * Listen for `event` to receive all server events, or subscribe to a specific
+ * server event's `type`. Always register an `error` listener; otherwise API and
+ * transport failures are reported as unhandled promise rejections.
+ */
 class OpenAIRealtimeEmitter extends EventEmitter_1.EventEmitter {
     _onError(event, message, cause) {
-        message =
-            event?.error ?
-                `${event.error.message} code=${event.error.code} param=${event.error.param} type=${event.error.type} event_id=${event.error.event_id}`
-                : message ?? 'unknown error';
+        message = event?.error
+            ? `${safeErrorValue(event.error.message)} code=${safeErrorValue(event.error.code)} param=${safeErrorValue(event.error.param)} type=${safeErrorValue(event.error.type)} event_id=${safeErrorValue(event.error.event_id)}`
+            : (message ?? 'unknown error');
         if (!this._hasListener('error')) {
             const error = new OpenAIRealtimeError(message +
                 `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`rt.on('error', (error) => ...)\` `, event);
@@ -35,10 +72,18 @@ class OpenAIRealtimeEmitter extends EventEmitter_1.EventEmitter {
     }
 }
 exports.OpenAIRealtimeEmitter = OpenAIRealtimeEmitter;
+/** Reports whether the client is an Azure OpenAI client with Azure-specific Realtime routing. */
 function isAzure(client) {
     return client instanceof index_1.AzureOpenAI;
 }
+/**
+ * Builds the secure WebSocket URL for a beta Realtime session or non-Azure sideband call.
+ *
+ * @throws {Error} If both `model` and `callID`, or neither, are supplied, or an
+ * Azure sideband call is requested through the beta helpers.
+ */
 function buildRealtimeURL(client, connection) {
+    (0, x509_workload_identity_auth_1.assertX509WebSocketSupported)(client);
     const config = typeof connection === 'string' ? { model: connection } : connection;
     const baseURL = client.baseURL;
     const azure = isAzure(client);
@@ -58,13 +103,11 @@ function buildRealtimeURL(client, connection) {
         url.searchParams.set('api-version', client.apiVersion);
         url.searchParams.set('deployment', config.model);
     }
+    else if (hasCallID) {
+        url.searchParams.set('call_id', config.callID);
+    }
     else {
-        if (hasCallID) {
-            url.searchParams.set('call_id', config.callID);
-        }
-        else {
-            url.searchParams.set('model', config.model);
-        }
+        url.searchParams.set('model', config.model);
     }
     return url;
 }

package/beta/realtime/internal-base.js.map

@@ -1 +1 @@
-{"version":3,"file":"internal-base.js","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":";;;AA4EA,0BAEC;AAkBD,4CAkCC;AAjID,4DAAsD;AACtD,0CAA0C;AAC1C,0CAAkD;AAElD,MAAa,mBAAoB,SAAQ,mBAAW;IAWlD,YAAY,OAAe,EAAE,KAAwB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,CAAC;IAClC,CAAC;CACF;AAjBD,kDAiBC;AAeD,MAAsB,qBAAsB,SAAQ,2BAA4B;IAapE,QAAQ,CAAC,KAAwB,EAAE,OAA4B,EAAE,KAAW;QACpF,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,CAAC;gBACZ,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,KAAK,CAAC,KAAK,CAAC,IAAI,UAAU,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,KAAK,CAAC,KAAK,CAAC,IAAI,aAAa,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE;gBACxI,CAAC,CAAC,OAAO,IAAI,eAAe,CAAC;QAE/B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,mBAAmB,CACnC,OAAO;gBACL,iIAAiI,EACnI,KAAK,CACN,CAAC;YACF,aAAa;YACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtD,aAAa;QACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AArCD,sDAqCC;AAED,SAAgB,OAAO,CAAC,MAA0C;IAChE,OAAO,MAAM,YAAY,mBAAW,CAAC;AACvC,CAAC;AAkBD,SAAgB,gBAAgB,CAC9B,MAA0C,EAC1C,UAA6C;IAE7C,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAChC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAElC,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC;IACrB,yEAAyE;IACzE,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,IAAI,SAAS,EAAE,CAAC;YACd,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"file":"internal-base.js","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":";;;AAYA,gDAUC;AA4HD,0BAEC;AA4BD,4CAiCC;AA5MD,4DAAsD;AACtD,0CAA0C;AAE1C,0CAA0C;AAC1C,oGAA+F;AAE/F,wFAAwF;AACxF,SAAgB,kBAAkB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAwB,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,IAAI,WAAW,CAAC,wDAAwD,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,8BAA8B,CAAC;IACxC,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,MAAa,mBAAoB,SAAQ,mBAAW;IAclD;;;;;OAKG;IACH,YAAY,OAAe,EAAE,KAAwB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QApBjB,uEAAuE;QAC9D,SAAI,GAAG,qBAAqB,CAAC;QAqBpC,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,CAAC;IAClC,CAAC;CACF;AA1BD,kDA0BC;AAiCD;;;;;;GAMG;AACH,MAAsB,qBAAsB,SAAQ,2BAA4B;IAqBpE,QAAQ,CAAC,KAAwB,EAAE,OAA4B,EAAE,KAAW;QACpF,OAAO,GAAG,KAAK,EAAE,KAAK;YACpB,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YACxN,CAAC,CAAC,CAAC,OAAO,IAAI,eAAe,CAAC,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,mBAAmB,CACnC,OAAO;gBACL,iIAAiI,EACnI,KAAK,CACN,CAAC;YACF,aAAa;YACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtD,aAAa;QACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AA5CD,sDA4CC;AAED,iGAAiG;AACjG,SAAgB,OAAO,CAAC,MAA0C;IAChE,OAAO,MAAM,YAAY,mBAAW,CAAC;AACvC,CAAC;AAsBD;;;;;GAKG;AACH,SAAgB,gBAAgB,CAC9B,MAA0C,EAC1C,UAA6C;IAE7C,IAAA,0DAA4B,EAAC,MAAM,CAAC,CAAC;IACrC,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAChC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAElC,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC;IACrB,yEAAyE;IACzE,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IACpD,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/beta/realtime/internal-base.mjs

@@ -1,19 +1,55 @@
 import { EventEmitter } from "../../lib/EventEmitter.mjs";
 import { OpenAIError } from "../../error.mjs";
 import { AzureOpenAI } from "../../index.mjs";
+import { assertX509WebSocketSupported } from "../../internal/auth/x509-workload-identity-auth.mjs";
+/** Parses frame data without exposing malformed payloads through JSON syntax errors. */
+export function parseRealtimeEvent(data) {
+    try {
+        return JSON.parse(data);
+    }
+    catch (error) {
+        if (error instanceof SyntaxError) {
+            throw new SyntaxError('Could not parse Realtime WebSocket event data as JSON.');
+        }
+        throw error;
+    }
+}
+function safeErrorValue(value) {
+    try {
+        return String(value);
+    }
+    catch {
+        return '[unserializable error value]';
+    }
+}
+/** An API-reported or client-side error encountered by a beta Realtime connection. */
 export class OpenAIRealtimeError extends OpenAIError {
+    /**
+     * Creates a beta Realtime error, preserving server-provided details when available.
+     *
+     * @param message Human-readable API or connection error description.
+     * @param event Server error event, or `null` for a client-side failure.
+     */
     constructor(message, event) {
         super(message);
+        /** Stable error name used to identify Realtime connection failures. */
+        this.name = 'OpenAIRealtimeError';
         this.error = event?.error;
         this.event_id = event?.event_id;
     }
 }
+/**
+ * Typed event emitter shared by the beta Realtime WebSocket implementations.
+ *
+ * Listen for `event` to receive all server events, or subscribe to a specific
+ * server event's `type`. Always register an `error` listener; otherwise API and
+ * transport failures are reported as unhandled promise rejections.
+ */
 export class OpenAIRealtimeEmitter extends EventEmitter {
     _onError(event, message, cause) {
-        message =
-            event?.error ?
-                `${event.error.message} code=${event.error.code} param=${event.error.param} type=${event.error.type} event_id=${event.error.event_id}`
-                : message ?? 'unknown error';
+        message = event?.error
+            ? `${safeErrorValue(event.error.message)} code=${safeErrorValue(event.error.code)} param=${safeErrorValue(event.error.param)} type=${safeErrorValue(event.error.type)} event_id=${safeErrorValue(event.error.event_id)}`
+            : (message ?? 'unknown error');
         if (!this._hasListener('error')) {
             const error = new OpenAIRealtimeError(message +
                 `\n\nTo resolve these unhandled rejection errors you should bind an \`error\` callback, e.g. \`rt.on('error', (error) => ...)\` `, event);
@@ -28,10 +64,18 @@ export class OpenAIRealtimeEmitter extends EventEmitter {
         this._emit('error', error);
     }
 }
+/** Reports whether the client is an Azure OpenAI client with Azure-specific Realtime routing. */
 export function isAzure(client) {
     return client instanceof AzureOpenAI;
 }
+/**
+ * Builds the secure WebSocket URL for a beta Realtime session or non-Azure sideband call.
+ *
+ * @throws {Error} If both `model` and `callID`, or neither, are supplied, or an
+ * Azure sideband call is requested through the beta helpers.
+ */
 export function buildRealtimeURL(client, connection) {
+    assertX509WebSocketSupported(client);
     const config = typeof connection === 'string' ? { model: connection } : connection;
     const baseURL = client.baseURL;
     const azure = isAzure(client);
@@ -51,13 +95,11 @@ export function buildRealtimeURL(client, connection) {
         url.searchParams.set('api-version', client.apiVersion);
         url.searchParams.set('deployment', config.model);
     }
+    else if (hasCallID) {
+        url.searchParams.set('call_id', config.callID);
+    }
     else {
-        if (hasCallID) {
-            url.searchParams.set('call_id', config.callID);
-        }
-        else {
-            url.searchParams.set('model', config.model);
-        }
+        url.searchParams.set('model', config.model);
     }
     return url;
 }

package/beta/realtime/internal-base.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"internal-base.mjs","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,mCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAC1C,OAAe,EAAE,WAAW,EAAE,wBAAoB;AAElD,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAWlD,YAAY,OAAe,EAAE,KAAwB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,CAAC;IAClC,CAAC;CACF;AAeD,MAAM,OAAgB,qBAAsB,SAAQ,YAA4B;IAapE,QAAQ,CAAC,KAAwB,EAAE,OAA4B,EAAE,KAAW;QACpF,OAAO;YACL,KAAK,EAAE,KAAK,CAAC,CAAC;gBACZ,GAAG,KAAK,CAAC,KAAK,CAAC,OAAO,SAAS,KAAK,CAAC,KAAK,CAAC,IAAI,UAAU,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,KAAK,CAAC,KAAK,CAAC,IAAI,aAAa,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE;gBACxI,CAAC,CAAC,OAAO,IAAI,eAAe,CAAC;QAE/B,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,mBAAmB,CACnC,OAAO;gBACL,iIAAiI,EACnI,KAAK,CACN,CAAC;YACF,aAAa;YACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtD,aAAa;QACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AAED,MAAM,UAAU,OAAO,CAAC,MAA0C;IAChE,OAAO,MAAM,YAAY,WAAW,CAAC;AACvC,CAAC;AAkBD,MAAM,UAAU,gBAAgB,CAC9B,MAA0C,EAC1C,UAA6C;IAE7C,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAChC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAElC,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC;IACrB,yEAAyE;IACzE,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IACpD,CAAC;SAAM,CAAC;QACN,IAAI,SAAS,EAAE,CAAC;YACd,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;QAClD,CAAC;aAAM,CAAC;YACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}
+{"version":3,"file":"internal-base.mjs","sourceRoot":"","sources":["../../src/beta/realtime/internal-base.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,YAAY,EAAE,mCAA+B;AACtD,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAE1C,OAAO,EAAE,WAAW,EAAE,wBAAoB;AAC1C,OAAO,EAAE,4BAA4B,EAAE,4DAAwD;AAE/F,wFAAwF;AACxF,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAwB,CAAC;IACjD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,KAAK,YAAY,WAAW,EAAE,CAAC;YACjC,MAAM,IAAI,WAAW,CAAC,wDAAwD,CAAC,CAAC;QAClF,CAAC;QAED,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC;AAED,SAAS,cAAc,CAAC,KAAc;IACpC,IAAI,CAAC;QACH,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,8BAA8B,CAAC;IACxC,CAAC;AACH,CAAC;AAED,sFAAsF;AACtF,MAAM,OAAO,mBAAoB,SAAQ,WAAW;IAclD;;;;;OAKG;IACH,YAAY,OAAe,EAAE,KAAwB;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;QApBjB,uEAAuE;QAC9D,SAAI,GAAG,qBAAqB,CAAC;QAqBpC,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,KAAK,EAAE,QAAQ,CAAC;IAClC,CAAC;CACF;AAiCD;;;;;;GAMG;AACH,MAAM,OAAgB,qBAAsB,SAAQ,YAA4B;IAqBpE,QAAQ,CAAC,KAAwB,EAAE,OAA4B,EAAE,KAAW;QACpF,OAAO,GAAG,KAAK,EAAE,KAAK;YACpB,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,cAAc,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;YACxN,CAAC,CAAC,CAAC,OAAO,IAAI,eAAe,CAAC,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,mBAAmB,CACnC,OAAO;gBACL,iIAAiI,EACnI,KAAK,CACN,CAAC;YACF,aAAa;YACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;YACpB,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,mBAAmB,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACtD,aAAa;QACb,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC;QAEpB,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;CACF;AAED,iGAAiG;AACjG,MAAM,UAAU,OAAO,CAAC,MAA0C;IAChE,OAAO,MAAM,YAAY,WAAW,CAAC;AACvC,CAAC;AAsBD;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAA0C,EAC1C,UAA6C;IAE7C,4BAA4B,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,MAAM,GACV,OAAO,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;IAC/B,MAAM,KAAK,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC9B,MAAM,QAAQ,GAAG,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;IAChC,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC;IAElC,MAAM,IAAI,GAAG,WAAW,CAAC;IACzB,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE9E,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,MAAM,IAAI,KAAK,CAAC,4EAA4E,CAAC,CAAC;IAChG,CAAC;IAED,GAAG,CAAC,QAAQ,GAAG,KAAK,CAAC;IACrB,yEAAyE;IACzE,IAAI,KAAK,EAAE,CAAC;QACV,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CAAC,iEAAiE,CAAC,CAAC;QACrF,CAAC;QACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;QACvD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IACpD,CAAC;SAAM,IAAI,SAAS,EAAE,CAAC;QACrB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,CAAC,MAAO,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAM,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}