@docusaurus/plugin-content-docs 0.0.0-4904 → 0.0.0-4913

package/lib/globalData.d.ts

@@ -4,6 +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 { LoadedVersion } from './types';
+import type { FullVersion } from './types';
 import type { GlobalVersion } from '@docusaurus/plugin-content-docs/client';
-export declare function toGlobalDataVersion(version: LoadedVersion): GlobalVersion;
+export declare function toGlobalDataVersion(version: FullVersion): GlobalVersion;

package/lib/globalData.js

@@ -9,7 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.toGlobalDataVersion = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
-const utils_1 = require("./sidebars/utils");
+const docs_1 = require("./docs");
 function toGlobalDataDoc(doc) {
     return {
         id: doc.unversionedId,
@@ -25,9 +25,8 @@ function toGlobalDataGeneratedIndex(doc) {
     };
 }
 function toGlobalSidebars(sidebars, version) {
-    const { getFirstLink } = (0, utils_1.createSidebarsUtils)(sidebars);
     return lodash_1.default.mapValues(sidebars, (sidebar, sidebarId) => {
-        const firstLink = getFirstLink(sidebarId);
+        const firstLink = version.sidebarsUtils.getFirstLink(sidebarId);
         if (!firstLink) {
             return {};
         }
@@ -47,7 +46,7 @@ function toGlobalDataVersion(version) {
         label: version.label,
         isLast: version.isLast,
         path: version.path,
-        mainDocId: version.mainDocId,
+        mainDocId: (0, docs_1.getMainDocId)(version),
         docs: version.docs
             .map(toGlobalDataDoc)
             .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),

package/lib/index.js

@@ -18,12 +18,12 @@ 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;
@@ -108,11 +108,6 @@ async function pluginContentDocs(context, options) {
                     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) {
@@ -135,6 +130,17 @@ 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
@@ -177,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,
@@ -187,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,
             });
         },

package/lib/routes.d.ts

@@ -5,10 +5,10 @@
  * LICENSE file in the root directory of this source tree.
  */
 import type { PluginContentLoadedActions, RouteConfig } from '@docusaurus/types';
-import type { 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;
@@ -18,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

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

@@ -8,6 +8,7 @@ import type { Sidebars } from './sidebars/types';
 import type { BrokenMarkdownLink } from '@docusaurus/utils';
 import type { VersionMetadata, LastUpdateData, DocMetadata, CategoryGeneratedIndexMetadata } from '@docusaurus/plugin-content-docs';
 import type { Tag } from '@docusaurus/types';
+import type { SidebarsUtils } from './sidebars/utils';
 export declare type DocFile = {
     contentPath: string;
     filePath: string;
@@ -26,15 +27,17 @@ export declare type VersionTags = {
     [permalink: string]: VersionTag;
 };
 export declare type LoadedVersion = VersionMetadata & {
-    mainDocId: string;
     docs: DocMetadata[];
     drafts: DocMetadata[];
     sidebars: Sidebars;
-    categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 export declare type LoadedContent = {
     loadedVersions: LoadedVersion[];
 };
+export declare type FullVersion = LoadedVersion & {
+    sidebarsUtils: SidebarsUtils;
+    categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
+};
 export declare type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
 export declare type DocsMarkdownOption = {
     versionsMetadata: VersionMetadata[];

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-4904",
+  "version": "0.0.0-4913",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
   "exports": {
+    "./src/*": "./src/*",
     "./client": "./lib/client/index.js",
     "./server": "./lib/server-export.js",
     ".": "./lib/index.js"
@@ -24,11 +25,11 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4904",
-    "@docusaurus/logger": "0.0.0-4904",
-    "@docusaurus/mdx-loader": "0.0.0-4904",
-    "@docusaurus/utils": "0.0.0-4904",
-    "@docusaurus/utils-validation": "0.0.0-4904",
+    "@docusaurus/core": "0.0.0-4913",
+    "@docusaurus/logger": "0.0.0-4913",
+    "@docusaurus/mdx-loader": "0.0.0-4913",
+    "@docusaurus/utils": "0.0.0-4913",
+    "@docusaurus/utils-validation": "0.0.0-4913",
     "combine-promises": "^1.1.0",
     "fs-extra": "^10.1.0",
     "import-fresh": "^3.3.0",
@@ -40,8 +41,8 @@
     "webpack": "^5.72.0"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "0.0.0-4904",
-    "@docusaurus/types": "0.0.0-4904",
+    "@docusaurus/module-type-aliases": "0.0.0-4913",
+    "@docusaurus/types": "0.0.0-4913",
     "@types/js-yaml": "^4.0.5",
     "@types/picomatch": "^2.3.0",
     "commander": "^5.1.0",
@@ -57,5 +58,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "a237dd7794660c64330a78c782cf066fae59355c"
+  "gitHead": "1212d635d4fde3ae7f92786802f64a2efdc3e3a0"
 }

package/src/globalData.ts

@@ -7,8 +7,8 @@
 
 import _ from 'lodash';
 import type {Sidebars} from './sidebars/types';
-import {createSidebarsUtils} from './sidebars/utils';
-import type {LoadedVersion} from './types';
+import {getMainDocId} from './docs';
+import type {FullVersion} from './types';
 import type {
   CategoryGeneratedIndexMetadata,
   DocMetadata,
@@ -39,11 +39,10 @@ function toGlobalDataGeneratedIndex(
 
 function toGlobalSidebars(
   sidebars: Sidebars,
-  version: LoadedVersion,
+  version: FullVersion,
 ): {[sidebarId: string]: GlobalSidebar} {
-  const {getFirstLink} = createSidebarsUtils(sidebars);
   return _.mapValues(sidebars, (sidebar, sidebarId) => {
-    const firstLink = getFirstLink(sidebarId);
+    const firstLink = version.sidebarsUtils.getFirstLink(sidebarId);
     if (!firstLink) {
       return {};
     }
@@ -62,13 +61,13 @@ function toGlobalSidebars(
   });
 }
 
-export function toGlobalDataVersion(version: LoadedVersion): GlobalVersion {
+export function toGlobalDataVersion(version: FullVersion): GlobalVersion {
   return {
     name: version.versionName,
     label: version.label,
     isLast: version.isLast,
     path: version.path,
-    mainDocId: version.mainDocId,
+    mainDocId: getMainDocId(version),
     docs: version.docs
       .map(toGlobalDataDoc)
       .concat(version.categoryGeneratedIndices.map(toGlobalDataGeneratedIndex)),

package/src/index.ts

@@ -23,12 +23,7 @@ import type {LoadContext, Plugin} from '@docusaurus/types';
 import {loadSidebars, resolveSidebarPathOption} from './sidebars';
 import {CategoryMetadataFilenamePattern} from './sidebars/generator';
 import type {DocEnv} from './docs';
-import {
-  readVersionDocs,
-  processDocMetadata,
-  addDocNavigation,
-  getMainDocId,
-} from './docs';
+import {readVersionDocs, processDocMetadata, addDocNavigation} from './docs';
 import {readVersionsMetadata} from './versions';
 import type {
   LoadedContent,
@@ -37,12 +32,14 @@ import type {
   DocFile,
   DocsMarkdownOption,
   VersionTag,
+  FullVersion,
 } from './types';
 import type {RuleSetRule} from 'webpack';
 import {cliDocsVersionCommand} from './cli';
 import {VERSIONS_JSON_FILE} from './constants';
 import {toGlobalDataVersion} from './globalData';
 import {toTagDocListProp} from './props';
+import {getCategoryGeneratedIndexMetadataList} from './categoryGeneratedIndex';
 import {
   translateLoadedContent,
   getLoadedContentTranslationFiles,
@@ -58,7 +55,6 @@ import type {
   DocFrontMatter,
 } from '@docusaurus/plugin-content-docs';
 import {createSidebarsUtils} from './sidebars/utils';
-import {getCategoryGeneratedIndexMetadataList} from './categoryGeneratedIndex';
 import _ from 'lodash';
 
 export default async function pluginContentDocs(
@@ -188,11 +184,6 @@ export default async function pluginContentDocs(
           ),
           drafts,
           sidebars,
-          mainDocId: getMainDocId({docs, sidebarsUtils}),
-          categoryGeneratedIndices: getCategoryGeneratedIndexMetadataList({
-            docs,
-            sidebarsUtils,
-          }),
         };
       }
 
@@ -223,8 +214,19 @@ export default async function pluginContentDocs(
         breadcrumbs,
       } = options;
       const {addRoute, createData, setGlobalData} = actions;
+      const versions: FullVersion[] = loadedVersions.map((version) => {
+        const sidebarsUtils = createSidebarsUtils(version.sidebars);
+        return {
+          ...version,
+          sidebarsUtils,
+          categoryGeneratedIndices: getCategoryGeneratedIndexMetadataList({
+            docs: version.docs,
+            sidebarsUtils,
+          }),
+        };
+      });
 
-      async function createVersionTagsRoutes(version: LoadedVersion) {
+      async function createVersionTagsRoutes(version: FullVersion) {
         const versionTags = getVersionTags(version.docs);
 
         // TODO tags should be a sub route of the version route
@@ -280,9 +282,9 @@ export default async function pluginContentDocs(
       }
 
       await Promise.all(
-        loadedVersions.map((loadedVersion) =>
+        versions.map((version) =>
           createVersionRoutes({
-            loadedVersion,
+            version,
             docItemComponent,
             docLayoutComponent,
             docCategoryGeneratedIndexComponent,
@@ -294,11 +296,11 @@ export default async function pluginContentDocs(
       );
 
       // 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: normalizeUrl([baseUrl, options.routeBasePath]),
-        versions: loadedVersions.map(toGlobalDataVersion),
+        versions: versions.map(toGlobalDataVersion),
         breadcrumbs,
       });
     },

package/src/routes.ts

@@ -7,7 +7,7 @@
 
 import type {PluginContentLoadedActions, RouteConfig} from '@docusaurus/types';
 import {docuHash, createSlugger} from '@docusaurus/utils';
-import type {LoadedVersion} from './types';
+import type {FullVersion} from './types';
 import type {
   CategoryGeneratedIndexMetadata,
   DocMetadata,
@@ -21,7 +21,7 @@ export async function createCategoryGeneratedIndexRoutes({
   docCategoryGeneratedIndexComponent,
   aliasedSource,
 }: {
-  version: LoadedVersion;
+  version: FullVersion;
   actions: PluginContentLoadedActions;
   docCategoryGeneratedIndexComponent: string;
   aliasedSource: (str: string) => string;
@@ -99,7 +99,7 @@ export async function createDocRoutes({
 }
 
 export async function createVersionRoutes({
-  loadedVersion,
+  version,
   actions,
   docItemComponent,
   docLayoutComponent,
@@ -107,7 +107,7 @@ export async function createVersionRoutes({
   pluginId,
   aliasedSource,
 }: {
-  loadedVersion: LoadedVersion;
+  version: FullVersion;
   actions: PluginContentLoadedActions;
   docLayoutComponent: string;
   docItemComponent: string;
@@ -115,7 +115,7 @@ export async function createVersionRoutes({
   pluginId: string;
   aliasedSource: (str: string) => string;
 }): Promise<void> {
-  async function doCreateVersionRoutes(version: LoadedVersion): Promise<void> {
+  async function doCreateVersionRoutes(): Promise<void> {
     const versionMetadata = toVersionMetadataProp(pluginId, version);
     const versionMetadataPropPath = await actions.createData(
       `${docuHash(`version-${version.versionName}-metadata-prop`)}.json`,
@@ -151,9 +151,9 @@ export async function createVersionRoutes({
   }
 
   try {
-    return await doCreateVersionRoutes(loadedVersion);
+    return await doCreateVersionRoutes();
   } catch (err) {
-    logger.error`Can't create version routes for version name=${loadedVersion.versionName}`;
+    logger.error`Can't create version routes for version name=${version.versionName}`;
     throw err;
   }
 }

package/src/types.ts

@@ -16,6 +16,7 @@ import type {
   CategoryGeneratedIndexMetadata,
 } from '@docusaurus/plugin-content-docs';
 import type {Tag} from '@docusaurus/types';
+import type {SidebarsUtils} from './sidebars/utils';
 
 export type DocFile = {
   contentPath: string; // /!\ may be localized
@@ -38,17 +39,20 @@ export type VersionTags = {
 };
 
 export type LoadedVersion = VersionMetadata & {
-  mainDocId: string;
   docs: DocMetadata[];
   drafts: DocMetadata[];
   sidebars: Sidebars;
-  categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
 };
 
 export type LoadedContent = {
   loadedVersions: LoadedVersion[];
 };
 
+export type FullVersion = LoadedVersion & {
+  sidebarsUtils: SidebarsUtils;
+  categoryGeneratedIndices: CategoryGeneratedIndexMetadata[];
+};
+
 export type DocBrokenMarkdownLink = BrokenMarkdownLink<VersionMetadata>;
 
 export type DocsMarkdownOption = {