@scalar/import 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @scalar/import
 
+## 0.0.4
+
+### Patch Changes
+
+- 2275977: feat: import from way more sources, leverage the proxy more
+- f2361b3: fix: resolve JSON/YAML URLs
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/resolve.d.ts

@@ -2,5 +2,10 @@
  * Find an OpenAPI document URL in the HTML of @scalar/api-reference and other places.
  * This is useful to open the OpenAPI document from basically any source.
  */
-export declare function resolve(value?: string | null): Promise<string | Record<string, any> | undefined>;
+export declare function resolve(value?: string | null, options?: {
+    /**
+     * Fetch function to use instead of the global fetch. Use this to intercept requests.
+     */
+    fetch?: (url: string) => Promise<Response>;
+}): Promise<string | Record<string, any> | undefined>;
 //# sourceMappingURL=resolve.d.ts.map

package/dist/resolve.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,wBAAsB,OAAO,CAC3B,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,GACpB,OAAO,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,SAAS,CAAC,CA0DnD"}
+{"version":3,"file":"resolve.d.ts","sourceRoot":"","sources":["../src/resolve.ts"],"names":[],"mappings":"AAEA;;;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,CAmHnD"}

package/dist/resolve.js

@@ -1,8 +1,10 @@
+import { parse } from 'yaml';
+
 /**
  * Find an OpenAPI document URL in the HTML of @scalar/api-reference and other places.
  * This is useful to open the OpenAPI document from basically any source.
  */
-async function resolve(value) {
+async function resolve(value, options) {
     // URLs
     if (value?.startsWith('http://') || value?.startsWith('https://')) {
         // Transform GitHub URLs to raw file URLs
@@ -26,14 +28,69 @@ async function resolve(value) {
         }
         // Fetch URL
         try {
-            const result = await fetch(value);
+            let result = await (options?.fetch
+                ? options.fetch(value)
+                : fetch(value, {
+                    cache: 'no-cache',
+                }));
+            // If the custom fetch failed, try again with regular fetch
+            if (!result.ok && options?.fetch) {
+                result = await fetch(value, {
+                    cache: 'no-cache',
+                });
+            }
             if (result.ok) {
                 const content = await result.text();
-                const urlOrPath = parseHtml(content);
-                if (urlOrPath) {
-                    return makeRelativeUrlsAbsolute(value, urlOrPath);
+                // Check if content is directly JSON/YAML
+                try {
+                    // Try parsing as JSON
+                    const jsonContent = JSON.parse(content);
+                    if (jsonContent.openapi || jsonContent.swagger) {
+                        return value;
+                    }
+                }
+                catch {
+                    // Try parsing as YAML
+                    try {
+                        const yamlContent = parse(content);
+                        if (yamlContent?.openapi || yamlContent?.swagger) {
+                            return value;
+                        }
+                    }
+                    catch {
+                        // Not YAML
+                    }
+                }
+                const urlOrPathOrDocument = parseHtml(content);
+                // Document (string)
+                if (typeof urlOrPathOrDocument === 'string') {
+                    try {
+                        // JSON?
+                        return JSON.parse(urlOrPathOrDocument);
+                    }
+                    catch {
+                        // No JSON
+                        try {
+                            // YAML?
+                            const yaml = parse(urlOrPathOrDocument);
+                            if (typeof yaml === 'object') {
+                                return yaml;
+                            }
+                        }
+                        catch {
+                            // Not YAML
+                        }
+                    }
                 }
-                // New: Check for embedded OpenAPI document
+                // Document (object)
+                if (typeof urlOrPathOrDocument === 'object') {
+                    return urlOrPathOrDocument;
+                }
+                // Relative or absolute URL
+                if (urlOrPathOrDocument) {
+                    return makeRelativeUrlsAbsolute(value, urlOrPathOrDocument);
+                }
+                // Check for embedded OpenAPI document
                 const embeddedSpec = parseEmbeddedOpenApi(content);
                 if (embeddedSpec) {
                     return embeddedSpec;
@@ -57,10 +114,13 @@ function parseHtml(html) {
     if (!html?.includes('<')) {
         return undefined;
     }
-    // data-url="*"
-    const dataUrlMatch = html.match(/data-url=["']([^"']+)["']/);
-    if (dataUrlMatch?.[1]) {
-        return dataUrlMatch[1];
+    // id="api-reference" data-url="*"
+    const dataUrlMatch = html
+        .match(/id=["']api-reference["'][\s\S]*?data-url=["']([^"']+)["']/)
+        ?.slice(1)
+        .find(Boolean);
+    if (dataUrlMatch) {
+        return dataUrlMatch;
     }
     // spec-url="*"
     const specUrlMatch = html.match(/spec-url=["']([^"']+)["']/);
@@ -73,9 +133,52 @@ function parseHtml(html) {
         return redocInit[1];
     }
     // &amp;quot;url&amp;quot;:&amp;quot;MY_CUSTOM_URL&amp;quot;
-    const configurationUrl = html.match(/&amp;quot;url&amp;quot;:&amp;quot;([^;]+)&amp;quot;/);
-    if (configurationUrl?.[1]) {
-        return configurationUrl[1];
+    const doubleEncodedConfigurationUrl = html.match(/&amp;quot;url&amp;quot;:&amp;quot;([^;]+)&amp;quot;/);
+    if (doubleEncodedConfigurationUrl?.[1]) {
+        return doubleEncodedConfigurationUrl[1];
+    }
+    // &amp;quot;url&amp;quot;:&amp;quot;MY_CUSTOM_URL&amp;quot;
+    const encodedConfigurationUrl = html.match(/&quot;url&quot;:&quot;([^;]+)&quot;/);
+    if (encodedConfigurationUrl?.[1]) {
+        return encodedConfigurationUrl[1];
+    }
+    // Try to find embedded OpenAPI document in script tag first
+    const scriptContent = parseScriptContent(html);
+    if (scriptContent) {
+        return scriptContent;
+    }
+    // Check for configuration in script tag
+    const scriptConfigMatch = html.match(/url:\s*["']([^"']+)["']/i);
+    if (scriptConfigMatch?.[1]) {
+        return scriptConfigMatch?.[1];
+    }
+    // Check for OpenAPI URLs in the HTML
+    const linkMatch = html.match(/<a[^>]*href=["']([^"']+\.(?:yaml|yml|json))["'][^>]*>/i);
+    if (linkMatch?.[1]) {
+        return linkMatch[1];
+    }
+    return undefined;
+}
+/**
+ * Parse OpenAPI document directly from script tag content
+ */
+function parseScriptContent(html) {
+    const match = html.match(/<script[^>]*id="api-reference"[^>]*>([\s\S]*?)<\/script>/);
+    if (!match?.[1])
+        return undefined;
+    try {
+        const content = match[1].trim();
+        if (content) {
+            try {
+                return JSON.parse(content);
+            }
+            catch {
+                return parse(content);
+            }
+        }
+    }
+    catch (error) {
+        console.error('[@scalar/import] Failed to parse script content:', error);
     }
     return undefined;
 }
@@ -102,13 +205,19 @@ function makeRelativeUrlsAbsolute(baseUrl, path) {
  * Parse embedded OpenAPI document from HTML
  */
 function parseEmbeddedOpenApi(html) {
-    const match = html.match(/<script[^>]*data-configuration=['"]([^'"]+)['"][^>]*>(.*?)<\/script>/);
+    const match = html.match(/<script[^>]*data-configuration=['"]([^'"]+)['"][^>]*>(.*?)<\/script>/s);
     if (!match)
         return undefined;
     try {
         const configString = decodeHtmlEntities(match[1]);
         const config = JSON.parse(configString);
+        // Handle both direct JSON content and YAML content
         if (config.spec?.content) {
+            // If content is a string, assume it's YAML
+            if (typeof config.spec.content === 'string') {
+                return parse(config.spec.content);
+            }
+            // If content is an object, return it directly
             return config.spec.content;
         }
     }
@@ -128,7 +237,15 @@ function decodeHtmlEntities(text) {
         '&quot;': '"',
         '&#39;': "'",
     };
-    return text.replace(new RegExp(Object.keys(entities).join('|'), 'g'), (match) => entities[match]);
+    const updatedText = text
+        .replace(new RegExp(Object.keys(entities).join('|'), 'g'), (match) => entities[match])
+        .replace(/\n/g, '\\n')
+        .trim();
+    if (updatedText.startsWith('{&quot;')) {
+        // console.log('ok', updatedText)
+        return decodeHtmlEntities(updatedText);
+    }
+    return updatedText;
 }
 /**
  * Transform GitHub URLs to raw file URLs, preserving the branch information

package/package.json

@@ -16,7 +16,7 @@
     "postman",
     "scalar"
   ],
-  "version": "0.0.3",
+  "version": "0.0.4",
   "engines": {
     "node": ">=18"
   },
@@ -35,6 +35,7 @@
   ],
   "module": "dist/index.js",
   "dependencies": {
+    "yaml": "^2.4.5",
     "@scalar/openapi-parser": "0.8.8"
   },
   "devDependencies": {