# @assembly-js/node-sdk 中文文档

规范地址：https://npmcn.com/package/%40assembly-js/node-sdk/

版本：4\.2\.4
npm 元数据更新时间：2026-10-06T16:58:17.428Z
中文译文更新时间：2026-11-07T00:15:21.540Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40assembly-js/node-sdk
原文对照：https://npmcn.com/package/%40assembly-js/node-sdk/?lang=original
项目主页：https://docs.assembly.com/
源码仓库：https://github.com/assemblycom/core

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

- 包体积（解压后）：706 kB，644 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18
- 运行依赖：0 个
- 首次发布：2026-01-28T21:16:07.465Z
- 最新版本发布：2026-10-06T16:58:17.252Z
- 近 30 天下载量：9211（2026-10-07 至 2026-11-05，npm 官方下载统计）
- 已发布版本数：15（近 12 个月 15 个）

## 中文简介

Ass.js 节点JS SDK

## 安装

```sh
npm install @assembly-js/node-sdk
```

也可以使用：`pnpm add @assembly-js/node-sdk`、`yarn add @assembly-js/node-sdk`、`bun add @assembly-js/node-sdk`

## README

# Assembly.js 节点 SDK

Assembly.js Node SDK为与Assembly REST API互动提供TypeScript所写的功能调用方便. 现在,这只是一个TypeScript软件包。 未来,我们将有一个Vanilla JS软件包,并配有相应的@types软件包.

此SDK仅用于服务器侧. 我们目前没有为客户方的发展提供一揽子方案.

## 对于 AI 编码代理

本节显示基于LLM的工具和与这个SDK合作的AI编码代理的关键资源.

-   完整 API 参考 : [https://docs.assembly.com/参考资料](https://docs.assembly.com/reference)
-   OpenAPI 规格 : [https://api.assembly.com/openapi.json 页面存档备份,存于互联网档案馆](https://api.assembly.com/openapi.json)

## 安装

```bash
npm install @assembly-js/node-sdk
# or
yarn add @assembly-js/node-sdk
```

## 设置

> **说明:** 从v4起, `assemblyApi()` 和必须调用 `await`。 。 。 .

### 自定义应用程序

```typescript
import { assemblyApi } from '@assembly-js/node-sdk';

const assembly = await assemblyApi({ apiKey: YOUR_API_KEY_HERE });
```

### 市场应用程序

如果您正在构建一个 Marketplace 应用程序, 您应该经过一个额外的步骤, 获取一个查询参数, 当在仪表盘中提供时, 它会传递到 App URL: `?token=TOKEN_IS_HERE`

从 URL 中取出该令牌并将其传递到 Api 配置对象 .

```typescript
import { assemblyApi } from '@assembly-js/node-sdk';

const assembly = await assemblyApi({
  apiKey: YOUR_API_KEY_HERE,
  token: searchParams.token,
});
```

## 从副驾驶-节点-sdk迁移

如果你正在迁徙 从 `copilot-node-sdk`,需要进行下列修改:

### 软件包安装

```bash
# Remove old package
npm uninstall copilot-node-sdk

# Install new package
npm install @assembly-js/node-sdk
```

### 代码更改

```typescript
// Before
import { copilotApi } from 'copilot-node-sdk';
const copilot = copilotApi({ apiKey: YOUR_API_KEY });

// After (note: assemblyApi is async since v4)
import { assemblyApi } from '@assembly-js/node-sdk';
const assembly = await assemblyApi({ apiKey: YOUR_API_KEY });
```

### 环境变量

| 旧变量 | 新建变量 | 页:1 |
| --- | --- | --- |
| `COPILOT_ENV` | `ASSEMBLY_ENV` | 两项工作,新工作优先 |
| `COPILOT_DEBUG` | `ASSEMBLY_DEBUG` | 两项工作,新工作优先 |

### 后向兼容性

为了逐渐地迁移,旧名仍可取取而代之:

```typescript
// These still work but are deprecated
import { copilotApi, type CopilotAPI } from '@assembly-js/node-sdk';
```

## 如何在内部开发此软件包 :

1.  `yarn`
2.  `yarn generate-api`
3.  `yarn test` \* 提出成功的对策
4.  `yarn test:fail` 生成一个因缺少嵌入变量而失败的响应.

对于额外的日志, 您可以设置环境变量 `ASSEMBLY_DEBUG` 任何真实价值。 如果您想在应用程序的代码库中开发时看到 SDK 日志,这个是有用的.

## 外地折旧

### 折旧的字段

以下字段已贬值,并将在未来版本的 SDK 中被去除:

#### `companyId` (在v3.1.5.0中折旧)

-   **替换**: 使用 `companyIds` 数组代替
-   **原因**: 支持多公司的功能
-   **受影响的终点**: 客户端操作, App 连接,任务

#### `recipientId` (在v3.1.5.0中折旧)

-   **替换**: 使用 `clientId` 财务报告和审定财务报表 `companyId` 换成
-   **原因**: 更明确的受援方目标
-   **受影响的终点**合同、发票、通知、订阅

### 移徙指南

**在( 折旧 ) 之前 :**

```typescript
// Creating a client with single company
await assembly.createClient({
  companyId: 'company-uuid-here',
  // ... other fields
});

// Creating an invoice with recipient ID
await assembly.createInvoice({
  recipientId: 'recipient-uuid-here',
  // ... other fields
});
```

**在(建议):**

```typescript
// Creating a client with multiple companies support
await assembly.createClient({
  companyIds: ['company-uuid-here'], // Now an array
  // ... other fields
});

// Creating an invoice with explicit client and company targeting
await assembly.createInvoice({
  clientId: 'client-uuid-here',
  companyId: 'company-uuid-here',
  // ... other fields
});
```

### 开发者经验

使用被贬值的字段时,可以看到:

-   **IDE 警告**: TypeScript 将在编辑器中显示折旧警告
-   **联合来文说明**: 逾越已荒芜的田地,看移民指南
-   **继续功能**: 折旧后田地继续工作,直至拆除

## 常见问题

### @assembly-js/node-sdk 是什么？

Ass\.js 节点JS SDK

### 如何安装 @assembly-js/node-sdk？

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

### @assembly-js/node-sdk 支持 TypeScript 吗？

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

### @assembly-js/node-sdk 支持 ESM 还是 CommonJS？

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

### @assembly-js/node-sdk 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @assembly-js/node-sdk 可以商用吗？

@assembly-js/node-sdk 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @assembly-js/node-sdk 的下载量有多少？

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

### @assembly-js/node-sdk 还在维护吗？

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