@nuxtjs/seo 2.0.0-rc.16 → 2.0.0-rc.18

package/dist/module.d.mts

@@ -13,6 +13,10 @@ interface ModuleOptions {
      * @default true
      */
     automaticDefaults?: boolean;
+    /**
+     * When enabled, it will whitelist the query parameters that are allowed in the canonical URL.
+     */
+    canonicalQueryWhitelist?: string[];
     /**
      * When enabled, it will redirect any request to the canonical domain (site url) using a 301 redirect on non-dev environments.
      *

package/dist/module.d.ts

@@ -13,6 +13,10 @@ interface ModuleOptions {
      * @default true
      */
     automaticDefaults?: boolean;
+    /**
+     * When enabled, it will whitelist the query parameters that are allowed in the canonical URL.
+     */
+    canonicalQueryWhitelist?: string[];
     /**
      * When enabled, it will redirect any request to the canonical domain (site url) using a 301 redirect on non-dev environments.
      *

package/dist/module.json

@@ -5,7 +5,7 @@
     "bridge": false
   },
   "configKey": "seo",
-  "version": "2.0.0-rc.15",
+  "version": "2.0.0-rc.17",
   "builder": {
     "@nuxt/module-builder": "0.8.1",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -44,15 +44,21 @@ const module = defineNuxtModule({
     await installNuxtSiteConfig();
     for (const module of Modules)
       await installModule(await resolvePath(module));
+    nuxt.options.runtimeConfig.public["nuxt-seo"] = {
+      canonicalQueryWhitelist: config.canonicalQueryWhitelist || [
+        "page",
+        "sort",
+        "filter",
+        "search",
+        "q",
+        "category",
+        "tag"
+      ]
+    };
     if (config.automaticDefaults) {
       if (hasNuxtModule("@nuxtjs/i18n")) {
         addPlugin({
-          src: resolve(`./runtime/nuxt/plugin/defaultsWaitI18n.server`),
-          mode: "server"
-        });
-        addPlugin({
-          src: resolve(`./runtime/nuxt/plugin/defaults`),
-          mode: "client"
+          src: resolve(`./runtime/nuxt/plugin/defaultsWaitI18n`)
         });
       } else {
         addPlugin({

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

@@ -5,6 +5,6 @@ export declare function useI18n(): {
     t: (_: string, fallback: string) => string;
     te: (_: string) => boolean;
     strategy: string;
-    defaultLocale: import("#imports").Ref<any>;
-    locale: import("#imports").Ref<any>;
+    defaultLocale: import("vue").Ref<any, any>;
+    locale: import("vue").Ref<any, any>;
 };

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

@@ -82,5 +82,5 @@ export interface BreadcrumbItemProps extends NuxtUIBreadcrumbItem {
         last: boolean;
     };
 }
-export declare function useBreadcrumbItems(options?: BreadcrumbProps): import("#imports").ComputedRef<BreadcrumbItemProps[]>;
+export declare function useBreadcrumbItems(options?: BreadcrumbProps): import("vue").ComputedRef<BreadcrumbItemProps[]>;
 export {};

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

@@ -1,5 +1,6 @@
 import { withoutTrailingSlash } from "ufo";
 import { defu } from "defu";
+import { fixSlashes } from "site-config-stack/urls";
 import { pathBreadcrumbSegments } from "../../pure/breadcrumbs.js";
 import {
   computed,
@@ -10,7 +11,7 @@ import {
   useRoute,
   useRouter,
   useSchemaOrg,
-  withSiteTrailingSlash
+  useSiteConfig
 } from "#imports";
 function withoutQuery(path) {
   return path.split("?")[0];
@@ -26,6 +27,7 @@ export function useBreadcrumbItems(options = {}) {
     canonical: true,
     absolute: true
   });
+  const siteConfig = useSiteConfig();
   const items = computed(() => {
     let rootNode = "/";
     if (i18n) {
@@ -74,7 +76,7 @@ export function useBreadcrumbItems(options = {}) {
       return item;
     }).map((m) => {
       if (m && m.to) {
-        m.to = withSiteTrailingSlash(m.to).value;
+        m.to = fixSlashes(siteConfig.trailingSlash, m.to);
         if (m.to === rootNode && toValue(options.hideRoot))
           return false;
       }

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

@@ -1 +1,4 @@
-export declare function applyDefaults(): void;
+import type { Ref } from 'vue';
+export declare function applyDefaults(i18n: {
+    locale: Ref<string>;
+}): void;

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

@@ -1,38 +1,40 @@
+import { stringifyQuery } from "ufo";
 import {
   computed,
   createSitePathResolver,
   useHead,
   useRoute,
+  useRuntimeConfig,
   useSeoMeta,
-  useServerHead,
   useSiteConfig
 } from "#imports";
-export function applyDefaults() {
+export function applyDefaults(i18n) {
+  const { canonicalQueryWhitelist } = useRuntimeConfig().public["nuxt-seo"];
   const siteConfig = useSiteConfig();
   const route = useRoute();
   const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });
-  const canonicalUrl = computed(() => resolveUrl(route.path || "/").value || route.path);
+  const canonicalUrl = computed(() => {
+    const { query } = route;
+    const url = resolveUrl(route.path || "/").value || route.path;
+    const filteredQuery = Object.fromEntries(
+      Object.entries(query).filter(([key]) => canonicalQueryWhitelist.includes(key))
+    );
+    return Object.keys(filteredQuery).length ? `${url}?${stringifyQuery(filteredQuery)}` : url;
+  });
   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({
+    htmlAttrs: { lang: i18n.locale },
     templateParams: { site: siteConfig, siteName: siteConfig.name || "" },
-    titleTemplate: "%s %separator %siteName"
+    titleTemplate: "%s %separator %siteName",
+    link: [{ rel: "canonical", href: () => canonicalUrl.value }]
   }, minimalPriority);
   const seoMeta = {
     ogType: "website",
     ogUrl: () => canonicalUrl.value,
-    ogLocale: locale,
+    ogLocale: () => i18n.locale.value,
     ogSiteName: siteConfig.name
   };
   if (siteConfig.description)

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

@@ -1,11 +1,20 @@
-import { applyDefaults as setup } from "../logic/applyDefaults.js";
+import { applyDefaults } from "../logic/applyDefaults.js";
 import {
-  defineNuxtPlugin
+  defineNuxtPlugin,
+  ref,
+  useSiteConfig
 } from "#imports";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",
+  order: 999,
   env: {
     islands: false
   },
-  setup
+  setup() {
+    const siteConfig = useSiteConfig();
+    const locale = ref(siteConfig.currentLocale || siteConfig.defaultLocale);
+    applyDefaults({
+      locale
+    });
+  }
 });

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

@@ -0,0 +1,23 @@
+import { applyDefaults } from "../logic/applyDefaults.js";
+import { defineNuxtPlugin, ref, useSiteConfig } from "#imports";
+export default defineNuxtPlugin({
+  name: "nuxt-seo:defaults",
+  env: {
+    islands: false
+  },
+  // we need to wait for the i18n plugin to run first
+  // @ts-expect-error dynamic
+  dependsOn: import.meta.server ? [
+    "nuxt-site-config:i18n"
+  ] : [
+    "i18n:plugin"
+  ],
+  setup(nuxtApp) {
+    const siteConfig = useSiteConfig();
+    const locale = ref(nuxtApp.$i18n?.locale?.value || siteConfig.currentLocale || siteConfig.defaultLocale);
+    nuxtApp.hook("i18n:localeSwitched", ({ newLocale }) => {
+      locale.value = newLocale;
+    });
+    applyDefaults({ locale });
+  }
+});

package/package.json

@@ -1,7 +1,8 @@
 {
   "name": "@nuxtjs/seo",
   "type": "module",
-  "version": "2.0.0-rc.16",
+  "version": "2.0.0-rc.18",
+  "packageManager": "pnpm@9.5.0",
   "description": "The all-in-one SEO layer for Nuxt 3.",
   "author": {
     "name": "Harlan Wilton",
@@ -33,7 +34,7 @@
   "dependencies": {
     "@nuxt/kit": "^3.12.3",
     "@nuxtjs/robots": "^4.0.2",
-    "@nuxtjs/sitemap": "^5.3.5",
+    "@nuxtjs/sitemap": "^6.0.0-beta.1",
     "defu": "^6.1.4",
     "nuxt-link-checker": "^3.0.2",
     "nuxt-og-image": "^3.0.0-rc.64",
@@ -47,15 +48,15 @@
   "devDependencies": {
     "@antfu/eslint-config": "^2.23.0",
     "@nuxt/module-builder": "^0.8.1",
-    "@nuxt/schema": "^3.12.3",
-    "@nuxt/test-utils": "3.13.1",
+    "@nuxt/schema": "^3.12.4",
+    "@nuxt/test-utils": "^3.14.0",
     "@nuxt/ui": "^2.17.0",
-    "@nuxtjs/i18n": "^8.3.1",
+    "@nuxtjs/i18n": "^8.3.3",
     "bumpp": "^9.4.1",
     "eslint": "^9.7.0",
     "execa": "^9.3.0",
     "nitropack": "^2.9.7",
-    "nuxt": "^3.12.3",
+    "nuxt": "^3.12.4",
     "typescript": "5.4.5",
     "vitest": "^2.0.3"
   },
@@ -66,6 +67,8 @@
     ]
   },
   "resolutions": {
+    "@nuxt/schema": "3.12.3",
+    "nuxt": "3.12.3",
     "shiki": "1.10.1"
   },
   "scripts": {

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

@@ -1,14 +0,0 @@
-import { applyDefaults as setup } from "../logic/applyDefaults.js";
-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
-});