compressing 1.4.0 → 1.6.0

package/History.md

@@ -1,4 +1,31 @@
 
+1.6.0 / 2022-06-13
+==================
+
+**features**
+  * [[`bd8ef44`](http://github.com/node-modules/compressing/commit/bd8ef44ade2f4b93d41ff2f78d6f17902d965798)] - feat: unzip should keep file mode (#68) (Artin <<lengthmin@gmail.com>>)
+
+**others**
+  * [[`592e518`](http://github.com/node-modules/compressing/commit/592e5180dfbdbc6cb1becd1baf6a007ce7b7cd39)] - Create codeql-analysis.yml (fengmk2 <<fengmk2@gmail.com>>)
+
+1.5.1 / 2020-05-11
+==================
+
+**fixes**
+  * [[`f516814`](http://github.com/node-modules/compressing/commit/f51681490aeea44a7b27ec0c09d3fb3d0385c5c0)] - fix: index.d.ts streamHeader.name wrong declearing (#46) (shadyzoz <<ShadyZOZ@users.noreply.github.com>>)
+
+1.5.0 / 2019-12-04
+==================
+
+**features**
+  * [[`15c29e9`](http://github.com/node-modules/compressing/commit/15c29e9893880d2c19c343d133edb50f0c55c713)] - feat: zip format support custom fileName encoding (#36) (fengmk2 <<fengmk2@gmail.com>>)
+
+**fixes**
+  * [[`7d605fe`](http://github.com/node-modules/compressing/commit/7d605fe01a88bc6aab9a2b06a8725545f591bab9)] - fix: typescript error(#29) (Ruanyq <<yiqiang0930@163.com>>)
+
+**others**
+  * [[`4808fb8`](http://github.com/node-modules/compressing/commit/4808fb8e1d6cbbb31c0e82c359ec04eccb0c1eaf)] - test: add node 11 (#20) (fengmk2 <<fengmk2@gmail.com>>)
+
 1.4.0 / 2018-11-30
 ==================
 

package/README.md

@@ -1,22 +1,13 @@
 # compressing
 
 [![NPM version][npm-image]][npm-url]
-[![build status][travis-image]][travis-url]
 [![Test coverage][codecov-image]][codecov-url]
-[![David deps][david-image]][david-url]
-[![Known Vulnerabilities][snyk-image]][snyk-url]
 [![npm download][download-image]][download-url]
 
 [npm-image]: https://img.shields.io/npm/v/compressing.svg?style=flat-square
 [npm-url]: https://npmjs.org/package/compressing
-[travis-image]: https://img.shields.io/travis/node-modules/compressing.svg?style=flat-square
-[travis-url]: https://travis-ci.org/node-modules/compressing
 [codecov-image]: https://codecov.io/gh/node-modules/compressing/branch/master/graph/badge.svg
 [codecov-url]: https://codecov.io/gh/node-modules/compressing
-[david-image]: https://img.shields.io/david/node-modules/compressing.svg?style=flat-square
-[david-url]: https://david-dm.org/node-modules/compressing
-[snyk-image]: https://snyk.io/test/npm/compressing/badge.svg?style=flat-square
-[snyk-url]: https://snyk.io/test/npm/compressing
 [download-image]: https://img.shields.io/npm/dm/compressing.svg?style=flat-square
 [download-url]: https://npmjs.org/package/compressing
 
@@ -88,7 +79,6 @@ const destStream = fs.createWriteStream('path/to/destination.gz');
 pump(sourceStream, gzipStream, destStream, handleError);
 ```
 
-
 ### Compress a dir
 
 Use tar as an example, tgz and zip is same as gzip.
@@ -167,8 +157,7 @@ compressing.tgz.uncompress(stream, 'path/to/destination/dir')
 .catch(handleError);
 ```
 
-**Note: tar, tgz and zip have the same uncompressing API as above: destination should be a path of a directory, while that of gzip is slightly different: destination must be a file or filestream.**
-
+__Note: tar, tgz and zip have the same uncompressing API as above: destination should be a path of a directory, while that of gzip is slightly different: destination must be a file or filestream.__
 
 And working with urllib is super easy. Let's download a tgz file and uncompress to a directory:
 
@@ -280,8 +269,14 @@ Use this API to uncompress a file. This is a convenient method, which wraps Unco
 Params
 
 - source {String|Buffer|Stream} - source to be uncompressed
-- dest {String|Stream} - uncompressing destination. When uncompressing tar, tgz and zip, it should be a directory path (eg. `/path/to/xx`). **When uncompressing gzip, it should be a file path or a writable stream.**
+- dest {String|Stream} - uncompressing destination. When uncompressing tar, tgz and zip, it should be a directory path (eg. `/path/to/xx`). __When uncompressing gzip, it should be a file path or a writable stream.__
 - opts {Object} - usually you don't need it
+  - opts.zipFileNameEncoding {String} - Only work on zip format, default is 'utf8'.
+    Major non-UTF8 encodings by languages:
+
+    - Korean: cp949, euc-kr
+    - Japanese: sjis (shift_jis), cp932, euc-jp
+    - Chinese: gbk, gb18030, gb2312, cp936, hkscs, big5, cp950
 
 ### FileStream
 
@@ -368,7 +363,15 @@ Due to the design of the .zip file format, it's impossible to interpret a .zip f
 
 Although the API is streaming style(try to keep it handy), it still loads all data into memory.
 
-https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api
+<https://github.com/thejoshwolfe/yauzl#no-streaming-unzip-api>
+<!-- GITCONTRIBUTOR_START -->
+
+## Contributors
 
+|[<img src="https://avatars.githubusercontent.com/u/456108?v=4" width="100px;"/><br/><sub><b>shaoshuai0102</b></sub>](https://github.com/shaoshuai0102)<br/>|[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/360661?v=4" width="100px;"/><br/><sub><b>popomore</b></sub>](https://github.com/popomore)<br/>|[<img src="https://avatars.githubusercontent.com/u/9692408?v=4" width="100px;"/><br/><sub><b>DiamondYuan</b></sub>](https://github.com/DiamondYuan)<br/>|[<img src="https://avatars.githubusercontent.com/u/13938334?v=4" width="100px;"/><br/><sub><b>bytemain</b></sub>](https://github.com/bytemain)<br/>|[<img src="https://avatars.githubusercontent.com/u/8382136?v=4" width="100px;"/><br/><sub><b>Ryqsky</b></sub>](https://github.com/Ryqsky)<br/>|
+| :---: | :---: | :---: | :---: | :---: | :---: |
+[<img src="https://avatars.githubusercontent.com/u/9857273?v=4" width="100px;"/><br/><sub><b>ShadyZOZ</b></sub>](https://github.com/ShadyZOZ)<br/>
 
+This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Mon Jun 13 2022 13:26:08 GMT+0800`.
 
+<!-- GITCONTRIBUTOR_END -->

package/index.d.ts

@@ -1,23 +1,33 @@
-import {ReadStream, WriteStream} from 'fs'
+import { ReadStream, WriteStream } from 'fs'
 
-type sourceType = string | Buffer | ReadStream;
+type sourceType = string | Buffer | ReadStream
 
-type destType = string | WriteStream;
+type destType = string | WriteStream
 
-type streamEntryOpts = {
-  relativePath?: string;
-  ignoreBase?: boolean;
-  size?: number;
+interface streamEntryOpts {
+  relativePath?: string
+  ignoreBase?: boolean
+  size?: number
 }
 
+interface streamHeader {
+  type: 'file' | 'directory',
+  name: string
+}
+
+interface streamHeaderWithMode {
+  type: 'file' | 'directory',
+  name: string
+  mode: number
+}
 
 export namespace gzip {
 
-  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function uncompress(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function uncompress(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  export class FileStream {
+  export class FileStream extends ReadStream {
 
     constructor(opts?: {
       zlib?: object,
@@ -26,14 +36,15 @@ export namespace gzip {
 
   }
 
-  export class UncompressStream {
+  export class UncompressStream extends WriteStream {
 
     constructor(opts?: {
       zlib?: object,
       source: sourceType
     });
 
-    on(event: 'error', cb: Function)
+    on(event: string, listener: (...args: any[]) => void): this
+    on(event: 'error', listener: (err: Error) => void): this
 
   }
 
@@ -41,22 +52,22 @@ export namespace gzip {
 
 export namespace tar {
 
-  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
+  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>
 
-  export class Stream {
+  export class Stream extends ReadStream {
 
     constructor();
 
-    addEntry(entry: string, opts?: streamEntryOpts);
+    addEntry(entry: string, opts?: streamEntryOpts): void
 
-    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts);
+    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void
   }
 
-  export class FileStream {
+  export class FileStream extends ReadStream {
 
     constructor(opts?: {
       relativePath?: string,
@@ -67,14 +78,16 @@ export namespace tar {
 
   }
 
-  export class UncompressStream {
+  export class UncompressStream extends WriteStream {
 
     constructor(opts?: {
       source: sourceType
     });
 
-
-    on(event: 'error', cb: Function)
+    on(event: string, listener: (...args: any[]) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: WriteStream, next: () => void) => void): this
+    on(event: 'finish', listener: () => void): this
+    on(event: 'error', listener: (err: Error) => void): this
 
   }
 
@@ -82,22 +95,22 @@ export namespace tar {
 
 export namespace tgz {
 
-  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
+  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>
 
-  export class Stream {
+  export class Stream extends ReadStream {
 
     constructor();
 
-    addEntry(entry: string, opts?: streamEntryOpts);
+    addEntry(entry: string, opts?: streamEntryOpts): void
 
-    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts);
+    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void
   }
 
-  export class FileStream {
+  export class FileStream extends ReadStream {
 
     constructor(opts?: {
       relativePath?: string,
@@ -109,14 +122,17 @@ export namespace tgz {
 
   }
 
-  export class UncompressStream {
+  export class UncompressStream extends WriteStream {
 
     constructor(opts?: {
       source?: sourceType,
       strip?: number
     });
 
-    on(event: 'entry' | 'finish' | 'error', cb: Function)
+    on(event: string, listener: (...args: any[]) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: WriteStream, next: () => void) => void): this
+    on(event: 'finish', listener: () => void): this
+    on(event: 'error', listener: (err: Error) => void): this
 
   }
 
@@ -124,22 +140,22 @@ export namespace tgz {
 
 export namespace zip {
 
-  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressFile(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>;
+  function compressDir(source: sourceType, dest: destType, opts?: any): Promise<void>
 
-  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>;
+  function uncompress(source: sourceType, dest: string, opts?: any): Promise<void>
 
-  export class Stream {
+  export class Stream extends ReadStream {
 
     constructor();
 
-    addEntry(entry: string, opts?: streamEntryOpts);
+    addEntry(entry: string, opts?: streamEntryOpts): void
 
-    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts);
+    addEntry(entry: Buffer | ReadStream, opts: streamEntryOpts): void
   }
 
-  export class FileStream {
+  export class FileStream extends ReadStream {
 
     /**
      *  If opts.source is a file path, opts.relativePath is optional, otherwise it's required.
@@ -148,26 +164,29 @@ export namespace zip {
      */
     constructor(opts?: {
       relativePath?: string,
-      yazl?: Object,
+      yazl?: object,
       source: string
     } | {
       relativePath: string,
-      yazl?: Object,
+      yazl?: object,
       source?: Buffer | ReadStream
     });
 
   }
 
-  export class UncompressStream {
+  export class UncompressStream extends WriteStream {
 
     constructor(opts?: {
       source?: sourceType,
-      strip?: number
+      strip?: number,
+      zipFileNameEncoding?: string
     });
 
-    on(event: 'entry' | 'finish' | 'error', cb: Function)
+    on(event: string, listener: (...args: any[]) => void): this
+    on(event: 'entry', listener: (header: streamHeaderWithMode, stream: WriteStream, next: () => void) => void): this
+    on(event: 'finish', listener: () => void): this
+    on(event: 'error', listener: (err: Error) => void): this
 
   }
 
 }
-

package/lib/zip/uncompress_stream.js

@@ -7,6 +7,9 @@ const stream = require('stream');
 const UncompressBaseStream = require('../base_write_stream');
 const utils = require('../utils');
 
+// lazy load iconv-lite
+let iconv;
+
 const YAUZL_CALLBACK = Symbol('ZipUncompressStream#yauzlCallback');
 const STRIP_NAME = Symbol('ZipUncompressStream#stripName');
 
@@ -15,6 +18,15 @@ const STRIP_NAME = Symbol('ZipUncompressStream#stripName');
 //  - support "absolute path"
 const DEFAULTS = { lazyEntries: true, decodeStrings: false };
 
+// from: https://github.com/microsoft/vscode/blob/c0769274fa136b45799edeccc0d0a2f645b75caf/src/vs/base/node/zip.ts#L51
+function modeFromEntry(entry) {
+  const attr = entry.externalFileAttributes >> 16 || 33188;
+
+  return [ 448 /* S_IRWXU */, 56 /* S_IRWXG */, 7 /* S_IRWXO */ ]
+    .map(mask => attr & mask)
+    .reduce((a, b) => a + b, attr & 61440 /* S_IFMT */);
+}
+
 class ZipUncompressStream extends UncompressBaseStream {
   constructor(opts) {
     opts = opts || {};
@@ -22,6 +34,10 @@ class ZipUncompressStream extends UncompressBaseStream {
 
     this._chunks = [];
     this._strip = Number(opts.strip) || 0;
+    this._zipFileNameEncoding = opts.zipFileNameEncoding || 'utf8';
+    if (this._zipFileNameEncoding === 'utf-8') {
+      this._zipFileNameEncoding = 'utf8';
+    }
 
     this[YAUZL_CALLBACK] = this[YAUZL_CALLBACK].bind(this);
 
@@ -70,11 +86,23 @@ class ZipUncompressStream extends UncompressBaseStream {
 
     zipFile
     .on('entry', entry => {
+      const mode = modeFromEntry(entry);
+      // fileName is buffer by default because decodeStrings = false
+      if (Buffer.isBuffer(entry.fileName)) {
+        if (this._zipFileNameEncoding === 'utf8') {
+          entry.fileName = entry.fileName.toString();
+        } else {
+          if (!iconv) {
+            iconv = require('iconv-lite');
+          }
+          entry.fileName = iconv.decode(entry.fileName, this._zipFileNameEncoding);
+        }
+      }
       // directory file names end with '/'
       const type = /\/$/.test(entry.fileName) ? 'directory' : 'file';
       const name = entry.fileName = this[STRIP_NAME](entry.fileName, type);
 
-      const header = { name, type, yauzl: entry };
+      const header = { name, type, yauzl: entry, mode };
 
       if (type === 'file') {
         zipFile.openReadStream(entry, (err, readStream) => {

package/package.json

@@ -1,13 +1,15 @@
 {
   "name": "compressing",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "Everything you need for compressing and uncompressing",
   "main": "index.js",
   "scripts": {
-    "test": "egg-bin test && tsc -p ./test/fixtures/types/tsconfig.json",
+    "contributor": "git-contributor",
+    "ts-test": "tsc -p ./test/fixtures/types/tsconfig.json",
+    "test": "egg-bin test && npm run ts-test",
     "cov": "egg-bin cov",
     "lint": "eslint .",
-    "ci": "npm run lint && npm run cov"
+    "ci": "npm run lint && npm run ts-test && npm run cov"
   },
   "repository": {
     "type": "git",
@@ -38,6 +40,7 @@
   "dependencies": {
     "flushwritable": "^1.0.0",
     "get-ready": "^1.0.0",
+    "iconv-lite": "^0.5.0",
     "mkdirp": "^0.5.1",
     "pump": "^3.0.0",
     "streamifier": "^0.1.1",
@@ -53,6 +56,7 @@
     "egg-ci": "^1.8.0",
     "eslint": "^3.10.2",
     "eslint-config-egg": "^3.2.0",
+    "git-contributor": "^1.1.0",
     "mm": "^2.0.0",
     "mz-modules": "^2.1.0",
     "power-assert": "^1.4.2",
@@ -64,7 +68,7 @@
     "node": ">= 4.0.0"
   },
   "ci": {
-    "version": "4, 6, 8, 10",
+    "version": "4, 6, 8, 10, 12",
     "license": {
       "year": "2017",
       "fullname": "node-modules and other contributors"