@rspress/plugin-rss 2.0.6 → 2.0.8

package/dist/index.d.ts

@@ -28,7 +28,7 @@ export declare interface FeedChannel extends PartialPartial<FeedOptions, 'title'
      * @param page page data
      * @returns modified feed item
      */
-    item?: (item: FeedItem, page: PageIndexInfo) => FeedItem | PromiseLike<FeedItem>;
+    item?: (item: FeedItem, page: PageIndexInfo, siteUrl: string) => FeedItem | PromiseLike<FeedItem>;
     /**
      * feed level output config
      */
@@ -62,8 +62,20 @@ export declare interface FeedOutputOptions {
      * sort feed items
      */
     sorting?: (left: FeedItem, right: FeedItem) => number;
+    /**
+     * transform the final generated feed content before it is written to disk.
+     */
+    transform?: FeedOutputTransformer;
 }
 
+export declare interface FeedOutputTransformContext {
+    type: FeedOutputType;
+    feed: Feed;
+    channel: FeedChannel;
+}
+
+export declare type FeedOutputTransformer = (content: string, context: FeedOutputTransformContext) => string | PromiseLike<string>;
+
 /**
  * output feed file type
  */
@@ -140,6 +152,8 @@ export declare interface PluginRssOptions {
     output?: Omit<FeedOutputOptions, 'filename'>;
 }
 
+export declare function renderFeedContent(feed: Feed, channel: FeedChannel, output: ResolvedOutput): Promise<string>;
+
 declare interface ResolvedOutput {
     type: FeedOutputType;
     mime: string;
@@ -149,6 +163,7 @@ declare interface ResolvedOutput {
     publicPath: string;
     url: string;
     sorting: (left: FeedItem, right: FeedItem) => number;
+    transform?: FeedOutputTransformer;
 }
 
 export declare function testPage(test: FeedChannel['test'], page: PageIndexInfo): boolean;

package/dist/index.js

@@ -1,8 +1,9 @@
 import { resolve } from "node:url";
 import { promises } from "node:fs";
-import node_path, { dirname } from "node:path";
+import node_path from "node:path";
 import { getIconUrlPath } from "@rspress/core";
 import { Feed } from "feed";
+import * as __rspack_external_node_path_c5b9b54f from "node:path";
 function notNullish(n) {
     return null != n;
 }
@@ -27,7 +28,7 @@ function sortByDate(l, r) {
     return (r ? r.getTime() : 0) - (l ? l.getTime() : 0);
 }
 async function writeFile(path, content) {
-    const dir = dirname(path);
+    const dir = __rspack_external_node_path_c5b9b54f.dirname(path);
     await promises.mkdir(dir, {
         mode: 493,
         recursive: true
@@ -137,6 +138,15 @@ function getFeedFileType(type) {
             };
     }
 }
+async function renderFeedContent(feed, channel, output) {
+    const content = output.getContent(feed);
+    if (!output.transform) return content;
+    return output.transform(content, {
+        type: output.type,
+        feed,
+        channel
+    });
+}
 function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
     const type = output?.type || globalOutput?.type || 'atom';
     const { extension, mime, getContent } = getFeedFileType(type);
@@ -149,6 +159,7 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
         filename
     ].reduce((u, part)=>u ? resolve(u, part) : part);
     const sorting = output?.sorting || globalOutput?.sorting || ((l, r)=>sortByDate(l.date, r.date));
+    const transform = output?.transform || globalOutput?.transform;
     return {
         type,
         mime,
@@ -157,7 +168,8 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
         dir,
         publicPath,
         url,
-        sorting
+        sorting,
+        transform
     };
 }
 class FeedsSet {
@@ -195,7 +207,7 @@ class FeedsSet {
 async function getRssItems(feeds, page, siteUrl, htmlContent) {
     return Promise.all(feeds.filter((options)=>testPage(options.test, page)).map(async (options)=>{
         const after = options.item || ((feed)=>feed);
-        const item = await after(generateFeedItem(page, siteUrl, htmlContent), page);
+        const item = await after(generateFeedItem(page, siteUrl, htmlContent), page, siteUrl);
         return {
             ...item,
             channel: options.id
@@ -253,13 +265,14 @@ function pluginRss(pluginRssOptions) {
                 }
             }
             for (const [channel, feed] of Object.entries(feeds)){
-                const { output } = feedsSet.get(channel);
+                const feedChannel = feedsSet.get(channel);
+                const { output } = feedChannel;
                 feed.items.sort(output.sorting);
                 const path = node_path.resolve(outDir, output.dir, output.filename);
-                await writeFile(path, output.getContent(feed));
+                await writeFile(path, await renderFeedContent(feed, feedChannel, output));
             }
             _pagesForRss = null;
         }
     };
 }
-export { PluginComponents, PluginName, createFeed, generateFeedItem, getDefaultFeedOption, getFeedFileType, getOutputInfo, pluginRss, testPage };
+export { PluginComponents, PluginName, createFeed, generateFeedItem, getDefaultFeedOption, getFeedFileType, getOutputInfo, pluginRss, renderFeedContent, testPage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rspress/plugin-rss",
-  "version": "2.0.6",
+  "version": "2.0.8",
   "description": "A plugin for rss generation for rspress",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
@@ -28,7 +28,7 @@
     "feed": "^5.2.0"
   },
   "devDependencies": {
-    "@rslib/core": "0.20.0",
+    "@rslib/core": "0.20.2",
     "@types/node": "^22.8.1",
     "@types/react": "^19.2.14",
     "react": "^19.2.4",
@@ -36,7 +36,7 @@
     "typescript": "^5.8.2"
   },
   "peerDependencies": {
-    "@rspress/core": "^2.0.6"
+    "@rspress/core": "^2.0.8"
   },
   "engines": {
     "node": "^20.19.0 || >=22.12.0"