TS fix

facebook · Jan 17, 2025 · d3028cc · d3028cc
1 parent e499f7c
commit d3028cc
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/packages/docusaurus-types/src/index.d.ts b/packages/docusaurus-types/src/index.d.ts
@@ -67,7 +67,6 @@ export {
   Validate,
   ValidationSchema,
   AllContent,
-  PostBuildProps,
   RouteBuildMetadata,
   ConfigureWebpackUtils,
   PostCssOptions,

diff --git a/packages/docusaurus-types/src/plugin.d.ts b/packages/docusaurus-types/src/plugin.d.ts
@@ -119,7 +119,7 @@ export type RouteBuildMetadata = {
   // For now the only need is our sitemap plugin to filter noindex pages
   noIndex: boolean;
 };
-export type PostBuildProps = Props & {
+export type PostBuildProps<Content> = Props & {
   content: Content;
 
   // TODO Docusaurus v4: remove old messy unserializable "head" API
@@ -141,7 +141,16 @@ export type Plugin<Content = unknown> = {
     allContent: AllContent;
     actions: PluginContentLoadedActions;
   }) => Promise<void> | void;
-  postBuild?: (props: PostBuildProps) => Promise<void> | void;
+  postBuild?: (
+    props: Props & {
+      content: Content;
+      // TODO Docusaurus v4: remove old messy unserializable "head" API
+      //  breaking change, replaced by routesBuildMetadata
+      //  Reason: https://github.com/facebook/docusaurus/pull/10826
+      head: {[location: string]: HelmetServerState};
+      routesBuildMetadata: {[location: string]: RouteBuildMetadata};
+    },
+  ) => Promise<void> | void;
   // TODO Docusaurus v4 ?
   //  refactor the configureWebpack API surface: use an object instead of
   //  multiple params (requires breaking change)

diff --git a/packages/docusaurus/src/commands/build/buildLocale.ts b/packages/docusaurus/src/commands/build/buildLocale.ts
@@ -23,7 +23,6 @@ import type {
   ConfigureWebpackUtils,
   LoadedPlugin,
   Props,
-  PostBuildProps,
 } from '@docusaurus/types';
 import type {SiteCollectedData} from '../../common';
 import {BuildCLIOptions} from './build';
@@ -139,15 +138,12 @@ async function executePluginsPostBuild({
       if (!plugin.postBuild) {
         return;
       }
-
-      const postBuildProps: PostBuildProps = {
+      await plugin.postBuild({
         ...props,
         head,
         routesBuildMetadata,
         content: plugin.content,
-      };
-
-      await plugin.postBuild(postBuildProps);
+      });
     }),
   );
 }