@rhyster/wow-casc-dbc 1.0.1

package/dist/index.d.cts

@@ -0,0 +1,233 @@
+interface ArchiveIndex {
+    key: string;
+    size: number;
+    offset: number;
+}
+declare const parseArchiveIndex: (buffer: Buffer, cKey: string) => Map<string, ArchiveIndex>;
+
+interface EncodingData {
+    eSpec: string[];
+    cKey2FileSize: Map<string, number>;
+    cKey2EKey: Map<string, string | string[]>;
+    eKey2ESpecIndex: Map<string, number>;
+    eKey2FileSize: Map<string, number>;
+}
+declare const parseEncodingFile: (inputBuffer: Buffer, eKey: string, cKey: string) => EncodingData;
+
+interface FileInfo {
+    cKey: string;
+    contentFlags: number;
+    localeFlags: number;
+}
+interface RootData {
+    fileDataID2CKey: Map<number, FileInfo[]>;
+    nameHash2FileDataID: Map<string, number>;
+}
+declare const parseRootFile: (inputBuffer: Buffer, eKey: string, cKey: string) => RootData;
+
+interface Version {
+    Region: string;
+    BuildConfig: string;
+    CDNConfig: string;
+    KeyRing: string;
+    BuildId: string;
+    VersionsName: string;
+    ProductConfig: string;
+}
+
+interface MissingKeyBlock {
+    offset: number;
+    size: number;
+    blockIndex: number;
+    keyName: string;
+}
+
+interface ClientPreloadData {
+    prefixes: string[];
+    archives: ReturnType<typeof parseArchiveIndex>;
+    encoding: ReturnType<typeof parseEncodingFile>;
+    rootFile: ReturnType<typeof parseRootFile>;
+}
+interface FileFetchResultFull {
+    type: 'full';
+    buffer: Buffer;
+}
+interface FileFetchResultPartial {
+    type: 'partial';
+    buffer: Buffer;
+    blocks: MissingKeyBlock[];
+}
+type FileFetchResult = FileFetchResultFull | FileFetchResultPartial;
+declare enum LogLevel {
+    error = 0,
+    warn = 1,
+    info = 2,
+    debug = 3
+}
+declare class CASCClient {
+    readonly region: string;
+    readonly product: string;
+    readonly version: Version;
+    readonly name2FileDataID: Map<string, number>;
+    readonly keys: Map<string, Uint8Array>;
+    preload?: ClientPreloadData;
+    static getProductVersion(region: string, product: string): Promise<Version | undefined>;
+    static LocaleFlags: {
+        enUS: number;
+        koKR: number;
+        frFR: number;
+        deDE: number;
+        zhCN: number;
+        esES: number;
+        zhTW: number;
+        enGB: number;
+        esMX: number;
+        ruRU: number;
+        ptBR: number;
+        itIT: number;
+        ptPT: number;
+    };
+    static ContentFlags: {
+        Install: number;
+        LoadOnWindows: number;
+        LoadOnMacOS: number;
+        x86_32: number;
+        x86_64: number;
+        LowViolence: number;
+        DoNotLoad: number;
+        UpdatePlugin: number;
+        ARM64: number;
+        Encrypted: number;
+        NoNameHash: number;
+        UncommonResolution: number;
+        Bundle: number;
+        NoCompression: number;
+    };
+    static LogLevel: typeof LogLevel;
+    logLevel: LogLevel;
+    constructor(region: string, product: string, version: Version, logLevel?: LogLevel);
+    private log;
+    init(): Promise<void>;
+    loadRemoteListFile(): Promise<void>;
+    loadRemoteTACTKeys(): Promise<void>;
+    loadTACTKeys(): Promise<void>;
+    getFileDataIDByName(name: string): number | undefined;
+    getContentKeysByFileDataID(fileDataID: number): FileInfo[] | undefined;
+    getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
+    getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
+}
+
+interface FieldStructure {
+    size: number;
+    position: number;
+}
+interface FieldStorageInfoCompressionNone {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'none';
+}
+interface FieldStorageInfoCompressionBitpacked {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpacked';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+interface FieldStorageInfoCompressionCommonData {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'commonData';
+    defaultValue: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexed {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexed';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexedArray {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexedArray';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    arrayCount: number;
+}
+interface FieldStorageInfoCompressionBitpackedSigned {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedSigned';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+type FieldStorageInfo = FieldStorageInfoCompressionNone | FieldStorageInfoCompressionBitpacked | FieldStorageInfoCompressionCommonData | FieldStorageInfoCompressionBitpackedIndexed | FieldStorageInfoCompressionBitpackedIndexedArray | FieldStorageInfoCompressionBitpackedSigned;
+interface ParsedFieldNone {
+    type: 'none';
+    data: number | bigint;
+    string?: string;
+}
+interface ParsedFieldCommonData {
+    type: 'commonData';
+    data: number;
+}
+interface ParsedFieldBitpacked {
+    type: 'bitpacked';
+    data: number;
+}
+interface ParsedFieldBitpackedArray {
+    type: 'bitpackedArray';
+    data: number[];
+}
+type ParsedField = ParsedFieldNone | ParsedFieldCommonData | ParsedFieldBitpacked | ParsedFieldBitpackedArray;
+interface SparseRow {
+    type: 'sparse';
+    data: Buffer;
+}
+declare class WDCReader {
+    readonly tableHash: number;
+    readonly layoutHash: number;
+    readonly locale: number;
+    readonly isNormal: boolean;
+    readonly hasRelationshipData: boolean;
+    readonly fields: FieldStructure[];
+    readonly fieldsInfo: FieldStorageInfo[];
+    readonly rows: Map<number, SparseRow | ParsedField[]>;
+    readonly relationships: Map<number, number>;
+    readonly copyTable: Map<number, number>;
+    constructor(buffer: Buffer, blocks?: MissingKeyBlock[]);
+    getAllIDs(): number[];
+    getRowData(id: number): ParsedField[] | SparseRow | undefined;
+    getRowRelationship(id: number): number | undefined;
+}
+
+interface Column {
+    name: string;
+    type: string;
+    isID: boolean;
+    isInline: boolean;
+    isRelation: boolean;
+    isSigned: boolean;
+    size?: number;
+    arraySize?: number;
+}
+type ColumnData = number | bigint | string | undefined;
+declare class DBDParser {
+    readonly wdc: WDCReader;
+    readonly definitions: Map<string, string>;
+    columns: Column[];
+    constructor(wdc: WDCReader);
+    init(): Promise<void>;
+    getAllIDs(): number[];
+    getRowData(id: number): Record<string, ColumnData | ColumnData[]> | undefined;
+}
+
+export { CASCClient, DBDParser, WDCReader };

package/dist/index.d.mts

@@ -0,0 +1,233 @@
+interface ArchiveIndex {
+    key: string;
+    size: number;
+    offset: number;
+}
+declare const parseArchiveIndex: (buffer: Buffer, cKey: string) => Map<string, ArchiveIndex>;
+
+interface EncodingData {
+    eSpec: string[];
+    cKey2FileSize: Map<string, number>;
+    cKey2EKey: Map<string, string | string[]>;
+    eKey2ESpecIndex: Map<string, number>;
+    eKey2FileSize: Map<string, number>;
+}
+declare const parseEncodingFile: (inputBuffer: Buffer, eKey: string, cKey: string) => EncodingData;
+
+interface FileInfo {
+    cKey: string;
+    contentFlags: number;
+    localeFlags: number;
+}
+interface RootData {
+    fileDataID2CKey: Map<number, FileInfo[]>;
+    nameHash2FileDataID: Map<string, number>;
+}
+declare const parseRootFile: (inputBuffer: Buffer, eKey: string, cKey: string) => RootData;
+
+interface Version {
+    Region: string;
+    BuildConfig: string;
+    CDNConfig: string;
+    KeyRing: string;
+    BuildId: string;
+    VersionsName: string;
+    ProductConfig: string;
+}
+
+interface MissingKeyBlock {
+    offset: number;
+    size: number;
+    blockIndex: number;
+    keyName: string;
+}
+
+interface ClientPreloadData {
+    prefixes: string[];
+    archives: ReturnType<typeof parseArchiveIndex>;
+    encoding: ReturnType<typeof parseEncodingFile>;
+    rootFile: ReturnType<typeof parseRootFile>;
+}
+interface FileFetchResultFull {
+    type: 'full';
+    buffer: Buffer;
+}
+interface FileFetchResultPartial {
+    type: 'partial';
+    buffer: Buffer;
+    blocks: MissingKeyBlock[];
+}
+type FileFetchResult = FileFetchResultFull | FileFetchResultPartial;
+declare enum LogLevel {
+    error = 0,
+    warn = 1,
+    info = 2,
+    debug = 3
+}
+declare class CASCClient {
+    readonly region: string;
+    readonly product: string;
+    readonly version: Version;
+    readonly name2FileDataID: Map<string, number>;
+    readonly keys: Map<string, Uint8Array>;
+    preload?: ClientPreloadData;
+    static getProductVersion(region: string, product: string): Promise<Version | undefined>;
+    static LocaleFlags: {
+        enUS: number;
+        koKR: number;
+        frFR: number;
+        deDE: number;
+        zhCN: number;
+        esES: number;
+        zhTW: number;
+        enGB: number;
+        esMX: number;
+        ruRU: number;
+        ptBR: number;
+        itIT: number;
+        ptPT: number;
+    };
+    static ContentFlags: {
+        Install: number;
+        LoadOnWindows: number;
+        LoadOnMacOS: number;
+        x86_32: number;
+        x86_64: number;
+        LowViolence: number;
+        DoNotLoad: number;
+        UpdatePlugin: number;
+        ARM64: number;
+        Encrypted: number;
+        NoNameHash: number;
+        UncommonResolution: number;
+        Bundle: number;
+        NoCompression: number;
+    };
+    static LogLevel: typeof LogLevel;
+    logLevel: LogLevel;
+    constructor(region: string, product: string, version: Version, logLevel?: LogLevel);
+    private log;
+    init(): Promise<void>;
+    loadRemoteListFile(): Promise<void>;
+    loadRemoteTACTKeys(): Promise<void>;
+    loadTACTKeys(): Promise<void>;
+    getFileDataIDByName(name: string): number | undefined;
+    getContentKeysByFileDataID(fileDataID: number): FileInfo[] | undefined;
+    getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
+    getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
+}
+
+interface FieldStructure {
+    size: number;
+    position: number;
+}
+interface FieldStorageInfoCompressionNone {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'none';
+}
+interface FieldStorageInfoCompressionBitpacked {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpacked';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+interface FieldStorageInfoCompressionCommonData {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'commonData';
+    defaultValue: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexed {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexed';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexedArray {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexedArray';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    arrayCount: number;
+}
+interface FieldStorageInfoCompressionBitpackedSigned {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedSigned';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+type FieldStorageInfo = FieldStorageInfoCompressionNone | FieldStorageInfoCompressionBitpacked | FieldStorageInfoCompressionCommonData | FieldStorageInfoCompressionBitpackedIndexed | FieldStorageInfoCompressionBitpackedIndexedArray | FieldStorageInfoCompressionBitpackedSigned;
+interface ParsedFieldNone {
+    type: 'none';
+    data: number | bigint;
+    string?: string;
+}
+interface ParsedFieldCommonData {
+    type: 'commonData';
+    data: number;
+}
+interface ParsedFieldBitpacked {
+    type: 'bitpacked';
+    data: number;
+}
+interface ParsedFieldBitpackedArray {
+    type: 'bitpackedArray';
+    data: number[];
+}
+type ParsedField = ParsedFieldNone | ParsedFieldCommonData | ParsedFieldBitpacked | ParsedFieldBitpackedArray;
+interface SparseRow {
+    type: 'sparse';
+    data: Buffer;
+}
+declare class WDCReader {
+    readonly tableHash: number;
+    readonly layoutHash: number;
+    readonly locale: number;
+    readonly isNormal: boolean;
+    readonly hasRelationshipData: boolean;
+    readonly fields: FieldStructure[];
+    readonly fieldsInfo: FieldStorageInfo[];
+    readonly rows: Map<number, SparseRow | ParsedField[]>;
+    readonly relationships: Map<number, number>;
+    readonly copyTable: Map<number, number>;
+    constructor(buffer: Buffer, blocks?: MissingKeyBlock[]);
+    getAllIDs(): number[];
+    getRowData(id: number): ParsedField[] | SparseRow | undefined;
+    getRowRelationship(id: number): number | undefined;
+}
+
+interface Column {
+    name: string;
+    type: string;
+    isID: boolean;
+    isInline: boolean;
+    isRelation: boolean;
+    isSigned: boolean;
+    size?: number;
+    arraySize?: number;
+}
+type ColumnData = number | bigint | string | undefined;
+declare class DBDParser {
+    readonly wdc: WDCReader;
+    readonly definitions: Map<string, string>;
+    columns: Column[];
+    constructor(wdc: WDCReader);
+    init(): Promise<void>;
+    getAllIDs(): number[];
+    getRowData(id: number): Record<string, ColumnData | ColumnData[]> | undefined;
+}
+
+export { CASCClient, DBDParser, WDCReader };

package/dist/index.d.ts

@@ -0,0 +1,233 @@
+interface ArchiveIndex {
+    key: string;
+    size: number;
+    offset: number;
+}
+declare const parseArchiveIndex: (buffer: Buffer, cKey: string) => Map<string, ArchiveIndex>;
+
+interface EncodingData {
+    eSpec: string[];
+    cKey2FileSize: Map<string, number>;
+    cKey2EKey: Map<string, string | string[]>;
+    eKey2ESpecIndex: Map<string, number>;
+    eKey2FileSize: Map<string, number>;
+}
+declare const parseEncodingFile: (inputBuffer: Buffer, eKey: string, cKey: string) => EncodingData;
+
+interface FileInfo {
+    cKey: string;
+    contentFlags: number;
+    localeFlags: number;
+}
+interface RootData {
+    fileDataID2CKey: Map<number, FileInfo[]>;
+    nameHash2FileDataID: Map<string, number>;
+}
+declare const parseRootFile: (inputBuffer: Buffer, eKey: string, cKey: string) => RootData;
+
+interface Version {
+    Region: string;
+    BuildConfig: string;
+    CDNConfig: string;
+    KeyRing: string;
+    BuildId: string;
+    VersionsName: string;
+    ProductConfig: string;
+}
+
+interface MissingKeyBlock {
+    offset: number;
+    size: number;
+    blockIndex: number;
+    keyName: string;
+}
+
+interface ClientPreloadData {
+    prefixes: string[];
+    archives: ReturnType<typeof parseArchiveIndex>;
+    encoding: ReturnType<typeof parseEncodingFile>;
+    rootFile: ReturnType<typeof parseRootFile>;
+}
+interface FileFetchResultFull {
+    type: 'full';
+    buffer: Buffer;
+}
+interface FileFetchResultPartial {
+    type: 'partial';
+    buffer: Buffer;
+    blocks: MissingKeyBlock[];
+}
+type FileFetchResult = FileFetchResultFull | FileFetchResultPartial;
+declare enum LogLevel {
+    error = 0,
+    warn = 1,
+    info = 2,
+    debug = 3
+}
+declare class CASCClient {
+    readonly region: string;
+    readonly product: string;
+    readonly version: Version;
+    readonly name2FileDataID: Map<string, number>;
+    readonly keys: Map<string, Uint8Array>;
+    preload?: ClientPreloadData;
+    static getProductVersion(region: string, product: string): Promise<Version | undefined>;
+    static LocaleFlags: {
+        enUS: number;
+        koKR: number;
+        frFR: number;
+        deDE: number;
+        zhCN: number;
+        esES: number;
+        zhTW: number;
+        enGB: number;
+        esMX: number;
+        ruRU: number;
+        ptBR: number;
+        itIT: number;
+        ptPT: number;
+    };
+    static ContentFlags: {
+        Install: number;
+        LoadOnWindows: number;
+        LoadOnMacOS: number;
+        x86_32: number;
+        x86_64: number;
+        LowViolence: number;
+        DoNotLoad: number;
+        UpdatePlugin: number;
+        ARM64: number;
+        Encrypted: number;
+        NoNameHash: number;
+        UncommonResolution: number;
+        Bundle: number;
+        NoCompression: number;
+    };
+    static LogLevel: typeof LogLevel;
+    logLevel: LogLevel;
+    constructor(region: string, product: string, version: Version, logLevel?: LogLevel);
+    private log;
+    init(): Promise<void>;
+    loadRemoteListFile(): Promise<void>;
+    loadRemoteTACTKeys(): Promise<void>;
+    loadTACTKeys(): Promise<void>;
+    getFileDataIDByName(name: string): number | undefined;
+    getContentKeysByFileDataID(fileDataID: number): FileInfo[] | undefined;
+    getFileByContentKey(cKey: string, allowMissingKey?: false): Promise<FileFetchResultFull>;
+    getFileByContentKey(cKey: string, allowMissingKey: true): Promise<FileFetchResult>;
+}
+
+interface FieldStructure {
+    size: number;
+    position: number;
+}
+interface FieldStorageInfoCompressionNone {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'none';
+}
+interface FieldStorageInfoCompressionBitpacked {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpacked';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+interface FieldStorageInfoCompressionCommonData {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'commonData';
+    defaultValue: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexed {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexed';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+}
+interface FieldStorageInfoCompressionBitpackedIndexedArray {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedIndexedArray';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    arrayCount: number;
+}
+interface FieldStorageInfoCompressionBitpackedSigned {
+    fieldOffsetBits: number;
+    fieldSizeBits: number;
+    additionalDataSize: number;
+    storageType: 'bitpackedSigned';
+    bitpackingOffsetBits: number;
+    bitpackingSizeBits: number;
+    flags: number;
+}
+type FieldStorageInfo = FieldStorageInfoCompressionNone | FieldStorageInfoCompressionBitpacked | FieldStorageInfoCompressionCommonData | FieldStorageInfoCompressionBitpackedIndexed | FieldStorageInfoCompressionBitpackedIndexedArray | FieldStorageInfoCompressionBitpackedSigned;
+interface ParsedFieldNone {
+    type: 'none';
+    data: number | bigint;
+    string?: string;
+}
+interface ParsedFieldCommonData {
+    type: 'commonData';
+    data: number;
+}
+interface ParsedFieldBitpacked {
+    type: 'bitpacked';
+    data: number;
+}
+interface ParsedFieldBitpackedArray {
+    type: 'bitpackedArray';
+    data: number[];
+}
+type ParsedField = ParsedFieldNone | ParsedFieldCommonData | ParsedFieldBitpacked | ParsedFieldBitpackedArray;
+interface SparseRow {
+    type: 'sparse';
+    data: Buffer;
+}
+declare class WDCReader {
+    readonly tableHash: number;
+    readonly layoutHash: number;
+    readonly locale: number;
+    readonly isNormal: boolean;
+    readonly hasRelationshipData: boolean;
+    readonly fields: FieldStructure[];
+    readonly fieldsInfo: FieldStorageInfo[];
+    readonly rows: Map<number, SparseRow | ParsedField[]>;
+    readonly relationships: Map<number, number>;
+    readonly copyTable: Map<number, number>;
+    constructor(buffer: Buffer, blocks?: MissingKeyBlock[]);
+    getAllIDs(): number[];
+    getRowData(id: number): ParsedField[] | SparseRow | undefined;
+    getRowRelationship(id: number): number | undefined;
+}
+
+interface Column {
+    name: string;
+    type: string;
+    isID: boolean;
+    isInline: boolean;
+    isRelation: boolean;
+    isSigned: boolean;
+    size?: number;
+    arraySize?: number;
+}
+type ColumnData = number | bigint | string | undefined;
+declare class DBDParser {
+    readonly wdc: WDCReader;
+    readonly definitions: Map<string, string>;
+    columns: Column[];
+    constructor(wdc: WDCReader);
+    init(): Promise<void>;
+    getAllIDs(): number[];
+    getRowData(id: number): Record<string, ColumnData | ColumnData[]> | undefined;
+}
+
+export { CASCClient, DBDParser, WDCReader };