b129154cc8
- Changed ToolRenderer return type from TemplateResult to ToolRenderResult
- ToolRenderResult = { content: TemplateResult, isCustom: boolean }
- isCustom: true = no card wrapper, false = wrap in card
- Updated all existing tool renderers to return new format
- Updated Messages.ts to handle custom rendering
This enables tools to render without default card chrome when needed.
613 lines
20 KiB
TypeScript
613 lines
20 KiB
TypeScript
import { Button, icon } from "@mariozechner/mini-lit";
|
|
import "@mariozechner/mini-lit/dist/MarkdownBlock.js";
|
|
import { type AgentTool, type Message, StringEnum, type ToolCall } from "@mariozechner/pi-ai";
|
|
import { type Static, Type } from "@sinclair/typebox";
|
|
import { html, LitElement, type TemplateResult } from "lit";
|
|
import { customElement, property, state } from "lit/decorators.js";
|
|
import { createRef, type Ref, ref } from "lit/directives/ref.js";
|
|
import { X } from "lucide";
|
|
import type { ArtifactMessage } from "../../components/Messages.js";
|
|
import type { SandboxRuntimeProvider } from "../../components/sandbox/SandboxRuntimeProvider.js";
|
|
import { buildArtifactsDescription } from "../../prompts/tool-prompts.js";
|
|
import { i18n } from "../../utils/i18n.js";
|
|
import type { ArtifactElement } from "./ArtifactElement.js";
|
|
import { HtmlArtifact } from "./HtmlArtifact.js";
|
|
import { ImageArtifact } from "./ImageArtifact.js";
|
|
import { MarkdownArtifact } from "./MarkdownArtifact.js";
|
|
import { SvgArtifact } from "./SvgArtifact.js";
|
|
import { TextArtifact } from "./TextArtifact.js";
|
|
|
|
// Simple artifact model
|
|
export interface Artifact {
|
|
filename: string;
|
|
content: string;
|
|
createdAt: Date;
|
|
updatedAt: Date;
|
|
}
|
|
|
|
// JSON-schema friendly parameters object (LLM-facing)
|
|
const artifactsParamsSchema = Type.Object({
|
|
command: StringEnum(["create", "update", "rewrite", "get", "delete", "logs"], {
|
|
description: "The operation to perform",
|
|
}),
|
|
filename: Type.String({ description: "Filename including extension (e.g., 'index.html', 'script.js')" }),
|
|
content: Type.Optional(Type.String({ description: "File content" })),
|
|
old_str: Type.Optional(Type.String({ description: "String to replace (for update command)" })),
|
|
new_str: Type.Optional(Type.String({ description: "Replacement string (for update command)" })),
|
|
});
|
|
export type ArtifactsParams = Static<typeof artifactsParamsSchema>;
|
|
|
|
@customElement("artifacts-panel")
|
|
export class ArtifactsPanel extends LitElement {
|
|
@state() private _artifacts = new Map<string, Artifact>();
|
|
@state() private _activeFilename: string | null = null;
|
|
|
|
// Programmatically managed artifact elements
|
|
private artifactElements = new Map<string, ArtifactElement>();
|
|
private contentRef: Ref<HTMLDivElement> = createRef();
|
|
|
|
// External factory for runtime providers (decouples panel from AgentInterface)
|
|
@property({ attribute: false }) runtimeProvidersFactory?: () => SandboxRuntimeProvider[];
|
|
// Sandbox URL provider for browser extensions (optional)
|
|
@property({ attribute: false }) sandboxUrlProvider?: () => string;
|
|
// Callbacks
|
|
@property({ attribute: false }) onArtifactsChange?: () => void;
|
|
@property({ attribute: false }) onClose?: () => void;
|
|
@property({ attribute: false }) onOpen?: () => void;
|
|
// Collapsed mode: hides panel content but can show a floating reopen pill
|
|
@property({ type: Boolean }) collapsed = false;
|
|
// Overlay mode: when true, panel renders full-screen overlay (mobile)
|
|
@property({ type: Boolean }) overlay = false;
|
|
|
|
// Public getter for artifacts
|
|
get artifacts() {
|
|
return this._artifacts;
|
|
}
|
|
|
|
protected override createRenderRoot(): HTMLElement | DocumentFragment {
|
|
return this; // light DOM for shared styles
|
|
}
|
|
|
|
override connectedCallback(): void {
|
|
super.connectedCallback();
|
|
this.style.display = "block";
|
|
this.style.height = "100%";
|
|
// Reattach existing artifact elements when panel is re-inserted into the DOM
|
|
requestAnimationFrame(() => {
|
|
const container = this.contentRef.value;
|
|
if (!container) return;
|
|
// Ensure we have an active filename
|
|
if (!this._activeFilename && this._artifacts.size > 0) {
|
|
this._activeFilename = Array.from(this._artifacts.keys())[0];
|
|
}
|
|
this.artifactElements.forEach((element, name) => {
|
|
if (!element.parentElement) container.appendChild(element);
|
|
element.style.display = name === this._activeFilename ? "block" : "none";
|
|
});
|
|
});
|
|
}
|
|
|
|
override disconnectedCallback() {
|
|
super.disconnectedCallback();
|
|
// Do not tear down artifact elements; keep them to restore on next mount
|
|
}
|
|
|
|
// Helper to determine file type from extension
|
|
private getFileType(filename: string): "html" | "svg" | "markdown" | "image" | "text" {
|
|
const ext = filename.split(".").pop()?.toLowerCase();
|
|
if (ext === "html") return "html";
|
|
if (ext === "svg") return "svg";
|
|
if (ext === "md" || ext === "markdown") return "markdown";
|
|
if (
|
|
ext === "png" ||
|
|
ext === "jpg" ||
|
|
ext === "jpeg" ||
|
|
ext === "gif" ||
|
|
ext === "webp" ||
|
|
ext === "bmp" ||
|
|
ext === "ico"
|
|
)
|
|
return "image";
|
|
return "text";
|
|
}
|
|
|
|
// Get or create artifact element
|
|
private getOrCreateArtifactElement(filename: string, content: string): ArtifactElement {
|
|
let element = this.artifactElements.get(filename);
|
|
|
|
if (!element) {
|
|
const type = this.getFileType(filename);
|
|
if (type === "html") {
|
|
element = new HtmlArtifact();
|
|
const runtimeProviders = this.runtimeProvidersFactory?.() || [];
|
|
(element as HtmlArtifact).runtimeProviders = runtimeProviders;
|
|
if (this.sandboxUrlProvider) {
|
|
(element as HtmlArtifact).sandboxUrlProvider = this.sandboxUrlProvider;
|
|
}
|
|
} else if (type === "svg") {
|
|
element = new SvgArtifact();
|
|
} else if (type === "markdown") {
|
|
element = new MarkdownArtifact();
|
|
} else if (type === "image") {
|
|
element = new ImageArtifact();
|
|
} else {
|
|
element = new TextArtifact();
|
|
}
|
|
element.filename = filename;
|
|
element.content = content;
|
|
element.style.display = "none";
|
|
element.style.height = "100%";
|
|
|
|
// Store element
|
|
this.artifactElements.set(filename, element);
|
|
|
|
// Add to DOM - try immediately if container exists, otherwise schedule
|
|
const newElement = element;
|
|
if (this.contentRef.value) {
|
|
this.contentRef.value.appendChild(newElement);
|
|
} else {
|
|
requestAnimationFrame(() => {
|
|
if (this.contentRef.value && !newElement.parentElement) {
|
|
this.contentRef.value.appendChild(newElement);
|
|
}
|
|
});
|
|
}
|
|
} else {
|
|
// Just update content
|
|
element.content = content;
|
|
if (element instanceof HtmlArtifact) {
|
|
const runtimeProviders = this.runtimeProvidersFactory?.() || [];
|
|
element.runtimeProviders = runtimeProviders;
|
|
}
|
|
}
|
|
|
|
return element;
|
|
}
|
|
|
|
// Show/hide artifact elements
|
|
private showArtifact(filename: string) {
|
|
// Ensure the active element is in the DOM
|
|
requestAnimationFrame(() => {
|
|
this.artifactElements.forEach((element, name) => {
|
|
if (this.contentRef.value && !element.parentElement) {
|
|
this.contentRef.value.appendChild(element);
|
|
}
|
|
element.style.display = name === filename ? "block" : "none";
|
|
});
|
|
});
|
|
this._activeFilename = filename;
|
|
this.requestUpdate(); // Only for tab bar update
|
|
}
|
|
|
|
// Open panel and focus an artifact tab by filename
|
|
public openArtifact(filename: string) {
|
|
if (this._artifacts.has(filename)) {
|
|
this.showArtifact(filename);
|
|
// Ask host to open panel (AgentInterface demo listens to onOpen)
|
|
this.onOpen?.();
|
|
}
|
|
}
|
|
|
|
// Build the AgentTool (no details payload; return only output strings)
|
|
public get tool(): AgentTool<typeof artifactsParamsSchema, undefined> {
|
|
const self = this;
|
|
return {
|
|
label: "Artifacts",
|
|
name: "artifacts",
|
|
get description() {
|
|
// Get dynamic provider descriptions
|
|
const providers = self.runtimeProvidersFactory?.() || [];
|
|
const providerDocs = providers
|
|
.map((p) => p.getDescription?.())
|
|
.filter(Boolean)
|
|
.join("\n");
|
|
|
|
return buildArtifactsDescription(providerDocs || undefined);
|
|
},
|
|
parameters: artifactsParamsSchema,
|
|
// Execute mutates our local store and returns a plain output
|
|
execute: async (_toolCallId: string, args: Static<typeof artifactsParamsSchema>, _signal?: AbortSignal) => {
|
|
const output = await this.executeCommand(args);
|
|
return { output, details: undefined };
|
|
},
|
|
};
|
|
}
|
|
|
|
// Re-apply artifacts by scanning a message list (optional utility)
|
|
public async reconstructFromMessages(
|
|
messages: Array<Message | { role: "aborted" } | { role: "artifact" }>,
|
|
): Promise<void> {
|
|
const toolCalls = new Map<string, ToolCall>();
|
|
const artifactToolName = "artifacts";
|
|
|
|
// 1) Collect tool calls from assistant messages
|
|
for (const message of messages) {
|
|
if (message.role === "assistant") {
|
|
for (const block of message.content) {
|
|
if (block.type === "toolCall" && block.name === artifactToolName) {
|
|
toolCalls.set(block.id, block);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// 2) Build an ordered list of successful artifact operations
|
|
const operations: Array<ArtifactsParams> = [];
|
|
for (const m of messages) {
|
|
// Handle artifact messages (from programmatic operations like browser_javascript)
|
|
if ((m as any).role === "artifact") {
|
|
const artifactMsg = m as ArtifactMessage;
|
|
switch (artifactMsg.action) {
|
|
case "create":
|
|
operations.push({
|
|
command: "create",
|
|
filename: artifactMsg.filename,
|
|
content: artifactMsg.content,
|
|
});
|
|
break;
|
|
case "update":
|
|
operations.push({
|
|
command: "rewrite",
|
|
filename: artifactMsg.filename,
|
|
content: artifactMsg.content,
|
|
});
|
|
break;
|
|
case "delete":
|
|
operations.push({
|
|
command: "delete",
|
|
filename: artifactMsg.filename,
|
|
});
|
|
break;
|
|
}
|
|
}
|
|
// Handle tool result messages (from artifacts tool calls)
|
|
else if ((m as any).role === "toolResult" && (m as any).toolName === artifactToolName && !(m as any).isError) {
|
|
const toolCallId = (m as any).toolCallId as string;
|
|
const call = toolCalls.get(toolCallId);
|
|
if (!call) continue;
|
|
const params = call.arguments as ArtifactsParams;
|
|
if (params.command === "get" || params.command === "logs") continue; // no state change
|
|
operations.push(params);
|
|
}
|
|
}
|
|
|
|
// 3) Compute final state per filename by simulating operations in-memory
|
|
const finalArtifacts = new Map<string, string>();
|
|
for (const op of operations) {
|
|
const filename = op.filename;
|
|
switch (op.command) {
|
|
case "create": {
|
|
if (op.content) {
|
|
finalArtifacts.set(filename, op.content);
|
|
}
|
|
break;
|
|
}
|
|
case "rewrite": {
|
|
if (op.content) {
|
|
finalArtifacts.set(filename, op.content);
|
|
}
|
|
break;
|
|
}
|
|
case "update": {
|
|
let existing = finalArtifacts.get(filename);
|
|
if (!existing) break; // skip invalid update (shouldn't happen for successful results)
|
|
if (op.old_str !== undefined && op.new_str !== undefined) {
|
|
existing = existing.replace(op.old_str, op.new_str);
|
|
finalArtifacts.set(filename, existing);
|
|
}
|
|
break;
|
|
}
|
|
case "delete": {
|
|
finalArtifacts.delete(filename);
|
|
break;
|
|
}
|
|
case "get":
|
|
case "logs":
|
|
// Ignored above, just for completeness
|
|
break;
|
|
}
|
|
}
|
|
|
|
// 4) Reset current UI state before bulk create
|
|
this._artifacts.clear();
|
|
this.artifactElements.forEach((el) => {
|
|
el.remove();
|
|
});
|
|
this.artifactElements.clear();
|
|
this._activeFilename = null;
|
|
this._artifacts = new Map(this._artifacts);
|
|
|
|
// 5) Create artifacts in a single pass without waiting for iframe execution or tab switching
|
|
for (const [filename, content] of finalArtifacts.entries()) {
|
|
const createParams: ArtifactsParams = { command: "create", filename, content } as const;
|
|
try {
|
|
await this.createArtifact(createParams, { skipWait: true, silent: true });
|
|
} catch {
|
|
// Ignore failures during reconstruction
|
|
}
|
|
}
|
|
|
|
// 6) Show first artifact if any exist, and notify listeners once
|
|
if (!this._activeFilename && this._artifacts.size > 0) {
|
|
this.showArtifact(Array.from(this._artifacts.keys())[0]);
|
|
}
|
|
this.onArtifactsChange?.();
|
|
this.requestUpdate();
|
|
}
|
|
|
|
// Core command executor
|
|
private async executeCommand(
|
|
params: ArtifactsParams,
|
|
options: { skipWait?: boolean; silent?: boolean } = {},
|
|
): Promise<string> {
|
|
switch (params.command) {
|
|
case "create":
|
|
return await this.createArtifact(params, options);
|
|
case "update":
|
|
return await this.updateArtifact(params, options);
|
|
case "rewrite":
|
|
return await this.rewriteArtifact(params, options);
|
|
case "get":
|
|
return this.getArtifact(params);
|
|
case "delete":
|
|
return this.deleteArtifact(params);
|
|
case "logs":
|
|
return this.getLogs(params);
|
|
default:
|
|
// Should never happen with TypeBox validation
|
|
return `Error: Unknown command ${(params as any).command}`;
|
|
}
|
|
}
|
|
|
|
// Wait for HTML artifact execution and get logs
|
|
private async waitForHtmlExecution(filename: string): Promise<string> {
|
|
const element = this.artifactElements.get(filename);
|
|
if (!(element instanceof HtmlArtifact)) {
|
|
return "";
|
|
}
|
|
|
|
return new Promise((resolve) => {
|
|
// Fallback timeout - just get logs after execution should complete
|
|
setTimeout(() => {
|
|
// Get whatever logs we have
|
|
const logs = element.getLogs();
|
|
resolve(logs);
|
|
}, 1500);
|
|
});
|
|
}
|
|
|
|
private async createArtifact(
|
|
params: ArtifactsParams,
|
|
options: { skipWait?: boolean; silent?: boolean } = {},
|
|
): Promise<string> {
|
|
if (!params.filename || !params.content) {
|
|
return "Error: create command requires filename and content";
|
|
}
|
|
if (this._artifacts.has(params.filename)) {
|
|
return `Error: File ${params.filename} already exists`;
|
|
}
|
|
|
|
const artifact: Artifact = {
|
|
filename: params.filename,
|
|
content: params.content,
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
};
|
|
this._artifacts.set(params.filename, artifact);
|
|
this._artifacts = new Map(this._artifacts);
|
|
|
|
// Create or update element
|
|
this.getOrCreateArtifactElement(params.filename, params.content);
|
|
if (!options.silent) {
|
|
this.showArtifact(params.filename);
|
|
this.onArtifactsChange?.();
|
|
this.requestUpdate();
|
|
}
|
|
|
|
// For HTML files, wait for execution
|
|
let result = `Created file ${params.filename}`;
|
|
if (this.getFileType(params.filename) === "html" && !options.skipWait) {
|
|
const logs = await this.waitForHtmlExecution(params.filename);
|
|
result += `\n${logs}`;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
private async updateArtifact(
|
|
params: ArtifactsParams,
|
|
options: { skipWait?: boolean; silent?: boolean } = {},
|
|
): Promise<string> {
|
|
const artifact = this._artifacts.get(params.filename);
|
|
if (!artifact) {
|
|
const files = Array.from(this._artifacts.keys());
|
|
if (files.length === 0) return `Error: File ${params.filename} not found. No files have been created yet.`;
|
|
return `Error: File ${params.filename} not found. Available files: ${files.join(", ")}`;
|
|
}
|
|
if (!params.old_str || params.new_str === undefined) {
|
|
return "Error: update command requires old_str and new_str";
|
|
}
|
|
if (!artifact.content.includes(params.old_str)) {
|
|
return `Error: String not found in file. Here is the full content:\n\n${artifact.content}`;
|
|
}
|
|
|
|
artifact.content = artifact.content.replace(params.old_str, params.new_str);
|
|
artifact.updatedAt = new Date();
|
|
this._artifacts.set(params.filename, artifact);
|
|
|
|
// Update element
|
|
this.getOrCreateArtifactElement(params.filename, artifact.content);
|
|
if (!options.silent) {
|
|
this.onArtifactsChange?.();
|
|
this.requestUpdate();
|
|
}
|
|
|
|
// Show the artifact
|
|
this.showArtifact(params.filename);
|
|
|
|
// For HTML files, wait for execution
|
|
let result = `Updated file ${params.filename}`;
|
|
if (this.getFileType(params.filename) === "html" && !options.skipWait) {
|
|
const logs = await this.waitForHtmlExecution(params.filename);
|
|
result += `\n${logs}`;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
private async rewriteArtifact(
|
|
params: ArtifactsParams,
|
|
options: { skipWait?: boolean; silent?: boolean } = {},
|
|
): Promise<string> {
|
|
const artifact = this._artifacts.get(params.filename);
|
|
if (!artifact) {
|
|
const files = Array.from(this._artifacts.keys());
|
|
if (files.length === 0) return `Error: File ${params.filename} not found. No files have been created yet.`;
|
|
return `Error: File ${params.filename} not found. Available files: ${files.join(", ")}`;
|
|
}
|
|
if (!params.content) {
|
|
return "Error: rewrite command requires content";
|
|
}
|
|
|
|
artifact.content = params.content;
|
|
artifact.updatedAt = new Date();
|
|
this._artifacts.set(params.filename, artifact);
|
|
|
|
// Update element
|
|
this.getOrCreateArtifactElement(params.filename, artifact.content);
|
|
if (!options.silent) {
|
|
this.onArtifactsChange?.();
|
|
}
|
|
|
|
// Show the artifact
|
|
this.showArtifact(params.filename);
|
|
|
|
// For HTML files, wait for execution
|
|
let result = "";
|
|
if (this.getFileType(params.filename) === "html" && !options.skipWait) {
|
|
const logs = await this.waitForHtmlExecution(params.filename);
|
|
result += `\n${logs}`;
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
private getArtifact(params: ArtifactsParams): string {
|
|
const artifact = this._artifacts.get(params.filename);
|
|
if (!artifact) {
|
|
const files = Array.from(this._artifacts.keys());
|
|
if (files.length === 0) return `Error: File ${params.filename} not found. No files have been created yet.`;
|
|
return `Error: File ${params.filename} not found. Available files: ${files.join(", ")}`;
|
|
}
|
|
return artifact.content;
|
|
}
|
|
|
|
private deleteArtifact(params: ArtifactsParams): string {
|
|
const artifact = this._artifacts.get(params.filename);
|
|
if (!artifact) {
|
|
const files = Array.from(this._artifacts.keys());
|
|
if (files.length === 0) return `Error: File ${params.filename} not found. No files have been created yet.`;
|
|
return `Error: File ${params.filename} not found. Available files: ${files.join(", ")}`;
|
|
}
|
|
|
|
this._artifacts.delete(params.filename);
|
|
this._artifacts = new Map(this._artifacts);
|
|
|
|
// Remove element
|
|
const element = this.artifactElements.get(params.filename);
|
|
if (element) {
|
|
element.remove();
|
|
this.artifactElements.delete(params.filename);
|
|
}
|
|
|
|
// Show another artifact if this was active
|
|
if (this._activeFilename === params.filename) {
|
|
const remaining = Array.from(this._artifacts.keys());
|
|
if (remaining.length > 0) {
|
|
this.showArtifact(remaining[0]);
|
|
} else {
|
|
this._activeFilename = null;
|
|
this.requestUpdate();
|
|
}
|
|
}
|
|
this.onArtifactsChange?.();
|
|
this.requestUpdate();
|
|
|
|
return `Deleted file ${params.filename}`;
|
|
}
|
|
|
|
private getLogs(params: ArtifactsParams): string {
|
|
const element = this.artifactElements.get(params.filename);
|
|
if (!element) {
|
|
const files = Array.from(this._artifacts.keys());
|
|
if (files.length === 0) return `Error: File ${params.filename} not found. No files have been created yet.`;
|
|
return `Error: File ${params.filename} not found. Available files: ${files.join(", ")}`;
|
|
}
|
|
|
|
if (!(element instanceof HtmlArtifact)) {
|
|
return `Error: File ${params.filename} is not an HTML file. Logs are only available for HTML files.`;
|
|
}
|
|
|
|
return element.getLogs();
|
|
}
|
|
|
|
override render(): TemplateResult {
|
|
const artifacts = Array.from(this._artifacts.values());
|
|
|
|
// Panel is hidden when collapsed OR when there are no artifacts
|
|
const showPanel = artifacts.length > 0 && !this.collapsed;
|
|
|
|
return html`
|
|
<div
|
|
class="${showPanel ? "" : "hidden"} ${
|
|
this.overlay ? "fixed inset-0 z-40 pointer-events-auto backdrop-blur-sm bg-background/95" : "relative"
|
|
} h-full flex flex-col bg-background text-card-foreground ${
|
|
!this.overlay ? "border-l border-border" : ""
|
|
} overflow-hidden shadow-xl"
|
|
>
|
|
<!-- Tab bar (always shown when there are artifacts) -->
|
|
<div class="flex items-center justify-between border-b border-border bg-background">
|
|
<div class="flex overflow-x-auto">
|
|
${artifacts.map((a) => {
|
|
const isActive = a.filename === this._activeFilename;
|
|
const activeClass = isActive
|
|
? "border-primary text-primary"
|
|
: "border-transparent text-muted-foreground hover:text-foreground";
|
|
return html`
|
|
<button
|
|
class="px-3 py-2 whitespace-nowrap border-b-2 ${activeClass}"
|
|
@click=${() => this.showArtifact(a.filename)}
|
|
>
|
|
<span class="font-mono text-xs">${a.filename}</span>
|
|
</button>
|
|
`;
|
|
})}
|
|
</div>
|
|
<div class="flex items-center gap-1 px-2">
|
|
${(() => {
|
|
const active = this._activeFilename ? this.artifactElements.get(this._activeFilename) : undefined;
|
|
return active ? active.getHeaderButtons() : "";
|
|
})()}
|
|
${Button({
|
|
variant: "ghost",
|
|
size: "sm",
|
|
onClick: () => this.onClose?.(),
|
|
title: i18n("Close artifacts"),
|
|
children: icon(X, "sm"),
|
|
})}
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Content area where artifact elements are added programmatically -->
|
|
<div class="flex-1 overflow-hidden" ${ref(this.contentRef)}></div>
|
|
</div>
|
|
`;
|
|
}
|
|
}
|
|
|
|
declare global {
|
|
interface HTMLElementTagNameMap {
|
|
"artifacts-panel": ArtifactsPanel;
|
|
}
|
|
}
|