@docusaurus/types 2.0.0-beta.15 → 2.0.0-beta.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "2.0.0-beta.15",
+  "version": "2.0.0-beta.16",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -17,11 +17,11 @@
   },
   "dependencies": {
     "commander": "^5.1.0",
-    "joi": "^17.4.2",
+    "joi": "^17.6.0",
     "querystring": "0.2.1",
     "utility-types": "^3.10.0",
-    "webpack": "^5.61.0",
+    "webpack": "^5.69.1",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "32ec84ef3c0a238436e913b2026ab809e5750fa8"
+  "gitHead": "eb43c4d4f95a4fb97dc9bb9dc615413e0dc2e1e7"
 }

package/src/index.d.ts

@@ -6,15 +6,12 @@
  */
 
 import type {RuleSetRule, Configuration} from 'webpack';
-import type {Command} from 'commander';
+import type {CustomizeRuleString} from 'webpack-merge/dist/types';
+import type {CommanderStatic} from 'commander';
 import type {ParsedUrlQueryInput} from 'querystring';
 import type Joi from 'joi';
 import type {Overwrite, DeepPartial} from 'utility-types';
-
-// Convert webpack-merge webpack-merge enum to union type
-// For type retro-compatible webpack-merge upgrade: we used string literals before)
-// see https://github.com/survivejs/webpack-merge/issues/179
-type MergeStrategy = 'match' | 'merge' | 'append' | 'prepend' | 'replace';
+import type {Location} from 'history';
 
 export type ReportingSeverity = 'ignore' | 'log' | 'warn' | 'error' | 'throw';
 
@@ -27,10 +24,11 @@ export interface DocusaurusConfig {
   baseUrl: string;
   baseUrlIssueBanner: boolean;
   favicon?: string;
-  tagline?: string;
+  tagline: string;
   title: string;
   url: string;
-  // trailingSlash undefined = legacy retrocompatible behavior => /file => /file/index.html
+  // trailingSlash undefined = legacy retrocompatible behavior
+  // /file => /file/index.html
   trailingSlash: boolean | undefined;
   i18n: I18nConfig;
   onBrokenLinks: ReportingSeverity;
@@ -73,8 +71,8 @@ export interface DocusaurusConfig {
 }
 
 // Docusaurus config, as provided by the user (partial/unnormalized)
-// This type is used to provide type-safety / IDE auto-complete on the config file
-// See https://docusaurus.io/docs/typescript-support
+// This type is used to provide type-safety / IDE auto-complete on the config
+// file. See https://docusaurus.io/docs/typescript-support
 export type Config = Overwrite<
   Partial<DocusaurusConfig>,
   {
@@ -88,7 +86,8 @@ export type Config = Overwrite<
 /**
  * - `type: 'package'`, plugin is in a different package.
  * - `type: 'project'`, plugin is in the same docusaurus project.
- * - `type: 'local'`, none of plugin's ancestor directory contains any package.json.
+ * - `type: 'local'`, none of the plugin's ancestor directories contains a
+ * package.json.
  * - `type: 'synthetic'`, docusaurus generated internal plugin.
  */
 export type DocusaurusPluginVersionInformation =
@@ -259,8 +258,8 @@ export interface Plugin<Content = unknown> {
   }) => Promise<void>;
   routesLoaded?: (routes: RouteConfig[]) => void; // TODO remove soon, deprecated (alpha-60)
   postBuild?: (props: Props & {content: Content}) => Promise<void>;
-  postStart?: (props: Props) => void;
-  // TODO refactor the configureWebpack API surface: use an object instead of multiple params (requires breaking change)
+  // TODO refactor the configureWebpack API surface: use an object instead of
+  // multiple params (requires breaking change)
   configureWebpack?: (
     config: Configuration,
     isServer: boolean,
@@ -272,7 +271,7 @@ export interface Plugin<Content = unknown> {
   getTypeScriptThemePath?: () => string;
   getPathsToWatch?: () => string[];
   getClientModules?: () => string[];
-  extendCli?: (cli: Command) => void;
+  extendCli?: (cli: CommanderStatic) => void;
   injectHtmlTags?: ({content}: {content: Content}) => {
     headTags?: HtmlTags;
     preBodyTags?: HtmlTags;
@@ -317,13 +316,30 @@ export type LoadedPlugin<Content = unknown> = InitializedPlugin<Content> & {
   readonly content: Content;
 };
 
+export type SwizzleAction = 'eject' | 'wrap';
+export type SwizzleActionStatus = 'safe' | 'unsafe' | 'forbidden';
+
+export type SwizzleComponentConfig = {
+  actions: Record<SwizzleAction, SwizzleActionStatus>;
+  description?: string;
+};
+
+export type SwizzleConfig = {
+  components: Record<string, SwizzleComponentConfig>;
+  // Other settings could be added here,
+  // For example: the ability to declare the config as exhaustive
+  // so that we can emit errors
+};
+
 export type PluginModule = {
   <Options, Content>(context: LoadContext, options: Options):
     | Plugin<Content>
     | Promise<Plugin<Content>>;
   validateOptions?: <T>(data: OptionValidationContext<T>) => T;
   validateThemeConfig?: <T>(data: ThemeConfigValidationContext<T>) => T;
-  getSwizzleComponentList?: () => string[];
+
+  getSwizzleComponentList?: () => string[] | undefined; // TODO deprecate this one later
+  getSwizzleConfig?: () => SwizzleConfig | undefined;
 };
 
 export type ImportedPluginModule = PluginModule & {
@@ -331,7 +347,10 @@ export type ImportedPluginModule = PluginModule & {
 };
 
 export type ConfigureWebpackFn = Plugin<unknown>['configureWebpack'];
-export type ConfigureWebpackFnMergeStrategy = Record<string, MergeStrategy>;
+export type ConfigureWebpackFnMergeStrategy = Record<
+  string,
+  CustomizeRuleString
+>;
 export type ConfigurePostCssFn = Plugin<unknown>['configurePostCss'];
 
 export type PluginOptions = {id?: string} & Record<string, unknown>;
@@ -390,18 +409,6 @@ export interface ConfigureWebpackUtils {
     isServer: boolean;
     babelOptions?: Record<string, unknown>;
   }) => RuleSetRule;
-
-  // TODO deprecated: remove before end of 2021?
-  getCacheLoader: (
-    isServer: boolean,
-    cacheOptions?: Record<string, unknown>,
-  ) => RuleSetRule | null;
-
-  // TODO deprecated: remove before end of 2021?
-  getBabelLoader: (
-    isServer: boolean,
-    options?: Record<string, unknown>,
-  ) => RuleSetRule;
 }
 
 interface HtmlTagObject {
@@ -439,11 +446,18 @@ export interface ThemeConfigValidationContext<T> {
   themeConfig: Partial<T>;
 }
 
-export interface TOCItem {
+export type TOCItem = {
   readonly value: string;
   readonly id: string;
-  readonly children: TOCItem[];
   readonly level: number;
-}
+};
 
 export type RouteChunksTree = {[x: string | number]: string | RouteChunksTree};
+
+export type ClientModule = {
+  onRouteUpdate?: (args: {
+    previousLocation: Location | null;
+    location: Location;
+  }) => void;
+  onRouteUpdateDelayed?: (args: {location: Location}) => void;
+};