跳转到内容

签名关联类型:CameraAspect – CanvasGenerationHistoryListPage

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

返回接口索引

CameraAspect · CameraTrack · CameraTrackProperty · CanvasAccess · CanvasActivityChangesQuery · CanvasAsset · CanvasAssetSource · CanvasAssetStatus · CanvasCaptureFreezeResult · CanvasCatalogOrigin · CanvasCommandBatch · CanvasContextMenuItem · CanvasCreateOptionContribution · CanvasDetailSummary · CanvasDocumentFocusTarget · CanvasEditRecordResult · CanvasEditScope · CanvasEditScopeCategory · CanvasEditSnapshot · CanvasFocusKind · CanvasFocusTarget · CanvasFocusTransition · CanvasGenerationHistoryListItem · CanvasGenerationHistoryListPage

CameraAspect

export type CameraAspect = (typeof CAMERA_ASPECTS)[number];

CameraTrack

镜头轨道:在 [startTime,endTime] 内把某属性从 from 插值到 to。

export type CameraTrack = {
id: string;
property: CameraTrackProperty;
startTime: number;
endTime: number;
from: number;
to: number;
easing: MotionEasing;
};

关联类型:CameraTrackProperty · MotionEasing

CameraTrackProperty

export type CameraTrackProperty = (typeof CAMERA_TRACK_PROPERTIES)[number];

CanvasAccess

调用者在这张画布上的内容权限(服务端判定,客户端只渲染)。

与 sync(链路状态)是两个维度:同步正常也可能只读(协作者 viewer、链接只读分享), 断线也可能本来可写。界面在进入画布时据此决定是否显示只读提示、是否允许生成/编辑。

省略表示未知(没接远端、远端这次没给答案),调用方不得把未知当成只读。

export type CanvasAccess = {
canRead: boolean;
canWrite: boolean;
canDelete?: boolean;
};

成员说明:

  • canRead:能否读取这张画布;false 表示远端明确拒绝(本机内容可能只是陈旧副本)。
  • canWrite:能否写入这张画布;false 表示只读。
  • canDelete:能否删除这张画布(可选;省略表示未知,按可删处理)。 删除是作者动作:服务端 DeleteCanvas 按 canvas.share 判定,可写协作者(editor) 能改内容但不蕴含删除。界面据此隐藏注定被拒的删除入口,只在明确 false 时隐藏。

CanvasActivityChangesQuery

画布活动有限增量查询(GET /changes)。

export type CanvasActivityChangesQuery = {
canvasId: string;
after: number;
limit?: number;
};

CanvasAsset

export type CanvasAsset = {
id: string;
title: string;
mediaKind: CanvasMediaKind;
source: CanvasAssetSource;
status: CanvasAssetStatus;
isFavorite?: boolean;
prompt?: string;
url?: string;
posterUrl?: string;
text?: string;
durationSeconds?: number;
progress?: number;
error?: string;
provenance?: {
taskNodeId?: string;
taskKind?: string;
runId?: string;
outputIndex?: number;
};
tags?: string[];
metadata?: Record<string, unknown>;
};

关联类型:CanvasMediaKind · CanvasAssetSource · CanvasAssetStatus

成员说明:

  • isFavorite:Whether this asset is saved in the current canvas generation history.

CanvasAssetSource

export type CanvasAssetSource = "generated" | "uploaded" | "external";

CanvasAssetStatus

export type CanvasAssetStatus = "ready" | "generating" | "needs-review" | "missing" | "failed";

CanvasCaptureFreezeResult

export type CanvasCaptureFreezeResult = {
ok: true;
binding: import("@woohaa3/contracts").WorldCaptureGenerationBinding;
} | {
ok: false;
code: string;
error: string;
requestedKey?: import("@woohaa3/contracts").WorldCaptureVersionKey;
currentKey?: import("@woohaa3/contracts").WorldCaptureVersionKey;
};

关联类型:WorldCaptureGenerationBinding · WorldCaptureVersionKey

CanvasCatalogOrigin

画布在哪些来源里存在。

目录可以同时接入多个来源(本机存储、远端服务端),两者都生效:同一个 id 在两边 都有时只出现一次,sources 记着它在哪几边存在。这决定了界面该显示“仅本机”、 “仅远端”还是“已同步”。

export type CanvasCatalogOrigin = "local" | "remote";

CanvasCommandBatch

export type CanvasCommandBatch = {
protocolVersion: number;
canvasId: string;
commandId: string;
baseRevision: number;
actorId: string;
commands: CanvasCommand[];
};

关联类型:CanvasCommand

成员说明:

  • protocolVersion:同步协议版本(design D4 握手的一部分)。
  • commandId:客户端生成的命令 id;用于幂等重放(spec「响应丢失后重试」)。
  • baseRevision:客户端生成时看到的业务 revision;用于诊断与命令前置条件,不做全局 CAS。

CanvasContextMenuItem

export type CanvasContextMenuItem = {
icon?: import("react").ComponentType<{
className?: string;
}>;
id: string;
label: string;
disabled?: boolean;
danger?: boolean;
separatorBefore?: boolean;
section?: string;
order?: number;
reason?: string;
};

成员说明:

  • disabled:不可点击项(例如断线只读时的插入项)。
  • danger:危险操作(删除)用红色强调。
  • separatorBefore:该项前插入分隔线。
  • section:菜单 section identity。 宿主合并后按 section 顺序统一规范化并补分隔线,不依赖注册先后。
  • order:section 内顺序;未声明时保持贡献顺序。
  • reason:不可用原因。 仅用于桌面鼠标悬停提示与诊断;不构成无障碍契约。禁用项用它说明为何不能激活 (只读、提交中、成员均在运行等),不新增第二份菜单状态。

CanvasCreateOptionContribution

新建画布时可勾选的选项(canvas.create-option slot)。

宿主只负责:建完画布后按勾选顺序调用每个贡献的 apply,失败如实报出(不回滚画布—— 画布已经建好了,回滚会让用户丢掉刚建的东西)。「要不要出现、什么时候可用」由贡献方 自己回答,宿主不认识任何扩展。

export type CanvasCreateOptionContribution = {
id: string;
owner: string;
priority?: number;
label: string;
description?: string;
defaultEnabled?: boolean;
available?: () => boolean;
apply: (context: {
canvasId: string;
}) => Promise<{
ok: true;
} | {
ok: false;
error: string;
}>;
};

成员说明:

  • id:贡献稳定 ID;同一 slot 内重复会启动失败。
  • owner:拥有者(诊断用)。
  • priority:越小越靠前。
  • label:复选框文案。
  • description:一句解释,放在文案下方。
  • defaultEnabled:默认是否勾选;缺省不勾(新建默认本地,同步是显式选择)。
  • available:此刻是否应该出现;缺省总是出现。
  • apply:画布建好后执行;失败返回原因,由宿主展示。

CanvasDetailSummary

单画布摘要(无 createdAt)。

GET /api/canvases/:canvasId 返回完整画布而不含结构化 createdAt;目录按 ID 校验/展示 当前画布时只取这些字段。需要 createdAt 的列表场景用 CanvasSummary。

export type CanvasDetailSummary = {
id: string;
title: string;
revision: number;
updatedAt: string;
nodeCount: number;
assetCount: number;
access?: CanvasAccess;
};

关联类型:CanvasAccess

成员说明:

  • access:调用者在这张画布上的内容权限;省略表示未知(按可写处理)。

CanvasDocumentFocusTarget

独立文件文档聚焦目标(无节点身份)。

export type CanvasDocumentFocusTarget = {
kind: "document";
documentId: string;
};

CanvasEditRecordResult

export type CanvasEditRecordResult = {
ok: true;
entry: JournalEntry;
} | {
ok: false;
reason: string;
code?: string;
};

关联类型:JournalEntry

CanvasEditScope

export type CanvasEditScope = {
"2d": CanvasScopeMode;
"3d": CanvasScopeMode;
};

关联类型:CanvasScopeMode

CanvasEditScopeCategory

export type CanvasEditScopeCategory = "2d" | "3d";

CanvasEditSnapshot

export type CanvasEditSnapshot = {
canUndo: boolean;
canRedo: boolean;
undoLabel: string | null;
redoLabel: string | null;
busy: boolean;
writable: boolean;
blockedReason: string | null;
size: number;
pending: readonly JournalPendingEntry[];
lastAction: {
kind: "delete" | "other";
label: string;
entryId: string;
} | null;
};

关联类型:JournalPendingEntry

成员说明:

  • busy:仅长操作(世界转换/导演区采纳)的独立互斥;不再阻断普通结构动作。
  • pending:尚未结算/等待对账/冲突的记录(每条独立状态)。
  • lastAction:最近一次可撤销动作的类型。 及其条目 id,提示按钮据此绑定具体动作身份,避免误撤销后来动作。

CanvasFocusKind

可聚焦节点内容种类(design D1:统一 image/video/model focus identity)。

"extension":通用纯模型扩展节点(如 composite-asset)聚焦到的扩展工作区,工作区覆盖层由 extension 经 canvas.overlay 贡献;宿主只提供通用导航/呈现。

export type CanvasFocusKind = "image" | "video" | "model" | "extension";

CanvasFocusTarget

adapter 接收的完整聚焦目标(design D2):null 表示未聚焦。

export type CanvasFocusTarget = CanvasNodeFocusTarget | CanvasDocumentFocusTarget;

关联类型:CanvasNodeFocusTarget · CanvasDocumentFocusTarget

CanvasFocusTransition

一次 focus target transition 的上下文(design D2/D4)。

  • preserveSession:owner 切换保持同一 overview 返回上下文(进入/退出忽略该标志)。
  • restoreDirectCamera:history -> direct 时恢复进入 history 前的 direct 主观察相机。
export type CanvasFocusTransition = {
preserveSession: boolean;
restoreDirectCamera?: boolean;
};

CanvasGenerationHistoryListItem

画布级列表项:在节点级安全列表项之上补充 nodeId 与安全节点标题。

export type CanvasGenerationHistoryListItem = NodeGenerationHistoryListItem & {
nodeId: string;
nodeTitle: string;
};

关联类型:NodeGenerationHistoryListItem

成员说明:

  • outcome:版本结果语义。 缺省视为 succeeded(兼容旧条目与既有 fixture)。
  • current:是否与节点当前生效输出一致(由权威回流判定,绝不本地猜测)。失败记录恒为 false。
  • recoverable:引用内容是否仍可解析(媒体缺失 / 脚本失效时为 false)。失败归档恒为 false。
  • previewable:预览是否可用(缩略图/媒体缺失时为 false,不影响列表与恢复)。

CanvasGenerationHistoryListPage

export type CanvasGenerationHistoryListPage = {
items: CanvasGenerationHistoryListItem[];
nextCursor: string | null;
total: number;
kindCounts: NodeHistoryKindCounts;
};

关联类型:CanvasGenerationHistoryListItem · NodeHistoryKindCounts