sonic-ws 1.0.6 → 1.1.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2025 Lily (liwybloc)
+Copyright 2026 Lily (liwybloc)
 
 Licensed under the Apache License, Version 2.0 (the "License");
 You may not use this software except in compliance with the License.

package/README.md

@@ -18,6 +18,7 @@ Developer Friendly:
 
 Security:
 - Tamper-proof; any invalid packet instantly causes closure, and tampering becomes incredibly difficult
+- Basic but immensely effective anti-tampering for browser clients
 - Built-in ability for handshake packets, preventing repetitive initiation checks in listeners (for example, removes if(!init) everywhere)
 - Built-in rate limiting for packets; ability for global send & receive, alongside per-packet rate limiting
 - Built-in disabling & enabling of packets to prevent abuse
@@ -35,7 +36,7 @@ Developer Experience:
 - Many data types to maximize speed, clarity, bandwidth, and security
 - Debug tools for socket ids, byte size, data logging, etc. for troubleshooting
 - Very minimal learning curve, easy to work in
-- JSDoc's for understanding
+- JSDoc's for understanding; immensely intuitive (personally, I took a break for half a year and came back and snapped right back in)
 
 Whether you're making a real-time game, a dashboard, a distributed system, or anything else, SonicWS gets you safe, structured packets, fast.
 
@@ -109,6 +110,10 @@ ws.on_close((event) => {
 
 ## KNOWN ISSUES
 
+Some weird error messages when invalid inputs are in like CreatePacket() and stuff
+
 ## PLANNED FEATURES
 
-Better error handling
+Better error handling
+
+ZLib/gzip compression

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/version.d.ts

@@ -1,5 +1,5 @@
 /** Current protocol version */
-export declare const VERSION = 13;
+export declare const VERSION = 14;
 /** Server data suffix */
 export declare const SERVER_SUFFIX = "SWS";
 /** Server data suffix in array */

package/dist/version.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -18,7 +18,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SERVER_SUFFIX_NUMS = exports.SERVER_SUFFIX = exports.VERSION = void 0;
 const StringUtil_1 = require("./ws/util/StringUtil");
 /** Current protocol version */
-exports.VERSION = 13;
+exports.VERSION = 14;
 /** Server data suffix */
 exports.SERVER_SUFFIX = "SWS";
 /** Server data suffix in array */

package/dist/ws/Connection.d.ts

@@ -3,17 +3,18 @@
  */
 export interface Connection {
     /**
-     * List of timers, in object just for efficiency.
+     * List of timers.
      * For internal use only.
      */
-    _timers: Record<number, number>;
+    _timers: Record<number, [number, (closed: boolean) => void, boolean]>;
     /**
      * Sets a timeout that will automatically end when the socket closes
      * @param call The function to call
      * @param time The time between now and the call (ms)
+     * @param callOnClose If the callback should be fired anyways when the socket closes
      * @returns The timeout id to be used with socket.clearInterval(id)
      */
-    setTimeout(call: () => void, time: number): number;
+    setTimeout(call: () => void, time: number, callOnClose: boolean): number;
     /**
      * Sets an interval that will automatically end when the socket closes
      * @param call The function to call

package/dist/ws/Connection.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/client/core/ClientCore.d.ts

@@ -21,7 +21,7 @@ export declare abstract class SonicWSCore implements Connection {
     private batcher;
     private bufferHandler;
     id: number;
-    _timers: Record<number, number>;
+    _timers: Record<number, [number, (closed: boolean) => void, boolean]>;
     constructor(ws: WebSocket, bufferHandler: (val: MessageEvent) => Promise<Uint8Array>);
     private reading;
     private serverKeyHandler;
@@ -62,9 +62,8 @@ export declare abstract class SonicWSCore implements Connection {
      */
     on(tag: string, listener: (value: any[]) => void): void;
     raw_send(data: Uint8Array): void;
-    setTimeout(call: () => void, time: number): number;
-    setInterval(call: () => void, time: number): number;
-    private setTimer;
+    setTimeout(call: () => void, time: number, callOnClose?: boolean): number;
+    setInterval(call: () => void, time: number, callOnClose?: boolean): number;
     clearTimeout(id: number): void;
     clearInterval(id: number): void;
     close(code?: number, reason?: string): void;

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -52,7 +52,11 @@ class SonicWSCore {
         this.socket.addEventListener('message', this.serverKeyHandler);
         this.socket.addEventListener('close', (event) => {
             this.listeners.close.forEach(listener => listener(event));
-            Object.values(this._timers).forEach(clearTimeout);
+            for (const [id, callback, shouldCall] of Object.values(this._timers)) {
+                this.clearTimeout(id);
+                if (shouldCall)
+                    callback(true);
+            }
         });
         this.bufferHandler = bufferHandler;
     }
@@ -192,22 +196,19 @@ class SonicWSCore {
         this.listeners.send.forEach(d => d(data));
         this.socket.send(data);
     }
-    setTimeout(call, time) {
+    setTimeout(call, time, callOnClose = false) {
         const timeout = setTimeout(() => {
             call();
             this.clearTimeout(timeout);
         }, time);
-        this.setTimer(timeout);
+        this._timers[timeout] = [timeout, call, callOnClose];
         return timeout;
     }
-    setInterval(call, time) {
+    setInterval(call, time, callOnClose = false) {
         const interval = setInterval(call, time);
-        this.setTimer(interval);
+        this._timers[interval] = [interval, call, callOnClose];
         return interval;
     }
-    setTimer(id) {
-        this._timers[id] = id;
-    }
     clearTimeout(id) {
         clearTimeout(id);
         delete this._timers[id];

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

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/packets/PacketProcessors.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/packets/PacketType.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/packets/Packets.d.ts

@@ -24,7 +24,7 @@ export declare class Packet<T extends (PacketType | readonly PacketType[])> {
     private sendProcessor;
     private validator;
     processReceive: (data: Uint8Array, validationResult: any) => any;
-    processSend: (data: any[]) => number[];
+    processSend: (data: any[]) => Uint8Array;
     validate: (data: Uint8Array) => boolean;
     customValidator: ((socket: SonicWSConnection, ...values: any[]) => boolean) | null;
     constructor(tag: string, schema: PacketSchema<T>, customValidator: ValidatorFunction, enabled: boolean, client: boolean);

package/dist/ws/packets/Packets.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -85,7 +85,7 @@ class Packet {
             this.sendProcessor = (0, PacketProcessors_1.createSendProcessor)(this.type);
         }
         this.processReceive = (data, validationResult) => this.receiveProcessor(data, validationResult, 0);
-        this.processSend = (data) => this.sendProcessor(data);
+        this.processSend = (data) => new Uint8Array(this.sendProcessor(data));
         this.validate = (data) => this.validator(data, 0);
         this.customValidator = customValidator;
     }

package/dist/ws/server/SonicWSConnection.d.ts

@@ -19,7 +19,8 @@ export declare class SonicWSConnection implements Connection {
     handshakeComplete: boolean;
     /** The index of the connection; unique for all connected, recycles old disconnected ids. Should be safe for INTS_C unless you have more than 27,647 connected at once. */
     id: number;
-    _timers: Record<number, number>;
+    _timers: Record<number, [number, (closed: boolean) => void, boolean]>;
+    private closed;
     constructor(socket: WS.WebSocket, host: SonicWSServer, id: number, handshakePacket: string | null, clientRateLimit: number, serverRateLimit: number);
     private parseData;
     private handshakeHandler;
@@ -55,7 +56,7 @@ export declare class SonicWSConnection implements Connection {
     /**
      * For internal use.
      */
-    send_processed(code: number, data: number[], packet: Packet<any>): void;
+    send_processed(code: number, data: Uint8Array, packet: Packet<any>): void;
     /**
      * Sends a packet with the tag and values
      * @param tag The tag to send
@@ -80,8 +81,8 @@ export declare class SonicWSConnection implements Connection {
     togglePrint(): void;
     raw_send(data: Uint8Array): void;
     close(code?: number, reason?: string | Buffer): void;
-    setTimeout(call: () => void, time: number): number;
-    setInterval(call: () => void, time: number): number;
+    setTimeout(call: () => void, time: number, callOnClose?: boolean): number;
+    setInterval(call: () => void, time: number, callOnClose?: boolean): number;
     clearTimeout(id: number): void;
     clearInterval(id: number): void;
     /**

package/dist/ws/server/SonicWSConnection.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -80,6 +80,7 @@ class SonicWSConnection {
     /** The index of the connection; unique for all connected, recycles old disconnected ids. Should be safe for INTS_C unless you have more than 27,647 connected at once. */
     id;
     _timers = {};
+    closed = false;
     constructor(socket, host, id, handshakePacket, clientRateLimit, serverRateLimit) {
         this.socket = socket;
         this.host = host;
@@ -108,7 +109,12 @@ class SonicWSConnection {
             this.socket.addEventListener('message', this.handshakeLambda);
         }
         this.socket.on('close', () => {
-            Object.values(this._timers).forEach(clearTimeout);
+            this.closed = true;
+            for (const [id, callback, shouldCall] of Object.values(this._timers)) {
+                this.clearTimeout(id);
+                if (shouldCall)
+                    callback(true);
+            }
         });
     }
     parseData(event) {
@@ -158,6 +164,8 @@ class SonicWSConnection {
         this.socket.close(4003, listened);
     }
     listenPacket(data, tag) {
+        if (this.closed)
+            return;
         (0, PacketUtils_1.listenPacket)(data, this.listeners[tag], this.invalidPacket);
     }
     messageHandler(data) {
@@ -196,7 +204,7 @@ class SonicWSConnection {
      * @returns If it's closed or not
      */
     isClosed() {
-        return this.socket.readyState == WS.CLOSED;
+        return this.closed || this.socket.readyState == WS.CLOSED;
     }
     /**
      * Listens for when the connection closes
@@ -270,19 +278,20 @@ class SonicWSConnection {
         this.socket.send(data);
     }
     close(code = 1000, reason) {
+        this.closed = true;
         this.socket.close(code, reason);
     }
-    setTimeout(call, time) {
+    setTimeout(call, time, callOnClose = false) {
         const timeout = setTimeout(() => {
             call();
             this.clearTimeout(timeout);
         }, time);
-        this._timers[timeout] = timeout;
+        this._timers[timeout] = [timeout, call, callOnClose];
         return timeout;
     }
-    setInterval(call, time) {
+    setInterval(call, time, callOnClose = false) {
         const interval = setInterval(call, time);
-        this._timers[interval] = interval;
+        this._timers[interval] = [interval, call, callOnClose];
         return interval;
     }
     clearTimeout(id) {

package/dist/ws/server/SonicWSServer.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/ArrayUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/BufferUtil.d.ts

@@ -1,4 +1,4 @@
-export declare function toPacketBuffer(code: number, data: number[]): Uint8Array;
+export declare function toPacketBuffer(code: number, data: Uint8Array): Uint8Array;
 export declare function splitBuffer(arr: Uint8Array, x: number): number[][];
 export declare function as8String(data: Uint8Array): string;
 export declare function as16String(data: Uint8Array): string;

package/dist/ws/util/BufferUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/StringUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/enums/EnumHandler.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/enums/EnumType.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/packets/BatchHelper.d.ts

@@ -10,6 +10,6 @@ export declare class BatchHelper {
     registerSendPackets(packetHolder: PacketHolder, conn: Connection): void;
     private initiateBatch;
     private startBatch;
-    batchPacket(code: number, data: number[]): void;
+    batchPacket(code: number, data: Uint8Array): void;
     static unravelBatch(packet: Packet<any>, data: Uint8Array, socket: SonicWSConnection | null): any[] | string;
 }

package/dist/ws/util/packets/BatchHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -39,10 +39,10 @@ class BatchHelper {
     }
     startBatch(code) {
         this.batchTimeouts[code] = this.conn.setTimeout(() => {
-            this.conn.raw_send((0, BufferUtil_1.toPacketBuffer)(code, this.batchedData[code]));
+            this.conn.raw_send((0, BufferUtil_1.toPacketBuffer)(code, new Uint8Array(this.batchedData[code])));
             this.batchedData[code] = [];
             delete this.batchTimeouts[code];
-        }, this.batchTimes[code]);
+        }, this.batchTimes[code], false);
     }
     batchPacket(code, data) {
         const batch = this.batchedData[code];

package/dist/ws/util/packets/CompressionUtil.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/packets/PacketHolder.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/dist/ws/util/packets/PacketUtils.d.ts

@@ -9,7 +9,7 @@ import { EnumPackage } from "../enums/EnumType";
  * @param values The values
  * @returns The indexed code, the data, and the packet schema
  */
-export declare function processPacket(packets: PacketHolder, tag: string, values: any[]): [code: number, data: number[], packet: Packet<any>];
+export declare function processPacket(packets: PacketHolder, tag: string, values: any[]): [code: number, data: Uint8Array, packet: Packet<any>];
 /**
  * Calls the listener for a packet with error callback
  * @param listened The listened data

package/dist/ws/util/packets/PacketUtils.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.
@@ -65,7 +65,7 @@ function processPacket(packets, tag, values) {
             }
         }
     }
-    return [code, values.length > 0 ? packet.processSend(values) : [], packet];
+    return [code, values.length > 0 ? packet.processSend(values) : new Uint8Array([]), packet];
 }
 /**
  * Calls the listener for a packet with error callback
@@ -127,7 +127,9 @@ function clampDataMin(dataMin, dataMax) {
  * @throws {Error} If the `type` is invalid.
  */
 function CreatePacket(settings) {
-    let { tag, type = PacketType_1.PacketType.NONE, dataMax = 1, dataMin, noDataRange = false, dontSpread = false, validator = null, dataBatching = 0, maxBatchSize = 10, rateLimit = 0, enabled = true } = settings;
+    let { tag, type = PacketType_1.PacketType.NONE, dataMax = 1, dataMin = 1, noDataRange = false, dontSpread = false, validator = null, dataBatching = 0, maxBatchSize = 10, rateLimit = 0, enabled = true, } = settings;
+    if (!tag)
+        throw new Error("Tag not selected!");
     if (noDataRange) {
         dataMin = 0;
         dataMax = MAX_DATA_MAX;
@@ -148,7 +150,11 @@ function CreatePacket(settings) {
  * @throws {Error} If any type in `types` is invalid.
  */
 function CreateObjPacket(settings) {
-    let { tag, types, dataMaxes, dataMins, noDataRange = false, dontSpread = false, autoFlatten = false, validator = null, dataBatching = 0, maxBatchSize = 10, rateLimit = 0, enabled = true } = settings;
+    let { tag, types = [], dataMaxes, dataMins, noDataRange = false, dontSpread = false, autoFlatten = false, validator = null, dataBatching = 0, maxBatchSize = 10, rateLimit = 0, enabled = true } = settings;
+    if (!tag)
+        throw new Error("Tag not selected!");
+    if (types.length == 0)
+        throw new Error("Types is set to 0 length");
     for (const type of types) {
         if (!isInvalidType(type))
             continue;

package/dist/ws/util/packets/RateHandler.js

@@ -1,6 +1,6 @@
 "use strict";
 /*
- * Copyright 2025 Lily (liwybloc)
+ * 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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sonic-ws",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "description": "Ultra-lightweight, high-performance, and bandwidth efficient websocket library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -24,7 +24,8 @@
   "author": "lily",
   "license": "Apache-2.0",
   "dependencies": {
-    "ws": "^8.18.2"
+    "ws": "^8.18.2",
+    "zstd-codec": "^0.1.5"
   },
   "devDependencies": {
     "@types/node": "^24.2.1",