@docusaurus/plugin-content-docs 0.0.0-4071 → 0.0.0-4075

package/lib/sidebars/validation.js

@@ -0,0 +1,102 @@
+"use strict";
+/**
+ * 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateSidebars = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+const types_1 = require("./types");
+const sidebarItemBaseSchema = utils_validation_1.Joi.object({
+    className: utils_validation_1.Joi.string(),
+    customProps: utils_validation_1.Joi.object().unknown(),
+});
+const sidebarItemAutogeneratedSchema = sidebarItemBaseSchema.append({
+    type: 'autogenerated',
+    dirName: utils_validation_1.Joi.string()
+        .required()
+        .pattern(/^[^/](.*[^/])?$/)
+        .message('"dirName" must be a dir path relative to the docs folder root, and should not start or end with slash'),
+});
+const sidebarItemDocSchema = sidebarItemBaseSchema.append({
+    type: utils_validation_1.Joi.string().valid('doc', 'ref').required(),
+    id: utils_validation_1.Joi.string().required(),
+    label: utils_validation_1.Joi.string(),
+});
+const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
+    type: 'link',
+    href: utils_validation_1.URISchema.required(),
+    label: utils_validation_1.Joi.string()
+        .required()
+        .messages({ 'any.unknown': '"label" must be a string' }),
+});
+const sidebarItemCategorySchema = sidebarItemBaseSchema.append({
+    type: 'category',
+    label: utils_validation_1.Joi.string()
+        .required()
+        .messages({ 'any.unknown': '"label" must be a string' }),
+    // TODO: Joi doesn't allow mutual recursion. See https://github.com/sideway/joi/issues/2611
+    items: utils_validation_1.Joi.array()
+        .required()
+        .messages({ 'any.unknown': '"items" must be an array' }),
+    collapsed: utils_validation_1.Joi.boolean().messages({
+        'any.unknown': '"collapsed" must be a boolean',
+    }),
+    collapsible: utils_validation_1.Joi.boolean().messages({
+        'any.unknown': '"collapsible" must be a boolean',
+    }),
+});
+const sidebarItemSchema = utils_validation_1.Joi.object()
+    .when('.type', {
+    switch: [
+        { is: 'link', then: sidebarItemLinkSchema },
+        {
+            is: utils_validation_1.Joi.string().valid('doc', 'ref').required(),
+            then: sidebarItemDocSchema,
+        },
+        { is: 'autogenerated', then: sidebarItemAutogeneratedSchema },
+        { is: 'category', then: sidebarItemCategorySchema },
+        {
+            is: 'subcategory',
+            then: utils_validation_1.Joi.forbidden().messages({
+                'any.unknown': 'Docusaurus v2: "subcategory" has been renamed as "category".',
+            }),
+        },
+        {
+            is: utils_validation_1.Joi.string().required(),
+            then: utils_validation_1.Joi.forbidden().messages({
+                'any.unknown': 'Unknown sidebar item type "{.type}".',
+            }),
+        },
+    ],
+})
+    .id('sidebarItemSchema');
+function validateSidebarItem(item) {
+    if (typeof item === 'string') {
+        return;
+    }
+    // TODO: remove once with proper Joi support
+    // Because we can't use Joi to validate nested items (see above), we do it manually
+    if ((0, types_1.isCategoriesShorthand)(item)) {
+        Object.values(item).forEach((category) => category.forEach(validateSidebarItem));
+    }
+    else {
+        utils_validation_1.Joi.assert(item, sidebarItemSchema);
+        if (item.type === 'category') {
+            item.items.forEach(validateSidebarItem);
+        }
+    }
+}
+function validateSidebars(sidebars) {
+    Object.values(sidebars).forEach((sidebar) => {
+        if (Array.isArray(sidebar)) {
+            sidebar.forEach(validateSidebarItem);
+        }
+        else {
+            validateSidebarItem(sidebar);
+        }
+    });
+}
+exports.validateSidebars = validateSidebars;

package/lib/translations.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadedContent } from './types';
+import type { LoadedContent } from './types';
 import { TranslationFile, TranslationFiles } from '@docusaurus/types';
 export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFiles;
 export declare function translateLoadedContent(loadedContent: LoadedContent, translationFiles: TranslationFile[]): LoadedContent;

package/lib/translations.js

@@ -8,8 +8,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
 const lodash_1 = require("lodash");
-const sidebars_1 = require("./sidebars");
-const utils_1 = require("@docusaurus/utils");
+const utils_1 = require("./sidebars/utils");
+const utils_2 = require("@docusaurus/utils");
 const constants_1 = require("./constants");
 function getVersionFileName(versionName) {
     if (versionName === constants_1.CURRENT_VERSION_NAME) {
@@ -74,7 +74,7 @@ function translateDocs(
 }
  */
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
-    const categories = (0, sidebars_1.collectSidebarCategories)(sidebar);
+    const categories = (0, utils_1.collectSidebarCategories)(sidebar);
     const categoryContent = (0, lodash_1.chain)(categories)
         .keyBy((category) => `sidebar.${sidebarName}.category.${category.label}`)
         .mapValues((category) => ({
@@ -82,7 +82,7 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
         description: `The label for category ${category.label} in sidebar ${sidebarName}`,
     }))
         .value();
-    const links = (0, sidebars_1.collectSidebarLinks)(sidebar);
+    const links = (0, utils_1.collectSidebarLinks)(sidebar);
     const linksContent = (0, lodash_1.chain)(links)
         .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
         .mapValues((link) => ({
@@ -90,10 +90,10 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
         description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
     }))
         .value();
-    return (0, utils_1.mergeTranslations)([categoryContent, linksContent]);
+    return (0, utils_2.mergeTranslations)([categoryContent, linksContent]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
-    return (0, sidebars_1.transformSidebarItems)(sidebar, (item) => {
+    return (0, utils_1.transformSidebarItems)(sidebar, (item) => {
         var _a, _b, _c, _d;
         if (item.type === 'category') {
             return {
@@ -111,7 +111,7 @@ function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
     });
 }
 function getSidebarsTranslations(version) {
-    return (0, utils_1.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
+    return (0, utils_2.mergeTranslations)(Object.entries(version.sidebars).map(([sidebarName, sidebar]) => {
         const normalizedSidebarName = getNormalizedSidebarName({
             sidebarName,
             versionName: version.versionName,
@@ -143,7 +143,7 @@ function getVersionTranslationFiles(version) {
     return [
         {
             path: getVersionFileName(version.versionName),
-            content: (0, utils_1.mergeTranslations)([
+            content: (0, utils_2.mergeTranslations)([
                 versionTranslations,
                 sidebarsTranslations,
                 // docsTranslations,
@@ -162,7 +162,7 @@ function translateVersion(version, translationFiles) {
     };
 }
 function getVersionsTranslationFiles(versions) {
-    return (0, lodash_1.flatten)(versions.map(getVersionTranslationFiles));
+    return versions.flatMap(getVersionTranslationFiles);
 }
 function translateVersions(versions, translationFiles) {
     return versions.map((version) => translateVersion(version, translationFiles));

package/lib/types.d.ts

@@ -7,6 +7,7 @@
 import type { RemarkAndRehypePluginOptions } from '@docusaurus/mdx-loader';
 import type { Tag, FrontMatterTag } from '@docusaurus/utils';
 import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
+import type { SidebarItemsGeneratorOption, Sidebars } from './sidebars/types';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -81,64 +82,6 @@ export declare type PluginOptions = MetadataOptions & PathOptions & VersionsOpti
     sidebarItemsGenerator: SidebarItemsGeneratorOption;
     tagsBasePath: string;
 };
-export declare type SidebarItemBase = {
-    className?: string;
-    customProps?: Record<string, unknown>;
-};
-export declare type SidebarItemDoc = SidebarItemBase & {
-    type: 'doc' | 'ref';
-    label?: string;
-    id: string;
-};
-export declare type SidebarItemLink = SidebarItemBase & {
-    type: 'link';
-    href: string;
-    label: string;
-};
-export declare type SidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: SidebarItem[];
-    collapsed: boolean;
-    collapsible: boolean;
-};
-export declare type UnprocessedSidebarItemAutogenerated = {
-    type: 'autogenerated';
-    dirName: string;
-};
-export declare type UnprocessedSidebarItemCategory = SidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: UnprocessedSidebarItem[];
-    collapsed: boolean;
-    collapsible: boolean;
-};
-export declare type UnprocessedSidebarItem = SidebarItemDoc | SidebarItemLink | UnprocessedSidebarItemCategory | UnprocessedSidebarItemAutogenerated;
-export declare type UnprocessedSidebar = UnprocessedSidebarItem[];
-export declare type UnprocessedSidebars = Record<string, UnprocessedSidebar>;
-export declare type SidebarItem = SidebarItemDoc | SidebarItemLink | SidebarItemCategory;
-export declare type Sidebar = SidebarItem[];
-export declare type SidebarItemType = SidebarItem['type'];
-export declare type Sidebars = Record<string, Sidebar>;
-export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
-export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
-export declare type SidebarItemsGeneratorArgs = {
-    item: UnprocessedSidebarItemAutogenerated;
-    version: SidebarItemsGeneratorVersion;
-    docs: SidebarItemsGeneratorDoc[];
-    numberPrefixParser: NumberPrefixParser;
-    options: SidebarOptions;
-};
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<SidebarItem[]>;
-export declare type SidebarItemsGeneratorOptionArgs = {
-    defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<SidebarItem[]>;
-export declare type OrderMetadata = {
-    previous?: string;
-    next?: string;
-    sidebar?: string;
-};
 export declare type LastUpdateData = {
     lastUpdatedAt?: number;
     formattedLastUpdatedAt?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4071",
+  "version": "0.0.0-4075",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-docs.d.ts",
@@ -18,18 +18,19 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4071",
+    "@docusaurus/module-type-aliases": "0.0.0-4075",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
-    "picomatch": "^2.1.1"
+    "picomatch": "^2.1.1",
+    "utility-types": "^3.10.0"
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4071",
-    "@docusaurus/mdx-loader": "0.0.0-4071",
-    "@docusaurus/types": "0.0.0-4071",
-    "@docusaurus/utils": "0.0.0-4071",
-    "@docusaurus/utils-validation": "0.0.0-4071",
+    "@docusaurus/core": "0.0.0-4075",
+    "@docusaurus/mdx-loader": "0.0.0-4075",
+    "@docusaurus/types": "0.0.0-4075",
+    "@docusaurus/utils": "0.0.0-4075",
+    "@docusaurus/utils-validation": "0.0.0-4075",
     "chalk": "^4.1.2",
     "combine-promises": "^1.1.0",
     "escape-string-regexp": "^4.0.0",
@@ -53,5 +54,5 @@
   "engines": {
     "node": ">=12.13.0"
   },
-  "gitHead": "4f7ce92c2e0b8034302be0a080122e8f24b65f6a"
+  "gitHead": "8a2dfe320e0bfe6a6833d610c824846f649986e3"
 }

package/src/__tests__/index.test.ts

@@ -22,17 +22,16 @@ import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 import * as cliDocs from '../cli';
 import {OptionsSchema} from '../options';
 import {normalizePluginOptions} from '@docusaurus/utils-validation';
-import {
-  DocMetadata,
-  LoadedVersion,
+import type {DocMetadata, LoadedVersion} from '../types';
+import type {
   SidebarItem,
   SidebarItemsGeneratorOption,
   SidebarItemsGeneratorOptionArgs,
-} from '../types';
+} from '../sidebars/types';
 import {toSidebarsProp} from '../props';
 
 import {validate} from 'webpack';
-import {DefaultSidebarItemsGenerator} from '../sidebarItemsGenerator';
+import {DefaultSidebarItemsGenerator} from '../sidebars/generator';
 import {DisabledSidebars} from '../sidebars';
 
 function findDocById(version: LoadedVersion, unversionedId: string) {

package/src/__tests__/options.test.ts

@@ -7,7 +7,7 @@
 
 import {OptionsSchema, DEFAULT_OPTIONS, validateOptions} from '../options';
 import {normalizePluginOptions} from '@docusaurus/utils-validation';
-import {DefaultSidebarItemsGenerator} from '../sidebarItemsGenerator';
+import {DefaultSidebarItemsGenerator} from '../sidebars/generator';
 import {
   DefaultNumberPrefixParser,
   DisabledNumberPrefixParser,

package/src/cli.ts

@@ -12,13 +12,10 @@ import {
 } from './versions';
 import fs from 'fs-extra';
 import path from 'path';
-import {
-  PathOptions,
-  UnprocessedSidebarItem,
-  UnprocessedSidebars,
-  SidebarOptions,
-} from './types';
-import {loadSidebars, resolveSidebarPathOption} from './sidebars';
+import type {PathOptions, SidebarOptions} from './types';
+import {transformSidebarItems} from './sidebars/utils';
+import type {SidebarItem, NormalizedSidebars, Sidebar} from './sidebars/types';
+import {loadUnprocessedSidebars, resolveSidebarPathOption} from './sidebars';
 import {DEFAULT_PLUGIN_ID} from '@docusaurus/core/lib/constants';
 
 function createVersionedSidebarFile({
@@ -35,7 +32,7 @@ function createVersionedSidebarFile({
   options: SidebarOptions;
 }) {
   // Load current sidebar and create a new versioned sidebars file (if needed).
-  const loadedSidebars = loadSidebars(sidebarPath, options);
+  const loadedSidebars = loadUnprocessedSidebars(sidebarPath, options);
 
   // Do not create a useless versioned sidebars file if sidebars file is empty or sidebars are disabled/false)
   const shouldCreateVersionedSidebarFile =
@@ -45,30 +42,27 @@ function createVersionedSidebarFile({
     // TODO @slorber: this "version prefix" in versioned sidebars looks like a bad idea to me
     // TODO try to get rid of it
     // Transform id in original sidebar to versioned id.
-    const normalizeItem = (
-      item: UnprocessedSidebarItem,
-    ): UnprocessedSidebarItem => {
-      switch (item.type) {
-        case 'category':
-          return {...item, items: item.items.map(normalizeItem)};
-        case 'ref':
-        case 'doc':
-          return {
-            type: item.type,
-            id: `version-${version}/${item.id}`,
-          };
-        default:
-          return item;
+    const prependVersion = (item: SidebarItem): SidebarItem => {
+      if (item.type === 'ref' || item.type === 'doc') {
+        return {
+          type: item.type,
+          id: `version-${version}/${item.id}`,
+        };
       }
+      return item;
     };
 
-    const versionedSidebar: UnprocessedSidebars = Object.entries(
-      loadedSidebars,
-    ).reduce((acc: UnprocessedSidebars, [sidebarId, sidebarItems]) => {
-      const newVersionedSidebarId = `version-${version}/${sidebarId}`;
-      acc[newVersionedSidebarId] = sidebarItems.map(normalizeItem);
-      return acc;
-    }, {});
+    const versionedSidebar = Object.entries(loadedSidebars).reduce(
+      (acc: NormalizedSidebars, [sidebarId, sidebar]) => {
+        const versionedId = `version-${version}/${sidebarId}`;
+        acc[versionedId] = transformSidebarItems(
+          sidebar as Sidebar,
+          prependVersion,
+        );
+        return acc;
+      },
+      {},
+    );
 
     const versionedSidebarsDir = getVersionedSidebarsDirPath(siteDir, pluginId);
     const newSidebarFile = path.join(

package/src/index.ts

@@ -21,7 +21,9 @@ import {
   createAbsoluteFilePathMatcher,
 } from '@docusaurus/utils';
 import {LoadContext, Plugin, RouteConfig} from '@docusaurus/types';
-import {loadSidebars, createSidebarsUtils, processSidebars} from './sidebars';
+import {loadSidebars} from './sidebars';
+import {createSidebarsUtils} from './sidebars/utils';
+import {CategoryMetadataFilenamePattern} from './sidebars/generator';
 import {readVersionDocs, processDocMetadata} from './docs';
 import {getDocsDirPaths, readVersionsMetadata} from './versions';
 
@@ -42,14 +44,13 @@ import {
 import {RuleSetRule} from 'webpack';
 import {cliDocsVersionCommand} from './cli';
 import {VERSIONS_JSON_FILE} from './constants';
-import {flatten, keyBy, compact, mapValues} from 'lodash';
+import {keyBy, compact, mapValues} from 'lodash';
 import {toGlobalDataVersion} from './globalData';
 import {toTagDocListProp, toVersionMetadataProp} from './props';
 import {
   translateLoadedContent,
   getLoadedContentTranslationFiles,
 } from './translations';
-import {CategoryMetadataFilenamePattern} from './sidebarItemsGenerator';
 import chalk from 'chalk';
 import {getVersionTags} from './tags';
 import {PropTagsListPage} from '@docusaurus/plugin-content-docs-types';
@@ -116,11 +117,9 @@ export default function pluginContentDocs(
     getPathsToWatch() {
       function getVersionPathsToWatch(version: VersionMetadata): string[] {
         const result = [
-          ...flatten(
-            options.include.map((pattern) =>
-              getDocsDirPaths(version).map(
-                (docsDirPath) => `${docsDirPath}/${pattern}`,
-              ),
+          ...options.include.flatMap((pattern) =>
+            getDocsDirPaths(version).map(
+              (docsDirPath) => `${docsDirPath}/${pattern}`,
             ),
           ),
           `${version.contentPath}/**/${CategoryMetadataFilenamePattern}`,
@@ -131,7 +130,7 @@ export default function pluginContentDocs(
         return result;
       }
 
-      return flatten(versionsMetadata.map(getVersionPathsToWatch));
+      return versionsMetadata.flatMap(getVersionPathsToWatch);
     },
 
     async loadContent() {
@@ -163,14 +162,6 @@ export default function pluginContentDocs(
       async function doLoadVersion(
         versionMetadata: VersionMetadata,
       ): Promise<LoadedVersion> {
-        const unprocessedSidebars = loadSidebars(
-          versionMetadata.sidebarFilePath,
-          {
-            sidebarCollapsed: options.sidebarCollapsed,
-            sidebarCollapsible: options.sidebarCollapsible,
-          },
-        );
-
         const docsBase: DocMetadataBase[] = await loadVersionDocsBase(
           versionMetadata,
         );
@@ -179,10 +170,9 @@ export default function pluginContentDocs(
           (doc) => doc.id,
         );
 
-        const sidebars = await processSidebars({
+        const sidebars = await loadSidebars(versionMetadata.sidebarFilePath, {
           sidebarItemsGenerator: options.sidebarItemsGenerator,
           numberPrefixParser: options.numberPrefixParser,
-          unprocessedSidebars,
           docs: docsBase,
           version: versionMetadata,
           options: {
@@ -191,18 +181,21 @@ export default function pluginContentDocs(
           },
         });
 
-        const sidebarsUtils = createSidebarsUtils(sidebars);
+        const {
+          checkSidebarsDocIds,
+          getDocNavigation,
+          getFirstDocIdOfFirstSidebar,
+        } = createSidebarsUtils(sidebars);
 
         const validDocIds = Object.keys(docsBaseById);
-        sidebarsUtils.checkSidebarsDocIds(
+        checkSidebarsDocIds(
           validDocIds,
           versionMetadata.sidebarFilePath as string,
         );
 
         // Add sidebar/next/previous to the docs
         function addNavData(doc: DocMetadataBase): DocMetadata {
-          const {sidebarName, previousId, nextId} =
-            sidebarsUtils.getDocNavigation(doc.id);
+          const {sidebarName, previousId, nextId} = getDocNavigation(doc.id);
           const toDocNavLink = (navDocId: string): DocNavLink => {
             const {title, permalink, frontMatter} = docsBaseById[navDocId];
             return {
@@ -236,8 +229,7 @@ export default function pluginContentDocs(
             (doc) =>
               doc.unversionedId === options.homePageId || doc.slug === '/',
           );
-          const firstDocIdOfFirstSidebar =
-            sidebarsUtils.getFirstDocIdOfFirstSidebar();
+          const firstDocIdOfFirstSidebar = getFirstDocIdOfFirstSidebar();
           if (versionHomeDoc) {
             return versionHomeDoc;
           } else if (firstDocIdOfFirstSidebar) {
@@ -429,7 +421,7 @@ export default function pluginContentDocs(
       } = options;
 
       function getSourceToPermalink(): SourceToPermalink {
-        const allDocs = flatten(content.loadedVersions.map((v) => v.docs));
+        const allDocs = content.loadedVersions.flatMap((v) => v.docs);
         return mapValues(
           keyBy(allDocs, (d) => d.source),
           (d) => d.permalink,
@@ -452,7 +444,7 @@ export default function pluginContentDocs(
       };
 
       function createMDXLoaderRule(): RuleSetRule {
-        const contentDirs = flatten(versionsMetadata.map(getDocsDirPaths));
+        const contentDirs = versionsMetadata.flatMap(getDocsDirPaths);
         return {
           test: /(\.mdx?)$/,
           include: contentDirs

package/src/options.ts

@@ -17,7 +17,7 @@ import {GlobExcludeDefault} from '@docusaurus/utils';
 import {OptionValidationContext, ValidationResult} from '@docusaurus/types';
 import chalk from 'chalk';
 import admonitions from 'remark-admonitions';
-import {DefaultSidebarItemsGenerator} from './sidebarItemsGenerator';
+import {DefaultSidebarItemsGenerator} from './sidebars/generator';
 import {
   DefaultNumberPrefixParser,
   DisabledNumberPrefixParser,

package/src/plugin-content-docs.d.ts

@@ -7,6 +7,7 @@
 
 declare module '@docusaurus/plugin-content-docs' {
   export type Options = Partial<import('./types').PluginOptions>;
+  export type SidebarsConfig = import('./sidebars/types').SidebarsConfig;
 }
 
 // TODO public api surface types should rather be exposed as "@docusaurus/plugin-content-docs"
@@ -29,30 +30,11 @@ declare module '@docusaurus/plugin-content-docs-types' {
     docsSidebars: PropSidebars;
   };
 
-  type PropsSidebarItemBase = {
-    className?: string;
-    customProps?: Record<string, unknown>;
-  };
-
-  export type PropSidebarItemLink = PropsSidebarItemBase & {
-    type: 'link';
-    href: string;
-    label: string;
-  };
-
-  export type PropSidebarItemCategory = PropsSidebarItemBase & {
-    type: 'category';
-    label: string;
-    items: PropSidebarItem[];
-    collapsed: boolean;
-    collapsible: boolean;
-  };
-
-  export type PropSidebarItem = PropSidebarItemLink | PropSidebarItemCategory;
-
-  export type PropSidebars = {
-    [sidebarId: string]: PropSidebarItem[];
-  };
+  export type PropSidebarItemLink = import('./sidebars/types').SidebarItemLink;
+  export type PropSidebarItemCategory =
+    import('./sidebars/types').PropSidebarItemCategory;
+  export type PropSidebarItem = import('./sidebars/types').PropSidebarItem;
+  export type PropSidebars = import('./sidebars/types').PropSidebars;
 
   export type PropTagDocListDoc = {
     id: string;

package/src/props.ts

@@ -5,14 +5,12 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {
-  LoadedVersion,
+import {LoadedVersion, VersionTag, DocMetadata} from './types';
+import type {
   SidebarItemDoc,
   SidebarItemLink,
   SidebarItem,
-  VersionTag,
-  DocMetadata,
-} from './types';
+} from './sidebars/types';
 import type {
   PropSidebars,
   PropVersionMetadata,