@gleamkit/engine.io 6.6.3

package/build/transport.d.ts

@@ -0,0 +1,124 @@
+import { EventEmitter } from "events";
+import type { IncomingMessage, ServerResponse } from "http";
+import { Packet, RawData } from "engine.io-parser";
+type ReadyState = "open" | "closing" | "closed";
+export type EngineRequest = IncomingMessage & {
+    _query: Record<string, string>;
+    res?: ServerResponse;
+    cleanup?: Function;
+    websocket?: any;
+};
+export declare abstract class Transport extends EventEmitter {
+    /**
+     * The session ID.
+     */
+    sid: string;
+    /**
+     * Whether the transport is currently ready to send packets.
+     */
+    writable: boolean;
+    /**
+     * The revision of the protocol:
+     *
+     * - 3 is used in Engine.IO v3 / Socket.IO v2
+     * - 4 is used in Engine.IO v4 and above / Socket.IO v3 and above
+     *
+     * It is found in the `EIO` query parameters of the HTTP requests.
+     *
+     * @see https://github.com/socketio/engine.io-protocol
+     */
+    protocol: number;
+    /**
+     * The current state of the transport.
+     * @protected
+     */
+    protected _readyState: ReadyState;
+    /**
+     * Whether the transport is discarded and can be safely closed (used during upgrade).
+     * @protected
+     */
+    protected discarded: boolean;
+    /**
+     * The parser to use (depends on the revision of the {@link Transport#protocol}.
+     * @protected
+     */
+    protected parser: any;
+    /**
+     * Whether the transport supports binary payloads (else it will be base64-encoded)
+     * @protected
+     */
+    protected supportsBinary: boolean;
+    get readyState(): ReadyState;
+    set readyState(state: ReadyState);
+    /**
+     * Transport constructor.
+     *
+     * @param {EngineRequest} req
+     */
+    constructor(req: {
+        _query: Record<string, string>;
+    });
+    /**
+     * Flags the transport as discarded.
+     *
+     * @package
+     */
+    discard(): void;
+    /**
+     * Called with an incoming HTTP request.
+     *
+     * @param req
+     * @package
+     */
+    onRequest(req: any): void;
+    /**
+     * Closes the transport.
+     *
+     * @package
+     */
+    close(fn?: () => void): void;
+    /**
+     * Called with a transport error.
+     *
+     * @param {String} msg - message error
+     * @param {Object} desc - error description
+     * @protected
+     */
+    protected onError(msg: string, desc?: any): void;
+    /**
+     * Called with parsed out a packets from the data stream.
+     *
+     * @param {Object} packet
+     * @protected
+     */
+    protected onPacket(packet: Packet): void;
+    /**
+     * Called with the encoded packet data.
+     *
+     * @param {String} data
+     * @protected
+     */
+    protected onData(data: RawData): void;
+    /**
+     * Called upon transport close.
+     *
+     * @protected
+     */
+    protected onClose(): void;
+    /**
+     * The name of the transport.
+     */
+    abstract get name(): string;
+    /**
+     * Sends an array of packets.
+     *
+     * @param {Array} packets
+     * @package
+     */
+    abstract send(packets: Packet[]): void;
+    /**
+     * Closes the transport.
+     */
+    abstract doClose(fn?: () => void): void;
+}
+export {};

package/build/transport.js

@@ -0,0 +1,117 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transport = void 0;
+const events_1 = require("events");
+const parser_v4 = require("engine.io-parser");
+const parser_v3 = require("./parser-v3/index");
+const debug_1 = require("debug");
+const debug = (0, debug_1.default)("engine:transport");
+function noop() { }
+class Transport extends events_1.EventEmitter {
+    get readyState() {
+        return this._readyState;
+    }
+    set readyState(state) {
+        debug("readyState updated from %s to %s (%s)", this._readyState, state, this.name);
+        this._readyState = state;
+    }
+    /**
+     * Transport constructor.
+     *
+     * @param {EngineRequest} req
+     */
+    constructor(req) {
+        super();
+        /**
+         * Whether the transport is currently ready to send packets.
+         */
+        this.writable = false;
+        /**
+         * The current state of the transport.
+         * @protected
+         */
+        this._readyState = "open";
+        /**
+         * Whether the transport is discarded and can be safely closed (used during upgrade).
+         * @protected
+         */
+        this.discarded = false;
+        this.protocol = req._query.EIO === "4" ? 4 : 3; // 3rd revision by default
+        this.parser = this.protocol === 4 ? parser_v4 : parser_v3;
+        this.supportsBinary = !(req._query && req._query.b64);
+    }
+    /**
+     * Flags the transport as discarded.
+     *
+     * @package
+     */
+    discard() {
+        this.discarded = true;
+    }
+    /**
+     * Called with an incoming HTTP request.
+     *
+     * @param req
+     * @package
+     */
+    onRequest(req) { }
+    /**
+     * Closes the transport.
+     *
+     * @package
+     */
+    close(fn) {
+        if ("closed" === this.readyState || "closing" === this.readyState)
+            return;
+        this.readyState = "closing";
+        this.doClose(fn || noop);
+    }
+    /**
+     * Called with a transport error.
+     *
+     * @param {String} msg - message error
+     * @param {Object} desc - error description
+     * @protected
+     */
+    onError(msg, desc) {
+        if (this.listeners("error").length) {
+            const err = new Error(msg);
+            // @ts-ignore
+            err.type = "TransportError";
+            // @ts-ignore
+            err.description = desc;
+            this.emit("error", err);
+        }
+        else {
+            debug("ignored transport error %s (%s)", msg, desc);
+        }
+    }
+    /**
+     * Called with parsed out a packets from the data stream.
+     *
+     * @param {Object} packet
+     * @protected
+     */
+    onPacket(packet) {
+        this.emit("packet", packet);
+    }
+    /**
+     * Called with the encoded packet data.
+     *
+     * @param {String} data
+     * @protected
+     */
+    onData(data) {
+        this.onPacket(this.parser.decodePacket(data));
+    }
+    /**
+     * Called upon transport close.
+     *
+     * @protected
+     */
+    onClose() {
+        this.readyState = "closed";
+        this.emit("close");
+    }
+}
+exports.Transport = Transport;

package/build/transports/index.d.ts

@@ -0,0 +1,16 @@
+import { Polling as XHR } from "./polling";
+import { WebSocket } from "./websocket";
+import { WebTransport } from "./webtransport";
+declare const _default: {
+    polling: typeof polling;
+    websocket: typeof WebSocket;
+    webtransport: typeof WebTransport;
+};
+export default _default;
+/**
+ * Polling polymorphic constructor.
+ */
+declare function polling(req: any): XHR;
+declare namespace polling {
+    var upgradesTo: string[];
+}

package/build/transports/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const polling_1 = require("./polling");
+const polling_jsonp_1 = require("./polling-jsonp");
+const websocket_1 = require("./websocket");
+const webtransport_1 = require("./webtransport");
+exports.default = {
+    polling: polling,
+    websocket: websocket_1.WebSocket,
+    webtransport: webtransport_1.WebTransport,
+};
+/**
+ * Polling polymorphic constructor.
+ */
+function polling(req) {
+    if ("string" === typeof req._query.j) {
+        return new polling_jsonp_1.JSONP(req);
+    }
+    else {
+        return new polling_1.Polling(req);
+    }
+}
+polling.upgradesTo = ["websocket", "webtransport"];

package/build/transports/polling-jsonp.d.ts

@@ -0,0 +1,12 @@
+import { Polling } from "./polling";
+import type { RawData } from "engine.io-parser";
+export declare class JSONP extends Polling {
+    private readonly head;
+    private readonly foot;
+    /**
+     * JSON-P polling transport.
+     */
+    constructor(req: any);
+    onData(data: RawData): void;
+    doWrite(data: any, options: any, callback: any): void;
+}

package/build/transports/polling-jsonp.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JSONP = void 0;
+const polling_1 = require("./polling");
+const qs = require("querystring");
+const rDoubleSlashes = /\\\\n/g;
+const rSlashes = /(\\)?\\n/g;
+class JSONP extends polling_1.Polling {
+    /**
+     * JSON-P polling transport.
+     */
+    constructor(req) {
+        super(req);
+        this.head = "___eio[" + (req._query.j || "").replace(/[^0-9]/g, "") + "](";
+        this.foot = ");";
+    }
+    onData(data) {
+        // we leverage the qs module so that we get built-in DoS protection
+        // and the fast alternative to decodeURIComponent
+        data = qs.parse(data).d;
+        if ("string" === typeof data) {
+            // client will send already escaped newlines as \\\\n and newlines as \\n
+            // \\n must be replaced with \n and \\\\n with \\n
+            data = data.replace(rSlashes, function (match, slashes) {
+                return slashes ? match : "\n";
+            });
+            super.onData(data.replace(rDoubleSlashes, "\\n"));
+        }
+    }
+    doWrite(data, options, callback) {
+        // we must output valid javascript, not valid json
+        // see: http://timelessrepo.com/json-isnt-a-javascript-subset
+        const js = JSON.stringify(data)
+            .replace(/\u2028/g, "\\u2028")
+            .replace(/\u2029/g, "\\u2029");
+        // prepare response
+        data = this.head + js + this.foot;
+        super.doWrite(data, options, callback);
+    }
+}
+exports.JSONP = JSONP;

package/build/transports/polling.d.ts

@@ -0,0 +1,87 @@
+import { EngineRequest, Transport } from "../transport";
+import type { Packet, RawData } from "engine.io-parser";
+export declare class Polling extends Transport {
+    maxHttpBufferSize: number;
+    httpCompression: any;
+    private req;
+    private res;
+    private dataReq;
+    private dataRes;
+    private shouldClose;
+    private readonly closeTimeout;
+    /**
+     * HTTP polling constructor.
+     */
+    constructor(req: any);
+    /**
+     * Transport name
+     */
+    get name(): string;
+    /**
+     * Overrides onRequest.
+     *
+     * @param {EngineRequest} req
+     * @package
+     */
+    onRequest(req: EngineRequest): void;
+    /**
+     * The client sends a request awaiting for us to send data.
+     *
+     * @private
+     */
+    private onPollRequest;
+    /**
+     * The client sends a request with data.
+     *
+     * @private
+     */
+    private onDataRequest;
+    /**
+     * Processes the incoming data payload.
+     *
+     * @param data - encoded payload
+     * @protected
+     */
+    onData(data: RawData): void;
+    /**
+     * Overrides onClose.
+     *
+     * @private
+     */
+    onClose(): void;
+    send(packets: Packet[]): void;
+    /**
+     * Writes data as response to poll request.
+     *
+     * @param {String} data
+     * @param {Object} options
+     * @private
+     */
+    private write;
+    /**
+     * Performs the write.
+     *
+     * @protected
+     */
+    protected doWrite(data: any, options: any, callback: any): void;
+    /**
+     * Compresses data.
+     *
+     * @private
+     */
+    private compress;
+    /**
+     * Closes the transport.
+     *
+     * @private
+     */
+    doClose(fn: () => void): void;
+    /**
+     * Returns headers for a response.
+     *
+     * @param {http.IncomingMessage} req
+     * @param {Object} headers - extra headers
+     * @private
+     */
+    private headers;
+}