@docusaurus/plugin-content-docs 0.0.0-4679 → 0.0.0-4683

package/lib/categoryGeneratedIndex.js

@@ -11,9 +11,6 @@ const utils_1 = require("./sidebars/utils");
 const docs_1 = require("./docs");
 function getCategoryGeneratedIndexMetadata({ category, sidebarsUtils, docsById, }) {
     const { sidebarName, previous, next } = sidebarsUtils.getCategoryGeneratedIndexNavigation(category.link.permalink);
-    if (!sidebarName) {
-        throw new Error('unexpected');
-    }
     return {
         title: category.link.title ?? category.label,
         description: category.link.description,

package/lib/sidebars/generator.js

@@ -27,7 +27,9 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
     const getDoc = (docId) => {
         const doc = findDoc(docId);
         if (!doc) {
-            throw new Error(`Can't find any doc with id=${docId}.\nAvailable doc ids:\n- ${Object.keys(docsById).join('\n- ')}`);
+            throw new Error(`Can't find any doc with ID ${docId}.
+Available doc IDs:
+- ${Object.keys(docsById).join('\n- ')}`);
         }
         return doc;
     };

package/lib/sidebars/index.js

@@ -43,7 +43,7 @@ async function readCategoriesMetadata(contentPath) {
     });
     const categoryToFile = lodash_1.default.groupBy(categoryFiles, path_1.default.dirname);
     return (0, combine_promises_1.default)(lodash_1.default.mapValues(categoryToFile, async (files, folder) => {
-        const [filePath] = files;
+        const filePath = files[0];
         if (files.length > 1) {
             logger_1.default.warn `There are more than one category metadata files for path=${folder}: ${files.join(', ')}. The behavior is undetermined.`;
         }

package/lib/sidebars/utils.js

@@ -119,10 +119,10 @@ function createSidebarsUtils(sidebars) {
         if (!sidebarName) {
             return emptySidebarNavigation();
         }
-        if (!sidebarNameToNavigationItems[sidebarName]) {
+        const navigationItems = sidebarNameToNavigationItems[sidebarName];
+        if (!navigationItems) {
             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;
@@ -158,10 +158,7 @@ function createSidebarsUtils(sidebars) {
                 item.link?.type === 'generated-index' &&
                 item.link.permalink === categoryGeneratedIndexPermalink);
         }
-        const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))?.[0];
-        if (!sidebarName) {
-            return emptySidebarNavigation();
-        }
+        const sidebarName = Object.entries(sidebarNameToNavigationItems).find(([, navigationItems]) => navigationItems.find(isCurrentCategoryGeneratedIndexItem))[0];
         const navigationItems = sidebarNameToNavigationItems[sidebarName];
         const currentItemIndex = navigationItems.findIndex(isCurrentCategoryGeneratedIndexItem);
         const { previous, next } = (0, utils_1.getElementsAround)(navigationItems, currentItemIndex);

package/lib/translations.js

@@ -195,10 +195,13 @@ function getVersionTranslationFiles(version) {
     ];
 }
 function translateVersion(version, translationFiles) {
-    const versionTranslations = translationFiles[getVersionFileName(version.versionName)].content;
+    const versionTranslations = translationFiles[getVersionFileName(version.versionName)]?.content;
+    if (!versionTranslations) {
+        return version;
+    }
     return {
         ...version,
-        versionLabel: versionTranslations['version.label']?.message,
+        versionLabel: versionTranslations['version.label']?.message ?? version.versionLabel,
         sidebars: translateSidebars(version, versionTranslations),
         // docs: translateDocs(version.docs, versionTranslations),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4679",
+  "version": "0.0.0-4683",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4679",
-    "@docusaurus/logger": "0.0.0-4679",
-    "@docusaurus/mdx-loader": "0.0.0-4679",
-    "@docusaurus/utils": "0.0.0-4679",
-    "@docusaurus/utils-validation": "0.0.0-4679",
+    "@docusaurus/core": "0.0.0-4683",
+    "@docusaurus/logger": "0.0.0-4683",
+    "@docusaurus/mdx-loader": "0.0.0-4683",
+    "@docusaurus/utils": "0.0.0-4683",
+    "@docusaurus/utils-validation": "0.0.0-4683",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.0.1",
     "import-fresh": "^3.3.0",
@@ -39,8 +39,8 @@
     "webpack": "^5.69.1"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4679",
-    "@docusaurus/types": "0.0.0-4679",
+    "@docusaurus/module-type-aliases": "0.0.0-4683",
+    "@docusaurus/types": "0.0.0-4683",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "446224a0b9b4f91bb8676d85518b5d7af0221044"
+  "gitHead": "57af658e8e5cf53b765ba7267a2b1c062e0bf6a1"
 }

package/src/categoryGeneratedIndex.ts

@@ -21,10 +21,6 @@ function getCategoryGeneratedIndexMetadata({
 }): CategoryGeneratedIndexMetadata {
   const {sidebarName, previous, next} =
     sidebarsUtils.getCategoryGeneratedIndexNavigation(category.link.permalink);
-  if (!sidebarName) {
-    throw new Error('unexpected');
-  }
-
   return {
     title: category.link.title ?? category.label,
     description: category.link.description,
@@ -32,7 +28,7 @@ function getCategoryGeneratedIndexMetadata({
     keywords: category.link.keywords,
     slug: category.link.slug,
     permalink: category.link.permalink,
-    sidebar: sidebarName,
+    sidebar: sidebarName!,
     previous: toNavigationLink(previous, docsById),
     next: toNavigationLink(next, docsById),
   };

package/src/docs.ts

@@ -363,7 +363,7 @@ export function getMainDocId({
           doc.unversionedId === firstDocIdOfFirstSidebar,
       )!;
     }
-    return docs[0];
+    return docs[0]!;
   }
 
   return getMainDoc().unversionedId;

package/src/sidebars/generator.ts

@@ -60,9 +60,9 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
     const doc = findDoc(docId);
     if (!doc) {
       throw new Error(
-        `Can't find any doc with id=${docId}.\nAvailable doc ids:\n- ${Object.keys(
-          docsById,
-        ).join('\n- ')}`,
+        `Can't find any doc with ID ${docId}.
+Available doc IDs:
+- ${Object.keys(docsById).join('\n- ')}`,
       );
     }
     return doc;

package/src/sidebars/index.ts

@@ -49,7 +49,7 @@ async function readCategoriesMetadata(contentPath: string) {
   const categoryToFile = _.groupBy(categoryFiles, path.dirname);
   return combinePromises(
     _.mapValues(categoryToFile, async (files, folder) => {
-      const [filePath] = files;
+      const filePath = files[0]!;
       if (files.length > 1) {
         logger.warn`There are more than one category metadata files for path=${folder}: ${files.join(
           ', ',

package/src/sidebars/utils.ts

@@ -201,12 +201,12 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
     if (!sidebarName) {
       return emptySidebarNavigation();
     }
-    if (!sidebarNameToNavigationItems[sidebarName]) {
+    const navigationItems = sidebarNameToNavigationItems[sidebarName];
+    if (!navigationItems) {
       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;
@@ -258,12 +258,8 @@ export function createSidebarsUtils(sidebars: Sidebars): SidebarsUtils {
     const sidebarName = Object.entries(sidebarNameToNavigationItems).find(
       ([, navigationItems]) =>
         navigationItems.find(isCurrentCategoryGeneratedIndexItem),
-    )?.[0];
-
-    if (!sidebarName) {
-      return emptySidebarNavigation();
-    }
-    const navigationItems = sidebarNameToNavigationItems[sidebarName];
+    )![0];
+    const navigationItems = sidebarNameToNavigationItems[sidebarName]!;
     const currentItemIndex = navigationItems.findIndex(
       isCurrentCategoryGeneratedIndexItem,
     );
@@ -341,7 +337,7 @@ Available document ids are:
     getCategoryGeneratedIndexList,
     getCategoryGeneratedIndexNavigation,
     checkSidebarsDocIds,
-    getFirstLink: (id) => getFirstLink(sidebars[id]),
+    getFirstLink: (id) => getFirstLink(sidebars[id]!),
   };
 }
 

package/src/translations.ts

@@ -274,10 +274,14 @@ function translateVersion(
   translationFiles: Record<string, TranslationFile>,
 ): LoadedVersion {
   const versionTranslations =
-    translationFiles[getVersionFileName(version.versionName)].content;
+    translationFiles[getVersionFileName(version.versionName)]?.content;
+  if (!versionTranslations) {
+    return version;
+  }
   return {
     ...version,
-    versionLabel: versionTranslations['version.label']?.message,
+    versionLabel:
+      versionTranslations['version.label']?.message ?? version.versionLabel,
     sidebars: translateSidebars(version, versionTranslations),
     // docs: translateDocs(version.docs, versionTranslations),
   };

package/src/versions.ts

@@ -464,11 +464,11 @@ Please set the docs "sidebarPath" field in your config file to:
 // "last version" is not a very good concept nor api surface
 function getDefaultLastVersionName(versionNames: string[]) {
   if (versionNames.length === 1) {
-    return versionNames[0];
+    return versionNames[0]!;
   }
   return versionNames.filter(
     (versionName) => versionName !== CURRENT_VERSION_NAME,
-  )[0];
+  )[0]!;
 }
 
 function checkVersionsOptions(