# @fayz-ai/plugin-reports 中文文档

规范地址：https://npmcn.com/package/%40fayz-ai/plugin-reports/

版本：0\.16\.49
npm 元数据更新时间：2026-11-11T14:53:08.565Z
中文译文更新时间：2026-11-14T12:10:44.241Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40fayz-ai/plugin-reports
原文对照：https://npmcn.com/package/%40fayz-ai/plugin-reports/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：626 kB，105 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：4 个
- 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
- 首次发布：2026-06-17T23:02:16.867Z
- 最新版本发布：2026-11-11T14:53:08.302Z
- 近 30 天下载量：7901（2026-10-15 至 2026-11-13，npm 官方下载统计）
- 已发布版本数：89（近 12 个月 89 个）

## 中文简介

\[实验\] Fayz SDK — 插件报告插件

## 安装

```sh
npm install @fayz-ai/plugin-reports
```

也可以使用：`pnpm add @fayz-ai/plugin-reports`、`yarn add @fayz-ai/plugin-reports`、`bun add @fayz-ai/plugin-reports`

## README

# @fayz-ai/plugin-报告

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

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

[![npm](https://img.shields.io/npm/v/@fayz-ai/plugin-reports.svg)](https://www.npmjs.com/package/@fayz-ai/plugin-reports) [![license](https://img.shields.io/npm/l/@fayz-ai/plugin-reports.svg)](https://github.com/FayaLabs/fayz-sdk/blob/main/LICENSE)

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

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

## 里面的东西

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

## 安装

```bash
npm install @fayz-ai/plugin-reports
```

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

## 使用量

```tsx
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路线图](https://npmcn.com/package/docs/platform/ROADMAP.md#plugin-reports) 对于当前空白,缺失的特征,以及良好的第一问题.

## 常见问题

### @fayz-ai/plugin-reports 是什么？

\[实验\] Fayz SDK — 插件报告插件

### 如何安装 @fayz-ai/plugin-reports？

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

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

### @fayz-ai/plugin-reports 支持 ESM 还是 CommonJS？

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

### @fayz-ai/plugin-reports 可以商用吗？

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

### @fayz-ai/plugin-reports 的下载量有多少？

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

### @fayz-ai/plugin-reports 还在维护吗？

最新版本 0\.16\.49 发布于 2026/11/11（2 天前）；至今共发布 89 个版本，其中过去 12 个月发布了 89 个；首次发布于 2026/06/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。