@fayz-ai/financial 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Faya Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,35 @@
-# Temporary Holding Version
+# @fayz-ai/financial
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+> 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](../../docs/platform/PATTERNS.md) describes. There is no entry file: each module is imported by its path.
+
+## Install
+
+```bash
+npm install @fayz-ai/financial
+```
+
+## Modules
+
+| Import | What 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/provider` | `FinancialDataProvider`, the repository port |
+| `@fayz-ai/financial/data/supabase` | `createSupabaseFinancialProvider` — with `data/tables`, the only modules that name a table |
+| `@fayz-ai/financial/data/mock` | `createMockFinancialProvider`, the same contract in memory |
+| `@fayz-ai/financial/store` | `createFinancialStore`, `createSafeFinancialProvider` |
+| `@fayz-ai/financial/views/zones` | `FINANCIAL_ZONES` and their props: where another plugin renders a financial screen with a `WidgetSlot` |
+
+```tsx
+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](./GLOSSARY.md).