zip-lib 1.1.2 → 1.2.0

package/lib/cancelable.js

@@ -33,7 +33,9 @@ class CancellationToken {
             return;
         }
         this._isCancelled = true;
-        this._callbacks.forEach((cb) => cb());
+        this._callbacks.forEach((cb) => {
+            cb();
+        });
         this._callbacks.clear();
     }
 }

package/lib/fs.d.ts

@@ -5,15 +5,19 @@ export interface FileEntry {
     mtime: Date;
     mode: number;
 }
+export type FolderStat = {
+    isDirectory: true;
+    isSymbolicLink: false;
+} | {
+    isDirectory: false;
+    isSymbolicLink: true;
+    realpath: string;
+};
 export type FileType = "file" | "dir";
 export declare function realpath(target: string): Promise<string>;
 export declare function readdirp(folder: string): Promise<FileEntry[]>;
 export declare function getFileEntry(target: string): Promise<FileEntry>;
-export declare function ensureFolder(folder: string): Promise<{
-    isDirectory: boolean;
-    isSymbolicLink: boolean;
-    realpath?: string;
-}>;
+export declare function ensureFolder(folder: string): Promise<FolderStat>;
 export declare function pathExists(target: string): Promise<boolean>;
 export declare function rimraf(target: string): Promise<void>;
 export declare function isRootPath(target: string): boolean;

package/lib/fs.js

@@ -7,10 +7,10 @@ exports.ensureFolder = ensureFolder;
 exports.pathExists = pathExists;
 exports.rimraf = rimraf;
 exports.isRootPath = isRootPath;
-const path = require("path");
-const fs = require("fs/promises");
+const fsSync = require("node:fs");
+const fs = require("node:fs/promises");
+const path = require("node:path");
 const util = require("node:util");
-const fsSync = require("fs");
 async function realpath(target) {
     // fs.promises.realpath has a bug with long path on Windows.
     // https://github.com/nodejs/node/issues/51031
@@ -59,7 +59,7 @@ async function getFileEntry(target) {
         isSymbolicLink,
         type: fileType,
         mtime: stat.mtime,
-        mode: stat.mode
+        mode: stat.mode,
     };
 }
 async function ensureFolder(folder) {
@@ -67,7 +67,7 @@ async function ensureFolder(folder) {
     if (folder === path.dirname(folder)) {
         return Promise.resolve({
             isDirectory: true,
-            isSymbolicLink: false
+            isSymbolicLink: false,
         });
     }
     try {
@@ -90,7 +90,7 @@ async function pathExists(target) {
         await fs.access(target);
         return true;
     }
-    catch (error) {
+    catch (_error) {
         return false;
     }
 }
@@ -105,7 +105,7 @@ async function rimraf(target) {
         if (stat.isDirectory() && !stat.isSymbolicLink()) {
             // Children
             const children = await fs.readdir(target);
-            await Promise.all(children.map(child => rimraf(path.join(target, child))));
+            await Promise.all(children.map((child) => rimraf(path.join(target, child))));
             // Folder
             await fs.rmdir(target);
         }
@@ -113,7 +113,8 @@ async function rimraf(target) {
         else {
             // chmod as needed to allow for unlink
             const mode = stat.mode;
-            if (!(mode & 128)) { // 128 === 0200
+            if (!(mode & 128)) {
+                // 128 === 0200
                 await fs.chmod(target, mode | 128);
             }
             return fs.unlink(target);
@@ -164,7 +165,7 @@ async function mkdir(folder) {
                 };
             }
         }
-        catch (statError) {
+        catch (_statError) {
             throw error; // rethrow original error
         }
     }
@@ -182,9 +183,9 @@ const charColon = 58;
 // "\"
 const charWinSep = 92;
 // "/"
-const cahrUnixSep = 47;
+const charUnixSep = 47;
 function isDriveLetter(char0) {
-    return char0 >= charA && char0 <= charZ || char0 >= chara && char0 <= charz;
+    return (char0 >= charA && char0 <= charZ) || (char0 >= chara && char0 <= charz);
 }
 const winSep = "\\";
 const unixSep = "/";
@@ -192,17 +193,16 @@ function isRootPath(target) {
     if (!target) {
         return false;
     }
-    if (target === winSep ||
-        target === unixSep) {
+    if (target === winSep || target === unixSep) {
         return true;
     }
     if (process.platform === "win32") {
         if (target.length > 3) {
             return false;
         }
-        return isDriveLetter(target.charCodeAt(0))
-            && target.charCodeAt(1) === charColon
-            && (target.length === 2 || target.charCodeAt(2) === charWinSep || target.charCodeAt(2) === cahrUnixSep);
+        return (isDriveLetter(target.charCodeAt(0)) &&
+            target.charCodeAt(1) === charColon &&
+            (target.length === 2 || target.charCodeAt(2) === charWinSep || target.charCodeAt(2) === charUnixSep));
     }
     return false;
 }

package/lib/index.d.ts

@@ -1,7 +1,7 @@
-import { IZipOptions } from "./zip";
-import { IExtractOptions } from "./unzip";
-export * from "./zip";
+import { type IExtractOptions } from "./unzip";
+import { type IZipOptions } from "./zip";
 export * from "./unzip";
+export * from "./zip";
 /**
  * Compress a single file to zip.
  * @param file

package/lib/index.js

@@ -17,10 +17,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.archiveFile = archiveFile;
 exports.archiveFolder = archiveFolder;
 exports.extract = extract;
-const zip_1 = require("./zip");
 const unzip_1 = require("./unzip");
-__exportStar(require("./zip"), exports);
+const zip_1 = require("./zip");
 __exportStar(require("./unzip"), exports);
+__exportStar(require("./zip"), exports);
 /**
  * Compress a single file to zip.
  * @param file

package/lib/unzip.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Unzip = void 0;
+const node_fs_1 = require("node:fs");
+const fs = require("node:fs/promises");
+const path = require("node:path");
 const yauzl = require("yauzl");
-const exfs = require("./fs");
-const fs_1 = require("fs");
-const fs = require("fs/promises");
-const path = require("path");
 const cancelable_1 = require("./cancelable");
+const exfs = require("./fs");
 class EntryEvent {
     /**
      *
@@ -64,8 +64,14 @@ class EntryContext {
             this._symlinkFolders.push({ folder, realpath });
         }
     }
+    isOutside(baseDir, targetPath) {
+        const absoluteBase = path.resolve(baseDir);
+        const absoluteTarget = path.resolve(targetPath);
+        const relative = path.relative(absoluteBase, absoluteTarget);
+        return relative.startsWith("..") || path.isAbsolute(relative);
+    }
     getFilePath() {
-        return path.join(this.targetFolder, this.decodeEntryFileName);
+        return path.resolve(path.join(this.targetFolder, this.decodeEntryFileName));
     }
     async ensureFolder(folder) {
         if (this._ensuredFolders.includes(folder)) {
@@ -78,12 +84,10 @@ class EntryContext {
         this._ensuredFolders.push(folder);
     }
     async isOutsideTargetFolder(tpath) {
-        if (this._symlinkFileNames.length === 0 &&
-            this._symlinkFolders.length === 0) {
+        if (this._symlinkFileNames.length === 0 && this._symlinkFolders.length === 0) {
             return false;
         }
-        if (process.platform === "win32" &&
-            this.symlinkAsFileOnWindows) {
+        if (process.platform === "win32" && this.symlinkAsFileOnWindows) {
             return false;
         }
         for (const { folder, realpath } of this._symlinkFolders) {
@@ -96,7 +100,7 @@ class EntryContext {
         for (const fileName of this._symlinkFileNames) {
             if (tpath.includes(fileName)) {
                 const realFilePath = await exfs.realpath(tpath);
-                if (realFilePath.indexOf(this.realTargetFolder) !== 0) {
+                if (this.isOutside(this.realTargetFolder, realFilePath)) {
                     return true;
                 }
             }
@@ -227,7 +231,7 @@ class Unzip extends cancelable_1.Cancelable {
             yauzl.open(zipFile, {
                 lazyEntries: true,
                 // see https://github.com/thejoshwolfe/yauzl/issues/84
-                decodeStrings: false
+                decodeStrings: false,
             }, (err, zfile) => {
                 if (err) {
                     e(this.wrapError(err, token.isCancelled));
@@ -285,17 +289,17 @@ class Unzip extends cancelable_1.Cancelable {
                 fileStream.destroy(this.canceledError());
             }
         });
-        return new Promise(async (c, e) => {
+        return new Promise((c, e) => {
             try {
                 const filePath = entryContext.getFilePath();
-                const mode = this.modeFromEntry(entry);
-                // see https://unix.stackexchange.com/questions/193465/what-file-mode-is-a-symlink
-                const isSymlink = ((mode & 0o170000) === 0o120000);
                 readStream.once("error", (err) => {
                     e(this.wrapError(err, token.isCancelled));
                 });
+                const mode = this.modeFromEntry(entry);
+                // see https://unix.stackexchange.com/questions/193465/what-file-mode-is-a-symlink
+                const isSymlink = (mode & 0o170000) === 0o120000;
                 if (isSymlink) {
-                    entryContext.symlinkFileNames.push(entryContext.decodeEntryFileName);
+                    entryContext.symlinkFileNames.push(path.resolve(path.join(entryContext.targetFolder, entryContext.decodeEntryFileName)));
                 }
                 if (isSymlink && !this.symlinkToFile()) {
                     let linkContent = "";
@@ -312,7 +316,7 @@ class Unzip extends cancelable_1.Cancelable {
                     });
                 }
                 else {
-                    fileStream = (0, fs_1.createWriteStream)(filePath, { mode });
+                    fileStream = (0, node_fs_1.createWriteStream)(filePath, { mode });
                     fileStream.once("close", () => c());
                     fileStream.once("error", (err) => {
                         e(this.wrapError(err, token.isCancelled));
@@ -328,12 +332,12 @@ class Unzip extends cancelable_1.Cancelable {
     modeFromEntry(entry) {
         const attr = entry.externalFileAttributes >> 16 || 33188;
         return [448 /* S_IRWXU */, 56 /* S_IRWXG */, 7 /* S_IRWXO */]
-            .map(mask => attr & mask)
+            .map((mask) => attr & mask)
             .reduce((a, b) => a + b, attr & 61440 /* S_IFMT */);
     }
     async createSymlink(linkContent, des) {
         let linkType = "file";
-        if (process.platform === 'win32') {
+        if (process.platform === "win32") {
             if (/\/$/.test(linkContent)) {
                 linkType = "dir";
             }
@@ -348,7 +352,7 @@ class Unzip extends cancelable_1.Cancelable {
                         linkType = "dir";
                     }
                 }
-                catch (error) {
+                catch (_error) {
                     // ignore
                 }
             }
@@ -356,22 +360,22 @@ class Unzip extends cancelable_1.Cancelable {
         await fs.symlink(linkContent, des, linkType);
     }
     isOverwrite() {
-        if (this.options &&
-            this.options.overwrite) {
+        var _a;
+        if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.overwrite) {
             return true;
         }
         return false;
     }
     onEntryCallback(event) {
-        if (this.options && this.options.onEntry) {
+        var _a;
+        if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.onEntry) {
             this.options.onEntry(event);
         }
     }
     symlinkToFile() {
         let symlinkToFile = false;
         if (process.platform === "win32") {
-            if (this.options &&
-                this.options.symlinkAsFileOnWindows === false) {
+            if (this.options && this.options.symlinkAsFileOnWindows === false) {
                 symlinkToFile = false;
             }
             else {

package/lib/zip.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Zip = void 0;
+const node_fs_1 = require("node:fs");
+const fs = require("node:fs/promises");
+const path = require("node:path");
 const yazl = require("yazl");
-const fs_1 = require("fs");
-const fs = require("fs/promises");
-const exfs = require("./fs");
-const path = require("path");
 const cancelable_1 = require("./cancelable");
+const exfs = require("./fs");
 /**
  * Compress files or folders to a zip file.
  */
@@ -34,7 +34,7 @@ class Zip extends cancelable_1.Cancelable {
         }
         this.zipFiles.push({
             path: file,
-            metadataPath: mPath
+            metadataPath: mPath,
         });
     }
     /**
@@ -46,7 +46,7 @@ class Zip extends cancelable_1.Cancelable {
     addFolder(folder, metadataPath) {
         this.zipFolders.push({
             path: folder,
-            metadataPath
+            metadataPath,
         });
     }
     /**
@@ -64,13 +64,13 @@ class Zip extends cancelable_1.Cancelable {
         // Re-instantiate yazl every time the archive method is called to ensure that files are not added repeatedly.
         // This will also make the Zip class reusable.
         this.yazlFile = new yazl.ZipFile();
-        return new Promise(async (c, e) => {
+        return new Promise((c, e) => {
             this.yazlFile.once("error", (err) => {
                 e(this.wrapError(err, token.isCancelled));
             });
             const zip = this.yazlFile;
             if (!token.isCancelled) {
-                this.zipStream = (0, fs_1.createWriteStream)(zipFile);
+                this.zipStream = (0, node_fs_1.createWriteStream)(zipFile);
                 this.zipStream.once("error", (err) => {
                     e(this.wrapError(err, token.isCancelled));
                 });
@@ -88,21 +88,24 @@ class Zip extends cancelable_1.Cancelable {
                 zip.outputStream.pipe(this.zipStream);
                 this.isPipe = true;
             }
-            try {
-                const files = this.zipFiles;
-                for (const file of files) {
-                    const entry = await exfs.getFileEntry(file.path);
-                    await this.addEntry(zip, entry, file, token);
+            const start = async () => {
+                try {
+                    const files = this.zipFiles;
+                    for (const file of files) {
+                        const entry = await exfs.getFileEntry(file.path);
+                        await this.addEntry(zip, entry, file, token);
+                    }
+                    if (this.zipFolders.length > 0) {
+                        await this.walkDir(this.zipFolders, token);
+                    }
                 }
-                if (this.zipFolders.length > 0) {
-                    await this.walkDir(this.zipFolders, token);
+                catch (error) {
+                    e(this.wrapError(error, token.isCancelled));
                 }
-            }
-            catch (error) {
-                e(this.wrapError(error, token.isCancelled));
-                return;
-            }
-            zip.end();
+            };
+            start().finally(() => {
+                zip.end();
+            });
         });
     }
     /**
@@ -135,7 +138,7 @@ class Zip extends cancelable_1.Cancelable {
             if (entry.type === "dir") {
                 zip.addEmptyDirectory(file.metadataPath, {
                     mtime: entry.mtime,
-                    mode: entry.mode
+                    mode: entry.mode,
                 });
             }
             else {
@@ -145,7 +148,7 @@ class Zip extends cancelable_1.Cancelable {
     }
     addFileStream(zip, file, metadataPath, token) {
         return new Promise((c, e) => {
-            const fileStream = (0, fs_1.createReadStream)(file.path);
+            const fileStream = (0, node_fs_1.createReadStream)(file.path);
             fileStream.once("error", (err) => {
                 const wrappedError = this.wrapError(err, token.isCancelled);
                 this.stopPipe(wrappedError);
@@ -175,7 +178,9 @@ class Zip extends cancelable_1.Cancelable {
                         return;
                     }
                     const relativePath = path.relative(folder.path, entry.path);
-                    const metadataPath = folder.metadataPath ? path.join(folder.metadataPath, relativePath) : relativePath;
+                    const metadataPath = folder.metadataPath
+                        ? path.join(folder.metadataPath, relativePath)
+                        : relativePath;
                     await this.addEntry(this.yazlFile, entry, { path: entry.path, metadataPath }, token);
                 }
             }
@@ -197,8 +202,7 @@ class Zip extends cancelable_1.Cancelable {
     }
     followSymlink() {
         let followSymlink = false;
-        if (this.options &&
-            this.options.followSymlinks === true) {
+        if (this.options && this.options.followSymlinks === true) {
             followSymlink = true;
         }
         return followSymlink;

package/package.json

@@ -1,22 +1,22 @@
 {
     "name": "zip-lib",
-    "version": "1.1.2",
+    "version": "1.2.0",
     "description": "zip and unzip library for node",
     "main": "lib/index.js",
     "types": "./lib/index.d.ts",
     "scripts": {
-        "compile": "rimraf ./dist && tsc -p ./src/tsconfig.json",
-        "release": "rimraf ./pkg && npm run tsc-cjs && node ./build.mjs",
+        "lint": "biome lint",
         "tsc-cjs": "tsc -p ./src/tsconfig.production.cjs.json",
-        "compile-test": "rimraf ./test/out && tsc -p ./test/src/tsconfig.json",
-        "test": "npm run compile && npm run compile-test && node ./test/src/before.js && mocha ./test/out --timeout 10000"
+        "release": "rimraf ./pkg && npm run tsc-cjs && node ./build.mjs",
+        "test": "vitest run",
+        "test:coverage": "vitest run --coverage"
     },
     "repository": {
         "type": "git",
         "url": "https://github.com/fpsqdb/zip-lib.git"
     },
     "engines": {
-        "node": ">=18"
+        "node": ">=20"
     },
     "keywords": [
         "zip",
@@ -34,12 +34,13 @@
         "yazl": "^3.3.1"
     },
     "devDependencies": {
-        "@types/mocha": "^10.0.10",
-        "@types/node": "^18.19.86",
+        "@biomejs/biome": "^2.3.14",
+        "@types/node": "^20.19.32",
         "@types/yauzl": "^2.10.3",
-        "@types/yazl": "^2.4.6",
-        "mocha": "^11.1.0",
-        "rimraf": "^6.0.1",
-        "typescript": "^5.8.3"
+        "@types/yazl": "^3.3.0",
+        "@vitest/coverage-v8": "^4.0.18",
+        "rimraf": "^6.1.2",
+        "typescript": "^5.9.3",
+        "vitest": "^4.0.18"
     }
 }