@docusaurus/plugin-content-docs 0.0.0-4677 → 0.0.0-4680

package/lib/sidebars/generator.js

@@ -104,6 +104,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
         function createCategoryItem(dir, fullPath, folderName) {
             const categoryMetadata = categoriesMetadata[(0, utils_1.posixPath)(path_1.default.join(autogenDir, fullPath))];
             const className = categoryMetadata?.className;
+            const customProps = categoryMetadata?.customProps;
             const { filename, numberPrefix } = numberPrefixParser(folderName);
             const allItems = Object.entries(dir).map(([key, content]) => dirToItem(content, key, `${fullPath}/${key}`));
             // Try to match a doc inside the category folder,
@@ -149,6 +150,7 @@ const DefaultSidebarItemsGenerator = async ({ numberPrefixParser, isCategoryInde
                 collapsed: categoryMetadata?.collapsed,
                 position: categoryMetadata?.position ?? numberPrefix,
                 source: folderName,
+                ...(customProps !== undefined && { customProps }),
                 ...(className !== undefined && { className }),
                 items,
                 ...(link && { link }),

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/types.d.ts

@@ -138,6 +138,7 @@ export declare type CategoryMetadataFile = {
     collapsible?: boolean;
     className?: string;
     link?: SidebarItemCategoryLinkConfig | null;
+    customProps?: Record<string, unknown>;
 };
 export declare type SidebarItemsGeneratorDoc = Pick<DocMetadataBase, 'id' | 'unversionedId' | 'frontMatter' | 'source' | 'sourceDirName' | 'sidebarPosition'>;
 export declare type SidebarItemsGeneratorVersion = Pick<VersionMetadata, 'versionName' | 'contentPath'>;

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;

package/lib/sidebars/validation.js

@@ -130,6 +130,7 @@ const categoryMetadataFileSchema = utils_validation_1.Joi.object({
     collapsible: utils_validation_1.Joi.boolean(),
     className: utils_validation_1.Joi.string(),
     link: sidebarItemCategoryLinkSchema,
+    customProps: utils_validation_1.Joi.object().unknown(),
 });
 function validateCategoryMetadataFile(unsafeContent) {
     return utils_validation_1.Joi.attempt(unsafeContent, categoryMetadataFileSchema);

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-4677",
+  "version": "0.0.0-4680",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "exports": {
@@ -23,11 +23,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4677",
-    "@docusaurus/logger": "0.0.0-4677",
-    "@docusaurus/mdx-loader": "0.0.0-4677",
-    "@docusaurus/utils": "0.0.0-4677",
-    "@docusaurus/utils-validation": "0.0.0-4677",
+    "@docusaurus/core": "0.0.0-4680",
+    "@docusaurus/logger": "0.0.0-4680",
+    "@docusaurus/mdx-loader": "0.0.0-4680",
+    "@docusaurus/utils": "0.0.0-4680",
+    "@docusaurus/utils-validation": "0.0.0-4680",
     "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-4677",
-    "@docusaurus/types": "0.0.0-4677",
+    "@docusaurus/module-type-aliases": "0.0.0-4680",
+    "@docusaurus/types": "0.0.0-4680",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "e4f370386120aba552fb9783ac8bcea85bf7fe53"
+  "gitHead": "367835b86a28dea97e2addba03291438a5f813f8"
 }

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

@@ -159,6 +159,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
       const categoryMetadata =
         categoriesMetadata[posixPath(path.join(autogenDir, fullPath))];
       const className = categoryMetadata?.className;
+      const customProps = categoryMetadata?.customProps;
       const {filename, numberPrefix} = numberPrefixParser(folderName);
       const allItems = Object.entries(dir).map(([key, content]) =>
         dirToItem(content, key, `${fullPath}/${key}`),
@@ -219,6 +220,7 @@ export const DefaultSidebarItemsGenerator: SidebarItemsGenerator = async ({
         collapsed: categoryMetadata?.collapsed,
         position: categoryMetadata?.position ?? numberPrefix,
         source: folderName,
+        ...(customProps !== undefined && {customProps}),
         ...(className !== undefined && {className}),
         items,
         ...(link && {link}),

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/types.ts

@@ -216,6 +216,7 @@ export type CategoryMetadataFile = {
   collapsible?: boolean;
   className?: string;
   link?: SidebarItemCategoryLinkConfig | null;
+  customProps?: Record<string, unknown>;
 
   // TODO should we allow "items" here? how would this work? would an
   // "autogenerated" type be allowed?

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

package/src/sidebars/validation.ts

@@ -164,6 +164,7 @@ const categoryMetadataFileSchema = Joi.object<CategoryMetadataFile>({
   collapsible: Joi.boolean(),
   className: Joi.string(),
   link: sidebarItemCategoryLinkSchema,
+  customProps: Joi.object().unknown(),
 });
 
 export function validateCategoryMetadataFile(

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(