feat: gzip streaming with experimentalCompression

Closes #77

package.json

@@ -50,6 +50,7 @@
     "@nuxt/kit": "^3.9.0",
     "chalk": "^5.3.0",
     "defu": "^6.1.3",
+    "h3-compression": "^0.3.2",
     "nuxt-site-config": "^2.2.0",
     "nuxt-site-config-kit": "^2.2.0",
     "ofetch": "^1.3.3",

src/module.ts

@@ -303,12 +303,14 @@ declare module 'vue-router' {
     }
 
     if (config.experimentalWarmUp)
-      addServerPlugin(resolve('./runtime/plugins/warm-up'))
+      addServerPlugin(resolve('./runtime/nitro/plugins/warm-up'))
+    if (config.experimentalCompression)
+      addServerPlugin(resolve('./runtime/nitro/plugins/compression'))
 
     // @ts-expect-error untyped
     const isNuxtContentDocumentDriven = (!!nuxt.options.content?.documentDriven || config.strictNuxtContentPaths)
     if (hasNuxtModule('@nuxt/content')) {
-      addServerPlugin(resolve('./runtime/plugins/nuxt-content'))
+      addServerPlugin(resolve('./runtime/nitro/plugins/nuxt-content'))
       addServerHandler({
         route: '/__sitemap__/nuxt-content-urls.json',
         handler: resolve('./runtime/routes/__sitemap__/nuxt-content-urls'),

src/runtime/nitro/plugins/compression.ts

@@ -0,0 +1,9 @@
+import { useCompressionStream } from 'h3-compression'
+import { defineNitroPlugin } from '#imports'
+
+export default defineNitroPlugin((nitro) => {
+  nitro.hooks.hook('beforeResponse', async (event, response) => {
+    if (event.context._isSitemap)
+      await useCompressionStream(event, response)
+  })
+})

src/runtime/plugins/nuxt-content.ts → src/runtime/nitro/plugins/nuxt-content.ts

@@ -1,8 +1,8 @@
 import { defu } from 'defu'
 import { defineNitroPlugin } from 'nitropack/dist/runtime/plugin'
 import type { ParsedContent } from '@nuxt/content/dist/runtime/types'
-import type { SitemapUrl } from '../types'
-import { useSimpleSitemapRuntimeConfig } from '../utils'
+import type { SitemapUrl } from '../../types'
+import { useSimpleSitemapRuntimeConfig } from '../../utils'
 
 export default defineNitroPlugin((nitroApp) => {
   const { discoverImages, isNuxtContentDocumentDriven } = useSimpleSitemapRuntimeConfig()

src/runtime/plugins/warm-up.ts → src/runtime/nitro/plugins/warm-up.ts

@@ -1,6 +1,6 @@
 import { defineNitroPlugin } from 'nitropack/dist/runtime/plugin'
 import { withLeadingSlash } from 'ufo'
-import { useSimpleSitemapRuntimeConfig } from '../utils'
+import { useSimpleSitemapRuntimeConfig } from '../../utils'
 
 export default defineNitroPlugin((nitroApp) => {
   const { sitemaps } = useSimpleSitemapRuntimeConfig()

src/runtime/nitro/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../../../.nuxt/tsconfig.server.json"
+}

src/runtime/sitemap/nitro.ts

@@ -42,5 +42,6 @@ export async function createSitemap(e: H3Event, definition: SitemapDefinition) {
   setHeader(e, 'Content-Type', 'text/xml; charset=UTF-8')
   if (!process.dev)
     setHeader(e, 'Cache-Control', 'max-age=600, must-revalidate')
+  e.context._isSitemap = true
   return sitemap
 }

src/runtime/types.ts

@@ -133,9 +133,15 @@ export interface ModuleOptions extends SitemapDefinition {
    *
    * May be implemented by default in a future minor version.
    *
-   * @experimental
+   * @experimental Will be enabled by default in v5 (if stable)
    */
   experimentalWarmUp?: boolean
+  /**
+   * Send the Sitemap as a compressed stream supporting gzip, brolti, etc.
+   *
+   * @experimental Will be enabled by default in v5 (if stable)
+   */
+  experimentalCompression?: boolean
 }
 
 export interface IndexSitemapRemotes {