nuxt-seo-utils 7.0.4 → 7.0.6

package/dist/module.d.mts

@@ -111,4 +111,5 @@ interface ModuleOptions {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
-export { type ModuleOptions, _default as default };
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -5,9 +5,9 @@
     "nuxt": ">=3.16.0",
     "bridge": false
   },
-  "version": "7.0.3",
+  "version": "7.0.5",
   "builder": {
-    "@nuxt/module-builder": "0.8.4",
-    "unbuild": "2.0.0"
+    "@nuxt/module-builder": "1.0.0",
+    "unbuild": "3.5.0"
   }
 }

package/dist/module.mjs

@@ -211,7 +211,7 @@ async function getImageMeta(base, path, isIcon = false) {
     const altTextPath = resolve(dirname(absolutePath), `${keyword}.alt.txt`);
     if (fs.existsSync(altTextPath)) {
       payload.alt = fs.readFileSync(altTextPath, "utf8");
-      payload.alt = payload.alt.replace(/\n/g, " ").trim();
+      payload.alt = String(payload.alt).replace(/\n/g, " ").trim();
     }
   } else {
     if (path.includes(".dark") || path.includes("-dark"))

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

@@ -68,6 +68,9 @@ export interface BreadcrumbProps {
      */
     rootSegment?: string;
 }
+export type ResolvedBreadcrumbProps = {
+    [key in keyof BreadcrumbProps]: BreadcrumbProps[key] extends MaybeRefOrGetter<infer T> ? T : BreadcrumbProps[key];
+};
 export interface BreadcrumbItemProps extends NuxtUIBreadcrumbItem {
     /** Whether the breadcrumb item represents the aria-current. */
     current?: boolean;

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

@@ -1,15 +1,22 @@
-import {
-  defineBreadcrumb,
-  useI18n,
-  useSchemaOrg
-} from "#imports";
+import { defineBreadcrumb, useI18n, useSchemaOrg } from "#imports";
 import { useSiteConfig } from "#site-config/app/composables/useSiteConfig";
 import { createSitePathResolver } from "#site-config/app/composables/utils";
 import { defu } from "defu";
 import { fixSlashes } from "nuxt-site-config/urls";
 import { useNuxtApp, useRoute, useRouter, useState } from "nuxt/app";
 import { withoutTrailingSlash } from "ufo";
-import { computed, getCurrentInstance, inject, onScopeDispose, onUnmounted, provide, ref, toRaw, toValue } from "vue";
+import {
+  computed,
+  getCurrentInstance,
+  inject,
+  onScopeDispose,
+  onUnmounted,
+  provide,
+  ref,
+  toRaw,
+  toValue,
+  watch
+} from "vue";
 import { pathBreadcrumbSegments } from "../../shared/breadcrumbs.js";
 function withoutQuery(path) {
   return path.split("?")[0];
@@ -20,7 +27,13 @@ function titleCase(s) {
 const BreadcrumbCtx = Symbol("BreadcrumbCtx");
 export function useBreadcrumbItems(_options = {}) {
   const vm = getCurrentInstance();
-  const id = _options.id || "breadcrumb";
+  const id = `${vm?.uid || 0}:${_options.id || "breadcrumb"}`;
+  const parentChain = [];
+  let parent = vm?.parent;
+  while (parent) {
+    parentChain.push(parent.uid);
+    parent = parent.parent;
+  }
   const pauseUpdates = ref(import.meta.client);
   let stateRef = null;
   if (vm) {
@@ -30,17 +43,12 @@ export function useBreadcrumbItems(_options = {}) {
       provide(BreadcrumbCtx, stateRef);
     }
     const state = stateRef.value;
-    if (!state[id]) {
-      state[id] = [];
-    }
-    const idx = state[id].push(_options) - 1;
+    state[id] = _options;
     stateRef.value = state;
     onUnmounted(() => {
       const state2 = toRaw(stateRef.value);
-      if (state2[id]) {
-        state2[id] = state2[id].map((_, i) => i === idx ? false : _);
-        stateRef.value = state2;
-      }
+      delete state2[id];
+      stateRef.value = state2;
     });
     if (import.meta.client) {
       const nuxtApp = useNuxtApp();
@@ -78,10 +86,33 @@ export function useBreadcrumbItems(_options = {}) {
     if (import.meta.client && pauseUpdates.value) {
       return lastBreadcrumbs.value;
     }
-    const optionStack = stateRef?.value?.[id] || [_options];
-    const flatOptions = toRaw([...optionStack]).filter(Boolean).reduce((acc, cur) => {
+    const state = toValue(stateRef) || {};
+    const optionStack = [...parentChain, vm?.uid || 0].map((parentId) => state[`${parentId}:${_options.id || "breadcrumb"}`]).filter(Boolean);
+    const flatOptions = optionStack.reduce((acc, _cur) => {
+      const cur = {};
+      Object.entries(_cur).forEach(([key, value]) => {
+        cur[key] = toValue(value);
+      });
+      acc.hideRoot = typeof cur.hideRoot === "undefined" ? acc.hideRoot : cur.hideRoot;
+      acc.hideCurrent = typeof cur.hideCurrent === "undefined" ? acc.hideCurrent : cur.hideCurrent;
       acc.rootSegment = acc.rootSegment || cur.rootSegment;
       acc.path = acc.path || cur.path;
+      acc.overrides = acc.overrides || [];
+      const overrides = toRaw(toValue(cur.overrides));
+      if (overrides) {
+        overrides.forEach((item, index) => {
+          if (item !== void 0) {
+            acc.overrides[index] = toRaw(toValue(item));
+          }
+        });
+      }
+      const prepend = toRaw(toValue(cur.prepend));
+      const append = toRaw(toValue(cur.append));
+      if (prepend && prepend.length) {
+        acc.prepend = [...acc.prepend || [], ...prepend.map((m) => toRaw(toValue(m)))].filter(Boolean);
+      }
+      if (append && append.length)
+        acc.append = [...acc.append || [], ...append.map((m) => toRaw(toValue(m)))].filter(Boolean);
       return acc;
     }, {});
     let rootNode = flatOptions.rootSegment || "/";
@@ -89,36 +120,22 @@ export function useBreadcrumbItems(_options = {}) {
       if (i18n.strategy === "prefix" || i18n.strategy !== "no_prefix" && toValue(i18n.defaultLocale) !== toValue(i18n.locale))
         rootNode = `${rootNode}${toValue(i18n.locale)}`;
     }
-    const current = withoutQuery(withoutTrailingSlash(toValue(flatOptions.path) || toRaw(route).path || rootNode));
-    const allOverrides = toRaw([...optionStack]).filter(Boolean)?.map((opts) => toValue(opts.overrides)).filter(Boolean);
-    const flatOverrides = allOverrides?.reduce((acc, i) => {
-      if (i) {
-        i.forEach((item, index) => {
-          if (item !== void 0) {
-            acc[index] = item;
-          }
-        });
-      }
-      return acc;
-    }, []) || {};
+    const current = withoutQuery(withoutTrailingSlash(flatOptions.path || toRaw(route).path || rootNode));
     const segments = pathBreadcrumbSegments(current, rootNode).map((path, index) => {
       let item = {
         to: path
       };
-      if (typeof flatOverrides[index] !== "undefined") {
-        if (flatOverrides[index] === false)
+      const override = flatOptions.overrides[index];
+      if (typeof override !== "undefined") {
+        if (override === false)
           return false;
-        item = defu(flatOverrides[index], item);
+        item = defu(override, item);
       }
       return item;
     });
-    const allPrepends = toRaw([...optionStack]).filter(Boolean).flatMap((opts) => toValue(opts.prepend)).filter(Boolean);
-    const allAppends = toRaw([...optionStack]).filter(Boolean).flatMap((opts) => toValue(opts.append)).filter(Boolean);
-    if (allPrepends.length)
-      segments.unshift(...allPrepends);
-    if (allAppends.length)
-      segments.push(...allAppends);
-    lastBreadcrumbs.value = segments.filter(Boolean).map((item) => {
+    segments.unshift(...flatOptions.prepend || []);
+    segments.push(...flatOptions.append || []);
+    return segments.filter(Boolean).map((item) => {
       let fallbackLabel = titleCase(String((item.to || "").split("/").pop()));
       let fallbackAriaLabel = "";
       const route2 = item.to ? router.resolve(item.to)?.matched?.[0] : null;
@@ -130,7 +147,7 @@ export function useBreadcrumbItems(_options = {}) {
             ...routeMeta.breadcrumb
           };
         }
-        const routeName = String(route2.name).split("___")[0];
+        const routeName = String(route2.name).split("___")?.[0];
         if (routeName === "index") {
           fallbackLabel = "Home";
         }
@@ -141,19 +158,23 @@ export function useBreadcrumbItems(_options = {}) {
       item.label = item.label || fallbackLabel;
       item.ariaLabel = item.ariaLabel || fallbackAriaLabel || item.label;
       item.current = item.current || item.to === current;
-      if (toValue(flatOptions.hideCurrent) && item.current)
+      if (flatOptions.hideCurrent && item.current)
         return false;
       return item;
     }).map((m) => {
       if (m && m.to) {
         m.to = fixSlashes(siteConfig.trailingSlash, m.to);
-        if (m.to === rootNode && toValue(flatOptions.hideRoot))
+        if (m.to === rootNode && flatOptions.hideRoot)
           return false;
       }
       return m;
     }).filter(Boolean);
-    return lastBreadcrumbs.value;
   });
+  watch(items, (newItems) => {
+    if (!pauseUpdates.value) {
+      lastBreadcrumbs.value = newItems;
+    }
+  }, { immediate: true });
   const schemaOrgEnabled = typeof _options.schemaOrg === "undefined" ? true : _options.schemaOrg;
   if ((import.meta.dev || import.meta.server || import.meta.env?.NODE_ENV === "test") && schemaOrgEnabled) {
     useSchemaOrg([

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

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

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

@@ -4,12 +4,14 @@ import { createSitePathResolver } from "#site-config/app/composables/utils";
 import { TemplateParamsPlugin } from "@unhead/vue/plugins";
 import { useError, useRoute, useRuntimeConfig } from "nuxt/app";
 import { stringifyQuery } from "ufo";
-import { computed } from "vue";
-export function applyDefaults(i18n) {
+import { computed, toValue } from "vue";
+export function applyDefaults() {
+  const siteConfig = useSiteConfig({
+    resolveRefs: false
+  });
   const head = injectHead();
   head.use(TemplateParamsPlugin);
   const { canonicalQueryWhitelist, canonicalLowercase } = useRuntimeConfig().public["seo-utils"];
-  const siteConfig = useSiteConfig();
   const route = useRoute();
   const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });
   const err = useError();
@@ -38,7 +40,7 @@ export function applyDefaults(i18n) {
     tagPriority: "low"
   };
   useHead({
-    htmlAttrs: { lang: i18n.locale },
+    htmlAttrs: { lang: siteConfig.currentLocale },
     templateParams: {
       site: () => siteConfig,
       siteName: () => siteConfig.name
@@ -53,10 +55,11 @@ export function applyDefaults(i18n) {
       return url ? url.href : false;
     },
     ogLocale: () => {
-      if (i18n.locale.value) {
-        const locale = i18n.locale.value.replace("-", "_");
-        if (locale.includes("_")) {
-          return locale;
+      const locale = toValue(siteConfig.currentLocale);
+      if (locale) {
+        const l = locale.replace("-", "_");
+        if (l.includes("_")) {
+          return l;
         }
       }
       return false;

package/dist/runtime/app/plugins/defaults.js

@@ -1,6 +1,4 @@
-import { useSiteConfig } from "#site-config/app/composables/useSiteConfig";
 import { defineNuxtPlugin } from "nuxt/app";
-import { ref } from "vue";
 import { applyDefaults } from "../logic/applyDefaults.js";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",
@@ -9,10 +7,6 @@ export default defineNuxtPlugin({
     islands: false
   },
   setup() {
-    const siteConfig = useSiteConfig();
-    const locale = ref(siteConfig.currentLocale || siteConfig.defaultLocale);
-    applyDefaults({
-      locale
-    });
+    applyDefaults();
   }
 });

package/dist/runtime/app/plugins/defaultsWaitI18n.js

@@ -1,6 +1,4 @@
-import { useSiteConfig } from "#site-config/app/composables/useSiteConfig";
 import { defineNuxtPlugin } from "nuxt/app";
-import { ref } from "vue";
 import { applyDefaults } from "../logic/applyDefaults.js";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",
@@ -9,12 +7,7 @@ export default defineNuxtPlugin({
   },
   // we need to wait for the i18n plugin to run first
   dependsOn: ["nuxt-site-config:i18n"],
-  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 });
+  setup() {
+    applyDefaults();
   }
 });

package/dist/runtime/app/plugins/inferSeoMetaPlugin.js

@@ -1,9 +1,11 @@
 import { injectHead } from "#imports";
 import { InferSeoMetaPlugin } from "@unhead/addons";
 import { defineNuxtPlugin } from "nuxt/app";
+import { TemplateParamsPlugin } from "unhead/plugins";
 export default defineNuxtPlugin(() => {
   const head = injectHead();
   if (!head)
     return;
+  head.use(TemplateParamsPlugin);
   head.use(InferSeoMetaPlugin());
 });

package/dist/runtime/server/middleware/resolveImagesInPagesDir.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<Buffer | undefined>>;
+declare const _default: import("h3").EventHandler<import("h3").EventHandlerRequest, Promise<Buffer<ArrayBufferLike> | undefined>>;
 export default _default;

package/dist/types.d.mts

@@ -1 +1,3 @@
-export { type ModuleOptions, default } from './module.js'
+export { default } from './module.mjs'
+
+export { type ModuleOptions } from './module.mjs'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-seo-utils",
   "type": "module",
-  "version": "7.0.4",
+  "version": "7.0.6",
   "description": "SEO utilities to improve your Nuxt sites discoverability and shareability",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -15,13 +15,11 @@
   },
   "exports": {
     ".": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.cjs"
+      "types": "./dist/types.d.mts",
+      "import": "./dist/module.mjs"
     }
   },
-  "main": "./dist/module.cjs",
-  "types": "./dist/types.d.ts",
+  "main": "./dist/module.mjs",
   "files": [
     "dist"
   ],
@@ -34,13 +32,13 @@
     ]
   },
   "dependencies": {
-    "@nuxt/kit": "^3.16.0",
-    "@unhead/addons": "^2.0.0-rc.12",
+    "@nuxt/kit": "^3.16.2",
+    "@unhead/addons": "^2.0.4",
     "defu": "^6.1.4",
     "escape-string-regexp": "^5.0.0",
     "fast-glob": "^3.3.3",
-    "image-size": "^2.0.0",
-    "nuxt-site-config": "^3.1.5",
+    "image-size": "^2.0.2",
+    "nuxt-site-config": "^3.1.7",
     "pathe": "^2.0.3",
     "pkg-types": "^2.1.0",
     "scule": "^1.3.0",
@@ -48,33 +46,30 @@
     "ufo": "^1.5.4"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "4.10.1",
-    "@nuxt/module-builder": "^0.8.4",
-    "@nuxt/schema": "3.16.0",
+    "@antfu/eslint-config": "4.11.0",
+    "@nuxt/module-builder": "^1.0.0",
+    "@nuxt/schema": "3.16.2",
     "@nuxt/test-utils": "^3.17.2",
-    "@nuxt/ui": "^3.0.0",
+    "@nuxt/ui": "^3.0.2",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@nuxtjs/i18n": "^9.3.1",
-    "@unhead/vue": "2.0.0-rc.12",
+    "@nuxtjs/i18n": "^9.5.2",
+    "@types/node": "^22.14.0",
+    "@unhead/vue": "2.0.4",
     "@vue/test-utils": "^2.4.6",
     "bumpp": "^10.1.0",
-    "case-police": "^1.0.0",
+    "case-police": "^2.0.0",
     "cheerio": "1.0.0",
-    "eslint": "^9.22.0",
+    "eslint": "^9.24.0",
     "happy-dom": "^17.4.4",
     "markdownlint-cli": "^0.44.0",
-    "nuxt": "^3.16.0",
+    "nuxt": "3.16.2",
     "nuxt-content-twoslash": "^0.1.2",
-    "playwright-core": "^1.51.0",
-    "sass": "^1.85.1",
-    "typescript": "5.8.2",
-    "vitest": "^3.0.8",
+    "playwright-core": "^1.51.1",
+    "sass": "^1.86.3",
+    "typescript": "5.8.3",
+    "vitest": "^3.1.1",
     "vue-tsc": "^2.2.8"
   },
-  "resolutions": {
-    "nuxt": "3.16.0",
-    "typescript": "5.6.3"
-  },
   "scripts": {
     "lint": "eslint . --fix",
     "stub": "nuxt-build-module build --stub && nuxt-module-build prepare",

package/dist/module.cjs

@@ -1,5 +0,0 @@
-module.exports = function(...args) {
-  return import('./module.mjs').then(m => m.default.call(this, ...args))
-}
-const _meta = module.exports.meta = require('./module.json')
-module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.ts

@@ -1,114 +0,0 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { MetaFlatSerializable } from '../dist/runtime/types.js';
-
-interface ModuleOptions {
-    /**
-     * Whether the SEO experiements should run.
-     *
-     * @default true
-     */
-    enabled: boolean;
-    /**
-     * Should the files in the public directory be used to infer tags such as favicon, apple-touch-icon, and
-     * open graph images.
-     *
-     * @default true
-     */
-    metaDataFiles: boolean;
-    /**
-     * Should head data be inferred from the current input to fill in the gaps.
-     *
-     * For example:
-     * - If you supply a title, this will automatically add an og:title.
-     * - If you provide an og:image, it will automatically add a twitter:image.
-     *
-     * @default true
-     */
-    automaticOgAndTwitterTags: boolean;
-    /**
-     * Attempts to treeshake the `useSeoMeta` function. Can save around 5kb in the client bundle.
-     *
-     * @default true
-     */
-    treeShakeUseSeoMeta: boolean;
-    /**
-     * Injects site config into the `useHead` composable such as setting the title template
-     *
-     * @default true
-     */
-    mergeWithSiteConfig: boolean;
-    /**
-     * Adds `head` and `seoMeta` to the route rules and app config.
-     *
-     * @default true
-     */
-    extendRouteRules: boolean;
-    /**
-     * Tries to convert relative image paths to absolute paths in meta tags.
-     *
-     * @default true
-     */
-    fixRequiredAbsoluteMetaTagsLinks: boolean;
-    /**
-     * Extends the `head` in the Nuxt config with the `seoMeta` object.
-     *
-     * @default true
-     */
-    extendNuxtConfigAppHeadSeoMeta: boolean;
-    /**
-     * Augments the head schema with `/public` files making it easier to reference them in the head.
-     *
-     * @default true
-     */
-    extendNuxtConfigAppHeadTypes: boolean;
-    /**
-     * @dead
-     */
-    setupNuxtConfigAppHeadWithMoreDefaults: boolean;
-    /**
-     * Will ensure a title is always set by providing a fallback title based on the casing the last slug segment.
-     *
-     * @default true
-     */
-    fallbackTitle?: boolean;
-    /**
-     * Will set up a number of defaults for meta tags and Schema.org, if the modules and config are available.
-     *
-     * @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 lowercase the canonical URL.
-     *
-     * @default true
-     */
-    canonicalLowercase?: boolean;
-    /**
-     * When enabled, it will redirect any request to the canonical domain (site url) using a 301 redirect on non-dev environments.
-     *
-     * E.g if the site url is 'www.example.com' and the user visits 'example.com',
-     * they will be redirected to 'www.example.com'.
-     *
-     * This is useful for SEO as it prevents duplicate content and consolidates page rank.
-     *
-     * @default false
-     */
-    redirectToCanonicalSiteUrl?: boolean;
-    /**
-     * The SEO meta object to be used as defaults.
-     */
-    meta: MetaFlatSerializable;
-    /**
-     * Enables debug logs and a debug endpoint.
-     *
-     * @default false
-     */
-    debug: boolean;
-}
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
-
-export { type ModuleOptions, _default as default };

package/dist/types.d.ts

@@ -1 +0,0 @@
-export { type ModuleOptions, default } from './module'