@nuxtjs/seo 2.0.0-rc.1 → 2.0.0-rc.10

package/README.md

@@ -17,7 +17,7 @@ The complete SEO solution for Nuxt.
 <tbody>
 <td align="center">
 <img width="800" height="0" /><br>
-<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-seo/releases/tag/v2.0.0">v2 Released</a></b> <br>
+<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-seo/releases/tag/v2.0.0">v2 RC is available</a></b> <br>
 <sup> Please report any issues 🐛</sup><br>
 <sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
 <img width="800" height="0" />
@@ -38,7 +38,7 @@ With powerful APIs built for fully dynamic sites and zero-config defaults for st
 
 ## Modules
 
-- 📖 [nuxt-simple-sitemap](https://github.com/nuxt-modules/sitemap) - Sitemap.xml Support
+- 📖 [@nuxtjs/sitemap](https://github.com/nuxt-modules/sitemap) - Sitemap.xml Support
 - 🤖 [nuxt-simple-robots](https://github.com/harlan-zw/nuxt-simple-robots) - Manage site crawling
 - 🔎 [nuxt-schema-org](https://unhead-schema-org.harlanzw.com/) - Generate Schema.org JSON-LD for SEO
 - △ [nuxt-seo-experiments](https://github.com/harlan-zw/nuxt-seo-experiments) - Experimental SEO meta features

package/dist/module.json

@@ -5,5 +5,5 @@
     "bridge": false
   },
   "configKey": "seo",
-  "version": "2.0.0-rc.1"
+  "version": "2.0.0-rc.9"
 }

package/dist/module.mjs

@@ -1,12 +1,12 @@
-import { defineNuxtModule, useLogger, createResolver, installModule, addPlugin, hasNuxtModule, addImports, addServerHandler } from '@nuxt/kit';
-import chalk from 'chalk';
+import { defineNuxtModule, createResolver, useLogger, installModule, hasNuxtModule, addPlugin, addImports, addServerHandler } from '@nuxt/kit';
+import { colors } from 'consola/utils';
 import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
-
-const version = "2.0.0-rc.1";
+import { readPackageJSON } from 'pkg-types';
+import { $fetch } from 'ofetch';
 
 const Modules = [
   "nuxt-simple-robots",
-  "nuxt-simple-sitemap",
+  "@nuxtjs/sitemap",
   "nuxt-og-image",
   "nuxt-schema-org",
   "nuxt-seo-experiments",
@@ -32,20 +32,32 @@ const module = defineNuxtModule({
     };
   },
   async setup(config, nuxt) {
-    const logger = useLogger("@nuxtjs/seo");
+    const { resolve, resolvePath } = createResolver(import.meta.url);
+    const { name, version } = await readPackageJSON(resolve("../package.json"));
+    const logger = useLogger(name);
     logger.level = config.debug ? 4 : 3;
     if (config.enabled === false) {
       logger.debug("The module is disabled, skipping setup.");
       return;
     }
-    const { resolve, resolvePath } = createResolver(import.meta.url);
     await installNuxtSiteConfig();
     for (const module of Modules)
       await installModule(await resolvePath(module));
     if (config.automaticDefaults) {
-      addPlugin({
-        src: resolve("./runtime/nuxt/plugin/defaults")
-      });
+      if (hasNuxtModule("@nuxtjs/i18n")) {
+        addPlugin({
+          src: resolve(`./runtime/nuxt/plugin/defaultsWaitI18n.server`),
+          mode: "server"
+        });
+        addPlugin({
+          src: resolve(`./runtime/nuxt/plugin/defaults`),
+          mode: "client"
+        });
+      } else {
+        addPlugin({
+          src: resolve(`./runtime/nuxt/plugin/defaults`)
+        });
+      }
     }
     if (config.fallbackTitle) {
       addPlugin({
@@ -67,10 +79,10 @@ const module = defineNuxtModule({
     };
     for (const [module, composables] of Object.entries(polyfills)) {
       if (nuxt.options[module]?.enable === false) {
-        composables.forEach((name) => {
+        composables.forEach((name2) => {
           addImports({
             from: resolve("./runtime/nuxt/composables/polyfills"),
-            name
+            name: name2
           });
         });
       }
@@ -82,18 +94,19 @@ const module = defineNuxtModule({
         middleware: true
       });
     }
-    if (config.splash) {
+    if (config.splash && !version.includes("rc") && nuxt.options.dev) {
       logger.log("");
       let latestTag = `v${version}`;
-      try {
-        latestTag = (await $fetch("https://ungh.unjs.io/repos/harlan-zw/nuxt-seo/releases/latest")).release.tag;
-      } catch (e) {
-      }
+      latestTag = (await $fetch("https://ungh.unjs.io/repos/harlan-zw/nuxt-seo/releases/latest", {
+        timeout: 2e3
+      }).catch(() => {
+        return { release: { tag: `v${version}` } };
+      })).release.tag;
       const upToDate = latestTag === `v${version}`;
-      logger.log(`${chalk.green("Nuxt SEO")} ${chalk.yellow(`v${version}`)} ${chalk.gray(`by ${chalk.underline("@harlan_zw")}`)}`);
+      logger.log(`${colors.green("Nuxt SEO")} ${colors.yellow(`v${version}`)} ${colors.gray(`by ${colors.underline("@harlan_zw")}`)}`);
       if (!upToDate)
-        logger.log(`${chalk.gray("  \u251C\u2500 ")}\u{1F389} New version available!${chalk.gray(` Run ${chalk.underline(`npm i @nuxtjs/seo@${latestTag}`)} to update.`)}`);
-      logger.log(chalk.dim("  \u2514\u2500 \u{1F9EA} Help get Nuxt SEO stable by providing feedback https://github.com/harlan-zw/nuxt-seo/discussions/108"));
+        logger.log(`${colors.gray("  \u251C\u2500 ")}\u{1F389} New version available!${colors.gray(` Run ${colors.underline(`npm i @nuxtjs/seo@${latestTag}`)} to update.`)}`);
+      logger.log(colors.dim("  \u2514\u2500 \u{1F9EA} Help get Nuxt SEO stable by providing feedback https://github.com/harlan-zw/nuxt-seo/discussions/108"));
       logger.log("");
     }
   }

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

@@ -4,11 +4,10 @@ import { useNitroOrigin, useSiteConfig } from "#imports";
 export default defineEventHandler((e) => {
   const siteConfig = useSiteConfig(e);
   if (siteConfig.site) {
+    const siteConfigHostName = new URL(e.path, siteConfig.site).hostname;
     const origin = useNitroOrigin(e);
-    if (!siteConfig.site.startsWith(origin)) {
-      const url = new URL(e.path, origin);
-      url.hostname = siteConfig.site;
-      return sendRedirect(e, joinURL(siteConfig.site, url.pathname), 301);
-    }
+    const originHostname = new URL(e.path, origin).hostname;
+    if (originHostname !== siteConfigHostName)
+      return sendRedirect(e, joinURL(siteConfig.site, e.path), 301);
   }
 });

package/dist/runtime/nuxt/composables/useBreadcrumbItems.d.ts

@@ -1,8 +1,48 @@
 import type { MaybeRefOrGetter } from 'vue';
-import type { BreadcrumbLink } from '@nuxt/ui/dist/runtime/types';
+import type { NuxtLinkProps } from 'nuxt/app';
+interface NuxtUIBreadcrumbItem extends NuxtLinkProps {
+    label: string;
+    labelClass?: string;
+    icon?: string;
+    iconClass?: string;
+    as?: string;
+    type?: string;
+    disabled?: boolean;
+    active?: boolean;
+    exact?: boolean;
+    exactQuery?: boolean;
+    exactMatch?: boolean;
+    inactiveClass?: string;
+    [key: string]: any;
+}
 export interface BreadcrumbProps {
+    /**
+     * Generate the breadcrumbs based on a different path than the current route.
+     */
     path?: MaybeRefOrGetter<string>;
+    /**
+     * The id of the breadcrumb list. It's recommended to provide a unique
+     * id when adding multiple breadcrumb lists to the same page.
+     */
     id?: string;
+    /**
+     * Append additional breadcrumb items to the end of the list. This is applied
+     * after the `overrides` option.
+     */
+    append?: BreadcrumbItemProps[];
+    /**
+     * Prepend additional breadcrumb items to the start of the list. This is applied
+     * after the `overrides` option.
+     */
+    prepend?: BreadcrumbItemProps[];
+    /**
+     * Override any of the breadcrumb items based on the index.
+     */
+    overrides?: (BreadcrumbItemProps | false | undefined)[];
+    /**
+     * Should the schema.org breadcrumb be generated.
+     * @default true
+     */
     schemaOrg?: boolean;
     /**
      * The Aria Label for the breadcrumbs.
@@ -22,7 +62,7 @@ export interface BreadcrumbProps {
      */
     hideRoot?: MaybeRefOrGetter<boolean>;
 }
-export interface BreadcrumbItemProps extends BreadcrumbLink {
+export interface BreadcrumbItemProps extends NuxtUIBreadcrumbItem {
     /** Whether the breadcrumb item represents the aria-current. */
     current?: boolean;
     /**
@@ -30,12 +70,9 @@ export interface BreadcrumbItemProps extends BreadcrumbLink {
      * @default 'page'
      */
     ariaCurrent?: 'page' | 'step' | 'location' | 'date' | 'time' | boolean | 'true' | 'false';
-    /** Whether the breadcrumb item is disabled. */
-    disabled?: boolean;
-    to: string;
+    to?: string;
     ariaLabel?: string;
     separator?: boolean | string;
-    icon?: string;
     class?: (string | string[] | undefined)[] | string;
     /**
      * @internal
@@ -46,3 +83,4 @@ export interface BreadcrumbItemProps extends BreadcrumbLink {
     };
 }
 export declare function useBreadcrumbItems(options?: BreadcrumbProps): any;
+export {};

package/dist/runtime/nuxt/composables/useBreadcrumbItems.mjs

@@ -1,7 +1,9 @@
 import { withoutTrailingSlash } from "ufo";
+import { defu } from "defu";
 import { pathBreadcrumbSegments } from "../../pure/breadcrumbs.mjs";
 import {
   computed,
+  createSitePathResolver,
   defineBreadcrumb,
   toValue,
   useI18n,
@@ -20,22 +22,40 @@ export function useBreadcrumbItems(options = {}) {
   const router = useRouter();
   const routes = router.getRoutes();
   const i18n = useI18n();
+  const siteResolver = createSitePathResolver({
+    canonical: true,
+    absolute: true
+  });
   const items = computed(() => {
     let rootNode = "/";
     if (i18n) {
-      if (i18n.strategy === "prefix" || i18n.strategy !== "no_prefix" && i18n.defaultLocale.value !== i18n.locale.value)
-        rootNode = `/${i18n.defaultLocale.value}`;
+      if (i18n.strategy === "prefix" || i18n.strategy !== "no_prefix" && toValue(i18n.defaultLocale) !== toValue(i18n.locale))
+        rootNode = `/${toValue(i18n.locale)}`;
     }
     const current = withoutQuery(withoutTrailingSlash(toValue(options.path || useRoute().path) || rootNode));
-    return pathBreadcrumbSegments(current, rootNode).map((path) => ({
-      to: path
-    })).map((item) => {
+    const overrides = options.overrides || [];
+    const segments = pathBreadcrumbSegments(current, rootNode).map((path, index) => {
+      let item = {
+        to: path
+      };
+      if (typeof overrides[index] !== "undefined") {
+        if (overrides[index] === false)
+          return false;
+        item = defu(overrides[index], item);
+      }
+      return item;
+    });
+    if (options.prepend)
+      segments.unshift(...options.prepend);
+    if (options.append)
+      segments.push(...options.append);
+    return segments.filter(Boolean).map((item) => {
       const route = routes.find((r) => withoutTrailingSlash(r.path) === withoutTrailingSlash(item.to));
       const routeMeta = route?.meta || {};
       const routeName = route ? String(route.name || route.path) : item.to === "/" ? "index" : "unknown";
       let [name] = routeName.split("___");
       if (name === "unknown")
-        name = item.to.split("/").pop() || "";
+        name = (item.to || "").split("/").pop() || "";
       if (routeMeta.breadcrumb) {
         item = {
           ...item,
@@ -61,14 +81,15 @@ export function useBreadcrumbItems(options = {}) {
       return m;
     }).filter(Boolean);
   });
-  if (process.server && options.schemaOrg) {
+  const schemaOrgEnabled = typeof options.schemaOrg === "undefined" ? true : options.schemaOrg;
+  if (process.server && schemaOrgEnabled) {
     useSchemaOrg([
       defineBreadcrumb(computed(() => {
         return {
           id: `#${options.id || "breadcrumb"}`,
           itemListElement: items.value.map((item) => ({
             name: item.label || item.ariaLabel,
-            item: item.to
+            item: item.to ? siteResolver(item.to) : void 0
           }))
         };
       }))

package/dist/runtime/nuxt/logic/applyDefaults.d.ts

@@ -0,0 +1 @@
+export declare function applyDefaults(): void;

package/dist/runtime/nuxt/logic/applyDefaults.mjs

@@ -0,0 +1,46 @@
+import {
+  computed,
+  createSitePathResolver,
+  useHead,
+  useRoute,
+  useSeoMeta,
+  useServerHead,
+  useSiteConfig
+} from "#imports";
+export function applyDefaults() {
+  const siteConfig = useSiteConfig();
+  const route = useRoute();
+  const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });
+  const canonicalUrl = computed(() => resolveUrl(route.path || "/").value || route.path);
+  const minimalPriority = {
+    // give nuxt.config values higher priority
+    tagPriority: 101
+  };
+  useHead({
+    link: [{ rel: "canonical", href: () => canonicalUrl.value }]
+  });
+  const locale = siteConfig.currentLocale || siteConfig.defaultLocale;
+  if (locale) {
+    useServerHead({
+      htmlAttrs: { lang: locale }
+    });
+  }
+  useHead({
+    templateParams: { site: siteConfig, siteName: siteConfig.name || "" },
+    titleTemplate: "%s %separator %siteName"
+  }, minimalPriority);
+  const seoMeta = {
+    ogType: "website",
+    ogUrl: () => canonicalUrl.value,
+    ogLocale: locale,
+    ogSiteName: siteConfig.name
+  };
+  if (siteConfig.description)
+    seoMeta.description = siteConfig.description;
+  if (siteConfig.twitter) {
+    const id = siteConfig.twitter.startsWith("@") ? siteConfig.twitter : `@${siteConfig.twitter}`;
+    seoMeta.twitterCreator = id;
+    seoMeta.twitterSite = id;
+  }
+  useSeoMeta(seoMeta, minimalPriority);
+}

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

@@ -1,49 +1,11 @@
+import { applyDefaults as setup } from "../logic/applyDefaults.mjs";
 import {
-  computed,
-  createSitePathResolver,
-  defineNuxtPlugin,
-  useHead,
-  useRoute,
-  useSeoMeta,
-  useServerHead,
-  useSiteConfig
+  defineNuxtPlugin
 } from "#imports";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",
-  setup() {
-    const siteConfig = useSiteConfig() || {};
-    const route = useRoute();
-    const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });
-    const canonicalUrl = computed(() => resolveUrl(route.path || "/").value || route.path);
-    const minimalPriority = {
-      // give nuxt.config values higher priority
-      tagPriority: 101
-    };
-    useHead({
-      link: [{ rel: "canonical", href: () => canonicalUrl.value }]
-    });
-    const locale = siteConfig.currentLocale || siteConfig.defaultLocale;
-    if (locale) {
-      useServerHead({
-        htmlAttrs: { lang: locale }
-      });
-    }
-    useHead({
-      templateParams: { site: siteConfig, siteName: siteConfig.name || "" },
-      titleTemplate: "%s %separator %siteName"
-    }, minimalPriority);
-    const seoMeta = {
-      ogUrl: () => canonicalUrl.value,
-      ogLocale: locale,
-      ogSiteName: siteConfig.name
-    };
-    if (siteConfig.description)
-      seoMeta.description = siteConfig.description;
-    if (siteConfig.twitter) {
-      const id = siteConfig.twitter.startsWith("@") ? siteConfig.twitter : `@${siteConfig.twitter}`;
-      seoMeta.twitterCreator = id;
-      seoMeta.twitterSite = id;
-    }
-    useSeoMeta(seoMeta, minimalPriority);
-  }
+  env: {
+    islands: false
+  },
+  setup
 });

package/dist/runtime/nuxt/plugin/defaultsWaitI18n.server.d.ts

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

package/dist/runtime/nuxt/plugin/defaultsWaitI18n.server.mjs

@@ -0,0 +1,14 @@
+import { applyDefaults as setup } from "../logic/applyDefaults.mjs";
+import { defineNuxtPlugin } from "#imports";
+export default defineNuxtPlugin({
+  name: "nuxt-seo:defaults",
+  env: {
+    islands: false
+  },
+  // we need to wait for the i18n plugin to run first
+  dependsOn: [
+    // @ts-expect-error dynamic
+    "nuxt-site-config:i18n"
+  ],
+  setup
+});

package/dist/runtime/nuxt/plugin/titles.mjs

@@ -10,6 +10,9 @@ function titleCase(s) {
 }
 export default defineNuxtPlugin({
   name: "nuxt-seo:fallback-titles",
+  env: {
+    islands: false
+  },
   setup() {
     const route = useRoute();
     const title = computed(() => {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@nuxtjs/seo",
   "type": "module",
-  "version": "2.0.0-rc.1",
-  "packageManager": "pnpm@8.14.0",
+  "version": "2.0.0-rc.10",
+  "packageManager": "pnpm@8.15.5",
   "description": "The all-in-one SEO layer for Nuxt 3.",
   "author": {
     "name": "Harlan Wilton",
@@ -19,44 +19,61 @@
   "bugs": {
     "url": "https://github.com/harlan-zw/nuxt-seo/issues"
   },
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
+  },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@nuxt/kit": "^3.9.0",
-    "chalk": "^5.3.0",
-    "defu": "^6.1.3",
-    "nuxt-link-checker": "^3.0.0-rc.3",
-    "nuxt-og-image": "^3.0.0-rc.21",
-    "nuxt-schema-org": "^3.3.0",
-    "nuxt-seo-experiments": "^4.0.0-rc.0",
-    "nuxt-simple-robots": "^4.0.0-rc.9",
-    "nuxt-simple-sitemap": "^4.4.1",
-    "nuxt-site-config": "^2.2.0",
-    "nuxt-site-config-kit": "^2.2.0",
-    "ufo": "^1.3.2"
+    "@nuxt/kit": "^3.11.1",
+    "@nuxtjs/sitemap": "^5.1.2",
+    "defu": "^6.1.4",
+    "nuxt-link-checker": "^3.0.0-rc.7",
+    "nuxt-og-image": "^3.0.0-rc.47",
+    "nuxt-schema-org": "^3.3.6",
+    "nuxt-seo-experiments": "4.0.0-rc.5",
+    "nuxt-simple-robots": "4.0.0-rc.16",
+    "nuxt-site-config": "^2.2.11",
+    "nuxt-site-config-kit": "^2.2.11",
+    "pkg-types": "^1.0.3",
+    "ufo": "^1.5.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^2.6.1",
+    "@antfu/eslint-config": "^2.9.0",
     "@nuxt/module-builder": "^0.5.5",
-    "@nuxt/schema": "^3.9.0",
-    "@nuxt/test-utils": "3.9.0",
-    "@nuxt/ui": "^2.11.1",
-    "@nuxtjs/i18n": "8.0.0",
-    "bumpp": "^9.2.1",
-    "eslint": "^8.56.0",
+    "@nuxt/schema": "^3.11.1",
+    "@nuxt/test-utils": "3.12.0",
+    "@nuxt/ui": "^2.14.2",
+    "@nuxtjs/i18n": "8.2.0",
+    "bumpp": "^9.4.0",
+    "eslint": "^8.57.0",
     "execa": "^8.0.1",
-    "nitropack": "^2.8.1",
-    "nuxt": "^3.9.0",
-    "typescript": "^5.3.3",
-    "vitest": "^1.1.1"
+    "nitropack": "^2.9.4",
+    "nuxt": "^3.11.1",
+    "nuxt-icon": "^0.6.10",
+    "typescript": "^5.4.3",
+    "vitest": "^1.4.0"
+  },
+  "build": {
+    "externals": [
+      "ofetch",
+      "consola/utils"
+    ]
   },
   "scripts": {
     "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build",
     "dev": "nuxi dev .playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare .playground",
     "lint": "eslint . --fix",
-    "release": "bumpp && pnpm -r publish --access public",
-    "test": "nuxi prepare .playground && true",
-    "typecheck": "tsc --noEmit --strict"
+    "release": "pnpm build && bumpp && pnpm -r publish --access public",
+    "test": "nuxi prepare .playground && vitest",
+    "typecheck": "npx vue-tsc --noEmit --strict"
   }
 }