# @nemphi/sdk 中文文档

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

版本：0\.2\.4682
npm 元数据更新时间：2026-11-01T23:19:20.260Z
中文译文更新时间：2026-11-01T23:48:31.918Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40nemphi/sdk
原文对照：https://npmcn.com/package/%40nemphi/sdk/?lang=original
项目主页：https://github.com/nemphi/sekai/tree/master/packages/sdk
源码仓库：https://github.com/nemphi/sekai

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

- 包体积（解压后）：820 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=20
- 运行依赖：0 个
- 首次发布：2026-04-17T18:15:29.745Z
- 最新版本发布：2026-11-01T23:19:19.963Z
- 已发布版本数：8（近 12 个月 8 个）

## 中文简介

用于Nemphi API的类型化TypeScript客户端——授权、工具和产品使用的相同管道

## 安装

```sh
npm install @nemphi/sdk
```

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

## README

# `@nemphi/sdk`

的类型化TypeScript客户端 [Nemphi](https://nemphi.com/) API。零运行时 依赖关系。它使用平台 `fetch`． 业务工具调用使用 与产品UI相同的租户范围、策略、幂等性和操作分类账。

## 安装

```bash
npm install @nemphi/sdk
# or: pnpm add @nemphi/sdk / yarn add @nemphi/sdk
```

需要Node 20+（或任何带有global的运行时） `fetch`）。

## 快速启动

```ts
import { createClient } from "@nemphi/sdk";

const nemphi = createClient({
  baseUrl: "https://api.nemphi.com",
  // API key (nk_…) is tenant-bound. Session tokens (nse_…) also need tenantId.
  token: process.env.NEMPHI_API_KEY!,
});

const { invoice, journal_entry } = await nemphi.postInvoice(invoiceId, {
  idempotencyKey: `post-${invoiceId}`,
});

console.log(invoice.status, journal_entry.entry_number);
```

## 配置

| 选项 | 描述 |
| --- | --- |
| `baseUrl` | 原料药来源，例如 `https://api.nemphi.com` |
| `token` | 承载凭证：API密钥(`nk_…`)或会话令牌(`nse_…`） |
| `tenantId` | 在使用用户会话时，租户范围的调用必需 |
| `headers` | 每个请求的额外标头 |
| `fetch` | 自定义 `fetch` （默认为全局） |

## 身份验证

-   **API密钥** 是在工作区设置中创建的，并且已经绑定到一个 房客——把它们当作 `token`,没有 `tenantId` 需要的。
-   **用户会话** 两者都需要 `token` 和 `tenantId` （`X-Tenant-Id`）。

```ts
const session = createClient({
  baseUrl: "https://api.nemphi.com",
  token: sessionToken,
  tenantId: workspaceId,
});
```

## 错误

```ts
import { ApiError } from "@nemphi/sdk";

try {
  await nemphi.postInvoice(id);
} catch (err) {
  if (err instanceof ApiError) {
    // status, code (e.g. "approval_required"), message, body
    console.error(err.status, err.code, err.message);
  }
  throw err;
}
```

## 它涵盖了什么

客户端镜像Nemphi web应用程序使用的HTTP界面：auth、工作区、 工具(`invoke` /输入的助手)、操作、运行、仪表板、邮件、CRM等等。 类型位于同一模块的客户端旁边。

设计合同见 `docs/backbone.md` 在单列波中(第3节，第9节 API契约)。

## 维护人员工作流程

网络和移动应用程序使用 `workspace:*`． 重建他们的SDK `pnpm build:sdk` 在源代码更改之后。将SDK更改合并到 `master` 将它发布到npm； [PUBLISHING.md](https://npmcn.com/package/%40nemphi/sdk/PUBLISHING.md) 涵盖版本控制、包 检查和发布。

私人 `@nemphi/admin-sdk` 拥有 `/v1/admin/*`;这些方法不属于我们 在这个公共包裹中。

## 常见问题

### @nemphi/sdk 是什么？

用于Nemphi API的类型化TypeScript客户端——授权、工具和产品使用的相同管道

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

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

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

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

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

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

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

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

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

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

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

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