跳转到内容

签名关联类型:CanvasPanelDefinition – CanvasTaskInput

本页由当前 SDK 声明自动生成。

返回接口索引

CanvasPanelDefinition · CanvasPanelRenderProps · CanvasPanelRoute · CanvasPanelType · CanvasPositionUpdate · CanvasPresentationSnapshot · CanvasReferenceMediaKind · CanvasRenderScene · CanvasResourceStateUpdate · CanvasScopeMode · CanvasSourceCatalogEntry · CanvasSourceListPage · CanvasSourceRef · CanvasSummary · CanvasSurfaceCleanup · CanvasSyncOfflineReason · CanvasSyncPhase · CanvasSyncState · CanvasTaskActivity · CanvasTaskActivityEventBatch · CanvasTaskActivitySnapshot · CanvasTaskCatalog · CanvasTaskCatalogModel · CanvasTaskInput

CanvasPanelDefinition

export type CanvasPanelDefinition = {
type: CanvasPanelType;
owner: string;
validate?: (route: CanvasPanelRoute) => boolean;
focusPresentation?: "sidebar";
render: ComponentType<CanvasPanelRenderProps>;
};

关联类型:CanvasPanelType · CanvasPanelRoute · CanvasPanelRenderProps

成员说明:

  • validate:校验 route payload;返回 false 时 transition 被拒绝。
  • focusPresentation:聚焦态呈现。 sidebar 表示该 panel 在 node-focus 时占用公共聚焦侧栏容器(与工作区检查器共用 同一栏、互斥,不额外并列一栏);缺省只在 overview 由 CanvasPanelHost 渲染。
  • render:面板渲染器。

CanvasPanelRenderProps

export type CanvasPanelRenderProps = {
route: CanvasPanelRoute;
writable: boolean;
};

关联类型:CanvasPanelRoute

CanvasPanelRoute

面板 route:只带稳定 nodeId、类型与有限 presentation(不复制 prompt/参数/草稿)。

agent-conversation 是 Agent 对话详情的唯一展开状态源:只带稳定会话/回合与适用领域运行身份, 不复制消息/事件/工具输出。默认不产生本 route;只有用户明确点击详情动作才打开。

export type CanvasPanelRoute = {
type: "node-execution";
nodeId: string;
presentation?: ExecutionPanelPresentation;
} | {
type: "model-node-editor";
nodeId: string;
} | {
type: "group-execution";
nodeId: string;
} | {
type: "director-execution";
nodeId: string;
} | {
type: "camera-execution";
nodeId: string;
} | {
type: "node-history";
nodeId: string;
} | {
type: "agent-conversation";
conversationId: string;
requestId: string;
nodeId?: string;
runId?: string;
taskId?: string;
};

关联类型:ExecutionPanelPresentation

成员说明:

  • nodeId:来源生成面板节点(合法返回目标);历史/活动入口可为空。

CanvasPanelType

export type CanvasPanelType = CanvasPanelRoute["type"];

关联类型:CanvasPanelRoute

CanvasPositionUpdate

export type CanvasPositionUpdate = {
version: typeof CANVAS_POSITION_UPDATE_VERSION;
baseSceneGeneration: number;
positions: readonly CanvasNodePosition[];
viewport?: Woohaa3CanvasViewport;
};

关联类型:CanvasNodePosition · Woohaa3CanvasViewport

成员说明:

  • positions:Includes affected descendants as absolute positions, never relative deltas.

CanvasPresentationSnapshot

export type CanvasPresentationSnapshot = {
mode: CanvasMode;
panel: CanvasPanelRoute | null;
menu: CanvasMenuRoute | null;
};

关联类型:CanvasMode · CanvasPanelRoute · CanvasMenuRoute

CanvasReferenceMediaKind

模型可接受的参考输入媒体类别。

export type CanvasReferenceMediaKind = "image" | "video" | "audio";

CanvasRenderScene

与 Rust Scene 对应;这是发给 Bevy set_scene 的唯一快照。

export type CanvasRenderScene = {
editScope?: CanvasEditScope;
executingScopes?: string[];
worldCameraEdit?: {
nodeId: string;
camera: WorldCameraData;
showHelpers?: boolean;
};
sceneAreas?: Array<{
nodeId: string;
title?: string;
editScope?: {
category: "3d";
mode: CanvasScopeMode;
};
bounds: {
min: {
u: number;
v: number;
};
max: {
u: number;
v: number;
};
};
playback?: {
time: number;
duration: number;
playing: boolean;
loop: boolean;
};
}>;
version: typeof CANVAS_RENDER_SCENE_VERSION;
canvasId: string;
revision: number;
nodes: BevyRenderNode[];
edges: BevyRenderEdge[];
selection: BevyRenderSelection;
viewport: {
x: number;
y: number;
zoom: number;
};
draft: BevyRenderDraft | null;
marquee?: BevyRenderMarquee | null;
surface: BevyRenderSurface | null;
theme: AppThemeSnapshot;
globalLightEnabled?: boolean;
modelFocus?: BevyModelFocus;
modelFocusContext?: {
nodeId: string;
x: number;
y: number;
width: number;
height: number;
}[];
imageFocus?: BevyImageFocus;
videoFocus?: BevyVideoFocus;
modelEditor?: BevyModelEditor;
hover?: BevyHover;
dragAttach?: BevyDragAttach;
aggregateConnect?: BevyAggregateConnect;
animationPlayback?: BevyAnimationPlayback;
focusTransition?: BevyFocusTransition;
nodeActions?: Record<string, BevyNodeActionsPresentation>;
};

关联类型:CanvasEditScope · WorldCameraData · CanvasScopeMode · BevyRenderNode · BevyRenderEdge · BevyRenderSelection · BevyRenderDraft · BevyRenderMarquee · BevyRenderSurface · AppThemeSnapshot · BevyModelFocus · BevyImageFocus · BevyVideoFocus · BevyModelEditor · BevyHover · BevyDragAttach · BevyAggregateConnect · BevyAnimationPlayback · BevyFocusTransition · BevyNodeActionsPresentation

成员说明:

  • editScope:Presentation-only editor state; capture/export scenes omit it.
  • executingScopes:Live assistant edits on scope boundaries; presentation only.
  • canvasId:文档身份(画布 id)。 revision 是每张画布各自的版本号,跨画布没有可比性:渲染器必须按身份重置单调基线, 否则「切到 revision 更小的画布」会被误判为代数倒退而整帧丢弃 。
  • marquee:框选选区矩形。 缺省/null 表示当前没有框选。只承载浏览器本地呈现态。
  • theme:当前应用主题 snapshot。 这是呈现态,不进入 canonical canvas 文档/Y.Doc;由 Theme Service 提供, fingerprint 参与 renderSceneEquals,仅主题变化也会触发一次 set_scene。
  • globalLightEnabled:Browser-local global directional light and shadows. Missing means enabled.
  • modelFocus:模型聚焦瞬时投影。 缺省表示普通正交画布;携带时 Bevy 切换到透视聚焦并只渲染目标。
  • modelFocusContext:Read-only references in focus workspace CSS pixels; original node/model geometry stays intact.
  • imageFocus:图片聚焦瞬时投影。 缺省表示普通画布;携带时 Bevy 隐藏节点外框/标题/端口/连线及其它内容,仅显示聚焦图片, 并按本地二维取景平移缩放。只承载浏览器本地呈现态,不进入 ServerCanvas / Y.Doc。
  • videoFocus:视频聚焦瞬时投影 。 缺省表示普通画布;携带时 Bevy 隐藏节点外框/标题/端口/连线及其它内容,仅显示聚焦视频的 真实解码纹理,并按本地二维取景平移缩放。与 imageFocus 互斥,只承载浏览器本地呈现态, 不进入 ServerCanvas / Y.Doc。
  • modelEditor:模型编辑 gitmo/镜头工具瞬时态。 携带时 Bevy 在聚焦模型上绘制 placement gizmo 或选中镜头的 shot gizmo/frustum。 只承载浏览器本地编辑态,不进入 ServerCanvas / Y.Doc。
  • hover:节点端点 / 连线悬停瞬时态。 缺省表示无悬停——所有节点端点静止不绘制、所有连线不显示删除按钮。携带时 Bevy 在对应 节点左右中点画「+」圆钮,或在对应连线中点画删除按钮。只承载浏览器本地呈现态, 不进入 ServerCanvas / Y.Doc。
  • dragAttach:单节点拖动中的 Q/E 触碰粘连瞬时投影。 缺省表示当前没有粘连拖动;携带时 Bevy 在拖动节点下方绘制操作条、活动触须、 接触反馈与待提交连线预览。只承载浏览器本地呈现态,不进入 ServerCanvas / Y.Doc。
  • aggregateConnect:多选聚合拉线瞬时投影。 缺省表示当前没有聚合把手;携带时 Bevy 在选区左右绘制聚合把手、活动方向强调与 拖拽虚线预览。只承载浏览器本地呈现态,不进入 ServerCanvas / Y.Doc。
  • animationPlayback:活动动画节点播放瞬时投影。 缺省表示当前无活动动画节点;携带时 Bevy 为该节点独立求值模型姿态与镜头。 只承载浏览器本地呈现态,不进入 ServerCanvas / Y.Doc。
  • focusTransition:公共聚焦过渡进度瞬时更新 。 由 Canvas Runtime scope 的唯一 coordinator 推入;Rust 三维聚焦相机据此求值,不再启动 独立计时。版本化且带 node/runtimeGeneration 身份,旧代或不匹配节点被原子丢弃。 只承载浏览器本地呈现态,不进入 ServerCanvas / Y.Doc。
  • nodeActions:每节点的顶部操作横条描述,按节点 id keyed。 横条由 Bevy 在画布内绘制、由 Rust interaction snapshot 命中,因此内容必须随 scene 下发。 缺省或某节点缺失表示该节点不绘制横条。动作世界矩形由 contracts nodeActionToolbarLayout 与 Rust 同一公式派生;只承载浏览器本地呈现态与命中所需字段,不进入 ServerCanvas / Y.Doc。

CanvasResourceStateUpdate

export type CanvasResourceStateUpdate = {
version: typeof CANVAS_RESOURCE_STATE_VERSION;
baseSceneGeneration: number;
nodes: readonly CanvasNodeResourceState[];
};

关联类型:CanvasNodeResourceState

CanvasScopeMode

export type CanvasScopeMode = "edit" | "locked" | "hidden";

CanvasSourceCatalogEntry

/api/canvas-sources 的活动来源目录条目摘要;不含路径、URI、数据库名。

export type CanvasSourceCatalogEntry = {
sourceId: string;
displayName: string;
availability: "available" | "unavailable";
};

CanvasSourceListPage

来源目录稳定 cursor 分页。

export type CanvasSourceListPage = {
items: SourceCanvasSummary[];
nextCursor: string | null;
};

关联类型:SourceCanvasSummary

CanvasSourceRef

来源作品引用:来源身份 + 旧作品 ID + 切换代次。

export type CanvasSourceRef = {
sourceId: string;
sourceCanvasId: string;
cutoverGeneration: string;
};

CanvasSummary

画布列表条目的摘要;不含完整 document,避免分页响应过大。

export type CanvasSummary = {
id: string;
title: string;
revision: number;
updatedAt: string;
createdAt: string;
nodeCount: number;
assetCount: number;
sources?: readonly CanvasCatalogOrigin[];
sync?: CanvasSyncState;
access?: CanvasAccess;
};

关联类型:CanvasCatalogOrigin · CanvasSyncState · CanvasAccess

成员说明:

  • sources:这个 id 在哪些来源里存在;省略表示“只有本机”(旧响应兼容)。
  • sync:本机看到的同步状态;省略表示目录没有接入远端(纯本地部署)。
  • access:调用者在这张画布上的内容权限;省略表示未知(按可写处理)。

CanvasSurfaceCleanup

Panel/menu owner 在关闭时注册的 cleanup(取消本地 session / input scope)。

export type CanvasSurfaceCleanup = () => void;

CanvasSyncOfflineReason

断线来源。

两种断线对用户意味着不同的事:browser-offline 是整台机器的网络断了,页面里所有 网络都不通;session-closed 只是这一条画布连接被关闭(画布服务重启、会话被回收、 权限被撤销),页面的 HTTP 读取往往仍然可用。文案与恢复入口都据此区分,不能一律说 「网络已断开」。

export type CanvasSyncOfflineReason = "browser-offline" | "session-closed";

CanvasSyncPhase

浏览器 Yjs 同步状态(唯一持久化路径)。

与 remote-cas 时代的 RemoteSyncStatus 不同:没有 unpublished/conflict/本地 outbox 概念。断线即只读,重连后由 state-vector 差量收敛。

export type CanvasSyncPhase = "idle" | "syncing" | "synced" | "offline";

CanvasSyncState

画布的同步状态(本机视角)。

  • local-only:只在本机存在,尚未同步到任何远端;
  • synced:两边都有且链路已同步完成;
  • syncing:正在连/正在补差;
  • offline:配置了远端但当前连不上(离线编辑仍会落到本机);
  • failed:远端明确拒绝(如已删除),重连不会自愈;
  • remote-only:只在远端存在,本机还没有内容副本;
  • unlinked:属于远端、远端此刻也列得到,本机有副本,但本机还没有建立上游链路 (比如宿主重启后房间在会话就绪之前创建、解析没有得到凭据)。本地改动只落本机,尚未推送。 只在远端存在的画布不算 unlinked:那里没有「改动推不上去」的风险,结论是 remote-only。

synced 的判据是“两边都有内容”,不是“链路此刻在线”;没有链路时必须用 unlinked 表态,不能回落成 synced——否则界面会在整条上传链路不存在时显示“已同步”。

export type CanvasSyncState = "local-only" | "synced" | "syncing" | "offline" | "failed" | "remote-only" | "unlinked";

CanvasTaskActivity

卡片所需的安全活动项。

taskKey 与 runId 同时存在时,store 先按 taskKey 合并、尚未取得 taskKey 时按 runId 合并。

export type CanvasTaskActivity = {
taskKey: string;
runId: string;
nodeId: string;
state: TaskExecutionState;
modelType?: "language" | "image" | "video" | "audio" | "motion";
modelKey?: string;
progress?: number;
result?: TaskResultSummary;
error?: TaskErrorSummary;
createdAt: string;
startedAt?: string;
updatedAt: string;
finishedAt?: string;
durationMs: number;
};

关联类型:TaskExecutionState · TaskResultSummary · TaskErrorSummary

成员说明:

  • taskKey:durable 任务主键。
  • runId:业务 run 关联键;optimistic 合并兜底。
  • nodeId:权威画布节点身份。
  • modelType:模型类型摘要(用于卡片与图标)。
  • progress:权威进度(0..1);缺失时前端不得伪造百分比。
  • result:安全结果摘要(只含 storageKey 等白名单字段)。
  • error:安全错误摘要(只含 name/message)。

CanvasTaskActivityEventBatch

事件流批量(Canvas ↔ Task 内部补偿用)。

export type CanvasTaskActivityEventBatch = {
items: CanvasTaskActivity[];
cursor: number;
};

关联类型:CanvasTaskActivity

CanvasTaskActivitySnapshot

有界活动快照。

active 是当前画布全部 queued/pending/running(不受保留期与分页影响);recent 是保留期内 终态记录,按 (createdAt DESC, taskKey DESC) 分页;cursor 是快照时刻的事件高水位, 客户端据此启动可恢复事件流或轮询补偿。

export type CanvasTaskActivitySnapshot = {
active: CanvasTaskActivity[];
recent: CanvasTaskActivity[];
nextCursor?: string;
cursor: number;
};

关联类型:CanvasTaskActivity

成员说明:

  • nextCursor:更旧 recent 的分页 cursor;缺失表示已到末尾。
  • cursor:事件高水位(单调)。

CanvasTaskCatalog

GET /api/pptask/catalog 的响应。

export type CanvasTaskCatalog = {
available: boolean;
reason?: string;
models: CanvasTaskCatalogModel[];
defaultModels: Partial<Record<CanvasTaskModelType, string>>;
catalogRevision?: number;
};

关联类型:CanvasTaskCatalogModel · CanvasTaskModelType

成员说明:

  • defaultModels:默认模型按 modelKey 引用。
  • catalogRevision:单调 catalog 修订。 随模型集合/运营策略变化推进;客户端只用它做失效判断,不是模型数据事实源。

CanvasTaskCatalogModel

catalog 中单个模型的可投影描述。

export type CanvasTaskCatalogModel = {
modelKey: string;
providerId: string;
providerModelId: string;
modelType: CanvasTaskModelType;
title: string;
interaction: ModelInteractionDescriptor;
inputSchema: Record<string, unknown>;
defaultInput: Record<string, unknown>;
bindings: CanvasTaskInputBinding[];
taskTimeoutMs: number;
promptRequirement?: "required" | "optional" | "none";
cancel?: "local" | "remote" | "unsupported";
schemaRevision?: number;
configVersion?: number;
capabilities?: Record<string, unknown>;
capabilityFacts?: GenerationModelCapabilityFacts;
};

关联类型:CanvasTaskModelType · ModelInteractionDescriptor · CanvasTaskInputBinding · GenerationModelCapabilityFacts

成员说明:

  • modelKey:catalog 内唯一、opaque 的调用身份。 调用方只做查找;不得 解析出 Provider 或原始模型 id。
  • providerModelId:Provider 自己的原始模型 id;只传给对应 Provider adapter。
  • interaction:受信任配置选择的非执行交互 identity(design D2)。Catalog 不承载 UI DSL, 只声明本地 Registry 的 { id, version }。
  • bindings:规范化多模态参考输入 bindings(新服务只写这一项)。
  • promptRequirement:模型级 prompt 要求。 required 保持既有规则;optional/none 允许纯素材工作流。 旧 catalog 无此字段时按 required 处理。
  • cancel:取消能力(design D6);缺省 local。
  • schemaRevision:该模型运行配置的 schema 版本。
  • configVersion:该模型运行配置版本(不可变配置快照;恢复依据)。
  • capabilities:声明能力摘要(operation 等);不含秘密。
  • capabilityFacts:模型事实能力(Provider 声明、目录校验后透传)。 读取请用 canvasModelCapabilities(model):参考输入由 bindings 派生,reasoning 取本字段;缺省 = 未声明(按不支持处理)。

CanvasTaskInput

稳定媒体引用:只提交这些字段,执行前由 Task 通过 Media Service 重新校验并签名。

export type CanvasTaskInput = {
assetId: string;
role: string;
storageKey: string;
mediaType: string;
mediaKind?: CanvasReferenceMediaKind;
};

关联类型:CanvasReferenceMediaKind

成员说明:

  • mediaKind:稳定媒体类别;Task Service 按 binding 校验。旧客户端可缺省(按 mediaType 推断)。