nuxt-site-config 1.5.4 → 1.6.0

package/dist/module.json

@@ -5,5 +5,5 @@
     "bridge": false
   },
   "configKey": "site",
-  "version": "1.5.4"
+  "version": "1.6.0"
 }

package/dist/module.mjs

@@ -1,8 +1,9 @@
 import { useNuxt, createResolver, addTemplate, defineNuxtModule, useLogger, addImports, addComponent, addPlugin, hasNuxtModule, addServerHandler, addPrerenderRoutes, addServerPlugin } from '@nuxt/kit';
 import { initSiteConfig, updateSiteConfig, getSiteConfigStack } from 'nuxt-site-config-kit';
 import { relative } from 'pathe';
+import { existsSync } from 'node:fs';
 
-const version = "1.5.4";
+const version = "1.6.0";
 
 function extendTypes(module, template) {
   const nuxt = useNuxt();
@@ -23,6 +24,48 @@ export {}
   });
 }
 
+const DEVTOOLS_UI_ROUTE = "/__nuxt-site-config";
+const DEVTOOLS_UI_LOCAL_PORT = 3030;
+function setupDevToolsUI(resolve, nuxt = useNuxt()) {
+  const clientPath = resolve("./client");
+  const isProductionBuild = existsSync(clientPath);
+  if (isProductionBuild) {
+    nuxt.hook("vite:serverCreated", async (server) => {
+      const sirv = await import('sirv').then((r) => r.default || r);
+      server.middlewares.use(
+        DEVTOOLS_UI_ROUTE,
+        sirv(clientPath, { dev: true, single: true })
+      );
+    });
+  } else {
+    nuxt.hook("vite:extendConfig", (config) => {
+      config.server = config.server || {};
+      config.server.proxy = config.server.proxy || {};
+      config.server.proxy[DEVTOOLS_UI_ROUTE] = {
+        target: `http://localhost:${DEVTOOLS_UI_LOCAL_PORT}${DEVTOOLS_UI_ROUTE}`,
+        changeOrigin: true,
+        followRedirects: true,
+        rewrite: (path) => path.replace(DEVTOOLS_UI_ROUTE, "")
+      };
+    });
+  }
+  nuxt.hook("devtools:customTabs", (tabs) => {
+    tabs.push({
+      // unique identifier
+      name: "nuxt-simple-sitemap",
+      // title to display in the tab
+      title: "Site Config",
+      // any icon from Iconify, or a URL to an image
+      icon: "carbon:settings-check",
+      // iframe view
+      view: {
+        type: "iframe",
+        src: DEVTOOLS_UI_ROUTE
+      }
+    });
+  });
+}
+
 const module = defineNuxtModule({
   meta: {
     name: "nuxt-site-config",
@@ -175,11 +218,14 @@ declare module '@nuxt/schema' {
     });
     if (config.debug) {
       addServerHandler({
-        route: "/api/__site-config__/debug",
-        handler: resolve("./runtime/nitro/routes/debug")
+        route: "/__site-config__/debug.json",
+        handler: resolve("./runtime/nitro/routes/__site-config__/debug")
       });
-      addPrerenderRoutes("/api/__site-config__/debug");
+      if (nuxt.options._generate)
+        addPrerenderRoutes("/__site-config__/debug.json");
     }
+    if (nuxt.options.dev)
+      setupDevToolsUI(resolve);
     addServerPlugin(resolve("./runtime/nitro/plugins/injectState"));
   }
 });

package/dist/runtime/nitro/middleware/init.mjs

@@ -1,9 +1,18 @@
 import { createSiteConfigStack } from "site-config-stack";
 import { defineEventHandler, useAppConfig, useNitroOrigin, useRuntimeConfig } from "#imports";
+function getEnv(config) {
+  const key = config.toUpperCase();
+  const env = import.meta.env || {};
+  const privateKey = `NUXT_SITE_${key}`;
+  const publicKey = `NUXT_PUBLIC_SITE_${key}`;
+  if (privateKey in env)
+    return env[privateKey];
+  if (publicKey in env)
+    return env[publicKey];
+}
 export default defineEventHandler((e) => {
   const config = useRuntimeConfig()["nuxt-site-config"];
   const siteConfig = e.context.siteConfig || createSiteConfigStack({
-    // @ts-expect-error untyped
     debug: config.debug
   });
   if (siteConfig) {
@@ -15,6 +24,17 @@ export default defineEventHandler((e) => {
       _priority: -4,
       url: nitroOrigin
     });
+    siteConfig.push({
+      _context: "runtimeEnv",
+      _priority: 0,
+      env: getEnv("Env"),
+      url: getEnv("Url"),
+      name: getEnv("Name"),
+      description: getEnv("Description"),
+      logo: getEnv("Image"),
+      defaultLocale: getEnv("Language"),
+      indexable: getEnv("Indexable")
+    });
     const buildStack = config.stack || [];
     buildStack.forEach((c) => siteConfig.push(c));
     if (appConfig.site) {
@@ -30,6 +50,15 @@ export default defineEventHandler((e) => {
         ...e.context._nitro.routeRules.site
       });
     }
+    const curStack = siteConfig.get();
+    if (typeof curStack.indexable === "undefined") {
+      siteConfig.push({
+        _context: "computed-env",
+        _priority: -4,
+        // allow overriding from the module
+        indexable: curStack.env === "production"
+      });
+    }
   }
   e.context.siteConfig = siteConfig;
 });

package/dist/runtime/nitro/routes/{debug.mjs → __site-config__/debug.mjs}

@@ -10,6 +10,6 @@ export default defineEventHandler(async (e) => {
     config: siteConfig,
     stack,
     nitroOrigin,
-    version: publicRuntimeConfig["nuxt-site-config"]?.version
+    version: publicRuntimeConfig["nuxt-site-config"]
   };
 });

package/dist/runtime/plugins/i18n.mjs

@@ -1,16 +1,30 @@
-import { computed, defineNuxtPlugin, updateSiteConfig } from "#imports";
+import { parseURL } from "ufo";
+import { computed, defineNuxtPlugin, updateSiteConfig, useSiteConfig } from "#imports";
 export default defineNuxtPlugin({
   name: "nuxt-site-config:i18n",
-  // @ts-expect-error todo fix upstream
   enforce: 1,
   // needs to come after i18n
   setup(nuxtApp) {
     const i18n = nuxtApp.$i18n;
     if (!i18n)
       return;
+    const currentUrl = useSiteConfig().url;
+    let i18nBaseUrl = false;
+    try {
+      const url = parseURL(i18n.baseUrl.value);
+      if (import.meta.dev && url.host) {
+        if (url.host.includes("localhost"))
+          console.warn(`[Nuxt Site Config] You have set an i18n baseUrl to \`${url.host}\`. This will not work in production. Please set a proper baseUrl in your i18n config.`);
+        else if (!currentUrl.includes(url.host))
+          console.warn(`[Nuxt Site Config] Your i18n baseUrl \`${url}\` doesn't match your site url. This can lead to unexpected behavior. Please set a matching baseUrl in your i18n config.`);
+        else
+          i18nBaseUrl = url.host;
+      }
+    } catch {
+    }
     updateSiteConfig({
       _context: "@nuxtjs/i18n",
-      url: i18n.baseUrl.value,
+      url: i18nBaseUrl || void 0,
       currentLocale: i18n.locale,
       description: computed(() => i18n.te("nuxtSiteConfig.description") ? i18n.t("nuxtSiteConfig.description") : void 0),
       name: computed(() => i18n.te("nuxtSiteConfig.name") ? i18n.t("nuxtSiteConfig.name") : void 0)

package/dist/runtime/types.d.ts

@@ -1,3 +1,8 @@
 import type { SiteConfig, SiteConfigInput, SiteConfigStack } from 'site-config-stack';
 export type NuxtSiteConfig = Omit<SiteConfig, 'url'> & Required<Pick<SiteConfig, 'url'>>;
-export { SiteConfig, SiteConfigStack, SiteConfigInput };
+export type { SiteConfig, SiteConfigStack, SiteConfigInput };
+export interface ModuleRuntimeConfig {
+    debug?: boolean;
+    stack?: Partial<SiteConfigInput>[];
+    version: string;
+}

package/dist/runtime/types.mjs

@@ -1 +0,0 @@
-export {};

package/dist/types.d.mts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions, ModuleHooks, ModuleRuntimeConfig } from './module'
+import type { ModuleOptions, ModuleHooks, ModuleRuntimeConfig } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['site']?: Partial<ModuleOptions> }
@@ -16,4 +17,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ModuleHooks, ModuleOptions, ModuleRuntimeConfig, default } from './module'
+export type { ModuleHooks, ModuleOptions, ModuleRuntimeConfig, default } from './module'

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions, ModuleHooks, ModuleRuntimeConfig } from './module'
+import type { ModuleOptions, ModuleHooks, ModuleRuntimeConfig } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['site']?: Partial<ModuleOptions> }
@@ -16,4 +17,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ModuleHooks, ModuleOptions, ModuleRuntimeConfig, default } from './module'
+export type { ModuleHooks, ModuleOptions, ModuleRuntimeConfig, default } from './module'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-site-config",
   "type": "module",
-  "version": "1.5.4",
+  "version": "1.6.0",
   "description": "Shared site configuration for Nuxt 3 modules.",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -26,12 +26,16 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.7.4",
-    "@nuxt/schema": "^3.7.4",
+    "@nuxt/devtools-kit": "^1.0.2",
+    "@nuxt/devtools-ui-kit": "^1.0.2",
+    "@nuxt/kit": "^3.8.1",
+    "@nuxt/schema": "^3.8.1",
     "pathe": "^1.1.1",
-    "ufo": "^1.3.1",
-    "nuxt-site-config-kit": "1.5.4",
-    "site-config-stack": "1.5.4"
+    "shiki-es": "^0.14.0",
+    "sirv": "^2.0.3",
+    "ufo": "^1.3.2",
+    "site-config-stack": "1.6.0",
+    "nuxt-site-config-kit": "1.6.0"
   },
   "build": {
     "externals": [