# @boundaryml/baml-nextjs-plugin 中文文档

规范地址：https://npmcn.com/package/%40boundaryml/baml-nextjs-plugin/

版本：0\.1\.0
npm 元数据更新时间：2025-02-18T23:18:56.361Z
中文译文更新时间：2026-11-08T12:35:34.311Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40boundaryml/baml-nextjs-plugin
原文对照：https://npmcn.com/package/%40boundaryml/baml-nextjs-plugin/?lang=original
项目主页：https://github.com/BoundaryML/baml#readme
源码仓库：https://github.com/BoundaryML/baml

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

- 包体积（解压后）：8.9 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>= 18
- 运行依赖：0 个
- peer 依赖：next \*，react \*
- 首次发布：2025-02-18T23:18:55.818Z
- 最新版本发布：2025-02-18T23:18:56.071Z
- 近 30 天下载量：15462（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1（近 12 个月 0 个）

## 中文简介

BAML 下一个.js 集成

## 安装

```sh
npm install @boundaryml/baml-nextjs-plugin
```

也可以使用：`pnpm add @boundaryml/baml-nextjs-plugin`、`yarn add @boundaryml/baml-nextjs-plugin`、`bun add @boundaryml/baml-nextjs-plugin`

## README

# @ 边界ml/ nextjs

Next.js 为BAML集成,为服务器组件,服务器动作和流回响应提供无缝支持.

## 安装

```bash
npm install @boundaryml/baml @boundaryml/nextjs
```

## 设置

1.  更新您的 Next.js 配置 :

```typescript
// next.config.ts
import { withBaml } from '@boundaryml/nextjs';
import type { NextConfig } from 'next';

const nextConfig: NextConfig = {
  // ... your existing config
};

export default withBaml()(nextConfig);
```

2.  在您的服务器动作中使用 BAML 函数 :

```typescript
// app/actions/story.ts
'use server'

import { b } from "@/baml_client";

export async function writeMeAStoryAction(prompt: string) {
  return b.WriteMeAStory.stream(prompt).toStreamable();
}
```

3.  使用您反应组件中生成的钩子 :

```typescript
// app/components/story.tsx
'use client'

import { useWriteMeAStoryAction } from "@/baml_client/nextjs";

export function StoryForm() {
  const {
    data: finalStory,
    partialData: streamingStory,
    isLoading,
    isError,
    error,
    mutate
  } = useWriteMeAStoryAction();

  const story = isLoading ? streamingStory : finalStory;

  return (
    <div>
      <button onClick={() => mutate("Once upon a time...")}>
        Generate Story
      </button>
      {isLoading && <p>Generating story...</p>}
      {story && (
        <div>
          <h2>{story.title}</h2>
          <p>{story.content}</p>
        </div>
      )}
    </div>
  );
}
```

## 特征

-   QQ 安全: 在服务器上运行 BAML 函数以保持 API 密钥的安全
-   QQ 流: 内置支持流响应
-   QQ 类型安全: 所有 BAML 函数的完整类型脚本支持
-   QQ快:优化了Next.js App路由器和回放服务器组件
-   简单:零配置设置 `withBaml`

## API 参考

### `withBaml(config?: BamlNextConfig)`

将您的 Next.js 配置与 BAML 集成 .

```typescript
interface BamlNextConfig {
  webpack?: NextConfig['webpack']; // Custom webpack configuration
}
```

### 生成的钩子

对于每个BAML函数,生成一个相应的反应钩,其界面如下:

```typescript
interface BamlStreamHookResult<T> {
  data?: T;              // Final result
  partialData?: T;       // Streaming result
  isLoading: boolean;    // Loading state
  error?: Error;         // Error state
  mutate: (input: any) => Promise<void>; // Function to call the BAML function
}
```

## 许可证

麻省理工学院

## 常见问题

### @boundaryml/baml-nextjs-plugin 是什么？

BAML 下一个\.js 集成

### 如何安装 @boundaryml/baml-nextjs-plugin？

在项目目录运行 npm install @boundaryml/baml-nextjs-plugin，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：next（\*）、react（\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @boundaryml/baml-nextjs-plugin 支持 TypeScript 吗？

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

### @boundaryml/baml-nextjs-plugin 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @boundaryml/baml-nextjs-plugin 需要什么版本的 Node\.js？

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

### @boundaryml/baml-nextjs-plugin 可以商用吗？

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

### @boundaryml/baml-nextjs-plugin 的下载量有多少？

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

### @boundaryml/baml-nextjs-plugin 还在维护吗？

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