file-type 20.0.1 → 20.2.0

package/core.d.ts

@@ -116,13 +116,28 @@ export declare function fileTypeFromBlob(blob: Blob): Promise<FileTypeResult | u
 /**
 A custom file type detector.
 
+Custom file type detectors are plugins designed to extend the default detection capabilities.
+They allow support for uncommon file types, non-binary formats, or customized detection behavior.
+
+Detectors can be added via the constructor options or by modifying `FileTypeParser#detectors` directly.
+Detectors provided through the constructor are executed before the default ones.
+
 Detectors can be added via the constructor options or by directly modifying `FileTypeParser#detectors`.
 
-Detectors provided through the constructor options are executed before the default detectors.
+### Example adding a detector
+
+```js
+import {FileTypeParser} from 'file-type';
+import {detectXml} from '@file-type/xml';
+
+const parser = new FileTypeParser({customDetectors: [detectXml]});
+const fileType = await parser.fromFile('sample.kml');
+console.log(fileType);
+```
+
+### Available-third party file-type detectors
 
-Custom detectors allow for:
-- Introducing new `FileTypeResult` entries.
-- Modifying the detection behavior of existing `FileTypeResult` types.
+- [@file-type/xml](https://github.com/Borewit/file-type-xml): Detects common XML file types, such as GLM, KML, MusicXML, RSS, SVG, and XHTML
 
 ### Detector execution flow
 
@@ -131,7 +146,7 @@ If a detector returns `undefined`, the following rules apply:
 1. **No Tokenizer Interaction**: If the detector does not modify the tokenizer's position, the next detector in the sequence is executed.
 2. **Tokenizer Interaction**: If the detector modifies the tokenizer's position (`tokenizer.position` is advanced), no further detectors are executed. In this case, the file type remains `undefined`, as subsequent detectors cannot evaluate the content. This is an exceptional scenario, as it prevents any other detectors from determining the file type.
 
-### Example usage
+### Example writing a custom detector
 
 Below is an example of a custom detector array. This can be passed to the `FileTypeParser` via the `fileTypeOptions` argument.
 

package/core.js

@@ -476,13 +476,6 @@ export class FileTypeParser {
 			};
 		}
 
-		if (this.checkString('WEBP', {offset: 8})) {
-			return {
-				ext: 'webp',
-				mime: 'image/webp',
-			};
-		}
-
 		// Musepack, SV8
 		if (this.checkString('MPCK')) {
 			return {
@@ -851,31 +844,6 @@ export class FileTypeParser {
 			}
 		}
 
-		// RIFF file format which might be AVI, WAV, QCP, etc
-		if (this.check([0x52, 0x49, 0x46, 0x46])) {
-			if (this.check([0x41, 0x56, 0x49], {offset: 8})) {
-				return {
-					ext: 'avi',
-					mime: 'video/vnd.avi',
-				};
-			}
-
-			if (this.check([0x57, 0x41, 0x56, 0x45], {offset: 8})) {
-				return {
-					ext: 'wav',
-					mime: 'audio/wav',
-				};
-			}
-
-			// QLCM, QCP file
-			if (this.check([0x51, 0x4C, 0x43, 0x4D], {offset: 8})) {
-				return {
-					ext: 'qcp',
-					mime: 'audio/qcelp',
-				};
-			}
-		}
-
 		if (this.checkString('SQLi')) {
 			return {
 				ext: 'sqlite',
@@ -1053,6 +1021,15 @@ export class FileTypeParser {
 			};
 		}
 
+		if (this.checkString('.RMF')) {
+			return {
+				ext: 'rm',
+				mime: 'application/vnd.rn-realmedia',
+			};
+		}
+
+		// -- 5-byte signatures --
+
 		if (this.checkString('DRACO')) {
 			return {
 				ext: 'drc',
@@ -1307,6 +1284,38 @@ export class FileTypeParser {
 
 		// -- 12-byte signatures --
 
+		// RIFF file format which might be AVI, WAV, QCP, etc
+		if (this.check([0x52, 0x49, 0x46, 0x46])) {
+			if (this.checkString('WEBP', {offset: 8})) {
+				return {
+					ext: 'webp',
+					mime: 'image/webp',
+				};
+			}
+
+			if (this.check([0x41, 0x56, 0x49], {offset: 8})) {
+				return {
+					ext: 'avi',
+					mime: 'video/vnd.avi',
+				};
+			}
+
+			if (this.check([0x57, 0x41, 0x56, 0x45], {offset: 8})) {
+				return {
+					ext: 'wav',
+					mime: 'audio/wav',
+				};
+			}
+
+			// QLCM, QCP file
+			if (this.check([0x51, 0x4C, 0x43, 0x4D], {offset: 8})) {
+				return {
+					ext: 'qcp',
+					mime: 'audio/qcelp',
+				};
+			}
+		}
+
 		if (this.check([0x49, 0x49, 0x55, 0x00, 0x18, 0x00, 0x00, 0x00, 0x88, 0xE7, 0x74, 0xD8])) {
 			return {
 				ext: 'rw2',

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "file-type",
-	"version": "20.0.1",
+	"version": "20.2.0",
 	"description": "Detect the file type of a file, stream, or data",
 	"license": "MIT",
 	"repository": "sindresorhus/file-type",
@@ -234,7 +234,8 @@
 		"dotm",
 		"potm",
 		"pptm",
-		"jar"
+		"jar",
+		"rm"
 	],
 	"dependencies": {
 		"@tokenizer/inflate": "^0.2.6",

package/readme.md

@@ -20,6 +20,8 @@ npm install file-type
 
 If you use it with Webpack, you need the latest Webpack version and ensure you configure it correctly for ESM.
 
+File type detection is based on binary signatures (magic numbers) and should be treated as a best-effort hint, not a guarantee.
+
 ## Usage
 
 ### Node.js
@@ -341,15 +343,28 @@ Returns a `Set<string>` of supported MIME types.
 
 ## Custom detectors
 
-A custom file type detector.
+Custom file type detectors are plugins designed to extend the default detection capabilities.
+They allow support for uncommon file types, non-binary formats, or customized detection behavior.
+
+Detectors can be added via the constructor options or by modifying `FileTypeParser#detectors` directly.
+Detectors provided through the constructor are executed before the default ones.
 
 Detectors can be added via the constructor options or by directly modifying `FileTypeParser#detectors`.
 
-Detectors provided through the constructor options are executed before the default detectors.
+### Example adding a detector
+
+```js
+import {FileTypeParser} from 'file-type';
+import {detectXml} from '@file-type/xml';
+
+const parser = new FileTypeParser({customDetectors: [detectXml]});
+const fileType = await parser.fromFile('sample.kml');
+console.log(fileType);
+```
+
+### Available third-party file-type detectors
 
-Custom detectors allow for:
-- Introducing new `FileTypeResult` entries.
-- Modifying the detection behavior of existing `FileTypeResult` types.
+- [@file-type/xml](https://github.com/Borewit/file-type-xml): Detects common XML file types, such as GLM, KML, MusicXML, RSS, SVG, and XHTML
 
 ### Detector execution flow
 
@@ -358,7 +373,7 @@ If a detector returns `undefined`, the following rules apply:
 1. **No Tokenizer Interaction**: If the detector does not modify the tokenizer's position, the next detector in the sequence is executed.
 2. **Tokenizer Interaction**: If the detector modifies the tokenizer's position (`tokenizer.position` is advanced), no further detectors are executed. In this case, the file type remains `undefined`, as subsequent detectors cannot evaluate the content. This is an exceptional scenario, as it prevents any other detectors from determining the file type.
 
-### Example usage
+### Writing your own custom detector
 
 Below is an example of a custom detector array. This can be passed to the `FileTypeParser` via the `fileTypeOptions` argument.
 
@@ -550,6 +565,7 @@ abortController.abort(); // Abort file-type reading from the Blob stream.
 - [`qcp`](https://en.wikipedia.org/wiki/QCP) - Tagged and chunked data
 - [`raf`](https://en.wikipedia.org/wiki/Raw_image_format) - Fujifilm RAW image file
 - [`rar`](https://en.wikipedia.org/wiki/RAR_(file_format)) - Archive file
+- [`rm`](https://en.wikipedia.org/wiki/RealMedia) - RealMedia
 - [`rpm`](https://fileinfo.com/extension/rpm) - Red Hat Package Manager file
 - [`rtf`](https://en.wikipedia.org/wiki/Rich_Text_Format) - Rich Text Format
 - [`rw2`](https://en.wikipedia.org/wiki/Raw_image_format) - Panasonic RAW image file
@@ -595,7 +611,7 @@ The following file types will not be accepted:
 	- `.ppt` - Microsoft PowerPoint97-2003 Document
 	- `.msi` - Microsoft Windows Installer
 - `.csv` - [Reason.](https://github.com/sindresorhus/file-type/issues/264#issuecomment-568439196)
-- `.svg` - Detecting it requires a full-blown parser. Check out [`is-svg`](https://github.com/sindresorhus/is-svg) for something that mostly works.
+- `.svg` - Supported by [third-party detector](#available-third-party-file-type-detectors).
 
 #### tokenizer
 

package/supported.js

@@ -171,6 +171,7 @@ export const extensions = [
 	'potm',
 	'pptm',
 	'jar',
+	'rm',
 ];
 
 export const mimeTypes = [
@@ -341,4 +342,5 @@ export const mimeTypes = [
 	'application/vnd.ms-powerpoint.template.macroEnabled.12',
 	'application/vnd.ms-powerpoint.presentation.macroEnabled.12',
 	'application/java-archive',
+	'application/vnd.rn-realmedia',
 ];