binary-packet 1.0.4 → 1.0.6

package/README.md

@@ -31,9 +31,11 @@ Currently, these kinds of `fields` are supported:
 | `Field.FLOAT_32` | 32 bits IEEE754 floating-point | | 4 |
 | `Field.FLOAT_64` | 64 bits IEEE754 floating-point | | 8 |
 | `BinaryPacket` | BinaryPacket "subpacket" | BinaryPacket | size(BinaryPacket) |
-| `FieldArray` | Array of one of the types above | Up to 256 elements | 1 + length \* size(Field) |
+| `FieldArray` | Dynamically-sized array of one of the types above | Up to 256 elements | 1 + length \* size(Element) |
+| `FieldFixedArray` | Statically-sized array of one of the types above | Any pre-defined numbers of elements | length \* size(Element) |
 
-As you can see from the table above, both arrays and nested objects ("subpackets") are supported.
+As you can see from the table above, both arrays and nested objects ("subpackets") are supported. \
+Note that `FieldFixedArray`s are much more memory efficient and performant than `FieldArray`s, but require a pre-defined length.
 
 ## Usage Examples
 
@@ -57,7 +59,7 @@ const CellPacket = BinaryPacket.define(0, Cell)
 const Board = {
   numPlayers: Field.UNSIGNED_INT_8,
   otherStuff: Field.INT_32,
-  cells: FieldArray(CellPacket) // equivalent to { cells: [CellPacket] }
+  cells: FieldArray(CellPacket)
 }
 
 // When done with the board definition we can create its BinaryPacket writer/reader.
@@ -108,14 +110,14 @@ So, take these "performance" comparisons with a grain of salt; or, even better,
 
 This library has been benchmarked against the following alternatives:
 
-- [msgpackr](https://www.npmjs.com/package/msgpackr) - A very popular and very fast and battle-tested serialization library. It currently offers **many** more features than binary-packet, but it appears to be 2x-4x slower in writes and 3x-10x slower in reads.
-- [restructure](https://www.npmjs.com/package/restructure) - A very popular schema-based serialization library, has some extra features like LazyArrays, but it is **much slower** than both binary-packet and msgpackr. And, sadly, easily crashes with complex structures.
+- [msgpackr](https://www.npmjs.com/package/msgpackr) - A very popular, fast and battle-tested library. Currently offers **many** more features than binary-packet, but it appears to be 2x-4x slower in writes and 3x-10x slower in reads (depends on the packet structure) - is also less type-safe.
+- [restructure](https://www.npmjs.com/package/restructure) - An older, popular schema-based library, has some extra features like LazyArrays, but it is **much slower** than both binary-packet and msgpackr. And, sadly, easily crashes with complex structures.
 
 The benchmarks are executed on three different kinds of packets:
 
 - EmptyPacket: basically an empty javascript object.
-- SimplePacket: objects with primitive-only fields.
-- ComplexPacket: objects with primitives, arrays and other nested objects/arrays.
+- SimplePacket: objects with just primitive fields and statically-sized arrays.
+- ComplexPacket: objects with primitives, statically-sized arrays, dynamically-sized arrays and other nested objects/arrays.
 
 You can see and run the benchmarks yourself if you clone the repository and launch `npm run benchmark`.
 

package/dist/index.d.mts

@@ -39,10 +39,22 @@ declare const enum Field {
     FLOAT_64 = 7
 }
 /**
- * Defines an array of a certain type. \
- * As of now, only arrays with at most 256 elements are supported.
+ * Defines a dynamically-sized array with elements of a certain type. \
+ * Dynamically-sized arrays are useful when a packet's field is an array of a non pre-defined length. \
+ * Although, this makes dynamically-sized arrays more memory expensive as the internal buffer needs to be grown accordingly.
+ *
+ * NOTE: If an array will ALWAYS have the same length, prefer using the `FieldFixedArray` type, for both better performance and memory efficiency. \
+ * NOTE: As of now, dynamic arrays can have at most 256 elements.
+ */
+declare function FieldArray<T extends Field | BinaryPacket<Definition>>(item: T): [itemType: T];
+/**
+ * Defines a statically-sized array with elements of a certain type. \
+ * Fixed arrays are useful when a packet's field is an array of a pre-defined length. \
+ * Fixed arrays much more memory efficient and performant than non-fixed ones.
+ *
+ * NOTE: If an array will not always have the same length, use the `FieldArray` type.
  */
-declare function FieldArray<T extends Field | BinaryPacket<Definition>>(item: T): T[];
+declare function FieldFixedArray<T extends Field | BinaryPacket<Definition>, Length extends number>(item: T, length: Length): [itemType: T, length: Length];
 declare class BinaryPacket<T extends Definition> {
     private readonly packetId;
     /**
@@ -139,10 +151,13 @@ declare class BinaryPacket<T extends Definition> {
     private constructor();
     private read;
     private write;
+    /**
+     * Fast write does not support writing dynamically-sized arrays.
+     */
     private fastWrite;
     /**
      * The slow writing path tries writing data into the buffer as fast as the fast writing path does. \
-     * But, if a non-empty array is encountered, the buffer needs to grow, slightly reducing performance.
+     * But, if a non-empty dynamically-sized array is encountered, the buffer needs to grow, slightly reducing performance.
      */
     private slowWrite;
 }
@@ -167,7 +182,7 @@ declare class BinaryPacket<T extends Definition> {
  * // You can also specify arrays of both "primitive" fields and other BinaryPackets.
  * const Board = {
  *  numPlayers: Field.UNSIGNED_INT_8,
- *  cells: FieldArray(CellPacket) // equivalent to { cells: [CellPacket] }
+ *  cells: FieldArray(CellPacket)
  * }
  *
  * // When done with the board definition we can create its BinaryPacket writer/reader.
@@ -190,13 +205,18 @@ declare class BinaryPacket<T extends Definition> {
  * // ...
  */
 type Definition = {
-    [fieldName: string]: Field | Field[] | BinaryPacket<Definition> | BinaryPacket<Definition>[];
+    [fieldName: string]: MaybeArray<Field> | MaybeArray<BinaryPacket<Definition>>;
 };
+type MaybeArray<T> = T | [itemType: T] | [itemType: T, length: number];
 /**
  * Meta-type that converts a `Definition` schema to the type of the actual JavaScript object that will be written into a packet or read from. \
  */
 type ToJson<T extends Definition> = {
-    [K in keyof T]: T[K] extends ReadonlyArray<infer Item> ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] : number[] : T[K] extends BinaryPacket<infer BPDef> ? ToJson<BPDef> : number;
+    [K in keyof T]: T[K] extends [infer Item] ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] : number[] : T[K] extends [infer Item, infer Length] ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] & {
+        length: Length;
+    } : number[] & {
+        length: Length;
+    } : T[K] extends BinaryPacket<infer BPDef> ? ToJson<BPDef> : number;
 };
 
-export { BinaryPacket, type Definition, Field, FieldArray };
+export { BinaryPacket, type Definition, Field, FieldArray, FieldFixedArray };

package/dist/index.d.ts

@@ -39,10 +39,22 @@ declare const enum Field {
     FLOAT_64 = 7
 }
 /**
- * Defines an array of a certain type. \
- * As of now, only arrays with at most 256 elements are supported.
+ * Defines a dynamically-sized array with elements of a certain type. \
+ * Dynamically-sized arrays are useful when a packet's field is an array of a non pre-defined length. \
+ * Although, this makes dynamically-sized arrays more memory expensive as the internal buffer needs to be grown accordingly.
+ *
+ * NOTE: If an array will ALWAYS have the same length, prefer using the `FieldFixedArray` type, for both better performance and memory efficiency. \
+ * NOTE: As of now, dynamic arrays can have at most 256 elements.
+ */
+declare function FieldArray<T extends Field | BinaryPacket<Definition>>(item: T): [itemType: T];
+/**
+ * Defines a statically-sized array with elements of a certain type. \
+ * Fixed arrays are useful when a packet's field is an array of a pre-defined length. \
+ * Fixed arrays much more memory efficient and performant than non-fixed ones.
+ *
+ * NOTE: If an array will not always have the same length, use the `FieldArray` type.
  */
-declare function FieldArray<T extends Field | BinaryPacket<Definition>>(item: T): T[];
+declare function FieldFixedArray<T extends Field | BinaryPacket<Definition>, Length extends number>(item: T, length: Length): [itemType: T, length: Length];
 declare class BinaryPacket<T extends Definition> {
     private readonly packetId;
     /**
@@ -139,10 +151,13 @@ declare class BinaryPacket<T extends Definition> {
     private constructor();
     private read;
     private write;
+    /**
+     * Fast write does not support writing dynamically-sized arrays.
+     */
     private fastWrite;
     /**
      * The slow writing path tries writing data into the buffer as fast as the fast writing path does. \
-     * But, if a non-empty array is encountered, the buffer needs to grow, slightly reducing performance.
+     * But, if a non-empty dynamically-sized array is encountered, the buffer needs to grow, slightly reducing performance.
      */
     private slowWrite;
 }
@@ -167,7 +182,7 @@ declare class BinaryPacket<T extends Definition> {
  * // You can also specify arrays of both "primitive" fields and other BinaryPackets.
  * const Board = {
  *  numPlayers: Field.UNSIGNED_INT_8,
- *  cells: FieldArray(CellPacket) // equivalent to { cells: [CellPacket] }
+ *  cells: FieldArray(CellPacket)
  * }
  *
  * // When done with the board definition we can create its BinaryPacket writer/reader.
@@ -190,13 +205,18 @@ declare class BinaryPacket<T extends Definition> {
  * // ...
  */
 type Definition = {
-    [fieldName: string]: Field | Field[] | BinaryPacket<Definition> | BinaryPacket<Definition>[];
+    [fieldName: string]: MaybeArray<Field> | MaybeArray<BinaryPacket<Definition>>;
 };
+type MaybeArray<T> = T | [itemType: T] | [itemType: T, length: number];
 /**
  * Meta-type that converts a `Definition` schema to the type of the actual JavaScript object that will be written into a packet or read from. \
  */
 type ToJson<T extends Definition> = {
-    [K in keyof T]: T[K] extends ReadonlyArray<infer Item> ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] : number[] : T[K] extends BinaryPacket<infer BPDef> ? ToJson<BPDef> : number;
+    [K in keyof T]: T[K] extends [infer Item] ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] : number[] : T[K] extends [infer Item, infer Length] ? Item extends BinaryPacket<infer BPDef> ? ToJson<BPDef>[] & {
+        length: Length;
+    } : number[] & {
+        length: Length;
+    } : T[K] extends BinaryPacket<infer BPDef> ? ToJson<BPDef> : number;
 };
 
-export { BinaryPacket, type Definition, Field, FieldArray };
+export { BinaryPacket, type Definition, Field, FieldArray, FieldFixedArray };

package/dist/index.js

@@ -1,412 +1,2 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  BinaryPacket: () => BinaryPacket,
-  Field: () => Field,
-  FieldArray: () => FieldArray
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/buffers.ts
-var hasNodeBuffers = typeof Buffer === "function";
-function growDataView(dataview, newByteLength) {
-  const resizedBuffer = new ArrayBuffer(newByteLength);
-  const amountToCopy = Math.min(dataview.byteLength, resizedBuffer.byteLength);
-  let length = Math.trunc(amountToCopy / 8);
-  new Float64Array(resizedBuffer, 0, length).set(new Float64Array(dataview.buffer, 0, length));
-  const offset = length * 8;
-  length = amountToCopy - offset;
-  new Uint8Array(resizedBuffer, offset, length).set(new Uint8Array(dataview.buffer, offset, length));
-  return new DataView(resizedBuffer);
-}
-function growNodeBuffer(buffer, newByteLength) {
-  const newBuffer = Buffer.allocUnsafe(newByteLength);
-  buffer.copy(newBuffer);
-  return newBuffer;
-}
-
-// src/index.ts
-var Field = /* @__PURE__ */ ((Field2) => {
-  Field2[Field2["UNSIGNED_INT_8"] = 0] = "UNSIGNED_INT_8";
-  Field2[Field2["UNSIGNED_INT_16"] = 1] = "UNSIGNED_INT_16";
-  Field2[Field2["UNSIGNED_INT_32"] = 2] = "UNSIGNED_INT_32";
-  Field2[Field2["INT_8"] = 3] = "INT_8";
-  Field2[Field2["INT_16"] = 4] = "INT_16";
-  Field2[Field2["INT_32"] = 5] = "INT_32";
-  Field2[Field2["FLOAT_32"] = 6] = "FLOAT_32";
-  Field2[Field2["FLOAT_64"] = 7] = "FLOAT_64";
-  return Field2;
-})(Field || {});
-function FieldArray(item) {
-  return [item];
-}
-var BinaryPacket = class _BinaryPacket {
-  constructor(packetId, definition) {
-    this.packetId = packetId;
-    this.entries = definition ? sortEntries(definition) : [];
-    const inspection = inspectEntries(this.entries);
-    this.minimumByteLength = inspection.minimumByteLength;
-    this.canFastWrite = inspection.canFastWrite;
-  }
-  /**
-   * Defines a new binary packet. \
-   * Make sure that every `packetId` is unique.
-   * @throws RangeError If packetId is negative, floating-point, or greater than 255.
-   */
-  static define(packetId, definition) {
-    if (packetId < 0 || !Number.isFinite(packetId)) {
-      throw new RangeError("Packet IDs must be positive integers.");
-    }
-    if (packetId > 255) {
-      throw new RangeError(
-        "Packet IDs greater than 255 are not supported. Do you REALLY need more than 255 different kinds of packets?"
-      );
-    }
-    return new _BinaryPacket(packetId, definition);
-  }
-  /**
-   * Reads just the packetId from the given Buffer. \
-   * This method practically just reads the uint8 at offset `byteOffset` (default: 0). \
-   * Useful if the receiving side receives multiple types of packets.
-   */
-  static readPacketIdNodeBuffer(buffer, byteOffset = 0) {
-    return buffer.readUint8(byteOffset);
-  }
-  /**
-   * Reads just the packetId from the given DataView. \
-   * This method practically just reads the uint8 at offset `byteOffset` (default: 0). \
-   * Useful if the receiving side receives multiple types of packets.
-   */
-  static readPacketIdDataView(dataview, byteOffset = 0) {
-    return dataview.getUint8(byteOffset);
-  }
-  /**
-   * Reads just the packetId from the given ArrayBuffer. \
-   * This method practically just reads the uint8 at offset `byteOffset`. \
-   * Useful if the receiving side receives multiple types of packets.
-   *
-   * NOTE: Due to security issues, the `byteOffset` argument cannot be defaulted and must be provided by the user. \
-   * NOTE: For more information read the `readArrayBuffer` method documentation.
-   */
-  static readPacketIdArrayBuffer(arraybuffer, byteOffset) {
-    return new Uint8Array(arraybuffer, byteOffset, 1)[0];
-  }
-  /**
-   * Reads/deserializes from the given Buffer. \
-   * Method available ONLY on NodeJS and Bun.
-   *
-   * If possible, always prefer reading using this method, as it is much faster than the other ones.
-   *
-   * NOTE: if you have an ArrayBuffer do not bother wrapping it into a node Buffer yourself. \
-   * NOTE: if you have an ArrayBuffer use the appropriate `readArrayBuffer`.
-   */
-  readNodeBuffer(dataIn, offsetPointer = { offset: 0 }, byteLength = dataIn.byteLength) {
-    return this.read(dataIn, offsetPointer, byteLength, GET_FUNCTION_BUF);
-  }
-  /**
-   * Reads/deserializes from the given DataView.
-   *
-   * NOTE: if you have an ArrayBuffer do not bother wrapping it into a DataView yourself. \
-   * NOTE: if you have an ArrayBuffer use the appropriate `readArrayBuffer`.
-   */
-  readDataView(dataIn, offsetPointer = { offset: 0 }, byteLength = dataIn.byteLength) {
-    return this.read(dataIn, offsetPointer, byteLength, GET_FUNCTION);
-  }
-  /**
-   * Reads/deserializes from the given ArrayBuffer. \
-   * WARNING: this method is practically a HACK.
-   *
-   * When using this method both the `byteOffset` and `byteLength` are REQUIRED and cannot be defaulted. \
-   * This is to prevent serious bugs and security issues. \
-   * That is because often raw ArrayBuffers come from a pre-allocated buffer pool and do not start at byteOffset 0.
-   *
-   * NOTE: if you have a node Buffer do not bother wrapping it into an ArrayBuffer yourself. \
-   * NOTE: if you have a node Buffer use the appropriate `readNodeBuffer` as it is much faster and less error prone.
-   */
-  readArrayBuffer(dataIn, byteOffset, byteLength) {
-    return this.read(
-      hasNodeBuffers ? Buffer.from(dataIn, byteOffset, byteLength) : new DataView(dataIn, byteOffset, byteLength),
-      { offset: 0 },
-      // The underlying buffer has already been offsetted
-      byteLength,
-      hasNodeBuffers ? GET_FUNCTION_BUF : GET_FUNCTION
-    );
-  }
-  /**
-   * Writes/serializes the given object into a Buffer. \
-   * Method available ONLY on NodeJS and Bun.
-   *
-   * If possible, always prefer writing using this method, as it is much faster than the other ones.
-   */
-  writeNodeBuffer(dataOut) {
-    const buffer = Buffer.allocUnsafe(this.minimumByteLength);
-    return this.write(buffer, dataOut, { offset: 0 }, SET_FUNCTION_BUF, growNodeBuffer);
-  }
-  /**
-   * Writes/serializes the given object into a DataView. \
-   */
-  writeDataView(dataOut) {
-    const dataview = new DataView(new ArrayBuffer(this.minimumByteLength));
-    return this.write(dataview, dataOut, { offset: 0 }, SET_FUNCTION, growDataView);
-  }
-  /**
-   * Writes/serializes the given object into an ArrayBuffer. \
-   * This method is just a wrapper around either  `writeNodeBuffer` or `writeDataView`. \
-   *
-   * This method works with JavaScript standard raw ArrayBuffer(s) and, as such, is very error prone: \
-   * Make sure you're using the returned byteLength and byteOffset fields in the read counterpart. \
-   *
-   * Always consider whether is possible to use directly `writeNodeBuffer` or `writeDataView` instead of `writeArrayBuffer`. \
-   * For more information read the `readArrayBuffer` documentation.
-   */
-  writeArrayBuffer(dataOut) {
-    const buf = hasNodeBuffers ? this.writeNodeBuffer(dataOut) : this.writeDataView(dataOut);
-    return { buffer: buf.buffer, byteLength: buf.byteLength, byteOffset: buf.byteOffset };
-  }
-  entries;
-  canFastWrite;
-  minimumByteLength;
-  read(dataIn, offsetPointer, byteLength, readFunctions) {
-    if (byteLength + offsetPointer.offset < this.minimumByteLength) {
-      throw new Error(
-        `There is no space available to fit a packet of type ${this.packetId} at offset ${offsetPointer.offset}`
-      );
-    }
-    if (readFunctions[0 /* UNSIGNED_INT_8 */](dataIn, offsetPointer.offset) !== this.packetId) {
-      throw new Error(
-        `Data at offset ${offsetPointer.offset} is not a packet of type ${this.packetId}`
-      );
-    }
-    offsetPointer.offset += 1;
-    const result = {};
-    for (const [name, def] of this.entries) {
-      if (Array.isArray(def)) {
-        const length = readFunctions[0 /* UNSIGNED_INT_8 */](dataIn, offsetPointer.offset++);
-        const array = Array(length);
-        const itemType = def[0];
-        if (typeof itemType === "object") {
-          for (let i = 0; i < length; ++i) {
-            array[i] = itemType.read(dataIn, offsetPointer, byteLength, readFunctions);
-          }
-        } else {
-          const itemSize = BYTE_SIZE[itemType];
-          for (let i = 0; i < length; ++i) {
-            array[i] = readFunctions[itemType](dataIn, offsetPointer.offset);
-            offsetPointer.offset += itemSize;
-          }
-        }
-        result[name] = array;
-      } else if (typeof def === "object") {
-        result[name] = def.read(dataIn, offsetPointer, byteLength, readFunctions);
-      } else {
-        result[name] = readFunctions[def](dataIn, offsetPointer.offset);
-        offsetPointer.offset += BYTE_SIZE[def];
-      }
-    }
-    return result;
-  }
-  write(buffer, dataOut, offsetPointer, writeFunctions, growBufferFunction) {
-    writeFunctions[0 /* UNSIGNED_INT_8 */](buffer, this.packetId, offsetPointer.offset);
-    offsetPointer.offset += 1;
-    if (this.canFastWrite) {
-      this.fastWrite(buffer, dataOut, offsetPointer, writeFunctions);
-      return buffer;
-    } else {
-      return this.slowWrite(
-        buffer,
-        dataOut,
-        offsetPointer,
-        this.minimumByteLength,
-        this.minimumByteLength,
-        writeFunctions,
-        growBufferFunction
-      );
-    }
-  }
-  fastWrite(buffer, dataOut, offsetPointer, writeFunctions) {
-    for (const [name, def] of this.entries) {
-      if (typeof def === "object") {
-        ;
-        def.fastWrite(
-          buffer,
-          dataOut[name],
-          offsetPointer,
-          writeFunctions
-        );
-      } else {
-        writeFunctions[def](buffer, dataOut[name], offsetPointer.offset);
-        offsetPointer.offset += BYTE_SIZE[def];
-      }
-    }
-  }
-  /**
-   * The slow writing path tries writing data into the buffer as fast as the fast writing path does. \
-   * But, if a non-empty array is encountered, the buffer needs to grow, slightly reducing performance.
-   */
-  slowWrite(buffer, dataOut, offsetPointer, byteLength, maxByteLength, writeFunctions, growBufferFunction) {
-    for (const [name, def] of this.entries) {
-      const data = dataOut[name];
-      if (Array.isArray(def)) {
-        const length = data.length;
-        writeFunctions[0 /* UNSIGNED_INT_8 */](buffer, length, offsetPointer.offset);
-        offsetPointer.offset += 1;
-        if (length > 0) {
-          const itemType = def[0];
-          if (typeof itemType === "object") {
-            const neededBytesForElements = length * itemType.minimumByteLength;
-            byteLength += neededBytesForElements;
-            maxByteLength += neededBytesForElements;
-            if (buffer.byteLength < maxByteLength) {
-              buffer = growBufferFunction(buffer, maxByteLength);
-            }
-            for (const object of data) {
-              writeFunctions[0 /* UNSIGNED_INT_8 */](
-                buffer,
-                itemType.packetId,
-                offsetPointer.offset
-              );
-              offsetPointer.offset += 1;
-              buffer = itemType.slowWrite(
-                buffer,
-                object,
-                offsetPointer,
-                byteLength,
-                maxByteLength,
-                writeFunctions,
-                growBufferFunction
-              );
-              byteLength = offsetPointer.offset;
-              maxByteLength = buffer.byteLength;
-            }
-          } else {
-            const itemSize = BYTE_SIZE[itemType];
-            const neededBytesForElements = length * itemSize;
-            byteLength += neededBytesForElements;
-            maxByteLength += neededBytesForElements;
-            if (buffer.byteLength < maxByteLength) {
-              buffer = growBufferFunction(buffer, maxByteLength);
-            }
-            for (const number of data) {
-              writeFunctions[itemType](buffer, number, offsetPointer.offset);
-              offsetPointer.offset += itemSize;
-            }
-          }
-        }
-      } else if (typeof def === "object") {
-        writeFunctions[0 /* UNSIGNED_INT_8 */](buffer, def.packetId, offsetPointer.offset);
-        offsetPointer.offset += 1;
-        buffer = def.slowWrite(
-          buffer,
-          data,
-          offsetPointer,
-          byteLength,
-          maxByteLength,
-          writeFunctions,
-          growBufferFunction
-        );
-        byteLength = offsetPointer.offset;
-        maxByteLength = buffer.byteLength;
-      } else {
-        writeFunctions[def](buffer, data, offsetPointer.offset);
-        offsetPointer.offset += BYTE_SIZE[def];
-      }
-    }
-    return buffer;
-  }
-};
-function sortEntries(definition) {
-  return Object.entries(definition).sort(
-    ([fieldName1], [fieldName2]) => fieldName1.localeCompare(fieldName2)
-  );
-}
-function inspectEntries(entries) {
-  let minimumByteLength = 1;
-  let canFastWrite = true;
-  for (const [, type] of entries) {
-    if (Array.isArray(type)) {
-      minimumByteLength += 1;
-      canFastWrite = false;
-    } else if (type instanceof BinaryPacket) {
-      minimumByteLength += type.minimumByteLength;
-      canFastWrite &&= type.canFastWrite;
-    } else {
-      minimumByteLength += BYTE_SIZE[type];
-    }
-  }
-  return { minimumByteLength, canFastWrite };
-}
-var BYTE_SIZE = Array(8);
-BYTE_SIZE[0 /* UNSIGNED_INT_8 */] = 1;
-BYTE_SIZE[3 /* INT_8 */] = 1;
-BYTE_SIZE[1 /* UNSIGNED_INT_16 */] = 2;
-BYTE_SIZE[4 /* INT_16 */] = 2;
-BYTE_SIZE[2 /* UNSIGNED_INT_32 */] = 4;
-BYTE_SIZE[5 /* INT_32 */] = 4;
-BYTE_SIZE[6 /* FLOAT_32 */] = 4;
-BYTE_SIZE[7 /* FLOAT_64 */] = 8;
-var GET_FUNCTION = Array(8);
-GET_FUNCTION[0 /* UNSIGNED_INT_8 */] = (view, offset) => view.getUint8(offset);
-GET_FUNCTION[3 /* INT_8 */] = (view, offset) => view.getInt8(offset);
-GET_FUNCTION[1 /* UNSIGNED_INT_16 */] = (view, offset, le) => view.getUint16(offset, le);
-GET_FUNCTION[4 /* INT_16 */] = (view, offset, le) => view.getInt16(offset, le);
-GET_FUNCTION[2 /* UNSIGNED_INT_32 */] = (view, offset, le) => view.getUint32(offset, le);
-GET_FUNCTION[5 /* INT_32 */] = (view, offset, le) => view.getInt32(offset, le);
-GET_FUNCTION[6 /* FLOAT_32 */] = (view, offset, le) => view.getFloat32(offset, le);
-GET_FUNCTION[7 /* FLOAT_64 */] = (view, offset, le) => view.getFloat64(offset, le);
-var SET_FUNCTION = Array(8);
-SET_FUNCTION[0 /* UNSIGNED_INT_8 */] = (view, value, offset) => view.setUint8(offset, value);
-SET_FUNCTION[3 /* INT_8 */] = (view, value, offset) => view.setInt8(offset, value);
-SET_FUNCTION[1 /* UNSIGNED_INT_16 */] = (view, value, offset) => view.setUint16(offset, value);
-SET_FUNCTION[4 /* INT_16 */] = (view, value, offset) => view.setInt16(offset, value);
-SET_FUNCTION[2 /* UNSIGNED_INT_32 */] = (view, value, offset) => view.setUint32(offset, value);
-SET_FUNCTION[5 /* INT_32 */] = (view, value, offset) => view.setInt32(offset, value);
-SET_FUNCTION[6 /* FLOAT_32 */] = (view, value, offset) => view.setFloat32(offset, value);
-SET_FUNCTION[7 /* FLOAT_64 */] = (view, value, offset) => view.setFloat64(offset, value);
-var SET_FUNCTION_BUF = Array(8);
-if (hasNodeBuffers) {
-  SET_FUNCTION_BUF[0 /* UNSIGNED_INT_8 */] = (view, value, offset) => view.writeUint8(value, offset);
-  SET_FUNCTION_BUF[3 /* INT_8 */] = (view, value, offset) => view.writeInt8(value, offset);
-  SET_FUNCTION_BUF[1 /* UNSIGNED_INT_16 */] = (view, value, offset) => view.writeUint16LE(value, offset);
-  SET_FUNCTION_BUF[4 /* INT_16 */] = (view, value, offset) => view.writeInt16LE(value, offset);
-  SET_FUNCTION_BUF[2 /* UNSIGNED_INT_32 */] = (view, value, offset) => view.writeUint32LE(value, offset);
-  SET_FUNCTION_BUF[5 /* INT_32 */] = (view, value, offset) => view.writeInt32LE(value, offset);
-  SET_FUNCTION_BUF[6 /* FLOAT_32 */] = (view, value, offset) => view.writeFloatLE(value, offset);
-  SET_FUNCTION_BUF[7 /* FLOAT_64 */] = (view, value, offset) => view.writeDoubleLE(value, offset);
-}
-var GET_FUNCTION_BUF = Array(8);
-if (hasNodeBuffers) {
-  GET_FUNCTION_BUF[0 /* UNSIGNED_INT_8 */] = (view, offset) => view.readUint8(offset);
-  GET_FUNCTION_BUF[3 /* INT_8 */] = (view, offset) => view.readInt8(offset);
-  GET_FUNCTION_BUF[1 /* UNSIGNED_INT_16 */] = (view, offset) => view.readUint16LE(offset);
-  GET_FUNCTION_BUF[4 /* INT_16 */] = (view, offset) => view.readInt16LE(offset);
-  GET_FUNCTION_BUF[2 /* UNSIGNED_INT_32 */] = (view, offset) => view.readUint32LE(offset);
-  GET_FUNCTION_BUF[5 /* INT_32 */] = (view, offset) => view.readInt32LE(offset);
-  GET_FUNCTION_BUF[6 /* FLOAT_32 */] = (view, offset) => view.readFloatLE(offset);
-  GET_FUNCTION_BUF[7 /* FLOAT_64 */] = (view, offset) => view.readDoubleLE(offset);
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  BinaryPacket,
-  Field,
-  FieldArray
-});
+"use strict";var E=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var b=Object.getOwnPropertyNames;var L=Object.prototype.hasOwnProperty;var g=(n,e)=>{for(var t in e)E(n,t,{get:e[t],enumerable:!0})},S=(n,e,t,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of b(e))!L.call(n,i)&&i!==t&&E(n,i,{get:()=>e[i],enumerable:!(r=A(e,i))||r.enumerable});return n};var G=n=>S(E({},"__esModule",{value:!0}),n);var v={};g(v,{BinaryPacket:()=>p,Field:()=>w,FieldArray:()=>O,FieldFixedArray:()=>k});module.exports=G(v);var B=typeof Buffer=="function";function U(n,e){let t=new ArrayBuffer(e),r=Math.min(n.byteLength,t.byteLength),i=Math.trunc(r/8);new Float64Array(t,0,i).set(new Float64Array(n.buffer,0,i));let s=i*8;return i=r-s,new Uint8Array(t,s,i).set(new Uint8Array(n.buffer,s,i)),new DataView(t)}function h(n,e){let t=Buffer.allocUnsafe(e);return n.copy(t),t}var w=(a=>(a[a.UNSIGNED_INT_8=0]="UNSIGNED_INT_8",a[a.UNSIGNED_INT_16=1]="UNSIGNED_INT_16",a[a.UNSIGNED_INT_32=2]="UNSIGNED_INT_32",a[a.INT_8=3]="INT_8",a[a.INT_16=4]="INT_16",a[a.INT_32=5]="INT_32",a[a.FLOAT_32=6]="FLOAT_32",a[a.FLOAT_64=7]="FLOAT_64",a))(w||{});function O(n){return[n]}function k(n,e){if(e<0||!Number.isFinite(e))throw new RangeError("Length of a FixedArray must be a positive integer.");return[n,e]}var p=class n{constructor(e,t){this.packetId=e;this.entries=t?J(t):[];let r=V(this.entries);this.minimumByteLength=r.minimumByteLength,this.canFastWrite=r.canFastWrite}static define(e,t){if(e<0||!Number.isFinite(e))throw new RangeError("Packet IDs must be positive integers.");if(e>255)throw new RangeError("Packet IDs greater than 255 are not supported. Do you REALLY need more than 255 different kinds of packets?");return new n(e,t)}static readPacketIdNodeBuffer(e,t=0){return e.readUint8(t)}static readPacketIdDataView(e,t=0){return e.getUint8(t)}static readPacketIdArrayBuffer(e,t){return new Uint8Array(e,t,1)[0]}readNodeBuffer(e,t={offset:0},r=e.byteLength){return this.read(e,t,r,l)}readDataView(e,t={offset:0},r=e.byteLength){return this.read(e,t,r,m)}readArrayBuffer(e,t,r){return this.read(B?Buffer.from(e,t,r):new DataView(e,t,r),{offset:0},r,B?l:m)}writeNodeBuffer(e){let t=Buffer.allocUnsafe(this.minimumByteLength);return this.write(t,e,{offset:0},d,h)}writeDataView(e){let t=new DataView(new ArrayBuffer(this.minimumByteLength));return this.write(t,e,{offset:0},I,U)}writeArrayBuffer(e){let t=B?this.writeNodeBuffer(e):this.writeDataView(e);return{buffer:t.buffer,byteLength:t.byteLength,byteOffset:t.byteOffset}}entries;canFastWrite;minimumByteLength;read(e,t,r,i){if(r+t.offset<this.minimumByteLength)throw new Error(`There is no space available to fit a packet of type ${this.packetId} at offset ${t.offset}`);if(i[0](e,t.offset)!==this.packetId)throw new Error(`Data at offset ${t.offset} is not a packet of type ${this.packetId}`);t.offset+=1;let s={};for(let[f,o]of this.entries)if(Array.isArray(o)){let a=o[1]??i[0](e,t.offset++),y=Array(a),T=o[0];if(typeof T=="object")for(let u=0;u<a;++u)y[u]=T.read(e,t,r,i);else{let u=N[T];for(let _=0;_<a;++_)y[_]=i[T](e,t.offset),t.offset+=u}s[f]=y}else typeof o=="object"?s[f]=o.read(e,t,r,i):(s[f]=i[o](e,t.offset),t.offset+=N[o]);return s}write(e,t,r,i,s){return i[0](e,this.packetId,r.offset),r.offset+=1,this.canFastWrite?(this.fastWrite(e,t,r,i),e):this.slowWrite(e,t,r,this.minimumByteLength,this.minimumByteLength,i,s)}fastWrite(e,t,r,i){for(let[s,f]of this.entries)if(Array.isArray(f)){let o=f[0],a=f[1],y=t[s];if(typeof o=="object")for(let T=0;T<a;++T)o.fastWrite(e,y[T],r,i);else{let T=N[o];for(let u=0;u<a;++u)i[o](e,y[u],r.offset),r.offset+=T}}else typeof f=="object"?f.fastWrite(e,t[s],r,i):(i[f](e,t[s],r.offset),r.offset+=N[f])}slowWrite(e,t,r,i,s,f,o){for(let[a,y]of this.entries){let T=t[a];if(Array.isArray(y)){let u=T.length,_=y[1]===void 0;if(_&&(f[0](e,u,r.offset),r.offset+=1),u>0){let D=y[0];if(typeof D=="object"){if(_){let c=u*D.minimumByteLength;i+=c,s+=c,e.byteLength<s&&(e=o(e,s))}for(let c of T)f[0](e,D.packetId,r.offset),r.offset+=1,e=D.slowWrite(e,c,r,i,s,f,o),i=r.offset,s=e.byteLength}else{let c=N[D];if(_){let F=u*c;i+=F,s+=F,e.byteLength<s&&(e=o(e,s))}for(let F of T)f[D](e,F,r.offset),r.offset+=c}}}else typeof y=="object"?(f[0](e,y.packetId,r.offset),r.offset+=1,e=y.slowWrite(e,T,r,i,s,f,o),i=r.offset,s=e.byteLength):(f[y](e,T,r.offset),r.offset+=N[y])}return e}};function J(n){return Object.entries(n).sort(([e],[t])=>e.localeCompare(t))}function V(n){let e=1,t=!0;for(let[,r]of n)if(Array.isArray(r))if(r.length===2){let i=typeof r[0]=="object"?r[0].minimumByteLength:N[r[0]];e+=r[1]*i}else e+=1,t=!1;else r instanceof p?(e+=r.minimumByteLength,t&&=r.canFastWrite):e+=N[r];return{minimumByteLength:e,canFastWrite:t}}var N=Array(8);N[0]=1;N[3]=1;N[1]=2;N[4]=2;N[2]=4;N[5]=4;N[6]=4;N[7]=8;var m=Array(8);m[0]=(n,e)=>n.getUint8(e);m[3]=(n,e)=>n.getInt8(e);m[1]=(n,e)=>n.getUint16(e);m[4]=(n,e)=>n.getInt16(e);m[2]=(n,e)=>n.getUint32(e);m[5]=(n,e)=>n.getInt32(e);m[6]=(n,e)=>n.getFloat32(e);m[7]=(n,e)=>n.getFloat64(e);var I=Array(8);I[0]=(n,e,t)=>n.setUint8(t,e);I[3]=(n,e,t)=>n.setInt8(t,e);I[1]=(n,e,t)=>n.setUint16(t,e);I[4]=(n,e,t)=>n.setInt16(t,e);I[2]=(n,e,t)=>n.setUint32(t,e);I[5]=(n,e,t)=>n.setInt32(t,e);I[6]=(n,e,t)=>n.setFloat32(t,e);I[7]=(n,e,t)=>n.setFloat64(t,e);var d=Array(8);B&&(d[0]=(n,e,t)=>n.writeUint8(e,t),d[3]=(n,e,t)=>n.writeInt8(e,t),d[1]=(n,e,t)=>n.writeUint16LE(e,t),d[4]=(n,e,t)=>n.writeInt16LE(e,t),d[2]=(n,e,t)=>n.writeUint32LE(e,t),d[5]=(n,e,t)=>n.writeInt32LE(e,t),d[6]=(n,e,t)=>n.writeFloatLE(e,t),d[7]=(n,e,t)=>n.writeDoubleLE(e,t));var l=Array(8);B&&(l[0]=(n,e)=>n.readUint8(e),l[3]=(n,e)=>n.readInt8(e),l[1]=(n,e)=>n.readUint16LE(e),l[4]=(n,e)=>n.readInt16LE(e),l[2]=(n,e)=>n.readUint32LE(e),l[5]=(n,e)=>n.readInt32LE(e),l[6]=(n,e)=>n.readFloatLE(e),l[7]=(n,e)=>n.readDoubleLE(e));0&&(module.exports={BinaryPacket,Field,FieldArray,FieldFixedArray});
 //# sourceMappingURL=index.js.map