file-type 19.4.1 → 19.6.0

package/core.d.ts

@@ -165,6 +165,8 @@ export type FileExtension =
 	| 'icc'
 	| 'fbx'
 	| 'vsdx'
+	| 'vtt'
+	| 'apk'
 	; // eslint-disable-line semi-style
 
 export type MimeType =
@@ -212,9 +214,9 @@ export type MimeType =
 	| 'video/3gpp'
 	| 'audio/mpeg'
 	| 'audio/mp4' // RFC 4337
-	| 'audio/opus'
 	| 'video/ogg'
 	| 'audio/ogg'
+	| 'audio/ogg; codecs=opus'
 	| 'application/ogg'
 	| 'audio/x-flac'
 	| 'audio/ape'
@@ -270,6 +272,7 @@ export type MimeType =
 	| 'audio/x-musepack'
 	| 'text/calendar'
 	| 'text/vcard'
+	| 'text/vtt'
 	| 'model/gltf-binary'
 	| 'application/vnd.tcpdump.pcap'
 	| 'audio/x-dsf' // Non-standard
@@ -316,6 +319,7 @@ export type MimeType =
 	| 'application/vnd.iccprofile'
 	| 'application/x.autodesk.fbx'
 	| 'application/vnd.visio'
+	| 'application/vnd.android.package-archive'
 	; // eslint-disable-line semi-style
 
 export type FileTypeResult = {
@@ -489,7 +493,7 @@ export function fileTypeStream(webStream: AnyWebReadableStream<Uint8Array>, opti
 export declare class FileTypeParser {
 	detectors: Iterable<Detector>;
 
-	constructor(options?: {customDetectors?: Iterable<Detector>});
+	constructor(options?: {customDetectors?: Iterable<Detector>; signal: AbortSignal});
 
 	/**
 	Works the same way as {@link fileTypeFromBuffer}, additionally taking into account custom detectors (if any were provided to the constructor).

package/core.js

@@ -58,7 +58,9 @@ export async function fileTypeStream(webStream, options) {
 export class FileTypeParser {
 	constructor(options) {
 		this.detectors = options?.customDetectors;
-
+		this.tokenizerOptions = {
+			abortSignal: options?.signal,
+		};
 		this.fromTokenizer = this.fromTokenizer.bind(this);
 		this.fromBuffer = this.fromBuffer.bind(this);
 		this.parse = this.parse.bind(this);
@@ -92,7 +94,7 @@ export class FileTypeParser {
 			return;
 		}
 
-		return this.fromTokenizer(strtok3.fromBuffer(buffer));
+		return this.fromTokenizer(strtok3.fromBuffer(buffer, this.tokenizerOptions));
 	}
 
 	async fromBlob(blob) {
@@ -100,7 +102,7 @@ export class FileTypeParser {
 	}
 
 	async fromStream(stream) {
-		const tokenizer = await strtok3.fromWebStream(stream);
+		const tokenizer = await strtok3.fromWebStream(stream, this.tokenizerOptions);
 		try {
 			return await this.fromTokenizer(tokenizer);
 		} finally {
@@ -402,6 +404,13 @@ export class FileTypeParser {
 					zipHeader.filename = await tokenizer.readToken(new Token.StringType(zipHeader.filenameLength, 'utf-8'));
 					await tokenizer.ignore(zipHeader.extraFieldLength);
 
+					if (/classes\d*\.dex/.test(zipHeader.filename)) {
+						return {
+							ext: 'apk',
+							mime: 'application/vnd.android.package-archive',
+						};
+					}
+
 					// Assumes signed `.xpi` from addons.mozilla.org
 					if (zipHeader.filename === 'META-INF/mozilla.rsa') {
 						return {
@@ -527,7 +536,7 @@ export class FileTypeParser {
 			if (_check(type, [0x4F, 0x70, 0x75, 0x73, 0x48, 0x65, 0x61, 0x64])) {
 				return {
 					ext: 'opus',
-					mime: 'audio/opus',
+					mime: 'audio/ogg; codecs=opus',
 				};
 			}
 
@@ -1129,14 +1138,16 @@ export class FileTypeParser {
 			};
 		}
 
-		if (this.checkString('**ACE', {offset: 7})) {
-			await tokenizer.peekBuffer(this.buffer, {length: 14, mayBeLess: true});
-			if (this.checkString('**', {offset: 12})) {
-				return {
-					ext: 'ace',
-					mime: 'application/x-ace-compressed',
-				};
-			}
+		if (
+			this.checkString('WEBVTT')
+			&&	(
+				// One of LF, CR, tab, space, or end of file must follow "WEBVTT" per the spec (see `fixture/fixture-vtt-*.vtt` for examples). Note that `\0` is technically the null character (there is no such thing as an EOF character). However, checking for `\0` gives us the same result as checking for the end of the stream.
+				(['\n', '\r', '\t', ' ', '\0'].some(char7 => this.checkString(char7, {offset: 6}))))
+		) {
+			return {
+				ext: 'vtt',
+				mime: 'text/vtt',
+			};
 		}
 
 		// -- 8-byte signatures --
@@ -1420,6 +1431,14 @@ export class FileTypeParser {
 			};
 		}
 
+		// ACE: requires 14 bytes in the buffer
+		if (this.checkString('**ACE', {offset: 7}) && this.checkString('**', {offset: 12})) {
+			return {
+				ext: 'ace',
+				mime: 'application/x-ace-compressed',
+			};
+		}
+
 		// -- 15-byte signatures --
 
 		if (this.checkString('BEGIN:')) {

package/index.js

@@ -9,9 +9,9 @@ import {FileTypeParser, reasonableDetectionSizeInBytes} from './core.js';
 
 export class NodeFileTypeParser extends FileTypeParser {
 	async fromStream(stream) {
-		const tokenizer = await (stream instanceof WebReadableStream ? strtok3.fromWebStream(stream) : strtok3.fromStream(stream));
+		const tokenizer = await (stream instanceof WebReadableStream ? strtok3.fromWebStream(stream, this.tokenizerOptions) : strtok3.fromStream(stream, this.tokenizerOptions));
 		try {
-			return super.fromTokenizer(tokenizer);
+			return await super.fromTokenizer(tokenizer);
 		} finally {
 			await tokenizer.close();
 		}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "file-type",
-	"version": "19.4.1",
+	"version": "19.6.0",
 	"description": "Detect the file type of a file, stream, or data",
 	"license": "MIT",
 	"repository": "sindresorhus/file-type",
@@ -215,11 +215,13 @@
 		"avro",
 		"icc",
 		"fbx",
-		"vsdx"
+		"vsdx",
+		"vtt",
+		"apk"
 	],
 	"dependencies": {
 		"get-stream": "^9.0.1",
-		"strtok3": "^8.1.0",
+		"strtok3": "^9.0.1",
 		"token-types": "^6.0.0",
 		"uint8array-extras": "^1.3.0"
 	},

package/readme.md

@@ -367,6 +367,22 @@ const fileType = await parser.fromBuffer(buffer);
 console.log(fileType);
 ```
 
+## Abort signal
+
+Some async operations can be aborted by passing an [`AbortSignal`](https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal) to the `FileTypeParser` constructor.
+
+```js
+import {FileTypeParser} from 'file-type'; // or `NodeFileTypeParser` in Node.js
+
+const abortController = new AbortController()
+
+const parser = new FileTypeParser({abortSignal: abortController.signal});
+
+const promise = parser.fromStream(blob.stream());
+
+abortController.abort(); // Abort file-type reading from the Blob stream.
+```
+
 ## Supported file types
 
 - [`3g2`](https://en.wikipedia.org/wiki/3GP_and_3G2#3G2) - Multimedia container format defined by the 3GPP2 for 3G CDMA2000 multimedia services
@@ -382,6 +398,7 @@ console.log(fileType);
 - [`alias`](https://en.wikipedia.org/wiki/Alias_%28Mac_OS%29) - macOS Alias file
 - [`amr`](https://en.wikipedia.org/wiki/Adaptive_Multi-Rate_audio_codec) - Adaptive Multi-Rate audio codec
 - [`ape`](https://en.wikipedia.org/wiki/Monkey%27s_Audio) - Monkey's Audio
+- [`apk`](https://en.wikipedia.org/wiki/Apk_(file_format)) - Android package format
 - [`apng`](https://en.wikipedia.org/wiki/APNG) - Animated Portable Network Graphics
 - [`ar`](https://en.wikipedia.org/wiki/Ar_(Unix)) - Archive file
 - [`arj`](https://en.wikipedia.org/wiki/ARJ) - Archive file
@@ -507,6 +524,7 @@ console.log(fileType);
 - [`vcf`](https://en.wikipedia.org/wiki/VCard) - vCard
 - [`voc`](https://wiki.multimedia.cx/index.php/Creative_Voice) - Creative Voice File
 - [`vsdx`](https://en.wikipedia.org/wiki/Microsoft_Visio) - Microsoft Visio File
+- [`vtt`](https://en.wikipedia.org/wiki/WebVTT) - WebVTT File (for video captions)
 - [`wasm`](https://en.wikipedia.org/wiki/WebAssembly) - WebAssembly intermediate compiled format
 - [`wav`](https://en.wikipedia.org/wiki/WAV) - Waveform Audio file
 - [`webm`](https://en.wikipedia.org/wiki/WebM) - Web video file

package/supported.js

@@ -152,6 +152,8 @@ export const extensions = [
 	'icc',
 	'fbx',
 	'vsdx',
+	'vtt',
+	'apk',
 ];
 
 export const mimeTypes = [
@@ -199,9 +201,9 @@ export const mimeTypes = [
 	'video/3gpp',
 	'audio/mpeg',
 	'audio/mp4', // RFC 4337
-	'audio/opus',
 	'video/ogg',
 	'audio/ogg',
+	'audio/ogg; codecs=opus',
 	'application/ogg',
 	'audio/x-flac',
 	'audio/ape',
@@ -257,6 +259,7 @@ export const mimeTypes = [
 	'audio/x-musepack',
 	'text/calendar',
 	'text/vcard',
+	'text/vtt',
 	'model/gltf-binary',
 	'application/vnd.tcpdump.pcap',
 	'audio/x-dsf', // Non-standard
@@ -303,4 +306,5 @@ export const mimeTypes = [
 	'application/vnd.iccprofile',
 	'application/x.autodesk.fbx', // Invented by us
 	'application/vnd.visio',
+	'application/vnd.android.package-archive',
 ];