@etothepii/satisfactory-file-parser 0.1.24 → 0.1.26

package/build/parser/stream/save-stream-writer.class.js

@@ -1,119 +1,82 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SaveStreamWriter = void 0;
-class SaveStreamWriter {
+class ModeStateTracker {
+    constructor(mode) {
+        this.mode = mode;
+    }
+    checkIsComingFrom(...allowedPredecessors) {
+        if (!allowedPredecessors.includes(this.mode)) {
+            throw new Error(`Wrong order of commands. mode is ${this.mode}. but only ${allowedPredecessors.join(', ')} is/are allowed.`);
+        }
+    }
+    advance(newMode) {
+        this.mode = newMode;
+    }
+}
+export class SaveStreamWriter {
     constructor(writer) {
         this.writer = writer;
+        this.createExecutionFunction = async (allowedInputModes, fn, targetMode) => {
+            this.tracker.checkIsComingFrom(...allowedInputModes);
+            await fn();
+            this.tracker.advance(targetMode);
+        };
+        this.beginSave = () => this.createExecutionFunction(['BEFORE_START'], async () => {
+            await this.writer.write('{');
+        }, 'OPENED_SAVE');
+        this.writeHeader = (header) => this.createExecutionFunction(['OPENED_SAVE'], async () => {
+            await this.writer.write(`"header": ${JSON.stringify(header)}`);
+        }, 'FINISHED_HEADER');
+        this.writeCompressionInfo = (compressionInfo) => this.createExecutionFunction(['FINISHED_HEADER'], async () => {
+            await this.writer.write(`, "compressionInfo": ${JSON.stringify(compressionInfo)}`);
+        }, 'WROTE_COMPRESSION_INFO');
+        this.writeGridHash = (gridHash) => this.createExecutionFunction(['WROTE_COMPRESSION_INFO'], async () => {
+            await this.writer.write(`, "gridHash": ${JSON.stringify(gridHash)}`);
+        }, 'WROTE_GRID_HASH');
+        this.writeGrids = (grids) => this.createExecutionFunction(['WROTE_GRID_HASH'], async () => {
+            await this.writer.write(`, "grids": ${JSON.stringify(grids)}`);
+        }, 'WROTE_GRIDS');
+        this.openLevels = () => this.createExecutionFunction(['WROTE_GRIDS'], async () => {
+            await this.writer.write(`, "levels": [`);
+        }, 'OPENED_LEVELS');
+        this.openLevel = (levelName) => this.createExecutionFunction(['OPENED_LEVELS', 'FINISHED_LEVEL'], async () => {
+            this.formatTracker.levels.push({
+                objectCount: 0, collectablesCount: 0
+            });
+            const prefix = this.formatTracker.levels.length > 1 ? ', ' : '';
+            await this.writer.write(`${prefix}{"name": "${levelName}", "objects": [`);
+        }, 'OPENED_LEVEL');
+        this.writeObjects = (...objects) => this.createExecutionFunction(['OPENED_LEVEL', 'WROTE_OBJECT'], async () => {
+            const stringified = objects.map(saveObj => JSON.stringify(saveObj));
+            for (const obj of stringified) {
+                await this.writer.write(`${this.formatTracker.levels.at(-1).objectCount >= 1 ? ', ' : ''}${obj}`);
+                this.formatTracker.levels.at(-1).objectCount++;
+            }
+        }, 'WROTE_OBJECT');
+        this.switchInLevelToCollectables = (...objects) => this.createExecutionFunction(['OPENED_LEVEL', 'WROTE_OBJECT'], async () => {
+            await this.writer.write(`], "collectables": [`);
+        }, 'SWITCH_TO_COLLECTABLES');
+        this.writeCollectables = (...collectables) => this.createExecutionFunction(['SWITCH_TO_COLLECTABLES', 'WROTE_COLLECTABLE'], async () => {
+            const stringified = collectables.map(coll => JSON.stringify(coll));
+            for (const obj of stringified) {
+                await this.writer.write(`${this.formatTracker.levels.at(-1).collectablesCount >= 1 ? ', ' : ''}${obj}`);
+                this.formatTracker.levels.at(-1).collectablesCount++;
+            }
+        }, 'WROTE_COLLECTABLE');
+        this.endLevel = () => this.createExecutionFunction(['SWITCH_TO_COLLECTABLES', 'WROTE_COLLECTABLE'], async () => {
+            await this.writer.write(`]}`);
+        }, 'FINISHED_LEVEL');
+        this.endLevels = () => this.createExecutionFunction(['OPENED_LEVELS', 'FINISHED_LEVEL'], async () => {
+            await this.writer.write(`]`);
+        }, 'FINISHED_LEVELS');
+        this.endSave = () => this.createExecutionFunction(['FINISHED_LEVELS'], async () => {
+            await this.writer.write('}');
+        }, 'FINISHED_SAVE');
         this.mode = 'BEFORE_START';
+        this.tracker = new ModeStateTracker(this.mode);
         this.formatTracker = {
             levels: []
         };
     }
-    async beginSave() {
-        if (this.mode !== 'BEFORE_START') {
-            throw new Error(`Wrong order of commands. Already opened save. mode is ${this.mode}.`);
-        }
-        await this.writer.write('{');
-        this.mode = 'OPENED_SAVE';
-    }
-    async writeHeader(header) {
-        if (this.mode !== 'OPENED_SAVE') {
-            throw new Error(`Wrong order of commands. Header has to come after save open. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`"header": ${JSON.stringify(header)}`);
-        this.mode = 'FINISHED_HEADER';
-    }
-    async writeCompressionInfo(compressionInfo) {
-        if (this.mode !== 'FINISHED_HEADER') {
-            throw new Error(`Wrong order of commands. Compression info has to come after header. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`, "compressionInfo": ${JSON.stringify(compressionInfo)}`);
-        this.mode = 'WROTE_COMPRESSION_INFO';
-    }
-    async writeGridHash(gridHash) {
-        if (this.mode !== 'WROTE_COMPRESSION_INFO') {
-            throw new Error(`Wrong order of commands. Save hbody hash has to come after compression info. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`, "gridHash": ${JSON.stringify(gridHash)}`);
-        this.mode = 'WROTE_GRID_HASH';
-    }
-    async writeGrids(grids) {
-        if (this.mode !== 'WROTE_GRID_HASH') {
-            throw new Error(`Wrong order of commands. Grids have to come after save body hash info. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`, "grids": ${JSON.stringify(grids)}`);
-        this.mode = 'WROTE_GRIDS';
-    }
-    async openLevels() {
-        if (this.mode !== 'WROTE_GRIDS') {
-            throw new Error(`Wrong order of commands. Levels have to come after grids info. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`, "levels": [`);
-        this.mode = 'OPENED_LEVELS';
-    }
-    async openLevel(levelName) {
-        if (this.mode !== 'OPENED_LEVELS' && this.mode !== 'FINISHED_LEVEL') {
-            throw new Error(`Wrong order of commands. Single level can only come after opening levels array or after finishing single level. mode is ${this.mode}.`);
-        }
-        this.formatTracker.levels.push({
-            objectCount: 0, collectablesCount: 0
-        });
-        const prefix = this.formatTracker.levels.length > 1 ? ', ' : '';
-        await this.writer.write(`${prefix}{"name": "${levelName}", "objects": [`);
-        this.mode = 'OPENED_LEVEL';
-    }
-    async writeObjects(...objects) {
-        if (this.mode !== 'OPENED_LEVEL' && this.mode !== 'WROTE_OBJECT') {
-            throw new Error(`Wrong order of commands. An object can not be written into the level if it was not opened or other objects were not written. mode is ${this.mode}.`);
-        }
-        const stringified = objects.map(saveObj => JSON.stringify(saveObj));
-        for (const obj of stringified) {
-            await this.writer.write(`${this.formatTracker.levels.at(-1).objectCount >= 1 ? ', ' : ''}${obj}`);
-            this.formatTracker.levels.at(-1).objectCount++;
-        }
-        this.mode = 'WROTE_OBJECT';
-    }
-    async switchInLevelToCollectables() {
-        if (this.mode !== 'OPENED_LEVEL' && this.mode !== 'WROTE_OBJECT') {
-            throw new Error(`Wrong order of commands. The level structure can not be switched to collectables if the level was not opened recently or has not written objects. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`], "collectables": [`);
-        this.mode = 'SWITCH_TO_COLLECTABLES';
-    }
-    async writeCollectables(...collectables) {
-        if (this.mode !== 'SWITCH_TO_COLLECTABLES' && this.mode !== 'WROTE_COLLECTABLE') {
-            throw new Error(`Wrong order of commands. A  collectable can not be written into the level if we did not switch to collectables or other collectables were not written. mode is ${this.mode}.`);
-        }
-        const stringified = collectables.map(coll => JSON.stringify(coll));
-        for (const obj of stringified) {
-            await this.writer.write(`${this.formatTracker.levels.at(-1).collectablesCount >= 1 ? ', ' : ''}${obj}`);
-            this.formatTracker.levels.at(-1).collectablesCount++;
-        }
-        this.mode = 'WROTE_COLLECTABLE';
-    }
-    async endLevel() {
-        if (this.mode !== 'SWITCH_TO_COLLECTABLES' && this.mode !== 'WROTE_COLLECTABLE') {
-            throw new Error(`Wrong order of commands. Single level can not be closed if a switch to collectibles or writing of collectible did not happen. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`]}`);
-        this.mode = 'FINISHED_LEVEL';
-    }
-    async endLevels() {
-        if (this.mode !== 'OPENED_LEVELS' && this.mode !== 'FINISHED_LEVEL') {
-            throw new Error(`Wrong order of commands. Levels can only be closed after opening levels array or after finishing single level. mode is ${this.mode}.`);
-        }
-        await this.writer.write(`]`);
-        this.mode = 'FINISHED_LEVELS';
-    }
-    async endSave() {
-        if (this.mode !== 'FINISHED_LEVELS') {
-            throw new Error(`Wrong order of commands. Save has to end after levels. mode is ${this.mode}.`);
-        }
-        await this.writer.write('}');
-        this.mode = 'FINISHED_SAVE';
-    }
     async close() {
         return this.writer.close();
     }
 }
-exports.SaveStreamWriter = SaveStreamWriter;

package/build/parser/stream/stream-level.class.js

@@ -1,10 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamLevel = void 0;
-const __1 = require("../..");
-const SaveComponent_1 = require("../satisfactory/objects/SaveComponent");
-const SaveEntity_1 = require("../satisfactory/objects/SaveEntity");
-class StreamLevel {
+import { Level, ParseTransform } from "../..";
+import { SaveComponent } from "../satisfactory/objects/SaveComponent";
+import { SaveEntity } from "../satisfactory/objects/SaveEntity";
+export class StreamLevel {
     constructor(name) {
         this.name = name;
     }
@@ -12,13 +9,13 @@ class StreamLevel {
         const binaryLength = reader.readInt32();
         await reader.allocate(binaryLength);
         const objectHeaders = StreamLevel.ReadObjectHeaders(reader);
-        const collectables = __1.Level.ReadCollectablesList(reader);
+        const collectables = Level.ReadCollectablesList(reader);
         await writer.openLevel(levelName);
         await StreamLevel.StreamObjectContentsAsync(reader, writer, objectHeaders, buildVersion);
         await writer.switchInLevelToCollectables();
         await writer.writeCollectables(...collectables);
         await writer.endLevel();
-        __1.Level.ReadCollectablesList(reader);
+        Level.ReadCollectablesList(reader);
         return;
     }
     static ReadObjectHeaders(reader) {
@@ -33,7 +30,7 @@ class StreamLevel {
                         rootObject: reader.readString(),
                         instanceName: reader.readString(),
                         needTransform: reader.readInt32() == 1,
-                        transform: (0, __1.ParseTransform)(reader),
+                        transform: ParseTransform(reader),
                         wasPlacedInLevel: reader.readInt32() == 1
                     });
                     break;
@@ -78,13 +75,13 @@ class StreamLevel {
             }
             const isComponent = obj.parentEntityName !== undefined;
             if (!isComponent) {
-                const entity = new SaveEntity_1.SaveEntity(obj.typePath, obj.rootObject, obj.instanceName, '', obj.needTransform);
-                SaveEntity_1.SaveEntity.ParseData(entity, len, reader, buildVersion, obj.typePath);
+                const entity = new SaveEntity(obj.typePath, obj.rootObject, obj.instanceName, '', obj.needTransform);
+                SaveEntity.ParseData(entity, len, reader, buildVersion, obj.typePath);
                 bufferedObjects.push(entity);
             }
             else if (isComponent) {
-                const component = new SaveComponent_1.SaveComponent(obj.typePath, obj.rootObject, obj.instanceName, obj.parentEntityName);
-                SaveComponent_1.SaveComponent.ParseData(component, len, reader, buildVersion, obj.typePath);
+                const component = new SaveComponent(obj.typePath, obj.rootObject, obj.instanceName, obj.parentEntityName);
+                SaveComponent.ParseData(component, len, reader, buildVersion, obj.typePath);
                 bufferedObjects.push(component);
             }
             const after = reader.getBufferPosition();
@@ -100,4 +97,3 @@ class StreamLevel {
         }
     }
 }
-exports.StreamLevel = StreamLevel;

package/build/parser/stream/stream-parser.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamParserReader = void 0;
-const alignment_enum_1 = require("../byte/alignment.enum");
-class StreamParserReader {
+import { Alignment } from "../byte/alignment.enum";
+export class StreamParserReader {
     constructor(minBufferSize) {
         this.minBufferSize = minBufferSize;
-        this.alignment = alignment_enum_1.Alignment.LITTLE_ENDIAN;
+        this.alignment = Alignment.LITTLE_ENDIAN;
         this.getAmountLeftToRead = () => {
             return this.view.byteLength - this.currentByte;
         };
@@ -154,27 +151,27 @@ class StreamParserReader {
         return data;
     }
     readInt16() {
-        let data = this.view.getInt16(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getInt16(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 2;
         return data;
     }
     readUint16() {
-        let data = this.view.getUint16(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getUint16(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 2;
         return data;
     }
     readInt32() {
-        let data = this.view.getInt32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getInt32(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 4;
         return data;
     }
     readUint32() {
-        let data = this.view.getUint32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getUint32(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 4;
         return data;
     }
     readLong() {
-        let data = this.view.getBigInt64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getBigInt64(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 8;
         return data;
     }
@@ -182,17 +179,17 @@ class StreamParserReader {
         return this.readLong();
     }
     readUint64() {
-        let data = this.view.getBigUint64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getBigUint64(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 8;
         return data;
     }
     readFloat32() {
-        let data = this.view.getFloat32(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getFloat32(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 4;
         return data;
     }
     readDouble() {
-        let data = this.view.getFloat64(this.currentByte, this.alignment === alignment_enum_1.Alignment.LITTLE_ENDIAN);
+        let data = this.view.getFloat64(this.currentByte, this.alignment === Alignment.LITTLE_ENDIAN);
         this.currentByte += 8;
         return data;
     }
@@ -222,4 +219,3 @@ class StreamParserReader {
         }
     }
 }
-exports.StreamParserReader = StreamParserReader;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@etothepii/satisfactory-file-parser",
 	"author": "etothepii",
-	"version": "0.1.24",
+	"version": "0.1.26",
 	"description": "A file parser for satisfactory files. Includes save files and blueprint files.",
 	"types": "./build/index.d.ts",
 	"main": "./build/index.js",
@@ -45,6 +45,8 @@
 		"webpack-cli": "^5.0.1"
 	},
 	"dependencies": {
-		"pako": "^2.1.0"
+		"pako": "^2.1.0",
+		"stream-browserify": "^3.0.0",
+		"web-streams-polyfill": "^4.0.0"
 	}
 }

package/build/parser/satisfactory/objects/ue/FMD5Hash.d.ts

@@ -1,7 +0,0 @@
-import { ByteReader, ByteWriter } from '../../../..';
-export type MD5Hash = {
-    isValid: boolean;
-    hash?: number[];
-};
-export declare const readMD5Hash: (reader: ByteReader) => MD5Hash;
-export declare const writeMD5Hash: (writer: ByteWriter, md5Hash: MD5Hash) => void;

package/build/parser/satisfactory/objects/ue/FMD5Hash.js

@@ -1,19 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeMD5Hash = exports.readMD5Hash = void 0;
-const readMD5Hash = (reader) => {
-    const md5Hash = { isValid: false };
-    md5Hash.isValid = reader.readInt32() === 1;
-    if (md5Hash.isValid) {
-        md5Hash.hash = Array.from(reader.readBytes(16));
-    }
-    return md5Hash;
-};
-exports.readMD5Hash = readMD5Hash;
-const writeMD5Hash = (writer, md5Hash) => {
-    writer.writeInt32(md5Hash.isValid ? 1 : 0);
-    if (md5Hash.isValid) {
-        writer.writeBytesArray(md5Hash.hash);
-    }
-};
-exports.writeMD5Hash = writeMD5Hash;