@docusaurus/plugin-content-blog 2.0.0-beta.fbdeefcac → 2.0.0-rc.1

package/lib/feed.js

@@ -0,0 +1,102 @@
+"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.createBlogFeedFiles = void 0;
+const tslib_1 = require("tslib");
+const path_1 = tslib_1.__importDefault(require("path"));
+const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
+const logger_1 = tslib_1.__importDefault(require("@docusaurus/logger"));
+const feed_1 = require("feed");
+const utils_1 = require("@docusaurus/utils");
+const utils_common_1 = require("@docusaurus/utils-common");
+const cheerio_1 = require("cheerio");
+async function generateBlogFeed({ blogPosts, options, siteConfig, outDir, locale, }) {
+    if (!blogPosts.length) {
+        return null;
+    }
+    const { feedOptions, routeBasePath } = options;
+    const { url: siteUrl, baseUrl, title, favicon } = siteConfig;
+    const blogBaseUrl = (0, utils_1.normalizeUrl)([siteUrl, baseUrl, routeBasePath]);
+    const updated = blogPosts[0]?.metadata.date;
+    const feed = new feed_1.Feed({
+        id: blogBaseUrl,
+        title: feedOptions.title ?? `${title} Blog`,
+        updated,
+        language: feedOptions.language ?? locale,
+        link: blogBaseUrl,
+        description: feedOptions.description ?? `${siteConfig.title} Blog`,
+        favicon: favicon ? (0, utils_1.normalizeUrl)([siteUrl, baseUrl, favicon]) : undefined,
+        copyright: feedOptions.copyright,
+    });
+    function toFeedAuthor(author) {
+        return { name: author.name, link: author.url, email: author.email };
+    }
+    await Promise.all(blogPosts.map(async (post) => {
+        const { id, metadata: { title: metadataTitle, permalink, date, description, authors, tags, }, } = post;
+        const content = await (0, utils_1.readOutputHTMLFile)(permalink.replace(siteConfig.baseUrl, ''), outDir, siteConfig.trailingSlash);
+        const $ = (0, cheerio_1.load)(content);
+        const feedItem = {
+            title: metadataTitle,
+            id,
+            link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
+            date,
+            description,
+            // Atom feed demands the "term", while other feeds use "name"
+            category: tags.map((tag) => ({ name: tag.label, term: tag.label })),
+            content: $(`#${utils_common_1.blogPostContainerID}`).html(),
+        };
+        // json1() method takes the first item of authors array
+        // it causes an error when authors array is empty
+        const feedItemAuthors = authors.map(toFeedAuthor);
+        if (feedItemAuthors.length > 0) {
+            feedItem.author = feedItemAuthors;
+        }
+        return feedItem;
+    })).then((items) => items.forEach(feed.addItem));
+    return feed;
+}
+async function createBlogFeedFile({ feed, feedType, generatePath, }) {
+    const [feedContent, feedPath] = (() => {
+        switch (feedType) {
+            case 'rss':
+                return [feed.rss2(), 'rss.xml'];
+            case 'json':
+                return [feed.json1(), 'feed.json'];
+            case 'atom':
+                return [feed.atom1(), 'atom.xml'];
+            default:
+                throw new Error(`Feed type ${feedType} not supported.`);
+        }
+    })();
+    try {
+        await fs_extra_1.default.outputFile(path_1.default.join(generatePath, feedPath), feedContent);
+    }
+    catch (err) {
+        logger_1.default.error(`Generating ${feedType} feed failed.`);
+        throw err;
+    }
+}
+async function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, locale, }) {
+    const feed = await generateBlogFeed({
+        blogPosts,
+        options,
+        siteConfig,
+        outDir,
+        locale,
+    });
+    const feedTypes = options.feedOptions.type;
+    if (!feed || !feedTypes) {
+        return;
+    }
+    await Promise.all(feedTypes.map((feedType) => createBlogFeedFile({
+        feed,
+        feedType,
+        generatePath: path_1.default.join(outDir, options.routeBasePath),
+    })));
+}
+exports.createBlogFeedFiles = createBlogFeedFiles;

package/lib/frontMatter.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 { BlogPostFrontMatter } from '@docusaurus/plugin-content-blog';
+export declare function validateBlogPostFrontMatter(frontMatter: {
+    [key: string]: unknown;
+}): BlogPostFrontMatter;

package/lib/{blogFrontMatter.js → frontMatter.js}

@@ -7,44 +7,56 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateBlogPostFrontMatter = void 0;
-/* eslint-disable camelcase */
 const utils_validation_1 = require("@docusaurus/utils-validation");
-// NOTE: we don't add any default value on purpose here
-// We don't want default values to magically appear in doc metadatas and props
-// While the user did not provide those values explicitly
-// We use default values in code instead
-const BlogTagSchema = utils_validation_1.JoiFrontMatter.alternatives().try(utils_validation_1.JoiFrontMatter.string().required(), utils_validation_1.JoiFrontMatter.object({
-    label: utils_validation_1.JoiFrontMatter.string().required(),
-    permalink: utils_validation_1.JoiFrontMatter.string().required(),
-}));
+const BlogPostFrontMatterAuthorSchema = utils_validation_1.JoiFrontMatter.object({
+    key: utils_validation_1.JoiFrontMatter.string(),
+    name: utils_validation_1.JoiFrontMatter.string(),
+    title: utils_validation_1.JoiFrontMatter.string(),
+    url: utils_validation_1.URISchema,
+    imageURL: utils_validation_1.JoiFrontMatter.string(),
+})
+    .or('key', 'name', 'imageURL')
+    .rename('image_url', 'imageURL', { alias: true });
+const FrontMatterAuthorErrorMessage = '{{#label}} does not look like a valid blog post author. Please use an author key or an author object (with a key and/or name).';
 const BlogFrontMatterSchema = utils_validation_1.JoiFrontMatter.object({
     id: utils_validation_1.JoiFrontMatter.string(),
     title: utils_validation_1.JoiFrontMatter.string().allow(''),
     description: utils_validation_1.JoiFrontMatter.string().allow(''),
-    tags: utils_validation_1.JoiFrontMatter.array().items(BlogTagSchema),
+    tags: utils_validation_1.FrontMatterTagsSchema,
     draft: utils_validation_1.JoiFrontMatter.boolean(),
     date: utils_validation_1.JoiFrontMatter.date().raw(),
+    // New multi-authors front matter:
+    authors: utils_validation_1.JoiFrontMatter.alternatives()
+        .try(utils_validation_1.JoiFrontMatter.string(), BlogPostFrontMatterAuthorSchema, utils_validation_1.JoiFrontMatter.array()
+        .items(utils_validation_1.JoiFrontMatter.string(), BlogPostFrontMatterAuthorSchema)
+        .messages({
+        'array.sparse': FrontMatterAuthorErrorMessage,
+        'array.includes': FrontMatterAuthorErrorMessage,
+    }))
+        .messages({
+        'alternatives.match': FrontMatterAuthorErrorMessage,
+    }),
+    // Legacy author front matter
     author: utils_validation_1.JoiFrontMatter.string(),
     author_title: utils_validation_1.JoiFrontMatter.string(),
     author_url: utils_validation_1.URISchema,
     author_image_url: utils_validation_1.URISchema,
-    slug: utils_validation_1.JoiFrontMatter.string(),
-    image: utils_validation_1.URISchema,
-    keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
-    hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
-    // TODO re-enable warnings later, our v1 blog posts use those older frontmatter fields
+    // TODO enable deprecation warnings later
     authorURL: utils_validation_1.URISchema,
     // .warning('deprecate.error', { alternative: '"author_url"'}),
     authorTitle: utils_validation_1.JoiFrontMatter.string(),
     // .warning('deprecate.error', { alternative: '"author_title"'}),
     authorImageURL: utils_validation_1.URISchema,
     // .warning('deprecate.error', { alternative: '"author_image_url"'}),
-})
-    .unknown()
-    .messages({
+    slug: utils_validation_1.JoiFrontMatter.string(),
+    image: utils_validation_1.URISchema,
+    keywords: utils_validation_1.JoiFrontMatter.array().items(utils_validation_1.JoiFrontMatter.string().required()),
+    hide_table_of_contents: utils_validation_1.JoiFrontMatter.boolean(),
+    ...utils_validation_1.FrontMatterTOCHeadingLevels,
+}).messages({
     'deprecate.error': '{#label} blog frontMatter field is deprecated. Please use {#alternative} instead.',
 });
 function validateBlogPostFrontMatter(frontMatter) {
-    return utils_validation_1.validateFrontMatter(frontMatter, BlogFrontMatterSchema);
+    return (0, utils_validation_1.validateFrontMatter)(frontMatter, BlogFrontMatterSchema);
 }
 exports.validateBlogPostFrontMatter = validateBlogPostFrontMatter;

package/lib/index.d.ts

@@ -4,7 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { PluginOptions, BlogContent } from './types';
-import { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
-export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Plugin<BlogContent>;
-export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { PluginOptions, BlogContent } from '@docusaurus/plugin-content-blog';
+export default function pluginContentBlog(context: LoadContext, options: PluginOptions): Promise<Plugin<BlogContent>>;
+export { validateOptions } from './options';