@fayz-ai/admin

中文文档
0.94.0发布于 2026/11/11MITTypeScriptESM + CJS近 30 天下载 2.5万

Fayz SDK admin layer — the admin shell, CRUD engine, multi-tenancy, billing, permissions and org management

原始使用文档
文档目录5 节
  1. What's inside
  2. Install
  3. Usage
  4. Part of the Fayz SDK
  5. Roadmap & contributing

@fayz-ai/admin

Turn plugins into a real multi-tenant SaaS with one defineSaas call.

npm license

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

This is where the Fayz pitch becomes a product. @fayz-ai/admin is the multi-tenant layer that wraps the headless core in everything a commercial app needs: organizations and tenancy, role-based permissions, billing, a native CRUD engine, and a full admin shell. You enable a set of plugins, call defineSaas, and get a running app with auth, org switching, permission gates, and a generated admin UI.

A salon and a clinic ship from the same engine — @fayz-ai/admin is the part that makes each one a real, isolated, billable tenant. Plugins snap in; this layer gives them an org to live in, a user to act as, and a shell to render through.

What's inside

  • App factory — defineSaas, AdminScaffold, AdminShell, LoginPage (manifest-first admin entry)
  • CRUD engine — CrudPage, CrudListView, CrudFormPage, CrudDetailPage, CrudCardGrid, createCrudPage, ImportWizard, exportToCSV
  • Org / multi-tenancy — createSupabaseOrgAdapter, createMockOrgAdapter, OrgProvider, useTenant, useOrganizationStore
  • Permissions — PermissionsProvider, PermissionGate, usePermission, useHasPermission, usePermissions
  • Billing — useBillingStore with Subscription / Invoice types (Stripe-backed)
  • Plugin framework UI — WidgetSlot, SettingsGroup, QuickActionsButton, ModuleActionBar, createPluginContext, createViewRouter, PluginRegistryManager
  • Supabase + theme — createFayzSupabaseClient, getCoreSchemaClient, createFayzTheme, fayzThemePresets

Install

npm install @fayz-ai/admin

Peer dep: react (^18/^19). Pulls in @fayz-ai/core, @fayz-ai/auth, and @fayz-ai/ui.

Usage

import { defineSaas } from '@fayz-ai/admin'

export default defineSaas({
  name: 'Glow Studio',
  plugins: [crmPlugin, agendaPlugin, financialPlugin],
  org: { adapter: orgAdapter },
})

Part of the Fayz SDK

The top of the stack — the multi-tenant SaaS layer that composes core, auth, and ui into a shippable app.

Roadmap & contributing

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

版本与发布记录

@fayz-ai/admin 共发布 112 个版本,首次发布于 2026/08/11;过去 12 个月发布了 112 个版本。

版本发布日期距今
0.94.0latest2026/11/112 天前
0.93.02026/11/113 天前
0.92.02026/11/113 天前
0.91.22026/11/104 天前
0.91.02026/11/067 天前
0.90.02026/11/068 天前

其他发布通道:canary → 0.76.0-canary.20261028153856。

关于 @fayz-ai/admin 的常见问题

@fayz-ai/admin 是什么?

Fayz SDK admin layer — the admin shell, CRUD engine, multi-tenancy, billing, permissions and org management

如何安装 @fayz-ai/admin?

在项目目录运行 npm install @fayz-ai/admin,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、react-dom(^18.0.0 || ^19.0.0)、lucide-react(>=0.400.0 <1.0.0)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/admin 支持 TypeScript 吗?

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

@fayz-ai/admin 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@fayz-ai/admin 可以商用吗?

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

@fayz-ai/admin 的下载量有多少?

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

@fayz-ai/admin 还在维护吗?

最新版本 0.94.0 发布于 2026/11/11(2 天前);至今共发布 112 个版本,其中过去 12 个月发布了 112 个;首次发布于 2026/08/11。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。