@file-type/xml 0.4.0 → 0.4.2

package/README.md

@@ -1,5 +1,7 @@
 [![NPM version](https://img.shields.io/npm/v/@file-type/xml.svg)](https://npmjs.org/package/@file-type/xml)
 [![Node.js CI](https://github.com/Borewit/file-type-xml/actions/workflows/nodejs-ci.yml/badge.svg)](https://github.com/Borewit/file-type-xml/actions/workflows/nodejs-ci.yml)
+[![npm downloads](http://img.shields.io/npm/dm/@file-type/xml.svg)](https://npmcharts.com/compare/@file-type/xml?start=365)
+
 # @file-type/xml
 
 Detector plugin for [file-type](https://github.com/sindresorhus/file-type) for XML files.
@@ -17,15 +19,16 @@ The following example shows how add the XML detector to [file-type](https://gith
 import {NodeFileTypeParser} from 'file-type';
 import {detectXml} from '@file-type/xml';
 
-const parser = new NodeFileTypeParser({customDetectors: [detectXml]});
+const parser = new FileTypeParser({customDetectors: [detectXml]});
 const fileType = await parser.fromFile('example.kml');
 console.log(fileType);
 ```
 
-You can also use the XML detector outside file-type:
+You can also use the XML detector outside [file-type](https://github.com/sindresorhus/file-type):
 ```js
 import {XmlTextDetector} from '@file-type/xml';
 
+const xmlTextDetector = new XmlTextDetector();
 xmlTextDetector.write('<svg xmlns="http://www.w3.org/2000/svg"><path fill="#00CD9F"/></svg>');
 const fileType = xmlTextDetector.fileType;
 console.log(JSON.stringify(fileType)); // Outputs: {"ext":"svg","mime":"image/svg+xml"}

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { type FileTypeResult, type Detector } from 'file-type';
+import type { FileTypeResult, Detector } from 'file-type';
 interface IXmlTextDetectorOptions {
     fullScan?: boolean;
 }

package/lib/index.js

@@ -10,25 +10,45 @@ function startsWith(array, prefix) {
     }
     return true;
 }
+function hasXmlTag(xmlString) {
+    return /^<\s*\w+(?=\s+[^<>]*=|>)/.test(xmlString);
+}
+function hasArrayXmlTag(array, encoding) {
+    const textDecoder = new TextDecoder(encoding);
+    return hasXmlTag(textDecoder.decode(array));
+}
 function isXml(array) {
     if (startsWith(array, [60, 63, 120, 109, 108, 32])) {
         return { xml: true, encoding: 'utf-8', offset: 0 };
     }
-    else if (startsWith(array, [0xEF, 0xBB, 0xBF, 60, 63, 120, 109, 108, 32])) { // UTF-8 BOM
-        return { xml: true, encoding: 'utf-8', offset: 3 };
+    if (startsWith(array, [0xEF, 0xBB, 0xBF])) { // UTF-8 BOM
+        const encoding = 'utf-8';
+        if (startsWith(array.subarray(3), [60, 63, 120, 109, 108, 32]) || hasArrayXmlTag(array, encoding)) {
+            return { xml: true, encoding, offset: 3 };
+        }
     }
-    else if (startsWith(array, [0xFE, 0xFF, 0, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32])) {
-        return { xml: true, encoding: 'utf-16be', offset: 2 };
+    if (startsWith(array, [0xFE, 0xFF])) {
+        const encoding = 'utf-16be';
+        if (startsWith(array.subarray(2), [0, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32]) || hasArrayXmlTag(array, encoding)) {
+            return { xml: true, encoding, offset: 2 };
+        }
     }
-    else if (startsWith(array, [0xFF, 0xFE, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32, 0])) {
+    if (startsWith(array, [0xFF, 0xFE])) {
+        const encoding = 'utf-16le';
+        if (startsWith(array.subarray(2), [60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32, 0]) || hasArrayXmlTag(array, encoding)) {
+            return { xml: true, encoding, offset: 2 };
+        }
         return { xml: true, encoding: 'utf-16le', offset: 2 };
     }
-    else if (startsWith(array, [0, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32])) {
+    if (startsWith(array, [0, 60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32])) {
         return { xml: true, encoding: 'utf-16be', offset: 0 };
     }
-    else if (startsWith(array, [60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32, 0])) {
+    if (startsWith(array, [60, 0, 63, 0, 120, 0, 109, 0, 108, 0, 32, 0])) {
         return { xml: true, encoding: 'utf-16le', offset: 0 };
     }
+    if (hasArrayXmlTag(array, 'utf-8')) {
+        return { xml: true, encoding: 'utf-8', offset: 0 };
+    }
     return { xml: false };
 }
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@file-type/xml",
-	"version": "0.4.0",
-	"description": "XML detection plugin",
+	"version": "0.4.2",
+	"description": "XML detection plugin for file-type",
 	"type": "module",
 	"types": "./lib/index.d.ts",
 	"exports": "./lib/index.js",
@@ -9,8 +9,10 @@
 		"clean": "del-cli 'lib/**/*.js' 'lib/**/*.js.map' 'lib/**/*.d.ts' 'src/**/*.d.ts'",
 		"compile-src": "tsc -p lib",
 		"compile": "yarn run  compile-src",
+		"lint-ts": "biome check",
 		"build": "yarn run clean && yarn compile",
-		"test": "mocha"
+		"test": "mocha",
+		"prepublishOnly": "yarn run build"
 	},
 	"keywords": [
 		"file-type",
@@ -29,15 +31,16 @@
 	],
 	"dependencies": {
 		"sax": "^1.4.1",
-		"strtok3": "^10.0.1"
+		"strtok3": "^10.2.2"
 	},
 	"devDependencies": {
+		"@biomejs/biome": "^1.9.4",
 		"@types/sax": "^1.2.7",
-		"chai": "^5.1.2",
+		"chai": "^5.2.0",
 		"del-cli": "^6.0.0",
-		"file-type": "^20.0.0",
-		"mocha": "^11.0.1",
-		"typescript": "^5.7.3"
+		"file-type": "^20.4.1",
+		"mocha": "^11.1.0",
+		"typescript": "^5.8.3"
 	},
 	"files": [
 		"lib/**/*.js",
@@ -53,5 +56,5 @@
 		"url": "git+https://github.com/Borewit/file-type-xml.git"
 	},
 	"license": "MIT",
-	"packageManager": "yarn@4.5.3"
+	"packageManager": "yarn@4.9.1"
 }