Пакеты client-SDK
9 client-SDK пакетов, сгруппированных по слоям (ADR-0042). Для каждого — нарративный гайд (эта секция) и API-референс из ко да (секция «API-референс»).
@mineflow/api-tools (нейтральный каталог tool-use для backend/sim,
ADR-0053) — не client-SDK
пакет (private), поэтому здесь не документируется.
| Пакет | Слой | Назначение | Гайд | API из кода |
|---|---|---|---|---|
@mineflow/api-client | L0 | TS-типы REST (codegen) | гайд | REST ↗ |
@mineflow/api-zod | L0 | Zod-схемы форм (codegen) | гайд | REST ↗ |
@mineflow/api-schemas | L0 | FSM-машины + энумы | гайд | ↗ |
@mineflow/client-core | L1 | ядро: fetch/ошибки/саги/JWT | гайд | ↗ |
@mineflow/client-react | L2 | провайдер + хуки | гайд | ↗ |
@mineflow/auth-web | L3 | Keycloak adapter (web) | гайд | ↗ |
@mineflow/auth-native | L3 | token provider (RN) | гайд | ↗ |
@mineflow/contracts | — | типы доменных событий | гайд | ↗ |
@mineflow/shared-validation | — | ИИН/БИН/IBAN-проверки | гайд | ↗ |
Установка извне монорепо
Пакеты публикуются в приватный Verdaccio, который владеет scope @mineflow
(в отличие от GitHub Packages, прив язанного к owner-логину). Live pre-prod
instance — https://npm.57.129.115.249.nip.io. В frontend-репозитории:
# .npmrc
@mineflow:registry=https://npm.57.129.115.249.nip.io
//npm.57.129.115.249.nip.io/:_authToken=${MINEFLOW_NPM_TOKEN}
Регистрация в registry закрыта (max_users: -1) — read-учётку заводит админ
registry. Получив креды, залогинься один раз, чтобы .npmrc получил токен:
npm login --registry https://npm.57.129.115.249.nip.io
pnpm add @mineflow/client-react @mineflow/auth-web @mineflow/api-zod
Версия SDK должна совпадать с tag'ом backend-образа (X.Y.Z). Provisioning
кред и деплой registry — runbook «Приватные registry»;
обзор пакетов для фронта — docs/frontend-sdk-packages.md.