@mswjs/interceptors/lib/browser/interceptors/WebSocket/index.d.ts

Low-level HTTP/HTTPS/XHR/fetch request interception library.

import { I as Interceptor } from '../../Interceptor-af98b768.js';
import '@open-draft/logger';
import 'strict-event-emitter';

declare const kCancelable: unique symbol;
declare const kDefaultPrevented: unique symbol;
/**
 * A `MessageEvent` superset that supports event cancellation
 * in Node.js. It's rather non-intrusive so it can be safely
 * used in the browser as well.
 *
 * @see https://github.com/nodejs/node/issues/51767
 */
declare class CancelableMessageEvent<T = any> extends MessageEvent<T> {
    [kCancelable]: boolean;
    [kDefaultPrevented]: boolean;
    constructor(type: string, init: MessageEventInit<T>);
    get cancelable(): boolean;
    set cancelable(nextCancelable: boolean);
    get defaultPrevented(): boolean;
    set defaultPrevented(nextDefaultPrevented: boolean);
    preventDefault(): void;
}
interface CloseEventInit extends EventInit {
    code?: number;
    reason?: string;
    wasClean?: boolean;
}
declare class CloseEvent extends Event {
    code: number;
    reason: string;
    wasClean: boolean;
    constructor(type: string, init?: CloseEventInit);
}
declare class CancelableCloseEvent extends CloseEvent {
    [kCancelable]: boolean;
    [kDefaultPrevented]: boolean;
    constructor(type: string, init?: CloseEventInit);
    get cancelable(): boolean;
    set cancelable(nextCancelable: boolean);
    get defaultPrevented(): boolean;
    set defaultPrevented(nextDefaultPrevented: boolean);
    preventDefault(): void;
}

type WebSocketData = string | ArrayBufferLike | Blob | ArrayBufferView;
type WebSocketTransportEventMap = {
    incoming: MessageEvent<WebSocketData>;
    outgoing: MessageEvent<WebSocketData>;
    close: CloseEvent;
};
type StrictEventListenerOrEventListenerObject<EventType extends Event> = ((this: WebSocket, event: EventType) => void) | {
    handleEvent(this: WebSocket, event: EventType): void;
};
interface WebSocketTransport {
    addEventListener<EventType extends keyof WebSocketTransportEventMap>(event: EventType, listener: StrictEventListenerOrEventListenerObject<WebSocketTransportEventMap[EventType]> | null, options?: boolean | AddEventListenerOptions): void;
    dispatchEvent<EventType extends keyof WebSocketTransportEventMap>(event: WebSocketTransportEventMap[EventType]): boolean;
    /**
     * Send the data from the server to this client.
     */
    send(data: WebSocketData): void;
    /**
     * Close the client connection.
     */
    close(code?: number, reason?: string): void;
}

type WebSocketEventListener<EventType extends WebSocketEventMap[keyof WebSocketEventMap] = Event> = (this: WebSocket, event: EventType) => void;
declare const kPassthroughPromise: unique symbol;
declare const kOnSend: unique symbol;
declare const kClose: unique symbol;
declare class WebSocketOverride extends EventTarget implements WebSocket {
    static readonly CONNECTING = 0;
    static readonly OPEN = 1;
    static readonly CLOSING = 2;
    static readonly CLOSED = 3;
    readonly CONNECTING = 0;
    readonly OPEN = 1;
    readonly CLOSING = 2;
    readonly CLOSED = 3;
    url: string;
    protocol: string;
    extensions: string;
    binaryType: BinaryType;
    readyState: number;
    bufferedAmount: number;
    private _onopen;
    private _onmessage;
    private _onerror;
    private _onclose;
    private [kPassthroughPromise];
    private [kOnSend]?;
    constructor(url: string | URL, protocols?: string | Array<string>);
    set onopen(listener: WebSocketEventListener | null);
    get onopen(): WebSocketEventListener | null;
    set onmessage(listener: WebSocketEventListener<MessageEvent<WebSocketData>> | null);
    get onmessage(): WebSocketEventListener<MessageEvent<WebSocketData>> | null;
    set onerror(listener: WebSocketEventListener | null);
    get onerror(): WebSocketEventListener | null;
    set onclose(listener: WebSocketEventListener<CloseEvent> | null);
    get onclose(): WebSocketEventListener<CloseEvent> | null;
    /**
     * @see https://websockets.spec.whatwg.org/#ref-for-dom-websocket-send%E2%91%A0
     */
    send(data: WebSocketData): void;
    close(code?: number, reason?: string): void;
    private [kClose];
    addEventListener<K extends keyof WebSocketEventMap>(type: K, listener: (this: WebSocket, event: WebSocketEventMap[K]) => void, options?: boolean | AddEventListenerOptions): void;
    addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void;
    removeEventListener<K extends keyof WebSocketEventMap>(type: K, callback: EventListenerOrEventListenerObject | null, options?: boolean | EventListenerOptions): void;
}

declare const kEmitter$1: unique symbol;
interface WebSocketClientEventMap {
    message: MessageEvent<WebSocketData>;
    close: CloseEvent;
}
declare abstract class WebSocketClientConnectionProtocol {
    abstract id: string;
    abstract url: URL;
    abstract send(data: WebSocketData): void;
    abstract close(code?: number, reason?: string): void;
    abstract addEventListener<EventType extends keyof WebSocketClientEventMap>(type: EventType, listener: WebSocketEventListener<WebSocketClientEventMap[EventType]>, options?: AddEventListenerOptions | boolean): void;
    abstract removeEventListener<EventType extends keyof WebSocketClientEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketClientEventMap[EventType]>, options?: EventListenerOptions | boolean): void;
}
/**
 * The WebSocket client instance represents an incoming
 * client connection. The user can control the connection,
 * send and receive events.
 */
declare class WebSocketClientConnection implements WebSocketClientConnectionProtocol {
    readonly socket: WebSocket;
    private readonly transport;
    readonly id: string;
    readonly url: URL;
    private [kEmitter$1];
    constructor(socket: WebSocket, transport: WebSocketTransport);
    /**
     * Listen for the outgoing events from the connected WebSocket client.
     */
    addEventListener<EventType extends keyof WebSocketClientEventMap>(type: EventType, listener: WebSocketEventListener<WebSocketClientEventMap[EventType]>, options?: AddEventListenerOptions | boolean): void;
    /**
     * Removes the listener for the given event.
     */
    removeEventListener<EventType extends keyof WebSocketClientEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketClientEventMap[EventType]>, options?: EventListenerOptions | boolean): void;
    /**
     * Send data to the connected client.
     */
    send(data: WebSocketData): void;
    /**
     * Close the WebSocket connection.
     * @param {number} code A status code (see https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1).
     * @param {string} reason A custom connection close reason.
     */
    close(code?: number, reason?: string): void;
}

/**
 * Abstraction over the given mock `WebSocket` instance that allows
 * for controlling that instance (e.g. sending and receiving messages).
 */
declare class WebSocketClassTransport extends EventTarget implements WebSocketTransport {
    protected readonly socket: WebSocketOverride;
    constructor(socket: WebSocketOverride);
    addEventListener<EventType extends keyof WebSocketTransportEventMap>(type: EventType, callback: StrictEventListenerOrEventListenerObject<WebSocketTransportEventMap[EventType]> | null, options?: boolean | AddEventListenerOptions): void;
    dispatchEvent<EventType extends keyof WebSocketTransportEventMap>(event: WebSocketTransportEventMap[EventType]): boolean;
    send(data: WebSocketData): void;
    close(code: number, reason?: string): void;
}

declare const kEmitter: unique symbol;
declare const kSend: unique symbol;
interface WebSocketServerEventMap {
    open: Event;
    message: MessageEvent<WebSocketData>;
    error: Event;
    close: CloseEvent;
}
declare abstract class WebSocketServerConnectionProtocol {
    abstract connect(): void;
    abstract send(data: WebSocketData): void;
    abstract close(): void;
    abstract addEventListener<EventType extends keyof WebSocketServerEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketServerEventMap[EventType]>, options?: AddEventListenerOptions | boolean): void;
    abstract removeEventListener<EventType extends keyof WebSocketServerEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketServerEventMap[EventType]>, options?: EventListenerOptions | boolean): void;
}
/**
 * The WebSocket server instance represents the actual production
 * WebSocket server connection. It's idle by default but you can
 * establish it by calling `server.connect()`.
 */
declare class WebSocketServerConnection implements WebSocketServerConnectionProtocol {
    private readonly client;
    private readonly transport;
    private readonly createConnection;
    /**
     * A WebSocket instance connected to the original server.
     */
    private realWebSocket?;
    private mockCloseController;
    private realCloseController;
    private [kEmitter];
    constructor(client: WebSocketOverride, transport: WebSocketClassTransport, createConnection: () => WebSocket);
    /**
     * The `WebSocket` instance connected to the original server.
     * Accessing this before calling `server.connect()` will throw.
     */
    get socket(): WebSocket;
    /**
     * Open connection to the original WebSocket server.
     */
    connect(): void;
    /**
     * Listen for the incoming events from the original WebSocket server.
     */
    addEventListener<EventType extends keyof WebSocketServerEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketServerEventMap[EventType]>, options?: AddEventListenerOptions | boolean): void;
    /**
     * Remove the listener for the given event.
     */
    removeEventListener<EventType extends keyof WebSocketServerEventMap>(event: EventType, listener: WebSocketEventListener<WebSocketServerEventMap[EventType]>, options?: EventListenerOptions | boolean): void;
    /**
     * Send data to the original WebSocket server.
     * @example
     * server.send('hello')
     * server.send(new Blob(['hello']))
     * server.send(new TextEncoder().encode('hello'))
     */
    send(data: WebSocketData): void;
    private [kSend];
    /**
     * Close the actual server connection.
     */
    close(): void;
    private handleIncomingMessage;
    private handleMockClose;
    private handleRealClose;
}

type WebSocketEventMap$1 = {
    connection: [args: WebSocketConnectionData];
};
type WebSocketConnectionData = {
    /**
     * The incoming WebSocket client connection.
     */
    client: WebSocketClientConnection;
    /**
     * The original WebSocket server connection.
     */
    server: WebSocketServerConnection;
    /**
     * The connection information.
     */
    info: {
        /**
         * The protocols supported by the WebSocket client.
         */
        protocols: string | Array<string> | undefined;
    };
};
/**
 * Intercept the outgoing WebSocket connections created using
 * the global `WebSocket` class.
 */
declare class WebSocketInterceptor extends Interceptor<WebSocketEventMap$1> {
    static symbol: symbol;
    constructor();
    protected checkEnvironment(): boolean;
    protected setup(): void;
}

export { CancelableCloseEvent, CancelableMessageEvent, CloseEvent, WebSocketClientConnection, WebSocketClientConnectionProtocol, WebSocketClientEventMap, WebSocketConnectionData, WebSocketData, WebSocketEventMap$1 as WebSocketEventMap, WebSocketInterceptor, WebSocketServerConnection, WebSocketServerConnectionProtocol, WebSocketServerEventMap, WebSocketTransport };