@fayz-ai/core

中文文档
0.94.0发布于 2026/11/11MITTypeScriptES Module近 30 天下载 3.1万

Fayz SDK core — data providers, entity system, plugin runtime, i18n, routing

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

@fayz-ai/core

The headless kernel that turns plugin manifests into a running app.

npm license

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

A salon, a restaurant, and a clinic are the same engine with different plugins enabled. @fayz-ai/core is that engine — headless and UI-free. It defines the plugin contract, the entity/CRUD model, the data-provider abstraction, and the manifest format that describes an entire app as data. Plugins declare what they are; core resolves them into navigation, routes, widgets, and tools at runtime.

The bet: a SaaS app should be composable and portable, not hand-wired. Swap Supabase for the Fayz API or a mock with one provider call. Describe an app as a manifest and render it. Register an entity once and get list/form/detail behavior everywhere. Core is the substrate that makes plugins "snap in."

What's inside

  • Plugin runtime — definePlugin, resolvePluginRuntime, getWidgetsForZone, getDashboardWidgets, PluginRuntimeProvider, PLUGIN_API_VERSION
  • Data providers — createSupabaseProvider, createFayzApiProvider, createMockProvider, createArchetypeProvider, withCache, resolveDataProvider over one DataProvider interface
  • Entity + registry — registerEntity, getEntityByKey, and the uniform Registry for components, blocks, pages, metrics, scaffolds, and plugin factories
  • App manifest — defineApp, renderApp, migrateManifest, validateManifest, JSON schema, and a versioned migration runner
  • Blocks — BlockRenderer / renderBlocks, the universal page primitive
  • i18n + router — I18nProvider, useTranslation, hashRouterAdapter, windowRouterAdapter
  • Event bus + utils — eventBus, useOnEvent, formatCurrency, exportCSV, tenant context (setActiveTenantId)

Install

npm install @fayz-ai/core

Peer deps: react, react-dom (^18 or ^19).

Usage

import { definePlugin, createSupabaseProvider } from '@fayz-ai/core'

const provider = createSupabaseProvider({ url, anonKey })

export const crmPlugin = definePlugin({
  id: 'crm',
  navigation: [{ label: 'Clients', path: '/clients' }],
  entities: [/* declarative data models */],
})

Part of the Fayz SDK

The headless core. @fayz-ai/auth, @fayz-ai/ui, and @fayz-ai/admin build the running app on top of it.

Roadmap & contributing

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

版本与发布记录

@fayz-ai/core 共发布 82 个版本,首次发布于 2026/06/18;过去 12 个月发布了 82 个版本。

版本发布日期距今
0.94.0latest2026/11/112 天前
0.92.02026/11/113 天前
0.90.02026/11/068 天前
0.79.02026/11/059 天前
0.78.02026/11/0410 天前
0.77.72026/11/0310 天前

其他发布通道:next → 0.9.0-next.1,canary → 0.76.0-canary.20261028153856。

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

@fayz-ai/core 是什么?

Fayz SDK core — data providers, entity system, plugin runtime, i18n, routing

如何安装 @fayz-ai/core?

在项目目录运行 npm install @fayz-ai/core,或使用 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)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/core 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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