koishi-plugin-imx 2.2.3 → 2.2.5

package/README.md

@@ -1,34 +1,52 @@
 # koishi-plugin-imx
 
-这是一个将 IMX Bot 功能移植到 Koishi 平台的插件，提供丰富的聊天机器人功能。
+[![npm](https://img.shields.io/npm/v/koishi-plugin-imx)](https://www.npmjs.com/package/koishi-plugin-imx)
+[![license](https://img.shields.io/npm/l/koishi-plugin-imx)](https://github.com/sysfox/koishi-plugin-imx/blob/main/LICENSE)
 
-## ✨ 功能特性
-
-### 🔄 复读机
-- 自动检测连续重复的消息并进行复读
-- 支持复读打断机制
+一个功能丰富的 Koishi 聊天机器人插件，集成了 Mix-Space、Bilibili、GitHub 等多种服务，为你的聊天机器人提供强大的功能扩展。
 
-### 🛠️ 工具命令
-- `tool.ip <ip>` - 查询 IP 地址信息
-- `tool.base64 <text>` - Base64 编码/解码（使用 `-d` 参数解码）
-- `tool.md5 <text>` - 计算 MD5 哈希值
+## ✨ 功能特性
 
 ### 🌸 MX Space 集成
-- 支持 MX Space API 集成
-- 自动早安/晚安问候（可配置时间）
-- 新成员加入欢迎
-- `hitokoto` - 获取一言
-
+- **Webhook 事件推送**: 支持博客文章、说说、评论等事件的实时推送
+- **定时问候**: 自动早安/晚安问候，支持 cron 表达式自定义时间
+- **新成员欢迎**: 自动欢迎新加入群组的成员
+- **评论回复**: 支持博客评论的互动回复功能
+- **博客数据查询**: 获取博客统计信息和最新动态
 
 ### 📺 Bilibili 直播监控
-- 监控指定 B站直播间开播状态
-- 开播时自动推送通知到指定频道
-- `bili.status` - 查看当前直播状态
-
-### 🐙 GitHub Webhook
-- 支持 GitHub 事件推送通知
-- 监控 Push、Issue、Pull Request 事件
-- `github.test` - 测试 GitHub 通知功能
+- **多房间监控**: 支持同时监控多个直播间的开播状态
+- **智能推送**: 开播时自动推送通知到指定频道
+- **状态查询**: `bili.status` 命令查看当前所有监控房间的直播状态
+- **广播模式**: 支持向所有联系人广播开播通知
+
+### 🐙 GitHub 集成
+- **Webhook 支持**: 监听 GitHub 仓库的各种事件
+- **多事件类型**: 支持 Push、Issue、Pull Request、工作流等事件
+- **状态查询**: `github.status` 命令查看仓库状态
+- **安全验证**: 支持 webhook 签名验证
+
+### 🛠️ 实用工具命令
+- **哈希计算**: `tools.md5`、`tools.sha256` - 计算文本哈希值
+- **IP 查询**: `tools.ip <ip>` - 查询 IP 地址的详细信息
+- **时间戳转换**: `tools.timestamp [timestamp]` - 时间戳与可读时间互转
+- **Base64 编解码**: `tools.base64 <encode|decode> <text>` - 文本编解码
+- **随机生成**: `tools.random [min] [max]` - 生成指定范围的随机数
+- **UUID 生成**: `tools.uuid` - 生成标准 UUID
+- **颜色生成**: `tools.color` - 生成随机颜色及其各种格式
+- **一言**: `tools.hitokoto` 或 `一言` - 获取随机一言
+- **短链接**: `tools.shorturl <url>` - 生成短链接
+- **二维码**: `tools.qrcode <text>` - 生成二维码图片
+
+### 🔄 智能复读机
+- **智能触发**: 自动检测连续重复的消息并按概率复读
+- **复读打断**: 连续复读到一定次数后自动打断
+- **可配置参数**: 支持自定义触发阈值、复读概率、打断阈值
+
+### 🚀 强大的广播系统
+- **全局广播**: 支持向所有联系人发送消息
+- **精准控制**: 支持排除特定频道的广播功能
+- **详细统计**: 提供发送统计和详细日志记录
 
 ## 安装
 
@@ -42,6 +60,12 @@ npm install koishi-plugin-imx
 yarn add koishi-plugin-imx
 ```
 
+也可以使用 pnpm：
+
+```bash
+pnpm add koishi-plugin-imx
+```
+
 ## 配置
 
 在 Koishi 配置文件中添加插件配置：
@@ -53,88 +77,294 @@ plugins:
     mxSpace:
       baseUrl: "https://your-mx-space-api.com"
       token: "your-mx-space-token"
-      watchChannels: ["channel-id-1", "channel-id-2"]
-      enableGreeting: true
+      webhook:
+        secret: "your-webhook-secret"
+        path: "/mx-space/webhook"
+        watchChannels: ["channel-id-1"]
+        broadcastToAll: false
+        excludeChannels: []
+      greeting:
+        enabled: true
+        channels: ["channel-id-1", "channel-id-2"]
+        morningTime: "0 0 6 * * *"  # 每天早上6点
+        eveningTime: "0 0 22 * * *"  # 每天晚上10点
+        broadcastToAll: false
+        excludeChannels: []
+      commands:
+        enabled: true
+        replyPrefix: "来自 Mix Space 的"
+      welcomeNewMember:
+        enabled: true
+        channels: ["group-channel-id"]
+      commentReply:
+        enabled: true
+        channels: ["channel-id-1"]
     
     # Bilibili 配置
     bilibili:
       enabled: true
-      liveRoomId: "123456"
+      roomIds: [123456, 789012]  # 监控的直播间ID列表
       watchChannels: ["channel-id"]
-      checkInterval: 60000
-      atAll: false
+      checkInterval: 5  # 检查间隔（分钟）
+      broadcastToAll: false
+      excludeChannels: []
     
     # GitHub 配置
     github:
       enabled: true
-      webhookSecret: "your-webhook-secret"
-      webhookPort: 3000
-      watchChannels: ["channel-id"]
+      webhook:
+        secret: "your-github-webhook-secret"
+        path: "/github/webhook"
+        watchChannels: ["channel-id"]
+        broadcastToAll: false
+        excludeChannels: []
     
-    # 错误通知配置
-    errorNotify:
-      enabled: true
+    # 共享功能配置
+    shared:
+      errorNotify:
+        enabled: true
+        channels: ["admin-channel-id"]
+      repeater:
+        enabled: true
+        threshold: 3  # 触发复读的次数
+        chance: 0.5   # 复读概率
+        breakThreshold: 12  # 打断阈值
+      tools:
+        enabled: true
 ```
 
 ## 配置说明
 
 ### MX Space 配置
-- `baseUrl`: MX Space API 地址
-- `token`: API 访问令牌
-- `watchChannels`: 监听的频道ID列表
-- `enableGreeting`: 是否启用自动问候功能
 
+- `baseUrl`: MX Space API 地址（必填）
+- `token`: API 访问令牌
+- **Webhook 配置**:
+  - `secret`: Webhook 验证密钥
+  - `path`: Webhook 接收路径
+  - `watchChannels`: 接收推送的频道ID列表
+  - `broadcastToAll`: 是否广播到所有联系人
+  - `excludeChannels`: 广播时排除的频道列表
+- **问候功能**:
+  - `enabled`: 是否启用自动问候
+  - `channels`: 发送问候消息的频道
+  - `morningTime`/`eveningTime`: 问候时间（cron 格式）
+- **其他功能**: 新成员欢迎、评论回复等
 
 ### Bilibili 配置
+
 - `enabled`: 是否启用 Bilibili 监控
-- `liveRoomId`: 要监控的直播间ID
+- `roomIds`: 要监控的直播间ID列表（支持多个）
 - `watchChannels`: 推送通知的频道ID列表
-- `checkInterval`: 检查间隔（毫秒）
-- `atAll`: 开播时是否 @全体成员
+- `checkInterval`: 检查间隔（分钟，1-60）
+- `broadcastToAll`: 开播时是否广播到所有联系人
+- `excludeChannels`: 广播时排除的频道列表
 
 ### GitHub 配置
+
 - `enabled`: 是否启用 GitHub Webhook
-- `webhookSecret`: GitHub Webhook 密钥
-- `webhookPort`: Webhook 监听端口
-- `watchChannels`: 推送通知的频道ID列表
+- **Webhook 配置**:
+  - `secret`: GitHub Webhook 密钥
+  - `path`: Webhook 接收路径
+  - `watchChannels`: 推送通知的频道ID列表
+  - `broadcastToAll`: 是否广播到所有联系人
+  - `excludeChannels`: 广播时排除的频道列表
 
-## 使用示例
+### 共享功能配置
+
+- **错误通知**: 系统错误的通知设置
+- **复读机**: 智能复读功能的参数调整
+- **工具命令**: 实用工具命令的开关
+
+## 命令使用
 
 ### 工具命令
+
+```bash
+# 基础工具
+tools.md5 hello world          # 计算 MD5 哈希
+tools.sha256 hello world       # 计算 SHA256 哈希
+tools.ip 8.8.8.8              # 查询 IP 信息
+tools.timestamp               # 获取当前时间戳
+tools.timestamp 1640995200    # 转换时间戳
+
+# 编码工具
+tools.base64 encode hello      # Base64 编码
+tools.base64 decode aGVsbG8=   # Base64 解码
+
+# 生成工具
+tools.random                  # 生成随机数 (1-100)
+tools.random 1 10             # 生成 1-10 的随机数
+tools.uuid                    # 生成 UUID
+tools.color                   # 生成随机颜色
+
+# 网络工具
+tools.hitokoto                # 获取一言
+一言                          # 获取一言（别名）
+tools.shorturl https://...    # 生成短链接
+tools.qrcode hello world      # 生成二维码
 ```
-tool.ip 8.8.8.8
-tool.base64 Hello World
-tool.base64 -d SGVsbG8gV29ybGQ=
-tool.md5 Hello World
+
+### 监控命令
+
+```bash
+bili.status                   # 查看直播状态
+github.status                 # 查看仓库状态
 ```
 
-### 其他命令
+## 使用示例
+
+### 工具命令使用
+
+```bash
+# IP 查询
+tools.ip 8.8.8.8
+
+# 编码解码
+tools.base64 encode Hello World
+tools.base64 decode SGVsbG8gV29ybGQ=
+
+# 哈希计算
+tools.md5 Hello World
+tools.sha256 Hello World
+
+# 时间工具
+tools.timestamp
+tools.timestamp 1640995200
+
+# 随机生成
+tools.random 1 100
+tools.uuid
+tools.color
 ```
-hitokoto
-bili.status
-github.test
+
+### MX Space 事件推送
+
+当 MX Space 博客有新内容时，插件会自动推送通知：
+
+- 📝 新博客文章发布
+- 💭 新说说发布  
+- 💬 博客评论更新
+- 📊 博客数据统计
+
+### Bilibili 直播监控
+
+支持监控多个直播间，当主播开播时自动推送：
+
+```text
+🔴 直播开始了！
+🎯 房间号：123456
+👤 主播：某某主播
+🎬 标题：今天直播XXX内容
+🔗 链接：https://live.bilibili.com/123456
 ```
 
 ## 开发
 
-1. 克隆仓库
-2. 安装依赖：`npm install`
-3. 构建：`npm run build`
-4. 开发模式：`npm run dev`
+### 本地开发
+
+```bash
+# 克隆仓库
+git clone https://github.com/sysfox/koishi-plugin-imx.git
+cd koishi-plugin-imx
+
+# 安装依赖
+pnpm install
+
+# 开发模式（自动编译）
+pnpm run dev
+
+# 构建
+pnpm run build
+```
+
+### 项目结构
+
+```text
+src/
+├── index.ts              # 主入口文件
+├── constants/            # 常量定义
+├── modules/              # 功能模块
+│   ├── mx-space.ts       # MX Space 集成
+│   ├── bilibili.ts       # Bilibili 监控
+│   └── github.ts         # GitHub 集成
+├── shared/               # 共享功能
+│   ├── repeater.ts       # 复读机
+│   └── commands/         # 命令模块
+├── types/                # 类型定义
+├── utils/                # 工具函数
+└── debug/                # 调试工具
+```
+
+## 部署指南
+
+### Webhook 配置
+
+如果你需要使用 MX Space 或 GitHub 的 Webhook 功能，需要：
+
+1. 确保你的 Koishi 实例可以从外网访问
+2. 配置正确的 Webhook 路径和密钥
+3. 在对应服务中设置 Webhook URL
+
+**MX Space Webhook URL**: `https://your-domain.com/mx-space/webhook`  
+**GitHub Webhook URL**: `https://your-domain.com/github/webhook`
+
+### 环境要求
 
-## 从 IMX Bot 迁移
+- Node.js 16+
+- Koishi 4.15.0+
+- 稳定的网络连接（用于 API 请求）
 
-如果你之前使用的是 IMX Bot，可以参考以下迁移步骤：
+## 常见问题
 
-1. 安装此插件
-2. 将原有的配置转换为 Koishi 配置格式
-3. 确保所有依赖的服务（如 MX Space、OpenAI 等）配置正确
-4. 测试各项功能是否正常工作
+### Q: 为什么 Bilibili 直播监控不工作？
+
+A: 请检查：
+
+1. 直播间ID是否正确
+2. 网络连接是否正常
+3. 检查间隔设置是否合理（建议 1-10 分钟）
+
+### Q: MX Space Webhook 没有收到推送？
+
+A: 请确认：
+
+1. MX Space 中的 Webhook URL 配置正确
+2. Webhook 密钥匹配
+3. Koishi 服务可以从外网访问
+
+### Q: 如何自定义问候时间？
+
+A: 在配置中使用 cron 表达式：
+
+```yaml
+morningTime: "0 0 8 * * *"    # 每天早上8点
+eveningTime: "0 30 21 * * *"  # 每天晚上9点30分
+```
+
+## 版本历史
+
+查看 [CHANGELOG.md](./CHANGELOG.md) 了解详细的版本更新记录。
+
+## 相关链接
+
+- [Koishi 官网](https://koishi.chat)
+- [MX Space](https://github.com/mx-space)
+- [插件 GitHub 仓库](https://github.com/sysfox/koishi-plugin-imx)
 
 ## 许可证
 
-MIT License
+[MIT License](./LICENSE)
 
 ## 贡献
 
-欢迎提交 Issue 和 Pull Request！
+欢迎提交 Issue 和 Pull Request！
+
+在提交代码前，请确保：
+
+1. 代码符合项目的编码规范
+2. 添加了必要的测试
+3. 更新了相关文档
+4. 提交信息清晰明确
+
+感谢所有贡献者的支持！

package/lib/modules/mx-space.js

@@ -374,8 +374,8 @@ function setupCommands(ctx, config, logger) {
         .subcommand('.stat', '获取 MX Space 统计信息')
         .action(async ({ session }) => {
         try {
-            const data = await apiClient.aggregate.getStat();
-            const { posts, notes, comments, links, says, recently, todayIpAccessCount, todayMaxOnline, todayOnlineTotal, unreadComments, linkApply, callTime, online } = data;
+            const aggregateData = await (0, mx_api_1.getMxSpaceAggregateData)(ctx, config);
+            const { posts, notes, comments, links, says, recently, todayIpAccessCount, todayMaxOnline, todayOnlineTotal, unreadComments, linkApply, callTime, online } = aggregateData.stat;
             const replyPrefix = config.commands?.replyPrefix || '来自 Mix Space 的';
             return `📊 ${replyPrefix}统计信息：\n\n` +
                 `📝 文章 ${posts} 篇，📔 记录 ${notes} 篇\n` +

package/lib/utils/mx-event-handler.d.ts

@@ -1,11 +1,11 @@
 import { Context } from 'koishi';
 export declare enum BusinessEvents {
-    POST_CREATE = "post_create",
-    POST_UPDATE = "post_update",
-    NOTE_CREATE = "note_create",
-    COMMENT_CREATE = "comment_create",
-    LINK_APPLY = "link_apply",
-    SAY_CREATE = "say_create",
-    RECENTLY_CREATE = "recently_create"
+    POST_CREATE = "POST_CREATE",
+    POST_UPDATE = "POST_UPDATE",
+    NOTE_CREATE = "NOTE_CREATE",
+    COMMENT_CREATE = "COMMENT_CREATE",
+    LINK_APPLY = "LINK_APPLY",
+    SAY_CREATE = "SAY_CREATE",
+    RECENTLY_CREATE = "RECENTLY_CREATE"
 }
 export declare function handleMxSpaceEvent(ctx: Context, config: any, type: string, payload: any, logger: any): Promise<void>;

package/lib/utils/mx-event-handler.js

@@ -15,13 +15,13 @@ const broadcast_1 = require("./broadcast");
 // MX Space 事件类型
 var BusinessEvents;
 (function (BusinessEvents) {
-    BusinessEvents["POST_CREATE"] = "post_create";
-    BusinessEvents["POST_UPDATE"] = "post_update";
-    BusinessEvents["NOTE_CREATE"] = "note_create";
-    BusinessEvents["COMMENT_CREATE"] = "comment_create";
-    BusinessEvents["LINK_APPLY"] = "link_apply";
-    BusinessEvents["SAY_CREATE"] = "say_create";
-    BusinessEvents["RECENTLY_CREATE"] = "recently_create";
+    BusinessEvents["POST_CREATE"] = "POST_CREATE";
+    BusinessEvents["POST_UPDATE"] = "POST_UPDATE";
+    BusinessEvents["NOTE_CREATE"] = "NOTE_CREATE";
+    BusinessEvents["COMMENT_CREATE"] = "COMMENT_CREATE";
+    BusinessEvents["LINK_APPLY"] = "LINK_APPLY";
+    BusinessEvents["SAY_CREATE"] = "SAY_CREATE";
+    BusinessEvents["RECENTLY_CREATE"] = "RECENTLY_CREATE";
 })(BusinessEvents || (exports.BusinessEvents = BusinessEvents = {}));
 async function handleMxSpaceEvent(ctx, config, type, payload, logger) {
     logger.info(`处理 MX Space 事件: ${type}`);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "koishi-plugin-imx",
   "description": "Mix-Space Bot for Koishi - 集成多种功能的聊天机器人插件",
-  "version": "2.2.3",
+  "version": "2.2.5",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
   "files": [
@@ -44,16 +44,16 @@
     "@koishijs/plugin-server": "^3.2.7",
     "@mx-space/api-client": "^1.17.0",
     "@mx-space/webhook": "^0.5.0",
-    "@tanstack/query-core": "^4.40.0",
+    "@tanstack/query-core": "^5.0.0",
     "axios": "^1.10.0",
-    "chalk": "^4.1.2",
-    "consola": "^2.15.3",
-    "cron": "^2.4.4",
+    "chalk": "^5.0.0",
+    "consola": "^3.0.0",
+    "cron": "^4.0.0",
     "dayjs": "^1.11.13",
     "lodash": "^4.17.21",
-    "marked": "^5.1.2",
+    "marked": "^16.0.0",
     "randomcolor": "^0.6.2",
-    "remove-markdown": "^0.5.5",
+    "remove-markdown": "^0.6.0",
     "sanitize-html": "^2.17.0",
     "socket.io-client": "^4.8.1",
     "zod": "^3.25.76"
@@ -69,6 +69,11 @@
   },
   "scripts": {
     "build": "tsc -b",
-    "dev": "tsc -b --watch"
+    "dev": "tsc -b --watch",
+    "release": "node scripts/release.js",
+    "release:patch": "node scripts/release.js patch",
+    "release:minor": "node scripts/release.js minor",
+    "release:major": "node scripts/release.js major",
+    "test:release": "node scripts/test-release.js"
   }
 }