@rhyster/wow-casc-dbc 2.7.6 → 2.8.1

package/dist/index.d.cts

@@ -36,6 +36,22 @@ interface EncodingData {
     eKey2FileSize: Map<string, number>;
 }
 
+interface InstallTag {
+    name: string;
+    type: number;
+    files: boolean[];
+}
+interface InstallFile {
+    name: string;
+    hash: string;
+    size: number;
+    tags: InstallTag[];
+}
+interface InstallData {
+    tags: InstallTag[];
+    files: InstallFile[];
+}
+
 interface Version {
     Region: string;
     BuildConfig: string;
@@ -61,6 +77,7 @@ interface ClientPreloadData {
     archives: Map<string, ArchiveIndex>;
     encoding: EncodingData;
     rootFile: RootData;
+    install: InstallData;
 }
 interface FileFetchResultFull {
     type: 'full';
@@ -129,6 +146,7 @@ declare class CASCClient {
     loadBroadcastTACTKeys(adb: ADBReader): void;
     getFileDataIDByName(name: string): number | undefined;
     getContentKeysByFileDataID(fileDataID: number): FileInfo[] | undefined;
+    getContentKeysFromInstall(name: string): InstallFile[] | undefined;
     getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
     getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
 }
@@ -258,4 +276,4 @@ declare class DBDParser {
     getRowData(id: number): Record<string, ColumnData> | undefined;
 }
 
-export { ADBReader, type ArchiveIndex, type BasicColumnData, CASCClient, type ClientPreloadData, type Column, type ColumnData, DBDParser, type EncodingData, type FieldStorageInfo, type FieldStorageInfoCompressionBitpacked, type FieldStorageInfoCompressionBitpackedIndexed, type FieldStorageInfoCompressionBitpackedIndexedArray, type FieldStorageInfoCompressionBitpackedSigned, type FieldStorageInfoCompressionCommonData, type FieldStorageInfoCompressionNone, type FieldStructure, type FileFetchResult, type FileFetchResultFull, type FileFetchResultPartial, type FileInfo, type Hotfix, type HotfixDelete, type HotfixEntry, type HotfixModify, type MissingKeyBlock, type ParsedField, type ParsedFieldBitpacked, type ParsedFieldBitpackedArray, type ParsedFieldCommonData, type ParsedFieldNone, type RootData, type SparseRow, type Version, WDCReader };
+export { ADBReader, type ArchiveIndex, type BasicColumnData, CASCClient, type ClientPreloadData, type Column, type ColumnData, DBDParser, type EncodingData, type FieldStorageInfo, type FieldStorageInfoCompressionBitpacked, type FieldStorageInfoCompressionBitpackedIndexed, type FieldStorageInfoCompressionBitpackedIndexedArray, type FieldStorageInfoCompressionBitpackedSigned, type FieldStorageInfoCompressionCommonData, type FieldStorageInfoCompressionNone, type FieldStructure, type FileFetchResult, type FileFetchResultFull, type FileFetchResultPartial, type FileInfo, type Hotfix, type HotfixDelete, type HotfixEntry, type HotfixModify, type InstallData, type InstallFile, type MissingKeyBlock, type ParsedField, type ParsedFieldBitpacked, type ParsedFieldBitpackedArray, type ParsedFieldCommonData, type ParsedFieldNone, type RootData, type SparseRow, type Version, WDCReader };

package/dist/index.d.mts

@@ -36,6 +36,22 @@ interface EncodingData {
     eKey2FileSize: Map<string, number>;
 }
 
+interface InstallTag {
+    name: string;
+    type: number;
+    files: boolean[];
+}
+interface InstallFile {
+    name: string;
+    hash: string;
+    size: number;
+    tags: InstallTag[];
+}
+interface InstallData {
+    tags: InstallTag[];
+    files: InstallFile[];
+}
+
 interface Version {
     Region: string;
     BuildConfig: string;
@@ -61,6 +77,7 @@ interface ClientPreloadData {
     archives: Map<string, ArchiveIndex>;
     encoding: EncodingData;
     rootFile: RootData;
+    install: InstallData;
 }
 interface FileFetchResultFull {
     type: 'full';
@@ -129,6 +146,7 @@ declare class CASCClient {
     loadBroadcastTACTKeys(adb: ADBReader): void;
     getFileDataIDByName(name: string): number | undefined;
     getContentKeysByFileDataID(fileDataID: number): FileInfo[] | undefined;
+    getContentKeysFromInstall(name: string): InstallFile[] | undefined;
     getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
     getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
 }
@@ -258,4 +276,4 @@ declare class DBDParser {
     getRowData(id: number): Record<string, ColumnData> | undefined;
 }
 
-export { ADBReader, type ArchiveIndex, type BasicColumnData, CASCClient, type ClientPreloadData, type Column, type ColumnData, DBDParser, type EncodingData, type FieldStorageInfo, type FieldStorageInfoCompressionBitpacked, type FieldStorageInfoCompressionBitpackedIndexed, type FieldStorageInfoCompressionBitpackedIndexedArray, type FieldStorageInfoCompressionBitpackedSigned, type FieldStorageInfoCompressionCommonData, type FieldStorageInfoCompressionNone, type FieldStructure, type FileFetchResult, type FileFetchResultFull, type FileFetchResultPartial, type FileInfo, type Hotfix, type HotfixDelete, type HotfixEntry, type HotfixModify, type MissingKeyBlock, type ParsedField, type ParsedFieldBitpacked, type ParsedFieldBitpackedArray, type ParsedFieldCommonData, type ParsedFieldNone, type RootData, type SparseRow, type Version, WDCReader };
+export { ADBReader, type ArchiveIndex, type BasicColumnData, CASCClient, type ClientPreloadData, type Column, type ColumnData, DBDParser, type EncodingData, type FieldStorageInfo, type FieldStorageInfoCompressionBitpacked, type FieldStorageInfoCompressionBitpackedIndexed, type FieldStorageInfoCompressionBitpackedIndexedArray, type FieldStorageInfoCompressionBitpackedSigned, type FieldStorageInfoCompressionCommonData, type FieldStorageInfoCompressionNone, type FieldStructure, type FileFetchResult, type FileFetchResultFull, type FileFetchResultPartial, type FileInfo, type Hotfix, type HotfixDelete, type HotfixEntry, type HotfixModify, type InstallData, type InstallFile, type MissingKeyBlock, type ParsedField, type ParsedFieldBitpacked, type ParsedFieldBitpackedArray, type ParsedFieldCommonData, type ParsedFieldNone, type RootData, type SparseRow, type Version, WDCReader };

package/dist/index.d.ts

@@ -3,7 +3,7 @@ export { default as CASCClient } from './client.ts';
 export { default as DBDParser } from './dbd.ts';
 export { default as WDCReader } from './wdc.ts';
 export type { HotfixEntry } from './adb.ts';
-export type { Version, ClientPreloadData, ArchiveIndex, EncodingData, RootData, FileInfo, FileFetchResultFull, FileFetchResultPartial, FileFetchResult, MissingKeyBlock, } from './client.ts';
+export type { Version, ClientPreloadData, ArchiveIndex, EncodingData, InstallFile, InstallData, RootData, FileInfo, FileFetchResultFull, FileFetchResultPartial, FileFetchResult, MissingKeyBlock, } from './client.ts';
 export type { Column, ColumnData, BasicColumnData, } from './dbd.ts';
 export type { FieldStructure, FieldStorageInfo, FieldStorageInfoCompressionNone, FieldStorageInfoCompressionBitpacked, FieldStorageInfoCompressionCommonData, FieldStorageInfoCompressionBitpackedIndexed, FieldStorageInfoCompressionBitpackedIndexedArray, FieldStorageInfoCompressionBitpackedSigned, ParsedField, ParsedFieldNone, ParsedFieldCommonData, ParsedFieldBitpacked, ParsedFieldBitpackedArray, SparseRow, Hotfix, HotfixModify, HotfixDelete, } from './wdc.ts';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAEhD,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACR,OAAO,EACP,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,eAAe,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACR,MAAM,EACN,UAAU,EACV,eAAe,GAClB,MAAM,UAAU,CAAC;AAClB,YAAY,EACR,cAAc,EACd,gBAAgB,EAChB,+BAA+B,EAC/B,oCAAoC,EACpC,qCAAqC,EACrC,2CAA2C,EAC3C,gDAAgD,EAChD,0CAA0C,EAC1C,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,YAAY,GACf,MAAM,UAAU,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,UAAU,EAAE,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,EAAE,OAAO,IAAI,SAAS,EAAE,MAAM,UAAU,CAAC;AAEhD,YAAY,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAC5C,YAAY,EACR,OAAO,EACP,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,WAAW,EACX,WAAW,EACX,QAAQ,EACR,QAAQ,EACR,mBAAmB,EACnB,sBAAsB,EACtB,eAAe,EACf,eAAe,GAClB,MAAM,aAAa,CAAC;AACrB,YAAY,EACR,MAAM,EACN,UAAU,EACV,eAAe,GAClB,MAAM,UAAU,CAAC;AAClB,YAAY,EACR,cAAc,EACd,gBAAgB,EAChB,+BAA+B,EAC/B,oCAAoC,EACpC,qCAAqC,EACrC,2CAA2C,EAC3C,gDAAgD,EAChD,0CAA0C,EAC1C,WAAW,EACX,eAAe,EACf,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,SAAS,EACT,MAAM,EACN,YAAY,EACZ,YAAY,GACf,MAAM,UAAU,CAAC"}

package/dist/index.mjs

@@ -680,8 +680,8 @@ const parseCDNConfig = (text) => parseConfig(text);
 const parseBuildConfig = (text) => parseConfig(text);
 
 const ENC_MAGIC = 17742;
-const MAGIC_OFFSET = 0;
-const VERSION_OFFSET = 2;
+const MAGIC_OFFSET$1 = 0;
+const VERSION_OFFSET$1 = 2;
 const HASH_SIZE_CKEY_OFFSET = 3;
 const HASH_SIZE_EKEY_OFFSET = 4;
 const CKEY_PAGE_SIZE_OFFSET = 5;
@@ -696,9 +696,9 @@ const parseEncodingFile = (inputBuffer, eKey, cKey) => {
   const { buffer } = reader;
   const encodingHash = crypto.createHash("md5").update(buffer).digest("hex");
   assert(encodingHash === cKey, `Invalid encoding hash: expected ${cKey}, got ${encodingHash}`);
-  const magic = buffer.readUInt16BE(MAGIC_OFFSET);
+  const magic = buffer.readUInt16BE(MAGIC_OFFSET$1);
   assert(magic === ENC_MAGIC, `Invalid encoding magic: ${magic.toString(16).padStart(4, "0")}`);
-  const version = buffer.readUInt8(VERSION_OFFSET);
+  const version = buffer.readUInt8(VERSION_OFFSET$1);
   const hashSizeCKey = buffer.readUInt8(HASH_SIZE_CKEY_OFFSET);
   const hashSizeEKey = buffer.readUInt8(HASH_SIZE_EKEY_OFFSET);
   const cKeyPageSizeKB = buffer.readUInt16BE(CKEY_PAGE_SIZE_OFFSET);
@@ -796,6 +796,71 @@ const parseEncodingFile = (inputBuffer, eKey, cKey) => {
   };
 };
 
+const INSTALL_MAGIC = 18766;
+const MAGIC_OFFSET = 0;
+const VERSION_OFFSET = 2;
+const HASH_SIZE_OFFSET = 3;
+const NUM_TAGS_OFFSET = 4;
+const NUM_ENTRIES_OFFSET = 6;
+const TAGS_OFFSET = 10;
+const parseInstallFile = (inputBuffer, eKey, cKey) => {
+  const reader = new BLTEReader(inputBuffer, eKey);
+  reader.processBytes();
+  const { buffer } = reader;
+  const installHash = crypto.createHash("md5").update(buffer).digest("hex");
+  assert(installHash === cKey, `Invalid root hash: expected ${cKey}, got ${installHash}`);
+  const magic = buffer.readUInt16BE(MAGIC_OFFSET);
+  assert(magic === INSTALL_MAGIC, `Invalid install magic: ${magic.toString(16).padStart(4, "0")}`);
+  const version = buffer.readUInt8(VERSION_OFFSET);
+  const hashSize = buffer.readUInt8(HASH_SIZE_OFFSET);
+  const numTags = buffer.readUInt16BE(NUM_TAGS_OFFSET);
+  const numEntries = buffer.readUInt32BE(NUM_ENTRIES_OFFSET);
+  assert(version === 1, `Invalid install version: ${version.toString()}`);
+  let pointer = TAGS_OFFSET;
+  const tags = [];
+  for (let i = 0; i < numTags; i += 1) {
+    const startOffset = pointer;
+    while (buffer[pointer] !== 0) {
+      pointer += 1;
+    }
+    const name = buffer.toString("utf-8", startOffset, pointer);
+    pointer += 1;
+    const type = buffer.readUInt16BE(pointer);
+    pointer += 2;
+    const files2 = [];
+    const finalOffset = pointer + Math.ceil(numEntries / 8);
+    while (pointer < finalOffset) {
+      const byte = buffer.readUInt8(pointer);
+      pointer += 1;
+      for (let j = 7; j >= 0; j -= 1) {
+        files2.push((byte & 1 << j) > 0);
+      }
+    }
+    tags.push({ name, type, files: files2 });
+  }
+  const files = [];
+  for (let i = 0; i < numEntries; i += 1) {
+    const startOffset = pointer;
+    while (buffer[pointer] !== 0) {
+      pointer += 1;
+    }
+    const name = buffer.toString("utf-8", startOffset, pointer);
+    pointer += 1;
+    const hash = buffer.toString("hex", pointer, pointer + hashSize);
+    pointer += hashSize;
+    const size = buffer.readUInt32BE(pointer);
+    pointer += 4;
+    const fileTags = tags.filter((tag) => tag.files[i]);
+    files.push({
+      name,
+      hash,
+      size,
+      tags: fileTags
+    });
+  }
+  return { tags, files };
+};
+
 const parseProductConfig = (text) => {
   const lines = text.split(/\r?\n/);
   const headers = lines[0].split("|").map((header) => header.split("!")[0].replace(" ", ""));
@@ -1594,11 +1659,19 @@ class CASCClient {
     this.log(2 /* info */, "Parsing encoding table...");
     const encoding = parseEncodingFile(encodingBuffer, encodingEKey, encodingCKey);
     this.log(2 /* info */, `Parsed encoding table (${encoding.cKey2EKey.size.toString()} entries)`);
+    const getBuildConfigKeys = (configText) => {
+      if (configText.includes(" ")) {
+        const [cKey2, eKey2] = configText.split(" ");
+        return [cKey2, eKey2];
+      }
+      const cKey = configText;
+      const eKeys = encoding.cKey2EKey.get(cKey);
+      assert(eKeys !== void 0, `Failing to find encoding key for ${cKey}`);
+      const eKey = typeof eKeys === "string" ? eKeys : eKeys[0];
+      return [cKey, eKey];
+    };
     this.log(2 /* info */, "Loading root table...");
-    const rootCKey = buildConfig.root;
-    const rootEKeys = encoding.cKey2EKey.get(rootCKey);
-    assert(rootEKeys !== void 0, "Failing to find EKey for root table.");
-    const rootEKey = typeof rootEKeys === "string" ? rootEKeys : rootEKeys[0];
+    const [rootCKey, rootEKey] = getBuildConfigKeys(buildConfig.root);
     const rootBuffer = await getDataFile(prefixes, rootEKey, "build", this.version.BuildConfig, {
       name: "root",
       showProgress: this.logLevel >= 2 /* info */,
@@ -1608,11 +1681,23 @@ class CASCClient {
     this.log(2 /* info */, "Parsing root file...");
     const rootFile = parseRootFile(rootBuffer, rootEKey, rootCKey);
     this.log(2 /* info */, `Parsed root file (${rootFile.fileDataID2CKey.size.toString()} entries, ${rootFile.nameHash2FileDataID.size.toString()} hashes)`);
+    this.log(2 /* info */, "Loading install manifest...");
+    const [installCKey, installEKey] = getBuildConfigKeys(buildConfig.install);
+    const installBuffer = await getDataFile(prefixes, installEKey, "build", this.version.BuildConfig, {
+      name: "install",
+      showProgress: this.logLevel >= 2 /* info */,
+      showAttemptFail: this.logLevel >= 1 /* warn */
+    });
+    this.log(2 /* info */, `Loaded install manifest (${formatFileSize(installBuffer.byteLength)})`);
+    this.log(2 /* info */, "Parsing install manifest...");
+    const install = parseInstallFile(installBuffer, installEKey, installCKey);
+    this.log(2 /* info */, `Parsed install manifest (${install.tags.length.toString()} tags, ${install.files.length.toString()} files)`);
     this.preload = {
       prefixes,
       archives,
       encoding,
-      rootFile
+      rootFile,
+      install
     };
   }
   async loadRemoteListFile() {
@@ -1700,6 +1785,11 @@ class CASCClient {
     const { rootFile } = this.preload;
     return rootFile.fileDataID2CKey.get(fileDataID);
   }
+  getContentKeysFromInstall(name) {
+    assert(this.preload, "Client not initialized");
+    const { install } = this.preload;
+    return install.files.filter((file) => file.name === name);
+  }
   async getFileByContentKey(cKey, allowMissingKey = false) {
     assert(this.preload, "Client not initialized");
     const { prefixes, encoding, archives } = this.preload;
@@ -1825,8 +1915,8 @@ class DBDParser {
     const versionChunk = chunks.find((chunk) => chunk.find((line) => {
       const layoutsMatch = PATTERN_LAYOUT.exec(line);
       const layouts = layoutsMatch?.[1].split(",").map((v) => v.trim().toLowerCase());
-      return layouts?.includes(layoutHashHex);
-    }));
+      return layouts?.includes(layoutHashHex) === true;
+    }) !== void 0);
     assert(versionChunk, `No version definition found for layout hash ${layoutHashHex}`);
     versionChunk.forEach((line) => {
       if (line.startsWith("LAYOUT") || line.startsWith("BUILD") || line.startsWith("COMMENT")) {