stormlib-js 0.1.0 → 0.1.1

package/dist/storm-buffer-nHXHoPVG.d.mts

@@ -0,0 +1,242 @@
+/** Raw MPQ header as parsed from disk (normalized to V4 superset) */
+interface MpqHeader {
+    /** 'MPQ\x1A' signature */
+    dwID: number;
+    /** Size of the header */
+    dwHeaderSize: number;
+    /** 32-bit archive size (V1) */
+    dwArchiveSize: number;
+    /** Format version: 0=V1, 1=V2, 2=V3, 3=V4 */
+    wFormatVersion: number;
+    /** Sector size shift (sector size = 512 << wSectorSize) */
+    wSectorSize: number;
+    /** Hash table offset (relative to archive start) */
+    dwHashTablePos: number;
+    /** Block table offset (relative to archive start) */
+    dwBlockTablePos: number;
+    /** Number of hash table entries */
+    dwHashTableSize: number;
+    /** Number of block table entries */
+    dwBlockTableSize: number;
+    /** 64-bit hi-block table offset */
+    hiBlockTablePos64: bigint;
+    /** High 16 bits of hash table offset */
+    wHashTablePosHi: number;
+    /** High 16 bits of block table offset */
+    wBlockTablePosHi: number;
+    /** 64-bit archive size */
+    archiveSize64: bigint;
+    /** 64-bit BET table position */
+    betTablePos64: bigint;
+    /** 64-bit HET table position */
+    hetTablePos64: bigint;
+    /** Compressed hash table size */
+    hashTableSize64: bigint;
+    /** Compressed block table size */
+    blockTableSize64: bigint;
+    /** Compressed hi-block table size */
+    hiBlockTableSize64: bigint;
+    /** Compressed HET table size */
+    hetTableSize64: bigint;
+    /** Compressed BET table size */
+    betTableSize64: bigint;
+    /** Raw chunk size for MD5 */
+    dwRawChunkSize: number;
+    /** MD5 checksums (V4) */
+    md5BlockTable: Uint8Array;
+    md5HashTable: Uint8Array;
+    md5HiBlockTable: Uint8Array;
+    md5BetTable: Uint8Array;
+    md5HetTable: Uint8Array;
+    md5MpqHeader: Uint8Array;
+}
+/** User data header that may precede the MPQ header */
+interface MpqUserData {
+    dwID: number;
+    cbUserDataSize: number;
+    dwHeaderOffs: number;
+    cbUserDataHeader: number;
+}
+/** Hash table entry (16 bytes on disk) */
+interface MpqHashEntry {
+    /** Hash of file path (method A) */
+    dwName1: number;
+    /** Hash of file path (method B) */
+    dwName2: number;
+    /** Windows LANGID locale */
+    lcLocale: number;
+    /** Platform (always 0) */
+    platform: number;
+    /** Index into block table (0xFFFFFFFF=free, 0xFFFFFFFE=deleted) */
+    dwBlockIndex: number;
+}
+/** Block table entry (16 bytes on disk) */
+interface MpqBlockEntry {
+    /** File data offset relative to archive start */
+    dwFilePos: number;
+    /** Compressed file size */
+    dwCSize: number;
+    /** Uncompressed file size */
+    dwFSize: number;
+    /** File flags */
+    dwFlags: number;
+}
+/** Unified file entry (in-memory representation) */
+interface FileEntry {
+    /** Jenkins hash (for BET table) */
+    fileNameHash: bigint;
+    /** File data offset relative to MPQ header */
+    byteOffset: bigint;
+    /** File time (FILETIME) from attributes */
+    fileTime: bigint;
+    /** Decompressed size */
+    fileSize: number;
+    /** Compressed size */
+    cmpSize: number;
+    /** File flags */
+    flags: number;
+    /** CRC32 from attributes */
+    crc32: number;
+    /** MD5 from attributes */
+    md5: Uint8Array;
+    /** File name (empty if unknown) */
+    fileName: string;
+}
+/** HET table header */
+interface HetTableHeader {
+    signature: number;
+    version: number;
+    dataSize: number;
+    tableSize: number;
+    maxFileCount: number;
+    hashTableSize: number;
+    hashEntrySize: number;
+    totalIndexSize: number;
+    indexSizeExtra: number;
+    indexSize: number;
+    blockTableSize: number;
+}
+/** BET table header */
+interface BetTableHeader {
+    signature: number;
+    version: number;
+    dataSize: number;
+    tableSize: number;
+    maxFileCount: number;
+    flagCount: number;
+}
+/** File search result */
+interface FileFindData {
+    fileName: string;
+    plainName: string;
+    hashIndex: number;
+    blockIndex: number;
+    fileSize: number;
+    compSize: number;
+    fileFlags: number;
+    locale: number;
+}
+/** Open archive flags */
+interface OpenArchiveOptions {
+    noListfile?: boolean;
+    noAttributes?: boolean;
+    noHeaderSearch?: boolean;
+    forceMpqV1?: boolean;
+    checkSectorCrc?: boolean;
+}
+
+declare class MpqError extends Error {
+    constructor(message: string);
+}
+declare class MpqNotFoundError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqCorruptError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqUnsupportedError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqEncryptionError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqCompressionError extends MpqError {
+    constructor(message?: string);
+}
+
+declare const ID_MPQ = 441536589;
+declare const ID_MPQ_USERDATA = 458313805;
+declare const MPQ_FORMAT_VERSION_1 = 0;
+declare const MPQ_FORMAT_VERSION_2 = 1;
+declare const MPQ_FORMAT_VERSION_3 = 2;
+declare const MPQ_FORMAT_VERSION_4 = 3;
+declare const MPQ_FILE_IMPLODE = 256;
+declare const MPQ_FILE_COMPRESS = 512;
+declare const MPQ_FILE_ENCRYPTED = 65536;
+declare const MPQ_FILE_KEY_V2 = 131072;
+declare const MPQ_FILE_SINGLE_UNIT = 16777216;
+declare const MPQ_FILE_EXISTS = 2147483648;
+declare const MPQ_COMPRESSION_HUFFMANN = 1;
+declare const MPQ_COMPRESSION_ZLIB = 2;
+declare const MPQ_COMPRESSION_PKWARE = 8;
+declare const MPQ_COMPRESSION_BZIP2 = 16;
+declare const MPQ_COMPRESSION_LZMA = 18;
+declare const MPQ_COMPRESSION_SPARSE = 32;
+declare const MPQ_COMPRESSION_ADPCM_MONO = 64;
+declare const MPQ_COMPRESSION_ADPCM_STEREO = 128;
+declare const LISTFILE_NAME = "(listfile)";
+declare const SIGNATURE_NAME = "(signature)";
+declare const ATTRIBUTES_NAME = "(attributes)";
+
+/**
+ * Compute MPQ hash of a string. The hashType selects which section of the
+ * StormBuffer to use:
+ * - MPQ_HASH_TABLE_INDEX (0x000): hash table slot
+ * - MPQ_HASH_NAME_A (0x100): file name verification hash 1
+ * - MPQ_HASH_NAME_B (0x200): file name verification hash 2
+ * - MPQ_HASH_FILE_KEY (0x300): encryption key derivation
+ */
+declare function hashString(str: string, hashType: number): number;
+/** Convenience: compute hash table index */
+declare function hashTableIndex(fileName: string): number;
+/** Convenience: compute name hash A */
+declare function hashNameA(fileName: string): number;
+/** Convenience: compute name hash B */
+declare function hashNameB(fileName: string): number;
+/** Convenience: compute file encryption key hash */
+declare function hashFileKey(fileName: string): number;
+/**
+ * Jenkins hashlittle2 - used for HET/BET tables (64-bit hash).
+ * Produces a 64-bit hash as a BigInt.
+ */
+declare function jenkinsHash(str: string): bigint;
+
+/**
+ * Decrypt an MPQ data block in-place.
+ * The buffer must be DWORD-aligned (length must be a multiple of 4).
+ *
+ * @param data - Buffer to decrypt (modified in place)
+ * @param key - Primary encryption key (DWORD)
+ */
+declare function decryptBlock(data: Buffer, key: number): void;
+/**
+ * Encrypt an MPQ data block in-place.
+ *
+ * @param data - Buffer to encrypt (modified in place)
+ * @param key - Primary encryption key (DWORD)
+ */
+declare function encryptBlock(data: Buffer, key: number): void;
+/**
+ * Calculate the decryption key for a file within an MPQ archive.
+ *
+ * @param fileName - Full path of the file within the archive
+ * @param byteOffset - File's offset within the archive (lower 32 bits)
+ * @param fileSize - Uncompressed file size
+ * @param flags - File flags from block table
+ * @returns The file decryption key
+ */
+declare function decryptFileKey(fileName: string, byteOffset: bigint, fileSize: number, flags: number): number;
+
+declare function getStormBuffer(): Uint32Array;
+
+export { ATTRIBUTES_NAME as A, type BetTableHeader as B, MpqNotFoundError as C, MpqUnsupportedError as D, type MpqUserData as E, type FileEntry as F, decryptBlock as G, type HetTableHeader as H, ID_MPQ as I, decryptFileKey as J, encryptBlock as K, LISTFILE_NAME as L, type MpqHeader as M, getStormBuffer as N, type OpenArchiveOptions as O, hashFileKey as P, hashNameA as Q, hashNameB as R, SIGNATURE_NAME as S, hashString as T, hashTableIndex as U, jenkinsHash as V, type FileFindData as a, ID_MPQ_USERDATA as b, MPQ_COMPRESSION_ADPCM_MONO as c, MPQ_COMPRESSION_ADPCM_STEREO as d, MPQ_COMPRESSION_BZIP2 as e, MPQ_COMPRESSION_HUFFMANN as f, MPQ_COMPRESSION_LZMA as g, MPQ_COMPRESSION_PKWARE as h, MPQ_COMPRESSION_SPARSE as i, MPQ_COMPRESSION_ZLIB as j, MPQ_FILE_COMPRESS as k, MPQ_FILE_ENCRYPTED as l, MPQ_FILE_EXISTS as m, MPQ_FILE_IMPLODE as n, MPQ_FILE_KEY_V2 as o, MPQ_FILE_SINGLE_UNIT as p, MPQ_FORMAT_VERSION_1 as q, MPQ_FORMAT_VERSION_2 as r, MPQ_FORMAT_VERSION_3 as s, MPQ_FORMAT_VERSION_4 as t, type MpqBlockEntry as u, MpqCompressionError as v, MpqCorruptError as w, MpqEncryptionError as x, MpqError as y, type MpqHashEntry as z };

package/dist/storm-buffer-nHXHoPVG.d.ts

@@ -0,0 +1,242 @@
+/** Raw MPQ header as parsed from disk (normalized to V4 superset) */
+interface MpqHeader {
+    /** 'MPQ\x1A' signature */
+    dwID: number;
+    /** Size of the header */
+    dwHeaderSize: number;
+    /** 32-bit archive size (V1) */
+    dwArchiveSize: number;
+    /** Format version: 0=V1, 1=V2, 2=V3, 3=V4 */
+    wFormatVersion: number;
+    /** Sector size shift (sector size = 512 << wSectorSize) */
+    wSectorSize: number;
+    /** Hash table offset (relative to archive start) */
+    dwHashTablePos: number;
+    /** Block table offset (relative to archive start) */
+    dwBlockTablePos: number;
+    /** Number of hash table entries */
+    dwHashTableSize: number;
+    /** Number of block table entries */
+    dwBlockTableSize: number;
+    /** 64-bit hi-block table offset */
+    hiBlockTablePos64: bigint;
+    /** High 16 bits of hash table offset */
+    wHashTablePosHi: number;
+    /** High 16 bits of block table offset */
+    wBlockTablePosHi: number;
+    /** 64-bit archive size */
+    archiveSize64: bigint;
+    /** 64-bit BET table position */
+    betTablePos64: bigint;
+    /** 64-bit HET table position */
+    hetTablePos64: bigint;
+    /** Compressed hash table size */
+    hashTableSize64: bigint;
+    /** Compressed block table size */
+    blockTableSize64: bigint;
+    /** Compressed hi-block table size */
+    hiBlockTableSize64: bigint;
+    /** Compressed HET table size */
+    hetTableSize64: bigint;
+    /** Compressed BET table size */
+    betTableSize64: bigint;
+    /** Raw chunk size for MD5 */
+    dwRawChunkSize: number;
+    /** MD5 checksums (V4) */
+    md5BlockTable: Uint8Array;
+    md5HashTable: Uint8Array;
+    md5HiBlockTable: Uint8Array;
+    md5BetTable: Uint8Array;
+    md5HetTable: Uint8Array;
+    md5MpqHeader: Uint8Array;
+}
+/** User data header that may precede the MPQ header */
+interface MpqUserData {
+    dwID: number;
+    cbUserDataSize: number;
+    dwHeaderOffs: number;
+    cbUserDataHeader: number;
+}
+/** Hash table entry (16 bytes on disk) */
+interface MpqHashEntry {
+    /** Hash of file path (method A) */
+    dwName1: number;
+    /** Hash of file path (method B) */
+    dwName2: number;
+    /** Windows LANGID locale */
+    lcLocale: number;
+    /** Platform (always 0) */
+    platform: number;
+    /** Index into block table (0xFFFFFFFF=free, 0xFFFFFFFE=deleted) */
+    dwBlockIndex: number;
+}
+/** Block table entry (16 bytes on disk) */
+interface MpqBlockEntry {
+    /** File data offset relative to archive start */
+    dwFilePos: number;
+    /** Compressed file size */
+    dwCSize: number;
+    /** Uncompressed file size */
+    dwFSize: number;
+    /** File flags */
+    dwFlags: number;
+}
+/** Unified file entry (in-memory representation) */
+interface FileEntry {
+    /** Jenkins hash (for BET table) */
+    fileNameHash: bigint;
+    /** File data offset relative to MPQ header */
+    byteOffset: bigint;
+    /** File time (FILETIME) from attributes */
+    fileTime: bigint;
+    /** Decompressed size */
+    fileSize: number;
+    /** Compressed size */
+    cmpSize: number;
+    /** File flags */
+    flags: number;
+    /** CRC32 from attributes */
+    crc32: number;
+    /** MD5 from attributes */
+    md5: Uint8Array;
+    /** File name (empty if unknown) */
+    fileName: string;
+}
+/** HET table header */
+interface HetTableHeader {
+    signature: number;
+    version: number;
+    dataSize: number;
+    tableSize: number;
+    maxFileCount: number;
+    hashTableSize: number;
+    hashEntrySize: number;
+    totalIndexSize: number;
+    indexSizeExtra: number;
+    indexSize: number;
+    blockTableSize: number;
+}
+/** BET table header */
+interface BetTableHeader {
+    signature: number;
+    version: number;
+    dataSize: number;
+    tableSize: number;
+    maxFileCount: number;
+    flagCount: number;
+}
+/** File search result */
+interface FileFindData {
+    fileName: string;
+    plainName: string;
+    hashIndex: number;
+    blockIndex: number;
+    fileSize: number;
+    compSize: number;
+    fileFlags: number;
+    locale: number;
+}
+/** Open archive flags */
+interface OpenArchiveOptions {
+    noListfile?: boolean;
+    noAttributes?: boolean;
+    noHeaderSearch?: boolean;
+    forceMpqV1?: boolean;
+    checkSectorCrc?: boolean;
+}
+
+declare class MpqError extends Error {
+    constructor(message: string);
+}
+declare class MpqNotFoundError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqCorruptError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqUnsupportedError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqEncryptionError extends MpqError {
+    constructor(message?: string);
+}
+declare class MpqCompressionError extends MpqError {
+    constructor(message?: string);
+}
+
+declare const ID_MPQ = 441536589;
+declare const ID_MPQ_USERDATA = 458313805;
+declare const MPQ_FORMAT_VERSION_1 = 0;
+declare const MPQ_FORMAT_VERSION_2 = 1;
+declare const MPQ_FORMAT_VERSION_3 = 2;
+declare const MPQ_FORMAT_VERSION_4 = 3;
+declare const MPQ_FILE_IMPLODE = 256;
+declare const MPQ_FILE_COMPRESS = 512;
+declare const MPQ_FILE_ENCRYPTED = 65536;
+declare const MPQ_FILE_KEY_V2 = 131072;
+declare const MPQ_FILE_SINGLE_UNIT = 16777216;
+declare const MPQ_FILE_EXISTS = 2147483648;
+declare const MPQ_COMPRESSION_HUFFMANN = 1;
+declare const MPQ_COMPRESSION_ZLIB = 2;
+declare const MPQ_COMPRESSION_PKWARE = 8;
+declare const MPQ_COMPRESSION_BZIP2 = 16;
+declare const MPQ_COMPRESSION_LZMA = 18;
+declare const MPQ_COMPRESSION_SPARSE = 32;
+declare const MPQ_COMPRESSION_ADPCM_MONO = 64;
+declare const MPQ_COMPRESSION_ADPCM_STEREO = 128;
+declare const LISTFILE_NAME = "(listfile)";
+declare const SIGNATURE_NAME = "(signature)";
+declare const ATTRIBUTES_NAME = "(attributes)";
+
+/**
+ * Compute MPQ hash of a string. The hashType selects which section of the
+ * StormBuffer to use:
+ * - MPQ_HASH_TABLE_INDEX (0x000): hash table slot
+ * - MPQ_HASH_NAME_A (0x100): file name verification hash 1
+ * - MPQ_HASH_NAME_B (0x200): file name verification hash 2
+ * - MPQ_HASH_FILE_KEY (0x300): encryption key derivation
+ */
+declare function hashString(str: string, hashType: number): number;
+/** Convenience: compute hash table index */
+declare function hashTableIndex(fileName: string): number;
+/** Convenience: compute name hash A */
+declare function hashNameA(fileName: string): number;
+/** Convenience: compute name hash B */
+declare function hashNameB(fileName: string): number;
+/** Convenience: compute file encryption key hash */
+declare function hashFileKey(fileName: string): number;
+/**
+ * Jenkins hashlittle2 - used for HET/BET tables (64-bit hash).
+ * Produces a 64-bit hash as a BigInt.
+ */
+declare function jenkinsHash(str: string): bigint;
+
+/**
+ * Decrypt an MPQ data block in-place.
+ * The buffer must be DWORD-aligned (length must be a multiple of 4).
+ *
+ * @param data - Buffer to decrypt (modified in place)
+ * @param key - Primary encryption key (DWORD)
+ */
+declare function decryptBlock(data: Buffer, key: number): void;
+/**
+ * Encrypt an MPQ data block in-place.
+ *
+ * @param data - Buffer to encrypt (modified in place)
+ * @param key - Primary encryption key (DWORD)
+ */
+declare function encryptBlock(data: Buffer, key: number): void;
+/**
+ * Calculate the decryption key for a file within an MPQ archive.
+ *
+ * @param fileName - Full path of the file within the archive
+ * @param byteOffset - File's offset within the archive (lower 32 bits)
+ * @param fileSize - Uncompressed file size
+ * @param flags - File flags from block table
+ * @returns The file decryption key
+ */
+declare function decryptFileKey(fileName: string, byteOffset: bigint, fileSize: number, flags: number): number;
+
+declare function getStormBuffer(): Uint32Array;
+
+export { ATTRIBUTES_NAME as A, type BetTableHeader as B, MpqNotFoundError as C, MpqUnsupportedError as D, type MpqUserData as E, type FileEntry as F, decryptBlock as G, type HetTableHeader as H, ID_MPQ as I, decryptFileKey as J, encryptBlock as K, LISTFILE_NAME as L, type MpqHeader as M, getStormBuffer as N, type OpenArchiveOptions as O, hashFileKey as P, hashNameA as Q, hashNameB as R, SIGNATURE_NAME as S, hashString as T, hashTableIndex as U, jenkinsHash as V, type FileFindData as a, ID_MPQ_USERDATA as b, MPQ_COMPRESSION_ADPCM_MONO as c, MPQ_COMPRESSION_ADPCM_STEREO as d, MPQ_COMPRESSION_BZIP2 as e, MPQ_COMPRESSION_HUFFMANN as f, MPQ_COMPRESSION_LZMA as g, MPQ_COMPRESSION_PKWARE as h, MPQ_COMPRESSION_SPARSE as i, MPQ_COMPRESSION_ZLIB as j, MPQ_FILE_COMPRESS as k, MPQ_FILE_ENCRYPTED as l, MPQ_FILE_EXISTS as m, MPQ_FILE_IMPLODE as n, MPQ_FILE_KEY_V2 as o, MPQ_FILE_SINGLE_UNIT as p, MPQ_FORMAT_VERSION_1 as q, MPQ_FORMAT_VERSION_2 as r, MPQ_FORMAT_VERSION_3 as s, MPQ_FORMAT_VERSION_4 as t, type MpqBlockEntry as u, MpqCompressionError as v, MpqCorruptError as w, MpqEncryptionError as x, MpqError as y, type MpqHashEntry as z };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stormlib-js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Pure TypeScript implementation of StormLib for reading MPQ archives",
   "author": "changmyeong",
   "license": "MIT",
@@ -18,11 +18,19 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
+      "browser": "./dist/index.browser.mjs",
       "import": "./dist/index.mjs",
       "require": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./dist/index.browser.d.ts",
+      "import": "./dist/index.browser.mjs",
+      "require": "./dist/index.browser.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "build": "tsup",
     "prepublishOnly": "npm run build",
@@ -30,8 +38,17 @@
     "test:watch": "vitest",
     "typecheck": "tsc --noEmit"
   },
-  "keywords": ["mpq", "stormlib", "blizzard", "archive", "diablo", "warcraft", "starcraft"],
+  "keywords": [
+    "mpq",
+    "stormlib",
+    "blizzard",
+    "archive",
+    "diablo",
+    "warcraft",
+    "starcraft"
+  ],
   "dependencies": {
+    "buffer": "^6.0.3",
     "pako": "^2.1.0"
   },
   "devDependencies": {