@zebbedaja/er-save-parser 0.1.1 → 0.1.3

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,9 @@
 //#region src/types.d.ts
+type LogLevel = 'debug' | 'info' | 'warn' | 'error' | 'none';
+interface ParseOptions {
+  logLevel?: LogLevel;
+  includeEventFlagUInt8Array?: boolean;
+}
 interface Save {
   magicBytes?: string;
   checksum?: string;
@@ -75,6 +80,7 @@ interface Slot {
   notAloneFlag?: number;
   inGameCountdownTimer?: number;
   eventFlags?: EventFlag[];
+  eventFlagUint8Array?: Uint8Array;
 }
 interface Character {
   unk0x0?: number;
@@ -139,6 +145,78 @@ 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'
+ * @param options.includeEventFlagUInt8Array - Includes the raw event flag array data
+ * @returns A Save object containing parsed slot and profile data
+ */
+declare function parse(buffer: ArrayBuffer, options?: ParseOptions): Save;
+//#endregion
+//#region src/util.d.ts
+/**
+ * Compare two ArrayBuffers for byte-by-byte equality.
+ *
+ * @param buf1 - The first ArrayBuffer to compare
+ * @param buf2 - The second ArrayBuffer to compare
+ * @returns True if both buffers have identical byte content
+ */
+declare function arrayBuffersEqual(buf1: ArrayBuffer, buf2: ArrayBuffer): boolean;
+/**
+ * Convert a string into an array of byte values.
+ *
+ * @param string - The string to convert
+ * @returns An array of ASCII/Unicode byte values for each character
+ */
+declare function stringToBytes(string: string): number[];
+/**
+ * Convert an ArrayBuffer to a lowercase hexadecimal string.
+ *
+ * @param buffer - The ArrayBuffer to convert
+ * @returns A lowercase hexadecimal string representation of the buffer
+ */
+declare function toHexString(buffer: ArrayBuffer): string;
+/**
+ * Remove all null ('\x00') characters from a string.
+ *
+ * @param text - The string to clean
+ * @returns The input string with all null ('\x00') characters removed
+ */
+declare const trim: (text: string) => string;
+/**
+ * Parse a string of delimiter-separated "key,value" pairs into a Map.
+ *
+ * @param text - A string of delimiter-separated pairs, one per line
+ * @param delimiter - The character separating key and value (default: ",")
+ * @returns A Map with numeric keys and values parsed from the input
+ */
+declare const parseToMap: (text: string, delimiter?: string) => Map<number, number>;
+/**
+ * Returns tha Bst Map as a Map
+ *
+ * @returns Bst Map as Map
+ */
+declare const getBstMap: () => Map<number, number>;
+/**
+ * Determine whether a specific event flag is set.
+ *
+ * @param bstMap - A map of block IDs to their binary offsets
+ * @param eventFlags - The raw event_flags byte array from the save data
+ * @param eventId - The event ID to check
+ * @returns True if the event flag is set (active), false otherwise
+ */
+declare const getEventFlagState: (bstMap: Map<number, number>, eventFlags: Uint8Array, eventId: number) => boolean;
+/**
+ * Determine the event ID from a byte position and bit index.
+ *
+ * @param bstMap - A map of block IDs to their binary offsets
+ * @param bytePos - The byte position in the event_flags array
+ * @param bitIndex - The bit index within the byte (0-7)
+ * @returns The event ID corresponding to the given position
+ */
+declare const getEventIdFromPosition: (bstMap: Map<number, number>, bytePos: number, bitIndex: number) => number;
 //#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, arrayBuffersEqual, getBstMap, getEventFlagState, getEventIdFromPosition, parse, parseToMap, stringToBytes, toHexString, trim };