@fayz-ai/plugin-automations

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

[experimental] Fayz SDK — workflows & automations plugin

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

@fayz-ai/plugin-automations

Status: experimental (incubating). Not capability-complete — missing some or all of the capability bar (data-provider contract w/ supabase+mock pair, entity registries, settings, migrations; see docs/plugins/PLUGIN-PATTERNS.md). Fine to explore in dogfoods; NOT ready for fresh installs or generated apps, and its API may change without notice.

Visual trigger → action workflows, native to your app's own events.

npm license

The best automations don't live in a third-party tool watching webhooks from the outside — they live inside the app, listening to its own events. plugin-automations is the GoHighLevel "Automation" surface for Fayz: when a form is submitted, a call is missed, or a deal is won, fan out into SMS, email, waits, tags, and tasks. Because it's a plugin in the same defineSaas app, it can react to real domain events instead of guessing from polling.

We're honest about where it is. M1 ships a polished /automations home — real workflow cards with triggers, multi-step sequences, and enrollment stats — to lock the model and UX. The trigger→action execution engine (over the core event bus + scheduler) is the next milestone.

What's inside

  • /automations route + nav entry (icon Zap), permission-gated on automations:read
  • Automations home view — workflows with triggers, step sequences (SMS, email, wait, tag, task), and enrollment counts
  • Universal scope — works across every vertical
  • Configurable nav — navPosition, navSection, navLabel
  • Declared feature — automations (in the "Automate" group) for permissions and feature gating

Status: M1 mock home. The execution engine over the event bus + scheduler is on the roadmap.

Install

npm install @fayz-ai/plugin-automations

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

Usage

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

export const app = defineSaas({
  // ...
  plugins: [
    createAutomationsPlugin({
      navLabel: 'Automations',
      navPosition: 6,
    }),
  ],
})

Part of the Fayz SDK

One of the composable plugins for @fayz-ai/admin — this one owns the automate surface: workflows that react to your app's events.

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-automations 共发布 86 个版本,首次发布于 2026/06/20;过去 12 个月发布了 86 个版本。

版本发布日期距今
0.15.49latest2026/11/112 天前
0.15.482026/11/113 天前
0.15.472026/11/113 天前
0.15.462026/11/067 天前
0.15.452026/11/068 天前
0.15.442026/11/068 天前

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

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

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

[experimental] Fayz SDK — workflows & automations plugin

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

在项目目录运行 npm install @fayz-ai/plugin-automations,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.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-automations 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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