@docusaurus/plugin-content-docs 0.0.0-4788 → 0.0.0-4792

package/package.json

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

package/src/categoryGeneratedIndex.ts

@@ -5,7 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import type {CategoryGeneratedIndexMetadata, DocMetadataBase} from './types';
+import type {
+  CategoryGeneratedIndexMetadata,
+  DocMetadataBase,
+} from '@docusaurus/plugin-content-docs';
 import type {SidebarItemCategoryWithGeneratedIndex} from './sidebars/types';
 import {type SidebarsUtils, toNavigationLink} from './sidebars/utils';
 import {createDocsByIdIndex} from './docs';
@@ -29,8 +32,10 @@ function getCategoryGeneratedIndexMetadata({
     slug: category.link.slug,
     permalink: category.link.permalink,
     sidebar: sidebarName!,
-    previous: toNavigationLink(previous, docsById),
-    next: toNavigationLink(next, docsById),
+    navigation: {
+      previous: toNavigationLink(previous, docsById),
+      next: toNavigationLink(next, docsById),
+    },
   };
 }
 

package/src/docs.ts

@@ -12,6 +12,7 @@ import {
   aliasedSitePath,
   getEditUrl,
   getFolderContainingFile,
+  getContentPathList,
   normalizeUrl,
   parseMarkdownString,
   posixPath,
@@ -21,18 +22,9 @@ import {
 import type {LoadContext} from '@docusaurus/types';
 
 import {getFileLastUpdate} from './lastUpdate';
-import type {
-  DocFile,
-  DocMetadataBase,
-  DocMetadata,
-  DocNavLink,
-  LastUpdateData,
-  VersionMetadata,
-  LoadedVersion,
-} from './types';
+import type {DocFile, LoadedVersion} from './types';
 import getSlug from './slug';
 import {CURRENT_VERSION_NAME} from './constants';
-import {getDocsDirPaths} from './versions';
 import {stripPathNumberPrefixes} from './numberPrefix';
 import {validateDocFrontMatter} from './frontMatter';
 import type {SidebarsUtils} from './sidebars/utils';
@@ -41,7 +33,11 @@ import type {
   MetadataOptions,
   PluginOptions,
   CategoryIndexMatcher,
-  CategoryIndexMatcherParam,
+  DocMetadataBase,
+  DocMetadata,
+  PropNavigationLink,
+  LastUpdateData,
+  VersionMetadata,
 } from '@docusaurus/plugin-content-docs';
 
 type LastUpdateOptions = Pick<
@@ -85,7 +81,7 @@ export async function readDocFile(
   options: LastUpdateOptions,
 ): Promise<DocFile> {
   const contentPath = await getFolderContainingFile(
-    getDocsDirPaths(versionMetadata),
+    getContentPathList(versionMetadata),
     source,
   );
 
@@ -213,7 +209,7 @@ function doProcessDocMetadata({
 
   const description: string = frontMatter.description ?? excerpt ?? '';
 
-  const permalink = normalizeUrl([versionMetadata.versionPath, docSlug]);
+  const permalink = normalizeUrl([versionMetadata.path, docSlug]);
 
   function getDocEditUrl() {
     const relativeFilePath = path.relative(contentPath, filePath);
@@ -232,8 +228,8 @@ function doProcessDocMetadata({
       const isLocalized = contentPath === versionMetadata.contentPathLocalized;
       const baseVersionEditUrl =
         isLocalized && options.editLocalizedFiles
-          ? versionMetadata.versionEditUrlLocalized
-          : versionMetadata.versionEditUrl;
+          ? versionMetadata.editUrlLocalized
+          : versionMetadata.editUrl;
       return getEditUrl(relativeFilePath, baseVersionEditUrl);
     }
     return undefined;
@@ -304,7 +300,7 @@ export function addDocNavigation(
     const toNavigationLinkByDocId = (
       docId: string | null | undefined,
       type: 'prev' | 'next',
-    ): DocNavLink | undefined => {
+    ): PropNavigationLink | undefined => {
       if (!docId) {
         return undefined;
       }
@@ -401,7 +397,7 @@ export function toCategoryIndexMatcherParam({
 }: Pick<
   DocMetadataBase,
   'source' | 'sourceDirName'
->): CategoryIndexMatcherParam {
+>): Parameters<CategoryIndexMatcher>[0] {
   // source + sourceDirName are always posix-style
   return {
     fileName: path.posix.parse(source).name,

package/src/frontMatter.ts

@@ -12,7 +12,7 @@ import {
   FrontMatterTOCHeadingLevels,
   validateFrontMatter,
 } from '@docusaurus/utils-validation';
-import type {DocFrontMatter} from './types';
+import type {DocFrontMatter} from '@docusaurus/plugin-content-docs';
 
 // NOTE: we don't add any default value on purpose here
 // We don't want default values to magically appear in doc metadata and props

package/src/globalData.ts

@@ -8,11 +8,11 @@
 import _ from 'lodash';
 import type {Sidebars} from './sidebars/types';
 import {createSidebarsUtils} from './sidebars/utils';
+import type {LoadedVersion} from './types';
 import type {
   CategoryGeneratedIndexMetadata,
   DocMetadata,
-  LoadedVersion,
-} from './types';
+} from '@docusaurus/plugin-content-docs';
 import type {
   GlobalVersion,
   GlobalSidebar,
@@ -65,9 +65,9 @@ function toGlobalSidebars(
 export function toGlobalDataVersion(version: LoadedVersion): GlobalVersion {
   return {
     name: version.versionName,
-    label: version.versionLabel,
+    label: version.label,
     isLast: version.isLast,
-    path: version.versionPath,
+    path: version.path,
     mainDocId: version.mainDocId,
     docs: version.docs
       .map(toGlobalDataDoc)

package/src/index.ts

@@ -11,6 +11,7 @@ import {
   normalizeUrl,
   docuHash,
   aliasedSitePath,
+  getContentPathList,
   reportMessage,
   posixPath,
   addTrailingPathSeparator,
@@ -27,18 +28,14 @@ import {
   addDocNavigation,
   getMainDocId,
 } from './docs';
-import {getDocsDirPaths, readVersionsMetadata} from './versions';
-
+import {readVersionsMetadata} from './versions';
 import type {
   LoadedContent,
   SourceToPermalink,
-  DocMetadataBase,
-  VersionMetadata,
   LoadedVersion,
   DocFile,
   DocsMarkdownOption,
   VersionTag,
-  DocFrontMatter,
 } from './types';
 import type {RuleSetRule} from 'webpack';
 import {cliDocsVersionCommand} from './cli';
@@ -55,6 +52,9 @@ import {createVersionRoutes} from './routes';
 import type {
   PropTagsListPage,
   PluginOptions,
+  DocMetadataBase,
+  VersionMetadata,
+  DocFrontMatter,
 } from '@docusaurus/plugin-content-docs';
 import {createSidebarsUtils} from './sidebars/utils';
 import {getCategoryGeneratedIndexMetadataList} from './categoryGeneratedIndex';
@@ -114,7 +114,7 @@ export default async function pluginContentDocs(
       function getVersionPathsToWatch(version: VersionMetadata): string[] {
         const result = [
           ...options.include.flatMap((pattern) =>
-            getDocsDirPaths(version).map(
+            getContentPathList(version).map(
               (docsDirPath) => `${docsDirPath}/${pattern}`,
             ),
           ),
@@ -228,7 +228,7 @@ export default async function pluginContentDocs(
           const tagsProp: PropTagsListPage['tags'] = Object.values(
             versionTags,
           ).map((tagValue) => ({
-            name: tagValue.name,
+            name: tagValue.label,
             permalink: tagValue.permalink,
             count: tagValue.docIds.length,
           }));
@@ -331,7 +331,7 @@ export default async function pluginContentDocs(
       };
 
       function createMDXLoaderRule(): RuleSetRule {
-        const contentDirs = versionsMetadata.flatMap(getDocsDirPaths);
+        const contentDirs = versionsMetadata.flatMap(getContentPathList);
         return {
           test: /\.mdx?$/i,
           include: contentDirs

package/src/markdown/linkify.ts

@@ -6,12 +6,11 @@
  */
 
 import type {DocsMarkdownOption} from '../types';
-import {getDocsDirPaths} from '../versions';
-import {replaceMarkdownLinks} from '@docusaurus/utils';
+import {replaceMarkdownLinks, getContentPathList} from '@docusaurus/utils';
 
 function getVersion(filePath: string, options: DocsMarkdownOption) {
   const versionFound = options.versionsMetadata.find((version) =>
-    getDocsDirPaths(version).some((docsDirPath) =>
+    getContentPathList(version).some((docsDirPath) =>
       filePath.startsWith(docsDirPath),
     ),
   );