@scalar/nuxt 0.2.211 → 0.3.1

package/README.md

@@ -41,9 +41,7 @@ If you would like to add your own OpenAPI document you can do so with the follow
 export default defineNuxtConfig({
   modules: ['@scalar/nuxt'],
   scalar: {
-    spec: {
-      url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
-    },
+    url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
   },
 })
 ```
@@ -67,9 +65,7 @@ export default defineNuxtConfig({
     pathRouting: {
       basePath: '/scalar',
     },
-    spec: {
-      url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
-    },
+    url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml',
   },
 })
 ```
@@ -88,17 +84,13 @@ export default defineNuxtConfig({
     proxyUrl: 'https://proxy.scalar.com',
     configurations: [
       {
-        spec: {
-          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml,
-        },
+        url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.yaml,
         pathRouting: {
           basePath: '/yaml',
         },
       },
       {
-        spec: {
-          url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
-        },
+        url: 'https://cdn.jsdelivr.net/npm/@scalar/galaxy/dist/latest.json',
         pathRouting: {
           basePath: '/json',
         },

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@scalar/nuxt",
   "configKey": "scalar",
-  "version": "0.2.211",
+  "version": "0.3.1",
   "builder": {
     "@nuxt/module-builder": "0.8.1",
     "unbuild": "unknown"

package/dist/runtime/components/ScalarApiReference.vue

@@ -11,22 +11,27 @@ const props = defineProps<{
 
 const isDark = ref(props.configuration.darkMode)
 
+// @ts-expect-error support the old syntax for a bit
+const content = props.configuration.spec?.content ?? props.configuration.content
+// @ts-expect-error support the old syntax for a bit
+const url = props.configuration.spec?.url ?? props.configuration.url
+
 // Grab spec if we can
-const content =
-  typeof props.configuration.spec?.content === 'function'
-    ? toRaw(props.configuration.spec.content())
-    : props.configuration.spec?.content
-      ? toRaw(props.configuration.spec.content)
-      : props.configuration.spec?.url
-        ? await $fetch<string>(props.configuration.spec?.url)
+const document =
+  typeof content === 'function'
+    ? toRaw(content())
+    : content
+      ? toRaw(content)
+      : url
+        ? await $fetch<string>(url)
         : await $fetch<string>('/_openapi.json')
 
 // Check for empty spec
-if (!content)
+if (!document)
   throw new Error('You must provide a document for Scalar API References')
 
-const parsedSpec = reactive(await parse(content))
-const rawSpec = JSON.stringify(content)
+const parsedSpec = reactive(await parse(document))
+const rawSpec = JSON.stringify(document)
 
 // Load up the metadata
 if (props.configuration?.metaData) useSeoMeta(props.configuration.metaData)

package/dist/runtime/pages/ScalarPage.vue

@@ -8,7 +8,11 @@ const meta = route.meta as Meta
 // Ensure we have a spec
 if (
   !meta.isOpenApiEnabled &&
+  !meta.configuration?.url &&
+  !meta.configuration?.content &&
+  // @ts-expect-error support the old syntax for a bit
   !meta.configuration?.spec?.url &&
+  // @ts-expect-error support the old syntax for a bit
   !meta.configuration?.spec?.content
 )
   throw new Error(

package/package.json

@@ -20,7 +20,7 @@
     "testing",
     "vue"
   ],
-  "version": "0.2.211",
+  "version": "0.3.1",
   "engines": {
     "node": ">=18"
   },
@@ -39,9 +39,9 @@
   ],
   "dependencies": {
     "@nuxt/kit": "^3.12.3",
-    "@scalar/api-client": "2.2.62",
-    "@scalar/types": "0.0.40",
-    "@scalar/api-reference": "1.26.2"
+    "@scalar/api-client": "2.3.1",
+    "@scalar/api-reference": "1.28.1",
+    "@scalar/types": "0.1.0"
   },
   "devDependencies": {
     "@nuxt/devtools": "^1.3.9",