@docusaurus/plugin-content-docs 2.0.0-beta.15 → 2.0.0-beta.16

package/lib/sidebars/types.d.ts

@@ -7,6 +7,7 @@
 import type { Optional, Required } from 'utility-types';
 import type { DocMetadataBase, VersionMetadata } from '../types';
 import type { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher } from '@docusaurus/plugin-content-docs';
+import type { Slugger } from '@docusaurus/utils';
 declare type Expand<T extends Record<string, unknown>> = {
     [P in keyof T]: T[P];
 };
@@ -19,6 +20,11 @@ export declare type SidebarItemDoc = SidebarItemBase & {
     label?: string;
     id: string;
 };
+export declare type SidebarItemHtml = SidebarItemBase & {
+    type: 'html';
+    value: string;
+    defaultStyle?: boolean;
+};
 export declare type SidebarItemLink = SidebarItemBase & {
     type: 'link';
     href: string;
@@ -58,26 +64,35 @@ export declare type SidebarItemCategoryLinkGeneratedIndex = {
 export declare type SidebarItemCategoryLinkConfig = SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndexConfig;
 export declare type SidebarItemCategoryLink = SidebarItemCategoryLinkDoc | SidebarItemCategoryLinkGeneratedIndex;
 export declare type SidebarItemCategoryConfig = Expand<Optional<SidebarItemCategoryBase, 'collapsed' | 'collapsible'> & {
-    items: SidebarItemConfig[];
+    items: SidebarCategoriesShorthand | SidebarItemConfig[];
     link?: SidebarItemCategoryLinkConfig;
 }>;
 export declare type SidebarCategoriesShorthand = {
-    [sidebarCategory: string]: SidebarItemConfig[];
+    [sidebarCategory: string]: SidebarCategoriesShorthand | SidebarItemConfig[];
 };
-export declare type SidebarItemConfig = SidebarItemDoc | SidebarItemLink | SidebarItemAutogenerated | SidebarItemCategoryConfig | string | SidebarCategoriesShorthand;
+export declare type SidebarItemConfig = SidebarItemDoc | SidebarItemHtml | SidebarItemLink | SidebarItemAutogenerated | SidebarItemCategoryConfig | string | SidebarCategoriesShorthand;
 export declare type SidebarConfig = SidebarCategoriesShorthand | SidebarItemConfig[];
 export declare type SidebarsConfig = {
     [sidebarId: string]: SidebarConfig;
 };
-export declare type NormalizedSidebarItemCategory = Expand<SidebarItemCategoryBase & {
+export declare type NormalizedSidebarItemCategory = Expand<Optional<SidebarItemCategoryBase, 'collapsed' | 'collapsible'> & {
     items: NormalizedSidebarItem[];
-    link?: SidebarItemCategoryLink;
+    link?: SidebarItemCategoryLinkConfig;
 }>;
-export declare type NormalizedSidebarItem = SidebarItemDoc | SidebarItemLink | NormalizedSidebarItemCategory | SidebarItemAutogenerated;
+export declare type NormalizedSidebarItem = SidebarItemDoc | SidebarItemHtml | SidebarItemLink | NormalizedSidebarItemCategory | SidebarItemAutogenerated;
 export declare type NormalizedSidebar = NormalizedSidebarItem[];
 export declare type NormalizedSidebars = {
     [sidebarId: string]: NormalizedSidebar;
 };
+export declare type ProcessedSidebarItemCategory = Expand<Optional<SidebarItemCategoryBase, 'collapsed' | 'collapsible'> & {
+    items: ProcessedSidebarItem[];
+    link?: SidebarItemCategoryLinkConfig;
+}>;
+export declare type ProcessedSidebarItem = SidebarItemDoc | SidebarItemHtml | SidebarItemLink | ProcessedSidebarItemCategory;
+export declare type ProcessedSidebar = ProcessedSidebarItem[];
+export declare type ProcessedSidebars = {
+    [sidebarId: string]: ProcessedSidebar;
+};
 export declare type SidebarItemCategory = Expand<SidebarItemCategoryBase & {
     items: SidebarItem[];
     link?: SidebarItemCategoryLink;
@@ -86,7 +101,7 @@ export declare type SidebarItemCategoryWithLink = Required<SidebarItemCategory,
 export declare type SidebarItemCategoryWithGeneratedIndex = SidebarItemCategoryWithLink & {
     link: SidebarItemCategoryLinkGeneratedIndex;
 };
-export declare type SidebarItem = SidebarItemDoc | SidebarItemLink | SidebarItemCategory;
+export declare type SidebarItem = SidebarItemDoc | SidebarItemHtml | SidebarItemLink | SidebarItemCategory;
 export declare type SidebarNavigationItem = SidebarItemDoc | SidebarItemCategoryWithLink;
 export declare type Sidebar = SidebarItem[];
 export declare type SidebarItemType = SidebarItem['type'];
@@ -100,11 +115,13 @@ export declare type PropSidebarItemCategory = Expand<SidebarItemCategoryBase & {
 export declare type PropSidebarItemLink = SidebarItemLink & {
     docId?: string;
 };
-export declare type PropSidebarItem = PropSidebarItemLink | PropSidebarItemCategory;
+export declare type PropSidebarItemHtml = SidebarItemHtml;
+export declare type PropSidebarItem = PropSidebarItemLink | PropSidebarItemCategory | PropSidebarItemHtml;
 export declare type PropSidebar = PropSidebarItem[];
 export declare type PropSidebars = {
     [sidebarId: string]: PropSidebar;
 };
+export declare type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCategory;
 export declare type PropVersionDoc = {
     id: string;
     title: string;
@@ -114,6 +131,14 @@ export declare type PropVersionDoc = {
 export declare type PropVersionDocs = {
     [docId: string]: PropVersionDoc;
 };
+export declare type CategoryMetadataFile = {
+    label?: string;
+    position?: number;
+    collapsed?: boolean;
+    collapsible?: boolean;
+    className?: string;
+    link?: SidebarItemCategoryLinkConfig | null;
+};
 export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
 export declare type SidebarItemsGeneratorArgs = {
@@ -122,11 +147,20 @@ export declare type SidebarItemsGeneratorArgs = {
     docs: SidebarItemsGeneratorDoc[];
     numberPrefixParser: NumberPrefixParser;
     isCategoryIndex: CategoryIndexMatcher;
+    categoriesMetadata: Record<string, CategoryMetadataFile>;
     options: SidebarOptions;
 };
-export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<SidebarItem[]>;
+export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
 export declare type SidebarItemsGeneratorOptionArgs = {
     defaultSidebarItemsGenerator: SidebarItemsGenerator;
 } & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<SidebarItem[]>;
+export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<NormalizedSidebarItem[]>;
+export declare type SidebarProcessorParams = {
+    sidebarItemsGenerator: SidebarItemsGeneratorOption;
+    numberPrefixParser: NumberPrefixParser;
+    docs: DocMetadataBase[];
+    version: VersionMetadata;
+    categoryLabelSlugger: Slugger;
+    sidebarOptions: SidebarOptions;
+};
 export {};

package/lib/sidebars/utils.js

@@ -7,10 +7,11 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.toNavigationLink = exports.toDocNavigationLink = exports.createSidebarsUtils = exports.collectSidebarsNavigations = exports.collectSidebarsDocIds = exports.collectSidebarNavigation = exports.collectSidebarDocIds = exports.collectSidebarLinks = exports.collectSidebarCategories = exports.collectSidebarDocItems = exports.transformSidebarItems = exports.isCategoriesShorthand = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
 function isCategoriesShorthand(item) {
-    return typeof item !== 'string' && !item.type;
+    return typeof item === 'object' && !item.type;
 }
 exports.isCategoriesShorthand = isCategoriesShorthand;
 function transformSidebarItems(sidebar, updateFn) {
@@ -26,8 +27,11 @@ function transformSidebarItems(sidebar, updateFn) {
     return sidebar.map(transformRecursive);
 }
 exports.transformSidebarItems = transformSidebarItems;
-// Flatten sidebar items into a single flat array (containing categories/docs on the same level)
-// /!\ order matters (useful for next/prev nav), top categories appear before their child elements
+/**
+ * Flatten sidebar items into a single flat array (containing categories/docs on
+ * the same level). Order matters (useful for next/prev nav), top categories
+ * appear before their child elements
+ */
 function flattenSidebarItems(items) {
     function flattenRecursive(item) {
         return item.type === 'category'
@@ -78,11 +82,11 @@ function collectSidebarNavigation(sidebar) {
 }
 exports.collectSidebarNavigation = collectSidebarNavigation;
 function collectSidebarsDocIds(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, collectSidebarDocIds);
+    return lodash_1.default.mapValues(sidebars, collectSidebarDocIds);
 }
 exports.collectSidebarsDocIds = collectSidebarsDocIds;
 function collectSidebarsNavigations(sidebars) {
-    return (0, lodash_1.mapValues)(sidebars, collectSidebarNavigation);
+    return lodash_1.default.mapValues(sidebars, collectSidebarNavigation);
 }
 exports.collectSidebarsNavigations = collectSidebarsNavigations;
 function createSidebarsUtils(sidebars) {
@@ -114,29 +118,27 @@ function createSidebarsUtils(sidebars) {
             docId = versionedId;
             sidebarName = getSidebarNameByDocId(docId);
         }
-        if (sidebarName) {
-            if (!sidebarNameToNavigationItems[sidebarName]) {
-                throw new Error(`Doc with ID ${docId} wants to display sidebar ${sidebarName} but a sidebar with this name doesn't exist`);
+        if (!sidebarName) {
+            return emptySidebarNavigation();
+        }
+        if (!sidebarNameToNavigationItems[sidebarName]) {
+            throw new Error(`Doc with ID ${docId} wants to display sidebar ${sidebarName} but a sidebar with this name doesn't exist`);
+        }
+        const navigationItems = sidebarNameToNavigationItems[sidebarName];
+        const currentItemIndex = navigationItems.findIndex((item) => {
+            if (item.type === 'doc') {
+                return item.id === docId;
             }
-            const navigationItems = sidebarNameToNavigationItems[sidebarName];
-            const currentItemIndex = navigationItems.findIndex((item) => {
-                if (item.type === 'doc') {
-                    return item.id === docId;
-                }
-                if (item.type === 'category' && item.link.type === 'doc') {
-                    return item.link.id === docId;
-                }
-                return false;
-            });
-            if (currentItemIndex === -1) {
-                return { sidebarName, next: undefined, previous: undefined };
+            if (item.type === 'category' && item.link.type === 'doc') {
+                return item.link.id === docId;
             }
-            const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
-            return { sidebarName, previous, next };
-        }
-        else {
-            return emptySidebarNavigation();
+            return false;
+        });
+        if (currentItemIndex === -1) {
+            return { sidebarName, next: undefined, previous: undefined };
         }
+        const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
+        return { sidebarName, previous, next };
     }
     function getCategoryGeneratedIndexList() {
         return Object.values(sidebarNameToNavigationItems)
@@ -148,8 +150,10 @@ function createSidebarsUtils(sidebars) {
             return [];
         });
     }
-    // We identity the category generated index by its permalink (should be unique)
-    // More reliable than using object identity
+    /**
+     * We identity the category generated index by its permalink (should be
+     * unique). More reliable than using object identity
+     */
     function getCategoryGeneratedIndexNavigation(categoryGeneratedIndexPermalink) {
         var _a;
         function isCurrentCategoryGeneratedIndexItem(item) {
@@ -159,31 +163,28 @@ function createSidebarsUtils(sidebars) {
                 item.link.permalink === categoryGeneratedIndexPermalink);
         }
         const sidebarName = (_a = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))) === null || _a === void 0 ? void 0 : _a[0];
-        if (sidebarName) {
-            const navigationItems = sidebarNameToNavigationItems[sidebarName];
-            const currentItemIndex = navigationItems.findIndex(isCurrentCategoryGeneratedIndexItem);
-            const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
-            return { sidebarName, previous, next };
-        }
-        else {
+        if (!sidebarName) {
             return emptySidebarNavigation();
         }
+        const navigationItems = sidebarNameToNavigationItems[sidebarName];
+        const currentItemIndex = navigationItems.findIndex(isCurrentCategoryGeneratedIndexItem);
+        const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);
+        return { sidebarName, previous, next };
     }
     function checkSidebarsDocIds(validDocIds, sidebarFilePath) {
         const allSidebarDocIds = Object.values(sidebarNameToDocIds).flat();
-        const invalidSidebarDocIds = (0, lodash_1.difference)(allSidebarDocIds, validDocIds);
+        const invalidSidebarDocIds = lodash_1.default.difference(allSidebarDocIds, validDocIds);
         if (invalidSidebarDocIds.length > 0) {
             throw new Error(`Invalid sidebar file at "${(0, utils_1.toMessageRelativeFilePath)(sidebarFilePath)}".
 These sidebar document ids do not exist:
 - ${invalidSidebarDocIds.sort().join('\n- ')}
 
 Available document ids are:
-- ${(0, lodash_1.uniq)(validDocIds).sort().join('\n- ')}`);
+- ${lodash_1.default.uniq(validDocIds).sort().join('\n- ')}`);
         }
     }
     function getFirstLink(sidebar) {
         var _a, _b, _c;
-        // eslint-disable-next-line no-restricted-syntax
         for (const item of sidebar) {
             if (item.type === 'doc') {
                 return {
@@ -207,11 +208,9 @@ Available document ids are:
                         label: item.label,
                     };
                 }
-                else {
-                    const firstSubItem = getFirstLink(item.items);
-                    if (firstSubItem) {
-                        return firstSubItem;
-                    }
+                const firstSubItem = getFirstLink(item.items);
+                if (firstSubItem) {
+                    return firstSubItem;
                 }
             }
         }
@@ -243,20 +242,6 @@ function toNavigationLink(navigationItem, docsById) {
         }
         return doc;
     }
-    function handleCategory(category) {
-        if (category.link.type === 'doc') {
-            return toDocNavigationLink(getDocById(category.link.id));
-        }
-        else if (category.link.type === 'generated-index') {
-            return {
-                title: category.label,
-                permalink: category.link.permalink,
-            };
-        }
-        else {
-            throw new Error('unexpected category link type');
-        }
-    }
     if (!navigationItem) {
         return undefined;
     }
@@ -264,10 +249,17 @@ function toNavigationLink(navigationItem, docsById) {
         return toDocNavigationLink(getDocById(navigationItem.id));
     }
     else if (navigationItem.type === 'category') {
-        return handleCategory(navigationItem);
-    }
-    else {
-        throw new Error('unexpected navigation item');
+        if (navigationItem.link.type === 'doc') {
+            return toDocNavigationLink(getDocById(navigationItem.link.id));
+        }
+        else if (navigationItem.link.type === 'generated-index') {
+            return {
+                title: navigationItem.label,
+                permalink: navigationItem.link.permalink,
+            };
+        }
+        throw new Error('unexpected category link type');
     }
+    throw new Error('unexpected navigation item');
 }
 exports.toNavigationLink = toNavigationLink;

package/lib/sidebars/validation.d.ts

@@ -4,7 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { SidebarsConfig } from './types';
-import type { CategoryMetadataFile } from './generator';
-export declare function validateSidebars(sidebars: unknown): asserts sidebars is SidebarsConfig;
+import type { NormalizedSidebars, CategoryMetadataFile } from './types';
+export declare function validateSidebars(sidebars: Record<string, unknown>): asserts sidebars is NormalizedSidebars;
 export declare function validateCategoryMetadataFile(unsafeContent: unknown): CategoryMetadataFile;

package/lib/sidebars/validation.js

@@ -8,9 +8,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateCategoryMetadataFile = exports.validateSidebars = void 0;
 const utils_validation_1 = require("@docusaurus/utils-validation");
-const utils_1 = require("./utils");
 // NOTE: we don't add any default values during validation on purpose!
-// Config types are exposed to users for typechecking and we use the same type in normalization
+// Config types are exposed to users for typechecking and we use the same type
+// in normalization
 const sidebarItemBaseSchema = utils_validation_1.Joi.object({
     className: utils_validation_1.Joi.string(),
     customProps: utils_validation_1.Joi.object().unknown(),
@@ -19,7 +19,7 @@ const sidebarItemAutogeneratedSchema = sidebarItemBaseSchema.append({
     type: 'autogenerated',
     dirName: utils_validation_1.Joi.string()
         .required()
-        .pattern(/^[^/](.*[^/])?$/)
+        .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({
@@ -27,6 +27,11 @@ const sidebarItemDocSchema = sidebarItemBaseSchema.append({
     id: utils_validation_1.Joi.string().required(),
     label: utils_validation_1.Joi.string(),
 });
+const sidebarItemHtmlSchema = sidebarItemBaseSchema.append({
+    type: 'html',
+    value: utils_validation_1.Joi.string().required(),
+    defaultStyle: utils_validation_1.Joi.boolean(),
+});
 const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
     type: 'link',
     href: utils_validation_1.URISchema.required(),
@@ -35,6 +40,7 @@ const sidebarItemLinkSchema = sidebarItemBaseSchema.append({
         .messages({ 'any.unknown': '"label" must be a string' }),
 });
 const sidebarItemCategoryLinkSchema = utils_validation_1.Joi.object()
+    .allow(null)
     .when('.type', {
     switch: [
         {
@@ -49,7 +55,8 @@ const sidebarItemCategoryLinkSchema = utils_validation_1.Joi.object()
             then: utils_validation_1.Joi.object({
                 type: 'generated-index',
                 slug: utils_validation_1.Joi.string().optional(),
-                // permalink: Joi.string().optional(), // No, this one is not in the user config, only in the normalized version
+                // This one is not in the user config, only in the normalized version
+                // permalink: Joi.string().optional(),
                 title: utils_validation_1.Joi.string().optional(),
                 description: utils_validation_1.Joi.string().optional(),
                 image: utils_validation_1.Joi.string().optional(),
@@ -57,23 +64,23 @@ const sidebarItemCategoryLinkSchema = utils_validation_1.Joi.object()
             }),
         },
         {
-            is: utils_validation_1.Joi.string().required(),
+            is: utils_validation_1.Joi.required(),
             then: utils_validation_1.Joi.forbidden().messages({
                 'any.unknown': 'Unknown sidebar category link type "{.type}".',
             }),
         },
     ],
-})
-    .id('sidebarCategoryLinkSchema');
+});
 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' }),
+    // TODO: Joi doesn't allow mutual recursion. See https://github.com/sideway/joi/issues/2611
+    // .items(Joi.link('#sidebarItemSchema')),
     link: sidebarItemCategoryLinkSchema,
     collapsed: utils_validation_1.Joi.boolean().messages({
         'any.unknown': '"collapsed" must be a boolean',
@@ -82,14 +89,14 @@ const sidebarItemCategorySchema = sidebarItemBaseSchema.append({
         'any.unknown': '"collapsible" must be a boolean',
     }),
 });
-const sidebarItemSchema = utils_validation_1.Joi.object()
-    .when('.type', {
+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: 'html', then: sidebarItemHtmlSchema },
         { is: 'autogenerated', then: sidebarItemAutogeneratedSchema },
         { is: 'category', then: sidebarItemCategorySchema },
         {
@@ -99,32 +106,20 @@ const sidebarItemSchema = utils_validation_1.Joi.object()
             }),
         },
     ],
-})
-    .id('sidebarItemSchema');
+});
+// .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, utils_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);
-        }
+    // Because we can't use Joi to validate nested items (see above), we do it
+    // manually
+    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);
-        }
+        sidebar.forEach(validateSidebarItem);
     });
 }
 exports.validateSidebars = validateSidebars;

package/lib/slug.js

@@ -23,15 +23,13 @@ function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumbe
         if (frontMatterSlug === null || frontMatterSlug === void 0 ? void 0 : frontMatterSlug.startsWith('/')) {
             return frontMatterSlug;
         }
-        else {
-            const dirNameSlug = getDirNameSlug();
-            if (!frontMatterSlug &&
-                (0, docs_1.isCategoryIndex)((0, docs_1.toCategoryIndexMatcherParam)({ source, sourceDirName }))) {
-                return dirNameSlug;
-            }
-            const baseSlug = frontMatterSlug || baseID;
-            return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
+        const dirNameSlug = getDirNameSlug();
+        if (!frontMatterSlug &&
+            (0, docs_1.isCategoryIndex)((0, docs_1.toCategoryIndexMatcherParam)({ source, sourceDirName }))) {
+            return dirNameSlug;
         }
+        const baseSlug = frontMatterSlug || baseID;
+        return (0, utils_1.resolvePathname)(baseSlug, getDirNameSlug());
     }
     function ensureValidSlug(slug) {
         if (!(0, utils_1.isValidPathname)(slug)) {

package/lib/tags.js

@@ -7,11 +7,12 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVersionTags = void 0;
+const tslib_1 = require("tslib");
 const utils_1 = require("@docusaurus/utils");
-const lodash_1 = require("lodash");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 function getVersionTags(docs) {
     const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
-    return (0, lodash_1.mapValues)(groups, (group) => ({
+    return lodash_1.default.mapValues(groups, (group) => ({
         name: group.tag.label,
         docIds: group.items.map((item) => item.id),
         permalink: group.tag.permalink,

package/lib/translations.js

@@ -7,7 +7,8 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateLoadedContent = exports.getLoadedContentTranslationFiles = void 0;
-const lodash_1 = require("lodash");
+const tslib_1 = require("tslib");
+const lodash_1 = (0, tslib_1.__importDefault)(require("lodash"));
 const utils_1 = require("./sidebars/utils");
 const utils_2 = require("@docusaurus/utils");
 const constants_1 = require("./constants");
@@ -15,11 +16,9 @@ function getVersionFileName(versionName) {
     if (versionName === constants_1.CURRENT_VERSION_NAME) {
         return versionName;
     }
-    else {
-        // I don't like this "version-" prefix,
-        // but it's for consistency with site/versioned_docs
-        return `version-${versionName}`;
-    }
+    // I don't like this "version-" prefix,
+    // but it's for consistency with site/versioned_docs
+    return `version-${versionName}`;
 }
 // TODO legacy, the sidebar name is like "version-2.0.0-alpha.66/docs"
 // input: "version-2.0.0-alpha.66/docs"
@@ -44,7 +43,8 @@ function getDocTranslations(doc: DocMetadata): TranslationFileContent {
       ? {
           [`${doc.unversionedId}.sidebar_label`]: {
             message: doc.sidebar_label,
-            description: `The sidebar label for doc with id=${doc.unversionedId}`,
+            description:
+              `The sidebar label for doc with id=${doc.unversionedId}`,
           },
         }
       : undefined),
@@ -109,13 +109,13 @@ function getSidebarTranslationFileContent(sidebar, sidebarName) {
         return entries;
     }));
     const links = (0, utils_1.collectSidebarLinks)(sidebar);
-    const linksContent = (0, lodash_1.chain)(links)
-        .keyBy((link) => `sidebar.${sidebarName}.link.${link.label}`)
-        .mapValues((link) => ({
-        message: link.label,
-        description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
-    }))
-        .value();
+    const linksContent = Object.fromEntries(links.map((link) => [
+        `sidebar.${sidebarName}.link.${link.label}`,
+        {
+            message: link.label,
+            description: `The label for link ${link.label} in sidebar ${sidebarName}, linking to ${link.href}`,
+        },
+    ]));
     return (0, utils_2.mergeTranslations)([categoryContent, linksContent]);
 }
 function translateSidebar({ sidebar, sidebarName, sidebarsTranslations, }) {
@@ -164,7 +164,7 @@ function getSidebarsTranslations(version) {
     }));
 }
 function translateSidebars(version, sidebarsTranslations) {
-    return (0, lodash_1.mapValues)(version.sidebars, (sidebar, sidebarName) => translateSidebar({
+    return lodash_1.default.mapValues(version.sidebars, (sidebar, sidebarName) => translateSidebar({
         sidebar,
         sidebarName: getNormalizedSidebarName({
             sidebarName,
@@ -181,7 +181,8 @@ function getVersionTranslationFiles(version) {
         },
     };
     const sidebarsTranslations = getSidebarsTranslations(version);
-    // const docsTranslations: TranslationFileContent = getDocsTranslations(version);
+    // const docsTranslations: TranslationFileContent =
+    //   getDocsTranslations(version);
     return [
         {
             path: getVersionFileName(version.versionName),
@@ -214,7 +215,7 @@ function getLoadedContentTranslationFiles(loadedContent) {
 }
 exports.getLoadedContentTranslationFiles = getLoadedContentTranslationFiles;
 function translateLoadedContent(loadedContent, translationFiles) {
-    const translationFilesMap = (0, lodash_1.keyBy)(translationFiles, (f) => f.path);
+    const translationFilesMap = lodash_1.default.keyBy(translationFiles, (f) => f.path);
     return {
         loadedVersions: translateVersions(loadedContent.loadedVersions, translationFilesMap),
     };

package/lib/types.d.ts

@@ -5,9 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars } from './sidebars/types';
-import type { Tag, FrontMatterTag, Slugger } from '@docusaurus/utils';
+import type { Tag, FrontMatterTag } from '@docusaurus/utils';
 import type { BrokenMarkdownLink as IBrokenMarkdownLink, ContentPaths } from '@docusaurus/utils/lib/markdownLinks';
-import type { VersionBanner, SidebarOptions } from '@docusaurus/plugin-content-docs';
+import type { VersionBanner } from '@docusaurus/plugin-content-docs';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -29,10 +29,6 @@ export declare type VersionMetadata = ContentPaths & {
     sidebarFilePath: string | false | undefined;
     routePriority: number | undefined;
 };
-export declare type NormalizeSidebarsParams = SidebarOptions & {
-    version: VersionMetadata;
-    categoryLabelSlugger: Slugger;
-};
 export declare type LastUpdateData = {
     lastUpdatedAt?: number;
     formattedLastUpdatedAt?: string;
@@ -51,6 +47,7 @@ export declare type DocFrontMatter = {
     sidebar_label?: string;
     sidebar_position?: number;
     sidebar_class_name?: string;
+    sidebar_custom_props?: Record<string, unknown>;
     displayed_sidebar?: string | null;
     pagination_label?: string;
     custom_edit_url?: string | null;

package/lib/versions.d.ts

@@ -5,11 +5,35 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { VersionMetadata } from './types';
-import type { PluginOptions } from '@docusaurus/plugin-content-docs';
+import type { PluginOptions, VersionBanner } from '@docusaurus/plugin-content-docs';
 import type { LoadContext } from '@docusaurus/types';
 export declare function getVersionedDocsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionedSidebarsDirPath(siteDir: string, pluginId: string): string;
 export declare function getVersionsFilePath(siteDir: string, pluginId: string): string;
+export declare function readVersionsFile(siteDir: string, pluginId: string): Promise<string[] | null>;
+export declare function readVersionNames(siteDir: string, options: Pick<PluginOptions, 'id' | 'disableVersioning' | 'includeCurrentVersion'>): Promise<string[]>;
+export declare function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }: {
+    versionName: string;
+    versionNames: string[];
+    lastVersionName: string;
+}): VersionBanner | null;
+export declare function getVersionBanner({ versionName, versionNames, lastVersionName, options, }: {
+    versionName: string;
+    versionNames: string[];
+    lastVersionName: string;
+    options: Pick<PluginOptions, 'versions'>;
+}): VersionBanner | null;
+export declare function getVersionBadge({ versionName, versionNames, options, }: {
+    versionName: string;
+    versionNames: string[];
+    options: Pick<PluginOptions, 'versions'>;
+}): boolean;
+/**
+ * Filter versions according to provided options.
+ * Note: we preserve the order in which versions are provided;
+ * the order of the onlyIncludeVersions array does not matter
+ */
+export declare function filterVersions(versionNamesUnfiltered: string[], options: Pick<PluginOptions, 'onlyIncludeVersions'>): string[];
 export declare function readVersionsMetadata({ context, options, }: {
     context: Pick<LoadContext, 'siteDir' | 'baseUrl' | 'i18n'>;
     options: Pick<PluginOptions, 'id' | 'path' | 'sidebarPath' | 'routeBasePath' | 'tagsBasePath' | 'includeCurrentVersion' | 'disableVersioning' | 'lastVersion' | 'versions' | 'onlyIncludeVersions' | 'editUrl' | 'editCurrentVersion'>;