@supabase/realtime-js 2.71.2-canary.29 → 2.71.2-canary.3

package/dist/module/RealtimeClient.d.ts

@@ -1,196 +0,0 @@
-import { WebSocketLike } from './lib/websocket-factory';
-import { CONNECTION_STATE } from './lib/constants';
-import Serializer from './lib/serializer';
-import Timer from './lib/timer';
-import RealtimeChannel from './RealtimeChannel';
-import type { RealtimeChannelOptions } from './RealtimeChannel';
-type Fetch = typeof fetch;
-export type Channel = {
-    name: string;
-    inserted_at: string;
-    updated_at: string;
-    id: number;
-};
-export type LogLevel = 'info' | 'warn' | 'error';
-export type RealtimeMessage = {
-    topic: string;
-    event: string;
-    payload: any;
-    ref: string;
-    join_ref?: string;
-};
-export type RealtimeRemoveChannelResponse = 'ok' | 'timed out' | 'error';
-export type HeartbeatStatus = 'sent' | 'ok' | 'error' | 'timeout' | 'disconnected';
-export interface WebSocketLikeConstructor {
-    new (address: string | URL, subprotocols?: string | string[] | undefined): WebSocketLike;
-    [key: string]: any;
-}
-export interface WebSocketLikeError {
-    error: any;
-    message: string;
-    type: string;
-}
-export type RealtimeClientOptions = {
-    transport?: WebSocketLikeConstructor;
-    timeout?: number;
-    heartbeatIntervalMs?: number;
-    logger?: Function;
-    encode?: Function;
-    decode?: Function;
-    reconnectAfterMs?: Function;
-    headers?: {
-        [key: string]: string;
-    };
-    params?: {
-        [key: string]: any;
-    };
-    log_level?: LogLevel;
-    logLevel?: LogLevel;
-    fetch?: Fetch;
-    worker?: boolean;
-    workerUrl?: string;
-    accessToken?: () => Promise<string | null>;
-};
-export default class RealtimeClient {
-    accessTokenValue: string | null;
-    apiKey: string | null;
-    channels: RealtimeChannel[];
-    endPoint: string;
-    httpEndpoint: string;
-    /** @deprecated headers cannot be set on websocket connections */
-    headers?: {
-        [key: string]: string;
-    };
-    params?: {
-        [key: string]: string;
-    };
-    timeout: number;
-    transport: WebSocketLikeConstructor | null;
-    heartbeatIntervalMs: number;
-    heartbeatTimer: ReturnType<typeof setInterval> | undefined;
-    pendingHeartbeatRef: string | null;
-    heartbeatCallback: (status: HeartbeatStatus) => void;
-    ref: number;
-    reconnectTimer: Timer | null;
-    logger: Function;
-    logLevel?: LogLevel;
-    encode: Function;
-    decode: Function;
-    reconnectAfterMs: Function;
-    conn: WebSocketLike | null;
-    sendBuffer: Function[];
-    serializer: Serializer;
-    stateChangeCallbacks: {
-        open: Function[];
-        close: Function[];
-        error: Function[];
-        message: Function[];
-    };
-    fetch: Fetch;
-    accessToken: (() => Promise<string | null>) | null;
-    worker?: boolean;
-    workerUrl?: string;
-    workerRef?: Worker;
-    private _connectionState;
-    private _wasManualDisconnect;
-    private _authPromise;
-    /**
-     * Initializes the Socket.
-     *
-     * @param endPoint The string WebSocket endpoint, ie, "ws://example.com/socket", "wss://example.com", "/socket" (inherited host & protocol)
-     * @param httpEndpoint The string HTTP endpoint, ie, "https://example.com", "/" (inherited host & protocol)
-     * @param options.transport The Websocket Transport, for example WebSocket. This can be a custom implementation
-     * @param options.timeout The default timeout in milliseconds to trigger push timeouts.
-     * @param options.params The optional params to pass when connecting.
-     * @param options.headers Deprecated: headers cannot be set on websocket connections and this option will be removed in the future.
-     * @param options.heartbeatIntervalMs The millisec interval to send a heartbeat message.
-     * @param options.logger The optional function for specialized logging, ie: logger: (kind, msg, data) => { console.log(`${kind}: ${msg}`, data) }
-     * @param options.logLevel Sets the log level for Realtime
-     * @param options.encode The function to encode outgoing messages. Defaults to JSON: (payload, callback) => callback(JSON.stringify(payload))
-     * @param options.decode The function to decode incoming messages. Defaults to Serializer's decode.
-     * @param options.reconnectAfterMs he optional function that returns the millsec reconnect interval. Defaults to stepped backoff off.
-     * @param options.worker Use Web Worker to set a side flow. Defaults to false.
-     * @param options.workerUrl The URL of the worker script. Defaults to https://realtime.supabase.com/worker.js that includes a heartbeat event call to keep the connection alive.
-     */
-    constructor(endPoint: string, options?: RealtimeClientOptions);
-    /**
-     * Connects the socket, unless already connected.
-     */
-    connect(): void;
-    /**
-     * Returns the URL of the websocket.
-     * @returns string The URL of the websocket.
-     */
-    endpointURL(): string;
-    /**
-     * Disconnects the socket.
-     *
-     * @param code A numeric status code to send on disconnect.
-     * @param reason A custom reason for the disconnect.
-     */
-    disconnect(code?: number, reason?: string): void;
-    /**
-     * Returns all created channels
-     */
-    getChannels(): RealtimeChannel[];
-    /**
-     * Unsubscribes and removes a single channel
-     * @param channel A RealtimeChannel instance
-     */
-    removeChannel(channel: RealtimeChannel): Promise<RealtimeRemoveChannelResponse>;
-    /**
-     * Unsubscribes and removes all channels
-     */
-    removeAllChannels(): Promise<RealtimeRemoveChannelResponse[]>;
-    /**
-     * Logs the message.
-     *
-     * For customized logging, `this.logger` can be overridden.
-     */
-    log(kind: string, msg: string, data?: any): void;
-    /**
-     * Returns the current state of the socket.
-     */
-    connectionState(): CONNECTION_STATE;
-    /**
-     * Returns `true` is the connection is open.
-     */
-    isConnected(): boolean;
-    /**
-     * Returns `true` if the connection is currently connecting.
-     */
-    isConnecting(): boolean;
-    /**
-     * Returns `true` if the connection is currently disconnecting.
-     */
-    isDisconnecting(): boolean;
-    channel(topic: string, params?: RealtimeChannelOptions): RealtimeChannel;
-    /**
-     * Push out a message if the socket is connected.
-     *
-     * If the socket is not connected, the message gets enqueued within a local buffer, and sent out when a connection is next established.
-     */
-    push(data: RealtimeMessage): void;
-    /**
-     * Sets the JWT access token used for channel subscription authorization and Realtime RLS.
-     *
-     * If param is null it will use the `accessToken` callback function or the token set on the client.
-     *
-     * On callback used, it will set the value of the token internal to the client.
-     *
-     * @param token A JWT string to override the token set on the client.
-     */
-    setAuth(token?: string | null): Promise<void>;
-    /**
-     * Sends a heartbeat message if the socket is connected.
-     */
-    sendHeartbeat(): Promise<void>;
-    onHeartbeat(callback: (status: HeartbeatStatus) => void): void;
-    /**
-     * Flushes send buffer
-     */
-    flushSendBuffer(): void;
-    private _workerObjectUrl;
-}
-export {};
-//# sourceMappingURL=RealtimeClient.d.ts.map

package/dist/module/RealtimeClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"RealtimeClient.d.ts","sourceRoot":"","sources":["../../src/RealtimeClient.ts"],"names":[],"mappings":"AAAA,OAAyB,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAA;AAEzE,OAAO,EAEL,gBAAgB,EAOjB,MAAM,iBAAiB,CAAA;AAExB,OAAO,UAAU,MAAM,kBAAkB,CAAA;AACzC,OAAO,KAAK,MAAM,aAAa,CAAA;AAG/B,OAAO,eAAe,MAAM,mBAAmB,CAAA;AAC/C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,mBAAmB,CAAA;AAE/D,KAAK,KAAK,GAAG,OAAO,KAAK,CAAA;AAEzB,MAAM,MAAM,OAAO,GAAG;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;IAClB,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AACD,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;AAEhD,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,GAAG,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG,IAAI,GAAG,WAAW,GAAG,OAAO,CAAA;AACxE,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,CAAA;AAgBlF,MAAM,WAAW,wBAAwB;IACvC,KAAK,OAAO,EAAE,MAAM,GAAG,GAAG,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GAAG,aAAa,CAAA;IAExF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,GAAG,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,qBAAqB,GAAG;IAClC,SAAS,CAAC,EAAE,wBAAwB,CAAA;IACpC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,MAAM,CAAC,EAAE,QAAQ,CAAA;IACjB,MAAM,CAAC,EAAE,QAAQ,CAAA;IACjB,MAAM,CAAC,EAAE,QAAQ,CAAA;IACjB,gBAAgB,CAAC,EAAE,QAAQ,CAAA;IAC3B,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IACnC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAA;IAE/B,SAAS,CAAC,EAAE,QAAQ,CAAA;IACpB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,KAAK,CAAC,EAAE,KAAK,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,WAAW,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAA;CAC3C,CAAA;AASD,MAAM,CAAC,OAAO,OAAO,cAAc;IACjC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAO;IACtC,MAAM,EAAE,MAAM,GAAG,IAAI,CAAO;IAC5B,QAAQ,EAAE,eAAe,EAAE,CAAc;IACzC,QAAQ,EAAE,MAAM,CAAK;IACrB,YAAY,EAAE,MAAM,CAAK;IACzB,iEAAiE;IACjE,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAK;IACxC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAK;IACvC,OAAO,EAAE,MAAM,CAAkB;IACjC,SAAS,EAAE,wBAAwB,GAAG,IAAI,CAAO;IACjD,mBAAmB,EAAE,MAAM,CAAyC;IACpE,cAAc,EAAE,UAAU,CAAC,OAAO,WAAW,CAAC,GAAG,SAAS,CAAY;IACtE,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAO;IACzC,iBAAiB,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,CAAO;IAC3D,GAAG,EAAE,MAAM,CAAI;IACf,cAAc,EAAE,KAAK,GAAG,IAAI,CAAO;IACnC,MAAM,EAAE,QAAQ,CAAO;IACvB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,MAAM,EAAG,QAAQ,CAAA;IACjB,MAAM,EAAG,QAAQ,CAAA;IACjB,gBAAgB,EAAG,QAAQ,CAAA;IAC3B,IAAI,EAAE,aAAa,GAAG,IAAI,CAAO;IACjC,UAAU,EAAE,QAAQ,EAAE,CAAK;IAC3B,UAAU,EAAE,UAAU,CAAmB;IACzC,oBAAoB,EAAE;QACpB,IAAI,EAAE,QAAQ,EAAE,CAAA;QAChB,KAAK,EAAE,QAAQ,EAAE,CAAA;QACjB,KAAK,EAAE,QAAQ,EAAE,CAAA;QACjB,OAAO,EAAE,QAAQ,EAAE,CAAA;KACpB,CAKA;IACD,KAAK,EAAE,KAAK,CAAA;IACZ,WAAW,EAAE,CAAC,MAAM,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAO;IACzD,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,gBAAgB,CAAsC;IAC9D,OAAO,CAAC,oBAAoB,CAAiB;IAC7C,OAAO,CAAC,YAAY,CAA6B;IAEjD;;;;;;;;;;;;;;;;;OAiBG;gBACS,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,qBAAqB;IAgB7D;;OAEG;IACH,OAAO,IAAI,IAAI;IA8Cf;;;OAGG;IACH,WAAW,IAAI,MAAM;IAIrB;;;;;OAKG;IACH,UAAU,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI;IA+BhD;;OAEG;IACH,WAAW,IAAI,eAAe,EAAE;IAIhC;;;OAGG;IACG,aAAa,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,6BAA6B,CAAC;IAUrF;;OAEG;IACG,iBAAiB,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;IAOnE;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,GAAG;IAIzC;;OAEG;IACH,eAAe,IAAI,gBAAgB;IAanC;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;OAEG;IACH,YAAY,IAAI,OAAO;IAIvB;;OAEG;IACH,eAAe,IAAI,OAAO;IAI1B,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,GAAE,sBAAuC,GAAG,eAAe;IAcxF;;;;OAIG;IACH,IAAI,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI;IAejC;;;;;;;;OAQG;IACG,OAAO,CAAC,KAAK,GAAE,MAAM,GAAG,IAAW,GAAG,OAAO,CAAC,IAAI,CAAC;IAQzD;;OAEG;IACG,aAAa;IAqCnB,WAAW,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,eAAe,KAAK,IAAI,GAAG,IAAI;IAG9D;;OAEG;IACH,eAAe;IAmPf,OAAO,CAAC,gBAAgB;CA6JzB"}