@docusaurus/plugin-sitemap 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/index.js

@@ -10,6 +10,7 @@ exports.validateOptions = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const createSitemap_1 = tslib_1.__importDefault(require("./createSitemap"));
 function pluginSitemap(context, options) {
     return {
@@ -21,12 +22,13 @@ function pluginSitemap(context, options) {
             // Generate sitemap.
             const generatedSitemap = await (0, createSitemap_1.default)(siteConfig, routesPaths, head, options);
             // Write sitemap file.
-            const sitemapPath = path_1.default.join(outDir, 'sitemap.xml');
+            const sitemapPath = path_1.default.join(outDir, options.filename);
             try {
                 await fs_extra_1.default.outputFile(sitemapPath, generatedSitemap);
             }
             catch (err) {
-                throw new Error(`Writing sitemap failed: ${err}`);
+                logger_1.default.error('Writing sitemap failed.');
+                throw err;
             }
         },
     };

package/lib/options.d.ts

@@ -16,6 +16,11 @@ export declare type PluginOptions = {
      * sitemap. Note that you may need to include the base URL in here.
      */
     ignorePatterns: string[];
+    /**
+     * The path to the created sitemap file, relative to the output directory.
+     * Useful if you have two plugin instances outputting two files.
+     */
+    filename: string;
 };
 export declare type Options = Partial<PluginOptions>;
 export declare const DEFAULT_OPTIONS: PluginOptions;

package/lib/options.js

@@ -13,8 +13,10 @@ exports.DEFAULT_OPTIONS = {
     changefreq: sitemap_1.EnumChangefreq.WEEKLY,
     priority: 0.5,
     ignorePatterns: [],
+    filename: 'sitemap.xml',
 };
 const PluginOptionSchema = utils_validation_1.Joi.object({
+    // @ts-expect-error: forbidden
     cacheTime: utils_validation_1.Joi.forbidden().messages({
         'any.unknown': 'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
     }),
@@ -28,6 +30,7 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     trailingSlash: utils_validation_1.Joi.forbidden().messages({
         'any.unknown': 'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
     }),
+    filename: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.filename),
 });
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "2.0.0-beta.20",
+  "version": "2.0.0-beta.21",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,23 +18,24 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.20",
-    "@docusaurus/utils": "2.0.0-beta.20",
-    "@docusaurus/utils-common": "2.0.0-beta.20",
-    "@docusaurus/utils-validation": "2.0.0-beta.20",
+    "@docusaurus/core": "2.0.0-beta.21",
+    "@docusaurus/logger": "2.0.0-beta.21",
+    "@docusaurus/utils": "2.0.0-beta.21",
+    "@docusaurus/utils-common": "2.0.0-beta.21",
+    "@docusaurus/utils-validation": "2.0.0-beta.21",
     "fs-extra": "^10.1.0",
     "sitemap": "^7.1.1",
     "tslib": "^2.4.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "2.0.0-beta.20"
+    "@docusaurus/types": "2.0.0-beta.21"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=16.14"
   },
-  "gitHead": "ed5cdba401a5948e187e927039b142a0decc702d"
+  "gitHead": "69ac49fc6909517f13615ee40290c4bd00c39df4"
 }

package/src/createSitemap.ts

@@ -5,13 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import type {ReactElement} from 'react';
 import {SitemapStream, streamToPromise} from 'sitemap';
 import {applyTrailingSlash} from '@docusaurus/utils-common';
 import {createMatcher} from '@docusaurus/utils';
 import type {DocusaurusConfig} from '@docusaurus/types';
 import type {HelmetServerState} from 'react-helmet-async';
 import type {PluginOptions} from './options';
-import type {ReactElement} from 'react';
 
 export default async function createSitemap(
   siteConfig: DocusaurusConfig,
@@ -35,7 +35,7 @@ export default async function createSitemap(
     }
     // https://github.com/staylor/react-helmet-async/pull/167
     const meta = head[route]?.meta.toComponent() as unknown as
-      | ReactElement[]
+      | ReactElement<{name?: string; content?: string}>[]
       | undefined;
     return !meta?.some(
       (tag) => tag.props.name === 'robots' && tag.props.content === 'noindex',

package/src/index.ts

@@ -7,6 +7,7 @@
 
 import fs from 'fs-extra';
 import path from 'path';
+import logger from '@docusaurus/logger';
 import createSitemap from './createSitemap';
 import type {PluginOptions, Options} from './options';
 import type {LoadContext, Plugin} from '@docusaurus/types';
@@ -31,11 +32,12 @@ export default function pluginSitemap(
       );
 
       // Write sitemap file.
-      const sitemapPath = path.join(outDir, 'sitemap.xml');
+      const sitemapPath = path.join(outDir, options.filename);
       try {
         await fs.outputFile(sitemapPath, generatedSitemap);
       } catch (err) {
-        throw new Error(`Writing sitemap failed: ${err}`);
+        logger.error('Writing sitemap failed.');
+        throw err;
       }
     },
   };

package/src/options.ts

@@ -19,6 +19,11 @@ export type PluginOptions = {
    * sitemap. Note that you may need to include the base URL in here.
    */
   ignorePatterns: string[];
+  /**
+   * The path to the created sitemap file, relative to the output directory.
+   * Useful if you have two plugin instances outputting two files.
+   */
+  filename: string;
 };
 
 export type Options = Partial<PluginOptions>;
@@ -27,9 +32,11 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   changefreq: EnumChangefreq.WEEKLY,
   priority: 0.5,
   ignorePatterns: [],
+  filename: 'sitemap.xml',
 };
 
-const PluginOptionSchema = Joi.object({
+const PluginOptionSchema = Joi.object<PluginOptions>({
+  // @ts-expect-error: forbidden
   cacheTime: Joi.forbidden().messages({
     'any.unknown':
       'Option `cacheTime` in sitemap config is deprecated. Please remove it.',
@@ -45,6 +52,7 @@ const PluginOptionSchema = Joi.object({
     'any.unknown':
       'Please use the new Docusaurus global trailingSlash config instead, and the sitemaps plugin will use it.',
   }),
+  filename: Joi.string().default(DEFAULT_OPTIONS.filename),
 });
 
 export function validateOptions({