@scalar/import 0.5.28 → 0.5.29

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @scalar/import
 
+## 0.5.29
+
+### Patch Changes
+
+- [#10411](https://github.com/scalar/scalar/pull/10411): Import API descriptions from reference page URLs, including Hono pages, and retain discovered document URLs for watch mode.
+
+  Ignore JSON-LD website metadata during URL discovery and preserve link and escaped-JSON fallbacks for URLs with unsupported JavaScript escapes.
+
 ## 0.5.28
 
 ## 0.5.27

package/dist/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,OAAO,CAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,OAAO,CAAC,EAAE;IACR;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3C,GACA,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,CAyHnD;AA6ED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAiBtE;AAgCD;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAqB1E"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAsB,OAAO,CAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,EACrB,OAAO,CAAC,EAAE;IACR;;OAEG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC3C,GACA,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,CAyHnD;AAyFD;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAiBtE;AAgCD;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAqB1E"}

package/dist/resolve.js

@@ -156,10 +156,19 @@ function parseHtml(html) {
     if (scriptContent) {
         return scriptContent;
     }
+    // SEO metadata describes the website rather than its API description.
+    // Preserve a separator so excluding metadata cannot join surrounding text into a new match.
+    const htmlWithoutMetadata = html.replace(/<script\b[^>]*\btype\s*=\s*(?:"application\/ld\+json"|'application\/ld\+json'|application\/ld\+json(?=[\s>]))[^>]*>[\s\S]*?<\/script\s*>/gi, ' ');
     // Check for configuration in script tag
-    const scriptConfigMatch = html.match(/url:\s*["']([^"']+)["']/i);
+    const scriptConfigMatch = htmlWithoutMetadata.match(/(?:["']url["']|\burl)\s*:\s*("(?:\\.|[^"\\])*"|'[^']*')/i);
     if (scriptConfigMatch?.[1]) {
-        return scriptConfigMatch?.[1];
+        try {
+            // JSON serialization escapes characters in quoted URLs, including inline-script escapes.
+            return scriptConfigMatch[1].startsWith('"') ? JSON.parse(scriptConfigMatch[1]) : scriptConfigMatch[1].slice(1, -1);
+        }
+        catch {
+            // JS-only escapes are not JSON; keep trying the remaining discovery methods.
+        }
     }
     // Check for OpenAPI URLs in the HTML
     const linkMatch = html.match(/<a[^>]*href=["']([^"']+\.(?:yaml|yml|json))["'][^>]*>/i);

package/package.json

@@ -16,7 +16,7 @@
     "postman",
     "scalar"
   ],
-  "version": "0.5.28",
+  "version": "0.5.29",
   "engines": {
     "node": ">=22"
   },
@@ -38,7 +38,9 @@
     "@scalar/helpers": "0.16.0",
     "yaml": "^2.9.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+    "@scalar/client-side-rendering": "0.4.8"
+  },
   "scripts": {
     "build": "tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
     "dev": "tsx watch playground/index.ts",