@fayz-ai/core

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

Fayz SDK核心 — 数据提供者,实体系统,插件运行时间, i18n, 路由

中文使用文档
文档目录5 节
  1. 里面的东西
  2. 安装
  3. 使用量
  4. 费兹SDK的一部分
  5. 路线图贡献( I)

@ fayz-ai/ 核心

将插件显示为运行中的应用程序的无头内核.

npm license

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

一个沙龙,一个餐厅,和一个诊所是同一个引擎,可以启用不同的插件. @fayz-ai/core 是无头无UI的引擎。 它定义了插件合同,实体/CRUD模型,数据提供者抽象,以及将整个应用描述为数据的显示格式. 插件声明它们是什么;核心在运行时将其解析为导航、路径、部件和工具.

下注:一款SaaS应用软件应可堆肥并可携带,而不能手接. 把Supabase换成Fayz API 或用一个提供商呼叫的模拟器. 将应用描述为显示并制作. 登记一个实体一次,并获得清单/形式/详细行为。 Core是制作插件"snap in"的底片

里面的东西

  • 插件运行时间 —— 说 definePlugin, (中文(简体) ), resolvePluginRuntime, (中文(简体) ), getWidgetsForZone, (中文(简体) ), getDashboardWidgets, (中文(简体) ), PluginRuntimeProvider, (中文(简体) ), PLUGIN_API_VERSION
  • 数据提供者 —— 说 createSupabaseProvider, (中文(简体) ), createFayzApiProvider, (中文(简体) ), createMockProvider, (中文(简体) ), createArchetypeProvider, (中文(简体) ), withCache, (中文(简体) ), resolveDataProvider 一个以上 DataProvider 接口
  • 实体+登记册 —— 说 registerEntity, (中文(简体) ), getEntityByKey和制服 Registry 用于组件、块、页、度量衡、脚手架和插件厂
  • 应用程序显示 —— 说 defineApp, (中文(简体) ), renderApp, (中文(简体) ), migrateManifest, (中文(简体) ), validateManifestJSON计划,以及一个版本的迁移跑者
  • 块 —— 说 BlockRenderer 编号 : renderBlocks,通用页面原始
  • i18n + 路由器 —— 说 I18nProvider, (中文(简体) ), useTranslation, (中文(简体) ), hashRouterAdapter, (中文(简体) ), windowRouterAdapter
  • 活动总线 + 功用 —— 说 eventBus, (中文(简体) ), useOnEvent, (中文(简体) ), formatCurrency, (中文(简体) ), exportCSV租户背景setActiveTenantId(中文(简体) )

安装

npm install @fayz-ai/core

端点 : react, (中文(简体) ), react-dom (^18或^19) (中文(简体) ).

使用量

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

费兹SDK的一部分

无头核. @fayz-ai/auth, (中文(简体) ), @fayz-ai/ui,以及 @fayz-ai/admin 在上面建起运行中的应用程序 .

路线图贡献( I)

建设并不断发展于开阔. 见 费兹SDK路线图 对于当前空白,缺失的特征,以及良好的第一问题.

版本与发布记录

@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核心 — 数据提供者,实体系统,插件运行时间, i18n, 路由

如何安装 @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 和提交记录判断。