@tembo-io/sdk 0.10.0 → 0.12.0

package/dist/cjs/resources/live/internal-base.d.ts

@@ -0,0 +1,70 @@
+import { Tembo } from '../../client';
+import { EventEmitter, type EventParameters } from '../../core/EventEmitter';
+import { TemboError } from '../../error';
+import type { RawWebSocketData, ReconnectingEvent, UnsentMessage } from '../../internal/ws';
+import type { LiveWSParameters } from './ws-base';
+type EventTypeOf<T> = T extends {
+    type?: infer EventType;
+} ? EventType : never;
+type LiveWSErrorEvent = Extract<unknown, {
+    type?: 'error';
+}>;
+export type LiveStreamMessage = {
+    type: 'connecting' | 'open' | 'closing';
+} | {
+    type: 'close';
+    code: number;
+    reason: string;
+    unsent: UnsentMessage<unknown>[];
+} | {
+    type: 'reconnecting';
+    reconnect: ReconnectingEvent<LiveWSParameters>;
+} | {
+    type: 'reconnected';
+} | {
+    type: 'message';
+    message: unknown;
+} | {
+    type: 'raw';
+    data: RawWebSocketData;
+} | {
+    type: 'error';
+    error: WebSocketError;
+};
+export declare class WebSocketError extends TemboError {
+    error?: LiveWSErrorEvent | undefined;
+    constructor(message: string, event: LiveWSErrorEvent | null);
+}
+type Simplify<T> = {
+    [KeyType in keyof T]: T[KeyType];
+} & {};
+type WebSocketEvents = Simplify<{
+    event: (event: unknown) => void;
+    raw: (data: RawWebSocketData) => void;
+    error: (error: WebSocketError) => void;
+    close: (code: number, reason: string, unsent: UnsentMessage<unknown>[]) => void;
+    reconnecting: (event: ReconnectingEvent<LiveWSParameters>) => void;
+    reconnected: () => void;
+} & {
+    [EventType in Exclude<NonNullable<EventTypeOf<unknown>>, 'error'> & string]: (event: Extract<unknown, {
+        type?: EventType;
+    }>) => unknown;
+}>;
+export declare abstract class LiveEmitter extends EventEmitter<WebSocketEvents> {
+    /** Send an event to the API. */
+    abstract send(event: unknown): void;
+    /** Send raw data over the WebSocket without JSON serialization. */
+    abstract sendRaw(data: RawWebSocketData): void;
+    /** Close the WebSocket connection. */
+    abstract close(props?: {
+        code: number;
+        reason: string;
+    }): void;
+    protected _onError(event: null, message: string, cause: unknown): void;
+    protected _onError(event: LiveWSErrorEvent, message?: string | undefined): void;
+    _emit<Event extends keyof WebSocketEvents>(event: Event, ...args: EventParameters<WebSocketEvents, Event>): void;
+}
+export declare function buildURL(client: Tembo, parameters: Record<string, unknown>): URL;
+export declare function parameterHeaders(parameters: Record<string, unknown>): Record<string, string>;
+export {};
+//# sourceMappingURL=internal-base.d.ts.map

package/dist/cjs/resources/live/internal-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-base.d.ts","sourceRoot":"","sources":["../../../../src/resources/live/internal-base.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AACrC,OAAO,EAAE,YAAY,EAAE,KAAK,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC7E,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAC5F,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAElD,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS;IAAE,IAAI,CAAC,EAAE,MAAM,SAAS,CAAA;CAAE,GAAG,SAAS,GAAG,KAAK,CAAC;AAC/E,KAAK,gBAAgB,GAAG,OAAO,CAAC,OAAO,EAAE;IAAE,IAAI,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAAC;AAE7D,MAAM,MAAM,iBAAiB,GACzB;IAAE,IAAI,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS,CAAA;CAAE,GAC3C;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,CAAA;CAAE,GACjF;IAAE,IAAI,EAAE,cAAc,CAAC;IAAC,SAAS,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,CAAA;CAAE,GACxE;IAAE,IAAI,EAAE,aAAa,CAAA;CAAE,GACvB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,OAAO,EAAE,OAAO,CAAA;CAAE,GACrC;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,gBAAgB,CAAA;CAAE,GACvC;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,cAAc,CAAA;CAAE,CAAC;AAE7C,qBAAa,cAAe,SAAQ,UAAU;IAC5C,KAAK,CAAC,EAAE,gBAAgB,GAAG,SAAS,CAAC;gBAEzB,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,gBAAgB,GAAG,IAAI;CAI5D;AAID,KAAK,QAAQ,CAAC,CAAC,IAAI;KAAG,OAAO,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC;CAAE,GAAG,EAAE,CAAC;AAE7D,KAAK,eAAe,GAAG,QAAQ,CAC7B;IACE,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IAChC,GAAG,EAAE,CAAC,IAAI,EAAE,gBAAgB,KAAK,IAAI,CAAC;IACtC,KAAK,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,IAAI,CAAC;IACvC,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,OAAO,CAAC,EAAE,KAAK,IAAI,CAAC;IAChF,YAAY,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAC;IACnE,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB,GAAG;KACD,SAAS,IAAI,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,MAAM,GAAG,CAC3E,KAAK,EAAE,OAAO,CAAC,OAAO,EAAE;QAAE,IAAI,CAAC,EAAE,SAAS,CAAA;KAAE,CAAC,KAC1C,OAAO;CACb,CACF,CAAC;AAEF,8BAAsB,WAAY,SAAQ,YAAY,CAAC,eAAe,CAAC;IACrE,gCAAgC;IAChC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAEnC,mEAAmE;IACnE,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAE9C,sCAAsC;IACtC,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,OAAO,GAAG,IAAI;IACtE,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI;IAoBxE,KAAK,CAAC,KAAK,SAAS,MAAM,eAAe,EAC9C,KAAK,EAAE,KAAK,EACZ,GAAG,IAAI,EAAE,eAAe,CAAC,eAAe,EAAE,KAAK,CAAC,GAC/C,IAAI;CAGR;AAED,wBAAgB,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,GAAG,CAMhF;AAED,wBAAgB,gBAAgB,CAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAG5F"}

package/dist/cjs/resources/live/internal-base.js

@@ -0,0 +1,57 @@
+"use strict";
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveEmitter = exports.WebSocketError = void 0;
+exports.buildURL = buildURL;
+exports.parameterHeaders = parameterHeaders;
+const path_1 = require("../../internal/utils/path");
+const EventEmitter_1 = require("../../core/EventEmitter");
+const error_1 = require("../../error");
+class WebSocketError extends error_1.TemboError {
+    error;
+    constructor(message, event) {
+        super(message);
+        this.error = event ?? undefined;
+    }
+}
+exports.WebSocketError = WebSocketError;
+WebSocketError.prototype.name = 'WebSocketError';
+class LiveEmitter extends EventEmitter_1.EventEmitter {
+    _onError(event, message, cause) {
+        message = message ?? safeJSONStringify(event) ?? 'unknown error';
+        if (!this._hasListener('error')) {
+            const error = new WebSocketError(message +
+                "\n\nTo resolve these unhandled rejection errors you should bind an `error` callback, e.g. `ws.on('error', (error) => ...)` ", event);
+            error.cause = cause;
+            Promise.reject(error);
+            return;
+        }
+        const error = new WebSocketError(message, event);
+        error.cause = cause;
+        this._emit('error', error);
+    }
+    _emit(event, ...args) {
+        super._emit(event, ...args);
+    }
+}
+exports.LiveEmitter = LiveEmitter;
+function buildURL(client, parameters) {
+    const { ...query } = parameters;
+    const endpoint = (0, path_1.path) `/v1/live`;
+    const url = new URL(client.buildURL(endpoint, query, undefined));
+    url.protocol = url.protocol === 'http:' || url.protocol === 'ws:' ? 'ws:' : 'wss:';
+    return url;
+}
+function parameterHeaders(parameters) {
+    const headers = {};
+    return headers;
+}
+function safeJSONStringify(value) {
+    try {
+        return JSON.stringify(value);
+    }
+    catch {
+        return null;
+    }
+}
+//# sourceMappingURL=internal-base.js.map

package/dist/cjs/resources/live/internal-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"internal-base.js","sourceRoot":"","sources":["../../../../src/resources/live/internal-base.ts"],"names":[],"mappings":";AAAA,6EAA6E;;;AAyF7E,4BAMC;AAED,4CAGC;AAlGD,oDAAiE;AAGjE,0DAA6E;AAC7E,uCAAyC;AAgBzC,MAAa,cAAe,SAAQ,kBAAU;IAC5C,KAAK,CAAgC;IAErC,YAAY,OAAe,EAAE,KAA8B;QACzD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,KAAK,GAAG,KAAK,IAAI,SAAS,CAAC;IAClC,CAAC;CACF;AAPD,wCAOC;AAED,cAAc,CAAC,SAAS,CAAC,IAAI,GAAG,gBAAgB,CAAC;AAmBjD,MAAsB,WAAY,SAAQ,2BAA6B;IAY3D,QAAQ,CAAC,KAA8B,EAAE,OAA4B,EAAE,KAAe;QAC9F,OAAO,GAAG,OAAO,IAAI,iBAAiB,CAAC,KAAK,CAAC,IAAI,eAAe,CAAC;QAEjE,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,IAAI,cAAc,CAC9B,OAAO;gBACL,6HAA6H,EAC/H,KAAK,CACN,CAAC;YACD,KAAqC,CAAC,KAAK,GAAG,KAAK,CAAC;YACrD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,OAAO;QACT,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAChD,KAAqC,CAAC,KAAK,GAAG,KAAK,CAAC;QACrD,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEM,KAAK,CACV,KAAY,EACZ,GAAG,IAA6C;QAEhD,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IAC9B,CAAC;CACF;AArCD,kCAqCC;AAED,SAAgB,QAAQ,CAAC,MAAa,EAAE,UAAmC;IACzE,MAAM,EAAE,GAAG,KAAK,EAAE,GAAG,UAAU,CAAC;IAChC,MAAM,QAAQ,GAAG,IAAA,WAAY,EAAA,UAAU,CAAC;IACxC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,EAAE,SAAS,CAAC,CAAC,CAAC;IACjE,GAAG,CAAC,QAAQ,GAAG,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,GAAG,CAAC,QAAQ,KAAK,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC;IACnF,OAAO,GAAG,CAAC;AACb,CAAC;AAED,SAAgB,gBAAgB,CAAC,UAAmC;IAClE,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAc;IACvC,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/cjs/resources/live/live.d.ts

@@ -0,0 +1,54 @@
+import { APIResource } from '../../resource';
+import { APIPromise } from '../../api-promise';
+import type { RequestOptions } from '../../internal/request-options';
+import { LiveWS, type LiveWSClientOptions } from './ws';
+export declare class Live extends APIResource {
+    /**
+     * Issue a 30-second WebSocket ticket for one live connection that multiplexes resource subscriptions.
+     *
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<LiveAuthorizeResponse>} Connection ticket
+     *
+     * @example
+     * ```ts
+     * const live = await client.live.authorize();
+     * ```
+     */
+    authorize(options?: RequestOptions): APIPromise<LiveAuthorizeResponse>;
+    /**
+     * Native WebSocket. Send `{ op: "subscribe", id, resource, input }`, `{ op: "unsubscribe", id }`, or `{ op: "ping" }`; receive `{ id, type: "ready" | "event" | "error" }` or `{ type: "pong" }`.
+     *
+     * @param {LiveConnectParams} params - The parameters to send with the request.
+     * @param {LiveWSClientOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {LiveWS} Authorized native WebSocket
+     *
+     * @example
+     * ```ts
+     * const connection = client.live.connect({
+     *   ticket: 'ticket',
+     * });
+     *
+     * try {
+     *   for await (const message of connection) {
+     *     console.log(message);
+     *   }
+     * } finally {
+     *   connection.close();
+     * }
+     * ```
+     */
+    connect(params: LiveConnectParams, options?: LiveWSClientOptions): LiveWS;
+}
+export interface LiveAuthorizeResponse {
+    ticket: string;
+}
+export interface LiveConnectParams {
+    /**
+     * @minLength 1
+     */
+    ticket: string;
+}
+export declare namespace Live {
+    export { type LiveAuthorizeResponse as LiveAuthorizeResponse, type LiveConnectParams as LiveConnectParams };
+}
+//# sourceMappingURL=live.d.ts.map

package/dist/cjs/resources/live/live.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"live.d.ts","sourceRoot":"","sources":["../../../../src/resources/live/live.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AACrE,OAAO,EAAE,MAAM,EAAE,KAAK,mBAAmB,EAAE,MAAM,MAAM,CAAC;AAExD,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAItE;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,MAAM,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,MAAM;CAI1E;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AACD,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EAAE,KAAK,qBAAqB,IAAI,qBAAqB,EAAE,KAAK,iBAAiB,IAAI,iBAAiB,EAAE,CAAC;CAC7G"}

package/dist/cjs/resources/live/live.js

@@ -0,0 +1,50 @@
+"use strict";
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Live = void 0;
+const resource_1 = require("../../resource");
+const ws_1 = require("./ws");
+class Live extends resource_1.APIResource {
+    /**
+     * Issue a 30-second WebSocket ticket for one live connection that multiplexes resource subscriptions.
+     *
+     * @param {RequestOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {APIPromise<LiveAuthorizeResponse>} Connection ticket
+     *
+     * @example
+     * ```ts
+     * const live = await client.live.authorize();
+     * ```
+     */
+    authorize(options) {
+        return this._client.post('/v1/live', options);
+    }
+    /**
+     * Native WebSocket. Send `{ op: "subscribe", id, resource, input }`, `{ op: "unsubscribe", id }`, or `{ op: "ping" }`; receive `{ id, type: "ready" | "event" | "error" }` or `{ type: "pong" }`.
+     *
+     * @param {LiveConnectParams} params - The parameters to send with the request.
+     * @param {LiveWSClientOptions} [options] - Options to apply to the request, such as headers and an abort signal.
+     * @returns {LiveWS} Authorized native WebSocket
+     *
+     * @example
+     * ```ts
+     * const connection = client.live.connect({
+     *   ticket: 'ticket',
+     * });
+     *
+     * try {
+     *   for await (const message of connection) {
+     *     console.log(message);
+     *   }
+     * } finally {
+     *   connection.close();
+     * }
+     * ```
+     */
+    connect(params, options) {
+        const { ticket } = params;
+        return new ws_1.LiveWS(this._client, { ticket: ticket }, options);
+    }
+}
+exports.Live = Live;
+//# sourceMappingURL=live.js.map

package/dist/cjs/resources/live/live.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"live.js","sourceRoot":"","sources":["../../../../src/resources/live/live.ts"],"names":[],"mappings":";AAAA,6EAA6E;;;AAE7E,6CAA6C;AAG7C,6BAAwD;AAExD,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,OAAwB;QAChC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,CAAC,MAAyB,EAAE,OAA6B;QAC9D,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC;QAC1B,OAAO,IAAI,WAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;CACF;AA1CD,oBA0CC"}

package/dist/cjs/resources/live/ws-base.d.ts

@@ -0,0 +1,57 @@
+import { LiveEmitter, LiveStreamMessage } from './internal-base';
+import { type WebSocketLike } from '../../internal/ws-adapter';
+import { type RawWebSocketData, type ReconnectingEvent, type ReconnectingOverrides } from '../../internal/ws';
+import { Tembo } from '../../client';
+export interface LiveWSParameters extends Record<string, unknown> {
+    ticket: string;
+}
+export interface LiveWSReconnectOptions {
+    /** Called before each reconnect attempt. */
+    onReconnecting(event: ReconnectingEvent<LiveWSParameters>): ReconnectingOverrides<LiveWSParameters> | void;
+    /** Maximum number of reconnection attempts. Default: 5. Set to 0 to disable reconnection. */
+    maxRetries?: number;
+    /** Initial backoff delay in milliseconds. Default: 500. */
+    initialDelay?: number;
+    /** Maximum backoff delay in milliseconds. Default: 8000. */
+    maxDelay?: number;
+}
+export interface LiveWSBaseOptions {
+    /** Options for automatic reconnection on recoverable close codes. */
+    reconnect?: LiveWSReconnectOptions | null | undefined;
+    /** Maximum size of the outgoing message queue in bytes. Default: 1 MB. */
+    maxQueueSize?: number | undefined;
+}
+export declare abstract class LiveWSBase<TSocket extends WebSocketLike> extends LiveEmitter {
+    url: URL;
+    socket: TSocket;
+    protected _client: Tembo;
+    protected _parameters: LiveWSParameters | null | undefined;
+    private _reconnectOptions;
+    private _sendQueue;
+    private _isReconnecting;
+    private _intentionallyClosed;
+    private _closeCode;
+    private _closeReason;
+    private _lastCloseCode;
+    private _lastCloseReason;
+    private _internalEvents;
+    constructor(client: Tembo, parameters: LiveWSParameters, options?: LiveWSBaseOptions | undefined);
+    protected _connectInitial(): void;
+    protected abstract _createSocket(url: URL, authHeaders: Record<string, string>): TSocket;
+    send(event: unknown): void;
+    sendRaw(data: RawWebSocketData): void;
+    close(props?: {
+        code: number;
+        reason: string;
+    }): void;
+    stream(): AsyncIterableIterator<LiveStreamMessage>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<LiveStreamMessage>;
+    private _connect;
+    private _canReconnect;
+    private _reconnect;
+    private _awaitOpen;
+    private _flushSendQueue;
+    private _emitPermanentClose;
+    protected _authHeaders(): Record<string, string>;
+}
+//# sourceMappingURL=ws-base.d.ts.map

package/dist/cjs/resources/live/ws-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ws-base.d.ts","sourceRoot":"","sources":["../../../../src/resources/live/ws-base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,iBAAiB,EAA8C,MAAM,iBAAiB,CAAC;AAG7G,OAAO,EAAE,KAAK,aAAa,EAAc,MAAM,2BAA2B,CAAC;AAC3E,OAAO,EAIL,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,qBAAqB,EAE3B,MAAM,mBAAmB,CAAC;AAE3B,OAAO,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAGrC,MAAM,WAAW,gBAAiB,SAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAC/D,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,sBAAsB;IACrC,4CAA4C;IAC5C,cAAc,CAAC,KAAK,EAAE,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,qBAAqB,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IAC3G,6FAA6F;IAC7F,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,qEAAqE;IACrE,SAAS,CAAC,EAAE,sBAAsB,GAAG,IAAI,GAAG,SAAS,CAAC;IACtD,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,8BAAsB,UAAU,CAAC,OAAO,SAAS,aAAa,CAAE,SAAQ,WAAW;IACjF,GAAG,EAAG,GAAG,CAAC;IACV,MAAM,EAAG,OAAO,CAAC;IAEjB,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC;IACzB,SAAS,CAAC,WAAW,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC;IAC3D,OAAO,CAAC,iBAAiB,CAAgC;IACzD,OAAO,CAAC,UAAU,CAAqB;IACvC,OAAO,CAAC,eAAe,CAAS;IAChC,OAAO,CAAC,oBAAoB,CAAS;IACrC,OAAO,CAAC,UAAU,CAAQ;IAC1B,OAAO,CAAC,YAAY,CAAQ;IAC5B,OAAO,CAAC,cAAc,CAAQ;IAC9B,OAAO,CAAC,gBAAgB,CAAM;IAC9B,OAAO,CAAC,eAAe,CAKlB;gBAEO,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,gBAAgB,EAAE,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS;IAQhG,SAAS,CAAC,eAAe,IAAI,IAAI;IAKjC,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,OAAO,GAAG,IAAI;IAiB1B,OAAO,CAAC,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAiBrC,KAAK,CAAC,KAAK,CAAC,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,IAAI;IAWrD,MAAM,IAAI,qBAAqB,CAAC,iBAAiB,CAAC;IAIlD,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,iBAAiB,CAAC;IA4FlE,OAAO,CAAC,QAAQ;IAgChB,OAAO,CAAC,aAAa;YAWP,UAAU;IAyFxB,OAAO,CAAC,UAAU;IAyBlB,OAAO,CAAC,eAAe;IAQvB,OAAO,CAAC,mBAAmB;IAQ3B,SAAS,CAAC,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;CAGjD"}

package/dist/cjs/resources/live/ws-base.js

@@ -0,0 +1,359 @@
+"use strict";
+// File generated from our OpenAPI spec by Scalar. See README.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveWSBase = void 0;
+const internal_base_1 = require("./internal-base");
+const EventEmitter_1 = require("../../core/EventEmitter");
+const sleep_1 = require("../../internal/utils/sleep");
+const ws_adapter_1 = require("../../internal/ws-adapter");
+const ws_1 = require("../../internal/ws");
+class LiveWSBase extends internal_base_1.LiveEmitter {
+    url;
+    socket;
+    _client;
+    _parameters;
+    _reconnectOptions;
+    _sendQueue;
+    _isReconnecting = false;
+    _intentionallyClosed = false;
+    _closeCode = 1000;
+    _closeReason = 'OK';
+    _lastCloseCode = 1006;
+    _lastCloseReason = '';
+    _internalEvents = new EventEmitter_1.InternalEventEmitter();
+    constructor(client, parameters, options) {
+        super();
+        this._client = client;
+        this._parameters = parameters ?? undefined;
+        this._reconnectOptions = options?.reconnect ?? null;
+        this._sendQueue = new ws_1.SendQueue(options?.maxQueueSize);
+    }
+    _connectInitial() {
+        this.url = (0, internal_base_1.buildURL)(this._client, this._parameters ?? {});
+        this.socket = this._connect();
+    }
+    send(event) {
+        if (this._isReconnecting || this.socket.readyState === ws_adapter_1.ReadyState.CONNECTING) {
+            if (!this._sendQueue.enqueue(event))
+                this._onError(null, 'send queue is full, message discarded', undefined);
+            return;
+        }
+        if (this.socket.readyState !== ws_adapter_1.ReadyState.OPEN) {
+            this._onError(null, 'cannot send on a closed WebSocket', undefined);
+            return;
+        }
+        try {
+            this.socket.send(JSON.stringify(event));
+        }
+        catch (err) {
+            this._onError(null, 'could not send data', err);
+        }
+    }
+    sendRaw(data) {
+        if (this._isReconnecting || this.socket.readyState === ws_adapter_1.ReadyState.CONNECTING) {
+            if (!this._sendQueue.enqueueRaw(data))
+                this._onError(null, 'send queue is full, message discarded', undefined);
+            return;
+        }
+        if (this.socket.readyState !== ws_adapter_1.ReadyState.OPEN) {
+            this._onError(null, 'cannot send on a closed WebSocket', undefined);
+            return;
+        }
+        try {
+            this.socket.send((0, ws_1.flattenRawData)(data));
+        }
+        catch (err) {
+            this._onError(null, 'could not send data', err);
+        }
+    }
+    close(props) {
+        this._intentionallyClosed = true;
+        this._closeCode = props?.code ?? 1000;
+        this._closeReason = props?.reason ?? 'OK';
+        try {
+            this.socket.close(this._closeCode, this._closeReason);
+        }
+        catch (err) {
+            this._onError(null, 'could not close the connection', err);
+        }
+    }
+    stream() {
+        return this[Symbol.asyncIterator]();
+    }
+    [Symbol.asyncIterator]() {
+        const queue = [];
+        const resolvers = [];
+        let done = false;
+        let currentSocket = this.socket;
+        const push = (msg) => {
+            queue.push(msg);
+            resolvers.shift()?.();
+        };
+        const flushResolvers = () => {
+            for (let resolver = resolvers.shift(); resolver; resolver = resolvers.shift())
+                resolver();
+        };
+        const cleanup = () => {
+            this.off('event', onEvent);
+            this.off('raw', onRaw);
+            this.off('error', onEmitterError);
+            currentSocket.off('open', onOpen);
+            this._internalEvents.off('close', onClose);
+            this._internalEvents.off('socketSwap', onSocketSwap);
+            this._internalEvents.off('reconnecting', onReconnecting);
+            this._internalEvents.off('reconnected', onReconnected);
+        };
+        const onEvent = (event) => {
+            if (!isErrorEvent(event))
+                push({ type: 'message', message: event });
+        };
+        const onRaw = (data) => push({ type: 'raw', data });
+        const onEmitterError = (error) => push({ type: 'error', error });
+        const onOpen = () => push({ type: 'open' });
+        const onReconnecting = (event) => push({ type: 'reconnecting', reconnect: event });
+        const onReconnected = () => push({ type: 'reconnected' });
+        const onClose = (code, reason, unsent) => {
+            push({ type: 'close', code, reason, unsent });
+            done = true;
+            flushResolvers();
+            cleanup();
+        };
+        const onSocketSwap = (oldSocket, newSocket) => {
+            oldSocket.off('open', onOpen);
+            newSocket.on('open', onOpen);
+            currentSocket = newSocket;
+        };
+        this.on('event', onEvent);
+        this.on('raw', onRaw);
+        this.on('error', onEmitterError);
+        this.socket.on('open', onOpen);
+        this._internalEvents.on('close', onClose);
+        this._internalEvents.on('socketSwap', onSocketSwap);
+        this._internalEvents.on('reconnecting', onReconnecting);
+        this._internalEvents.on('reconnected', onReconnected);
+        if (this._isReconnecting)
+            push({
+                type: 'reconnecting',
+                reconnect: { attempt: 0, maxAttempts: 0, delay: 0, closeCode: 0, parameters: undefined },
+            });
+        else if (this.socket.readyState === ws_adapter_1.ReadyState.CONNECTING)
+            push({ type: 'connecting' });
+        else if (this.socket.readyState === ws_adapter_1.ReadyState.OPEN)
+            push({ type: 'open' });
+        else if (this.socket.readyState === ws_adapter_1.ReadyState.CLOSING)
+            push({ type: 'closing' });
+        else {
+            push({
+                type: 'close',
+                code: this._lastCloseCode,
+                reason: this._lastCloseReason,
+                unsent: this._sendQueue.drain(),
+            });
+            done = true;
+            cleanup();
+        }
+        const next = () => new Promise((resolve) => {
+            if (queue.length > 0)
+                resolve({ value: queue.shift(), done: false });
+            else if (done)
+                resolve({ value: undefined, done: true });
+            else
+                resolvers.push(() => {
+                    if (queue.length > 0)
+                        resolve({ value: queue.shift(), done: false });
+                    else
+                        resolve({ value: undefined, done: true });
+                });
+        });
+        return {
+            next,
+            return: () => {
+                done = true;
+                cleanup();
+                flushResolvers();
+                return Promise.resolve({ value: undefined, done: true });
+            },
+            [Symbol.asyncIterator]() {
+                return this;
+            },
+        };
+    }
+    _connect() {
+        this.url = (0, internal_base_1.buildURL)(this._client, this._parameters ?? {});
+        const socket = this._createSocket(this.url, this._authHeaders());
+        socket.on('message', (data, isBinary) => {
+            if (isBinary) {
+                this._emit('raw', data);
+                return;
+            }
+            const text = typeof data === 'string' ? data : String(data);
+            let event;
+            try {
+                event = JSON.parse(text);
+            }
+            catch {
+                this._emit('raw', data);
+                return;
+            }
+            this._emit('event', event);
+            if (isErrorEvent(event))
+                this._onError(event);
+            else
+                emitTypedEvent(this, event);
+        });
+        socket.on('error', (err) => {
+            if (!this._isReconnecting)
+                this._onError(null, err.message, err);
+        });
+        socket.on('open', () => this._flushSendQueue());
+        socket.on('close', (code, reason) => {
+            if (socket !== this.socket)
+                return;
+            if (!this._intentionallyClosed && this._canReconnect(code))
+                this._reconnect(code);
+            else if (!this._isReconnecting)
+                this._emitPermanentClose(code, reason);
+        });
+        return socket;
+    }
+    _canReconnect(code) {
+        if (this._intentionallyClosed ||
+            !this._reconnectOptions ||
+            this._reconnectOptions.maxRetries === 0 ||
+            !this._reconnectOptions.onReconnecting)
+            return false;
+        return (0, ws_1.isRecoverableClose)(code);
+    }
+    async _reconnect(closeCode) {
+        if (this._isReconnecting || !this._reconnectOptions)
+            return;
+        this._isReconnecting = true;
+        const maxRetries = this._reconnectOptions.maxRetries ?? 5;
+        const initialDelay = this._reconnectOptions.initialDelay ?? 500;
+        const maxDelay = this._reconnectOptions.maxDelay ?? 8000;
+        for (let attempt = 1; attempt <= maxRetries; attempt++) {
+            if (!this._canReconnect(closeCode)) {
+                this._isReconnecting = false;
+                this._emitPermanentClose(this._intentionallyClosed ? this._closeCode : closeCode, this._intentionallyClosed ? this._closeReason : 'reconnect aborted');
+                return;
+            }
+            const delay = Math.round(Math.min(initialDelay * 2 ** (attempt - 1), maxDelay) * (0.75 + Math.random() * 0.25));
+            let reconnectingEvent = {
+                attempt,
+                maxAttempts: maxRetries,
+                delay,
+                closeCode,
+                parameters: this._parameters ? { ...this._parameters } : undefined,
+            };
+            let overrides;
+            try {
+                overrides = this._reconnectOptions.onReconnecting(reconnectingEvent);
+            }
+            catch (err) {
+                this._isReconnecting = false;
+                this._onError(null, 'onReconnecting callback threw', err);
+                this._emitPermanentClose(closeCode, 'onReconnecting callback threw');
+                return;
+            }
+            if (overrides && 'abort' in overrides && overrides.abort) {
+                this._isReconnecting = false;
+                this._emitPermanentClose(closeCode, 'reconnect aborted by handler');
+                return;
+            }
+            if (overrides && 'parameters' in overrides) {
+                this._parameters = overrides.parameters;
+                reconnectingEvent = { ...reconnectingEvent, parameters: this._parameters };
+            }
+            this._emit('reconnecting', reconnectingEvent);
+            this._internalEvents._emit('reconnecting', reconnectingEvent);
+            if (!this._canReconnect(closeCode)) {
+                this._isReconnecting = false;
+                this._emitPermanentClose(this._intentionallyClosed ? this._closeCode : closeCode, this._intentionallyClosed ? this._closeReason : 'reconnect aborted');
+                return;
+            }
+            await (0, sleep_1.sleep)(delay);
+            if (!this._canReconnect(closeCode)) {
+                this._isReconnecting = false;
+                this._emitPermanentClose(this._intentionallyClosed ? this._closeCode : closeCode, this._intentionallyClosed ? this._closeReason : 'reconnect aborted');
+                return;
+            }
+            let closeCodePromise;
+            try {
+                const oldSocket = this.socket;
+                this.socket = this._connect();
+                closeCodePromise = new Promise((resolve) => {
+                    this.socket.once('close', resolve);
+                });
+                await this._awaitOpen(this.socket);
+                this._internalEvents._emit('socketSwap', oldSocket, this.socket);
+                this._isReconnecting = false;
+                this._flushSendQueue();
+                this._emit('reconnected');
+                this._internalEvents._emit('reconnected');
+                return;
+            }
+            catch {
+                if (closeCodePromise)
+                    closeCode = await closeCodePromise;
+            }
+        }
+        this._isReconnecting = false;
+        this._onError(null, `WebSocket reconnect failed after ${maxRetries} attempts (close code: ${closeCode})`, undefined);
+        this._emitPermanentClose(closeCode, `reconnect failed after ${maxRetries} attempts`);
+    }
+    _awaitOpen(socket) {
+        return new Promise((resolve, reject) => {
+            const cleanup = () => {
+                socket.off('open', onOpen);
+                socket.off('error', onError);
+                socket.off('close', onFail);
+            };
+            const onOpen = () => {
+                cleanup();
+                resolve();
+            };
+            const onError = (err) => {
+                cleanup();
+                reject(err);
+            };
+            const onFail = () => {
+                cleanup();
+                reject(new Error('socket closed before open'));
+            };
+            socket.once('open', onOpen);
+            socket.once('error', onError);
+            socket.once('close', onFail);
+        });
+    }
+    _flushSendQueue() {
+        try {
+            this._sendQueue.flush((data) => this.socket.send((0, ws_1.flattenRawData)(data)));
+        }
+        catch (err) {
+            this._onError(null, 'could not send queued data', err);
+        }
+    }
+    _emitPermanentClose(code, reason) {
+        this._lastCloseCode = code;
+        this._lastCloseReason = reason;
+        const unsent = this._sendQueue.drain();
+        this._internalEvents._emit('close', code, reason, unsent);
+        this._emit('close', code, reason, unsent);
+    }
+    _authHeaders() {
+        return { ...this._client.webSocketAuthHeaders(), ...(0, internal_base_1.parameterHeaders)(this._parameters ?? {}) };
+    }
+}
+exports.LiveWSBase = LiveWSBase;
+const isErrorEvent = (event) => typeof event === 'object' && event !== null && 'type' in event && event.type === 'error';
+const emitTypedEvent = (emitter, event) => {
+    // `/v1/live` frames use `type: 'event'`, which `_connect` has already emitted on the `event` channel.
+    if (typeof event === 'object' &&
+        event !== null &&
+        'type' in event &&
+        typeof event.type === 'string' &&
+        event.type !== 'event') {
+        emitter._emit(event.type, event);
+    }
+};
+//# sourceMappingURL=ws-base.js.map