@peninsula-med/beisen-ehr-plugin 1.0.6 → 1.1.0

package/README.md

@@ -1,201 +1,139 @@
-# 北森 EHR OpenClaw Plugin 🏢
+# 北森 EHR OpenClaw 插件 🐉
 
-北森 EHR 系统的 OpenClaw 插件，支持加班申请、考勤查询、假期余额等功能。
+北森 EHR 系统集成插件，支持加班申请、考勤查询、假期余额等功能。
 
-> **开发：** 龙二 (Long Er) 🐉  
-> **版本：** 1.0.1
+## 快速开始
 
----
-
-## 快速安装
-
-### 1️⃣ 安装插件
+### 方式一：使用配置向导（推荐）
 
 ```bash
+# 1. 安装插件
 openclaw plugins install @peninsula-med/beisen-ehr-plugin
-```
 
-### 2️⃣ 配置凭证（推荐 ⭐）
-
-使用独立的配置工具，无需查找路径：
-
-```bash
+# 2. 运行配置向导（交互式输入凭证）
 npx @peninsula-med/beisen-ehr-configure
+
+# 3. 重启 Gateway
+openclaw gateway restart
 ```
 
-或（安装到全局后）：
+### 方式二：一键安装 + 配置（适合脚本化）
 
 ```bash
-npx beisen-ehr-configure
+openclaw plugins install @peninsula-med/beisen-ehr-plugin && \
+npx @peninsula-med/beisen-ehr-configure && \
+openclaw gateway restart
 ```
 
-按提示输入北森凭证即可，自动完成配置！
+### 方式三：手动配置
 
-**方式 C：手动编辑配置文件**
+```bash
+# 1. 安装插件
+openclaw plugins install @peninsula-med/beisen-ehr-plugin
 
-编辑 `~/.openclaw/config.json`：
+# 2. 编辑配置文件（~/.openclaw/config.json）
+```
 
-```json
+在配置文件中添加：
+
+```json5
 {
-  "plugins": {
-    "@peninsula-med/beisen-ehr-plugin": {
-      "enabled": true,
-      "config": {
-        "apiUrl": "https://openapi.italent.cn",
-        "appKey": "YOUR_APP_KEY",
-        "appSecret": "YOUR_APP_SECRET",
-        "staffId": "YOUR_STAFF_ID",
-        "tenantId": "YOUR_TENANT_ID",
-        "email": "your.email@company.com"
+  plugins: {
+    entries: {
+      "beisen-ehr-plugin": {
+        enabled: true,
+        config: {
+          apiUrl: "https://openapi.italent.cn",  // 可选，默认就是这个
+          appKey: "your-app-key",
+          appSecret: "your-app-secret",
+          staffId: "your-staff-id",
+          tenantId: "your-tenant-id",
+          email: "your-email@company.com"
+        }
       }
     }
   }
 }
 ```
 
-### 3️⃣ 重启 OpenClaw
+然后重启：
 
 ```bash
-openclaw restart
-```
-
-### 4️⃣ 测试
-
-```
-帮我提交一个加班申请
-```
-
----
-
-## 功能
-
-### Tools (工具)
-
-| 工具 | 说明 |
-|------|------|
-| `submit_overtime` | 提交加班申请 |
-| `query_attendance` | 查询考勤记录 |
-| `get_approval_status` | 查询审批状态 |
-| `get_leave_balance` | 查询假期余额 |
-
-### Resources (资源)
-
-- `ehr://employee/{id}/profile` - 员工信息
-- `ehr://attendance/{id}/records` - 考勤记录
-- `ehr://overtime/{id}/list` - 加班记录
-
----
-
-## 使用示例
-
-### 提交加班申请
-
-```
-帮我提交一个加班申请，这周日全天
-```
-
-### 查询假期余额
-
-```
-我还有多少调休假？
-```
-
-### 查询考勤
-
-```
-查一下本周的考勤记录
+openclaw gateway restart
 ```
 
----
-
 ## 配置说明
 
-### 必要配置
-
-| 字段 | 说明 | 获取方式 |
-|------|------|---------|
-| `appKey` | 北森 App Key | 联系北森管理员 |
-| `appSecret` | 北森 App Secret | 联系北森管理员 |
-| `staffId` | 员工 ID | 北森系统或个人信息 |
-| `tenantId` | 企业租户 ID | 北森管理员 |
-| `email` | 企业邮箱 | 公司邮箱 |
+| 字段 | 说明 | 必填 |
+|------|------|------|
+| `apiUrl` | 北森 API 地址 | 否（默认 `https://openapi.italent.cn`） |
+| `appKey` | App Key（从北森管理员获取） | 是 |
+| `appSecret` | App Secret（从北森管理员获取） | 是 |
+| `staffId` | 员工 ID | 是 |
+| `tenantId` | 企业租户 ID | 是 |
+| `email` | 企业邮箱 | 是 |
 
-### 可选配置
+## 可用工具
 
-| 字段 | 说明 | 默认值 |
-|------|------|-------|
-| `apiUrl` | 北森 API 地址 | `https://openapi.italent.cn` |
+插件提供以下工具供 AI 调用：
 
----
+1. **beisen_submit_overtime** - 提交加班申请
+2. **beisen_get_leave_balance** - 查询假期余额
+3. **beisen_query_attendance** - 查询考勤记录
+4. **beisen_get_approval_status** - 查询审批状态
 
 ## 配置向导
 
-运行配置向导，按提示输入凭证：
+独立的配置工具，支持交互式输入凭证：
 
 ```bash
 npx @peninsula-med/beisen-ehr-configure
 ```
 
-向导会：
-1. ✅ 提示输入必要凭证
-2. ✅ 自动验证格式
-3. ✅ 备份现有配置
-4. ✅ 写入配置文件
-5. ✅ 显示配置摘要
-6. ✅ 提供下一步指引
+功能：
+- 🎯 交互式引导配置
+- 🔐 安全保存凭证到 OpenClaw 配置文件
+- ✅ 自动验证配置
+- 💾 自动备份旧配置
 
----
-
-## 故障排查
+## 开发
 
-### 插件未加载
+### 本地开发
 
 ```bash
-openclaw plugins list
-openclaw plugins info @peninsula-med/beisen-ehr-plugin
-```
-
-### 配置错误
+# 安装依赖
+pnpm install
 
-重新运行配置向导：
-```bash
-npx @peninsula-med/beisen-ehr-configure
-```
+# 开发模式（监听变化自动构建）
+pnpm dev
 
-### 查看日志
+# 生产构建
+pnpm build
 
-```bash
-openclaw gateway logs | grep beisen
+# 发布到 npm
+pnpm publish:release
 ```
 
-### 卸载
+### 本地测试
+
+使用 `--link` 安装本地插件：
 
 ```bash
-openclaw plugins uninstall @peninsula-med/beisen-ehr-plugin
+openclaw plugins install -l /path/to/beisen-ehr-plugin
 ```
 
----
-
-## 更新日志
+## 注意事项
 
-### v1.0.1 (2026-03-11)
-- ✅ 添加配置向导脚本
-- ✅ 支持 npx 一键配置
-
-### v1.0.0 (2026-03-11)
-- ✅ 初始版本
-- ✅ 提交加班申请
-- ✅ 查询考勤记录
-- ✅ 查询审批状态
-- ✅ 查询假期余额
-
----
+- 凭证信息需要联系北森管理员获取
+- Token 会自动管理，有效期 2 小时，自动刷新
+- 所有 API 请求都会记录到 Gateway 日志中
 
-## License
+## 技术支持
 
-MIT
+遇到问题？联系龙二 🐉
 
 ---
 
-🐉 **开发：** 龙二 (Long Er)  
-**最后更新：** 2026-03-11
+**版本**: 1.1.0  
+**作者**: 龙二 🐉  
+**License**: MIT