@fayz-ai/financial

中文文档
0.4.8发布于 2026/11/11MITTypeScriptES Module近 30 天下载 1.1万

Fayz SDK financial context — invoices, payments, accounts and reconciliation: the domain rules, the repository port and its adapters, and the store

原始使用文档

@fayz-ai/financial

The financial bounded context: invoices, payments, accounts, cash sessions and bank reconciliation — the rules, where they are stored, and the store over them.

Status: beta — extracted from @fayz-ai/plugin-financial, which still re-exports every name it had and keeps the screens. Pre-1.0: minor APIs may change before 1.0.

Shaped as docs/platform/PATTERNS.md describes. There is no entry file: each module is imported by its path.

Install

npm install @fayz-ai/financial

Modules

ImportWhat it holds
@fayz-ai/financial/domain/*types and pure rules: invoice, movement, transfer, statement, reconciliation, cash-session, chart-of-accounts, cnab240…
@fayz-ai/financial/data/providerFinancialDataProvider, the repository port
@fayz-ai/financial/data/supabasecreateSupabaseFinancialProvider — with data/tables, the only modules that name a table
@fayz-ai/financial/data/mockcreateMockFinancialProvider, the same contract in memory
@fayz-ai/financial/storecreateFinancialStore, createSafeFinancialProvider
@fayz-ai/financial/views/zonesFINANCIAL_ZONES and their props: where another plugin renders a financial screen with a WidgetSlot
import { WidgetSlot } from '@fayz-ai/admin'
import { FINANCIAL_ZONES } from '@fayz-ai/financial/views/zones'

<WidgetSlot zone={FINANCIAL_ZONES.receivePayment} installment={bill} onClose={close} onPaid={reload} />

The zones are filled by @fayz-ai/plugin-financial — either createFinancialPlugin() or the settings-only createFinancialSettingsPlugin(). An app that mounts neither gets an empty zone.

Words used here are defined in GLOSSARY.md.

版本与发布记录

@fayz-ai/financial 共发布 44 个版本,首次发布于 2026/10/16;过去 12 个月发布了 44 个版本。

版本发布日期距今
0.4.8latest2026/11/112 天前
0.4.72026/11/113 天前
0.4.62026/11/067 天前
0.4.52026/11/068 天前
0.4.42026/11/068 天前
0.4.32026/11/059 天前

其他发布通道:canary → 0.3.6-canary.20261028153856。

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

@fayz-ai/financial 是什么?

Fayz SDK financial context — invoices, payments, accounts and reconciliation: the domain rules, the repository port and its adapters, and the store

如何安装 @fayz-ai/financial?

在项目目录运行 npm install @fayz-ai/financial,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:react(^18.0.0 || ^19.0.0)、zustand(^4.5.0 || ^5.0.0)、@supabase/supabase-js(^2.45.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@fayz-ai/financial 支持 TypeScript 吗?

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

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

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

@fayz-ai/financial 可以商用吗?

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

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

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

@fayz-ai/financial 还在维护吗?

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