# @archastro/sdk 中文文档

规范地址：https://npmcn.com/package/%40archastro/sdk/

版本：0\.23\.0
npm 元数据更新时间：2026-11-03T20:38:36.167Z
中文译文更新时间：2026-11-06T14:17:39.008Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40archastro/sdk
原文对照：https://npmcn.com/package/%40archastro/sdk/?lang=original
项目主页：https://github.com/ArchAstro/archastro-js#readme
源码仓库：https://github.com/ArchAstro/archastro-js

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.1 MB，454 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：1 个
- peer 依赖：ws ^8\.17\.0
- 首次发布：2026-04-13T22:09:14.807Z
- 最新版本发布：2026-11-03T20:38:35.819Z
- 近 30 天下载量：216018（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 28 个）

## 中文简介

用于ArchAstro平台 API(节点、浏览器、回放原生)的 SDK 类型

## 安装

```sh
npm install @archastro/sdk
```

也可以使用：`pnpm add @archastro/sdk`、`yarn add @archastro/sdk`、`bun add @archastro/sdk`

## README

# @ archastro/ sdk

用于ArchAstro平台API的TypeScript SDK.

## 文档

API 参考文件公布于 [(原始内容存档于2013-10-12). archastro.github.io/archastro-js](https://archastro.github.io/archastro-js/)。 。 。 .

使用此站台分两层 :

-   将SDK接入应用程序、工人或 内部工具.
-   当您知道您需要的资源或方法时使用 API 引用 .

## 安装

```sh
npm install @archastro/sdk
```

## 选择一个自定义模式

大多数应用程序集成都使用可公布的API密钥外加用户访问令牌:

```ts
import { PlatformClient } from "@archastro/sdk";

const client = PlatformClient.withToken(
  process.env.ARCHASTRO_API_KEY ?? "",
  process.env.ARCHASTRO_ACCESS_TOKEN ?? "",
);
```

服务器侧面 Org bots 和工人也可以直接使用应用扫描的用户符:

```ts
const client = new PlatformClient({
  accessToken: process.env.ARCHASTRO_ACCESS_TOKEN,
});
```

设定 `baseUrl` 仅用于当地发展或进行:

```ts
import { PlatformClient } from "@archastro/sdk";

const client = PlatformClient.withToken(
  process.env.ARCHASTRO_API_KEY ?? "",
  process.env.ARCHASTRO_ACCESS_TOKEN ?? "",
  process.env.ARCHASTRO_PLATFORM_BASE_URL,
);
```

## 快速启动

```ts
const me = await client.users.me();
const teams = await client.teams.list();

console.log(me.id, me.email, teams);
```

## 反应原生/博览会

盒外的原生移动工程——节点 `ws` 编号 : `events` 多填充剂. 使用 **`PlatformClient.forApp`** 因此会话存储,无密码的检察官办公室,以及 自动更新停留在一个客户端后面( 不是平行会话帮助器) :

```ts
import { PlatformClient, ApiChatChannel, type SessionStorage } from "@archastro/sdk";

const client = PlatformClient.forApp({
  publishableKey: process.env.EXPO_PUBLIC_PUBLISHABLE_KEY!,
  baseUrl: process.env.EXPO_PUBLIC_API_BASE_URL!,
  storage, // your SessionStorage (SecureStore / AsyncStorage)
});

await client.restore();
// client.passwordless… → client.signIn(tokens, user)
await client.agents.list();
const socket = client.createSocket();
```

见 [反应原生指南](https://npmcn.com/package/%40archastro/sdk/docs/react-native.md)。 。 。 .

## 融合指南

-   [认证](https://npmcn.com/package/%40archastro/sdk/docs/authentication.md): 为 浏览器会话,服务器侧应用集成,以及org工人.
-   [反应原生/博览会](https://npmcn.com/package/%40archastro/sdk/docs/react-native.md): 会话存储, 无密码 auth,以及没有节点多填充的聊天频道.
-   [一体化设想](https://npmcn.com/package/%40archastro/sdk/docs/scenarios.md): 读取当前用户, 列表 制作一个有片段的特工 上面的片段经过烟雾测试 本地平台 dev 牵引.
-   [自定义对象协作](https://npmcn.com/package/%40archastro/sdk/docs/custom-object-collaboration.md): 团队拥有 对象、同源饼干认证、实时快照、重新连接 恢复,存在,和反应清理.

## 共同资源模式

资源直接挂起 `PlatformClient` 下 `client.v1`数字 :

```ts
await client.agents.list();
await client.agents.create({
  name: "Support triage",
  identity: "You triage support requests and keep replies concise.",
});
```

生成的 API 表面包括已键入的 REST 资源、 认证助手和 频道客户端. 下层凤凰频道客户端记录在 [`src/phx_channel/README.md`](https://npmcn.com/package/%40archastro/sdk/src/phx_channel/README.md)。 。 。 .

## 常见问题

### @archastro/sdk 是什么？

用于ArchAstro平台 API\(节点、浏览器、回放原生\)的 SDK 类型

### 如何安装 @archastro/sdk？

在项目目录运行 npm install @archastro/sdk，或使用 pnpm add / yarn add / bun add。

### @archastro/sdk 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @archastro/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @archastro/sdk 可以商用吗？

@archastro/sdk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @archastro/sdk 的下载量有多少？

根据 npm 官方下载统计，@archastro/sdk 在 2026/10/07 – 2026/11/05 这 30 天内被下载 216,018 次，日均约 7,201 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @archastro/sdk 还在维护吗？

最新版本 0\.23\.0 发布于 2026/11/04（3 天前）；至今共发布 28 个版本，其中过去 12 个月发布了 28 个；首次发布于 2026/04/14。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。