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

package/README.md

@@ -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.2"
 }

package/dist/module.mjs

@@ -2,11 +2,11 @@ import { defineNuxtModule, useLogger, createResolver, installModule, addPlugin,
 import chalk from 'chalk';
 import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
 
-const version = "2.0.0-rc.1";
+const version = "2.0.0-rc.2";
 
 const Modules = [
   "nuxt-simple-robots",
-  "nuxt-simple-sitemap",
+  "@nuxtjs/sitemap",
   "nuxt-og-image",
   "nuxt-schema-org",
   "nuxt-seo-experiments",

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

@@ -1,8 +1,33 @@
 import type { MaybeRefOrGetter } from 'vue';
 import type { BreadcrumbLink } from '@nuxt/ui/dist/runtime/types';
 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.

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

@@ -1,4 +1,5 @@
 import { withoutTrailingSlash } from "ufo";
+import { defu } from "defu";
 import { pathBreadcrumbSegments } from "../../pure/breadcrumbs.mjs";
 import {
   computed,
@@ -23,13 +24,27 @@ export function useBreadcrumbItems(options = {}) {
   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";
@@ -61,7 +76,8 @@ 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 {

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

@@ -11,7 +11,7 @@ import {
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",
   setup() {
-    const siteConfig = useSiteConfig() || {};
+    const siteConfig = useSiteConfig();
     const route = useRoute();
     const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });
     const canonicalUrl = computed(() => resolveUrl(route.path || "/").value || route.path);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxtjs/seo",
   "type": "module",
-  "version": "2.0.0-rc.1",
+  "version": "2.0.0-rc.3",
   "packageManager": "pnpm@8.14.0",
   "description": "The all-in-one SEO layer for Nuxt 3.",
   "author": {
@@ -19,27 +19,36 @@
   "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",
+    "@nuxt/kit": "^3.9.1",
+    "@nuxtjs/sitemap": "^5.0.1",
     "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",
+    "defu": "^6.1.4",
+    "nuxt-link-checker": "^3.0.0-rc.4",
+    "nuxt-og-image": "3.0.0-rc.23",
+    "nuxt-schema-org": "^3.3.2",
     "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",
+    "nuxt-simple-robots": "^4.0.0-rc.10",
+    "nuxt-site-config": "^2.2.3",
+    "nuxt-site-config-kit": "^2.2.3",
     "ufo": "^1.3.2"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^2.6.1",
     "@nuxt/module-builder": "^0.5.5",
-    "@nuxt/schema": "^3.9.0",
+    "@nuxt/schema": "^3.9.1",
     "@nuxt/test-utils": "3.9.0",
     "@nuxt/ui": "^2.11.1",
     "@nuxtjs/i18n": "8.0.0",
@@ -47,16 +56,17 @@
     "eslint": "^8.56.0",
     "execa": "^8.0.1",
     "nitropack": "^2.8.1",
-    "nuxt": "^3.9.0",
+    "nuxt": "^3.9.1",
+    "nuxt-icon": "^0.6.8",
     "typescript": "^5.3.3",
-    "vitest": "^1.1.1"
+    "vitest": "^1.1.3"
   },
   "scripts": {
     "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build",
     "dev": "nuxi dev .playground",
     "lint": "eslint . --fix",
-    "release": "bumpp && pnpm -r publish --access public",
-    "test": "nuxi prepare .playground && true",
+    "release": "pnpm build && bumpp && pnpm -r publish --access public",
+    "test": "nuxi prepare .playground && vitest",
     "typecheck": "tsc --noEmit --strict"
   }
 }