pw-js-world 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Doomester
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,67 @@
+# pw-js-world
+
+This is a helper for the main library [PW-JS-Api](https://www.npmjs.com/package/pw-js-api) (since v0.2.1).
+
+## Installation
+
+To install this dependency, you must install PW-JS-Api first before installing this helper.
+
+NPM:
+```bash
+npm i pw-js-api pw-js-world
+```
+
+PNPM:
+```bash
+pnpm i pw-js-api pw-js-world
+```
+
+Yarn:
+```bash
+yarn add pw-js-api pw-js-world
+```
+
+Bun:
+```bash
+bun i pw-js-api pw-js-world
+```
+
+## Usage
+
+The code below shows an example, it does not do anything but you will get an idea on what you're expected to do before being able to use this.
+
+```ts
+import { BlockNames, PWApiClient } from "pw-js-api";
+import { PWGameWorldHelper } from "pw-js-world";
+
+const api = new PWApiClient(<YOUR_EMAIL>, <YOUR_PASSWORD>);
+const helper = new PWGameWorldHelper();
+
+await api.authenticate();
+
+const con = await api.joinWorld(<WORLD_ID>, {
+    gameSettings: {
+        handlePackets: ["PING", "INIT"]
+    }
+});
+
+con
+// This is important, you must add the hook as soon as you get the
+// connection before it receives init event.
+.addHook(helper.receiveHook)
+.addCallback("playerInitPacket", (data, states) => {
+    console.log("Logged in as " + states?.player?.username);
+})
+.addCallback("worldBlockPlacedPacket", (data, states) => {
+    console.log("Prev Block Id: " + states?.oldBlocks[0].bId);
+    console.log("Prev Block Args: " + states?.oldBlocks[0].args);
+    console.log("New Block Id: " + states?.newBlocks[0].bId);
+    console.log("New Block Args: " + states?.newBlocks[0].args);
+});
+```
+
+Once you have added the hook, the states (second parameter) in some of the callbacks will have the variables populated, allowing you to get the player object directly without needing to do yourself.
+
+They may be undefined if the events occur before the initialisation of helper (which can happen in the first two seconds since the bot joins).
+
+Alternatively, you can export and use the helper directly yourself if you want.

package/dist/Block.d.ts

@@ -0,0 +1,117 @@
+import { BlockNames } from "pw-js-api";
+import type { BlockArg, Point, SendableBlockPacket } from "./types";
+import BufferReader, { ComponentTypeHeader } from "./BufferReader";
+import { LayerType } from "./Constants";
+export default class Block {
+    bId: number;
+    args: BlockArg[];
+    constructor(bId: number | keyof typeof BlockNames, args?: BlockArg[]);
+    /**
+     * I mean... Just use .args.length !== 0 to see if it has args.
+     *
+     * But anyway, this will return true if there is at least one args, otherwise false.
+     */
+    hasArgs(): boolean;
+    /**
+     * For helper.
+     *
+     * This is in Block class for organisation.
+     *
+     * This will deserialise by using the reader to get the block ID then retrieve the args, if applicable.
+     */
+    static deserialize(reader: BufferReader): Block;
+    protected deserializeArgs(reader: BufferReader, flag?: boolean): this;
+    /**
+     * For helper.
+     *
+     * This is in Block class for organisation.
+     */
+    static deserializeArgs(blockId: number, reader: BufferReader, flag?: boolean): BlockArg[];
+    /**
+     * Serializes the block into a buffer. This is used to convert
+     * the block into a binary format that can be sent over the game
+     * server. As this is static, block id and args are required.
+     *
+     * - Little Endian
+     * - With Id
+     * - Type Byte omitted
+     */
+    static serializeArgs(bId: number, args: BlockArg[]): Buffer;
+    /**
+     * Serializes the block into a buffer. This is used to convert
+     * the block into a binary format that can be sent over the game
+     * server. As this is static, block id and args are required.
+     *
+     * - Big Endian
+     * - No Id
+     * - Type Byte included
+     */
+    static serializeArgs(bId: number, args: BlockArg[], options: {
+        endian: "big";
+        writeId: false;
+        readTypeByte: true;
+    }): Buffer;
+    /**
+     *
+     * @param pos List of points (X and Y)
+     */
+    toPacket(pos: Point[], layer: LayerType): SendableBlockPacket;
+    toPacket(x: number, y: number, layer: LayerType): SendableBlockPacket;
+    /**
+     * This will return the block name in UPPER_CASE form.
+     *
+     * For eg EFFECTS_INVULNERABILITY.
+     */
+    get name(): keyof typeof BlockNames;
+    /**
+     * Returns a copy of the block.
+     */
+    clone(obj?: false): Block;
+    clone(obj: true): {
+        bId: number;
+        args: BlockArg[];
+        name: string;
+    };
+}
+/**
+ * This mapping contains definitions of block data which require additional
+ * arguments to be sent or received with.
+ */
+export declare const BlockArgsHeadings: {
+    readonly COIN_GOLD_DOOR: readonly [ComponentTypeHeader.Int32];
+    readonly COIN_BLUE_DOOR: readonly [ComponentTypeHeader.Int32];
+    readonly COIN_GOLD_GATE: readonly [ComponentTypeHeader.Int32];
+    readonly COIN_BLUE_GATE: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_JUMP_HEIGHT: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_FLY: readonly [ComponentTypeHeader.Boolean];
+    readonly EFFECTS_SPEED: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_INVULNERABILITY: readonly [ComponentTypeHeader.Boolean];
+    readonly EFFECTS_CURSE: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_ZOMBIE: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_GRAVITYFORCE: readonly [ComponentTypeHeader.Int32];
+    readonly EFFECTS_MULTI_JUMP: readonly [ComponentTypeHeader.Int32];
+    readonly TOOL_PORTAL_WORLD_SPAWN: readonly [ComponentTypeHeader.Int32];
+    readonly SIGN_NORMAL: readonly [ComponentTypeHeader.String];
+    readonly SIGN_RED: readonly [ComponentTypeHeader.String];
+    readonly SIGN_GREEN: readonly [ComponentTypeHeader.String];
+    readonly SIGN_BLUE: readonly [ComponentTypeHeader.String];
+    readonly SIGN_GOLD: readonly [ComponentTypeHeader.String];
+    readonly PORTAL: readonly [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32];
+    readonly PORTAL_INVISIBLE: readonly [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32];
+    readonly PORTAL_WORLD: readonly [ComponentTypeHeader.String, ComponentTypeHeader.Int32];
+    readonly SWITCH_LOCAL_TOGGLE: readonly [ComponentTypeHeader.Int32];
+    readonly SWITCH_LOCAL_ACTIVATOR: readonly [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean];
+    readonly SWITCH_LOCAL_RESETTER: readonly [ComponentTypeHeader.Boolean];
+    readonly SWITCH_LOCAL_DOOR: readonly [ComponentTypeHeader.Int32];
+    readonly SWITCH_LOCAL_GATE: readonly [ComponentTypeHeader.Int32];
+    readonly SWITCH_GLOBAL_TOGGLE: readonly [ComponentTypeHeader.Int32];
+    readonly SWITCH_GLOBAL_ACTIVATOR: readonly [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean];
+    readonly SWITCH_GLOBAL_RESETTER: readonly [ComponentTypeHeader.Boolean];
+    readonly SWITCH_GLOBAL_DOOR: readonly [ComponentTypeHeader.Int32];
+    readonly SWITCH_GLOBAL_GATE: readonly [ComponentTypeHeader.Int32];
+    readonly HAZARD_DEATH_DOOR: readonly [ComponentTypeHeader.Int32];
+    readonly HAZARD_DEATH_GATE: readonly [ComponentTypeHeader.Int32];
+    readonly NOTE_DRUM: readonly [ComponentTypeHeader.ByteArray];
+    readonly NOTE_PIANO: readonly [ComponentTypeHeader.ByteArray];
+    readonly NOTE_GUITAR: readonly [ComponentTypeHeader.ByteArray];
+};

package/dist/Block.js

@@ -0,0 +1,156 @@
+import { BlockNames } from "pw-js-api";
+import BufferReader, { ComponentTypeHeader } from "./BufferReader";
+export default class Block {
+    constructor(bId, args) {
+        this.args = [];
+        if (typeof bId === "number")
+            this.bId = bId;
+        else {
+            this.bId = BlockNames[bId];
+        }
+        if (args)
+            this.args = args;
+    }
+    /**
+     * I mean... Just use .args.length !== 0 to see if it has args.
+     *
+     * But anyway, this will return true if there is at least one args, otherwise false.
+     */
+    hasArgs() {
+        return this.args.length !== 0;
+    }
+    /**
+     * For helper.
+     *
+     * This is in Block class for organisation.
+     *
+     * This will deserialise by using the reader to get the block ID then retrieve the args, if applicable.
+     */
+    static deserialize(reader) {
+        return new Block(reader.readUInt32LE()).deserializeArgs(reader);
+    }
+    deserializeArgs(reader, flag = false) {
+        var _a;
+        const format = BlockArgsHeadings[this.name];
+        for (let i = 0; i < ((_a = format === null || format === void 0 ? void 0 : format.length) !== null && _a !== void 0 ? _a : 0); i++) {
+            if (flag) {
+                reader.expectUInt8(format[i]);
+            }
+            this.args[i] = reader.read(format[i], !flag);
+        }
+        return this;
+    }
+    /**
+     * For helper.
+     *
+     * This is in Block class for organisation.
+     */
+    static deserializeArgs(blockId, reader, flag = false) {
+        var _a;
+        const format = BlockArgsHeadings[BlockNames[blockId]];
+        const args = [];
+        for (let i = 0; i < ((_a = format === null || format === void 0 ? void 0 : format.length) !== null && _a !== void 0 ? _a : 0); i++) {
+            if (flag) {
+                reader.expectUInt8(format[i]);
+            }
+            args[i] = reader.read(format[i], !flag);
+        }
+        return args;
+    }
+    static serializeArgs(bId, args, options) {
+        var _a;
+        options || (options = {
+            endian: "little",
+            writeId: true,
+            readTypeByte: false,
+        });
+        const buffer = [];
+        if (options.writeId) {
+            const idBuffer = Buffer.alloc(4);
+            idBuffer.writeUInt32LE(bId);
+            buffer.push(idBuffer);
+        }
+        const blockData = (_a = BlockArgsHeadings[BlockNames[bId]]) !== null && _a !== void 0 ? _a : [];
+        for (let i = 0, len = blockData.length; i < len; i++) {
+            const entry = BufferReader.Dynamic(i, args[i]);
+            buffer.push(entry);
+        }
+        return Buffer.concat(buffer);
+    }
+    toPacket(pos, y, layer) {
+        if (typeof pos === "number") {
+            pos = [{
+                    x: pos, y
+                }];
+            layer = layer !== null && layer !== void 0 ? layer : 0;
+        }
+        else
+            layer = y !== null && y !== void 0 ? y : 0;
+        return {
+            isFillOperation: false,
+            blockId: this.bId,
+            layer,
+            positions: pos,
+            extraFields: Block.serializeArgs(this.bId, this.args, { endian: "big", writeId: false, readTypeByte: true })
+        };
+    }
+    /**
+     * This will return the block name in UPPER_CASE form.
+     *
+     * For eg EFFECTS_INVULNERABILITY.
+     */
+    get name() {
+        return BlockNames[this.bId];
+    }
+    clone(obj = false) {
+        if (obj === true)
+            return { bId: this.bId, args: this.args, name: this.name };
+        return new Block(this.bId, this.args);
+    }
+}
+/**
+ * This mapping contains definitions of block data which require additional
+ * arguments to be sent or received with.
+ */
+export const BlockArgsHeadings = {
+    COIN_GOLD_DOOR: [ComponentTypeHeader.Int32],
+    COIN_BLUE_DOOR: [ComponentTypeHeader.Int32],
+    COIN_GOLD_GATE: [ComponentTypeHeader.Int32],
+    COIN_BLUE_GATE: [ComponentTypeHeader.Int32],
+    EFFECTS_JUMP_HEIGHT: [ComponentTypeHeader.Int32],
+    EFFECTS_FLY: [ComponentTypeHeader.Boolean],
+    EFFECTS_SPEED: [ComponentTypeHeader.Int32],
+    EFFECTS_INVULNERABILITY: [ComponentTypeHeader.Boolean],
+    EFFECTS_CURSE: [ComponentTypeHeader.Int32],
+    EFFECTS_ZOMBIE: [ComponentTypeHeader.Int32],
+    EFFECTS_GRAVITYFORCE: [ComponentTypeHeader.Int32],
+    EFFECTS_MULTI_JUMP: [ComponentTypeHeader.Int32],
+    // gravity effects no data
+    // effects off
+    // effects zombie
+    TOOL_PORTAL_WORLD_SPAWN: [ComponentTypeHeader.Int32],
+    SIGN_NORMAL: [ComponentTypeHeader.String],
+    SIGN_RED: [ComponentTypeHeader.String],
+    SIGN_GREEN: [ComponentTypeHeader.String],
+    SIGN_BLUE: [ComponentTypeHeader.String],
+    SIGN_GOLD: [ComponentTypeHeader.String],
+    PORTAL: [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32],
+    PORTAL_INVISIBLE: [ComponentTypeHeader.Int32, ComponentTypeHeader.Int32, ComponentTypeHeader.Int32],
+    PORTAL_WORLD: [ComponentTypeHeader.String, ComponentTypeHeader.Int32],
+    SWITCH_LOCAL_TOGGLE: [ComponentTypeHeader.Int32],
+    SWITCH_LOCAL_ACTIVATOR: [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean],
+    SWITCH_LOCAL_RESETTER: [ComponentTypeHeader.Boolean],
+    SWITCH_LOCAL_DOOR: [ComponentTypeHeader.Int32],
+    SWITCH_LOCAL_GATE: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_TOGGLE: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_ACTIVATOR: [ComponentTypeHeader.Int32, ComponentTypeHeader.Boolean],
+    SWITCH_GLOBAL_RESETTER: [ComponentTypeHeader.Boolean],
+    SWITCH_GLOBAL_DOOR: [ComponentTypeHeader.Int32],
+    SWITCH_GLOBAL_GATE: [ComponentTypeHeader.Int32],
+    HAZARD_DEATH_DOOR: [ComponentTypeHeader.Int32],
+    HAZARD_DEATH_GATE: [ComponentTypeHeader.Int32],
+    NOTE_DRUM: [ComponentTypeHeader.ByteArray],
+    NOTE_PIANO: [ComponentTypeHeader.ByteArray],
+    NOTE_GUITAR: [ComponentTypeHeader.ByteArray],
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQmxvY2suanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9saWIvQmxvY2sudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLFVBQVUsRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUV2QyxPQUFPLFlBQVksRUFBRSxFQUFFLG1CQUFtQixFQUFFLE1BQU0sZ0JBQWdCLENBQUM7QUFHbkUsTUFBTSxDQUFDLE9BQU8sT0FBTyxLQUFLO0lBSXRCLFlBQVksR0FBcUMsRUFBRSxJQUFpQjtRQUZwRSxTQUFJLEdBQWUsRUFBRSxDQUFDO1FBR2xCLElBQUksT0FBTyxHQUFHLEtBQUssUUFBUTtZQUFFLElBQUksQ0FBQyxHQUFHLEdBQUcsR0FBRyxDQUFDO2FBQ3ZDLENBQUM7WUFDRixJQUFJLENBQUMsR0FBRyxHQUFHLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQztRQUMvQixDQUFDO1FBRUQsSUFBSSxJQUFJO1lBQUUsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7SUFDL0IsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxPQUFPO1FBQ0gsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLE1BQU0sS0FBSyxDQUFDLENBQUM7SUFDbEMsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILE1BQU0sQ0FBQyxXQUFXLENBQUMsTUFBb0I7UUFDbkMsT0FBTyxJQUFJLEtBQUssQ0FBQyxNQUFNLENBQUMsWUFBWSxFQUFFLENBQUMsQ0FBQyxlQUFlLENBQUMsTUFBTSxDQUFDLENBQUM7SUFDcEUsQ0FBQztJQUVTLGVBQWUsQ0FBQyxNQUFvQixFQUFFLElBQUksR0FBRyxLQUFLOztRQUN4RCxNQUFNLE1BQU0sR0FBMkIsaUJBQXlCLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBRTVFLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLE1BQUEsTUFBTSxhQUFOLE1BQU0sdUJBQU4sTUFBTSxDQUFFLE1BQU0sbUNBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQztZQUM3QyxJQUFJLElBQUksRUFBRSxDQUFDO2dCQUNQLE1BQU0sQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDbEMsQ0FBQztZQUVELElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDLEdBQUcsTUFBTSxDQUFDLElBQUksQ0FBQyxNQUFNLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNqRCxDQUFDO1FBRUQsT0FBTyxJQUFJLENBQUM7SUFDaEIsQ0FBQztJQUVEOzs7O09BSUc7SUFDSCxNQUFNLENBQUMsZUFBZSxDQUFDLE9BQWUsRUFBRSxNQUFvQixFQUFFLElBQUksR0FBRyxLQUFLOztRQUN0RSxNQUFNLE1BQU0sR0FBMkIsaUJBQXlCLENBQUMsVUFBVSxDQUFDLE9BQU8sQ0FBQyxDQUFDLENBQUM7UUFFdEYsTUFBTSxJQUFJLEdBQUcsRUFBRSxDQUFDO1FBRWhCLEtBQUssSUFBSSxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUMsR0FBRyxDQUFDLE1BQUEsTUFBTSxhQUFOLE1BQU0sdUJBQU4sTUFBTSxDQUFFLE1BQU0sbUNBQUksQ0FBQyxDQUFDLEVBQUUsQ0FBQyxFQUFFLEVBQUUsQ0FBQztZQUM3QyxJQUFJLElBQUksRUFBRSxDQUFDO2dCQUNQLE1BQU0sQ0FBQyxXQUFXLENBQUMsTUFBTSxDQUFDLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDbEMsQ0FBQztZQUVELElBQUksQ0FBQyxDQUFDLENBQUMsR0FBRyxNQUFNLENBQUMsSUFBSSxDQUFDLE1BQU0sQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQzVDLENBQUM7UUFFRCxPQUFPLElBQUksQ0FBQztJQUNoQixDQUFDO0lBd0JNLE1BQU0sQ0FBQyxhQUFhLENBQUMsR0FBVyxFQUFFLElBQWdCLEVBQUUsT0FBK0U7O1FBQ3RJLE9BQU8sS0FBUCxPQUFPLEdBQUs7WUFDUixNQUFNLEVBQUUsUUFBUTtZQUNoQixPQUFPLEVBQUUsSUFBSTtZQUNiLFlBQVksRUFBRSxLQUFLO1NBQ3RCLEVBQUM7UUFFRixNQUFNLE1BQU0sR0FBYSxFQUFFLENBQUM7UUFFNUIsSUFBSSxPQUFPLENBQUMsT0FBTyxFQUFFLENBQUM7WUFDbEIsTUFBTSxRQUFRLEdBQUcsTUFBTSxDQUFDLEtBQUssQ0FBQyxDQUFDLENBQUMsQ0FBQztZQUNqQyxRQUFRLENBQUMsYUFBYSxDQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQzVCLE1BQU0sQ0FBQyxJQUFJLENBQUMsUUFBUSxDQUFDLENBQUM7UUFDMUIsQ0FBQztRQUVELE1BQU0sU0FBUyxHQUF5QixNQUFDLGlCQUF5QixDQUFDLFVBQVUsQ0FBQyxHQUFHLENBQUMsQ0FBQyxtQ0FBSSxFQUFFLENBQUM7UUFFMUYsS0FBSyxJQUFJLENBQUMsR0FBRyxDQUFDLEVBQUUsR0FBRyxHQUFHLFNBQVMsQ0FBQyxNQUFNLEVBQUUsQ0FBQyxHQUFHLEdBQUcsRUFBRSxDQUFDLEVBQUUsRUFBRSxDQUFDO1lBQ25ELE1BQU0sS0FBSyxHQUFHLFlBQVksQ0FBQyxPQUFPLENBQUMsQ0FBQyxFQUFFLElBQUksQ0FBQyxDQUFDLENBQUMsQ0FBQyxDQUFDO1lBQy9DLE1BQU0sQ0FBQyxJQUFJLENBQUMsS0FBSyxDQUFDLENBQUM7UUFDdkIsQ0FBQztRQUVELE9BQU8sTUFBTSxDQUFDLE1BQU0sQ0FBQyxNQUFNLENBQUMsQ0FBQztJQUNqQyxDQUFDO0lBUUQsUUFBUSxDQUFDLEdBQXFCLEVBQUUsQ0FBUyxFQUFFLEtBQWlCO1FBQ3hELElBQUksT0FBTyxHQUFHLEtBQUssUUFBUSxFQUFFLENBQUM7WUFDMUIsR0FBRyxHQUFHLENBQUM7b0JBQ0gsQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDO2lCQUNaLENBQUMsQ0FBQztZQUVILEtBQUssR0FBRyxLQUFLLGFBQUwsS0FBSyxjQUFMLEtBQUssR0FBSSxDQUFDLENBQUM7UUFDdkIsQ0FBQzs7WUFBTSxLQUFLLEdBQUcsQ0FBQyxhQUFELENBQUMsY0FBRCxDQUFDLEdBQUksQ0FBQyxDQUFDO1FBRXRCLE9BQU87WUFDSCxlQUFlLEVBQUUsS0FBSztZQUN0QixPQUFPLEVBQUUsSUFBSSxDQUFDLEdBQUc7WUFDakIsS0FBSztZQUNMLFNBQVMsRUFBRSxHQUFHO1lBQ2QsV0FBVyxFQUFFLEtBQUssQ0FBQyxhQUFhLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsSUFBSSxFQUFFLEVBQUUsTUFBTSxFQUFFLEtBQUssRUFBRSxPQUFPLEVBQUUsS0FBSyxFQUFFLFlBQVksRUFBRSxJQUFJLEVBQUUsQ0FBQztTQUNqRixDQUFDO0lBQ3BDLENBQUM7SUFFRDs7OztPQUlHO0lBQ0gsSUFBSSxJQUFJO1FBQ0osT0FBTyxVQUFVLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBNEIsQ0FBQztJQUMzRCxDQUFDO0lBT0QsS0FBSyxDQUFDLEdBQUcsR0FBRyxLQUFLO1FBQ2IsSUFBSSxHQUFHLEtBQUssSUFBSTtZQUFFLE9BQU8sRUFBRSxHQUFHLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksRUFBRSxJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUksRUFBRSxDQUFDO1FBRTdFLE9BQU8sSUFBSSxLQUFLLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDMUMsQ0FBQztDQUNKO0FBRUQ7OztHQUdHO0FBQ0gsTUFBTSxDQUFDLE1BQU0saUJBQWlCLEdBQUc7SUFDN0IsY0FBYyxFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQzNDLGNBQWMsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUMzQyxjQUFjLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDM0MsY0FBYyxFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBRTNDLG1CQUFtQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQ2hELFdBQVcsRUFBRSxDQUFDLG1CQUFtQixDQUFDLE9BQU8sQ0FBQztJQUMxQyxhQUFhLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDMUMsdUJBQXVCLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLENBQUM7SUFDdEQsYUFBYSxFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQzFDLGNBQWMsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUMzQyxvQkFBb0IsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUNqRCxrQkFBa0IsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUMvQywwQkFBMEI7SUFDMUIsY0FBYztJQUNkLGlCQUFpQjtJQUVqQix1QkFBdUIsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUVwRCxXQUFXLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxNQUFNLENBQUM7SUFDekMsUUFBUSxFQUFFLENBQUMsbUJBQW1CLENBQUMsTUFBTSxDQUFDO0lBQ3RDLFVBQVUsRUFBRSxDQUFDLG1CQUFtQixDQUFDLE1BQU0sQ0FBQztJQUN4QyxTQUFTLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxNQUFNLENBQUM7SUFDdkMsU0FBUyxFQUFFLENBQUMsbUJBQW1CLENBQUMsTUFBTSxDQUFDO0lBRXZDLE1BQU0sRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssRUFBRSxtQkFBbUIsQ0FBQyxLQUFLLEVBQUUsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQ3pGLGdCQUFnQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxFQUFFLG1CQUFtQixDQUFDLEtBQUssRUFBRSxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDbkcsWUFBWSxFQUFFLENBQUMsbUJBQW1CLENBQUMsTUFBTSxFQUFFLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUVyRSxtQkFBbUIsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssQ0FBQztJQUNoRCxzQkFBc0IsRUFBRSxDQUFDLG1CQUFtQixDQUFDLEtBQUssRUFBRSxtQkFBbUIsQ0FBQyxPQUFPLENBQUM7SUFDaEYscUJBQXFCLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxPQUFPLENBQUM7SUFDcEQsaUJBQWlCLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDOUMsaUJBQWlCLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDOUMsb0JBQW9CLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLENBQUM7SUFDakQsdUJBQXVCLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLEVBQUUsbUJBQW1CLENBQUMsT0FBTyxDQUFDO0lBQ2pGLHNCQUFzQixFQUFFLENBQUMsbUJBQW1CLENBQUMsT0FBTyxDQUFDO0lBQ3JELGtCQUFrQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQy9DLGtCQUFrQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBRS9DLGlCQUFpQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBQzlDLGlCQUFpQixFQUFFLENBQUMsbUJBQW1CLENBQUMsS0FBSyxDQUFDO0lBRTlDLFNBQVMsRUFBRSxDQUFDLG1CQUFtQixDQUFDLFNBQVMsQ0FBQztJQUMxQyxVQUFVLEVBQUUsQ0FBQyxtQkFBbUIsQ0FBQyxTQUFTLENBQUM7SUFDM0MsV0FBVyxFQUFFLENBQUMsbUJBQW1CLENBQUMsU0FBUyxDQUFDO0NBQ3RDLENBQUMifQ==

package/dist/BufferReader.d.ts

@@ -0,0 +1,324 @@
+/**
+ * CREDIT: Anatoly for making this Buffer Reader so I don't have to!
+ * Source: https://github.com/Anatoly03/pixelwalker.js/blob/9bb3c7e39a45006086a2abae8c515599bd3db835/src/util/buffer-reader.ts
+ * License: ISC
+ */
+/**
+ * Data during the communication in the process is dynamic
+ * typed. Every entry is followed by a byte identifying the
+ * type, followed by data. The type header is noted by its'
+ * 7-bit notation.
+ */
+export declare enum ComponentTypeHeader {
+    String = 0,
+    Byte = 1,
+    Int16 = 2,
+    Int32 = 3,
+    Int64 = 4,
+    Float = 5,
+    Double = 6,
+    Boolean = 7,
+    ByteArray = 8
+}
+/**
+ * A Buffer reader is a special buffer extension made to perform
+ * game-specific tasks in the field of communication.
+ *
+ * @implements Buffer
+ */
+export default class BufferReader {
+    private buffer;
+    private offset;
+    /**
+     *
+     */
+    private constructor();
+    /**
+     *
+     */
+    static from(from: Uint8Array | Buffer): BufferReader;
+    /**
+     *
+     */
+    static alloc(amount: number): BufferReader;
+    /**
+     * @param {string} value
+     * @returns {Buffer}
+     */
+    static String(value?: string): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Byte(value?: number): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Int16(value?: number): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Int32(value?: number): Buffer;
+    /**
+     * @param {bigint} value
+     * @returns {Buffer}
+     */
+    static Int64(value?: bigint): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Float(value?: number): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Double(value?: number): Buffer;
+    /**
+     * @param {boolean} value
+     * @returns {Buffer}
+     */
+    static Boolean(value?: boolean): Buffer;
+    /**
+     * @param {Uint8Array} buffer
+     * @returns {Buffer}
+     */
+    static ByteArray(buffer?: Buffer): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Magic(value: number): Buffer;
+    /**
+     * @param {number} value
+     * @returns {Buffer}
+     */
+    static Bit7(value?: number): Buffer;
+    /**
+     * @param tt
+     * @param value
+     */
+    static Dynamic(tt: ComponentTypeHeader, value: boolean | number | bigint | string | Buffer): Buffer;
+    /**
+     *
+     */
+    get length(): number;
+    /**
+     *
+     */
+    subarray(start?: number, end?: number): BufferReader;
+    /**
+     *
+     */
+    write(value: string): number;
+    /**
+     *
+     */
+    writeBigInt64BE(value: bigint): number;
+    /**
+     *
+     */
+    writeBigInt64LE(value: bigint): number;
+    /**
+     *
+     */
+    writeUInt8(value: number): number;
+    /**
+     *
+     */
+    writeUInt16LE(value: number): number;
+    /**
+     *
+     */
+    writeUInt16BE(value: number): number;
+    /**
+     *
+     */
+    writeUInt32LE(value: number): number;
+    /**
+     *
+     */
+    writeUInt32BE(value: number): number;
+    /**
+     *
+     */
+    writeInt8(value: number): number;
+    /**
+     *
+     */
+    writeInt16LE(value: number): number;
+    /**
+     *
+     */
+    writeInt16BE(value: number): number;
+    /**
+     *
+     */
+    writeInt32LE(value: number): number;
+    /**
+     *
+     */
+    writeInt32BE(value: number): number;
+    /**
+     *
+     */
+    writeFloatLE(value: number): number;
+    /**
+     *
+     */
+    writeFloatBE(value: number): number;
+    /**
+     *
+     */
+    writeDoubleLE(value: number): number;
+    /**
+     *
+     */
+    writeDoubleBE(value: number): number;
+    /**
+     *
+     */
+    readBigUInt64BE(): bigint;
+    /**
+     *
+     */
+    readBigUInt64LE(): bigint;
+    /**
+     *
+     */
+    readBigInt64BE(): bigint;
+    /**
+     *
+     */
+    readBigInt64LE(): bigint;
+    /**
+     *
+     */
+    expectUInt8(value: number): number;
+    /**
+     *
+     */
+    readUInt8(): number;
+    /**
+     *
+     */
+    readUInt16LE(): number;
+    /**
+     *
+     */
+    readUInt16BE(): number;
+    /**
+     *
+     */
+    readUInt32LE(): number;
+    /**
+     *
+     */
+    readUInt32BE(): number;
+    /**
+     *
+     */
+    readInt8(): number;
+    /**
+     *
+     */
+    readInt16LE(): number;
+    /**
+     *
+     */
+    readInt16BE(): number;
+    /**
+     *
+     */
+    readInt32LE(): number;
+    /**
+     *
+     */
+    readInt32BE(): number;
+    /**
+     *
+     */
+    readFloatLE(): number;
+    /**
+     *
+     */
+    readFloatBE(): number;
+    /**
+     *
+     */
+    readDoubleLE(): number;
+    /**
+     *
+     */
+    readDoubleBE(): number;
+    read(tt: ComponentTypeHeader, littleEndian?: boolean): string | number | bigint | boolean | Buffer;
+    read(tt: ComponentTypeHeader.String, littleEndian?: boolean): string;
+    read(tt: ComponentTypeHeader.Byte, littleEndian?: boolean): number;
+    read(tt: ComponentTypeHeader.Int16, littleEndian?: boolean): number;
+    read(tt: ComponentTypeHeader.Int32, littleEndian?: boolean): number;
+    read(tt: ComponentTypeHeader.Int64, littleEndian?: boolean): bigint;
+    read(tt: ComponentTypeHeader.Float, littleEndian?: boolean): number;
+    read(tt: ComponentTypeHeader.Double, littleEndian?: boolean): number;
+    read(tt: ComponentTypeHeader.Boolean, littleEndian?: boolean): boolean;
+    read(tt: ComponentTypeHeader.ByteArray, littleEndian?: boolean): Buffer;
+    /**
+     *
+     */
+    toBuffer(): Buffer;
+    /**
+     * https://stackoverflow.com/questions/8609289/convert-a-binary-nodejs-buffer-to-javascript-arraybuffer
+     */
+    toArrayBuffer(): ArrayBuffer;
+    /**
+     *
+     */
+    at(idx: number): number;
+    /**
+     * Advanced the buffer reader by pffset.
+     */
+    advanceOffset(relativeOffset?: number): this;
+    /**
+     * This function reads how many bytes a normal integer would take
+     * as a 7-bit number
+     *
+     * 1(000 0001) 0(111 1110)
+     */
+    static length7BitInt(value: number): number;
+    /**
+     * Reads in an integer in 7-bit notation. A 7-bit integer
+     * encoding splits a number into a variable size of bits,
+     * in which the first bit is set while bytes are following.
+     *
+     * @example
+     *
+     * ```
+     * 1111 0000 1010 1010 1000 0000 0000 0001 Reading In
+     * ^--- ---- ^--- ---- ^--- ---- ^--- ----
+     *  111 0000  010 1010  000 0000  000 0001 Writing Out
+     * ```
+     */
+    read7BitInt(): number;
+    /**
+     * Write a normal integer value into buffer at offset.
+     */
+    write7BitInt(value: number): void;
+    /**
+     * Reads a dynamic buffer which is prepended by its' length
+     * in 7-bit encoding.
+     */
+    readDynamicBuffer(): Buffer<ArrayBufferLike>;
+    /**
+     * Append a buffer to the current buffer. Asserts the cursor
+     * to be at the end of the current buffer.
+     */
+    append(buffer: Buffer): this;
+    /**
+     * Keep Deserializing the buffer for typed data until
+     * you reach the end of the buffer. Typed data consists
+     * of a type indicator in 7-bit-encoding and data following
+     * accordingly.
+     */
+    deserialize(): (string | number | bigint | boolean | Buffer<ArrayBufferLike>)[];
+}