@scalar/import 0.2.36 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scalar/import
 
+## 0.3.0
+
+### Minor Changes
+
+- 5f9a8a2: feat!: remove the spec prefix, make content and url top-level attributes
+
+### Patch Changes
+
+- 14c5d22: fix: getting configuration for galaxy example
+  - @scalar/oas-utils@0.2.118
+  - @scalar/openapi-parser@0.10.10
+
+## 0.2.37
+
+### Patch Changes
+
+- @scalar/oas-utils@0.2.117
+- @scalar/openapi-parser@0.10.10
+
 ## 0.2.36
 
 ### Patch Changes

package/dist/index.js

@@ -1 +1 @@
-export { getConfigurationAttribute, getContentOfScriptTag, resolve } from './resolve.js';
+export { getConfigurationAttribute, getConfigurationAttributeUrl, getContentOfScriptTag, resolve } from './resolve.js';

package/dist/resolve.d.ts

@@ -20,4 +20,6 @@ export declare function getContentOfScriptTag(html: string): string | undefined;
  * @example <script id="api-reference" data-configuration="{&quot;spec&quot;:{&quot;content&quot;:&quot;foo&quot;}}"></script>
  */
 export declare function getConfigurationAttribute(html: string): string | undefined;
+/** Grab the URL from the configuration data attribute */
+export declare const getConfigurationAttributeUrl: (html: string) => string | 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":"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,CA+GnD;AA6ED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAetE;AAgCD;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAiB1E"}
+{"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,CAqHnD;AA6ED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAetE;AAgCD;;;;GAIG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAqB1E;AAED,yDAAyD;AACzD,eAAO,MAAM,4BAA4B,SAAU,MAAM,KAAG,MAAM,GAAG,SAMpE,CAAA"}

package/dist/resolve.js

@@ -91,6 +91,11 @@ async function resolve(value, options) {
                 if (urlOrPathOrDocument) {
                     return makeUrlAbsolute(urlOrPathOrDocument, forwardedHost || value);
                 }
+                // Check for configuration attribute URL
+                const configUrl = getConfigurationAttributeUrl(content);
+                if (configUrl) {
+                    return makeUrlAbsolute(configUrl, forwardedHost || value);
+                }
                 // Check for embedded OpenAPI document
                 const embeddedSpec = parseEmbeddedOpenApi(content);
                 if (embeddedSpec) {
@@ -224,6 +229,10 @@ function getConfigurationAttribute(html) {
         /<script[^>]*id="api-reference"[^>]*data-configuration=["]([^"]+)["][^>]*>(.*?)<\/script>/s,
         // Single quotes
         /<script[^>]*id='api-reference'[^>]*data-configuration=[']([^']+)['][^>]*>(.*?)<\/script>/s,
+        // Mix quote single first
+        /<script[^>]*id='api-reference'[^>]*data-configuration=["]([^"]+)["][^>]*>(.*?)<\/script>/s,
+        // Mix quote double first
+        /<script[^>]*id="api-reference"[^>]*data-configuration=[']([^']+)['][^>]*>(.*?)<\/script>/s,
     ];
     for (const pattern of patterns) {
         const match = html.match(pattern);
@@ -233,6 +242,14 @@ function getConfigurationAttribute(html) {
     }
     return undefined;
 }
+/** Grab the URL from the configuration data attribute */
+const getConfigurationAttributeUrl = (html) => {
+    const configString = getConfigurationAttribute(html);
+    if (!configString)
+        return undefined;
+    const config = JSON.parse(decodeHtmlEntities(configString));
+    return config.url || config.spec?.url;
+};
 /**
  * Parse embedded OpenAPI document from HTML
  */
@@ -242,14 +259,16 @@ function parseEmbeddedOpenApi(html) {
         return undefined;
     try {
         const config = JSON.parse(decodeHtmlEntities(configString));
+        // Handle the old spec format while we transition to the new one
+        const content = config.content || config.spec?.content;
         // Handle both direct JSON content and YAML content
-        if (config.spec?.content) {
+        if (content) {
             // If content is a string, assume it's YAML
-            if (typeof config.spec.content === 'string') {
-                return parse(config.spec.content);
+            if (typeof content === 'string') {
+                return parse(content);
             }
             // If content is an object, return it directly
-            return config.spec.content;
+            return content;
         }
     }
     catch (error) {
@@ -291,4 +310,4 @@ function transformGitHubUrl(url) {
     return undefined;
 }
 
-export { getConfigurationAttribute, getContentOfScriptTag, resolve };
+export { getConfigurationAttribute, getConfigurationAttributeUrl, getContentOfScriptTag, resolve };

package/package.json

@@ -16,7 +16,7 @@
     "postman",
     "scalar"
   ],
-  "version": "0.2.36",
+  "version": "0.3.0",
   "engines": {
     "node": ">=18"
   },
@@ -36,8 +36,8 @@
   "module": "dist/index.js",
   "dependencies": {
     "yaml": "^2.4.5",
-    "@scalar/oas-utils": "0.2.116",
-    "@scalar/openapi-parser": "0.10.10"
+    "@scalar/openapi-parser": "0.10.10",
+    "@scalar/oas-utils": "0.2.118"
   },
   "devDependencies": {
     "vite": "^5.4.10",