@docusaurus/plugin-content-blog 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 { BlogContent, BlogPost } from '@docusaurus/plugin-content-blog';
+export declare function createContentHelpers(): {
+    updateContent: (content: BlogContent) => void;
+    sourceToBlogPost: Map<string, BlogPost>;
+    sourceToPermalink: Map<string, string>;
+};

package/lib/contentHelpers.js

@@ -0,0 +1,30 @@
+"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 indexBlogPostsBySource(content) {
+    return new Map(content.blogPosts.map((blogPost) => [blogPost.metadata.source, blogPost]));
+}
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to blog/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 sourceToBlogPost = new Map();
+    const sourceToPermalink = new Map();
+    // Mutable map update :/
+    function updateContent(content) {
+        sourceToBlogPost.clear();
+        sourceToPermalink.clear();
+        indexBlogPostsBySource(content).forEach((value, key) => {
+            sourceToBlogPost.set(key, value);
+            sourceToPermalink.set(key, value.metadata.permalink);
+        });
+    }
+    return { updateContent, sourceToBlogPost, sourceToPermalink };
+}

package/lib/index.js

@@ -20,28 +20,8 @@ const translations_1 = require("./translations");
 const feed_1 = require("./feed");
 const routes_1 = require("./routes");
 const authorsMap_1 = require("./authorsMap");
+const contentHelpers_1 = require("./contentHelpers");
 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;
@@ -69,7 +49,7 @@ async function pluginContentBlog(context, options) {
         filePath: options.authorsMapPath,
         contentPaths,
     });
-    const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+    const contentHelpers = (0, contentHelpers_1.createContentHelpers)();
     async function createBlogMDXLoaderRule() {
         const { admonitions, rehypePlugins, remarkPlugins, recmaPlugins, truncateMarker, beforeDefaultRemarkPlugins, beforeDefaultRehypePlugins, } = options;
         const contentDirs = (0, utils_1.getContentPathList)(contentPaths);
@@ -95,18 +75,22 @@ async function pluginContentBlog(context, options) {
             // For blog posts a title in markdown is always removed
             // Blog posts title are rendered separately
             removeContentTitle: true,
-            // Assets allow to convert some relative images paths to
-            // require() calls
-            // @ts-expect-error: TODO fix typing issue
-            createAssets: ({ frontMatter, metadata, }) => ({
-                image: frontMatter.image,
-                authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-            }),
+            // createAssets converts relative paths to require() calls
+            createAssets: ({ filePath }) => {
+                const blogPost = contentHelpers.sourceToBlogPost.get((0, utils_1.aliasedSitePath)(filePath, siteDir));
+                if (!blogPost) {
+                    throw new Error(`Blog post not found for  filePath=${filePath}`);
+                }
+                return {
+                    image: blogPost.metadata.frontMatter.image,
+                    authorsImageUrls: blogPost.metadata.authors.map((author) => author.imageURL),
+                };
+            },
             markdownConfig: siteConfig.markdown,
             resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
                 const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                     sourceFilePath,
-                    sourceToPermalink: sourceToPermalinkHelper.get(),
+                    sourceToPermalink: contentHelpers.sourceToPermalink,
                     siteDir,
                     contentPaths,
                 });
@@ -235,7 +219,7 @@ async function pluginContentBlog(context, options) {
             };
         },
         async contentLoaded({ content, actions }) {
-            sourceToPermalinkHelper.update(content);
+            contentHelpers.updateContent(content);
             await (0, routes_1.createAllRoutes)({
                 baseUrl,
                 content,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-6064",
+  "version": "0.0.0-6067",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,14 +31,14 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-6064",
-    "@docusaurus/logger": "0.0.0-6064",
-    "@docusaurus/mdx-loader": "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/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",
     "cheerio": "1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -62,5 +62,5 @@
     "@total-typescript/shoehorn": "^0.1.2",
     "tree-node-cli": "^1.6.0"
   },
-  "gitHead": "f9f463e54c7ff8013cb938f94857af8e4bff5a72"
+  "gitHead": "856911a5474e8e907f83438abe5c42d4793e06cb"
 }

package/src/contentHelpers.ts

@@ -0,0 +1,35 @@
+/**
+ * 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 {BlogContent, BlogPost} from '@docusaurus/plugin-content-blog';
+
+function indexBlogPostsBySource(content: BlogContent): Map<string, BlogPost> {
+  return new Map(
+    content.blogPosts.map((blogPost) => [blogPost.metadata.source, blogPost]),
+  );
+}
+
+// TODO this is bad, we should have a better way to do this (new lifecycle?)
+//  The source to blog/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 sourceToBlogPost = new Map<string, BlogPost>();
+  const sourceToPermalink = new Map<string, string>();
+
+  // Mutable map update :/
+  function updateContent(content: BlogContent): void {
+    sourceToBlogPost.clear();
+    sourceToPermalink.clear();
+    indexBlogPostsBySource(content).forEach((value, key) => {
+      sourceToBlogPost.set(key, value);
+      sourceToPermalink.set(key, value.metadata.permalink);
+    });
+  }
+
+  return {updateContent, sourceToBlogPost, sourceToPermalink};
+}

package/src/index.ts

@@ -19,7 +19,6 @@ import {
   getDataFilePath,
   DEFAULT_PLUGIN_ID,
   resolveMarkdownLinkPathname,
-  type SourceToPermalink,
 } from '@docusaurus/utils';
 import {getTagsFilePathsToWatch} from '@docusaurus/utils-validation';
 import {
@@ -40,12 +39,11 @@ import {createBlogFeedFiles, createFeedHtmlHeadTags} from './feed';
 
 import {createAllRoutes} from './routes';
 import {checkAuthorsMapPermalinkCollisions, getAuthorsMap} from './authorsMap';
+import {createContentHelpers} from './contentHelpers';
 import type {BlogContentPaths, BlogMarkdownLoaderOptions} from './types';
 import type {LoadContext, Plugin} from '@docusaurus/types';
 import type {
   PluginOptions,
-  BlogPostFrontMatter,
-  BlogPostMetadata,
   Assets,
   BlogTags,
   BlogContent,
@@ -55,33 +53,6 @@ import type {RuleSetRule, 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,
@@ -128,7 +99,7 @@ export default async function pluginContentBlog(
     contentPaths,
   });
 
-  const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+  const contentHelpers = createContentHelpers();
 
   async function createBlogMDXLoaderRule(): Promise<RuleSetRule> {
     const {
@@ -167,24 +138,26 @@ export default async function pluginContentBlog(
       // For blog posts a title in markdown is always removed
       // Blog posts title are rendered separately
       removeContentTitle: true,
-      // Assets allow to convert some relative images paths to
-      // require() calls
-      // @ts-expect-error: TODO fix typing issue
-      createAssets: ({
-        frontMatter,
-        metadata,
-      }: {
-        frontMatter: BlogPostFrontMatter;
-        metadata: BlogPostMetadata;
-      }): Assets => ({
-        image: frontMatter.image,
-        authorsImageUrls: metadata.authors.map((author) => author.imageURL),
-      }),
+      // createAssets converts relative paths to require() calls
+      createAssets: ({filePath}: {filePath: string}): Assets => {
+        const blogPost = contentHelpers.sourceToBlogPost.get(
+          aliasedSitePath(filePath, siteDir),
+        )!;
+        if (!blogPost) {
+          throw new Error(`Blog post not found for  filePath=${filePath}`);
+        }
+        return {
+          image: blogPost.metadata.frontMatter.image as string,
+          authorsImageUrls: blogPost.metadata.authors.map(
+            (author) => author.imageURL,
+          ),
+        };
+      },
       markdownConfig: siteConfig.markdown,
       resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
         const permalink = resolveMarkdownLinkPathname(linkPathname, {
           sourceFilePath,
-          sourceToPermalink: sourceToPermalinkHelper.get(),
+          sourceToPermalink: contentHelpers.sourceToPermalink,
           siteDir,
           contentPaths,
         });
@@ -352,7 +325,7 @@ export default async function pluginContentBlog(
     },
 
     async contentLoaded({content, actions}) {
-      sourceToPermalinkHelper.update(content);
+      contentHelpers.updateContent(content);
 
       await createAllRoutes({
         baseUrl,