@fayz-ai/plugin-报告

现状:实验(孵化). 能力不完全——缺少部分或全部能力栏(数据提供者合同w/supabase+mock配对、实体登记、设置、迁移;见 docs/plugins/PLUGIN-PATTERNS.md) (中文(简体) ). 精细在狗食中探索;不准备新安装或生成应用,其API可能会不经通知而改变.

您的 SaaS 的配置驱动报告 —— 宣布报告, 获取页面 .

每个企业最终都问同样的事情:"给我看数字" plugin-reports 没有BI螺栓就答了 您声明报告为数据 – 列, 过滤器, 日期范围, 徽章, 和数据源 – 插件使一个可搜索的报告集线器加上一个可过滤, 可导取的查看器 。 没有每份报告的UI,没有复制的表格.

这是SDK的读取层:将它指向其它应用程序已经写出的数据,任何垂直都从框中获取分析和决定支持. 日期预设,货币格式化,以及默认的CSV/Excel/PDF导出船;报告本身只是配置,所以添加一个是数组条目,而不是新的屏幕.

里面的东西

• 报告页 (单位:千美元)/reports)——一个报告中心,它列出和搜索你宣布的报告,另外还有一个单份报告的查看器.
• 声明报告 —— 说 ReportDef 带有列、过滤器、日期范围、徽章和数据源;报告作为选项传递.
• 日期预设 ——今天,昨天,过去7天,本/上月,本季度,以及定制范围.
• 导出 ——CSV,Excel,和PDF,有打印支持.
• 可配置 ——标签,货币,默认页面大小,和页眉能见度.
• Supabase- or- mock 数据提供者, 与 createSupabaseReportProvider 编号 : createMockReportProvider 导出为自定义接线; i18n 已建入.

安装

npm install @fayz-ai/plugin-reports

端点 : react, (中文(简体) ), react-dom中。运行时解码包括 @fayz-ai/core, (中文(简体) ), @fayz-ai/ui,以及 @fayz-ai/admin。 。 。 .

使用量

import { defineSaas } from '@fayz-ai/admin'
import { createReportsPlugin } from '@fayz-ai/plugin-reports'

export const app = defineSaas({
  // ...
  plugins: [
    createReportsPlugin({
      currency: { code: 'BRL', locale: 'pt-BR', symbol: 'R$' },
      defaultPageSize: 50,
      reports: [
        {
          id: 'revenue-by-day',
          title: 'Revenue by Day',
          // columns, filters, dataSource, ...
        },
      ],
    }),
  ],
})

费兹SDK的一部分

plugin-reports 是SDK的分析表面。 自然读取 @fayz-ai/plugin-financial (收入、佣金)和 @fayz-ai/plugin-agenda (预订,占用)将业务数据转化为报告.

路线图贡献( I)

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