@fayz-ai/sdk

The typed client and contract layer every Fayz app talks to.

Status: beta — published to npm and used across Fayz dogfood apps. Pre-1.0: minor APIs may change before 1.0.

Fayz builds real, multi-tenant SaaS apps by composing plugins. @fayz-ai/sdk is the seam between a generated Fayz project and the platform behind it: a typed API client, the shared manifest/user/params types, a runtime broker for OAuth-backed integrations, and the release-channel resolver that keeps every package on a coherent version set.

This is the lowest-trust, zero-React layer — no UI, no framework, just the contract. Generated apps call Fayz through the SDK instead of importing provider clients directly, which is what keeps OAuth secrets and tenant authority server-side. If you're reading Fayz tables, exchanging plugin OAuth grants, or pinning a package channel, you start here.

What's inside

• createFayzClient / fayz — typed client with auth.me() and data row access (listRows, countRows, createRow, updateRow, deleteRows) plus FayzApiError
• createFayzRuntimeClient / FayzRuntimeError — runtime OAuth broker for plugin grant exchange and Google Calendar access
• createFayzShopProvider / FayzShopError — commerce read provider (products, orders, customers, discounts) with status types
• appParams / resolveAppParams — read the app params Fayz injects into a generated project
• fayzPackageVersionSets + resolveFayzPackage* — release-channel resolution across the SDK
• Shared types: AppManifest, PageManifest, SurfaceManifest, PluginRef, FayzUser, FayzAuthMeResponse

Install

npm install @fayz-ai/sdk

No peer dependencies — framework-agnostic.

Usage

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' }],
})

Part of the Fayz SDK

The foundation client beneath @fayz-ai/core, @fayz-ai/admin, and every Fayz plugin.

Roadmap & contributing

Built and evolving in the open. See the Fayz SDK roadmap for current gaps, missing features, and good first issues.