rss-pal-dsh 0.0.0-stage → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 MoreFreeze
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.en.md ADDED
@@ -0,0 +1,110 @@
1
+ # RSS Pal for DeepSeek Harness
2
+
3
+ [简体中文](README.md) · **English**
4
+
5
+ **A local-first reading room inside DSH: RSS subscriptions, full-text search, bulk read marking, on-demand AI summaries and a native reading companion.**
6
+
7
+ - Repository: <https://github.com/morefreeze/dsh-plugin-rss-pal>
8
+ - Plugin package: `rss-pal-dsh` · Version: `0.1.0`
9
+ - Marketplace category: **Data & Knowledge (knowledge)**
10
+ - License: [MIT](LICENSE)
11
+ - A community plugin, not affiliated with DeepSeek AI.
12
+
13
+ ## Features
14
+
15
+ - RSS / Atom subscription previews, groups, pause/resume, scheduled and manual refresh, and OPML import/export.
16
+ - Webpage full-text extraction and refetching, Chinese full-text search, pagination, favorites, tags, likes and dislikes.
17
+ - A three-dot menu on each article: mark this article, this article and everything above, or this article and everything below as read. Ranges include the current article and span pages within the current subscription, filter, search and tag scope, while preserving a nearby list anchor.
18
+ - Foreground reading time, open counts and progress. Tracking pauses when the window is hidden, loses focus, or receives no activity for 120 seconds.
19
+ - On-demand brief summaries and detailed analysis, with templates, streaming background jobs, cached results and stale-summary indicators when article content changes.
20
+ - An independently remembered summary-model selection, following the host default initially. Reasoning options reflect the host model's actual capabilities; selecting a summary model does not change the host's global default.
21
+ - Native DSH reading companion for whole articles and selected passages, using the host's model picker, composer and conversations.
22
+ - URL clipping, Markdown export, local backup/restore, job retry/cancellation and Agent tools.
23
+
24
+ **Models are called only when you click Generate or explicitly invoke the summary tool.** Opening articles, refreshing feeds and searching do not automatically generate summaries. Ordinary reading requires no model account.
25
+
26
+ ## Screenshot
27
+
28
+ ![Mobile article list and bulk read menu](docs/screenshots/read-menu-mobile.png)
29
+
30
+ An actual DSH Web screenshot at mobile width, showing the article action menu. Host conversation lists and account information are excluded.
31
+
32
+ ## Installation
33
+
34
+ ### Install from GitHub — current distribution channel
35
+
36
+ ```sh
37
+ dsh plugin --profile web add github:morefreeze/dsh-plugin-rss-pal
38
+ ```
39
+
40
+ The repository includes prebuilt `lib/index.js` and `lib/client.js`, so installing the plugin does not require compiling its source. `better-sqlite3` is a native dependency: if the installer requests build approval, approve the native build for that dependency only. Enable **RSS Pal** in the plugin manager and refresh the page. New Host modules require reloading the plugin or the host.
41
+
42
+ ### Install a release package
43
+
44
+ Download `rss-pal-dsh-0.1.0.tgz` from [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases):
45
+
46
+ ```sh
47
+ dsh plugin --profile web add ./rss-pal-dsh-0.1.0.tgz
48
+ ```
49
+
50
+ npm publication status: **not yet published**. Some marketplace websites accept GitHub-source listings; npm-backed one-click entries in the DSH plugin center require npm publication and marketplace verification. The package name will remain `rss-pal-dsh` when published.
51
+
52
+ ## Compatibility and runtime requirements
53
+
54
+ | Item | Requirement / verification scope |
55
+ | --- | --- |
56
+ | DSH profile | `web` |
57
+ | Declared DSH versions | `0.2.1-rc.5`, `0.2.2-rc.1` |
58
+ | Runtime-tested environment | macOS, DeepSeek Harness `0.2.1-rc.5` Web |
59
+ | Node.js | `>=22.19.0`; the selected DSH release may require a newer version |
60
+ | Database | Local SQLite through the `better-sqlite3` native module |
61
+ | Other environments | Windows, Linux, Desktop and DSH `0.2.2-rc.1` have not been runtime-tested |
62
+
63
+ ## Permissions, external services and data
64
+
65
+ - The Host reads and writes the SQLite library and pre-restore backups under `storages/rss-pal-dsh/` in Harness home. Uninstalling the plugin preserves reading data.
66
+ - Network access is used for user-added RSS / Atom feeds, webpages and remote images in article content. Full-text extraction depends on the source site's content and access conditions.
67
+ - On-demand summarization sends article content to the selected host model. The reading companion uses host conversations and model configuration; model services may incur charges.
68
+ - No additional account system, separate model credentials, telemetry or cloud synchronization. The original RSS Pal server, Go, PostgreSQL and Docker are not required.
69
+ - Feeds refresh every 60 minutes by default; set the interval to `0` to disable scheduled refresh. Refresh runs only while the host is running. Pausing a subscription preserves its articles.
70
+ - Backups contain subscriptions, article content, reading history and summaries, but not host model credentials. Restore validates the input, replaces data transactionally and preserves a pre-restore backup. Running jobs must finish or be cancelled first.
71
+
72
+ This version does not include personalized recommendations, daily/weekly digests, audio/video subtitles, PDF / OCR, public sharing or a browser extension.
73
+
74
+ ## Agent tools
75
+
76
+ `rsspal_list_feeds`, `rsspal_list_articles`, `rsspal_read_article`, `rsspal_search`, `rsspal_subscribe`, `rsspal_refresh`, `rsspal_capture`, `rsspal_summarize`, `rsspal_jobs`, `rsspal_set_state`, `rsspal_export_markdown`.
77
+
78
+ Agent reads do not count toward human reading time. The summary tool should be invoked only when explicitly requested by the user.
79
+
80
+ ## Development and testing
81
+
82
+ Install development dependencies:
83
+
84
+ ```sh
85
+ npm ci --include=dev
86
+ ```
87
+
88
+ The `@deepseek-ai` runtime dependencies are provided by DSH. For development, also install the following four packages at the same version as your target DSH release:
89
+
90
+ ```sh
91
+ npm install --include=dev --save-dev --package-lock=false \
92
+ @deepseek-ai/dsh-tools@0.2.1-rc.5 \
93
+ @deepseek-ai/dsh-llm@0.2.1-rc.5 \
94
+ @deepseek-ai/dsh-home-paths@0.2.1-rc.5 \
95
+ @deepseek-ai/dsh-typert-protocol@0.2.1-rc.5
96
+ npm run check
97
+ npm pack
98
+ ```
99
+
100
+ `npm run check` performs type checking, Host / Client builds and the full regression suite.
101
+
102
+ The Host entry is the Cordis `RssPalService` plugin class. The Web Client exports `apply(ctx)` from `src/client/index.tsx`, registering the RSS Pal panel, Remote methods and native companion. The client includes KaTeX styles and fonts, without an additional formula-font service.
103
+
104
+ ## Verification
105
+
106
+ Current regression baseline: **88 passing tests**, covering transactional read ranges, filter isolation, pagination/filter navigation during pending writes, reading tracking, explicit summary generation and model selection. Desktop and mobile-width layouts, single-article read-state RPC and the native reading companion have been verified in actual DSH Web.
107
+
108
+ ## Acknowledgments
109
+
110
+ Inspired by RSS Pal. Article extraction and sanitization use Mozilla Readability, DOMPurify and other open-source projects. Dependencies retain their respective licenses.
package/README.md CHANGED
@@ -1,3 +1,112 @@
1
- # Temporary Holding Version
1
+ # RSS Pal for DeepSeek Harness
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ **简体中文** · [English](README.en.md)
4
+
5
+ **DSH 内的本地 RSS 阅读室:订阅、全文搜索、批量已读、手动 AI 总结与原生伴读。**
6
+
7
+ A local-first RSS/Atom reader for DeepSeek Harness, with full-text search, on-demand AI summaries and a native reading companion.
8
+
9
+ - 仓库:<https://github.com/morefreeze/dsh-plugin-rss-pal>
10
+ - 插件包名:`rss-pal-dsh` · 版本:`0.1.0`
11
+ - 市场能力分类:**Data & Knowledge (knowledge) / 数据与知识**
12
+ - 许可证:[MIT](LICENSE)
13
+ - 社区插件,与 DeepSeek AI 官方无隶属关系。
14
+
15
+ ## 功能
16
+
17
+ - RSS / Atom 订阅预览、分组、暂停、定时与手动刷新,OPML 导入导出。
18
+ - 网页全文提取与重抓、中文全文搜索、分页、收藏、标签、点赞与不喜欢。
19
+ - 每篇文章的三点菜单:标记已读、标记这篇及以上 / 以下已读。范围包含本篇,按当前订阅、筛选、搜索、标签跨分页计算,并保留附近列表锚点。
20
+ - 前台活跃阅读时长、次数与进度;隐藏窗口、失焦及连续 120 秒无操作时暂停计时。
21
+ - 手动生成简短摘要和详细分析,支持模板、流式后台任务、结果缓存与正文变化标记。
22
+ - 总结模型独立选择并记忆,默认跟随宿主;推理强度按宿主真实模型能力显示,不修改宿主全局默认模型。
23
+ - 文章与选段接入 DSH 原生伴读,使用原生模型选择、输入框和会话。
24
+ - URL 网摘、Markdown 导出、本地备份恢复、任务重试 / 取消及 Agent 工具。
25
+
26
+ **只有用户点击生成或明确调用总结工具时才调用模型。** 打开文章、刷新订阅和搜索不自动生成总结。普通阅读无需模型账号。
27
+
28
+ ## 截图
29
+
30
+ ![手机文章列表与批量已读菜单](docs/screenshots/read-menu-mobile.png)
31
+
32
+ 实际 DSH Web 手机宽度截图,展示三点菜单;未包含宿主会话列表或账号信息。
33
+
34
+ ## 安装
35
+
36
+ ### 从 GitHub 安装(当前发布渠道)
37
+
38
+ ```sh
39
+ dsh plugin --profile web add github:morefreeze/dsh-plugin-rss-pal
40
+ ```
41
+
42
+ 仓库包含预构建的 `lib/index.js` 和 `lib/client.js`,安装时无需编译插件源码。`better-sqlite3` 是原生依赖;安装器提示构建审批时,只为该依赖允许原生构建。安装完成后在插件管理中启用 **RSS Pal**,刷新页面;新增 Host 模块需重载对应插件或宿主。
43
+
44
+ ### 发布包安装
45
+
46
+ 从 [GitHub Releases](https://github.com/morefreeze/dsh-plugin-rss-pal/releases) 下载 `rss-pal-dsh-0.1.0.tgz`:
47
+
48
+ ```sh
49
+ dsh plugin --profile web add ./rss-pal-dsh-0.1.0.tgz
50
+ ```
51
+
52
+ npm 发布状态:**尚未发布**。市场官网支持 GitHub 源码收录;DSH 内插件中心的一键安装条目需要 npm 发布并通过市场核验。发布后包名将保持 `rss-pal-dsh`。
53
+
54
+ ## 兼容与运行要求
55
+
56
+ | 项目 | 要求 / 验证范围 |
57
+ | --- | --- |
58
+ | DSH profile | `web` |
59
+ | DSH 版本声明 | `0.2.1-rc.5`、`0.2.2-rc.1` |
60
+ | 实机验收 | macOS、DeepSeek Harness `0.2.1-rc.5` Web |
61
+ | Node.js | `>=22.19.0`;使用的 DSH 版本可能要求更高版本 |
62
+ | 数据库 | 本地 SQLite / `better-sqlite3` 原生模块 |
63
+ | 其他平台 | Windows、Linux、Desktop 和 `0.2.2-rc.1` 尚未实机验收 |
64
+
65
+ ## 权限、外部服务与数据
66
+
67
+ - Host 读写 Harness home 下 `storages/rss-pal-dsh/` 的 SQLite 资料库与恢复前备份;卸载插件保留阅读数据。
68
+ - 网络访问用户添加的 RSS / Atom 源、网页及正文中的远程图片;全文提取取决于目标网页的内容和访问条件。
69
+ - 手动总结将文章内容发送到用户选择的宿主模型;伴读使用宿主会话和模型配置,模型服务可能计费。
70
+ - 不新增账号系统、独立模型凭据、遥测或云端同步;无需原 RSS Pal 服务、Go、PostgreSQL 或 Docker。
71
+ - 默认 60 分钟刷新,设为 `0` 可关闭;仅在宿主运行时执行,暂停订阅保留文章。
72
+ - 备份包含订阅、正文、阅读历史和总结,不包含宿主模型凭据。恢复校验输入并事务替换,保留恢复前备份;运行任务需先结束或取消。
73
+
74
+ 当前版本不含兴趣推荐、日报周报、音视频字幕、PDF / OCR、公开分享或浏览器扩展。
75
+
76
+ ## Agent 工具
77
+
78
+ `rsspal_list_feeds`、`rsspal_list_articles`、`rsspal_read_article`、`rsspal_search`、`rsspal_subscribe`、`rsspal_refresh`、`rsspal_capture`、`rsspal_summarize`、`rsspal_jobs`、`rsspal_set_state`、`rsspal_export_markdown`。
79
+
80
+ Agent 阅读不会计入人类阅读时长。总结工具只在用户明确要求时调用。
81
+
82
+ ## 开发与测试
83
+
84
+ 先安装开发依赖:
85
+
86
+ ```sh
87
+ npm ci --include=dev
88
+ ```
89
+
90
+ 宿主 `@deepseek-ai` 依赖由 DSH 提供,开发时还需在当前项目安装与目标 DSH 同版的 `dsh-tools`、`dsh-llm`、`dsh-home-paths`、`dsh-typert-protocol` 四个包:
91
+
92
+ ```sh
93
+ npm install --include=dev --save-dev --package-lock=false \
94
+ @deepseek-ai/dsh-tools@0.2.1-rc.5 \
95
+ @deepseek-ai/dsh-llm@0.2.1-rc.5 \
96
+ @deepseek-ai/dsh-home-paths@0.2.1-rc.5 \
97
+ @deepseek-ai/dsh-typert-protocol@0.2.1-rc.5
98
+ npm run check
99
+ npm pack
100
+ ```
101
+
102
+ `npm run check` 执行类型检查、Host / Client 构建与全部回归测试。
103
+
104
+ Host 入口为 Cordis `RssPalService` 插件类;Web Client 在 `src/client/index.tsx` 导出 `apply(ctx)`,注册 RSS Pal 面板、Remote 与原生伴读。客户端包含 KaTeX 样式与字体,无需额外公式字体服务。
105
+
106
+ ## 验证
107
+
108
+ 当前回归:**88 项通过**,包括事务范围已读、筛选隔离、待写入期间翻页 / 切筛选竞态、阅读追踪、手动总结与模型选择。已在真实 DSH Web 验证桌面和手机布局、单篇已读 RPC 与原生伴读。
109
+
110
+ ## 致谢
111
+
112
+ 产品灵感来自 RSS Pal;正文提取与清洗使用 Mozilla Readability、DOMPurify 等开源项目。依赖各自遵循其许可证。
@@ -0,0 +1,3 @@
1
+ - insert:
2
+ - id: rss-pal-dsh
3
+ name: rss-pal-dsh