pw-js-world 0.0.1 → 0.0.2

package/LICENSE

@@ -1,21 +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
+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/dist/Helper.d.ts

@@ -1,5 +1,5 @@
 import { BlockNames, Hook } from "pw-js-api";
-import type { WorldMeta } from "../node_modules/pw-js-api/dist/gen/world_pb";
+import type { ProtoGen } from "pw-js-api";
 import Block from "./Block";
 import Player, { IPlayerEffect, IPlayerRights } from "./Player";
 import { LayerType } from "./Constants";
@@ -38,7 +38,7 @@ export default class PWGameWorldHelper {
      *
      * If you didn't put the hook before init, this may throw error.
      */
-    get meta(): WorldMeta | null;
+    get meta(): ProtoGen.WorldMeta | null;
     /**
      * If this helper is ready. When it's false, the helper will not return anything for any of the packets.
      */

package/dist/types/index.d.ts

@@ -1,19 +1,19 @@
-// I cba so all of the typings will go here
-
-type Point = { x: number, y: number };
-
-export interface SendableBlockPacket {
-    /**
-     * If true, just leave one position
-     */
-    isFillOperation: boolean;
-    blockId: number;
-    layer: number;
-    /**
-     * Note: (I THINK) 250 positions limit.
-     */
-    positions: Point[];
-    extraFields?: Uint8Array;
-}
-
+// I cba so all of the typings will go here
+
+type Point = { x: number, y: number };
+
+export interface SendableBlockPacket {
+    /**
+     * If true, just leave one position
+     */
+    isFillOperation: boolean;
+    blockId: number;
+    layer: number;
+    /**
+     * Note: (I THINK) 250 positions limit.
+     */
+    positions: Point[];
+    extraFields?: Uint8Array;
+}
+
 export type BlockArg = (string | number | bigint | boolean | Buffer);

package/esm.mjs

@@ -1,19 +1,19 @@
-let WorldPlayerHelper = (await import("./dist/Helper.js")).default;
-let Block = (await import("./dist/Block.js")).default;
-let BufferReader = (await import("./dist/BufferReader.js")).default;
-let Player = (await import("./dist/Player.js")).default;
-
-if ("default" in WorldPlayerHelper) WorldPlayerHelper = WorldPlayerHelper.default;
-if ("default" in Block) Block = Block.default;
-if ("default" in BufferReader) BufferReader = BufferReader.default;
-if ("default" in Player) Player = Player.default;
-
-const Constants = (await import("./dist/Constants.js")).default;
-
-export default {
-    WorldPlayerHelper, Block, BufferReader, Player, Constants
-};
-
-export {
-    WorldPlayerHelper, Block, BufferReader, Player, Constants
+let WorldPlayerHelper = (await import("./dist/Helper.js")).default;
+let Block = (await import("./dist/Block.js")).default;
+let BufferReader = (await import("./dist/BufferReader.js")).default;
+let Player = (await import("./dist/Player.js")).default;
+
+if ("default" in WorldPlayerHelper) WorldPlayerHelper = WorldPlayerHelper.default;
+if ("default" in Block) Block = Block.default;
+if ("default" in BufferReader) BufferReader = BufferReader.default;
+if ("default" in Player) Player = Player.default;
+
+const Constants = (await import("./dist/Constants.js")).default;
+
+export default {
+    WorldPlayerHelper, Block, BufferReader, Player, Constants
+};
+
+export {
+    WorldPlayerHelper, Block, BufferReader, Player, Constants
 };

package/lib/Block.ts

@@ -1,217 +1,217 @@
-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[]) {
-        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() : boolean {
-        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: BufferReader) : Block {
-        return new Block(reader.readUInt32LE()).deserializeArgs(reader);
-    }
-
-    protected deserializeArgs(reader: BufferReader, flag = false) : this {
-        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[this.name];
-
-        for (let i = 0; i < (format?.length ?? 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: number, reader: BufferReader, flag = false) : BlockArg[] {
-        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[blockId]];
-
-        const args = [];
-
-        for (let i = 0; i < (format?.length ?? 0); i++) {
-            if (flag) {
-                reader.expectUInt8(format[i]);
-            }
-
-            args[i] = reader.read(format[i], !flag);
-        }
-
-        return args;
-    }
-    
-    /**
-     * 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
-     */
-    public 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
-     */
-    public static serializeArgs(bId: number, args: BlockArg[], options: { endian: "big"; writeId: false; readTypeByte: true }): Buffer;
-
-    public static serializeArgs(bId: number, args: BlockArg[], options?: { endian: "little" | "big"; writeId: boolean; readTypeByte: boolean }): Buffer {
-        options ||= {
-            endian: "little",
-            writeId: true,
-            readTypeByte: false,
-        };
-
-        const buffer: Buffer[] = [];
-
-        if (options.writeId) {
-            const idBuffer = Buffer.alloc(4);
-            idBuffer.writeUInt32LE(bId);
-            buffer.push(idBuffer);
-        }
-
-        const blockData:ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[bId]] ?? [];
-
-        for (let i = 0, len = blockData.length; i < len; i++) {
-            const entry = BufferReader.Dynamic(i, args[i]);
-            buffer.push(entry);
-        }
-
-        return Buffer.concat(buffer);
-    }
-
-    /**
-     * 
-     * @param pos List of points (X and Y)
-     */
-    toPacket(pos: Point[], layer: LayerType) : SendableBlockPacket;
-    toPacket(x: number, y: number, layer: LayerType) : SendableBlockPacket;
-    toPacket(pos: Point[] | number, y: number, layer?: LayerType) : SendableBlockPacket {
-        if (typeof pos === "number") {
-            pos = [{
-                x: pos, y
-            }];
-
-            layer = layer ?? 0;
-        } else layer = y ?? 0;
-
-        return {
-            isFillOperation: false,
-            blockId: this.bId,
-            layer,
-            positions: pos,
-            extraFields: Block.serializeArgs(this.bId, this.args, { endian: "big", writeId: false, readTypeByte: true })
-        } satisfies SendableBlockPacket;
-    }
-
-    /**
-     * This will return the block name in UPPER_CASE form.
-     * 
-     * For eg EFFECTS_INVULNERABILITY.
-     */
-    get name() : keyof typeof BlockNames {
-        return BlockNames[this.bId] as keyof typeof BlockNames;
-    }
-
-    /**
-     * Returns a copy of the block.
-     */
-    clone(obj?: false) : Block;
-    clone(obj: true) : { bId: number, args: BlockArg[], name: string }
-    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],
+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[]) {
+        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() : boolean {
+        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: BufferReader) : Block {
+        return new Block(reader.readUInt32LE()).deserializeArgs(reader);
+    }
+
+    protected deserializeArgs(reader: BufferReader, flag = false) : this {
+        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[this.name];
+
+        for (let i = 0; i < (format?.length ?? 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: number, reader: BufferReader, flag = false) : BlockArg[] {
+        const format: ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[blockId]];
+
+        const args = [];
+
+        for (let i = 0; i < (format?.length ?? 0); i++) {
+            if (flag) {
+                reader.expectUInt8(format[i]);
+            }
+
+            args[i] = reader.read(format[i], !flag);
+        }
+
+        return args;
+    }
+    
+    /**
+     * 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
+     */
+    public 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
+     */
+    public static serializeArgs(bId: number, args: BlockArg[], options: { endian: "big"; writeId: false; readTypeByte: true }): Buffer;
+
+    public static serializeArgs(bId: number, args: BlockArg[], options?: { endian: "little" | "big"; writeId: boolean; readTypeByte: boolean }): Buffer {
+        options ||= {
+            endian: "little",
+            writeId: true,
+            readTypeByte: false,
+        };
+
+        const buffer: Buffer[] = [];
+
+        if (options.writeId) {
+            const idBuffer = Buffer.alloc(4);
+            idBuffer.writeUInt32LE(bId);
+            buffer.push(idBuffer);
+        }
+
+        const blockData:ComponentTypeHeader[] = (BlockArgsHeadings as any)[BlockNames[bId]] ?? [];
+
+        for (let i = 0, len = blockData.length; i < len; i++) {
+            const entry = BufferReader.Dynamic(i, args[i]);
+            buffer.push(entry);
+        }
+
+        return Buffer.concat(buffer);
+    }
+
+    /**
+     * 
+     * @param pos List of points (X and Y)
+     */
+    toPacket(pos: Point[], layer: LayerType) : SendableBlockPacket;
+    toPacket(x: number, y: number, layer: LayerType) : SendableBlockPacket;
+    toPacket(pos: Point[] | number, y: number, layer?: LayerType) : SendableBlockPacket {
+        if (typeof pos === "number") {
+            pos = [{
+                x: pos, y
+            }];
+
+            layer = layer ?? 0;
+        } else layer = y ?? 0;
+
+        return {
+            isFillOperation: false,
+            blockId: this.bId,
+            layer,
+            positions: pos,
+            extraFields: Block.serializeArgs(this.bId, this.args, { endian: "big", writeId: false, readTypeByte: true })
+        } satisfies SendableBlockPacket;
+    }
+
+    /**
+     * This will return the block name in UPPER_CASE form.
+     * 
+     * For eg EFFECTS_INVULNERABILITY.
+     */
+    get name() : keyof typeof BlockNames {
+        return BlockNames[this.bId] as keyof typeof BlockNames;
+    }
+
+    /**
+     * Returns a copy of the block.
+     */
+    clone(obj?: false) : Block;
+    clone(obj: true) : { bId: number, args: BlockArg[], name: string }
+    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],
 } as const;