跳转到内容

签名关联类型:SomaBodySex – TaskExecutionEvent

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

返回接口索引

SomaBodySex · SomaMotionMetadata · SomaSceneLapRoute · SourceCanvasSummary · SpatialLeaseIdentity · StoredCanvas · StoredHumanoidRig · StoredJob · StringSettingDefinition · Surface · SyncSocket · SyncStatusAction · SyncStatusTone · SyncStatusView · TaskActivityFinished · TaskActivityFinishedLocalRejection · TaskActivityFinishedRemote · TaskActivityStarted · TaskActivityUpdated · TaskAdmissionVersions · TaskErrorSummary · TaskExecutionActor · TaskExecutionDetail · TaskExecutionEvent

SomaBodySex

export type SomaBodySex = 'male' | 'female';

SomaMotionMetadata

export type SomaMotionMetadata = {
formatVersion: "kimodo-soma-v1";
skeletonId: "somaskel77";
restPoseId: "kimodo-standard-tpose";
fps: number;
frameCount: number;
jointCount?: number;
skinAssetId?: string;
};

SomaSceneLapRoute

export type SomaSceneLapRoute = {
kind: 'scene-lap';
connectorMode?: 'smooth';
referenceFrame?: {
origin: GroundPoint;
quarterTurns: number;
};
phaseDistance?: number;
path: GroundPoint[];
startAnchor: GroundPoint;
cornerRadius: number;
groundAnchorLocal: Vec3;
baseRotation: WorldRotation;
scale: number;
rootHeight: number;
};

关联类型:GroundPoint · Vec3 · WorldRotation

SourceCanvasSummary

来源作品摘要(目录条目);不含正文/媒体/凭据。

export type SourceCanvasSummary = {
ref: CanvasSourceRef;
targetCanvasId: string;
title: string;
updatedAt: string;
nodeCount: number;
availability: "not-prepared" | "preparing" | "ready";
};

关联类型:CanvasSourceRef

SpatialLeaseIdentity

export interface SpatialLeaseIdentity {
canvasId: WorldId;
runId: WorldId;
epoch: number;
target: WorldObjectIdentity;
}

关联类型:WorldId · WorldObjectIdentity

StoredCanvas

export type StoredCanvas<TNodeData extends Woohaa3CanvasJsonObject = CanvasNodeData> = {
id: string;
title?: string;
revision: number;
document: Woohaa3CanvasDocument;
nodeData: Woohaa3CanvasNodeDataMap<TNodeData>;
updatedAt: string;
};

关联类型:Woohaa3CanvasJsonObject · CanvasNodeData · Woohaa3CanvasDocument · Woohaa3CanvasNodeDataMap

StoredHumanoidRig

export type StoredHumanoidRig = {
profile: "humanoid";
templateId: "humanoid";
templateVersion: 1;
parameters: HumanoidParameters;
};

关联类型:HumanoidParameters

StoredJob

export type StoredJob = {
id: string;
nodeId: string;
taskId: string;
modelKey?: string;
runId?: string;
worldCapture?: WorldCaptureGenerationBinding;
status: GenerationStatus;
error?: string;
updatedAt: string;
};

关联类型:WorldCaptureGenerationBinding · GenerationStatus

成员说明:

  • modelKey:该次运行使用的稳定模型身份;用于从历史/产物反查。
  • runId:客户端生成的任务运行 id;与 nodeData.activeRunId 对应(latest-run-wins)。
  • worldCapture:T10 frozen world-capture input for this run. It is written once at durable acceptance and never rewritten by later canvas changes.

StringSettingDefinition

export type StringSettingDefinition = SettingBase & {
kind: "string";
default?: string;
};

关联类型:SettingBase

成员说明:

  • label:设置页上的名称。
  • reload:hot:运行中生效;restart:写入后需要重启进程。
  • legacyEnv:过渡期兼容的旧环境变量名;新配置项不要再声明。
  • group:设置页上的分组(插件配置项按插件分组)。
  • ownerExtensionId:声明这段配置的扩展 id(宿主装载器按插件名填入)。设置面据此把「这个配置段的启停」 放到配置旁边,而不是留在插件清单里。

Surface

export type Surface = {
width: number;
height: number;
};

SyncSocket

同步传输抽象。

SyncSocket 是浏览器 provider 与服务端 sync session 共用的最小传输契约, 因此属于跨单元契约层。只要满足这几条,就能承载同步协议;具体实现(浏览器 WebSocket、Node ws、内存 fake)由各运行单元提供。

export type SyncSocket = {
send(data: Uint8Array): void;
close(code?: number, reason?: string): void;
onMessage(handler: (data: Uint8Array) => void): () => void;
onClose(handler: () => void): () => void;
onOpen?: (handler: () => void) => () => void;
isOpen?: () => boolean;
bufferedAmount?: () => number;
};

成员说明:

  • onOpen:连接就绪回调(可选)。 浏览器 WebSocket 在 CONNECTING 状态下 send() 会抛错,因此 provider 必须等 连接打开后再发出站消息。省略时视为「立即可写」(内存 fake / 已连接的传输)。
  • isOpen:当前是否可写;省略时视为 true。
  • bufferedAmount:当前底层未发送字节数(可选)。 Canvas Session 用它判定慢 consumer 并在超出队列上限时有界关闭;省略时视为 0。

SyncStatusAction

气泡里的显式动作(目前只有「重新连接」)。

export type SyncStatusAction = {
kind: "reconnect";
label: string;
busy: boolean;
};

成员说明:

  • label:按钮文案。
  • busy:重建进行中:按钮置灰,避免重复触发。

SyncStatusTone

右下角控件面板同步状态展示模型 。

纯函数:把 CanvasSessionStatus.remote 派生为可渲染的展示模型。稳态(已同步、 无待保存)只需静置图标 + hover/聚焦气泡;异常态(断线、待保存、同步错误)需要 不依赖 hover 就能看见,因此用 pinned 让 tooltip 气泡常驻展开。纯展示,不写 Y.Doc、不提交命令、不改变写入门禁。

export type SyncStatusTone = "ok" | "warning" | "danger";

SyncStatusView

export type SyncStatusView = {
tone: SyncStatusTone;
label: string;
detail: string;
pinned: boolean;
action?: SyncStatusAction;
};

关联类型:SyncStatusTone · SyncStatusAction

成员说明:

  • label:图标的可访问名称,也是气泡里的短状态文案。
  • detail:气泡正文:只承载同步信息(不含 MCP 指引,后者在底部中央单独展示)。
  • pinned:是否需要常驻显示(异常态为 true;稳态为 false)。
  • action:需要用户显式恢复动作时的按钮;稳态/待保存/不可用态不提供。

TaskActivityFinished

export type TaskActivityFinished = TaskActivityFinishedRemote | TaskActivityFinishedLocalRejection;

关联类型:TaskActivityFinishedRemote · TaskActivityFinishedLocalRejection

TaskActivityFinishedLocalRejection

网关在接受前拒绝:只结算匹配的 optimistic run,不伪造 taskKey/产物。

export type TaskActivityFinishedLocalRejection = {
source: "local-rejection";
cursor?: never;
activity: {
runId: string;
jobId?: string;
nodeId: string;
state: "failed";
error: {
message: string;
};
updatedAt: string;
};
};

TaskActivityFinishedRemote

权威终态活动。

export type TaskActivityFinishedRemote = {
source: "live" | "recovery";
cursor: number;
activity: CanvasTaskActivity & {
state: "succeeded" | "failed" | "cancelled";
};
};

关联类型:CanvasTaskActivity

TaskActivityStarted

本地已生成稳定 id、即将调用 Canvas Remote 的 optimistic 开始。

export type TaskActivityStarted = {
runId: string;
jobId: string;
nodeId: string;
state: "queued";
modelType?: CanvasTaskModelType;
modelKey?: string;
createdAt: string;
};

关联类型:CanvasTaskModelType

TaskActivityUpdated

权威非终态活动(queued/pending/running 及可选 progress)。

export type TaskActivityUpdated = {
source: "snapshot" | "live" | "recovery";
cursor: number;
activity: CanvasTaskActivity & {
state: "queued" | "pending" | "running";
};
};

关联类型:CanvasTaskActivity

TaskAdmissionVersions

受理时版本审计。

export type TaskAdmissionVersions = {
catalogRevision?: number;
schemaRevision?: number;
configVersion?: number;
extensionConfigVersion?: number;
};

TaskErrorSummary

安全错误摘要:只有名称与消息与结构化状态码,绝不含 stack / 上游响应头。

export type TaskErrorSummary = {
name?: string;
message: string;
status?: number;
code?: string;
};

成员说明:

  • status:上游 HTTP 状态码。 只保留数字本身;上游响应体、响应头仍不进历史。
  • code:上游业务错误码(如 InvalidParameter);只保留稳定字符串标识。

TaskExecutionActor

可信受理 actor。

unknown 表示旧记录或缺少可信受理依据;viewer 自身身份不得反填为 actor。

export type TaskExecutionActor = {
subject?: string;
displayName?: string;
unknown?: boolean;
};

成员说明:

  • unknown:旧记录无来源。

TaskExecutionDetail

详情:列表项 + 有界事件时间线 + 请求参数摘要(operator/admin 视图)。

export type TaskExecutionDetail = TaskExecutionSummary & {
events: TaskExecutionEvent[];
eventsTruncated?: boolean;
request?: TaskRequestSummary;
};

关联类型:TaskExecutionSummary · TaskExecutionEvent · TaskRequestSummary

成员说明:

  • upstreamTaskId:上游 Provider 的任务号(如 RunningHub taskId / Ark task id)。 有它才能拿着历史去上游控制台对账。
  • actor:可信受理 actor。 只来自冻结 delegation;旧记录缺失即 {unknown:true},不反填为查看者。
  • timing:生命周期时间与耗时。 旧记录缺失字段即不猜测;observedAt 为同一次快照时刻。
  • eventsTruncated:事件时间线因上限被裁剪(缺失表示未裁剪或未知)。
  • request:提交时的 prompt 与 parameters;仅详情返回,列表与事件流不含。

TaskExecutionEvent

有界事件时间线项。

export type TaskExecutionEvent = {
sequence: number;
occurredAt: string;
kind: "scheduling" | "execution";
stage: string;
detail?: Record<string, unknown>;
};

成员说明:

  • detail:已脱敏的细节;调用方不得假设其结构。