@scalar/json-magic 0.12.11 → 0.12.14

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @scalar/json-magic
 
+## 0.12.14
+
+### Patch Changes
+
+- [#9211](https://github.com/scalar/scalar/pull/9211): fix: strip a leading UTF-8 BOM before JSON.parse in normalize so BOM-prefixed files parse correctly
+
+## 0.12.13
+
+### Patch Changes
+
+- [#9107](https://github.com/scalar/scalar/pull/9107): fix: strip a leading UTF-8 BOM before JSON.parse in normalize so BOM-prefixed files parse correctly
+
+## 0.12.12
+
 ## 0.12.11
 
 ## 0.12.10

package/dist/helpers/normalize.d.ts

@@ -1,5 +1,5 @@
 /**
  * Normalize a string (YAML, JSON, object) to a JavaScript datatype.
  */
-export declare function normalize(content: any): any;
+export declare function normalize(content: unknown): unknown;
 //# sourceMappingURL=normalize.d.ts.map

package/dist/helpers/normalize.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../src/helpers/normalize.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,GAAG,OA6BrC"}
+{"version":3,"file":"normalize.d.ts","sourceRoot":"","sources":["../../src/helpers/normalize.ts"],"names":[],"mappings":"AAQA;;GAEG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAgCnD"}

package/dist/helpers/normalize.js

@@ -1,4 +1,9 @@
 import { parse } from 'yaml';
+/**
+ * Strip a leading UTF-8 BOM (U+FEFF). Editors on Windows often write this
+ * prefix; {@link JSON.parse} rejects it as an unexpected token.
+ */
+const stripLeadingUtf8Bom = (value) => (value.startsWith('\uFEFF') ? value.slice(1) : value);
 /**
  * Normalize a string (YAML, JSON, object) to a JavaScript datatype.
  */
@@ -7,20 +12,22 @@ export function normalize(content) {
         return undefined;
     }
     if (typeof content === 'string') {
-        if (content.trim() === '') {
+        const withoutBom = stripLeadingUtf8Bom(content);
+        if (withoutBom.trim() === '') {
             return undefined;
         }
         try {
-            return JSON.parse(content);
+            return JSON.parse(withoutBom);
         }
-        catch (_error) {
+        catch {
             // Does it look like YAML?
-            const hasColon = /^[^:]+:/.test(content);
-            const isJson = content.slice(0, 50).trimStart().startsWith('{');
-            if (!hasColon || isJson) {
+            const hasColon = /^[^:]+:/.test(withoutBom);
+            const trimmedStart = withoutBom.slice(0, 50).trimStart();
+            const looksLikeJson = trimmedStart.startsWith('{') || trimmedStart.startsWith('[');
+            if (!hasColon || looksLikeJson) {
                 return undefined;
             }
-            return parse(content, {
+            return parse(withoutBom, {
                 maxAliasCount: 10000,
                 merge: true,
             });

package/package.json

@@ -10,7 +10,7 @@
     "url": "git+https://github.com/scalar/scalar.git",
     "directory": "packages/json-magic"
   },
-  "version": "0.12.11",
+  "version": "0.12.14",
   "engines": {
     "node": ">=22"
   },
@@ -89,7 +89,7 @@
   "dependencies": {
     "pathe": "^2.0.3",
     "yaml": "^2.8.3",
-    "@scalar/helpers": "0.5.5"
+    "@scalar/helpers": "0.8.0"
   },
   "devDependencies": {
     "fastify": "^5.8.1",