@docusaurus/plugin-content-blog 0.0.0-5850 → 0.0.0-5853

package/lib/blogUtils.d.ts

@@ -39,4 +39,8 @@ export type LinkifyParams = {
     fileString: string;
 } & Pick<BlogMarkdownLoaderOptions, 'sourceToPermalink' | 'siteDir' | 'contentPaths' | 'onBrokenMarkdownLink'>;
 export declare function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalink, onBrokenMarkdownLink, }: LinkifyParams): string;
+export declare function applyProcessBlogPosts({ blogPosts, processBlogPosts, }: {
+    blogPosts: BlogPost[];
+    processBlogPosts: PluginOptions['processBlogPosts'];
+}): Promise<BlogPost[]>;
 export {};

package/lib/blogUtils.js

@@ -6,7 +6,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
+exports.applyProcessBlogPosts = exports.linkify = exports.generateBlogPosts = exports.parseBlogFileName = exports.getBlogTags = exports.shouldBeListed = exports.paginateBlogPosts = exports.getSourceToPermalink = exports.truncate = void 0;
 const tslib_1 = require("tslib");
 const fs_extra_1 = tslib_1.__importDefault(require("fs-extra"));
 const path_1 = tslib_1.__importDefault(require("path"));
@@ -261,3 +261,11 @@ function linkify({ filePath, contentPaths, fileString, siteDir, sourceToPermalin
     return newContent;
 }
 exports.linkify = linkify;
+async function applyProcessBlogPosts({ blogPosts, processBlogPosts, }) {
+    const processedBlogPosts = await processBlogPosts({ blogPosts });
+    if (Array.isArray(processedBlogPosts)) {
+        return processedBlogPosts;
+    }
+    return blogPosts;
+}
+exports.applyProcessBlogPosts = applyProcessBlogPosts;

package/lib/index.js

@@ -50,7 +50,11 @@ async function pluginContentBlog(context, options) {
             const { postsPerPage: postsPerPageOption, routeBasePath, tagsBasePath, blogDescription, blogTitle, blogSidebarTitle, pageBasePath, } = options;
             const baseBlogUrl = (0, utils_1.normalizeUrl)([baseUrl, routeBasePath]);
             const blogTagsListPath = (0, utils_1.normalizeUrl)([baseBlogUrl, tagsBasePath]);
-            const blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
+            let blogPosts = await (0, blogUtils_1.generateBlogPosts)(contentPaths, context, options);
+            blogPosts = await (0, blogUtils_1.applyProcessBlogPosts)({
+                blogPosts,
+                processBlogPosts: options.processBlogPosts,
+            });
             const listedBlogPosts = blogPosts.filter(blogUtils_1.shouldBeListed);
             if (!blogPosts.length) {
                 return {

package/lib/options.js

@@ -39,6 +39,7 @@ exports.DEFAULT_OPTIONS = {
     authorsMapPath: 'authors.yml',
     readingTime: ({ content, defaultReadingTime }) => defaultReadingTime({ content }),
     sortPosts: 'descending',
+    processBlogPosts: async () => undefined,
 };
 const PluginOptionSchema = utils_validation_1.Joi.object({
     path: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.path),
@@ -103,6 +104,9 @@ const PluginOptionSchema = utils_validation_1.Joi.object({
     sortPosts: utils_validation_1.Joi.string()
         .valid('descending', 'ascending')
         .default(exports.DEFAULT_OPTIONS.sortPosts),
+    processBlogPosts: utils_validation_1.Joi.function()
+        .optional()
+        .default(() => exports.DEFAULT_OPTIONS.processBlogPosts),
 }).default(exports.DEFAULT_OPTIONS);
 function validateOptions({ validate, options, }) {
     const validatedOptions = validate(PluginOptionSchema, options);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-content-blog",
-  "version": "0.0.0-5850",
+  "version": "0.0.0-5853",
   "description": "Blog plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "src/plugin-content-blog.d.ts",
@@ -31,13 +31,13 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-5850",
-    "@docusaurus/logger": "0.0.0-5850",
-    "@docusaurus/mdx-loader": "0.0.0-5850",
-    "@docusaurus/types": "0.0.0-5850",
-    "@docusaurus/utils": "0.0.0-5850",
-    "@docusaurus/utils-common": "0.0.0-5850",
-    "@docusaurus/utils-validation": "0.0.0-5850",
+    "@docusaurus/core": "0.0.0-5853",
+    "@docusaurus/logger": "0.0.0-5853",
+    "@docusaurus/mdx-loader": "0.0.0-5853",
+    "@docusaurus/types": "0.0.0-5853",
+    "@docusaurus/utils": "0.0.0-5853",
+    "@docusaurus/utils-common": "0.0.0-5853",
+    "@docusaurus/utils-validation": "0.0.0-5853",
     "cheerio": "^1.0.0-rc.12",
     "feed": "^4.2.2",
     "fs-extra": "^11.1.1",
@@ -56,5 +56,8 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "eb765ec0c438553dc61bdd1de3e61cf6357bbbbf"
+  "devDependencies": {
+    "@total-typescript/shoehorn": "^0.1.2"
+  },
+  "gitHead": "46a93e74e883666a9027425bab1862f859019e3e"
 }

package/src/blogUtils.ts

@@ -422,3 +422,19 @@ export function linkify({
 
   return newContent;
 }
+
+export async function applyProcessBlogPosts({
+  blogPosts,
+  processBlogPosts,
+}: {
+  blogPosts: BlogPost[];
+  processBlogPosts: PluginOptions['processBlogPosts'];
+}): Promise<BlogPost[]> {
+  const processedBlogPosts = await processBlogPosts({blogPosts});
+
+  if (Array.isArray(processedBlogPosts)) {
+    return processedBlogPosts;
+  }
+
+  return blogPosts;
+}

package/src/index.ts

@@ -20,11 +20,12 @@ import {
   DEFAULT_PLUGIN_ID,
 } from '@docusaurus/utils';
 import {
-  generateBlogPosts,
   getSourceToPermalink,
   getBlogTags,
   paginateBlogPosts,
   shouldBeListed,
+  applyProcessBlogPosts,
+  generateBlogPosts,
 } from './blogUtils';
 import footnoteIDFixer from './remark/footnoteIDFixer';
 import {translateContent, getTranslationFiles} from './translations';
@@ -113,7 +114,11 @@ export default async function pluginContentBlog(
 
       const baseBlogUrl = normalizeUrl([baseUrl, routeBasePath]);
       const blogTagsListPath = normalizeUrl([baseBlogUrl, tagsBasePath]);
-      const blogPosts = await generateBlogPosts(contentPaths, context, options);
+      let blogPosts = await generateBlogPosts(contentPaths, context, options);
+      blogPosts = await applyProcessBlogPosts({
+        blogPosts,
+        processBlogPosts: options.processBlogPosts,
+      });
       const listedBlogPosts = blogPosts.filter(shouldBeListed);
 
       if (!blogPosts.length) {

package/src/options.ts

@@ -51,6 +51,7 @@ export const DEFAULT_OPTIONS: PluginOptions = {
   authorsMapPath: 'authors.yml',
   readingTime: ({content, defaultReadingTime}) => defaultReadingTime({content}),
   sortPosts: 'descending',
+  processBlogPosts: async () => undefined,
 };
 
 const PluginOptionSchema = Joi.object<PluginOptions>({
@@ -134,6 +135,9 @@ const PluginOptionSchema = Joi.object<PluginOptions>({
   sortPosts: Joi.string()
     .valid('descending', 'ascending')
     .default(DEFAULT_OPTIONS.sortPosts),
+  processBlogPosts: Joi.function()
+    .optional()
+    .default(() => DEFAULT_OPTIONS.processBlogPosts),
 }).default(DEFAULT_OPTIONS);
 
 export function validateOptions({

package/src/plugin-content-blog.d.ts

@@ -330,6 +330,11 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
       defaultReadingTime: ReadingTimeFunction;
     },
   ) => number | undefined;
+
+  export type ProcessBlogPostsFn = (params: {
+    blogPosts: BlogPost[];
+  }) => Promise<void | BlogPost[]>;
+
   /**
    * Plugin options after normalization.
    */
@@ -421,6 +426,10 @@ yarn workspace v1.22.19image` is a collocated image path, this entry will be the
     readingTime: ReadingTimeFunctionOption;
     /** Governs the direction of blog post sorting. */
     sortPosts: 'ascending' | 'descending';
+    /** An optional function which can be used to transform blog posts
+     *  (filter, modify, delete, etc...).
+     */
+    processBlogPosts: ProcessBlogPostsFn;
   };
 
   /**