@xgjktech/xg_cwork_im 1.11.3 → 1.11.5

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.
Files changed (53) hide show
  1. package/README.md +20 -10
  2. package/dist/index.d.ts +10 -0
  3. package/dist/index.d.ts.map +1 -0
  4. package/{index.ts → dist/index.js} +5 -9
  5. package/dist/index.js.map +1 -0
  6. package/dist/src/auth.d.ts +25 -0
  7. package/dist/src/auth.d.ts.map +1 -0
  8. package/{src/auth.ts → dist/src/auth.js} +55 -79
  9. package/dist/src/auth.js.map +1 -0
  10. package/dist/src/channel.d.ts +13 -0
  11. package/dist/src/channel.d.ts.map +1 -0
  12. package/{src/channel.ts → dist/src/channel.js} +252 -392
  13. package/dist/src/channel.js.map +1 -0
  14. package/dist/src/connection.d.ts +51 -0
  15. package/dist/src/connection.d.ts.map +1 -0
  16. package/{src/connection.ts → dist/src/connection.js} +63 -124
  17. package/dist/src/connection.js.map +1 -0
  18. package/dist/src/group-history-tool.d.ts +23 -0
  19. package/dist/src/group-history-tool.d.ts.map +1 -0
  20. package/{src/group-history-tool.ts → dist/src/group-history-tool.js} +168 -204
  21. package/dist/src/group-history-tool.js.map +1 -0
  22. package/dist/src/inbound-media-local.d.ts +40 -0
  23. package/dist/src/inbound-media-local.d.ts.map +1 -0
  24. package/{src/inbound-media-local.ts → dist/src/inbound-media-local.js} +52 -90
  25. package/dist/src/inbound-media-local.js.map +1 -0
  26. package/dist/src/recommended-system-prompt.d.ts +3 -0
  27. package/dist/src/recommended-system-prompt.d.ts.map +1 -0
  28. package/dist/src/recommended-system-prompt.js +3 -0
  29. package/dist/src/recommended-system-prompt.js.map +1 -0
  30. package/dist/src/resource-file.d.ts +65 -0
  31. package/dist/src/resource-file.d.ts.map +1 -0
  32. package/{src/resource-file.ts → dist/src/resource-file.js} +80 -103
  33. package/dist/src/resource-file.js.map +1 -0
  34. package/dist/src/send-group-message-tool.d.ts +16 -0
  35. package/dist/src/send-group-message-tool.d.ts.map +1 -0
  36. package/{src/send-group-message-tool.ts → dist/src/send-group-message-tool.js} +17 -34
  37. package/dist/src/send-group-message-tool.js.map +1 -0
  38. package/dist/src/send-service.d.ts +34 -0
  39. package/dist/src/send-service.d.ts.map +1 -0
  40. package/dist/src/send-service.js +263 -0
  41. package/dist/src/send-service.js.map +1 -0
  42. package/{src/tool-json-result.ts → dist/src/tool-json-result.d.ts} +14 -24
  43. package/dist/src/tool-json-result.d.ts.map +1 -0
  44. package/dist/src/tool-json-result.js +20 -0
  45. package/dist/src/tool-json-result.js.map +1 -0
  46. package/{src/types.ts → dist/src/types.d.ts} +32 -95
  47. package/dist/src/types.d.ts.map +1 -0
  48. package/dist/src/types.js +32 -0
  49. package/dist/src/types.js.map +1 -0
  50. package/openclaw.plugin.json +6 -0
  51. package/package.json +7 -6
  52. package/src/recommended-system-prompt.ts +0 -3
  53. package/src/send-service.ts +0 -283
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xgjktech/xg_cwork_im",
3
- "version": "1.11.3",
3
+ "version": "1.11.5",
4
4
  "description": "XG CWork IM channel plugin for OpenClaw",
5
5
  "keywords": [
6
6
  "bot",
@@ -11,18 +11,19 @@
11
11
  ],
12
12
  "license": "MIT",
13
13
  "type": "module",
14
- "main": "index.ts",
14
+ "main": "dist/index.js",
15
+ "types": "dist/index.d.ts",
15
16
  "files": [
16
17
  ".npmrc",
17
- "index.ts",
18
- "src/*.ts",
18
+ "dist/**/*",
19
19
  "openclaw.plugin.json"
20
20
  ],
21
21
  "scripts": {
22
+ "build": "tsc -p tsconfig.json",
22
23
  "type-check": "tsc -p tsconfig.json --noEmit",
23
24
  "lint": "tsc -p tsconfig.json --noEmit",
24
25
  "install:prod": "npm install --omit=dev",
25
- "prepublishOnly": "npm run type-check"
26
+ "prepublishOnly": "npm run build"
26
27
  },
27
28
  "dependencies": {
28
29
  "@sinclair/typebox": "^0.32.0",
@@ -40,7 +41,7 @@
40
41
  },
41
42
  "openclaw": {
42
43
  "extensions": [
43
- "./index.ts"
44
+ "./dist/index.js"
44
45
  ],
45
46
  "channels": [
46
47
  "xg_cwork_im"
@@ -1,3 +0,0 @@
1
- /** 建议复制到 `channels.xg_cwork_im.systemPrompt`。 */
2
- export const XG_IM_RECOMMENDED_CHANNEL_SYSTEM_PROMPT =
3
- "发文件给用户时,在回复正文里单独写一行 `MEDIA:<路径>`,例如:MEDIA:/workspace/report.pdf。路径支持 /workspace/…、file://…、http(s)://…。OpenClaw 会自动读取该路径并让通道上传,用户可直接在 IM 中下载。不要把路径当作已发送;也不要上传到外部网站。";
@@ -1,283 +0,0 @@
1
- /**
2
- * XG-IM 消息发送模块
3
- *
4
- * 调用 IM 接口将 AI 回复发送到指定群聊,并 @ 原始发送者。
5
- * 支持 RICH_TEXT 与带资源 fileId 的 FILE 类型(attachments)。
6
- */
7
-
8
- import axios from "axios";
9
- import type { Log } from "./auth.js";
10
- import {
11
- downloadMediaBuffer,
12
- formatFromFilename,
13
- resolveMaxAttachmentBytes,
14
- resolveResourceUploadUrl,
15
- uploadWholeResourceFile,
16
- } from "./resource-file.js";
17
- import type { SendMessageBody, SendMessageFileAttachment, SendMessageReply, XgImConfig } from "./types.js";
18
-
19
- function formatDeliverError(err: unknown): string {
20
- if (axios.isAxiosError(err)) {
21
- const parts = [err.message];
22
- if (err.code) parts.push(`axiosCode=${err.code}`);
23
- if (err.response?.status != null) parts.push(`httpStatus=${err.response.status}`);
24
- return parts.join(" ");
25
- }
26
- if (err instanceof Error) return err.message;
27
- return String(err);
28
- }
29
-
30
- /**
31
- * 发消息接口的重试参数。
32
- *
33
- * 总尝试次数 = 1(首次) + IM_SEND_MAX_RETRIES(重试) = 6,间隔约 1 秒。
34
- * 仅对网络层瞬时错误(无响应 / 5xx / 408 / 429)重试;4xx 与业务 resultCode 错误视为永久失败,立即抛出。
35
- */
36
- const IM_SEND_MAX_RETRIES = 5;
37
- const IM_SEND_RETRY_DELAY_MS = 1_000;
38
-
39
- function delay(ms: number): Promise<void> {
40
- return new Promise((resolve) => setTimeout(resolve, ms));
41
- }
42
-
43
- /**
44
- * 判断错误是否值得重试。
45
- *
46
- * - axios 网络错误 / 超时 / 5xx / 408 / 429 → 重试
47
- * - 4xx(其它)/ 业务 resultCode 错误(普通 Error)→ 永久失败,不重试
48
- */
49
- function isRetryableSendError(err: unknown): boolean {
50
- if (axios.isAxiosError(err)) {
51
- const status = err.response?.status;
52
- if (status === undefined) return true;
53
- if (status >= 500) return true;
54
- if (status === 408 || status === 429) return true;
55
- return false;
56
- }
57
- return false;
58
- }
59
-
60
- async function postImMessage(
61
- config: XgImConfig,
62
- token: string,
63
- groupId: string,
64
- body: SendMessageBody,
65
- atUserIds: string[] = [],
66
- log?: Log,
67
- ): Promise<void> {
68
- const url = `${config.baseUrl}/im/message/send`;
69
- const full: SendMessageBody = {
70
- ...body,
71
- groupId,
72
- ...(atUserIds.length > 0 ? { atUserIds } : {}),
73
- } as SendMessageBody;
74
-
75
- log?.info(`[cwork_im:send] POST ${url} groupId=${groupId} type=${full.type} atUsers=${JSON.stringify(atUserIds)}`);
76
- if (config.debug) {
77
- log?.debug?.(`[cwork_im:send] Request body: ${JSON.stringify(full)}`);
78
- }
79
-
80
- const totalAttempts = 1 + IM_SEND_MAX_RETRIES;
81
- let lastErr: unknown = undefined;
82
-
83
- for (let attempt = 1; attempt <= totalAttempts; attempt++) {
84
- try {
85
- const res = await axios.post(url, full, {
86
- headers: {
87
- "Content-Type": "application/json",
88
- "access-token": token,
89
- },
90
- timeout: 10_000,
91
- });
92
-
93
- log?.info(`[cwork_im:send] Response status=${res.status} (attempt=${attempt}/${totalAttempts})`);
94
- if (config.debug) {
95
- log?.debug?.(`[cwork_im:send] Response body: ${JSON.stringify(res.data)}`);
96
- }
97
-
98
- // Detect business-level errors that arrive with HTTP 200.
99
- // IM API unified response: { data, resultCode: 1, resultMsg: "" } — resultCode=1 means success.
100
- const d = res.data;
101
- if (d && typeof d === "object") {
102
- const resultCode = (d as Record<string, unknown>).resultCode;
103
- const resultMsg = (d as Record<string, unknown>).resultMsg;
104
- if (resultCode !== undefined && resultCode !== 1) {
105
- throw new Error(
106
- `IM API error resultCode=${resultCode}${resultMsg ? ` resultMsg=${resultMsg}` : ""}`,
107
- );
108
- }
109
- }
110
- return;
111
- } catch (err: unknown) {
112
- lastErr = err;
113
- const msg = formatDeliverError(err);
114
- const retryable = isRetryableSendError(err);
115
- const isLast = attempt >= totalAttempts;
116
-
117
- if (!retryable || isLast) {
118
- log?.error(
119
- `[cwork_im:send] Failed to send message to groupId=${groupId} ` +
120
- `(attempt=${attempt}/${totalAttempts}, retryable=${retryable}): ${msg}`,
121
- );
122
- throw err;
123
- }
124
-
125
- const warn = log?.warn ?? log?.info;
126
- warn?.(
127
- `[cwork_im:send] Send failed (attempt=${attempt}/${totalAttempts}), ` +
128
- `retrying in ${IM_SEND_RETRY_DELAY_MS}ms: ${msg}`,
129
- );
130
- await delay(IM_SEND_RETRY_DELAY_MS);
131
- }
132
- }
133
-
134
- // 理论上不可达:上面循环里要么 return 要么 throw。这里只是给 TS 一个安全兜底。
135
- throw lastErr ?? new Error("[cwork_im:send] Send failed after retries");
136
- }
137
-
138
- /** OpenClaw dispatch deliver 单块载荷:文本 + 可选媒体 URL(与 plugin-sdk 约定对齐)。 */
139
- export type ReplyDeliverPayload = {
140
- markdown?: string;
141
- text?: string;
142
- isThinking?: boolean;
143
- mediaUrl?: string;
144
- mediaUrls?: string[];
145
- };
146
-
147
- /**
148
- * 将 deliver 块发到 IM:若有媒体则先 POST baseUrl/file/upDownload/uploadWholeFile 再发 FILE;否则发 RICH_TEXT。
149
- */
150
- export async function sendReplyDeliverBlock(
151
- config: XgImConfig,
152
- token: string,
153
- groupId: string,
154
- payload: ReplyDeliverPayload,
155
- atUserIds: string[] = [],
156
- log?: Log,
157
- msgId?: string,
158
- reply?: SendMessageReply,
159
- ): Promise<void> {
160
- const textToSend = (payload.markdown || payload.text || "").trim();
161
- const mediaList = [
162
- ...(payload.mediaUrl ? [payload.mediaUrl] : []),
163
- ...((payload.mediaUrls ?? []).filter((u) => typeof u === "string" && u.trim())),
164
- ];
165
- const uniqueUrls = [...new Set(mediaList)];
166
- const maxBytes = resolveMaxAttachmentBytes(config);
167
- const formField = config.fileUploadFormField?.trim() || "file";
168
-
169
- const wantFile = uniqueUrls.length > 0 && !payload.isThinking;
170
-
171
- if (wantFile) {
172
- const fileUploadUrl = resolveResourceUploadUrl(config.baseUrl);
173
- try {
174
- const attachments: SendMessageFileAttachment[] = [];
175
- for (const u of uniqueUrls) {
176
- const { buffer, filename } = await downloadMediaBuffer(u, maxBytes, log);
177
- const { fileId } = await uploadWholeResourceFile({
178
- fileUploadUrl,
179
- token,
180
- buffer,
181
- filename,
182
- formField,
183
- log,
184
- });
185
- attachments.push({
186
- fileId,
187
- fileType: "FILE",
188
- format: formatFromFilename(filename),
189
- name: filename,
190
- size: buffer.length,
191
- source: "resource",
192
- });
193
- }
194
- const caption = textToSend.length > 0 ? textToSend : " ";
195
- await postImMessage(
196
- config,
197
- token,
198
- groupId,
199
- {
200
- type: "FILE",
201
- text: caption,
202
- attachments,
203
- ...(msgId ? { msgId } : {}),
204
- ...(reply ? { reply } : {}),
205
- },
206
- atUserIds,
207
- log,
208
- );
209
- return;
210
- } catch (err: unknown) {
211
- log?.error(`[cwork_im:send] FILE deliver failed, fallback to text if any: ${formatDeliverError(err)}`);
212
- const errNote = `(文件发送失败:${formatDeliverError(err)})`;
213
- const fallbackText = textToSend.length > 0 ? `${textToSend}\n\n${errNote}` : errNote;
214
- await postImMessage(
215
- config,
216
- token,
217
- groupId,
218
- {
219
- type: "RICH_TEXT",
220
- text: fallbackText,
221
- ...(msgId ? { msgId } : {}),
222
- ...(reply ? { reply } : {}),
223
- },
224
- atUserIds,
225
- log,
226
- );
227
- return;
228
- }
229
- }
230
-
231
- if (textToSend.length > 0) {
232
- await postImMessage(
233
- config,
234
- token,
235
- groupId,
236
- {
237
- type: "RICH_TEXT",
238
- text: textToSend,
239
- ...(msgId ? { msgId } : {}),
240
- ...(reply ? { reply } : {}),
241
- },
242
- atUserIds,
243
- log,
244
- );
245
- }
246
- }
247
-
248
- /**
249
- * 发送文本消息到指定 IM 群聊。
250
- *
251
- * @param config 插件配置
252
- * @param token 鉴权 token
253
- * @param groupId 目标群聊 ID(gid / groupId)
254
- * @param content 消息内容文本
255
- * @param atUserIds 需要 @ 的用户 ID 列表(可为空)
256
- * @param log 日志接口
257
- * @param msgId 可选的业务消息 ID(用于覆盖/更新已有消息)
258
- * @param reply 可选的被回复消息信息(用于在 IM 中建立“回复某条消息”的关联)
259
- */
260
- export async function sendTextMessage(
261
- config: XgImConfig,
262
- token: string,
263
- groupId: string,
264
- content: string,
265
- atUserIds: string[] = [],
266
- log?: Log,
267
- msgId?: string,
268
- reply?: SendMessageReply,
269
- ): Promise<void> {
270
- await postImMessage(
271
- config,
272
- token,
273
- groupId,
274
- {
275
- type: "RICH_TEXT",
276
- text: content,
277
- ...(msgId ? { msgId } : {}),
278
- ...(reply ? { reply } : {}),
279
- },
280
- atUserIds,
281
- log,
282
- );
283
- }