@docusaurus/types 2.0.0-beta.7babfe036 → 2.0.0-beta.8

package/package.json

@@ -1,8 +1,7 @@
 {
   "name": "@docusaurus/types",
-  "version": "2.0.0-beta.7babfe036",
+  "version": "2.0.0-beta.8",
   "description": "Common types for Docusaurus packages.",
-  "main": "./src/index.js",
   "types": "./src/index.d.ts",
   "publishConfig": {
     "access": "public"
@@ -18,10 +17,11 @@
   },
   "dependencies": {
     "commander": "^5.1.0",
-    "joi": "^17.4.0",
+    "joi": "^17.4.2",
     "querystring": "0.2.0",
+    "utility-types": "^3.10.0",
     "webpack": "^5.40.0",
     "webpack-merge": "^5.8.0"
   },
-  "gitHead": "3f4ee03e60c4343e3fe7fa29d0200efda0d66bd5"
+  "gitHead": "4f9b8d76d1eab9f20ddfad9865a1388ea2ce1c9c"
 }

package/src/index.d.ts

@@ -5,12 +5,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// ESLint doesn't understand types dependencies in d.ts
-// eslint-disable-next-line import/no-extraneous-dependencies
 import type {RuleSetRule, Configuration} from 'webpack';
 import type {Command} 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)
@@ -23,6 +22,7 @@ export type ThemeConfig = {
   [key: string]: unknown;
 };
 
+// Docusaurus config, after validation/normalization
 export interface DocusaurusConfig {
   baseUrl: string;
   baseUrlIssueBanner: boolean;
@@ -70,6 +70,19 @@ 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
+export type Config = Overwrite<
+  Partial<DocusaurusConfig>,
+  {
+    title: Required<DocusaurusConfig['title']>;
+    url: Required<DocusaurusConfig['url']>;
+    baseUrl: Required<DocusaurusConfig['baseUrl']>;
+    i18n?: DeepPartial<DocusaurusConfig['i18n']>;
+  }
+>;
+
 /**
  * - `type: 'package'`, plugin is in a different package.
  * - `type: 'project'`, plugin is in the same docusaurus project.
@@ -127,7 +140,10 @@ export interface DocusaurusContext {
   globalData: Record<string, unknown>;
   i18n: I18n;
   codeTranslations: Record<string, string>;
-  isClient: boolean;
+
+  // Don't put mutable values here, to avoid triggering re-renders
+  // We could reconsider that choice if context selectors are implemented
+  // isBrowser: boolean; // Not here on purpose!
 }
 
 export interface Preset {
@@ -195,10 +211,10 @@ export interface InjectedHtmlTags {
 export type HtmlTags = string | HtmlTagObject | (string | HtmlTagObject)[];
 
 export interface Props extends LoadContext, InjectedHtmlTags {
-  siteMetadata: DocusaurusSiteMetadata;
-  routes: RouteConfig[];
-  routesPaths: string[];
-  plugins: LoadedPlugin[];
+  readonly siteMetadata: DocusaurusSiteMetadata;
+  readonly routes: RouteConfig[];
+  readonly routesPaths: string[];
+  readonly plugins: LoadedPlugin[];
 }
 
 export interface PluginContentLoadedActions {
@@ -229,7 +245,7 @@ export interface Plugin<Content = unknown> {
     content: Content; // the content loaded by this plugin instance
     allContent: AllContent; // content loaded by ALL the plugins
     actions: PluginContentLoadedActions;
-  }): void;
+  }): Promise<void>;
   routesLoaded?(routes: RouteConfig[]): void; // TODO remove soon, deprecated (alpha-60)
   postBuild?(props: Props): void;
   postStart?(props: Props): void;
@@ -246,11 +262,7 @@ export interface Plugin<Content = unknown> {
   getPathsToWatch?(): string[];
   getClientModules?(): string[];
   extendCli?(cli: Command): void;
-  injectHtmlTags?({
-    content,
-  }: {
-    content: Content;
-  }): {
+  injectHtmlTags?({content}: {content: Content}): {
     headTags?: HtmlTags;
     preBodyTags?: HtmlTags;
     postBodyTags?: HtmlTags;
@@ -346,7 +358,7 @@ export interface RouteConfig {
   routes?: RouteConfig[];
   exact?: boolean;
   priority?: number;
-  [propName: string]: any;
+  [propName: string]: unknown;
 }
 
 // Aliases used for Webpack resolution (when using docusaurus swizzle)
@@ -420,4 +432,5 @@ export interface TOCItem {
   readonly value: string;
   readonly id: string;
   readonly children: TOCItem[];
+  readonly level: number;
 }

package/src/index.js

@@ -1,10 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/* eslint-disable */
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});