sonic-ws 1.3.3 → 2.0.0

package/dist/ws/Connection.js

@@ -1,126 +0,0 @@
-"use strict";
-/*
- * Copyright 2026 Lily (liwybloc)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CloseCodes = exports.Connection = void 0;
-exports.getClosureCause = getClosureCause;
-const PacketProcessor_1 = require("./PacketProcessor");
-const BatchHelper_1 = require("./util/packets/BatchHelper");
-class Connection extends PacketProcessor_1.MiddlewareHolder {
-    listeners;
-    name;
-    closed = false;
-    socket;
-    _timers = {};
-    batcher;
-    _on;
-    _off;
-    /** The index of the connection; unique for all connected, not unique after disconnection. */
-    id;
-    constructor(socket, id, name, addListener, removeListener) {
-        super();
-        this.id = id;
-        this.listeners = {};
-        this.name = name;
-        this.socket = socket;
-        this.batcher = new BatchHelper_1.BatchHelper();
-        this._on = addListener;
-        this._off = removeListener;
-        this._on("close", () => {
-            this.callMiddleware('onStatusChange', WebSocket.CLOSED);
-            this.closed = true;
-            for (const [id, callback, shouldCall] of Object.values(this._timers)) {
-                this.clearTimeout(id);
-                if (shouldCall)
-                    callback(true);
-            }
-        });
-        this._on('open', () => this.callMiddleware('onStatusChange', WebSocket.OPEN));
-    }
-    setTimeout(call, time, callOnClose = false) {
-        const timeout = setTimeout(() => {
-            call();
-            this.clearTimeout(timeout);
-        }, time);
-        this._timers[timeout] = [timeout, call, callOnClose];
-        return timeout;
-    }
-    setInterval(call, time, callOnClose = false) {
-        const interval = setInterval(call, time);
-        this._timers[interval] = [interval, call, callOnClose];
-        return interval;
-    }
-    clearTimeout(id) {
-        clearTimeout(id);
-        delete this._timers[id];
-    }
-    clearInterval(id) {
-        this.clearTimeout(id);
-    }
-    raw_send(data) {
-        this.socket.send(data);
-    }
-    raw_onmessage(listener) {
-        this._on("message", listener);
-    }
-    close(code = 1000, reason) {
-        this.closed = true;
-        this.socket.close(code, reason?.toString());
-    }
-    isClosed() {
-        return this.closed || this.socket.readyState == WebSocket.CLOSED;
-    }
-    async setName(name) {
-        if (await this.callMiddleware("onNameChange", name))
-            return;
-        this.name = name;
-    }
-    getName() {
-        return this.name;
-    }
-}
-exports.Connection = Connection;
-var CloseCodes;
-(function (CloseCodes) {
-    CloseCodes[CloseCodes["RATELIMIT"] = 4000] = "RATELIMIT";
-    CloseCodes[CloseCodes["SMALL"] = 4001] = "SMALL";
-    CloseCodes[CloseCodes["INVALID_KEY"] = 4002] = "INVALID_KEY";
-    CloseCodes[CloseCodes["INVALID_PACKET"] = 4003] = "INVALID_PACKET";
-    CloseCodes[CloseCodes["INVALID_DATA"] = 4004] = "INVALID_DATA";
-    CloseCodes[CloseCodes["REPEATED_HANDSHAKE"] = 4005] = "REPEATED_HANDSHAKE";
-    CloseCodes[CloseCodes["DISABLED_PACKET"] = 4006] = "DISABLED_PACKET";
-    CloseCodes[CloseCodes["MIDDLEWARE"] = 4007] = "MIDDLEWARE";
-    CloseCodes[CloseCodes["MANUAL_SHUTDOWN"] = 4008] = "MANUAL_SHUTDOWN";
-})(CloseCodes || (exports.CloseCodes = CloseCodes = {}));
-function getClosureCause(id) {
-    if (id >= 4000) {
-        return CloseCodes[id] ?? 'UNKNOWN';
-    }
-    switch (id) {
-        case 1000:
-            return 'NORMAL_CLOSURE';
-        case 1001:
-            return 'GOING_AWAY';
-        case 1002:
-            return 'PROTOCOL_ERROR';
-        case 1003:
-            return 'UNSUPPORTED_DATA';
-        case 1006:
-            return 'ABNORMAL_CLOSURE';
-        default:
-            return 'UNKNOWN';
-    }
-}

package/dist/ws/PacketProcessor.js

@@ -1,52 +0,0 @@
-"use strict";
-/*
- * Copyright 2026 Lily (liwybloc)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MiddlewareHolder = void 0;
-class MiddlewareHolder {
-    middlewares = [];
-    addMiddleware(middleware) {
-        this.middlewares.push(middleware);
-        const m = middleware;
-        try {
-            if (typeof m.init === 'function')
-                m.init(this);
-        }
-        catch (e) {
-            console.warn('Middleware init threw an error:', e);
-        }
-    }
-    async callMiddleware(method, ...values) {
-        let cancelled = false;
-        for (const middleware of this.middlewares) {
-            const fn = middleware[method];
-            if (!fn)
-                continue;
-            try {
-                if (await fn(...values)) {
-                    cancelled = true;
-                }
-            }
-            catch (e) {
-                console.warn(`Middleware ${String(method)} threw an error:`, e);
-            }
-        }
-        return cancelled;
-    }
-}
-exports.MiddlewareHolder = MiddlewareHolder;
-;
-;

package/dist/ws/client/core/ClientCore.js

@@ -1,251 +0,0 @@
-"use strict";
-/*
- * Copyright 2026 Lily (liwybloc)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SonicWSCore = void 0;
-const PacketHolder_1 = require("../../util/packets/PacketHolder");
-const CompressionUtil_1 = require("../../util/packets/CompressionUtil");
-const PacketUtils_1 = require("../../util/packets/PacketUtils");
-const version_1 = require("../../../version");
-const Packets_1 = require("../../packets/Packets");
-const BatchHelper_1 = require("../../util/packets/BatchHelper");
-const BufferUtil_1 = require("../../util/BufferUtil");
-const Connection_1 = require("../../Connection");
-const StringUtil_1 = require("../../util/StringUtil");
-class SonicWSCore extends Connection_1.Connection {
-    preListen;
-    clientPackets = new PacketHolder_1.PacketHolder();
-    serverPackets = new PacketHolder_1.PacketHolder();
-    pastKeys = false;
-    readyListeners = [];
-    bufferHandler;
-    _timers = {};
-    asyncData = {};
-    asyncMap = {};
-    constructor(ws, bufferHandler, on, off) {
-        super(ws, -1, "LocalSocket", on, off);
-        this.socket = ws;
-        this.preListen = {};
-        this.invalidPacket = this.invalidPacket.bind(this);
-        this.serverKeyHandler = this.serverKeyHandler.bind(this);
-        this.messageHandler = this.messageHandler.bind(this);
-        this._on('message', this.serverKeyHandler);
-        this._on('close', () => {
-            this.callMiddleware('onStatusChange', WebSocket.CLOSED);
-            for (const [id, callback, shouldCall] of Object.values(this._timers)) {
-                this.clearTimeout(id);
-                if (shouldCall)
-                    callback(true);
-            }
-            for (const packet of this.clientPackets.getPackets()) {
-                delete packet.lastSent[0];
-            }
-            for (const packet of this.serverPackets.getPackets()) {
-                delete packet.lastReceived[0];
-            }
-        });
-        this.bufferHandler = bufferHandler;
-    }
-    reading = false;
-    readQueue = [];
-    async serverKeyHandler(event) {
-        if (this.reading)
-            return this.readQueue.push(event);
-        this.reading = true;
-        const cdata = await this.bufferHandler(event);
-        if (cdata.length < 3 || (0, StringUtil_1.as8String)(cdata.slice(0, 3)) != version_1.SERVER_SUFFIX) {
-            this.close(1000);
-            throw new Error("The server requested is not a Sonic WS server.");
-        }
-        const version = cdata[3];
-        if (version != version_1.VERSION) {
-            this.close(1000);
-            throw new Error(`Version mismatch: ${version > version_1.VERSION ? "client" : "server"} is outdated (server: ${version}, client: ${version_1.VERSION})`);
-        }
-        const data = await (0, CompressionUtil_1.decompressGzip)(cdata.subarray(4, cdata.length));
-        const [ckOff, id] = (0, CompressionUtil_1.readVarInt)(data, 0);
-        this.id = id;
-        const [valuesOff, ckLength] = (0, CompressionUtil_1.readVarInt)(data, ckOff);
-        const ckData = data.subarray(valuesOff, valuesOff + ckLength);
-        this.clientPackets.holdPackets(Packets_1.Packet.deserializeAll(ckData, true));
-        const skData = data.subarray(valuesOff + ckLength, data.length);
-        this.serverPackets.holdPackets(Packets_1.Packet.deserializeAll(skData, true));
-        this.batcher.registerSendPackets(this.clientPackets, this);
-        for (const p of this.serverPackets.getPackets()) {
-            const key = this.serverPackets.getKey(p.tag);
-            this.asyncMap[key] = p.async;
-            if (p.async) {
-                this.asyncData[key] = [false, []];
-            }
-        }
-        Object.keys(this.preListen).forEach(tag => this.preListen[tag].forEach(listener => {
-            // print the error to console without halting execution
-            if (!this.serverPackets.hasTag(tag))
-                return console.error(new Error(`The server does not send the packet with tag "${tag}"!`));
-            this.listen(tag, listener);
-        }));
-        this.preListen = null; // clear
-        this.pastKeys = true;
-        this.readyListeners.forEach(l => l());
-        this.readyListeners = null; // clear
-        this._off('message', this.serverKeyHandler);
-        this._on('message', this.messageHandler);
-        this.readQueue.forEach(e => this.messageHandler(e));
-        this.readQueue = [];
-    }
-    invalidPacket(listened) {
-        console.error(listened);
-        throw new Error("An error occured with data from the server!! This is probably my fault.. make an issue at https://github.com/liwybloc/sonic-ws");
-    }
-    listenLock = false;
-    packetQueue = [];
-    async listenPacket(data, tag, packetQueue, isAsync, asyncData) {
-        const listeners = this.listeners[tag];
-        if (!listeners)
-            return console.warn("Warn: No listener for packet " + tag);
-        await this.enqueuePacket(data, listeners, packetQueue, isAsync, asyncData);
-        await this.callMiddleware('onReceive_post', tag, typeof data == 'string' ? [data] : data[0]);
-    }
-    isAsync(code) {
-        return this.asyncMap[code];
-    }
-    async enqueuePacket(data, listeners, packetQueue, isAsync, asyncData) {
-        await (0, PacketUtils_1.listenPacket)(data, listeners, this.invalidPacket);
-        await this.triggerNextPacket(packetQueue, isAsync, asyncData);
-    }
-    async triggerNextPacket(packetQueue, isAsync, asyncData) {
-        if (isAsync)
-            asyncData[0] = false;
-        else
-            this.listenLock = false;
-        if (packetQueue.length > 0) {
-            this.dataHandler(packetQueue.shift());
-            return;
-        }
-    }
-    async dataHandler(data) {
-        const key = data[0];
-        const value = data.slice(1);
-        const isAsync = this.isAsync(key);
-        let locked;
-        let packetQueue;
-        let asyncData;
-        if (isAsync) {
-            asyncData = this.asyncData[key];
-            locked = asyncData[0];
-            packetQueue = asyncData[1];
-        }
-        else {
-            locked = this.listenLock;
-            packetQueue = this.packetQueue;
-        }
-        if (locked) {
-            packetQueue.push(data);
-            return;
-        }
-        if (isAsync)
-            asyncData[0] = true;
-        else
-            this.listenLock = true;
-        const tag = this.serverPackets.getTag(key);
-        const packet = this.serverPackets.getPacket(tag);
-        if (await this.callMiddleware('onReceive_pre', packet.tag, data, data.length))
-            return;
-        if (packet.rereference && value.length == 0) {
-            if (packet.lastReceived[0] === undefined)
-                return this.invalidPacket("No previous value to rereference");
-            this.listenPacket(packet.lastReceived[0], tag, packetQueue, isAsync, asyncData);
-            return;
-        }
-        if (packet.dataBatching == 0) {
-            const res = packet.lastReceived[0] = await packet.listen(value, null);
-            this.listenPacket(res, tag, packetQueue, isAsync, asyncData);
-            return;
-        }
-        const batchData = await BatchHelper_1.BatchHelper.unravelBatch(packet, value, null);
-        if (typeof batchData == 'string')
-            return this.invalidPacket(batchData);
-        batchData.forEach(data => this.listenPacket(data, tag, packetQueue, isAsync, asyncData));
-    }
-    async messageHandler(event) {
-        const data = await this.bufferHandler(event);
-        if (data.length < 1)
-            return;
-        await this.dataHandler(data);
-    }
-    listen(tag, listener) {
-        if (!this.serverPackets.hasTag(tag)) {
-            console.log("Tag is not available on server: " + tag);
-            return;
-        }
-        (this.listeners[tag] ??= []).push(listener);
-    }
-    /**
-     * Listens for all sent messages rawly
-     * @param listener Callback for when data is received
-     */
-    raw_onsend(listener) {
-        this.listeners.send.push(listener);
-    }
-    sendQueue = [false, [], undefined];
-    /**
-     * Sends a packet to the server
-     * @param tag The tag of the packet
-     * @param values The values to send
-     */
-    async send(tag, ...values) {
-        if (await this.callMiddleware('onSend_pre', tag, values, Date.now(), performance.now()))
-            return;
-        const [code, data, packet] = await (0, PacketUtils_1.processPacket)(this.clientPackets, tag, values, this.sendQueue, 0);
-        if (packet.dataBatching == 0)
-            this.raw_send((0, BufferUtil_1.toPacketBuffer)(code, data));
-        else
-            this.batcher.batchPacket(code, data);
-        await this.callMiddleware('onSend_post', tag, data, data.length);
-    }
-    /**
-     * Listens for when the client connects
-     * @param listener Callback on connection
-     */
-    on_ready(listener) {
-        if (this.pastKeys)
-            listener();
-        else
-            this.readyListeners.push(listener);
-    }
-    /**
-     * Listens for when the client closes
-     * @param listener Callback on close with close event
-     */
-    on_close(listener) {
-        this._on("close", listener);
-    }
-    /**
-     * Listens to a packet from the server
-     * @param tag The tag to listen for
-     * @param listener The callback with the values
-     */
-    on(tag, listener) {
-        if (this.socket.readyState !== WebSocket.OPEN) {
-            if (!this.preListen[tag])
-                this.preListen[tag] = [];
-            this.preListen[tag].push(listener);
-            return;
-        }
-        this.listen(tag, listener);
-    }
-}
-exports.SonicWSCore = SonicWSCore;

package/dist/ws/client/node/ClientNode.js

@@ -1,36 +0,0 @@
-"use strict";
-/*
- * Copyright 2026 Lily (liwybloc)
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SonicWS = void 0;
-const ws_1 = __importDefault(require("ws"));
-const ClientCore_1 = require("../core/ClientCore");
-/** Class to connect to a SonicWS server */
-class SonicWS extends ClientCore_1.SonicWSCore {
-    /**
-     * Creates a connection to the url
-     * @param url The url to connect to
-     * @param options The websocket options
-     */
-    constructor(url, options) {
-        const ws = new ws_1.default.WebSocket(url, options);
-        super(ws, (val) => Promise.resolve(new Uint8Array(val)), ws.addEventListener.bind(ws), ws.removeEventListener.bind(ws));
-    }
-}
-exports.SonicWS = SonicWS;