跳转到内容

签名关联类型:ApplicationExtensionHostIdentity – AssistantWorldContextView

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

返回接口索引

ApplicationExtensionHostIdentity · ApplicationExtensionMetadataSummary · ApplicationExtensionReleasePointer · ApplicationExtensionRemoteError · ApplicationExtensionSafeDiagnostic · ApplicationExtensionSecretStore · ApplicationExtensionSnapshot · ApplicationExtensionSnapshotResult · ApplicationExtensionStatus · ApplicationExtensionStatusService · ApplicationExtensionStatusSnapshot · ApplicationExtensionWriteResult · ApplicationHealthResult · ApplicationRemote · ApplicationSecretReadResult · ApplicationSecretRefreshCoordinator · ApplicationSecretWritePrecondition · ApplicationSecretWriteResult · ApplicationServiceConnectionFacade · ApplicationUserDelegation · AssistantDeliveryTarget · AssistantExecutionRef · AssistantTextCapabilities · AssistantWorldContextView

ApplicationExtensionHostIdentity

后端宿主注入的 identity;站点插件生产宿主为 application。

export type ApplicationExtensionHostIdentity = ApplicationExtensionHost;

关联类型:ApplicationExtensionHost

ApplicationExtensionMetadataSummary

公开可信元数据摘要(站点插件分区展示;可含展示目录,不含可执行入口与秘密)。

export type ApplicationExtensionMetadataSummary = {
directory?: string;
extensionId: string;
name: string;
description: string;
version: string;
};

成员说明:

  • directory:部署侧提供的所在目录,仅用于展示。

ApplicationExtensionReleasePointer

浏览器发布目录指针:href 是固定发布逻辑前缀 /extension-releases/<releaseId>.json。

export type ApplicationExtensionReleasePointer = {
releaseId: string;
href: string;
};

ApplicationExtensionRemoteError

export type ApplicationExtensionRemoteError = "unauthorized" | "revision-conflict" | "config-invalid" | "extension-not-found" | "unavailable" | "malformed";

ApplicationExtensionSafeDiagnostic

不含秘密、可供普通用户读取的诊断。

export type ApplicationExtensionSafeDiagnostic = {
code: string;
message: string;
detail?: string;
};

成员说明:

  • detail:安全附加字段(只允许稳定标量;脱敏层已剔除敏感键)。

ApplicationExtensionSecretStore

受限秘密仓库:插件只能读写的自己 purpose 的加密记录。

记录内容由插件定义(OAuth token 等),宿主只负责隔离、加密持久化与版本/epoch。

export type ApplicationExtensionSecretStore = {
read: <T>(owner: string, purpose: string) => ApplicationSecretReadResult<T>;
write: <T>(owner: string, purpose: string, record: T, precondition: ApplicationSecretWritePrecondition) => ApplicationSecretWriteResult;
clear: (owner: string, purpose: string) => void;
epoch: (owner: string) => number;
bumpEpoch: (owner: string) => number;
refresh: ApplicationSecretRefreshCoordinator;
};

关联类型:ApplicationSecretReadResult · ApplicationSecretWritePrecondition · ApplicationSecretWriteResult · ApplicationSecretRefreshCoordinator

成员说明:

  • read:读取 owner 的记录(不改变版本)。
  • write:原子加密写入(带版本/epoch 前置条件)。
  • clear:清除 owner 的记录(幂等)。
  • epoch:当前授权 epoch(断开/重绑后推进)。
  • bumpEpoch:推进授权 epoch(断开或重新绑定);使较旧刷新写入失效。
  • refresh:owner 内刷新协调。

ApplicationExtensionSnapshot

站点插件公开状态 snapshot(权威恢复来源)。

export type ApplicationExtensionSnapshot = {
revision: number;
catalog: ApplicationExtensionMetadataSummary[];
plugins: ApplicationExtensionStatus[];
extensionRelease?: ApplicationExtensionReleasePointer;
};

关联类型:ApplicationExtensionMetadataSummary · ApplicationExtensionStatus · ApplicationExtensionReleasePointer

成员说明:

  • revision:全局单调 revision。客户端只接受不早于当前 revision 的状态。
  • catalog:服务端可信清单的公开元数据摘要(名称/说明;不含代码位置)。
  • extensionRelease:当前浏览器发布目录指针。 受管扩展安装/卸载后随之切换;前端据此为新增条目热登记,已固定的 release 不变。旧宿主不返回此字段。

ApplicationExtensionSnapshotResult

export type ApplicationExtensionSnapshotResult = {
ok: true;
snapshot: ApplicationExtensionSnapshot;
} | {
ok: false;
code: ApplicationExtensionRemoteError;
error: string;
};

关联类型:ApplicationExtensionSnapshot · ApplicationExtensionRemoteError

ApplicationExtensionStatus

单个插件的公开状态。

export type ApplicationExtensionStatus = {
extensionId: string;
desiredEnabled: boolean;
actualState: ApplicationExtensionActualState;
configVersion: number | null;
extensionRevision: number;
activeWorkCount: number;
diagnostics: ApplicationExtensionSafeDiagnostic[];
};

关联类型:ApplicationExtensionActualState · ApplicationExtensionSafeDiagnostic

成员说明:

  • configVersion:实际生效的配置版本;未配置时为 null。
  • extensionRevision:全局单调 revision(所有插件共享同一序列)。
  • activeWorkCount:在途工作引用数(work-handle 计数;重启后由 durable 状态重建)。

ApplicationExtensionStatusService

export type ApplicationExtensionStatusService = {
getSnapshot: () => ApplicationExtensionStatusSnapshot;
subscribe: (listener: () => void) => () => void;
refresh: () => Promise<void>;
refreshChanges: () => Promise<void>;
writeConfig: (input: Omit<ApplicationExtensionConfigWriteInput, "expectedRevision"> & {
expectedRevision?: number;
}) => Promise<ApplicationExtensionWriteResult>;
start: () => void;
stop: () => void;
dispose: () => void;
};

关联类型:ApplicationExtensionStatusSnapshot · ApplicationExtensionConfigWriteInput · ApplicationExtensionWriteResult

成员说明:

  • refresh:拉取权威 snapshot(重连/丢失 cursor)。
  • refreshChanges:增量刷新(旧响应不覆盖新状态)。
  • writeConfig:管理员配置写入;成功后重取权威状态。
  • start:启动/停止轮询。

ApplicationExtensionStatusSnapshot

export type ApplicationExtensionStatusSnapshot = {
revision: number;
catalog: ApplicationExtensionCatalogSummary[];
plugins: ApplicationExtensionStatus[];
error: string | null;
loading: boolean;
extensionRelease?: ApplicationExtensionReleasePointer | null;
};

关联类型:ApplicationExtensionCatalogSummary · ApplicationExtensionStatus · ApplicationExtensionReleasePointer

成员说明:

  • catalog:服务端可信清单公开元数据摘要(名称/说明/展示目录,不含可执行入口)。
  • error:最近一次同步错误(安全文案);无错误为 null。
  • loading:尚未取得任何权威状态。
  • extensionRelease:宿主当前发布目录指针。 受管扩展热登记后变化;旧宿主不返回时为 null。与插件 revision 独立。

ApplicationExtensionWriteResult

export type ApplicationExtensionWriteResult = {
ok: true;
revision: number;
status: ApplicationExtensionStatus;
} | {
ok: false;
code: ApplicationExtensionRemoteError;
error: string;
currentRevision?: number;
};

关联类型:ApplicationExtensionStatus · ApplicationExtensionRemoteError

ApplicationHealthResult

export type ApplicationHealthResult = {
ok: true;
status: "ok" | "ready";
} | {
ok: false;
error: string;
reason?: string;
};

ApplicationRemote

export type ApplicationRemote = {
fetchSnapshot: () => Promise<ApplicationExtensionSnapshotResult>;
fetchChanges: (after: number) => Promise<ApplicationExtensionChangesResult>;
writeConfig: (input: ApplicationExtensionConfigWriteInput) => Promise<ApplicationExtensionWriteResult>;
health: () => Promise<ApplicationHealthResult>;
generationModels: {
fetchSnapshot: () => ReturnType<GenerationModelsRemote["fetchSnapshot"]>;
writeConfig: (input: import("@woohaa3/contracts").GenerationModelsWriteRequest) => ReturnType<GenerationModelsRemote["writeConfig"]>;
};
transport: ApplicationRemoteTransport;
};

关联类型:ApplicationExtensionSnapshotResult · ApplicationExtensionChangesResult · ApplicationExtensionConfigWriteInput · ApplicationExtensionWriteResult · ApplicationHealthResult · GenerationModelsRemote · GenerationModelsWriteRequest · ApplicationRemoteTransport

成员说明:

  • fetchSnapshot:权威状态 snapshot(不含秘密)。
  • fetchChanges:有界增量;resyncRequired 时调用方必须重取 snapshot。
  • writeConfig:管理员配置写入(浏览器不携带服务令牌;由同源 ingress 传递可信管理员上下文)。
  • health:读取 Application liveness/readiness(只含状态与安全原因)。
  • generationModels:生成模型策略。
  • transport:通用插件 JSON/流式传输。 插件(如 ChatGPT)拥有自己的业务协议 adapter,但 MUST 复用本传输发起同源请求,携带同源会话 与取消信号,不自行创建针对服务的 fetch/EventSource。传输只做 HTTP/SSE 编解码与稳定错误映射, 不解释业务协议,也不持有服务间令牌。

ApplicationSecretReadResult

秘密记录读取结果:不存在/解密失败返回 null。

export type ApplicationSecretReadResult<T> = {
value: T;
version: number;
} | null;

ApplicationSecretRefreshCoordinator

owner 内刷新协调:同一 owner 的并发刷新合并为一次。

export type ApplicationSecretRefreshCoordinator = {
run: <T>(owner: string, key: string, task: () => Promise<T>) => Promise<T>;
};

成员说明:

  • run:合并同名 key 的并发刷新;返回同一 promise。

ApplicationSecretWritePrecondition

一次写入的并发前置条件:

  • version:期望当前版本(新记录为 0);不匹配返回 conflict;
  • epoch:期望授权 epoch;断开后 epoch 变化使旧写入失效。
export type ApplicationSecretWritePrecondition = {
version: number;
epoch?: number;
};

成员说明:

  • epoch:期望的授权 epoch(可选);不匹配视为失效写入。

ApplicationSecretWriteResult

export type ApplicationSecretWriteResult = {
ok: true;
version: number;
} | {
ok: false;
code: "version-conflict" | "epoch-invalid" | "storage-failed";
message: string;
};

ApplicationServiceConnectionFacade

export type ApplicationServiceConnectionFacade = {
registerConsumer(input: {
protocols: readonly ServiceConnectionProtocol[];
purposes: readonly ServiceConnectionPurpose[];
}): () => void;
registerSource(adapter: ServiceConnectionSourceAdapter): () => void;
list(owner: string): Promise<readonly ServiceConnectionView[]>;
get(owner: string, id: string): Promise<ServiceConnectionView | null>;
resolve(owner: string, input: ServiceConnectionResolve): Promise<{
secret: string;
endpoint: string;
} & ServiceConnectionVersion>;
};

关联类型:ServiceConnectionProtocol · ServiceConnectionPurpose · ServiceConnectionSourceAdapter · ServiceConnectionView · ServiceConnectionResolve · ServiceConnectionVersion

成员说明:

  • list:Personal projection only. Site management uses the host’s administrator boundary.

ApplicationUserDelegation

进入领域端口时传递的宿主生成委托上下文。

下游据此检查「插件身份 + 应用用户委托」,插件不能改写它,也不获得原始服务令牌。

export type ApplicationUserDelegation = {
subject: string;
authLevel: ApplicationExtensionAuthLevel;
sessionId?: string;
auditActor?: string;
};

关联类型:ApplicationExtensionAuthLevel

成员说明:

  • sessionId:可信会话绑定(存在时)。
  • auditActor:审计 actor(不参与 owner 选择)。

AssistantDeliveryTarget

A finite domain delivery adapter. Conversation data and presentation remain host owned.

export type AssistantDeliveryTarget = {
domain?: {
requestId: string;
sourceNodeId: string;
targetNodeId: string;
commandId?: string;
};
execution?: import("@woohaa3/contracts").AssistantExecutionRef;
status: import("@woohaa3/contracts").ConversationTurnStatus;
stage: string;
reason?: string;
query(): Promise<{
ok: boolean;
error?: string;
}>;
cancel?: () => Promise<{
ok: boolean;
error?: string;
}>;
retry?: () => Promise<{
ok: boolean;
error?: string;
}>;
};

关联类型:AssistantExecutionRef · ConversationTurnStatus

AssistantExecutionRef

export type AssistantExecutionRef = {
canvasId: string;
targetNodeId: string;
conversationId: string;
turnRequestId: string;
domainRequestId?: string;
attemptId?: string;
};

AssistantTextCapabilities

adapter 声明的能力:通用面板据此决定可用动作与文案,不静默替换聊天模型。

  • discussion:支持多轮讨论;
  • targets:支持的目标创作模式;
  • tools:支持内置 MCP 工具(写范围须服务端门禁);
  • models:目录来源(remote 表示真实账户目录)。
export type AssistantTextCapabilities = {
imageInput: boolean;
maxImages: number;
};

AssistantWorldContextView

Read-only projection returned by get_world_context.

export type AssistantWorldContextView = {
version: typeof ASSISTANT_WORLD_AUTHORITY_VERSION;
canvasId: WorldId;
contextId: WorldId;
runId: WorldId;
epoch: number;
scope: WorldScopeVersion;
writable: WorldObjectVersion[];
readOnly: WorldObjectVersion[];
objects: AssistantWorldObjectSummary[];
allowSceneAreaExpansion?: boolean;
bounds?: {
min: {
u: number;
v: number;
};
max: {
u: number;
v: number;
};
};
sceneArea?: {
areaId?: string;
title?: string;
resourceVersion?: string;
nodeId: WorldId;
revision: number;
scopeVersion: WorldVersion;
animationOrigin: GroundPoint;
animationQuarterTurns?: number;
animationScript: WorldAnimationScript | null;
};
camera?: {
nodeId: WorldId;
settings: WorldCameraData;
};
sceneModels?: Array<{
instanceId: WorldId;
nodeId: WorldId;
title: string;
transform: WorldTransform;
localBounds: Aabb | null;
animationRig?: WorldModelAnimationRig;
modelContentVersion?: unknown;
}>;
modelScripts?: Record<WorldId, string>;
resourceVersions?: Record<string, string>;
sceneCameras?: Array<{
nodeId: string;
title: string;
settings: WorldCameraData;
}>;
worldWritable: boolean;
};

关联类型:WorldId · WorldScopeVersion · WorldObjectVersion · AssistantWorldObjectSummary · WorldVersion · GroundPoint · WorldAnimationScript · WorldCameraData · WorldTransform · Aabb · WorldModelAnimationRig

成员说明:

  • allowSceneAreaExpansion:Frozen per-turn policy; older contexts default to false.
  • bounds:导演区地面范围;模型创建/移动必须落在该范围内。2D 组没有世界范围。
  • sceneArea:Current published animation for this director area. Omitted by older hosts and for 2D groups.
  • camera:Selected camera and published scene geometry, for camera-only composition edits.
  • modelScripts:Authoritative scripts of the instance identities in this scope (writable plus read-only references), keyed by instance id. read_world_resource reads includeSource from here, so a chunk write can verify its real tail. Omitted by hosts that predate chunked authoring.
  • worldWritable:A 2D group has no writable world set and no completion.