@docusaurus/types 0.0.0-4684 → 0.0.0-4688

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/types",
-  "version": "0.0.0-4684",
+  "version": "0.0.0-4688",
   "description": "Common types for Docusaurus packages.",
   "types": "./src/index.d.ts",
   "publishConfig": {
@@ -23,5 +23,5 @@
     "webpack": "^5.69.1",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "9230ee0c61b8d04d2fcf195e72e1f992d7b39a86"
+  "gitHead": "1b4b624e2d929f444465aec5a01ccb8518c60df6"
 }

package/src/index.d.ts

@@ -40,24 +40,24 @@ export interface DocusaurusConfig {
   deploymentBranch?: string;
   githubHost?: string;
   githubPort?: string;
-  plugins?: PluginConfig[];
-  themes?: PluginConfig[];
-  presets?: PresetConfig[];
+  plugins: PluginConfig[];
+  themes: PluginConfig[];
+  presets: PresetConfig[];
   themeConfig: ThemeConfig;
   customFields?: {
     [key: string]: unknown;
   };
-  scripts?: (
+  scripts: (
     | string
     | {
         src: string;
         [key: string]: unknown;
       }
   )[];
-  clientModules?: string[];
+  clientModules: string[];
   ssrTemplate?: string;
   staticDirectories: string[];
-  stylesheets?: (
+  stylesheets: (
     | string
     | {
         href: string;
@@ -226,18 +226,15 @@ export interface Props extends LoadContext, InjectedHtmlTags {
 
 export interface PluginContentLoadedActions {
   addRoute: (config: RouteConfig) => void;
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  createData: (name: string, data: any) => Promise<string>;
+  createData: (name: string, data: string) => Promise<string>;
   setGlobalData: <T = unknown>(data: T) => void;
 }
 
-export type AllContent = Record<
-  string, // plugin name
-  Record<
-    string, // plugin id
-    unknown // plugin data
-  >
->;
+export type AllContent = {
+  [pluginName: string]: {
+    [pluginID: string]: unknown;
+  };
+};
 
 // TODO improve type (not exposed by postcss-loader)
 export type PostCssOptions = Record<string, unknown> & {plugins: unknown[]};
@@ -245,12 +242,11 @@ export type PostCssOptions = Record<string, unknown> & {plugins: unknown[]};
 export interface Plugin<Content = unknown> {
   name: string;
   loadContent?: () => Promise<Content>;
-  contentLoaded?: ({
-    content,
-    actions,
-  }: {
-    content: Content; // the content loaded by this plugin instance
-    allContent: AllContent; // content loaded by ALL the plugins
+  contentLoaded?: (args: {
+    /** the content loaded by this plugin instance */
+    content: Content; //
+    /** content loaded by ALL the plugins */
+    allContent: AllContent;
     actions: PluginContentLoadedActions;
   }) => Promise<void>;
   routesLoaded?: (routes: RouteConfig[]) => void; // TODO remove soon, deprecated (alpha-60)
@@ -269,7 +265,7 @@ export interface Plugin<Content = unknown> {
   getPathsToWatch?: () => string[];
   getClientModules?: () => string[];
   extendCli?: (cli: CommanderStatic) => void;
-  injectHtmlTags?: ({content}: {content: Content}) => {
+  injectHtmlTags?: (args: {content: Content}) => {
     headTags?: HtmlTags;
     preBodyTags?: HtmlTags;
     postBodyTags?: HtmlTags;
@@ -277,28 +273,13 @@ export interface Plugin<Content = unknown> {
   // TODO before/afterDevServer implementation
 
   // translations
-  getTranslationFiles?: ({
-    content,
-  }: {
-    content: Content;
-  }) => Promise<TranslationFiles>;
-  getDefaultCodeTranslationMessages?: () => Promise<
-    Record<
-      string, // id
-      string // message
-    >
-  >;
-  translateContent?: ({
-    content,
-    translationFiles,
-  }: {
+  getTranslationFiles?: (args: {content: Content}) => Promise<TranslationFiles>;
+  getDefaultCodeTranslationMessages?: () => Promise<{[id: string]: string}>;
+  translateContent?: (args: {
     content: Content; // the content loaded by this plugin instance
     translationFiles: TranslationFiles;
   }) => Content;
-  translateThemeConfig?: ({
-    themeConfig,
-    translationFiles,
-  }: {
+  translateThemeConfig?: (args: {
     themeConfig: ThemeConfig;
     translationFiles: TranslationFiles;
   }) => ThemeConfig;