@etothepii/satisfactory-file-parser 0.0.16 → 0.0.18

package/README.md

@@ -19,13 +19,15 @@ If there will be changes, those will come very soon as soon as U8 is out on Expe
 
 ## Installation via npm
 `npm install @etothepii/satisfactory-file-parser`
-## Usage
-Usage of the SaveParser is easy. For reading a save file, just pass a Buffer to it.
+
+## 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 { SaveParser } from "@etothepii/satisfactory-file-parser";
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
 
 const file = fs.readFileSync('./MySave.sav') as Buffer;
-const parsedSave = SaveParser.ParseSaveFile(file);
+const parsedSave = Parser.ParseSaveFile(file);
 ```
 
 Consequently, writing a parsed save file back is just as easy.
@@ -33,21 +35,57 @@ The SaveParser has callbacks to assist in syncing on different occasions during
 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 { SaveParser } from "@etothepii/satisfactory-file-parser";
+import * as fs from 'fs';
+import { Parser } from "@etothepii/satisfactory-file-parser";
 
-let header, bodyChunks;
-SaveParser.WriteSave(save, binaryBeforeCompressed => {}, header => {
+let header, bodyChunks = [];
+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);
-}, summary => {
-    console.log('finished writing chunks.');
+});
+
+// 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";
 
-    // write complete sav file back to disk
-    fs.writeFileSync('./MyModifiedSave.sav', Buffer.concat([header, ...bodyChunks]));
+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, mainFileBodyChunks = [];
+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 WriteBlueprint
+fs.writeFileSync('./MyModifiedSave.sbpcfg', Buffer.from(summary.configFileBinary));
 ```
 
 ## License

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 type * from './parser/satisfactory/save/save.types';
+export { ByteReader } from './parser/byte/byte-reader.class';
+export { ByteWriter } from './parser/byte/byte-writer.class';
 export { BlueprintConfigReader, BlueprintReader } from './parser/satisfactory/blueprint/blueprint-reader';
 export { BlueprintConfigWriter, BlueprintWriter } from './parser/satisfactory/blueprint/blueprint-writer';
 export { SaveReader } from './parser/satisfactory/save/save-reader';

package/build/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 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.SatisfactorySave = exports.Level = exports.SaveEntity = exports.SaveComponent = exports.ObjectReference = exports.DataFields = void 0;
+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;
 var DataFields_1 = require("./parser/satisfactory/objects/DataFields");
 Object.defineProperty(exports, "DataFields", { enumerable: true, get: function () { return DataFields_1.DataFields; } });
 var ObjectReference_1 = require("./parser/satisfactory/objects/ObjectReference");
@@ -28,6 +28,10 @@ var level_class_1 = require("./parser/satisfactory/save/level.class");
 Object.defineProperty(exports, "Level", { enumerable: true, get: function () { return level_class_1.Level; } });
 var satisfactory_save_1 = require("./parser/satisfactory/save/satisfactory-save");
 Object.defineProperty(exports, "SatisfactorySave", { enumerable: true, get: function () { return satisfactory_save_1.SatisfactorySave; } });
+var byte_reader_class_1 = require("./parser/byte/byte-reader.class");
+Object.defineProperty(exports, "ByteReader", { enumerable: true, get: function () { return byte_reader_class_1.ByteReader; } });
+var byte_writer_class_1 = require("./parser/byte/byte-writer.class");
+Object.defineProperty(exports, "ByteWriter", { enumerable: true, get: function () { return byte_writer_class_1.ByteWriter; } });
 var blueprint_reader_1 = require("./parser/satisfactory/blueprint/blueprint-reader");
 Object.defineProperty(exports, "BlueprintConfigReader", { enumerable: true, get: function () { return blueprint_reader_1.BlueprintConfigReader; } });
 Object.defineProperty(exports, "BlueprintReader", { enumerable: true, get: function () { return blueprint_reader_1.BlueprintReader; } });

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

@@ -1 +1,34 @@
-export {};
+import { Alignment } from "./alignment.enum";
+export declare abstract class ByteReader {
+    protected bufferView: DataView;
+    protected fileBuffer: ArrayBuffer;
+    protected alignment: Alignment;
+    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;
+    readByte(): number;
+    readBytes(count: number): Uint8Array;
+    readHex(hexLength: number): string;
+    readInt8(): number;
+    readUint8(): number;
+    readUint16(): number;
+    readInt32(): number;
+    readUint32(): number;
+    readLong(): bigint;
+    readFloat(): number;
+    readDouble(): number;
+    protected getStringInfo(): {
+        payload: string;
+        counter: number;
+    };
+    getBufferPosition: () => number;
+    getBufferSlice: (begin: number, end: number | undefined) => ArrayBuffer;
+    getBufferProgress: () => number;
+    getBufferLength: () => number;
+    getBuffer: () => ArrayBuffer;
+    readString(): string;
+}

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

@@ -1 +1,33 @@
-export {};
+import { Alignment } from "./alignment.enum";
+export declare abstract class ByteWriter {
+    protected alignment: Alignment;
+    protected bufferArray: ArrayBuffer;
+    protected bufferView: DataView;
+    protected currentByte: number;
+    constructor(alignment: Alignment, bufferSize?: number);
+    skipBytes(count?: number): void;
+    jumpTo(pos: number): void;
+    writeByte(value: number): void;
+    writeBytesArray(bytes: number[]): void;
+    writeBytes(bytes: Uint8Array): void;
+    writeInt8(value: number): void;
+    writeUint8(value: number): void;
+    writeInt16(value: number): void;
+    writeUint16(value: number): void;
+    writeInt32(value: number): void;
+    writeUint32(value: number): void;
+    writeInt64(value: bigint): void;
+    writeUint64(value: bigint): void;
+    writeFloat(value: number): void;
+    writeDouble(value: number): void;
+    writeString(value: string): void;
+    static IsASCIICompatible: (value: string) => boolean;
+    getBufferPosition: () => number;
+    getBufferSlice: (start: number, end?: number) => ArrayBuffer;
+    writeBinarySizeFromPosition(lenIndicatorPos: number, start: number): void;
+    protected extendBufferIfNeeded(countNeededBytes: number, factor?: number): void;
+    protected truncateBuffer(): void;
+    endWriting(): ArrayBuffer;
+    static ToInt32(num: number): Uint8Array;
+    static AppendBuffer(buffer1: ArrayBuffer, buffer2: ArrayBuffer): ArrayBuffer;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@etothepii/satisfactory-file-parser",
 	"author": "etothepii",
-	"version": "0.0.16",
+	"version": "0.0.18",
 	"description": "A file parser for satisfactory files. Includes save files and blueprint files.",
 	"module": "Node16",
 	"typings": "./build/index.d.ts",