@docusaurus/plugin-content-docs 2.0.0-beta.18 → 2.0.0-beta.19

package/lib/index.js

@@ -18,16 +18,19 @@ const cli_1 = require("./cli");
 const constants_1 = require("./constants");
 const globalData_1 = require("./globalData");
 const props_1 = require("./props");
+const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
 const translations_1 = require("./translations");
 const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 const tags_1 = require("./tags");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
-const categoryGeneratedIndex_1 = require("./categoryGeneratedIndex");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
+    // Mutate options to resolve sidebar path according to siteDir
+    options.sidebarPath = (0, sidebars_1.resolveSidebarPathOption)(siteDir, options.sidebarPath);
     const versionsMetadata = await (0, versions_1.readVersionsMetadata)({ context, options });
-    const pluginId = options.id ?? utils_1.DEFAULT_PLUGIN_ID;
+    const pluginId = options.id;
     const pluginDataDirRoot = path_1.default.join(generatedFilesDir, 'docusaurus-plugin-content-docs');
     const dataDir = path_1.default.join(pluginDataDirRoot, pluginId);
     const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
@@ -48,21 +51,16 @@ async function pluginContentDocs(context, options) {
                 .arguments('<version>')
                 .description(commandDescription)
                 .action((version) => {
-                (0, cli_1.cliDocsVersionCommand)(version, siteDir, pluginId, {
-                    path: options.path,
-                    sidebarPath: options.sidebarPath,
-                    sidebarCollapsed: options.sidebarCollapsed,
-                    sidebarCollapsible: options.sidebarCollapsible,
-                });
+                (0, cli_1.cliDocsVersionCommand)(version, options, context);
             });
         },
-        async getTranslationFiles({ content }) {
+        getTranslationFiles({ content }) {
             return (0, translations_1.getLoadedContentTranslationFiles)(content);
         },
         getPathsToWatch() {
             function getVersionPathsToWatch(version) {
                 const result = [
-                    ...options.include.flatMap((pattern) => (0, versions_1.getDocsDirPaths)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
+                    ...options.include.flatMap((pattern) => (0, utils_1.getContentPathList)(version).map((docsDirPath) => `${docsDirPath}/${pattern}`)),
                     `${version.contentPath}/**/${generator_1.CategoryMetadataFilenamePattern}`,
                 ];
                 if (typeof version.sidebarFilePath === 'string') {
@@ -84,16 +82,19 @@ async function pluginContentDocs(context, options) {
                         versionMetadata,
                         context,
                         options,
+                        env: process.env.NODE_ENV,
                     });
                 }
                 return Promise.all(docFiles.map(processVersionDoc));
             }
             async function doLoadVersion(versionMetadata) {
-                const docs = await loadVersionDocsBase(versionMetadata);
+                const docsBase = await loadVersionDocsBase(versionMetadata);
+                const [drafts, docs] = lodash_1.default.partition(docsBase, (doc) => doc.draft);
                 const sidebars = await (0, sidebars_1.loadSidebars)(versionMetadata.sidebarFilePath, {
                     sidebarItemsGenerator: options.sidebarItemsGenerator,
                     numberPrefixParser: options.numberPrefixParser,
                     docs,
+                    drafts,
                     version: versionMetadata,
                     sidebarOptions: {
                         sidebarCollapsed: options.sidebarCollapsed,
@@ -105,12 +106,8 @@ async function pluginContentDocs(context, options) {
                 return {
                     ...versionMetadata,
                     docs: (0, docs_1.addDocNavigation)(docs, sidebarsUtils, versionMetadata.sidebarFilePath),
+                    drafts,
                     sidebars,
-                    mainDocId: (0, docs_1.getMainDocId)({ docs, sidebarsUtils }),
-                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
-                        docs,
-                        sidebarsUtils,
-                    }),
                 };
             }
             async function loadVersion(versionMetadata) {
@@ -133,17 +130,28 @@ async function pluginContentDocs(context, options) {
             const { loadedVersions } = content;
             const { docLayoutComponent, docItemComponent, docCategoryGeneratedIndexComponent, breadcrumbs, } = options;
             const { addRoute, createData, setGlobalData } = actions;
+            const versions = loadedVersions.map((version) => {
+                const sidebarsUtils = (0, utils_2.createSidebarsUtils)(version.sidebars);
+                return {
+                    ...version,
+                    sidebarsUtils,
+                    categoryGeneratedIndices: (0, categoryGeneratedIndex_1.getCategoryGeneratedIndexMetadataList)({
+                        docs: version.docs,
+                        sidebarsUtils,
+                    }),
+                };
+            });
             async function createVersionTagsRoutes(version) {
                 const versionTags = (0, tags_1.getVersionTags)(version.docs);
                 // TODO tags should be a sub route of the version route
                 async function createTagsListPage() {
                     const tagsProp = Object.values(versionTags).map((tagValue) => ({
-                        name: tagValue.name,
+                        label: tagValue.label,
                         permalink: tagValue.permalink,
                         count: tagValue.docIds.length,
                     }));
                     // Only create /tags page if there are tags.
-                    if (Object.keys(tagsProp).length > 0) {
+                    if (tagsProp.length > 0) {
                         const tagsPropPath = await createData(`${(0, utils_1.docuHash)(`tags-list-${version.versionName}-prop`)}.json`, JSON.stringify(tagsProp, null, 2));
                         addRoute({
                             path: version.tagsPath,
@@ -175,8 +183,8 @@ async function pluginContentDocs(context, options) {
                 await createTagsListPage();
                 await Promise.all(Object.values(versionTags).map(createTagDocListPage));
             }
-            await Promise.all(loadedVersions.map((loadedVersion) => (0, routes_1.createVersionRoutes)({
-                loadedVersion,
+            await Promise.all(versions.map((version) => (0, routes_1.createVersionRoutes)({
+                version,
                 docItemComponent,
                 docLayoutComponent,
                 docCategoryGeneratedIndexComponent,
@@ -185,10 +193,10 @@ async function pluginContentDocs(context, options) {
                 actions,
             })));
             // TODO tags should be a sub route of the version route
-            await Promise.all(loadedVersions.map(createVersionTagsRoutes));
+            await Promise.all(versions.map(createVersionTagsRoutes));
             setGlobalData({
                 path: (0, utils_1.normalizeUrl)([baseUrl, options.routeBasePath]),
-                versions: loadedVersions.map(globalData_1.toGlobalDataVersion),
+                versions: versions.map(globalData_1.toGlobalDataVersion),
                 breadcrumbs,
             });
         },
@@ -211,7 +219,7 @@ async function pluginContentDocs(context, options) {
                 },
             };
             function createMDXLoaderRule() {
-                const contentDirs = versionsMetadata.flatMap(versions_1.getDocsDirPaths);
+                const contentDirs = versionsMetadata.flatMap(utils_1.getContentPathList);
                 return {
                     test: /\.mdx?$/i,
                     include: contentDirs

package/lib/markdown/linkify.js

@@ -7,10 +7,9 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.linkify = void 0;
-const versions_1 = require("../versions");
 const utils_1 = require("@docusaurus/utils");
 function getVersion(filePath, options) {
-    const versionFound = options.versionsMetadata.find((version) => (0, versions_1.getDocsDirPaths)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
+    const versionFound = options.versionsMetadata.find((version) => (0, utils_1.getContentPathList)(version).some((docsDirPath) => filePath.startsWith(docsDirPath)));
     // At this point, this should never happen, because the MDX loaders' paths are
     // literally using the version content paths; but if we allow sourcing content
     // from outside the docs directory (through the `include` option, for example;

package/lib/props.d.ts

@@ -4,12 +4,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import type { LoadedVersion, VersionTag, DocMetadata } from './types';
-import type { PropSidebars, PropVersionMetadata, PropTagDocList } from '@docusaurus/plugin-content-docs';
+import type { VersionTag } from './types';
+import type { PropSidebars, PropVersionMetadata, PropTagDocList, DocMetadata, LoadedVersion } from '@docusaurus/plugin-content-docs';
 export declare function toSidebarsProp(loadedVersion: LoadedVersion): PropSidebars;
 export declare function toVersionMetadataProp(pluginId: string, loadedVersion: LoadedVersion): PropVersionMetadata;
 export declare function toTagDocListProp({ allTagsPath, tag, docs, }: {
     allTagsPath: string;
     tag: VersionTag;
-    docs: Pick<DocMetadata, 'id' | 'title' | 'description' | 'permalink'>[];
+    docs: DocMetadata[];
 }): PropTagDocList;

package/lib/props.js

@@ -81,10 +81,10 @@ function toVersionMetadataProp(pluginId, loadedVersion) {
     return {
         pluginId,
         version: loadedVersion.versionName,
-        label: loadedVersion.versionLabel,
-        banner: loadedVersion.versionBanner,
-        badge: loadedVersion.versionBadge,
-        className: loadedVersion.versionClassName,
+        label: loadedVersion.label,
+        banner: loadedVersion.banner,
+        badge: loadedVersion.badge,
+        className: loadedVersion.className,
         isLast: loadedVersion.isLast,
         docsSidebars: toSidebarsProp(loadedVersion),
         docs: toVersionDocsProp(loadedVersion),
@@ -104,10 +104,11 @@ function toTagDocListProp({ allTagsPath, tag, docs, }) {
         }));
     }
     return {
-        name: tag.name,
+        label: tag.label,
         permalink: tag.permalink,
-        docs: toDocListProp(),
         allTagsPath,
+        count: tag.docIds.length,
+        items: toDocListProp(),
     };
 }
 exports.toTagDocListProp = toTagDocListProp;

package/lib/routes.d.ts

@@ -5,9 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
-import type { DocMetadata, LoadedVersion } from './types';
+import type { FullVersion } from './types';
+import type { DocMetadata } from '@docusaurus/plugin-content-docs';
 export declare function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }: {
-    version: LoadedVersion;
+    version: FullVersion;
     actions: PluginContentLoadedActions;
     docCategoryGeneratedIndexComponent: string;
     aliasedSource: (str: string) => string;
@@ -17,8 +18,8 @@ export declare function createDocRoutes({ docs, actions, docItemComponent, }: {
     actions: PluginContentLoadedActions;
     docItemComponent: string;
 }): Promise<RouteConfig[]>;
-export declare function createVersionRoutes({ loadedVersion, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }: {
-    loadedVersion: LoadedVersion;
+export declare function createVersionRoutes({ version, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }: {
+    version: FullVersion;
     actions: PluginContentLoadedActions;
     docLayoutComponent: string;
     docItemComponent: string;

package/lib/routes.js

@@ -14,23 +14,11 @@ const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
 async function createCategoryGeneratedIndexRoutes({ version, actions, docCategoryGeneratedIndexComponent, aliasedSource, }) {
     const slugs = (0, utils_1.createSlugger)();
     async function createCategoryGeneratedIndexRoute(categoryGeneratedIndex) {
-        const { sidebar, title, description, slug, permalink, previous, next, image, keywords, } = categoryGeneratedIndex;
-        const propFileName = slugs.slug(`${version.versionPath}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
-        const prop = {
-            title,
-            description,
-            slug,
-            permalink,
-            image,
-            keywords,
-            navigation: {
-                previous,
-                next,
-            },
-        };
+        const { sidebar, ...prop } = categoryGeneratedIndex;
+        const propFileName = slugs.slug(`${version.path}-${categoryGeneratedIndex.sidebar}-category-${categoryGeneratedIndex.title}`);
         const propData = await actions.createData(`${(0, utils_1.docuHash)(`category/${propFileName}`)}.json`, JSON.stringify(prop, null, 2));
         return {
-            path: permalink,
+            path: categoryGeneratedIndex.permalink,
             component: docCategoryGeneratedIndexComponent,
             exact: true,
             modules: {
@@ -68,8 +56,8 @@ async function createDocRoutes({ docs, actions, docItemComponent, }) {
     }));
 }
 exports.createDocRoutes = createDocRoutes;
-async function createVersionRoutes({ loadedVersion, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }) {
-    async function doCreateVersionRoutes(version) {
+async function createVersionRoutes({ version, actions, docItemComponent, docLayoutComponent, docCategoryGeneratedIndexComponent, pluginId, aliasedSource, }) {
+    async function doCreateVersionRoutes() {
         const versionMetadata = (0, props_1.toVersionMetadataProp)(pluginId, version);
         const versionMetadataPropPath = await actions.createData(`${(0, utils_1.docuHash)(`version-${version.versionName}-metadata-prop`)}.json`, JSON.stringify(versionMetadata, null, 2));
         async function createVersionSubRoutes() {
@@ -86,12 +74,10 @@ async function createVersionRoutes({ loadedVersion, actions, docItemComponent, d
             return routes.sort((a, b) => a.path.localeCompare(b.path));
         }
         actions.addRoute({
-            path: version.versionPath,
-            // allow matching /docs/* as well
+            path: version.path,
+            // Allow matching /docs/* since this is the wrapping route
             exact: false,
-            // main docs component (DocPage)
             component: docLayoutComponent,
-            // sub-routes for each doc
             routes: await createVersionSubRoutes(),
             modules: {
                 versionMetadata: aliasedSource(versionMetadataPropPath),
@@ -100,10 +86,10 @@ async function createVersionRoutes({ loadedVersion, actions, docItemComponent, d
         });
     }
     try {
-        return await doCreateVersionRoutes(loadedVersion);
+        return await doCreateVersionRoutes();
     }
     catch (err) {
-        logger_1.default.error `Can't create version routes for version name=${loadedVersion.versionName}`;
+        logger_1.default.error `Can't create version routes for version name=${version.versionName}`;
         throw err;
     }
 }

package/lib/server-export.d.ts

@@ -5,4 +5,5 @@
  * LICENSE file in the root directory of this source tree.
  */
 export { CURRENT_VERSION_NAME, VERSIONED_DOCS_DIR, VERSIONED_SIDEBARS_DIR, VERSIONS_JSON_FILE, } from './constants';
-export { filterVersions, getDefaultVersionBanner, getVersionBadge, getVersionBanner, getVersionsFilePath, readVersionsFile, readVersionNames, } from './versions';
+export { filterVersions, getDefaultVersionBanner, getVersionBadge, getVersionBanner, } from './versions';
+export { readVersionNames } from './versions/files';

package/lib/server-export.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionBanner = exports.getVersionBadge = exports.getDefaultVersionBanner = exports.filterVersions = exports.VERSIONS_JSON_FILE = exports.VERSIONED_SIDEBARS_DIR = exports.VERSIONED_DOCS_DIR = exports.CURRENT_VERSION_NAME = void 0;
+exports.readVersionNames = exports.getVersionBanner = exports.getVersionBadge = exports.getDefaultVersionBanner = exports.filterVersions = exports.VERSIONS_JSON_FILE = exports.VERSIONED_SIDEBARS_DIR = exports.VERSIONED_DOCS_DIR = exports.CURRENT_VERSION_NAME = void 0;
 // APIs available to Node.js
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "CURRENT_VERSION_NAME", { enumerable: true, get: function () { return constants_1.CURRENT_VERSION_NAME; } });
@@ -18,6 +18,5 @@ Object.defineProperty(exports, "filterVersions", { enumerable: true, get: functi
 Object.defineProperty(exports, "getDefaultVersionBanner", { enumerable: true, get: function () { return versions_1.getDefaultVersionBanner; } });
 Object.defineProperty(exports, "getVersionBadge", { enumerable: true, get: function () { return versions_1.getVersionBadge; } });
 Object.defineProperty(exports, "getVersionBanner", { enumerable: true, get: function () { return versions_1.getVersionBanner; } });
-Object.defineProperty(exports, "getVersionsFilePath", { enumerable: true, get: function () { return versions_1.getVersionsFilePath; } });
-Object.defineProperty(exports, "readVersionsFile", { enumerable: true, get: function () { return versions_1.readVersionsFile; } });
-Object.defineProperty(exports, "readVersionNames", { enumerable: true, get: function () { return versions_1.readVersionNames; } });
+var files_1 = require("./versions/files");
+Object.defineProperty(exports, "readVersionNames", { enumerable: true, get: function () { return files_1.readVersionNames; } });

package/lib/sidebars/generator.js

@@ -41,9 +41,9 @@ Available doc IDs:
             return (
             // Doc at the root of the autogenerated sidebar dir
             doc.sourceDirName === autogenDir ||
-                // autogen dir is . and doc is in subfolder
+                // Autogen dir is . and doc is in subfolder
                 autogenDir === '.' ||
-                // autogen dir is not . and doc is in subfolder
+                // Autogen dir is not . and doc is in subfolder
                 // "api/myDoc" startsWith "api/" (note "api2/myDoc" is not included)
                 doc.sourceDirName.startsWith((0, utils_1.addTrailingSlash)(autogenDir)));
         }
@@ -104,7 +104,7 @@ Available doc IDs:
             };
         }
         function createCategoryItem(dir, fullPath, folderName) {
-            const categoryMetadata = categoriesMetadata[(0, utils_1.posixPath)(path_1.default.join(autogenDir, fullPath))];
+            const categoryMetadata = categoriesMetadata[path_1.default.posix.join(autogenDir, fullPath)];
             const allItems = Object.entries(dir).map(([key, content]) => dirToItem(content, key, `${fullPath}/${key}`));
             // Try to match a doc inside the category folder,
             // using the "local id" (myDoc) or "qualified id" (dirName/myDoc)

package/lib/sidebars/index.js

@@ -30,7 +30,6 @@ exports.DefaultSidebars = {
 };
 exports.DisabledSidebars = {};
 // If a path is provided, make it absolute
-// use this before loadSidebars()
 function resolveSidebarPathOption(siteDir, sidebarPathOption) {
     return sidebarPathOption
         ? path_1.default.resolve(siteDir, sidebarPathOption)
@@ -76,7 +75,6 @@ async function loadSidebarsFileUnsafe(sidebarFilePath) {
     return (0, import_fresh_1.default)(sidebarFilePath);
 }
 exports.loadSidebarsFileUnsafe = loadSidebarsFileUnsafe;
-// Note: sidebarFilePath must be absolute, use resolveSidebarPathOption
 async function loadSidebars(sidebarFilePath, options) {
     try {
         const sidebarsConfig = await loadSidebarsFileUnsafe(sidebarFilePath);

package/lib/sidebars/normalization.js

@@ -42,7 +42,7 @@ function normalizeItem(item) {
 exports.normalizeItem = normalizeItem;
 function normalizeSidebar(sidebar, place) {
     if (!Array.isArray(sidebar) && !(0, utils_1.isCategoriesShorthand)(sidebar)) {
-        throw new Error(logger_1.default.interpolate `Invalid sidebar items collection code=${JSON.stringify(sidebar)} in ${place}: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a code=${'type'} property). See path=${'https://docusaurus.io/docs/sidebar/items'} for all valid syntaxes.`);
+        throw new Error(logger_1.default.interpolate `Invalid sidebar items collection code=${JSON.stringify(sidebar)} in ${place}: it must either be an array of sidebar items or a shorthand notation (which doesn't contain a code=${'type'} property). See url=${'https://docusaurus.io/docs/sidebar/items'} for all valid syntaxes.`);
     }
     const normalizedSidebar = Array.isArray(sidebar)
         ? sidebar

package/lib/sidebars/postProcessor.js

@@ -12,10 +12,10 @@ const utils_1 = require("@docusaurus/utils");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 function normalizeCategoryLink(category, params) {
     if (category.link?.type === 'generated-index') {
-        // default slug logic can be improved
+        // Default slug logic can be improved
         const getDefaultSlug = () => `/category/${params.categoryLabelSlugger.slug(category.label)}`;
         const slug = category.link.slug ?? getDefaultSlug();
-        const permalink = (0, utils_1.normalizeUrl)([params.version.versionPath, slug]);
+        const permalink = (0, utils_1.normalizeUrl)([params.version.path, slug]);
         return {
             ...category.link,
             slug,

package/lib/sidebars/processor.js

@@ -30,7 +30,7 @@ function toSidebarItemsGeneratorVersion(version) {
 // Handle the generation of autogenerated sidebar items and other
 // post-processing checks
 async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
-    const { sidebarItemsGenerator, numberPrefixParser, docs, version } = params;
+    const { sidebarItemsGenerator, numberPrefixParser, docs, drafts, version } = params;
     // Just a minor lazy transformation optimization
     const getSidebarItemsGeneratorDocsAndVersion = lodash_1.default.memoize(() => ({
         docs: docs.map(toSidebarItemsGeneratorDoc),
@@ -51,12 +51,23 @@ async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
         // more autogenerated items, or when loop count (e.g. 10) is reached
         return processItems(generatedItems);
     }
+    const draftIds = new Set(drafts.flatMap(docs_1.getDocIds));
+    const isDraftItem = (item) => {
+        if (item.type === 'doc' || item.type === 'ref') {
+            return draftIds.has(item.id);
+        }
+        // If a category only contains draft items, it should be filtered entirely.
+        if (item.type === 'category') {
+            return item.items.every(isDraftItem);
+        }
+        return false;
+    };
     async function processItem(item) {
         if (item.type === 'category') {
             return [
                 {
                     ...item,
-                    items: (await Promise.all(item.items.map(processItem))).flat(),
+                    items: await processItems(item.items),
                 },
             ];
         }
@@ -66,7 +77,7 @@ async function processSidebar(unprocessedSidebar, categoriesMetadata, params) {
         return [item];
     }
     async function processItems(items) {
-        return (await Promise.all(items.map(processItem))).flat();
+        return (await Promise.all(items.filter((i) => !isDraftItem(i)).map(processItem))).flat();
     }
     const processedSidebar = await processItems(unprocessedSidebar);
     return processedSidebar;

package/lib/sidebars/types.d.ts

@@ -5,8 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 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 { NumberPrefixParser, SidebarOptions, CategoryIndexMatcher, DocMetadataBase, VersionMetadata } from '@docusaurus/plugin-content-docs';
 import type { Slugger } from '@docusaurus/utils';
 declare type Expand<T extends {
     [x: string]: unknown;
@@ -126,15 +125,6 @@ export declare type PropSidebars = {
     [sidebarId: string]: PropSidebar;
 };
 export declare type PropSidebarBreadcrumbsItem = PropSidebarItemLink | PropSidebarItemCategory;
-export declare type PropVersionDoc = {
-    id: string;
-    title: string;
-    description?: string;
-    sidebar?: string;
-};
-export declare type PropVersionDocs = {
-    [docId: string]: PropVersionDoc;
-};
 export declare type CategoryMetadataFile = {
     label?: string;
     position?: number;
@@ -149,24 +139,38 @@ export declare type CategoryMetadataFile = {
 export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'title' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;
 export declare type SidebarItemsGeneratorArgs = {
+    /** The sidebar item with type "autogenerated" to be transformed. */
     item: SidebarItemAutogenerated;
+    /** Useful metadata for the version this sidebar belongs to. */
     version: SidebarItemsGeneratorVersion;
+    /** All the docs of that version (unfiltered). */
     docs: SidebarItemsGeneratorDoc[];
+    /** Number prefix parser configured for this plugin. */
     numberPrefixParser: NumberPrefixParser;
+    /** The default category index matcher which you can override. */
     isCategoryIndex: CategoryIndexMatcher;
+    /**
+     * Key is the path relative to the doc content directory, value is the
+     * category metadata file's content.
+     */
     categoriesMetadata: {
         [filePath: string]: CategoryMetadataFile;
     };
 };
 export declare type SidebarItemsGenerator = (generatorArgs: SidebarItemsGeneratorArgs) => Promise<NormalizedSidebar>;
-export declare type SidebarItemsGeneratorOptionArgs = {
+export declare type SidebarItemsGeneratorOption = (generatorArgs: {
+    /**
+     * Useful to re-use/enhance the default sidebar generation logic from
+     * Docusaurus.
+     * @see https://github.com/facebook/docusaurus/issues/4640#issuecomment-822292320
+     */
     defaultSidebarItemsGenerator: SidebarItemsGenerator;
-} & SidebarItemsGeneratorArgs;
-export declare type SidebarItemsGeneratorOption = (generatorArgs: SidebarItemsGeneratorOptionArgs) => Promise<NormalizedSidebarItem[]>;
+} & SidebarItemsGeneratorArgs) => Promise<NormalizedSidebarItem[]>;
 export declare type SidebarProcessorParams = {
     sidebarItemsGenerator: SidebarItemsGeneratorOption;
     numberPrefixParser: NumberPrefixParser;
     docs: DocMetadataBase[];
+    drafts: DocMetadataBase[];
     version: VersionMetadata;
     categoryLabelSlugger: Slugger;
     sidebarOptions: SidebarOptions;

package/lib/sidebars/utils.d.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { Sidebars, Sidebar, SidebarItem, SidebarItemCategory, SidebarItemLink, SidebarItemDoc, SidebarCategoriesShorthand, SidebarItemConfig, SidebarItemCategoryWithGeneratedIndex, SidebarNavigationItem } from './types';
-import type { DocMetadataBase, DocNavLink } from '../types';
+import type { DocMetadataBase, PropNavigationLink } from '@docusaurus/plugin-content-docs';
 export declare function isCategoriesShorthand(item: SidebarItemConfig): item is SidebarCategoriesShorthand;
 export declare function transformSidebarItems(sidebar: Sidebar, updateFn: (item: SidebarItem) => SidebarItem): Sidebar;
 export declare function collectSidebarDocItems(sidebar: Sidebar): SidebarItemDoc[];
@@ -48,7 +48,7 @@ export declare type SidebarsUtils = {
     checkSidebarsDocIds: (validDocIds: string[], sidebarFilePath: string) => void;
 };
 export declare function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils;
-export declare function toDocNavigationLink(doc: DocMetadataBase): DocNavLink;
+export declare function toDocNavigationLink(doc: DocMetadataBase): PropNavigationLink;
 export declare function toNavigationLink(navigationItem: SidebarNavigationItem | undefined, docsById: {
     [docId: string]: DocMetadataBase;
-}): DocNavLink | undefined;
+}): PropNavigationLink | undefined;

package/lib/slug.d.ts

@@ -4,8 +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 type { DocMetadataBase } from './types';
-import type { NumberPrefixParser } from '@docusaurus/plugin-content-docs';
+import type { NumberPrefixParser, DocMetadataBase } from '@docusaurus/plugin-content-docs';
 export default function getSlug({ baseID, frontMatterSlug, source, sourceDirName, stripDirNumberPrefixes, numberPrefixParser, }: {
     baseID: string;
     frontMatterSlug?: string;

package/lib/tags.d.ts

@@ -4,5 +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 { VersionTags, DocMetadata } from './types';
+import type { VersionTags } from './types';
+import type { DocMetadata } from '@docusaurus/plugin-content-docs';
 export declare function getVersionTags(docs: DocMetadata[]): VersionTags;

package/lib/tags.js

@@ -13,7 +13,7 @@ const lodash_1 = tslib_1.__importDefault(require("lodash"));
 function getVersionTags(docs) {
     const groups = (0, utils_1.groupTaggedItems)(docs, (doc) => doc.tags);
     return lodash_1.default.mapValues(groups, (group) => ({
-        name: group.tag.label,
+        label: group.tag.label,
         docIds: group.items.map((item) => item.id),
         permalink: group.tag.permalink,
     }));

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 type { LoadedContent } from './types';
-import type { TranslationFile, TranslationFiles } from '@docusaurus/types';
-export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFiles;
+import type { LoadedContent } from '@docusaurus/plugin-content-docs';
+import type { TranslationFile } from '@docusaurus/types';
+export declare function getLoadedContentTranslationFiles(loadedContent: LoadedContent): TranslationFile[];
 export declare function translateLoadedContent(loadedContent: LoadedContent, translationFiles: TranslationFile[]): LoadedContent;

package/lib/translations.js

@@ -30,49 +30,6 @@ function getNormalizedSidebarName({ versionName, sidebarName, }) {
     const [, ...rest] = sidebarName.split('/');
     return rest.join('/');
 }
-/*
-// Do we need to translate doc metadata?
-// It seems translating front matter labels is good enough
-function getDocTranslations(doc: DocMetadata): TranslationFileContent {
-  return {
-    [`${doc.unversionedId}.title`]: {
-      message: doc.title,
-      description: `The title for doc with id=${doc.unversionedId}`,
-    },
-    ...(doc.sidebar_label
-      ? {
-          [`${doc.unversionedId}.sidebar_label`]: {
-            message: doc.sidebar_label,
-            description:
-              `The sidebar label for doc with id=${doc.unversionedId}`,
-          },
-        }
-      : undefined),
-  };
-}
-function translateDoc(
-  doc: DocMetadata,
-  docsTranslations: TranslationFileContent,
-): DocMetadata {
-  return {
-    ...doc,
-    title: docsTranslations[`${doc.unversionedId}.title`]?.message ?? doc.title,
-    sidebar_label:
-      docsTranslations[`${doc.unversionedId}.sidebar_label`]?.message ??
-      doc.sidebar_label,
-  };
-}
-
-function getDocsTranslations(version: LoadedVersion): TranslationFileContent {
-  return mergeTranslations(version.docs.map(getDocTranslations));
-}
-function translateDocs(
-  docs: DocMetadata[],
-  docsTranslations: TranslationFileContent,
-): DocMetadata[] {
-  return docs.map((doc) => translateDoc(doc, docsTranslations));
-}
- */
 function getSidebarTranslationFileContent(sidebar, sidebarName) {
     const categories = (0, utils_1.collectSidebarCategories)(sidebar);
     const categoryContent = Object.fromEntries(categories.flatMap((category) => {
@@ -174,21 +131,15 @@ function translateSidebars(version, sidebarsTranslations) {
 function getVersionTranslationFiles(version) {
     const versionTranslations = {
         'version.label': {
-            message: version.versionLabel,
+            message: version.label,
             description: `The label for version ${version.versionName}`,
         },
     };
     const sidebarsTranslations = getSidebarsTranslations(version);
-    // const docsTranslations: TranslationFileContent =
-    //   getDocsTranslations(version);
     return [
         {
             path: getVersionFileName(version.versionName),
-            content: (0, utils_2.mergeTranslations)([
-                versionTranslations,
-                sidebarsTranslations,
-                // docsTranslations,
-            ]),
+            content: (0, utils_2.mergeTranslations)([versionTranslations, sidebarsTranslations]),
         },
     ];
 }
@@ -196,9 +147,8 @@ function translateVersion(version, translationFiles) {
     const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
     return {
         ...version,
-        versionLabel: versionTranslations['version.label']?.message ?? version.versionLabel,
+        label: versionTranslations['version.label']?.message ?? version.label,
         sidebars: translateSidebars(version, versionTranslations),
-        // docs: translateDocs(version.docs, versionTranslations),
     };
 }
 function getVersionsTranslationFiles(versions) {