fix: remove head and options from params

facebook · Apr 30, 2024 · fb069b1 · fb069b1
1 parent 0065a3f
commit fb069b1
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 14 deletions.
diff --git a/packages/docusaurus-plugin-sitemap/src/createSitemap.ts b/packages/docusaurus-plugin-sitemap/src/createSitemap.ts
@@ -10,7 +10,7 @@ import {createMatcher, flattenRoutes} from '@docusaurus/utils';
 import {sitemapItemsToXmlString} from './xml';
 import {createSitemapItem} from './createSitemapItem';
 import type {SitemapItem, DefaultCreateSitemapParams} from './types';
-import type {RouteConfig} from '@docusaurus/types';
+import type {DocusaurusConfig, RouteConfig} from '@docusaurus/types';
 import type {HelmetServerState} from 'react-helmet-async';
 
 // Maybe we want to add a routeConfig.metadata.noIndex instead?
@@ -89,16 +89,28 @@ export default async function createSitemap(
   params: DefaultCreateSitemapParams,
 ): Promise<string | null> {
   const {head, options, routes, siteConfig} = params;
-  const createSitemapItems =
-    params.options.createSitemapItems ?? defaultCreateSitemapItems;
 
-  const sitemapItems = await createSitemapItems({
-    head,
-    options,
-    routes,
-    siteConfig,
-    defaultCreateSitemapItems,
-  });
+  const sitemapItems = params.options.createSitemapItems
+    ? await params.options.createSitemapItems({
+        routes,
+        siteConfig,
+        defaultCreateSitemapItems: (userParams: {
+          routes: RouteConfig[];
+          siteConfig: DocusaurusConfig;
+        }) =>
+          defaultCreateSitemapItems({
+            head,
+            options,
+            ...userParams,
+          }),
+      })
+    : await defaultCreateSitemapItems({
+        head,
+        options,
+        routes,
+        siteConfig,
+      });
+
   if (sitemapItems.length === 0) {
     return null;
   }

diff --git a/packages/docusaurus-plugin-sitemap/src/options.ts b/packages/docusaurus-plugin-sitemap/src/options.ts
@@ -58,9 +58,12 @@ type CreateSitemapItemsFn = (
   params: CreateSitemapItemsParams,
 ) => Promise<SitemapItem[]>;
 
-type CreateSitemapItemsParams = DefaultCreateSitemapParams & {
+type CreateSitemapItemsParams = Omit<
+  DefaultCreateSitemapParams,
+  'head' | 'options'
+> & {
   defaultCreateSitemapItems: (
-    params: DefaultCreateSitemapParams,
+    params: Omit<DefaultCreateSitemapParams, 'head' | 'options'>,
   ) => Promise<SitemapItem[]>;
 };
 

diff --git a/website/docs/api/plugins/plugin-sitemap.mdx b/website/docs/api/plugins/plugin-sitemap.mdx
@@ -58,8 +58,6 @@ Accepted fields:
 type CreateSitemapItemsFn = (params: {
   siteConfig: DocusaurusConfig;
   routes: RouteConfig[];
-  head: {[location: string]: HelmetServerState};
-  options: PluginOptions;
 }) => Promise<SitemapItem[]>;
 ```