@anyul/koishi-plugin-rss 5.2.48 → 5.3.0

package/README.md

@@ -1,11 +1,33 @@
 # koishi-plugin-rss-owl
 
 [![npm](https://img.shields.io/npm/v/@anyul/koishi-plugin-rss?style=flat-square)](https://www.npmjs.com/package/@anyul/koishi-plugin-rss)
-![version](https://img.shields.io/badge/version-5.2.3-brightgreen)
+![version](https://img.shields.io/badge/version-5.3.0-brightgreen)
 
 > 功能强大的 Koishi RSS 订阅插件，支持多种订阅源、图片渲染、AI 摘要等高级功能
 
-当前文档基于 `v5.2.3`，已同步命令模块化、入口装配层收敛与最新模板名称。
+当前文档基于 `v5.3.0`，已同步命令模块化、原生子命令树、短别名与统一输出风格。
+
+## 📖 命令文档
+
+完整命令参考见 **[docs/COMMANDS.md](docs/COMMANDS.md)**，包含所有命令的用法、选项、示例与短别名速查表。
+
+### 命令短别名
+
+为方便聊天输入，每个命令都注册了 `rs` + 2 字母短别名（与完整写法等价）：
+
+| 短别名 | 完整命令 | 短别名 | 完整命令 |
+|--------|---------|--------|---------|
+| `rsls` | `rsso.list` | `rshm` | `rsso.html` |
+| `rsed` | `rsso.edit` | `rsak` | `rsso.ask` |
+| `rsrm` | `rsso.remove` | `rswt` | `rsso.watch` |
+| `rspl` | `rsso.pull` | `rsc` | `rsso.cache` |
+| `rsfw` | `rsso.follow` | `rsq` | `rsso.queue` |
+
+```text
+rsls              # = rsso.list
+rsed 1 -t "新标题" # = rsso.edit 1 -t "新标题"
+rsc list          # = rsso.cache list
+```
 
 ## ✨ 功能特性
 

package/lib/commands/index.d.ts

@@ -1,6 +1,7 @@
 import { Context } from 'koishi';
 import type { Config } from '../types';
 import { NotificationQueueManager } from '../core/notification-queue';
+import { type CachedMessage, type MessageCacheManager } from '../utils/message-cache';
 /**
  * 管理类命令依赖
  */
@@ -9,12 +10,43 @@ export interface ManagementCommandDeps {
     config: Config;
     queueManager: NotificationQueueManager;
 }
+interface CacheCommandContext {
+    cache: MessageCacheManager;
+    platform: string;
+    guildId: string;
+    authority: number;
+    logContext?: Record<string, any>;
+}
 /**
  * 注册管理类命令
+ *
+ * 设计要点（命令系统统一）：
+ *  - cache/queue 父命令【不带 .action()】，由 Koishi 原生「无 action → 显示 help」接管，
+ *    自动在 help 菜单/网页控制台列出子命令树。
+ *  - 子命令注册为 rssowl.cache.list / rssowl.cache.stats 等真正的嵌套命令；
+ *    用户在聊天里输入 "rsso.cache list"（带空格）时，Koishi 核心路由
+ *    （inferCommand, core index.mjs:1377-1405）会自动解析到 rssowl.cache.list 子命令，
+ *    输入方式与旧版完全一致，但获得了菜单可见性。
+ *  - 父命令 rssowl.cache 必须无位置参数（`ctx.command('rssowl.cache', ...)`），
+ *    否则路由会在父命令处 break，导致 list 被当作位置参数而非子命令。
  */
 export declare function registerManagementCommands(deps: ManagementCommandDeps): void;
+declare function handleCacheList(cmdCtx: CacheCommandContext, args: string[], config: Config): Promise<string>;
+declare function handleCacheMessage(cmdCtx: CacheCommandContext, args: string[], config: Config): Promise<string>;
+declare function handleCacheSearch(cmdCtx: CacheCommandContext, args: string[], config: Config): Promise<string>;
+declare function handleCacheStats(cmdCtx: CacheCommandContext, config: Config): Promise<string>;
+declare function handleCacheClear(cmdCtx: CacheCommandContext, config: Config): Promise<string>;
+declare function handleCacheCleanup(cmdCtx: CacheCommandContext, args: string[], config: Config): Promise<string>;
+declare function handleCachePull(ctx: Context, queueManager: NotificationQueueManager, session: any, cmdCtx: CacheCommandContext, args: string[], config: Config): Promise<string>;
+/**
+ * 按真实数据库 ID 取缓存消息，并校验其归属当前群组（防跨群越权）。
+ * 即使攻击者猜到其他群的 ID，也会因 platform/guildId 不匹配而被拦截。
+ */
+declare function resolveCacheMessageById(cmdCtx: CacheCommandContext, realId: number): Promise<CachedMessage | null>;
 export { registerSubscriptionManagementCommands } from './subscription-management';
 export { registerSubscriptionEditCommand } from './subscription-edit';
 export { registerSubscriptionCreateCommand } from './subscription-create';
 export { registerWebMonitorCommands } from './web-monitor';
 export { createCommandRuntimeDeps } from './runtime';
+export type { CacheCommandContext };
+export { resolveCacheMessageById, handleCacheList, handleCacheMessage, handleCacheSearch, handleCacheStats, handleCacheClear, handleCacheCleanup, handleCachePull, };