@fayz-ai/sdk (英语)

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

状态 : β-发布至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

安装

npm install @fayz-ai/sdk

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

使用量

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路线图 对于当前空白,缺失的特征,以及良好的第一问题.