ariestools-sdk

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Aries Tools SDK

Aries Tools SDK

Authority. This skill is maintained only in
ariestools/ariestools-skills
; edit there, not in installed copies.
Use the active packages from
ariestools/sdk-js
under the
@ariestools/*
scope. Do not install retired
@xylabs/*
utility names for new work, nor the frozen
@ariestools/{indexed-db,mongo,vitest-matchers,vitest-extended}
8.0.3 packages that npm deprecation notices point to. Prefer existing repository dependencies and versions; pin according to the consuming repo.
Scope. Only packages published from sdk-js. React work on
@ariestools/sdk-react*
belongs to ariestools-sdk-react. Actors, providers and their CLI and browser hosts (
@ariestools/actor*
,
@ariestools/provider*
,
@ariestools/cli-kit*
,
@ariestools/browser-kit*
) belong to ariestools-actor. Neither covers
@ariestools/cli
, the
aries
operator CLI. Toolchain and config packages belong to xy-toolchain.
Runtime. This skill describes sdk-js 9.x, whose packages declare
engines.node >=26
, above the toolchain's own Node 22 floor; see Runtime baseline.
Skill identity. When you present a plan, an acknowledgement, or a completion summary, state which skills informed it as
ariestools-sdk v<version>
, and list each other active skill from this pack the same way. Read the version from this file's
metadata.version
, never from an example.
维护来源。 此 skill 仅在
ariestools/ariestools-skills
中维护;请在该仓库中编辑,而不要修改已安装的副本。
请使用
ariestools/sdk-js
中
@ariestools/*
scope 下的活跃 packages。新工作不要安装已退役的
@xylabs/*
utility 名称,也不要安装 npm 弃用通知所指向的冻结版
@ariestools/{indexed-db,mongo,vitest-matchers,vitest-extended}
8.0.3 packages。优先沿用现有 repository 的 dependencies 和 versions;并根据使用方 repository 锁定版本。
范围。 仅包括从 sdk-js 发布的 packages。
@ariestools/sdk-react*
上的 React 工作属于 ariestools-sdk-react。Actors、providers 及其 CLI 和 browser hosts(
@ariestools/actor*
、
@ariestools/provider*
、
@ariestools/cli-kit*
、
@ariestools/browser-kit*
)属于 ariestools-actor。上述两部分均不涵盖
@ariestools/cli
,即
aries
operator CLI。Toolchain 和 config packages 属于 xy-toolchain。
运行环境。 此 skill 描述 sdk-js 9.x,其 packages 声明
engines.node >=26
,高于 toolchain 自身的 Node 22 下限;请参阅 Runtime baseline。
Skill 标识。 当你展示计划、确认结果或完成总结时,请说明哪些 skills 为其提供了依据,使用
ariestools-sdk v<version>
的形式,并将本 pack 中其他每个 active skill 也按相同方式列出。版本必须从此文件的
metadata.version
读取,绝不能从示例中读取。

References

参考文档

Overview and install

概览与安装

Read first when choosing the umbrella vs specialist packages, installing
@ariestools/sdk
(with
zod
and
@opentelemetry/api
, which the root barrel loads at runtime), checking the Node >= 26 runtime baseline, or replacing retired
@xylabs/*
and frozen 8.x
@ariestools/*
names via the migration map.
以下情况请首先阅读本文:选择总括包还是专用包;安装
@ariestools/sdk
(包含
zod
和
@opentelemetry/api
,root barrel 会在运行时加载它们);检查 Node >= 26 runtime baseline;或通过 migration map 替换已退役的
@xylabs/*
和冻结的 8.x
@ariestools/*
名称。

Umbrella modules

总括包模块

Read when picking a utility inside
@ariestools/sdk
(assert, delay, fetch, forget, hex, promise, retry, storage, typeof, logger, …), looking up a module's subpath or
/model
types, or using platform-conditional modules (
platform
,
url
,
subtle
).
在
@ariestools/sdk
中选择工具函数(assert、delay、fetch、forget、hex、promise、retry、storage、typeof、logger、…)、查找模块的 subpath 或
/model
types,或使用按平台区分的 modules(
platform
、
url
、
subtle
)时,请阅读本文。

Specialist packages

专用包

Read when you need Express helpers, IndexedDB/Mongo adapters, threads/workers, testing matchers, telemetry, crypto-auth, eth-address (
EthAddressWrapper
), pixel, json-rpc-engine, or sdk-meta (server-side HTML head / OpenGraph / Twitter meta) — packages that are not fully replaced by the main umbrella install alone. Also covers each package's runtime (Node, browser, or both) and dependency placement.
需要 Express helpers、IndexedDB/Mongo adapters、threads/workers、testing matchers、telemetry、crypto-auth、eth-address(
EthAddressWrapper
)、pixel、json-rpc-engine 或 sdk-meta(服务端 HTML head / OpenGraph / Twitter meta)时,请阅读本文。这些 packages 并非仅靠安装主 umbrella 包就能完全替代。本节还涵盖每个 package 的运行环境(Node、browser 或两者)以及依赖项的放置方式。

Fetch and HTTP

Fetch 与 HTTP

Read when calling
fetchJson
/
FetchClient
, setting request options or handling results and
FetchError
s, bounding or cancelling response reads (
maxResponseBytes
,
signal
, client
timeout
,
readResponseText
), injecting a custom fetcher, or configuring Node HTTP caching with Undici (consumer-owned).
调用
fetchJson
/
FetchClient
、设置 request options 或处理 results 与
FetchError
s、限制或取消 response reads(
maxResponseBytes
、
signal
、client
timeout
、
readResponseText
)、注入自定义 fetcher,或使用 Undici 配置 Node HTTP caching(由 consumer 自行维护)时,请阅读本文。

Conventions

约定

Read for import style (root barrel vs subpaths), ESM only, tree-shaking, deprecations (telemetry re-exports,
@ariestools/crypto
, retired 8.x package names, API-level deprecations), how this monorepo relates to the
xy
toolchain (including the monolith layout for maintainers), testing consumers, and the checklist for new code.
需要了解 import style(root barrel 与 subpaths)、仅支持 ESM、tree-shaking、弃用项(telemetry re-exports、
@ariestools/crypto
、已退役的 8.x package names、API-level deprecations)、本 monorepo 与
xy
toolchain 的关系(包括面向 maintainers 的 monolith layout)、testing consumers,以及新代码 checklist 时,请阅读本文。

Related skills

相关 skills

  • xy-development — TypeScript, Git, testing principles and the Definition of Done; this skill builds on it. Install:
    npx skills add ariestools/ariestools-skills --skill xy-development
    .
  • xy-toolchain — the
    xy
    CLI, configs, Vitest, deplint and package policy that sdk-js packages and their consumers build with; this skill builds on it. Install:
    npx skills add ariestools/ariestools-skills --skill xy-toolchain
    .
  • ariestools-sdk-react — React UI on
    @ariestools/sdk-react*
    , which imports this SDK's root barrel without declaring it and uses
    @ariestools/pixel
    and
    @ariestools/eth-address
    ; it builds on this skill. Install:
    npx skills add ariestools/ariestools-skills --skill ariestools-sdk-react
    .
  • ariestools-actor — actors, providers and the actor engine from actor-kit, hosted by cli-kit or browser-kit, which build on this SDK's
    creatable
    and logger utilities; it builds on this skill. Install:
    npx skills add ariestools/ariestools-skills --skill ariestools-actor
    .
If a linked skill is not installed, add it with
npx skills add ariestools/ariestools-skills --skill <name>
.
  • xy-development — TypeScript、Git、testing principles 和 Definition of Done;本 skill 建立在它之上。安装:
    npx skills add ariestools/ariestools-skills --skill xy-development
    。
  • xy-toolchain —
    xy
    CLI、configs、Vitest、deplint 和 package policy,sdk-js packages 及其 consumers 均使用它们构建;本 skill 建立在它之上。安装:
    npx skills add ariestools/ariestools-skills --skill xy-toolchain
    。
  • ariestools-sdk-react — 基于
    @ariestools/sdk-react*
    的 React UI。它导入此 SDK 的 root barrel,但未声明该依赖,并使用
    @ariestools/pixel
    和
    @ariestools/eth-address
    ;它建立在本 skill 之上。安装:
    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 utilities 构建;它建立在本 skill 之上。安装:
    npx skills add ariestools/ariestools-skills --skill ariestools-actor
    。
如果未安装链接中的 skill,请使用
npx skills add ariestools/ariestools-skills --skill <name>
添加。