@nuxtjs/sitemap 8.3.4 → 8.4.0

package/dist/devtools/nuxt.config.ts

@@ -1,7 +1,10 @@
+import { fileURLToPath } from 'node:url'
 import { resolve } from 'pathe'
 
+const currentDir = fileURLToPath(new URL('.', import.meta.url))
+
 // Nuxt SEO devtools panel, shipped as a layer (Model C). Components flat-registered
 // so intra-panel references resolve by name.
 export default defineNuxtConfig({
-  components: [{ path: resolve(__dirname, './components'), pathPrefix: false }],
+  components: [{ path: resolve(currentDir, './components'), pathPrefix: false }],
 })

package/dist/module.json

@@ -4,7 +4,7 @@
     "nuxt": ">=3.9.0"
   },
   "configKey": "sitemap",
-  "version": "8.3.4",
+  "version": "8.4.0",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -2,14 +2,14 @@ import { useNuxt, hasNuxtModule, addTypeTemplate, addTemplate, defineNuxtModule,
 import { defu } from 'defu';
 import { withSiteUrl, installNuxtSiteConfig } from 'nuxt-site-config/kit';
 import { isPathFile } from 'nuxt-site-config/urls';
-import { isNuxtGenerate, renderNitroTypeAugmentations, useModuleLogger, setupNitroRuntimeCompatibility, getNuxtModuleOptions, resolveNitroPreset, resolveNuxtContentVersion, createPagesPromise, createNitroPromise } from 'nuxtseo-shared/kit';
+import { isNuxtGenerate, renderNitroTypeAugmentations, useModuleLogger, setupNitroRuntimeCompatibility, getNuxtModuleOptions, resolveNitroPreset, resolveContentProvider, setupContentRuntime, createPagesPromise, createNitroPromise } from 'nuxtseo-shared/kit';
 import { serializeFilters } from 'nuxtseo-shared/utils';
 import { dirname, extname } from 'pathe';
 import { readPackageJSON } from 'pkg-types';
 import { withBase, withHttps, withTrailingSlash, withoutLeadingSlash, joinURL, withLeadingSlash } from 'ufo';
 import { setupDevToolsUI as setupDevToolsUI$1 } from 'nuxtseo-shared/devtools';
 import { readFileSync, statSync } from 'node:fs';
-import { mkdir, writeFile } from 'node:fs/promises';
+import { rm, mkdir, writeFile } from 'node:fs/promises';
 import { join } from 'node:path';
 import { colors } from 'consola/utils';
 import { splitForLocales, createPathFilter } from '../dist/runtime/utils-pure.js';
@@ -18,6 +18,9 @@ import { normaliseDate } from '../dist/runtime/server/sitemap/urlset/normalise.j
 import { mapPathForI18nPages, splitPathForI18nLocales as splitPathForI18nLocales$1, expandCompactLocaleRoute, normalizeLocales, generatePathForI18nPages } from 'nuxtseo-shared/i18n';
 import 'ultrahtml';
 
+const COMARK_CONTENT_SOURCE = "@harlan-zw/comark-content:urls";
+const COMARK_CONTENT_SITEMAP_ROUTE = "/__sitemap__/comark-content-urls.json";
+
 function setupDevToolsUI(_options, resolve, nuxt = useNuxt()) {
   setupDevToolsUI$1(
     { route: "/__nuxt-sitemap", name: "sitemap", title: "Sitemap", icon: "carbon:load-balancer-application" },
@@ -72,6 +75,10 @@ export async function readSourcesFromFilesystem(filename) {
 `;
   });
   nuxt.hooks.hook("nitro:init", async (nitro) => {
+    await Promise.all([
+      rm(join(runtimeAssetsPath, "global-sources.json"), { force: true }),
+      rm(join(runtimeAssetsPath, "child-sources.json"), { force: true })
+    ]);
     nitro.hooks.hook("prerender:generate", async (route) => {
       const html = route.contents;
       if (!route.fileName?.endsWith(".html") || !html || ["/200.html", "/404.html"].includes(route.route))
@@ -455,7 +462,34 @@ function generateExtraRoutesFromNuxtConfig(nuxt = useNuxt()) {
   }).map(([k]) => k).filter(filterForValidPage);
   return { routeRules };
 }
+function resolveExcludedAppSources(resolved, authored) {
+  if (resolved === true || authored === true)
+    return true;
+  if (!Array.isArray(authored))
+    return resolved;
+  const excluded = [...resolved];
+  for (const source of authored) {
+    if (typeof source === "string" && !excluded.includes(source))
+      excluded.push(source);
+  }
+  return excluded;
+}
 
+const IMAGE_TAGS = /* @__PURE__ */ new Set(["image", "img", "nuxtimg", "nuxt-img"]);
+function discoverContentImages(body) {
+  const images = [];
+  const walk = (nodes) => {
+    for (const node of nodes || []) {
+      if (!Array.isArray(node) || typeof node[0] !== "string")
+        continue;
+      if (IMAGE_TAGS.has(node[0]) && node[1]?.src)
+        images.push({ loc: node[1].src });
+      walk(node.slice(2));
+    }
+  };
+  walk(body?.value ?? body?.nodes);
+  return images;
+}
 const module$1 = defineNuxtModule({
   meta: {
     name: "@nuxtjs/sitemap",
@@ -480,6 +514,10 @@ const module$1 = defineNuxtModule({
       version: ">=2",
       optional: true
     },
+    "@harlan-zw/comark-content": {
+      version: ">=0.1.2",
+      optional: true
+    },
     "@nuxtjs/robots": {
       version: ">=4",
       optional: true
@@ -673,11 +711,11 @@ const module$1 = defineNuxtModule({
         const hasCustomI18nSitemaps = i18nSitemaps.length > 0;
         if (hasCustomI18nSitemaps) {
           for (const { name: name2, cfg } of i18nSitemaps) {
+            const { sitemapName: _sitemapName, _route, _isChunking, _chunkSize, _chunkCount, ...inheritedConfig } = cfg;
             for (const locale of resolvedAutoI18n.locales) {
               newSitemaps[`${locale._sitemap}-${name2}`] = {
-                includeAppSources: true,
-                ...cfg.exclude?.length && { exclude: cfg.exclude },
-                ...cfg.include?.length && { include: cfg.include }
+                ...inheritedConfig,
+                includeAppSources: true
               };
             }
           }
@@ -770,20 +808,13 @@ const module$1 = defineNuxtModule({
         addServerPlugin(resolve("./runtime/server/plugins/stream-transport"));
     }
     const isNuxtContentDocumentDriven = !!nuxt.options.content?.documentDriven || config.strictNuxtContentPaths;
-    const contentVersion = await resolveNuxtContentVersion();
-    const isNuxtContentV3 = contentVersion && contentVersion.version === 3;
+    const contentProvider = await resolveContentProvider(nuxt);
+    const isNuxtContentV3 = contentProvider._tag === "NuxtContent" && contentProvider.version === 3;
+    const isNuxtContentV2 = contentProvider._tag === "NuxtContent" && contentProvider.version === 2;
+    const isComarkContent = contentProvider._tag === "Comark";
     const nuxtV3Collections = /* @__PURE__ */ new Set();
-    const isNuxtContentV2 = contentVersion && contentVersion.version === 2;
-    if (isNuxtContentV3) {
-      if (nuxt.options._installedModules.some((m) => m.meta.name === "Content")) {
-        logger.warn("You have loaded `@nuxt/content` before `@nuxtjs/sitemap`, this may cause issues with the integration. Please ensure `@nuxtjs/sitemap` is loaded first.");
-      }
-      config.exclude.push("/__nuxt_content/**");
-      const needsCustomAlias = await hasNuxtModuleCompatibility("@nuxt/content", "<3.6.0");
-      if (needsCustomAlias) {
-        nuxt.options.alias["#sitemap/content-v3-nitro-path"] = resolve(dirname(resolveModule("@nuxt/content")), "runtime/nitro");
-        nuxt.options.alias["@nuxt/content/nitro"] = resolve("./runtime/server/content-compat");
-      }
+    setupContentRuntime(contentProvider, nuxt);
+    const registerContentSitemapHook = (options) => {
       nuxt.hooks.hook("content:file:afterParse", (ctx) => {
         try {
           const content = ctx.content;
@@ -792,7 +823,7 @@ const module$1 = defineNuxtModule({
             ctx.content.sitemap = null;
             return;
           }
-          if (!ctx.collection.fields || !("sitemap" in ctx.collection.fields)) {
+          if (options.requireCollectionField && (!ctx.collection.fields || !("sitemap" in ctx.collection.fields))) {
             ctx.content.sitemap = null;
             return;
           }
@@ -805,13 +836,8 @@ const module$1 = defineNuxtModule({
             return;
           }
           const images = [];
-          if (config.discoverImages) {
-            images.push(
-              ...content.body?.value?.filter(
-                (c) => ["image", "img", "nuxtimg", "nuxt-img"].includes(c[0])
-              ).filter((c) => c[1]?.src).map((c) => ({ loc: c[1].src })) || []
-            );
-          }
+          if (config.discoverImages)
+            images.push(...discoverContentImages(content.body));
           const lastmod = content.seo?.articleModifiedTime || content.updatedAt;
           const defaults = {
             loc: content.path
@@ -825,6 +851,8 @@ const module$1 = defineNuxtModule({
           logger.warn(`Failed to process sitemap data for content file (collection: ${ctx.collection?.name}, path: ${ctx.content?.path}), skipping.`, e);
         }
       });
+    };
+    const addContentCallbackVirtuals = () => {
       nuxt.hook("nitro:config", (nitroConfig) => {
         const filterEntries = [];
         if (globalThis.__sitemapCollectionFilters) {
@@ -842,9 +870,22 @@ ${filterEntries.join("\n")}`;
         nitroConfig.virtual["#sitemap/content-on-url"] = `export const onUrlFns = new Map()
 ${onUrlEntries.join("\n")}`;
       });
+    };
+    if (isNuxtContentV3) {
+      if (nuxt.options._installedModules.some((m) => m.meta.name === "Content")) {
+        logger.warn("You have loaded `@nuxt/content` before `@nuxtjs/sitemap`, this may cause issues with the integration. Please ensure `@nuxtjs/sitemap` is loaded first.");
+      }
+      config.exclude.push("/__nuxt_content/**");
+      const needsCustomAlias = await hasNuxtModuleCompatibility("@nuxt/content", "<3.6.0");
+      if (needsCustomAlias) {
+        nuxt.options.alias["#sitemap/content-v3-nitro-path"] = resolve(dirname(resolveModule("@nuxt/content")), "runtime/nitro");
+        nuxt.options.alias["@nuxt/content/nitro"] = resolve("./runtime/server/content-compat");
+      }
+      registerContentSitemapHook({ requireCollectionField: true });
+      addContentCallbackVirtuals();
       addServerHandler({
         route: "/__sitemap__/nuxt-content-urls.json",
-        handler: resolve("./runtime/server/routes/__sitemap__/nuxt-content-urls-v3")
+        handler: resolve("./runtime/server/routes/__sitemap__/content-urls")
       });
       if (config.strictNuxtContentPaths) {
         logger.warn("You have set `strictNuxtContentPaths: true` but are using @nuxt/content v3. This is not required, please remove it.");
@@ -857,6 +898,24 @@ ${onUrlEntries.join("\n")}`;
         },
         fetch: "/__sitemap__/nuxt-content-urls.json"
       });
+    } else if (isComarkContent) {
+      registerContentSitemapHook({ requireCollectionField: false });
+      addContentCallbackVirtuals();
+      addServerHandler({
+        route: COMARK_CONTENT_SITEMAP_ROUTE,
+        handler: resolve("./runtime/server/routes/__sitemap__/content-urls")
+      });
+      if (config.strictNuxtContentPaths) {
+        logger.warn("You have set `strictNuxtContentPaths: true` but are using comark-content. This is not required, please remove it.");
+      }
+      appGlobalSources.push({
+        context: {
+          name: COMARK_CONTENT_SOURCE,
+          description: "Generated from your markdown files.",
+          tips: nuxtV3Collections.size ? [`Parsing the following collections: ${Array.from(nuxtV3Collections).join(", ")}`] : ["No collections found. Set `sitemap: false` on a collection to keep it out."]
+        },
+        fetch: COMARK_CONTENT_SITEMAP_ROUTE
+      });
     } else if (isNuxtContentV2) {
       addServerPlugin(resolve("./runtime/server/plugins/nuxt-content-v2"));
       addServerHandler({
@@ -1097,6 +1156,10 @@ ${onUrlEntries.join("\n")}`;
       return r.contentType?.includes("text/html");
     };
     const generateGlobalSources = async () => {
+      const excludedAppSources = resolveExcludedAppSources(
+        config.excludeAppSources,
+        nuxt.options.sitemap?.excludeAppSources
+      );
       const { routeRules: routeRules2 } = generateExtraRoutesFromNuxtConfig();
       const nitro = await nitroPromise;
       const prerenderedRoutes2 = nitro._prerenderedRoutes || [];
@@ -1173,7 +1236,7 @@ ${onUrlEntries.join("\n")}`;
           s.sourceType = "user";
           return s;
         }),
-        ...(config.excludeAppSources === true ? [] : [
+        ...(excludedAppSources === true ? [] : [
           ...appGlobalSources,
           {
             context: {
@@ -1205,7 +1268,7 @@ ${onUrlEntries.join("\n")}`;
             },
             urls: prerenderUrlsFinal
           }
-        ]).filter((s) => !config.excludeAppSources.includes(s.context.name) && (!!s.urls?.length || !!s.fetch)).map((s) => {
+        ]).filter((s) => !excludedAppSources.includes(s.context.name) && (!!s.urls?.length || !!s.fetch)).map((s) => {
           s.sourceType = "app";
           return s;
         })

package/dist/runtime/server/routes/__sitemap__/content-urls.d.ts

@@ -0,0 +1,9 @@
+/**
+ * URLs from the installed content module's page collections.
+ *
+ * One route for every provider. `#nuxtseo/content` normalizes the manifest shape
+ * and the query builder; the `sitemap` field on each entry is written by the
+ * module's `content:file:afterParse` hook.
+ */
+declare const _default: any;
+export default _default;

package/dist/runtime/server/routes/__sitemap__/content-urls.js

@@ -0,0 +1,34 @@
+import * as contentRuntime from "#nuxtseo/content";
+import { defineEventHandler } from "#nuxtseo/h3";
+import { filters } from "#sitemap/content-filters";
+import { onUrlFns } from "#sitemap/content-on-url";
+const { listPageCollections, provider, queryPages } = contentRuntime;
+export default defineEventHandler(async (e) => {
+  const collections = (await listPageCollections(e)).filter((collection) => collection.inSitemap && collection.hasField("sitemap")).map((collection) => collection.name);
+  const results = await Promise.all(collections.map(async (collection) => {
+    const needsAllFields = filters?.has(collection) || onUrlFns?.has(collection);
+    const query = queryPages(e, collection).where("path", "IS NOT NULL").where("sitemap", "IS NOT NULL");
+    if (!needsAllFields)
+      query.select("path", "sitemap");
+    try {
+      const entries = await query.all();
+      const filter = filters?.get(collection);
+      return { collection, entries: filter ? entries.filter(filter) : entries };
+    } catch (err) {
+      const hint = provider === "nuxt-content-v3" ? " On serverless the content DB is restored from a prerendered sql_dump.txt that isn't readable inside the function (nuxt/content#3805). Fix: prerender the sitemap so content URLs resolve at build, or configure a runtime database (D1/Turso/Postgres)." : "";
+      console.error(`[@nuxtjs/sitemap] Couldn't query content collection "${collection}" for the sitemap, so its URLs will be missing.${hint}`, err);
+      return { collection, entries: [] };
+    }
+  }));
+  return results.flatMap(({ collection, entries }) => {
+    const onUrl = onUrlFns?.get(collection);
+    return entries.filter((entry) => entry.sitemap !== false && entry.path && !entry.path.endsWith(".navigation")).map((entry) => {
+      const url = {
+        loc: entry.path,
+        ...typeof entry.sitemap === "object" && entry.sitemap ? entry.sitemap : {}
+      };
+      onUrl?.(url, entry, collection);
+      return url;
+    });
+  });
+});

package/dist/runtime/types.d.ts

@@ -204,7 +204,7 @@ export interface SitemapSourceResolved extends Omit<SitemapSourceBase, 'urls'> {
         message: string;
     }[];
 }
-export type AppSourceContext = 'nuxt:pages' | 'nuxt:prerender' | 'nuxt:route-rules' | '@nuxtjs/i18n:pages' | 'nuxt-i18n-micro:pages' | '@nuxt/content@v2:urls' | '@nuxt/content@v3:urls';
+export type AppSourceContext = 'nuxt:pages' | 'nuxt:prerender' | 'nuxt:route-rules' | '@nuxtjs/i18n:pages' | 'nuxt-i18n-micro:pages' | '@nuxt/content@v2:urls' | '@nuxt/content@v3:urls' | '@harlan-zw/comark-content:urls';
 export type SitemapSourceInput = string | [string, FetchOptions] | SitemapSourceBase | SitemapSourceResolved;
 interface LocaleObject extends Record<string, any> {
     code: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxtjs/sitemap",
   "type": "module",
-  "version": "8.3.4",
+  "version": "8.4.0",
   "description": "Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.",
   "author": {
     "name": "Harlan Wilton",
@@ -58,42 +58,43 @@
     "@nuxt/kit": "^4.5.2",
     "consola": "^3.4.2",
     "defu": "^6.1.7",
-    "nuxt-site-config": "^4.2.0",
-    "nuxtseo-shared": "^5.3.11",
+    "nuxt-site-config": "^4.2.3",
+    "nuxtseo-shared": "^5.3.14",
     "ofetch": "^1.5.1",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.1",
     "radix3": "^1.1.2",
     "ufo": "^1.6.4",
     "ultrahtml": "^1.7.0",
-    "sitemapd": "^0.2.1"
+    "sitemapd": "^0.2.2"
   },
   "devDependencies": {
     "@antfu/eslint-config": "^9.3.0",
     "@arethetypeswrong/cli": "^0.18.5",
+    "@harlan-zw/comark-content": "^0.1.3",
     "@nuxt/content": "^3.15.2",
-    "@nuxt/devtools-kit": "4.0.0-alpha.9",
+    "@nuxt/devtools-kit": "4.0.0-alpha.11",
     "@nuxt/module-builder": "^1.0.3",
     "@nuxt/test-utils": "^4.1.0",
     "@nuxt/ui": "^4.10.0",
     "@nuxtjs/i18n": "^10.6.0",
-    "@nuxtjs/robots": "^6.1.4",
+    "@nuxtjs/robots": "^6.1.5",
     "@vue/test-utils": "^2.4.11",
     "better-sqlite3": "^13.0.3",
-    "bumpp": "^12.2.0",
+    "bumpp": "^12.2.1",
     "eslint": "^10.8.1",
-    "eslint-plugin-harlanzw": "^0.17.1",
+    "eslint-plugin-harlanzw": "^0.20.0",
     "happy-dom": "^20.11.2",
     "nuxt": "^4.5.2",
     "nuxt-i18n-micro": "^3.28.0",
-    "nuxtseo-layer-devtools": "^5.3.11",
+    "nuxtseo-layer-devtools": "^5.3.14",
     "std-env": "^4.2.0",
     "typescript": "6.0.3",
     "unbuild": "^3.6.1",
-    "vitest": "^4.1.10",
-    "vue-tsc": "^3.3.9",
+    "vitest": "^4.1.11",
+    "vue-tsc": "^3.3.10",
     "zod": "^4.4.3",
-    "@nuxtjs/sitemap": "8.3.4"
+    "@nuxtjs/sitemap": "8.4.0"
   },
   "scripts": {
     "lint": "eslint .",

package/dist/runtime/server/routes/__sitemap__/nuxt-content-urls-v3.d.ts

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

package/dist/runtime/server/routes/__sitemap__/nuxt-content-urls-v3.js

@@ -1,40 +0,0 @@
-import { queryCollection } from "@nuxt/content/server";
-import manifest from "#content/manifest";
-import { defineEventHandler } from "#nuxtseo/h3";
-import { filters } from "#sitemap/content-filters";
-import { onUrlFns } from "#sitemap/content-on-url";
-export default defineEventHandler(async (e) => {
-  const collections = [];
-  for (const collection in manifest) {
-    if (manifest[collection].fields.sitemap)
-      collections.push(collection);
-  }
-  const contentList = [];
-  for (const collection of collections) {
-    const needsAllFields = filters?.has(collection) || onUrlFns?.has(collection);
-    const query = queryCollection(e, collection).where("path", "IS NOT NULL").where("sitemap", "IS NOT NULL");
-    if (!needsAllFields)
-      query.select("path", "sitemap");
-    contentList.push(
-      query.all().then((results2) => {
-        const filter = filters?.get(collection);
-        return { collection, entries: filter ? results2.filter(filter) : results2 };
-      }).catch((err) => {
-        console.error(`[@nuxtjs/sitemap] Couldn't query @nuxt/content collection "${collection}" for the sitemap, so its URLs will be missing. On serverless the content DB is restored from a prerendered sql_dump.txt that isn't readable inside the function (nuxt/content#3805). Fix: prerender the sitemap so content URLs resolve at build, or configure a runtime database (D1/Turso/Postgres).`, err);
-        return { collection, entries: [] };
-      })
-    );
-  }
-  const results = await Promise.all(contentList);
-  return results.flatMap(({ collection, entries }) => {
-    const onUrl = onUrlFns?.get(collection);
-    return entries.filter((c) => c.sitemap !== false && c.path && !c.path.endsWith(".navigation")).map((c) => {
-      const url = {
-        loc: c.path,
-        ...typeof c.sitemap === "object" ? c.sitemap : {}
-      };
-      onUrl?.(url, c, collection);
-      return url;
-    });
-  }).filter(Boolean);
-});