dsh-plugin-dingtalk-bridge 0.3.8 → 0.3.9

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/README.md CHANGED
@@ -54,11 +54,37 @@
54
54
 
55
55
  ## 前置要求
56
56
 
57
- - DSH `>= 0.2.1-rc.3 < 0.3.0-0`,Node `>= 22.19.0`。
58
- - 本机已安装并登录钉钉工作台 CLI:`dws --version` 能输出版本号(当前验证版本 `1.0.68`)。
57
+ - DSH `>= 0.2.1-rc.3 < 0.3.0-0`,Node `>= 22.19.0`(DSH 自带的 Node 就够用)。
58
+ - **不需要预装 dws**:插件会检测环境,没有 `dws` 时点「安装 dws」即可自动安装(有 npm 走全局安装,**没有 npm 也能装**——直接下载 npm 包解压,并借用 DSH 自带的 Node)。
59
59
  - 首次使用需要一次钉钉授权(面板右上角 **钉钉授权**)。
60
60
 
61
- ## 安装(三步)
61
+ ## 安装(推荐:一句话 / 插件市场)
62
+
63
+ 插件已发布到 npm:`dsh-plugin-dingtalk-bridge`。装法从简到繁三种,任选一种:
64
+
65
+ **方式一 · 让 DSH 自己装(推荐)**
66
+
67
+ 在 DSH 对话框里直接说:
68
+
69
+ > 安装 npm 插件 `dsh-plugin-dingtalk-bridge`,装好后重启
70
+
71
+ 助手会调用 `plugin_manager` 以 npm 包名安装到当前 profile,完成后重启 DSH 即可。
72
+
73
+ **方式二 · 插件市场**
74
+
75
+ DSH → 插件市场(Open Plugin Market)→ 搜索 `dsh-plugin-dingtalk-bridge` 或「钉钉消息自动化」→ 安装 → 重启 DSH。
76
+ (收录申请审核中,暂时搜不到就用方式一。)
77
+
78
+ **方式三 · 手动装 npm 包**
79
+
80
+ ```bash
81
+ npm i -g dsh-plugin-dingtalk-bridge@0.3.9 # 或装到 profile 的 dependencies 里
82
+ ```
83
+
84
+ 然后在 DSH profile 的 `package.json` 的 `dsh.profile.bundles` 里加入 `"dsh-plugin-dingtalk-bridge"`,执行 `pnpm install`,重启 DSH。
85
+
86
+ <details>
87
+ <summary>开发者:从源码目录安装(改代码即时生效)</summary>
62
88
 
63
89
  1. 把插件目录放进本机任意位置,例如 `E:/project/deepseek-tool/dsh-plugin-dingtalk`。
64
90
  2. 在 DSH profile 的 `package.json` 里加 **link 依赖**(不要用 `file:`,`file:` 会复制一份,改源码不生效):
@@ -78,11 +104,16 @@
78
104
 
79
105
  3. 在该 profile 目录执行 `pnpm install --prefer-offline`,然后**重启 DSH**。
80
106
 
107
+ > 注意:npm 版与源码 `link:` 版共用同一个 loader id(`dingtalk-bridge`),**不要同时装**。从源码版切到 npm 版时,先删掉 `link:` 依赖再装。
108
+
109
+ </details>
110
+
81
111
  ## 验证是否装好
82
112
 
83
113
  - 侧边栏出现「钉钉消息」图标,点开后是「钉钉消息自动化」面板。
84
114
  - 设置 → 插件 → 钉钉消息自动化 能看到配置卡片;面板右上角点 **钉钉授权** 能弹出授权框。
85
- - 设置页 **宿主版本** 应与界面版本一致(当前 `0.3.2`);不一致说明宿主代码没重载,重启 DSH。
115
+ - 设置页 **宿主版本** 应与界面版本一致(当前 `0.3.9`);不一致说明宿主代码没重载,重启 DSH。
116
+ - 没装 dws 的机器会看到「未检测到 dws 命令」提示卡,点 **安装 dws** 即可。
86
117
 
87
118
  ## 配置项
88
119
 
package/client.js CHANGED
@@ -24,7 +24,7 @@ window.__ModuleLoader__.load({
24
24
  const POLL_MS = 5000
25
25
  const SOFT_POLL_MS = 30000
26
26
  // 与 package.json 的 version 保持一致:宿主上报的 build 前缀对不上,说明 DSH 还在跑旧宿主代码。
27
- const CLIENT_BUILD = '0.3.8'
27
+ const CLIENT_BUILD = '0.3.9'
28
28
  // 源码仓库(GitHub):Star 与 Issue 入口都指向这里
29
29
  const REPO_URL = 'https://github.com/gcggcg/dsh-plugin-dingtalk-bridge'
30
30
  const ISSUES_URL = `${REPO_URL}/issues`
@@ -43,35 +43,69 @@
43
43
 
44
44
  ### 1.1 前置检查
45
45
 
46
- 在终端依次确认三件事,全部通过再安装插件。
46
+ 插件已发布到 npm(`dsh-plugin-dingtalk-bridge`),**普通使用只需要三件事**:
47
+
48
+ | 检查项 | 要求 | 不满足怎么办 |
49
+ | --- | --- | --- |
50
+ | DSH 版本 | `>= 0.2.1-rc.3 < 0.3.0-0` | 升级 DSH |
51
+ | Node | `>= 22.19.0`(DSH 自带的就够) | 一般无需单独安装 |
52
+ | dws | **可以不装** | 装好插件后在面板里点 **安装 dws**,插件会自动装(没有 npm 也能装) |
53
+
54
+ 也就是说,**不需要事先在终端里 `npm i -g dingtalk-workspace-cli`,也不需要自己配 `dwsPath`**。只有想手动排障时,才需要下面这些命令:
47
55
 
48
56
  ```bash
49
57
  # 1) Node 版本(要求 >= 22.19.0)
50
58
  node -v
51
59
 
52
- # 2) dws 是否可用(要求已 npm i -g dingtalk-workspace-cli)
60
+ # 2) dws 是否可用(插件会自动安装,这里只是自查)
53
61
  dws --version
54
62
 
55
- # 3) 是否已有可用登录态
63
+ # 3) 是否已有可用登录态(没有就在面板里点「钉钉授权」)
56
64
  dws profile list -f json
57
65
  ```
58
66
 
59
- `dws profile list -f json` 会输出 `currentProfile` 与 `profiles` 数组;每个 profile 形如 `corpId:userId`,并带 `corpName`、`userName`、`status` 字段。**至少要有一个 `status` 为 `active` 的组织**。
67
+ `dws profile list -f json` 会输出 `currentProfile` 与 `profiles` 数组;每个 profile 形如 `corpId:userId`,并带 `corpName`、`userName`、`status` 字段。
60
68
 
61
- 若没有任何 profile:
69
+ 若没有任何 profile,可以直接在面板里点 **钉钉授权**(推荐,默认 `loginMode=loopback`,弹框自动打开浏览器授权页,本机 `127.0.0.1:<port>/callback` 回调,**不需要授权码、不显示二维码**;远程环境把 `loginMode` 改成 `device` 才显示二维码 + 授权码)。详见 [第 8 节](#8-钉钉授权登录)。
70
+
71
+ 也可以在终端手动授权:
62
72
 
63
73
  ```bash
64
- # 本机浏览器授权(推荐,桌面环境):自动打开授权页,扫码或账号密码登录即可,不需要授权码
74
+ # 本机浏览器授权(推荐,桌面环境)
65
75
  dws auth login --no-browser --yes
66
76
 
67
77
  # 设备流授权:终端打印授权码 + 链接,适合没有图形界面的远程环境
68
78
  dws auth login --device --no-browser
69
79
  ```
70
80
 
71
- > 也可以先装好插件,再在收件箱面板右上角点 **钉钉授权** 完成同样的授权:默认 `loginMode=loopback`,弹框会自动打开浏览器授权页(本机 `127.0.0.1:<port>/callback` 回调),**全程不需要授权码、不显示二维码**;远程环境把 `loginMode` 改成 `device` 才会显示二维码 + 授权码。详见 [第 8 节](#8-钉钉授权登录)。
72
-
73
81
  ### 1.2 安装插件
74
82
 
83
+ 三种装法,从简到繁任选一种,**都不需要手工改配置文件**。
84
+
85
+ #### 方式一 · 让 DSH 自己装(推荐)
86
+
87
+ 在 DSH 对话框里直接说:
88
+
89
+ > 安装 npm 插件 `dsh-plugin-dingtalk-bridge`,装好后重启
90
+
91
+ 助手会用 `plugin_manager` 把 npm 包装进当前 profile,然后重启 DSH 即可。
92
+
93
+ #### 方式二 · 插件市场
94
+
95
+ DSH → **插件市场**(Open Plugin Market)→ 搜索 `dsh-plugin-dingtalk-bridge` 或「钉钉消息自动化」→ **安装** → 重启 DSH。
96
+ (收录申请审核中,暂时搜不到就用方式一。)
97
+
98
+ #### 方式三 · 手动装 npm 包
99
+
100
+ ```bash
101
+ npm i -g dsh-plugin-dingtalk-bridge@0.3.9
102
+ ```
103
+
104
+ 或者把 `"dsh-plugin-dingtalk-bridge": "^0.3.9"` 加进 DSH profile 的 `dependencies`、并把包名追加到 `dsh.profile.bundles`,然后 `pnpm install`,最后**完全退出 DSH 再启动**。
105
+
106
+ <details>
107
+ <summary><b>开发者:从源码目录安装(改代码即时生效)</b></summary>
108
+
75
109
  1. **放好目录**。把插件目录放到任意位置(示例:`E:/project/deepseek-tool/dsh-plugin-dingtalk`)。
76
110
  2. **登记到 DSH profile**。编辑 `<DSH_HOME>/profiles/<profile>/package.json`:
77
111
  - `dependencies` 里加 **`link:`** 依赖;
@@ -100,14 +134,12 @@ dws auth login --device --no-browser
100
134
  >
101
135
  > 两种协议都要**重启 DSH**(完全退出进程再启动),仅刷新页面不够。
102
136
 
103
- 3. **安装依赖**:在 profile 目录执行
137
+ 3. **安装依赖**:在 profile 目录执行 `pnpm install`。
138
+ 4. **重启 DSH**:完全退出 DSH 再启动,改动才会生效(仅刷新页面不够)。
104
139
 
105
- ```bash
106
- pnpm install
107
- ```
140
+ > npm 版与源码 `link:` 版共用同一个 loader id(`dingtalk-bridge`),**不要同时装**;从源码版切到 npm 版时先删掉 `link:` 依赖。
108
141
 
109
- 4. **重启 DSH**:完全退出 DSH 再启动,改动才会生效(仅刷新页面不够)。
110
- 5. **完成授权**:打开收件箱面板,点右上角 **钉钉授权**,弹框会自动打开浏览器授权页,扫码或账号密码登录即可完成(默认 loopback,不需要授权码,详见 [第 8 节](#8-钉钉授权登录))。已经有 `dws auth login` 登录态的可跳过这一步。
142
+ </details>
111
143
 
112
144
  ### 1.3 确认插件已加载
113
145
 
@@ -125,7 +157,7 @@ dws auth login --device --no-browser
125
157
  | 状态文案 | 含义 | 处理 |
126
158
  | --- | --- | --- |
127
159
  | **插件已禁用** | `enabled` 为 `false` | 到「设置 → 插件」启用后重启 DSH |
128
- | **dws 未就绪** | `dws --version` 失败,或没有登录态(详情为 dws 返回的错误与「尚未登录钉钉」提示) | 未登录先点 **钉钉授权**([第 8 节](#8-钉钉授权登录));其余见 [10.1](#101-顶部显示dws-未就绪) |
160
+ | **dws 未就绪** | `dws --version` 失败,或没有登录态(详情为 dws 返回的错误与「尚未登录钉钉」提示) | 没装 dws 时面板顶部会有「未检测到 dws 命令」提示卡,先点 **安装 dws**;已装则点 **钉钉授权**([第 8 节](#8-钉钉授权登录));其余见 [10.1](#101-顶部显示dws-未就绪) |
129
161
  | **正在连接钉钉…** | 监听进程已启动、还没就绪 | 等几秒;长期停留见 [10.2](#102-顶部显示监听异常或一直正在连接钉钉) |
130
162
  | **监听异常** | 监听进程报错或已退出 | 点右上角 **重启监听**;仍有问题见 [10.2](#102-顶部显示监听异常或一直正在连接钉钉) |
131
163
 
@@ -137,7 +169,7 @@ dws auth login --device --no-browser
137
169
  2. 首次打开时列表可能是三块灰色骨架屏,表示正在拉取状态;服务连不上会显示 **无法连接插件服务**。
138
170
  3. 如果顶部显示 **dws 未就绪**、右上角 **钉钉授权** 是蓝色主按钮,先点它完成授权([第 8 节](#8-钉钉授权登录)):弹框会说明「在浏览器里完成一次授权」并自动打开授权页,扫码或账号密码登录即可(默认 loopback,不用授权码);授权成功后弹框自动关闭,状态变成 **实时监听中 · N 个组织**。
139
171
  4. 空收件箱显示 **还没有收到消息**,说明为:*保持页面打开即可。当有人给你发钉钉私信或在群里 @ 你时,消息会实时出现在这里。*
140
- 5. 建议先点右上角 **使用说明** 看一遍内置的六条速查(接收 / 消息源 / 自动回复开关 / 阴影建议 / 快捷键 / 发送通道),再按第 2 节熟悉布局。
172
+ 5. 建议先点右上角 **使用说明** 看一遍内置速查(授权 / 接收 / 消息源 / 自动回复开关 / 阈值 / 匹配度 / 图片 / 上下文 / 阴影建议 / 快捷键 / 发送通道 / dws 环境等),再按第 2 节熟悉布局。
141
173
 
142
174
  ---
143
175
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-plugin-dingtalk-bridge",
3
- "version": "0.3.8",
3
+ "version": "0.3.9",
4
4
  "private": false,
5
5
  "type": "module",
6
6
  "description": "钉钉私信 / 群 @ 消息实时接收、按发送人记录来源、AI 建议回复与自动回复插件",
@@ -21,7 +21,7 @@ import { buildSuggestPrompt, generateSuggestion, formatClock } from './suggest.j
21
21
 
22
22
  export const ROUTE_PREFIX = '/api/dingtalk-bridge'
23
23
  /** 每次改动宿主行为就换个标记:界面与 http-debug.log 都会带上,用来确认「跑的是新代码」。 */
24
- export const HOST_BUILD = '0.3.8-20261117T1545'
24
+ export const HOST_BUILD = '0.3.9-20261117T1615'
25
25
 
26
26
  /** 私信(单聊)全部消息。 */
27
27
  const O2O_KEY = 'user_im_message_receive_o2o_all'