关于 ariestools-sdk
面向使用 Aries Tools JavaScript SDK 的开发者的技能,说明 sdk-js 9.x 的包选择、运行环境与使用约定。内容限定于 sdk-js 发布的包,并区分 React、Actor、CLI 和工具链等相关技能的职责。
主要功能
- 01梳理 sdk-js 包与模块选择
- 02说明 Node.js 运行环境要求
- 03涵盖请求与 HTTP 处理
- 04提供专用包和平台模块指引
- 05标注弃用包与迁移边界
适用场景
- 01为项目选择合适的 SDK 包
- 02将旧版或弃用包迁移到当前包
- 03处理 JSON 请求与响应错误
- 04确认包的运行环境和导入方式
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ ariestools/ ariestools-skills --skill ariestools-sdk安装后在 Claude Code 中输入/ariestools-sdk确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
conventions.mdfetch.mdmodules.mdoverview.mdpackages.md详细介绍
Aries Tools SDK
权威来源。 此技能仅在 ariestools/ariestools-skills 中维护;请在该仓库中编辑,而不要修改已安装的副本。
请使用 ariestools/sdk-js 中以 @ariestools/* 为作用域的有效软件包。新项目中不要安装已退役的 @xylabs/* 工具名称,也不要安装 npm 弃用通知指向的冻结版 @ariestools/{indexed-db,mongo,vitest-matchers,vitest-extended} 8.0.3 软件包。优先使用仓库中已有的依赖和版本;根据使用方仓库锁定版本。
范围。 仅涵盖从 sdk-js 发布的软件包。@ariestools/sdk-react* 的 React 工作属于 ariestools-sdk-react。Actor、provider 及其 CLI 和浏览器宿主(@ariestools/actor*、@ariestools/provider*、@ariestools/cli-kit*、@ariestools/browser-kit*)属于 ariestools-actor。这两者都不涵盖 @ariestools/cli,即 aries 操作员 CLI。工具链和配置软件包属于 xy-toolchain。
运行时。 本技能介绍 sdk-js 9.x,其软件包声明 engines.node >=26,高于工具链自身要求的 Node 22 最低版本;请参阅运行时基线。
技能身份。 提交计划、确认或完成摘要时,请注明为其提供依据的技能,格式为 ariestools-sdk v<version>,并以相同格式列出此技能包中的其他每项有效技能。版本请从此文件的 metadata.version 中读取,切勿使用示例中的版本。
参考资料
概览与安装
在选择综合软件包还是专用软件包、安装 @ariestools/sdk(其根导出模块在运行时会加载 zod 和 @opentelemetry/api)、查看 Node >= 26 运行时基线,或通过迁移对照表替换已退役的 @xylabs/* 和冻结的 8.x @ariestools/* 名称时,请先阅读此文档。
综合模块
在选择 @ariestools/sdk 中的工具(assert、delay、fetch、forget、hex、promise、retry、storage、typeof、logger 等)、查找模块的子路径或 /model 类型,或使用依平台而异的模块(platform、url、subtle)时,请阅读此文档。
专用软件包
当你需要 Express 辅助工具、IndexedDB/Mongo 适配器、线程/工作线程、测试匹配器、遥测、crypto-auth、eth-address(EthAddressWrapper)、pixel、json-rpc-engine 或 sdk-meta(服务端 HTML head / OpenGraph / Twitter 元数据)时,请阅读此文档——这些软件包无法仅通过安装主综合软件包完全替代。文档还介绍了各软件包的运行环境(Node、浏览器或两者皆可)和依赖项配置位置。
Fetch 与 HTTP
调用 fetchJson / FetchClient、设置请求选项或处理结果和 FetchError、限制或取消响应读取(maxResponseBytes、signal、客户端 timeout、readResponseText)、注入自定义 fetcher,或使用 Undici 配置 Node HTTP 缓存(由使用方负责)时,请阅读此文档。
约定
有关导入风格(根导出模块与子路径)、仅支持 ESM、tree-shaking、弃用事项(遥测重新导出、@ariestools/crypto、已退役的 8.x 软件包名称、API 级弃用)、此 monorepo 与 xy 工具链的关系(包括维护者使用的单体仓库布局)、测试使用方以及新增代码检查清单,请阅读此文档。
相关技能
- xy-development — TypeScript、Git、测试原则和完成定义;此技能以其为基础。安装:
npx skills add ariestools/ariestools-skills --skill xy-development。 - xy-toolchain —
xyCLI、配置、Vitest、deplint 和包策略;sdk-js 包及其使用者基于这些内容构建,此技能以其为基础。安装:npx skills add ariestools/ariestools-skills --skill xy-toolchain。 - ariestools-sdk-react — 基于
@ariestools/sdk-react*的 React UI,它导入此 SDK 的根导出文件但不声明该 SDK,并使用@ariestools/pixel和@ariestools/eth-address;此技能以其为基础。安装:npx skills add ariestools/ariestools-skills --skill ariestools-sdk-react。 - ariestools-actor — actor-kit 中的 actors、providers 和 actor engine,由 cli-kit 或 browser-kit 承载;它们基于此 SDK 的
creatable和 logger 工具,此技能以其为基础。安装:npx skills add ariestools/ariestools-skills --skill ariestools-actor。
如果未安装链接的技能,请使用 npx skills add ariestools/ariestools-skills --skill <name> 添加。