openai 7.13.0 → 7.15.0

package/resources/live/sideband/sideband.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sideband.mjs","sourceRoot":"","sources":["../../../src/resources/live/sideband/sideband.ts"],"names":[],"mappings":"AAAA,qFAAqF;AAErF,OAAO,EAAE,WAAW,EAAE,mCAA+B;AAGrD,MAAM,OAAO,QAAS,SAAQ,WAAW;CAAG"}

package/resources/live/sideband/ws-base.d.mts

@@ -0,0 +1,114 @@
+import { SidebandEmitter, SidebandStreamMessage } from "./internal-base.mjs";
+import { type WebSocketLike } from "../../../internal/ws-adapter.mjs";
+import { type RawWebSocketData, type ReconnectingEvent, type ReconnectingOverrides } from "../../../internal/ws.mjs";
+import * as SidebandAPI from "./sideband.mjs";
+import { OpenAI } from "../../../client.mjs";
+export interface SidebandWSParameters extends Record<string, unknown> {
+    /**
+     * Opt in to the graceful WebSocket closing handshake when the session ends. The
+     * server may also enable this behavior by default.
+     */
+    graceful_close?: boolean;
+    session_id: string;
+}
+export interface SidebandWSReconnectOptions {
+    /**
+     * Called before each reconnect attempt. Return an object with
+     * `parameters` to override query parameters for the next connection.
+     */
+    onReconnecting(event: ReconnectingEvent<SidebandWSParameters>): ReconnectingOverrides<SidebandWSParameters> | void;
+    /**
+     * Maximum number of reconnection attempts. Default: 5.
+     * Set to 0 to disable reconnection entirely.
+     */
+    maxRetries?: number;
+    /**
+     * Initial backoff delay in milliseconds. Default: 500.
+     */
+    initialDelay?: number;
+    /**
+     * Maximum backoff delay in milliseconds. Default: 8000.
+     */
+    maxDelay?: number;
+}
+export interface SidebandWSBaseOptions {
+    /**
+     * Options for automatic reconnection on recoverable close codes.
+     * Automatic reconnection is only enabled when this has a non-null value.
+     */
+    reconnect?: SidebandWSReconnectOptions | 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
+     */
+    maxQueueSize?: number | undefined;
+}
+export declare abstract class SidebandWSBase<TSocket extends WebSocketLike> extends SidebandEmitter {
+    url: URL;
+    socket: TSocket;
+    protected _client: OpenAI;
+    protected _parameters: SidebandWSParameters | null | undefined;
+    private _reconnectOptions;
+    private _sendQueue;
+    private _isReconnecting;
+    private _intentionallyClosed;
+    private _closeCode;
+    private _closeReason;
+    private _lastCloseCode;
+    private _lastCloseReason;
+    private _internalEvents;
+    constructor(client: OpenAI, parameters: SidebandWSParameters, options?: SidebandWSBaseOptions | undefined);
+    /** Establishes the initial WebSocket connection. */
+    protected _connectInitial(): void;
+    /** Creates a platform-specific WebSocket for the given URL and auth headers. */
+    protected abstract _createSocket(url: URL, authHeaders: Record<string, string>): TSocket;
+    send(event: SidebandAPI.ConnectClientEvent): void;
+    sendRaw(data: RawWebSocketData): void;
+    close(props?: {
+        code: number;
+        reason: string;
+    }): void;
+    /**
+     * Returns an async iterator over WebSocket lifecycle and message events,
+     * providing an alternative to the event-based `.on()` API.
+     * The iterator will exit if the socket closes but exiting the iterator
+     * does not close the socket.
+     *
+     * @example
+     * ```ts
+     * for await (const event of client.stream()) {
+     *   switch (event.type) {
+     *     case 'message':
+     *       console.log('received:', event.message);
+     *       break;
+     *     case 'error':
+     *       console.error(event.error);
+     *       break;
+     *     case 'close':
+     *       console.log('connection closed');
+     *       break;
+     *   }
+     * }
+     * ```
+     */
+    stream(): AsyncIterableIterator<SidebandStreamMessage>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<SidebandStreamMessage>;
+    private _connect;
+    private _canReconnect;
+    private _reconnect;
+    /**
+     * Resolves once the socket is open, rejects if it errors or closes first
+     */
+    private _awaitOpen;
+    private _flushSendQueue;
+    /**
+     * Emits the public `close` event with unsent messages and the internal
+     * `close` event used by the async iterator.
+     */
+    private _emitPermanentClose;
+    protected _authHeaders(): Record<string, string>;
+}
+//# sourceMappingURL=ws-base.d.mts.map

package/resources/live/sideband/ws-base.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-base.d.mts","sourceRoot":"","sources":["../../../src/resources/live/sideband/ws-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAA4B,4BAAwB;AAGnG,OAAO,EAAE,KAAK,aAAa,EAAc,yCAAqC;AAC9E,OAAO,EAIL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAE3B,iCAA6B;AAC9B,OAAO,KAAK,WAAW,uBAAmB;AAC1C,OAAO,EAAE,MAAM,EAAE,4BAAwB;AAGzC,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnE;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,cAAc,CACZ,KAAK,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,GAC7C,qBAAqB,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;IAEtD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,CAAC,EAAE,0BAA0B,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1D;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,8BAAsB,cAAc,CAAC,OAAO,SAAS,aAAa,CAAE,SAAQ,eAAe;IACzF,GAAG,EAAG,GAAG,CAAC;IACV,MAAM,EAAG,OAAO,CAAC;IAEjB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,WAAW,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/D,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,UAAU,CAA4C;IAC9D,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,gBAAgB,CAAc;IAGtC,OAAO,CAAC,eAAe,CAKlB;gBAEO,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS;IAQzG,oDAAoD;IACpD,SAAS,CAAC,eAAe,IAAI,IAAI;IAKjC,gFAAgF;IAChF,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO;IAExF,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,kBAAkB;IAsB1C,OAAO,CAAC,IAAI,EAAE,gBAAgB;IAsB9B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAe9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,IAAI,qBAAqB,CAAC,qBAAqB,CAAC;IAItD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,qBAAqB,CAAC;IAwJtE,OAAO,CAAC,QAAQ;IA2DhB,OAAO,CAAC,aAAa;YAQP,UAAU;IA+IxB;;OAEG;IACH,OAAO,CAAC,UAAU;IAyBlB,OAAO,CAAC,eAAe;IAYvB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAU3B,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAMjD"}

package/resources/live/sideband/ws-base.d.ts

@@ -0,0 +1,114 @@
+import { SidebandEmitter, SidebandStreamMessage } from "./internal-base.js";
+import { type WebSocketLike } from "../../../internal/ws-adapter.js";
+import { type RawWebSocketData, type ReconnectingEvent, type ReconnectingOverrides } from "../../../internal/ws.js";
+import * as SidebandAPI from "./sideband.js";
+import { OpenAI } from "../../../client.js";
+export interface SidebandWSParameters extends Record<string, unknown> {
+    /**
+     * Opt in to the graceful WebSocket closing handshake when the session ends. The
+     * server may also enable this behavior by default.
+     */
+    graceful_close?: boolean;
+    session_id: string;
+}
+export interface SidebandWSReconnectOptions {
+    /**
+     * Called before each reconnect attempt. Return an object with
+     * `parameters` to override query parameters for the next connection.
+     */
+    onReconnecting(event: ReconnectingEvent<SidebandWSParameters>): ReconnectingOverrides<SidebandWSParameters> | void;
+    /**
+     * Maximum number of reconnection attempts. Default: 5.
+     * Set to 0 to disable reconnection entirely.
+     */
+    maxRetries?: number;
+    /**
+     * Initial backoff delay in milliseconds. Default: 500.
+     */
+    initialDelay?: number;
+    /**
+     * Maximum backoff delay in milliseconds. Default: 8000.
+     */
+    maxDelay?: number;
+}
+export interface SidebandWSBaseOptions {
+    /**
+     * Options for automatic reconnection on recoverable close codes.
+     * Automatic reconnection is only enabled when this has a non-null value.
+     */
+    reconnect?: SidebandWSReconnectOptions | 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
+     */
+    maxQueueSize?: number | undefined;
+}
+export declare abstract class SidebandWSBase<TSocket extends WebSocketLike> extends SidebandEmitter {
+    url: URL;
+    socket: TSocket;
+    protected _client: OpenAI;
+    protected _parameters: SidebandWSParameters | null | undefined;
+    private _reconnectOptions;
+    private _sendQueue;
+    private _isReconnecting;
+    private _intentionallyClosed;
+    private _closeCode;
+    private _closeReason;
+    private _lastCloseCode;
+    private _lastCloseReason;
+    private _internalEvents;
+    constructor(client: OpenAI, parameters: SidebandWSParameters, options?: SidebandWSBaseOptions | undefined);
+    /** Establishes the initial WebSocket connection. */
+    protected _connectInitial(): void;
+    /** Creates a platform-specific WebSocket for the given URL and auth headers. */
+    protected abstract _createSocket(url: URL, authHeaders: Record<string, string>): TSocket;
+    send(event: SidebandAPI.ConnectClientEvent): void;
+    sendRaw(data: RawWebSocketData): void;
+    close(props?: {
+        code: number;
+        reason: string;
+    }): void;
+    /**
+     * Returns an async iterator over WebSocket lifecycle and message events,
+     * providing an alternative to the event-based `.on()` API.
+     * The iterator will exit if the socket closes but exiting the iterator
+     * does not close the socket.
+     *
+     * @example
+     * ```ts
+     * for await (const event of client.stream()) {
+     *   switch (event.type) {
+     *     case 'message':
+     *       console.log('received:', event.message);
+     *       break;
+     *     case 'error':
+     *       console.error(event.error);
+     *       break;
+     *     case 'close':
+     *       console.log('connection closed');
+     *       break;
+     *   }
+     * }
+     * ```
+     */
+    stream(): AsyncIterableIterator<SidebandStreamMessage>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<SidebandStreamMessage>;
+    private _connect;
+    private _canReconnect;
+    private _reconnect;
+    /**
+     * Resolves once the socket is open, rejects if it errors or closes first
+     */
+    private _awaitOpen;
+    private _flushSendQueue;
+    /**
+     * Emits the public `close` event with unsent messages and the internal
+     * `close` event used by the async iterator.
+     */
+    private _emitPermanentClose;
+    protected _authHeaders(): Record<string, string>;
+}
+//# sourceMappingURL=ws-base.d.ts.map

package/resources/live/sideband/ws-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-base.d.ts","sourceRoot":"","sources":["../../../src/resources/live/sideband/ws-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAE,qBAAqB,EAA4B,2BAAwB;AAGnG,OAAO,EAAE,KAAK,aAAa,EAAc,wCAAqC;AAC9E,OAAO,EAIL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAE3B,gCAA6B;AAC9B,OAAO,KAAK,WAAW,sBAAmB;AAC1C,OAAO,EAAE,MAAM,EAAE,2BAAwB;AAGzC,MAAM,WAAW,oBAAqB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnE;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC;;;OAGG;IACH,cAAc,CACZ,KAAK,EAAE,iBAAiB,CAAC,oBAAoB,CAAC,GAC7C,qBAAqB,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC;IAEtD;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,SAAS,CAAC,EAAE,0BAA0B,GAAG,IAAI,GAAG,SAAS,CAAC;IAE1D;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,8BAAsB,cAAc,CAAC,OAAO,SAAS,aAAa,CAAE,SAAQ,eAAe;IACzF,GAAG,EAAG,GAAG,CAAC;IACV,MAAM,EAAG,OAAO,CAAC;IAEjB,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC;IAC1B,SAAS,CAAC,WAAW,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC/D,OAAO,CAAC,iBAAiB,CAAoC;IAC7D,OAAO,CAAC,UAAU,CAA4C;IAC9D,OAAO,CAAC,eAAe,CAAkB;IACzC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,UAAU,CAAgB;IAClC,OAAO,CAAC,YAAY,CAAgB;IACpC,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,gBAAgB,CAAc;IAGtC,OAAO,CAAC,eAAe,CAKlB;gBAEO,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,qBAAqB,GAAG,SAAS;IAQzG,oDAAoD;IACpD,SAAS,CAAC,eAAe,IAAI,IAAI;IAKjC,gFAAgF;IAChF,SAAS,CAAC,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO;IAExF,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,kBAAkB;IAsB1C,OAAO,CAAC,IAAI,EAAE,gBAAgB;IAsB9B,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE;IAe9C;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,MAAM,IAAI,qBAAqB,CAAC,qBAAqB,CAAC;IAItD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,qBAAqB,CAAC;IAwJtE,OAAO,CAAC,QAAQ;IA2DhB,OAAO,CAAC,aAAa;YAQP,UAAU;IA+IxB;;OAEG;IACH,OAAO,CAAC,UAAU;IAyBlB,OAAO,CAAC,eAAe;IAYvB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAU3B,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAMjD"}