feat: nitro hook sitemap:index-resolved

Relates to #237
nuxt-modules · May 22, 2024 · 19094b6 · 19094b6
1 parent 15b3d6d
commit 19094b6
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 1 deletion.
diff --git a/.playground/server/plugins/sitemap.ts b/.playground/server/plugins/sitemap.ts
@@ -5,4 +5,8 @@ export default defineNitroPlugin((nitroApp) => {
     // eslint-disable-next-line no-console
     console.log('Sitemap SSR hook')
   })
+  nitroApp.hooks.hook('sitemap:index-resolved', (ctx) => {
+    // eslint-disable-next-line no-console
+    console.log('Sitemap index resolved hook', ctx)
+  })
 })
diff --git a/src/module.ts b/src/module.ts
@@ -258,6 +258,7 @@ declare module 'nitropack' {
     sitemap?: import('${typesPath}').SitemapItemDefaults
   }
   interface NitroRuntimeHooks {
+    'sitemap:index-resolved': (ctx: import('${typesPath}').SitemapRenderCtx) => void | Promise<void>
     'sitemap:resolved': (ctx: import('${typesPath}').SitemapRenderCtx) => void | Promise<void>
     'sitemap:output': (ctx: import('${typesPath}').SitemapOutputHookCtx) => void | Promise<void>
   }

diff --git a/src/runtime/nitro/sitemap/builder/sitemap-index.ts b/src/runtime/nitro/sitemap/builder/sitemap-index.ts
@@ -13,6 +13,7 @@ import { applyI18nEnhancements } from '../urlset/i18n'
 import { filterSitemapUrls } from '../urlset/filter'
 import { sortSitemapUrls } from '../urlset/sort'
 import { escapeValueForXml, wrapSitemapXml } from './xml'
+import { useNitroApp } from '#imports'
 
 export async function buildSitemapIndex(resolvers: NitroUrlResolvers, runtimeConfig: ModuleRuntimeConfig) {
   const {
@@ -109,7 +110,11 @@ export async function buildSitemapIndex(resolvers: NitroUrlResolvers, runtimeCon
     }))
   }
 
-  const sitemapXml = entries.map(e => [
+  const ctx = { sitemaps: entries }
+  const nitro = useNitroApp()
+  await nitro.hooks.callHook('sitemap:index-resolved', ctx)
+
+  const sitemapXml = ctx.sitemaps.map(e => [
     '    <sitemap>',
     `        <loc>${escapeValueForXml(e.sitemap)}</loc>`,
     // lastmod is optional

diff --git a/src/runtime/types.ts b/src/runtime/types.ts
@@ -260,6 +260,10 @@ export interface SitemapDefinition {
   _route?: string
 }
 
+export interface SitemapIndexRenderCtx {
+  sitemaps: SitemapIndexEntry[]
+}
+
 export interface SitemapRenderCtx {
   sitemapName: string
   urls: ResolvedSitemapUrl[]