跳转到内容

签名关联类型:CanvasJournalEntry – CanvasOperationState

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

返回接口索引

CanvasJournalEntry · CanvasLayoutAdapter · CanvasMediaKind · CanvasMenuDefinition · CanvasMenuRenderProps · CanvasMenuRoute · CanvasMenuService · CanvasMenuType · CanvasModalOpenResult · CanvasMode · CanvasNavigationError · CanvasNavigationIntent · CanvasNavigationResult · CanvasNodeConnectInput · CanvasNodeData · CanvasNodeFocusTarget · CanvasNodeInputMapping · CanvasNodePosition · CanvasNodeResourceState · CanvasNodeRunSummary · CanvasObserverUpdate · CanvasOperationKind · CanvasOperationRecord · CanvasOperationState

CanvasJournalEntry

export type CanvasJournalEntry = {
kind: "canvas";
id: string;
label: string;
commandId?: string;
revision?: number;
undoRevision?: number;
forward: JournalPlannedEdit;
inverse: JournalPlannedEdit;
error?: string;
undoPending?: boolean;
redoPending?: boolean;
state: JournalEntryState;
};

关联类型:JournalPlannedEdit · JournalEntryState

成员说明:

  • commandId:入队时固定的 wire commandId;重试复用同一个值。
  • error:冲突/失败原因(用于界面展示)。
  • undoPending:已入队的撤销/重做尚未确认(不重复排队,也不提前移动指针)。
  • state:只有正式撤销栈中的记录才是 committed。

CanvasLayoutAdapter

export type CanvasLayoutAdapter = {
apply: (target: CanvasFocusTarget | null, transition: CanvasFocusTransition) => {
ok: true;
} | {
ok: false;
reason: string;
};
isFocused: () => boolean;
isTargetValid?: (nodeId: string, kind: CanvasFocusKind) => boolean;
targetUnavailableReason?: (nodeId: string, kind: CanvasFocusKind) => string | null;
isDocumentTargetValid?: (documentId: string) => boolean;
mode?: () => "edit" | "history";
};

关联类型:CanvasFocusTarget · CanvasFocusTransition · CanvasFocusKind

成员说明:

  • apply:应用完整 from/to 聚焦目标。null 退出聚焦并恢复进入前 overview。owner 变化(即使 nodeId 相同)必须到达这里;失败时不得留下与 snapshot 不一致的 owner/projection。 独立文档工作区的目标为 { kind: "document" }:adapter 只清除节点投影与历史 override, 不为文件文档伪造画布节点(编辑扩展工作区,D4)。
  • isFocused:是否仍有合法聚焦目标(用于 reconcile)。
  • isDocumentTargetValid:独立文档呈现目标是否合法(缺省视为合法;由编辑 feature 注入)。
  • mode:聚焦只读模式(历史 owner)。

CanvasMediaKind

export type CanvasMediaKind = "image" | "video" | "audio" | "text" | "storyboard" | "file" | "motion";

CanvasMenuDefinition

export type CanvasMenuDefinition = {
type: CanvasMenuType;
owner: string;
render: ComponentType<CanvasMenuRenderProps>;
};

关联类型:CanvasMenuType · CanvasMenuRenderProps

CanvasMenuRenderProps

export type CanvasMenuRenderProps = {
route: CanvasMenuRoute;
writable: boolean;
};

关联类型:CanvasMenuRoute

CanvasMenuRoute

菜单 route:屏幕坐标用于定位,世界坐标用于插入。

export type CanvasMenuRoute = {
type: "canvas-context";
nodeId: string | null;
screen: {
x: number;
y: number;
};
world: {
x: number;
y: number;
};
connectFrom?: {
nodeId: string;
nodeType: string;
};
};

CanvasMenuService

Canvas 上空闲占位(feature-owned capability;目前仅保留菜单关闭)。

export interface CanvasMenuService {
close(): void;
}

CanvasMenuType

export type CanvasMenuType = CanvasMenuRoute["type"];

关联类型:CanvasMenuRoute

CanvasModalOpenResult

受控异步模态打开结果。

stale 表示请求在等待结算期间失去了合法性(换画布/聚焦变更/协调器被释放),调用方 MUST NOT 重试或据此改页面;not-allowed 表示用户取消或结算失败,现场保留。

export type CanvasModalOpenResult = {
ok: true;
} | {
ok: false;
code: "not-allowed" | "stale" | "dialog-unavailable";
reason: string;
};

CanvasMode

画布 presentation mode。

export type CanvasMode = {
type: "overview";
} | {
type: "node-focus";
nodeId: string;
kind: CanvasFocusKind;
owner: "direct" | "history";
} | {
type: "document-workspace";
documentId: string;
};

关联类型:CanvasFocusKind

CanvasNavigationError

稳定 transition 错误码。

export type CanvasNavigationError = "panel-definition-unavailable" | "menu-definition-unavailable" | "focus-adapter-unavailable" | "focus-target-invalid" | "panel-cleanup-failed" | "not-allowed";

CanvasNavigationIntent

export type CanvasNavigationIntent = {
type: "open-panel";
route: CanvasPanelRoute;
} | {
type: "close-panel";
panelType?: CanvasPanelType;
} | {
type: "open-menu";
route: CanvasMenuRoute;
} | {
type: "close-menu";
} | {
type: "enter-node-focus";
nodeId: string;
kind: CanvasFocusKind;
owner: "direct" | "history";
preserveOverviewReturn?: boolean;
} | {
type: "enter-document-workspace";
documentId: string;
preserveOverviewReturn?: boolean;
} | {
type: "exit-node-focus";
} | {
type: "open-node-history";
nodeId: string;
kind: CanvasFocusKind;
} | {
type: "close-node-history";
} | {
type: "invalidate-node-focus";
reason?: string;
} | {
type: "clear-transient-surfaces";
} | {
type: "reset-presentation";
} | {
type: "reconcile";
validNodeIds: ReadonlySet<string>;
};

关联类型:CanvasPanelRoute · CanvasPanelType · CanvasMenuRoute · CanvasFocusKind

CanvasNavigationResult

export type CanvasNavigationResult = {
ok: true;
snapshot: CanvasPresentationSnapshot;
} | {
ok: false;
error: CanvasNavigationError;
reason: string;
snapshot: CanvasPresentationSnapshot;
};

关联类型:CanvasPresentationSnapshot · CanvasNavigationError

CanvasNodeConnectInput

创建节点时可一次性连一条来自已有节点的边(「拉线创建」)。

export type CanvasNodeConnectInput = {
fromNodeId: string;
label?: string;
edgeId?: string;
};

成员说明:

  • edgeId:新边的客户端稳定 ID。 与服务端共享 reducer 的语义:缺失时回退到本地生成值,但正常编辑器必须显式提供, 以保证本地 working projection 与服务端生成同一实体。

CanvasNodeData

export type CanvasNodeData = Woohaa3CanvasJsonObject & {
managedBy?: ManagedNodeRelation;
title?: string;
taskKind?: string;
prompt?: string;
panelPrompt?: string;
inputMapping?: CanvasNodeInputMapping[];
status?: GenerationStatus;
taskStatus?: "idle" | "pending" | "processing" | "successed" | "failed" | "cancelled" | "unknown";
activeRunId?: string;
modelKey?: string;
preferredModelKey?: string;
progress?: number;
error?: string | null;
errorMessage?: string | null;
result?: GenerationResult;
resultPreview?: GenerationResult;
providerTaskId?: string;
durationSeconds?: number;
mediaContent?: MediaContentRef;
outputAssetId?: string;
codexImageImport?: boolean;
historyPreviewFailure?: {
outcome: "failed" | "cancelled" | "interrupted" | "partial";
message: string;
};
posterAssetId?: string;
resourceKind?: string;
modelScript?: string;
modelScriptLanguage?: string;
modelScriptVersion?: string;
modelRig?: unknown;
modelScriptStatus?: "ok" | "failed";
modelScriptError?: string | null;
modelSourceKind?: "glb";
modelAssetId?: string;
frozenPreview?: GenerationResult;
videoEditIntents?: VideoEditIntent[];
imageEdit?: ImageEditDocument | null;
parameters?: Record<string, unknown>;
};

关联类型:Woohaa3CanvasJsonObject · ManagedNodeRelation · CanvasNodeInputMapping · GenerationStatus · GenerationResult · MediaContentRef · VideoEditIntent · ImageEditDocument

成员说明:

  • managedBy:Neutral extension-owned lifecycle relation. Business payload stays opaque.
  • activeRunId:当前节点的 active run(客户端生成)。任务结果只有在它与返回结果的 runId 一致时 才被接受。
  • modelKey:最近一次执行使用的稳定 modelKey。
  • preferredModelKey:用户保存的下次执行模型;独立于最近一次任务及其参数草稿。
  • error:null 表示显式清除上一次的错误(同一次提交里清掉失败态再进入 processing)。
  • codexImageImport:Codex 内建生图导入的成品图。选中时不打开图片生成面板。
  • historyPreviewFailure:浏览器本地历史预览的失败信息。 只在 node-history 的 ExecutionPreview 渲染投影中写入:选中失败/取消归档时,卡片正文 用它替代上一个成功输出显示安全原因。不进入 Y.Doc、ServerCanvas 或任何权威写入。
  • posterAssetId:视频结果的可选海报资产引用(稳定 asset ID)。
  • modelScript:模型节点的模型脚本。 规范定义是版本化 JavaScript(modelScriptLanguage: "javascript"、 modelScriptVersion: "WooHaa3-model-js-v2"),由浏览器注入 SceneBuilder API 执行, 结果经 Scene IR validator 校验后送给 Bevy。唯一权威写入方是 Canvas Service 的 model MCP;进入 Y.Doc 后在重新投影时继续生效。Scene IR 只是运行时 DTO,不在此持久化。
  • modelScriptLanguage:脚本语言;写入必须为 "javascript"。
  • modelScriptVersion:脚本语言版本;写入必须为受支持的 WooHaa3-model-js-v*。
  • modelRig:人形骨架 descriptor。 缺失表示旧作品。权威写入拒绝把已有骨架删掉或换成非法模板。
  • modelScriptStatus:模型脚本应用状态;与任务的 taskStatus 分离(任务终态仍由 projector 独占)。
  • modelScriptError:模型脚本应用失败的安全错误信息(不包含本机路径或堆栈)。
  • modelSourceKind:普通 model3d 的权威来源判别。 缺失表示脚本模型(与历史内容兼容);"glb" 表示以画布资产 modelAssetId 中的原始 GLB 为权威内容,此时节点不得保存任何 modelScript* 字段。
  • modelAssetId:文件模型引用的画布作用域资产 id(内容寻址、稳定;不写二进制或临时 URL)。
  • videoEditIntents:视频编辑意图。 只在 parameters.generationMode === "edit_video" 时使用。canonical 状态只保存 结构化 intent 与稳定 annotation preview identity,绝不保存 data URL、object URL、 Blob 或临时签名 URL(由 sanitizeVideoEditIntents 强制)。
  • imageEdit:图片节点的当前编辑定义 。 只保存当前版本的严格定义(稳定原图引用、源尺寸、归一化 shapes);outputAssetId 指向稳定合成输出。绝不含图片 bytes、Blob、URL、草稿栈或编辑 UI 状态。无此字段的合法 旧图继续作为纯媒体读取。完整历史集合由 canvas-node-generation-history 持有。 null 显式清除(恢复纯媒体版本时)。

CanvasNodeFocusTarget

节点聚焦目标(有 nodeId)。

export type CanvasNodeFocusTarget = {
kind: CanvasFocusKind;
nodeId: string;
owner: "direct" | "history";
};

关联类型:CanvasFocusKind

CanvasNodeInputMapping

export type CanvasNodeInputMapping = {
slotId?: string;
sourceNodeId: string;
sourceAssetIds?: string[];
role: string;
sortKey?: string;
label?: string;
};

CanvasNodePosition

export type CanvasNodePosition = {
id: string;
x: number;
y: number;
};

CanvasNodeResourceState

export type CanvasNodeResourceState = {
id: string;
texture: boolean;
mediaLoading: boolean;
};

CanvasNodeRunSummary

单节点运行摘要(底部历史条、聚合遮罩与面板门禁的有界读模型)。

这是投影给渲染层的形状:有界、不含完整历史列表或媒体 bytes。

export type CanvasNodeRunSummary = {
canvasId: string;
nodeId: string;
active: CanvasOperationRecord | null;
isAggregate: boolean;
aggregateRunning: boolean;
};

关联类型:CanvasOperationRecord

成员说明:

  • active:该节点当前非终态操作(若有);同一普通节点可有多个,但仅首个用于门禁。
  • isAggregate:该节点是否为聚合节点。
  • aggregateRunning:聚合节点是否存在运行中操作(驱动整体遮罩)。

CanvasObserverUpdate

export type CanvasObserverUpdate = {
version: typeof CANVAS_OBSERVER_UPDATE_VERSION;
baseSceneGeneration: number;
nodeId: string;
yaw: number;
pitch: number;
distance: number;
target: Vec3;
};

关联类型:Vec3

CanvasOperationKind

export type CanvasOperationKind = (typeof CANVAS_OPERATION_KINDS)[number];

CanvasOperationRecord

统一运行状态记录(有界摘要,不含完整内容/媒体 bytes)。

export type CanvasOperationRecord = {
operationId: string;
canvasId: string;
nodeId: string;
kind: CanvasOperationKind;
state: CanvasOperationState;
owner: RunLifecycleOwner;
progress?: number;
mediaState?: "materializing";
error?: string;
localFailure?: boolean;
batch?: boolean;
createdAt: string;
updatedAt: string;
};

关联类型:CanvasOperationKind · CanvasOperationState · RunLifecycleOwner

成员说明:

  • progress:0..100;仅非终态有意义。
  • mediaState:provider 已产出、正在转存稳定媒体。 仅非终态服务端操作会携带;节点据此显示「媒体准备中」并保持成功入口禁用。
  • error:安全错误摘要(不含堆栈/凭据/本机路径)。
  • localFailure:本地提交被拒(网关拒绝等);不伪造 canonical 状态。
  • batch:是否属于批量运行成员(不参与活动数量聚合,仅用于分组/展示)。

CanvasOperationState

export type CanvasOperationState = (typeof CANVAS_OPERATION_STATES)[number];