@etothepii/satisfactory-file-parser 0.0.31 → 0.0.33

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

@@ -7,6 +7,8 @@ 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';
@@ -14,6 +16,8 @@ export { BlueprintConfigWriter, BlueprintWriter } from './parser/satisfactory/bl
 export { SaveReader } from './parser/satisfactory/save/save-reader';
 export { SaveWriter } from './parser/satisfactory/save/save-writer';
 export * from './parser/satisfactory/structs/util.types';
-export { CompressionLibraryError, CorruptSaveError, ParserError, UnsupportedVersionError } from './parser/error/parser.error';
+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

@@ -18,12 +18,12 @@ var __exportStar = (this && this.__exportStar) || function(m, 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/error/parser.error", "./parser/file.types", "./parser/parser"], factory);
+        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.UnsupportedVersionError = exports.ParserError = exports.CorruptSaveError = exports.CompressionLibraryError = 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;
+    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; } });
@@ -54,11 +54,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     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 parser_error_1 = require("./parser/error/parser.error");
-    Object.defineProperty(exports, "CompressionLibraryError", { enumerable: true, get: function () { return parser_error_1.CompressionLibraryError; } });
-    Object.defineProperty(exports, "CorruptSaveError", { enumerable: true, get: function () { return parser_error_1.CorruptSaveError; } });
-    Object.defineProperty(exports, "ParserError", { enumerable: true, get: function () { return parser_error_1.ParserError; } });
-    Object.defineProperty(exports, "UnsupportedVersionError", { enumerable: true, get: function () { return parser_error_1.UnsupportedVersionError; } });
+    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/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

@@ -1,12 +1,13 @@
 import { Alignment } from "./alignment.enum";
-export declare abstract class ByteReader {
+import { BinaryReadable } from "./binary-readable.interface";
+export declare abstract class ByteReader implements BinaryReadable {
     protected bufferView: DataView;
     protected fileBuffer: ArrayBuffer;
-    protected alignment: Alignment;
+    alignment: Alignment;
+    debug: boolean;
     protected currentByte: number;
     protected handledByte: number;
     protected maxByte: number;
-    protected lastStrRead: number;
     constructor(fileBuffer: ArrayBuffer, alignment: Alignment);
     reset(newFileBuffer: ArrayBuffer): void;
     skipBytes(byteLength?: number): void;
@@ -15,20 +16,21 @@ export declare abstract class ByteReader {
     readHex(hexLength: number): string;
     readInt8(): number;
     readUint8(): number;
+    readInt16(): number;
     readUint16(): number;
     readInt32(): number;
     readUint32(): number;
     readLong(): bigint;
-    readFloat(): number;
+    readInt64(): bigint;
+    readUint64(): bigint;
+    readFloat32(): number;
     readDouble(): number;
-    protected getStringInfo(): {
-        payload: string;
-        counter: 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;
-    readString(): string;
 }

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

@@ -13,10 +13,11 @@
     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.lastStrRead = 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;
@@ -34,6 +35,7 @@
         }
         skipBytes(byteLength = 1) {
             this.currentByte += byteLength;
+            return;
         }
         readByte() {
             return parseInt(this.bufferView.getUint8(this.currentByte++).toString());
@@ -57,6 +59,11 @@
             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;
@@ -77,7 +84,15 @@
             this.currentByte += 8;
             return data;
         }
-        readFloat() {
+        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;
@@ -87,21 +102,8 @@
             this.currentByte += 8;
             return data;
         }
-        getStringInfo() {
-            let payload = '';
-            let counter = this.currentByte;
-            try {
-                let strLength = this.bufferView.getInt32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
-                counter += 4;
-                payload = new Array(strLength - 1).fill('').map(c => String.fromCharCode(this.bufferView.getUint8(counter++))).join('');
-            }
-            catch (error) { }
-            this.currentByte -= counter;
-            return { payload, counter };
-        }
         readString() {
             let strLength = this.readInt32();
-            this.lastStrRead = strLength;
             let startBytes = this.currentByte;
             if (strLength === 0) {
                 return '';
@@ -126,6 +128,12 @@
                 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;
 });

package/build/parser/error/parser.error.d.ts

@@ -10,3 +10,9 @@ export declare class CorruptSaveError extends ParserError {
 export declare class CompressionLibraryError extends ParserError {
     constructor(message?: string);
 }
+export declare class TimeoutError extends ParserError {
+    constructor(message?: string);
+}
+export declare class UnimplementedError extends ParserError {
+    constructor(message?: string);
+}

package/build/parser/error/parser.error.js

@@ -9,7 +9,7 @@
 })(function (require, exports) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    exports.CompressionLibraryError = exports.CorruptSaveError = exports.UnsupportedVersionError = exports.ParserError = void 0;
+    exports.UnimplementedError = exports.TimeoutError = exports.CompressionLibraryError = exports.CorruptSaveError = exports.UnsupportedVersionError = exports.ParserError = void 0;
     class ParserError extends Error {
         constructor(name, message) {
             super(message);
@@ -35,4 +35,16 @@
         }
     }
     exports.CompressionLibraryError = CompressionLibraryError;
+    class TimeoutError extends ParserError {
+        constructor(message) {
+            super('TimeoutError', message ?? 'Operation timed out.');
+        }
+    }
+    exports.TimeoutError = TimeoutError;
+    class UnimplementedError extends ParserError {
+        constructor(message) {
+            super('UnimplementedError', message ?? 'Unimplemented Operation.');
+        }
+    }
+    exports.UnimplementedError = UnimplementedError;
 });

package/build/parser/satisfactory/blueprint/blueprint-reader.d.ts

@@ -1,3 +1,4 @@
+import { BinaryReadable } from "../../byte/binary-readable.interface";
 import { ByteReader } from "../../byte/byte-reader.class";
 import { ChunkCompressionInfo } from "../../file.types";
 import { SaveComponent } from "../objects/SaveComponent";
@@ -6,7 +7,7 @@ import { BlueprintConfig, BlueprintHeader } from "./blueprint.types";
 export declare class BlueprintReader extends ByteReader {
     compressionInfo: ChunkCompressionInfo;
     constructor(bluePrintBuffer: ArrayBuffer);
-    static ReadHeader(reader: ByteReader): BlueprintHeader;
+    static ReadHeader(reader: BinaryReadable): BlueprintHeader;
     inflateChunks(): any;
     static ParseObjects(reader: ByteReader): (SaveEntity | SaveComponent)[];
 }
@@ -14,5 +15,5 @@ export declare class BlueprintConfigReader extends ByteReader {
     bluePrintConfigBuffer: ArrayBuffer;
     constructor(bluePrintConfigBuffer: ArrayBuffer);
     parse: () => BlueprintConfig;
-    static ParseConfig(reader: ByteReader): BlueprintConfig;
+    static ParseConfig(reader: BinaryReadable): BlueprintConfig;
 }

package/build/parser/satisfactory/blueprint/blueprint-writer.js

@@ -54,7 +54,7 @@
             writer.writeInt32(0);
             level_class_1.Level.SerializeObjectHeaders(writer, objects);
             writer.writeBinarySizeFromPosition(headersLenIndicator, headersLenIndicator + 4);
-            level_class_1.Level.SerializeObjectContents(writer, objects, 0);
+            level_class_1.Level.SerializeObjectContents(writer, objects, 0, '');
         }
     }
     exports.BlueprintWriter = BlueprintWriter;

package/build/parser/satisfactory/objects/DataFields.d.ts

@@ -1,13 +1,41 @@
-import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../..";
+import { BinaryReadable } from "../../byte/binary-readable.interface";
 import { SaveWriter } from "../save/save-writer";
+import { vec3 } from "../structs/util.types";
+import { ObjectReference } from "./ObjectReference";
 import { AbstractBaseProperty } from "./Property";
+export type SpecialAnyProperty = {} | PowerLineSpecialProperty;
+export type PowerLineSpecialProperty = {
+    num: number;
+    source: ObjectReference;
+    target: ObjectReference;
+    sourceTranslation?: vec3;
+    targetTranslation?: vec3;
+};
+export type PlayerSpecialProperty = {
+    flag: number;
+    eosData?: string;
+    steamPlayerData?: string;
+};
+export type ItemSpecialProperty = {
+    length: number;
+    name: string;
+    position: number;
+    pathName: string;
+};
+export type ConveyorSpecialProperty = {
+    items: ItemSpecialProperty[];
+};
 export declare class DataFields {
-    properties: any[];
+    properties: AbstractBaseProperty[];
+    specialProperties: SpecialAnyProperty;
     trailingData: number[];
     shouldBeNulled: boolean;
     constructor();
-    static Parse(length: number, reader: ByteReader, buildVersion: number): DataFields;
-    static ParseProperty(reader: ByteReader, buildVersion: number, propertyName: string): AbstractBaseProperty | null;
-    static Serialize(writer: SaveWriter, fields: DataFields, buildVersion: number): void;
-    static SerializeProperty(writer: SaveWriter, property: AbstractBaseProperty, propertyName: string, buildVersion: number): void;
+    static Parse(length: number, reader: BinaryReadable, buildVersion: number, typePath: string): DataFields;
+    static ParseAdditionalSpecialProperties(reader: BinaryReadable, typePath: string, remainingLen: number): SpecialAnyProperty;
+    static ParseProperty(reader: BinaryReadable, buildVersion: number, propertyName: string): AbstractBaseProperty | null;
+    static Serialize(writer: SaveWriter, fields: DataFields, buildVersion: number, typePath: string): void;
+    static SerializeAdditionalSpecialProperties(writer: ByteWriter, typePath: string, property: SpecialAnyProperty): void;
+    static SerializeProperty(writer: ByteWriter, property: AbstractBaseProperty, propertyName: string, buildVersion: number): void;
 }