@docusaurus/plugin-content-docs 0.0.0-4533 → 0.0.0-4539

package/lib/server/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 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.
+ */
+export * from '../constants';
+export { filterVersions, getDefaultVersionBanner, getVersionBadge, getVersionBanner, getVersionsFilePath, readVersionsFile, readVersionNames, } from '../versions';

package/lib/server/index.js

@@ -0,0 +1,20 @@
+"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.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionBanner = exports.getVersionBadge = exports.getDefaultVersionBanner = exports.filterVersions = void 0;
+const tslib_1 = require("tslib");
+// APIs available to Node.js
+(0, tslib_1.__exportStar)(require("../constants"), exports);
+var versions_1 = require("../versions");
+Object.defineProperty(exports, "filterVersions", { enumerable: true, get: function () { return versions_1.filterVersions; } });
+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; } });

package/lib/sidebars/processor.js

@@ -61,6 +61,32 @@ async function processSidebar(unprocessedSidebar, params) {
     }
     async function processItem(item) {
         if (item.type === 'category') {
+            // If the current category doesn't have subitems, we render a normal doc link instead.
+            if (item.items.length === 0) {
+                if (!item.link) {
+                    throw new Error(`Sidebar category ${item.label} has neither any subitem nor a link. This makes this item not able to link to anything.`);
+                }
+                switch (item.link.type) {
+                    case 'doc':
+                        return [
+                            {
+                                type: 'doc',
+                                label: item.label,
+                                id: item.link.id,
+                            },
+                        ];
+                    case 'generated-index':
+                        return [
+                            {
+                                type: 'link',
+                                label: item.label,
+                                href: item.link.permalink,
+                            },
+                        ];
+                    default:
+                        throw new Error('Unexpected sidebar category link type');
+                }
+            }
             return [await processCategoryItem(item)];
         }
         if (item.type === 'autogenerated') {

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'>;

package/lib/versions.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getDocsDirPaths = exports.readVersionsMetadata = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
+exports.getDocsDirPaths = exports.readVersionsMetadata = exports.filterVersions = exports.getVersionBadge = exports.getVersionBanner = exports.getDefaultVersionBanner = exports.readVersionNames = exports.readVersionsFile = exports.getVersionsFilePath = exports.getVersionedSidebarsDirPath = exports.getVersionedDocsDirPath = void 0;
 const tslib_1 = require("tslib");
 const path_1 = (0, tslib_1.__importDefault)(require("path"));
 const fs_extra_1 = (0, tslib_1.__importDefault)(require("fs-extra"));
@@ -56,6 +56,7 @@ async function readVersionsFile(siteDir, pluginId) {
     }
     return null;
 }
+exports.readVersionsFile = readVersionsFile;
 async function readVersionNames(siteDir, options) {
     const versionFileContent = await readVersionsFile(siteDir, options.id);
     if (!versionFileContent && options.disableVersioning) {
@@ -74,6 +75,7 @@ async function readVersionNames(siteDir, options) {
     }
     return versions;
 }
+exports.readVersionNames = readVersionNames;
 function getDocsDirPathLocalized({ siteDir, locale, pluginId, versionName, }) {
     return (0, utils_1.getPluginI18nPath)({
         siteDir,
@@ -150,6 +152,7 @@ function getDefaultVersionBanner({ versionName, versionNames, lastVersionName, }
     // Older versions: display unmaintained banner
     return 'unmaintained';
 }
+exports.getDefaultVersionBanner = getDefaultVersionBanner;
 function getVersionBanner({ versionName, versionNames, lastVersionName, options, }) {
     var _a;
     const versionBannerOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.banner;
@@ -162,6 +165,7 @@ function getVersionBanner({ versionName, versionNames, lastVersionName, options,
         lastVersionName,
     });
 }
+exports.getVersionBanner = getVersionBanner;
 function getVersionBadge({ versionName, versionNames, options, }) {
     var _a;
     const versionBadgeOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.badge;
@@ -171,6 +175,7 @@ function getVersionBadge({ versionName, versionNames, options, }) {
     const versionBadgeDefault = versionNames.length !== 1;
     return versionBadgeOption !== null && versionBadgeOption !== void 0 ? versionBadgeOption : versionBadgeDefault;
 }
+exports.getVersionBadge = getVersionBadge;
 function getVersionClassName({ versionName, options, }) {
     var _a;
     const versionClassNameOption = (_a = options.versions[versionName]) === null || _a === void 0 ? void 0 : _a.className;
@@ -297,6 +302,7 @@ function filterVersions(versionNamesUnfiltered, options) {
     }
     return versionNamesUnfiltered;
 }
+exports.filterVersions = filterVersions;
 async function readVersionsMetadata({ context, options, }) {
     var _a;
     const versionNamesUnfiltered = await readVersionNames(context.siteDir, options);

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4533",
+  "version": "0.0.0-4539",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
     "./client": "./lib/client/index.js",
+    "./server": "./lib/server/index.js",
     ".": "./lib/index.js"
   },
   "types": "src/plugin-content-docs.d.ts",
@@ -22,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4533",
-    "@docusaurus/logger": "0.0.0-4533",
-    "@docusaurus/mdx-loader": "0.0.0-4533",
-    "@docusaurus/utils": "0.0.0-4533",
-    "@docusaurus/utils-validation": "0.0.0-4533",
+    "@docusaurus/core": "0.0.0-4539",
+    "@docusaurus/logger": "0.0.0-4539",
+    "@docusaurus/mdx-loader": "0.0.0-4539",
+    "@docusaurus/utils": "0.0.0-4539",
+    "@docusaurus/utils-validation": "0.0.0-4539",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.0",
     "import-fresh": "^3.2.2",
@@ -39,8 +40,8 @@
     "webpack": "^5.68.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4533",
-    "@docusaurus/types": "0.0.0-4533",
+    "@docusaurus/module-type-aliases": "0.0.0-4539",
+    "@docusaurus/types": "0.0.0-4539",
     "@types/js-yaml": "^4.0.0",
     "@types/picomatch": "^2.2.1",
     "commander": "^5.1.0",
@@ -56,5 +57,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "5ab127cc566e3d1af8653a162eafbfbd64d0764e"
+  "gitHead": "7b82719906447f76637ad0452ad8df1d9698f805"
 }

package/src/server/index.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+// APIs available to Node.js
+export * from '../constants';
+
+export {
+  filterVersions,
+  getDefaultVersionBanner,
+  getVersionBadge,
+  getVersionBanner,
+  getVersionsFilePath,
+  readVersionsFile,
+  readVersionNames,
+} from '../versions';

package/src/sidebars/processor.ts

@@ -117,6 +117,34 @@ async function processSidebar(
     item: NormalizedSidebarItem,
   ): Promise<SidebarItem[]> {
     if (item.type === 'category') {
+      // If the current category doesn't have subitems, we render a normal doc link instead.
+      if (item.items.length === 0) {
+        if (!item.link) {
+          throw new Error(
+            `Sidebar category ${item.label} has neither any subitem nor a link. This makes this item not able to link to anything.`,
+          );
+        }
+        switch (item.link.type) {
+          case 'doc':
+            return [
+              {
+                type: 'doc',
+                label: item.label,
+                id: item.link.id,
+              },
+            ];
+          case 'generated-index':
+            return [
+              {
+                type: 'link',
+                label: item.label,
+                href: item.link.permalink,
+              },
+            ];
+          default:
+            throw new Error('Unexpected sidebar category link type');
+        }
+      }
       return [await processCategoryItem(item)];
     }
     if (item.type === 'autogenerated') {

package/src/versions.ts

@@ -85,7 +85,7 @@ function ensureValidVersionArray(
   versionArray.forEach(ensureValidVersionString);
 }
 
-async function readVersionsFile(
+export async function readVersionsFile(
   siteDir: string,
   pluginId: string,
 ): Promise<string[] | null> {
@@ -98,7 +98,7 @@ async function readVersionsFile(
   return null;
 }
 
-async function readVersionNames(
+export async function readVersionNames(
   siteDir: string,
   options: Pick<
     PluginOptions,
@@ -257,7 +257,7 @@ function getVersionEditUrls({
   };
 }
 
-function getDefaultVersionBanner({
+export function getDefaultVersionBanner({
   versionName,
   versionNames,
   lastVersionName,
@@ -280,7 +280,7 @@ function getDefaultVersionBanner({
   return 'unmaintained';
 }
 
-function getVersionBanner({
+export function getVersionBanner({
   versionName,
   versionNames,
   lastVersionName,
@@ -302,7 +302,7 @@ function getVersionBanner({
   });
 }
 
-function getVersionBadge({
+export function getVersionBadge({
   versionName,
   versionNames,
   options,
@@ -531,10 +531,10 @@ function checkVersionsOptions(
  * Note: we preserve the order in which versions are provided;
  * the order of the onlyIncludeVersions array does not matter
  */
-function filterVersions(
+export function filterVersions(
   versionNamesUnfiltered: string[],
   options: Pick<PluginOptions, 'onlyIncludeVersions'>,
-) {
+): string[] {
   if (options.onlyIncludeVersions) {
     return versionNamesUnfiltered.filter((name) =>
       (options.onlyIncludeVersions || []).includes(name),