Files
openclaw/src/chat/canvas-render.ts
Tak Hoffman cc5c691f00 feat(ui): render assistant directives and add embed tag (#64104)
* Add embed rendering for Control UI assistant output

* Add changelog entry for embed rendering

* Harden canvas path resolution and stage isolation

* Secure assistant media route and preserve UI avatar override

* Fix chat media and history regressions

* Harden embed iframe URL handling

* Fix embed follow-up review regressions

* Restore offloaded chat attachment persistence

* Harden hook and media routing

* Fix embed review follow-ups

* feat(ui): add configurable embed sandbox mode

* fix(gateway): harden assistant media and auth rotation

* fix(gateway): restore websocket pairing handshake flows

* fix(gateway): restore ws hello policy details

* Restore dropped control UI shell wiring

* Fix control UI reconnect cleanup regressions

* fix(gateway): restore media root and auth getter compatibility

* feat(ui): rename public canvas tag to embed

* fix(ui): address remaining media and gateway review issues

* fix(ui): address remaining embed and attachment review findings

* fix(ui): restore stop control and tool card inputs

* fix(ui): address history and attachment review findings

* fix(ui): restore prompt contribution wiring

* fix(ui): address latest history and directive reviews

* fix(ui): forward password auth for assistant media

* fix(ui): suppress silent transcript tokens with media

* feat(ui): add granular embed sandbox modes

* fix(ui): preserve relative media directives in history

* docs(ui): document embed sandbox modes

* fix(gateway): restrict canvas history hoisting to tool entries

* fix(gateway): tighten embed follow-up review fixes

* fix(ci): repair merged branch type drift

* fix(prompt): restore stable runtime prompt rendering

* fix(ui): harden local attachment preview checks

* fix(prompt): restore channel-aware approval guidance

* fix(gateway): enforce auth rotation and media cleanup

* feat(ui): gate external embed urls behind config

* fix(ci): repair rebased branch drift

* fix(ci): resolve remaining branch check failures
2026-04-11 07:32:53 -05:00

246 lines
7.4 KiB
TypeScript

import { parseFenceSpans } from "../markdown/fences.js";
export type CanvasSurface = "assistant_message";
export type CanvasPreview = {
kind: "canvas";
surface: CanvasSurface;
render: "url";
title?: string;
preferredHeight?: number;
url?: string;
viewId?: string;
className?: string;
style?: string;
};
function tryParseJsonRecord(value: string | undefined): Record<string, unknown> | undefined {
if (typeof value !== "string") {
return undefined;
}
try {
const parsed = JSON.parse(value);
return parsed && typeof parsed === "object" && !Array.isArray(parsed)
? (parsed as Record<string, unknown>)
: undefined;
} catch {
return undefined;
}
}
function getRecordStringField(
record: Record<string, unknown> | undefined,
key: string,
): string | undefined {
const value = record?.[key];
return typeof value === "string" && value.trim() ? value : undefined;
}
function getRecordNumberField(
record: Record<string, unknown> | undefined,
key: string,
): number | undefined {
const value = record?.[key];
return typeof value === "number" && Number.isFinite(value) ? value : undefined;
}
function getNestedRecord(
record: Record<string, unknown> | undefined,
key: string,
): Record<string, unknown> | undefined {
const value = record?.[key];
return value && typeof value === "object" && !Array.isArray(value)
? (value as Record<string, unknown>)
: undefined;
}
function normalizeSurface(value: string | undefined): CanvasSurface | undefined {
return value === "assistant_message" ? value : undefined;
}
function normalizePreferredHeight(value: number | undefined): number | undefined {
return typeof value === "number" && Number.isFinite(value) && value >= 160
? Math.min(Math.trunc(value), 1200)
: undefined;
}
function coerceCanvasPreview(
record: Record<string, unknown> | undefined,
): CanvasPreview | undefined {
if (!record) {
return undefined;
}
const kind = getRecordStringField(record, "kind")?.trim().toLowerCase();
if (kind !== "canvas") {
return undefined;
}
const presentation = getNestedRecord(record, "presentation");
const view = getNestedRecord(record, "view");
const source = getNestedRecord(record, "source");
const requestedSurface =
getRecordStringField(presentation, "target") ?? getRecordStringField(record, "target");
const surface = requestedSurface ? normalizeSurface(requestedSurface) : "assistant_message";
if (!surface) {
return undefined;
}
const title = getRecordStringField(presentation, "title") ?? getRecordStringField(view, "title");
const preferredHeight = normalizePreferredHeight(
getRecordNumberField(presentation, "preferred_height") ??
getRecordNumberField(presentation, "preferredHeight") ??
getRecordNumberField(view, "preferred_height") ??
getRecordNumberField(view, "preferredHeight"),
);
const className =
getRecordStringField(presentation, "class_name") ??
getRecordStringField(presentation, "className");
const style = getRecordStringField(presentation, "style");
const viewUrl = getRecordStringField(view, "url") ?? getRecordStringField(view, "entryUrl");
const viewId = getRecordStringField(view, "id") ?? getRecordStringField(view, "docId");
if (viewUrl) {
return {
kind: "canvas",
surface,
render: "url",
url: viewUrl,
...(viewId ? { viewId } : {}),
...(title ? { title } : {}),
...(preferredHeight ? { preferredHeight } : {}),
...(className ? { className } : {}),
...(style ? { style } : {}),
};
}
const sourceType = getRecordStringField(source, "type")?.trim().toLowerCase();
if (sourceType === "url") {
const url = getRecordStringField(source, "url");
if (!url) {
return undefined;
}
return {
kind: "canvas",
surface,
render: "url",
url,
...(title ? { title } : {}),
...(preferredHeight ? { preferredHeight } : {}),
...(className ? { className } : {}),
...(style ? { style } : {}),
};
}
return undefined;
}
function parseCanvasAttributes(raw: string): Record<string, string> {
const attrs: Record<string, string> = {};
const re = /([A-Za-z_][A-Za-z0-9_-]*)\s*=\s*(?:"([^"]*)"|'([^']*)')/g;
let match: RegExpExecArray | null;
while ((match = re.exec(raw))) {
const key = match[1]?.trim().toLowerCase();
const value = (match[2] ?? match[3] ?? "").trim();
if (key && value) {
attrs[key] = value;
}
}
return attrs;
}
function defaultCanvasEntryUrl(ref: string): string {
const encoded = encodeURIComponent(ref.trim());
return `/__openclaw__/canvas/documents/${encoded}/index.html`;
}
function previewFromShortcode(attrs: Record<string, string>): CanvasPreview | undefined {
if (attrs.target && normalizeSurface(attrs.target) !== "assistant_message") {
return undefined;
}
const surface = "assistant_message";
const title = attrs.title?.trim() || undefined;
const preferredHeight =
attrs.height && Number.isFinite(Number(attrs.height))
? normalizePreferredHeight(Number(attrs.height))
: undefined;
const className = attrs.class?.trim() || attrs.class_name?.trim() || undefined;
const style = attrs.style?.trim() || undefined;
const ref = attrs.ref?.trim();
const url = attrs.url?.trim();
if (url || ref) {
return {
kind: "canvas",
surface,
render: "url",
url: url ?? defaultCanvasEntryUrl(ref),
...(ref ? { viewId: ref } : {}),
...(title ? { title } : {}),
...(preferredHeight ? { preferredHeight } : {}),
...(className ? { className } : {}),
...(style ? { style } : {}),
};
}
return undefined;
}
export function extractCanvasFromText(
outputText: string | undefined,
_toolName?: string,
): CanvasPreview | undefined {
const parsed = tryParseJsonRecord(outputText);
return coerceCanvasPreview(parsed);
}
export function extractCanvasShortcodes(text: string | undefined): {
text: string;
previews: CanvasPreview[];
} {
if (!text?.trim() || !text.toLowerCase().includes("[embed")) {
return { text: text ?? "", previews: [] };
}
const fenceSpans = parseFenceSpans(text);
const matches: Array<{
start: number;
end: number;
attrs: Record<string, string>;
body?: string;
}> = [];
const blockRe = /\[embed\s+([^\]]*?)\]([\s\S]*?)\[\/embed\]/gi;
const selfClosingRe = /\[embed\s+([^\]]*?)\/\]/gi;
for (const re of [blockRe, selfClosingRe]) {
let match: RegExpExecArray | null;
while ((match = re.exec(text))) {
const start = match.index ?? 0;
if (fenceSpans.some((span) => start >= span.start && start < span.end)) {
continue;
}
matches.push({
start,
end: start + match[0].length,
attrs: parseCanvasAttributes(match[1] ?? ""),
...(match[2] !== undefined ? { body: match[2] } : {}),
});
}
}
if (matches.length === 0) {
return { text, previews: [] };
}
matches.sort((a, b) => a.start - b.start);
const previews: CanvasPreview[] = [];
let cursor = 0;
let stripped = "";
for (const match of matches) {
if (match.start < cursor) {
continue;
}
stripped += text.slice(cursor, match.start);
const preview = previewFromShortcode(match.attrs);
if (!preview) {
stripped += text.slice(match.start, match.end);
} else {
previews.push(preview);
}
cursor = match.end;
}
stripped += text.slice(cursor);
return {
text: stripped.replace(/\n{3,}/g, "\n\n").trim(),
previews,
};
}