跳转到内容

签名关联类型:EditFieldSnapshot – ExtensionDocumentRead

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

返回接口索引

EditFieldSnapshot · EditNodeDataField · EditNodeDataFieldSnapshot · EditNodeDataGuardField · EditNodeField · EditNodeFieldSnapshot · EditOperation · EditPrecondition · EditSessionBeginRequest · EditSessionBeginResponse · EditSessionCompleteRequest · EditSessionCompletionReceipt · EditSessionErrorCode · EditSessionKind · EditSessionStatusRequest · ExecutionPanelFormatCommand · ExecutionPanelPresentation · ExecutionPanelShellProps · ExecutionPanelSkill · ExecutionPanelVideoEditIntent · ExtensionDocument · ExtensionDocumentBatchResult · ExtensionDocumentOperation · ExtensionDocumentRead

EditFieldSnapshot

字段快照:明确区分「不存在」与「null」。

export type EditFieldSnapshot = {
present: false;
} | {
present: true;
value: unknown;
};

EditNodeDataField

export type EditNodeDataField = (typeof EDIT_NODE_DATA_FIELDS)[number];

EditNodeDataFieldSnapshot

export type EditNodeDataFieldSnapshot = {
field: EditNodeDataGuardField;
} & EditFieldSnapshot;

关联类型:EditNodeDataGuardField · EditFieldSnapshot

EditNodeDataGuardField

export type EditNodeDataGuardField = (typeof EDIT_NODE_DATA_GUARD_FIELDS)[number];

EditNodeField

export type EditNodeField = (typeof EDIT_NODE_FIELDS)[number];

EditNodeFieldSnapshot

export type EditNodeFieldSnapshot = {
field: EditNodeField;
} & EditFieldSnapshot;

关联类型:EditNodeField · EditFieldSnapshot

EditOperation

白名单编辑操作。刻意复用既有 node/edge 结构语义,不含 asset/job/嵌套 edit.apply。

export type EditOperation = {
kind: "extension.edit";
extensionId: string;
nodeId: string;
op: unknown;
} | {
kind: "node-add";
node: {
id: string;
type: string;
position?: {
x: number;
y: number;
};
width?: number;
height?: number;
zIndex?: number;
};
nodeData?: CanvasNodeData;
} | {
kind: "node-update";
nodeId: string;
position?: {
x: number;
y: number;
};
width?: number;
height?: number;
zIndex?: number;
} | {
kind: "node-remove";
nodeIds: readonly string[];
} | {
kind: "edge-add";
edge: {
id: string;
source: string;
target: string;
sourceHandle?: string | null;
targetHandle?: string | null;
data?: Woohaa3CanvasJsonObject;
};
} | {
kind: "edge-remove";
edgeId: string;
} | {
kind: "node-data-set";
nodeId: string;
value: CanvasNodeData;
} | {
kind: "node-data-unset";
nodeId: string;
fields: readonly EditNodeDataField[];
} | {
kind: "canvas-title-set";
title: string;
};

关联类型:CanvasNodeData · Woohaa3CanvasJsonObject · EditNodeDataField

EditPrecondition

结构化前置条件联合。所有条件都针对受保护编辑开始前的规范状态判定。

export type EditPrecondition = {
kind: "node-exists";
nodeId: string;
} | {
kind: "node-missing";
nodeId: string;
} | {
kind: "node-fields";
nodeId: string;
fields: readonly EditNodeFieldSnapshot[];
} | {
kind: "node-data-fields";
nodeId: string;
fields: readonly EditNodeDataFieldSnapshot[];
} | {
kind: "node-data-equals";
nodeId: string;
value: CanvasNodeData;
} | {
kind: "incident-edge-ids";
nodeId: string;
edgeIds: readonly string[];
} | {
kind: "edge-missing";
edgeId: string;
} | {
kind: "edge-present";
edgeId: string;
} | {
kind: "canvas-title-equals";
title: string;
} | {
kind: "no-active-run";
nodeIds: readonly string[];
} | {
kind: "asset-ready";
assetId: string;
} | {
kind: "assets-present";
assetIds: readonly string[];
};

关联类型:EditNodeFieldSnapshot · EditNodeDataFieldSnapshot · CanvasNodeData

EditSessionBeginRequest

编辑 begin 请求。

baselineContentIdentity 为图片媒体身份(media:<storageKey> 或编辑身份)或模型 model-source:<hash> / model-edit:<hash>:<key>。begin-only 不推进 canvas revision。

export type EditSessionBeginRequest = {
canvasId: string;
nodeId: string;
sessionId: string;
requestId: string;
kind: EditSessionKind;
baselineContentIdentity: string;
};

关联类型:EditSessionKind

EditSessionBeginResponse

export type EditSessionBeginResponse = {
ok: true;
sessionId: string;
kind: EditSessionKind;
status: "prepared";
baselineContentIdentity: string;
revision: number;
};

关联类型:EditSessionKind

成员说明:

  • baselineContentIdentity:服务端捕获的基线内容身份(可能比客户端上报更权威)。
  • revision:服务端为会话派生的稳定关联(模型命令归属用)。

EditSessionCompleteRequest

export type EditSessionCompleteRequest = ImageEditCompleteRequest | ModelEditCompleteRequest;

关联类型:ImageEditCompleteRequest · ModelEditCompleteRequest

EditSessionCompletionReceipt

完成回执(design D6):completed 确认该操作保存的版本,不承诺仍是最新内容。

export type EditSessionCompletionReceipt = {
requestId: string;
sessionId: string;
canvasId: string;
nodeId: string;
kind: EditSessionKind;
status: EditCompletionStatus;
contentIdentity: string;
entryId: string | null;
revision: number;
contentCommitted: boolean;
errorCode?: EditSessionErrorCode;
errorMessage?: string;
};

关联类型:EditSessionKind · EditCompletionStatus · EditSessionErrorCode

成员说明:

  • contentIdentity:本操作提交的内容 identity(用于本地确认 canonical 回流)。
  • entryId:已登记/待登记的历史条目 id(若有)。
  • revision:本次操作推进后的 canvas revision。
  • contentCommitted:已经权威提交内容(history-pending 时为 true)。
  • errorCode:失败/冲突时的稳定错误码。

EditSessionErrorCode

export type EditSessionErrorCode = (typeof EDIT_SESSION_ERROR_CODES)[number];

EditSessionKind

export type EditSessionKind = (typeof EDIT_SESSION_KINDS)[number];

EditSessionStatusRequest

status 查询请求:客户端在响应丢失/刷新后据此确认。

export type EditSessionStatusRequest = {
canvasId: string;
nodeId: string;
requestId: string;
};

ExecutionPanelFormatCommand

格式工具栏命令(对齐源工程 PromptFormatCommand)。

export type ExecutionPanelFormatCommand = {
type: "block";
value: "h1" | "h2" | "h3" | "paragraph";
} | {
type: "text";
value: "bold" | "italic" | "underline";
} | {
type: "style";
property: "color" | "background-color";
value: string;
} | {
type: "clear";
};

ExecutionPanelPresentation

export type ExecutionPanelPresentation = ExecutionPanelPresentation;

ExecutionPanelShellProps

export type ExecutionPanelShellProps = {
children: ReactNode;
ariaLabel: string;
className?: string;
};

ExecutionPanelSkill

快捷改写技能。

export interface ExecutionPanelSkill {
id: string;
label: string;
description: string;
}

ExecutionPanelVideoEditIntent

视频编辑意图(video-generation + edit_video 时提示词上方的标签)。

export interface ExecutionPanelVideoEditIntent {
id: string;
startSeconds: number;
endSeconds?: number;
prompt: string;
annotationPreviewUrl?: string;
annotationImageDataUrl?: string;
annotationCount?: number;
}

成员说明:

  • annotationPreviewUrl:稳定标记图同源 URL(仅展示,来自已确认的稳定 preview identity)。
  • annotationImageDataUrl:标记图数据 URL 兜底。 与 annotationPreviewUrl 二选一;两者都提供时优先同源 URL。
  • annotationCount:标注数量(可选的稳定摘要,用于 chip 展示)。

ExtensionDocument

一份文档的记录:值 + 单调 revision。读返回 null 表示不存在。

export type ExtensionDocument<T extends ExtensionDocumentValue = ExtensionDocumentValue> = {
key: string;
value: T;
revision: number;
updatedAt: string;
};

关联类型:ExtensionDocumentValue

ExtensionDocumentBatchResult

export type ExtensionDocumentBatchResult = {
ok: true;
revisions: Record<string, number | null>;
} | {
ok: false;
code: "revision-conflict";
key: string;
currentRevision: number | null;
} | {
ok: false;
code: "invalid";
message: string;
};

ExtensionDocumentOperation

原子写入操作:set(带可选 expectedRevision 做 CAS)、delete(带 expectedRevision)。

一次 batch 内的所有操作要么全提交、要么全不提交(成员索引与正文一致)。

export type ExtensionDocumentOperation = {
op: "set";
key: string;
value: ExtensionDocumentValue;
expectedRevision?: number | null;
} | {
op: "delete";
key: string;
expectedRevision?: number | null;
};

关联类型:ExtensionDocumentValue

成员说明:

  • expectedRevision:期望当前 revision;null 表示“应不存在”。缺省为无条件覆盖(不推荐用于 ACL)。

ExtensionDocumentRead

带版本读取,供 CAS 使用。

export type ExtensionDocumentRead<T extends ExtensionDocumentValue = ExtensionDocumentValue> = {
found: true;
document: ExtensionDocument<T>;
} | {
found: false;
};

关联类型:ExtensionDocumentValue · ExtensionDocument