跳转到内容

Extension API 参考

本参考从当前源码的公共 TypeScript 声明自动生成,每次官网构建都会更新。签名中的 ? 表示可选成员;返回 () => void 的注册方法提供注销函数。React、Cordis 等外部类型遵循其各自的包定义。

UI 组件与图标从 @woohaa3/ui 或批准的 JS 子路径具名导入;宿主函数、Context 与业务能力从 @woohaa3/frontend/extension-api 导入。扩展的 UI CSS 由宿主供给,扩展不得导入样式或私有路径。旧 SDK UI 导出保留同实例兼容。宿主服务通过插件 Context 注入。服务是否存在取决于当前 scope 和提供它的插件,声明 inject 后再访问。

import { defineExtensionPlugin } from "@woohaa3/frontend/extension-api";
export const plugin = defineExtensionPlugin(ctx => {
const dispose = ctx.slots.register("canvas.overlay", {
id: "example-overlay", owner: "example",
render: () => null
});
ctx.effect(() => dispose);
}, { name: "example", inject: ["slots"] });

canvas.node-template 注册创建入口;复合资产的渲染还需要 ctx.compositeAssets.register()。Slots、渲染适配器与后端定义是独立的注册协议。

接口组 条目数
Context 注入服务 46
Slots 贡献协议 32
前端事件 payload 10
公共 UI 组件与主题桥:ASSISTANT_SETUP_HINT – AsyncConfirmResult 24
公共 UI 组件与主题桥:AudioPlayer – CollapsibleRoot 24
公共 UI 组件与主题桥:CollapsibleTrigger – DialogSurfaceProps 24
公共 UI 组件与主题桥:DialogSurfaceRadixContentProps – FilmIcon 24
公共 UI 组件与主题桥:FitScreenIcon – LoadingIcon 24
公共 UI 组件与主题桥:LocateIcon – MusicIcon 24
公共 UI 组件与主题桥:MuteIcon – ScrollAreaProps 24
公共 UI 组件与主题桥:SearchIcon – TextInput 24
公共 UI 组件与主题桥:Theme – ZoomOutIcon 24
公共 UI 组件与主题桥:buttonClassName – useThemeService 15
前端 SDK 导出:AGENT_CONVERSATION_SERVICE – AlignBottomIcon 24
前端 SDK 导出:AlignCenterXIcon – AssistantDraftValue 24
前端 SDK 导出:AssistantInputResult – CanvasEditService 24
前端 SDK 导出:CanvasLocateService – ClockIcon 24
前端 SDK 导出:CloseIcon – DialogFooter 24
前端 SDK 导出:DialogHeader – DialogsService 24
前端 SDK 导出:DiamondIcon – ExtensionAppPageEntry 24
前端 SDK 导出:ExtensionAppPageMetadata – HandIcon 24
前端 SDK 导出:HistoryIcon – LockIcon 24
前端 SDK 导出:LogsIcon – MentionEditorProps 24
前端 SDK 导出:MentionSelectionApi – ModelSubmitOutcome 24
前端 SDK 导出:MoonIcon – Plugin 24
前端 SDK 导出:PluginIcon – SelectInput 24
前端 SDK 导出:SelectionService – TabItem 24
前端 SDK 导出:Tabs – TypeIcon 24
前端 SDK 导出:UPLOAD_ACCEPT – buildUploadedAsset 24
前端 SDK 导出:buildUploadedTextAsset – rectangularNodeResize 24
前端 SDK 导出:resolveAgentDetailAction – useThemeService 16
后端 web-contracts-src-extension-plugin 7
后端 web-contracts-src-extension-service:AgentAuthoringToolContribution – ApplicationExtensionMediaResourcesFacade 24
后端 web-contracts-src-extension-service:ApplicationExtensionMediaVerifyResult – ExtensionExecutorEvent 24
后端 web-contracts-src-extension-service:ExtensionExecutorModule – HostExtensionContext 24
后端 web-contracts-src-extension-service:HostGenerationService – MarketplaceSource 24
后端 web-contracts-src-extension-service:MediaFormatRegistry – TaskNotificationPermission 24
后端 web-contracts-src-extension-service:TaskNotificationPreferences – isStorageObjectNotFoundError 22
后端 web-contracts-src-backend:BackendAgentCanvasPort – ChatGptProgressEvent 24
后端 web-contracts-src-backend:ChatGptReasoningEffort – MarketplaceFailureCode 24
后端 web-contracts-src-backend:MarketplaceSigningKey – sameHostInstance 15
后端 web-contracts-src-backend-generation-models-dto 5
后端 web-contracts-src-extension-host-runtime 16
后端 web-contracts-src-extension-services:AgentAuthoringToolContribution – ApplicationExtensionMediaResourcesFacade 24
后端 web-contracts-src-extension-services:ApplicationExtensionMediaVerifyResult – ExtensionExecutorEvent 24
后端 web-contracts-src-extension-services:ExtensionExecutorModule – HostExtensionContext 24
后端 web-contracts-src-extension-services:HostGenerationService – MarketplaceSource 24
后端 web-contracts-src-extension-services:MediaFormatRegistry – TaskNotificationPermission 24
后端 web-contracts-src-extension-services:TaskNotificationPreferences – isStorageObjectNotFoundError 22
后端 web-contracts-src-extension-host-http 16
后端 web-contracts-src-extension-assistant-authoring 10
后端 web-contracts-src-canvas-content-runtime 1
Provider SDK 7
签名关联类型:Aabb – AgentModelCapabilitySource 24
签名关联类型:AgentModelView – AgentRoleRequirements 24
签名关联类型:AgentRoleStructuredOutput – ApplicationExtensionHost 24
签名关联类型:ApplicationExtensionHostIdentity – AssistantWorldContextView 24
签名关联类型:AssistantWorldFailure – BevyEdgeHover 24
签名关联类型:BevyFocusTransition – BooleanSettingDefinition 24
签名关联类型:CameraAspect – CanvasGenerationHistoryListPage 24
签名关联类型:CanvasJournalEntry – CanvasOperationState 24
签名关联类型:CanvasPanelDefinition – CanvasTaskInput 24
签名关联类型:CanvasTaskInputBinding – ConversationEventType 24
签名关联类型:ConversationMessage – EditCompletionStatus 24
签名关联类型:EditFieldSnapshot – ExtensionDocumentRead 24
签名关联类型:ExtensionDocumentScanPage – FocusLayoutSource 24
签名关联类型:FocusMediaLease – GizmoHandleName 24
签名关联类型:GizmoHitResult – ImageEditTool 24
签名关联类型:ImageFocusDetails – ManagedNodeMigrationAdapter 24
签名关联类型:McpBuiltinDiscoveryView – ModelScriptReport 24
签名关联类型:ModelStaticPoseSummary – NativeImageResource 24
签名关联类型:NodeActionActivation – NodeRunStateProjection 24
签名关联类型:NotificationServiceHandle – PrincipalContext 24
签名关联类型:ProbeCandidate – ResourcePermission 24
签名关联类型:ResourceRef – SceneAreaPlanRequest 24
签名关联类型:SceneAreaPlanRequestBase – SelectorProps 24
签名关联类型:ServerCanvas – SettingsEntryView 24
签名关联类型:SettingsExtensionPoints – SomaBodyPresetId 24
签名关联类型:SomaBodySex – TaskExecutionEvent 24
签名关联类型:TaskExecutionSource – TaskResultSummary 24
签名关联类型:TaskSubmitRequest – TelemetryWindow 24
签名关联类型:TextureUploadSource – Woohaa3CanvasJsonObject 24
签名关联类型:Woohaa3CanvasJsonPrimitive – WorldAuthoringHistoryOutcome 24
签名关联类型:WorldAuthoringNodeSnapshot – WorldCameraShotPhase 24
签名关联类型:WorldCameraShotState – WorldPoint 24
签名关联类型:WorldPreparedAuthoritySnapshot – WorldVersion 23

后端宿主与画布内容端口从 @woohaa3/contracts 导入,通过扩展声明的工厂接入;@woohaa3/provider-sdk 仅供本机宿主的 Provider 扩展使用。「签名关联类型」解释参数与返回值,不代表这些类型都可以从前端 SDK 单独导入。