Add @types/vpk package (DefinitelyTyped#73459)

Author: v0eak

types/vpk/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/vpk/index.d.ts

@@ -0,0 +1,36 @@
+/// <reference types="node" />
+
+declare namespace VPK {
+    interface VPKHeader {
+        version: number;
+        treeLength: number;
+        unknown1?: number;
+        footerLength?: number;
+        unknown3?: number;
+        unknown4?: number;
+    }
+
+    interface VPKDirectoryEntry {
+        crc: number;
+        preloadBytes: number;
+        archiveIndex: number;
+        entryOffset: number;
+        entryLength: number;
+        preloadOffset?: number;
+    }
+}
+
+declare class VPK {
+    constructor(path: string);
+
+    directoryPath: string;
+    header: VPK.VPKHeader;
+    tree: Record<string, VPK.VPKDirectoryEntry>;
+
+    isValid(): boolean;
+    load(): void;
+    readonly files: string[];
+    getFile(path: string): Buffer | null;
+}
+
+export = VPK;

types/vpk/package.json

@@ -0,0 +1,20 @@
+{
+    "private": true,
+    "name": "@types/vpk",
+    "version": "0.2.9999",
+    "projects": [
+        "https://github.com/fwdcp/node-vpk"
+    ],
+    "dependencies": {
+        "@types/node": "*"
+    },
+    "devDependencies": {
+        "@types/vpk": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Veak",
+            "githubUsername": "v0eak"
+        }
+    ]
+}

types/vpk/tsconfig.json

@@ -0,0 +1,19 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "vpk-tests.ts"
+    ]
+}

types/vpk/vpk-tests.ts

@@ -0,0 +1,51 @@
+import VPK = require("vpk");
+
+// $ExpectType VPK
+const archive = new VPK("path/to/archive.vpk");
+
+// $ExpectType string
+archive.directoryPath;
+
+// $ExpectType VPKHeader
+archive.header;
+
+// $ExpectType Record<string, VPKDirectoryEntry>
+archive.tree;
+
+// $ExpectType boolean
+archive.isValid();
+
+// $ExpectType void
+archive.load();
+
+// $ExpectType string[]
+archive.files;
+
+// $ExpectType Buffer | null || Buffer<ArrayBufferLike> | null
+archive.getFile("some/file.txt");
+
+// Manual construction of types for testing
+
+const header: VPK.VPKHeader = {
+    version: 2,
+    treeLength: 1024,
+    unknown1: 0,
+    footerLength: 512,
+    unknown3: 1,
+    unknown4: 2,
+};
+
+// $ExpectType VPKHeader
+header;
+
+const entry: VPK.VPKDirectoryEntry = {
+    crc: 123456,
+    preloadBytes: 128,
+    archiveIndex: 1,
+    entryOffset: 2048,
+    entryLength: 4096,
+    preloadOffset: 64,
+};
+
+// $ExpectType VPKDirectoryEntry
+entry;