@docusaurus/plugin-content-docs 0.0.0-6064 → 0.0.0-6067

package/lib/contentHelpers.d.ts

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ */
+import type { DocMetadata, LoadedContent } from '@docusaurus/plugin-content-docs';
+export declare function createContentHelpers(): {
+    updateContent: (content: LoadedContent) => void;
+    sourceToDoc: Map<string, DocMetadata>;
+    sourceToPermalink: Map<string, string>;
+};

package/lib/contentHelpers.js

@@ -0,0 +1,31 @@
+"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.createContentHelpers = createContentHelpers;
+function indexDocsBySource(content) {
+    const allDocs = content.loadedVersions.flatMap((v) => v.docs);
+    return new Map(allDocs.map((doc) => [doc.source, doc]));
+}
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to doc/permalink is a mutable map passed to the mdx loader
+//  See https://github.com/facebook/docusaurus/pull/10457
+//  See https://github.com/facebook/docusaurus/pull/10185
+function createContentHelpers() {
+    const sourceToDoc = new Map();
+    const sourceToPermalink = new Map();
+    // Mutable map update :/
+    function updateContent(content) {
+        sourceToDoc.clear();
+        sourceToPermalink.clear();
+        indexDocsBySource(content).forEach((value, key) => {
+            sourceToDoc.set(key, value);
+            sourceToPermalink.set(key, value.permalink);
+        });
+    }
+    return { updateContent, sourceToDoc, sourceToPermalink };
+}

package/lib/index.js

@@ -25,25 +25,7 @@ const globalData_1 = require("./globalData");
 const translations_1 = require("./translations");
 const routes_1 = require("./routes");
 const utils_2 = require("./sidebars/utils");
-// TODO this is bad, we should have a better way to do this (new lifecycle?)
-//  The source to permalink is currently a mutable map passed to the mdx loader
-//  for link resolution
-//  see https://github.com/facebook/docusaurus/pull/10185
-function createSourceToPermalinkHelper() {
-    const sourceToPermalink = new Map();
-    function computeSourceToPermalink(content) {
-        const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-        return new Map(allDocs.map(({ source, permalink }) => [source, permalink]));
-    }
-    // Mutable map update :/
-    function update(content) {
-        sourceToPermalink.clear();
-        computeSourceToPermalink(content).forEach((value, key) => {
-            sourceToPermalink.set(key, value);
-        });
-    }
-    return { get: () => sourceToPermalink, update };
-}
+const contentHelpers_1 = require("./contentHelpers");
 async function pluginContentDocs(context, options) {
     const { siteDir, generatedFilesDir, baseUrl, siteConfig } = context;
     // Mutate options to resolve sidebar path according to siteDir
@@ -58,7 +40,7 @@ async function pluginContentDocs(context, options) {
     const aliasedSource = (source) => `~docs/${(0, utils_1.posixPath)(path_1.default.relative(pluginDataDirRoot, source))}`;
     // TODO env should be injected into all plugins
     const env = process.env.NODE_ENV;
-    const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+    const contentHelpers = (0, contentHelpers_1.createContentHelpers)();
     async function createDocsMDXLoaderRule() {
         const { rehypePlugins, remarkPlugins, recmaPlugins, beforeDefaultRehypePlugins, beforeDefaultRemarkPlugins, } = options;
         const contentDirs = versionsMetadata
@@ -81,8 +63,7 @@ async function pluginContentDocs(context, options) {
                 const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
                 return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
             },
-            // Assets allow to convert some relative images paths to
-            // require(...) calls
+            // createAssets converts relative paths to require() calls
             createAssets: ({ frontMatter }) => ({
                 image: frontMatter.image,
             }),
@@ -91,7 +72,7 @@ async function pluginContentDocs(context, options) {
                 const version = (0, versions_1.getVersionFromSourceFilePath)(sourceFilePath, versionsMetadata);
                 const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                     sourceFilePath,
-                    sourceToPermalink: sourceToPermalinkHelper.get(),
+                    sourceToPermalink: contentHelpers.sourceToPermalink,
                     siteDir,
                     contentPaths: version,
                 });
@@ -221,7 +202,7 @@ async function pluginContentDocs(context, options) {
             return (0, translations_1.translateLoadedContent)(content, translationFiles);
         },
         async contentLoaded({ content, actions }) {
-            sourceToPermalinkHelper.update(content);
+            contentHelpers.updateContent(content);
             const versions = content.loadedVersions.map(versions_1.toFullVersion);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-docs",
-  "version": "0.0.0-6064",
+  "version": "0.0.0-6067",
   "description": "Docs plugin for Docusaurus.",
   "main": "lib/index.js",
   "sideEffects": false,
@@ -35,15 +35,15 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-6064",
-    "@docusaurus/logger": "0.0.0-6064",
-    "@docusaurus/mdx-loader": "0.0.0-6064",
-    "@docusaurus/module-type-aliases": "0.0.0-6064",
-    "@docusaurus/theme-common": "0.0.0-6064",
-    "@docusaurus/types": "0.0.0-6064",
-    "@docusaurus/utils": "0.0.0-6064",
-    "@docusaurus/utils-common": "0.0.0-6064",
-    "@docusaurus/utils-validation": "0.0.0-6064",
+    "@docusaurus/core": "0.0.0-6067",
+    "@docusaurus/logger": "0.0.0-6067",
+    "@docusaurus/mdx-loader": "0.0.0-6067",
+    "@docusaurus/module-type-aliases": "0.0.0-6067",
+    "@docusaurus/theme-common": "0.0.0-6067",
+    "@docusaurus/types": "0.0.0-6067",
+    "@docusaurus/utils": "0.0.0-6067",
+    "@docusaurus/utils-common": "0.0.0-6067",
+    "@docusaurus/utils-validation": "0.0.0-6067",
     "@types/react-router-config": "^5.0.7",
     "combine-promises": "^1.1.0",
     "fs-extra": "^11.1.1",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "f9f463e54c7ff8013cb938f94857af8e4bff5a72"
+  "gitHead": "856911a5474e8e907f83438abe5c42d4793e06cb"
 }

package/src/contentHelpers.ts

@@ -0,0 +1,34 @@
+/**
+ * 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.
+ */
+
+import type {DocMetadata, LoadedContent} from '@docusaurus/plugin-content-docs';
+
+function indexDocsBySource(content: LoadedContent): Map<string, DocMetadata> {
+  const allDocs = content.loadedVersions.flatMap((v) => v.docs);
+  return new Map(allDocs.map((doc) => [doc.source, doc]));
+}
+
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to doc/permalink is a mutable map passed to the mdx loader
+//  See https://github.com/facebook/docusaurus/pull/10457
+//  See https://github.com/facebook/docusaurus/pull/10185
+export function createContentHelpers() {
+  const sourceToDoc = new Map<string, DocMetadata>();
+  const sourceToPermalink = new Map<string, string>();
+
+  // Mutable map update :/
+  function updateContent(content: LoadedContent): void {
+    sourceToDoc.clear();
+    sourceToPermalink.clear();
+    indexDocsBySource(content).forEach((value, key) => {
+      sourceToDoc.set(key, value);
+      sourceToPermalink.set(key, value.permalink);
+    });
+  }
+
+  return {updateContent, sourceToDoc, sourceToPermalink};
+}

package/src/index.ts

@@ -19,7 +19,6 @@ import {
   createSlugger,
   resolveMarkdownLinkPathname,
   DEFAULT_PLUGIN_ID,
-  type SourceToPermalink,
   type TagsFile,
 } from '@docusaurus/utils';
 import {
@@ -54,6 +53,7 @@ import {
 import {createAllRoutes} from './routes';
 import {createSidebarsUtils} from './sidebars/utils';
 
+import {createContentHelpers} from './contentHelpers';
 import type {
   PluginOptions,
   DocMetadataBase,
@@ -66,29 +66,6 @@ import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {DocFile, FullVersion} from './types';
 import type {RuleSetRule} from 'webpack';
 
-// TODO this is bad, we should have a better way to do this (new lifecycle?)
-//  The source to permalink is currently a mutable map passed to the mdx loader
-//  for link resolution
-//  see https://github.com/facebook/docusaurus/pull/10185
-function createSourceToPermalinkHelper() {
-  const sourceToPermalink: SourceToPermalink = new Map();
-
-  function computeSourceToPermalink(content: LoadedContent): SourceToPermalink {
-    const allDocs = content.loadedVersions.flatMap((v) => v.docs);
-    return new Map(allDocs.map(({source, permalink}) => [source, permalink]));
-  }
-
-  // Mutable map update :/
-  function update(content: LoadedContent): void {
-    sourceToPermalink.clear();
-    computeSourceToPermalink(content).forEach((value, key) => {
-      sourceToPermalink.set(key, value);
-    });
-  }
-
-  return {get: () => sourceToPermalink, update};
-}
-
 export default async function pluginContentDocs(
   context: LoadContext,
   options: PluginOptions,
@@ -115,7 +92,7 @@ export default async function pluginContentDocs(
   // TODO env should be injected into all plugins
   const env = process.env.NODE_ENV as DocEnv;
 
-  const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+  const contentHelpers = createContentHelpers();
 
   async function createDocsMDXLoaderRule(): Promise<RuleSetRule> {
     const {
@@ -148,8 +125,7 @@ export default async function pluginContentDocs(
         const aliasedPath = aliasedSitePath(mdxPath, siteDir);
         return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
       },
-      // Assets allow to convert some relative images paths to
-      // require(...) calls
+      // createAssets converts relative paths to require() calls
       createAssets: ({frontMatter}: {frontMatter: DocFrontMatter}) => ({
         image: frontMatter.image,
       }),
@@ -161,7 +137,7 @@ export default async function pluginContentDocs(
         );
         const permalink = resolveMarkdownLinkPathname(linkPathname, {
           sourceFilePath,
-          sourceToPermalink: sourceToPermalinkHelper.get(),
+          sourceToPermalink: contentHelpers.sourceToPermalink,
           siteDir,
           contentPaths: version,
         });
@@ -335,7 +311,7 @@ export default async function pluginContentDocs(
     },
 
     async contentLoaded({content, actions}) {
-      sourceToPermalinkHelper.update(content);
+      contentHelpers.updateContent(content);
 
       const versions: FullVersion[] = content.loadedVersions.map(toFullVersion);