@etothepii/satisfactory-file-parser 0.0.30 → 0.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/LICENCE.md +20 -20
  2. package/README.md +112 -112
  3. package/build/index.d.ts +23 -0
  4. package/build/index.js +65 -0
  5. package/build/parser/byte/alignment.enum.d.ts +4 -0
  6. package/build/parser/byte/alignment.enum.js +18 -0
  7. package/build/parser/byte/binary-operable.interface.d.ts +6 -0
  8. package/build/parser/byte/binary-operable.interface.js +12 -0
  9. package/build/parser/byte/binary-readable.interface.d.ts +22 -0
  10. package/build/parser/byte/binary-readable.interface.js +12 -0
  11. package/build/parser/byte/byte-reader.class.d.ts +36 -0
  12. package/build/parser/byte/byte-reader.class.js +139 -0
  13. package/build/parser/byte/byte-writer.class.d.ts +33 -0
  14. package/build/parser/byte/byte-writer.class.js +149 -0
  15. package/build/parser/error/parser.error.d.ts +18 -0
  16. package/build/parser/error/parser.error.js +50 -0
  17. package/build/parser/file.types.d.ts +9 -0
  18. package/build/parser/file.types.js +12 -0
  19. package/build/parser/parser.d.ts +25 -0
  20. package/build/parser/parser.js +196 -0
  21. package/build/parser/satisfactory/blueprint/blueprint-reader.d.ts +19 -0
  22. package/build/parser/satisfactory/blueprint/blueprint-reader.js +134 -0
  23. package/build/parser/satisfactory/blueprint/blueprint-writer.d.ts +15 -0
  24. package/build/parser/satisfactory/blueprint/blueprint-writer.js +73 -0
  25. package/build/parser/satisfactory/blueprint/blueprint.types.d.ts +20 -0
  26. package/build/parser/satisfactory/blueprint/blueprint.types.js +12 -0
  27. package/build/parser/satisfactory/objects/DataFields.d.ts +41 -0
  28. package/build/parser/satisfactory/objects/DataFields.js +317 -0
  29. package/build/parser/satisfactory/objects/ObjectReference.d.ts +9 -0
  30. package/build/parser/satisfactory/objects/ObjectReference.js +27 -0
  31. package/build/parser/satisfactory/objects/Property.d.ts +270 -0
  32. package/build/parser/satisfactory/objects/Property.js +1012 -0
  33. package/build/parser/satisfactory/objects/SaveComponent.d.ts +19 -0
  34. package/build/parser/satisfactory/objects/SaveComponent.js +41 -0
  35. package/build/parser/satisfactory/objects/SaveEntity.d.ts +30 -0
  36. package/build/parser/satisfactory/objects/SaveEntity.js +80 -0
  37. package/build/parser/satisfactory/objects/SaveObject.d.ts +19 -0
  38. package/build/parser/satisfactory/objects/SaveObject.js +39 -0
  39. package/build/parser/satisfactory/save/asynchronous-level.class.d.ts +9 -0
  40. package/build/parser/satisfactory/save/asynchronous-level.class.js +76 -0
  41. package/build/parser/satisfactory/save/level.class.d.ts +21 -0
  42. package/build/parser/satisfactory/save/level.class.js +149 -0
  43. package/build/parser/satisfactory/save/satisfactory-save.d.ts +11 -0
  44. package/build/parser/satisfactory/save/satisfactory-save.js +21 -0
  45. package/build/parser/satisfactory/save/save-reader.d.ts +35 -0
  46. package/build/parser/satisfactory/save/save-reader.js +188 -0
  47. package/build/parser/satisfactory/save/save-writer.d.ts +12 -0
  48. package/build/parser/satisfactory/save/save-writer.js +122 -0
  49. package/build/parser/satisfactory/save/save.types.d.ts +49 -0
  50. package/build/parser/satisfactory/save/save.types.js +12 -0
  51. package/build/parser/satisfactory/structs/util.types.d.ts +40 -0
  52. package/build/parser/satisfactory/structs/util.types.js +105 -0
  53. package/build/parser/stream/byte-stream-reader.class.d.ts +57 -0
  54. package/build/parser/stream/byte-stream-reader.class.js +251 -0
  55. package/build/parser/stream/json-stream-state-writer.d.ts +12 -0
  56. package/build/parser/stream/json-stream-state-writer.js +28 -0
  57. package/build/parser/stream/json-stream-writable.d.ts +20 -0
  58. package/build/parser/stream/json-stream-writable.js +93 -0
  59. package/build/parser/stream/json-stream-writer.d.ts +22 -0
  60. package/build/parser/stream/json-stream-writer.js +137 -0
  61. package/build/parser/stream/save-stream-json-stringifier.d.ts +6 -0
  62. package/build/parser/stream/save-stream-json-stringifier.js +43 -0
  63. package/build/parser/stream/save-stream-reader.class.d.ts +15 -0
  64. package/build/parser/stream/save-stream-reader.class.js +131 -0
  65. package/build/parser/stream/save-stream-writer.class.d.ts +22 -0
  66. package/build/parser/stream/save-stream-writer.class.js +115 -0
  67. package/build/parser/stream/stream-level.class.d.ts +12 -0
  68. package/build/parser/stream/stream-level.class.js +113 -0
  69. package/package.json +5 -3
  70. package/dist/index.d.ts +0 -610
  71. package/dist/index.js +0 -1
@@ -0,0 +1,19 @@
1
+ import { BinaryReadable } from "../../byte/binary-readable.interface";
2
+ import { ByteWriter } from "../../byte/byte-writer.class";
3
+ import { SaveObject, SaveObjectHeader } from "./SaveObject";
4
+ export declare const isSaveComponent: (obj: any) => obj is SaveComponent;
5
+ export interface SaveComponentHeader extends SaveObjectHeader {
6
+ parentEntityName: string;
7
+ }
8
+ export declare class SaveComponent extends SaveObject implements SaveComponentHeader {
9
+ typePath: string;
10
+ rootObject: string;
11
+ instanceName: string;
12
+ parentEntityName: string;
13
+ static readonly TypeID = 0;
14
+ readonly type = "SaveComponent";
15
+ constructor(typePath: string, rootObject: string, instanceName: string, parentEntityName?: string);
16
+ static ParseHeader(reader: BinaryReadable, obj: SaveComponent): void;
17
+ static SerializeHeader(writer: ByteWriter, component: SaveComponent): void;
18
+ static ParseData(component: SaveComponent, length: number, reader: BinaryReadable, buildVersion: number, typePath: string): void;
19
+ }
@@ -0,0 +1,41 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports", "./SaveObject"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SaveComponent = exports.isSaveComponent = void 0;
13
+ const SaveObject_1 = require("./SaveObject");
14
+ const isSaveComponent = (obj) => {
15
+ return obj.type === 'SaveComponent';
16
+ };
17
+ exports.isSaveComponent = isSaveComponent;
18
+ class SaveComponent extends SaveObject_1.SaveObject {
19
+ constructor(typePath, rootObject, instanceName, parentEntityName = '') {
20
+ super(typePath, rootObject, instanceName);
21
+ this.typePath = typePath;
22
+ this.rootObject = rootObject;
23
+ this.instanceName = instanceName;
24
+ this.parentEntityName = parentEntityName;
25
+ this.type = 'SaveComponent';
26
+ }
27
+ static ParseHeader(reader, obj) {
28
+ SaveObject_1.SaveObject.ParseHeader(reader, obj);
29
+ obj.parentEntityName = reader.readString();
30
+ }
31
+ static SerializeHeader(writer, component) {
32
+ SaveObject_1.SaveObject.SerializeHeader(writer, component);
33
+ writer.writeString(component.parentEntityName);
34
+ }
35
+ static ParseData(component, length, reader, buildVersion, typePath) {
36
+ SaveObject_1.SaveObject.ParseData(component, length, reader, buildVersion, typePath);
37
+ }
38
+ }
39
+ SaveComponent.TypeID = 0;
40
+ exports.SaveComponent = SaveComponent;
41
+ });
@@ -0,0 +1,30 @@
1
+ import { BinaryReadable } from "../../byte/binary-readable.interface";
2
+ import { ByteWriter } from "../../byte/byte-writer.class";
3
+ import { Transform } from "../structs/util.types";
4
+ import { ObjectReference } from "./ObjectReference";
5
+ import { SaveObject, SaveObjectHeader } from "./SaveObject";
6
+ export declare const isSaveEntity: (obj: any) => obj is SaveEntity;
7
+ export interface SaveEntityHeader extends SaveObjectHeader {
8
+ needTransform: boolean;
9
+ transform: Transform;
10
+ wasPlacedInLevel: boolean;
11
+ }
12
+ export declare class SaveEntity extends SaveObject {
13
+ typePath: string;
14
+ rootObject: string;
15
+ instanceName: string;
16
+ parentEntityName: string;
17
+ static readonly TypeID = 1;
18
+ readonly type = "SaveEntity";
19
+ needTransform: boolean;
20
+ transform: Transform;
21
+ wasPlacedInLevel: boolean;
22
+ parentObjectRoot: string;
23
+ parentObjectName: string;
24
+ components: ObjectReference[];
25
+ constructor(typePath: string, rootObject: string, instanceName: string, parentEntityName?: string, needsTransform?: boolean);
26
+ static ParseHeader(reader: BinaryReadable, obj: SaveEntity): void;
27
+ static ParseData(entity: SaveEntity, length: number, reader: BinaryReadable, buildVersion: number, typePath: string): void;
28
+ static SerializeHeader(writer: ByteWriter, entity: SaveEntity): void;
29
+ static SerializeData(writer: ByteWriter, entity: SaveEntity, buildVersion: number): void;
30
+ }
@@ -0,0 +1,80 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports", "../structs/util.types", "./ObjectReference", "./SaveObject"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SaveEntity = exports.isSaveEntity = void 0;
13
+ const util_types_1 = require("../structs/util.types");
14
+ const ObjectReference_1 = require("./ObjectReference");
15
+ const SaveObject_1 = require("./SaveObject");
16
+ const isSaveEntity = (obj) => {
17
+ return obj.type === 'SaveEntity';
18
+ };
19
+ exports.isSaveEntity = isSaveEntity;
20
+ class SaveEntity extends SaveObject_1.SaveObject {
21
+ constructor(typePath, rootObject, instanceName, parentEntityName = '', needsTransform = false) {
22
+ super(typePath, rootObject, instanceName);
23
+ this.typePath = typePath;
24
+ this.rootObject = rootObject;
25
+ this.instanceName = instanceName;
26
+ this.parentEntityName = parentEntityName;
27
+ this.type = 'SaveEntity';
28
+ this.needTransform = needsTransform;
29
+ this.wasPlacedInLevel = false;
30
+ this.parentObjectRoot = '';
31
+ this.parentObjectName = '';
32
+ this.transform = {
33
+ rotation: { x: 0, y: 0, z: 0, w: 1 },
34
+ translation: { x: 0, y: 0, z: 0 },
35
+ scale3d: { x: 1, y: 1, z: 1 }
36
+ };
37
+ this.components = [];
38
+ }
39
+ static ParseHeader(reader, obj) {
40
+ SaveObject_1.SaveObject.ParseHeader(reader, obj);
41
+ obj.needTransform = reader.readInt32() == 1;
42
+ obj.transform = (0, util_types_1.ParseTransform)(reader);
43
+ obj.wasPlacedInLevel = reader.readInt32() == 1;
44
+ }
45
+ static ParseData(entity, length, reader, buildVersion, typePath) {
46
+ var newLen = length - 12;
47
+ entity.parentObjectRoot = reader.readString();
48
+ if (entity.parentObjectRoot.length > 0)
49
+ newLen -= entity.parentObjectRoot.length + 1;
50
+ entity.parentObjectName = reader.readString();
51
+ if (entity.parentObjectName.length > 0)
52
+ newLen -= entity.parentObjectName.length + 1;
53
+ var componentCount = reader.readInt32();
54
+ for (let i = 0; i < componentCount; i++) {
55
+ var componentRef = ObjectReference_1.ObjectReference.Parse(reader);
56
+ entity.components.push(componentRef);
57
+ newLen -= 10 + componentRef.levelName.length + componentRef.pathName.length;
58
+ }
59
+ return SaveObject_1.SaveObject.ParseData(entity, newLen, reader, buildVersion, typePath);
60
+ }
61
+ static SerializeHeader(writer, entity) {
62
+ SaveObject_1.SaveObject.SerializeHeader(writer, entity);
63
+ writer.writeInt32(entity.needTransform ? 1 : 0);
64
+ (0, util_types_1.SerializeTransform)(writer, entity.transform);
65
+ writer.writeInt32(entity.wasPlacedInLevel ? 1 : 0);
66
+ }
67
+ static SerializeData(writer, entity, buildVersion) {
68
+ writer.writeString(entity.parentObjectRoot);
69
+ writer.writeString(entity.parentObjectName);
70
+ writer.writeInt32(entity.components.length);
71
+ for (const com of entity.components) {
72
+ writer.writeString(com.levelName);
73
+ writer.writeString(com.pathName);
74
+ }
75
+ SaveObject_1.SaveObject.SerializeData(writer, entity, buildVersion);
76
+ }
77
+ }
78
+ SaveEntity.TypeID = 1;
79
+ exports.SaveEntity = SaveEntity;
80
+ });
@@ -0,0 +1,19 @@
1
+ import { BinaryReadable } from "../../byte/binary-readable.interface";
2
+ import { ByteWriter } from "../../byte/byte-writer.class";
3
+ import { DataFields } from "./DataFields";
4
+ export interface SaveObjectHeader {
5
+ typePath: string;
6
+ rootObject: string;
7
+ instanceName: string;
8
+ }
9
+ export declare abstract class SaveObject implements SaveObjectHeader {
10
+ typePath: string;
11
+ rootObject: string;
12
+ instanceName: string;
13
+ dataFields: DataFields;
14
+ constructor(typePath: string, rootObject: string, instanceName: string);
15
+ protected static ParseHeader(reader: BinaryReadable, obj: SaveObject): void;
16
+ protected static SerializeHeader(writer: ByteWriter, obj: SaveObject): void;
17
+ static ParseData(obj: SaveObject, length: number, reader: BinaryReadable, buildVersion: number, typePath: string): void;
18
+ static SerializeData(writer: any, obj: SaveObject, buildVersion: number): void;
19
+ }
@@ -0,0 +1,39 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports", "./DataFields"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SaveObject = void 0;
13
+ const DataFields_1 = require("./DataFields");
14
+ class SaveObject {
15
+ constructor(typePath, rootObject, instanceName) {
16
+ this.typePath = typePath;
17
+ this.rootObject = rootObject;
18
+ this.instanceName = instanceName;
19
+ this.dataFields = new DataFields_1.DataFields();
20
+ }
21
+ static ParseHeader(reader, obj) {
22
+ obj.typePath = reader.readString();
23
+ obj.rootObject = reader.readString();
24
+ obj.instanceName = reader.readString();
25
+ }
26
+ static SerializeHeader(writer, obj) {
27
+ writer.writeString(obj.typePath);
28
+ writer.writeString(obj.rootObject);
29
+ writer.writeString(obj.instanceName);
30
+ }
31
+ static ParseData(obj, length, reader, buildVersion, typePath) {
32
+ obj.dataFields = DataFields_1.DataFields.Parse(length, reader, buildVersion, typePath);
33
+ }
34
+ static SerializeData(writer, obj, buildVersion) {
35
+ DataFields_1.DataFields.Serialize(writer, obj.dataFields, buildVersion, obj.typePath);
36
+ }
37
+ }
38
+ exports.SaveObject = SaveObject;
39
+ });
@@ -0,0 +1,9 @@
1
+ import { ByteReader } from "../../byte/byte-reader.class";
2
+ import { SaveStreamWriter } from "../../stream/save-stream-writer.class";
3
+ import { SaveObject } from "../objects/SaveObject";
4
+ import { Level } from "./level.class";
5
+ import { SaveReader } from "./save-reader";
6
+ export declare class AsynchronousLevel {
7
+ static StreamReadObjectContents(reader: ByteReader, objectsList: SaveObject[], buildVersion: number, writer: SaveStreamWriter, onProgressCallback: (progress: number, msg?: string) => void): Promise<void>;
8
+ static StreamReadLevel(reader: SaveReader, levelName: string, buildVersion: number, writer: SaveStreamWriter): Promise<Level>;
9
+ }
@@ -0,0 +1,76 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports", "../objects/SaveComponent", "../objects/SaveEntity", "./level.class"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.AsynchronousLevel = void 0;
13
+ const SaveComponent_1 = require("../objects/SaveComponent");
14
+ const SaveEntity_1 = require("../objects/SaveEntity");
15
+ const level_class_1 = require("./level.class");
16
+ class AsynchronousLevel {
17
+ static async StreamReadObjectContents(reader, objectsList, buildVersion, writer, onProgressCallback) {
18
+ const binarySize = reader.readInt32();
19
+ const posBefore = reader.getBufferPosition();
20
+ await reader.allocate(binarySize);
21
+ const countEntities = reader.readInt32();
22
+ if (countEntities !== objectsList.length) {
23
+ throw new Error(`possibly corrupt. entity content count ${countEntities} does not equal object count of ${objectsList.length}`);
24
+ }
25
+ let dynamicObjectBatch = [];
26
+ for (let i = 0; i < countEntities; i++) {
27
+ if (i % 1000 === 0) {
28
+ console.log(`having some objects, writing ${i + 1}/${countEntities}.`);
29
+ onProgressCallback(reader.getBufferProgress());
30
+ await writer.writeObjects(...dynamicObjectBatch);
31
+ dynamicObjectBatch = [];
32
+ }
33
+ const len = reader.readInt32();
34
+ const before = reader.getBufferPosition();
35
+ if (len < reader.getAmountAllocatedLeft()) {
36
+ await reader.allocate(Math.max(before - binarySize, 300 * 1000 * 1000));
37
+ }
38
+ const obj = objectsList[i];
39
+ if ((0, SaveEntity_1.isSaveEntity)(obj)) {
40
+ SaveEntity_1.SaveEntity.ParseData(obj, len, reader, buildVersion, obj.typePath);
41
+ }
42
+ else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
43
+ SaveComponent_1.SaveComponent.ParseData(obj, len, reader, buildVersion, obj.typePath);
44
+ }
45
+ dynamicObjectBatch.push(obj);
46
+ const after = reader.getBufferPosition();
47
+ if (after - before !== len) {
48
+ console.warn('entity may be corrupt', this.name, i);
49
+ }
50
+ }
51
+ await writer.writeObjects(...dynamicObjectBatch);
52
+ const posAfter = reader.getBufferPosition();
53
+ if (posAfter - posBefore !== binarySize) {
54
+ console.warn('save seems corrupt.', this.name);
55
+ }
56
+ }
57
+ static async StreamReadLevel(reader, levelName, buildVersion, writer) {
58
+ const level = new level_class_1.Level(levelName);
59
+ const binaryLength = reader.readInt32();
60
+ await reader.allocate(binaryLength);
61
+ await writer.openLevel(levelName);
62
+ level_class_1.Level.ReadObjectHeaders(reader, level.objects, reader.onProgressCallback);
63
+ reader.onProgressCallback(reader.getBufferProgress());
64
+ level.collectables = level_class_1.Level.ReadCollectablesList(reader);
65
+ console.log(`before object contents buffer pos ${reader.getBufferPosition()}`);
66
+ await AsynchronousLevel.StreamReadObjectContents(reader, level.objects, buildVersion, writer, reader.onProgressCallback);
67
+ await writer.switchInLevelToCollectables();
68
+ await writer.writeCollectables(...level.collectables);
69
+ reader.onProgressCallback(reader.getBufferProgress());
70
+ level_class_1.Level.ReadCollectablesList(reader);
71
+ await writer.endLevel();
72
+ return level;
73
+ }
74
+ }
75
+ exports.AsynchronousLevel = AsynchronousLevel;
76
+ });
@@ -0,0 +1,21 @@
1
+ import { BinaryReadable } from "../../byte/binary-readable.interface";
2
+ import { ByteWriter } from "../../byte/byte-writer.class";
3
+ import { ObjectReference } from "../objects/ObjectReference";
4
+ import { SaveComponent } from "../objects/SaveComponent";
5
+ import { SaveEntity } from "../objects/SaveEntity";
6
+ import { SaveObject } from "../objects/SaveObject";
7
+ import { SaveReader } from "./save-reader";
8
+ export declare class Level {
9
+ name: string;
10
+ objects: (SaveEntity | SaveComponent)[];
11
+ collectables: ObjectReference[];
12
+ constructor(name: string);
13
+ static SerializeObjectHeaders(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[]): void;
14
+ static WriteLevel(writer: ByteWriter, level: Level, buildVersion: number): void;
15
+ static SerializeObjectContents(writer: ByteWriter, objects: (SaveEntity | SaveComponent)[], buildVersion: number, levelName: string): void;
16
+ static ReadObjectHeaders(reader: BinaryReadable, objectsList: SaveObject[], onProgressCallback: (progress: number, msg?: string) => void): void;
17
+ static ReadObjectContents(reader: BinaryReadable, objectsList: SaveObject[], buildVersion: number, onProgressCallback: (progress: number, msg?: string) => void): Promise<void>;
18
+ static ReadLevel(reader: SaveReader, levelName: string, buildVersion: number): Level;
19
+ static SerializeCollectablesList(writer: ByteWriter, collectables: ObjectReference[]): void;
20
+ static ReadCollectablesList(reader: BinaryReadable): ObjectReference[];
21
+ }
@@ -0,0 +1,149 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports", "../objects/ObjectReference", "../objects/SaveComponent", "../objects/SaveEntity"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.Level = void 0;
13
+ const ObjectReference_1 = require("../objects/ObjectReference");
14
+ const SaveComponent_1 = require("../objects/SaveComponent");
15
+ const SaveEntity_1 = require("../objects/SaveEntity");
16
+ class Level {
17
+ constructor(name) {
18
+ this.name = name;
19
+ this.objects = [];
20
+ this.collectables = [];
21
+ }
22
+ static SerializeObjectHeaders(writer, objects) {
23
+ writer.writeInt32(objects.length);
24
+ for (const obj of objects) {
25
+ switch (obj.type) {
26
+ case 'SaveEntity':
27
+ writer.writeInt32(SaveEntity_1.SaveEntity.TypeID);
28
+ SaveEntity_1.SaveEntity.SerializeHeader(writer, obj);
29
+ break;
30
+ case 'SaveComponent':
31
+ writer.writeInt32(SaveComponent_1.SaveComponent.TypeID);
32
+ SaveComponent_1.SaveComponent.SerializeHeader(writer, obj);
33
+ break;
34
+ default:
35
+ console.log('Unknown object type', obj);
36
+ break;
37
+ }
38
+ }
39
+ }
40
+ static WriteLevel(writer, level, buildVersion) {
41
+ const lenIndicatorHeaderAndCollectableSize = writer.getBufferPosition();
42
+ writer.writeInt32(0);
43
+ Level.SerializeObjectHeaders(writer, level.objects);
44
+ Level.SerializeCollectablesList(writer, level.collectables);
45
+ writer.writeBinarySizeFromPosition(lenIndicatorHeaderAndCollectableSize, lenIndicatorHeaderAndCollectableSize + 4);
46
+ Level.SerializeObjectContents(writer, level.objects, buildVersion, level.name);
47
+ Level.SerializeCollectablesList(writer, level.collectables);
48
+ }
49
+ static SerializeObjectContents(writer, objects, buildVersion, levelName) {
50
+ const lenIndicatorEntities = writer.getBufferPosition();
51
+ writer.writeInt32(0);
52
+ writer.writeInt32(objects.length);
53
+ for (const obj of objects) {
54
+ const lenReplacementPosition = writer.getBufferPosition();
55
+ writer.writeInt32(0);
56
+ if ((0, SaveEntity_1.isSaveEntity)(obj)) {
57
+ SaveEntity_1.SaveEntity.SerializeData(writer, obj, buildVersion);
58
+ }
59
+ else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
60
+ SaveComponent_1.SaveComponent.SerializeData(writer, obj, buildVersion);
61
+ }
62
+ writer.writeBinarySizeFromPosition(lenReplacementPosition, lenReplacementPosition + 4);
63
+ }
64
+ writer.writeBinarySizeFromPosition(lenIndicatorEntities, lenIndicatorEntities + 4);
65
+ }
66
+ static ReadObjectHeaders(reader, objectsList, onProgressCallback) {
67
+ let countObjectHeaders = reader.readInt32();
68
+ for (let i = 0; i < countObjectHeaders; i++) {
69
+ if (i % 1000 === 0) {
70
+ onProgressCallback(reader.getBufferProgress());
71
+ }
72
+ let objectType = reader.readInt32();
73
+ switch (objectType) {
74
+ case SaveEntity_1.SaveEntity.TypeID:
75
+ let object = new SaveEntity_1.SaveEntity('', '', '', '');
76
+ SaveEntity_1.SaveEntity.ParseHeader(reader, object);
77
+ objectsList.push(object);
78
+ break;
79
+ case SaveComponent_1.SaveComponent.TypeID:
80
+ let component = new SaveComponent_1.SaveComponent('', '', '', '');
81
+ SaveComponent_1.SaveComponent.ParseHeader(reader, component);
82
+ objectsList.push(component);
83
+ break;
84
+ default:
85
+ console.log('Unknown object type', objectType);
86
+ break;
87
+ }
88
+ }
89
+ }
90
+ static async ReadObjectContents(reader, objectsList, buildVersion, onProgressCallback) {
91
+ const binarySize = reader.readInt32();
92
+ const posBefore = reader.getBufferPosition();
93
+ const countEntities = reader.readInt32();
94
+ if (countEntities !== objectsList.length) {
95
+ throw new Error(`possibly corrupt. entity content count ${countEntities} does not equal object count of ${objectsList.length}`);
96
+ }
97
+ for (let i = 0; i < countEntities; i++) {
98
+ if (i % 1000 === 0) {
99
+ onProgressCallback(reader.getBufferProgress());
100
+ }
101
+ const len = reader.readInt32();
102
+ const before = reader.getBufferPosition();
103
+ const obj = objectsList[i];
104
+ if ((0, SaveEntity_1.isSaveEntity)(obj)) {
105
+ SaveEntity_1.SaveEntity.ParseData(obj, len, reader, buildVersion, obj.typePath);
106
+ }
107
+ else if ((0, SaveComponent_1.isSaveComponent)(obj)) {
108
+ SaveComponent_1.SaveComponent.ParseData(obj, len, reader, buildVersion, obj.typePath);
109
+ }
110
+ const after = reader.getBufferPosition();
111
+ if (after - before !== len) {
112
+ console.warn('entity may be corrupt', this.name, i);
113
+ }
114
+ }
115
+ const posAfter = reader.getBufferPosition();
116
+ if (posAfter - posBefore !== binarySize) {
117
+ console.warn('save seems corrupt.', this.name);
118
+ }
119
+ }
120
+ static ReadLevel(reader, levelName, buildVersion) {
121
+ const level = new Level(levelName);
122
+ reader.readInt32();
123
+ Level.ReadObjectHeaders(reader, level.objects, reader.onProgressCallback);
124
+ reader.onProgressCallback(reader.getBufferProgress());
125
+ level.collectables = Level.ReadCollectablesList(reader);
126
+ console.log(`before object contents buffer pos ${reader.getBufferPosition()}`);
127
+ Level.ReadObjectContents(reader, level.objects, buildVersion, reader.onProgressCallback);
128
+ reader.onProgressCallback(reader.getBufferProgress());
129
+ Level.ReadCollectablesList(reader);
130
+ return level;
131
+ }
132
+ static SerializeCollectablesList(writer, collectables) {
133
+ writer.writeInt32(collectables.length);
134
+ for (const collectable of collectables) {
135
+ ObjectReference_1.ObjectReference.Serialize(writer, collectable);
136
+ }
137
+ }
138
+ static ReadCollectablesList(reader) {
139
+ let countCollected = reader.readInt32();
140
+ const collected = [];
141
+ for (let i = 0; i < countCollected; i++) {
142
+ const collectable = ObjectReference_1.ObjectReference.Parse(reader);
143
+ collected.push(collectable);
144
+ }
145
+ return collected;
146
+ }
147
+ }
148
+ exports.Level = Level;
149
+ });
@@ -0,0 +1,11 @@
1
+ import { ChunkCompressionInfo } from "../../file.types";
2
+ import { ObjectReference } from "../objects/ObjectReference";
3
+ import { Level } from "./level.class";
4
+ import { SatisfactorySaveHeader } from "./save.types";
5
+ export declare class SatisfactorySave {
6
+ header: SatisfactorySaveHeader;
7
+ levels: Level[];
8
+ trailingCollectedObjects: ObjectReference[];
9
+ compressionInfo?: ChunkCompressionInfo;
10
+ constructor(header: SatisfactorySaveHeader);
11
+ }
@@ -0,0 +1,21 @@
1
+ (function (factory) {
2
+ if (typeof module === "object" && typeof module.exports === "object") {
3
+ var v = factory(require, exports);
4
+ if (v !== undefined) module.exports = v;
5
+ }
6
+ else if (typeof define === "function" && define.amd) {
7
+ define(["require", "exports"], factory);
8
+ }
9
+ })(function (require, exports) {
10
+ "use strict";
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SatisfactorySave = void 0;
13
+ class SatisfactorySave {
14
+ constructor(header) {
15
+ this.levels = [];
16
+ this.trailingCollectedObjects = [];
17
+ this.header = header;
18
+ }
19
+ }
20
+ exports.SatisfactorySave = SatisfactorySave;
21
+ });
@@ -0,0 +1,35 @@
1
+ import { ByteReader } from "../../byte/byte-reader.class";
2
+ import { ChunkCompressionInfo } from "../../file.types";
3
+ import { SaveStreamWriter } from "../../stream/save-stream-writer.class";
4
+ import { ObjectReference } from "../objects/ObjectReference";
5
+ import { SaveComponent } from "../objects/SaveComponent";
6
+ import { SaveEntity } from "../objects/SaveEntity";
7
+ import { Level } from "./level.class";
8
+ import { SatisfactorySaveHeader } from "./save.types";
9
+ export type EntityPathFilter = {
10
+ behavior: 'whitelist' | 'blacklist';
11
+ list: string[];
12
+ };
13
+ export type SaveProjectionConfig = {
14
+ entityPathFilter: EntityPathFilter;
15
+ includeComponents: boolean;
16
+ };
17
+ export declare const projectionFilterApplies: (config: SaveProjectionConfig, object: SaveComponent | SaveEntity) => boolean;
18
+ export type ReadMode = 'stream' | 'whole';
19
+ export declare const DEFAULT_SATISFACTORY_CHUNK_HEADER_SIZE = 48;
20
+ export declare class SaveReader extends ByteReader {
21
+ onProgressCallback: (progress: number, msg?: string) => void;
22
+ header: SatisfactorySaveHeader | undefined;
23
+ levels: Level[];
24
+ trailingCollectedObjects: ObjectReference[];
25
+ compressionInfo: ChunkCompressionInfo;
26
+ static readonly EPOCH_TICKS = 621355968000000000n;
27
+ constructor(fileBuffer: ArrayBuffer, onProgressCallback?: (progress: number, msg?: string) => void);
28
+ readHeader(): SatisfactorySaveHeader;
29
+ inflateChunks(): {
30
+ concatenatedChunkLength: number;
31
+ numChunks: number;
32
+ };
33
+ readLevels(): Level[];
34
+ readLevelsAsynchronously(writer: SaveStreamWriter): Promise<Level[]>;
35
+ }