@zebbedaja/er-save-parser 0.1.1 → 0.1.2

package/README.md

@@ -33,8 +33,14 @@ import { parse, type Save, type Slot, type Character } from '@zebbedaja/er-save-
 import { readFileSync } from 'fs'
 
 const buffer = readFileSync('ER0000.sl2').buffer
+
+// Default: only errors are logged (logLevel: 'error')
 const save: Save = parse(buffer)
 
+// Optional: configure logging with one of 'debug', 'info', 'warn', 'error', 'none'
+// const save: Save = parse(buffer, { logLevel: 'debug' }) // Verbose progress logs
+// const save: Save = parse(buffer, { logLevel: 'none' })   // Silent
+
 console.log(save.steamId)
 console.log(save.settings?.hud)
 
@@ -65,8 +71,14 @@ import { parse } from '@zebbedaja/er-save-parser'
 import { readFileSync } from 'node:fs'
 
 const buffer = readFileSync('ER0000.sl2').buffer
+
+// Default: only errors are logged (logLevel: 'error')
 const save = parse(buffer)
 
+// Optional: configure logging with one of 'debug', 'info', 'warn', 'error', 'none'
+// const save = parse(buffer, { logLevel: 'debug' }) // Verbose progress logs
+// const save = parse(buffer, { logLevel: 'none' })   // Silent
+
 console.log(save.steamId)
 console.log(save.settings?.hud)
 

package/dist/index.d.mts

@@ -1,4 +1,8 @@
 //#region src/types.d.ts
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+interface ParseOptions {
+  logLevel?: LogLevel;
+}
 interface Save {
   magicBytes?: string;
   checksum?: string;
@@ -139,6 +143,14 @@ interface EventFlag {
 }
 //#endregion
 //#region src/parser.d.ts
-declare function parse(buffer: ArrayBuffer): Save;
+/**
+ * Parse an Elden Ring save file buffer.
+ *
+ * @param buffer - The ArrayBuffer containing the save file data
+ * @param options - Optional configuration for parsing
+ * @param options.logLevel - Log level threshold: 'debug', 'info', 'warn', 'error', or 'none'. Defaults to 'error'
+ * @returns A Save object containing parsed slot and profile data
+ */
+declare function parse(buffer: ArrayBuffer, options?: ParseOptions): Save;
 //#endregion
-export { type Character, type EventFlag, type ProfileSummary, type Save, type Settings, type Slot, parse };
+export { type Character, type EventFlag, type LogLevel, type ParseOptions, type ProfileSummary, type Save, type Settings, type Slot, parse };

package/dist/index.mjs

@@ -6540,6 +6540,38 @@ const eventFlags = [
 	}
 ];
 //#endregion
+//#region src/logger.ts
+const levelValues = {
+	debug: 0,
+	info: 1,
+	warn: 2,
+	error: 3,
+	none: 4
+};
+/**
+* Factory for creating a logger instance with the specified log level threshold.
+*
+* @param level - The minimum log level to output. Defaults to 'error'
+* @returns A logger object with debug, info, warn, and error methods
+*/
+function createLogger(level = "error") {
+	const threshold = levelValues[level];
+	return {
+		debug: (msg) => {
+			if (levelValues.debug >= threshold) console.log(`[DEBUG] ${msg}`);
+		},
+		info: (msg) => {
+			if (levelValues.info >= threshold) console.log(`[INFO] ${msg}`);
+		},
+		warn: (msg) => {
+			if (levelValues.warn >= threshold) console.warn(`[WARN] ${msg}`);
+		},
+		error: (msg) => {
+			if (levelValues.error >= threshold) console.error(`[ERROR] ${msg}`);
+		}
+	};
+}
+//#endregion
 //#region src/bst-map.ts
 const bstFile = `1045540,6223
 1037495,3951
@@ -18466,7 +18498,16 @@ const bstFile = `1045540,6223
 const USER_10_DATA_START = 26215328;
 const ACTIVE_PROFILES_START = 26221828;
 const SLOT_COUNT = 10;
-function parse(buffer) {
+/**
+* Parse an Elden Ring save file buffer.
+*
+* @param buffer - The ArrayBuffer containing the save file data
+* @param options - Optional configuration for parsing
+* @param options.logLevel - Log level threshold: 'debug', 'info', 'warn', 'error', or 'none'. Defaults to 'error'
+* @returns A Save object containing parsed slot and profile data
+*/
+function parse(buffer, options = { logLevel: "error" }) {
+	const logger = createLogger(options.logLevel);
 	const dataView = new DataView(buffer);
 	const utf16leDecoder = new TextDecoder("utf-16le");
 	const utf8Decoder = new TextDecoder("utf-8");
@@ -18479,6 +18520,7 @@ function parse(buffer) {
 	offset += 764;
 	save.slots = [];
 	for (let i = 0; i < SLOT_COUNT; i++) {
+		logger.debug(`Parsing slot ${i}`);
 		offset = 768 + i * 2621456;
 		const slot = {};
 		slot.checksum = toHexString(buffer.slice(offset, offset + 16));
@@ -18488,6 +18530,7 @@ function parse(buffer) {
 		slot.mapId = toHexString(buffer.slice(offset, offset + 4));
 		offset += 4;
 		offset += 24;
+		logger.debug(`Reading GaItems for slot ${i}`);
 		for (let i = 0; i < 5120; i++) {
 			const gaitemHandle = dataView.getUint32(offset, true);
 			offset += 4;
@@ -18498,6 +18541,7 @@ function parse(buffer) {
 				if (gaitemHandleType === 2147483648) offset += 5;
 			}
 		}
+		logger.debug(`Reading character data for slot ${i}`);
 		slot.character = {};
 		slot.character.unk0x0 = dataView.getUint32(offset, true);
 		offset += 4;
@@ -18651,6 +18695,7 @@ function parse(buffer) {
 		slot.inGameCountdownTimer = dataView.getUint32(offset, true);
 		offset += 4;
 		offset += 4;
+		logger.debug(`Reading event flags for slot ${i} with offset ${offset}`);
 		const eventFlagUint8Array = new Uint8Array(buffer, offset, 1833375);
 		const bstMap = parseToMap(bstFile);
 		const slotEventFlags = [];
@@ -18663,6 +18708,7 @@ function parse(buffer) {
 		offset += 1833375;
 		save.slots?.push(slot);
 	}
+	logger.debug("Reading User_10 data");
 	offset = USER_10_DATA_START;
 	save.checksum = toHexString(buffer.slice(offset, offset + 16));
 	offset += 16;
@@ -18670,6 +18716,7 @@ function parse(buffer) {
 	offset += 4;
 	save.steamId = dataView.getBigUint64(offset, true).toString();
 	offset += 8;
+	logger.debug("Reading settings");
 	save.settings = {};
 	save.settings.cameraSpeed = dataView.getUint8(offset++);
 	save.settings.controllerVibration = dataView.getUint8(offset++);
@@ -18709,6 +18756,7 @@ function parse(buffer) {
 	save.settings.show_recent_tabs = dataView.getUint8(offset++);
 	offset = ACTIVE_PROFILES_START;
 	save.activeProfiles = Array.from({ length: SLOT_COUNT }, () => dataView.getUint8(offset++));
+	logger.debug("Reading profile summaries");
 	save.profileSummaries = [];
 	for (let i = 0; i < SLOT_COUNT; i++) {
 		const profileSummary = {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zebbedaja/er-save-parser",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "A parser for Elden Ring save files written in TypesScript.",
   "author": "zebbedaja",
   "license": "MIT",