@docusaurus/theme-classic 2.0.0-beta.1 → 2.0.0-beta.10

package/lib-next/validateThemeConfig.js

@@ -4,9 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
-const {Joi, URISchema} = require('@docusaurus/utils-validation');
-
+import {Joi, URISchema} from '@docusaurus/utils-validation';
 const DEFAULT_DOCS_CONFIG = {
   versionPersistence: 'localStorage',
 };
@@ -15,7 +13,6 @@ const DocsSchema = Joi.object({
     .equal('localStorage', 'none')
     .default(DEFAULT_DOCS_CONFIG.versionPersistence),
 }).default(DEFAULT_DOCS_CONFIG);
-
 const DEFAULT_COLOR_MODE_CONFIG = {
   defaultMode: 'light',
   disableSwitch: false,
@@ -27,11 +24,10 @@ const DEFAULT_COLOR_MODE_CONFIG = {
     lightIconStyle: {},
   },
 };
-
 const DEFAULT_CONFIG = {
   colorMode: DEFAULT_COLOR_MODE_CONFIG,
   docs: DEFAULT_DOCS_CONFIG,
-  metadatas: [],
+  metadata: [],
   prism: {
     additionalLanguages: [],
   },
@@ -40,84 +36,49 @@ const DEFAULT_CONFIG = {
     items: [],
   },
   hideableSidebar: false,
+  tableOfContents: {
+    minHeadingLevel: 2,
+    maxHeadingLevel: 3,
+  },
 };
-exports.DEFAULT_CONFIG = DEFAULT_CONFIG;
-
 const NavbarItemPosition = Joi.string().equal('left', 'right').default('left');
-
-const BaseNavbarItemSchema = Joi.object({
-  to: Joi.string(),
-  href: URISchema,
+const NavbarItemBaseSchema = Joi.object({
   label: Joi.string(),
   className: Joi.string(),
-  prependBaseUrlToHref: Joi.bool(),
-})
-  // We allow any unknown attributes on the links
+}) // We allow any unknown attributes on the links
   // (users may need additional attributes like target, aria-role, data-customAttribute...)
   .unknown();
-
-// TODO we should probably create a custom navbar item type "dropdown"
-// having this recursive structure is bad because we only support 2 levels
-// + parent/child don't have exactly the same props
-const DefaultNavbarItemSchema = BaseNavbarItemSchema.append({
-  items: Joi.array().optional().items(BaseNavbarItemSchema),
-  position: NavbarItemPosition,
+const DefaultNavbarItemSchema = NavbarItemBaseSchema.append({
+  to: Joi.string(),
+  href: URISchema,
   activeBasePath: Joi.string(),
   activeBaseRegex: Joi.string(),
-});
-// TODO the dropdown parent item can have no href/to
-// should check should not apply to dropdown parent item
-// .xor('href', 'to');
-
-const DocsVersionNavbarItemSchema = Joi.object({
+  prependBaseUrlToHref: Joi.bool(),
+  // This is only triggered in case of a nested dropdown
+  items: Joi.forbidden().messages({
+    'any.unknown': 'Nested dropdowns are not allowed',
+  }),
+})
+  .xor('href', 'to')
+  .messages({
+    'object.xor': 'One and only one between "to" and "href" should be provided',
+  });
+const DocsVersionNavbarItemSchema = NavbarItemBaseSchema.append({
   type: Joi.string().equal('docsVersion').required(),
-  position: NavbarItemPosition,
-  label: Joi.string(),
   to: Joi.string(),
   docsPluginId: Joi.string(),
-  className: Joi.string(),
 });
-
-const DocsVersionDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('docsVersionDropdown').required(),
-  position: NavbarItemPosition,
-  docsPluginId: Joi.string(),
-  dropdownActiveClassDisabled: Joi.boolean(),
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const DocItemSchema = Joi.object({
+const DocItemSchema = NavbarItemBaseSchema.append({
   type: Joi.string().equal('doc').required(),
-  position: NavbarItemPosition,
   docId: Joi.string().required(),
-  label: Joi.string(),
   docsPluginId: Joi.string(),
-  activeSidebarClassName: Joi.string().default('navbar__link--active'),
-  className: Joi.string(),
-});
-
-const LocaleDropdownNavbarItemSchema = Joi.object({
-  type: Joi.string().equal('localeDropdown').required(),
-  position: NavbarItemPosition,
-  dropdownItemsBefore: Joi.array().items(BaseNavbarItemSchema).default([]),
-  dropdownItemsAfter: Joi.array().items(BaseNavbarItemSchema).default([]),
-  className: Joi.string(),
-});
-
-const SearchItemSchema = Joi.object({
-  type: Joi.string().equal('search').required(),
-  position: NavbarItemPosition,
 });
 
-// Can this be made easier? :/
-const isOfType = (type) => {
-  let typeSchema = Joi.string().required();
+const itemWithType = (type) => {
   // because equal(undefined) is not supported :/
-  if (type) {
-    typeSchema = typeSchema.equal(type);
-  }
+  const typeSchema = type
+    ? Joi.string().required().equal(type)
+    : Joi.string().forbidden();
   return Joi.object({
     type: typeSchema,
   })
@@ -125,59 +86,100 @@ const isOfType = (type) => {
     .required();
 };
 
-const NavbarItemSchema = Joi.object().when({
+const DropdownSubitemSchema = Joi.object({
+  position: Joi.forbidden(),
+}).when('.', {
   switch: [
     {
-      is: isOfType('docsVersion'),
+      is: itemWithType('docsVersion'),
       then: DocsVersionNavbarItemSchema,
     },
     {
-      is: isOfType('docsVersionDropdown'),
+      is: itemWithType('doc'),
+      then: DocItemSchema,
+    },
+    {
+      is: itemWithType(undefined),
+      then: DefaultNavbarItemSchema,
+    },
+    {
+      is: Joi.alternatives().try(
+        itemWithType('dropdown'),
+        itemWithType('docsVersionDropdown'),
+        itemWithType('localeDropdown'),
+        itemWithType('search'),
+      ),
+      then: Joi.forbidden().messages({
+        'any.unknown': 'Nested dropdowns are not allowed',
+      }),
+    },
+  ],
+  otherwise: Joi.forbidden().messages({
+    'any.unknown': 'Bad navbar item type {.type}',
+  }),
+});
+const DropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  items: Joi.array().items(DropdownSubitemSchema).required(),
+});
+const DocsVersionDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  type: Joi.string().equal('docsVersionDropdown').required(),
+  docsPluginId: Joi.string(),
+  dropdownActiveClassDisabled: Joi.boolean(),
+  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
+  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
+});
+const LocaleDropdownNavbarItemSchema = NavbarItemBaseSchema.append({
+  type: Joi.string().equal('localeDropdown').required(),
+  dropdownItemsBefore: Joi.array().items(DropdownSubitemSchema).default([]),
+  dropdownItemsAfter: Joi.array().items(DropdownSubitemSchema).default([]),
+});
+const SearchItemSchema = Joi.object({
+  type: Joi.string().equal('search').required(),
+});
+const NavbarItemSchema = Joi.object({
+  position: NavbarItemPosition,
+}).when('.', {
+  switch: [
+    {
+      is: itemWithType('docsVersion'),
+      then: DocsVersionNavbarItemSchema,
+    },
+    {
+      is: itemWithType('dropdown'),
+      then: DropdownNavbarItemSchema,
+    },
+    {
+      is: itemWithType('docsVersionDropdown'),
       then: DocsVersionDropdownNavbarItemSchema,
     },
     {
-      is: isOfType('doc'),
+      is: itemWithType('doc'),
       then: DocItemSchema,
     },
     {
-      is: isOfType('localeDropdown'),
+      is: itemWithType('localeDropdown'),
       then: LocaleDropdownNavbarItemSchema,
     },
     {
-      is: isOfType('search'),
+      is: itemWithType('search'),
       then: SearchItemSchema,
     },
     {
-      is: isOfType(undefined),
-      then: Joi.forbidden().messages({
-        'any.unknown': 'Bad navbar item type {.type}',
+      is: itemWithType(undefined),
+      then: Joi.object().when('.', {
+        // Dropdown item can be specified without type field
+        is: Joi.object({
+          items: Joi.array().required(),
+        }).unknown(),
+        then: DropdownNavbarItemSchema,
+        otherwise: DefaultNavbarItemSchema,
       }),
     },
   ],
-  otherwise: DefaultNavbarItemSchema,
-});
-
-/*
-const NavbarItemSchema = Joi.object({
-  type: Joi.string().only(['docsVersion'])
-})
-  .when(Joi.object({ type: 'docsVersion' }).unknown(), {
-    then: Joi.object({ pepperoni: Joi.boolean() })
-  })
-  .when(Joi.object().unknown(), {
-    then: Joi.object({ croutons: Joi.boolean() })
-  })
-
- */
-
-/*
-const NavbarItemSchema = Joi.object().when('type', {
-  is: Joi.valid('docsVersion'),
-  then: DocsVersionNavbarItemSchema,
-  otherwise: DefaultNavbarItemSchema,
+  otherwise: Joi.forbidden().messages({
+    'any.unknown': 'Bad navbar item type {.type}',
+  }),
 });
- */
-
 const ColorModeSchema = Joi.object({
   defaultMode: Joi.string()
     .equal('dark', 'light')
@@ -200,9 +202,8 @@ const ColorModeSchema = Joi.object({
       DEFAULT_COLOR_MODE_CONFIG.switchConfig.lightIconStyle,
     ),
   }).default(DEFAULT_COLOR_MODE_CONFIG.switchConfig),
-}).default(DEFAULT_COLOR_MODE_CONFIG);
+}).default(DEFAULT_COLOR_MODE_CONFIG); // schema can probably be improved
 
-// schema can probably be improved
 const HtmlMetadataSchema = Joi.object({
   id: Joi.string(),
   name: Joi.string(),
@@ -210,7 +211,6 @@ const HtmlMetadataSchema = Joi.object({
   content: Joi.string(),
   itemprop: Joi.string(),
 }).unknown();
-
 const FooterLinkItemSchema = Joi.object({
   to: Joi.string(),
   href: URISchema,
@@ -220,23 +220,20 @@ const FooterLinkItemSchema = Joi.object({
   .xor('to', 'href', 'html')
   .with('to', 'label')
   .with('href', 'label')
-  .nand('html', 'label')
-  // We allow any unknown attributes on the links
+  .nand('html', 'label') // We allow any unknown attributes on the links
   // (users may need additional attributes like target, aria-role, data-customAttribute...)
   .unknown();
-
 const CustomCssSchema = Joi.alternatives()
   .try(Joi.array().items(Joi.string().required()), Joi.string().required())
   .optional();
-
 const ThemeConfigSchema = Joi.object({
   // TODO temporary (@alpha-58)
-  disableDarkMode: Joi.any().forbidden(false).messages({
+  disableDarkMode: Joi.any().forbidden().messages({
     'any.unknown':
       'disableDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.disableSwitch = true',
   }),
   // TODO temporary (@alpha-58)
-  defaultDarkMode: Joi.any().forbidden(false).messages({
+  defaultDarkMode: Joi.any().forbidden().messages({
     'any.unknown':
       'defaultDarkMode theme config is deprecated. Please use the new colorMode attribute. You likely want: config.themeConfig.colorMode.defaultMode = "dark"',
   }),
@@ -244,12 +241,16 @@ const ThemeConfigSchema = Joi.object({
   colorMode: ColorModeSchema,
   image: Joi.string(),
   docs: DocsSchema,
-  metadatas: Joi.array()
+  metadata: Joi.array()
     .items(HtmlMetadataSchema)
-    .default(DEFAULT_CONFIG.metadatas),
+    .default(DEFAULT_CONFIG.metadata),
+  metadatas: Joi.any().forbidden().messages({
+    'any.unknown':
+      'themeConfig.metadatas has been renamed as themeConfig.metadata. See https://github.com/facebook/docusaurus/pull/5871',
+  }),
   announcementBar: Joi.object({
     id: Joi.string().default('announcement-bar'),
-    content: Joi.string(),
+    content: Joi.string().required(),
     backgroundColor: Joi.string(),
     textColor: Joi.string(),
     isCloseable: Joi.bool().default(true),
@@ -270,6 +271,8 @@ const ThemeConfigSchema = Joi.object({
       alt: Joi.string().allow(''),
       src: Joi.string().required(),
       srcDark: Joi.string(),
+      width: Joi.alternatives().try(Joi.string(), Joi.number()),
+      height: Joi.alternatives().try(Joi.string(), Joi.number()),
       href: Joi.string(),
       target: Joi.string(),
     }),
@@ -280,6 +283,9 @@ const ThemeConfigSchema = Joi.object({
       alt: Joi.string().allow(''),
       src: Joi.string(),
       srcDark: Joi.string(),
+      // TODO infer this from reading the image
+      width: Joi.alternatives().try(Joi.string(), Joi.number()),
+      height: Joi.alternatives().try(Joi.string(), Joi.number()),
       href: Joi.string(),
     }),
     copyright: Joi.string(),
@@ -309,9 +315,30 @@ const ThemeConfigSchema = Joi.object({
     .default(DEFAULT_CONFIG.prism)
     .unknown(),
   hideableSidebar: Joi.bool().default(DEFAULT_CONFIG.hideableSidebar),
+  sidebarCollapsible: Joi.forbidden().messages({
+    'any.unknown':
+      'The themeConfig.sidebarCollapsible has been moved to docs plugin options. See: https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-docs',
+  }),
+  tableOfContents: Joi.object({
+    minHeadingLevel: Joi.number()
+      .default(DEFAULT_CONFIG.tableOfContents.minHeadingLevel)
+      .when('maxHeadingLevel', {
+        is: Joi.exist(),
+        then: Joi.number()
+          .integer()
+          .min(2)
+          .max(6)
+          .max(Joi.ref('maxHeadingLevel')),
+        otherwise: Joi.number().integer().min(2).max(6),
+      }),
+    maxHeadingLevel: Joi.number()
+      .integer()
+      .min(2)
+      .max(6)
+      .default(DEFAULT_CONFIG.tableOfContents.maxHeadingLevel),
+  }).default(DEFAULT_CONFIG.tableOfContents),
 });
-exports.ThemeConfigSchema = ThemeConfigSchema;
-
-exports.validateThemeConfig = ({validate, themeConfig}) => {
+export {DEFAULT_CONFIG, ThemeConfigSchema};
+export function validateThemeConfig({validate, themeConfig}) {
   return validate(ThemeConfigSchema, themeConfig);
-};
+}

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "2.0.0-beta.1",
+  "version": "2.0.0-beta.10",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
-  "types": "src/types.d.ts",
+  "types": "src/theme-classic.d.ts",
   "publishConfig": {
     "access": "public"
   },
@@ -14,50 +14,53 @@
   },
   "license": "MIT",
   "scripts": {
-    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn prettier:lib-next",
-    "watch": "concurrently -n \"lib,lib-next\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\"",
+    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn format:lib-next",
+    "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\"",
     "babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
     "babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
-    "prettier": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{js,ts,jsx,tsc}\"",
-    "prettier:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"",
+    "format": "prettier --config ../../.prettierrc --ignore-path ../../.prettierignore --write \"**/*.{js,ts,jsx,tsc}\"",
+    "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\"",
     "update-code-translations": "node -e 'require(\"./update-code-translations.js\").run()'"
   },
   "dependencies": {
-    "@docusaurus/core": "2.0.0-beta.1",
-    "@docusaurus/plugin-content-blog": "2.0.0-beta.1",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.1",
-    "@docusaurus/plugin-content-pages": "2.0.0-beta.1",
-    "@docusaurus/theme-common": "2.0.0-beta.1",
-    "@docusaurus/types": "2.0.0-beta.1",
-    "@docusaurus/utils": "2.0.0-beta.1",
-    "@docusaurus/utils-common": "2.0.0-beta.1",
-    "@docusaurus/utils-validation": "2.0.0-beta.1",
+    "@docusaurus/plugin-content-blog": "2.0.0-beta.10",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.10",
+    "@docusaurus/plugin-content-pages": "2.0.0-beta.10",
+    "@docusaurus/theme-common": "2.0.0-beta.10",
+    "@docusaurus/theme-translations": "2.0.0-beta.10",
+    "@docusaurus/utils": "2.0.0-beta.10",
+    "@docusaurus/utils-validation": "2.0.0-beta.10",
     "@mdx-js/mdx": "^1.6.21",
     "@mdx-js/react": "^1.6.21",
-    "chalk": "^4.1.1",
+    "chalk": "^4.1.2",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
-    "fs-extra": "^10.0.0",
     "globby": "^11.0.2",
-    "infima": "0.2.0-alpha.26",
+    "infima": "0.2.0-alpha.36",
     "lodash": "^4.17.20",
-    "parse-numeric-range": "^1.2.0",
-    "postcss": "^8.2.15",
+    "postcss": "^8.3.7",
     "prism-react-renderer": "^1.2.1",
     "prismjs": "^1.23.0",
-    "prop-types": "^15.7.2",
     "react-router-dom": "^5.2.0",
-    "rtlcss": "^3.1.2"
+    "rtlcss": "^3.3.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.1"
+    "@docusaurus/module-type-aliases": "2.0.0-beta.10",
+    "@docusaurus/types": "2.0.0-beta.10",
+    "@types/mdx-js__react": "^1.5.4",
+    "@types/parse-numeric-range": "^0.0.1",
+    "@types/rtlcss": "^3.1.1",
+    "fs-extra": "^10.0.0",
+    "react-test-renderer": "^17.0.2",
+    "utility-types": "^3.10.0"
   },
   "peerDependencies": {
+    "@docusaurus/core": "2.0.0-beta.9",
     "react": "^16.8.4 || ^17.0.0",
     "react-dom": "^16.8.4 || ^17.0.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=14"
   },
-  "gitHead": "72ed3476bf4ffe1fc2d1025dd2def536a2de8f12"
+  "gitHead": "6f4869af5721435d6995e63e2f24ac41646e34ea"
 }