sonic-ws 1.3.3 → 2.0.0

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

@@ -1,283 +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.processPacket = processPacket;
-exports.listenPacket = listenPacket;
-exports.CreatePacket = CreatePacket;
-exports.CreateObjPacket = CreateObjPacket;
-exports.CreateEnumPacket = CreateEnumPacket;
-exports.CreateKeyEffective = CreateKeyEffective;
-exports.FlattenData = FlattenData;
-exports.UnFlattenData = UnFlattenData;
-const Packets_1 = require("../../packets/Packets");
-const PacketType_1 = require("../../packets/PacketType");
-const EnumType_1 = require("../enums/EnumType");
-const CompressionUtil_1 = require("./CompressionUtil");
-const HashUtil_1 = require("./HashUtil");
-/**
- * Processes and verifies values into a sendable format
- * @param packets Packet holder
- * @param tag The tag of the packet
- * @param values The values
- * @returns The indexed code, the data, and the packet schema
- * @internal
- */
-async function processPacket(packets, tag, values, sendQueue, id, force = false) {
-    const code = packets.getKey(tag);
-    const packet = packets.getPacket(tag);
-    return handleQueue(sendQueue, packets, id, tag, values, force, async () => {
-        if (packet.rereference) {
-            if (id === -1)
-                throw new Error("Cannot send a re-referenced packet from the server-wide sender!");
-            const serialized = (0, HashUtil_1.hashValue)(values);
-            if (packet.lastSent[id] === serialized) {
-                return [code, CompressionUtil_1.EMPTY_UINT8, packet];
-            }
-            packet.lastSent[id] = serialized;
-        }
-        if (packet.autoFlatten) {
-            values = FlattenData(values[0]);
-        }
-        else {
-            if (values.length > packet.maxSize)
-                throw new Error(`Packet "${tag}" only allows ${packet.maxSize} values!`);
-            if (values.length < packet.minSize)
-                throw new Error(`Packet "${tag}" requires at least ${packet.minSize} values!`);
-        }
-        if (!packet.object) {
-            if (packet.type !== PacketType_1.PacketType.JSON) {
-                const found = values.find(v => typeof v === 'object' && v != null);
-                if (found)
-                    console.warn(`Passing an array will result in undefined behavior (${JSON.stringify(found)}). Spread the array with ...arr`);
-            }
-        }
-        else {
-            values = values.map(x => !Array.isArray(x) ? [x] : x);
-            if (!packet.autoFlatten) {
-                const dataMins = packet.dataMin;
-                const dataMaxes = packet.dataMax;
-                for (let i = 0; i < dataMins.length; i++) {
-                    if (values[i].length < dataMins[i])
-                        throw new Error(`Section ${i + 1} of packet "${tag}" requires at least ${dataMins[i]} values!`);
-                    if (values[i].length > dataMaxes[i])
-                        throw new Error(`Section ${i + 1} of packet "${tag}" only allows ${dataMaxes[i]} values!`);
-                }
-            }
-        }
-        const sendData = values.length > 0 ? await packet.processSend(values) : CompressionUtil_1.EMPTY_UINT8;
-        return [code, sendData, packet];
-    });
-}
-/**
- * @internal
- */
-async function handleQueue(sendQueue, packets, id, tag, values, force, fn) {
-    if (sendQueue[0] && !force) {
-        return new Promise((resolve) => sendQueue[1].push([resolve, tag, values]));
-    }
-    sendQueue[0] = true;
-    const result = await fn();
-    if (sendQueue[1].length > 0) {
-        const [resolve, nextTag, nextValues] = sendQueue[1].shift();
-        queueMicrotask(async () => {
-            resolve(await processPacket(packets, nextTag, nextValues, sendQueue, id, true));
-        });
-    }
-    else {
-        sendQueue[0] = false;
-    }
-    return result;
-}
-/**
- * Calls the listener for a packet with error callback
- * @param listened The listened data
- * @param listeners The listeners to run
- * @param errorCB The callback if something goes wrong
- * @internal
- */
-async function listenPacket(listened, listeners, errorCB) {
-    if (typeof listened === 'string')
-        return errorCB(listened);
-    const [processed, flatten] = listened;
-    try {
-        if (flatten && Array.isArray(processed)) {
-            for (const l of listeners) {
-                await l(...processed);
-            }
-        }
-        else {
-            for (const l of listeners) {
-                await l(processed);
-            }
-        }
-    }
-    catch (err) {
-        console.error(err);
-        errorCB(err);
-    }
-}
-/**
- * Determines if a type is a invalid packet type
- * @param type A possible type
- * @internal
- */
-function isInvalidType(type) {
-    return (!(typeof type == 'number' && type in PacketType_1.PacketType) && !(type instanceof EnumType_1.EnumPackage)) || type == PacketType_1.PacketType.KEY_EFFECTIVE;
-}
-const MAX_DATA_MAX = 2048383;
-/** Clamps data max between 0 and MAX_DATA_MAX @internal */
-function clampDataMax(dataMax) {
-    if (dataMax < 0) {
-        console.warn(`Having a data maximum below 0 does not do anything!`);
-        return 0;
-    }
-    // dfkjgsdkfgjk
-    if (dataMax > MAX_DATA_MAX) {
-        console.warn(`Only ${MAX_DATA_MAX} values can be sent on a type! Uhh make an issue if you want to send more.`);
-        return MAX_DATA_MAX;
-    }
-    return dataMax;
-}
-/** Clamps data min between 0 and datamax @internal */
-function clampDataMin(dataMin, dataMax) {
-    if (dataMin < 0) {
-        console.warn(`Having a data minimum below 0 does not do anything!`);
-        return 0;
-    }
-    // also catches >MAX_DATA_MAX
-    if (dataMin > dataMax) {
-        console.warn(`Data minimum can not be higher than the data maximum!`);
-        return dataMax;
-    }
-    return dataMin;
-}
-/**
- * Creates a structure for a simple single-typed packet.
- * This packet can be sent and received with the specified tag, type, and data cap.
- * @param settings The settings object containing `tag`, `type`, `dataMax`, `dataMin`, `noDataRange`, `dontSpread`, `validator`, `dataBatching`, and/or `maxBatchSize`.
- * @returns The constructed packet structure data.
- * @throws {Error} If the `type` is invalid.
- */
-function CreatePacket(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, async = false, gzipCompression = type == PacketType_1.PacketType.JSON, rereference = false } = settings;
-    if (!tag)
-        throw new Error("Tag not selected!");
-    if (noDataRange) {
-        dataMin = rereference ? 1 : 0;
-        dataMax = MAX_DATA_MAX;
-    }
-    else if (dataMin == undefined)
-        dataMin = type == PacketType_1.PacketType.NONE ? 0 : dataMax;
-    if (rereference && dataMin == 0)
-        throw new Error("Rereference cannot be true if the dataMin is 0");
-    if (isInvalidType(type)) {
-        throw new Error(`Invalid packet type: ${type}`);
-    }
-    const schema = new Packets_1.PacketSchema(false, type, async, clampDataMin(dataMin, dataMax), clampDataMax(dataMax), rateLimit, dontSpread, false, rereference, dataBatching, maxBatchSize, gzipCompression);
-    return new Packets_1.Packet(tag, schema, validator, enabled, false);
-}
-/**
- * Creates a structure for an object (multi-typed) packet.
- * This packet allows multiple types and their associated data caps.
- * @param settings The settings object containing `tag`, `types`, `dataMaxes`, `dataMins`, `noDataRange`, `dontSpread`, `autoFlatten`, `largePacket`, `validator`, `dataBatching`, and/or `maxBatchSize`.
- * @returns The constructed packet structure data.
- * @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, async = false, gzipCompression = types && types.includes(PacketType_1.PacketType.JSON) } = settings;
-    if (!tag)
-        throw new Error("Tag not selected!");
-    if (!types || types.length == 0)
-        throw new Error("Types is set to 0 length");
-    for (const type of types) {
-        if (!isInvalidType(type))
-            continue;
-        throw new Error(`Invalid packet type in "${tag}" packet: ${type}`);
-    }
-    if (noDataRange) {
-        dataMaxes = Array.from({ length: types.length }).map(() => MAX_DATA_MAX);
-        dataMins = Array.from({ length: types.length }).map(() => 0);
-    }
-    else {
-        if (dataMaxes == undefined)
-            dataMaxes = Array.from({ length: types.length }).map(() => 1);
-        else if (!Array.isArray(dataMaxes))
-            dataMaxes = Array.from({ length: types.length }).map(() => dataMaxes);
-        if (dataMins == undefined)
-            dataMins = Array.from({ length: types.length }).map((_, i) => dataMaxes[i]);
-        else if (!Array.isArray(dataMins))
-            dataMins = Array.from({ length: types.length }).map(() => dataMins);
-    }
-    const clampedDataMaxes = dataMaxes.map(clampDataMax);
-    const clampedDataMins = dataMins.map((m, i) => types[i] == PacketType_1.PacketType.NONE ? 0 : clampDataMin(m, clampedDataMaxes[i]));
-    const schema = new Packets_1.PacketSchema(true, types, async, clampedDataMins, clampedDataMaxes, rateLimit, dontSpread, autoFlatten, false, dataBatching, maxBatchSize, gzipCompression);
-    return new Packets_1.Packet(tag, schema, validator, enabled, false);
-}
-/**
- * Creates and defines an enum packet. This can be used to create an enum-based packet
- * with a specific tag and possible values.
- * @param settings The settings object containing `tag`, `enumTag`, `values`, `dataMax`, `dataMin`, `noDataRange`, `dontSpread`, `validator`, `dataBatching`, and/or `maxBatchSize`.
- * @returns The constructed packet structure data.
- */
-function CreateEnumPacket(settings) {
-    const { tag, enumData, dataMax = 1, dataMin = 0, noDataRange = false, dontSpread = false, validator = null, dataBatching = 0, maxBatchSize = 10, rateLimit = 0, enabled = true, async = false } = settings;
-    return CreatePacket({
-        tag: tag,
-        type: enumData,
-        dataMax,
-        dataMin,
-        noDataRange,
-        dontSpread,
-        validator,
-        dataBatching,
-        maxBatchSize,
-        rateLimit,
-        enabled,
-        async,
-    });
-}
-function CreateKeyEffective(settings) {
-    const { tag, count = 2, validator = null, async = false } = settings;
-    if (!tag)
-        throw new Error("Tag not selected!");
-    if (count < 2)
-        throw new Error("Must have at least 2 key consumptions on key effective packet!");
-    throw new Error("Currently W.I.P.");
-}
-/**
- * Flattens a 2-depth array for efficient wire transfer
- * Turns [[x,y,z],[x,y,z]...] to [[x,x...],[y,y...],[z,z...]]
- * @param array A 2-depth array of multi-valued
- */
-function FlattenData(arr) {
-    if (arr == null)
-        return [];
-    const setup = arr[0];
-    if (setup == null)
-        return [];
-    if (!Array.isArray(setup))
-        throw new Error(`Cannot flatten array: ${arr}`);
-    return setup.map((_, i) => arr.map(row => row[i])) ?? [];
-}
-/**
- * Unflattens an array into 2-depth; reverse of FlattenData()
- * turns [[x,x...],[y,y...],[z,z...]] to [[x,y,z],[x,y,z]...]
- * @param array A flattened array
- */
-function UnFlattenData(arr) {
-    return arr[0]?.map((_, i) => arr.map(col => col[i])) ?? [];
-}

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

@@ -1 +0,0 @@
-export {};

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

@@ -1,66 +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.RateHandler = void 0;
-const Connection_1 = require("../../Connection");
-/** @internal */
-class RateHandler {
-    rates = {};
-    limits = {};
-    setInterval;
-    socket;
-    constructor(host) {
-        // shared values
-        this.setInterval = host.setInterval;
-        this.socket = host.socket;
-    }
-    start() {
-        // no rates? don't start an interval
-        if (Object.keys(this.rates).length == 0)
-            return;
-        this.setInterval(() => {
-            for (const tag in this.rates) {
-                this.rates[tag] = 0;
-            }
-        }, 1000);
-    }
-    registerRate(tag, limit) {
-        // ignore no limits
-        if (limit == 0)
-            return;
-        this.rates[tag] = 0;
-        this.limits[tag] = limit;
-    }
-    registerAll(packetHolder, prefix) {
-        const packets = packetHolder.getPackets();
-        for (const packet of packets)
-            this.registerRate(prefix + packetHolder.getKey(packet.tag), packet.rateLimit);
-    }
-    trigger(tag) {
-        if (tag in this.rates && ++this.rates[tag] > this.limits[tag]) {
-            this.socket.close(Connection_1.CloseCodes.RATELIMIT);
-            return true;
-        }
-        return false;
-    }
-    subtract(tag) {
-        if (!(tag in this.rates))
-            return;
-        this.rates[tag]--;
-    }
-}
-exports.RateHandler = RateHandler;