@xhmikosr/downloader 9.0.0

package/index.js

@@ -0,0 +1,100 @@
+import {promises as fs} from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import contentDisposition from 'content-disposition';
+import archiveType from 'archive-type';
+import decompress from '@xhmikosr/decompress';
+import filenamify from 'filenamify';
+import getStream from 'get-stream';
+import got from 'got';
+import {pEvent} from 'p-event';
+import fileType from 'file-type';
+import extName from 'ext-name';
+
+const filenameFromPath = res => path.basename(new URL(res.requestUrl).pathname);
+
+const getExtFromMime = res => {
+	const header = res.headers['content-type'];
+
+	if (!header) {
+		return null;
+	}
+
+	const exts = extName.mime(header);
+
+	if (exts.length !== 1) {
+		return null;
+	}
+
+	return exts[0].ext;
+};
+
+const getFilename = (res, data) => {
+	const header = res.headers['content-disposition'];
+
+	if (header) {
+		const parsed = contentDisposition.parse(header);
+
+		if (parsed.parameters && parsed.parameters.filename) {
+			return parsed.parameters.filename;
+		}
+	}
+
+	let filename = filenameFromPath(res);
+
+	if (!path.extname(filename)) {
+		const ext = (fileType(data) || {}).ext || getExtFromMime(res);
+
+		if (ext) {
+			filename = `${filename}.${ext}`;
+		}
+	}
+
+	return filename;
+};
+
+const download = (uri, output, options) => {
+	if (typeof output === 'object') {
+		options = output;
+		output = null;
+	}
+
+	options = {
+		responseType: 'buffer',
+		https: {
+			rejectUnauthorized: process.env.npm_config_strict_ssl !== 'false',
+		},
+		...options,
+	};
+
+	const stream = got.stream(uri, options);
+
+	const promise = pEvent(stream, 'response').then(res => {
+		const encoding = options.responseType === 'buffer' ? 'buffer' : options.encoding;
+		return Promise.all([getStream(stream, {encoding}), res]);
+	}).then(result => {
+		const [data, res] = result;
+
+		if (!output) {
+			return options.extract && archiveType(data) ? decompress(data, options) : data;
+		}
+
+		const filename = options.filename || filenamify(getFilename(res, data));
+		const outputFilepath = path.join(output, filename);
+
+		if (options.extract && archiveType(data)) {
+			return decompress(data, path.dirname(outputFilepath), options);
+		}
+
+		return fs.mkdir(path.dirname(outputFilepath), {recursive: true})
+			.then(() => fs.writeFile(outputFilepath, data))
+			.then(() => data);
+	});
+
+	stream.then = promise.then.bind(promise); // eslint-disable-line unicorn/no-thenable
+	stream.catch = promise.catch.bind(promise);
+
+	return stream;
+};
+
+export default download;

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Kevin Mårtensson <kevinmartensson@gmail.com> (github.com/kevva)
+
+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/package.json

@@ -0,0 +1,70 @@
+{
+	"name": "@xhmikosr/downloader",
+	"version": "9.0.0",
+	"description": "Download and extract files",
+	"license": "MIT",
+	"repository": "XhmikosR/download",
+	"publishConfig": {
+		"access": "public"
+	},
+	"author": {
+		"email": "kevinmartensson@gmail.com",
+		"name": "Kevin Mårtensson",
+		"url": "github.com/kevva"
+	},
+	"engines": {
+		"node": "^12.20.0 || ^14.14.0 || >=16.0.0"
+	},
+	"scripts": {
+		"ava": "ava",
+		"xo": "xo",
+		"test": "npm run xo && npm run ava",
+		"test-ci": "npm run xo && c8 ava"
+	},
+	"main": "index.js",
+	"type": "module",
+	"exports": {
+		".": "./index.js"
+	},
+	"files": [
+		"index.js"
+	],
+	"keywords": [
+		"download",
+		"extract",
+		"http",
+		"request",
+		"url"
+	],
+	"c8": {
+		"reporter": [
+			"lcovonly",
+			"text"
+		]
+	},
+	"dependencies": {
+		"@xhmikosr/decompress": "^5.0.0",
+		"archive-type": "^4.0.0",
+		"content-disposition": "^0.5.4",
+		"ext-name": "^5.0.0",
+		"file-type": "^12.4.2",
+		"filenamify": "^5.1.1",
+		"get-stream": "^6.0.1",
+		"got": "^11.8.5",
+		"p-event": "^5.0.1"
+	},
+	"devDependencies": {
+		"ava": "^4.3.0",
+		"c8": "^7.11.3",
+		"is-zip": "^1.0.0",
+		"nock": "^13.2.6",
+		"path-exists": "^5.0.0",
+		"random-buffer": "^0.1.0",
+		"xo": "^0.49.0"
+	},
+	"xo": {
+		"rules": {
+			"unicorn/prevent-abbreviations": "off"
+		}
+	}
+}

package/readme.md

@@ -0,0 +1,75 @@
+# download [![CI](https://github.com/XhmikosR/download/actions/workflows/ci.yml/badge.svg)](https://github.com/XhmikosR/download/actions/workflows/ci.yml)
+
+> 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
+import fs from 'node:fs';
+import download from '@xhmikosr/downloader';
+
+(async () => {
+	await download('http://unicorn.com/foo.jpg', 'dist');
+
+	fs.writeFileSync('dist/foo.jpg', await download('http://unicorn.com/foo.jpg'));
+
+	download('unicorn.com/foo.jpg').pipe(fs.createWriteStream('dist/foo.jpg'));
+
+	await Promise.all([
+		'unicorn.com/foo.jpg',
+		'cats.com/dancing.gif'
+	].map(url => download(url, 'dist')));
+})();
+```
+
+### Proxies
+
+To work with proxies, read the [`got documentation`](https://github.com/sindresorhus/got#proxies).
+
+
+## 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).
+
+#### url
+
+Type: `string`
+
+URL to download.
+
+#### destination
+
+Type: `string`
+
+Path to where your file will be written.
+
+#### options
+
+Type: `Object`
+
+Same options as [`got`](https://github.com/sindresorhus/got#options) and [`decompress`](https://github.com/XhmikosR/decompress#options) in addition to the ones below.
+
+##### extract
+
+* Type: `boolean`
+* Default: `false`
+
+If set to `true`, try extracting the file using [`decompress`](https://github.com/XhmikosR/decompress).
+
+##### filename
+
+Type: `string`
+
+Name of the saved file.