@docusaurus/plugin-sitemap 3.4.0 → 3.5.0

package/lib/createSitemap.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = createSitemap;
 const utils_1 = require("@docusaurus/utils");
 const xml_1 = require("./xml");
 const createSitemapItem_1 = require("./createSitemapItem");
@@ -58,4 +59,3 @@ async function createSitemap(params) {
     });
     return xmlString;
 }
-exports.default = createSitemap;

package/lib/createSitemapItem.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createSitemapItem = void 0;
+exports.createSitemapItem = createSitemapItem;
 const utils_common_1 = require("@docusaurus/utils-common");
 const utils_1 = require("@docusaurus/utils");
 async function getRouteLastUpdatedAt(route) {
@@ -49,4 +49,3 @@ async function createSitemapItem({ route, siteConfig, options, }) {
         lastmod: await getRouteLastmod({ route, lastmod }),
     };
 }
-exports.createSitemapItem = createSitemapItem;

package/lib/head.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNoIndexMetaRoute = void 0;
+exports.isNoIndexMetaRoute = isNoIndexMetaRoute;
 // Maybe we want to add a routeConfig.metadata.noIndex instead?
 // But using Helmet is more reliable for third-party plugins...
 function isNoIndexMetaRoute({ head, route, }) {
@@ -24,4 +24,3 @@ function isNoIndexMetaRoute({ head, route, }) {
     const meta = head[route]?.meta.toComponent();
     return (meta?.some((tag) => isNoIndexMetaTag({ name: tag.props.name, content: tag.props.content })) ?? false);
 }
-exports.isNoIndexMetaRoute = isNoIndexMetaRoute;

package/lib/index.d.ts

@@ -6,6 +6,6 @@
  */
 import type { PluginOptions, Options } from './options';
 import type { LoadContext, Plugin } from '@docusaurus/types';
-export default function pluginSitemap(context: LoadContext, options: PluginOptions): Plugin<void>;
+export default function pluginSitemap(context: LoadContext, options: PluginOptions): Plugin<void> | null;
 export { validateOptions } from './options';
 export type { PluginOptions, Options };

package/lib/index.js

@@ -7,6 +7,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateOptions = void 0;
+exports.default = pluginSitemap;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -16,7 +17,7 @@ const PluginName = 'docusaurus-plugin-sitemap';
 function pluginSitemap(context, options) {
     if (context.siteConfig.future.experimental_router === 'hash') {
         logger_1.default.warn(`${PluginName} does not support the Hash Router and will be disabled.`);
-        return { name: PluginName };
+        return null;
     }
     return {
         name: PluginName,
@@ -46,6 +47,5 @@ function pluginSitemap(context, options) {
         },
     };
 }
-exports.default = pluginSitemap;
 var options_1 = require("./options");
 Object.defineProperty(exports, "validateOptions", { enumerable: true, get: function () { return options_1.validateOptions; } });

package/lib/options.js

@@ -6,7 +6,8 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateOptions = exports.DEFAULT_OPTIONS = void 0;
+exports.DEFAULT_OPTIONS = void 0;
+exports.validateOptions = validateOptions;
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const types_1 = require("./types");
 exports.DEFAULT_OPTIONS = {
@@ -56,4 +57,3 @@ function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);
     return validatedOptions;
 }
-exports.validateOptions = validateOptions;

package/lib/xml.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.sitemapItemsToXmlString = void 0;
+exports.sitemapItemsToXmlString = sitemapItemsToXmlString;
 const sitemap_1 = require("sitemap");
 async function sitemapItemsToXmlString(items, options) {
     if (items.length === 0) {
@@ -27,4 +27,3 @@ async function sitemapItemsToXmlString(items, options) {
     const buffer = await (0, sitemap_1.streamToPromise)(sitemapStream);
     return buffer.toString();
 }
-exports.sitemapItemsToXmlString = sitemapItemsToXmlString;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.4.0",
-    "@docusaurus/logger": "3.4.0",
-    "@docusaurus/types": "3.4.0",
-    "@docusaurus/utils": "3.4.0",
-    "@docusaurus/utils-common": "3.4.0",
-    "@docusaurus/utils-validation": "3.4.0",
+    "@docusaurus/core": "3.5.0",
+    "@docusaurus/logger": "3.5.0",
+    "@docusaurus/types": "3.5.0",
+    "@docusaurus/utils": "3.5.0",
+    "@docusaurus/utils-common": "3.5.0",
+    "@docusaurus/utils-validation": "3.5.0",
     "fs-extra": "^11.1.1",
     "sitemap": "^7.1.1",
     "tslib": "^2.6.0"
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "49e9a2143274a8dd795659b417b470bc42abbd6e"
+  "gitHead": "cb5829f3c34b26d798b869e38ee25073488140bd"
 }

package/src/index.ts

@@ -17,12 +17,12 @@ const PluginName = 'docusaurus-plugin-sitemap';
 export default function pluginSitemap(
   context: LoadContext,
   options: PluginOptions,
-): Plugin<void> {
+): Plugin<void> | null {
   if (context.siteConfig.future.experimental_router === 'hash') {
     logger.warn(
       `${PluginName} does not support the Hash Router and will be disabled.`,
     );
-    return {name: PluginName};
+    return null;
   }
 
   return {