@scalar/nuxt 0.2.27 → 0.2.29

package/dist/module.d.ts

@@ -1,22 +1,2 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { ReferenceConfiguration } from '@scalar/api-reference';
-
-type Configuration = Omit<ReferenceConfiguration, 'layout' | 'isEditable' | 'onSpecUpdate'> & {
-    /**
-     * Whether to show scalar in Nuxt DevTools
-     *
-     * @default true
-     */
-    devtools: boolean;
-};
-
-type ModuleOptions = {
-    /**
-     * For multiple references, pass an array of config objects into
-     * configurations. These configurations will extend over the base config
-     */
-    configurations: Omit<Configuration, 'devtools'>[];
-} & Configuration;
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
-
-export { type ModuleOptions, _default as default };
+export * from "/home/runner/work/scalar/scalar/packages/nuxt/src/module";
+export { default } from "/home/runner/work/scalar/scalar/packages/nuxt/src/module";

package/dist/module.json

@@ -1,5 +1,9 @@
 {
   "name": "@scalar/nuxt",
   "configKey": "scalar",
-  "version": "0.2.27"
+  "version": "0.2.29",
+  "builder": {
+    "@nuxt/module-builder": "0.8.1",
+    "unbuild": "unknown"
+  }
 }

package/dist/module.mjs

@@ -1,87 +1,12 @@
-import { defineNuxtModule, createResolver, addComponent, extendPages, addPlugin } from '@nuxt/kit';
+import jiti from "file:///home/runner/work/scalar/scalar/node_modules/.pnpm/jiti@1.21.6/node_modules/jiti/lib/index.js";
 
-const module = defineNuxtModule({
-  meta: {
-    name: "@scalar/nuxt",
-    configKey: "scalar"
-  },
-  // Default configuration options of the Nuxt module
-  defaults: {
-    darkMode: true,
-    metaData: {
-      title: "API Documentation by Scalar"
-    },
-    pathRouting: {
-      basePath: "/docs"
-    },
-    showSidebar: true,
-    devtools: true,
-    configurations: []
-  },
-  setup(_options, _nuxt) {
-    const resolver = createResolver(import.meta.url);
-    let isOpenApiEnabled = false;
-    _nuxt.options.build.transpile.push("yaml");
-    _nuxt.options.vite.optimizeDeps ||= {};
-    _nuxt.options.vite.optimizeDeps.include ||= [];
-    _nuxt.options.vite.optimizeDeps.include.push(
-      "debug",
-      "extend",
-      "stringify-object",
-      "rehype-highlight"
-    );
-    _nuxt.hook("nitro:config", (config) => {
-      if (config.experimental?.openAPI)
-        isOpenApiEnabled = true;
-    });
-    addComponent({
-      name: "ScalarApiReference",
-      export: "default",
-      filePath: resolver.resolve("./runtime/components/ScalarApiReference.vue")
-    });
-    extendPages((pages) => {
-      if (_options.configurations.length) {
-        const { configurations, ...baseConfig } = _options;
-        configurations.forEach((_config, index) => {
-          const configuration = { ...baseConfig, ..._config };
-          pages.push({
-            name: "scalar-" + index,
-            path: configuration.pathRouting?.basePath + ":pathMatch(.*)*",
-            meta: {
-              configuration,
-              isOpenApiEnabled
-            },
-            file: resolver.resolve("./runtime/pages/ScalarPage.vue")
-          });
-        });
-      } else {
-        pages.push({
-          name: "scalar",
-          path: _options.pathRouting?.basePath + ":pathMatch(.*)*",
-          meta: {
-            configuration: _options,
-            isOpenApiEnabled
-          },
-          file: resolver.resolve("./runtime/pages/ScalarPage.vue")
-        });
-      }
-    });
-    if (_nuxt.options.dev && _options.devtools) {
-      _nuxt.hook("devtools:customTabs", (tabs) => {
-        tabs.push({
-          name: "scalar",
-          title: "Scalar",
-          icon: "https://gist.githubusercontent.com/cameronrohani/0fa020f6dcf957266bff49e7b6b7c05e/raw/17fce1ef37bbb036dca36b778c8b422056ad6fdf/scalar-logo-nuxt-color.svg",
-          category: "server",
-          view: {
-            type: "iframe",
-            src: _options.pathRouting?.basePath ?? "/docs"
-          }
-        });
-      });
-    }
-    addPlugin(resolver.resolve("./runtime/plugins/hydrateClient"));
+/** @type {import("/home/runner/work/scalar/scalar/packages/nuxt/src/module")} */
+const _module = jiti(null, {
+  "esmResolve": true,
+  "interopDefault": true,
+  "alias": {
+    "@scalar/nuxt": "/home/runner/work/scalar/scalar/packages/nuxt"
   }
-});
+})("/home/runner/work/scalar/scalar/packages/nuxt/src/module.ts");
 
-export { module as default };
+export default _module;

package/dist/types.d.mts

@@ -1,16 +1,19 @@
+import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module.js'
 
-import type { ModuleOptions } from './module.js'
-
+declare module '#app' {
+  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
+}
 
 declare module '@nuxt/schema' {
-  interface NuxtConfig { ['scalar']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['scalar']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 declare module 'nuxt/schema' {
-  interface NuxtConfig { ['scalar']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['scalar']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
-
-export type { ModuleOptions, default } from './module.js'
+export * from "./module.js"

package/dist/types.d.ts

@@ -1,16 +1,19 @@
+import type { ModuleHooks, ModuleRuntimeHooks, ModuleRuntimeConfig, ModulePublicRuntimeConfig } from './module'
 
-import type { ModuleOptions } from './module'
-
+declare module '#app' {
+  interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
+}
 
 declare module '@nuxt/schema' {
-  interface NuxtConfig { ['scalar']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['scalar']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
 declare module 'nuxt/schema' {
-  interface NuxtConfig { ['scalar']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['scalar']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+  interface RuntimeConfig extends ModuleRuntimeConfig {}
+  interface PublicRuntimeConfig extends ModulePublicRuntimeConfig {}
 }
 
-
-export type { ModuleOptions, default } from './module'
+export * from "./module"

package/package.json

@@ -20,7 +20,7 @@
     "testing",
     "vue"
   ],
-  "version": "0.2.27",
+  "version": "0.2.29",
   "engines": {
     "node": ">=18"
   },
@@ -38,20 +38,20 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.11.2",
-    "@scalar/api-client": "2.0.5",
-    "@scalar/api-reference": "1.24.28"
+    "@nuxt/kit": "^3.12.3",
+    "@scalar/api-client": "2.0.7",
+    "@scalar/api-reference": "1.24.30"
   },
   "devDependencies": {
-    "@nuxt/devtools": "^1.1.5",
-    "@nuxt/eslint-config": "^0.3.4",
-    "@nuxt/module-builder": "^0.5.5",
-    "@nuxt/schema": "^3.11.2",
-    "@nuxt/test-utils": "^3.12.0",
+    "@nuxt/devtools": "^1.3.9",
+    "@nuxt/eslint-config": "^0.3.13",
+    "@nuxt/module-builder": "^0.8.1",
+    "@nuxt/schema": "^3.12.3",
+    "@nuxt/test-utils": "^3.13.1",
     "@types/node": "^20.8.4",
     "changelogen": "^0.5.5",
     "eslint": "^8.56.0",
-    "nuxt": "^3.11.2",
+    "nuxt": "^3.12.3",
     "vitest": "^1.6.0"
   },
   "scripts": {

package/dist/module.d.mts

@@ -1,22 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { ReferenceConfiguration } from '@scalar/api-reference';
-
-type Configuration = Omit<ReferenceConfiguration, 'layout' | 'isEditable' | 'onSpecUpdate'> & {
-    /**
-     * Whether to show scalar in Nuxt DevTools
-     *
-     * @default true
-     */
-    devtools: boolean;
-};
-
-type ModuleOptions = {
-    /**
-     * For multiple references, pass an array of config objects into
-     * configurations. These configurations will extend over the base config
-     */
-    configurations: Omit<Configuration, 'devtools'>[];
-} & Configuration;
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
-
-export { type ModuleOptions, _default as default };

package/dist/runtime/components/ScalarApiReference.vue

@@ -1,53 +0,0 @@
-<script lang="ts" setup>
-import { useHead, useRequestURL, useSeoMeta } from '#imports'
-import { ModernLayout, parse } from '@scalar/api-reference'
-import { reactive, ref, toRaw } from 'vue'
-import type { Configuration } from '~/src/types'
-
-import './nuxt-theme.css'
-
-const props = defineProps<{
-  configuration: Configuration
-}>()
-
-const isDark = ref(props.configuration.darkMode)
-
-// Grab spec if we can
-const content: unknown = props.configuration.spec?.content
-  ? toRaw(props.configuration.spec.content)
-  : props.configuration.spec?.url
-    ? await $fetch(props.configuration.spec?.url)
-    : await $fetch('/_nitro/openapi.json')
-
-// Check for empty spec
-if (!content)
-  throw new Error('You must provide a spec for Scalar API References')
-
-const parsedSpec = reactive(await parse(content))
-const rawSpec = JSON.stringify(content)
-
-// Load up the metadata
-if (props.configuration?.metaData) useSeoMeta(props.configuration.metaData)
-
-useHead({
-  bodyAttrs: {
-    class: () => (isDark.value ? 'dark-mode' : 'light-mode'),
-  },
-})
-
-// Add baseServerURL
-const { origin } = useRequestURL()
-const config = {
-  baseServerURL: origin,
-  ...props.configuration,
-}
-</script>
-
-<template>
-  <ModernLayout
-    :configuration="config"
-    :isDark="isDark"
-    :parsedSpec="parsedSpec"
-    :rawSpec="rawSpec"
-    @toggleDarkMode="isDark = !isDark" />
-</template>

package/dist/runtime/components/nuxt-theme.css

@@ -1 +0,0 @@
-@import "@scalar/api-client/style.css";@import "@scalar/api-reference/style.css";.light-mode{--scalar-background-1:#fff;--scalar-background-2:#f8fafc;--scalar-background-3:#e7e7e7;--scalar-background-accent:#8ab4f81f;--scalar-color-1:#000;--scalar-color-2:#6b7280;--scalar-color-3:#9ca3af;--scalar-color-accent:#00c16a;--scalar-border-color:#e5e7eb;--scalar-color-green:#069061;--scalar-color-red:#ef4444;--scalar-color-yellow:#f59e0b;--scalar-color-blue:#1d4ed8;--scalar-color-orange:#fb892c;--scalar-color-purple:#6d28d9;--scalar-button-1:#000;--scalar-button-1-hover:rgba(0,0,0,.9);--scalar-button-1-color:#fff}.dark-mode{--scalar-background-1:#020420;--scalar-background-2:#121a31;--scalar-background-3:#1e293b;--scalar-background-accent:#8ab4f81f;--scalar-color-1:#fff;--scalar-color-2:#cbd5e1;--scalar-color-3:#94a3b8;--scalar-color-accent:#00dc82;--scalar-border-color:#1e293b;--scalar-color-green:#069061;--scalar-color-red:#f87171;--scalar-color-yellow:#fde68a;--scalar-color-blue:#60a5fa;--scalar-color-orange:#fb892c;--scalar-color-purple:#ddd6fe;--scalar-button-1:hsla(0,0%,100%,.9);--scalar-button-1-hover:hsla(0,0%,100%,.8);--scalar-button-1-color:#000}.dark-mode .t-doc__sidebar,.light-mode .t-doc__sidebar{--scalar-sidebar-background-1:var(--scalar-background-1);--scalar-sidebar-color-1:var(--scalar-color-1);--scalar-sidebar-color-2:var(--scalar-color-3);--scalar-sidebar-border-color:var(--scalar-border-color);--scalar-sidebar-item-hover-background:transparent;--scalar-sidebar-item-hover-color:var(--scalar-color-1);--scalar-sidebar-item-active-background:transparent;--scalar-sidebar-color-active:var(--scalar-color-accent);--scalar-sidebar-search-background:transparent;--scalar-sidebar-search-color:var(--scalar-color-3);--scalar-sidebar-search-border-color:var(--scalar-border-color);--scalar-sidebar-indent-border:var(--scalar-border-color);--scalar-sidebar-indent-border-hover:var(--scalar-color-1);--scalar-sidebar-indent-border-active:var(--scalar-color-accent)}.scalar-card .request-card-footer{--scalar-background-3:var(--scalar-background-2);--scalar-button-1:#0f172a;--scalar-button-1-hover:rgba(30,41,59,.5);--scalar-button-1-color:#fff}.scalar-card .show-api-client-button{border:1px solid #334155!important}

package/dist/runtime/pages/ScalarPage.vue

@@ -1,21 +0,0 @@
-<script lang="ts" setup>
-import { useRoute } from '#imports'
-import type { Meta } from '~/src/types'
-
-const route = useRoute()
-const meta = route.meta as Meta
-
-// Ensure we have a spec
-if (
-  !meta.isOpenApiEnabled &&
-  !meta.configuration?.spec?.url &&
-  !meta.configuration?.spec?.content
-)
-  throw new Error(
-    'You must either provide a spec to scalar, or enable experimental openApi in the Nitro config.',
-  )
-</script>
-
-<template>
-  <ScalarApiReference :configuration="meta.configuration" />
-</template>

package/dist/runtime/plugins/hydrateClient.d.mts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/runtime/plugins/hydrateClient.d.ts

@@ -1,2 +0,0 @@
-declare const _default: any;
-export default _default;

package/dist/runtime/plugins/hydrateClient.mjs

@@ -1,13 +0,0 @@
-import { defineNuxtPlugin } from "#app";
-import { useHead } from "#imports";
-export default defineNuxtPlugin((_nuxtApp) => {
-  _nuxtApp.hook("app:rendered", ({ ssrContext }) => {
-    useHead({
-      script: [
-        {
-          children: `window.__SCALAR__ = ${JSON.stringify(ssrContext?.payload?.data ?? {})}`
-        }
-      ]
-    });
-  });
-});