File size: 42,684 Bytes
d197cf3 | 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 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 | // Interactive payload helpers normalize structured interactive UI payloads.
import { asOptionalRecord as toRecord } from "@openclaw/normalization-core/record-coerce";
import {
normalizeOptionalLowercaseString,
normalizeOptionalString,
} from "@openclaw/normalization-core/string-coerce";
import { isWellFormedApprovalId } from "../../packages/gateway-protocol/src/schema/approval-id.js";
import type { ChannelApprovalKind } from "../infra/approval-types.js";
const PRESENTATION_FALLBACK_CONTINUATION = Symbol.for(
"openclaw.presentation.fallback-continuation",
);
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;
type QuestionPresentationAction =
| {
/** Resolve one declared choice. */
type: "question";
questionId: string;
optionValue: string;
}
| {
/** Switch this question to its free-text answer path. */
type: "question";
questionId: string;
intent: "custom-input";
};
/** Core-owned model-picker action; channels serialize it only inside private envelopes. */
export type ModelPickerAction = (
| {
type: "model-picker";
version: 1;
snapshotToken: string;
intent: "show-providers";
cursor?: string;
}
| {
type: "model-picker";
version: 1;
snapshotToken: string;
intent: "show-models";
providerToken: string;
cursor?: string;
}
| {
type: "model-picker";
version: 1;
snapshotToken: string;
intent: "show-recents";
cursor?: string;
}
| {
type: "model-picker";
version: 1;
snapshotToken: string;
intent: "choose-model";
providerToken: string;
modelToken: string;
}
| {
type: "model-picker";
version: 1;
snapshotToken: string;
intent: "choose-runtime";
providerToken: string;
modelToken: string;
runtimeToken: string;
}
| { type: "model-picker"; version: 1; snapshotToken: string; intent: "reset" }
| { type: "model-picker"; version: 1; snapshotToken: string; intent: "cancel" }
) & {
/** Legacy command/callback payload fields are deliberately unavailable on picker actions. */
readonly command?: never;
readonly value?: never;
};
/** Portable typed action behind a button or select option. */
export type MessagePresentationAction =
| {
/** Run a core/plugin slash command through the target channel's native command path. */
type: "command";
command: string;
}
| {
/** Opaque callback value interpreted by the target channel/plugin. */
type: "callback";
value: string;
}
| ModelPickerAction
| {
/** Resolve one durable operator approval without exposing transport callback data. */
type: "approval";
approvalId: string;
approvalKind: ChannelApprovalKind;
decision: "allow-once" | "allow-always" | "deny";
}
| QuestionPresentationAction
| {
/** Open a normal external link. */
type: "url";
url: string;
}
| {
/** Launch a channel-native web app. */
type: "web-app";
/** External web app URL for channels that launch web apps by URL. */
url: string;
/** OpenClaw hosted-widget ID whose launch mechanics are owned by the channel. */
widgetId?: string;
}
| {
/** Launch a channel-native web app. */
type: "web-app";
/** External web app URL for channels that launch web apps by URL. */
url?: string;
/** OpenClaw hosted-widget ID whose launch mechanics are owned by the channel. */
widgetId: string;
};
type LegacyMessagePresentationAction = Exclude<MessagePresentationAction, ModelPickerAction>;
/** Portable action control rendered as a button or link by channel adapters. */
export type MessagePresentationButton = {
/** User-visible button label. */
label: string;
/** Typed action sent when the button is pressed. */
action?: MessagePresentationAction;
/**
* Legacy opaque callback value sent when the button is pressed.
* Prefer action for new presentation controls.
* @deprecated Use action.
*/
value?: string;
/** @deprecated Use an action with type "url". */
url?: string;
/** @deprecated Use an action with type "web-app". */
webApp?: {
url: string;
};
/**
* @deprecated Use an action with type "web-app". 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;
/** Typed action sent when the option is selected. */
action?: Extract<MessagePresentationAction, { type: "command" | "callback" | "model-picker" }>;
/** @deprecated Use action. */
value?: string;
};
export function resolveMessagePresentationActionValue(
action: MessagePresentationAction | undefined,
): string | undefined {
if (action?.type === "command") {
return action.command;
}
if (action?.type === "callback") {
return action.value;
}
return undefined;
}
export function resolveMessagePresentationControlValue(control: {
action?: MessagePresentationAction;
value?: string;
}): string | undefined {
if (control.action !== undefined) {
const action = normalizePresentationAction(control.action);
return action ? resolveMessagePresentationActionValue(action) : undefined;
}
return control.value;
}
/** Resolve a canonical button action, including deprecated boundary inputs. */
export function resolveMessagePresentationButtonAction(
button: Pick<MessagePresentationButton, "action" | "url" | "value" | "webApp" | "web_app">,
options: { modelPicker: true },
): MessagePresentationAction | undefined;
export function resolveMessagePresentationButtonAction(
button: Pick<MessagePresentationButton, "action" | "url" | "value" | "webApp" | "web_app">,
): LegacyMessagePresentationAction | undefined;
export function resolveMessagePresentationButtonAction(
button: Pick<MessagePresentationButton, "action" | "url" | "value" | "webApp" | "web_app">,
options?: { modelPicker?: boolean },
): MessagePresentationAction | undefined {
if (button.action !== undefined) {
const action = normalizePresentationAction(button.action);
return action?.type === "model-picker" && options?.modelPicker !== true ? undefined : action;
}
if (button.url) {
return { type: "url", url: button.url };
}
const webAppUrl = button.webApp?.url ?? button.web_app?.url;
if (webAppUrl) {
return { type: "web-app", url: webAppUrl };
}
return button.value ? { type: "callback", value: button.value } : undefined;
}
/** Resolve a canonical select action, including the deprecated value input. */
export function resolveMessagePresentationOptionAction(
option: Pick<MessagePresentationOption, "action" | "value">,
options: { modelPicker: true },
):
| Extract<MessagePresentationAction, { type: "command" | "callback" | "model-picker" }>
| undefined;
export function resolveMessagePresentationOptionAction(
option: Pick<MessagePresentationOption, "action" | "value">,
): Extract<LegacyMessagePresentationAction, { type: "command" | "callback" }> | undefined;
export function resolveMessagePresentationOptionAction(
option: Pick<MessagePresentationOption, "action" | "value">,
options?: { modelPicker?: boolean },
):
| Extract<MessagePresentationAction, { type: "command" | "callback" | "model-picker" }>
| undefined {
if (option.action !== undefined) {
const action = normalizePresentationAction(option.action);
if (action?.type === "model-picker" && options?.modelPicker !== true) {
return undefined;
}
return action?.type === "command" ||
action?.type === "callback" ||
action?.type === "model-picker"
? action
: undefined;
}
return option.value ? { type: "callback", value: option.value } : undefined;
}
export type LegacyInteractiveReplyButton = MessagePresentationButton;
/** @deprecated Use MessagePresentationButton. */
export type InteractiveReplyButton = LegacyInteractiveReplyButton;
export type LegacyInteractiveReplyOption = MessagePresentationOption;
/** @deprecated Use MessagePresentationOption. */
export type InteractiveReplyOption = LegacyInteractiveReplyOption;
export type LegacyInteractiveReplyTextBlock = {
type: "text";
text: string;
};
export type LegacyInteractiveReplySelectBlock = {
type: "select";
placeholder?: string;
options: LegacyInteractiveReplyOption[];
};
export type LegacyInteractiveReplyBlock =
| LegacyInteractiveReplyTextBlock
| MessagePresentationButtonsBlock
| LegacyInteractiveReplySelectBlock;
/** @deprecated Use MessagePresentationBlock. */
export type InteractiveReplyBlock = LegacyInteractiveReplyBlock;
export type LegacyInteractiveReply = {
blocks: LegacyInteractiveReplyBlock[];
};
export function reduceLegacyInteractiveReply<TState>(
interactive: LegacyInteractiveReply | undefined,
initialState: TState,
reduce: (state: TState, block: LegacyInteractiveReplyBlock, index: number) => TState,
): TState {
let state = initialState;
for (const [index, block] of (interactive?.blocks ?? []).entries()) {
state = reduce(state, block, index);
}
return state;
}
/** @deprecated Use MessagePresentation. */
export type InteractiveReply = LegacyInteractiveReply;
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 MessagePresentationChartSegment = {
/** Category label shown in the chart legend. */
label: string;
/** Positive segment magnitude. */
value: number;
};
export type MessagePresentationChartSeries = {
/** Unique series name shown in the chart legend. */
name: string;
/** One finite value for each chart category, in category order. */
values: number[];
};
export type MessagePresentationChartBlock =
| {
type: "chart";
chartType: "pie";
/** Short chart heading. */
title: string;
segments: MessagePresentationChartSegment[];
}
| {
type: "chart";
chartType: "bar" | "area" | "line";
/** Short chart heading. */
title: string;
/** Ordered categories shared by every series. */
categories: string[];
series: MessagePresentationChartSeries[];
xLabel?: string;
yLabel?: string;
};
/** Scalar cell value supported by portable table presentations. */
export type MessagePresentationTableCell = string | number;
/** Portable table rendered natively where supported and linearly elsewhere. */
export type MessagePresentationTableBlock = {
type: "table";
/** Short table heading used by native renderers and fallback text. */
caption: string;
/** Unique ordered column labels shared by every row. */
headers: string[];
/** Rows whose width exactly matches the header count. */
rows: MessagePresentationTableCell[][];
/** Optional column whose cells should be rendered as row headers. */
rowHeaderColumnIndex?: number;
};
export type MessagePresentationInteractiveBlock =
| MessagePresentationButtonsBlock
| MessagePresentationSelectBlock;
export type MessagePresentationBlock =
| MessagePresentationTextBlock
| MessagePresentationContextBlock
| MessagePresentationDividerBlock
| MessagePresentationButtonsBlock
| MessagePresentationSelectBlock
| MessagePresentationChartBlock
| MessagePresentationTableBlock;
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;
}
const MODEL_PICKER_TOKEN_MAX_LENGTH = 128;
const MODEL_PICKER_TOKEN_PATTERN = /^[A-Za-z0-9_-]+$/u;
function normalizeModelPickerToken(value: unknown): string | undefined {
const token = normalizeOptionalString(value);
return token &&
token.length <= MODEL_PICKER_TOKEN_MAX_LENGTH &&
MODEL_PICKER_TOKEN_PATTERN.test(token)
? token
: undefined;
}
function normalizeOptionalModelPickerCursor(
record: Record<string, unknown>,
): { valid: true; cursor?: string } | { valid: false } {
if (record.cursor === undefined) {
return { valid: true };
}
const cursor = normalizeModelPickerToken(record.cursor);
return cursor ? { valid: true, cursor } : { valid: false };
}
function normalizeModelPickerAction(
record: Record<string, unknown>,
): ModelPickerAction | undefined {
if (record.type !== "model-picker" || record.version !== 1) {
return undefined;
}
const snapshotToken = normalizeModelPickerToken(record.snapshotToken);
if (!snapshotToken) {
return undefined;
}
const intent = record.intent;
if (intent === "show-providers" || intent === "show-recents") {
const cursor = normalizeOptionalModelPickerCursor(record);
return cursor.valid
? {
type: "model-picker",
version: 1,
snapshotToken,
intent,
...(cursor.cursor ? { cursor: cursor.cursor } : {}),
}
: undefined;
}
if (intent === "show-models") {
const providerToken = normalizeModelPickerToken(record.providerToken);
const cursor = normalizeOptionalModelPickerCursor(record);
return providerToken && cursor.valid
? {
type: "model-picker",
version: 1,
snapshotToken,
intent,
providerToken,
...(cursor.cursor ? { cursor: cursor.cursor } : {}),
}
: undefined;
}
if (intent === "choose-model") {
const providerToken = normalizeModelPickerToken(record.providerToken);
const modelToken = normalizeModelPickerToken(record.modelToken);
return providerToken && modelToken
? { type: "model-picker", version: 1, snapshotToken, intent, providerToken, modelToken }
: undefined;
}
if (intent === "choose-runtime") {
const providerToken = normalizeModelPickerToken(record.providerToken);
const modelToken = normalizeModelPickerToken(record.modelToken);
const runtimeToken = normalizeModelPickerToken(record.runtimeToken);
return providerToken && modelToken && runtimeToken
? {
type: "model-picker",
version: 1,
snapshotToken,
intent,
providerToken,
modelToken,
runtimeToken,
}
: undefined;
}
return intent === "reset" || intent === "cancel"
? { type: "model-picker", version: 1, snapshotToken, intent }
: undefined;
}
function normalizePresentationAction(raw: unknown): MessagePresentationAction | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const type = normalizeOptionalLowercaseString(record.type);
if (type === "command") {
const command = normalizeOptionalString(record.command);
return command ? { type: "command", command } : undefined;
}
if (type === "callback") {
const value = normalizeOptionalString(record.value);
return value ? { type: "callback", value } : undefined;
}
if (type === "model-picker") {
return normalizeModelPickerAction(record);
}
if (type === "approval") {
if (record.type !== "approval") {
return undefined;
}
const approvalId = record.approvalId;
const approvalKind = record.approvalKind;
const decision = record.decision;
if (
typeof approvalId !== "string" ||
!isWellFormedApprovalId(approvalId) ||
(approvalKind !== "exec" && approvalKind !== "plugin" && approvalKind !== "system-agent") ||
(decision !== "allow-once" && decision !== "allow-always" && decision !== "deny")
) {
return undefined;
}
return { type: "approval", approvalId, approvalKind, decision };
}
if (type === "question") {
if (record.type !== "question") {
return undefined;
}
const questionId = record.questionId;
const optionValue = record.optionValue;
if (typeof questionId !== "string" || !isWellFormedApprovalId(questionId)) {
return undefined;
}
const intent = record.intent;
if (intent === undefined) {
return typeof optionValue === "string" && optionValue.trim()
? { type: "question", questionId, optionValue }
: undefined;
}
if (intent === "custom-input") {
return { type: "question", questionId, intent };
}
return undefined;
}
if (type === "url") {
const url = normalizeOptionalString(record.url);
return url ? { type: "url", url } : undefined;
}
if (type === "web-app") {
const url = normalizeOptionalString(record.url);
const widgetId = normalizeOptionalString(record.widgetId);
if (url) {
return { type: "web-app", url, ...(widgetId ? { widgetId } : {}) };
}
return widgetId ? { type: "web-app", widgetId } : undefined;
}
return 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);
const action =
record.action !== undefined ? normalizePresentationAction(record.action) : undefined;
if (
!label ||
(record.action !== undefined && !action) ||
(!action && !value && !url && !webAppUrl)
) {
return undefined;
}
const priority =
typeof record.priority === "number" && Number.isFinite(record.priority)
? record.priority
: undefined;
return {
label,
...(action ? { action } : {}),
...(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);
const normalizedAction =
record.action !== undefined ? normalizePresentationAction(record.action) : undefined;
const action =
normalizedAction?.type === "command" ||
normalizedAction?.type === "callback" ||
normalizedAction?.type === "model-picker"
? normalizedAction
: undefined;
if (!label || (record.action !== undefined && !action) || (!action && !value)) {
return undefined;
}
return { label, ...(action ? { action } : {}), ...(value ? { 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;
}
function normalizeChartSegments(value: unknown): MessagePresentationChartSegment[] | undefined {
if (!Array.isArray(value) || value.length === 0) {
return undefined;
}
const segments = value.map((entry) => {
const record = toRecord(entry);
const label = normalizeOptionalString(record?.label);
const segmentValue = record?.value;
return label && typeof segmentValue === "number" && Number.isFinite(segmentValue)
? { label, value: segmentValue }
: undefined;
});
return segments.every((segment): segment is MessagePresentationChartSegment =>
Boolean(segment && segment.value > 0),
)
? segments
: undefined;
}
function normalizeChartCategories(value: unknown): string[] | undefined {
if (!Array.isArray(value) || value.length === 0) {
return undefined;
}
const categories = value.map((entry) => normalizeOptionalString(entry));
if (categories.some((entry) => !entry)) {
return undefined;
}
const normalized = categories as string[];
return new Set(normalized).size === normalized.length ? normalized : undefined;
}
function normalizeChartSeries(params: {
value: unknown;
categoryCount: number;
}): MessagePresentationChartSeries[] | undefined {
if (!Array.isArray(params.value) || params.value.length === 0) {
return undefined;
}
const series = params.value.map((entry) => {
const record = toRecord(entry);
const name = normalizeOptionalString(record?.name);
const values = record?.values;
if (
!name ||
!Array.isArray(values) ||
values.length !== params.categoryCount ||
!values.every((value) => typeof value === "number" && Number.isFinite(value))
) {
return undefined;
}
return { name, values: values as number[] };
});
if (
!series.every((entry): entry is MessagePresentationChartSeries => Boolean(entry)) ||
new Set(series.map((entry) => entry.name)).size !== series.length
) {
return undefined;
}
return series;
}
function normalizeChartBlock(
record: Record<string, unknown>,
): MessagePresentationChartBlock | undefined {
const title = normalizeOptionalString(record.title);
const chartType = normalizeOptionalLowercaseString(record.chartType);
if (!title) {
return undefined;
}
if (chartType === "pie") {
const segments = normalizeChartSegments(record.segments);
return segments ? { type: "chart", chartType, title, segments } : undefined;
}
if (chartType !== "bar" && chartType !== "area" && chartType !== "line") {
return undefined;
}
const categories = normalizeChartCategories(record.categories);
if (!categories) {
return undefined;
}
const series = normalizeChartSeries({ value: record.series, categoryCount: categories.length });
if (!series) {
return undefined;
}
const xLabel = normalizeOptionalString(record.xLabel);
const yLabel = normalizeOptionalString(record.yLabel);
return {
type: "chart",
chartType,
title,
categories,
series,
...(xLabel ? { xLabel } : {}),
...(yLabel ? { yLabel } : {}),
};
}
function normalizeTableBlock(
record: Record<string, unknown>,
): MessagePresentationTableBlock | undefined {
const caption = normalizeOptionalString(record.caption);
if (!caption || !Array.isArray(record.headers) || record.headers.length === 0) {
return undefined;
}
const headers = record.headers.map((header) => normalizeOptionalString(header));
if (
!headers.every((header): header is string => Boolean(header)) ||
new Set(headers).size !== headers.length ||
!Array.isArray(record.rows) ||
record.rows.length === 0
) {
return undefined;
}
const rows = record.rows.map((row) => {
if (!Array.isArray(row) || row.length !== headers.length) {
return undefined;
}
const cells = row.map((cell) => {
if (typeof cell === "number") {
return Number.isFinite(cell) ? cell : undefined;
}
return normalizeOptionalString(cell);
});
return cells.every((cell): cell is MessagePresentationTableCell => cell !== undefined)
? cells
: undefined;
});
if (!rows.every((row): row is MessagePresentationTableCell[] => Boolean(row))) {
return undefined;
}
const rowHeaderColumnIndex = record.rowHeaderColumnIndex;
if (
rowHeaderColumnIndex !== undefined &&
(typeof rowHeaderColumnIndex !== "number" ||
!Number.isInteger(rowHeaderColumnIndex) ||
rowHeaderColumnIndex < 0 ||
rowHeaderColumnIndex >= headers.length)
) {
return undefined;
}
return {
type: "table",
caption,
headers,
rows,
...(typeof rowHeaderColumnIndex === "number" ? { rowHeaderColumnIndex } : {}),
};
}
export function normalizeLegacyInteractiveReply(raw: unknown): LegacyInteractiveReply | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const blocks = normalizeList(record.blocks, normalizeInteractiveBlock);
return blocks.length > 0 ? { blocks } : undefined;
}
/** @deprecated Use normalizeMessagePresentation. */
export const normalizeInteractiveReply = normalizeLegacyInteractiveReply;
function isPresentationContinuation(raw: unknown): boolean {
const record = toRecord(raw);
return Boolean(
record &&
Object.getOwnPropertyDescriptor(record, PRESENTATION_FALLBACK_CONTINUATION)?.value === true,
);
}
function normalizePresentationBlock(
raw: unknown,
followedByContinuation: boolean,
): MessagePresentationBlock | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const type = normalizeOptionalLowercaseString(record.type);
if (type === "text" || type === "context") {
const continuation = isPresentationContinuation(record);
// Adapted fragments share one authored paragraph; trimming either side loses
// whitespace at the split, and dropping the marker changes fallback layout.
const text =
(continuation || followedByContinuation) && typeof record.text === "string"
? record.text
: normalizeOptionalString(record.text);
const block: MessagePresentationBlock | undefined = text ? { type, text } : undefined;
if (block && continuation) {
Object.defineProperty(block, PRESENTATION_FALLBACK_CONTINUATION, { value: true });
}
return block;
}
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;
}
if (type === "chart") {
return normalizeChartBlock(record);
}
if (type === "table") {
return normalizeTableBlock(record);
}
return undefined;
}
export function normalizeMessagePresentation(raw: unknown): MessagePresentation | undefined {
const record = toRecord(raw);
if (!record) {
return undefined;
}
const rawBlocks: unknown[] = Array.isArray(record.blocks) ? record.blocks : [];
const blocks = rawBlocks.flatMap((block, index) => {
const normalized = normalizePresentationBlock(
block,
isPresentationContinuation(rawBlocks[index + 1]),
);
return normalized ? [normalized] : [];
});
const title =
isPresentationContinuation(rawBlocks[0]) && typeof record.title === "string"
? record.title
: normalizeOptionalString(record.title);
if (!title && blocks.length === 0) {
return undefined;
}
return {
...(title ? { title } : {}),
tone: normalizePresentationTone(record.tone),
blocks,
};
}
/**
* @deprecated Use hasMessagePresentationBlocks.
*/
export const hasInteractiveReplyBlocks = hasLegacyInteractiveReplyBlocks;
export function hasLegacyInteractiveReplyBlocks(value: unknown): value is LegacyInteractiveReply {
return Boolean(normalizeLegacyInteractiveReply(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) => resolveMessagePresentationButtonAction(button, { modelPicker: true }))
.map((button) => {
const interactiveButton: InteractiveReplyButton = {
label: button.label,
style: button.style,
};
if (button.action) {
interactiveButton.action = button.action;
const actionValue = resolveMessagePresentationActionValue(button.action);
if (actionValue) {
interactiveButton.value = actionValue;
} else if (button.action.type === "url") {
interactiveButton.url = button.action.url;
} else if (button.action.type === "web-app" && button.action.url) {
interactiveButton.webApp = { url: button.action.url };
}
} else {
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 === "chart") {
blocks.push({ type: "text", text: renderMessagePresentationChartFallbackText(block) });
continue;
}
if (block.type === "table") {
blocks.push({ type: "text", text: renderMessagePresentationTableFallbackText(block) });
continue;
}
if (block.type === "select") {
blocks.push({
type: "select",
placeholder: block.placeholder,
options: block.options.map((option) => {
const interactiveOption: InteractiveReplyOption = {
label: option.label,
};
if (option.action !== undefined) {
const action = resolveMessagePresentationOptionAction(option, { modelPicker: true });
if (action) {
interactiveOption.action = action;
const actionValue = resolveMessagePresentationActionValue(action);
if (actionValue) {
interactiveOption.value = actionValue;
}
}
} else if (option.value) {
interactiveOption.value = option.value;
}
return interactiveOption;
}),
});
}
}
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),
});
}
export function legacyInteractiveReplyToPresentation(
interactive: LegacyInteractiveReply,
): 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;
}
/**
* @deprecated Legacy bridge for old InteractiveReply payloads. New producers should send MessagePresentation.
*/
export const interactiveReplyToPresentation = legacyInteractiveReplyToPresentation;
/**
* Render presentation blocks as plain-text fallback for channels that do not
* support native interactive controls.
*
* Text and context blocks are rendered as-is. Buttons with a `command`-typed
* action render as `label: \`command\`` so the value is copyable. URL and web
* app actions include their user-facing URL. Approval, question, callback,
* legacy value, and select actions render label-only to keep transport data
* private. Disabled buttons render label-only regardless of action type.
*
* Downstream consumers should not claim a manual command is available unless
* they verify one was actually rendered.
*
* Exported through the plugin SDK for channel adapters.
*/
export function renderMessagePresentationChartFallbackText(
block: MessagePresentationChartBlock,
): string {
const lines = [`${block.title} (${block.chartType} chart)`];
if (block.chartType === "pie") {
lines.push(...block.segments.map((segment) => `- ${segment.label}: ${String(segment.value)}`));
return lines.join("\n");
}
if (block.xLabel) {
lines.push(`X axis: ${block.xLabel}`);
}
if (block.yLabel) {
lines.push(`Y axis: ${block.yLabel}`);
}
lines.push(
...block.series.map(
(series) =>
`- ${series.name}: ${block.categories
.map((category, index) => `${category}: ${String(series.values[index])}`)
.join("; ")}`,
),
);
return lines.join("\n");
}
function renderTableFallbackValue(value: MessagePresentationTableCell): string {
return String(value).replace(/\s+/g, " ").trim();
}
export function renderMessagePresentationTableFallbackText(
block: MessagePresentationTableBlock,
): string {
const headers = block.headers.map(renderTableFallbackValue);
const lines = [`${renderTableFallbackValue(block.caption)} (table)`];
lines.push(
...block.rows.map(
(row) =>
`- ${row
.map((cell, index) => `${headers[index]}: ${renderTableFallbackValue(cell)}`)
.join("; ")}`,
),
);
return lines.join("\n");
}
/** Keep only operator-visible navigation and public command text in control fallbacks. */
export function renderMessagePresentationControlFallbackLabel(
control: Pick<
MessagePresentationButton,
"label" | "action" | "value" | "url" | "webApp" | "web_app" | "disabled"
>,
): string {
if (control.disabled) {
return control.label;
}
const action = resolveMessagePresentationButtonAction(control);
if (action?.type === "url" || (action?.type === "web-app" && action.url)) {
return `${control.label}: ${action.url}`;
}
if (action?.type === "command") {
return `${control.label}: \`${action.command}\``;
}
return control.label;
}
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") {
// Generated continuation blocks are bounded native fragments, not new paragraphs.
if (isPresentationContinuation(block) && lines.length) {
lines[lines.length - 1] += block.text;
} else {
lines.push(block.text);
}
continue;
}
if (block.type === "buttons") {
const labels = block.buttons
.map(renderMessagePresentationControlFallbackLabel)
.filter(Boolean);
if (labels.length > 0) {
lines.push(labels.map((label) => `- ${label}`).join("\n"));
}
continue;
}
if (block.type === "chart") {
lines.push(renderMessagePresentationChartFallbackText(block));
continue;
}
if (block.type === "table") {
lines.push(renderMessagePresentationTableFallbackText(block));
continue;
}
if (block.type === "select") {
const labels = block.options
.map(renderMessagePresentationControlFallbackLabel)
.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) ||
hasLegacyInteractiveReplyBlocks(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;
location?: 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 ?? payload.location != null,
});
}
export function resolveLegacyInteractiveTextFallback(params: {
text?: string;
interactive?: LegacyInteractiveReply;
}): string | undefined {
const text = normalizeOptionalString(params.text);
if (text) {
return params.text;
}
const interactiveText = (params.interactive?.blocks ?? [])
.filter((block): block is LegacyInteractiveReplyTextBlock => block.type === "text")
.map((block) => block.text.trim())
.filter(Boolean)
.join("\n\n");
return interactiveText || params.text;
}
/** @deprecated Use renderMessagePresentationFallbackText with MessagePresentation. */
export const resolveInteractiveTextFallback = resolveLegacyInteractiveTextFallback;
/* oxlint-disable max-lines -- TODO: split this grandfathered oversized file. */
|