跳转到内容

签名关联类型:SettingsExtensionPoints – SomaBodyPresetId

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

返回接口索引

SettingsExtensionPoints · SettingsIssue · SettingsLayer · SettingsOpenService · SettingsPanelEditState · SettingsPanelRenderProps · SettingsRemote · SettingsRemoteFailure · SettingsRemoteResult · SettingsSnapshot · SettingsTestRemoteResult · SettingsWriteValue · SiteAccessPolicy · SkillMediaAttemptView · SkillMediaRunRef · SkillMediaState · SkillMediaStepView · SkillStepUpdatedEvent · SnippetCatalogFilter · SnippetCatalogService · SnippetCatalogState · SnippetCatalogTagState · SomaBodyHeads · SomaBodyPresetId

SettingsExtensionPoints

宿主扩展点的可用提供者;按扩展点分组,新增扩展点时在这里加一段。

export type SettingsExtensionPoints = {
storage?: SettingExtensionPointProvider[];
exposer?: SettingExtensionPointProvider[];
temporaryHosting?: TemporaryHostingRouteView;
};

关联类型:SettingExtensionPointProvider · TemporaryHostingRouteView

成员说明:

  • storage:存储后端(storage.primary 的可选值)。
  • exposer:对外地址提供者(exposer.primary 的可选值)。
  • temporaryHosting:临时图床的权威路由快照(模式、候选、当前选择与最近真实失败)。

SettingsIssue

export type SettingsIssue = {
key: string;
layer: SettingsLayer;
message: string;
};

关联类型:SettingsLayer

SettingsLayer

export type SettingsLayer = "file" | "secrets" | "env";

SettingsOpenService

settings 插件提供的打开能力(capability 形状)。

export type SettingsOpenService = {
open: (input?: {
canvasId?: string | null;
section?: "backend" | "plugins" | "appearance" | "notifications" | "runtimes";
pluginId?: string;
}) => Promise<{
ok: true;
} | {
ok: false;
code: string;
reason: string;
}>;
};

成员说明:

  • open:打开设置弹窗。 section 落到左侧分区;pluginId 再往里一步直接打开该插件详情——扩展需要一个 「点击我的入口就到我自己的配置面」的动作时用它(例如顶栏的接入徽标),不必先让用户 在插件列表里自己找。插件不存在时退回到 section 对应的列表,不报错:设置里少一个 插件不是调用方该处理的异常。

SettingsPanelEditState

扩展面板可上报的编辑状态(均为可选;缺省 false)。

export type SettingsPanelEditState = {
dirty?: boolean;
pending?: boolean;
};

成员说明:

  • dirty:面板内是否有未保存输入。
  • pending:面板内是否有写/检测请求进行中。

SettingsPanelRenderProps

export type SettingsPanelRenderProps = {
requestClose?: () => void;
reportEditState?: (state: SettingsPanelEditState) => void;
};

关联类型:SettingsPanelEditState

成员说明:

  • requestClose:设置语境下的「返回插件列表」(经草稿门禁;不关闭设置)。
  • reportEditState:把面板的 dirty/pending 汇报给设置工作区(关闭、切分区与返回列表共用一个门禁)。

SettingsRemote

export type SettingsRemote = {
fetchSnapshot(): Promise<SettingsRemoteResult>;
setExtensionInstalled?(extensionId: string, installed: boolean): Promise<SettingsRemoteResult>;
write(values: Record<string, SettingsWriteValue>): Promise<SettingsRemoteResult>;
test?(values: Record<string, SettingsWriteValue>): Promise<SettingsTestRemoteResult>;
setExtensionToggle?(extensionId: string, enabled: boolean): Promise<SettingsRemoteResult>;
};

关联类型:SettingsRemoteResult · SettingsWriteValue · SettingsTestRemoteResult

成员说明:

  • setExtensionInstalled:安装/卸载一个扩展目录(改名,下一次启动生效);与启停无关。
  • test:测试配置项(不落盘)。
  • setExtensionToggle:写一个 browser-local 插件的启停目标状态:宿主把 extensions.<id>.enabled 写进配置文件,并热生效。

SettingsRemoteFailure

export type SettingsRemoteFailure = {
ok: false;
code: string;
error: string;
issues?: SettingsIssue[];
};

关联类型:SettingsIssue

SettingsRemoteResult

export type SettingsRemoteResult = {
ok: true;
snapshot: SettingsSnapshot;
} | SettingsRemoteFailure;

关联类型:SettingsSnapshot · SettingsRemoteFailure

SettingsSnapshot

export type SettingsSnapshot = {
safeMode?: HostSafeModeView | null;
installedExtensions?: InstalledExtensionView[];
extensionInstallations?: ExtensionInstallationsView;
settings: SettingsEntryView[];
plugins: SettingPluginView[];
extensionPoints?: SettingsExtensionPoints;
extensionToggles?: ExtensionToggles;
files: {
config: string;
secrets: string;
};
};

关联类型:HostSafeModeView · InstalledExtensionView · ExtensionInstallationsView · SettingsEntryView · SettingPluginView · SettingsExtensionPoints · ExtensionToggles

成员说明:

  • safeMode:安全模式;缺省或 null 表示正常启动。
  • extensionInstallations:受管安装概览;宿主未装配 Extension Manager 时缺省。
  • plugins:宿主插件树(基础层 / 核心层 / 扩展层);「插件配置」按它列出每个插件。
  • extensionPoints:宿主扩展点当前可用的提供者(例如已注册的存储后端);缺省表示宿主没有暴露注册表。
  • extensionToggles:扩展的启停状态(配置文件 extensions.<id>.enabled 的投影)。 缺省表示宿主没有提供该项(旧宿主):消费方按 manifest 默认值处理。

SettingsTestRemoteResult

export type SettingsTestRemoteResult = {
ok: true;
message: string;
} | {
ok: false;
error: string;
issues?: SettingsIssue[];
};

关联类型:SettingsIssue

SettingsWriteValue

export type SettingsWriteValue = string | number | boolean | null;

SiteAccessPolicy

站点管理授权提供者(site-access 拥有管理员名单与四个具名 action)。

export type SiteAccessPolicy = {
policyId: string;
policyVersion(): string;
allowedActions(input: {
principal: PrincipalContext;
}): Promise<readonly AccessAction[]>;
authorize(input: {
principal: PrincipalContext;
action: AccessAction;
}): Promise<AccessDecision>;
ready?(): boolean;
};

关联类型:PrincipalContext · AccessAction · AccessDecision

成员说明:

  • policyVersion:安全 policy 版本(可返回给当前用户;不含名单)。
  • allowedActions:当前用户自身允许的 action(用于界面资格;服务端仍重查)。
  • authorize:具名 action 决策;在副作用/查询前调用。
  • ready:provider 是否就绪;缺省视为就绪。

SkillMediaAttemptView

单个尝试的持久事实(owner 授权后的读模型)。

export type SkillMediaAttemptView = SkillMediaRunRef & {
runId: string;
requestId: string;
state: SkillMediaState;
current: boolean;
superseded: boolean;
supersededByAttempt?: number;
supersededByRunId?: string;
modelKey?: string;
jobId?: string;
mediaKind?: "text" | "image" | "video" | "audio" | "motion";
error?: string;
prompt?: string;
createdAt: string;
updatedAt: string;
settledAt?: string;
};

关联类型:SkillMediaRunRef · SkillMediaState

成员说明:

  • current:是否为步骤当前尝试。
  • superseded:是否已被同一步骤的更新尝试替代(即使 Provider 仍返回结果)。
  • error:安全错误摘要;不含堆栈、本机路径、provider 凭据或签名地址。
  • prompt:该尝试确认的提示词(历史核对用;事件与 MCP 输出不携带)。

SkillMediaRunRef

一次运行与 Skill 步骤的稳定关联(可放进 run 视图,不替代 run 身份)。

export type SkillMediaRunRef = {
skillRunId: string;
stepId: string;
attempt: number;
promptRevision: number;
};

SkillMediaState

export type SkillMediaState = (typeof SKILL_MEDIA_STATES)[number];

SkillMediaStepView

步骤快照:一个步骤多个尝试,只有一个 currentAttempt 指针。

export type SkillMediaStepView = {
canvasId: string;
nodeId: string;
rootGroupId?: string;
scopeEpoch?: number;
skillRunId: string;
stepId: string;
currentAttempt: number;
currentRunId?: string;
promptRevision: number;
latestSuccessfulRunId?: string;
latestSuccess?: {
attempt: number;
promptRevision: number;
runId: string;
};
attempts: readonly SkillMediaAttemptView[];
createdAt: string;
updatedAt: string;
};

关联类型:SkillMediaAttemptView

成员说明:

  • latestSuccess:最新成功尝试(可被显式回退使用;不代表当前尝试成功)。

SkillStepUpdatedEvent

步骤状态变化事件。

payload 只含身份、状态与安全摘要;禁止完整 prompt、storage key、签名地址与媒体 bytes。

export type SkillStepUpdatedEvent = {
type: typeof SKILL_STEP_EVENT_TYPE;
canvasId: string;
nodeId: string;
skillRunId: string;
stepId: string;
attempt: number;
promptRevision: number;
state: SkillMediaState;
current: boolean;
superseded: boolean;
runId?: string;
jobId?: string;
progress?: number;
supersededByAttempt?: number;
supersededByRunId?: string;
latestSuccessfulRunId?: string;
error?: string;
at: string;
};

关联类型:SkillMediaState

SnippetCatalogFilter

片段目录 capability 契约(由 prompt-snippets extension 提供;宿主 Context 只持有契约)。

增强属于对应 extension,宿主只公开契约供消费者按 capability key 查找;核心不 type-import 包内部实现。实现细节(防抖、serial、缓存)不在契约内。

export type SnippetCatalogFilter = "all" | "builtIn" | "untagged" | {
tagId: string;
};

SnippetCatalogService

export type SnippetCatalogService = {
getState(): SnippetCatalogState;
getTagState(): SnippetCatalogTagState;
subscribe(listener: () => void): () => void;
setQuery(query: string): void;
setFilter(filter: SnippetCatalogFilter): void;
loadMore(): Promise<void>;
refresh(): Promise<void>;
loadTags(): Promise<void>;
dispose(): void;
};

关联类型:SnippetCatalogState · SnippetCatalogTagState · SnippetCatalogFilter

SnippetCatalogState

export type SnippetCatalogState = {
status: "idle" | "loading" | "ready" | "error";
items: import("@woohaa3/contracts").PromptSnippet[];
total: number;
nextCursor: string | null;
loadingMore: boolean;
error: string | null;
query: string;
filter: SnippetCatalogFilter;
activeTagId: string | null;
counts: {
all: number;
builtIn: number;
untagged: number;
};
};

关联类型:PromptSnippet · SnippetCatalogFilter

SnippetCatalogTagState

export type SnippetCatalogTagState = {
status: "idle" | "loading" | "ready" | "error";
items: Array<import("@woohaa3/contracts").PromptSnippetTag & {
snippetCount: number;
}>;
error: string | null;
};

关联类型:PromptSnippetTag

SomaBodyHeads

Kept for reading v1 metadata; the quick picker no longer exposes head ratios.

export type SomaBodyHeads = 7 | 8 | 9 | 10;

SomaBodyPresetId

export type SomaBodyPresetId = `soma-body-v1/${SomaBodySex}-${SomaBodyHeads}-${'slim' | 'fat'}` | 'soma-body-v1/baby' | `soma-body-v1/${SomaBodySex}-${'child' | 'teen'}` | `soma-body-v2/${SomaBodySex}` | `soma-body-v2/${SomaBodySex}-${'newborn' | 'child' | 'old'}`;

关联类型:SomaBodySex · SomaBodyHeads