跳转至

导入路径

如何挑选最窄的有文档子路径,以及已移除通道门面的逐导出映射。本指南是 插件 SDK 迁移 指南的一部分。

导入路径参考

使用从 SDK 概览 链接的主题 SDK 指南,并优先选择最窄的有文档的类型化公开子路径。在 package.json 中,这些子路径同时具有 types 和 default 导出目标。

scripts/lib/plugin-sdk-entrypoints.json 中的编译器清单还包含私有本地条目。它们的分类维护在 scripts/lib/plugin-sdk-private-local-only-subpaths.json 中。生产私有条目可能为捆绑或单独发布的官方插件提供仅 JavaScript 的 default 导出,但其声明被排除在包之外。运行时导出或源文件不是类型化第三方 SDK 契约。

本页中的映射是迁移子集,而非完整的 SDK 范围。在替换导入之前,请检查公开子路径及其实际的命名导出。

保留的捆绑插件辅助接缝(包括 plugin-sdk/discord 和 plugin-sdk/telegram-account 兼容门面)已从公共 SDK 导出映射中退役。所有者特定的辅助函数位于拥有它们的插件包内;共享宿主行为通过通用 SDK 契约传递,例如 plugin-sdk/gateway-runtime、plugin-sdk/security-runtime 和注入的插件 API。

使用与任务匹配的最窄导入。如果找不到某个导出,请检查 src/plugin-sdk/ 中的源代码,或询问维护者哪个通用契约应拥有它。

已移除的命令和通道门面

command-auth、discord 和 telegram-account 子路径已于 2026 年 10 月 2 日在获得 SDK 所有者明确批准后退役。请使用以下替代方案:

已移除的表面 替代方案
command-auth 发送者授权辅助函数和运行时参数类型 来自 channel-ingress-runtime 的 resolveChannelMessageIngress;将调用方适配到入口契约,而不是重新创建旧版允许列表策略。
command-auth 原生命令解析、规范、授权和会话目标辅助函数 command-auth-native 中对应的命名导出。
command-auth 帮助构建器 来自 command-status 的 buildCommandsMessage、buildCommandsMessagePaginated 和 buildHelpMessage。
command-auth 模型提供商数据辅助函数 models-provider-runtime 中对应的命名导出。
command-auth 访问组辅助函数 将发送者授权委托给 channel-ingress-runtime;access-groups 是私有本地的,不是第三方替代方案。
command-auth 直接私信访问辅助函数 channel-inbound 中对应的命名导出。
discord 通用通道类型和辅助函数 channel-contract、channel-core、channel-plugin-common、channel-status 或 config-contracts 中对应的命名导出。
discord 通道拥有的辅助函数和类型 仓库使用者使用 Discord 插件的 api.ts / runtime-api.ts;外部插件使用通用通道契约和注入的运行时。
telegram-account 账户解析和类型 仓库使用者使用 Telegram 插件的 api.ts;外部插件使用通用通道契约和注入的运行时辅助函数。

在更改导入之前,请检查每个命名导出。旧版发送者授权类型和 Discord 门面的宽松组件/线程绑定类型已被移除;所属 API 有各自的契约。一些旧版导出没有类型化公开替代方案,需要调用方更改。不要将它们替换为私有本地宿主导出或另一个插件的私有 src/* 文件。导入这些门面的旧版已发布包必须在加载到包含此移除的宿主之前进行升级;SDK 所有者批准不是外部迁移的证据。

已移除的通道门面映射

已移除的通道门面不能与 channel-outbound 互换。请分别迁移每个函数和类型。

对于 openclaw/plugin-sdk/channel-reply-pipeline,请使用来自 openclaw/plugin-sdk/channel-outbound 的以下导出:

旧版导出 现代导出
createChannelReplyPipeline createChannelMessageReplyPipeline
resolveChannelSourceReplyDeliveryMode resolveChannelMessageSourceReplyDeliveryMode
createReplyPrefixContext、createReplyPrefixOptions、createTypingCallbacks 相同名称
新版导出 新版导出

这些函数保留了原外观(facade)的实现。它们的命名类型也保持不变,可从 channel-outbound 中获取: ChannelReplyPipeline、CreateTypingCallbacksParams、ReplyPrefixContext、 ReplyPrefixContextBundle、ReplyPrefixOptions、SourceReplyDeliveryMode 和 TypingCallbacks。

从 openclaw/plugin-sdk/channel-lifecycle 中,以下函数将原样迁移到 channel-outbound:createAccountStatusSink、createChannelRunQueue、 keepHttpServerTaskAlive、runPassiveAccountLifecycle、waitUntilAbort、 createDraftStreamLoop、createFinalizableDraftLifecycle、 createFinalizableDraftStreamControls、 createFinalizableDraftStreamControlsForState、clearFinalizableDraftMessage、 takeMessageIdAfterStop、createRunStateMachine 和 createArmableStallWatchdog。

命名类型 ChannelRunQueue、ChannelRunQueueParams、 ChannelRunQueueTaskContext、DraftStreamLoop、FinalizableDraftStreamState、 ArmableStallWatchdog 和 StallWatchdogTimeoutMeta 也原样迁移到 channel-outbound。

用 defineFinalizableLivePreviewAdapter 和 deliverWithFinalizableLivePreviewAdapter 替换 deliverFinalizableDraftPreview。 将预览回调移入 adapter,并处理带有 kind 和可选 liveState 的对象结果, 而不是旧版字符串结果。适配器可以返回 preview-retained;已移除的包装器将该 kind 映射为 normal-skipped。

旧版名称 DraftPreviewFinalizerDraft 和 DraftPreviewFinalizerResult 已移除。请将类型用法适配到聚焦的实时预览契约,并考虑结果形状的变化。

对于 openclaw/plugin-sdk/channel-message,将出站导出原样迁移到 channel-outbound,但将其三个分发别名迁移到 openclaw/plugin-sdk/channel-inbound:

旧版导出 新版入站导出
hasFinalChannelTurnDispatch hasFinalInboundReplyDispatch
hasVisibleChannelTurnDispatch hasVisibleInboundReplyDispatch
resolveChannelTurnDispatchCounts resolveInboundReplyDispatchCounts

这些别名共享其实现和签名。有关出站契约,请参阅 Channel outbound API。

本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 cl/openclaw