# @b4run/sdk 中文文档

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

版本：0\.15\.8
npm 元数据更新时间：2026-10-30T22:21:31.879Z
中文译文更新时间：2026-11-07T16:01:28.281Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：530 kB，114 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=24\.0\.0
- 运行依赖：0 个
- peer 依赖：zod ^4\.6\.6
- 首次发布：2026-09-09T02:59:08.811Z
- 最新版本发布：2026-10-30T22:21:31.553Z
- 近 30 天下载量：5775（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：23（近 12 个月 23 个）

## 中文简介

用于定义 B4. run 代理、工具、中间软件、内存和路由的作者化类型SDK.

## 安装

```sh
npm install @b4run/sdk
```

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

## README

![B4.run](https://raw.githubusercontent.com/cacheplane/b4run/main/docs/brand/b4-logo-horizontal-black-on-white.png)

# @b4run/ sdk (英语)

用于编写 B4. run apps 的 TypeScript SDK: 运行时函数, 如 `agent()`, (中文(简体) ), `defineMemory()` 财务报告和审定财务报表 `defineMiddleware()`,以及工具、路线和运行时间合同的类型.

**当 :** 您正在撰写路径、 工具、 中间软件、 内存声明, 或输入运行时合同 .

[![The B4.run navlog demo: a VFR flight plan with its navlog sheet in the Workbench. Opens the demo video.](https://raw.githubusercontent.com/cacheplane/b4run/main/apps/web/public/demo/product-loop-poster.webp)](https://9rq8ezyghevy0wop.public.blob.vercel-storage.com/b4/demo/product-loop.mp4)  
[观察50秒的导航演示](https://9rq8ezyghevy0wop.public.blob.vercel-storage.com/b4/demo/product-loop.mp4)

## 安装

需要节点.js 24或后. `create-b4-app` 通常为您安装 SDK, 同时 `@b4run/cli`因为线路运行在CLI的运行时间。 将两者添加到现有的应用程序中:

```bash
npm install @b4run/sdk @b4run/cli
```

添加 `zod` 当声明输入的长期内存时:

```bash
npm install zod
```

## 示例

定义代理路由 `issueRefund` 工具需要个人批准:

```ts
// src/app/support/index.ts
import { agent } from "@b4run/sdk"

export default agent({
  model: "gpt-5-mini",
  systemPrompt: "Answer support questions clearly and concisely.",
  tools: { approve: ["issueRefund"] },
})
```

```ts
// src/app/support/tools/issueRefund.ts
/** Refund an order. */
export default async (input: { readonly orderId: string }) => {
  return { refunded: input.orderId }
}
```

每个工具都是一个默认导出的文件: 路由本地工具在路由的 `tools/` 目录和共享工具 `src/tools/`中的名称 `tools.approve` 每次通话暂停,直到有人回答,一个"总是"的回答会停止该工具的提示. 写入 `{ tool: "issueRefund", allowAlways: false }` 而不是每通电话都问.

同一软件包提供相邻的内存和中间软件声明:

```ts
// src/app/support/memory.ts
import { defineMemory } from "@b4run/sdk"
import { z } from "zod"

export default defineMemory({
  kind: "semantic",
  scope: ["workspace", "route"],
  schema: z.object({
    subject: z.string(),
    predicate: z.string(),
    value: z.string(),
  }),
})
```

```ts
// src/middleware.ts
import { defineMiddleware } from "@b4run/sdk"

export default defineMiddleware(() => ({ action: "continue" }))
```

或者,拥有长寿资源的中间软件,例如数据库 池中,使用生命周期形式而不是上面的函数. `setup` 运行一次, 懒惰地,在第一个登门请求之前(如果 失败); `dispose` 当节点运行时间关闭时运行.

```ts
// src/middleware.ts
import { allow, defineMiddleware, reject } from "@b4run/sdk"
import { Pool } from "pg"

let pool: Pool | undefined

export default defineMiddleware({
  async setup() {
    pool = new Pool({ connectionString: process.env.DATABASE_URL })
    await pool.query("select 1")
  },
  async dispose() {
    await pool?.end()
  },
  async handle(req) {
    const token = req.headers.authorization?.replace(/^Bearer /, "")
    if (!token) return reject(401)
    const result = await pool?.query("select user_id from sessions where token = $1", [token])
    const row = result?.rows[0]
    return row ? allow({ userId: row.user_id }) : reject(401)
  },
})
```

这个 [认证中间软件配方](https://b4.run/docs/recipes/auth-middleware) 穿过无记名证。 启动模板解决呼叫者一次, in `src/auth.ts`,从两者导入 `src/middleware.ts` 财务报告和审定财务报表 `src/thread-access.ts`; 添加时保持该形状 [线程访问](https://b4.run/docs/thread-access),所以两个文件 同意谁是打电话者.

## 运行时间和稳定性

-   `@b4run/sdk` 是支持的边缘安全应用表面.
-   `@b4run/sdk/pure` 是一个支持的无依赖的边缘安全整合表面.
-   `@b4run/sdk/testing` 是一个被支持的只有节点的情景作者表面。 这是分开的 `@b4run/testing`。 。 。 .

## 相关

-   [`@b4run/cli`](https://www.npmjs.com/package/@b4run/cli) 开发、测试、建造和服务SDK申报的路线.
-   [`@b4run/testing`](https://www.npmjs.com/package/@b4run/testing) 为 B4. 运行应用程序提供程序配置.
-   [SDK API 参考](https://b4.run/docs/api/sdk)
-   [探员](https://b4.run/docs/agents)
-   [工具](https://b4.run/docs/tools)
-   [中间软件](https://b4.run/docs/middleware)
-   [内存](https://b4.run/docs/memory)
-   [假设测试](https://b4.run/docs/testing)

## 成熟和支持

B4.run为1.0前置,其公用地表可以改变. 所有可公布的 B4. 运行包作为一个固定组一起发布; 审查 [`@b4run/sdk` 更改日志](https://github.com/cacheplane/b4run/blob/main/packages/sdk/CHANGELOG.md) 财务报告和审定财务报表 [升级指南](https://b4.run/docs/upgrading) 升级前。 用于支持, 使用 [GitHub 讨论](https://github.com/cacheplane/b4run/discussions); 报告缺陷 [GitHub 问题](https://github.com/cacheplane/b4run/issues)。 。 。 .

## 许可证

麻省理工学院. 见 [仓库许可证](https://github.com/cacheplane/b4run/blob/main/LICENSE)。 。 。 .

## 常见问题

### @b4run/sdk 是什么？

用于定义 B4\. run 代理、工具、中间软件、内存和路由的作者化类型SDK\.

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

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

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

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

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

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

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

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

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

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

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

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

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

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