@docusaurus/types 0.0.0-4240 → 0.0.0-4244

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "0.0.0-4240",
+  "version": "0.0.0-4244",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -23,5 +23,5 @@
     "webpack": "^5.61.0",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "7402103577fe6c4f5f45cc3bc98a397c54e6a34e"
+  "gitHead": "92169a27a03dacb747edc8d13166daed2a3efd25"
 }

package/src/index.d.ts

@@ -153,6 +153,14 @@ export interface Preset {
   themes?: PluginConfig[];
 }
 
+export type PresetModule = {
+  <T>(context: LoadContext, presetOptions: T): Preset;
+};
+
+export type ImportedPresetModule = PresetModule & {
+  default?: PresetModule;
+};
+
 export type PresetConfig =
   | [string, Record<string, unknown>]
   | [string]
@@ -220,10 +228,10 @@ export interface Props extends LoadContext, InjectedHtmlTags {
 }
 
 export interface PluginContentLoadedActions {
-  addRoute(config: RouteConfig): void;
+  addRoute: (config: RouteConfig) => void;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  createData(name: string, data: any): Promise<string>;
-  setGlobalData<T = unknown>(data: T): void;
+  createData: (name: string, data: any) => Promise<string>;
+  setGlobalData: <T = unknown>(data: T) => void;
 }
 
 export type AllContent = Record<
@@ -239,32 +247,32 @@ export type PostCssOptions = Record<string, unknown> & {plugins: unknown[]};
 
 export interface Plugin<Content = unknown> {
   name: string;
-  loadContent?(): Promise<Content>;
-  contentLoaded?({
+  loadContent?: () => Promise<Content>;
+  contentLoaded?: ({
     content,
     actions,
   }: {
     content: Content; // the content loaded by this plugin instance
     allContent: AllContent; // content loaded by ALL the plugins
     actions: PluginContentLoadedActions;
-  }): Promise<void>;
-  routesLoaded?(routes: RouteConfig[]): void; // TODO remove soon, deprecated (alpha-60)
-  postBuild?(props: Props): void;
-  postStart?(props: Props): void;
+  }) => Promise<void>;
+  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?(
+  configureWebpack?: (
     config: Configuration,
     isServer: boolean,
     utils: ConfigureWebpackUtils,
     content: Content,
-  ): Configuration & {mergeStrategy?: ConfigureWebpackFnMergeStrategy};
-  configurePostCss?(options: PostCssOptions): PostCssOptions;
-  getThemePath?(): string;
-  getTypeScriptThemePath?(): string;
-  getPathsToWatch?(): string[];
-  getClientModules?(): string[];
-  extendCli?(cli: Command): void;
-  injectHtmlTags?({content}: {content: Content}): {
+  ) => Configuration & {mergeStrategy?: ConfigureWebpackFnMergeStrategy};
+  configurePostCss?: (options: PostCssOptions) => PostCssOptions;
+  getThemePath?: () => string;
+  getTypeScriptThemePath?: () => string;
+  getPathsToWatch?: () => string[];
+  getClientModules?: () => string[];
+  extendCli?: (cli: Command) => void;
+  injectHtmlTags?: ({content}: {content: Content}) => {
     headTags?: HtmlTags;
     preBodyTags?: HtmlTags;
     postBodyTags?: HtmlTags;
@@ -272,31 +280,31 @@ export interface Plugin<Content = unknown> {
   // TODO before/afterDevServer implementation
 
   // translations
-  getTranslationFiles?({
+  getTranslationFiles?: ({
     content,
   }: {
     content: Content;
-  }): Promise<TranslationFiles>;
-  getDefaultCodeTranslationMessages?(): Promise<
+  }) => Promise<TranslationFiles>;
+  getDefaultCodeTranslationMessages?: () => Promise<
     Record<
       string, // id
       string // message
     >
   >;
-  translateContent?({
+  translateContent?: ({
     content,
     translationFiles,
   }: {
     content: Content; // the content loaded by this plugin instance
     translationFiles: TranslationFiles;
-  }): Content;
-  translateThemeConfig?({
+  }) => Content;
+  translateThemeConfig?: ({
     themeConfig,
     translationFiles,
   }: {
     themeConfig: ThemeConfig;
     translationFiles: TranslationFiles;
-  }): ThemeConfig;
+  }) => ThemeConfig;
 }
 
 export type InitializedPlugin<Content = unknown> = Plugin<Content> & {
@@ -310,9 +318,9 @@ export type LoadedPlugin<Content = unknown> = InitializedPlugin<Content> & {
 
 export type PluginModule = {
   <T, X>(context: LoadContext, options: T): Plugin<X>;
-  validateOptions?<T>(data: OptionValidationContext<T>): T;
-  validateThemeConfig?<T>(data: ThemeConfigValidationContext<T>): T;
-  getSwizzleComponentList?(): string[];
+  validateOptions?: <T>(data: OptionValidationContext<T>) => T;
+  validateThemeConfig?: <T>(data: ThemeConfigValidationContext<T>) => T;
+  getSwizzleComponentList?: () => string[];
 };
 
 export type ImportedPluginModule = PluginModule & {