Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 | 1x 1x 17x 17x 17x 17x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 2x 2x 2x 2x 2x 2x 2x 17x 17x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 17x 17x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 17x 17x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 2x 17x 17x 2x 2x 2x 2x 2x 2x 2x 2x 2x 17x 17x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 17x 17x 1x 1x 1x 1x 1x 1x 1x 1x 17x 17x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 17x 17x 17x 17x | /**
* Gateway Methods 注册
*
* 提供钉钉插件的 RPC 接口，允许外部系统、AI Agent 和其他插件调用钉钉功能
*/
import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
import { resolveDingtalkAccount } from "./config/accounts.ts";
import { DingtalkDocsClient } from "./docs.ts";
import { sendProactive } from "./services/messaging.ts";
import { getUnionId } from "./utils/utils-legacy.ts";
/**
* 注册所有 Gateway Methods
*/
export function registerGatewayMethods(api: OpenClawPluginApi) {
const log = api.logger;
log?.info?.('[DingTalk][Gateway] 开始注册 Gateway Methods...');
// ============ 消息发送类 ============
/**
* 主动发送单聊消息
*
* @example
* ```typescript
* await gateway.call('dingtalk-connector.sendToUser', {
* userId: 'user123',
* content: '任务已完成！',
* useAICard: true
* });
* ```
*/
log?.info?.('[DingTalk][Gateway] 注册方法: dingtalk-connector.sendToUser');
api.registerGatewayMethod('dingtalk-connector.sendToUser', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { userId, userIds, content, msgType, title, useAICard, fallbackToNormal, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
const targetUserIds = userIds || (userId ? [userId] : []);
if (targetUserIds.length === 0) {
return respond(false, { error: 'userId or userIds is required' });
}
if (!content) {
return respond(false, { error: 'content is required' });
}
// 构建目标
const target = targetUserIds.length === 1
? { userId: targetUserIds[0] }
: { userIds: targetUserIds };
const result = await sendProactive(account.config, target, content, {
msgType,
title,
log,
useAICard: useAICard !== false,
fallbackToNormal: fallbackToNormal !== false,
});
respond(result.ok, result);
} catch (err: any) {
log?.error?.(`[Gateway][sendToUser] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 主动发送群聊消息
*
* @example
* ```typescript
* await gateway.call('dingtalk-connector.sendToGroup', {
* openConversationId: 'cid123',
* content: '构建失败，请检查日志',
* useAICard: true
* });
* ```
*/
api.registerGatewayMethod('dingtalk-connector.sendToGroup', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { openConversationId, content, msgType, title, useAICard, fallbackToNormal, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!openConversationId) {
return respond(false, { error: 'openConversationId is required' });
}
if (!content) {
return respond(false, { error: 'content is required' });
}
const result = await sendProactive(account.config, { openConversationId }, content, {
msgType,
title,
log,
useAICard: useAICard !== false,
fallbackToNormal: fallbackToNormal !== false,
});
respond(result.ok, result);
} catch (err: any) {
log?.error?.(`[Gateway][sendToGroup] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 智能发送消息（自动识别目标类型）
*
* @example
* ```typescript
* // 发送给用户
* await gateway.call('dingtalk-connector.send', {
* target: 'user:user123',
* content: '你好！'
* });
*
* // 发送到群
* await gateway.call('dingtalk-connector.send', {
* target: 'group:cid123',
* content: '大家好！'
* });
* ```
*/
api.registerGatewayMethod('dingtalk-connector.send', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { target, content, message, msgType, title, useAICard, fallbackToNormal, accountId } = params || {};
const actualContent = content || message;
const account = resolveDingtalkAccount({ cfg, accountId });
log?.info?.(`[Gateway][send] 收到请求: target=${target}, contentLen=${actualContent?.length}`);
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!target) {
return respond(false, { error: 'target is required (format: user:<userId> or group:<openConversationId>)' });
}
if (!actualContent) {
return respond(false, { error: 'content is required' });
}
const targetStr = String(target);
let sendTarget: { userId?: string; openConversationId?: string };
if (targetStr.startsWith('user:')) {
sendTarget = { userId: targetStr.slice(5) };
} else if (targetStr.startsWith('group:')) {
sendTarget = { openConversationId: targetStr.slice(6) };
} else {
// 默认当作 userId
sendTarget = { userId: targetStr };
}
const result = await sendProactive(account.config, sendTarget, actualContent, {
msgType,
title,
log,
useAICard: useAICard !== false,
fallbackToNormal: fallbackToNormal !== false,
});
respond(result.ok, result);
} catch (err: any) {
log?.error?.(`[Gateway][send] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
// ============ 文档操作类 ============
/**
* 读取钉钉文档
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.docs.read', {
* docId: 'doc123',
* operatorId: 'user_union_id'
* });
* console.log(result.content);
* ```
*/
api.registerGatewayMethod('dingtalk-connector.docs.read', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { docId, operatorId: rawOperatorId, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!docId) {
return respond(false, { error: 'docId is required' });
}
if (!rawOperatorId) {
return respond(false, { error: 'operatorId (unionId or staffId) is required' });
}
// 如果 operatorId 不像 unionId，尝试转换
let operatorId = rawOperatorId;
if (!rawOperatorId.includes('$')) {
const resolved = await getUnionId(rawOperatorId, account.config, log);
if (resolved) operatorId = resolved;
}
const client = new DingtalkDocsClient(account.config, log);
const content = await client.readDoc(docId, operatorId);
if (content !== null) {
respond(true, { content });
} else {
respond(false, { error: 'Failed to read document node' });
}
} catch (err: any) {
log?.error?.(`[Gateway][docs.read] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 创建钉钉文档
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.docs.create', {
* spaceId: 'workspace123',
* title: '会议纪要',
* content: '今天讨论了...'
* });
* console.log('文档ID:', result.docId);
* ```
*/
api.registerGatewayMethod('dingtalk-connector.docs.create', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { spaceId, title, content, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!spaceId || !title) {
return respond(false, { error: 'spaceId and title are required' });
}
const client = new DingtalkDocsClient(account.config, log);
const doc = await client.createDoc(spaceId, title, content);
if (doc) {
respond(true, doc);
} else {
respond(false, { error: 'Failed to create document' });
}
} catch (err: any) {
log?.error?.(`[Gateway][docs.create] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 向钉钉文档追加内容
*
* @example
* ```typescript
* await gateway.call('dingtalk-connector.docs.append', {
* docId: 'doc123',
* content: '补充内容...'
* });
* ```
*/
api.registerGatewayMethod('dingtalk-connector.docs.append', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { docId, content, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!docId || !content) {
return respond(false, { error: 'docId and content are required' });
}
const client = new DingtalkDocsClient(account.config, log);
const ok = await client.appendToDoc(docId, content);
respond(ok, ok ? { success: true } : { error: 'Failed to append to document' });
} catch (err: any) {
log?.error?.(`[Gateway][docs.append] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 搜索钉钉文档
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.docs.search', {
* keyword: '项目规范',
* spaceId: 'workspace123' // 可选
* });
* console.log('找到文档:', result.docs);
* ```
*/
api.registerGatewayMethod('dingtalk-connector.docs.search', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { keyword, spaceId, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!keyword) {
return respond(false, { error: 'keyword is required' });
}
const client = new DingtalkDocsClient(account.config, log);
const docs = await client.searchDocs(keyword, spaceId);
respond(true, { docs });
} catch (err: any) {
log?.error?.(`[Gateway][docs.search] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 列出空间下的文档
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.docs.list', {
* spaceId: 'workspace123',
* parentId: 'folder456' // 可选，不传则列出根目录
* });
* console.log('文档列表:', result.docs);
* ```
*/
api.registerGatewayMethod('dingtalk-connector.docs.list', async ({ context, params, respond }) => {
const cfg = context.deps.getConfig();
try {
const { spaceId, parentId, accountId } = params || {};
const account = resolveDingtalkAccount({ cfg, accountId });
if (!account.config?.clientId) {
return respond(false, { error: 'DingTalk not configured' });
}
if (!spaceId) {
return respond(false, { error: 'spaceId is required' });
}
const client = new DingtalkDocsClient(account.config, log);
const docs = await client.listDocs(spaceId, parentId);
respond(true, { docs });
} catch (err: any) {
log?.error?.(`[Gateway][docs.list] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
// ============ 状态检查类 ============
/**
* 检查插件状态
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.status');
* console.log('配置状态:', result);
* ```
*/
api.registerGatewayMethod('dingtalk-connector.status', async ({ context, respond }) => {
const cfg = context.deps.getConfig();
try {
const account = resolveDingtalkAccount({ cfg });
const configured = Boolean(account.config?.clientId && account.config?.clientSecret);
respond(true, {
configured,
enabled: account.enabled,
accountId: account.accountId,
clientId: account.config?.clientId,
});
} catch (err: any) {
log?.error?.(`[Gateway][status] 错误: ${err.message}`);
respond(false, { error: err.message });
}
});
/**
* 探测钉钉连接
*
* @example
* ```typescript
* const result = await gateway.call('dingtalk-connector.probe');
* if (result.ok) {
* console.log('连接正常');
* }
* ```
*/
api.registerGatewayMethod('dingtalk-connector.probe', async ({ context, respond }) => {
const cfg = context.deps.getConfig();
try {
const account = resolveDingtalkAccount({ cfg });
if (!account.config?.clientId || !account.config?.clientSecret) {
return respond(false, { error: 'Not configured' });
}
// 尝试获取 access token 来验证连接
const { getAccessToken } = await import('./utils/utils-legacy.ts');
await getAccessToken(account.config);
respond(true, { ok: true, details: { clientId: account.config.clientId } });
} catch (err: any) {
log?.error?.(`[Gateway][probe] 错误: ${err.message}`);
respond(false, { ok: false, error: err.message });
}
});
}
|