-
-
Notifications
You must be signed in to change notification settings - Fork 80.8k
Expand file tree
/
Copy pathsend.shared.ts
More file actions
482 lines (459 loc) · 14.2 KB
/
Copy pathsend.shared.ts
File metadata and controls
482 lines (459 loc) · 14.2 KB
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
// Discord plugin module implements send.shared behavior.
import { PollLayoutType } from "discord-api-types/payloads/v10";
import type { RESTAPIPoll } from "discord-api-types/rest/v10";
import type { APIChannel } from "discord-api-types/v10";
import type { OpenClawConfig } from "openclaw/plugin-sdk/config-contracts";
import { buildOutboundMediaLoadOptions } from "openclaw/plugin-sdk/media-runtime";
import { extensionForMime } from "openclaw/plugin-sdk/media-runtime";
import {
normalizePollDurationHours,
normalizePollInput,
type OutboundMediaAccess,
type PollInput,
} from "openclaw/plugin-sdk/media-runtime";
import { requireRuntimeConfig } from "openclaw/plugin-sdk/plugin-config-runtime";
import type { ChunkMode } from "openclaw/plugin-sdk/reply-chunking";
import { resolveTextChunksWithFallback } from "openclaw/plugin-sdk/reply-payload";
import type { RetryRunner } from "openclaw/plugin-sdk/retry-runtime";
import { normalizeStringEntries } from "openclaw/plugin-sdk/string-coerce-runtime";
import { loadWebMedia } from "openclaw/plugin-sdk/web-media";
import { chunkDiscordTextWithMode } from "./chunk.js";
import { createDiscordClient, resolveDiscordRest, type DiscordClientOpts } from "./client.js";
import {
createChannelMessage,
createUserDmChannel,
getChannel,
RequestClient,
} from "./internal/discord.js";
import { parseAndResolveRecipient } from "./recipient-resolution.js";
import { fetchChannelPermissionsDiscord, isThreadChannelType } from "./send.permissions.js";
import { DiscordSendError } from "./send.types.js";
const DISCORD_TEXT_LIMIT = 2000;
const DISCORD_MAX_STICKERS = 3;
const DISCORD_POLL_MAX_ANSWERS = 10;
const DISCORD_POLL_MAX_DURATION_HOURS = 32 * 24;
const DISCORD_MISSING_PERMISSIONS = 50013;
const DISCORD_CANNOT_DM = 50007;
type DiscordRequest = RetryRunner;
export {
buildDiscordMessagePayload,
buildDiscordMessageRequest,
resolveDiscordMessageFlags,
resolveDiscordSendComponents,
resolveDiscordSendEmbeds,
stripUndefinedFields,
SUPPRESS_EMBEDS_FLAG,
SUPPRESS_NOTIFICATIONS_FLAG,
type DiscordSendComponentFactory,
type DiscordSendComponents,
type DiscordSendEmbeds,
} from "./send.message-request.js";
import {
buildDiscordMessageRequest,
resolveDiscordMessageFlags,
resolveDiscordSendComponents,
resolveDiscordSendEmbeds,
type DiscordSendComponents,
type DiscordSendEmbeds,
} from "./send.message-request.js";
type DiscordRecipient =
| {
kind: "user";
id: string;
}
| {
kind: "channel";
id: string;
};
function normalizeReactionEmoji(raw: string) {
const trimmed = raw.trim();
if (!trimmed) {
throw new Error("emoji required");
}
const customMatch = trimmed.match(/^<a?:([^:>]+):(\d+)>$/);
const identifier = customMatch
? `${customMatch[1]}:${customMatch[2]}`
: trimmed.replace(/[\uFE0E\uFE0F]/g, "");
return encodeURIComponent(identifier);
}
function normalizeStickerIds(raw: string[]) {
const ids = normalizeStringEntries(raw);
if (ids.length === 0) {
throw new Error("At least one sticker id is required");
}
if (ids.length > DISCORD_MAX_STICKERS) {
throw new Error("Discord supports up to 3 stickers per message");
}
return ids;
}
function normalizeEmojiName(raw: string, label: string) {
const name = raw.trim();
if (!name) {
throw new Error(`${label} is required`);
}
return name;
}
function normalizeDiscordPollInput(input: PollInput): RESTAPIPoll {
const poll = normalizePollInput(input, {
maxOptions: DISCORD_POLL_MAX_ANSWERS,
});
const duration = normalizePollDurationHours(poll.durationHours, {
defaultHours: 24,
maxHours: DISCORD_POLL_MAX_DURATION_HOURS,
});
return {
question: { text: poll.question },
answers: poll.options.map((answer) => ({ poll_media: { text: answer } })),
duration,
allow_multiselect: poll.maxSelections > 1,
layout_type: PollLayoutType.Default,
};
}
function getDiscordErrorCode(err: unknown) {
if (!err || typeof err !== "object") {
return undefined;
}
const candidate =
"code" in err && err.code !== undefined
? err.code
: "rawError" in err && err.rawError && typeof err.rawError === "object"
? (err.rawError as { code?: unknown }).code
: undefined;
if (typeof candidate === "number") {
return candidate;
}
if (typeof candidate === "string" && /^\d+$/.test(candidate)) {
return Number(candidate);
}
return undefined;
}
function getDiscordErrorStatus(err: unknown) {
if (!err || typeof err !== "object") {
return undefined;
}
const candidate =
"status" in err && err.status !== undefined
? err.status
: "statusCode" in err && err.statusCode !== undefined
? err.statusCode
: undefined;
if (typeof candidate === "number" && Number.isFinite(candidate)) {
return candidate;
}
if (typeof candidate === "string" && /^\d+$/.test(candidate)) {
return Number(candidate);
}
return undefined;
}
async function buildDiscordSendError(
err: unknown,
ctx: {
channelId: string;
cfg: OpenClawConfig;
rest: RequestClient;
token: string;
hasMedia: boolean;
},
) {
if (err instanceof DiscordSendError) {
return err;
}
const code = getDiscordErrorCode(err);
if (code === DISCORD_CANNOT_DM) {
return new DiscordSendError(
`discord dm failed: user blocks dms or privacy settings disallow it (code=${code})`,
{ kind: "dm-blocked", discordCode: code, status: getDiscordErrorStatus(err) },
);
}
if (code !== DISCORD_MISSING_PERMISSIONS) {
return err;
}
let missing: string[] = [];
let probedChannelType: number | undefined;
try {
const permissions = await fetchChannelPermissionsDiscord(ctx.channelId, {
rest: ctx.rest,
token: ctx.token,
cfg: ctx.cfg,
});
probedChannelType = permissions.channelType;
const current = new Set(permissions.permissions);
const required = ["ViewChannel", "SendMessages"];
if (isThreadChannelType(probedChannelType)) {
required.push("SendMessagesInThreads");
}
if (ctx.hasMedia) {
required.push("AttachFiles");
}
missing = required.filter((permission) => !current.has(permission));
} catch {
/* ignore permission probe errors */
}
const status = getDiscordErrorStatus(err);
const apiDetails = [`code=${code}`, status != null ? `status=${status}` : undefined]
.filter(Boolean)
.join(" ");
const probedPermissions = ["ViewChannel", "SendMessages"];
if (isThreadChannelType(probedChannelType)) {
probedPermissions.push("SendMessagesInThreads");
}
if (ctx.hasMedia) {
probedPermissions.push("AttachFiles");
}
const probeSummary = probedPermissions.join("/");
const missingLabel = missing.length
? `discord missing permissions in channel ${ctx.channelId}: ${missing.join(", ")}`
: `discord missing permissions in channel ${ctx.channelId}; permission probe did not identify missing ${probeSummary}`;
return new DiscordSendError(
`${missingLabel} (${apiDetails}). bot might be blocked by channel/thread overrides, archived thread state, reply target visibility, or app-role position`,
{
kind: "missing-permissions",
channelId: ctx.channelId,
missingPermissions: missing,
discordCode: code,
status,
},
);
}
async function resolveChannelId(
rest: RequestClient,
recipient: DiscordRecipient,
request: DiscordRequest,
): Promise<{ channelId: string; dm?: boolean }> {
if (recipient.kind === "channel") {
return { channelId: recipient.id };
}
const dmChannel = (await request(
() => createUserDmChannel(rest, recipient.id),
"dm-channel",
)) as { id: string };
if (!dmChannel?.id) {
throw new Error("Failed to create Discord DM channel");
}
return { channelId: dmChannel.id, dm: true };
}
async function resolveDiscordTargetChannelId(
raw: string,
opts: DiscordClientOpts & { cfg: OpenClawConfig },
): Promise<{ channelId: string; dm?: boolean }> {
const cfg = requireRuntimeConfig(opts.cfg, "Discord target channel resolution");
const recipient = await parseAndResolveRecipient(raw, cfg, opts.accountId, {
defaultKind: "channel",
});
const { rest, request } = createDiscordClient(opts);
return await resolveChannelId(rest, recipient, request);
}
export async function resolveDiscordChannelType(
rest: RequestClient,
channelId: string,
): Promise<number | undefined> {
try {
const channel = (await getChannel(rest, channelId)) as APIChannel | undefined;
return channel?.type;
} catch {
return undefined;
}
}
export function buildDiscordTextChunks(
text: string,
opts: { maxLinesPerMessage?: number; chunkMode?: ChunkMode; maxChars?: number } = {},
): string[] {
if (!text) {
return [];
}
const chunks = chunkDiscordTextWithMode(text, {
maxChars: opts.maxChars ?? DISCORD_TEXT_LIMIT,
maxLines: opts.maxLinesPerMessage,
chunkMode: opts.chunkMode,
});
return resolveTextChunksWithFallback(text, chunks);
}
export function toDiscordFileBlob(data: Blob | Uint8Array): Blob {
if (data instanceof Blob) {
return data;
}
const arrayBuffer = new ArrayBuffer(data.byteLength);
new Uint8Array(arrayBuffer).set(data);
return new Blob([arrayBuffer]);
}
export type DiscordSendProgress = (
result: { id: string; channel_id: string },
kind: "text" | "media",
) => Promise<void> | void;
async function sendDiscordText(
rest: RequestClient,
channelId: string,
text: string,
replyTo: string | undefined,
request: DiscordRequest,
maxLinesPerMessage?: number,
components?: DiscordSendComponents,
embeds?: DiscordSendEmbeds,
chunkMode?: ChunkMode,
silent?: boolean,
suppressEmbeds?: boolean,
maxChars?: number,
onResult?: DiscordSendProgress,
) {
if (!text.trim()) {
throw new Error("Message must be non-empty for Discord sends");
}
const chunks = buildDiscordTextChunks(text, { maxLinesPerMessage, chunkMode, maxChars });
const sendChunk = async (chunk: string, isFirst: boolean) => {
const chunkComponents = resolveDiscordSendComponents({
components,
text: chunk,
isFirst,
});
const chunkEmbeds = resolveDiscordSendEmbeds({ embeds, isFirst });
const flags = resolveDiscordMessageFlags({
silent,
suppressEmbeds: suppressEmbeds && !chunkEmbeds?.length,
});
const body = buildDiscordMessageRequest({
text: chunk,
components: chunkComponents,
embeds: chunkEmbeds,
flags,
replyTo,
});
return (await request(
() => createChannelMessage<{ id: string; channel_id: string }>(rest, channelId, { body }),
"text",
)) as { id: string; channel_id: string };
};
if (chunks.length === 1) {
const result = await sendChunk(chunks[0], true);
await onResult?.(result, "text");
return { ...result, platformMessageIds: result.id ? [result.id] : [] };
}
const platformMessageIds: string[] = [];
let last: { id: string; channel_id: string } | null = null;
for (const [index, chunk] of chunks.entries()) {
last = await sendChunk(chunk, index === 0);
await onResult?.(last, "text");
if (last.id) {
platformMessageIds.push(last.id);
}
}
if (!last) {
throw new Error("Discord send failed (empty chunk result)");
}
return { ...last, platformMessageIds };
}
async function sendDiscordMedia(
rest: RequestClient,
channelId: string,
text: string,
mediaUrl: string,
filename: string | undefined,
mediaAccess: OutboundMediaAccess | undefined,
mediaLocalRoots: readonly string[] | undefined,
mediaReadFile: ((filePath: string) => Promise<Buffer>) | undefined,
maxBytes: number | undefined,
replyTo: string | undefined,
request: DiscordRequest,
maxLinesPerMessage?: number,
components?: DiscordSendComponents,
embeds?: DiscordSendEmbeds,
chunkMode?: ChunkMode,
silent?: boolean,
suppressEmbeds?: boolean,
maxChars?: number,
onResult?: DiscordSendProgress,
) {
const media = await loadWebMedia(
mediaUrl,
buildOutboundMediaLoadOptions({ maxBytes, mediaAccess, mediaLocalRoots, mediaReadFile }),
);
const requestedFileName = filename?.trim();
const resolvedFileName =
requestedFileName ||
media.fileName ||
(media.contentType ? `upload${extensionForMime(media.contentType) ?? ""}` : "") ||
"upload";
const chunks = text
? buildDiscordTextChunks(text, { maxLinesPerMessage, chunkMode, maxChars })
: [];
const caption = chunks[0] ?? "";
const fileData = toDiscordFileBlob(media.buffer);
const captionComponents = resolveDiscordSendComponents({
components,
text: caption,
isFirst: true,
});
const captionEmbeds = resolveDiscordSendEmbeds({ embeds, isFirst: true });
const flags = resolveDiscordMessageFlags({
silent,
suppressEmbeds: suppressEmbeds && !captionEmbeds?.length,
});
const body = buildDiscordMessageRequest({
text: caption,
components: captionComponents,
embeds: captionEmbeds,
flags,
replyTo,
files: [
{
data: fileData,
name: resolvedFileName,
},
],
});
const res = (await request(
() => createChannelMessage<{ id: string; channel_id: string }>(rest, channelId, { body }),
"media",
)) as { id: string; channel_id: string };
await onResult?.(res, "media");
const platformMessageIds = res.id ? [res.id] : [];
for (const chunk of chunks.slice(1)) {
if (!chunk.trim()) {
continue;
}
const followup = await sendDiscordText(
rest,
channelId,
chunk,
replyTo,
request,
maxLinesPerMessage,
undefined,
undefined,
chunkMode,
silent,
suppressEmbeds,
maxChars,
onResult,
);
for (const id of followup.platformMessageIds) {
if (id) {
platformMessageIds.push(id);
}
}
}
return { ...res, platformMessageIds };
}
function buildReactionIdentifier(emoji: { id?: string | null; name?: string | null }) {
if (emoji.id && emoji.name) {
return `${emoji.name}:${emoji.id}`;
}
return emoji.name ?? "";
}
function formatReactionEmoji(emoji: { id?: string | null; name?: string | null }) {
return buildReactionIdentifier(emoji);
}
export {
buildDiscordSendError,
buildReactionIdentifier,
createDiscordClient,
formatReactionEmoji,
normalizeDiscordPollInput,
normalizeEmojiName,
normalizeReactionEmoji,
normalizeStickerIds,
resolveChannelId,
resolveDiscordTargetChannelId,
resolveDiscordRest,
sendDiscordMedia,
sendDiscordText,
};