Skip to content

TypeScript SDK 参考

@dotcraft/sdk 的包标识与语言特定细节。如何使用请从快速开始入手。

包名@dotcraft/sdk(npm)
模块格式ESM("type": "module"
运行时基线Node.js 20+
版本从包导出的 versionsdkContractVersion
bash
npm install @dotcraft/sdk

入口点

包按 subpath export 拆分,应用只引入所需部分:

入口点用途
@dotcraft/sdk高层应用 API(DotCraftDotCraftThread、run、events)。
@dotcraft/sdk/wire低层 JSON-RPC 客户端、传输、raw DTO。
@dotcraft/sdk/hubHub 发现、启动与 SSE 辅助。
@dotcraft/sdk/channel渠道适配器与托管模块 runtime。
@dotcraft/sdk/testing一致性测试辅助。

顶层导出

DotCraftDotCraftThreadDotCraftRunResultDotCraftRunEventDotCraftError、typed error 类(TurnInProgressErrorTurnFailedError 等)、输入 part 构造器(textPartimageUrlPartlocalImagePartskillRefPartcommandRefPartfileRefPart)、App Binding 辅助(parseAppBindingHandoffappBindingToolErrorAPP_BINDING_ERROR_CODES),以及审批决策常量。

渠道模块

TypeScript 拥有一方托管渠道模块,均依赖 @dotcraft/sdk

@dotcraft/channel-feishu@dotcraft/channel-weixin@dotcraft/channel-telegram@dotcraft/channel-qq@dotcraft/channel-wecom。参见渠道适配器

验证

bash
cd sdk/typescript
npm run typecheck:all
npm run test:all

参见

Apache License 2.0