@docusaurus/plugin-content-blog 3.4.0 → 3.5.0

package/lib/authorsProblems.js

@@ -0,0 +1,51 @@
+"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.reportAuthorsProblems = reportAuthorsProblems;
+exports.reportInlineAuthors = reportInlineAuthors;
+exports.reportDuplicateAuthors = reportDuplicateAuthors;
+const tslib_1 = require("tslib");
+const lodash_1 = tslib_1.__importDefault(require("lodash"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+function reportAuthorsProblems(params) {
+    reportInlineAuthors(params);
+    reportDuplicateAuthors(params);
+}
+function reportInlineAuthors({ authors, blogSourceRelative, options: { onInlineAuthors, authorsMapPath }, }) {
+    if (onInlineAuthors === 'ignore') {
+        return;
+    }
+    const inlineAuthors = authors.filter((author) => !author.key);
+    if (inlineAuthors.length > 0) {
+        logger_1.default.report(onInlineAuthors)(logger_1.default.interpolate `Some blog authors used in path=${blogSourceRelative} are not defined in path=${authorsMapPath}:
+- ${inlineAuthors.map(authorToString).join('\n- ')}
+
+Note that we recommend to declare authors once in a path=${authorsMapPath} file and reference them by key in blog posts front matter to avoid author info duplication.
+But if you want to allow inline blog authors, you can disable this message by setting onInlineAuthors: 'ignore' in your blog plugin options.
+More info at url=${'https://docusaurus.io/docs/blog'}
+`);
+    }
+}
+function reportDuplicateAuthors({ authors, blogSourceRelative, }) {
+    const duplicateAuthors = (0, lodash_1.default)(authors)
+        // for now we only check for predefined authors duplicates
+        .filter((author) => !!author.key)
+        .groupBy((author) => author.key)
+        .pickBy((authorsByKey) => authorsByKey.length > 1)
+        // We only keep the "test" of all the duplicate groups
+        // The first author of a group is not really a duplicate...
+        .flatMap(([, ...rest]) => rest)
+        .value();
+    if (duplicateAuthors.length > 0) {
+        throw new Error(logger_1.default.interpolate `Duplicate blog post authors were found in blog post path=${blogSourceRelative} front matter:
+- ${duplicateAuthors.map(authorToString).join('\n- ')}`);
+    }
+}
+function authorToString(author) {
+    return JSON.stringify(author);
+}

package/lib/authorsSocials.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { Joi } from '@docusaurus/utils-validation';
+import type { AuthorSocials } from '@docusaurus/plugin-content-blog';
+export declare const AuthorSocialsSchema: Joi.ObjectSchema<AuthorSocials>;
+export declare const normalizeSocials: (socials: AuthorSocials) => AuthorSocials;

package/lib/authorsSocials.js

@@ -0,0 +1,48 @@
+"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.normalizeSocials = exports.AuthorSocialsSchema = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+exports.AuthorSocialsSchema = utils_validation_1.Joi.object({
+    twitter: utils_validation_1.Joi.string(),
+    github: utils_validation_1.Joi.string(),
+    linkedin: utils_validation_1.Joi.string(),
+    // StackOverflow userIds like '82609' are parsed as numbers by Yaml
+    stackoverflow: utils_validation_1.Joi.alternatives()
+        .try(utils_validation_1.Joi.number(), utils_validation_1.Joi.string())
+        .custom((val) => String(val)),
+    x: utils_validation_1.Joi.string(),
+}).unknown();
+const PredefinedPlatformNormalizers = {
+    x: (handle) => `https://x.com/${handle}`,
+    twitter: (handle) => `https://twitter.com/${handle}`,
+    github: (handle) => `https://github.com/${handle}`,
+    linkedin: (handle) => `https://www.linkedin.com/in/${handle}/`,
+    stackoverflow: (userId) => `https://stackoverflow.com/users/${userId}`,
+};
+function normalizeSocialEntry([platform, value]) {
+    const normalizer = PredefinedPlatformNormalizers[platform.toLowerCase()];
+    const isAbsoluteUrl = value.startsWith('http://') || value.startsWith('https://');
+    if (isAbsoluteUrl) {
+        return [platform, value];
+    }
+    else if (value.includes('/')) {
+        throw new Error(`Author socials should be usernames/userIds/handles, or fully qualified HTTP(s) absolute URLs.
+Social platform '${platform}' has illegal value '${value}'`);
+    }
+    if (normalizer && !isAbsoluteUrl) {
+        const normalizedPlatform = platform.toLowerCase();
+        const normalizedValue = normalizer(value);
+        return [normalizedPlatform, normalizedValue];
+    }
+    return [platform, value];
+}
+const normalizeSocials = (socials) => {
+    return Object.fromEntries(Object.entries(socials).map(normalizeSocialEntry));
+};
+exports.normalizeSocials = normalizeSocials;

package/lib/blogUtils.d.ts

@@ -4,11 +4,14 @@
  * 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 { LoadContext } from '@docusaurus/types';
-import type { PluginOptions, BlogPost, BlogTags, BlogPaginated } from '@docusaurus/plugin-content-blog';
+import type { AuthorsMap, 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 reportUntruncatedBlogPosts({ blogPosts, onUntruncatedBlogPosts, }: {
+    blogPosts: BlogPost[];
+    onUntruncatedBlogPosts: PluginOptions['onUntruncatedBlogPosts'];
+}): void;
 export declare function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }: {
     blogPosts: BlogPost[];
     basePageUrl: string;
@@ -31,7 +34,7 @@ type ParsedBlogFileName = {
     slug: string;
 };
 export declare function parseBlogFileName(blogSourceRelative: string): ParsedBlogFileName;
-export declare function generateBlogPosts(contentPaths: BlogContentPaths, context: LoadContext, options: PluginOptions): Promise<BlogPost[]>;
+export declare function generateBlogPosts(contentPaths: BlogContentPaths, context: LoadContext, options: PluginOptions, authorsMap?: AuthorsMap): Promise<BlogPost[]>;
 export declare function applyProcessBlogPosts({ blogPosts, processBlogPosts, }: {
     blogPosts: BlogPost[];
     processBlogPosts: PluginOptions['processBlogPosts'];

package/lib/blogUtils.js

@@ -6,7 +6,14 @@
  * 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.truncate = void 0;
+exports.truncate = truncate;
+exports.reportUntruncatedBlogPosts = reportUntruncatedBlogPosts;
+exports.paginateBlogPosts = paginateBlogPosts;
+exports.shouldBeListed = shouldBeListed;
+exports.getBlogTags = getBlogTags;
+exports.parseBlogFileName = parseBlogFileName;
+exports.generateBlogPosts = generateBlogPosts;
+exports.applyProcessBlogPosts = applyProcessBlogPosts;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -17,14 +24,27 @@ const utils_1 = require("@docusaurus/utils");
 const utils_validation_1 = require("@docusaurus/utils-validation");
 const frontMatter_1 = require("./frontMatter");
 const authors_1 = require("./authors");
+const authorsProblems_1 = require("./authorsProblems");
 function truncate(fileString, truncateMarker) {
     return fileString.split(truncateMarker, 1).shift();
 }
-exports.truncate = truncate;
+function reportUntruncatedBlogPosts({ blogPosts, onUntruncatedBlogPosts, }) {
+    const untruncatedBlogPosts = blogPosts.filter((p) => !p.metadata.hasTruncateMarker);
+    if (onUntruncatedBlogPosts !== 'ignore' && untruncatedBlogPosts.length > 0) {
+        const message = logger_1.default.interpolate `Docusaurus found blog posts without truncation markers:
+- ${untruncatedBlogPosts
+            .map((p) => logger_1.default.path((0, utils_1.aliasedSitePathToRelativePath)(p.metadata.source)))
+            .join('\n- ')}
+
+We recommend using truncation markers (code=${`<!-- truncate -->`} or code=${`{/* truncate */}`}) in blog posts to create shorter previews on blog paginated lists.
+Tip: turn this security off with the code=${`onUntruncatedBlogPosts: 'ignore'`} blog plugin option.`;
+        logger_1.default.report(onUntruncatedBlogPosts)(message);
+    }
+}
 function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription, postsPerPageOption, pageBasePath, }) {
     const totalCount = blogPosts.length;
     const postsPerPage = postsPerPageOption === 'ALL' ? totalCount : postsPerPageOption;
-    const numberOfPages = Math.ceil(totalCount / postsPerPage);
+    const numberOfPages = Math.max(1, Math.ceil(totalCount / postsPerPage));
     const pages = [];
     function permalink(page) {
         return page > 0
@@ -51,11 +71,9 @@ function paginateBlogPosts({ blogPosts, basePageUrl, blogTitle, blogDescription,
     }
     return pages;
 }
-exports.paginateBlogPosts = paginateBlogPosts;
 function shouldBeListed(blogPost) {
     return !blogPost.metadata.unlisted;
 }
-exports.shouldBeListed = shouldBeListed;
 function getBlogTags({ blogPosts, ...params }) {
     const groups = (0, utils_1.groupTaggedItems)(blogPosts, (blogPost) => blogPost.metadata.tags);
     return lodash_1.default.mapValues(groups, ({ tag, items: tagBlogPosts }) => {
@@ -78,7 +96,6 @@ function getBlogTags({ blogPosts, ...params }) {
         };
     });
 }
-exports.getBlogTags = getBlogTags;
 const DATE_FILENAME_REGEX = /^(?<folder>.*)(?<date>\d{4}[-/]\d{1,2}[-/]\d{1,2})[-/]?(?<text>.*?)(?:\/index)?.mdx?$/;
 function parseBlogFileName(blogSourceRelative) {
     const dateFilenameMatch = blogSourceRelative.match(DATE_FILENAME_REGEX);
@@ -94,7 +111,6 @@ function parseBlogFileName(blogSourceRelative) {
     const slug = `/${text}`;
     return { date: undefined, text, slug };
 }
-exports.parseBlogFileName = parseBlogFileName;
 async function parseBlogPostMarkdownFile({ filePath, parseFrontMatter, }) {
     const fileContent = await fs_extra_1.default.readFile(filePath, 'utf-8');
     try {
@@ -195,6 +211,11 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         tagsRouteBasePath,
     ]);
     const authors = (0, authors_1.getBlogPostAuthors)({ authorsMap, frontMatter, baseUrl });
+    (0, authorsProblems_1.reportAuthorsProblems)({
+        authors,
+        blogSourceRelative,
+        options,
+    });
     const tags = (0, utils_1.normalizeTags)({
         options,
         source: blogSourceRelative,
@@ -229,7 +250,7 @@ async function processBlogSourceFile(blogSourceRelative, contentPaths, context,
         content,
     };
 }
-async function generateBlogPosts(contentPaths, context, options) {
+async function generateBlogPosts(contentPaths, context, options, authorsMap) {
     const { include, exclude } = options;
     if (!(await fs_extra_1.default.pathExists(contentPaths.contentPath))) {
         return [];
@@ -238,10 +259,6 @@ async function generateBlogPosts(contentPaths, context, options) {
         cwd: contentPaths.contentPath,
         ignore: exclude,
     });
-    const authorsMap = await (0, authors_1.getAuthorsMap)({
-        contentPaths,
-        authorsMapPath: options.authorsMapPath,
-    });
     const tagsFile = await (0, utils_validation_1.getTagsFile)({ contentPaths, tags: options.tags });
     async function doProcessBlogSourceFile(blogSourceFile) {
         try {
@@ -258,7 +275,6 @@ async function generateBlogPosts(contentPaths, context, options) {
     }
     return blogPosts;
 }
-exports.generateBlogPosts = generateBlogPosts;
 async function applyProcessBlogPosts({ blogPosts, processBlogPosts, }) {
     const processedBlogPosts = await processBlogPosts({ blogPosts });
     if (Array.isArray(processedBlogPosts)) {
@@ -266,4 +282,3 @@ async function applyProcessBlogPosts({ blogPosts, processBlogPosts, }) {
     }
     return blogPosts;
 }
-exports.applyProcessBlogPosts = applyProcessBlogPosts;

package/lib/client/contexts.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 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 ReactNode } from 'react';
+import type { PropBlogPostContent, BlogMetadata } from '@docusaurus/plugin-content-blog';
+export declare function useBlogMetadata(): BlogMetadata;
+/**
+ * The React context value returned by the `useBlogPost()` hook.
+ * It contains useful data related to the currently browsed blog post.
+ */
+export type BlogPostContextValue = Pick<PropBlogPostContent, 'metadata' | 'frontMatter' | 'assets' | 'toc'> & {
+    readonly isBlogPostPage: boolean;
+};
+/**
+ * This is a very thin layer around the `content` received from the MDX loader.
+ * It provides metadata about the blog post to the children tree.
+ */
+export declare function BlogPostProvider({ children, content, isBlogPostPage, }: {
+    children: ReactNode;
+    content: PropBlogPostContent;
+    isBlogPostPage?: boolean;
+}): JSX.Element;
+/**
+ * Returns the data of the currently browsed blog post. Gives access to
+ * front matter, metadata, TOC, etc.
+ * When swizzling a low-level component (e.g. the "Edit this page" link)
+ * and you need some extra metadata, you don't have to drill the props
+ * all the way through the component tree: simply use this hook instead.
+ */
+export declare function useBlogPost(): BlogPostContextValue;

package/lib/client/contexts.js

@@ -0,0 +1,54 @@
+/**
+ * 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 React, { useMemo, useContext } from 'react';
+import { ReactContextError } from '@docusaurus/theme-common/internal';
+import useRouteContext from '@docusaurus/useRouteContext';
+export function useBlogMetadata() {
+    const routeContext = useRouteContext();
+    const blogMetadata = routeContext?.data?.blogMetadata;
+    if (!blogMetadata) {
+        throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");
+    }
+    return blogMetadata;
+}
+const Context = React.createContext(null);
+/**
+ * Note: we don't use `PropBlogPostContent` as context value on purpose.
+ * Metadata is currently stored inside the MDX component, but we may want to
+ * change that in the future.
+ */
+function useContextValue({ content, isBlogPostPage, }) {
+    return useMemo(() => ({
+        metadata: content.metadata,
+        frontMatter: content.frontMatter,
+        assets: content.assets,
+        toc: content.toc,
+        isBlogPostPage,
+    }), [content, isBlogPostPage]);
+}
+/**
+ * This is a very thin layer around the `content` received from the MDX loader.
+ * It provides metadata about the blog post to the children tree.
+ */
+export function BlogPostProvider({ children, content, isBlogPostPage = false, }) {
+    const contextValue = useContextValue({ content, isBlogPostPage });
+    return <Context.Provider value={contextValue}>{children}</Context.Provider>;
+}
+/**
+ * Returns the data of the currently browsed blog post. Gives access to
+ * front matter, metadata, TOC, etc.
+ * When swizzling a low-level component (e.g. the "Edit this page" link)
+ * and you need some extra metadata, you don't have to drill the props
+ * all the way through the component tree: simply use this hook instead.
+ */
+export function useBlogPost() {
+    const blogPost = useContext(Context);
+    if (blogPost === null) {
+        throw new ReactContextError('BlogPostProvider');
+    }
+    return blogPost;
+}

package/lib/client/index.d.ts

@@ -4,6 +4,6 @@
  * 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 { BlogMetadata } from '@docusaurus/plugin-content-blog';
-export declare function useBlogMetadata(): BlogMetadata;
+export { BlogPostProvider, type BlogPostContextValue, useBlogPost, useBlogMetadata, } from './contexts';
+export { useBlogListPageStructuredData, useBlogPostStructuredData, } from './structuredDataUtils';
+export { BlogSidebarItemList, groupBlogSidebarItemsByYear, useVisibleBlogSidebarItems, } from './sidebarUtils';

package/lib/client/index.js

@@ -4,12 +4,6 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import useRouteContext from '@docusaurus/useRouteContext';
-export function useBlogMetadata() {
-    const routeContext = useRouteContext();
-    const blogMetadata = routeContext?.data?.blogMetadata;
-    if (!blogMetadata) {
-        throw new Error("useBlogMetadata() can't be called on the current route because the blog metadata could not be found in route context");
-    }
-    return blogMetadata;
-}
+export { BlogPostProvider, useBlogPost, useBlogMetadata, } from './contexts';
+export { useBlogListPageStructuredData, useBlogPostStructuredData, } from './structuredDataUtils';
+export { BlogSidebarItemList, groupBlogSidebarItemsByYear, useVisibleBlogSidebarItems, } from './sidebarUtils';

package/lib/client/sidebarUtils.d.ts

@@ -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 ReactNode } from 'react';
+import type { BlogSidebarItem } from '@docusaurus/plugin-content-blog';
+/**
+ * Return the visible blog sidebar items to display.
+ * Unlisted items are filtered.
+ */
+export declare function useVisibleBlogSidebarItems(items: BlogSidebarItem[]): BlogSidebarItem[];
+export declare function groupBlogSidebarItemsByYear(items: BlogSidebarItem[]): [string, BlogSidebarItem[]][];
+export declare function BlogSidebarItemList({ items, ulClassName, liClassName, linkClassName, linkActiveClassName, }: {
+    items: BlogSidebarItem[];
+    ulClassName?: string;
+    liClassName?: string;
+    linkClassName?: string;
+    linkActiveClassName?: string;
+}): ReactNode;

package/lib/client/sidebarUtils.js

@@ -0,0 +1,49 @@
+/**
+ * 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 React, { useMemo } from 'react';
+import { useLocation } from '@docusaurus/router';
+import Link from '@docusaurus/Link';
+import { groupBy } from '@docusaurus/theme-common';
+import { isSamePath } from '@docusaurus/theme-common/internal';
+function isVisible(item, pathname) {
+    if (item.unlisted && !isSamePath(item.permalink, pathname)) {
+        return false;
+    }
+    return true;
+}
+/**
+ * Return the visible blog sidebar items to display.
+ * Unlisted items are filtered.
+ */
+export function useVisibleBlogSidebarItems(items) {
+    const { pathname } = useLocation();
+    return useMemo(() => items.filter((item) => isVisible(item, pathname)), [items, pathname]);
+}
+export function groupBlogSidebarItemsByYear(items) {
+    const groupedByYear = groupBy(items, (item) => {
+        return `${new Date(item.date).getFullYear()}`;
+    });
+    // "as" is safe here
+    // see https://github.com/microsoft/TypeScript/pull/56805#issuecomment-2196526425
+    const entries = Object.entries(groupedByYear);
+    // We have to use entries because of https://x.com/sebastienlorber/status/1806371668614369486
+    // Objects with string/number keys are automatically sorted asc...
+    // Even if keys are strings like "2024"
+    // We want descending order for years
+    // Alternative: using Map.groupBy (not affected by this "reordering")
+    entries.reverse();
+    return entries;
+}
+export function BlogSidebarItemList({ items, ulClassName, liClassName, linkClassName, linkActiveClassName, }) {
+    return (<ul className={ulClassName}>
+      {items.map((item) => (<li key={item.permalink} className={liClassName}>
+          <Link isNavLink to={item.permalink} className={linkClassName} activeClassName={linkActiveClassName}>
+            {item.title}
+          </Link>
+        </li>))}
+    </ul>);
+}

package/lib/client/sidebarUtils.test.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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.
+ */
+export {};

package/lib/client/sidebarUtils.test.js

@@ -0,0 +1,43 @@
+/**
+ * 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 { groupBlogSidebarItemsByYear } from './sidebarUtils';
+describe('groupBlogSidebarItemsByYear', () => {
+    const post1 = {
+        title: 'post1',
+        permalink: '/post1',
+        date: '2024-10-03',
+        unlisted: false,
+    };
+    const post2 = {
+        title: 'post2',
+        permalink: '/post2',
+        date: '2024-05-02',
+        unlisted: false,
+    };
+    const post3 = {
+        title: 'post3',
+        permalink: '/post3',
+        date: '2022-11-18',
+        unlisted: false,
+    };
+    it('can group items by year', () => {
+        const items = [post1, post2, post3];
+        const entries = groupBlogSidebarItemsByYear(items);
+        expect(entries).toEqual([
+            ['2024', [post1, post2]],
+            ['2022', [post3]],
+        ]);
+    });
+    it('always returns result in descending chronological order', () => {
+        const items = [post3, post1, post2];
+        const entries = groupBlogSidebarItemsByYear(items);
+        expect(entries).toEqual([
+            ['2024', [post1, post2]],
+            ['2022', [post3]],
+        ]);
+    });
+});

package/lib/client/structuredDataUtils.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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 { Props as BlogListPageStructuredDataProps } from '@theme/BlogListPage/StructuredData';
+import type { Blog, BlogPosting, WithContext } from 'schema-dts';
+export declare function useBlogListPageStructuredData(props: BlogListPageStructuredDataProps): WithContext<Blog>;
+export declare function useBlogPostStructuredData(): WithContext<BlogPosting>;

package/lib/client/structuredDataUtils.js

@@ -0,0 +1,122 @@
+/**
+ * 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 { useBaseUrlUtils } from '@docusaurus/useBaseUrl';
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import { useBlogMetadata } from '@docusaurus/plugin-content-blog/client';
+import { useBlogPost } from './contexts';
+const convertDate = (dateMs) => new Date(dateMs).toISOString();
+function getBlogPost(blogPostContent, siteConfig, withBaseUrl) {
+    const { assets, frontMatter, metadata } = blogPostContent;
+    const { date, title, description, lastUpdatedAt } = metadata;
+    const image = assets.image ?? frontMatter.image;
+    const keywords = frontMatter.keywords ?? [];
+    const blogUrl = `${siteConfig.url}${metadata.permalink}`;
+    const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
+    return {
+        '@type': 'BlogPosting',
+        '@id': blogUrl,
+        mainEntityOfPage: blogUrl,
+        url: blogUrl,
+        headline: title,
+        name: title,
+        description,
+        datePublished: date,
+        ...(dateModified ? { dateModified } : {}),
+        ...getAuthor(metadata.authors),
+        ...getImage(image, withBaseUrl, title),
+        ...(keywords ? { keywords } : {}),
+    };
+}
+function getAuthor(authors) {
+    const authorsStructuredData = authors.map(createPersonStructuredData);
+    return {
+        author: authorsStructuredData.length === 1
+            ? authorsStructuredData[0]
+            : authorsStructuredData,
+    };
+}
+function getImage(image, withBaseUrl, title) {
+    return image
+        ? {
+            image: createImageStructuredData({
+                imageUrl: withBaseUrl(image, { absolute: true }),
+                caption: `title image for the blog post: ${title}`,
+            }),
+        }
+        : {};
+}
+export function useBlogListPageStructuredData(props) {
+    const { siteConfig } = useDocusaurusContext();
+    const { withBaseUrl } = useBaseUrlUtils();
+    const { metadata: { blogDescription, blogTitle, permalink }, } = props;
+    const url = `${siteConfig.url}${permalink}`;
+    // details on structured data support: https://schema.org/Blog
+    return {
+        '@context': 'https://schema.org',
+        '@type': 'Blog',
+        '@id': url,
+        mainEntityOfPage: url,
+        headline: blogTitle,
+        description: blogDescription,
+        blogPost: props.items.map((blogItem) => getBlogPost(blogItem.content, siteConfig, withBaseUrl)),
+    };
+}
+export function useBlogPostStructuredData() {
+    const blogMetadata = useBlogMetadata();
+    const { assets, metadata } = useBlogPost();
+    const { siteConfig } = useDocusaurusContext();
+    const { withBaseUrl } = useBaseUrlUtils();
+    const { date, title, description, frontMatter, lastUpdatedAt } = metadata;
+    const image = assets.image ?? frontMatter.image;
+    const keywords = frontMatter.keywords ?? [];
+    const dateModified = lastUpdatedAt ? convertDate(lastUpdatedAt) : undefined;
+    const url = `${siteConfig.url}${metadata.permalink}`;
+    // details on structured data support: https://schema.org/BlogPosting
+    // BlogPosting is one of the structured data types that Google explicitly
+    // supports: https://developers.google.com/search/docs/appearance/structured-data/article#structured-data-type-definitions
+    return {
+        '@context': 'https://schema.org',
+        '@type': 'BlogPosting',
+        '@id': url,
+        mainEntityOfPage: url,
+        url,
+        headline: title,
+        name: title,
+        description,
+        datePublished: date,
+        ...(dateModified ? { dateModified } : {}),
+        ...getAuthor(metadata.authors),
+        ...getImage(image, withBaseUrl, title),
+        ...(keywords ? { keywords } : {}),
+        isPartOf: {
+            '@type': 'Blog',
+            '@id': `${siteConfig.url}${blogMetadata.blogBasePath}`,
+            name: blogMetadata.blogTitle,
+        },
+    };
+}
+/** @returns A {@link https://schema.org/Person} constructed from the {@link Author} */
+function createPersonStructuredData(author) {
+    return {
+        '@type': 'Person',
+        ...(author.name ? { name: author.name } : {}),
+        ...(author.title ? { description: author.title } : {}),
+        ...(author.url ? { url: author.url } : {}),
+        ...(author.email ? { email: author.email } : {}),
+        ...(author.imageURL ? { image: author.imageURL } : {}),
+    };
+}
+/** @returns A {@link https://schema.org/ImageObject} */
+function createImageStructuredData({ imageUrl, caption, }) {
+    return {
+        '@type': 'ImageObject',
+        '@id': imageUrl,
+        url: imageUrl,
+        contentUrl: imageUrl,
+        caption,
+    };
+}

package/lib/feed.d.ts

@@ -4,15 +4,16 @@
  * 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 { DocusaurusConfig, HtmlTags, LoadContext } from '@docusaurus/types';
 import type { PluginOptions, BlogPost } from '@docusaurus/plugin-content-blog';
-export declare function createBlogFeedFiles({ blogPosts: allBlogPosts, options, siteConfig, outDir, locale, }: {
+export declare function createBlogFeedFiles({ blogPosts: allBlogPosts, options, siteConfig, outDir, locale, contentPaths, }: {
     blogPosts: BlogPost[];
     options: PluginOptions;
     siteConfig: DocusaurusConfig;
     outDir: string;
     locale: string;
+    contentPaths: BlogContentPaths;
 }): Promise<void>;
 export declare function createFeedHtmlHeadTags({ context, options, }: {
     context: LoadContext;