nuxt-seo-utils 5.0.2 → 6.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Harlan Wilton
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,26 +1,20 @@
-<h1 align='center'>nuxt-seo-utils</h1>
+<h1>nuxt-seo-utils</h1>
 
-<p align="center">
-<a href='https://github.com/harlan-zw/nuxt-seo-utils/actions/workflows/test.yml'>
-</a>
-<a href="https://www.npmjs.com/package/nuxt-seo-utils" target="__blank"><img src="https://img.shields.io/npm/v/nuxt-seo-utils?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
-<a href="https://www.npmjs.com/package/nuxt-seo-utils" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/nuxt-seo-utils?flat&colorA=002438&colorB=28CF8D"></a>
-<a href="https://github.com/harlan-zw/nuxt-seo-utils" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/harlan-zw/nuxt-seo-utils?flat&colorA=002438&colorB=28CF8D"></a>
-</p>
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
 
-<p align="center">
-SEO utilities for Nuxt to help you make your site more discoverable and shareable.
-</p>
+Nuxt SEO Utils is a collection of defaults and utilities to improve your Nuxt site's discoverability and shareability.
+
+While there are several features covering many aspects of SEO, it covers important defaults such as [automatic canonical URLs](https://nuxtseo.com/learn/controlling-crawlers/canonical-urls) and
+[open graph tags](https://nuxtseo.com/learn/mastering-meta/open-graph).
 
 <p align="center">
 <table>
 <tbody>
 <td align="center">
-<img width="800" height="0" /><br>
-<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-seo-utils/releases/tag/v3.0.0">v3 Released</a> <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" />
 </td>
 </tbody>
 </table>
@@ -44,10 +38,16 @@ Install `nuxt-seo-utils` dependency to your project:
 npx nuxi@latest module add nuxt-seo-utils
 ```
 
-# Documentation
+💡 Need a complete SEO solution for Nuxt? Check out [Nuxt SEO](https://nuxtseo.com).
+
+## Documentation
 
 [📖 Read the full documentation](https://nuxtseo.com/docs/utils) for more information.
 
+## Demos
+
+[Basic](https://stackblitz.com/edit/nuxt-starter-vbay3q?file=app.vue)
+
 ## Sponsors
 
 <p align="center">
@@ -58,4 +58,17 @@ npx nuxi@latest module add nuxt-seo-utils
 
 ## License
 
-MIT License © 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)
+Licensed under the [MIT license](https://github.com/harlan-zw/nuxt-seo-utils/blob/main/LICENSE.md).
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/nuxt-seo-utils/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/nuxt-seo-utils
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-seo-utils.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/nuxt-seo-utils
+
+[license-src]: https://img.shields.io/github/license/harlan-zw/nuxt-seo-utils.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://github.com/harlan-zw/nuxt-seo-utils/blob/main/LICENSE.md
+
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com

package/dist/module.d.mts

@@ -1,4 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { UseSeoMetaInput } from '@unhead/schema';
 
 interface ModuleOptions {
     /**
@@ -91,6 +92,10 @@ interface ModuleOptions {
      * @default false
      */
     redirectToCanonicalSiteUrl?: boolean;
+    /**
+     * The SEO meta object to be used as defaults.
+     */
+    meta: UseSeoMetaInput;
     /**
      * Enables debug logs and a debug endpoint.
      *

package/dist/module.d.ts

@@ -1,4 +1,5 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { UseSeoMetaInput } from '@unhead/schema';
 
 interface ModuleOptions {
     /**
@@ -91,6 +92,10 @@ interface ModuleOptions {
      * @default false
      */
     redirectToCanonicalSiteUrl?: boolean;
+    /**
+     * The SEO meta object to be used as defaults.
+     */
+    meta: UseSeoMetaInput;
     /**
      * Enables debug logs and a debug endpoint.
      *

package/dist/module.json

@@ -5,7 +5,7 @@
     "nuxt": ">=3.6.1",
     "bridge": false
   },
-  "version": "5.0.1",
+  "version": "6.0.0",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,11 +1,12 @@
 import { useNuxt, createResolver, addTemplate, defineNuxtModule, useLogger, addServerHandler, hasNuxtModule, addPlugin, addImports, addVitePlugin } from '@nuxt/kit';
 import UnheadVite from '@unhead/addons/vite';
-import { installNuxtSiteConfig } from 'nuxt-site-config-kit';
+import { defu } from 'defu';
+import { resolvePath } from 'mlly';
+import { installNuxtSiteConfig } from 'nuxt-site-config/kit';
+import { relative, resolve, extname, dirname, basename } from 'pathe';
 import { unpackMeta } from '@unhead/shared';
 import fg from 'fast-glob';
-import { relative, resolve, extname, dirname, basename } from 'pathe';
 import fs from 'node:fs';
-import { defu } from 'defu';
 import { encodePath, joinURL } from 'ufo';
 import escapeRE from 'escape-string-regexp';
 import { readFile } from 'node:fs/promises';
@@ -13,6 +14,7 @@ import imageSize from 'image-size';
 
 function extendNuxtConfigAppHeadSeoMeta(nuxt = useNuxt()) {
   const seoMeta = nuxt.options.app?.seoMeta || nuxt.options.app?.head?.seoMeta || false;
+  const configSeoMeta = nuxt.options.seo?.meta || false;
   if (!seoMeta)
     return;
   nuxt.options.app.head = nuxt.options.app.head || {};
@@ -20,10 +22,12 @@ function extendNuxtConfigAppHeadSeoMeta(nuxt = useNuxt()) {
     ...nuxt.options.app.head,
     meta: [
       ...nuxt.options.app.head.meta || [],
-      ...unpackMeta(seoMeta)
+      ...unpackMeta(seoMeta),
+      ...unpackMeta(configSeoMeta)
     ]
   };
   delete nuxt.options.app.seoMeta;
+  delete nuxt.options.app.head.seoMeta;
   return nuxt.options.app.head;
 }
 
@@ -268,7 +272,7 @@ async function generateTagsFromPageDirImages(nuxt = useNuxt()) {
   nuxt.options.nitro.routeRules = defu(appendRouteRules, nuxt.options.nitro.routeRules);
   if (nuxt.options.dev) {
     nuxt.hooks.hook("nitro:config", async (nitroConfig) => {
-      nitroConfig.virtual["#nuxt-seo-utils/pageDirImages"] = `export const fileMapping = ${JSON.stringify(devMiddlewareMap)}`;
+      nitroConfig.virtual["#seo-utils-virtual/pageDirImages"] = `export const fileMapping = ${JSON.stringify(devMiddlewareMap)}`;
     });
   }
   nuxt.hooks.hook("nitro:build:public-assets", (_nitro) => {
@@ -423,7 +427,7 @@ const module = defineNuxtModule({
       if (nuxt.options.dev) {
         addServerHandler({
           middleware: true,
-          handler: resolve("runtime/nitro/middleware/resolveImagesInPagesDir.dev")
+          handler: resolve("./runtime/server/middleware/resolveImagesInPagesDir")
         });
       }
     }
@@ -431,27 +435,27 @@ const module = defineNuxtModule({
     if (config.automaticDefaults) {
       if (hasI18n) {
         addPlugin({
-          src: resolve(`./runtime/nuxt/plugins/defaultsWaitI18n`)
+          src: resolve(`./runtime/app/plugins/defaultsWaitI18n`)
         });
       } else {
         addPlugin({
-          src: resolve(`./runtime/nuxt/plugins/defaults`)
+          src: resolve(`./runtime/app/plugins/defaults`)
         });
       }
     }
     if (config.fallbackTitle) {
       addPlugin({
-        src: resolve("./runtime/nuxt/plugins/titles")
+        src: resolve("./runtime/app/plugins/titles")
       });
     }
     if (!hasI18n) {
       addImports({
-        from: resolve(`./runtime/nuxt/composables/polyfills`),
+        from: resolve(`./runtime/app/composables/polyfills`),
         name: "useI18n"
       });
     }
     addImports({
-      from: resolve(`./runtime/nuxt/composables/useBreadcrumbItems`),
+      from: resolve(`./runtime/app/composables/useBreadcrumbItems`),
       name: "useBreadcrumbItems"
     });
     const polyfills = [
@@ -465,19 +469,19 @@ const module = defineNuxtModule({
     ];
     polyfills.forEach((name) => {
       addImports({
-        from: resolve("./runtime/nuxt/composables/polyfills"),
+        from: resolve("./runtime/app/composables/polyfills"),
         name
       });
     });
     nuxt.options.experimental.headNext = true;
     if (!nuxt.options.dev && config.redirectToCanonicalSiteUrl) {
       addServerHandler({
-        handler: resolve("./runtime/nitro/middleware/redirect"),
+        handler: resolve("./runtime/server/middleware/redirectCanonical"),
         middleware: true
       });
     }
     nuxt.options.alias["#seo-utils"] = resolve("./runtime");
-    nuxt.options.runtimeConfig.public["nuxt-seo"] = {
+    nuxt.options.runtimeConfig.public["seo-utils"] = defu(nuxt.options.runtimeConfig.public["seo-utils"] || {}, {
       canonicalQueryWhitelist: config.canonicalQueryWhitelist || [
         "page",
         "sort",
@@ -487,7 +491,7 @@ const module = defineNuxtModule({
         "category",
         "tag"
       ]
-    };
+    });
     if (config.extendNuxtConfigAppHeadSeoMeta)
       extendNuxtConfigAppHeadSeoMeta();
     if (config.setupNuxtConfigAppHeadWithMoreDefaults)
@@ -495,28 +499,29 @@ const module = defineNuxtModule({
     if (config.extendNuxtConfigAppHeadTypes)
       extendNuxtConfigAppHeadTypes();
     extendTypes("nuxt-seo-utils", async () => {
+      const unheadSchemaPath = relative(resolve(nuxt.options.rootDir, nuxt.options.buildDir, "module"), await resolvePath("@unhead/schema"));
       return `
 declare module 'nitropack' {
   interface NitroRouteRules {
-     seoMeta?: import('@unhead/schema').UseSeoMetaInput
-     head?: import('@unhead/schema').Head
+     seoMeta?: import('${unheadSchemaPath}').UseSeoMetaInput
+     head?: import('${unheadSchemaPath}').Head
   }
   interface NitroRouteConfig {
-    seoMeta?: import('@unhead/schema').UseSeoMetaInput
-    head?: import('@unhead/schema').Head
+    seoMeta?: import('${unheadSchemaPath}').UseSeoMetaInput
+    head?: import('${unheadSchemaPath}').Head
   }
 }
 
 declare module '@nuxt/schema' {
-  interface MetaObjectRaw { seoMeta?: import('@unhead/schema').UseSeoMetaInput }
+  interface AppHeadMetaObject { seoMeta?: import('${unheadSchemaPath}').UseSeoMetaInput }
 }
 
 declare module 'nuxt/schema' {
-  interface MetaObjectRaw { seoMeta?: import('@unhead/schema').UseSeoMetaInput }
+  interface AppHeadMetaObject { seoMeta?: import('${unheadSchemaPath}').UseSeoMetaInput }
 }
 `;
     });
-    const runtimeDir = resolve("./runtime/nuxt");
+    const runtimeDir = resolve("./runtime/app");
     if (config.treeShakeUseSeoMeta)
       addVitePlugin(UnheadVite());
     if (config.automaticOgAndTwitterTags)

package/dist/runtime/{nuxt → app}/composables/useBreadcrumbItems.js

@@ -1,17 +1,16 @@
 import {
-  computed,
   createSitePathResolver,
   defineBreadcrumb,
-  toValue,
   useI18n,
-  useRouter,
   useSchemaOrg,
   useSiteConfig
 } from "#imports";
 import { defu } from "defu";
-import { fixSlashes } from "site-config-stack/urls";
+import { useRouter } from "nuxt/app";
+import { fixSlashes } from "nuxt-site-config/urls";
 import { withoutTrailingSlash } from "ufo";
-import { pathBreadcrumbSegments } from "../../pure/breadcrumbs.js";
+import { computed, toValue } from "vue";
+import { pathBreadcrumbSegments } from "../../shared/breadcrumbs.js";
 function withoutQuery(path) {
   return path.split("?")[0];
 }

package/dist/runtime/{nuxt → app}/logic/applyDefaults.js

@@ -1,15 +1,13 @@
 import {
-  computed,
   createSitePathResolver,
-  useHead,
-  useRoute,
-  useRuntimeConfig,
-  useSeoMeta,
   useSiteConfig
 } from "#imports";
+import { useHead, useSeoMeta } from "@unhead/vue";
+import { useRoute, useRuntimeConfig } from "nuxt/app";
 import { stringifyQuery } from "ufo";
+import { computed } from "vue";
 export function applyDefaults(i18n) {
-  const { canonicalQueryWhitelist } = useRuntimeConfig().public["nuxt-seo"];
+  const { canonicalQueryWhitelist } = useRuntimeConfig().public["seo-utils"];
   const siteConfig = useSiteConfig();
   const route = useRoute();
   const resolveUrl = createSitePathResolver({ withBase: true, absolute: true });

package/dist/runtime/{nuxt → app}/plugins/0.routeRules.server.js

@@ -1,7 +1,6 @@
-import { useRequestEvent } from "#imports";
 import { unpackMeta } from "@unhead/shared";
 import { injectHead } from "@unhead/vue";
-import { defineNuxtPlugin } from "nuxt/app";
+import { defineNuxtPlugin, useRequestEvent } from "nuxt/app";
 export default defineNuxtPlugin({
   enforce: "post",
   async setup() {

package/dist/runtime/{nuxt → app}/plugins/1.absoluteImageUrls.server.js

@@ -1,6 +1,7 @@
-import { createSitePathResolver, unref } from "#imports";
+import { createSitePathResolver } from "#imports";
 import { injectHead } from "@unhead/vue";
 import { defineNuxtPlugin } from "nuxt/app";
+import { unref } from "vue";
 export default defineNuxtPlugin({
   enforce: "post",
   setup() {

package/dist/runtime/{nuxt → app}/plugins/defaults.js

@@ -1,8 +1,8 @@
 import {
-  defineNuxtPlugin,
-  ref,
   useSiteConfig
 } from "#imports";
+import { defineNuxtPlugin } from "nuxt/app";
+import { ref } from "vue";
 import { applyDefaults } from "../logic/applyDefaults.js";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",

package/dist/runtime/{nuxt → app}/plugins/defaultsWaitI18n.js

@@ -1,4 +1,6 @@
-import { defineNuxtPlugin, ref, useSiteConfig } from "#imports";
+import { useSiteConfig } from "#imports";
+import { defineNuxtPlugin } from "nuxt/app";
+import { ref } from "vue";
 import { applyDefaults } from "../logic/applyDefaults.js";
 export default defineNuxtPlugin({
   name: "nuxt-seo:defaults",

package/dist/runtime/{nuxt → app}/plugins/titles.js

@@ -1,11 +1,8 @@
-import {
-  computed,
-  defineNuxtPlugin,
-  useHead,
-  useRoute
-} from "#imports";
+import { useHead } from "@unhead/vue";
+import { defineNuxtPlugin, useRoute } from "nuxt/app";
 import { titleCase } from "scule";
 import { withoutTrailingSlash } from "ufo";
+import { computed } from "vue";
 export default defineNuxtPlugin({
   name: "nuxt-seo:fallback-titles",
   env: {

package/dist/runtime/{nitro/middleware/redirectNitroOrigin.js → server/middleware/redirectCanonical.js}

@@ -1,16 +1,15 @@
-import { useNitroOrigin, useSiteConfig } from "#imports";
-import { defineEventHandler, sendRedirect, setHeader } from "h3";
+import { useSiteConfig } from "#site-config/server/composables/useSiteConfig";
+import { defineEventHandler, getRequestHost, sendRedirect, setHeader } from "h3";
 import { joinURL } from "ufo";
 export default defineEventHandler((e) => {
   const siteConfig = useSiteConfig(e);
   if (siteConfig.url) {
-    const siteConfigHostName = new URL(e.path, siteConfig.url).hostname;
-    const origin = useNitroOrigin(e);
-    const originHostname = new URL(e.path, origin).hostname;
+    const siteConfigHostName = new URL(e.path, siteConfig.url).host;
+    const host = getRequestHost(e, { xForwardedHost: true });
     if (e.headers.get("x-nuxt-seo-redirected")) {
       return;
     }
-    if (originHostname !== siteConfigHostName && originHostname !== new URL(e.path, origin).hostname) {
+    if (host.split(":")[0] !== siteConfigHostName.split(":")[0]) {
       setHeader(e, "x-nuxt-seo-redirected", "true");
       return sendRedirect(e, joinURL(siteConfig.url, e.path), 301);
     }

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

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

package/dist/runtime/{nitro/middleware/resolveImagesInPagesDir.dev.js → server/middleware/resolveImagesInPagesDir.js}

@@ -1,7 +1,6 @@
 import fs from "node:fs";
-import { defineEventHandler } from "#imports";
-import { fileMapping } from "#nuxt-seo-utils/pageDirImages";
-import { setHeader } from "h3";
+import { fileMapping } from "#seo-utils-virtual/pageDirImages";
+import { defineEventHandler, setHeader } from "h3";
 import { parseURL } from "ufo";
 export default defineEventHandler(async (e) => {
   const path = parseURL(e.path).pathname;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nuxt-seo-utils",
   "type": "module",
-  "version": "5.0.2",
+  "version": "6.0.1",
   "description": "SEO utilities to improve your Nuxt sites discoverability and shareability",
   "license": "MIT",
   "funding": "https://github.com/sponsors/harlan-zw",
@@ -32,39 +32,43 @@
     ]
   },
   "dependencies": {
-    "@nuxt/kit": "^3.13.2",
-    "@unhead/addons": "^1.11.10",
+    "@nuxt/kit": "^3.14.1592",
+    "@unhead/addons": "^1.11.11",
+    "@unhead/schema": "^1.11.11",
     "defu": "^6.1.4",
     "escape-string-regexp": "^5.0.0",
     "fast-glob": "^3.3.2",
     "image-size": "^1.1.1",
-    "nuxt-site-config": "^2.2.18",
-    "nuxt-site-config-kit": "^2.2.18",
+    "mlly": "^1.7.3",
+    "nuxt-site-config": "^3.0.3",
     "pathe": "^1.1.2",
     "scule": "^1.3.0",
     "ufo": "^1.5.4"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "3.8.0",
+    "@antfu/eslint-config": "3.9.2",
     "@nuxt/module-builder": "^0.8.4",
     "@nuxt/test-utils": "^3.14.4",
-    "@nuxt/ui": "^2.18.7",
+    "@nuxt/ui": "^2.19.2",
     "@nuxtjs/eslint-config-typescript": "^12.1.0",
-    "@nuxtjs/i18n": "^8.5.5",
-    "@unhead/shared": "^1.11.10",
+    "@nuxtjs/i18n": "^9.1.0",
+    "@unhead/shared": "^1.11.11",
     "@vue/test-utils": "^2.4.6",
-    "bumpp": "^9.8.0",
+    "bumpp": "^9.8.1",
     "case-police": "^0.7.0",
     "cheerio": "1.0.0",
-    "eslint": "^9.13.0",
-    "happy-dom": "^15.7.4",
-    "markdownlint-cli": "^0.42.0",
-    "nuxt": "^3.13.2",
+    "eslint": "^9.15.0",
+    "happy-dom": "^15.11.6",
+    "markdownlint-cli": "^0.43.0",
+    "nuxt": "^3.14.1592",
     "nuxt-content-twoslash": "^0.1.1",
-    "playwright-core": "^1.48.2",
-    "sass": "^1.80.5",
+    "playwright-core": "^1.49.0",
+    "sass": "^1.81.0",
     "typescript": "5.6.3",
-    "vitest": "^2.1.4"
+    "vitest": "^2.1.5"
+  },
+  "resolutions": {
+    "typescript": "5.6.3"
   },
   "scripts": {
     "lint": "eslint . --fix",

package/dist/runtime/nitro/middleware/resolveImagesInPagesDir.dev.d.ts

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