@docusaurus/plugin-sitemap 3.7.0 → 3.8.0

package/lib/createSitemap.d.ts

@@ -5,11 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { CreateSitemapItemsParams } from './types';
+import type { RouteBuildMetadata } from '@docusaurus/types';
 import type { PluginOptions } from './options';
-import type { HelmetServerState } from 'react-helmet-async';
 type CreateSitemapParams = CreateSitemapItemsParams & {
-    head: {
-        [location: string]: HelmetServerState;
+    routesBuildMetadata: {
+        [location: string]: RouteBuildMetadata;
     };
     options: PluginOptions;
 };

package/lib/createSitemap.js

@@ -15,16 +15,16 @@ const head_1 = require("./head");
 // - parent routes, used for layouts
 // - routes matching options.ignorePatterns
 // - routes with no index metadata
-function getSitemapRoutes({ routes, head, options }) {
+function getSitemapRoutes({ routes, routesBuildMetadata, options, }) {
     const { ignorePatterns } = options;
     const ignoreMatcher = (0, utils_1.createMatcher)(ignorePatterns);
     function isRouteExcluded(route) {
-        return (ignoreMatcher(route.path) || (0, head_1.isNoIndexMetaRoute)({ head, route: route.path }));
+        return (ignoreMatcher(route.path) ||
+            (0, head_1.isNoIndexMetaRoute)({ routesBuildMetadata, route: route.path }));
     }
     return (0, utils_1.flattenRoutes)(routes).filter((route) => !isRouteExcluded(route));
 }
 // Our default implementation receives some additional parameters on purpose
-// Params such as "head" are "messy" and not directly exposed to the user
 function createDefaultCreateSitemapItems(internalParams) {
     return async (params) => {
         const sitemapRoutes = getSitemapRoutes({ ...params, ...internalParams });
@@ -39,8 +39,8 @@ function createDefaultCreateSitemapItems(internalParams) {
     };
 }
 async function createSitemap(params) {
-    const { head, options, routes, siteConfig } = params;
-    const defaultCreateSitemapItems = createDefaultCreateSitemapItems({ head, options });
+    const { routesBuildMetadata, options, routes, siteConfig } = params;
+    const defaultCreateSitemapItems = createDefaultCreateSitemapItems({ routesBuildMetadata, options });
     const sitemapItems = params.options.createSitemapItems
         ? await params.options.createSitemapItems({
             routes,

package/lib/head.d.ts

@@ -4,10 +4,10 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { HelmetServerState } from 'react-helmet-async';
-export declare function isNoIndexMetaRoute({ head, route, }: {
-    head: {
-        [location: string]: HelmetServerState;
+import type { RouteBuildMetadata } from '@docusaurus/types';
+export declare function isNoIndexMetaRoute({ routesBuildMetadata, route, }: {
+    routesBuildMetadata: {
+        [location: string]: RouteBuildMetadata;
     };
     route: string;
 }): boolean;

package/lib/head.js

@@ -9,18 +9,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 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, }) {
-    const isNoIndexMetaTag = ({ name, content, }) => {
-        if (!name || !content) {
-            return false;
-        }
-        return (
-        // meta name is not case-sensitive
-        name.toLowerCase() === 'robots' &&
-            // Robots directives are not case-sensitive
-            content.toLowerCase().includes('noindex'));
-    };
-    // https://github.com/staylor/react-helmet-async/pull/167
-    const meta = head[route]?.meta.toComponent();
-    return (meta?.some((tag) => isNoIndexMetaTag({ name: tag.props.name, content: tag.props.content })) ?? false);
+function isNoIndexMetaRoute({ routesBuildMetadata, route, }) {
+    const routeBuildMetadata = routesBuildMetadata[route];
+    if (routeBuildMetadata) {
+        return routeBuildMetadata.noIndex;
+    }
+    return false;
 }

package/lib/index.js

@@ -21,7 +21,7 @@ function pluginSitemap(context, options) {
     }
     return {
         name: PluginName,
-        async postBuild({ siteConfig, routes, outDir, head }) {
+        async postBuild({ siteConfig, routes, outDir, routesBuildMetadata }) {
             if (siteConfig.noIndex) {
                 return;
             }
@@ -29,7 +29,7 @@ function pluginSitemap(context, options) {
             const generatedSitemap = await (0, createSitemap_1.default)({
                 siteConfig,
                 routes,
-                head,
+                routesBuildMetadata,
                 options,
             });
             if (!generatedSitemap) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "3.7.0",
+  "version": "3.8.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.7.0",
-    "@docusaurus/logger": "3.7.0",
-    "@docusaurus/types": "3.7.0",
-    "@docusaurus/utils": "3.7.0",
-    "@docusaurus/utils-common": "3.7.0",
-    "@docusaurus/utils-validation": "3.7.0",
+    "@docusaurus/core": "3.8.0",
+    "@docusaurus/logger": "3.8.0",
+    "@docusaurus/types": "3.8.0",
+    "@docusaurus/utils": "3.8.0",
+    "@docusaurus/utils-common": "3.8.0",
+    "@docusaurus/utils-validation": "3.8.0",
     "fs-extra": "^11.1.1",
     "sitemap": "^7.1.1",
     "tslib": "^2.6.0"
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "dd59750c16fe6908a26f18806a54d4c3dbe6db43"
+  "gitHead": "948d63c42fad0ba24b7b531a9deb6167e64dc845"
 }

package/src/createSitemap.ts

@@ -10,22 +10,26 @@ import {sitemapItemsToXmlString} from './xml';
 import {createSitemapItem} from './createSitemapItem';
 import {isNoIndexMetaRoute} from './head';
 import type {CreateSitemapItemsFn, CreateSitemapItemsParams} from './types';
-import type {RouteConfig} from '@docusaurus/types';
+import type {RouteConfig, RouteBuildMetadata} from '@docusaurus/types';
 import type {PluginOptions} from './options';
-import type {HelmetServerState} from 'react-helmet-async';
 
 // Not all routes should appear in the sitemap, and we should filter:
 // - parent routes, used for layouts
 // - routes matching options.ignorePatterns
 // - routes with no index metadata
-function getSitemapRoutes({routes, head, options}: CreateSitemapParams) {
+function getSitemapRoutes({
+  routes,
+  routesBuildMetadata,
+  options,
+}: CreateSitemapParams) {
   const {ignorePatterns} = options;
 
   const ignoreMatcher = createMatcher(ignorePatterns);
 
   function isRouteExcluded(route: RouteConfig) {
     return (
-      ignoreMatcher(route.path) || isNoIndexMetaRoute({head, route: route.path})
+      ignoreMatcher(route.path) ||
+      isNoIndexMetaRoute({routesBuildMetadata, route: route.path})
     );
   }
 
@@ -33,9 +37,8 @@ function getSitemapRoutes({routes, head, options}: CreateSitemapParams) {
 }
 
 // Our default implementation receives some additional parameters on purpose
-// Params such as "head" are "messy" and not directly exposed to the user
 function createDefaultCreateSitemapItems(
-  internalParams: Pick<CreateSitemapParams, 'head' | 'options'>,
+  internalParams: Pick<CreateSitemapParams, 'routesBuildMetadata' | 'options'>,
 ): CreateSitemapItemsFn {
   return async (params) => {
     const sitemapRoutes = getSitemapRoutes({...params, ...internalParams});
@@ -55,17 +58,17 @@ function createDefaultCreateSitemapItems(
 }
 
 type CreateSitemapParams = CreateSitemapItemsParams & {
-  head: {[location: string]: HelmetServerState};
+  routesBuildMetadata: {[location: string]: RouteBuildMetadata};
   options: PluginOptions;
 };
 
 export default async function createSitemap(
   params: CreateSitemapParams,
 ): Promise<string | null> {
-  const {head, options, routes, siteConfig} = params;
+  const {routesBuildMetadata, options, routes, siteConfig} = params;
 
   const defaultCreateSitemapItems: CreateSitemapItemsFn =
-    createDefaultCreateSitemapItems({head, options});
+    createDefaultCreateSitemapItems({routesBuildMetadata, options});
 
   const sitemapItems = params.options.createSitemapItems
     ? await params.options.createSitemapItems({

package/src/head.ts

@@ -5,43 +5,21 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {ReactElement} from 'react';
-import type {HelmetServerState} from 'react-helmet-async';
+import type {RouteBuildMetadata} from '@docusaurus/types';
 
 // Maybe we want to add a routeConfig.metadata.noIndex instead?
 // But using Helmet is more reliable for third-party plugins...
 export function isNoIndexMetaRoute({
-  head,
+  routesBuildMetadata,
   route,
 }: {
-  head: {[location: string]: HelmetServerState};
+  routesBuildMetadata: {[location: string]: RouteBuildMetadata};
   route: string;
 }): boolean {
-  const isNoIndexMetaTag = ({
-    name,
-    content,
-  }: {
-    name?: string;
-    content?: string;
-  }): boolean => {
-    if (!name || !content) {
-      return false;
-    }
-    return (
-      // meta name is not case-sensitive
-      name.toLowerCase() === 'robots' &&
-      // Robots directives are not case-sensitive
-      content.toLowerCase().includes('noindex')
-    );
-  };
+  const routeBuildMetadata = routesBuildMetadata[route];
 
-  // https://github.com/staylor/react-helmet-async/pull/167
-  const meta = head[route]?.meta.toComponent() as unknown as
-    | ReactElement<{name?: string; content?: string}>[]
-    | undefined;
-  return (
-    meta?.some((tag) =>
-      isNoIndexMetaTag({name: tag.props.name, content: tag.props.content}),
-    ) ?? false
-  );
+  if (routeBuildMetadata) {
+    return routeBuildMetadata.noIndex;
+  }
+  return false;
 }

package/src/index.ts

@@ -28,7 +28,7 @@ export default function pluginSitemap(
   return {
     name: PluginName,
 
-    async postBuild({siteConfig, routes, outDir, head}) {
+    async postBuild({siteConfig, routes, outDir, routesBuildMetadata}) {
       if (siteConfig.noIndex) {
         return;
       }
@@ -36,7 +36,7 @@ export default function pluginSitemap(
       const generatedSitemap = await createSitemap({
         siteConfig,
         routes,
-        head,
+        routesBuildMetadata,
         options,
       });
       if (!generatedSitemap) {