forked from openclaw/openclaw
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathpayload.ts
More file actions
543 lines (501 loc) · 16.4 KB
/
Copy pathpayload.ts
File metadata and controls
543 lines (501 loc) · 16.4 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
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
import { asOptionalRecord as toRecord } from "../shared/record-coerce.js";
import {
normalizeOptionalLowercaseString,
normalizeOptionalString,
} from "../shared/string-coerce.js";
export type InteractiveButtonStyle = "primary" | "secondary" | "success" | "danger";
/** Visual tone for a portable message presentation. */
export type MessagePresentationTone = "info" | "success" | "warning" | "danger" | "neutral";
/** Button style hint for renderers that support styled actions. */
export type MessagePresentationButtonStyle = InteractiveButtonStyle;
/** Portable action control rendered as a button or link by channel adapters. */
export type MessagePresentationButton = {
/** User-visible button label. */
label: string;
/** Callback command or opaque value sent when the button is pressed. */
value?: string;
/** External URL opened by the button instead of sending a callback value. */
url?: string;
/** Telegram-style web app launch target. */
webApp?: {
url: string;
};
/**
* @deprecated Use webApp. The snake_case alias is accepted for legacy JSON payloads only.
*/
web_app?: {
url: string;
};
/** Higher-priority buttons are kept first when channel limits require truncation. */
priority?: number;
/** Disable the button when the target channel supports disabled controls. */
disabled?: boolean;
/** Keep this action available after a successful interaction when the target channel supports it. */
reusable?: boolean;
/** Optional visual style hint; unsupported channels ignore or normalize it. */
style?: InteractiveButtonStyle;
};
/** Portable select/menu option. */
export type MessagePresentationOption = {
/** User-visible option label. */
label: string;
/** Callback command or opaque value sent when the option is selected. */
value: string;
};
/**
* @deprecated Use MessagePresentationButton.
*/
export type InteractiveReplyButton = MessagePresentationButton;
/**
* @deprecated Use MessagePresentationOption.
*/
export type InteractiveReplyOption = MessagePresentationOption;
/**
* @deprecated Use MessagePresentationTextBlock.
*/
export type InteractiveReplyTextBlock = {
type: "text";
text: string;
};
/**
* @deprecated Use MessagePresentationButtonsBlock.
*/
type InteractiveReplyButtonsBlock = {
type: "buttons";
buttons: InteractiveReplyButton[];
};
/**
* @deprecated Use MessagePresentationSelectBlock.
*/
export type InteractiveReplySelectBlock = {
type: "select";
placeholder?: string;
options: InteractiveReplyOption[];
};
/**
* @deprecated Use MessagePresentationBlock.
*/
export type InteractiveReplyBlock =
| InteractiveReplyTextBlock
| InteractiveReplyButtonsBlock
| InteractiveReplySelectBlock;
/**
* @deprecated Use MessagePresentation.
*/
export type InteractiveReply = {
blocks: InteractiveReplyBlock[];
};
export type MessagePresentationTextBlock = {
type: "text";
/** Primary markdown-ish text rendered in the message body. */
text: string;
};
export type MessagePresentationContextBlock = {
type: "context";
/** Lower-emphasis contextual text, or normal text on channels without context support. */
text: string;
};
export type MessagePresentationDividerBlock = {
type: "divider";
};
export type MessagePresentationButtonsBlock = {
type: "buttons";
/** Button row candidates; core may split or truncate them for channel limits. */
buttons: MessagePresentationButton[];
};
export type MessagePresentationSelectBlock = {
type: "select";
/** Optional prompt shown above or inside the select control. */
placeholder?: string;
/** Menu options; core may truncate them for channel limits. */
options: MessagePresentationOption[];
};
export type MessagePresentationInteractiveBlock =
| MessagePresentationButtonsBlock
| MessagePresentationSelectBlock;
export type MessagePresentationBlock =
| MessagePresentationTextBlock
| MessagePresentationContextBlock
| MessagePresentationDividerBlock
| MessagePresentationButtonsBlock
| MessagePresentationSelectBlock;
export type MessagePresentation = {
/** Optional short heading rendered before blocks when the channel supports it. */
title?: string;
/** Optional severity/status tone for renderers that support toned presentations. */
tone?: MessagePresentationTone;
/** Ordered portable blocks rendered or downgraded by the target channel adapter. */
blocks: MessagePresentationBlock[];
};
export type ReplyPayloadDeliveryPin = {
enabled: boolean;
notify?: boolean;
required?: boolean;
};
export type ReplyPayloadDelivery = {
pin?: boolean | ReplyPayloadDeliveryPin;
};
function normalizeButtonStyle(value: unknown): InteractiveButtonStyle | undefined {
const style = normalizeOptionalLowercaseString(value);
return style === "primary" || style === "secondary" || style === "success" || style === "danger"
? style
: undefined;
}
function normalizePresentationTone(value: unknown): MessagePresentationTone | undefined {
const tone = normalizeOptionalLowercaseString(value);
return tone === "info" ||
tone === "success" ||
tone === "warning" ||
tone === "danger" ||
tone === "neutral"
? tone
: undefined;
}
function normalizeButton(raw: unknown): InteractiveReplyButton | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const label = normalizeOptionalString(record.label) ?? normalizeOptionalString(record.text);
const value =
normalizeOptionalString(record.value) ??
normalizeOptionalString(record.callbackData) ??
normalizeOptionalString(record.callback_data);
const url = normalizeOptionalString(record.url);
const webAppRecord = toRecord(record.webApp) ?? toRecord(record.web_app);
const webAppUrl = normalizeOptionalString(webAppRecord?.url);
if (!label || (!value && !url && !webAppUrl)) {
return undefined;
}
const priority =
typeof record.priority === "number" && Number.isFinite(record.priority)
? record.priority
: undefined;
return {
label,
...(value ? { value } : {}),
...(url ? { url } : {}),
...(webAppUrl ? { webApp: { url: webAppUrl } } : {}),
...(priority !== undefined ? { priority } : {}),
...(record.disabled === true ? { disabled: true } : {}),
...(record.reusable === true ? { reusable: true } : {}),
style: normalizeButtonStyle(record.style),
};
}
function normalizeOption(raw: unknown): InteractiveReplyOption | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const label = normalizeOptionalString(record.label) ?? normalizeOptionalString(record.text);
const value = normalizeOptionalString(record.value);
if (!label || !value) {
return undefined;
}
return { label, value };
}
function normalizeList<T>(value: unknown, normalizeEntry: (entry: unknown) => T | undefined): T[] {
return Array.isArray(value)
? value.map((entry) => normalizeEntry(entry)).filter((entry): entry is T => Boolean(entry))
: [];
}
function normalizeInteractiveBlock(raw: unknown): InteractiveReplyBlock | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const type = normalizeOptionalLowercaseString(record.type);
if (type === "text") {
const text = normalizeOptionalString(record.text);
return text ? { type: "text", text } : undefined;
}
if (type === "buttons") {
const buttons = normalizeList(record.buttons, normalizeButton);
return buttons.length > 0 ? { type: "buttons", buttons } : undefined;
}
if (type === "select") {
const options = normalizeList(record.options, normalizeOption);
return options.length > 0
? {
type: "select",
placeholder: normalizeOptionalString(record.placeholder),
options,
}
: undefined;
}
return undefined;
}
/**
* @deprecated Use normalizeMessagePresentation.
*/
export function normalizeInteractiveReply(raw: unknown): InteractiveReply | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const blocks = normalizeList(record.blocks, normalizeInteractiveBlock);
return blocks.length > 0 ? { blocks } : undefined;
}
function normalizePresentationBlock(raw: unknown): MessagePresentationBlock | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const type = normalizeOptionalLowercaseString(record.type);
if (type === "text" || type === "context") {
const text = normalizeOptionalString(record.text);
return text ? { type, text } : undefined;
}
if (type === "divider") {
return { type: "divider" };
}
if (type === "buttons") {
const buttons = normalizeList(record.buttons, normalizeButton);
return buttons.length > 0 ? { type: "buttons", buttons } : undefined;
}
if (type === "select") {
const options = normalizeList(record.options, normalizeOption);
return options.length > 0
? {
type: "select",
placeholder: normalizeOptionalString(record.placeholder),
options,
}
: undefined;
}
return undefined;
}
export function normalizeMessagePresentation(raw: unknown): MessagePresentation | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const blocks = normalizeList(record.blocks, normalizePresentationBlock);
const title = normalizeOptionalString(record.title);
if (!title && blocks.length === 0) {
return undefined;
}
return {
...(title ? { title } : {}),
tone: normalizePresentationTone(record.tone),
blocks,
};
}
/**
* @deprecated Use hasMessagePresentationBlocks.
*/
export function hasInteractiveReplyBlocks(value: unknown): value is InteractiveReply {
return Boolean(normalizeInteractiveReply(value));
}
export function hasMessagePresentationBlocks(value: unknown): value is MessagePresentation {
return Boolean(normalizeMessagePresentation(value));
}
/**
* @deprecated Avoid producing InteractiveReply payloads; send MessagePresentation directly.
*/
export function presentationToInteractiveReply(
presentation: MessagePresentation,
): InteractiveReply | undefined {
const blocks: InteractiveReplyBlock[] = [];
if (presentation.title) {
blocks.push({ type: "text", text: presentation.title });
}
for (const block of presentation.blocks) {
if (block.type === "text" || block.type === "context") {
blocks.push({ type: "text", text: block.text });
continue;
}
if (block.type === "buttons") {
const buttons = block.buttons
.filter((button) => button.value || button.url || button.webApp || button.web_app)
.map((button) => {
const interactiveButton: InteractiveReplyButton = {
label: button.label,
style: button.style,
};
if (button.value) {
interactiveButton.value = button.value;
}
if (button.url) {
interactiveButton.url = button.url;
}
const webApp = button.webApp ?? button.web_app;
if (webApp) {
interactiveButton.webApp = webApp;
}
if (button.priority !== undefined) {
interactiveButton.priority = button.priority;
}
if (button.disabled === true) {
interactiveButton.disabled = true;
}
if (button.reusable === true) {
interactiveButton.reusable = true;
}
return interactiveButton;
});
if (buttons.length > 0) {
blocks.push({ type: "buttons", buttons });
}
continue;
}
if (block.type === "select") {
blocks.push({
type: "select",
placeholder: block.placeholder,
options: block.options,
});
}
}
return blocks.length > 0 ? { blocks } : undefined;
}
export function isMessagePresentationInteractiveBlock(
block: MessagePresentationBlock,
): block is MessagePresentationInteractiveBlock {
return block.type === "buttons" || block.type === "select";
}
/**
* @deprecated Avoid producing InteractiveReply payloads; send MessagePresentation directly.
*/
export function presentationToInteractiveControlsReply(
presentation: MessagePresentation,
): InteractiveReply | undefined {
return presentationToInteractiveReply({
blocks: presentation.blocks.filter(isMessagePresentationInteractiveBlock),
});
}
/**
* @deprecated Legacy bridge for old InteractiveReply payloads. New producers should send MessagePresentation.
*/
export function interactiveReplyToPresentation(
interactive: InteractiveReply,
): MessagePresentation | undefined {
const blocks = interactive.blocks.map((block): MessagePresentationBlock => {
if (block.type === "text") {
return { type: "text", text: block.text };
}
if (block.type === "buttons") {
return { type: "buttons", buttons: block.buttons };
}
return {
type: "select",
placeholder: block.placeholder,
options: block.options,
};
});
return blocks.length > 0 ? { blocks } : undefined;
}
export function renderMessagePresentationFallbackText(params: {
presentation?: MessagePresentation;
emptyFallback?: string | null;
text?: string | null;
}): string {
const lines: string[] = [];
const text = normalizeOptionalString(params.text);
if (text) {
lines.push(text);
}
const presentation = params.presentation;
if (!presentation) {
return lines.join("\n\n");
}
if (presentation.title) {
lines.push(presentation.title);
}
for (const block of presentation.blocks) {
if (block.type === "text" || block.type === "context") {
lines.push(block.text);
continue;
}
if (block.type === "buttons") {
const labels = block.buttons
.map((button) => {
const targetUrl = button.url ?? button.webApp?.url ?? button.web_app?.url;
return targetUrl ? `${button.label}: ${targetUrl}` : button.label;
})
.filter(Boolean);
if (labels.length > 0) {
lines.push(labels.map((label) => `- ${label}`).join("\n"));
}
continue;
}
if (block.type === "select") {
const labels = block.options.map((option) => option.label).filter(Boolean);
if (labels.length > 0) {
const heading = block.placeholder ? `${block.placeholder}:` : "Options:";
lines.push(`${heading}\n${labels.map((label) => `- ${label}`).join("\n")}`);
}
}
}
const rendered = lines.join("\n\n");
return rendered || normalizeOptionalString(params.emptyFallback) || "";
}
export function hasReplyChannelData(value: unknown): value is Record<string, unknown> {
return Boolean(
value && typeof value === "object" && !Array.isArray(value) && Object.keys(value).length > 0,
);
}
export function hasReplyContent(params: {
text?: string | null;
mediaUrl?: string | null;
mediaUrls?: ReadonlyArray<string | null | undefined>;
interactive?: unknown;
presentation?: unknown;
hasChannelData?: boolean;
extraContent?: boolean;
}): boolean {
const text = normalizeOptionalString(params.text);
const mediaUrl = normalizeOptionalString(params.mediaUrl);
return Boolean(
text ||
mediaUrl ||
params.mediaUrls?.some((entry) => Boolean(normalizeOptionalString(entry))) ||
hasMessagePresentationBlocks(params.presentation) ||
hasInteractiveReplyBlocks(params.interactive) ||
params.hasChannelData ||
params.extraContent,
);
}
export function hasReplyPayloadContent(
payload: {
text?: string | null;
mediaUrl?: string | null;
mediaUrls?: ReadonlyArray<string | null | undefined>;
interactive?: unknown;
presentation?: unknown;
channelData?: unknown;
},
options?: {
trimText?: boolean;
hasChannelData?: boolean;
extraContent?: boolean;
},
): boolean {
return hasReplyContent({
text: options?.trimText ? payload.text?.trim() : payload.text,
mediaUrl: payload.mediaUrl,
mediaUrls: payload.mediaUrls,
interactive: payload.interactive,
presentation: payload.presentation,
hasChannelData: options?.hasChannelData ?? hasReplyChannelData(payload.channelData),
extraContent: options?.extraContent,
});
}
/**
* @deprecated Use renderMessagePresentationFallbackText with MessagePresentation.
*/
export function resolveInteractiveTextFallback(params: {
text?: string;
interactive?: InteractiveReply;
}): string | undefined {
const text = normalizeOptionalString(params.text);
if (text) {
return params.text;
}
const interactiveText = (params.interactive?.blocks ?? [])
.filter((block): block is InteractiveReplyTextBlock => block.type === "text")
.map((block) => block.text.trim())
.filter(Boolean)
.join("\n\n");
return interactiveText || params.text;
}