file-type 19.4.0 → 19.5.0

package/core.d.ts

@@ -3,7 +3,7 @@ Typings for primary entry point, Node.js specific typings can be found in index.
 */
 
 import type {ReadableStream as WebReadableStream} from 'node:stream/web';
-import type {ITokenizer} from 'strtok3';
+import type {ITokenizer, AnyWebByteStream} from 'strtok3';
 
 /**
 Either the Node.js ReadableStream or the `lib.dom.d.ts` ReadableStream.
@@ -165,6 +165,7 @@ export type FileExtension =
 	| 'icc'
 	| 'fbx'
 	| 'vsdx'
+	| 'vtt'
 	; // eslint-disable-line semi-style
 
 export type MimeType =
@@ -270,6 +271,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
@@ -350,7 +352,7 @@ The file type is detected by checking the [magic number](https://en.wikipedia.or
 @param stream - A [web `ReadableStream`](https://developer.mozilla.org/en-US/docs/Web/API/ReadableStream) streaming a file to examine.
 @returns A `Promise` for an object with the detected file type, or `undefined` when there is no match.
 */
-export function fileTypeFromStream(stream: AnyWebReadableStream<Uint8Array>): Promise<FileTypeResult | undefined>;
+export function fileTypeFromStream(stream: AnyWebByteStream): Promise<FileTypeResult | undefined>;
 
 /**
 Detect the file type from an [`ITokenizer`](https://github.com/Borewit/strtok3#tokenizer) source.

package/core.js

@@ -51,8 +51,8 @@ export async function fileTypeFromTokenizer(tokenizer) {
 	return new FileTypeParser().fromTokenizer(tokenizer);
 }
 
-export async function fileTypeStream(webStream) {
-	return new FileTypeParser().toDetectionStream(webStream);
+export async function fileTypeStream(webStream, options) {
+	return new FileTypeParser(options).toDetectionStream(webStream, options);
 }
 
 export class FileTypeParser {
@@ -1139,6 +1139,18 @@ export class FileTypeParser {
 			}
 		}
 
+		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 --
 
 		if (this.check([0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A])) {

package/index.d.ts

@@ -3,6 +3,7 @@ Typings for Node.js specific entry point.
 */
 
 import type {Readable as NodeReadableStream} from 'node:stream';
+import type {AnyWebByteStream} from 'strtok3';
 import type {FileTypeResult, StreamOptions, AnyWebReadableStream, Detector, AnyWebReadableByteStreamWithFileType} from './core.js';
 import {FileTypeParser} from './core.js';
 
@@ -85,6 +86,6 @@ if (stream2.fileType?.mime === 'image/jpeg') {
 ```
 */
 export function fileTypeStream(readableStream: NodeReadableStream, options?: StreamOptions): Promise<ReadableStreamWithFileType>;
-export function fileTypeStream(webStream: AnyWebReadableStream<Uint8Array>, options?: StreamOptions): Promise<AnyWebReadableByteStreamWithFileType>;
+export function fileTypeStream(webStream: AnyWebByteStream, options?: StreamOptions): Promise<AnyWebReadableByteStreamWithFileType>;
 
 export * from './core.js';

package/index.js

@@ -3,7 +3,7 @@ Node.js specific entry point.
 */
 
 import {ReadableStream as WebReadableStream} from 'node:stream/web';
-import {pipeline, PassThrough} from 'node:stream';
+import {pipeline, PassThrough, Readable} from 'node:stream';
 import * as strtok3 from 'strtok3';
 import {FileTypeParser, reasonableDetectionSizeInBytes} from './core.js';
 
@@ -27,7 +27,7 @@ export class NodeFileTypeParser extends FileTypeParser {
 	}
 
 	async toDetectionStream(readableStream, options = {}) {
-		if (readableStream instanceof WebReadableStream) {
+		if (!(readableStream instanceof Readable)) {
 			return super.toDetectionStream(readableStream, options);
 		}
 

package/package.json

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

package/readme.md

@@ -507,6 +507,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,7 @@ export const extensions = [
 	'icc',
 	'fbx',
 	'vsdx',
+	'vtt',
 ];
 
 export const mimeTypes = [
@@ -257,6 +258,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