file-type 10.7.1 → 10.11.0

package/index.d.ts

@@ -0,0 +1,191 @@
+/// <reference types="node"/>
+import {Readable as ReadableStream} from 'stream';
+
+declare namespace fileType {
+	type FileType =
+		| 'jpg'
+		| 'png'
+		| 'gif'
+		| 'webp'
+		| 'flif'
+		| 'cr2'
+		| 'tif'
+		| 'bmp'
+		| 'jxr'
+		| 'psd'
+		| 'zip'
+		| 'tar'
+		| 'rar'
+		| 'gz'
+		| 'bz2'
+		| '7z'
+		| 'dmg'
+		| 'mp4'
+		| 'm4v'
+		| 'mid'
+		| 'mkv'
+		| 'webm'
+		| 'mov'
+		| 'avi'
+		| 'wmv'
+		| 'mpg'
+		| 'mp2'
+		| 'mp3'
+		| 'm4a'
+		| 'ogg'
+		| 'opus'
+		| 'flac'
+		| 'wav'
+		| 'qcp'
+		| 'amr'
+		| 'pdf'
+		| 'epub'
+		| 'mobi'
+		| 'exe'
+		| 'swf'
+		| 'rtf'
+		| 'woff'
+		| 'woff2'
+		| 'eot'
+		| 'ttf'
+		| 'otf'
+		| 'ico'
+		| 'flv'
+		| 'ps'
+		| 'xz'
+		| 'sqlite'
+		| 'nes'
+		| 'crx'
+		| 'xpi'
+		| 'cab'
+		| 'deb'
+		| 'ar'
+		| 'rpm'
+		| 'Z'
+		| 'lz'
+		| 'msi'
+		| 'mxf'
+		| 'mts'
+		| 'wasm'
+		| 'blend'
+		| 'bpg'
+		| 'docx'
+		| 'pptx'
+		| 'xlsx'
+		| '3gp'
+		| 'jp2'
+		| 'jpm'
+		| 'jpx'
+		| 'mj2'
+		| 'aif'
+		| 'odt'
+		| 'ods'
+		| 'odp'
+		| 'xml'
+		| 'heic'
+		| 'cur'
+		| 'ktx'
+		| 'ape'
+		| 'wv'
+		| 'asf'
+		| 'wma'
+		| 'wmv'
+		| 'dcm'
+		| 'mpc'
+		| 'ics'
+		| 'glb'
+		| 'pcap';
+
+	interface FileTypeResult {
+		/**
+		One of the supported [file types](https://github.com/sindresorhus/file-type#supported-file-types).
+		*/
+		ext: FileType;
+
+		/**
+		The detected [MIME type](https://en.wikipedia.org/wiki/Internet_media_type).
+		*/
+		mime: string;
+	}
+
+	type ReadableStreamWithFileType = ReadableStream & {
+		readonly fileType: FileTypeResult | null;
+	};
+}
+
+declare const fileType: {
+	/**
+	Detect the file type of a `Buffer`/`Uint8Array`/`ArrayBuffer`. The file type is detected by checking the [magic number](https://en.wikipedia.org/wiki/Magic_number_(programming)#Magic_numbers_in_files) of the buffer.
+
+	@param buffer - It only needs the first `.minimumBytes` bytes. The exception is detection of `docx`, `pptx`, and `xlsx` which potentially requires reading the whole file.
+	@returns An object with the detected file type and MIME type or `null` when there was no match.
+
+	@example
+	```
+	import readChunk = require('read-chunk');
+	import fileType = require('file-type');
+
+	const buffer = readChunk.sync('unicorn.png', 0, fileType.minimumBytes);
+
+	fileType(buffer);
+	//=> {ext: 'png', mime: 'image/png'}
+
+
+	// Or from a remote location:
+
+	import * as http from 'http';
+
+	const url = 'https://assets-cdn.github.com/images/spinners/octocat-spinner-32.gif';
+
+	http.get(url, response => {
+		response.on('readable', () => {
+			const chunk = response.read(fileType.minimumBytes);
+			response.destroy();
+			console.log(fileType(chunk));
+			//=> {ext: 'gif', mime: 'image/gif'}
+		});
+	});
+	```
+	*/
+	(buffer: Buffer | Uint8Array | ArrayBuffer): fileType.FileTypeResult | null;
+
+	/**
+	The minimum amount of bytes needed to detect a file type. Currently, it's 4100 bytes, but it can change, so don't hard-code it.
+	*/
+	readonly minimumBytes: number;
+
+	/**
+	Detect the file type of a readable stream.
+
+	@param readableStream - A readable stream containing a file to examine, see: [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable).
+	@returns A `Promise` which resolves to the original readable stream argument, but with an added `fileType` property, which is an object like the one returned from `fileType()`.
+
+	@example
+	```
+	import * as fs from 'fs';
+	import * as crypto from 'crypto';
+	import fileType = require('file-type');
+
+	(async () => {
+		const read = fs.createReadStream('encrypted.enc');
+		const decipher = crypto.createDecipheriv(alg, key, iv);
+
+		const stream = await fileType.stream(read.pipe(decipher));
+
+		console.log(stream.fileType);
+		//=> {ext: 'mov', mime: 'video/quicktime'}
+
+		const write = fs.createWriteStream(`decrypted.${stream.fileType.ext}`);
+		stream.pipe(write);
+	})();
+	```
+	*/
+	readonly stream: (
+		readableStream: ReadableStream
+	) => Promise<fileType.ReadableStreamWithFileType>;
+
+	// TODO: Remove this for the next major release
+	readonly default: typeof fileType;
+};
+
+export = fileType;

package/index.js

@@ -12,12 +12,13 @@ function readUInt64LE(buf, offset = 0) {
 		mul *= 0x100;
 		n += buf[offset + i] * mul;
 	}
+
 	return n;
 }
 
-module.exports = input => {
-	if (!(input instanceof Uint8Array || Buffer.isBuffer(input))) {
-		throw new TypeError(`Expected the \`input\` argument to be of type \`Uint8Array\` or \`Buffer\`, got \`${typeof input}\``);
+const fileType = input => {
+	if (!(input instanceof Uint8Array || input instanceof ArrayBuffer || Buffer.isBuffer(input))) {
+		throw new TypeError(`Expected the \`input\` argument to be of type \`Uint8Array\` or \`Buffer\` or \`ArrayBuffer\`, got \`${typeof input}\``);
 	}
 
 	const buf = input instanceof Uint8Array ? input : new Uint8Array(input);
@@ -344,12 +345,14 @@ module.exports = input => {
 				mime: 'video/vnd.avi'
 			};
 		}
+
 		if (check([0x57, 0x41, 0x56, 0x45], {offset: 8})) {
 			return {
 				ext: 'wav',
 				mime: 'audio/vnd.wave'
 			};
 		}
+
 		// QLCM, QCP file
 		if (check([0x51, 0x4C, 0x43, 0x4D], {offset: 8})) {
 			return {
@@ -386,6 +389,7 @@ module.exports = input => {
 
 				break;
 			}
+
 			offset += objectSize;
 		} while (offset + 24 <= buf.length);
 
@@ -454,8 +458,7 @@ module.exports = input => {
 	}
 
 	if (
-		check([0x66, 0x74, 0x79, 0x70, 0x4D, 0x34, 0x41], {offset: 4}) ||
-		check([0x4D, 0x34, 0x41, 0x20])
+		check([0x66, 0x74, 0x79, 0x70, 0x4D, 0x34, 0x41], {offset: 4})
 	) {
 		return { // MPEG-4 layer 3 (audio)
 			ext: 'm4a',
@@ -482,6 +485,7 @@ module.exports = input => {
 				mime: 'video/ogg'
 			};
 		}
+
 		// If '\x01video' in header.
 		if (check([0x01, 0x76, 0x69, 0x64, 0x65, 0x6F, 0x00], {offset: 28})) {
 			return {
@@ -489,6 +493,7 @@ module.exports = input => {
 				mime: 'video/ogg'
 			};
 		}
+
 		// If ' FLAC' in header  https://xiph.org/flac/faq.html
 		if (check([0x7F, 0x46, 0x4C, 0x41, 0x43], {offset: 28})) {
 			return {
@@ -908,7 +913,41 @@ module.exports = input => {
 		};
 	}
 
+	if (check([0xD4, 0xC3, 0xB2, 0xA1]) || check([0xA1, 0xB2, 0xC3, 0xD4])) {
+		return {
+			ext: 'pcap',
+			mime: 'application/vnd.tcpdump.pcap'
+		};
+	}
+
 	return null;
 };
 
-Object.defineProperty(module.exports, 'minimumBytes', {value: 4100});
+module.exports = fileType;
+// TODO: Remove this for the next major release
+module.exports.default = fileType;
+
+Object.defineProperty(fileType, 'minimumBytes', {value: 4100});
+
+module.exports.stream = readableStream => new Promise((resolve, reject) => {
+	// Using `eval` to work around issues when bundling with Webpack
+	const stream = eval('require')('stream'); // eslint-disable-line no-eval
+
+	readableStream.once('readable', () => {
+		const pass = new stream.PassThrough();
+		const chunk = readableStream.read(module.exports.minimumBytes) || readableStream.read();
+		try {
+			pass.fileType = fileType(chunk);
+		} catch (error) {
+			reject(error);
+		}
+
+		readableStream.unshift(chunk);
+
+		if (stream.pipeline) {
+			resolve(stream.pipeline(readableStream, pass, () => {}));
+		} else {
+			resolve(readableStream.pipe(pass));
+		}
+	});
+});

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "file-type",
-	"version": "10.7.1",
-	"description": "Detect the file type of a Buffer/Uint8Array",
+	"version": "10.11.0",
+	"description": "Detect the file type of a Buffer/Uint8Array/ArrayBuffer",
 	"license": "MIT",
 	"repository": "sindresorhus/file-type",
 	"author": {
@@ -13,10 +13,11 @@
 		"node": ">=6"
 	},
 	"scripts": {
-		"test": "xo && ava"
+		"test": "xo && ava && tsd"
 	},
 	"files": [
-		"index.js"
+		"index.js",
+		"index.d.ts"
 	],
 	"keywords": [
 		"mime",
@@ -116,11 +117,15 @@
 		"heic",
 		"wma",
 		"ics",
-		"glb"
+		"glb",
+		"pcap"
 	],
 	"devDependencies": {
-		"ava": "^1.0.1",
-		"read-chunk": "^3.0.0",
-		"xo": "^0.23.0"
+		"@types/node": "^11.12.2",
+		"ava": "^1.4.1",
+		"pify": "^4.0.1",
+		"read-chunk": "^3.2.0",
+		"tsd": "^0.7.1",
+		"xo": "^0.24.0"
 	}
 }

package/readme.md

@@ -1,8 +1,8 @@
 # file-type [![Build Status](https://travis-ci.org/sindresorhus/file-type.svg?branch=master)](https://travis-ci.org/sindresorhus/file-type)
 
-> Detect the file type of a Buffer/Uint8Array
+> Detect the file type of a Buffer/Uint8Array/ArrayBuffer
 
-The file type is detected by checking the [magic number](http://en.wikipedia.org/wiki/Magic_number_(programming)#Magic_numbers_in_files) of the buffer.
+The file type is detected by checking the [magic number](https://en.wikipedia.org/wiki/Magic_number_(programming)#Magic_numbers_in_files) of the buffer.
 
 
 ## Install
@@ -36,7 +36,7 @@ Or from a remote location:
 const http = require('http');
 const fileType = require('file-type');
 
-const url = 'http://assets-cdn.github.com/images/spinners/octocat-spinner-32.gif';
+const url = 'https://assets-cdn.github.com/images/spinners/octocat-spinner-32.gif';
 
 http.get(url, response => {
 	response.on('readable', () => {
@@ -48,6 +48,28 @@ http.get(url, response => {
 });
 ```
 
+Or from a stream:
+
+```js
+const fs = require('fs');
+const crypto = require('crypto');
+const fileType = require('file-type');
+
+(async () => {
+	const read = fs.createReadStream('encrypted.enc');
+	const decipher = crypto.createDecipheriv(alg, key, iv);
+
+	const stream = await fileType.stream(read.pipe(decipher));
+
+	console.log(stream.fileType);
+	//=> {ext: 'mov', mime: 'video/quicktime'}
+
+	const write = fs.createWriteStream(`decrypted.${stream.fileType.ext}`);
+	stream.pipe(write);
+})();
+```
+
+
 ##### Browser
 
 ```js
@@ -71,13 +93,13 @@ xhr.send();
 Returns an `Object` with:
 
 - `ext` - One of the [supported file types](#supported-file-types)
-- `mime` - The [MIME type](http://en.wikipedia.org/wiki/Internet_media_type)
+- `mime` - The [MIME type](https://en.wikipedia.org/wiki/Internet_media_type)
 
-Or `null` when no match.
+Or `null` when there is no match.
 
 #### input
 
-Type: `Buffer` `Uint8Array`
+Type: `Buffer | Uint8Array | ArrayBuffer`
 
 It only needs the first `.minimumBytes` bytes. The exception is detection of `docx`, `pptx`, and `xlsx` which potentially requires reading the whole file.
 
@@ -87,6 +109,18 @@ Type: `number`
 
 The minimum amount of bytes needed to detect a file type. Currently, it's 4100 bytes, but it can change, so don't hardcode it.
 
+### fileType.stream(readableStream)
+
+Detect the file type of a readable stream.
+
+Returns a `Promise` which resolves to the original readable stream argument, but with an added `fileType` property, which is an object like the one returned from `fileType()`.
+
+*Note:* This method is only for Node.js.
+
+#### readableStream
+
+Type: [`stream.Readable`](https://nodejs.org/api/stream.html#stream_class_stream_readable)
+
 
 ## Supported file types
 
@@ -95,7 +129,7 @@ The minimum amount of bytes needed to detect a file type. Currently, it's 4100 b
 - [`gif`](https://en.wikipedia.org/wiki/GIF)
 - [`webp`](https://en.wikipedia.org/wiki/WebP)
 - [`flif`](https://en.wikipedia.org/wiki/Free_Lossless_Image_Format)
-- [`cr2`](http://fileinfo.com/extension/cr2)
+- [`cr2`](https://fileinfo.com/extension/cr2)
 - [`tif`](https://en.wikipedia.org/wiki/Tagged_Image_File_Format)
 - [`bmp`](https://en.wikipedia.org/wiki/BMP_file_format)
 - [`jxr`](https://en.wikipedia.org/wiki/JPEG_XR)
@@ -141,14 +175,14 @@ The minimum amount of bytes needed to detect a file type. Currently, it's 4100 b
 - [`ps`](https://en.wikipedia.org/wiki/Postscript)
 - [`xz`](https://en.wikipedia.org/wiki/Xz)
 - [`sqlite`](https://www.sqlite.org/fileformat2.html)
-- [`nes`](http://fileinfo.com/extension/nes)
+- [`nes`](https://fileinfo.com/extension/nes)
 - [`crx`](https://developer.chrome.com/extensions/crx)
 - [`xpi`](https://en.wikipedia.org/wiki/XPInstall)
 - [`cab`](https://en.wikipedia.org/wiki/Cabinet_(file_format))
 - [`deb`](https://en.wikipedia.org/wiki/Deb_(file_format))
 - [`ar`](https://en.wikipedia.org/wiki/Ar_(Unix))
-- [`rpm`](http://fileinfo.com/extension/rpm)
-- [`Z`](http://fileinfo.com/extension/z)
+- [`rpm`](https://fileinfo.com/extension/rpm)
+- [`Z`](https://fileinfo.com/extension/z)
 - [`lz`](https://en.wikipedia.org/wiki/Lzip)
 - [`msi`](https://en.wikipedia.org/wiki/Windows_Installer)
 - [`mxf`](https://en.wikipedia.org/wiki/Material_Exchange_Format)
@@ -169,7 +203,7 @@ The minimum amount of bytes needed to detect a file type. Currently, it's 4100 b
 - [`ods`](https://en.wikipedia.org/wiki/OpenDocument) - OpenDocument for spreadsheets
 - [`odp`](https://en.wikipedia.org/wiki/OpenDocument) - OpenDocument for presentations
 - [`xml`](https://en.wikipedia.org/wiki/XML)
-- [`heic`](http://nokiatech.github.io/heif/technical.html)
+- [`heic`](https://nokiatech.github.io/heif/technical.html)
 - [`cur`](https://en.wikipedia.org/wiki/ICO_(file_format))
 - [`ktx`](https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/)
 - [`ape`](https://en.wikipedia.org/wiki/Monkey%27s_Audio) - Monkey's Audio
@@ -181,6 +215,7 @@ The minimum amount of bytes needed to detect a file type. Currently, it's 4100 b
 - [`mpc`](https://en.wikipedia.org/wiki/Musepack) - Musepack (SV7 & SV8)
 - [`ics`](https://en.wikipedia.org/wiki/ICalendar#Data_format) - iCalendar
 - [`glb`](https://github.com/KhronosGroup/glTF) - GL Transmission Format
+- [`pcap`](https://wiki.wireshark.org/Development/LibpcapFileFormat) - Libpcap File Format
 
 *SVG isn't included as it requires the whole file to be read, but you can get it [here](https://github.com/sindresorhus/is-svg).*