nuxt-schema-org 3.3.9 → 3.4.0

package/dist/module.mjs

@@ -1,10 +1,10 @@
-import { useNuxt, createResolver, addTemplate, defineNuxtModule, useLogger, addPlugin, addComponent, addImports, addServerHandler } from '@nuxt/kit';
+import { useNuxt, createResolver, addTemplate, defineNuxtModule, useLogger, hasNuxtModule, addPlugin, addComponent, addImports, addServerHandler } from '@nuxt/kit';
 import { schemaOrgAutoImports, schemaOrgComponents } from '@unhead/schema-org/vue';
 import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
 import { existsSync } from 'node:fs';
 import { relative } from 'pathe';
 
-const version = "3.3.8";
+const version = "3.3.9";
 
 const DEVTOOLS_UI_ROUTE = "/__nuxt-schema-org";
 const DEVTOOLS_UI_LOCAL_PORT = 3030;
@@ -112,14 +112,14 @@ const module = defineNuxtModule({
       nuxt.options.runtimeConfig.public["nuxt-schema-org"] = runtimeConfig;
     else
       nuxt.options.runtimeConfig["nuxt-schema-org"] = runtimeConfig;
-    nuxt.options.build.transpile.push("@unhead/schema-org");
+    const pluginPath = hasNuxtModule("@nuxtjs/i18n") && nuxt.options.i18n?.locales ? "./runtime/nuxt/plugin/i18n" : "./runtime/nuxt/plugin";
     addPlugin({
-      src: resolve("runtime/nuxt/plugin/init"),
+      src: resolve(pluginPath, "init"),
       mode: config.reactive ? "all" : "server"
     });
     if (config.defaults) {
       addPlugin({
-        src: resolve("./runtime/nuxt/plugin/defaults"),
+        src: resolve(pluginPath, "defaults"),
         mode: config.reactive ? "all" : "server"
       });
     }

package/dist/runtime/nitro/routes/__schema-org__/debug.js

@@ -1,5 +1,5 @@
-import { defineEventHandler } from "h3";
 import { useNitroOrigin, useRuntimeConfig } from "#imports";
+import { defineEventHandler } from "h3";
 export default defineEventHandler(async (e) => {
   const _config = useRuntimeConfig();
   const runtimeConfig = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];

package/dist/runtime/nuxt/imports/useSchemaOrg.d.ts

@@ -1,5 +1,5 @@
-import type { useSchemaOrg as _useSchemaOrg } from '@unhead/schema-org/vue';
 import type { ActiveHeadEntry } from '@unhead/schema';
+import type { useSchemaOrg as _useSchemaOrg } from '@unhead/schema-org/vue';
 import type { UnheadAugmentation } from '../../types.js';
 type Input = Parameters<typeof _useSchemaOrg>[0];
 export declare function useSchemaOrg<T extends Input>(input: T): ActiveHeadEntry<UnheadAugmentation<T>> | void;

package/dist/runtime/nuxt/imports/useSchemaOrg.js

@@ -1,4 +1,4 @@
-import { useHead, useRuntimeConfig, useServerHead } from "#imports";
+import { useHead, useRequestEvent, useRuntimeConfig, useServerHead } from "#imports";
 export function useSchemaOrg(input) {
   const _config = useRuntimeConfig();
   const config = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];
@@ -9,6 +9,10 @@ export function useSchemaOrg(input) {
     ...config?.scriptAttributes || {}
   };
   if (import.meta.server) {
+    const event = useRequestEvent();
+    if (typeof event?.context.robots !== "undefined" && !event.context.robots?.indexable) {
+      return;
+    }
     return useServerHead({
       script: [script]
     });

package/dist/runtime/nuxt/plugin/defaults.js

@@ -1,22 +1,18 @@
-import { defu } from "defu";
 import {
   defineNuxtPlugin,
-  defineOrganization,
-  definePerson,
   defineWebPage,
   defineWebSite,
-  useRuntimeConfig,
   useSchemaOrg,
   useSiteConfig
 } from "#imports";
+import { maybeAddIdentitySchemaOrg } from "../util/shared.js";
 export default defineNuxtPlugin({
   name: "nuxt-schema-org:defaults",
+  dependsOn: [
+    "nuxt-schema-org:init"
+  ],
   setup() {
-    const _config = useRuntimeConfig();
-    const runtimeConfig = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];
     const siteConfig = useSiteConfig();
-    if (!siteConfig?.name)
-      return;
     useSchemaOrg([
       defineWebSite({
         name: siteConfig?.name || "",
@@ -25,29 +21,6 @@ export default defineNuxtPlugin({
       }),
       defineWebPage()
     ]);
-    if (runtimeConfig.identity || siteConfig.identity) {
-      const identity = runtimeConfig.identity || siteConfig.identity;
-      let identityPayload = {
-        name: siteConfig.name,
-        url: siteConfig.url
-      };
-      let identityType = "Organization";
-      if (typeof identity !== "string") {
-        identityPayload = defu(identity, identityPayload);
-        identityType = identity.type;
-        delete identityPayload.type;
-      } else {
-        identityType = identity;
-      }
-      if (siteConfig.twitter) {
-        const id = siteConfig.twitter.startsWith("@") ? siteConfig.twitter.slice(1) : siteConfig.twitter;
-        identityPayload.sameAs = [
-          `https://twitter.com/${id}`
-        ];
-      }
-      useSchemaOrg([
-        identityType === "Person" ? definePerson(identityPayload) : defineOrganization(identityPayload)
-      ]);
-    }
+    maybeAddIdentitySchemaOrg();
   }
 });

package/dist/runtime/nuxt/plugin/i18n/defaults.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/nuxt/plugin/i18n/defaults.js

@@ -0,0 +1,75 @@
+import {
+  createSitePathResolver,
+  defineNuxtPlugin,
+  defineWebPage,
+  defineWebSite,
+  useLocalePath,
+  useRuntimeConfig,
+  useSchemaOrg,
+  useSiteConfig
+} from "#imports";
+import { resolveSitePath } from "site-config-stack/urls";
+import { hasProtocol, withHttps } from "ufo";
+import { maybeAddIdentitySchemaOrg } from "../../util/shared.js";
+export default defineNuxtPlugin({
+  name: "nuxt-schema-org:defaults",
+  dependsOn: [
+    "nuxt-schema-org:init"
+  ],
+  setup(nuxtApp) {
+    const siteConfig = useSiteConfig();
+    const pathResolver = createSitePathResolver({
+      canonical: true,
+      absolute: true
+    });
+    if (!nuxtApp.$i18n)
+      return;
+    const localePath = useLocalePath();
+    const locales = nuxtApp.$i18n?.locales.value || [];
+    const siteUrl = pathResolver(localePath("index")).value;
+    const websiteId = `${siteUrl}#website`;
+    const website = defineWebSite({
+      "@id": websiteId,
+      "url": siteUrl,
+      "name": siteConfig?.name || "",
+      "inLanguage": nuxtApp.$i18n.localeProperties.value.language || "",
+      "description": siteConfig.description || ""
+    });
+    const nuxtBase = useRuntimeConfig().app.baseURL || "/";
+    const resolveIdForLocale = (locale) => {
+      if (locale.domain) {
+        return resolveSitePath(localePath("index", locale.code), {
+          absolute: true,
+          siteUrl: hasProtocol(locale.domain, { acceptRelative: false }) ? locale.domain : withHttps(locale.domain),
+          trailingSlash: siteConfig.trailingSlash,
+          base: nuxtBase
+        });
+      }
+      return pathResolver(localePath("index", locale.code)).value;
+    };
+    if (siteConfig.defaultLocale) {
+      if (siteConfig.currentLocale && siteConfig.currentLocale !== siteConfig.defaultLocale) {
+        website.translationOfWork = {
+          "@type": "WebSite",
+          "@id": `${resolveIdForLocale({ code: siteConfig.currentLocale })}#website`
+        };
+      } else {
+        website.workTranslation = locales.filter((locale) => locale.code !== siteConfig.defaultLocale).map((locale) => {
+          return {
+            "@type": "WebSite",
+            "@id": `${resolveIdForLocale(locale)}#website`
+          };
+        });
+      }
+    }
+    useSchemaOrg([
+      website,
+      defineWebPage({
+        isPartOf: {
+          "@id": websiteId
+        }
+      })
+    ]);
+    maybeAddIdentitySchemaOrg();
+  }
+});

package/dist/runtime/nuxt/plugin/i18n/init.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/nuxt/plugin/i18n/init.js

@@ -0,0 +1,10 @@
+import { defineNuxtPlugin } from "#imports";
+import { initPlugin } from "../../util/shared.js";
+export default defineNuxtPlugin({
+  name: "nuxt-schema-org:init",
+  order: 999,
+  dependsOn: ["i18n:plugin"],
+  setup(nuxtApp) {
+    initPlugin(nuxtApp);
+  }
+});

package/dist/runtime/nuxt/plugin/init.js

@@ -1,36 +1,8 @@
-import { SchemaOrgUnheadPlugin } from "@unhead/schema-org";
-import { joinURL } from "ufo";
-import { computed } from "vue";
-import { defineNuxtPlugin, injectHead, useRoute, useRuntimeConfig, useSiteConfig } from "#imports";
+import { defineNuxtPlugin } from "#imports";
+import { initPlugin } from "../util/shared.js";
 export default defineNuxtPlugin({
   name: "nuxt-schema-org:init",
-  enforce: "post",
   setup(nuxtApp) {
-    const head = injectHead();
-    const _config = useRuntimeConfig();
-    const config = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];
-    const route = useRoute();
-    const siteConfig = useSiteConfig();
-    const schemaOrg = computed(() => {
-      return {
-        ...route.meta?.schemaOrg || {},
-        ...siteConfig,
-        url: joinURL(siteConfig.url, route.path),
-        host: siteConfig.url,
-        inLanguage: siteConfig.currentLocale || siteConfig.defaultLocale,
-        path: route.path
-      };
-    });
-    head.push({ templateParams: { schemaOrg } });
-    head.use(
-      SchemaOrgUnheadPlugin({}, async () => {
-        const meta = {};
-        await nuxtApp.hooks.callHook("schema-org:meta", meta);
-        return meta;
-      }, {
-        minify: config.minify,
-        trailingSlash: siteConfig.trailingSlash
-      })
-    );
+    initPlugin(nuxtApp);
   }
 });

package/dist/runtime/nuxt/util/shared.d.ts

@@ -0,0 +1,3 @@
+import type { NuxtApp } from '#app/nuxt';
+export declare function initPlugin(nuxtApp: NuxtApp): void;
+export declare function maybeAddIdentitySchemaOrg(): void;

package/dist/runtime/nuxt/util/shared.js

@@ -0,0 +1,80 @@
+import {
+  createSitePathResolver,
+  defineOrganization,
+  definePerson,
+  injectHead,
+  useRoute,
+  useRuntimeConfig,
+  useSchemaOrg,
+  useSiteConfig
+} from "#imports";
+import { SchemaOrgUnheadPlugin } from "@unhead/schema-org";
+import { defu } from "defu";
+import { withoutTrailingSlash } from "ufo";
+import { computed } from "vue";
+export function initPlugin(nuxtApp) {
+  const head = injectHead();
+  const _config = useRuntimeConfig();
+  const config = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];
+  const route = useRoute();
+  const siteConfig = useSiteConfig();
+  const resolvePath = createSitePathResolver({
+    absolute: false,
+    withBase: true
+  });
+  const resolveUrl = createSitePathResolver({
+    canonical: true,
+    absolute: true,
+    withBase: true
+  });
+  const schemaOrg = computed(() => {
+    return {
+      ...route.meta?.schemaOrg || {},
+      ...siteConfig,
+      url: resolveUrl(route.path),
+      host: withoutTrailingSlash(siteConfig.url),
+      inLanguage: siteConfig.currentLocale || siteConfig.defaultLocale,
+      path: resolvePath(route.path)
+    };
+  });
+  head.push({ templateParams: { schemaOrg } });
+  head.use(
+    SchemaOrgUnheadPlugin({}, async () => {
+      const meta = {};
+      await nuxtApp.hooks.callHook("schema-org:meta", meta);
+      return meta;
+    }, {
+      minify: config.minify,
+      trailingSlash: siteConfig.trailingSlash
+    })
+  );
+}
+export function maybeAddIdentitySchemaOrg() {
+  const _config = useRuntimeConfig();
+  const runtimeConfig = import.meta.client ? _config.public["nuxt-schema-org"] : _config["nuxt-schema-org"] || _config.public["nuxt-schema-org"];
+  const siteConfig = useSiteConfig();
+  if (runtimeConfig.identity || siteConfig.identity) {
+    const identity = runtimeConfig.identity || siteConfig.identity;
+    let identityPayload = {
+      name: siteConfig.name,
+      url: siteConfig.url
+    };
+    let identityType;
+    if (typeof identity !== "string") {
+      identityPayload = defu(identity, identityPayload);
+      identityType = identity.type;
+      delete identityPayload.type;
+    } else {
+      identityType = identity;
+    }
+    if (siteConfig.twitter) {
+      const id = siteConfig.twitter.startsWith("@") ? siteConfig.twitter.slice(1) : siteConfig.twitter;
+      identityPayload.sameAs = [
+        `https://twitter.com/${id}`
+      ];
+    }
+    useSchemaOrg([
+      identityType === "Person" ? definePerson(identityPayload) : defineOrganization(identityPayload)
+    ]);
+  }
+}

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "nuxt-schema-org",
   "type": "module",
-  "version": "3.3.9",
-  "description": "Schema.org for Nuxt",
+  "version": "3.4.0",
+  "description": "The quickest and easiest way to build Schema.org graphs for Nuxt.",
   "author": "Harlan Wilton <harlan@harlanzw.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -34,28 +34,28 @@
     "dist"
   ],
   "dependencies": {
-    "@nuxt/devtools-kit": "^1.3.9",
-    "@nuxt/kit": "^3.12.3",
-    "@unhead/schema-org": "^1.9.16",
-    "nuxt-site-config": "^2.2.15",
-    "nuxt-site-config-kit": "^2.2.15",
+    "@nuxt/devtools-kit": "^1.4.1",
+    "@nuxt/kit": "^3.13.1",
+    "@unhead/schema-org": "^1.11.2",
+    "nuxt-site-config": "^2.2.16",
+    "nuxt-site-config-kit": "^2.2.16",
     "pathe": "^1.1.2",
     "sirv": "^2.0.4"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^2.22.4",
-    "@nuxt/module-builder": "^0.8.1",
-    "@nuxt/schema": "^3.12.3",
-    "@nuxt/test-utils": "^3.13.1",
-    "@nuxt/ui": "^2.17.0",
-    "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@nuxtjs/i18n": "^8.3.1",
-    "bumpp": "^9.4.1",
-    "cheerio": "1.0.0-rc.12",
-    "eslint": "^9.7.0",
-    "nuxt": "^3.12.3",
-    "typescript": "5.4.5",
-    "vitest": "^2.0.3"
+    "@antfu/eslint-config": "^3.5.0",
+    "@nuxt/module-builder": "^0.8.3",
+    "@nuxt/schema": "^3.13.1",
+    "@nuxt/test-utils": "^3.14.1",
+    "@nuxt/ui": "^2.18.4",
+    "@nuxtjs/i18n": "^8.5.2",
+    "@nuxtjs/robots": "^4.1.6",
+    "bumpp": "^9.5.2",
+    "cheerio": "1.0.0",
+    "eslint": "^9.10.0",
+    "nuxt": "^3.13.1",
+    "typescript": "5.5.4",
+    "vitest": "^2.0.5"
   },
   "build": {
     "externals": [
@@ -66,7 +66,7 @@
   "scripts": {
     "lint": "eslint . --fix",
     "client:build": "nuxi generate client",
-    "client:dev": "nuxi dev client --port 3300",
+    "client:dev": "nuxi dev client --port 3030",
     "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && npm run client:build",
     "dev": "nuxi dev playground",
     "dev:build": "nuxi build playground",