# @fayz-ai/sdk 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/sdk/

版本：0\.94\.0
npm 元数据更新时间：2026-11-11T14:52:49.209Z
中文译文更新时间：2026-11-14T12:08:12.641Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：705 kB，96 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-06-14T12:24:38.264Z
- 最新版本发布：2026-11-11T14:52:48.924Z
- 近 30 天下载量：26561（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：62（近 12 个月 62 个）

## 中文简介

Fayz SDK — API客户端,应用参数,运行时代理助手,以及生成的Fayz项目的共享类型

## 安装

```sh
npm install @fayz-ai/sdk
```

也可以使用：`pnpm add @fayz-ai/sdk`、`yarn add @fayz-ai/sdk`、`bun add @fayz-ai/sdk`

## README

# @fayz-ai/sdk (英语)

> 每一个Fayz应用软件的打字客户端和合同层.

[![npm](https://img.shields.io/npm/v/@fayz-ai/sdk.svg)](https://www.npmjs.com/package/@fayz-ai/sdk) [![license](https://img.shields.io/npm/l/@fayz-ai/sdk.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

**状态 :** β-发布至npm并在整个法伊兹狗食应用. 事前1.0:小API在1.0之前可能会有变化.

Fayz通过编译插件来构建真实,多租借的SaaS应用程序. `@fayz-ai/sdk` 是生成的 Fayz 项目与其背后的平台之间的接合:一个被键入的 API 客户端,共享的 express/user/params 类型,OAuth 支持的集成的运行时间中介,以及将每个软件包保存在一个连贯的版本集上的放行通道解析器.

这是最小的信托,零反应层——没有UI,没有框架,只有合同. 生成的apps通过SDK调用法伊兹,而不是直接导入提供商客户端,这让OAuth的秘密和租户当局服务器侧面保持了这个功能. 如果您正在阅读 Fayz 表格, 交换插件 OAuth 授权, 或固定一个软件包通道, 请从这里开始 .

## 里面的东西

-   `createFayzClient` 编号 : `fayz` - 输入客户端 `auth.me()` 财务报告和审定财务报表 `data` 行访问( e)`listRows`, (中文(简体) ), `countRows`, (中文(简体) ), `createRow`, (中文(简体) ), `updateRow`, (中文(简体) ), `deleteRows`+) 加上 (中文(简体) ) `FayzApiError`
-   `createFayzRuntimeClient` 编号 : `FayzRuntimeError` – 插件赠与交换和谷歌日历访问的运行时间 OAuth 经纪人
-   `createFayzShopProvider` 编号 : `FayzShopError` - 有地位类型的商业读取商(产品、订单、客户、折扣)
-   `appParams` 编号 : `resolveAppParams` 读取应用参数 Fayz注入生成的项目
-   `fayzPackageVersionSets` + 键 `resolveFayzPackage*` ——跨SDK的放行通道分辨率
-   共享类型 : `AppManifest`, (中文(简体) ), `PageManifest`, (中文(简体) ), `SurfaceManifest`, (中文(简体) ), `PluginRef`, (中文(简体) ), `FayzUser`, (中文(简体) ), `FayzAuthMeResponse`

## 安装

```bash
npm install @fayz-ai/sdk
```

没有同行的依赖性——框架不可知.

## 使用量

```ts
import { fayz } from '@fayz-ai/sdk'

const me = await fayz.auth.me()

const { rows, total } = await fayz.data.listRows({
  table: 'v_bookings',
  filters: [{ column: 'status', operator: 'neq', value: 'cancelled' }],
})
```

## 费兹SDK的一部分

下面的基金会客户端 `@fayz-ai/core`, (中文(简体) ), `@fayz-ai/admin`,每个 Fayz 插件.

## 路线图贡献( I)

建设并不断发展于开阔. 见 [费兹SDK路线图](https://npmcn.com/package/docs/platform/ROADMAP.md#sdk) 对于当前空白,缺失的特征,以及良好的第一问题.

## 常见问题

### @fayz-ai/sdk 是什么？

Fayz SDK — API客户端,应用参数,运行时代理助手,以及生成的Fayz项目的共享类型

### 如何安装 @fayz-ai/sdk？

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

### @fayz-ai/sdk 支持 TypeScript 吗？

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

### @fayz-ai/sdk 支持 ESM 还是 CommonJS？

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

### @fayz-ai/sdk 可以商用吗？

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

### @fayz-ai/sdk 的下载量有多少？

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

### @fayz-ai/sdk 还在维护吗？

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