zip-lib 1.0.3 → 1.0.5

package/README.md

@@ -16,6 +16,7 @@ npm install zip-lib
     - [Zip single folder](#zip-single-folder)
 * [Unzip](#unzip)
 * [Advanced usage](#advance-usage)
+    - [Sets the compression level](#sets-the-compression-level)
     - [Zip multiple files and folders](#zip-multiple-files-and-folders)
     - [Zip with metadata](#zip-with-metadata)
     - [Unzip with entry callback](#unzip-with-entry-callback)
@@ -72,6 +73,18 @@ zl.extract("path/to/target.zip", "path/to/target").then(function () {
 
 ## Advanced usage
 
+### Sets the compression level
+
+```js
+const zl = require("zip-lib");
+
+zl.archiveFolder("path/to/folder", "path/to/target.zip", { compressionLevel: 9 }).then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
 ### Zip multiple files and folders
 
 ```js
@@ -345,6 +358,7 @@ Returns: `void`
 
 Object
 - `followSymlinks?`: Boolean (optional) - Indicates how to handle when the given path is a symbolic link. The default value is `false`.<br>`true`: add the target of the symbolic link to the zip.<br>`false`: add symbolic link itself to the zip.
+- `compressionLevel?`: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 - Sets the compression level. The default value is `6`.<br>`0`: the file data will be stored.<br>`1-9`: the file data will be deflated.
 
 ### Options: IExtractOptions <a id="iextractoptions"></a>
 

package/lib/fs.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRootPath = exports.rimraf = exports.pathExists = exports.ensureFolder = exports.getFileEntry = exports.readdirp = void 0;
+exports.readdirp = readdirp;
+exports.getFileEntry = getFileEntry;
+exports.ensureFolder = ensureFolder;
+exports.pathExists = pathExists;
+exports.rimraf = rimraf;
+exports.isRootPath = isRootPath;
 const path = require("path");
 const util = require("./util");
 async function readdirp(folder) {
@@ -22,7 +27,6 @@ async function readdirp(folder) {
     }
     return result;
 }
-exports.readdirp = readdirp;
 async function getFileEntry(target) {
     const stat = await util.lstat(target);
     let isSymbolicLink = false;
@@ -50,7 +54,6 @@ async function getFileEntry(target) {
         mode: stat.mode
     };
 }
-exports.getFileEntry = getFileEntry;
 async function ensureFolder(folder) {
     // stop at root
     if (folder === path.dirname(folder)) {
@@ -70,7 +73,6 @@ async function ensureFolder(folder) {
         return Promise.reject(error);
     }
 }
-exports.ensureFolder = ensureFolder;
 async function pathExists(target) {
     try {
         await util.access(target);
@@ -80,7 +82,6 @@ async function pathExists(target) {
         return false;
     }
 }
-exports.pathExists = pathExists;
 async function rimraf(target) {
     if (isRootPath(target)) {
         // refuse to recursively delete root
@@ -112,7 +113,6 @@ async function rimraf(target) {
         }
     }
 }
-exports.rimraf = rimraf;
 async function mkdir(folder) {
     try {
         await util.mkdir(folder, 0o777);
@@ -172,4 +172,3 @@ function isRootPath(target) {
     }
     return false;
 }
-exports.isRootPath = isRootPath;

package/lib/index.js

@@ -14,7 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.extract = exports.archiveFolder = exports.archiveFile = void 0;
+exports.archiveFile = archiveFile;
+exports.archiveFolder = archiveFolder;
+exports.extract = extract;
 const zip_1 = require("./zip");
 const unzip_1 = require("./unzip");
 __exportStar(require("./zip"), exports);
@@ -30,7 +32,6 @@ function archiveFile(file, zipFile, options) {
     zip.addFile(file);
     return zip.archive(zipFile);
 }
-exports.archiveFile = archiveFile;
 /**
  * Compress all the contents of the specified folder to zip.
  * @param folder
@@ -42,7 +43,6 @@ function archiveFolder(folder, zipFile, options) {
     zip.addFolder(folder);
     return zip.archive(zipFile);
 }
-exports.archiveFolder = archiveFolder;
 /**
  * Extract the zip file to the specified location.
  * @param zipFile
@@ -53,4 +53,3 @@ function extract(zipFile, targetFolder, options) {
     const unzip = new unzip_1.Unzip(options);
     return unzip.extract(zipFile, targetFolder);
 }
-exports.extract = extract;

package/lib/util.js

@@ -1,49 +1,48 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readlink = exports.symlink = exports.rmdir = exports.access = exports.readdir = exports.chmod = exports.lstat = exports.stat = exports.realpath = exports.mkdir = exports.unlink = void 0;
+exports.unlink = unlink;
+exports.mkdir = mkdir;
+exports.realpath = realpath;
+exports.stat = stat;
+exports.lstat = lstat;
+exports.chmod = chmod;
+exports.readdir = readdir;
+exports.access = access;
+exports.rmdir = rmdir;
+exports.symlink = symlink;
+exports.readlink = readlink;
 const fs = require("fs");
 const util = require("util");
 function unlink(path) {
     return util.promisify(fs.unlink)(path);
 }
-exports.unlink = unlink;
 function mkdir(path, mode) {
     return util.promisify(fs.mkdir)(path, mode);
 }
-exports.mkdir = mkdir;
 function realpath(path) {
     return util.promisify(fs.realpath)(path);
 }
-exports.realpath = realpath;
 function stat(path) {
     return util.promisify(fs.stat)(path);
 }
-exports.stat = stat;
 function lstat(path) {
     return util.promisify(fs.lstat)(path);
 }
-exports.lstat = lstat;
 function chmod(path, mode) {
     return util.promisify(fs.chmod)(path, mode);
 }
-exports.chmod = chmod;
 function readdir(path) {
     return util.promisify(fs.readdir)(path);
 }
-exports.readdir = readdir;
 function access(path, mode) {
     return util.promisify(fs.access)(path, mode);
 }
-exports.access = access;
 function rmdir(path) {
     return util.promisify(fs.rmdir)(path);
 }
-exports.rmdir = rmdir;
 function symlink(target, path, type) {
     return util.promisify(fs.symlink)(target, path, type);
 }
-exports.symlink = symlink;
 function readlink(path) {
     return util.promisify(fs.readlink)(path);
 }
-exports.readlink = readlink;

package/lib/zip.d.ts

@@ -10,6 +10,14 @@ export interface IZipOptions {
      * The default value is `false`.
      */
     followSymlinks?: boolean;
+    /**
+     * Sets the compression level.
+     *
+     * 0: the file data will be stored, otherwise, the file data will be deflated.
+     *
+     * The default value is `6`.
+     */
+    compressionLevel?: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
 }
 /**
  * Compress files or folders to a zip file.
@@ -56,4 +64,11 @@ export declare class Zip extends Cancelable {
     private walkDir;
     private stopPipe;
     private followSymlink;
+    /**
+     * Retrieves the yazl options based on the current settings.
+     *
+     * @returns The yazl options with the specified compression level,
+     * or undefined if options or compressionLevel are not properly set.
+     */
+    private getYazlOption;
 }

package/lib/zip.js

@@ -28,13 +28,13 @@ class Zip extends cancelable_1.Cancelable {
      * A valid metadataPath must not start with "/" or /[A-Za-z]:\//, and must not contain "..".
      */
     addFile(file, metadataPath) {
-        let mpath = metadataPath;
-        if (!mpath) {
-            mpath = path.basename(file);
+        let mPath = metadataPath;
+        if (!mPath) {
+            mPath = path.basename(file);
         }
         this.zipFiles.push({
             path: file,
-            metadataPath: mpath
+            metadataPath: mPath
         });
     }
     /**
@@ -124,7 +124,7 @@ class Zip extends cancelable_1.Cancelable {
                     await this.walkDir([{ path: realPath, metadataPath: file.metadataPath }], token);
                 }
                 else {
-                    zip.addFile(file.path, file.metadataPath);
+                    zip.addFile(file.path, file.metadataPath, this.getYazlOption());
                 }
             }
             else {
@@ -156,18 +156,12 @@ class Zip extends cancelable_1.Cancelable {
             });
             // If the file attribute is known, add the entry using `addReadStream`,
             // this can reduce the number of calls to the `fs.stat` method.
-            zip.addReadStream(fileStream, metadataPath, {
-                mode: file.mode,
-                mtime: file.mtime
-            });
+            zip.addReadStream(fileStream, metadataPath, Object.assign(Object.assign({}, this.getYazlOption()), { mode: file.mode, mtime: file.mtime }));
         });
     }
     async addSymlink(zip, file, metadataPath) {
         const linkTarget = await util.readlink(file.path);
-        zip.addBuffer(Buffer.from(linkTarget), metadataPath, {
-            mtime: file.mtime,
-            mode: file.mode
-        });
+        zip.addBuffer(Buffer.from(linkTarget), metadataPath, Object.assign(Object.assign({}, this.getYazlOption()), { mtime: file.mtime, mode: file.mode }));
     }
     async walkDir(folders, token) {
         for (const folder of folders) {
@@ -209,5 +203,22 @@ class Zip extends cancelable_1.Cancelable {
         }
         return followSymlink;
     }
+    /**
+     * Retrieves the yazl options based on the current settings.
+     *
+     * @returns The yazl options with the specified compression level,
+     * or undefined if options or compressionLevel are not properly set.
+     */
+    getYazlOption() {
+        if (!this.options) {
+            return undefined;
+        }
+        if (typeof this.options.compressionLevel !== "number") {
+            return undefined;
+        }
+        return {
+            compressionLevel: this.options.compressionLevel,
+        };
+    }
 }
 exports.Zip = Zip;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "zip-lib",
-    "version": "1.0.3",
+    "version": "1.0.5",
     "description": "zip and unzip library for node",
     "main": "lib/index.js",
     "scripts": {
@@ -30,16 +30,16 @@
     "author": "fpsqdb",
     "license": "MIT",
     "dependencies": {
-        "yauzl": "^3.1.2",
-        "yazl": "^2.5.1"
+        "yauzl": "^3.2.0",
+        "yazl": "^3.2.1"
     },
     "devDependencies": {
-        "@types/mocha": "^10.0.6",
+        "@types/mocha": "^10.0.9",
         "@types/node": "^12.20.55",
-        "@types/yauzl": "^2.9.1",
-        "@types/yazl": "^2.4.2",
-        "mocha": "^10.3.0",
-        "rimraf": "^5.0.5",
-        "typescript": "^5.4.2"
+        "@types/yauzl": "^2.10.3",
+        "@types/yazl": "^2.4.5",
+        "mocha": "^10.8.2",
+        "rimraf": "^6.0.1",
+        "typescript": "^5.6.3"
     }
 }