@docusaurus/plugin-content-blog 0.0.0-6063 → 0.0.0-6065

package/lib/authors.js

@@ -12,6 +12,7 @@ exports.groupBlogPostsByAuthorKey = groupBlogPostsByAuthorKey;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
+const authorsSocials_1 = require("./authorsSocials");
 function normalizeImageUrl({ imageURL, baseUrl, }) {
     return imageURL?.startsWith('/')
         ? (0, utils_1.normalizeUrl)([baseUrl, imageURL])
@@ -66,7 +67,10 @@ function getFrontMatterAuthors(params) {
                 // becoming a name and may end up unnoticed
                 return { key: authorInput };
             }
-            return authorInput;
+            return {
+                ...authorInput,
+                socials: (0, authorsSocials_1.normalizeSocials)(authorInput.socials ?? {}),
+            };
         }
         return Array.isArray(frontMatter.authors)
             ? frontMatter.authors.map(normalizeAuthor)

package/lib/authorsSocials.js

@@ -27,6 +27,10 @@ const PredefinedPlatformNormalizers = {
 };
 function normalizeSocialEntry([platform, value]) {
     const normalizer = PredefinedPlatformNormalizers[platform.toLowerCase()];
+    if (typeof value !== 'string') {
+        throw new Error(`Author socials should be usernames/userIds/handles, or fully qualified HTTP(s) absolute URLs.
+Social platform '${platform}' has illegal value '${value}'`);
+    }
     const isAbsoluteUrl = value.startsWith('http://') || value.startsWith('https://');
     if (isAbsoluteUrl) {
         return [platform, value];

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);
@@ -90,7 +70,12 @@ async function pluginContentBlog(context, options) {
                 // Note that metadataPath must be the same/in-sync as
                 // the path from createData for each MDX.
                 const aliasedPath = (0, utils_1.aliasedSitePath)(mdxPath, siteDir);
-                return path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
+                const metadataPath = path_1.default.join(dataDir, `${(0, utils_1.docuHash)(aliasedPath)}.json`);
+                const metadataContent = contentHelpers.sourceToBlogPost.get(aliasedPath).metadata;
+                return {
+                    metadataPath,
+                    metadataContent,
+                };
             },
             // For blog posts a title in markdown is always removed
             // Blog posts title are rendered separately
@@ -106,7 +91,7 @@ async function pluginContentBlog(context, options) {
             resolveMarkdownLink: ({ linkPathname, sourceFilePath }) => {
                 const permalink = (0, utils_1.resolveMarkdownLinkPathname)(linkPathname, {
                     sourceFilePath,
-                    sourceToPermalink: sourceToPermalinkHelper.get(),
+                    sourceToPermalink: contentHelpers.sourceToPermalink,
                     siteDir,
                     contentPaths,
                 });
@@ -235,7 +220,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-6063",
+  "version": "0.0.0-6065",
   "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-6063",
-    "@docusaurus/logger": "0.0.0-6063",
-    "@docusaurus/mdx-loader": "0.0.0-6063",
-    "@docusaurus/theme-common": "0.0.0-6063",
-    "@docusaurus/types": "0.0.0-6063",
-    "@docusaurus/utils": "0.0.0-6063",
-    "@docusaurus/utils-common": "0.0.0-6063",
-    "@docusaurus/utils-validation": "0.0.0-6063",
+    "@docusaurus/core": "0.0.0-6065",
+    "@docusaurus/logger": "0.0.0-6065",
+    "@docusaurus/mdx-loader": "0.0.0-6065",
+    "@docusaurus/theme-common": "0.0.0-6065",
+    "@docusaurus/types": "0.0.0-6065",
+    "@docusaurus/utils": "0.0.0-6065",
+    "@docusaurus/utils-common": "0.0.0-6065",
+    "@docusaurus/utils-validation": "0.0.0-6065",
     "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": "d6fbbb85fcb98fd3bf658610f6d7345e5dad2530"
+  "gitHead": "6da713a524315a36515fc3e998ff1551bfa054d2"
 }

package/src/authors.ts

@@ -7,6 +7,7 @@
 
 import _ from 'lodash';
 import {normalizeUrl} from '@docusaurus/utils';
+import {normalizeSocials} from './authorsSocials';
 import type {
   Author,
   AuthorsMap,
@@ -107,7 +108,10 @@ function getFrontMatterAuthors(params: AuthorsParam): Author[] {
         // becoming a name and may end up unnoticed
         return {key: authorInput};
       }
-      return authorInput;
+      return {
+        ...authorInput,
+        socials: normalizeSocials(authorInput.socials ?? {}),
+      };
     }
 
     return Array.isArray(frontMatter.authors)

package/src/authorsSocials.ts

@@ -41,6 +41,12 @@ type SocialEntry = [string, string];
 
 function normalizeSocialEntry([platform, value]: SocialEntry): SocialEntry {
   const normalizer = PredefinedPlatformNormalizers[platform.toLowerCase()];
+  if (typeof value !== 'string') {
+    throw new Error(
+      `Author socials should be usernames/userIds/handles, or fully qualified HTTP(s) absolute URLs.
+Social platform '${platform}' has illegal value '${value}'`,
+    );
+  }
   const isAbsoluteUrl =
     value.startsWith('http://') || value.startsWith('https://');
   if (isAbsoluteUrl) {

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,6 +39,7 @@ 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 {
@@ -55,33 +55,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 +101,7 @@ export default async function pluginContentBlog(
     contentPaths,
   });
 
-  const sourceToPermalinkHelper = createSourceToPermalinkHelper();
+  const contentHelpers = createContentHelpers();
 
   async function createBlogMDXLoaderRule(): Promise<RuleSetRule> {
     const {
@@ -162,7 +135,16 @@ export default async function pluginContentBlog(
         // Note that metadataPath must be the same/in-sync as
         // the path from createData for each MDX.
         const aliasedPath = aliasedSitePath(mdxPath, siteDir);
-        return path.join(dataDir, `${docuHash(aliasedPath)}.json`);
+        const metadataPath = path.join(
+          dataDir,
+          `${docuHash(aliasedPath)}.json`,
+        );
+        const metadataContent =
+          contentHelpers.sourceToBlogPost.get(aliasedPath)!.metadata;
+        return {
+          metadataPath,
+          metadataContent,
+        };
       },
       // For blog posts a title in markdown is always removed
       // Blog posts title are rendered separately
@@ -184,7 +166,7 @@ export default async function pluginContentBlog(
       resolveMarkdownLink: ({linkPathname, sourceFilePath}) => {
         const permalink = resolveMarkdownLinkPathname(linkPathname, {
           sourceFilePath,
-          sourceToPermalink: sourceToPermalinkHelper.get(),
+          sourceToPermalink: contentHelpers.sourceToPermalink,
           siteDir,
           contentPaths,
         });
@@ -352,7 +334,7 @@ export default async function pluginContentBlog(
     },
 
     async contentLoaded({content, actions}) {
-      sourceToPermalinkHelper.update(content);
+      contentHelpers.updateContent(content);
 
       await createAllRoutes({
         baseUrl,