@etothepii/satisfactory-file-parser 0.0.29 → 0.0.31

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

@@ -0,0 +1,16 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../byte/byte-writer.class";
+import { SaveObject } from "./SaveObject";
+export declare const isSaveComponent: (obj: any) => obj is SaveComponent;
+export declare class SaveComponent extends SaveObject {
+    typePath: string;
+    rootObject: string;
+    instanceName: string;
+    parentEntityName: string;
+    static readonly TypeID = 0;
+    readonly type = "SaveComponent";
+    constructor(typePath: string, rootObject: string, instanceName: string, parentEntityName?: string);
+    static ParseHeader(reader: ByteReader, obj: SaveComponent): void;
+    static SerializeHeader(writer: ByteWriter, component: SaveComponent): void;
+    static ParseData(component: SaveComponent, length: number, reader: ByteReader, buildVersion: number): void;
+}

package/build/parser/satisfactory/objects/SaveComponent.js

@@ -0,0 +1,41 @@
+(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", "./SaveObject"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SaveComponent = exports.isSaveComponent = void 0;
+    const SaveObject_1 = require("./SaveObject");
+    const isSaveComponent = (obj) => {
+        return obj.type === 'SaveComponent';
+    };
+    exports.isSaveComponent = isSaveComponent;
+    class SaveComponent extends SaveObject_1.SaveObject {
+        constructor(typePath, rootObject, instanceName, parentEntityName = '') {
+            super(typePath, rootObject, instanceName);
+            this.typePath = typePath;
+            this.rootObject = rootObject;
+            this.instanceName = instanceName;
+            this.parentEntityName = parentEntityName;
+            this.type = 'SaveComponent';
+        }
+        static ParseHeader(reader, obj) {
+            SaveObject_1.SaveObject.ParseHeader(reader, obj);
+            obj.parentEntityName = reader.readString();
+        }
+        static SerializeHeader(writer, component) {
+            SaveObject_1.SaveObject.SerializeHeader(writer, component);
+            writer.writeString(component.parentEntityName);
+        }
+        static ParseData(component, length, reader, buildVersion) {
+            SaveObject_1.SaveObject.ParseData(component, length, reader, buildVersion);
+        }
+    }
+    SaveComponent.TypeID = 0;
+    exports.SaveComponent = SaveComponent;
+});

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

@@ -0,0 +1,25 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../byte/byte-writer.class";
+import { Transform } from "../structs/util.types";
+import { ObjectReference } from "./ObjectReference";
+import { SaveObject } from "./SaveObject";
+export declare const isSaveEntity: (obj: any) => obj is SaveEntity;
+export declare class SaveEntity extends SaveObject {
+    typePath: string;
+    rootObject: string;
+    instanceName: string;
+    parentEntityName: string;
+    static readonly TypeID = 1;
+    readonly type = "SaveEntity";
+    needTransform: boolean;
+    transform: Transform;
+    wasPlacedInLevel: boolean;
+    parentObjectRoot: string;
+    parentObjectName: string;
+    components: ObjectReference[];
+    constructor(typePath: string, rootObject: string, instanceName: string, parentEntityName?: string, needsTransform?: boolean);
+    static ParseHeader(reader: ByteReader, obj: SaveEntity): void;
+    static ParseData(entity: SaveEntity, length: number, reader: ByteReader, buildVersion: number): void;
+    static SerializeHeader(writer: ByteWriter, entity: SaveEntity): void;
+    static SerializeData(writer: ByteWriter, entity: SaveEntity, buildVersion: number): void;
+}

package/build/parser/satisfactory/objects/SaveEntity.js

@@ -0,0 +1,80 @@
+(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", "../structs/util.types", "./ObjectReference", "./SaveObject"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SaveEntity = exports.isSaveEntity = void 0;
+    const util_types_1 = require("../structs/util.types");
+    const ObjectReference_1 = require("./ObjectReference");
+    const SaveObject_1 = require("./SaveObject");
+    const isSaveEntity = (obj) => {
+        return obj.type === 'SaveEntity';
+    };
+    exports.isSaveEntity = isSaveEntity;
+    class SaveEntity extends SaveObject_1.SaveObject {
+        constructor(typePath, rootObject, instanceName, parentEntityName = '', needsTransform = false) {
+            super(typePath, rootObject, instanceName);
+            this.typePath = typePath;
+            this.rootObject = rootObject;
+            this.instanceName = instanceName;
+            this.parentEntityName = parentEntityName;
+            this.type = 'SaveEntity';
+            this.needTransform = needsTransform;
+            this.wasPlacedInLevel = false;
+            this.parentObjectRoot = '';
+            this.parentObjectName = '';
+            this.transform = {
+                rotation: { x: 0, y: 0, z: 0, w: 1 },
+                translation: { x: 0, y: 0, z: 0 },
+                scale3d: { x: 1, y: 1, z: 1 }
+            };
+            this.components = [];
+        }
+        static ParseHeader(reader, obj) {
+            SaveObject_1.SaveObject.ParseHeader(reader, obj);
+            obj.needTransform = reader.readInt32() == 1;
+            obj.transform = (0, util_types_1.ParseTransform)(reader);
+            obj.wasPlacedInLevel = reader.readInt32() == 1;
+        }
+        static ParseData(entity, length, reader, buildVersion) {
+            var newLen = length - 12;
+            entity.parentObjectRoot = reader.readString();
+            if (entity.parentObjectRoot.length > 0)
+                newLen -= entity.parentObjectRoot.length + 1;
+            entity.parentObjectName = reader.readString();
+            if (entity.parentObjectName.length > 0)
+                newLen -= entity.parentObjectName.length + 1;
+            var componentCount = reader.readInt32();
+            for (let i = 0; i < componentCount; i++) {
+                var componentRef = ObjectReference_1.ObjectReference.Parse(reader);
+                entity.components.push(componentRef);
+                newLen -= 10 + componentRef.levelName.length + componentRef.pathName.length;
+            }
+            SaveObject_1.SaveObject.ParseData(entity, newLen, reader, buildVersion);
+        }
+        static SerializeHeader(writer, entity) {
+            SaveObject_1.SaveObject.SerializeHeader(writer, entity);
+            writer.writeInt32(entity.needTransform ? 1 : 0);
+            (0, util_types_1.SerializeTransform)(writer, entity.transform);
+            writer.writeInt32(entity.wasPlacedInLevel ? 1 : 0);
+        }
+        static SerializeData(writer, entity, buildVersion) {
+            writer.writeString(entity.parentObjectRoot);
+            writer.writeString(entity.parentObjectName);
+            writer.writeInt32(entity.components.length);
+            for (const com of entity.components) {
+                writer.writeString(com.levelName);
+                writer.writeString(com.pathName);
+            }
+            SaveObject_1.SaveObject.SerializeData(writer, entity, buildVersion);
+        }
+    }
+    SaveEntity.TypeID = 1;
+    exports.SaveEntity = SaveEntity;
+});

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

@@ -0,0 +1,14 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../byte/byte-writer.class";
+import { DataFields } from "./DataFields";
+export declare abstract class SaveObject {
+    typePath: string;
+    rootObject: string;
+    instanceName: string;
+    dataFields: DataFields;
+    constructor(typePath: string, rootObject: string, instanceName: string);
+    protected static ParseHeader(reader: ByteReader, obj: SaveObject): void;
+    protected static SerializeHeader(writer: ByteWriter, obj: SaveObject): void;
+    static ParseData(obj: SaveObject, length: number, reader: ByteReader, buildVersion: number): void;
+    static SerializeData(writer: any, obj: SaveObject, buildVersion: number): void;
+}

package/build/parser/satisfactory/objects/SaveObject.js

@@ -0,0 +1,39 @@
+(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", "./DataFields"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.SaveObject = void 0;
+    const DataFields_1 = require("./DataFields");
+    class SaveObject {
+        constructor(typePath, rootObject, instanceName) {
+            this.typePath = typePath;
+            this.rootObject = rootObject;
+            this.instanceName = instanceName;
+            this.dataFields = new DataFields_1.DataFields();
+        }
+        static ParseHeader(reader, obj) {
+            obj.typePath = reader.readString();
+            obj.rootObject = reader.readString();
+            obj.instanceName = reader.readString();
+        }
+        static SerializeHeader(writer, obj) {
+            writer.writeString(obj.typePath);
+            writer.writeString(obj.rootObject);
+            writer.writeString(obj.instanceName);
+        }
+        static ParseData(obj, length, reader, buildVersion) {
+            obj.dataFields = DataFields_1.DataFields.Parse(length, reader, buildVersion);
+        }
+        static SerializeData(writer, obj, buildVersion) {
+            DataFields_1.DataFields.Serialize(writer, obj.dataFields, buildVersion);
+        }
+    }
+    exports.SaveObject = SaveObject;
+});

package/build/parser/satisfactory/save/level.class.d.ts

@@ -0,0 +1,21 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ByteWriter } from "../../byte/byte-writer.class";
+import { ObjectReference } from "../objects/ObjectReference";
+import { SaveComponent } from "../objects/SaveComponent";
+import { SaveEntity } from "../objects/SaveEntity";
+import { SaveObject } from "../objects/SaveObject";
+import { SaveReader } from "./save-reader";
+export declare class Level {
+    name: string;
+    objects: (SaveEntity | SaveComponent)[];
+    collectables: ObjectReference[];
+    constructor(name: string);
+    static SerializeObjectHeaders(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[]): void;
+    static WriteLevel(writer: ByteWriter, level: Level, buildVersion: number): void;
+    static SerializeObjectContents(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[], buildVersion: number): void;
+    static ReadObjectHeaders(reader: ByteReader, objectsList: SaveObject[], onProgressCallback: (progress: number, msg?: string) => void): void;
+    static ReadObjectContents(reader: ByteReader, objectsList: SaveObject[], buildVersion: number, onProgressCallback: (progress: number, msg?: string) => void): void;
+    static ReadLevel(reader: SaveReader, levelName: string, buildVersion: number): Level;
+    static SerializeCollectablesList(writer: ByteWriter, collectables: ObjectReference[]): void;
+    static ReadCollectablesList(reader: SaveReader): ObjectReference[];
+}

package/build/parser/satisfactory/save/level.class.js

@@ -0,0 +1,148 @@
+(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", "../objects/ObjectReference", "../objects/SaveComponent", "../objects/SaveEntity"], factory);
+    }
+})(function (require, exports) {
+    "use strict";
+    Object.defineProperty(exports, "__esModule", { value: true });
+    exports.Level = void 0;
+    const ObjectReference_1 = require("../objects/ObjectReference");
+    const SaveComponent_1 = require("../objects/SaveComponent");
+    const SaveEntity_1 = require("../objects/SaveEntity");
+    class Level {
+        constructor(name) {
+            this.name = name;
+            this.objects = [];
+            this.collectables = [];
+        }
+        static SerializeObjectHeaders(writer, objects) {
+            writer.writeInt32(objects.length);
+            for (const obj of objects) {
+                switch (obj.type) {
+                    case 'SaveEntity':
+                        writer.writeInt32(SaveEntity_1.SaveEntity.TypeID);
+                        SaveEntity_1.SaveEntity.SerializeHeader(writer, obj);
+                        break;
+                    case 'SaveComponent':
+                        writer.writeInt32(SaveComponent_1.SaveComponent.TypeID);
+                        SaveComponent_1.SaveComponent.SerializeHeader(writer, obj);
+                        break;
+                    default:
+                        console.log('Unknown object type', obj);
+                        break;
+                }
+            }
+        }
+        static WriteLevel(writer, level, buildVersion) {
+            const lenIndicatorHeaderAndCollectableSize = writer.getBufferPosition();
+            writer.writeInt32(0);
+            Level.SerializeObjectHeaders(writer, level.objects);
+            Level.SerializeCollectablesList(writer, level.collectables);
+            writer.writeBinarySizeFromPosition(lenIndicatorHeaderAndCollectableSize, lenIndicatorHeaderAndCollectableSize + 4);
+            Level.SerializeObjectContents(writer, level.objects, buildVersion);
+            Level.SerializeCollectablesList(writer, level.collectables);
+        }
+        static SerializeObjectContents(writer, objects, buildVersion) {
+            const lenIndicatorEntities = writer.getBufferPosition();
+            writer.writeInt32(0);
+            writer.writeInt32(objects.length);
+            for (const obj of objects) {
+                const lenReplacementPosition = writer.getBufferPosition();
+                writer.writeInt32(0);
+                if ((0, SaveEntity_1.isSaveEntity)(obj)) {
+                    SaveEntity_1.SaveEntity.SerializeData(writer, obj, buildVersion);
+                }
+                else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
+                    SaveComponent_1.SaveComponent.SerializeData(writer, obj, buildVersion);
+                }
+                writer.writeBinarySizeFromPosition(lenReplacementPosition, lenReplacementPosition + 4);
+            }
+            writer.writeBinarySizeFromPosition(lenIndicatorEntities, lenIndicatorEntities + 4);
+        }
+        static ReadObjectHeaders(reader, objectsList, onProgressCallback) {
+            let countObjectHeaders = reader.readInt32();
+            for (let i = 0; i < countObjectHeaders; i++) {
+                if (i % 1000 === 0) {
+                    onProgressCallback(reader.getBufferProgress());
+                }
+                let objectType = reader.readInt32();
+                switch (objectType) {
+                    case SaveEntity_1.SaveEntity.TypeID:
+                        let object = new SaveEntity_1.SaveEntity('', '', '', '');
+                        SaveEntity_1.SaveEntity.ParseHeader(reader, object);
+                        objectsList.push(object);
+                        break;
+                    case SaveComponent_1.SaveComponent.TypeID:
+                        let component = new SaveComponent_1.SaveComponent('', '', '', '');
+                        SaveComponent_1.SaveComponent.ParseHeader(reader, component);
+                        objectsList.push(component);
+                        break;
+                    default:
+                        console.log('Unknown object type', objectType);
+                        break;
+                }
+            }
+        }
+        static ReadObjectContents(reader, objectsList, buildVersion, onProgressCallback) {
+            const binarySize = reader.readInt32();
+            const posBefore = reader.getBufferPosition();
+            const countEntities = reader.readInt32();
+            if (countEntities !== objectsList.length) {
+                throw new Error(`possibly corrupt. entity content count ${countEntities} does not object count of ${objectsList.length}`);
+            }
+            for (let i = 0; i < countEntities; i++) {
+                if (i % 1000 === 0) {
+                    onProgressCallback(reader.getBufferProgress());
+                }
+                const len = reader.readInt32();
+                const before = reader.getBufferPosition();
+                const obj = objectsList[i];
+                if ((0, SaveEntity_1.isSaveEntity)(obj)) {
+                    SaveEntity_1.SaveEntity.ParseData(obj, len, reader, buildVersion);
+                }
+                else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
+                    SaveComponent_1.SaveComponent.ParseData(obj, len, reader, buildVersion);
+                }
+                const after = reader.getBufferPosition();
+                if (after - before !== len) {
+                    console.warn('entity may be corrupt', this.name, i);
+                }
+            }
+            const posAfter = reader.getBufferPosition();
+            if (posAfter - posBefore !== binarySize) {
+                console.warn('save seems corrupt.', this.name);
+            }
+        }
+        static ReadLevel(reader, levelName, buildVersion) {
+            const level = new Level(levelName);
+            reader.readInt32();
+            Level.ReadObjectHeaders(reader, level.objects, reader.onProgressCallback);
+            reader.onProgressCallback(reader.getBufferProgress());
+            level.collectables = Level.ReadCollectablesList(reader);
+            Level.ReadObjectContents(reader, level.objects, buildVersion, reader.onProgressCallback);
+            reader.onProgressCallback(reader.getBufferProgress());
+            Level.ReadCollectablesList(reader);
+            return level;
+        }
+        static SerializeCollectablesList(writer, collectables) {
+            writer.writeInt32(collectables.length);
+            for (const collectable of collectables) {
+                ObjectReference_1.ObjectReference.Serialize(writer, collectable);
+            }
+        }
+        static ReadCollectablesList(reader) {
+            let countCollected = reader.readInt32();
+            const collected = [];
+            for (let i = 0; i < countCollected; i++) {
+                const collectable = ObjectReference_1.ObjectReference.Parse(reader);
+                collected.push(collectable);
+            }
+            return collected;
+        }
+    }
+    exports.Level = Level;
+});

package/build/parser/satisfactory/save/satisfactory-save.d.ts

@@ -0,0 +1,11 @@
+import { ChunkCompressionInfo } from "../../file.types";
+import { ObjectReference } from "../objects/ObjectReference";
+import { Level } from "./level.class";
+import { SatisfactorySaveHeader } from "./save.types";
+export declare class SatisfactorySave {
+    header: SatisfactorySaveHeader;
+    levels: Level[];
+    trailingCollectedObjects: ObjectReference[];
+    compressionInfo?: ChunkCompressionInfo;
+    constructor(header: SatisfactorySaveHeader);
+}

package/build/parser/satisfactory/save/satisfactory-save.js

@@ -0,0 +1,21 @@
+(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.SatisfactorySave = void 0;
+    class SatisfactorySave {
+        constructor(header) {
+            this.levels = [];
+            this.trailingCollectedObjects = [];
+            this.header = header;
+        }
+    }
+    exports.SatisfactorySave = SatisfactorySave;
+});

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

@@ -0,0 +1,44 @@
+import { ByteReader } from "../../byte/byte-reader.class";
+import { ChunkCompressionInfo } from "../../file.types";
+import { ObjectReference } from "../objects/ObjectReference";
+import { SaveComponent } from "../objects/SaveComponent";
+import { SaveEntity } from "../objects/SaveEntity";
+import { SaveObject } from "../objects/SaveObject";
+import { Level } from "./level.class";
+import { SatisfactorySaveHeader } from "./save.types";
+export type EntityPathFilter = {
+    behavior: 'whitelist' | 'blacklist';
+    list: string[];
+};
+export type SaveProjectionConfig = {
+    entityPathFilter: EntityPathFilter;
+    includeComponents: boolean;
+};
+export declare const projectionFilterApplies: (config: SaveProjectionConfig, object: SaveComponent | SaveEntity) => boolean;
+export declare class SaveReader extends ByteReader {
+    onProgressCallback: (progress: number, msg?: string) => void;
+    header: SatisfactorySaveHeader | undefined;
+    levels: Level[];
+    trailingCollectedObjects: ObjectReference[];
+    compressionInfo: ChunkCompressionInfo;
+    static readonly EPOCH_TICKS = 621355968000000000n;
+    constructor(fileBuffer: ArrayBuffer, onProgressCallback?: (progress: number, msg?: string) => void);
+    readHeader(): SatisfactorySaveHeader;
+    inflateChunks(): {
+        concatenatedChunkLength: number;
+        numChunks: number;
+    };
+    readLevels(): Level[];
+}
+export declare class Conveyor {
+    static getConveyorBeltRegex(): RegExp;
+    static getConveyorLiftRegex(): RegExp;
+    static isAConveyorBelt(obj: SaveObject): boolean;
+    static isAConveyorLift(obj: SaveObject): boolean;
+    static get availableConnections(): string[];
+    static get availableConveyorBelts(): string[];
+    static get availableConveyorLifts(): string[];
+    static isConveyor(currentObject: any): boolean;
+    static isConveyorBelt(currentObject: any): boolean;
+    static isConveyorLift(currentObject: any): boolean;
+}