@finsys/core 2.6.0 → 2.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +164 -2
- package/dist/index.d.ts +164 -2
- package/dist/index.js.map +1 -1
- package/dist/schema/adapter-manifest.schema.json +11 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,8 +1,20 @@
|
|
|
1
1
|
# @finsys/core
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
The shared contract layer for the FinSys ecosystem. Two distinct surfaces:
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
1. **Unified form configuration** — generate Zod schemas, React Hook Form defaults, and SurveyJS JSON from a single JSON form spec.
|
|
6
|
+
2. **Source Adapter Framework** — vendor-agnostic contract for ingesting alternative-data sources (telco, payments, bank statements, etc.) into FinSys's canonical credit-signal vocabulary.
|
|
7
|
+
|
|
8
|
+
## Building a Source Adapter?
|
|
9
|
+
|
|
10
|
+
Partner-facing integration documentation lives in [`docs/`](./docs/):
|
|
11
|
+
|
|
12
|
+
- 📖 [**Adapter Authoring Guide**](./docs/adapter-authoring.md) — start here. Walks from "what's an adapter" through "how do I package and deliver one."
|
|
13
|
+
- 📋 [Category Reference](./docs/category-reference.md) — canonical field set per category.
|
|
14
|
+
- 📋 [Manifest Reference](./docs/manifest-reference.md) — every field in `manifest.json`.
|
|
15
|
+
- 🔒 [Security Model](./docs/security-model.md) — sandboxing, secrets, network posture.
|
|
16
|
+
|
|
17
|
+
## Features (form-config surface)
|
|
6
18
|
|
|
7
19
|
- **Unified Form Configuration** — Single JSON format for defining form fields and multi-step page layouts
|
|
8
20
|
- **React Hook Form Generator** — Generate Zod schemas, default values, and step configurations from a form config
|