@rspress/plugin-rss 2.0.0-beta.0 → 2.0.0-beta.10

package/README.md

@@ -2,4 +2,4 @@
 
 > RSS plugin for rspress
 
-[Documentation](https://rspress.dev/plugin/official-plugins/rss)
+[Documentation](https://rspress.rs/plugin/official-plugins/rss)

package/dist/{index.mjs → index.js}

@@ -1,5 +1,6 @@
 import * as __WEBPACK_EXTERNAL_MODULE_node_path_c5b9b54f__ from "node:path";
 import * as __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__ from "node:url";
+import * as __WEBPACK_EXTERNAL_MODULE__rspress_shared_node_utils_78947ce6__ from "@rspress/shared/node-utils";
 import * as __WEBPACK_EXTERNAL_MODULE_feed__ from "feed";
 import * as __WEBPACK_EXTERNAL_MODULE_node_fs_5ea92f0c__ from "node:fs";
 function notNullish(n) {
@@ -49,11 +50,10 @@ function generateFeedItem(page, siteUrl) {
     };
 }
 function createFeed(options, config) {
-    var _config_themeConfig_footer, _config_themeConfig;
     const { output, item, id, title, ..._options } = options;
     return {
         id,
-        copyright: (null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_footer = _config_themeConfig.footer) ? void 0 : _config_themeConfig_footer.message) || '',
+        copyright: config.themeConfig?.footer?.message || '',
         description: config.description || '',
         link: output.url,
         ..._options,
@@ -119,17 +119,17 @@ function getFeedFileType(type) {
     }
 }
 function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
-    const type = (null == output ? void 0 : output.type) || (null == globalOutput ? void 0 : globalOutput.type) || 'atom';
+    const type = output?.type || globalOutput?.type || 'atom';
     const { extension, mime, getContent } = getFeedFileType(type);
-    const filename = (null == output ? void 0 : output.filename) || `${id}.${extension}`;
-    const dir = (null == output ? void 0 : output.dir) || (null == globalOutput ? void 0 : globalOutput.dir) || 'rss';
-    const publicPath = (null == output ? void 0 : output.publicPath) || (null == globalOutput ? void 0 : globalOutput.publicPath) || siteUrl;
+    const filename = output?.filename || `${id}.${extension}`;
+    const dir = output?.dir || globalOutput?.dir || 'rss';
+    const publicPath = output?.publicPath || globalOutput?.publicPath || siteUrl;
     const url = [
         publicPath,
         `${dir}/`,
         filename
     ].reduce((u, part)=>u ? (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(u, part) : part);
-    const sorting = (null == output ? void 0 : output.sorting) || (null == globalOutput ? void 0 : globalOutput.sorting) || ((l, r)=>sortByDate(l.date, r.date));
+    const sorting = output?.sorting || globalOutput?.sorting || ((l, r)=>sortByDate(l.date, r.date));
     return {
         type,
         mime,
@@ -141,30 +141,20 @@ function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
         sorting
     };
 }
-function _define_property(obj, key, value) {
-    if (key in obj) Object.defineProperty(obj, key, {
-        value: value,
-        enumerable: true,
-        configurable: true,
-        writable: true
-    });
-    else obj[key] = value;
-    return obj;
-}
 class FeedsSet {
+    feeds = [];
+    feedsMapById = Object.create(null);
     set({ feed, output, siteUrl }, config) {
         this.feeds = (Array.isArray(feed) ? feed : [
             {
                 ...getDefaultFeedOption(),
                 ...feed
             }
-        ]).map((options)=>{
-            var _config_themeConfig_footer, _config_themeConfig;
-            return {
+        ]).map((options)=>({
                 title: config.title || '',
                 description: config.description || '',
-                favicon: config.icon && (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(siteUrl, config.icon),
-                copyright: (null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_footer = _config_themeConfig.footer) ? void 0 : _config_themeConfig_footer.message) || '',
+                favicon: config.icon && (0, __WEBPACK_EXTERNAL_MODULE_node_url_e96de089__.resolve)(siteUrl, (0, __WEBPACK_EXTERNAL_MODULE__rspress_shared_node_utils_78947ce6__.getIconUrlPath)(config.icon)),
+                copyright: config.themeConfig?.footer?.message || '',
                 link: siteUrl,
                 docs: '',
                 ...options,
@@ -172,8 +162,7 @@ class FeedsSet {
                     siteUrl,
                     output
                 })
-            };
-        });
+            }));
         this.feedsMapById = this.feeds.reduce((m, f)=>({
                 ...m,
                 [f.id]: f
@@ -183,10 +172,6 @@ class FeedsSet {
         if (id) return this.feedsMapById[id] || null;
         return this.feeds.slice(0);
     }
-    constructor(){
-        _define_property(this, "feeds", []);
-        _define_property(this, "feedsMapById", Object.create(null));
-    }
 }
 function getRssItems(feeds, page, config, siteUrl) {
     return Promise.all(feeds.filter((options)=>testPage(options.test, page, config.base)).map(async (options)=>{

package/package.json

@@ -1,24 +1,23 @@
 {
   "name": "@rspress/plugin-rss",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.10",
   "description": "A plugin for rss generation for rspress",
   "bugs": "https://github.com/web-infra-dev/rspress/issues",
   "repository": {
     "type": "git",
-    "url": "https://github.com/web-infra-dev/rspress",
+    "url": "git+https://github.com/web-infra-dev/rspress.git",
     "directory": "packages/plugin-rss"
   },
   "license": "MIT",
+  "type": "module",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.mjs",
-      "default": "./dist/index.cjs"
+      "default": "./dist/index.js"
     },
-    "./FeedsAnnotations": "./static/global-components/FeedsAnnotations"
+    "./FeedsAnnotations": "./static/global-components/FeedsAnnotations.tsx"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.mjs",
+  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist",
@@ -26,22 +25,22 @@
   ],
   "dependencies": {
     "feed": "^4.2.2",
-    "@rspress/shared": "2.0.0-beta.0"
+    "@rspress/shared": "2.0.0-beta.10"
   },
   "devDependencies": {
-    "@rslib/core": "0.6.5",
-    "@types/node": "^18.11.17",
-    "@types/react": "^18.3.20",
+    "@rslib/core": "0.8.0",
+    "@types/node": "^22.8.1",
+    "@types/react": "^18.3.22",
     "react": "^19.1.0",
+    "rsbuild-plugin-publint": "^0.3.2",
     "typescript": "^5.8.2",
-    "@rspress/runtime": "2.0.0-beta.0"
+    "@rspress/runtime": "2.0.0-beta.10"
   },
   "peerDependencies": {
-    "react": ">=17.0.0",
-    "rspress": "^2.0.0-beta.0"
+    "rspress": "^2.0.0-beta.10"
   },
   "engines": {
-    "node": ">=14.17.6"
+    "node": ">=18.0.0"
   },
   "publishConfig": {
     "access": "public",

package/static/global-components/FeedsAnnotations.tsx

@@ -1,14 +1,14 @@
 /// <reference path="../../index.d.ts" />
 
 import type { LinkHTMLAttributes } from 'react';
-import { Helmet, usePageData } from 'rspress/runtime';
+import { Head, usePageData } from 'rspress/runtime';
 
 export default function FeedsAnnotations() {
   const { page } = usePageData();
   const feeds = page.feeds || [];
 
   return (
-    <Helmet>
+    <Head>
       {feeds.map(({ language, url, mime }) => {
         const props: LinkHTMLAttributes<HTMLLinkElement> = {
           rel: 'alternate',
@@ -21,6 +21,6 @@ export default function FeedsAnnotations() {
         // biome-ignore lint/correctness/useJsxKeyInIterable: no key props
         return <link {...props} />;
       })}
-    </Helmet>
+    </Head>
   );
 }

package/dist/index.cjs

@@ -1,319 +0,0 @@
-"use strict";
-var __webpack_require__ = {};
-(()=>{
-    __webpack_require__.n = (module)=>{
-        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
-        __webpack_require__.d(getter, {
-            a: getter
-        });
-        return getter;
-    };
-})();
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
-    };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
-        });
-    };
-})();
-var __webpack_exports__ = {};
-__webpack_require__.r(__webpack_exports__);
-__webpack_require__.d(__webpack_exports__, {
-    getDefaultFeedOption: ()=>getDefaultFeedOption,
-    PluginComponents: ()=>PluginComponents,
-    createFeed: ()=>createFeed,
-    getFeedFileType: ()=>getFeedFileType,
-    PluginName: ()=>PluginName,
-    generateFeedItem: ()=>generateFeedItem,
-    getOutputInfo: ()=>getOutputInfo,
-    testPage: ()=>testPage,
-    pluginRss: ()=>pluginRss
-});
-const external_node_path_namespaceObject = require("node:path");
-var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
-const external_node_url_namespaceObject = require("node:url");
-const external_feed_namespaceObject = require("feed");
-function notNullish(n) {
-    return null != n;
-}
-function concatArray(...arrList) {
-    return arrList.reduce((arr, item)=>arr.concat((Array.isArray(item) ? item : [
-            item
-        ]).filter(notNullish)), []);
-}
-function selectNonNullishProperty(...list) {
-    for (const item of list){
-        if ('' === item) return '';
-        if (0 === item) return '0';
-        if ('number' == typeof item) return `${item}`;
-        if ('string' == typeof item) return item;
-    }
-}
-function toDate(s) {
-    const d = new Date(s);
-    return Number.isNaN(d.getDate()) ? null : d;
-}
-function sortByDate(l, r) {
-    return (r ? r.getTime() : 0) - (l ? l.getTime() : 0);
-}
-const external_node_fs_namespaceObject = require("node:fs");
-async function writeFile(path, content) {
-    const dir = external_node_path_namespaceObject.dirname(path);
-    await external_node_fs_namespaceObject.promises.mkdir(dir, {
-        mode: 493,
-        recursive: true
-    });
-    return external_node_fs_namespaceObject.promises.writeFile(path, content);
-}
-function generateFeedItem(page, siteUrl) {
-    const { frontmatter: fm } = page;
-    return {
-        id: selectNonNullishProperty(fm.slug, fm.id, page.id) || '',
-        title: selectNonNullishProperty(fm.title, page.title) || '',
-        author: toAuthors(fm.author),
-        link: (0, external_node_url_namespaceObject.resolve)(siteUrl, selectNonNullishProperty(fm.permalink, page.routePath) || ''),
-        description: selectNonNullishProperty(fm.description) || '',
-        content: selectNonNullishProperty(fm.summary, page._html) || '',
-        date: toDate(fm.date || fm.published_at),
-        category: concatArray(fm.categories, fm.category).map((cat)=>({
-                name: cat
-            }))
-    };
-}
-function createFeed(options, config) {
-    var _config_themeConfig_footer, _config_themeConfig;
-    const { output, item, id, title, ..._options } = options;
-    return {
-        id,
-        copyright: (null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_footer = _config_themeConfig.footer) ? void 0 : _config_themeConfig_footer.message) || '',
-        description: config.description || '',
-        link: output.url,
-        ..._options,
-        title: title || config.title || ''
-    };
-}
-function toAuthors(author) {
-    const authors = (Array.isArray(author) ? author : [
-        author
-    ]).filter(Boolean).map((author)=>({
-            ...'string' == typeof author ? {
-                name: author
-            } : author
-        }));
-    return authors.length ? authors : void 0;
-}
-const PluginName = '@rspress/plugin-rss';
-const PluginComponents = {
-    FeedsAnnotations: '@rspress/plugin-rss/FeedsAnnotations'
-};
-function testPage(test, page, base = '/') {
-    if (Array.isArray(test)) return test.some((item)=>testPage(item, page, base));
-    if ('function' == typeof test) return test(page, base);
-    const routePath = page.routePath;
-    const pureRoutePath = `/${routePath.startsWith(base) ? routePath.slice(base.length) : routePath}`.replace(/^\/+/, '/');
-    if ('string' == typeof test) return [
-        routePath,
-        pureRoutePath
-    ].some((path)=>path.startsWith(test));
-    if (test instanceof RegExp) return [
-        routePath,
-        pureRoutePath
-    ].some((path)=>test.test(path));
-    throw new Error('test must be of `RegExp` or `string` or `(page: PageIndexInfo, base: string) => boolean`');
-}
-function getDefaultFeedOption() {
-    return {
-        id: 'blog',
-        test: '/blog/'
-    };
-}
-function getFeedFileType(type) {
-    switch(type){
-        case 'rss':
-            return {
-                extension: 'rss',
-                mime: 'application/rss+xml',
-                getContent: (feed)=>feed.rss2()
-            };
-        case 'json':
-            return {
-                extension: 'json',
-                mime: 'application/json',
-                getContent: (feed)=>feed.json1()
-            };
-        case 'atom':
-        default:
-            return {
-                extension: 'xml',
-                mime: 'application/atom+xml',
-                getContent: (feed)=>feed.atom1()
-            };
-    }
-}
-function getOutputInfo({ id, output }, { siteUrl, output: globalOutput }) {
-    const type = (null == output ? void 0 : output.type) || (null == globalOutput ? void 0 : globalOutput.type) || 'atom';
-    const { extension, mime, getContent } = getFeedFileType(type);
-    const filename = (null == output ? void 0 : output.filename) || `${id}.${extension}`;
-    const dir = (null == output ? void 0 : output.dir) || (null == globalOutput ? void 0 : globalOutput.dir) || 'rss';
-    const publicPath = (null == output ? void 0 : output.publicPath) || (null == globalOutput ? void 0 : globalOutput.publicPath) || siteUrl;
-    const url = [
-        publicPath,
-        `${dir}/`,
-        filename
-    ].reduce((u, part)=>u ? (0, external_node_url_namespaceObject.resolve)(u, part) : part);
-    const sorting = (null == output ? void 0 : output.sorting) || (null == globalOutput ? void 0 : globalOutput.sorting) || ((l, r)=>sortByDate(l.date, r.date));
-    return {
-        type,
-        mime,
-        filename,
-        getContent,
-        dir,
-        publicPath,
-        url,
-        sorting
-    };
-}
-function _define_property(obj, key, value) {
-    if (key in obj) Object.defineProperty(obj, key, {
-        value: value,
-        enumerable: true,
-        configurable: true,
-        writable: true
-    });
-    else obj[key] = value;
-    return obj;
-}
-class FeedsSet {
-    set({ feed, output, siteUrl }, config) {
-        this.feeds = (Array.isArray(feed) ? feed : [
-            {
-                ...getDefaultFeedOption(),
-                ...feed
-            }
-        ]).map((options)=>{
-            var _config_themeConfig_footer, _config_themeConfig;
-            return {
-                title: config.title || '',
-                description: config.description || '',
-                favicon: config.icon && (0, external_node_url_namespaceObject.resolve)(siteUrl, config.icon),
-                copyright: (null == (_config_themeConfig = config.themeConfig) ? void 0 : null == (_config_themeConfig_footer = _config_themeConfig.footer) ? void 0 : _config_themeConfig_footer.message) || '',
-                link: siteUrl,
-                docs: '',
-                ...options,
-                output: getOutputInfo(options, {
-                    siteUrl,
-                    output
-                })
-            };
-        });
-        this.feedsMapById = this.feeds.reduce((m, f)=>({
-                ...m,
-                [f.id]: f
-            }), Object.create(null));
-    }
-    get(id) {
-        if (id) return this.feedsMapById[id] || null;
-        return this.feeds.slice(0);
-    }
-    constructor(){
-        _define_property(this, "feeds", []);
-        _define_property(this, "feedsMapById", Object.create(null));
-    }
-}
-function getRssItems(feeds, page, config, siteUrl) {
-    return Promise.all(feeds.filter((options)=>testPage(options.test, page, config.base)).map(async (options)=>{
-        const after = options.item || ((feed)=>feed);
-        const item = await after(generateFeedItem(page, siteUrl), page, siteUrl);
-        return {
-            ...item,
-            channel: options.id
-        };
-    }));
-}
-function pluginRss(pluginRssOptions) {
-    const feedsSet = new FeedsSet();
-    let _rssWorkaround = null;
-    let _config;
-    return {
-        name: PluginName,
-        globalUIComponents: Object.values(PluginComponents),
-        beforeBuild (config, isProd) {
-            if (!isProd) {
-                _rssWorkaround = null;
-                return;
-            }
-            _rssWorkaround = {};
-            _config = config;
-            feedsSet.set(pluginRssOptions, config);
-        },
-        async extendPageData (pageData) {
-            if (!_rssWorkaround) return;
-            _rssWorkaround[pageData.id] = _rssWorkaround[pageData.id] || getRssItems(feedsSet.get(), pageData, _config, pluginRssOptions.siteUrl);
-            const feeds = await _rssWorkaround[pageData.id];
-            const showRssList = new Set(concatArray(pageData.frontmatter['link-rss']));
-            for (const feed of feeds)showRssList.add(feed.channel);
-            pageData.feeds = Array.from(showRssList, (id)=>{
-                const { output, language } = feedsSet.get(id);
-                return {
-                    url: output.url,
-                    mime: output.mime,
-                    language: language || pageData.lang
-                };
-            });
-        },
-        async afterBuild (config) {
-            if (!_rssWorkaround) return;
-            const items = concatArray(...await Promise.all(Object.values(_rssWorkaround)));
-            const feeds = Object.create(null);
-            for (const { channel, ...item } of items){
-                feeds[channel] = feeds[channel] || new external_feed_namespaceObject.Feed(createFeed(feedsSet.get(channel), config));
-                feeds[channel].addItem(item);
-            }
-            for (const [channel, feed] of Object.entries(feeds)){
-                const { output } = feedsSet.get(channel);
-                feed.items.sort(output.sorting);
-                const path = external_node_path_default().resolve(config.outDir || 'doc_build', output.dir, output.filename);
-                await writeFile(path, output.getContent(feed));
-            }
-            _rssWorkaround = null;
-            _config = null;
-        }
-    };
-}
-exports.PluginComponents = __webpack_exports__.PluginComponents;
-exports.PluginName = __webpack_exports__.PluginName;
-exports.createFeed = __webpack_exports__.createFeed;
-exports.generateFeedItem = __webpack_exports__.generateFeedItem;
-exports.getDefaultFeedOption = __webpack_exports__.getDefaultFeedOption;
-exports.getFeedFileType = __webpack_exports__.getFeedFileType;
-exports.getOutputInfo = __webpack_exports__.getOutputInfo;
-exports.pluginRss = __webpack_exports__.pluginRss;
-exports.testPage = __webpack_exports__.testPage;
-for(var __webpack_i__ in __webpack_exports__)if (-1 === [
-    "PluginComponents",
-    "PluginName",
-    "createFeed",
-    "generateFeedItem",
-    "getDefaultFeedOption",
-    "getFeedFileType",
-    "getOutputInfo",
-    "pluginRss",
-    "testPage"
-].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});