@etothepii/satisfactory-file-parser 0.0.30 → 0.0.32

package/LICENCE.md

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 etotheepii
-
-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) 2023 etotheepii
+
+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

@@ -1,113 +1,113 @@
-# Satisfactory File Parser
-This is an NPM TypeScript Module to parse Satisfactory Files. Satisfactory is a game released by Coffee Stain Studios.
-
-The Module is written entirely in TypeScript and comes with Type Definitions.
-Currently, only the built JavaScript and Type Definitions are available. But if needed, the TypeScript source can be provided as well in future versions.
-
-This parser can read, modify and write:
-- Save Files `.sav`
-- Blueprint Files `.sbp`, `.sbpcfg`
-
-## Supported Versions
-Game Version Files of U5 and below are NOT supported. However, U6 and above is perfectly fine and parsable.
-- ✅ U7 
-- ✅ U6 
-- ❌ <= U5 
-
-### U8 is on the Horizon!
-We can not promise that U8 saves will work out of the box!
-If there will be changes, those will come very soon as soon as U8 is out on Experimental.
-
-## Installation via npm
-`npm install @etothepii/satisfactory-file-parser`
-
-## Usage of Save Parsing
-Usage of the SaveParser is easy. For reading a save file (`.sav`), just pass a Buffer to the parser with the file content.
-```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
-
-const file = fs.readFileSync('./MySave.sav') as Buffer;
-const parsedSave = Parser.ParseSaveFile(file);
-```
-
-Consequently, writing a parsed save file back is just as easy.
-The SaveParser has callbacks to assist in syncing on different occasions during the process.
-For example, when writing the header or when writing a chunk of the save body.
-The splitting in individual chunks enables you to more easily stream the binary data to somewhere else.
-```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
-
-let header: Uint8Array, bodyChunks: Uint8Array[] = [];
-Parser.WriteSave(save, binaryBeforeCompressed => {
-    console.log('on binary data before being compressed.');
-}, header => {
-    console.log('on save header.');
-    header = header;
-}, chunk => {
-    console.log('on save body chunk.');
-    bodyChunks.push(chunk);
-});
-
-// write complete sav file back to disk
-fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([header!, ...bodyChunks]));
-```
-
-## Usage of Blueprint Parsing
-Blueprint parsing works very similiar. Note, that blueprints consist of 2 files. The `.sbp` main file and the config file `.sbpcfg`.
-
-```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
-
-const mainFile = fs.readFileSync('./MyBlueprint.sbp') as Buffer;
-const configFile = fs.readFileSync('./MyBlueprint.sbpcfg') as Buffer;
-const parsedBlueprint = Parser.ParseBlueprintFiles('MyBlueprint', mainFile, configFile);
-```
-
-Consequently, writing a blueprint into binary data works the same way with getting callbacks in the same style as the save parsing.
-```js
-import * as fs from 'fs';
-import { Parser } from "@etothepii/satisfactory-file-parser";
-
-let mainFileHeader: Uint8Array, mainFileBodyChunks: Uint8Array[] = [];
-const summary = Parser.WriteBlueprintFiles(blueprint, mainFileBinaryBeforeCompressed => {
-    console.log('on main file binary data before being compressed.');
-}, header => {
-    console.log('on main file blueprint header.');
-    mainFileHeader = header;
-}, chunk => {
-    console.log('on main file blueprint body chunk.');
-    mainFileBodyChunks.push(chunk);
-});
-
-// write complete .sbp file back to disk
-fs.writeFileSync('./MyModifiedBlueprint.sbp', Buffer.concat([mainFileHeader!, ...mainFileBodyChunks]));
-
-// write .sbpcfg file back to disk, we get that data from the result of WriteBlueprintFiles
-fs.writeFileSync('./MyModifiedSave.sbpcfg', Buffer.from(summary.configFileBinary));
-```
-
-## License 
-MIT License
-
-Copyright (c) 2023 etotheepii
-
-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
+# Satisfactory File Parser
+This is an NPM TypeScript Module to parse Satisfactory Files. Satisfactory is a game released by Coffee Stain Studios.
+
+The Module is written entirely in TypeScript and comes with Type Definitions.
+Currently, only the built JavaScript and Type Definitions are available. But if needed, the TypeScript source can be provided as well in future versions.
+
+This parser can read, modify and write:
+- Save Files `.sav`
+- Blueprint Files `.sbp`, `.sbpcfg`
+
+## Supported Versions
+Game Version Files of U5 and below are NOT supported. However, U6 and above is perfectly fine and parsable.
+- ✅ U7 
+- ✅ U6 
+- ❌ <= U5 
+
+### U8 is on the Horizon!
+We can not promise that U8 saves will work out of the box!
+If there will be changes, those will come very soon as soon as U8 is out on Experimental.
+
+## Installation via npm
+`npm install @etothepii/satisfactory-file-parser`
+
+## Usage of Save Parsing
+Usage of the SaveParser is easy. For reading a save file (`.sav`), just pass a Buffer to the parser with the file content.
+```js
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
+
+const file = fs.readFileSync('./MySave.sav') as Buffer;
+const parsedSave = Parser.ParseSaveFile(file);
+```
+
+Consequently, writing a parsed save file back is just as easy.
+The SaveParser has callbacks to assist in syncing on different occasions during the process.
+For example, when writing the header or when writing a chunk of the save body.
+The splitting in individual chunks enables you to more easily stream the binary data to somewhere else.
+```js
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
+
+let header: Uint8Array, bodyChunks: Uint8Array[] = [];
+Parser.WriteSave(save, binaryBeforeCompressed => {
+    console.log('on binary data before being compressed.');
+}, header => {
+    console.log('on save header.');
+    header = header;
+}, chunk => {
+    console.log('on save body chunk.');
+    bodyChunks.push(chunk);
+});
+
+// write complete sav file back to disk
+fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([header!, ...bodyChunks]));
+```
+
+## Usage of Blueprint Parsing
+Blueprint parsing works very similiar. Note, that blueprints consist of 2 files. The `.sbp` main file and the config file `.sbpcfg`.
+
+```js
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
+
+const mainFile = fs.readFileSync('./MyBlueprint.sbp') as Buffer;
+const configFile = fs.readFileSync('./MyBlueprint.sbpcfg') as Buffer;
+const parsedBlueprint = Parser.ParseBlueprintFiles('MyBlueprint', mainFile, configFile);
+```
+
+Consequently, writing a blueprint into binary data works the same way with getting callbacks in the same style as the save parsing.
+```js
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
+
+let mainFileHeader: Uint8Array, mainFileBodyChunks: Uint8Array[] = [];
+const summary = Parser.WriteBlueprintFiles(blueprint, mainFileBinaryBeforeCompressed => {
+    console.log('on main file binary data before being compressed.');
+}, header => {
+    console.log('on main file blueprint header.');
+    mainFileHeader = header;
+}, chunk => {
+    console.log('on main file blueprint body chunk.');
+    mainFileBodyChunks.push(chunk);
+});
+
+// write complete .sbp file back to disk
+fs.writeFileSync('./MyModifiedBlueprint.sbp', Buffer.concat([mainFileHeader!, ...mainFileBodyChunks]));
+
+// write .sbpcfg file back to disk, we get that data from the result of WriteBlueprintFiles
+fs.writeFileSync('./MyModifiedSave.sbpcfg', Buffer.from(summary.configFileBinary));
+```
+
+## License 
+MIT License
+
+Copyright (c) 2023 etotheepii
+
+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/build/index.d.ts

@@ -0,0 +1,23 @@
+export * from './parser/satisfactory/blueprint/blueprint.types';
+export { DataFields } from './parser/satisfactory/objects/DataFields';
+export { ObjectReference } from './parser/satisfactory/objects/ObjectReference';
+export * from './parser/satisfactory/objects/Property';
+export { SaveComponent } from './parser/satisfactory/objects/SaveComponent';
+export { SaveEntity } from './parser/satisfactory/objects/SaveEntity';
+export { Level } from './parser/satisfactory/save/level.class';
+export { SatisfactorySave } from './parser/satisfactory/save/satisfactory-save';
+export * from './parser/satisfactory/save/save.types';
+export { BinaryOperable } from './parser/byte/binary-operable.interface';
+export { BinaryReadable } from './parser/byte/binary-readable.interface';
+export { ByteReader } from './parser/byte/byte-reader.class';
+export { ByteWriter } from './parser/byte/byte-writer.class';
+export { BlueprintConfigReader, BlueprintReader } from './parser/satisfactory/blueprint/blueprint-reader';
+export { BlueprintConfigWriter, BlueprintWriter } from './parser/satisfactory/blueprint/blueprint-writer';
+export { SaveReader } from './parser/satisfactory/save/save-reader';
+export { SaveWriter } from './parser/satisfactory/save/save-writer';
+export * from './parser/satisfactory/structs/util.types';
+export { SaveStreamJsonStringifier } from './parser/stream/save-stream-json-stringifier';
+export { SaveStreamWriter } from './parser/stream/save-stream-writer.class';
+export * from './parser/error/parser.error';
+export * from './parser/file.types';
+export { Parser } from './parser/parser';

package/build/index.js

@@ -0,0 +1,65 @@
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./parser/satisfactory/blueprint/blueprint.types", "./parser/satisfactory/objects/DataFields", "./parser/satisfactory/objects/ObjectReference", "./parser/satisfactory/objects/Property", "./parser/satisfactory/objects/SaveComponent", "./parser/satisfactory/objects/SaveEntity", "./parser/satisfactory/save/level.class", "./parser/satisfactory/save/satisfactory-save", "./parser/satisfactory/save/save.types", "./parser/byte/byte-reader.class", "./parser/byte/byte-writer.class", "./parser/satisfactory/blueprint/blueprint-reader", "./parser/satisfactory/blueprint/blueprint-writer", "./parser/satisfactory/save/save-reader", "./parser/satisfactory/save/save-writer", "./parser/satisfactory/structs/util.types", "./parser/stream/save-stream-json-stringifier", "./parser/stream/save-stream-writer.class", "./parser/error/parser.error", "./parser/file.types", "./parser/parser"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Parser = exports.SaveStreamWriter = exports.SaveStreamJsonStringifier = exports.SaveWriter = exports.SaveReader = exports.BlueprintWriter = exports.BlueprintConfigWriter = exports.BlueprintReader = exports.BlueprintConfigReader = exports.ByteWriter = exports.ByteReader = exports.SatisfactorySave = exports.Level = exports.SaveEntity = exports.SaveComponent = exports.ObjectReference = exports.DataFields = void 0;
+    __exportStar(require("./parser/satisfactory/blueprint/blueprint.types"), exports);
+    var DataFields_1 = require("./parser/satisfactory/objects/DataFields");
+    Object.defineProperty(exports, "DataFields", { enumerable: true, get: function () { return DataFields_1.DataFields; } });
+    var ObjectReference_1 = require("./parser/satisfactory/objects/ObjectReference");
+    Object.defineProperty(exports, "ObjectReference", { enumerable: true, get: function () { return ObjectReference_1.ObjectReference; } });
+    __exportStar(require("./parser/satisfactory/objects/Property"), exports);
+    var SaveComponent_1 = require("./parser/satisfactory/objects/SaveComponent");
+    Object.defineProperty(exports, "SaveComponent", { enumerable: true, get: function () { return SaveComponent_1.SaveComponent; } });
+    var SaveEntity_1 = require("./parser/satisfactory/objects/SaveEntity");
+    Object.defineProperty(exports, "SaveEntity", { enumerable: true, get: function () { return SaveEntity_1.SaveEntity; } });
+    var level_class_1 = require("./parser/satisfactory/save/level.class");
+    Object.defineProperty(exports, "Level", { enumerable: true, get: function () { return level_class_1.Level; } });
+    var satisfactory_save_1 = require("./parser/satisfactory/save/satisfactory-save");
+    Object.defineProperty(exports, "SatisfactorySave", { enumerable: true, get: function () { return satisfactory_save_1.SatisfactorySave; } });
+    __exportStar(require("./parser/satisfactory/save/save.types"), exports);
+    var byte_reader_class_1 = require("./parser/byte/byte-reader.class");
+    Object.defineProperty(exports, "ByteReader", { enumerable: true, get: function () { return byte_reader_class_1.ByteReader; } });
+    var byte_writer_class_1 = require("./parser/byte/byte-writer.class");
+    Object.defineProperty(exports, "ByteWriter", { enumerable: true, get: function () { return byte_writer_class_1.ByteWriter; } });
+    var blueprint_reader_1 = require("./parser/satisfactory/blueprint/blueprint-reader");
+    Object.defineProperty(exports, "BlueprintConfigReader", { enumerable: true, get: function () { return blueprint_reader_1.BlueprintConfigReader; } });
+    Object.defineProperty(exports, "BlueprintReader", { enumerable: true, get: function () { return blueprint_reader_1.BlueprintReader; } });
+    var blueprint_writer_1 = require("./parser/satisfactory/blueprint/blueprint-writer");
+    Object.defineProperty(exports, "BlueprintConfigWriter", { enumerable: true, get: function () { return blueprint_writer_1.BlueprintConfigWriter; } });
+    Object.defineProperty(exports, "BlueprintWriter", { enumerable: true, get: function () { return blueprint_writer_1.BlueprintWriter; } });
+    var save_reader_1 = require("./parser/satisfactory/save/save-reader");
+    Object.defineProperty(exports, "SaveReader", { enumerable: true, get: function () { return save_reader_1.SaveReader; } });
+    var save_writer_1 = require("./parser/satisfactory/save/save-writer");
+    Object.defineProperty(exports, "SaveWriter", { enumerable: true, get: function () { return save_writer_1.SaveWriter; } });
+    __exportStar(require("./parser/satisfactory/structs/util.types"), exports);
+    var save_stream_json_stringifier_1 = require("./parser/stream/save-stream-json-stringifier");
+    Object.defineProperty(exports, "SaveStreamJsonStringifier", { enumerable: true, get: function () { return save_stream_json_stringifier_1.SaveStreamJsonStringifier; } });
+    var save_stream_writer_class_1 = require("./parser/stream/save-stream-writer.class");
+    Object.defineProperty(exports, "SaveStreamWriter", { enumerable: true, get: function () { return save_stream_writer_class_1.SaveStreamWriter; } });
+    __exportStar(require("./parser/error/parser.error"), exports);
+    __exportStar(require("./parser/file.types"), exports);
+    var parser_1 = require("./parser/parser");
+    Object.defineProperty(exports, "Parser", { enumerable: true, get: function () { return parser_1.Parser; } });
+});

package/build/parser/byte/alignment.enum.d.ts

@@ -0,0 +1,4 @@
+export declare enum Alignment {
+    BIG_ENDIAN = 0,
+    LITTLE_ENDIAN = 1
+}

package/build/parser/byte/alignment.enum.js

@@ -0,0 +1,18 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Alignment = void 0;
+    var Alignment;
+    (function (Alignment) {
+        Alignment[Alignment["BIG_ENDIAN"] = 0] = "BIG_ENDIAN";
+        Alignment[Alignment["LITTLE_ENDIAN"] = 1] = "LITTLE_ENDIAN";
+    })(Alignment = exports.Alignment || (exports.Alignment = {}));
+});

package/build/parser/byte/binary-operable.interface.d.ts

@@ -0,0 +1,6 @@
+import { Alignment } from "./alignment.enum";
+export interface BinaryOperable {
+    alignment: Alignment;
+    getBufferPosition: () => number;
+    getBufferLength: () => number;
+}

package/build/parser/byte/binary-operable.interface.js

@@ -0,0 +1,12 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/build/parser/byte/binary-readable.interface.d.ts

@@ -0,0 +1,22 @@
+import { BinaryOperable } from "./binary-operable.interface";
+export interface BinaryReadable extends BinaryOperable {
+    debug: boolean;
+    skipBytes: (count?: number) => void;
+    readBytes: (count: number) => Uint8Array;
+    readByte: () => number;
+    readHex: (count: number) => string;
+    readInt8: () => number;
+    readUint8: () => number;
+    readInt16: () => number;
+    readUint16: () => number;
+    readInt32: () => number;
+    readUint32: () => number;
+    readInt64: () => bigint;
+    readUint64: () => bigint;
+    readFloat32: () => number;
+    readDouble: () => number;
+    readString: () => string;
+    getBufferProgress: () => number;
+    allocate: (count: number) => PromiseLike<void>;
+    getAmountAllocatedLeft: () => number;
+}

package/build/parser/byte/binary-readable.interface.js

@@ -0,0 +1,12 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+});

package/build/parser/byte/byte-reader.class.d.ts

@@ -0,0 +1,36 @@
+import { Alignment } from "./alignment.enum";
+import { BinaryReadable } from "./binary-readable.interface";
+export declare abstract class ByteReader implements BinaryReadable {
+    protected bufferView: DataView;
+    protected fileBuffer: ArrayBuffer;
+    alignment: Alignment;
+    debug: boolean;
+    protected currentByte: number;
+    protected handledByte: number;
+    protected maxByte: number;
+    constructor(fileBuffer: ArrayBuffer, alignment: Alignment);
+    reset(newFileBuffer: ArrayBuffer): void;
+    skipBytes(byteLength?: number): void;
+    readByte(): number;
+    readBytes(count: number): Uint8Array;
+    readHex(hexLength: number): string;
+    readInt8(): number;
+    readUint8(): number;
+    readInt16(): number;
+    readUint16(): number;
+    readInt32(): number;
+    readUint32(): number;
+    readLong(): bigint;
+    readInt64(): bigint;
+    readUint64(): bigint;
+    readFloat32(): number;
+    readDouble(): number;
+    readString(): string;
+    allocate(count: number): Promise<void>;
+    getAmountAllocatedLeft: () => number;
+    getBufferPosition: () => number;
+    getBufferSlice: (begin: number, end: number | undefined) => ArrayBuffer;
+    getBufferProgress: () => number;
+    getBufferLength: () => number;
+    getBuffer: () => ArrayBuffer;
+}

package/build/parser/byte/byte-reader.class.js

@@ -0,0 +1,139 @@
+(function (factory) {
+    if (typeof module === "object" && typeof module.exports === "object") {
+        var v = factory(require, exports);
+        if (v !== undefined) module.exports = v;
+    }
+    else if (typeof define === "function" && define.amd) {
+        define(["require", "exports", "./alignment.enum"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.ByteReader = void 0;
+    const alignment_enum_1 = require("./alignment.enum");
+    class ByteReader {
+        constructor(fileBuffer, alignment) {
+            this.debug = false;
+            this.currentByte = 0;
+            this.handledByte = 0;
+            this.maxByte = 0;
+            this.getAmountAllocatedLeft = () => this.bufferView.byteLength - this.currentByte;
+            this.getBufferPosition = () => this.currentByte;
+            this.getBufferSlice = (begin, end) => this.bufferView.buffer.slice(begin, end);
+            this.getBufferProgress = () => this.currentByte / this.bufferView.buffer.byteLength;
+            this.getBufferLength = () => this.bufferView.buffer.byteLength;
+            this.getBuffer = () => this.bufferView.buffer;
+            this.alignment = alignment;
+            this.reset(fileBuffer);
+        }
+        reset(newFileBuffer) {
+            this.fileBuffer = newFileBuffer;
+            this.bufferView = new DataView(newFileBuffer, 0, Math.min(102400, this.fileBuffer.byteLength));
+            this.maxByte = newFileBuffer.byteLength;
+            this.currentByte = 0;
+            this.handledByte = 0;
+        }
+        skipBytes(byteLength = 1) {
+            this.currentByte += byteLength;
+            return;
+        }
+        readByte() {
+            return parseInt(this.bufferView.getUint8(this.currentByte++).toString());
+        }
+        readBytes(count) {
+            return new Uint8Array(new Array(count).fill(0).map(pl => this.bufferView.getUint8(this.currentByte++)));
+        }
+        readHex(hexLength) {
+            let hexPart = [];
+            for (let i = 0; i < hexLength; i++) {
+                let currentHex = String.fromCharCode(this.bufferView.getUint8(this.currentByte++));
+                hexPart.push(currentHex);
+            }
+            return hexPart.join('');
+        }
+        readInt8() {
+            let data = this.bufferView.getInt8(this.currentByte++);
+            return data;
+        }
+        readUint8() {
+            let data = this.bufferView.getUint8(this.currentByte++);
+            return data;
+        }
+        readInt16() {
+            let data = this.bufferView.getInt16(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 2;
+            return data;
+        }
+        readUint16() {
+            let data = this.bufferView.getUint16(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 2;
+            return data;
+        }
+        readInt32() {
+            let data = this.bufferView.getInt32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 4;
+            return data;
+        }
+        readUint32() {
+            let data = this.bufferView.getUint32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 4;
+            return data;
+        }
+        readLong() {
+            let data = this.bufferView.getBigInt64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 8;
+            return data;
+        }
+        readInt64() {
+            return this.readLong();
+        }
+        readUint64() {
+            let data = this.bufferView.getBigUint64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 8;
+            return data;
+        }
+        readFloat32() {
+            let data = this.bufferView.getFloat32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 4;
+            return data;
+        }
+        readDouble() {
+            let data = this.bufferView.getFloat64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+            this.currentByte += 8;
+            return data;
+        }
+        readString() {
+            let strLength = this.readInt32();
+            let startBytes = this.currentByte;
+            if (strLength === 0) {
+                return '';
+            }
+            if (strLength > (this.bufferView.buffer.byteLength - this.currentByte)) {
+                let errorMessage = `Cannot read string of length ${strLength} at position ${this.currentByte} as it exceeds the end at ${this.bufferView.buffer.byteLength}`;
+                throw new Error(errorMessage);
+            }
+            if (strLength < 0) {
+                const string = new Array(-strLength - 1).fill('').map(c => String.fromCharCode(this.readUint16()));
+                this.currentByte += 2;
+                return string.join('');
+            }
+            try {
+                const string = new Array(strLength - 1).fill('').map(c => String.fromCharCode(this.readUint8()));
+                this.currentByte += 1;
+                return string.join('');
+            }
+            catch (error) {
+                let errorMessage = `Cannot read UTF8 string of length ${strLength} at position ${this.currentByte}.`;
+                console.log(errorMessage, error);
+                throw error;
+            }
+        }
+        allocate(count) {
+            if (this.currentByte + count < this.bufferView.byteLength) {
+                console.warn('tried to allocate but there is not enough data left.');
+            }
+            return Promise.resolve();
+        }
+    }
+    exports.ByteReader = ByteReader;
+});