stormlib-js 0.1.0 → 0.1.1

package/dist/index.browser.d.ts

@@ -0,0 +1,195 @@
+import { F as FileEntry, O as OpenArchiveOptions, a as FileFindData, M as MpqHeader } from './storm-buffer-nHXHoPVG.js';
+export { A as ATTRIBUTES_NAME, B as BetTableHeader, H as HetTableHeader, I as ID_MPQ, b as ID_MPQ_USERDATA, L as LISTFILE_NAME, c as MPQ_COMPRESSION_ADPCM_MONO, d as MPQ_COMPRESSION_ADPCM_STEREO, e as MPQ_COMPRESSION_BZIP2, f as MPQ_COMPRESSION_HUFFMANN, g as MPQ_COMPRESSION_LZMA, h as MPQ_COMPRESSION_PKWARE, i as MPQ_COMPRESSION_SPARSE, j as MPQ_COMPRESSION_ZLIB, k as MPQ_FILE_COMPRESS, l as MPQ_FILE_ENCRYPTED, m as MPQ_FILE_EXISTS, n as MPQ_FILE_IMPLODE, o as MPQ_FILE_KEY_V2, p as MPQ_FILE_SINGLE_UNIT, q as MPQ_FORMAT_VERSION_1, r as MPQ_FORMAT_VERSION_2, s as MPQ_FORMAT_VERSION_3, t as MPQ_FORMAT_VERSION_4, u as MpqBlockEntry, v as MpqCompressionError, w as MpqCorruptError, x as MpqEncryptionError, y as MpqError, z as MpqHashEntry, C as MpqNotFoundError, D as MpqUnsupportedError, E as MpqUserData, S as SIGNATURE_NAME, G as decryptBlock, J as decryptFileKey, K as encryptBlock, N as getStormBuffer, P as hashFileKey, Q as hashNameA, R as hashNameB, T as hashString, U as hashTableIndex, V as jenkinsHash } from './storm-buffer-nHXHoPVG.js';
+
+/**
+ * Browser-safe stream abstraction backed by in-memory binary data.
+ */
+type BinaryInput$1 = Buffer | Uint8Array | ArrayBuffer;
+declare class FileStream {
+    private fileSize;
+    private filePath;
+    private memoryData;
+    private constructor();
+    /**
+     * Path-based open is not available in browsers.
+     */
+    static open(_path: string): never;
+    /**
+     * Create an in-memory stream from binary data.
+     */
+    static fromBuffer(data: BinaryInput$1, filePath?: string): FileStream;
+    private static normalizeBuffer;
+    /**
+     * Read bytes at a given offset.
+     */
+    read(offset: bigint, length: number): Buffer;
+    /**
+     * Read bytes into an existing buffer.
+     */
+    readInto(offset: bigint, buffer: Buffer, bufOffset: number, length: number): number;
+    /**
+     * Get the total file size.
+     */
+    getSize(): bigint;
+    /**
+     * Get the file path.
+     */
+    getPath(): string;
+    /**
+     * Close the stream.
+     */
+    close(): void;
+}
+
+/**
+ * MpqFile represents an open file handle within an MPQ archive.
+ * It provides methods to read file data.
+ */
+
+declare class MpqFile {
+    private stream;
+    private archiveOffset;
+    private entry;
+    private sectorSize;
+    private fileKey;
+    private closed;
+    constructor(stream: FileStream, archiveOffset: bigint, entry: FileEntry, sectorSize: number);
+    /** Uncompressed file size */
+    get size(): number;
+    /** Compressed file size */
+    get compressedSize(): number;
+    /** File flags */
+    get flags(): number;
+    /** File name */
+    get name(): string;
+    /** The underlying file entry */
+    get fileEntry(): FileEntry;
+    /**
+     * Read the entire file contents.
+     *
+     * @returns Buffer containing the decompressed file data
+     */
+    read(): Buffer;
+    /**
+     * Close the file handle.
+     */
+    close(): void;
+}
+
+/**
+ * MpqArchive - Main class for reading MPQ archives.
+ *
+ * This is the primary public API for opening and reading MPQ files.
+ */
+
+type BinaryInput = Buffer | Uint8Array | ArrayBuffer;
+declare class MpqArchive {
+    private stream;
+    private header;
+    private archiveOffset;
+    private sectorSize;
+    private hashTable;
+    private blockTable;
+    private hiBlockTable;
+    private hetTable;
+    private betTable;
+    private fileEntries;
+    private attributes;
+    private closed;
+    private constructor();
+    /**
+     * Open an MPQ archive from a file path.
+     *
+     * @param path - Path to the MPQ file
+     * @param options - Open options
+     * @returns MpqArchive instance
+     */
+    static open(path: string, options?: OpenArchiveOptions): MpqArchive;
+    /**
+     * Open an MPQ archive from in-memory binary data.
+     *
+     * This API works in both Node.js and browser runtimes.
+     *
+     * @param data - MPQ binary contents
+     * @param options - Open options
+     * @returns MpqArchive instance
+     */
+    static openFromBuffer(data: BinaryInput, options?: OpenArchiveOptions): MpqArchive;
+    private static openFromStream;
+    /**
+     * Load all archive tables (hash, block, HET, BET).
+     */
+    private loadTables;
+    /**
+     * Load and parse the (listfile) to populate file names.
+     */
+    private loadListfile;
+    /**
+     * Load and parse the (attributes) file.
+     */
+    private loadAttributes;
+    /**
+     * Internal: extract a file by name without relying on the listfile.
+     * Used for bootstrapping (listfile) and (attributes) loading.
+     */
+    private extractFileByName;
+    /**
+     * Check if a file exists in the archive.
+     */
+    hasFile(name: string): boolean;
+    /**
+     * Open a file within the archive for reading.
+     *
+     * @param name - File path within the archive
+     * @returns MpqFile handle
+     */
+    openFile(name: string): MpqFile;
+    /**
+     * Extract a file's contents directly.
+     *
+     * @param name - File path within the archive
+     * @returns Buffer with the file contents
+     */
+    extractFile(name: string): Buffer;
+    /**
+     * Get the list of all known file names (from listfile).
+     */
+    getFileList(): string[];
+    /**
+     * Find files matching a wildcard pattern.
+     *
+     * @param mask - Wildcard pattern (supports '*' and '?')
+     * @returns Array of matching file entries
+     */
+    findFiles(mask?: string): FileFindData[];
+    /**
+     * Apply an external list of file names to resolve unnamed entries.
+     * Equivalent to providing an external listfile to SFileFindFirstFile.
+     *
+     * @param names - Array of file names to try
+     * @returns Number of newly resolved names
+     */
+    addListfile(names: string[]): number;
+    /**
+     * Enumerate all existing file entries, including those without names.
+     * Unnamed entries get a synthetic name like "File00001234.xxx".
+     */
+    enumerateFiles(): FileFindData[];
+    /** Get the archive header */
+    getHeader(): Readonly<MpqHeader>;
+    /** Get the number of file entries */
+    get fileCount(): number;
+    /** Get the sector size */
+    getSectorSize(): number;
+    /**
+     * Close the archive and release resources.
+     */
+    close(): void;
+    /**
+     * Resolve a file name to its FileEntry.
+     */
+    private resolveFile;
+    private ensureOpen;
+}
+
+export { FileEntry, FileFindData, MpqArchive, MpqFile, MpqHeader, OpenArchiveOptions };