@fayz-ai/plugin-agenda

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

Fayz SDK — plugin-agenda plugin

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

@fayz-ai/plugin-agenda

The scheduling engine that turns any SaaS into a bookable business.

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 service business runs on a calendar. Salons book stylists, clinics book doctors, studios book rooms — the same primitive, rebuilt badly a thousand times. plugin-agenda is that primitive done once: a resource-aware calendar with appointments, blocks, working hours, conflict detection, and drag-and-drop, all driven by config instead of forks.

It snaps into any defineSaas app and reshapes itself per vertical — booking types, statuses, professional/client/service lookups, and locations are all options. Pair it with @fayz-ai/plugin-financial and a booking can auto-create an order, so scheduling and revenue stay in sync from the first appointment. One engine, every vertical, no rewrite.

What's inside

  • Calendar page (/agenda) — FullCalendar-powered day/week/month/list views plus resource time-grid, with drag-and-drop and conflict detection.
  • Booking types — appointments, tasks, and blocks out of the box, each with its own fields and rules; fully overridable.
  • Status workflow — scheduled → confirmed → in progress → completed, plus cancelled / no-show, with time-aware availability.
  • Working hours & schedule blocks — buffer time, max-concurrent, advance-booking windows, multi-location selection.
  • AI tools — listAppointments, createAppointment, checkAvailability for natural-language scheduling.
  • Financial bridge — optional cross-plugin integration that auto-creates orders and tracks booking payment status (createFinancialBridge, computeCommissionAmount).
  • Supabase-or-mock data provider, settings tab, and i18n built in.

Install

npm install @fayz-ai/plugin-agenda

Peer deps: react, react-dom. Runtime deps include @fayz-ai/core, @fayz-ai/ui, @fayz-ai/admin, @fayz-ai/plugin-financial, and FullCalendar.

Usage

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

export const app = defineSaas({
  // ...
  plugins: [
    createAgendaPlugin({
      labels: { pageTitle: 'Bookings' },
      defaultCalendarView: 'resourceTimeGridWeek',
      businessHours: { startTime: '08:00', endTime: '20:00' },
      slotDuration: 30,
      autoCreateOrder: true,
      modules: { locationSelection: true },
    }),
  ],
})

Part of the Fayz SDK

plugin-agenda is the front door for any booking-driven vertical (beauty, health, services). It pairs naturally with @fayz-ai/plugin-financial via the financial bridge, and with @fayz-ai/plugin-reports for occupancy and revenue analytics.

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

版本发布日期距今
0.27.34latest2026/11/112 天前
0.27.332026/11/113 天前
0.27.322026/11/113 天前
0.27.312026/11/067 天前
0.27.302026/11/068 天前
0.27.292026/11/068 天前

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

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

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

Fayz SDK — plugin-agenda plugin

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

在项目目录运行 npm install @fayz-ai/plugin-agenda,或使用 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-agenda 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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