@nuxtjs/sitemap 2.4.0 → 5.0.0

package/lib/middleware.js

@@ -1,195 +0,0 @@
-const { gzipSync } = require('zlib')
-
-const generateETag = require('etag')
-const fresh = require('fresh')
-
-const { createSitemap, createSitemapIndex } = require('./builder')
-const { createRoutesCache } = require('./cache')
-const logger = require('./logger')
-const { setDefaultSitemapOptions, setDefaultSitemapIndexOptions } = require('./options')
-const { excludeRoutes } = require('./routes')
-
-/**
- * Register a middleware for each sitemap or sitemapindex
- *
- * @param {Object} options
- * @param {Object} globalCache
- * @param {Nuxt}   nuxtInstance
- * @param {number} depth
- */
-function registerSitemaps(options, globalCache, nuxtInstance, depth = 0) {
-  /* istanbul ignore if */
-  if (depth > 1) {
-    // see https://webmasters.stackexchange.com/questions/18243/can-a-sitemap-index-contain-other-sitemap-indexes
-    logger.warn("A sitemap index file can't list other sitemap index files, but only sitemap files")
-  }
-
-  const isSitemapIndex = options && options.sitemaps && Array.isArray(options.sitemaps) && options.sitemaps.length > 0
-
-  if (isSitemapIndex) {
-    registerSitemapIndex(options, globalCache, nuxtInstance, depth)
-  } else {
-    registerSitemap(options, globalCache, nuxtInstance, depth)
-  }
-}
-
-/**
- * Register a middleware to serve a sitemap
- *
- * @param {Object} options
- * @param {Object} globalCache
- * @param {Nuxt}   nuxtInstance
- * @param {number} depth
- */
-function registerSitemap(options, globalCache, nuxtInstance, depth = 0) {
-  const base = nuxtInstance.options.router.base
-
-  // Init options
-  options = setDefaultSitemapOptions(options, nuxtInstance, depth > 0)
-
-  // Init cache
-  const cache = {}
-  cache.staticRoutes = () => excludeRoutes(options.exclude, globalCache.staticRoutes)
-  cache.routes = createRoutesCache(cache, options)
-
-  // On run cmd "start" or "generate [--no-build]"
-  if (globalCache.staticRoutes) {
-    // On server ready
-    nuxtInstance.nuxt.hook('listen', () => {
-      // Hydrate cache
-      cache.routes.get('routes')
-    })
-  }
-
-  if (options.gzip) {
-    // Add server middleware for sitemap.xml.gz
-    nuxtInstance.addServerMiddleware({
-      path: options.pathGzip,
-      async handler(req, res, next) {
-        try {
-          // Init sitemap
-          const routes = await cache.routes.get('routes')
-          const gzip = await createSitemap(options, routes, base, req).toGzip()
-          // Check cache headers
-          if (validHttpCache(gzip, options.etag, req, res)) {
-            return
-          }
-          // Send http response
-          res.setHeader('Content-Type', 'application/gzip')
-          res.end(gzip)
-        } catch (err) {
-          /* istanbul ignore next */
-          next(err)
-        }
-      },
-    })
-  }
-
-  // Add server middleware for sitemap.xml
-  nuxtInstance.addServerMiddleware({
-    path: options.path,
-    /**
-     * @param {Request} req
-     * @param {Response} res
-     * @param {*} next
-     */
-    async handler(req, res, next) {
-      try {
-        // Init sitemap
-        const routes = await cache.routes.get('routes')
-        const xml = await createSitemap(options, routes, base, req).toXML()
-        // Check cache headers
-        if (validHttpCache(xml, options.etag, req, res)) {
-          return
-        }
-        // Send http response
-        res.setHeader('Content-Type', 'application/xml')
-        res.end(xml)
-      } catch (err) {
-        /* istanbul ignore next */
-        next(err)
-      }
-    },
-  })
-}
-
-/**
- * Register a middleware to serve a sitemapindex
- *
- * @param {Object} options
- * @param {Object} globalCache
- * @param {Nuxt}   nuxtInstance
- * @param {number} depth
- */
-function registerSitemapIndex(options, globalCache, nuxtInstance, depth = 0) {
-  const base = nuxtInstance.options.router.base
-
-  // Init options
-  options = setDefaultSitemapIndexOptions(options, nuxtInstance)
-
-  if (options.gzip) {
-    // Add server middleware for sitemapindex.xml.gz
-    nuxtInstance.addServerMiddleware({
-      path: options.pathGzip,
-      handler(req, res, next) {
-        // Init sitemap index
-        const sitemapIndex = createSitemapIndex(options, base, req)
-        const gzip = gzipSync(sitemapIndex)
-        // Check cache headers
-        if (validHttpCache(gzip, options.etag, req, res)) {
-          return
-        }
-        // Send http response
-        res.setHeader('Content-Type', 'application/gzip')
-        res.end(gzip)
-      },
-    })
-  }
-
-  // Add server middleware for sitemapindex.xml
-  nuxtInstance.addServerMiddleware({
-    path: options.path,
-    handler(req, res, next) {
-      // Init sitemap index
-      const xml = createSitemapIndex(options, base, req)
-      // Check cache headers
-      if (validHttpCache(xml, options.etag, req, res)) {
-        return
-      }
-      // Send http response
-      res.setHeader('Content-Type', 'application/xml')
-      res.end(xml)
-    },
-  })
-
-  // Register linked sitemaps
-  options.sitemaps.forEach((sitemapOptions) => registerSitemaps(sitemapOptions, globalCache, nuxtInstance, depth + 1))
-}
-
-/**
- * Validate the freshness of HTTP cache using headers
- *
- * @param {Object} entity
- * @param {Object} options
- * @param {Request} req
- * @param {Response} res
- * @returns {boolean}
- */
-function validHttpCache(entity, options, req, res) {
-  if (!options) {
-    return false
-  }
-  const { hash } = options
-  const etag = hash ? hash(entity, options) : generateETag(entity, options)
-  if (fresh(req.headers, { etag })) {
-    // Resource not modified
-    res.statusCode = 304
-    res.end()
-    return true
-  }
-  // Add ETag header
-  res.setHeader('ETag', etag)
-  return false
-}
-
-module.exports = { registerSitemaps, registerSitemap, registerSitemapIndex }

package/lib/module.js

@@ -1,72 +0,0 @@
-const path = require('path')
-
-const fs = require('fs-extra')
-
-const { generateSitemaps } = require('./generator')
-const logger = require('./logger')
-const { registerSitemaps } = require('./middleware')
-const { getStaticRoutes } = require('./routes')
-
-module.exports = async function module(moduleOptions) {
-  const nuxtInstance = this
-
-  // Init options
-  const options = await initOptions(nuxtInstance, moduleOptions)
-  if (options === false) {
-    logger.info('Sitemap disabled')
-    return
-  }
-
-  // Init cache
-  // a file "sitemap-routes.json" is written to "dist" dir on "build" mode
-  const jsonStaticRoutesPath = !nuxtInstance.options.dev
-    ? path.resolve(nuxtInstance.options.buildDir, path.join('dist', 'sitemap-routes.json'))
-    : null
-  const staticRoutes = fs.readJsonSync(jsonStaticRoutesPath, { throws: false })
-  const globalCache = { staticRoutes }
-
-  // Init static routes
-  nuxtInstance.extendRoutes((routes) => {
-    // Create a cache for static routes
-    globalCache.staticRoutes = getStaticRoutes(routes)
-
-    // On run cmd "build"
-    if (!nuxtInstance.options.dev) {
-      // Save static routes
-      fs.outputJsonSync(jsonStaticRoutesPath, globalCache.staticRoutes)
-    }
-  })
-
-  // On "generate" mode, generate static files for each sitemap or sitemapindex
-  nuxtInstance.nuxt.hook('generate:done', async () => {
-    await nuxtInstance.nuxt.callHook('sitemap:generate:before', nuxtInstance, options)
-    logger.info('Generating sitemaps')
-    await Promise.all(options.map((options) => generateSitemaps(options, globalCache, nuxtInstance)))
-    await nuxtInstance.nuxt.callHook('sitemap:generate:done', nuxtInstance)
-  })
-
-  // On "ssr" mode, register middlewares for each sitemap or sitemapindex
-  options.forEach((options) => {
-    registerSitemaps(options, globalCache, nuxtInstance)
-  })
-}
-
-async function initOptions(nuxtInstance, moduleOptions) {
-  if (nuxtInstance.options.sitemap === false || moduleOptions === false) {
-    return false
-  }
-
-  let options = nuxtInstance.options.sitemap || moduleOptions
-
-  if (typeof options === 'function') {
-    options = await options.call(nuxtInstance)
-  }
-
-  if (options === false) {
-    return false
-  }
-
-  return Array.isArray(options) ? options : [options]
-}
-
-module.exports.meta = require('../package.json')

package/lib/options.js

@@ -1,135 +0,0 @@
-const MODULE_NAME = require('../package.json').name
-
-const logger = require('./logger')
-
-const DEFAULT_NUXT_PUBLIC_PATH = '/_nuxt/'
-
-/**
- * Set default options for a sitemap config
- *
- * @param   {Object}  options
- * @param   {Nuxt}    nuxtInstance
- * @param   {boolean} isLinkedToSitemapIndex
- * @returns {Object}
- */
-function setDefaultSitemapOptions(options, nuxtInstance, isLinkedToSitemapIndex = false) {
-  const defaults = {
-    path: '/sitemap.xml',
-    hostname:
-      // TODO: remove support of "build.publicPath" on release 3.0
-      nuxtInstance.options.build.publicPath !== DEFAULT_NUXT_PUBLIC_PATH
-        ? nuxtInstance.options.build.publicPath
-        : undefined,
-    exclude: [],
-    routes: nuxtInstance.options.generate.routes || [],
-    cacheTime: 1000 * 60 * 15,
-    etag: nuxtInstance.options.render.etag,
-    filter: undefined,
-    gzip: false,
-    xmlNs: undefined,
-    xslUrl: undefined,
-    trailingSlash: false,
-    lastmod: undefined,
-    i18n: undefined,
-    defaults: {},
-  }
-
-  const sitemapOptions = {
-    ...defaults,
-    ...options,
-  }
-
-  if (sitemapOptions.i18n) {
-    // Check modules config
-    const modules = Object.keys(nuxtInstance.requiredModules)
-    /* istanbul ignore if */
-    if (modules.indexOf('nuxt-i18n') > modules.indexOf(MODULE_NAME)) {
-      logger.warn(
-        `To enable the "i18n" option, the "${MODULE_NAME}" must be declared after the "nuxt-i18n" module in your config`
-      )
-    }
-
-    /* istanbul ignore if */
-    if (typeof sitemapOptions.i18n === 'string') {
-      // TODO: remove support of "string" as shortcut notation on release 3.0
-      sitemapOptions.i18n = true
-    }
-
-    // Set default i18n options
-    sitemapOptions.i18n = {
-      locales: [],
-      routesNameSeparator: '___',
-      ...sitemapOptions.i18n,
-    }
-  }
-
-  /* istanbul ignore if */
-  if (sitemapOptions.generate) {
-    logger.warn("The `generate` option isn't needed anymore in your config. Please remove it!")
-  }
-
-  /* istanbul ignore if */
-  if (!sitemapOptions.path) {
-    logger.fatal('The `path` option is either empty or missing in your config for a sitemap', options)
-  }
-
-  /* istanbul ignore if */
-  if (sitemapOptions.lastmod && !isLinkedToSitemapIndex) {
-    logger.warn('The `lastmod` option is only available in the config of a sitemap linked to a sitemap index')
-  }
-
-  sitemapOptions.pathGzip = sitemapOptions.gzip ? `${sitemapOptions.path}.gz` : sitemapOptions.path
-
-  return sitemapOptions
-}
-
-/**
- * Set default options for a sitemapindex config
- *
- * @param   {Object} options
- * @param   {Nuxt}   nuxtInstance
- * @returns {Object}
- */
-function setDefaultSitemapIndexOptions(options, nuxtInstance) {
-  const defaults = {
-    path: '/sitemapindex.xml',
-    hostname: undefined,
-    sitemaps: [],
-    lastmod: undefined,
-    etag: nuxtInstance.options.render.etag,
-    gzip: false,
-    xmlNs: undefined,
-    xslUrl: undefined,
-  }
-
-  const sitemapIndexOptions = {
-    ...defaults,
-    ...options,
-  }
-
-  /* istanbul ignore if */
-  if (sitemapIndexOptions.generate) {
-    logger.warn("The `generate` option isn't needed anymore in your config. Please remove it!")
-  }
-
-  /* istanbul ignore if */
-  if (!sitemapIndexOptions.path) {
-    logger.fatal('The `path` option is either empty or missing in your config for a sitemap index', options)
-  }
-
-  sitemapIndexOptions.sitemaps.forEach((sitemapOptions) => {
-    /* istanbul ignore if */
-    if (!sitemapOptions.path) {
-      logger.fatal('The `path` option is either empty or missing in your config for a sitemap', sitemapOptions)
-    }
-
-    // set cascading hostname
-    sitemapOptions.hostname = sitemapOptions.hostname || sitemapIndexOptions.hostname
-  })
-
-  sitemapIndexOptions.pathGzip = sitemapIndexOptions.gzip ? `${sitemapIndexOptions.path}.gz` : sitemapIndexOptions.path
-
-  return sitemapIndexOptions
-}
-
-module.exports = { setDefaultSitemapOptions, setDefaultSitemapIndexOptions }

package/lib/routes.js

@@ -1,55 +0,0 @@
-const { Minimatch } = require('minimatch')
-
-/**
- * Exclude routes by matching glob patterns on url
- *
- * @param   {string[]} patterns
- * @param   {Array}    routes
- * @returns {Array}
- */
-function excludeRoutes(patterns, routes) {
-  patterns.forEach((pattern) => {
-    const minimatch = new Minimatch(pattern)
-    minimatch.negate = true
-    routes = routes.filter(({ url }) => minimatch.match(url))
-  })
-  return routes
-}
-
-/**
- * Get static routes from Nuxt router and ignore dynamic routes
- *
- * @param   {Object} router
- * @returns {Array}
- */
-function getStaticRoutes(router) {
-  return flattenStaticRoutes(router)
-}
-
-/**
- * Recursively flatten all static routes and their nested routes
- *
- * @param   {Object} router
- * @param   {string} path
- * @param   {Array}  routes
- * @returns {Array}
- */
-function flattenStaticRoutes(router, path = '', routes = []) {
-  router.forEach((route) => {
-    // Skip dynamic routes
-    if ([':', '*'].some((c) => route.path.includes(c))) {
-      return
-    }
-    // Nested routes
-    if (route.children) {
-      return flattenStaticRoutes(route.children, path + route.path + '/', routes)
-    }
-    // Normalize url (without trailing slash)
-    route.url = path.length && !route.path.length ? path.slice(0, -1) : path + route.path
-
-    routes.push(route)
-  })
-  return routes
-}
-
-module.exports = { excludeRoutes, getStaticRoutes }