@docusaurus/plugin-content-blog 0.0.0-5962 → 0.0.0-5963

package/lib/blogUtils.d.ts

@@ -9,9 +9,6 @@ import type { LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
 import type { BlogContentPaths } from './types';
 export declare function truncate(fileString: string, truncateMarker: RegExp): string;
-export declare function getSourceToPermalink(blogPosts: BlogPost[]): {
-    [aliasedPath: string]: string;
-};
 export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }: {
     blogPosts: BlogPost[];
     basePageUrl: string;

package/lib/blogUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyProcessBlogPosts = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
+exports.applyProcessBlogPosts = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -21,10 +21,6 @@ function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
 exports.truncate = truncate;
-function getSourceToPermalink(blogPosts) {
-    return Object.fromEntries(blogPosts.map(({ metadata: { source, permalink } }) => [source, permalink]));
-}
-exports.getSourceToPermalink = getSourceToPermalink;
 function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }) {
     const totalCount = blogPosts.length;
     const postsPerPage = postsPerPageOption === 'ALL' ? totalCount : postsPerPageOption;

package/lib/index.js

@@ -18,6 +18,27 @@ const translations_1 = require("./translations");
 const feed_1 = require("./feed");
 const routes_1 = require("./routes");
 const PluginName = 'docusaurus-plugin-content-blog';
+// 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) {
+        return new Map(content.blogPosts.map(({ metadata: { 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 };
+}
 async function pluginContentBlog(context, options) {
     const { siteDir, siteConfig, generatedFilesDir, localizationDir, i18n: { currentLocale }, } = context;
     const router = siteConfig.future.experimental_router;
@@ -45,6 +66,7 @@ async function pluginContentBlog(context, options) {
         filePath: options.authorsMapPath,
         contentPaths,
     });
+    const sourceToPermalinkHelper = createSourceToPermalinkHelper();
     return {
         name: PluginName,
         getPathsToWatch() {
@@ -126,6 +148,7 @@ async function pluginContentBlog(context, options) {
             };
         },
         async contentLoaded({ content, actions }) {
+            sourceToPermalinkHelper.update(content);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,
                 content,
@@ -137,9 +160,8 @@ async function pluginContentBlog(context, options) {
         translateContent({ content, translationFiles }) {
             return (0, translations_1.translateContent)(content, translationFiles);
         },
-        configureWebpack(_config, isServer, utils, content) {
+        configureWebpack() {
             const { admonitions, rehypePlugins, remarkPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
-            const sourceToPermalink = (0, blogUtils_1.getSourceToPermalink)(content.blogPosts);
             const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
             function createMDXLoader() {
                 const loaderOptions = {
@@ -174,7 +196,7 @@ async function pluginContentBlog(context, options) {
                     resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
                         const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                             sourceFilePath,
-                            sourceToPermalink,
+                            sourceToPermalink: sourceToPermalinkHelper.get(),
                             siteDir,
                             contentPaths,
                         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5962",
+  "version": "0.0.0-5963",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5962",
-    "@docusaurus/logger": "0.0.0-5962",
-    "@docusaurus/mdx-loader": "0.0.0-5962",
-    "@docusaurus/types": "0.0.0-5962",
-    "@docusaurus/utils": "0.0.0-5962",
-    "@docusaurus/utils-common": "0.0.0-5962",
-    "@docusaurus/utils-validation": "0.0.0-5962",
+    "@docusaurus/core": "0.0.0-5963",
+    "@docusaurus/logger": "0.0.0-5963",
+    "@docusaurus/mdx-loader": "0.0.0-5963",
+    "@docusaurus/types": "0.0.0-5963",
+    "@docusaurus/utils": "0.0.0-5963",
+    "@docusaurus/utils-common": "0.0.0-5963",
+    "@docusaurus/utils-validation": "0.0.0-5963",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -59,5 +59,5 @@
   "devDependencies": {
     "@total-typescript/shoehorn": "^0.1.2"
   },
-  "gitHead": "35386a1d384d8e8757ef9f993b84dd5accc00e97"
+  "gitHead": "e9090dc8a38a21043b0849887aa7d54d04c4af9f"
 }

package/src/blogUtils.ts

@@ -45,14 +45,6 @@ export function truncate(fileString: string, truncateMarker: RegExp): string {
   return fileString.split(truncateMarker, 1).shift()!;
 }
 
-export function getSourceToPermalink(blogPosts: BlogPost[]): {
-  [aliasedPath: string]: string;
-} {
-  return Object.fromEntries(
-    blogPosts.map(({metadata: {source, permalink}}) => [source, permalink]),
-  );
-}
-
 export function paginateBlogPosts({
   blogPosts,
   basePageUrl,

package/src/index.ts

@@ -19,10 +19,10 @@ import {
   getDataFilePath,
   DEFAULT_PLUGIN_ID,
   resolveMarkdownLinkPathname,
+  type SourceToPermalink,
 } from '@docusaurus/utils';
 import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation';
 import {
-  getSourceToPermalink,
   getBlogTags,
   paginateBlogPosts,
   shouldBeListed,
@@ -50,6 +50,33 @@ import type {RuleSetUseItem} from 'webpack';
 
 const PluginName = 'docusaurus-plugin-content-blog';
 
+// 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: BlogContent): SourceToPermalink {
+    return new Map(
+      content.blogPosts.map(({metadata: {source, permalink}}) => [
+        source,
+        permalink,
+      ]),
+    );
+  }
+
+  // Mutable map update :/
+  function update(content: BlogContent): void {
+    sourceToPermalink.clear();
+    computeSourceToPermalink(content).forEach((value, key) => {
+      sourceToPermalink.set(key, value);
+    });
+  }
+
+  return {get: () => sourceToPermalink, update};
+}
+
 export default async function pluginContentBlog(
   context: LoadContext,
   options: PluginOptions,
@@ -96,6 +123,8 @@ export default async function pluginContentBlog(
     contentPaths,
   });
 
+  const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+
   return {
     name: PluginName,
 
@@ -201,6 +230,8 @@ export default async function pluginContentBlog(
     },
 
     async contentLoaded({content, actions}) {
+      sourceToPermalinkHelper.update(content);
+
       await createAllRoutes({
         baseUrl,
         content,
@@ -214,7 +245,7 @@ export default async function pluginContentBlog(
       return translateContent(content, translationFiles);
     },
 
-    configureWebpack(_config, isServer, utils, content) {
+    configureWebpack() {
       const {
         admonitions,
         rehypePlugins,
@@ -224,7 +255,6 @@ export default async function pluginContentBlog(
         beforeDefaultRehypePlugins,
       } = options;
 
-      const sourceToPermalink = getSourceToPermalink(content.blogPosts);
       const contentDirs = getContentPathList(contentPaths);
 
       function createMDXLoader(): RuleSetUseItem {
@@ -271,7 +301,7 @@ export default async function pluginContentBlog(
           resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
             const permalink = resolveMarkdownLinkPathname(linkPathname, {
               sourceFilePath,
-              sourceToPermalink,
+              sourceToPermalink: sourceToPermalinkHelper.get(),
               siteDir,
               contentPaths,
             });