nuxt-schema-org 3.0.0 → 3.1.0

package/README.md

@@ -10,7 +10,7 @@
 
 
 <p align="center">
-The quickest and easiest way to build Schema.org graphs for Nuxt.
+The quickest and easiest way to build Schema.org graphs for Nuxt. Powered by [Unhead](https://unhead.unjs.io).
 </p>
 
 <p align="center">

package/dist/module.json

@@ -5,5 +5,5 @@
     "nuxt": "^3.7.0",
     "bridge": false
   },
-  "version": "3.0.0"
+  "version": "3.1.0"
 }

package/dist/module.mjs

@@ -1,6 +1,49 @@
-import { defineNuxtModule, useLogger, createResolver, addPlugin, addComponent } from '@nuxt/kit';
+import { useNuxt, defineNuxtModule, useLogger, createResolver, addPlugin, addComponent } from '@nuxt/kit';
 import { schemaOrgComponents, schemaOrgAutoImports } from '@unhead/schema-org/vue';
 import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
+import { existsSync } from 'node:fs';
+
+const DEVTOOLS_UI_ROUTE = "/__nuxt-schema-org";
+const DEVTOOLS_UI_LOCAL_PORT = 3030;
+function setupDevToolsUI(options, 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-schema-org",
+      // title to display in the tab
+      title: "Schema.org",
+      // any icon from Iconify, or a URL to an image
+      icon: "carbon:chart-relationship",
+      // iframe view
+      view: {
+        type: "iframe",
+        src: DEVTOOLS_UI_ROUTE
+      }
+    });
+  });
+}
 
 const module = defineNuxtModule({
   meta: {
@@ -16,7 +59,7 @@ const module = defineNuxtModule({
       enabled: true,
       debug: false,
       reactive: nuxt.options.dev || !nuxt.options.ssr,
-      minify: process.env.NODE_ENV === "production"
+      minify: import.meta.env.PROD
     };
   },
   async setup(config, nuxt) {
@@ -49,6 +92,8 @@ const module = defineNuxtModule({
     nuxt.hooks.hook("imports:sources", (autoImports) => {
       autoImports.unshift(...schemaOrgAutoImports);
     });
+    if (config.debug || nuxt.options.dev)
+      setupDevToolsUI(config, resolve);
   }
 });
 

package/dist/runtime/plugin.mjs

@@ -1,5 +1,7 @@
-import { PluginSchemaOrg } from "@unhead/schema-org";
-import { defineNuxtPlugin, injectHead, unref, useRouter, useRuntimeConfig, useSiteConfig } from "#imports";
+import { SchemaOrgUnheadPlugin } from "@unhead/schema-org";
+import { joinURL } from "ufo";
+import { computed } from "vue";
+import { defineNuxtPlugin, injectHead, useHead, useRouter, useRuntimeConfig, useSiteConfig } from "#imports";
 export default defineNuxtPlugin({
   name: "nuxt-schema-org:init",
   enforce: "post",
@@ -7,23 +9,31 @@ export default defineNuxtPlugin({
     const head = injectHead();
     const config = useRuntimeConfig().public["nuxt-schema-org"];
     const router = useRouter();
-    const currentRoute = router.currentRoute;
     const siteConfig = useSiteConfig();
-    head.use(PluginSchemaOrg({
-      minify: config.minify,
-      resolveMeta: async () => {
-        const route = unref(currentRoute);
-        const meta = {
-          host: siteConfig.url,
-          trailingSlash: siteConfig.trailingSlash,
-          inLanguage: siteConfig.currentLocale || siteConfig.defaultLocale,
-          ...siteConfig,
-          ...route.meta,
-          path: route.path
-        };
+    const schemaOrg = computed(() => {
+      return {
+        ...router.currentRoute.value.meta,
+        ...siteConfig,
+        url: joinURL(siteConfig.url, router.currentRoute.value.path),
+        host: siteConfig.url,
+        inLanguage: siteConfig.currentLocale || siteConfig.defaultLocale,
+        path: router.currentRoute.value.path
+      };
+    });
+    useHead({
+      templateParams: {
+        schemaOrg
+      }
+    });
+    head.use(
+      SchemaOrgUnheadPlugin({}, async () => {
+        const meta = {};
         await nuxtApp.hooks.callHook("schema-org:meta", meta);
         return meta;
-      }
-    }));
+      }, {
+        minify: config.minify,
+        trailingSlash: siteConfig.trailingSlash
+      })
+    );
   }
 });

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "nuxt-schema-org",
   "type": "module",
-  "version": "3.0.0",
-  "packageManager": "pnpm@8.7.5",
+  "version": "3.1.0",
+  "packageManager": "pnpm@8.10.0",
   "description": "Schema.org for Nuxt",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
@@ -35,23 +35,27 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.7.3",
-    "@unhead/schema-org": "^1.7.3",
-    "nuxt-site-config": "^1.2.1",
-    "nuxt-site-config-kit": "^1.2.1",
-    "pathe": "^1.1.1"
+    "@nuxt/devtools-kit": "^1.0.0",
+    "@nuxt/devtools-ui-kit": "^1.0.0",
+    "@nuxt/kit": "^3.8.0",
+    "@unhead/schema-org": "^1.8.2",
+    "nuxt-site-config": "^1.5.5",
+    "nuxt-site-config-kit": "^1.5.5",
+    "pathe": "^1.1.1",
+    "shiki-es": "^0.14.0",
+    "sirv": "^2.0.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.42.0",
-    "@nuxt/module-builder": "^0.5.1",
-    "@nuxt/schema": "^3.7.3",
-    "@nuxt/test-utils": "^3.7.3",
+    "@antfu/eslint-config": "^1.0.0",
+    "@nuxt/module-builder": "^0.5.2",
+    "@nuxt/schema": "^3.8.0",
+    "@nuxt/test-utils": "^3.8.0",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
     "bumpp": "^9.2.0",
-    "eslint": "8.49.0",
-    "nuxt": "^3.7.3",
+    "eslint": "8.52.0",
+    "nuxt": "^3.8.0",
     "nuxt-windicss": "^2.6.1",
-    "vitest": "0.34.4"
+    "vitest": "0.34.6"
   },
   "scripts": {
     "lint": "eslint . --fix",