openai 7.14.0 → 7.16.0

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

@@ -6,6 +6,8 @@ import { sleep } from '../../../internal/utils/sleep';
 import { type WebSocketLike, ReadyState } from '../../../internal/ws-adapter';
 import {
   SendQueue,
+  getMaxBufferedEvents,
+  type WebSocketStreamOptions,
   flattenRawData,
   isRecoverableClose,
   type RawWebSocketData,
@@ -51,11 +53,11 @@ export interface ResponsesWSBaseOptions {
   reconnect?: ResponsesWSReconnectOptions | null | undefined;
 
   /**
-   * Maximum size of the outgoing message queue in bytes.
-   * Messages queued while the socket is connecting or reconnecting are held
-   * in memory up to this limit. Once the limit is reached, new messages are
-   * discarded and an `error` event is emitted.
-   * Default: 1 MB
+   * Byte budget for outgoing messages queued while the socket is connecting
+   * or reconnecting. An empty queue accepts one message even if it exceeds
+   * this budget. Further messages are discarded and an `error` event is emitted
+   * if the total queued size would exceed the budget.
+   * Default: 1 MiB (1,048,576 bytes).
    */
   maxQueueSize?: number | undefined;
 }
@@ -169,6 +171,11 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
    * The iterator will exit if the socket closes but exiting the iterator
    * does not close the socket.
    *
+   * Pass `maxBufferedEvents` to limit queued records for this iterator, including
+   * lifecycle events. Overflow discards its backlog and rejects `next()` with a
+   * WebSocketError; the shared socket and other iterators remain active.
+   * Omitted means unlimited. This is an event-count limit, not a byte limit.
+   *
    * @example
    * ```ts
    * for await (const event of client.stream()) {
@@ -186,26 +193,59 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
    * }
    * ```
    */
-  stream(): AsyncIterableIterator<ResponsesStreamMessage> {
-    return this[Symbol.asyncIterator]();
+  stream(options?: WebSocketStreamOptions): AsyncIterableIterator<ResponsesStreamMessage> {
+    return options === undefined ? this[Symbol.asyncIterator]() : this[Symbol.asyncIterator](options);
   }
 
-  [Symbol.asyncIterator](): AsyncIterableIterator<ResponsesStreamMessage> {
+  [Symbol.asyncIterator](options?: WebSocketStreamOptions): AsyncIterableIterator<ResponsesStreamMessage> {
     if (!this.socket) {
       throw new OpenAIError('Internal error: failed to initialize socket. Please report this issue.');
     }
 
+    const maxBufferedEvents = getMaxBufferedEvents(options);
+
     // Two-queue async iterator: `queue` buffers incoming messages,
     // `resolvers` buffers waiting next() calls. A push wakes the
     // oldest next(); a next() drains the oldest message.
-    const queue: ResponsesStreamMessage[] = [];
-    const resolvers: (() => void)[] = [];
+    const queue: (ResponsesStreamMessage | undefined)[] = [];
+    const resolvers: ((() => void) | undefined)[] = [];
+    let queueHead = 0;
+    let resolverHead = 0;
     let done = false;
+    let failure: WebSocketError | undefined;
     let currentSocket = this.socket;
 
+    const wakeResolver = () => {
+      if (resolverHead >= resolvers.length) return;
+
+      const resolver = resolvers[resolverHead];
+      resolvers[resolverHead] = undefined;
+      resolverHead += 1;
+      if (resolverHead >= 64 && resolverHead * 2 >= resolvers.length) {
+        resolvers.splice(0, resolverHead);
+        resolverHead = 0;
+      }
+      resolver?.();
+    };
+
     const push = (msg: ResponsesStreamMessage) => {
+      if (done) return;
+
+      if (maxBufferedEvents !== undefined && queue.length - queueHead >= maxBufferedEvents) {
+        failure = new WebSocketError(
+          `WebSocket stream exceeded maxBufferedEvents (${maxBufferedEvents})`,
+          null,
+        );
+        done = true;
+        queue.length = 0;
+        queueHead = 0;
+        cleanup();
+        flushResolvers();
+        return;
+      }
+
       queue.push(msg);
-      resolvers.shift()?.();
+      wakeResolver();
     };
 
     const onEvent = (event: ResponsesAPI.BetaResponsesServerEvent) => {
@@ -235,9 +275,14 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     };
 
     const flushResolvers = () => {
-      for (let resolver = resolvers.shift(); resolver; resolver = resolvers.shift()) {
-        resolver();
+      while (resolverHead < resolvers.length) {
+        const resolver = resolvers[resolverHead];
+        resolvers[resolverHead] = undefined;
+        resolverHead += 1;
+        resolver?.();
       }
+      resolvers.length = 0;
+      resolverHead = 0;
     };
 
     const onClose = (
@@ -251,8 +296,9 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       cleanup();
     };
 
-    const onSocketSwap = (oldSocket: TSocket, newSocket: TSocket) => {
-      oldSocket.off('open', onOpen);
+    const onSocketSwap = (_oldSocket: TSocket, newSocket: TSocket) => {
+      if (currentSocket === newSocket) return;
+      currentSocket.off('open', onOpen);
       newSocket.on('open', onOpen);
       currentSocket = newSocket;
     };
@@ -309,9 +355,21 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       }
     }
 
-    const resolve = (res: (value: IteratorResult<ResponsesStreamMessage>) => void) => {
-      if (queue.length > 0) {
-        res({ value: queue.shift()!, done: false });
+    const resolve = (
+      res: (value: IteratorResult<ResponsesStreamMessage>) => void,
+      reject: (error: WebSocketError) => void,
+    ) => {
+      if (failure) {
+        reject(failure);
+      } else if (queueHead < queue.length) {
+        const queued = queue[queueHead]!;
+        queue[queueHead] = undefined;
+        queueHead += 1;
+        if (queueHead >= 64 && queueHead * 2 >= queue.length) {
+          queue.splice(0, queueHead);
+          queueHead = 0;
+        }
+        res({ value: queued, done: false });
       } else if (done) {
         res({ value: undefined, done: true });
       } else {
@@ -321,10 +379,10 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
     };
 
     const next = (): Promise<IteratorResult<ResponsesStreamMessage>> =>
-      new Promise((res) => {
-        if (resolve(res)) return;
+      new Promise((res, reject) => {
+        if (resolve(res, reject)) return;
         resolvers.push(() => {
-          resolve(res);
+          resolve(res, reject);
         });
       });
 
@@ -332,6 +390,8 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
       next,
       return: (): Promise<IteratorReturnResult<undefined>> => {
         done = true;
+        queue.length = 0;
+        queueHead = 0;
         cleanup();
         flushResolvers();
         return Promise.resolve({ value: undefined, done: true });
@@ -364,6 +424,35 @@ export abstract class ResponsesWSBase<TSocket extends WebSocketLike> extends Res
         return;
       }
 
+      if (
+        event === null ||
+        typeof event !== 'object' ||
+        Array.isArray(event) ||
+        !Object.prototype.hasOwnProperty.call(event, 'type') ||
+        typeof event.type !== 'string'
+      ) {
+        this._onError(
+          null,
+          'received invalid WebSocket event: expected an object with an own string type',
+          undefined,
+        );
+        return;
+      }
+
+      const eventType: string = event.type;
+      const reservedEventType =
+        eventType === 'raw' ||
+        eventType === 'close' ||
+        eventType === 'event' ||
+        eventType === 'reconnecting' ||
+        eventType === 'reconnected' ||
+        eventType === 'open' ||
+        eventType === 'error';
+      if (reservedEventType && eventType !== 'error') {
+        this._onError(null, 'received reserved WebSocket event type', undefined);
+        return;
+      }
+
       this._emit('event', event);
 
       if (event.type === 'error') {

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

@@ -6,6 +6,8 @@ import { ResponsesWSBase, type ResponsesWSBaseOptions } from './ws-base';
 import { OpenAI } from '../../../client';
 import { VERSION } from '../../../version';
 
+export type { WebSocketStreamOptions } from '../../../internal/ws';
+
 export type { ResponsesWSReconnectOptions } from './ws-base';
 
 export interface ResponsesWSClientOptions extends WS.ClientOptions, ResponsesWSBaseOptions {}

package/src/resources/live/forks/ws-base.ts

@@ -6,6 +6,8 @@ import { sleep } from '../../../internal/utils/sleep';
 import { type WebSocketLike, ReadyState } from '../../../internal/ws-adapter';
 import {
   SendQueue,
+  getMaxBufferedEvents,
+  type WebSocketStreamOptions,
   flattenRawData,
   isRecoverableClose,
   type RawWebSocketData,
@@ -55,11 +57,11 @@ export interface ForksWSBaseOptions {
   reconnect?: ForksWSReconnectOptions | null | undefined;
 
   /**
-   * Maximum size of the outgoing message queue in bytes.
-   * Messages queued while the socket is connecting or reconnecting are held
-   * in memory up to this limit. Once the limit is reached, new messages are
-   * discarded and an `error` event is emitted.
-   * Default: 1 MB
+   * Byte budget for outgoing messages queued while the socket is connecting
+   * or reconnecting. An empty queue accepts one message even if it exceeds
+   * this budget. Further messages are discarded and an `error` event is emitted
+   * if the total queued size would exceed the budget.
+   * Default: 1 MiB (1,048,576 bytes).
    */
   maxQueueSize?: number | undefined;
 }
@@ -169,6 +171,11 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
    * The iterator will exit if the socket closes but exiting the iterator
    * does not close the socket.
    *
+   * Pass `maxBufferedEvents` to limit queued records for this iterator, including
+   * lifecycle events. Overflow discards its backlog and rejects `next()` with a
+   * WebSocketError; the shared socket and other iterators remain active.
+   * Omitted means unlimited. This is an event-count limit, not a byte limit.
+   *
    * @example
    * ```ts
    * for await (const event of client.stream()) {
@@ -186,26 +193,59 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
    * }
    * ```
    */
-  stream(): AsyncIterableIterator<ForksStreamMessage> {
-    return this[Symbol.asyncIterator]();
+  stream(options?: WebSocketStreamOptions): AsyncIterableIterator<ForksStreamMessage> {
+    return options === undefined ? this[Symbol.asyncIterator]() : this[Symbol.asyncIterator](options);
   }
 
-  [Symbol.asyncIterator](): AsyncIterableIterator<ForksStreamMessage> {
+  [Symbol.asyncIterator](options?: WebSocketStreamOptions): AsyncIterableIterator<ForksStreamMessage> {
     if (!this.socket) {
       throw new OpenAIError('Internal error: failed to initialize socket. Please report this issue.');
     }
 
+    const maxBufferedEvents = getMaxBufferedEvents(options);
+
     // Two-queue async iterator: `queue` buffers incoming messages,
     // `resolvers` buffers waiting next() calls. A push wakes the
     // oldest next(); a next() drains the oldest message.
-    const queue: ForksStreamMessage[] = [];
-    const resolvers: (() => void)[] = [];
+    const queue: (ForksStreamMessage | undefined)[] = [];
+    const resolvers: ((() => void) | undefined)[] = [];
+    let queueHead = 0;
+    let resolverHead = 0;
     let done = false;
+    let failure: WebSocketError | undefined;
     let currentSocket = this.socket;
 
+    const wakeResolver = () => {
+      if (resolverHead >= resolvers.length) return;
+
+      const resolver = resolvers[resolverHead];
+      resolvers[resolverHead] = undefined;
+      resolverHead += 1;
+      if (resolverHead >= 64 && resolverHead * 2 >= resolvers.length) {
+        resolvers.splice(0, resolverHead);
+        resolverHead = 0;
+      }
+      resolver?.();
+    };
+
     const push = (msg: ForksStreamMessage) => {
+      if (done) return;
+
+      if (maxBufferedEvents !== undefined && queue.length - queueHead >= maxBufferedEvents) {
+        failure = new WebSocketError(
+          `WebSocket stream exceeded maxBufferedEvents (${maxBufferedEvents})`,
+          null,
+        );
+        done = true;
+        queue.length = 0;
+        queueHead = 0;
+        cleanup();
+        flushResolvers();
+        return;
+      }
+
       queue.push(msg);
-      resolvers.shift()?.();
+      wakeResolver();
     };
 
     const onEvent = (event: ForksAPI.ForkServerEvent) => {
@@ -235,9 +275,14 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
     };
 
     const flushResolvers = () => {
-      for (let resolver = resolvers.shift(); resolver; resolver = resolvers.shift()) {
-        resolver();
+      while (resolverHead < resolvers.length) {
+        const resolver = resolvers[resolverHead];
+        resolvers[resolverHead] = undefined;
+        resolverHead += 1;
+        resolver?.();
       }
+      resolvers.length = 0;
+      resolverHead = 0;
     };
 
     const onClose = (code: number, reason: string, unsent: UnsentMessage<ForksAPI.ForkClientEvent>[]) => {
@@ -247,8 +292,9 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
       cleanup();
     };
 
-    const onSocketSwap = (oldSocket: TSocket, newSocket: TSocket) => {
-      oldSocket.off('open', onOpen);
+    const onSocketSwap = (_oldSocket: TSocket, newSocket: TSocket) => {
+      if (currentSocket === newSocket) return;
+      currentSocket.off('open', onOpen);
       newSocket.on('open', onOpen);
       currentSocket = newSocket;
     };
@@ -305,9 +351,21 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
       }
     }
 
-    const resolve = (res: (value: IteratorResult<ForksStreamMessage>) => void) => {
-      if (queue.length > 0) {
-        res({ value: queue.shift()!, done: false });
+    const resolve = (
+      res: (value: IteratorResult<ForksStreamMessage>) => void,
+      reject: (error: WebSocketError) => void,
+    ) => {
+      if (failure) {
+        reject(failure);
+      } else if (queueHead < queue.length) {
+        const queued = queue[queueHead]!;
+        queue[queueHead] = undefined;
+        queueHead += 1;
+        if (queueHead >= 64 && queueHead * 2 >= queue.length) {
+          queue.splice(0, queueHead);
+          queueHead = 0;
+        }
+        res({ value: queued, done: false });
       } else if (done) {
         res({ value: undefined, done: true });
       } else {
@@ -317,10 +375,10 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
     };
 
     const next = (): Promise<IteratorResult<ForksStreamMessage>> =>
-      new Promise((res) => {
-        if (resolve(res)) return;
+      new Promise((res, reject) => {
+        if (resolve(res, reject)) return;
         resolvers.push(() => {
-          resolve(res);
+          resolve(res, reject);
         });
       });
 
@@ -328,6 +386,8 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
       next,
       return: (): Promise<IteratorReturnResult<undefined>> => {
         done = true;
+        queue.length = 0;
+        queueHead = 0;
         cleanup();
         flushResolvers();
         return Promise.resolve({ value: undefined, done: true });
@@ -360,6 +420,35 @@ export abstract class ForksWSBase<TSocket extends WebSocketLike> extends ForksEm
         return;
       }
 
+      if (
+        event === null ||
+        typeof event !== 'object' ||
+        Array.isArray(event) ||
+        !Object.prototype.hasOwnProperty.call(event, 'type') ||
+        typeof event.type !== 'string'
+      ) {
+        this._onError(
+          null,
+          'received invalid WebSocket event: expected an object with an own string type',
+          undefined,
+        );
+        return;
+      }
+
+      const eventType: string = event.type;
+      const reservedEventType =
+        eventType === 'raw' ||
+        eventType === 'close' ||
+        eventType === 'event' ||
+        eventType === 'reconnecting' ||
+        eventType === 'reconnected' ||
+        eventType === 'open' ||
+        eventType === 'error';
+      if (reservedEventType && eventType !== 'error') {
+        this._onError(null, 'received reserved WebSocket event type', undefined);
+        return;
+      }
+
       this._emit('event', event);
 
       if (event.type === 'error') {

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

@@ -6,6 +6,8 @@ import { ForksWSBase, type ForksWSBaseOptions, type ForksWSParameters } from './
 import { OpenAI } from '../../../client';
 import { VERSION } from '../../../version';
 
+export type { WebSocketStreamOptions } from '../../../internal/ws';
+
 export type { ForksWSParameters, ForksWSReconnectOptions } from './ws-base';
 
 export interface ForksWSClientOptions extends WS.ClientOptions, ForksWSBaseOptions {}

package/src/resources/live/sessions.ts

@@ -9,7 +9,11 @@ import { path } from '../../internal/utils/path';
 
 export class Sessions extends APIResource {
   /**
-   * Accept an incoming SIP call with Live startup configuration.
+   * Accept an incoming SIP call. Supply session with type live, the model, and
+   * startup configuration. Before accepting calls, follow the
+   * [Live prompting guide](https://developers.openai.com/api/docs/guides/live-prompting)
+   * to write frontend conversation instructions and a separate backend prompt. SIP
+   * media format is negotiated; omit audio.format.
    *
    * @example
    * ```ts
@@ -72,7 +76,7 @@ export class Sessions extends APIResource {
   }
 
   /**
-   * Hang up a Live session.
+   * End a SIP call identified by session_id.
    *
    * @example
    * ```ts
@@ -88,7 +92,8 @@ export class Sessions extends APIResource {
   }
 
   /**
-   * Transfer a Live SIP call to another destination.
+   * Transfer a SIP call to another destination. Supply a nonblank target_uri for the
+   * SIP Refer-To header.
    *
    * @example
    * ```ts
@@ -107,7 +112,8 @@ export class Sessions extends APIResource {
   }
 
   /**
-   * Reject an incoming SIP call.
+   * Reject an incoming SIP call. Send a required SIP rejection status_code between
+   * 300 and 699.
    *
    * @example
    * ```ts