vortez 5.0.2 → 6.0.0-dev.1

package/build/server/websocket/Websocket.js

@@ -1,225 +1,45 @@
-/**
- * @author NetFeez <netfeez.dev@gmail.com>
- * @description adds websocket functionality to Vortez
- * @license Apache-2.0
- */
-import EVENTS from 'events';
-import CRYPTO from 'crypto';
-import Chunk from './Chunk.js';
-import LoggerManager from '../LoggerManager.js';
-import ServerError from '../ServerError.js';
-const logger = LoggerManager.getInstance().webSocket;
-export { Chunk } from './Chunk.js';
-export class Websocket extends EVENTS {
-    request;
-    connection;
-    static WEBSOCKET_GUID = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11';
-    _status = 'pending';
-    /**
-     * Creates a new websocket.
-     * @param client The connection with the client.
-     */
-    constructor(request, connection) {
-        super();
-        this.request = request;
-        this.connection = connection;
-        this.initEvents();
-    }
-    /** Whether the connection is closed. */
-    get isClosed() { return this.connection.readableEnded; }
-    get status() { return this._status; }
-    /**
-     * Accepts the connection with the client.
-     */
-    accept() {
-        const key = this.request.headers['sec-websocket-key']?.trim();
-        if (!key)
-            throw new ServerError('Missing Sec-WebSocket-Key header', 400);
-        this._status = 'accepted';
-        const acceptToken = CRYPTO.createHash('SHA1').update(key + Websocket.WEBSOCKET_GUID).digest('base64');
-        const headers = this.buildHeaders([
-            'HTTP/1.1 101 Switching Protocols',
-            'Upgrade: websocket',
-            'Connection: Upgrade',
-            `Sec-WebSocket-Accept: ${acceptToken}`
-        ], this.request.cookies);
-        this.connection.write(headers);
-    }
-    /**
-     * Rejects the connection with the client.
-     * @param code The code that will be sent to the client.
-     * @param reason The reason that will be sent to the client.
-     */
-    reject(code, reason) {
-        this._status = 'rejected';
-        const body = JSON.stringify({ code, reason }, null, 4);
-        const headers = this.buildHeaders([
-            `HTTP/1.1 ${code} ${reason}`,
-            'Content-Type: application/json',
-            `Content-Length: ${Buffer.byteLength(body)}`,
-            'Connection: close'
-        ], this.request.cookies);
-        this.connection.write(headers);
-        this.connection.end(body);
-    }
-    /**  Finishes the connection. */
-    end() { this.connection.end(); }
-    /** Destroys the connection. */
-    destroy() { this.connection.destroy(); }
-    /**
-     * Send data to the client.
-     * @param data The data that will be sent.
-     */
-    send(data) {
-        if (this.status == 'rejected')
-            return void logger.warn('You cannot send data to a rejected websocket connection');
-        if (this.status == 'pending')
-            return void logger.warn('You cannot send data to a pending websocket connection');
-        this.write(data);
-    }
-    /**
-     * Send data to the client in JSON format.
-     * @param data The data that will be sent.
-     */
-    sendJson(data) {
-        const message = JSON.stringify(data);
-        this.send(message);
-    }
-    /**
-     * Writes data to the client socket.
-     * @param data The data that will be sent.
-     */
-    write(data) {
-        const [buffer, isText] = typeof data == 'string'
-            ? [this.stringToBuffer(data), true]
-            : data instanceof Buffer
-                ? [data, false]
-                : [this.stringToBuffer('[Error]: unsupported data type MyNetFeez-Labs.Vortez.Websocket.send'), true];
-        const message = this.encode(buffer, isText);
-        this.connection.write(message);
-    }
-    /**
-     * Encodes the data to be sent to the client.
-     * @param data The data that will be encoded.
-     * @param isText Whether the data is a text or a binary.
-     */
-    encode(data, isText = false) {
-        const encoded = isText ? [129] : [130];
-        if (data.length <= 125) {
-            encoded[1] = data.length;
-        }
-        else if (data.length >= 126 && data.length <= 65535) {
-            encoded[1] = 126;
-            encoded[2] = (data.length >> 8) & 255;
-            encoded[3] = (data.length) & 255;
-        }
-        else {
-            encoded[1] = 127;
-            encoded[2] = (data.length >> 56) & 255;
-            encoded[3] = (data.length >> 48) & 255;
-            encoded[4] = (data.length >> 40) & 255;
-            encoded[5] = (data.length >> 32) & 255;
-            encoded[6] = (data.length >> 24) & 255;
-            encoded[7] = (data.length >> 16) & 255;
-            encoded[8] = (data.length >> 8) & 255;
-            encoded[9] = (data.length) & 255;
-        }
-        encoded.push(...data);
-        return Buffer.from(encoded);
-    }
-    /**
-     * Converts a string to a buffer.
-     * @param message The string that will be converted.
-     */
-    stringToBuffer(message) {
-        return Buffer.from(message, 'utf-8');
-    }
-    /** Initializes the events. */
-    initEvents() {
-        let surplus = Buffer.alloc(0);
-        let currentChunk = null;
-        let chunks = [];
-        this.connection.on('data', (data) => {
-            if (surplus) {
-                data = Buffer.concat([surplus, data]);
-                surplus = Buffer.alloc(0);
-            }
-            if (!currentChunk)
-                currentChunk = new Chunk(data);
-            else if (currentChunk.isWaiting())
-                currentChunk.pushData(data);
-            if (!currentChunk.isWaiting()) {
-                chunks.push(currentChunk);
-                surplus = currentChunk.surplus;
-                if (currentChunk.fin) {
-                    const decoded = Buffer.concat(chunks.map(chunk => chunk.decode()));
-                    this.emit('message', decoded, {
-                        opCode: chunks[0].opCode,
-                        size: chunks[0].size
-                    });
-                    chunks = [];
-                }
-                currentChunk = null;
-            }
-        });
-        this.connection.on('close', () => this.emit('close'));
-        this.connection.on('end', () => this.emit('finish'));
-        this.connection.on('error', (error) => this.emit('error', error));
-    }
-    on(event, listener) {
-        return super.on(event, listener);
-    }
-    off(event, listener) {
-        return super.off(event, listener);
-    }
-    buildHeaders(lines, cookies) {
-        const cookieSetters = cookies
-            ? cookies.getSetters().map((setter) => `Set-Cookie: ${setter}`)
-            : [];
-        return [...lines, ...cookieSetters, '\r\n'].join('\r\n');
+import WebsocketBase from "./WebsocketBase.js";
+import _WebsocketCSInit from './WebsocketCSInit.js';
+import _WebsocketSSInit from './WebsocketSSInit.js';
+export { Codec } from './Codec.js';
+export { WebsocketCSInit } from './WebsocketCSInit.js';
+export { WebsocketSSInit } from './WebsocketSSInit.js';
+export class Websocket extends WebsocketBase {
+    /**
+     * Creates a new ServerInit with handshake functions for accepting or rejecting WebSocket connections.
+     * This method is intended to be used in server-side applications to handle incoming WebSocket handshake requests and establish WebSocket connections with clients.
+     * Before handshakes finish you should get WebSocket instance with get method `websocket`
+     * @example
+     * ```typescript
+     * const serverSocketInit = Websocket.SS(socket, request);
+     * serverSocketInit.accept(); // To accept the handshake and establish the WebSocket connection
+     * // or
+     * serverSocketInit.reject(400, 'Bad Request'); // To reject the handshake with a specific status code and reason
+     *
+     * const socket = serverSocketInit.websocket; // Access the WebSocket instance for further communication after accepting the handshake
+     * ```
+     * @param socket - The Duplex stream representing the incoming socket connection from a client, which will be used for the WebSocket handshake and subsequent communication if the handshake is accepted.
+     * @param request - The Request object representing the client's handshake request, which contains the necessary information for validating and processing the handshake.
+     * @returns A ServerInit instance that provides methods for accepting or rejecting the WebSocket handshake, as well as access to the WebSocket instance for communication after a successful handshake.
+     * @remarks The method creates a new ServerInit instance with the provided socket and request, which encapsulates the logic for handling the WebSocket handshake process. The returned ServerInit instance can then be used to accept or reject the handshake based on the validation of the client's request, and to access the WebSocket instance for communication if the handshake is accepted.
+     */
+    static SS(socket, request) {
+        return new _WebsocketSSInit(request, socket);
+    }
+    /**
+     * Creates a new ClientInit and initiates a WebSocket connection to the specified URL by performing the necessary handshake process.
+     * This method is intended to be used in client-side applications to establish WebSocket connections to servers by providing the appropriate WebSocket URL.
+     * @param url - The WebSocket URL to connect to, which should include the protocol (ws:// or wss://), host, optional port, and path.
+     * @returns A promise that resolves to a Websocket instance representing the established connection if the handshake is successful, or rejects with an error if the handshake fails or if there are issues during the connection process.
+     * @remarks The method calls the static `connect` method of the ClientInit class, which handles parsing the URL, creating the socket connection, and performing the WebSocket handshake. If the handshake is successful, it resolves with a Websocket instance that can be used for communication. If any errors occur during the process, it rejects with the corresponding error.
+     */
+    static CS(url) {
+        return _WebsocketCSInit.connect(url);
     }
 }
+(function (Websocket) {
+    Websocket.WebsocketCSInit = _WebsocketCSInit;
+    Websocket.WebsocketSSInit = _WebsocketSSInit;
+})(Websocket || (Websocket = {}));
 export default Websocket;
-/* To accept a connection
- *
- * HTTP/1.1 101 Switching Protocols
- * Upgrade: websocket
- * Connection: Upgrade
- * Sec-WebSocket-Accept: Sec-Websocket-key + '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
- *                                            en HASH SHA-1 encoded in Base64
- *
- ** Format to data exchange
- *  0               1               2               3
- *  0                   1                   2                   3
- *  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
- * +-+-+-+-+-------+-+-------------+-------------------------------+
- * |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
- * |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
- * |N|V|V|V|       |S|             |   (if payload len==126/127)   |
- * | |1|2|3|       |K|             |                               |
- * +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
- * |     Extended payload length continued, if payload len == 127  |
- * + - - - - - - - - - - - - - - - +-------------------------------+
- * |                               |Masking-key, if MASK set to 1  |
- * +-------------------------------+-------------------------------+
- * | Masking-key (continued)       |          Payload Data         |
- * +-------------------------------- - - - - - - - - - - - - - - - +
- * :                     Payload Data continued ...                :
- * + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
- * |                     Payload Data continued ...                |
- * +---------------------------------------------------------------+
- *
- *
- * FIN and OPCODE works together to deliver messages with a separate frame
- * Only available in OPCODE 0x0 to 0x2
- *
- *
- * OPCODES:
- * 0x0: continuation
- * 0x1: text
- * 0x2: binary
- * 0x8: close
- * 0x9: ping
- * 0xA: pong
- */ 
 //# sourceMappingURL=Websocket.js.map

package/build/server/websocket/Websocket.js.map

@@ -1 +1 @@
-{"version":3,"file":"Websocket.js","sourceRoot":"","sources":["../../../src/server/websocket/Websocket.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,MAAM,MAAM,QAAQ,CAAC;AAE5B,OAAO,KAAK,MAAM,YAAY,CAAC;AAG/B,OAAO,aAAa,MAAM,qBAAqB,CAAC;AAChD,OAAO,WAAW,MAAM,mBAAmB,CAAC;AAE5C,MAAM,MAAM,GAAG,aAAa,CAAC,WAAW,EAAE,CAAC,SAAS,CAAC;AAErD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAGnC,MAAM,OAAO,SAAU,SAAQ,MAAM;IAQb;IACA;IARb,MAAM,CAAU,cAAc,GAAG,sCAAsC,CAAC;IACvE,OAAO,GAA8B,SAAS,CAAC;IACvD;;;OAGG;IACH,YACoB,OAAgB,EAChB,UAAkB;QAClC,KAAK,EAAE,CAAC;QAFQ,YAAO,GAAP,OAAO,CAAS;QAChB,eAAU,GAAV,UAAU,CAAQ;QACzB,IAAI,CAAC,UAAU,EAAE,CAAC;IAAC,CAAC;IACjC,wCAAwC;IACxC,IAAW,QAAQ,KAAc,OAAO,IAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;IACxE,IAAW,MAAM,KAAgC,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;IACvE;;OAEG;IACI,MAAM;QACT,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,CAAC;QAC9D,IAAI,CAAC,GAAG;YAAE,MAAM,IAAI,WAAW,CAAC,kCAAkC,EAAE,GAAG,CAAC,CAAC;QACzE,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC1B,MAAM,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,CAChD,GAAG,GAAG,SAAS,CAAC,cAAc,CACjC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEnB,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,kCAAkC;YAClC,oBAAoB;YACpB,qBAAqB;YACrB,yBAAyB,WAAW,EAAE;SACzC,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAEzB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IACD;;;;OAIG;IACI,MAAM,CAAC,IAAY,EAAE,MAAc;QACtC,IAAI,CAAC,OAAO,GAAG,UAAU,CAAC;QAC1B,MAAM,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC;YAC9B,YAAY,IAAI,IAAI,MAAM,EAAE;YAC5B,gCAAgC;YAChC,mBAAmB,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;YAC5C,mBAAmB;SACtB,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC/B,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IACD,gCAAgC;IACzB,GAAG,KAAW,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC7C,+BAA+B;IACxB,OAAO,KAAW,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;IACrD;;;OAGG;IACI,IAAI,CAAC,IAAqB;QAC7B,IAAI,IAAI,CAAC,MAAM,IAAI,UAAU;YAAE,OAAO,KAAK,MAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;QAClH,IAAI,IAAI,CAAC,MAAM,IAAI,SAAS;YAAE,OAAO,KAAK,MAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;QAChH,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrB,CAAC;IACD;;;OAGG;IACI,QAAQ,CAAC,IAAS;QACrB,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IACD;;;OAGG;IACK,KAAK,CAAC,IAAqB;QAC/B,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,OAAO,IAAI,IAAI,QAAQ;YAChD,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC;YACnC,CAAC,CAAC,IAAI,YAAY,MAAM;gBACpB,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,qEAAqE,CAAC,EAAE,IAAI,CAAC,CAAC;QACzG,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5C,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACnC,CAAC;IACD;;;;OAIG;IACK,MAAM,CAAC,IAAY,EAAE,SAAkB,KAAK;QAChD,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACrB,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;QAC7B,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,EAAE,CAAC;YACpD,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;YACjB,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC;YACtC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAQ,GAAG,CAAA;QACzC,CAAC;aAAM,CAAC;YACJ,OAAO,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC;YACjB,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAK,CAAC,CAAC,GAAG,GAAG,CAAC;YACvC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,GAAS,GAAG,CAAC;QAC3C,CAAC;QACD,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC;QACtB,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC;IACD;;;OAGG;IACK,cAAc,CAAC,OAAe;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACzC,CAAC;IACD,8BAA8B;IACtB,UAAU;QACd,IAAI,OAAO,GAAW,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,YAAY,GAAiB,IAAI,CAAC;QACtC,IAAI,MAAM,GAAY,EAAE,CAAC;QAEzB,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAY,EAAE,EAAE;YACxC,IAAI,OAAO,EAAE,CAAC;gBACV,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;gBACtC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC;YACD,IAAI,CAAC,YAAY;gBAAE,YAAY,GAAG,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC;iBAC7C,IAAI,YAAY,CAAC,SAAS,EAAE;gBAAE,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAC/D,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,CAAC;gBAC5B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC1B,OAAO,GAAG,YAAY,CAAC,OAAO,CAAC;gBAC/B,IAAI,YAAY,CAAC,GAAG,EAAE,CAAC;oBACnB,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;oBACnE,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,EAAE;wBAC1B,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM;wBACxB,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI;qBACvB,CAAC,CAAC;oBACH,MAAM,GAAG,EAAE,CAAC;gBAChB,CAAC;gBACD,YAAY,GAAG,IAAI,CAAC;YACxB,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,GAAQ,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC3D,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,KAAK,EAAI,GAAQ,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACtE,CAAC;IAMM,EAAE,CAAC,KAAa,EAAE,QAAkC;QACvD,OAAO,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACrC,CAAC;IAKM,GAAG,CAAC,KAAa,EAAE,QAAkC;QACxD,OAAO,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;IACtC,CAAC;IACO,YAAY,CAAC,KAAe,EAAE,OAAgB;QAClD,MAAM,aAAa,GAAG,OAAO;YACzB,CAAC,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,eAAe,MAAM,EAAE,CAAC;YAC/D,CAAC,CAAC,EAAE,CAAC;QACT,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,aAAa,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC7D,CAAC;;AAiBL,eAAe,SAAS,CAAC;AAEzB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG"}
+{"version":3,"file":"Websocket.js","sourceRoot":"","sources":["../../../src/server/websocket/Websocket.ts"],"names":[],"mappings":"AAIA,OAAO,aAAa,MAAM,oBAAoB,CAAC;AAE/C,OAAO,gBAAgB,MAAM,sBAAsB,CAAC;AACpD,OAAO,gBAAgB,MAAM,sBAAsB,CAAC;AAEpD,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,OAAO,SAAU,SAAQ,aAAa;IACxC;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CAAC,EAAE,CAAC,MAAc,EAAE,OAAgB;QAC7C,OAAO,IAAI,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IACjD,CAAC;IACD;;;;;;OAMG;IACI,MAAM,CAAC,EAAE,CAAC,GAAW;QACxB,OAAO,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACzC,CAAC;CACJ;AACD,WAAiB,SAAS;IACR,yBAAe,GAAG,gBAAgB,CAAC;IACnC,yBAAe,GAAG,gBAAgB,CAAC;AACrD,CAAC,EAHgB,SAAS,KAAT,SAAS,QAGzB;AACD,eAAe,SAAS,CAAC"}

package/build/server/websocket/WebsocketBase.d.ts

@@ -0,0 +1,130 @@
+/**
+ * @author NetFeez <netfeez.dev@gmail.com>
+ * @description adds websocket functionality to Vortez
+ * @license Apache-2.0
+ */
+import type { Duplex } from 'stream';
+import { Events } from '@netfeez/common';
+import Message from './messageAssembler/Message.js';
+import MessageAssembler from './messageAssembler/MessageAssembler.js';
+export declare class WebsocketBase extends Events<WebsocketBase.EventMap> {
+    readonly connection: Duplex;
+    protected vStatus: WebsocketBase.Status;
+    protected readonly vEventBuffer: WebsocketBase.EventBuffer;
+    protected vEventBuffering: boolean;
+    protected assembler: MessageAssembler;
+    protected surplus: Buffer;
+    constructor(connection: Duplex);
+    get isClosed(): boolean;
+    get status(): WebsocketBase.Status;
+    /**
+     * Sends a JSON-serializable object through the WebSocket connection as a text frame. The object is first serialized to a JSON string before being sent.
+     * @param data - The JSON-serializable object to be sent through the WebSocket connection.
+     */
+    sendJson(data: any): void;
+    /**
+     * Sends data through the WebSocket connection.
+     * The data can be either a string (which will be sent as a text frame) or a Buffer (which will be sent as a binary frame).
+     * If the connection is not open, a warning is logged and the data is not sent.
+     * @param data - The data to be sent through the WebSocket connection, which can be either a string or a Buffer.
+     * @remarks The method first checks the status of the connection to ensure that it is open before attempting to send data. If the connection is closed or still in the handshake phase, a warning is logged to inform the developer that data cannot be sent in the current state. If the connection is open, the method calls the internal `write` method to handle encoding and sending the data through the WebSocket connection.
+     */
+    send(data: string | Buffer): void;
+    /**
+     * Sends a ping frame through the WebSocket connection and waits for a corresponding pong response to measure the round-trip time (RTT) of the ping-pong exchange. The method returns a promise that resolves with the measured RTT in milliseconds or rejects if a timeout occurs or if there is an error during the process.
+     * @param options - An optional object containing configuration options for the ping operation, including:
+     *   - `timeout`: The maximum time to wait for a pong response before rejecting the promise (default is 5000 milliseconds).
+     *   - `data`: Optional data to include in the ping frame, which can be a Buffer or a string. If a string is provided, it will be converted to a Buffer using UTF-8 encoding.
+     * @returns A promise that resolves with the measured round-trip time (RTT) in milliseconds if a pong response is received within the specified timeout, or rejects with an error if a timeout occurs or if there is an issue during the ping-pong exchange.
+     */
+    ping(options?: WebsocketBase.PingOptions): Promise<number>;
+    /**
+     * Closes the WebSocket connection by sending a close frame and ending the connection. If the connection is already closed, this method does nothing.
+      * - It first checks if the connection is already closed, and if so, it simply returns without performing any actions.
+      * - If the connection is not closed, it updates the internal status to 'closed', sends a close frame to the peer, and ends the connection.
+      * @remarks This method ensures that the WebSocket connection is properly closed by sending the appropriate close frame and terminating the connection. It also prevents any further actions from being taken on a closed connection by checking the status before attempting to close it again.
+     */
+    close(): void;
+    /**
+     * Writes the given buffer with the specified opcode to the WebSocket connection.
+     * This method is responsible for encoding the data into a WebSocket frame format and sending it through the underlying connection.
+     * In the base implementation, it uses the `encode` method to perform the encoding, which can be overridden in subclasses to provide different encoding strategies (e.g., masking for client-to-server communication).
+     * @param buffer - The data buffer to be encoded and sent through the WebSocket connection.
+     * @param opcode - The opcode indicating the type of frame being sent (e.g., 0x1 for text frames, 0x2 for binary frames).
+     * @remarks This method is designed to be overridden in client-side implementations to allow for different encoding strategies, such as masking frames for client-to-server communication. In the base implementation, it simply encodes the buffer using the standard `encode` method and writes it to the connection, but subclasses can provide their own encoding logic as necessary.
+     */
+    write(buffer: Buffer, opcode: number): void;
+    /**
+     * flush pending events. This method is used to emit any buffered events that were stored while there were no listeners for those events.
+     * It checks for buffered 'message', 'message:text', 'message:binary', and 'error' events and emits them if there are listeners available.
+     * Additionally, it handles re-emission of 'open' and 'close' events if they were emitted before listeners were added.
+     * This ensures that all relevant events are properly emitted to listeners once they are registered, allowing for correct handling of WebSocket events in the application.
+     *
+     * If you are using this class as a we client, you can use it after add your listeners.
+     *
+     * If you are using this class as a web server, you can use it after routing and executed the action rule on the router o middleware exec (vortez context).
+     *
+     * Here in **Vortez**, the WebsocketSSInit instance is created in the router on receive upgrade request.
+     * Before it is executed the middleware stack -> executed the action rule on the router and automatically is called flush() method to emit the buffered events.
+     * we are sure that the events will be received with your instance of Websocket on server side if you use `vortez`
+     *
+     * If you are using the class as a client ``WebsocketCSInit`` or out of Vortez, you can call it after add your listeners to make sure that you will receive the events emitted during the handshake phase.
+     * @remarks This method is essential for ensuring that all relevant events are emitted to listeners, especially in cases where events may have been emitted before listeners were registered. By calling this method after adding listeners, you can ensure that any buffered events are properly emitted and handled by the listeners, allowing for correct functionality of the WebSocket connection in your application.
+     */
+    flush(): void;
+    /**
+     * ====== Override this method in Client side to use different codec ======
+     *
+     * Encodes the given buffer with the specified opcode and sends it through the WebSocket connection. This method is responsible for encoding the data into a WebSocket frame format and writing it to the underlying connection.
+     * In the base implementation, it uses the Codec.encode method to perform the encoding, but this method can be overridden in subclasses (such as WebsocketCSInit) to use a different encoding strategy if needed.
+     * @param buffer - The data buffer to be encoded and sent through the WebSocket connection.
+     * @param opcode - The opcode indicating the type of frame being sent (e.g., 0x1 for text frames, 0x2 for binary frames).
+     * @returns the encoded buffer that was sent through the connection. This allows for further processing or logging of the encoded data if necessary.
+     * @remarks This method is designed to be overridden in client-side implementations to allow for different encoding strategies, such as masking frames for client-to-server communication. In the base implementation, it simply encodes the buffer using the standard Codec.encode method and writes it to the connection, but subclasses can provide their own encoding logic as necessary.
+     */
+    protected encode(buffer: Buffer, opcode: number): Buffer;
+    /**
+     * Initializes the WebSocket connection by setting up event listeners for incoming data, message assembly, and connection events.
+     * This method is called after a successful handshake to start processing WebSocket frames and messages.
+     * It listens for 'data' events on the socket to process incoming frames, and uses the MessageAssembler to assemble complete messages from the frames.
+     * It also handles control frames (like close and ping) appropriately, emitting events for messages, errors, and connection closures as needed.
+      * @remarks The method sets up a 'data' event listener on the socket to process incoming data buffers. It uses the MessageAssembler to handle the assembly of messages from frames, emitting 'message' events when complete messages are assembled. It also handles control frames such as close and ping, emitting a 'close' event when a close frame is received and responding to ping frames with pong frames. Additionally, it listens for 'close' and 'error' events on the socket to emit corresponding events for the WebSocket instance.
+     */
+    protected startup(): void;
+    /**
+     * Procesa el buffer recibido, extrayendo todos los frames completos y acumulando el surplus.
+     * Se encarga de manejar errores de parsing y de empujar los frames al assembler.
+     */
+    private processBuffer;
+    /**
+     * Middleware for emitting events. It handles buffering of messages and errors when there are no listeners, and re-emits 'open' and 'close' events if they were emitted before listeners were added.
+     * This method overrides the base emit method to provide additional functionality specific to WebSocket event handling, such as buffering messages and errors until listeners are available, and ensuring that 'open' and 'close' events are emitted appropriately based on the connection status and listener presence.
+     * @param event - The event to be emitted, which includes the event name and any associated arguments. The method processes the event based on its type and manages buffering and re-emission logic as needed.
+     */
+    protected emit<E extends string & keyof WebsocketBase.EventMap>(...event: [name: E, ...args: WebsocketBase.EventMap[E]]): void;
+}
+export declare namespace WebsocketBase {
+    type EventMap = {
+        message: [message: Message];
+        'message:text': [message: string];
+        'message:binary': [message: Buffer];
+        ping: [data: Buffer];
+        pong: [data: Buffer];
+        error: [error: Error];
+        close: [];
+        open: [];
+    };
+    type Status = 'handshake' | 'open' | 'closed';
+    interface DataInfo {
+        opCode: number;
+        size: number | bigint;
+    }
+    interface PingOptions {
+        timeout?: number;
+        data?: Buffer | string;
+    }
+    type EventBuffer = {
+        [name in keyof WebsocketBase.EventMap]?: WebsocketBase.EventMap[name][];
+    };
+}
+export default WebsocketBase;