Self-improving AI Employees for everyone
Python ai-agentsai-employeeai-employeesassistantautonomous-agentsco-employeescompanygrok-botinstinctloop-agentsmuseown-your-datapersonalself-hosted
/**
* Wire types + React Query identity for the Canvas node's content board.
*
* Declarations only — every decision is made server-side
* (`server/nodes/tool/canvas/`): items arrive with finished `FileRef`s, the
* `canvas_updated` broadcast carries identity + revision only, and content
* bodies flow exclusively through the authorized `canvas_list` handler
* (files) or the workspace HTTP route (bytes/text).
*/
import type { WorkspaceFileRef } from '../types/workspaceFiles';
export type CanvasItemKind = 'file' | 'url' | 'note';
/** One board item — `server/nodes/tool/canvas/_store.py::_serialize`. */
export interface CanvasItem {
id: string;
kind: CanvasItemKind;
title: string | null;
/** Serialized FileRef for kind 'file'; null otherwise. */
ref: WorkspaceFileRef | null;
/** http(s) address for kind 'url'; null otherwise. */
url: string | null;
/** Markdown body for kind 'note' (capped server-side); null otherwise. */
content: string | null;
language: string | null;
source: 'agent' | 'workflow' | string;
created_at: string | null;
/** Its version: the agent's canvas tool revises an item in place, and the
* board keeps the earlier ones (`canvas_version` reads one). */
version?: number;
updated_at?: string | null;
}
/** A request to show one item, at a version (a chat reply's artifact
* card). A new nonce asks again for the same item. */
export interface CanvasFocus {
itemId: string;
version?: number | null;
nonce: number;
}
/** One saved version, as `canvas_version` returns it: the item as it was
* then, and which version is the latest. */
export type CanvasItemVersion = Omit<CanvasItem, 'version' | 'updated_at'> & { version: number; latest: number };
/** Response to `canvas_version`. */
export interface CanvasVersionResponse {
success: boolean;
error?: string;
item?: CanvasItemVersion;
}
/** Response to `canvas_list`. */
export interface CanvasListResponse {
success: boolean;
error?: string;
items?: CanvasItem[];
revision?: number;
}
/** Identity carried by the `canvas_updated` broadcast (no content). */
export interface CanvasUpdatedIdentity {
workflow_id?: string | null;
node_id?: string | null;
revision?: number;
}
/** One cache entry per workflow + canvas node (todoQuery.ts shape). */
export const canvasBoardQueryKey = (
workflowId: string | null | undefined,
nodeId: string,
) => ['canvasBoard', workflowId ?? 'unsaved', nodeId] as const;
/** Prefix for broadcast-driven invalidation of every mounted board. */
export const CANVAS_BOARD_QUERY_PREFIX = ['canvasBoard'] as const;