🤖 Merge PR DefinitelyTyped#75106 [yauzl] Add support for promises in yauzl 3.4.0 by @joshkel

Author: joshkel

types/yauzl/index.d.ts

@@ -128,6 +128,18 @@ export class ZipFile extends EventEmitter {
         uncompressedSize: number | null,
         callback: (err: Error | null, stream: Readable) => void,
     ): void;
+    openReadStreamPromise(entry: Entry, options?: ZipFileOptions): Promise<Readable>;
+    readLocalFileHeaderPromise(entry: Entry, options: { minimal: true }): Promise<{ fileDataStart: number }>;
+    readLocalFileHeaderPromise(entry: Entry, options?: { minimal?: boolean }): Promise<LocalFileHeader>;
+    openReadStreamLowLevelPromise(
+        fileDataStart: number,
+        compressedSize: number,
+        relativeStart: number,
+        relativeEnd: number,
+        decompress: boolean,
+        uncompressedSize: number | null,
+    ): Promise<Readable>;
+    eachEntry(): AsyncIterableIterator<Entry>;
     close(): void;
     readEntry(): void;
 }
@@ -161,6 +173,14 @@ export function fromRandomAccessReader(
     totalSize: number,
     callback: (err: Error | null, zipfile: ZipFile) => void,
 ): void;
+export function openPromise(path: string, options?: Options): Promise<ZipFile>;
+export function fromFdPromise(fd: number, options?: Options): Promise<ZipFile>;
+export function fromBufferPromise(buffer: Buffer, options?: Options): Promise<ZipFile>;
+export function fromRandomAccessReaderPromise(
+    reader: RandomAccessReader,
+    totalSize: number,
+    options?: Options,
+): Promise<ZipFile>;
 /** @deprecated Use `entry.getLastModDate()` instead. */
 export function dosDateTimeToDate(date: number, time: number): Date;
 export function validateFileName(fileName: string): string | null;

types/yauzl/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/yauzl",
-    "version": "3.3.9999",
+    "version": "3.4.9999",
     "projects": [
         "https://github.com/thejoshwolfe/yauzl"
     ],

types/yauzl/tsconfig.json

@@ -2,7 +2,7 @@
     "compilerOptions": {
         "module": "node16",
         "lib": [
-            "es6"
+            "es2018"
         ],
         "noImplicitAny": true,
         "noImplicitThis": true,

types/yauzl/yauzl-tests.ts

@@ -119,3 +119,39 @@ if (fromDos.getTime() < 0) throw new Error("unreachable");
 const decodedName: string = yauzl.getFileNameLowLevel(0x800, Buffer.from("a.txt"), [], true);
 const parsed: yauzl.ExtraField[] = yauzl.parseExtraFields(Buffer.alloc(0));
 if (decodedName.length < 0 || parsed.length < 0) throw new Error("unreachable");
+
+// Promises API.
+async function withPromises() {
+    const zipfile: yauzl.ZipFile = await yauzl.openPromise("path/to/file.zip");
+    await yauzl.openPromise("path/to/file.zip", { strictFileNames: true });
+    await yauzl.fromFdPromise(0);
+    await yauzl.fromBufferPromise(Buffer.alloc(0), { decodeStrings: false });
+    await yauzl.fromRandomAccessReaderPromise(new MemoryReader(), 1024);
+
+    for await (const entry of zipfile.eachEntry()) {
+        const name: string = entry.fileName;
+        if (name.length < 0) throw new Error("unreachable");
+
+        const readStream: Readable = await zipfile.openReadStreamPromise(entry);
+        readStream.pipe(new Writable());
+        await zipfile.openReadStreamPromise(entry, { decodeFileData: false });
+
+        const minimal = await zipfile.readLocalFileHeaderPromise(entry, { minimal: true });
+        const start: number = minimal.fileDataStart;
+
+        const header: yauzl.LocalFileHeader = await zipfile.readLocalFileHeaderPromise(entry);
+        const rawName: Buffer = header.fileName;
+        if (rawName.length < 0) throw new Error("unreachable");
+
+        const lowStream: Readable = await zipfile.openReadStreamLowLevelPromise(
+            start,
+            entry.compressedSize,
+            0,
+            entry.compressedSize,
+            true,
+            entry.uncompressedSize,
+        );
+        lowStream.pipe(new Writable());
+    }
+}
+withPromises();