openai 7.24.0 → 7.26.0

package/src/resources/beta/responses/ws-base.ts

@@ -125,6 +125,8 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
    */
   protected abstract _createSocket(url: URL, authHeaders: Record<string, string>): TSocket;
 
+  private _cancelRefresh: (() => void) | undefined;
+
   send(event: ResponsesAPI.BetaResponsesClientEvent) {
     if (!this.socket) {
       throw new OpenAIError('Internal error: failed to initialize socket. Please report this issue.');
@@ -177,6 +179,7 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     this._intentionallyClosed = true;
     this._closeCode = props?.code ?? 1000;
     this._closeReason = props?.reason ?? 'OK';
+    this._cancelRefresh?.();
     try {
       this.socket.close(this._closeCode, this._closeReason);
     } catch (err) {
@@ -421,10 +424,13 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     };
   }
 
-  private _connect(): TSocket {
-    this.url = buildURL(this._client, this._parameters ?? {});
+  private _connect(
+    createSocket: (url: URL) => TSocket = (url) => this._createSocket(url, this._authHeaders()),
+    url: URL = buildURL(this._client, this._parameters ?? {}),
+  ): TSocket {
+    this.url = url;
 
-    const socket = this._createSocket(this.url, this._authHeaders());
+    const socket = createSocket(this.url);
 
     socket.on('message', (data: string | ArrayBuffer | ArrayBufferView, isBinary: boolean) => {
       if (isBinary) {
@@ -632,7 +638,22 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       let closeCodePromise: Promise<number> | undefined;
       try {
         const oldSocket = this.socket;
-        this.socket = this._connect();
+        const url = buildURL(this._client, this._parameters ?? {});
+        const canceled = new Promise<undefined>((resolve) => {
+          this._cancelRefresh = () => resolve(undefined);
+        });
+        let createSocket: ((url: URL) => TSocket) | undefined;
+        try {
+          createSocket = await Promise.race([this._prepareReconnectSocket(), canceled]);
+        } finally {
+          this._cancelRefresh = undefined;
+        }
+        if (!this._canReconnect(closeCode)) {
+          this._isReconnecting = false;
+          this._emitPermanentClose(this._closeCode, this._closeReason);
+          return;
+        }
+        this.socket = this._connect(createSocket, url);
         // Registered synchronously after _connect() and before any
         // await so the code is captured even when ws emits 'close'
         // in the same tick as 'error' (e.g. abortHandshake).
@@ -649,6 +670,15 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
         this._internalEvents._emit('reconnected');
         return;
       } catch {
+        if (this._intentionallyClosed) {
+          // A public close observer may have thrown after lifecycle cleanup.
+          // Only emit here if the reconnect itself had not already closed.
+          if (this._isReconnecting) {
+            this._isReconnecting = false;
+            this._emitPermanentClose(this._closeCode, this._closeReason);
+          }
+          return;
+        }
         if (closeCodePromise) {
           // ws may emit 'error' before 'close', so await the code
           // rather than reading it synchronously.
@@ -722,8 +752,12 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     this._emit('close', code, reason, unsent);
   }
 
-  protected _authHeaders(): Record<string, string> {
-    const apiKey = this._client.apiKey;
+  protected _prepareReconnectSocket(): Promise<(url: URL) => TSocket> {
+    const authHeaders = this._authHeaders();
+    return Promise.resolve((url) => this._createSocket(url, authHeaders));
+  }
+
+  protected _authHeaders(apiKey = this._client.apiKey): Record<string, string> {
     return typeof apiKey === 'string' && apiKey ? { Authorization: `Bearer ${apiKey}` } : {};
   }
 }

package/src/resources/beta/responses/ws.ts

@@ -1,11 +1,10 @@
 // File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
 
 import * as WS from 'ws';
-import { NodeWebSocket } from '../../../internal/ws-adapter-node';
+import { NodeWebSocket, snapshotNodeWebSocketOptions } from '../../../internal/ws-adapter-node';
 import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../../client';
-import { OpenAIError } from '../../../core/error';
-import { snapshotWebSocketCredentials } from '../../../internal/ws';
+import { ResponsesWebSocketCredentials } from '../../../internal/responses-ws-credentials';
 
 export type { WebSocketStreamOptions } from '../../../internal/ws';
 
@@ -18,6 +17,7 @@ export interface ResponsesWSClientOptions extends WS.ClientOptions, ResponsesWSB
 
 export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
   private _wsOptions: WS.ClientOptions | null | undefined;
+  private _credentials = new ResponsesWebSocketCredentials();
 
   constructor(client: OpenAI, options?: ResponsesWSClientOptions | null | undefined) {
     if (!WS?.WebSocket) {
@@ -31,32 +31,42 @@ export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
     this._connectInitial();
   }
 
+  protected override _authHeaders(apiKey?: string | null): Record<string, string> {
+    const headers = super._authHeaders(apiKey === undefined ? this._credentials.preparedAPIKey : apiKey);
+    this._credentials.trackInitialHeaders(this._client, headers, () => !!this.socket);
+    return headers;
+  }
+
+  /**
+   * Whether credentials passed to the Node transport use the SDK key.
+   * The SDK recognizes its key, including copies and additions in credential headers.
+   * Override and return true if your socket hook signs or otherwise irreversibly transforms it.
+   * Explicit caller options and header removals still take precedence on reconnect.
+   */
+  protected _usesSDKAPIKey(authHeaders: Record<string, string>): boolean {
+    return this._credentials.usesAPIKey(this._client, authHeaders);
+  }
+
   protected _createSocket(url: URL, authHeaders: Record<string, string>): NodeWebSocket {
     const capturedAuthHeaders = { ...authHeaders };
-    const headers = new Map(Object.entries(this._client._buildWebSocketHeaders(capturedAuthHeaders)));
-    for (const [name, value] of Object.entries(this._wsOptions?.headers ?? {})) {
-      if (value === null) {
-        headers.delete(name.toLowerCase());
-      } else if (value !== undefined) {
-        headers.set(name.toLowerCase(), value);
-      }
-    }
-    const socketOptions: ResponsesWSClientOptions = {
-      ...this._wsOptions,
-      headers: Object.fromEntries(headers),
-      followRedirects: false,
-    };
-    if (
-      this._client._hasApiKeyProvider() &&
-      !capturedAuthHeaders['Authorization'] &&
-      !snapshotWebSocketCredentials(socketOptions)
-    ) {
-      throw new OpenAIError(
-        'Cannot open a Responses WebSocket with an unresolved function-based apiKey. Resolve it before constructing the WebSocket or provide explicit WebSocket credentials.',
-      );
-    }
+    const socketOptions = this._credentials.build(
+      this._client,
+      capturedAuthHeaders,
+      this._wsOptions,
+      !this.socket ? this._usesSDKAPIKey(capturedAuthHeaders) : undefined,
+    );
+    return new NodeWebSocket(new WS.WebSocket(url, socketOptions));
+  }
 
-    const ws = new WS.WebSocket(url, socketOptions);
-    return new NodeWebSocket(ws);
+  protected override async _prepareReconnectSocket(): Promise<(url: URL) => NodeWebSocket> {
+    if (!this._client._hasApiKeyProvider()) {
+      return super._prepareReconnectSocket();
+    }
+    return this._credentials.prepare(
+      this._client,
+      snapshotNodeWebSocketOptions(this._wsOptions),
+      (...args) => this._authHeaders(...args),
+      (url, headers) => this._createSocket(url, headers),
+    );
   }
 }

package/src/resources/chat/completions/completions.ts

@@ -1524,7 +1524,7 @@ export namespace ChatCompletionContentPartImage {
      * Specifies the detail level of the image. Learn more in the
      * [Vision guide](https://developers.openai.com/api/docs/guides/images-vision#choose-an-image-detail-level).
      */
-    detail?: 'auto' | 'low' | 'high';
+    detail?: 'auto' | 'low' | 'high' | 'original';
   }
 
   /**

package/src/resources/evals/runs/runs.ts

@@ -300,7 +300,7 @@ export class Runs extends APIResource {
   cancel(runID: string, params: RunCancelParams, options?: RequestOptions): APIPromise<RunCancelResponse> {
     const { eval_id } = params;
     return this._client.post(
-      path`/evals/${eval_id}/runs/${runID}`,
+      path`/evals/${eval_id}/runs/${runID}/cancel`,
       resolveResourceRequestOptions(options, (options) => ({ ...options, __security: { bearerAuth: true } })),
     );
   }

package/src/resources/live/forks/forks.ts

@@ -87,7 +87,7 @@ export namespace ForkServerEvent {
   }
 
   /**
-   * A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+   * A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
    * sideband observers; this is not a client command.
    */
   export interface TransportDtmfSend {
@@ -96,6 +96,11 @@ export namespace ForkServerEvent {
     event_id: string;
 
     type: 'transport.dtmf.send';
+
+    /**
+     * The event_id of the client command, when supplied.
+     */
+    client_event_id?: string;
   }
 
   /**

package/src/resources/live/live.ts

@@ -1520,7 +1520,7 @@ export namespace ServerEvent {
   }
 
   /**
-   * A SIP DTMF keypress successfully sent by the hosted tool. Delivered only to
+   * A SIP DTMF keypress successfully sent to the SIP trunk. Delivered only to
    * sideband observers; this is not a client command.
    */
   export interface TransportDtmfSend {
@@ -1529,6 +1529,11 @@ export namespace ServerEvent {
     event_id: string;
 
     type: 'transport.dtmf.send';
+
+    /**
+     * The event_id of the client command, when supplied.
+     */
+    client_event_id?: string;
   }
 
   /**

package/src/resources/responses/ws-base.ts

@@ -123,6 +123,8 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
    */
   protected abstract _createSocket(url: URL, authHeaders: Record<string, string>): TSocket;
 
+  private _cancelRefresh: (() => void) | undefined;
+
   send(event: ResponsesAPI.ResponsesClientEvent) {
     if (!this.socket) {
       throw new OpenAIError('Internal error: failed to initialize socket. Please report this issue.');
@@ -175,6 +177,7 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     this._intentionallyClosed = true;
     this._closeCode = props?.code ?? 1000;
     this._closeReason = props?.reason ?? 'OK';
+    this._cancelRefresh?.();
     try {
       this.socket.close(this._closeCode, this._closeReason);
     } catch (err) {
@@ -419,10 +422,13 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     };
   }
 
-  private _connect(): TSocket {
-    this.url = buildURL(this._client, this._parameters ?? {});
+  private _connect(
+    createSocket: (url: URL) => TSocket = (url) => this._createSocket(url, this._authHeaders()),
+    url: URL = buildURL(this._client, this._parameters ?? {}),
+  ): TSocket {
+    this.url = url;
 
-    const socket = this._createSocket(this.url, this._authHeaders());
+    const socket = createSocket(this.url);
 
     socket.on('message', (data: string | ArrayBuffer | ArrayBufferView, isBinary: boolean) => {
       if (isBinary) {
@@ -630,7 +636,22 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       let closeCodePromise: Promise<number> | undefined;
       try {
         const oldSocket = this.socket;
-        this.socket = this._connect();
+        const url = buildURL(this._client, this._parameters ?? {});
+        const canceled = new Promise<undefined>((resolve) => {
+          this._cancelRefresh = () => resolve(undefined);
+        });
+        let createSocket: ((url: URL) => TSocket) | undefined;
+        try {
+          createSocket = await Promise.race([this._prepareReconnectSocket(), canceled]);
+        } finally {
+          this._cancelRefresh = undefined;
+        }
+        if (!this._canReconnect(closeCode)) {
+          this._isReconnecting = false;
+          this._emitPermanentClose(this._closeCode, this._closeReason);
+          return;
+        }
+        this.socket = this._connect(createSocket, url);
         // Registered synchronously after _connect() and before any
         // await so the code is captured even when ws emits 'close'
         // in the same tick as 'error' (e.g. abortHandshake).
@@ -647,6 +668,15 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
         this._internalEvents._emit('reconnected');
         return;
       } catch {
+        if (this._intentionallyClosed) {
+          // A public close observer may have thrown after lifecycle cleanup.
+          // Only emit here if the reconnect itself had not already closed.
+          if (this._isReconnecting) {
+            this._isReconnecting = false;
+            this._emitPermanentClose(this._closeCode, this._closeReason);
+          }
+          return;
+        }
         if (closeCodePromise) {
           // ws may emit 'error' before 'close', so await the code
           // rather than reading it synchronously.
@@ -720,8 +750,12 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     this._emit('close', code, reason, unsent);
   }
 
-  protected _authHeaders(): Record<string, string> {
-    const apiKey = this._client.apiKey;
+  protected _prepareReconnectSocket(): Promise<(url: URL) => TSocket> {
+    const authHeaders = this._authHeaders();
+    return Promise.resolve((url) => this._createSocket(url, authHeaders));
+  }
+
+  protected _authHeaders(apiKey = this._client.apiKey): Record<string, string> {
     return typeof apiKey === 'string' && apiKey ? { Authorization: `Bearer ${apiKey}` } : {};
   }
 }

package/src/resources/responses/ws.ts

@@ -1,11 +1,10 @@
 // File generated from our OpenAPI spec by Castiron. See CONTRIBUTING.md for details.
 
 import * as WS from 'ws';
-import { NodeWebSocket } from '../../internal/ws-adapter-node';
+import { NodeWebSocket, snapshotNodeWebSocketOptions } from '../../internal/ws-adapter-node';
 import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../client';
-import { OpenAIError } from '../../core/error';
-import { snapshotWebSocketCredentials } from '../../internal/ws';
+import { ResponsesWebSocketCredentials } from '../../internal/responses-ws-credentials';
 
 export type { WebSocketStreamOptions } from '../../internal/ws';
 
@@ -18,6 +17,7 @@ export interface ResponsesWSClientOptions extends WS.ClientOptions, ResponsesWSB
 
 export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
   private _wsOptions: WS.ClientOptions | null | undefined;
+  private _credentials = new ResponsesWebSocketCredentials();
 
   constructor(client: OpenAI, options?: ResponsesWSClientOptions | null | undefined) {
     if (!WS?.WebSocket) {
@@ -31,32 +31,42 @@ export class ResponsesWS extends ResponsesWSBase<NodeWebSocket> {
     this._connectInitial();
   }
 
+  protected override _authHeaders(apiKey?: string | null): Record<string, string> {
+    const headers = super._authHeaders(apiKey === undefined ? this._credentials.preparedAPIKey : apiKey);
+    this._credentials.trackInitialHeaders(this._client, headers, () => !!this.socket);
+    return headers;
+  }
+
+  /**
+   * Whether credentials passed to the Node transport use the SDK key.
+   * The SDK recognizes its key, including copies and additions in credential headers.
+   * Override and return true if your socket hook signs or otherwise irreversibly transforms it.
+   * Explicit caller options and header removals still take precedence on reconnect.
+   */
+  protected _usesSDKAPIKey(authHeaders: Record<string, string>): boolean {
+    return this._credentials.usesAPIKey(this._client, authHeaders);
+  }
+
   protected _createSocket(url: URL, authHeaders: Record<string, string>): NodeWebSocket {
     const capturedAuthHeaders = { ...authHeaders };
-    const headers = new Map(Object.entries(this._client._buildWebSocketHeaders(capturedAuthHeaders)));
-    for (const [name, value] of Object.entries(this._wsOptions?.headers ?? {})) {
-      if (value === null) {
-        headers.delete(name.toLowerCase());
-      } else if (value !== undefined) {
-        headers.set(name.toLowerCase(), value);
-      }
-    }
-    const socketOptions: ResponsesWSClientOptions = {
-      ...this._wsOptions,
-      headers: Object.fromEntries(headers),
-      followRedirects: false,
-    };
-    if (
-      this._client._hasApiKeyProvider() &&
-      !capturedAuthHeaders['Authorization'] &&
-      !snapshotWebSocketCredentials(socketOptions)
-    ) {
-      throw new OpenAIError(
-        'Cannot open a Responses WebSocket with an unresolved function-based apiKey. Resolve it before constructing the WebSocket or provide explicit WebSocket credentials.',
-      );
-    }
+    const socketOptions = this._credentials.build(
+      this._client,
+      capturedAuthHeaders,
+      this._wsOptions,
+      !this.socket ? this._usesSDKAPIKey(capturedAuthHeaders) : undefined,
+    );
+    return new NodeWebSocket(new WS.WebSocket(url, socketOptions));
+  }
 
-    const ws = new WS.WebSocket(url, socketOptions);
-    return new NodeWebSocket(ws);
+  protected override async _prepareReconnectSocket(): Promise<(url: URL) => NodeWebSocket> {
+    if (!this._client._hasApiKeyProvider()) {
+      return super._prepareReconnectSocket();
+    }
+    return this._credentials.prepare(
+      this._client,
+      snapshotNodeWebSocketOptions(this._wsOptions),
+      (...args) => this._authHeaders(...args),
+      (url, headers) => this._createSocket(url, headers),
+    );
   }
 }

package/src/tsconfig.dist-src-node.d.ts

@@ -0,0 +1,7 @@
+// Type the Node-only WebSocket adapter for published source navigation without @types/node.
+declare module 'node:async_hooks' {
+  export class AsyncLocalStorage<T> {
+    run<R>(store: T, operation: () => R): R;
+    getStore(): T | undefined;
+  }
+}

package/src/tsconfig.dist-src.d.ts

@@ -1,3 +1,4 @@
+import './tsconfig.dist-src-node';
 // Keep published source navigation independent of consumers installing @types/node.
 // oxlint-disable-next-line unicorn/require-module-specifiers -- keep ambient globals scoped to a module
 export {};
@@ -21,7 +22,8 @@ declare global {
 
   interface BufferConstructor {
     from(input: string, encoding: 'base64' | 'utf-8'): Buffer<ArrayBuffer> & Uint8Array;
-    from(input: ArrayBuffer): Buffer<ArrayBuffer> & Uint8Array;
+    from(input: ArrayBuffer | ArrayLike<number>): Buffer<ArrayBuffer> & Uint8Array;
+    isBuffer(value: unknown): value is Buffer;
     concat(list: readonly Buffer[]): Buffer<ArrayBuffer> & Uint8Array;
   }
 

package/src/version.ts

@@ -1,2 +1,2 @@
 /** Version of the installed OpenAI SDK package. */
-export const VERSION = '7.24.0'; // x-release-please-version
+export const VERSION = '7.26.0'; // x-release-please-version

package/version.d.mts

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export declare const VERSION = "7.24.0";
+export declare const VERSION = "7.26.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.ts

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export declare const VERSION = "7.24.0";
+export declare const VERSION = "7.26.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -2,5 +2,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 /** Version of the installed OpenAI SDK package. */
-exports.VERSION = '7.24.0'; // x-release-please-version
+exports.VERSION = '7.26.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,3 +1,3 @@
 /** Version of the installed OpenAI SDK package. */
-export const VERSION = '7.24.0'; // x-release-please-version
+export const VERSION = '7.26.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map