sonic-ws 1.3.0 → 1.3.2

package/dist/ws/packets/Packets.js

@@ -1,315 +1,6 @@
-"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.
+ * Licensed under the Apache License, Version 2.0.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.PacketSchema = exports.Packet = void 0;
-const EnumHandler_1 = require("../util/enums/EnumHandler");
-const EnumType_1 = require("../util/enums/EnumType");
-const CompressionUtil_1 = require("../util/packets/CompressionUtil");
-const PacketUtils_1 = require("../util/packets/PacketUtils");
-const PacketProcessors_1 = require("./PacketProcessors");
-const PacketType_1 = require("./PacketType");
-const BufferUtil_1 = require("../util/BufferUtil");
-const StringUtil_1 = require("../util/StringUtil");
-class Packet {
-    defaultEnabled;
-    tag;
-    maxSize;
-    minSize;
-    type;
-    enumData;
-    dataMax;
-    dataMin;
-    dataBatching;
-    maxBatchSize;
-    dontSpread;
-    autoFlatten;
-    rateLimit;
-    async;
-    rereference;
-    gzipCompression;
-    object;
-    client;
-    receiveProcessor;
-    sendProcessor;
-    validator;
-    processReceive;
-    processSend;
-    validate;
-    customValidator;
-    lastReceived = {};
-    lastSent = {};
-    constructor(tag, schema, customValidator, enabled, client) {
-        this.tag = tag;
-        this.defaultEnabled = enabled;
-        this.client = client;
-        this.async = schema.async;
-        this.enumData = schema.enumData;
-        this.rateLimit = schema.rateLimit;
-        this.dontSpread = schema.dontSpread;
-        this.autoFlatten = schema.autoFlatten;
-        this.rereference = schema.rereference;
-        this.dataBatching = schema.dataBatching;
-        this.maxBatchSize = client ? Infinity : schema.maxBatchSize;
-        this.gzipCompression = schema.gzipCompression;
-        this.object = schema.object;
-        if (schema.testObject()) {
-            this.type = schema.type;
-            this.dataMax = schema.dataMax;
-            this.dataMin = schema.dataMin;
-            // @ts-expect-error
-            this.maxSize = this.type.length;
-            // @ts-expect-error
-            this.minSize = this.type.length;
-            // trst me bro..
-            this.receiveProcessor = (0, PacketProcessors_1.createObjReceiveProcessor)(this);
-            this.sendProcessor = (0, PacketProcessors_1.createObjSendProcessor)(this);
-            this.validator = (0, PacketProcessors_1.createObjValidator)(this);
-        }
-        else {
-            this.type = schema.type;
-            this.dataMax = schema.dataMax;
-            this.dataMin = schema.dataMin;
-            this.maxSize = this.dataMax;
-            this.minSize = this.dataMin;
-            // @ts-expect-error
-            this.receiveProcessor = (0, PacketProcessors_1.createReceiveProcessor)(this.type, this.enumData, this.dataMax);
-            // @ts-expect-error
-            this.sendProcessor = (0, PacketProcessors_1.createSendProcessor)(this.type, this.gzipCompression, this.rereference);
-            // @ts-expect-error
-            this.validator = (0, PacketProcessors_1.createValidator)(this.type, this.dataMax, this.dataMin, this, this.gzipCompression, this.rereference);
-        }
-        this.processReceive = (data, validationResult) => this.receiveProcessor(data, validationResult, 0);
-        this.processSend = async (data) => new Uint8Array(await this.sendProcessor(tag, data));
-        this.validate = (data) => this.validator(data, 0);
-        this.customValidator = customValidator;
-    }
-    async listen(value, socket) {
-        try {
-            const [dcData, validationResult] = await this.validate(value);
-            // holy shit i used === to fix another bug
-            if (!this.client && validationResult === false)
-                return "Invalid packet";
-            const processed = this.processReceive(dcData, validationResult);
-            const useableData = this.autoFlatten ? (0, PacketUtils_1.UnFlattenData)(processed) : processed;
-            if (this.customValidator != null) {
-                if (!this.dontSpread) {
-                    if (!this.customValidator(socket, ...useableData))
-                        return "Didn't pass custom validator";
-                }
-                else {
-                    if (!this.customValidator(socket, useableData))
-                        return "Didn't pass custom validator";
-                }
-            }
-            return [useableData, !this.dontSpread];
-        }
-        catch (err) {
-            console.error("There was an error processing the packet! This is probably my fault... report at https://github.com/liwybloc/sonic-ws", err);
-            return "Error: " + err;
-        }
-    }
-    serialize() {
-        // shared values for both
-        const sharedData = [
-            this.tag.length, ...(0, StringUtil_1.processCharCodes)(this.tag),
-            (0, CompressionUtil_1.compressBools)([this.dontSpread, this.async, this.object, this.autoFlatten, this.gzipCompression, this.rereference]),
-            this.dataBatching,
-            this.enumData.length, ...this.enumData.map(x => x.serialize()).flat(),
-        ];
-        // single-value packet (not an object schema)
-        if (!this.object) {
-            return [
-                ...sharedData, // shared
-                ...(0, CompressionUtil_1.convertVarInt)(this.dataMax), // the data max
-                ...(0, CompressionUtil_1.convertVarInt)(this.dataMin), // the data min
-                this.type,
-            ];
-        }
-        // object packet
-        return [
-            ...sharedData,
-            this.maxSize, // size
-            ...this.dataMax.map(CompressionUtil_1.convertVarInt).flat(), // all data maxes, serialized
-            ...this.dataMin.map(CompressionUtil_1.convertVarInt).flat(), // all data mins, serialized
-            ...this.type, // all types
-        ];
-    }
-    static readVarInts(data, offset, size) {
-        const res = [];
-        for (let i = 0; i < size; i++) {
-            const [off, varint] = (0, CompressionUtil_1.readVarInt)(data, offset);
-            offset = off;
-            res.push(varint);
-        }
-        return [res, offset];
-    }
-    static deserialize(data, offset, client) {
-        const beginningOffset = offset;
-        // read length, go up 1
-        const tagLength = data[offset++];
-        // read tag as it's up 1, and add offset
-        const tag = (0, BufferUtil_1.as8String)(data.slice(offset, offset += tagLength));
-        // then read dontSpread and async
-        const [dontSpread, async, isObject, autoFlatten, gzipCompression, rereference] = (0, CompressionUtil_1.decompressBools)(data[offset++]);
-        // read batching, up 1
-        const dataBatching = data[offset++];
-        // read enum length, up 1
-        const enumLength = data[offset++];
-        const enums = [];
-        for (let i = 0; i < enumLength; i++) {
-            // read tag length, go up 1
-            const enumTagLength = data[offset++];
-            // up 1 so read offset -> offset += tag length, to add tag length and skip over it
-            const enumTag = (0, BufferUtil_1.as8String)(data.slice(offset, offset += enumTagLength));
-            // read amount of values
-            const valueCount = data[offset++];
-            const values = [];
-            for (let j = 0; j < valueCount; j++) {
-                // read the length of the value, go up 1
-                const valueLength = data[offset++];
-                // then read the type of value, up 1
-                const valueType = data[offset++];
-                // now can just read the values, increase offset for later use
-                const value = (0, BufferUtil_1.as8String)(data.slice(offset, offset += valueLength));
-                // process it
-                values.push(EnumType_1.TYPE_CONVERSION_MAP[valueType](value));
-            }
-            // define the enum with the values
-            enums.push((0, EnumHandler_1.DefineEnum)(enumTag, values));
-        }
-        // objects
-        if (isObject) {
-            // read size
-            const size = data[offset++];
-            // read var ints for the datamaxes
-            const [dataMaxes, o1] = this.readVarInts(data, offset, size);
-            offset = o1;
-            // read var ints for the datamins
-            const [dataMins, o2] = this.readVarInts(data, offset, size);
-            offset = o2;
-            // get types, skip past size since there'll be size of these
-            const types = Array.from(data.slice(offset, offset += size));
-            // convert any enums into their indexed form for best bandwidth
-            let index = 0;
-            const finalTypes = types.map(x => x == PacketType_1.PacketType.ENUMS ? enums[index++] : x); // convert enums to their enum packages
-            // make schema
-            const schema = PacketSchema.object(finalTypes, dataMaxes, dataMins, dontSpread, autoFlatten, dataBatching, -1, -1, async, gzipCompression);
-            return [
-                new Packet(tag, schema, null, false, client),
-                // +1 to go next
-                (offset - beginningOffset),
-            ];
-        }
-        // single packet
-        // read varint for datamax
-        const [o1, dataMax] = (0, CompressionUtil_1.readVarInt)(data, offset);
-        offset = o1;
-        // read varint for datamin
-        const [o2, dataMin] = (0, CompressionUtil_1.readVarInt)(data, offset);
-        offset = o2;
-        // read type
-        const type = data[offset++];
-        // do enum stuff
-        const finalType = type == PacketType_1.PacketType.ENUMS ? enums[0] : type; // convert enum to enum package
-        // make schema
-        const schema = PacketSchema.single(finalType, dataMax, dataMin, dontSpread, dataBatching, -1, -1, async, gzipCompression, rereference);
-        return [
-            new Packet(tag, schema, null, false, client),
-            (offset - beginningOffset),
-        ];
-    }
-    static deserializeAll(data, client) {
-        const arr = [];
-        let offset = 0;
-        while (offset < data.length) {
-            const [packet, len] = this.deserialize(data, offset, client);
-            arr.push(packet);
-            offset += len;
-        }
-        return arr;
-    }
-}
-exports.Packet = Packet;
-class PacketSchema {
-    type;
-    dataMax;
-    dataMin;
-    dataBatching = 0;
-    maxBatchSize = 10;
-    rateLimit = 0;
-    enumData = [];
-    dontSpread = false;
-    autoFlatten = false;
-    async = false;
-    rereference = false;
-    gzipCompression = false;
-    object;
-    constructor(object) {
-        this.object = object;
-    }
-    testObject() {
-        return this.object;
-    }
-    static single(type, dataMax, dataMin, dontSpread, dataBatching, maxBatchSize, rateLimit, async, gzipCompression, rereference) {
-        const schema = new PacketSchema(false);
-        if (typeof type == 'number') {
-            schema.type = type;
-            if (type == PacketType_1.PacketType.NONE)
-                dataMax = dataMin = 0; // remove garbage data issues
-        }
-        else {
-            schema.type = PacketType_1.PacketType.ENUMS;
-            schema.enumData = [type];
-        }
-        schema.async = async;
-        schema.dataMin = dataMin;
-        schema.dataMax = dataMax;
-        schema.rateLimit = rateLimit;
-        schema.dontSpread = dontSpread;
-        schema.rereference = rereference;
-        schema.dataBatching = dataBatching;
-        schema.maxBatchSize = maxBatchSize;
-        schema.gzipCompression = gzipCompression;
-        return schema;
-    }
-    static object(types, dataMaxes, dataMins, dontSpread, autoFlatten, dataBatching, maxBatchSize, rateLimit, async, gzipCompression) {
-        if (types.length != dataMaxes.length || types.length != dataMins.length)
-            throw new Error("There is an inbalance between the amount of types, data maxes, and data mins!");
-        const schema = new PacketSchema(true);
-        schema.type = [];
-        types.forEach(type => {
-            if (typeof type == 'number') {
-                schema.type.push(type);
-            }
-            else {
-                schema.type.push(PacketType_1.PacketType.ENUMS);
-                schema.enumData.push(type);
-            }
-        });
-        schema.async = async;
-        schema.dataMin = dataMins;
-        schema.dataMax = dataMaxes;
-        schema.rateLimit = rateLimit;
-        schema.dontSpread = dontSpread;
-        schema.autoFlatten = autoFlatten;
-        schema.dataBatching = dataBatching;
-        schema.maxBatchSize = maxBatchSize;
-        schema.gzipCompression = gzipCompression;
-        return schema;
-    }
-}
-exports.PacketSchema = PacketSchema;
+
+Object.defineProperty(exports,"__esModule",{value:!0}),exports.PacketSchema=exports.Packet=void 0;const t=require("../util/enums/EnumHandler"),e=require("../util/enums/EnumType"),a=require("../util/packets/CompressionUtil"),s=require("../util/packets/PacketUtils"),i=require("./PacketProcessors"),r=require("./PacketType"),n=require("../util/StringUtil");class o{defaultEnabled;tag;maxSize;minSize;type;enumData;dataMax;dataMin;dataBatching;maxBatchSize;dontSpread;autoFlatten;rateLimit;async;rereference;gzipCompression;object;client;receiveProcessor;sendProcessor;validator;processReceive;processSend;validate;customValidator;lastReceived={};lastSent={};constructor(t,e,a,s,n){if(this.tag=t,this.defaultEnabled=s,this.client=n,this.async=e.async,this.enumData=e.enumData,this.rateLimit=e.rateLimit,this.dontSpread=e.dontSpread,this.autoFlatten=e.autoFlatten,this.rereference=e.rereference,this.dataBatching=e.dataBatching,this.maxBatchSize=n?1/0:e.maxBatchSize,this.gzipCompression=e.gzipCompression,this.object=e.object,this.type=e.type,this.dataMax=e.dataMax,this.dataMin=e.dataMin,e.testObject(this)){this.maxSize=this.minSize=this.type.length;for(let t=0;t<this.type.length;t++)this.type[t]==r.PacketType.NONE&&(this.dataMax[t]=this.dataMin[t]=0);this.receiveProcessor=(0,i.createObjReceiveProcessor)(this),this.sendProcessor=(0,i.createObjSendProcessor)(this),this.validator=(0,i.createObjValidator)(this)}else this.maxSize=this.dataMax,this.minSize=this.dataMin,this.type==r.PacketType.NONE&&(this.dataMax=this.dataMin=0),this.receiveProcessor=(0,i.createReceiveProcessor)(this.type,this.enumData,this.dataMax),this.sendProcessor=(0,i.createSendProcessor)(this.type,this.gzipCompression,0!=this.dataBatching),this.validator=(0,i.createValidator)(this.type,this.dataMax,this.dataMin,this,this.gzipCompression);this.processReceive=(t,e)=>this.receiveProcessor(t,e,0),this.processSend=async e=>new Uint8Array(await this.sendProcessor(t,e)),this.validate=t=>this.validator(t,0),this.customValidator=a}async listen(t,e){try{const[a,i]=await this.validate(t);if(!this.client&&!1===i)return"Invalid packet";const r=this.processReceive(a,i),n=this.autoFlatten?(0,s.UnFlattenData)(r):r;if(null!=this.customValidator)if(this.dontSpread){if(!this.customValidator(e,n))return"Didn't pass custom validator"}else if(!this.customValidator(e,...n))return"Didn't pass custom validator";return[n,!this.dontSpread]}catch(t){return console.error("There was an error processing the packet! This is probably my fault... report at https://github.com/liwybloc/sonic-ws",t),"Error: "+t}}serialize(){const t=[this.tag.length,...(0,n.processCharCodes)(this.tag),(0,a.compressBools)([this.dontSpread,this.async,this.object,this.autoFlatten,this.gzipCompression,this.rereference]),this.dataBatching,this.enumData.length,...this.enumData.map(t=>t.serialize()).flat()];return this.object?[...t,this.maxSize,...this.dataMax.map(a.convertVarInt).flat(),...this.dataMin.map(a.convertVarInt).flat(),...this.type]:[...t,...(0,a.convertVarInt)(this.dataMax),...(0,a.convertVarInt)(this.dataMin),this.type]}static readVarInts(t,e,s){const i=[];for(let r=0;r<s;r++){const[s,r]=(0,a.readVarInt)(t,e);e=s,i.push(r)}return[i,e]}static deserialize(s,i,c){const d=i,l=s[i++],p=(0,n.as8String)(s.slice(i,i+=l)),[u,m,y,S,g,P]=(0,a.decompressBools)(s[i++]),f=s[i++],M=s[i++],v=[];for(let a=0;a<M;a++){const a=s[i++],r=(0,n.as8String)(s.slice(i,i+=a)),o=s[i++],c=[];for(let t=0;t<o;t++){const t=s[i++],a=s[i++],r=(0,n.as8String)(s.slice(i,i+=t));c.push(e.TYPE_CONVERSION_MAP[a](r))}v.push((0,t.DefineEnum)(r,c))}if(y){const t=s[i++],[e,a]=this.readVarInts(s,i,t);i=a;const[n,l]=this.readVarInts(s,i,t);i=l;const y=Array.from(s.slice(i,i+=t));let P=0;const M=y.map(t=>t==r.PacketType.ENUMS?v[P++]:t),x=new h(!0,M,m,n,e,-1,u,S,!1,f,-1,g);return[new o(p,x,null,!1,c),i-d]}const[x,z]=(0,a.readVarInt)(s,i);i=x;const[b,V]=(0,a.readVarInt)(s,i);i=b;const k=s[i++],j=k==r.PacketType.ENUMS?v[0]:k,B=new h(!1,j,m,V,z,-1,u,!1,P,f,-1,g);return[new o(p,B,null,!1,c),i-d]}static deserializeAll(t,e){const a=[];let s=0;for(;s<t.length;){const[i,r]=this.deserialize(t,s,e);a.push(i),s+=r}return a}}exports.Packet=o;const c=(t,a)=>t instanceof e.EnumPackage?(a.push(t),r.PacketType.ENUMS):t;class h{type;enumData=[];dataMax;dataMin;dataBatching;maxBatchSize;rateLimit;dontSpread=!1;autoFlatten=!1;async=!1;rereference=!1;gzipCompression=!1;object;constructor(t,e,a,s,i,r,n,o,h,d,l,p){this.object=t,this.async=a,this.dataMin=s,this.dataMax=i,this.rateLimit=r,this.dontSpread=n,this.autoFlatten=o,this.rereference=h,this.dataBatching=d,this.maxBatchSize=l,this.gzipCompression=p,this.type=t?e.map(t=>c(t,this.enumData)):c(e,this.enumData)}testObject(t){return this.object}}exports.PacketSchema=h;

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

@@ -1,30 +1,24 @@
+/**
+ * Copyright 2026 Lily (liwybloc)
+ * Licensed under the Apache License, Version 2.0.
+ */
 import * as WS from 'ws';
-import { SonicWSServer } from './SonicWSServer';
-import { Packet } from '../packets/Packets';
-import { Connection } from '../Connection';
-import { ConnectionMiddleware, FuncKeys } from '../PacketProcessor';
-export declare class SonicWSConnection implements Connection {
-    /** Raw 'ws' library socket */
-    socket: WS.WebSocket;
+import { SonicWSServer } from "./SonicWSServer";
+import { Packet } from "../packets/Packets";
+import { Connection } from "../Connection";
+export declare class SonicWSConnection extends Connection<WS.WebSocket, Buffer> {
     private host;
-    private listeners;
     private print;
-    private name;
     private handshakePacket;
     private handshakeLambda;
     private messageLambda;
     private handshakedMessageLambda;
-    private batcher;
     private rater;
     private enabledPackets;
     /** If the packet handshake has been completed; `wss.requireHandshake(packet)` */
     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, (closed: boolean) => void, boolean]>;
     private asyncMap;
     private asyncData;
-    private closed;
     constructor(socket: WS.WebSocket, host: SonicWSServer, id: number, handshakePacket: string | null, clientRateLimit: number, serverRateLimit: number);
     private parseData;
     private handshakeHandler;
@@ -34,9 +28,6 @@ export declare class SonicWSConnection implements Connection {
     private packetQueue;
     private listenPacket;
     private messageHandler;
-    private middlewares;
-    addMiddleware(middleware: ConnectionMiddleware): void;
-    callMiddleware<K extends FuncKeys<ConnectionMiddleware> & keyof ConnectionMiddleware>(method: K, ...values: Parameters<NonNullable<Extract<ConnectionMiddleware[K], (...args: any[]) => any>>>): Promise<boolean>;
     /**
      * Enables a packet for the client.
      * @param tag The tag of the packet
@@ -47,11 +38,6 @@ export declare class SonicWSConnection implements Connection {
      * @param tag The tag of the packet
      */
     disablePacket(tag: string): void;
-    /**
-     * Checks if the connection is closed
-     * @returns If it's closed or not
-     */
-    isClosed(): boolean;
     /**
      * Listens for when the connection closes
      * @param listener Called when it closes
@@ -91,23 +77,10 @@ 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, callOnClose?: boolean): number;
-    setInterval(call: () => void, time: number, callOnClose?: boolean): number;
-    clearTimeout(id: number): void;
-    clearInterval(id: number): void;
     /**
      * Tags the socket with a key
      * @param tag The tag to add
      * @param replace If it should replace a previous tag; defaults to true. If using false, you can add multiple tags.
      */
     tag(tag: string, replace?: boolean): void;
-    /**
-     * Sets the name of this connection for the debug menu; good for setting e.g. usernames on games
-     */
-    setName(name: string): Promise<void>;
-    /**
-     * @returns Name of the socket, defaults to Socket [ID] unless set with setName()
-     */
-    getName(): string;
 }