@anmiles/downloader 2.0.5 → 2.1.0

package/CHANGELOG.md

@@ -5,6 +5,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.1.0](../../tags/v2.1.0) - 2023-08-23
+### Added
+- Append mode for file stream
+
+## [2.0.6](../../tags/v2.0.6) - 2023-05-26
+### Changed
+- Re-initialize emitter instance before each test
+
 ## [2.0.5](../../tags/v2.0.5) - 2023-05-08
 ### Changed
 - Use shared eslint config * explicitly specify ignorePatterns

package/README.md

@@ -20,6 +20,11 @@ import { download } from '@anmiles/downloader';
 await download('http://url/file', '/path/to/file');
 ```
 
+```js
+import { download } from '@anmiles/downloader';
+await download('http://url/file', '/path/to/file', { append: true });
+```
+
 ```js
 import { downloadString } from '@anmiles/downloader';
 const str = downloadString('http://url/string');

package/dist/lib/downloader.d.ts

@@ -8,6 +8,8 @@ declare const _default: {
 export default _default;
 type BufferEncoding = Parameters<Buffer['toString']>[0];
 declare function download(url: string): Promise<Buffer>;
-declare function download(url: string, file: string): Promise<void>;
+declare function download(url: string, file: string, options?: {
+    append?: boolean;
+}): Promise<void>;
 declare function downloadString(url: string, encoding?: BufferEncoding): Promise<string>;
 declare function downloadJSON(url: string, encoding?: BufferEncoding): Promise<any>;

package/dist/lib/downloader.js

@@ -10,7 +10,7 @@ const https_1 = __importDefault(require("https"));
 const iconv_lite_1 = __importDefault(require("iconv-lite"));
 const downloader_1 = __importDefault(require("./downloader"));
 exports.default = { download, downloadString, downloadJSON };
-function download(url, file) {
+function download(url, file, options) {
     return new Promise((resolve, reject) => {
         let protocol;
         if (url.startsWith('https://')) {
@@ -22,12 +22,12 @@ function download(url, file) {
         else {
             throw `Unknown protocol in url ${url}, expected one of "http" or "https"`;
         }
-        const options = {
+        const reqOptions = {
             headers: {
                 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36',
             },
         };
-        protocol.get(url, options, function (res) {
+        protocol.get(url, reqOptions, function (res) {
             if (res.statusCode !== 200) {
                 reject(`Request to ${url} returned with status code: ${res.statusCode}`);
                 res.resume();
@@ -42,7 +42,7 @@ function download(url, file) {
                 });
             }
             else {
-                res.pipe(fs_1.default.createWriteStream(file));
+                res.pipe(fs_1.default.createWriteStream(file, { flags: (options === null || options === void 0 ? void 0 : options.append) ? 'a' : 'w' }));
                 res.on('end', function () {
                     resolve();
                 });

package/dist/lib/downloader.js.map

@@ -1 +1 @@
-{"version":3,"file":"downloader.js","sourceRoot":"","sources":["../../src/lib/downloader.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,4DAA+B;AAE/B,8DAAsC;AAGtC,kBAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;AAM1D,SAAS,QAAQ,CAAC,GAAW,EAAE,IAAa;IAC3C,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,IAAI,QAAqC,CAAC;QAE1C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,QAAQ,GAAG,eAAK,CAAC;SACjB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACrC,QAAQ,GAAG,cAAI,CAAC;SAChB;aAAM;YACN,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;SAC1E;QAED,MAAM,OAAO,GAAG;YACf,OAAO,EAAG;gBACT,YAAY,EAAG,iHAAiH;aAChI;SACD,CAAC;QAEF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,EAAE,UAAS,GAAG;YACtC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,MAAM,CAAC,cAAc,GAAG,+BAA+B,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;gBACzE,GAAG,CAAC,MAAM,EAAE,CAAC;aACb;YAED,MAAM,MAAM,GAAiB,EAAE,CAAC;YAEhC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAS,KAAK;oBAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;gBAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACH;iBAAM;gBACN,GAAG,CAAC,IAAI,CAAC,YAAE,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;gBAErC,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,EAAE,CAAC;gBACX,CAAC,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACpB,MAAM,CAAC,cAAc,GAAG,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AApDQ,4BAAQ;AAsDjB,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,WAA2B,MAAM;IAC3E,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACjC,MAAM,oBAAoB,QAAQ,EAAE,CAAC;KACrC;IAED,MAAM,MAAM,GAAG,MAAM,oBAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,oBAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AA7DkB,wCAAc;AA+DjC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,WAA2B,MAAM;IACzE,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAlEkC,oCAAY"}
+{"version":3,"file":"downloader.js","sourceRoot":"","sources":["../../src/lib/downloader.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AACpB,gDAAwB;AACxB,kDAA0B;AAC1B,4DAA+B;AAE/B,8DAAsC;AAGtC,kBAAe,EAAE,QAAQ,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC;AAM1D,SAAS,QAAQ,CAAC,GAAW,EAAE,IAAa,EAAE,OAA8B;IAC3E,OAAO,IAAI,OAAO,CAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrD,IAAI,QAAqC,CAAC;QAE1C,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE;YAC/B,QAAQ,GAAG,eAAK,CAAC;SACjB;aAAM,IAAI,GAAG,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE;YACrC,QAAQ,GAAG,cAAI,CAAC;SAChB;aAAM;YACN,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;SAC1E;QAED,MAAM,UAAU,GAAG;YAClB,OAAO,EAAG;gBACT,YAAY,EAAG,iHAAiH;aAChI;SACD,CAAC;QAEF,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,UAAU,EAAE,UAAS,GAAG;YACzC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC3B,MAAM,CAAC,cAAc,GAAG,+BAA+B,GAAG,CAAC,UAAU,EAAE,CAAC,CAAC;gBACzE,GAAG,CAAC,MAAM,EAAE,CAAC;aACb;YAED,MAAM,MAAM,GAAiB,EAAE,CAAC;YAEhC,IAAI,OAAO,IAAI,KAAK,WAAW,EAAE;gBAChC,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAS,KAAK;oBAC5B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;gBAEH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;aACH;iBAAM;gBACN,GAAG,CAAC,IAAI,CAAC,YAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,EAAE,KAAK,EAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;gBAE9E,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACb,OAAO,EAAE,CAAC;gBACX,CAAC,CAAC,CAAC;aACH;QACF,CAAC,CAAC,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE;YACpB,MAAM,CAAC,cAAc,GAAG,uBAAuB,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QAC7D,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;AACJ,CAAC;AApDQ,4BAAQ;AAsDjB,KAAK,UAAU,cAAc,CAAC,GAAW,EAAE,WAA2B,MAAM;IAC3E,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE;QACjC,MAAM,oBAAoB,QAAQ,EAAE,CAAC;KACrC;IAED,MAAM,MAAM,GAAG,MAAM,oBAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC9C,OAAO,oBAAK,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACvC,CAAC;AA7DkB,wCAAc;AA+DjC,KAAK,UAAU,YAAY,CAAC,GAAW,EAAE,WAA2B,MAAM;IACzE,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,cAAc,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC5D,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACzB,CAAC;AAlEkC,oCAAY"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@anmiles/downloader",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "description": "Wrapper for downloading data as string, buffer or complex types",
   "keywords": [
     "download",

package/src/lib/__tests__/downloader.test.ts

@@ -12,10 +12,8 @@ jest.mock<Partial<typeof downloader>>('../downloader', () => ({
 	downloadString : jest.fn().mockImplementation((...args: Parameters<typeof original.downloadString>) => original.downloadString(...args)),
 }));
 
-const request   = emitter() as http.ClientRequest;
-const response  = emitter() as http.IncomingMessage;
-response.pipe   = jest.fn();
-response.resume = jest.fn();
+let request: http.ClientRequest;
+let response: http.IncomingMessage;
 
 function get(url: string | URL, options: https.RequestOptions, callback?: ((res: http.IncomingMessage) => void) | undefined): http.ClientRequest {
 	if (callback) {
@@ -26,6 +24,12 @@ function get(url: string | URL, options: https.RequestOptions, callback?: ((res:
 }
 
 beforeEach(() => {
+	request  = emitter() as typeof request;
+	response = emitter() as typeof response;
+
+	response.pipe   = jest.fn();
+	response.resume = jest.fn();
+
 	response.statusCode = 200;
 });
 
@@ -100,7 +104,7 @@ describe('src/lib/downloader', () => {
 			expect(result).toEqual(Buffer.from([ 10, 11, 12, 20, 21, 22, 30, 31, 32 ]));
 		});
 
-		it('should pipe response stream to file if specified', async () => {
+		it('should pipe response stream to file if specified with write mode', async () => {
 			const stream               = {} as fs.WriteStream;
 			const createWriteStreamSpy = jest.spyOn(fs, 'createWriteStream').mockReturnValue(stream);
 			const promise              = original.download('http://url', 'file');
@@ -109,7 +113,22 @@ describe('src/lib/downloader', () => {
 			response.emit('data', new Uint8Array([ 30, 31, 32 ]));
 			response.emit('end');
 			const result = await promise;
-			expect(createWriteStreamSpy).toHaveBeenCalledWith('file');
+			expect(createWriteStreamSpy).toHaveBeenCalledWith('file', { flags : 'w' });
+			expect(response.pipe).toHaveBeenCalledWith(stream);
+			expect(result).toEqual(undefined);
+			createWriteStreamSpy.mockRestore();
+		});
+
+		it('should pipe response stream to file if specified with append mode', async () => {
+			const stream               = {} as fs.WriteStream;
+			const createWriteStreamSpy = jest.spyOn(fs, 'createWriteStream').mockReturnValue(stream);
+			const promise              = original.download('http://url', 'file', { append : true });
+			response.emit('data', new Uint8Array([ 10, 11, 12 ]));
+			response.emit('data', new Uint8Array([ 20, 21, 22 ]));
+			response.emit('data', new Uint8Array([ 30, 31, 32 ]));
+			response.emit('end');
+			const result = await promise;
+			expect(createWriteStreamSpy).toHaveBeenCalledWith('file', { flags : 'a' });
 			expect(response.pipe).toHaveBeenCalledWith(stream);
 			expect(result).toEqual(undefined);
 			createWriteStreamSpy.mockRestore();

package/src/lib/downloader.ts

@@ -11,8 +11,8 @@ export default { download, downloadString, downloadJSON };
 type BufferEncoding = Parameters<Buffer['toString']>[0];
 
 function download(url: string): Promise<Buffer>;
-function download(url: string, file: string): Promise<void>;
-function download(url: string, file?: string): Promise<Buffer | void> {
+function download(url: string, file: string, options?: { append?: boolean }): Promise<void>;
+function download(url: string, file?: string, options?: { append?: boolean }): Promise<Buffer | void> {
 	return new Promise<Buffer | void>((resolve, reject) => {
 		let protocol : typeof https | typeof http;
 
@@ -24,13 +24,13 @@ function download(url: string, file?: string): Promise<Buffer | void> {
 			throw `Unknown protocol in url ${url}, expected one of "http" or "https"`;
 		}
 
-		const options = {
+		const reqOptions = {
 			headers : {
 				'User-Agent' : 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36',
 			},
 		};
 
-		protocol.get(url, options, function(res) {
+		protocol.get(url, reqOptions, function(res) {
 			if (res.statusCode !== 200) {
 				reject(`Request to ${url} returned with status code: ${res.statusCode}`);
 				res.resume();
@@ -47,7 +47,7 @@ function download(url: string, file?: string): Promise<Buffer | void> {
 					resolve(Buffer.concat(chunks));
 				});
 			} else {
-				res.pipe(fs.createWriteStream(file));
+				res.pipe(fs.createWriteStream(file, { flags : options?.append ? 'a' : 'w' }));
 
 				res.on('end', function() {
 					resolve();