@fayz-ai/plugin-forms

中文文档
0.15.34发布于 2026/11/11MITTypeScriptES Module近 30 天下载 8727

Fayz SDK — plugin-forms plugin

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

@fayz-ai/plugin-forms

Templates, documents, and signatures — the paperwork layer for any vertical.

npm license

Status: beta — pre-1.0. Core surface is stable; some backend facets (see PLUGIN_PATTERNS.md) are still landing. APIs may change before 1.0.

Every real business runs on forms it never wanted to build: anamnesis sheets, evolution notes, consent contracts, intake docs. plugin-forms kills that busywork. Define a template once, attach a filled document to a person, and the data lives in your tenant — not in a PDF nobody can query.

It snaps into a defineSaas app as the document engine. A clinic fills health anamnesis, a salon collects consent forms, a studio signs contracts — same plugin, same frm_* tables, different templates. Documents surface right inside the person record via a detail-tab widget, and the AI assistant can list templates and a client's documents on demand.

What's inside

  • Template + document model backed by Supabase (frm_* tables) with a mock provider fallback via createSafeDataProvider
  • Form categories registry (frm_categories, tenant-scoped) seeded with Anamnese, Evolução, Laudo, Contrato, Geral
  • Person detail widget — a person.detail.documents zone tab that lists and attaches documents to a contact
  • Settings tab for managing templates, documents, and categories
  • Document-type provider API — registerDocumentTypeProvider lets other plugins contribute selectable document/file types
  • AI tools — listFormTemplates and listDocuments (read-only, permission-gated)
  • Pluggable data layer — pass your own dataProvider, or let it auto-resolve Supabase → mock

Install

npm install @fayz-ai/plugin-forms

Peer deps: react, react-dom. Runtime deps: @fayz-ai/core, @fayz-ai/ui.

Usage

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

export const app = defineSaas({
  // ...
  plugins: [
    createCustomFormsPlugin({
      labels: { pageTitle: 'Documents' },
      // dataProvider: myProvider,  // optional — defaults to Supabase → mock
    }),
  ],
})

Part of the Fayz SDK

One of the composable plugins that turn @fayz-ai/admin into a real, vertical-specific SaaS — this one owns documents and signatures.

Roadmap & contributing

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

版本与发布记录

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

版本发布日期距今
0.15.34latest2026/11/112 天前
0.15.332026/11/113 天前
0.15.322026/11/113 天前
0.15.312026/11/067 天前
0.15.302026/11/068 天前
0.15.292026/11/068 天前

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

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

@fayz-ai/plugin-forms 是什么?

Fayz SDK — plugin-forms plugin

如何安装 @fayz-ai/plugin-forms?

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

@fayz-ai/plugin-forms 支持 TypeScript 吗?

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

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

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

@fayz-ai/plugin-forms 可以商用吗?

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

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

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

@fayz-ai/plugin-forms 还在维护吗?

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