zip-lib 1.0.5 → 1.1.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2019 Ouga
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2019 Ouga
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,378 +1,381 @@
-# zip-lib
-zip and unzip library for node.
-
-[![npm Package](https://img.shields.io/npm/v/zip-lib.svg)](https://www.npmjs.org/package/zip-lib) [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/fpsqdb/zip-lib/blob/master/LICENSE) ![node](https://img.shields.io/node/v/zip-lib) ![Node.js CI](https://github.com/fpsqdb/zip-lib/workflows/Node.js%20CI/badge.svg)
-
-## Install
-
-```
-npm install zip-lib
-```
-
-## Quick Start
-
-* [Zip](#Zip)
-    - [Zip single file](#zip-single-file)
-    - [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)
-    - [Unzip and exclude specified entries](#unzip-and-exclude-specified-entries)
-    - [Cancel zip](#cancel-zip)
-    - [Cancel unzip](#cancel-unzip)
-* [API](#api)
-    - Method: [archiveFile](#archivefile)
-    - Method: [archiveFolder](#archivefolder)
-    - Method: [extract](#extract)
-    - Class: [Zip](#class-zip)
-    - Class: [Unzip](#class-unzip)
-    - Options: [IZipOptions](#izipoptions)
-    - Options: [IExtractOptions](#iextractoptions)
-
-## Zip
-You can use **zip-lib** to compress files or folders.
-
-### Zip single file
-
-```js
-const zl = require("zip-lib");
-
-zl.archiveFile("path/to/file.txt", "path/to/target.zip").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-### Zip single folder
-
-```js
-const zl = require("zip-lib");
-
-zl.archiveFolder("path/to/folder", "path/to/target.zip").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-## Unzip
-
-```js
-const zl = require("zip-lib");
-
-zl.extract("path/to/target.zip", "path/to/target").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-## 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
-const zl = require("zip-lib");
-
-const zip = new zl.Zip();
-// Adds a file from the file system
-zip.addFile("path/to/file.txt");
-// Adds a folder from the file system, putting its contents at the root of archive
-zip.addFolder("path/to/folder");
-// Generate zip file.
-zip.archive("path/to/target.zip").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-The `path/to/folder` directory is as follows:
-
-```
-path/to/folder
-.
-├── dir1
-│   ├── file.ext
-├── dir2
-└── file_in_root.ext
-```
-
-And the generated `path/to/target.zip` archive file directory will be as follows:
-
-```
-path/to/target.zip
-.
-├── file.txt
-├── dir1
-│   ├── file.ext
-├── dir2
-└── file_in_root.ext
-```
-
-### Zip with metadata
-
-```js
-const zl = require("zip-lib");
-
-const zip = new zl.Zip();
-// Adds a file from the file system
-zip.addFile("path/to/file.txt", "renamedFile.txt");
-zip.addFile("path/to/file2.txt", "folder/file.txt");
-// Adds a folder from the file system, and naming it `new folder` within the archive
-zip.addFolder("path/to/folder", "new folder");
-// Generate zip file.
-zip.archive("path/to/target.zip").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-The `path/to/folder` directory is as follows:
-
-```
-path/to/folder
-.
-├── dir1
-│   ├── file.ext
-├── dir2
-└── file_in_root.ext
-```
-
-And the generated `path/to/target.zip` archive file directory will be as follows:
-
-```
-path/to/target.zip
-.
-├── renamedFile.txt
-├── folder
-│   ├── file.txt
-│── new folder
-    ├── dir1
-    │   ├── file.ext
-    ├── dir2
-    └── file_in_root.ext
-```
-
-### Unzip with entry callback
-Using `onEntry` callback we can know the current progress of extracting and control the extraction operation. See [IExtractOptions](#iextractoptions).
-
-```js
-const zl = require("zip-lib");
-
-const unzip = new zl.Unzip({
-    // Called before an item is extracted.
-    onEntry: function (event) {
-        console.log(event.entryCount, event.entryName);
-    }
-})
-unzip.extract("path/to/target.zip", "path/to/target").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-### Unzip and exclude specified entries
-The following code shows how to exclude the `__MACOSX` folder in the zip file when extracting. See [IExtractOptions](#iextractoptions).
-
-```js
-const zl = require("zip-lib");
-
-const unzip = new zl.Unzip({
-    // Called before an item is extracted.
-    onEntry: function (event) {
-        if (/^__MACOSX\//.test(event.entryName)) {
-            // entry name starts with __MACOSX/
-            event.preventDefault();
-        }
-    }
-})
-unzip.extract("path/to/target.zip", "path/to/target").then(function () {
-    console.log("done");
-}, function (err) {
-    console.log(err);
-});
-```
-
-### Cancel zip
-If the `cancel` method is called after the archive is complete, nothing will happen.
-
-```js
-const zl = require("zip-lib");
-
-const zip = new zl.Zip();
-zip.addFile("path/to/file.txt");
-zip.archive("path/to/target.zip").then(function () {
-    console.log("done");
-}, function (err) {
-    if (err.name === "Canceled") {
-        console.log("cancel");
-    } else {
-        console.log(err);
-    }
-});
-
-// Cancel zip
-zip.cancel();
-```
-
-### Cancel unzip
-If the `cancel` method is called after the extract is complete, nothing will happen.
-
-```js
-const zl = require("zip-lib");
-
-const unzip = new zl.Unzip();
-unzip.extract("path/to/target.zip", "path/to/target").then(function () {
-    console.log("done");
-}, function (err) {
-    if (err.name === "Canceled") {
-        console.log("cancel");
-    } else {
-        console.log(err);
-    }
-});
-
-// cancel
-unzip.cancel();
-```
-
-## API
-
-### Method: archiveFile <a id="archivefile"></a>
-
-**archiveFile(file, zipFile, [options])**
-
-Compress a single file to zip.
-
-- `file`: String
-- `zipFile`: String
-- `options?`: [IZipOptions](#izipoptions) (optional)
-
-Returns: `Promise<viod>`
-
-### Method: archiveFolder <a id="archivefolder"></a>
-
-**archiveFolder(folder, zipFile, [options])**
-
-Compress all the contents of the specified folder to zip.
-
-- `folder`: String
-- `zipFile`: String
-- `options?`: [IZipOptions](#izipoptions) (optional)
-
-Returns: `Promise<void>`
-
-### Method: extract <a id="extract"></a>
-
-**extract(zipFile, targetFolder, [options])**
-
-Extract the zip file to the specified location.
-
-- `zipFile`: String
-- `targetFolder`: String
-- `options?`: [IExtractOptions](#iextractoptions) (optional)
-
-Returns: `Promise<void>`
-
-### Class: Zip<a id="class-zip"></a>
-Compress files or folders to a zip file.
-
-**Constructor: new Zip([options])**
-
-- `options?`: [IZipOptions](#izipoptions)
-
-**Method: addFile(file, [metadataPath])**
-
-Adds a file from the file system at realPath into the zipfile as metadataPath.
-
-- `file`: String
-- `metadataPath?`: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with `/` or `/[A-Za-z]:\//`, and must not contain `..`.
-
-Returns: `void`
-
-**Method: addFolder(folder, [metadataPath])**
-
-Adds a folder from the file system at realPath into the zipfile as metadataPath.
-
-- `folder`: String
-- `metadataPath?`: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with `/` or `/[A-Za-z]:\//`, and must not contain `..`.
-
-Returns: `void`
-
-**Method: archive(zipFile)**
-
-Generate zip file.
-
-- `zipFile`: String
-
-Returns: `Promise<viod>`
-
-**Method: cancel()**
-
-Cancel compression. If the `cancel` method is called after the archive is complete, nothing will happen.
-
-Returns: `void`
-
-### Class: Unzip<a id="class-unzip"></a>
-Extract the zip file.
-
-**Constructor: new Unzip([options])**
-
-- `options?`: [IZipOptions](#izipoptions) (optional)
-
-**Method: extract(zipFile, targetFolder)**
-
-Extract the zip file to the specified location.
-
-- `zipFile`: String
-- `targetFolder`: String
-
-Returns: `Promise<void>`
-
-**Method: cancel()**
-
-If the `cancel` method is called after the extract is complete, nothing will happen.
-
-Returns: `void`
-
-### Options: IZipOptions <a id="izipoptions"></a>
-
-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>
-
-Object
-- `overwrite?`: String (optional) - If it is true, the target directory will be deleted before extract. The default value is `false`.
-- `symlinkAsFileOnWindows?`: Boolean (optional) - Extract symbolic links as files on Windows. This value is only available on Windows and ignored on other platforms. The default value is `true`.<br>If `true`, the symlink in the zip will be extracted as a normal file on Windows.<br>If `false`, the symlink in the zip will be extracted as a symlink correctly on Windows, but an `EPERM` error will be thrown under non-administrators.
-
-    > ⚠**WARNING:** On Windows, the default security policy allows only administrators to create symbolic links. If you set `symlinkAsFileOnWindows` to `false` and the zip contains symlink, be sure to run the code under the administrator, otherwise an `EPERM` error will be thrown.
-
-- `onEntry?`: Function (optional) - Called before an item is extracted.<br>Arguments:
-    - `event`: Object - Represents an event that an entry is about to be extracted.
-        - `entryName`: String (readonly) - Entry name.
-        - `entryCount`: Number (readonly) - Total number of entries.
-        - `preventDefault()`: Function - Prevent extracting current entry. This method can be used to prevent extraction of the current item. By calling this method we can control which items can be extracted.
-
-# License
+# zip-lib
+zip and unzip library for node.
+
+[![npm Package](https://img.shields.io/npm/v/zip-lib.svg)](https://www.npmjs.org/package/zip-lib)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/fpsqdb/zip-lib/blob/master/LICENSE)
+![node](https://img.shields.io/node/v/zip-lib)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/fpsqdb/zip-lib/test.yml?branch=master)](https://github.com/fpsqdb/zip-lib/actions?query=workflow%3Atest)
+
+## Install
+
+```
+npm install zip-lib
+```
+
+## Quick Start
+
+* [Zip](#Zip)
+    - [Zip single file](#zip-single-file)
+    - [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)
+    - [Unzip and exclude specified entries](#unzip-and-exclude-specified-entries)
+    - [Cancel zip](#cancel-zip)
+    - [Cancel unzip](#cancel-unzip)
+* [API](#api)
+    - Method: [archiveFile](#archivefile)
+    - Method: [archiveFolder](#archivefolder)
+    - Method: [extract](#extract)
+    - Class: [Zip](#class-zip)
+    - Class: [Unzip](#class-unzip)
+    - Options: [IZipOptions](#izipoptions)
+    - Options: [IExtractOptions](#iextractoptions)
+
+## Zip
+You can use **zip-lib** to compress files or folders.
+
+### Zip single file
+
+```js
+const zl = require("zip-lib");
+
+zl.archiveFile("path/to/file.txt", "path/to/target.zip").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+### Zip single folder
+
+```js
+const zl = require("zip-lib");
+
+zl.archiveFolder("path/to/folder", "path/to/target.zip").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+## Unzip
+
+```js
+const zl = require("zip-lib");
+
+zl.extract("path/to/target.zip", "path/to/target").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+## 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
+const zl = require("zip-lib");
+
+const zip = new zl.Zip();
+// Adds a file from the file system
+zip.addFile("path/to/file.txt");
+// Adds a folder from the file system, putting its contents at the root of archive
+zip.addFolder("path/to/folder");
+// Generate zip file.
+zip.archive("path/to/target.zip").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+The `path/to/folder` directory is as follows:
+
+```
+path/to/folder
+.
+├── dir1
+│   ├── file.ext
+├── dir2
+└── file_in_root.ext
+```
+
+And the generated `path/to/target.zip` archive file directory will be as follows:
+
+```
+path/to/target.zip
+.
+├── file.txt
+├── dir1
+│   ├── file.ext
+├── dir2
+└── file_in_root.ext
+```
+
+### Zip with metadata
+
+```js
+const zl = require("zip-lib");
+
+const zip = new zl.Zip();
+// Adds a file from the file system
+zip.addFile("path/to/file.txt", "renamedFile.txt");
+zip.addFile("path/to/file2.txt", "folder/file.txt");
+// Adds a folder from the file system, and naming it `new folder` within the archive
+zip.addFolder("path/to/folder", "new folder");
+// Generate zip file.
+zip.archive("path/to/target.zip").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+The `path/to/folder` directory is as follows:
+
+```
+path/to/folder
+.
+├── dir1
+│   ├── file.ext
+├── dir2
+└── file_in_root.ext
+```
+
+And the generated `path/to/target.zip` archive file directory will be as follows:
+
+```
+path/to/target.zip
+.
+├── renamedFile.txt
+├── folder
+│   ├── file.txt
+│── new folder
+    ├── dir1
+    │   ├── file.ext
+    ├── dir2
+    └── file_in_root.ext
+```
+
+### Unzip with entry callback
+Using `onEntry` callback we can know the current progress of extracting and control the extraction operation. See [IExtractOptions](#iextractoptions).
+
+```js
+const zl = require("zip-lib");
+
+const unzip = new zl.Unzip({
+    // Called before an item is extracted.
+    onEntry: function (event) {
+        console.log(event.entryCount, event.entryName);
+    }
+})
+unzip.extract("path/to/target.zip", "path/to/target").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+### Unzip and exclude specified entries
+The following code shows how to exclude the `__MACOSX` folder in the zip file when extracting. See [IExtractOptions](#iextractoptions).
+
+```js
+const zl = require("zip-lib");
+
+const unzip = new zl.Unzip({
+    // Called before an item is extracted.
+    onEntry: function (event) {
+        if (/^__MACOSX\//.test(event.entryName)) {
+            // entry name starts with __MACOSX/
+            event.preventDefault();
+        }
+    }
+})
+unzip.extract("path/to/target.zip", "path/to/target").then(function () {
+    console.log("done");
+}, function (err) {
+    console.log(err);
+});
+```
+
+### Cancel zip
+If the `cancel` method is called after the archive is complete, nothing will happen.
+
+```js
+const zl = require("zip-lib");
+
+const zip = new zl.Zip();
+zip.addFile("path/to/file.txt");
+zip.archive("path/to/target.zip").then(function () {
+    console.log("done");
+}, function (err) {
+    if (err.name === "Canceled") {
+        console.log("cancel");
+    } else {
+        console.log(err);
+    }
+});
+
+// Cancel zip
+zip.cancel();
+```
+
+### Cancel unzip
+If the `cancel` method is called after the extract is complete, nothing will happen.
+
+```js
+const zl = require("zip-lib");
+
+const unzip = new zl.Unzip();
+unzip.extract("path/to/target.zip", "path/to/target").then(function () {
+    console.log("done");
+}, function (err) {
+    if (err.name === "Canceled") {
+        console.log("cancel");
+    } else {
+        console.log(err);
+    }
+});
+
+// cancel
+unzip.cancel();
+```
+
+## API
+
+### Method: archiveFile <a id="archivefile"></a>
+
+**archiveFile(file, zipFile, [options])**
+
+Compress a single file to zip.
+
+- `file`: String
+- `zipFile`: String
+- `options?`: [IZipOptions](#izipoptions) (optional)
+
+Returns: `Promise<viod>`
+
+### Method: archiveFolder <a id="archivefolder"></a>
+
+**archiveFolder(folder, zipFile, [options])**
+
+Compress all the contents of the specified folder to zip.
+
+- `folder`: String
+- `zipFile`: String
+- `options?`: [IZipOptions](#izipoptions) (optional)
+
+Returns: `Promise<void>`
+
+### Method: extract <a id="extract"></a>
+
+**extract(zipFile, targetFolder, [options])**
+
+Extract the zip file to the specified location.
+
+- `zipFile`: String
+- `targetFolder`: String
+- `options?`: [IExtractOptions](#iextractoptions) (optional)
+
+Returns: `Promise<void>`
+
+### Class: Zip<a id="class-zip"></a>
+Compress files or folders to a zip file.
+
+**Constructor: new Zip([options])**
+
+- `options?`: [IZipOptions](#izipoptions)
+
+**Method: addFile(file, [metadataPath])**
+
+Adds a file from the file system at realPath into the zipfile as metadataPath.
+
+- `file`: String
+- `metadataPath?`: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with `/` or `/[A-Za-z]:\//`, and must not contain `..`.
+
+Returns: `void`
+
+**Method: addFolder(folder, [metadataPath])**
+
+Adds a folder from the file system at realPath into the zipfile as metadataPath.
+
+- `folder`: String
+- `metadataPath?`: String (optional) - Typically metadataPath would be calculated as path.relative(root, realPath). A valid metadataPath must not start with `/` or `/[A-Za-z]:\//`, and must not contain `..`.
+
+Returns: `void`
+
+**Method: archive(zipFile)**
+
+Generate zip file.
+
+- `zipFile`: String
+
+Returns: `Promise<viod>`
+
+**Method: cancel()**
+
+Cancel compression. If the `cancel` method is called after the archive is complete, nothing will happen.
+
+Returns: `void`
+
+### Class: Unzip<a id="class-unzip"></a>
+Extract the zip file.
+
+**Constructor: new Unzip([options])**
+
+- `options?`: [IZipOptions](#izipoptions) (optional)
+
+**Method: extract(zipFile, targetFolder)**
+
+Extract the zip file to the specified location.
+
+- `zipFile`: String
+- `targetFolder`: String
+
+Returns: `Promise<void>`
+
+**Method: cancel()**
+
+If the `cancel` method is called after the extract is complete, nothing will happen.
+
+Returns: `void`
+
+### Options: IZipOptions <a id="izipoptions"></a>
+
+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>
+
+Object
+- `overwrite?`: String (optional) - If it is true, the target directory will be deleted before extract. The default value is `false`.
+- `symlinkAsFileOnWindows?`: Boolean (optional) - Extract symbolic links as files on Windows. This value is only available on Windows and ignored on other platforms. The default value is `true`.<br>If `true`, the symlink in the zip will be extracted as a normal file on Windows.<br>If `false`, the symlink in the zip will be extracted as a symlink correctly on Windows, but an `EPERM` error will be thrown under non-administrators.
+
+    > ⚠**WARNING:** On Windows, the default security policy allows only administrators to create symbolic links. If you set `symlinkAsFileOnWindows` to `false` and the zip contains symlink, be sure to run the code under the administrator, otherwise an `EPERM` error will be thrown.
+
+- `onEntry?`: Function (optional) - Called before an item is extracted.<br>Arguments:
+    - `event`: Object - Represents an event that an entry is about to be extracted.
+        - `entryName`: String (readonly) - Entry name.
+        - `entryCount`: Number (readonly) - Total number of entries.
+        - `preventDefault()`: Function - Prevent extracting current entry. This method can be used to prevent extraction of the current item. By calling this method we can control which items can be extracted.
+
+# License
 Licensed under the [MIT](https://github.com/fpsqdb/zip-lib/blob/master/LICENSE) license.

package/fs.d.ts

@@ -0,0 +1,19 @@
+export interface FileEntry {
+    path: string;
+    isSymbolicLink: boolean;
+    type: FileType;
+    mtime: Date;
+    mode: number;
+}
+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 pathExists(target: string): Promise<boolean>;
+export declare function rimraf(target: string): Promise<void>;
+export declare function isRootPath(target: string): boolean;

package/{lib/fs.js → fs.js}

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.realpath = realpath;
 exports.readdirp = readdirp;
 exports.getFileEntry = getFileEntry;
 exports.ensureFolder = ensureFolder;
@@ -7,10 +8,17 @@ exports.pathExists = pathExists;
 exports.rimraf = rimraf;
 exports.isRootPath = isRootPath;
 const path = require("path");
-const util = require("./util");
+const fs = require("fs/promises");
+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
+    return util.promisify(fsSync.realpath)(target);
+}
 async function readdirp(folder) {
     const result = [];
-    const files = await util.readdir(folder);
+    const files = await fs.readdir(folder);
     for (const item of files) {
         const file = path.join(folder, item);
         const entry = await getFileEntry(file);
@@ -28,7 +36,7 @@ async function readdirp(folder) {
     return result;
 }
 async function getFileEntry(target) {
-    const stat = await util.lstat(target);
+    const stat = await fs.lstat(target);
     let isSymbolicLink = false;
     let fileType = "file";
     if (stat.isDirectory()) {
@@ -40,7 +48,7 @@ async function getFileEntry(target) {
             // If the path is a link, we must instead use fs.stat() to find out if the
             // link is a directory or not because lstat will always return the stat of
             // the link which is always a file.
-            const actualStat = await util.stat(target);
+            const actualStat = await fs.stat(target);
             if (actualStat.isDirectory()) {
                 fileType = "dir";
             }
@@ -57,10 +65,14 @@ async function getFileEntry(target) {
 async function ensureFolder(folder) {
     // stop at root
     if (folder === path.dirname(folder)) {
-        return Promise.resolve();
+        return Promise.resolve({
+            isDirectory: true,
+            isSymbolicLink: false
+        });
     }
     try {
-        await mkdir(folder);
+        const result = await mkdir(folder);
+        return result;
     }
     catch (error) {
         // ENOENT: a parent folder does not exist yet, continue
@@ -75,7 +87,7 @@ async function ensureFolder(folder) {
 }
 async function pathExists(target) {
     try {
-        await util.access(target);
+        await fs.access(target);
         return true;
     }
     catch (error) {
@@ -88,23 +100,23 @@ async function rimraf(target) {
         return Promise.reject(new Error(`Refuse to recursively delete root, path: "${target}"`));
     }
     try {
-        const stat = await util.lstat(target);
+        const stat = await fs.lstat(target);
         // Folder delete (recursive) - NOT for symbolic links though!
         if (stat.isDirectory() && !stat.isSymbolicLink()) {
             // Children
-            const children = await util.readdir(target);
+            const children = await fs.readdir(target);
             await Promise.all(children.map(child => rimraf(path.join(target, child))));
             // Folder
-            await util.rmdir(target);
+            await fs.rmdir(target);
         }
         // Single file delete
         else {
             // chmod as needed to allow for unlink
             const mode = stat.mode;
             if (!(mode & 128)) { // 128 === 0200
-                await util.chmod(target, mode | 128);
+                await fs.chmod(target, mode | 128);
             }
-            return util.unlink(target);
+            return fs.unlink(target);
         }
     }
     catch (error) {
@@ -115,7 +127,11 @@ async function rimraf(target) {
 }
 async function mkdir(folder) {
     try {
-        await util.mkdir(folder, 0o777);
+        await fs.mkdir(folder, 0o777);
+        return {
+            isDirectory: true,
+            isSymbolicLink: false,
+        };
     }
     catch (error) {
         // ENOENT: a parent folder does not exist yet or folder name is invalid.
@@ -125,15 +141,81 @@ async function mkdir(folder) {
         // Any other error: check if folder exists and
         // return normally in that case if its a folder
         try {
-            const fileStat = await util.stat(folder);
-            if (!fileStat.isDirectory()) {
-                return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+            const fileStat = await fs.lstat(folder);
+            if (fileStat.isSymbolicLink()) {
+                const realFilePath = await realpath(folder);
+                const realFileStat = await fs.lstat(realFilePath);
+                if (!realFileStat.isDirectory()) {
+                    return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+                }
+                return {
+                    isDirectory: false,
+                    isSymbolicLink: true,
+                    realpath: realFilePath,
+                };
+            }
+            else {
+                if (!fileStat.isDirectory()) {
+                    return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+                }
+                return {
+                    isDirectory: true,
+                    isSymbolicLink: false,
+                };
             }
         }
         catch (statError) {
             throw error; // rethrow original error
         }
     }
+    // // Any other error: check if folder exists and
+    // // return normally in that case if its a folder
+    // try {
+    //     if (folder.includes("dirlink")) {
+    //         console.log("tttttt11111", folder);
+    //     }
+    //     const fileStat = await fs.lstat(folder);
+    //     if (folder.includes("dirlink")) {
+    //         console.log("tttttt22222", fileStat);
+    //     }
+    //     if (fileStat.isSymbolicLink()) {
+    //         console.log("kkkkkkkkk", fileStat);
+    //         const realFilePath = await realpath(folder);
+    //         const realFileStat = await fs.lstat(realFilePath);
+    //         if (!realFileStat.isDirectory()) {
+    //             return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+    //         }
+    //         return {
+    //             isDirectory: false,
+    //             isSymbolicLink: true,
+    //             realpath: realFilePath,
+    //         }
+    //     } else {
+    //         if (!fileStat.isDirectory()) {
+    //             return Promise.reject(new Error(`"${folder}" exists and is not a directory.`));
+    //         }
+    //         return {
+    //             isDirectory: true,
+    //             isSymbolicLink: false,
+    //         }
+    //     }
+    // } catch (statError) {
+    //     if (folder.includes("dirlink")) {
+    //         console.log("yyyyy", statError);
+    //     }
+    //     // ignore
+    // }
+    // if (folder.includes("dirlink")) {
+    //     console.log("kkkkkkkkk22222", folder);
+    // }
+    // await fs.mkdir(folder, { recursive: true, mode: 0o777 });
+    // if (folder.includes("dirlink")) {
+    //     console.log("kkkkkkkkk3333333", folder);
+    // }
+    // return {
+    //     isDirectory: true,
+    //     isSymbolicLink: false,
+    // };
 }
 // "A"
 const charA = 65;

package/package.json

@@ -1,45 +1,43 @@
-{
-    "name": "zip-lib",
-    "version": "1.0.5",
-    "description": "zip and unzip library for node",
-    "main": "lib/index.js",
-    "scripts": {
-        "compile": "rimraf ./lib && tsc -p ./src/tsconfig.json",
-        "release": "rimraf ./lib && tsc -p ./src/tsconfig.release.json",
-        "compile-test": "rimraf ./test/out && tsc -p ./test/src/tsconfig.json",
-        "test": "node ./test/src/before.js && mocha ./test/out --timeout 10000",
-        "pack": "npm run release && npm pack",
-        "publish": "npm run release && npm publish"
-    },
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/fpsqdb/zip-lib.git"
-    },
-    "engines": {
-        "node": ">=12"
-    },
-    "keywords": [
-        "zip",
-        "folder",
-        "unzip",
-        "archive",
-        "extract",
-        "promise",
-        "async"
-    ],
-    "author": "fpsqdb",
-    "license": "MIT",
-    "dependencies": {
-        "yauzl": "^3.2.0",
-        "yazl": "^3.2.1"
-    },
-    "devDependencies": {
-        "@types/mocha": "^10.0.9",
-        "@types/node": "^12.20.55",
-        "@types/yauzl": "^2.10.3",
-        "@types/yazl": "^2.4.5",
-        "mocha": "^10.8.2",
-        "rimraf": "^6.0.1",
-        "typescript": "^5.6.3"
-    }
-}
+{
+    "name": "zip-lib",
+    "version": "1.1.0",
+    "description": "zip and unzip library for node",
+    "main": "lib/index.js",
+    "scripts": {
+        "compile": "rimraf ./dist && tsc -p ./src/tsconfig.json",
+        "release": "rimraf ./lib && tsc -p ./src/tsconfig.release.json && node ./build.mjs",
+        "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"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/fpsqdb/zip-lib.git"
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "keywords": [
+        "zip",
+        "folder",
+        "unzip",
+        "archive",
+        "extract",
+        "promise",
+        "async"
+    ],
+    "author": "fpsqdb",
+    "license": "MIT",
+    "dependencies": {
+        "yauzl": "^3.2.0",
+        "yazl": "^3.3.1"
+    },
+    "devDependencies": {
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^18.19.86",
+        "@types/yauzl": "^2.10.3",
+        "@types/yazl": "^2.4.6",
+        "mocha": "^11.1.0",
+        "rimraf": "^6.0.1",
+        "typescript": "^5.8.3"
+    }
+}

package/{lib/unzip.js → unzip.js}

@@ -4,8 +4,8 @@ exports.Unzip = void 0;
 const yauzl = require("yauzl");
 const exfs = require("./fs");
 const fs_1 = require("fs");
+const fs = require("fs/promises");
 const path = require("path");
-const util = require("./util");
 const cancelable_1 = require("./cancelable");
 class EntryEvent {
     /**
@@ -40,6 +40,7 @@ class EntryContext {
         this._realTargetFolder = _realTargetFolder;
         this.symlinkAsFileOnWindows = symlinkAsFileOnWindows;
         this._symlinkFileNames = [];
+        this._symlinkFolders = [];
     }
     get decodeEntryFileName() {
         return this._decodeEntryFileName;
@@ -56,20 +57,31 @@ class EntryContext {
     get symlinkFileNames() {
         return this._symlinkFileNames;
     }
+    get symlinkFolders() {
+        return this._symlinkFolders;
+    }
     getFilePath() {
         return path.join(this.targetFolder, this.decodeEntryFileName);
     }
     async isOutsideTargetFolder(tpath) {
-        if (this.symlinkFileNames.length === 0) {
+        if (this.symlinkFileNames.length === 0 &&
+            this.symlinkFolders.length === 0) {
             return false;
         }
         if (process.platform === "win32" &&
             this.symlinkAsFileOnWindows) {
             return false;
         }
+        for (const { folder, realpath } of this.symlinkFolders) {
+            if (tpath.includes(folder)) {
+                if (realpath.indexOf(this.realTargetFolder) !== 0) {
+                    return true;
+                }
+            }
+        }
         for (const fileName of this.symlinkFileNames) {
             if (tpath.includes(fileName)) {
-                const realFilePath = await util.realpath(tpath);
+                const realFilePath = await exfs.realpath(tpath);
                 if (realFilePath.indexOf(this.realTargetFolder) !== 0) {
                     return true;
                 }
@@ -106,7 +118,7 @@ class Unzip extends cancelable_1.Cancelable {
             return Promise.reject(this.canceledError());
         }
         await exfs.ensureFolder(targetFolder);
-        const realTargetFolder = await util.realpath(targetFolder);
+        const realTargetFolder = await exfs.realpath(targetFolder);
         const zfile = await this.openZip(zipFile, token);
         this.zipFile = zfile;
         zfile.readEntry();
@@ -240,7 +252,13 @@ class Unzip extends cancelable_1.Cancelable {
     async extractEntry(zfile, entry, entryContext, token) {
         const filePath = entryContext.getFilePath();
         const fileDir = path.dirname(filePath);
-        await exfs.ensureFolder(fileDir);
+        const folderStat = await exfs.ensureFolder(fileDir);
+        if (folderStat.isSymbolicLink) {
+            entryContext.symlinkFolders.push({
+                folder: fileDir,
+                realpath: folderStat.realpath,
+            });
+        }
         const outside = await entryContext.isOutsideTargetFolder(fileDir);
         if (outside) {
             const error = new Error(`Refuse to write file outside "${entryContext.targetFolder}", file: "${filePath}"`);
@@ -317,7 +335,7 @@ class Unzip extends cancelable_1.Cancelable {
                     targetPath = path.join(path.dirname(des), linkContent);
                 }
                 try {
-                    const stat = await util.stat(targetPath);
+                    const stat = await fs.stat(targetPath);
                     if (stat.isDirectory()) {
                         linkType = "dir";
                     }
@@ -327,7 +345,7 @@ class Unzip extends cancelable_1.Cancelable {
                 }
             }
         }
-        await util.symlink(linkContent, des, linkType);
+        await fs.symlink(linkContent, des, linkType);
     }
     isOverwrite() {
         if (this.options &&

package/{lib/zip.js → zip.js}

@@ -3,9 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Zip = void 0;
 const yazl = require("yazl");
 const fs_1 = require("fs");
+const fs = require("fs/promises");
 const exfs = require("./fs");
 const path = require("path");
-const util = require("./util");
 const cancelable_1 = require("./cancelable");
 /**
  * Compress files or folders to a zip file.
@@ -120,7 +120,7 @@ class Zip extends cancelable_1.Cancelable {
         if (entry.isSymbolicLink) {
             if (this.followSymlink()) {
                 if (entry.type === "dir") {
-                    const realPath = await util.realpath(file.path);
+                    const realPath = await exfs.realpath(file.path);
                     await this.walkDir([{ path: realPath, metadataPath: file.metadataPath }], token);
                 }
                 else {
@@ -160,7 +160,7 @@ class Zip extends cancelable_1.Cancelable {
         });
     }
     async addSymlink(zip, file, metadataPath) {
-        const linkTarget = await util.readlink(file.path);
+        const linkTarget = await fs.readlink(file.path);
         zip.addBuffer(Buffer.from(linkTarget), metadataPath, Object.assign(Object.assign({}, this.getYazlOption()), { mtime: file.mtime, mode: file.mode }));
     }
     async walkDir(folders, token) {

package/lib/util.js

@@ -1,48 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-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);
-}
-function mkdir(path, mode) {
-    return util.promisify(fs.mkdir)(path, mode);
-}
-function realpath(path) {
-    return util.promisify(fs.realpath)(path);
-}
-function stat(path) {
-    return util.promisify(fs.stat)(path);
-}
-function lstat(path) {
-    return util.promisify(fs.lstat)(path);
-}
-function chmod(path, mode) {
-    return util.promisify(fs.chmod)(path, mode);
-}
-function readdir(path) {
-    return util.promisify(fs.readdir)(path);
-}
-function access(path, mode) {
-    return util.promisify(fs.access)(path, mode);
-}
-function rmdir(path) {
-    return util.promisify(fs.rmdir)(path);
-}
-function symlink(target, path, type) {
-    return util.promisify(fs.symlink)(target, path, type);
-}
-function readlink(path) {
-    return util.promisify(fs.readlink)(path);
-}