feat: appendSitemaps config for improved type safety

Fixes #222
nuxt-modules · Feb 1, 2024 · 609caf1 · 609caf1
1 parent 225da13
commit 609caf1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 5 deletions.
diff --git a/src/module.ts b/src/module.ts
@@ -212,8 +212,9 @@ export default defineNuxtModule<ModuleOptions>({
       // if they haven't set `sitemaps` explicitly then we can set it up automatically for them
       if (canI18nMap && resolvedAutoI18n) {
         // @ts-expect-error untyped
-        config.sitemaps = { index: config.sitemaps?.index || [] }
+        config.sitemaps = { index: [...(config.sitemaps?.index || []), ...(config.appendSitemaps || [])] }
         for (const locale of resolvedAutoI18n.locales)
+          // @ts-expect-error untyped
           config.sitemaps[locale.iso || locale.code] = { includeAppSources: true }
         isI18nMapped = true
         usingMultiSitemaps = true
@@ -379,9 +380,8 @@ declare module 'vue-router' {
       sitemaps.index = {
         sitemapName: 'index',
         _route: withBase('sitemap_index.xml', nuxt.options.app.baseURL || '/'),
-        // TODO better index support
         // @ts-expect-error untyped
-        sitemaps: config.sitemaps!.index || [],
+        sitemaps: [...(config.sitemaps!.index || []), ...(config.appendSitemaps || [])],
       }
       if (typeof config.sitemaps === 'object') {
         for (const sitemapName in config.sitemaps) {

diff --git a/src/runtime/nitro/sitemap/builder/sitemap-index.ts b/src/runtime/nitro/sitemap/builder/sitemap-index.ts
@@ -103,8 +103,11 @@ export async function buildSitemapIndex(resolvers: NitroUrlResolvers, runtimeCon
   }
 
   // allow extending the index sitemap
-  if (sitemaps.index)
-    entries.push(...sitemaps.index.sitemaps)
+  if (sitemaps.index) {
+    entries.push(...sitemaps.index.sitemaps.map((entry) => {
+      return typeof entry === 'string' ? { sitemap: entry } : entry
+    }))
+  }
 
   const sitemapXml = entries.map(e => [
     '    <sitemap>',

diff --git a/src/runtime/types.ts b/src/runtime/types.ts
@@ -43,6 +43,12 @@ export interface ModuleOptions extends SitemapDefinition {
    * @default false
    */
   sitemaps?: boolean | MultiSitemapsInput
+  /**
+   * Sitemaps to append to the sitemap index.
+   *
+   * This will only do anything when using multiple sitemaps.
+   */
+  appendSitemaps?: (string | SitemapIndexEntry)[]
   /**
    * Path to the xsl that styles sitemap.xml.
    *