@xhmikosr/downloader 16.1.1 → 16.1.3

package/index.js

@@ -2,10 +2,9 @@ import events from 'node:events';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 import process from 'node:process';
-import contentDisposition from 'content-disposition';
+import {parse} from 'content-disposition';
 import archiveType from '@xhmikosr/archive-type';
 import decompress from '@xhmikosr/decompress';
-import defaults from 'defaults';
 import extName from 'ext-name';
 import {fileTypeFromBuffer} from 'file-type';
 import filenamify from 'filenamify';
@@ -26,7 +25,7 @@ const getExtFromMime = response => {
 		return null;
 	}
 
-	const exts = extName.mime(header);
+	const exts = extName.mime(header.split(';')[0].trim());
 
 	return exts.length === 1 ? exts[0].ext : null;
 };
@@ -35,7 +34,7 @@ const getFilename = async (response, data) => {
 	const header = response.headers['content-disposition'];
 
 	if (header) {
-		const parsed = contentDisposition.parse(header);
+		const parsed = parse(header);
 
 		if (parsed.parameters?.filename) {
 			return parsed.parameters.filename;
@@ -56,15 +55,27 @@ const getFilename = async (response, data) => {
 	return filename;
 };
 
-const filterEvents = async (name, listener) => {
-	for await (const [message] of events.on(name, listener)) {
+const filterEvents = async (emitter, event) => {
+	for await (const [message] of events.on(emitter, event)) {
 		if (message) {
 			return message;
 		}
 	}
 };
 
-const download = (uri, output, options) => {
+const mergeDefinedOptions = (defaults, overrides = {}) => {
+	const merged = {...defaults};
+
+	for (const [key, value] of Object.entries(overrides)) {
+		if (value !== undefined) {
+			merged[key] = value;
+		}
+	}
+
+	return merged;
+};
+
+const download = (uri, output, options = {}) => {
 	if (typeof output === 'object') {
 		options = output;
 		output = null;
@@ -72,36 +83,34 @@ const download = (uri, output, options) => {
 
 	options = {
 		...options,
-		got: defaults(options?.got, defaultGotOptions),
-		decompress: options?.decompress ?? {},
+		got: mergeDefinedOptions(defaultGotOptions, options.got),
+		decompress: options.decompress ?? {},
 	};
 
 	const stream = got.stream(uri, options.got);
 
-	const promise = filterEvents(stream, 'response')
-		.then(response => {
-			const streamData = options.got.responseType === 'buffer' ? getStreamAsBuffer(stream) : getStream(stream);
-			return Promise.all([streamData, response]);
-		})
-		.then(async ([data, response]) => {
-			const hasArchiveData = options.extract && await archiveType(data);
-
-			if (!output) {
-				return hasArchiveData ? decompress(data, options.decompress) : data;
-			}
-
-			const filename = options.filename || filenamify(await getFilename(response, data));
-			const outputFilepath = path.join(output, filename);
-
-			if (hasArchiveData) {
-				return decompress(data, path.dirname(outputFilepath), options.decompress);
-			}
-
-			return fs
-				.mkdir(path.dirname(outputFilepath), {recursive: true})
-				.then(() => fs.writeFile(outputFilepath, data))
-				.then(() => data);
-		});
+	const promise = (async () => {
+		const response = await filterEvents(stream, 'response');
+		const streamData = options.got.responseType === 'buffer' ? getStreamAsBuffer(stream) : getStream(stream);
+		const data = await streamData;
+
+		const hasArchiveData = options.extract && await archiveType(data);
+
+		if (!output) {
+			return hasArchiveData ? decompress(data, options.decompress) : data;
+		}
+
+		const filename = options.filename || filenamify(await getFilename(response, data));
+		const outputFilepath = path.join(output, filename);
+
+		if (hasArchiveData) {
+			return decompress(data, path.dirname(outputFilepath), options.decompress);
+		}
+
+		await fs.mkdir(path.dirname(outputFilepath), {recursive: true});
+		await fs.writeFile(outputFilepath, data);
+		return data;
+	})();
 
 	// eslint-disable-next-line unicorn/no-thenable
 	stream.then = promise.then.bind(promise);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@xhmikosr/downloader",
-	"version": "16.1.1",
+	"version": "16.1.3",
 	"description": "Download and extract files",
 	"license": "MIT",
 	"repository": {
@@ -43,21 +43,20 @@
 	],
 	"dependencies": {
 		"@xhmikosr/archive-type": "^8.0.1",
-		"@xhmikosr/decompress": "^11.1.1",
-		"content-disposition": "^1.0.1",
-		"defaults": "^2.0.2",
+		"@xhmikosr/decompress": "^11.1.3",
+		"content-disposition": "^2.0.1",
 		"ext-name": "^5.0.0",
-		"file-type": "^21.3.0",
+		"file-type": "^21.3.4",
 		"filenamify": "^7.0.1",
 		"get-stream": "^9.0.1",
 		"got": "^14.6.6"
 	},
 	"devDependencies": {
-		"@xhmikosr/decompress-unzip": "^8.1.0",
+		"@xhmikosr/decompress-unzip": "^8.1.1",
 		"ava": "^7.0.0",
 		"c8": "^11.0.0",
-		"nock": "^14.0.11",
-		"xo": "^1.2.3"
+		"nock": "^14.0.15",
+		"xo": "^2.0.2"
 	},
 	"xo": {
 		"rules": {

package/readme.md

@@ -1,17 +1,15 @@
-# download [![npm version](https://img.shields.io/npm/v/@xhmikosr/downloader?logo=npm&logoColor=fff)](https://www.npmjs.com/package/@xhmikosr/downloader) [![CI Status](https://img.shields.io/github/actions/workflow/status/XhmikosR/download/ci.yml?branch=master&label=CI&logo=github)](https://github.com/XhmikosR/download/actions/workflows/ci.yml?query=branch%3Amaster)
+# @xhmikosr/downloader [![npm version](https://img.shields.io/npm/v/@xhmikosr/downloader?logo=npm&logoColor=fff)](https://www.npmjs.com/package/@xhmikosr/downloader) [![CI Status](https://img.shields.io/github/actions/workflow/status/XhmikosR/download/ci.yml?branch=master&label=CI&logo=github)](https://github.com/XhmikosR/download/actions/workflows/ci.yml?query=branch%3Amaster)
 
 > Download and extract files
 
 *See [download-cli](https://github.com/kevva/download-cli) for the command-line version.*
 
-
 ## Install
 
 ```sh
 npm install @xhmikosr/downloader
 ```
 
-
 ## Usage
 
 ```js
@@ -23,25 +21,28 @@ import download from '@xhmikosr/downloader';
 
 	fs.writeFileSync('dist/foo.jpg', await download('http://unicorn.com/foo.jpg'));
 
-	download('unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
+	download('http://unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
 
 	await Promise.all([
-		'unicorn.com/foo.jpg',
-		'cats.com/dancing.gif'
+		'http://unicorn.com/foo.jpg',
+		'http://cats.com/dancing.gif'
 	].map(url => download(url, 'dist')));
 })();
 ```
 
 ### Proxies
 
-To work with proxies, read the [`got documentation`](https://github.com/sindresorhus/got#proxies).
+To work with proxies, read the [`got documentation`](https://github.com/sindresorhus/got/blob/main/documentation/tips.md#proxying).
+
+### SSL
 
+TLS certificate verification is enabled by default. It honors npm's [`strict-ssl`](https://docs.npmjs.com/cli/v11/using-npm/config#strict-ssl) config, so running `npm config set strict-ssl false` disables it for self-signed certificates or proxy setups. Override per call with [`options.got.https.rejectUnauthorized`]https://github.com/sindresorhus/got/blob/v14.6.6/documentation/5-https.md).
 
 ## API
 
 ### download(url, destination?, options?)
 
-Returns both a `Promise<Buffer>` and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with [additional events](https://github.com/sindresorhus/got#streams-1).
+Returns both a `Promise<Buffer>` and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex) with [additional events](https://github.com/sindresorhus/got/blob/main/documentation/3-streams.md#events).
 
 #### url
 
@@ -53,7 +54,7 @@ URL to download.
 
 Type: `string`
 
-Path to where your file will be written.
+Directory to save the file to.
 
 #### options
 
@@ -67,14 +68,14 @@ Same options as [`got`](https://github.com/sindresorhus/got#options).
 
 Same options as [`decompress`](https://github.com/XhmikosR/decompress#options).
 
-##### extract
+##### options.extract
 
 * Type: `boolean`
 * Default: `false`
 
 If set to `true`, try extracting the file using [`decompress`](https://github.com/XhmikosR/decompress).
 
-##### filename
+##### options.filename
 
 Type: `string`