# @bonnard/sdk 中文文档

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

版本：0\.4\.7
npm 元数据更新时间：2026-03-19T15:32:32.949Z
中文译文更新时间：2026-11-08T10:57:44.785Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：67 kB，25 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.0\.0
- 运行依赖：0 个
- peer 依赖：zod ^3\.0\.0，@langchain/core \>=0\.2\.0
- 首次发布：2026-02-18T12:21:04.774Z
- 最新版本发布：2026-03-19T15:32:32.650Z
- 近 30 天下载量：1849（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：12（近 12 个月 12 个）

## 中文简介

Bonard SDK - 从任何 JavaScript 或 TypeScript app 查询您的语义层

## 安装

```sh
npm install @bonnard/sdk
```

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

## README

# @ bonnard/ sdk (英语)

用于查询的脚本 SDK 类型 [博纳德](https://www.bonnard.dev/) 任何JavaScript或TypeScript应用程序的语义层.

## 安装

```bash
npm install @bonnard/sdk
```

## 快速启动

### 有可以出版的密钥

```typescript
import { createClient } from '@bonnard/sdk';

const bon = createClient({
  apiKey: 'bon_pk_...',
});

const { data } = await bon.query({
  measures: ['orders.revenue', 'orders.count'],
  dimensions: ['orders.status'],
});

console.log(data);
// [{ "orders.revenue": 45000, "orders.count": 120, "orders.status": "completed" }, ...]
```

### 以代币交换(多租户)

对于每个用户看到自己数据的B2B应用程序,使用服务器侧密钥来薄荷瞄准符:

```typescript
// Server: exchange secret key for a scoped JWT
const res = await fetch('https://app.bonnard.dev/api/sdk/token', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer bon_sk_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    security_context: { tenant_id: 'acme-123' },
  }),
});
const { token } = await res.json();
```

```typescript
// Client: use the token callback
const bon = createClient({
  fetchToken: async () => {
    const res = await fetch('/api/analytics/token');
    const { token } = await res.json();
    return token;
  },
});

const { data } = await bon.query({
  measures: ['orders.revenue'],
  timeDimension: {
    dimension: 'orders.created_at',
    granularity: 'month',
    dateRange: ['2025-01-01', '2025-12-31'],
  },
});
```

托肯在到期前60秒自动被缓存并刷新.

## API 密码

### `createClient(config)`

| 选项 | 类型 | 说明 |
| --- | --- | --- |
| `apiKey` | `string` | 可公布的密钥( E)`bon_pk_...`) (中文(简体) ). 使用其中的一个 `apiKey` 或者说 `fetchToken`。 。 。 . |
| `fetchToken` | `() => Promise<string>` | Async召回,返回一个JWT。 用于多租户设置. |
| `baseUrl` | `string` | API 基础 URL( 默认 ): `https://app.bonnard.dev`(中文(简体) ) |

### `client.query(options)`

JSON针对语义层的查询.

```typescript
const { data } = await bon.query({
  measures: ['orders.revenue', 'orders.count'],
  dimensions: ['orders.product_category'],
  filters: [
    { dimension: 'orders.status', operator: 'equals', values: ['completed'] },
  ],
  timeDimension: {
    dimension: 'orders.created_at',
    granularity: 'month',
    dateRange: ['2025-01-01', '2025-12-31'],
  },
  orderBy: { 'orders.revenue': 'desc' },
  limit: 100,
});
```

### `client.sql(query)`

使用 Cube SQL 语法进行 Raw SQL 查询.

```typescript
const { data } = await bon.sql(
  `SELECT product_category, MEASURE(revenue) FROM orders GROUP BY 1`
);
```

### 处理错误

所有 API 出错 `BonnardError` hTTP 状态代码 :

```typescript
import { createClient, BonnardError } from '@bonnard/sdk';

try {
  const { data } = await bon.query({ measures: ['orders.revenue'] });
} catch (err) {
  if (err instanceof BonnardError) {
    console.log(err.statusCode); // 401, 400, 500, etc.
    console.log(err.retryable);  // true for 429 and 5xx
  }
}
```

## 链接

-   [博纳德医生](https://docs.bonnard.dev/)
-   [开始](https://docs.bonnard.dev/docs/getting-started)
-   [解析器](https://discord.com/invite/RQuvjGRz)

## 许可证

[麻省理工学院](https://npmcn.com/package/%40bonnard/sdk/LICENSE)

## 常见问题

### @bonnard/sdk 是什么？

Bonard SDK - 从任何 JavaScript 或 TypeScript app 查询您的语义层

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

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

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

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

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

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

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

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

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

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

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

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

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

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