file-type 17.1.4 → 18.0.0

package/core.d.ts

@@ -1,5 +1,5 @@
 import {Readable as ReadableStream} from 'node:stream';
-import {ITokenizer} from 'strtok3/lib/core';
+import {ITokenizer} from 'strtok3';
 
 export type FileExtension =
 	| 'jpg'
@@ -364,7 +364,7 @@ export interface StreamOptions {
 }
 
 /**
-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.fromFile()`.
+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 `fileTypeFromFile()`.
 
 This method can be handy to put in between a stream, but it comes with a price.
 Internally `stream()` builds up a buffer of `sampleSize` bytes, used as a sample, to determine the file type.
@@ -375,7 +375,7 @@ A smaller sample size will result in lower probability of the best file type det
 **Note:** Requires Node.js 14 or later.
 
 @param readableStream - A [readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable) containing a file to examine.
-@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.fromFile()`.
+@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 `fileTypeFromFile()`.
 
 @example
 ```
@@ -387,7 +387,7 @@ const url = 'https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg';
 const stream1 = got.stream(url);
 const stream2 = await fileTypeStream(stream1, {sampleSize: 1024});
 
-if (stream2.fileType && stream2.fileType.mime === 'image/jpeg') {
+if (stream2.fileType?.mime === 'image/jpeg') {
 	// stream2 can be used to stream the JPEG image (from the very beginning of the stream)
 }
 ```

package/core.js

@@ -1,6 +1,6 @@
 import {Buffer} from 'node:buffer';
 import * as Token from 'token-types';
-import * as strtok3 from 'strtok3/core';
+import * as strtok3 from 'strtok3/core'; // eslint-disable-line n/file-extension-in-import
 import {
 	stringToBytes,
 	tarHeaderChecksumMatches,
@@ -26,7 +26,7 @@ export async function fileTypeFromBuffer(input) {
 
 	const buffer = input instanceof Uint8Array ? input : new Uint8Array(input);
 
-	if (!(buffer && buffer.length > 1)) {
+	if (!(buffer?.length > 1)) {
 		return;
 	}
 
@@ -146,6 +146,12 @@ class FileTypeParser {
 
 		// -- 3-byte signatures --
 
+		if (this.check([0xEF, 0xBB, 0xBF])) { // UTF-8-BOM
+			// Strip off UTF-8-BOM
+			this.tokenizer.ignore(3);
+			return this.parse(tokenizer);
+		}
+
 		if (this.check([0x47, 0x49, 0x46])) {
 			return {
 				ext: 'gif',
@@ -331,7 +337,8 @@ class FileTypeParser {
 					// - one entry indicating specific type of file.
 					// MS Office, OpenOffice and LibreOffice may put the parts in different order, so the check should not rely on it.
 					if (zipHeader.filename === 'mimetype' && zipHeader.compressedSize === zipHeader.uncompressedSize) {
-						const mimeType = (await tokenizer.readToken(new Token.StringType(zipHeader.compressedSize, 'utf-8'))).trim();
+						let mimeType = await tokenizer.readToken(new Token.StringType(zipHeader.compressedSize, 'utf-8'));
+						mimeType = mimeType.trim();
 
 						switch (mimeType) {
 							case 'application/epub+zip':
@@ -1016,13 +1023,6 @@ class FileTypeParser {
 			};
 		}
 
-		if (this.check([0xEF, 0xBB, 0xBF]) && this.checkString('<?xml', {offset: 3})) { // UTF-8-BOM
-			return {
-				ext: 'xml',
-				mime: 'application/xml',
-			};
-		}
-
 		// -- 9-byte signatures --
 
 		if (this.check([0x49, 0x49, 0x52, 0x4F, 0x08, 0x00, 0x00, 0x00, 0x18])) {
@@ -1160,14 +1160,15 @@ class FileTypeParser {
 			};
 		}
 
-		if (
-			this.check([0xFE, 0xFF, 0, 60, 0, 63, 0, 120, 0, 109, 0, 108]) // UTF-16-BOM-LE
-			|| this.check([0xFF, 0xFE, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0]) // UTF-16-BOM-LE
-		) {
-			return {
-				ext: 'xml',
-				mime: 'application/xml',
-			};
+		if (this.check([0xFE, 0xFF])) { // UTF-16-BOM-LE
+			if (this.check([0, 60, 0, 63, 0, 120, 0, 109, 0, 108], {offset: 2})) {
+				return {
+					ext: 'xml',
+					mime: 'application/xml',
+				};
+			}
+
+			return undefined; // Some unknown text based format
 		}
 
 		// -- Unsafe signatures --
@@ -1361,11 +1362,22 @@ class FileTypeParser {
 			};
 		}
 
-		if (this.check([0xFF, 0xFE, 0xFF, 0x0E, 0x53, 0x00, 0x6B, 0x00, 0x65, 0x00, 0x74, 0x00, 0x63, 0x00, 0x68, 0x00, 0x55, 0x00, 0x70, 0x00, 0x20, 0x00, 0x4D, 0x00, 0x6F, 0x00, 0x64, 0x00, 0x65, 0x00, 0x6C, 0x00])) {
-			return {
-				ext: 'skp',
-				mime: 'application/vnd.sketchup.skp',
-			};
+		if (this.check([0xFF, 0xFE])) { // UTF-16-BOM-BE
+			if (this.check([60, 0, 63, 0, 120, 0, 109, 0, 108, 0], {offset: 2})) {
+				return {
+					ext: 'xml',
+					mime: 'application/xml',
+				};
+			}
+
+			if (this.check([0xFF, 0x0E, 0x53, 0x00, 0x6B, 0x00, 0x65, 0x00, 0x74, 0x00, 0x63, 0x00, 0x68, 0x00, 0x55, 0x00, 0x70, 0x00, 0x20, 0x00, 0x4D, 0x00, 0x6F, 0x00, 0x64, 0x00, 0x65, 0x00, 0x6C, 0x00], {offset: 2})) {
+				return {
+					ext: 'skp',
+					mime: 'application/vnd.sketchup.skp',
+				};
+			}
+
+			return undefined; // Some text based format
 		}
 
 		if (this.checkString('-----BEGIN PGP MESSAGE-----')) {
@@ -1488,7 +1500,6 @@ class FileTypeParser {
 }
 
 export async function fileTypeStream(readableStream, {sampleSize = minimumBytes} = {}) {
-	// eslint-disable-next-line node/no-unsupported-features/es-syntax
 	const {default: stream} = await import('node:stream');
 
 	return new Promise((resolve, reject) => {
@@ -1502,7 +1513,7 @@ export async function fileTypeStream(readableStream, {sampleSize = minimumBytes}
 					const outputStream = stream.pipeline ? stream.pipeline(readableStream, pass, () => {}) : readableStream.pipe(pass);
 
 					// Read the input stream and detect the filetype
-					const chunk = readableStream.read(sampleSize) || readableStream.read() || Buffer.alloc(0);
+					const chunk = readableStream.read(sampleSize) ?? readableStream.read() ?? Buffer.alloc(0);
 					try {
 						const fileType = await fileTypeFromBuffer(chunk);
 						pass.fileType = fileType;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "file-type",
-	"version": "17.1.4",
+	"version": "18.0.0",
 	"description": "Detect the file type of a Buffer/Uint8Array/ArrayBuffer",
 	"license": "MIT",
 	"repository": "sindresorhus/file-type",
@@ -19,7 +19,7 @@
 		"./core": "./core.js"
 	},
 	"engines": {
-		"node": "^12.20.0 || ^14.13.1 || >=16.0.0"
+		"node": ">=14.16"
 	},
 	"scripts": {
 		"test": "xo && ava && tsd"
@@ -197,18 +197,17 @@
 	],
 	"dependencies": {
 		"readable-web-to-node-stream": "^3.0.2",
-		"strtok3": "^7.0.0-alpha.9",
-		"token-types": "^5.0.0-alpha.2"
+		"strtok3": "^7.0.0",
+		"token-types": "^5.0.1"
 	},
 	"devDependencies": {
 		"@tokenizer/token": "^0.3.0",
-		"@types/node": "^16.11.10",
-		"ava": "^3.15.0",
+		"@types/node": "^18.7.13",
+		"ava": "^4.3.1",
 		"commonmark": "^0.30.0",
 		"noop-stream": "^1.0.0",
-		"tsd": "^0.19.0",
-		"typescript": "^4.5.2",
-		"xo": "^0.46.4"
+		"tsd": "^0.22.0",
+		"xo": "^0.51.0"
 	},
 	"xo": {
 		"envs": [
@@ -219,11 +218,11 @@
 			"no-inner-declarations": "warn",
 			"no-await-in-loop": "warn",
 			"no-bitwise": "off",
-			"@typescript-eslint/no-unsafe-assignment": "off"
+			"@typescript-eslint/no-unsafe-assignment": "off",
+			"unicorn/text-encoding-identifier-case": "off"
 		}
 	},
 	"ava": {
-		"serial": true,
-		"verbose": true
+		"serial": true
 	}
 }

package/readme.md

@@ -141,7 +141,7 @@ Detect the file type of a `Buffer`, `Uint8Array`, or `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.
 
-If file access is available, it is recommended to use `FileType.fromFile()` instead.
+If file access is available, it is recommended to use `fileTypeFromFile()` instead.
 
 Returns a `Promise` for an object with the detected file type and MIME type:
 
@@ -282,7 +282,7 @@ A file source implementing the [tokenizer interface](https://github.com/Borewit/
 
 ### fileTypeStream(readableStream, options?)
 
-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.fromFile()`.
+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 `fileTypeFromFile()`.
 
 This method can be handy to put in between a stream, but it comes with a price.
 Internally `stream()` builds up a buffer of `sampleSize` bytes, used as a sample, to determine the file type.
@@ -318,7 +318,7 @@ const url = 'https://upload.wikimedia.org/wikipedia/en/a/a9/Example.jpg';
 const stream1 = got.stream(url);
 const stream2 = await fileTypeStream(stream1, {sampleSize: 1024});
 
-if (stream2.fileType && stream2.fileType.mime === 'image/jpeg') {
+if (stream2.fileType?.mime === 'image/jpeg') {
 	// stream2 can be used to stream the JPEG image (from the very beginning of the stream)
 }
 ```

package/util.js

@@ -1,5 +1,5 @@
 export function stringToBytes(string) {
-	return [...string].map(character => character.charCodeAt(0));
+	return [...string].map(character => character.charCodeAt(0)); // eslint-disable-line unicorn/prefer-code-point
 }
 
 /**
@@ -17,12 +17,12 @@ export function tarHeaderChecksumMatches(buffer, offset = 0) {
 
 	let sum = 8 * 0x20; // Initialize signed bit sum
 
-	for (let i = offset; i < offset + 148; i++) {
-		sum += buffer[i];
+	for (let index = offset; index < offset + 148; index++) {
+		sum += buffer[index];
 	}
 
-	for (let i = offset + 156; i < offset + 512; i++) {
-		sum += buffer[i];
+	for (let index = offset + 156; index < offset + 512; index++) {
+		sum += buffer[index];
 	}
 
 	return readSum === sum;