@docusaurus/plugin-content-blog 0.0.0-4286 → 0.0.0-4290

package/lib/feed.js

@@ -51,23 +51,40 @@ async function generateBlogFeed({ blogPosts, options, siteConfig, }) {
     }
     blogPosts.forEach((post) => {
         const { id, metadata: { title: metadataTitle, permalink, date, description, authors }, } = post;
-        feed.addItem({
+        const feedItem = {
             title: metadataTitle,
             id,
             link: (0, utils_1.normalizeUrl)([siteUrl, permalink]),
             date,
             description,
             content: mdxToFeedContent(post.content),
-            author: authors.map(toFeedAuthor),
-        });
+        };
+        // 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;
+        }
+        feed.addItem(feedItem);
     });
     return feed;
 }
 exports.generateBlogFeed = generateBlogFeed;
-async function createBlogFeedFile({ feed, feedType, filePath, }) {
-    const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
+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(filePath, feedContent);
+        await fs_extra_1.default.outputFile(path_1.default.join(generatePath, feedPath), feedContent);
     }
     catch (err) {
         throw new Error(`Generating ${feedType} feed failed: ${err}.`);
@@ -79,12 +96,10 @@ async function createBlogFeedFiles({ blogPosts, options, siteConfig, outDir, })
     if (!feed || !feedTypes) {
         return;
     }
-    await Promise.all(feedTypes.map(async (feedType) => {
-        await createBlogFeedFile({
-            feed,
-            feedType,
-            filePath: path_1.default.join(outDir, options.routeBasePath, `${feedType}.xml`),
-        });
-    }));
+    await Promise.all(feedTypes.map((feedType) => createBlogFeedFile({
+        feed,
+        feedType,
+        generatePath: path_1.default.join(outDir, options.routeBasePath),
+    })));
 }
 exports.createBlogFeedFiles = createBlogFeedFiles;

package/lib/index.js

@@ -364,6 +364,11 @@ function pluginContentBlog(context, options) {
                     path: 'atom.xml',
                     title: `${feedTitle} Atom Feed`,
                 },
+                json: {
+                    type: 'application/json',
+                    path: 'feed.json',
+                    title: `${feedTitle} JSON Feed`,
+                },
             };
             const headTags = [];
             feedTypes.forEach((feedType) => {

package/lib/pluginOptionSchema.js

@@ -74,8 +74,8 @@ exports.PluginOptionSchema = utils_validation_1.Joi.object({
     beforeDefaultRehypePlugins: utils_validation_1.RehypePluginsSchema.default(exports.DEFAULT_OPTIONS.beforeDefaultRehypePlugins),
     feedOptions: utils_validation_1.Joi.object({
         type: utils_validation_1.Joi.alternatives()
-            .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string()), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom'), {
-            then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom'] : [val]),
+            .try(utils_validation_1.Joi.array().items(utils_validation_1.Joi.string().equal('rss', 'atom', 'json')), utils_validation_1.Joi.alternatives().conditional(utils_validation_1.Joi.string().equal('all', 'rss', 'atom', 'json'), {
+            then: utils_validation_1.Joi.custom((val) => val === 'all' ? ['rss', 'atom', 'json'] : [val]),
         }))
             .allow(null)
             .default(exports.DEFAULT_OPTIONS.feedOptions.type),

package/lib/types.d.ts

@@ -17,7 +17,7 @@ export interface BlogContent {
     blogTags: BlogTags;
     blogTagsListPath: string | null;
 }
-export declare type FeedType = 'rss' | 'atom';
+export declare type FeedType = 'rss' | 'atom' | 'json';
 export declare type FeedOptions = {
     type?: FeedType[] | null;
     title?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-4286",
+  "version": "0.0.0-4290",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -18,10 +18,10 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4286",
-    "@docusaurus/mdx-loader": "0.0.0-4286",
-    "@docusaurus/utils": "0.0.0-4286",
-    "@docusaurus/utils-validation": "0.0.0-4286",
+    "@docusaurus/core": "0.0.0-4290",
+    "@docusaurus/mdx-loader": "0.0.0-4290",
+    "@docusaurus/utils": "0.0.0-4290",
+    "@docusaurus/utils-validation": "0.0.0-4290",
     "chalk": "^4.1.2",
     "escape-string-regexp": "^4.0.0",
     "feed": "^4.2.2",
@@ -37,7 +37,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4286"
+    "@docusaurus/types": "0.0.0-4290"
   },
   "peerDependencies": {
     "react": "^16.8.4 || ^17.0.0",
@@ -46,5 +46,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "2a87bcff19729fff3df8fe20ca79fcac87b31371"
+  "gitHead": "ba51a860b7928a3d120f8409ad1ced28727b27b2"
 }

package/src/feed.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {Feed, Author as FeedAuthor} from 'feed';
+import {Feed, Author as FeedAuthor, Item as FeedItem} from 'feed';
 import {PluginOptions, Author, BlogPost, FeedType} from './types';
 import {normalizeUrl, mdxToHtml} from '@docusaurus/utils';
 import {DocusaurusConfig} from '@docusaurus/types';
@@ -68,15 +68,24 @@ export async function generateBlogFeed({
       id,
       metadata: {title: metadataTitle, permalink, date, description, authors},
     } = post;
-    feed.addItem({
+
+    const feedItem: FeedItem = {
       title: metadataTitle,
       id,
       link: normalizeUrl([siteUrl, permalink]),
       date,
       description,
       content: mdxToFeedContent(post.content),
-      author: authors.map(toFeedAuthor),
-    });
+    };
+
+    // 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;
+    }
+
+    feed.addItem(feedItem);
   });
 
   return feed;
@@ -85,15 +94,26 @@ export async function generateBlogFeed({
 async function createBlogFeedFile({
   feed,
   feedType,
-  filePath,
+  generatePath,
 }: {
   feed: Feed;
   feedType: FeedType;
-  filePath: string;
+  generatePath: string;
 }) {
-  const feedContent = feedType === 'rss' ? feed.rss2() : feed.atom1();
+  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.outputFile(filePath, feedContent);
+    await fs.outputFile(path.join(generatePath, feedPath), feedContent);
   } catch (err) {
     throw new Error(`Generating ${feedType} feed failed: ${err}.`);
   }
@@ -118,12 +138,12 @@ export async function createBlogFeedFiles({
   }
 
   await Promise.all(
-    feedTypes.map(async (feedType) => {
-      await createBlogFeedFile({
+    feedTypes.map((feedType) =>
+      createBlogFeedFile({
         feed,
         feedType,
-        filePath: path.join(outDir, options.routeBasePath, `${feedType}.xml`),
-      });
-    }),
+        generatePath: path.join(outDir, options.routeBasePath),
+      }),
+    ),
   );
 }

package/src/index.ts

@@ -550,6 +550,11 @@ export default function pluginContentBlog(
           path: 'atom.xml',
           title: `${feedTitle} Atom Feed`,
         },
+        json: {
+          type: 'application/json',
+          path: 'feed.json',
+          title: `${feedTitle} JSON Feed`,
+        },
       };
       const headTags: HtmlTags = [];
 

package/src/pluginOptionSchema.ts

@@ -90,12 +90,12 @@ export const PluginOptionSchema = Joi.object<PluginOptions>({
   feedOptions: Joi.object({
     type: Joi.alternatives()
       .try(
-        Joi.array().items(Joi.string()),
+        Joi.array().items(Joi.string().equal('rss', 'atom', 'json')),
         Joi.alternatives().conditional(
-          Joi.string().equal('all', 'rss', 'atom'),
+          Joi.string().equal('all', 'rss', 'atom', 'json'),
           {
             then: Joi.custom((val) =>
-              val === 'all' ? ['rss', 'atom'] : [val],
+              val === 'all' ? ['rss', 'atom', 'json'] : [val],
             ),
           },
         ),

package/src/types.ts

@@ -24,7 +24,7 @@ export interface BlogContent {
   blogTagsListPath: string | null;
 }
 
-export type FeedType = 'rss' | 'atom';
+export type FeedType = 'rss' | 'atom' | 'json';
 
 export type FeedOptions = {
   type?: FeedType[] | null;