@docusaurus/plugin-content-blog 0.0.0-6061 → 0.0.0-6062

package/lib/authors.d.ts

@@ -10,6 +10,10 @@ type AuthorsParam = {
     authorsMap: AuthorsMap | undefined;
     baseUrl: string;
 };
+export declare function normalizeImageUrl({ imageURL, baseUrl, }: {
+    imageURL: string | undefined;
+    baseUrl: string;
+}): string | undefined;
 export declare function getBlogPostAuthors(params: AuthorsParam): Author[];
 /**
  * Group blog posts by author key

package/lib/authors.js

@@ -6,6 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeImageUrl = normalizeImageUrl;
 exports.getBlogPostAuthors = getBlogPostAuthors;
 exports.groupBlogPostsByAuthorKey = groupBlogPostsByAuthorKey;
 const tslib_1 = require("tslib");
@@ -16,6 +17,17 @@ function normalizeImageUrl({ imageURL, baseUrl, }) {
         ? (0, utils_1.normalizeUrl)([baseUrl, imageURL])
         : imageURL;
 }
+function normalizeAuthorUrl({ author, baseUrl, }) {
+    if (author.key) {
+        // Ensures invariant: global authors should have already been normalized
+        if (author.imageURL?.startsWith('/') &&
+            !author.imageURL.startsWith(baseUrl)) {
+            throw new Error(`Docusaurus internal bug: global authors image ${author.imageURL} should start with the expected baseUrl=${baseUrl}`);
+        }
+        return author.imageURL;
+    }
+    return normalizeImageUrl({ imageURL: author.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
@@ -88,7 +100,8 @@ ${Object.keys(authorsMap)
             ...author,
             key: author.key ?? null,
             page: author.page ?? null,
-            imageURL: normalizeImageUrl({ imageURL: author.imageURL, baseUrl }),
+            // global author images have already been normalized
+            imageURL: normalizeAuthorUrl({ author, baseUrl }),
         };
     }
 }

package/lib/authorsMap.d.ts

@@ -18,6 +18,7 @@ export declare function getAuthorsMap(params: {
     authorsMapPath: string;
     authorsBaseRoutePath: string;
     contentPaths: BlogContentPaths;
+    baseUrl: string;
 }): Promise<AuthorsMap | undefined>;
 export declare function validateAuthorsMap(content: unknown): AuthorsMapInput;
 export {};

package/lib/authorsMap.js

@@ -15,6 +15,7 @@ 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 authors_1 = require("./authors");
 const AuthorPageSchema = utils_validation_1.Joi.object({
     permalink: utils_validation_1.Joi.string().required(),
 });
@@ -63,7 +64,7 @@ function checkAuthorsMapPermalinkCollisions(authorsMap) {
         throw new Error(`The following permalinks are duplicated:\n${errorMessage}`);
     }
 }
-function normalizeAuthor({ authorsBaseRoutePath, authorKey, author, }) {
+function normalizeAuthor({ authorsBaseRoutePath, authorKey, baseUrl, author, }) {
     function getAuthorPage() {
         if (!author.page) {
             return null;
@@ -77,12 +78,13 @@ function normalizeAuthor({ authorsBaseRoutePath, authorKey, author, }) {
         ...author,
         key: authorKey,
         page: getAuthorPage(),
+        imageURL: (0, authors_1.normalizeImageUrl)({ imageURL: author.imageURL, baseUrl }),
         socials: author.socials ? (0, authorsSocials_1.normalizeSocials)(author.socials) : undefined,
     };
 }
-function normalizeAuthorsMap({ authorsBaseRoutePath, authorsMapInput, }) {
+function normalizeAuthorsMap({ authorsBaseRoutePath, authorsMapInput, baseUrl, }) {
     return lodash_1.default.mapValues(authorsMapInput, (author, authorKey) => {
-        return normalizeAuthor({ authorsBaseRoutePath, authorKey, author });
+        return normalizeAuthor({ authorsBaseRoutePath, authorKey, author, baseUrl });
     });
 }
 function validateAuthorsMapInput(content) {

package/lib/index.js

@@ -168,6 +168,7 @@ async function pluginContentBlog(context, options) {
                     routeBasePath,
                     authorsBasePath,
                 ]),
+                baseUrl,
             });
             (0, authorsMap_1.checkAuthorsMapPermalinkCollisions)(authorsMap);
             let blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options, authorsMap);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-6061",
+  "version": "0.0.0-6062",
   "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-6061",
-    "@docusaurus/logger": "0.0.0-6061",
-    "@docusaurus/mdx-loader": "0.0.0-6061",
-    "@docusaurus/theme-common": "0.0.0-6061",
-    "@docusaurus/types": "0.0.0-6061",
-    "@docusaurus/utils": "0.0.0-6061",
-    "@docusaurus/utils-common": "0.0.0-6061",
-    "@docusaurus/utils-validation": "0.0.0-6061",
+    "@docusaurus/core": "0.0.0-6062",
+    "@docusaurus/logger": "0.0.0-6062",
+    "@docusaurus/mdx-loader": "0.0.0-6062",
+    "@docusaurus/theme-common": "0.0.0-6062",
+    "@docusaurus/types": "0.0.0-6062",
+    "@docusaurus/utils": "0.0.0-6062",
+    "@docusaurus/utils-common": "0.0.0-6062",
+    "@docusaurus/utils-validation": "0.0.0-6062",
     "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": "3e2c2a06f0d0400f0adf145fd24ba37776c65dbf"
+  "gitHead": "f32caf7a9bd354b43ea373b232021955fb95af2d"
 }

package/src/authors.ts

@@ -21,18 +21,41 @@ type AuthorsParam = {
   baseUrl: string;
 };
 
-function normalizeImageUrl({
+export function normalizeImageUrl({
   imageURL,
   baseUrl,
 }: {
   imageURL: string | undefined;
   baseUrl: string;
-}) {
+}): string | undefined {
   return imageURL?.startsWith('/')
     ? normalizeUrl([baseUrl, imageURL])
     : imageURL;
 }
 
+function normalizeAuthorUrl({
+  author,
+  baseUrl,
+}: {
+  author: Author;
+  baseUrl: string;
+}): string | undefined {
+  if (author.key) {
+    // Ensures invariant: global authors should have already been normalized
+    if (
+      author.imageURL?.startsWith('/') &&
+      !author.imageURL.startsWith(baseUrl)
+    ) {
+      throw new Error(
+        `Docusaurus internal bug: global authors image ${author.imageURL} should start with the expected baseUrl=${baseUrl}`,
+      );
+    }
+
+    return author.imageURL;
+  }
+  return normalizeImageUrl({imageURL: author.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
@@ -116,13 +139,14 @@ ${Object.keys(authorsMap)
       // Author def from authorsMap can be locally overridden by front matter
       ...getAuthorsMapAuthor(frontMatterAuthor.key),
       ...frontMatterAuthor,
-    };
+    } as Author;
 
     return {
       ...author,
       key: author.key ?? null,
       page: author.page ?? null,
-      imageURL: normalizeImageUrl({imageURL: author.imageURL, baseUrl}),
+      // global author images have already been normalized
+      imageURL: normalizeAuthorUrl({author, baseUrl}),
     };
   }
 }

package/src/authorsMap.ts

@@ -9,12 +9,13 @@ import _ from 'lodash';
 import {readDataFile, normalizeUrl} from '@docusaurus/utils';
 import {Joi, URISchema} from '@docusaurus/utils-validation';
 import {AuthorSocialsSchema, normalizeSocials} from './authorsSocials';
+import {normalizeImageUrl} from './authors';
 import type {BlogContentPaths} from './types';
 import type {
-  Author,
   AuthorAttributes,
   AuthorPage,
   AuthorsMap,
+  AuthorWithKey,
 } from '@docusaurus/plugin-content-blog';
 
 type AuthorInput = AuthorAttributes & {
@@ -93,12 +94,14 @@ export function checkAuthorsMapPermalinkCollisions(
 function normalizeAuthor({
   authorsBaseRoutePath,
   authorKey,
+  baseUrl,
   author,
 }: {
   authorsBaseRoutePath: string;
   authorKey: string;
+  baseUrl: string;
   author: AuthorInput;
-}): Author & {key: string} {
+}): AuthorWithKey {
   function getAuthorPage(): AuthorPage | null {
     if (!author.page) {
       return null;
@@ -114,6 +117,7 @@ function normalizeAuthor({
     ...author,
     key: authorKey,
     page: getAuthorPage(),
+    imageURL: normalizeImageUrl({imageURL: author.imageURL, baseUrl}),
     socials: author.socials ? normalizeSocials(author.socials) : undefined,
   };
 }
@@ -121,12 +125,14 @@ function normalizeAuthor({
 function normalizeAuthorsMap({
   authorsBaseRoutePath,
   authorsMapInput,
+  baseUrl,
 }: {
   authorsBaseRoutePath: string;
   authorsMapInput: AuthorsMapInput;
+  baseUrl: string;
 }): AuthorsMap {
   return _.mapValues(authorsMapInput, (author, authorKey) => {
-    return normalizeAuthor({authorsBaseRoutePath, authorKey, author});
+    return normalizeAuthor({authorsBaseRoutePath, authorKey, author, baseUrl});
   });
 }
 
@@ -153,6 +159,7 @@ export async function getAuthorsMap(params: {
   authorsMapPath: string;
   authorsBaseRoutePath: string;
   contentPaths: BlogContentPaths;
+  baseUrl: string;
 }): Promise<AuthorsMap | undefined> {
   const authorsMapInput = await getAuthorsMapInput(params);
   if (!authorsMapInput) {

package/src/index.ts

@@ -271,6 +271,7 @@ export default async function pluginContentBlog(
           routeBasePath,
           authorsBasePath,
         ]),
+        baseUrl,
       });
       checkAuthorsMapPermalinkCollisions(authorsMap);