npm - @docusaurus/plugin-content-blog - Versions diffs - 3.3.2 → 3.5.0 - Mend

@docusaurus/plugin-content-blog 3.3.2 → 3.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (62) hide show

package/assets/atom.css +75 -0
package/assets/atom.xsl +92 -0
package/assets/rss.css +75 -0
package/assets/rss.xsl +86 -0
package/lib/authors.d.ts +9 -11
package/lib/authors.js +42 -64
package/lib/authorsMap.d.ts +23 -0
package/lib/authorsMap.js +116 -0
package/lib/authorsProblems.d.ts +21 -0
package/lib/authorsProblems.js +51 -0
package/lib/authorsSocials.d.ts +10 -0
package/lib/authorsSocials.js +48 -0
package/lib/blogUtils.d.ts +7 -12
package/lib/blogUtils.js +44 -34
package/lib/client/contexts.d.ts +33 -0
package/lib/client/contexts.js +54 -0
package/lib/client/index.d.ts +3 -3
package/lib/client/index.js +3 -9
package/lib/client/sidebarUtils.d.ts +21 -0
package/lib/client/sidebarUtils.js +49 -0
package/lib/client/sidebarUtils.test.d.ts +7 -0
package/lib/client/sidebarUtils.test.js +43 -0
package/lib/client/structuredDataUtils.d.ts +10 -0
package/lib/client/structuredDataUtils.js +122 -0
package/lib/feed.d.ts +8 -3
package/lib/feed.js +111 -20
package/lib/frontMatter.d.ts +0 -1
package/lib/frontMatter.js +3 -2
package/lib/index.d.ts +0 -1
package/lib/index.js +132 -105
package/lib/markdownLoader.js +3 -7
package/lib/options.d.ts +4 -1
package/lib/options.js +107 -26
package/lib/props.d.ts +9 -2
package/lib/props.js +23 -3
package/lib/remark/footnoteIDFixer.js +1 -1
package/lib/routes.d.ts +0 -1
package/lib/routes.js +82 -14
package/lib/translations.d.ts +0 -1
package/lib/translations.js +2 -3
package/lib/types.d.ts +1 -8
package/package.json +13 -10
package/src/authors.ts +56 -93
package/src/authorsMap.ts +171 -0
package/src/authorsProblems.ts +72 -0
package/src/authorsSocials.ts +64 -0
package/src/blogUtils.ts +51 -46
package/src/client/contexts.tsx +95 -0
package/src/client/index.tsx +24 -0
package/src/client/sidebarUtils.test.ts +52 -0
package/src/client/sidebarUtils.tsx +85 -0
package/src/client/structuredDataUtils.ts +178 -0
package/src/feed.ts +197 -18
package/src/frontMatter.ts +2 -0
package/src/index.ts +182 -137
package/src/markdownLoader.ts +3 -7
package/src/options.ts +132 -32
package/src/plugin-content-blog.d.ts +252 -113
package/src/props.ts +41 -1
package/src/routes.ts +102 -12
package/src/types.ts +1 -6
package/src/client/index.ts +0 -20

package/assets/atom.css ADDED Viewed

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+main {
+  flex: 1 0 auto;
+  width: 100%;
+  margin: 2rem auto;
+  max-width: 800px;
+  /* stylelint-disable-next-line font-family-name-quotes */
+  font-family: system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell;
+}
+.info {
+  display: block;
+  margin: 2rem 0;
+  padding: 1.6rem 2.4rem;
+  border: 1px solid dodgerblue;
+  border-left-width: 0.5rem;
+  border-radius: 0.4rem;
+  background-color: #edf5ff;
+}
+a {
+  color: #005aff;
+  text-decoration: none;
+}
+h1 {
+  text-wrap: balance;
+  font-size: 3.4rem;
+  font-weight: 800;
+  margin-bottom: 2rem;
+  display: flex;
+  align-items: center;
+}
+h1 .rss-icon {
+  height: 3.2rem;
+  width: 3.2rem;
+  margin-right: 1rem;
+}
+h2 {
+  font-size: 2.2rem;
+  font-weight: 700;
+  margin-bottom: 0.2rem;
+}
+h3 {
+  font-size: 1.8rem;
+  font-weight: 700;
+  margin-bottom: 0.1rem;
+}
+.blog-description {
+  font-size: 1.4rem;
+  margin-bottom: 0.6rem;
+}
+.blog-post-date {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  font-style: italic;
+  color: #797b7e;
+}
+.blog-post-description {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  color: #434349;
+}

package/assets/atom.xsl ADDED Viewed

@@ -0,0 +1,92 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xsl:stylesheet
+  version="3.0"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  xmlns:atom="http://www.w3.org/2005/Atom">
+  <xsl:output method="html" version="1.0" encoding="UTF-8" indent="yes" />
+  <xsl:template match="/">
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+      <head>
+        <title>Atom Feed | <xsl:value-of
+            select="atom:feed/atom:title"
+          /></title>
+        <link rel="stylesheet" href="atom.css" />
+      </head>
+      <body>
+        <main>
+          <div class="description">
+            <div class="info">
+              <strong>This is an Atom feed</strong>. Subscribe by copying the URL
+              from the address bar into your newsreader. Visit
+              <a href="https://aboutfeeds.com/">About Feeds</a> to learn more
+              and get started. It’s free.
+            </div>
+            <h1>
+              <div class="rss-icon">
+                <svg
+                  version="1.1"
+                  id="Capa_1"
+                  xmlns="http://www.w3.org/2000/svg"
+                  xmlns:xlink="http://www.w3.org/1999/xlink"
+                  viewBox="0 0 455.731 455.731"
+                  xml:space="preserve">
+                  <g>
+                    <rect
+                      x="0"
+                      y="0"
+                      style="fill: #f78422"
+                      width="455.731"
+                      height="455.731"
+                    />
+                    <g>
+                      <path
+                        style="fill: #ffffff"
+                        d="M296.208,159.16C234.445,97.397,152.266,63.382,64.81,63.382v64.348
+                c70.268,0,136.288,27.321,185.898,76.931c49.609,49.61,76.931,115.63,76.931,185.898h64.348
+                C391.986,303.103,357.971,220.923,296.208,159.16z"
+                      />
+                      <path
+                        style="fill: #ffffff"
+                        d="M64.143,172.273v64.348c84.881,0,153.938,69.056,153.938,153.939h64.348
+                C282.429,270.196,184.507,172.273,64.143,172.273z"
+                      />
+                      <circle
+                        style="fill: #ffffff"
+                        cx="109.833"
+                        cy="346.26"
+                        r="46.088"
+                      />
+                    </g>
+                  </g>
+                </svg>
+              </div>
+              <xsl:value-of select="atom:feed/atom:title" />
+            </h1>
+            <p class="blog-description">
+              <xsl:value-of select="atom:feed/atom:subtitle" />
+            </p>
+          </div>
+          <h2>Recent Posts</h2>
+          <div class="blog-posts">
+            <xsl:for-each select="atom:feed/atom:entry">
+              <div class="blog-post">
+                <h3><a href="{atom:link[@rel='alternate']/@href}"><xsl:value-of
+                      select="atom:title"
+                    /></a></h3>
+                <div class="blog-post-date">
+                  Published on <xsl:value-of
+                    select="substring(atom:updated,0,11)"
+                  />
+                </div>
+                <div class="blog-post-description">
+                  <xsl:value-of select="atom:summary" />
+                </div>
+              </div>
+            </xsl:for-each>
+          </div>
+        </main>
+      </body>
+    </html>
+  </xsl:template>
+</xsl:stylesheet>

package/assets/rss.css ADDED Viewed

@@ -0,0 +1,75 @@
+/**
+ * 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.
+ */
+main {
+  flex: 1 0 auto;
+  width: 100%;
+  margin: 2rem auto;
+  max-width: 800px;
+  /* stylelint-disable-next-line font-family-name-quotes */
+  font-family: system-ui, -apple-system, Segoe UI, Roboto, Ubuntu, Cantarell;
+}
+.info {
+  display: block;
+  margin: 2rem 0;
+  padding: 1.6rem 2.4rem;
+  border: 1px solid dodgerblue;
+  border-left-width: 0.5rem;
+  border-radius: 0.4rem;
+  background-color: #edf5ff;
+}
+a {
+  color: #005aff;
+  text-decoration: none;
+}
+h1 {
+  text-wrap: balance;
+  font-size: 3.4rem;
+  font-weight: 800;
+  margin-bottom: 2rem;
+  display: flex;
+  align-items: center;
+}
+h1 .rss-icon {
+  height: 3.2rem;
+  width: 3.2rem;
+  margin-right: 1rem;
+}
+h2 {
+  font-size: 2.2rem;
+  font-weight: 700;
+  margin-bottom: 0.2rem;
+}
+h3 {
+  font-size: 1.8rem;
+  font-weight: 700;
+  margin-bottom: 0.1rem;
+}
+.blog-description {
+  font-size: 1.4rem;
+  margin-bottom: 0.6rem;
+}
+.blog-post-date {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  font-style: italic;
+  color: #797b7e;
+}
+.blog-post-description {
+  font-size: 1rem;
+  line-height: 1.4rem;
+  color: #434349;
+}

package/assets/rss.xsl ADDED Viewed

@@ -0,0 +1,86 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<xsl:stylesheet
+  version="3.0"
+  xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+  xmlns:atom="http://www.w3.org/2005/Atom">
+  <xsl:output method="html" version="1.0" encoding="UTF-8" indent="yes" />
+  <xsl:template match="/">
+    <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+      <head>
+        <title>RSS Feed | <xsl:value-of select="rss/channel/title" /></title>
+        <link rel="stylesheet" href="rss.css" />
+      </head>
+      <body>
+        <main>
+          <div class="description">
+            <div class="info">
+              <strong>This is an RSS feed</strong>. Subscribe by copying the URL
+              from the address bar into your newsreader. Visit
+              <a href="https://aboutfeeds.com/">About Feeds</a> to learn more
+              and get started. It’s free.
+            </div>
+            <h1>
+              <div class="rss-icon">
+                <svg
+                  version="1.1"
+                  id="Capa_1"
+                  xmlns="http://www.w3.org/2000/svg"
+                  xmlns:xlink="http://www.w3.org/1999/xlink"
+                  viewBox="0 0 455.731 455.731"
+                  xml:space="preserve">
+                  <g>
+                    <rect
+                      x="0"
+                      y="0"
+                      style="fill: #f78422"
+                      width="455.731"
+                      height="455.731"
+                    />
+                    <g>
+                      <path
+                        style="fill: #ffffff"
+                        d="M296.208,159.16C234.445,97.397,152.266,63.382,64.81,63.382v64.348
+                c70.268,0,136.288,27.321,185.898,76.931c49.609,49.61,76.931,115.63,76.931,185.898h64.348
+                C391.986,303.103,357.971,220.923,296.208,159.16z"
+                      />
+                      <path
+                        style="fill: #ffffff"
+                        d="M64.143,172.273v64.348c84.881,0,153.938,69.056,153.938,153.939h64.348
+                C282.429,270.196,184.507,172.273,64.143,172.273z"
+                      />
+                      <circle
+                        style="fill: #ffffff"
+                        cx="109.833"
+                        cy="346.26"
+                        r="46.088"
+                      />
+                    </g>
+                  </g>
+                </svg>
+              </div>
+              <xsl:value-of select="rss/channel/title" />
+            </h1>
+            <p class="blog-description">
+              <xsl:value-of select="rss/channel/description" />
+            </p>
+          </div>
+          <h2>Recent Posts</h2>
+          <div class="blog-posts">
+            <xsl:for-each select="rss/channel/item">
+              <div class="blog-post">
+                <h3><a href="{link}"><xsl:value-of select="title" /></a></h3>
+                <div class="blog-post-date">
+                  Published on <xsl:value-of select="substring(pubDate,0,17)" />
+                </div>
+                <div class="blog-post-description">
+                  <xsl:value-of select="description" />
+                </div>
+              </div>
+            </xsl:for-each>
+          </div>
+        </main>
+      </body>
+    </html>
+  </xsl:template>
+</xsl:stylesheet>

package/lib/authors.d.ts CHANGED Viewed

@@ -4,21 +4,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-/// <reference path="../src/plugin-content-blog.d.ts" />
-import type { BlogContentPaths } from './types';
-import type { Author, BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
-export type AuthorsMap = {
-    [authorKey: string]: Author;
-};
-export declare function validateAuthorsMap(content: unknown): AuthorsMap;
-export declare function getAuthorsMap(params: {
-    authorsMapPath: string;
-    contentPaths: BlogContentPaths;
-}): Promise<AuthorsMap | undefined>;
+import type { Author, AuthorsMap, BlogPost, BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
 type AuthorsParam = {
     frontMatter: BlogPostFrontMatter;
     authorsMap: AuthorsMap | undefined;
     baseUrl: string;
 };
 export declare function getBlogPostAuthors(params: AuthorsParam): Author[];
+/**
+ * Group blog posts by author key
+ * Blog posts with only inline authors are ignored
+ */
+export declare function groupBlogPostsByAuthorKey({ blogPosts, authorsMap, }: {
+    blogPosts: BlogPost[];
+    authorsMap: AuthorsMap | undefined;
+}): Record<string, BlogPost[]>;
 export {};

package/lib/authors.js CHANGED Viewed

@@ -6,44 +6,11 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBlogPostAuthors = exports.getAuthorsMap = exports.validateAuthorsMap = void 0;
+exports.getBlogPostAuthors = getBlogPostAuthors;
+exports.groupBlogPostsByAuthorKey = groupBlogPostsByAuthorKey;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const utils_1 = require("@docusaurus/utils");
-const utils_validation_1 = require("@docusaurus/utils-validation");
-const AuthorsMapSchema = utils_validation_1.Joi.object()
-    .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
-    name: utils_validation_1.Joi.string(),
-    url: utils_validation_1.URISchema,
-    imageURL: utils_validation_1.URISchema,
-    title: utils_validation_1.Joi.string(),
-    email: utils_validation_1.Joi.string(),
-})
-    .rename('image_url', 'imageURL')
-    .or('name', 'imageURL')
-    .unknown()
-    .required()
-    .messages({
-    'object.base': '{#label} should be an author object containing properties like name, title, and imageURL.',
-    'any.required': '{#label} cannot be undefined. It should be an author object containing properties like name, title, and imageURL.',
-}))
-    .messages({
-    'object.base': "The authors map file should contain an object where each entry contains an author key and the corresponding author's data.",
-});
-function validateAuthorsMap(content) {
-    const { error, value } = AuthorsMapSchema.validate(content);
-    if (error) {
-        throw error;
-    }
-    return value;
-}
-exports.validateAuthorsMap = validateAuthorsMap;
-async function getAuthorsMap(params) {
-    return (0, utils_1.getDataFileData)({
-        filePath: params.authorsMapPath,
-        contentPaths: params.contentPaths,
-        fileType: 'authors map',
-    }, validateAuthorsMap);
-}
-exports.getAuthorsMap = getAuthorsMap;
 function normalizeImageUrl({ imageURL, baseUrl, }) {
     return imageURL?.startsWith('/')
         ? (0, utils_1.normalizeUrl)([baseUrl, imageURL])
@@ -51,6 +18,7 @@ function normalizeImageUrl({ imageURL, baseUrl, }) {
 }
 // Legacy v1/early-v2 front matter fields
 // We may want to deprecate those in favor of using only frontMatter.authors
+// TODO Docusaurus v4: remove this legacy front matter
 function getFrontMatterAuthorLegacy({ baseUrl, frontMatter, }) {
     const name = frontMatter.author;
     const title = frontMatter.author_title ?? frontMatter.authorTitle;
@@ -65,27 +33,33 @@ function getFrontMatterAuthorLegacy({ baseUrl, frontMatter, }) {
             title,
             url,
             imageURL,
+            // legacy front matter authors do not have an author key/page
+            key: null,
+            page: null,
         };
     }
     return undefined;
 }
-function normalizeFrontMatterAuthors(frontMatterAuthors = []) {
-    function normalizeAuthor(authorInput) {
-        if (typeof authorInput === 'string') {
-            // Technically, we could allow users to provide an author's name here, but
-            // we only support keys, otherwise, a typo in a key would fallback to
-            // becoming a name and may end up unnoticed
-            return { key: authorInput };
+function getFrontMatterAuthors(params) {
+    const { authorsMap, frontMatter, baseUrl } = params;
+    return normalizeFrontMatterAuthors().map(toAuthor);
+    function normalizeFrontMatterAuthors() {
+        if (frontMatter.authors === undefined) {
+            return [];
         }
-        return authorInput;
+        function normalizeAuthor(authorInput) {
+            if (typeof authorInput === 'string') {
+                // We could allow users to provide an author's name here, but we only
+                // support keys, otherwise, a typo in a key would fall back to
+                // becoming a name and may end up unnoticed
+                return { key: authorInput };
+            }
+            return authorInput;
+        }
+        return Array.isArray(frontMatter.authors)
+            ? frontMatter.authors.map(normalizeAuthor)
+            : [normalizeAuthor(frontMatter.authors)];
     }
-    return Array.isArray(frontMatterAuthors)
-        ? frontMatterAuthors.map(normalizeAuthor)
-        : [normalizeAuthor(frontMatterAuthors)];
-}
-function getFrontMatterAuthors(params) {
-    const { authorsMap } = params;
-    const frontMatterAuthors = normalizeFrontMatterAuthors(params.frontMatter.authors);
     function getAuthorsMapAuthor(key) {
         if (key) {
             if (!authorsMap || Object.keys(authorsMap).length === 0) {
@@ -105,33 +79,37 @@ ${Object.keys(authorsMap)
         return undefined;
     }
     function toAuthor(frontMatterAuthor) {
-        return {
+        const author = {
             // Author def from authorsMap can be locally overridden by front matter
             ...getAuthorsMapAuthor(frontMatterAuthor.key),
             ...frontMatterAuthor,
         };
+        return {
+            ...author,
+            key: author.key ?? null,
+            page: author.page ?? null,
+            imageURL: normalizeImageUrl({ imageURL: author.imageURL, baseUrl }),
+        };
     }
-    return frontMatterAuthors.map(toAuthor);
-}
-function fixAuthorImageBaseURL(authors, { baseUrl }) {
-    return authors.map((author) => ({
-        ...author,
-        imageURL: normalizeImageUrl({ imageURL: author.imageURL, baseUrl }),
-    }));
 }
 function getBlogPostAuthors(params) {
     const authorLegacy = getFrontMatterAuthorLegacy(params);
     const authors = getFrontMatterAuthors(params);
-    const updatedAuthors = fixAuthorImageBaseURL(authors, params);
     if (authorLegacy) {
         // Technically, we could allow mixing legacy/authors front matter, but do we
         // really want to?
-        if (updatedAuthors.length > 0) {
+        if (authors.length > 0) {
             throw new Error(`To declare blog post authors, use the 'authors' front matter in priority.
 Don't mix 'authors' with other existing 'author_*' front matter. Choose one or the other, not both at the same time.`);
         }
         return [authorLegacy];
     }
-    return updatedAuthors;
+    return authors;
+}
+/**
+ * Group blog posts by author key
+ * Blog posts with only inline authors are ignored
+ */
+function groupBlogPostsByAuthorKey({ blogPosts, authorsMap, }) {
+    return lodash_1.default.mapValues(authorsMap, (author, key) => blogPosts.filter((p) => p.metadata.authors.some((a) => a.key === key)));
 }
-exports.getBlogPostAuthors = getBlogPostAuthors;

package/lib/authorsMap.d.ts ADDED Viewed

@@ -0,0 +1,23 @@
+/**
+ * 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 { BlogContentPaths } from './types';
+import type { AuthorAttributes, AuthorPage, AuthorsMap } from '@docusaurus/plugin-content-blog';
+type AuthorInput = AuthorAttributes & {
+    page?: boolean | AuthorPage;
+};
+export type AuthorsMapInput = {
+    [authorKey: string]: AuthorInput;
+};
+export declare function checkAuthorsMapPermalinkCollisions(authorsMap: AuthorsMap | undefined): void;
+export declare function validateAuthorsMapInput(content: unknown): AuthorsMapInput;
+export declare function getAuthorsMap(params: {
+    authorsMapPath: string;
+    authorsBaseRoutePath: string;
+    contentPaths: BlogContentPaths;
+}): Promise<AuthorsMap | undefined>;
+export declare function validateAuthorsMap(content: unknown): AuthorsMapInput;
+export {};

package/lib/authorsMap.js ADDED Viewed

@@ -0,0 +1,116 @@
+"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.checkAuthorsMapPermalinkCollisions = checkAuthorsMapPermalinkCollisions;
+exports.validateAuthorsMapInput = validateAuthorsMapInput;
+exports.getAuthorsMap = getAuthorsMap;
+exports.validateAuthorsMap = validateAuthorsMap;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const utils_1 = require("@docusaurus/utils");
+const utils_validation_1 = require("@docusaurus/utils-validation");
+const authorsSocials_1 = require("./authorsSocials");
+const AuthorPageSchema = utils_validation_1.Joi.object({
+    permalink: utils_validation_1.Joi.string().required(),
+});
+const AuthorsMapInputSchema = utils_validation_1.Joi.object()
+    .pattern(utils_validation_1.Joi.string(), utils_validation_1.Joi.object({
+    name: utils_validation_1.Joi.string(),
+    url: utils_validation_1.URISchema,
+    imageURL: utils_validation_1.URISchema,
+    title: utils_validation_1.Joi.string(),
+    email: utils_validation_1.Joi.string(),
+    page: utils_validation_1.Joi.alternatives(utils_validation_1.Joi.bool(), AuthorPageSchema),
+    socials: authorsSocials_1.AuthorSocialsSchema,
+    description: utils_validation_1.Joi.string(),
+})
+    .rename('image_url', 'imageURL')
+    .or('name', 'imageURL')
+    .unknown()
+    .required()
+    .messages({
+    'object.base': '{#label} should be an author object containing properties like name, title, and imageURL.',
+    'any.required': '{#label} cannot be undefined. It should be an author object containing properties like name, title, and imageURL.',
+}))
+    .messages({
+    'object.base': "The authors map file should contain an object where each entry contains an author key and the corresponding author's data.",
+});
+function checkAuthorsMapPermalinkCollisions(authorsMap) {
+    if (!authorsMap) {
+        return;
+    }
+    const permalinkCounts = (0, lodash_1.default)(authorsMap)
+        // Filter to keep only authors with a page
+        .pickBy((author) => !!author.page)
+        // Group authors by their permalink
+        .groupBy((author) => author.page?.permalink)
+        // Filter to keep only permalinks with more than one author
+        .pickBy((authors) => authors.length > 1)
+        // Transform the object into an array of [permalink, authors] pairs
+        .toPairs()
+        .value();
+    if (permalinkCounts.length > 0) {
+        const errorMessage = permalinkCounts
+            .map(([permalink, authors]) => `Permalink: ${permalink}\nAuthors: ${authors
+            .map((author) => author.name || 'Unknown')
+            .join(', ')}`)
+            .join('\n');
+        throw new Error(`The following permalinks are duplicated:\n${errorMessage}`);
+    }
+}
+function normalizeAuthor({ authorsBaseRoutePath, authorKey, author, }) {
+    function getAuthorPage() {
+        if (!author.page) {
+            return null;
+        }
+        const slug = author.page === true ? lodash_1.default.kebabCase(authorKey) : author.page.permalink;
+        return {
+            permalink: (0, utils_1.normalizeUrl)([authorsBaseRoutePath, slug]),
+        };
+    }
+    return {
+        ...author,
+        key: authorKey,
+        page: getAuthorPage(),
+        socials: author.socials ? (0, authorsSocials_1.normalizeSocials)(author.socials) : undefined,
+    };
+}
+function normalizeAuthorsMap({ authorsBaseRoutePath, authorsMapInput, }) {
+    return lodash_1.default.mapValues(authorsMapInput, (author, authorKey) => {
+        return normalizeAuthor({ authorsBaseRoutePath, authorKey, author });
+    });
+}
+function validateAuthorsMapInput(content) {
+    const { error, value } = AuthorsMapInputSchema.validate(content);
+    if (error) {
+        throw error;
+    }
+    return value;
+}
+async function getAuthorsMapInput(params) {
+    const content = await (0, utils_1.readDataFile)({
+        filePath: params.authorsMapPath,
+        contentPaths: params.contentPaths,
+    });
+    return content ? validateAuthorsMapInput(content) : undefined;
+}
+async function getAuthorsMap(params) {
+    const authorsMapInput = await getAuthorsMapInput(params);
+    if (!authorsMapInput) {
+        return undefined;
+    }
+    const authorsMap = normalizeAuthorsMap({ authorsMapInput, ...params });
+    return authorsMap;
+}
+function validateAuthorsMap(content) {
+    const { error, value } = AuthorsMapInputSchema.validate(content);
+    if (error) {
+        throw error;
+    }
+    return value;
+}

package/lib/authorsProblems.d.ts ADDED Viewed

@@ -0,0 +1,21 @@
+/**
+ * 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 { Author, PluginOptions } from '@docusaurus/plugin-content-blog';
+export declare function reportAuthorsProblems(params: {
+    authors: Author[];
+    blogSourceRelative: string;
+    options: Pick<PluginOptions, 'onInlineAuthors' | 'authorsMapPath'>;
+}): void;
+export declare function reportInlineAuthors({ authors, blogSourceRelative, options: { onInlineAuthors, authorsMapPath }, }: {
+    authors: Author[];
+    blogSourceRelative: string;
+    options: Pick<PluginOptions, 'onInlineAuthors' | 'authorsMapPath'>;
+}): void;
+export declare function reportDuplicateAuthors({ authors, blogSourceRelative, }: {
+    authors: Author[];
+    blogSourceRelative: string;
+}): void;