@docusaurus/types 2.0.0-beta.1b0acc554 → 2.0.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "2.0.0-beta.1b0acc554",
+  "version": "2.0.0-beta.2",
   "description": "Common types for Docusaurus packages.",
   "main": "./src/index.js",
   "types": "./src/index.d.ts",
@@ -17,8 +17,8 @@
     "commander": "^5.1.0",
     "joi": "^17.4.0",
     "querystring": "0.2.0",
-    "webpack": "^5.37.0",
-    "webpack-merge": "^5.7.3"
+    "webpack": "^5.40.0",
+    "webpack-merge": "^5.8.0"
   },
-  "gitHead": "20372a8567c378da38b3de385f7e8bc85af5f2aa"
+  "gitHead": "883f07fddffaf1657407c8e202e370cc436e25f7"
 }

package/src/index.d.ts

@@ -26,7 +26,7 @@ export type ThemeConfig = {
 export interface DocusaurusConfig {
   baseUrl: string;
   baseUrlIssueBanner: boolean;
-  favicon: string;
+  favicon?: string;
   tagline?: string;
   title: string;
   url: string;
@@ -198,7 +198,7 @@ export interface Props extends LoadContext, InjectedHtmlTags {
   siteMetadata: DocusaurusSiteMetadata;
   routes: RouteConfig[];
   routesPaths: string[];
-  plugins: Plugin<unknown>[];
+  plugins: LoadedPlugin<unknown>[];
 }
 
 export interface PluginContentLoadedActions {
@@ -233,10 +233,12 @@ export interface Plugin<Content> {
   routesLoaded?(routes: RouteConfig[]): void; // TODO remove soon, deprecated (alpha-60)
   postBuild?(props: Props): void;
   postStart?(props: Props): void;
+  // TODO refactor the configureWebpack API surface: use an object instead of multiple params (requires breaking change)
   configureWebpack?(
     config: Configuration,
     isServer: boolean,
     utils: ConfigureWebpackUtils,
+    content: Content,
   ): Configuration & {mergeStrategy?: ConfigureWebpackFnMergeStrategy};
   configurePostCss?(options: PostCssOptions): PostCssOptions;
   getThemePath?(): string;
@@ -244,7 +246,9 @@ export interface Plugin<Content> {
   getPathsToWatch?(): string[];
   getClientModules?(): string[];
   extendCli?(cli: Command): void;
-  injectHtmlTags?(): {
+  injectHtmlTags?({
+    content: Content,
+  }): {
     headTags?: HtmlTags;
     preBodyTags?: HtmlTags;
     postBodyTags?: HtmlTags;
@@ -279,6 +283,13 @@ export interface Plugin<Content> {
   }): ThemeConfig;
 }
 
+export type InitializedPlugin = Plugin<unknown> & {
+  readonly options: PluginOptions;
+  readonly version: DocusaurusPluginVersionInformation;
+};
+
+export type LoadedPlugin = InitializedPlugin & {readonly content: unknown};
+
 export type PluginModule = {
   <T, X>(context: LoadContext, options: T): Plugin<X>;
   validateOptions?<T>(data: OptionValidationContext<T>): T;
@@ -333,7 +344,8 @@ export interface RouteConfig {
   priority?: number;
 }
 
-export interface ThemeAlias {
+// Aliases used for Webpack resolution (when using docusaurus swizzle)
+export interface ThemeAliases {
   [alias: string]: string;
 }