From 605a4e8d00ed9cd9cbb573b8eff8b108206905f5 Mon Sep 17 00:00:00 2001 From: Sergey Krylov Date: Sat, 20 Jun 2026 21:07:53 +0300 Subject: [PATCH] docs: update frontend overview for portfolio FSD migration --- apps/docs/docs/frontend/overview.md | 158 +++++++++++++++------------- 1 file changed, 82 insertions(+), 76 deletions(-) diff --git a/apps/docs/docs/frontend/overview.md b/apps/docs/docs/frontend/overview.md index 19c161f..46db3ab 100644 --- a/apps/docs/docs/frontend/overview.md +++ b/apps/docs/docs/frontend/overview.md @@ -14,9 +14,8 @@ React SPA, собранная с Vite. ## Структура исходников -Published-структура ниже описывает primary FSD entrypoints. Historical каталоги `api/`, `context/`, -`hooks/`, `components/` ещё присутствуют в кодовой базе, но для уже мигрированных областей они всё -чаще играют роль transitional shim-слоя, а не source of truth. +Published-структура ниже описывает primary FSD entrypoints. Исторические каталоги `api/`, `context/`, +`hooks/`, `components/` ещё присутствуют в кодовой базе для ещё не мигрированных доменов. ``` apps/frontend/src/ @@ -38,54 +37,63 @@ apps/frontend/src/ ├── shared/ │ ├── api/ # shared API client, response types, generated OpenAPI types │ └── ui/ # shared UI primitives without domain logic -├── entities/ -│ ├── session/ # FSD: auth/session (api, model/context + hook) -│ ├── search/ # FSD: market search query slice -│ ├── stock/ # FSD: stock api + query hooks -│ ├── bond/ # FSD: bond api + query hooks -│ ├── portfolio/ # FSD: portfolio api + query hooks -│ ├── broker-account/ # FSD: account slice (api, model, ui) -│ ├── broker-position/ # FSD: position slice (api, model) -│ └── broker-operation/ # FSD: operation slice (api, model) -├── widgets/ -│ ├── search-bar/ # FSD: instrument search widget -│ ├── price-chart/ # FSD: market chart widget -│ ├── stock-details/ # FSD: stock details widget -│ ├── bond-details/ # FSD: bond details widget -│ ├── dividends-table/ # FSD: stock dividends widget -│ ├── broker-account-card/ # FSD: account card widget -│ ├── broker-accounts-summary/ # FSD: accounts summary widget -│ ├── broker-allocation-chart/ # FSD: allocation chart widget -│ └── broker-operations-table/ # FSD: operations table widget -├── pages/ -│ ├── HomePage.tsx # re-export shim → pages/home -│ ├── StockPage.tsx # re-export shim → pages/stock -│ ├── BondPage.tsx # re-export shim → pages/bond -│ ├── home/ # FSD: home page entrypoint -│ ├── stock/ # FSD: stock page entrypoint -│ ├── bond/ # FSD: bond page entrypoint -│ ├── LoginPage.tsx -│ ├── RegisterPage.tsx -│ ├── ProfilePage.tsx -│ ├── portfolios/ -│ ├── screener/ +├── entities/ # FSD business entities +│ ├── session/ # Auth/session (api, model) +│ ├── search/ # Market search query slice +│ ├── stock/ # Акции (api, model) +│ ├── bond/ # Облигации (api, model) +│ ├── portfolio/ # Портфели (api, model) +│ ├── broker-account/ # Брокерский счёт (api, model, ui) +│ ├── broker-position/ # Брокерская позиция (api, model) +│ └── broker-operation/ # Брокерская операция (api, model) +├── widgets/ # FSD compositional widgets +│ ├── search-bar/ # Поиск инструментов +│ ├── price-chart/ # График цены +│ ├── stock-details/ # Детальная карточка акции +│ ├── bond-details/ # Детальная карточка облигации +│ ├── dividends-table/ # Таблица дивидендов +│ ├── broker-account-card/ # Карточка брокерского счёта +│ ├── broker-accounts-summary/ # Сводка брокерских счетов +│ ├── broker-allocation-chart/ # График распределения +│ ├── broker-operations-table/ # Таблица операций +│ ├── portfolio-card/ # Карточка портфеля +│ ├── portfolio-form/ # Форма портфеля +│ ├── portfolio-summary/ # Сводка портфеля +│ ├── portfolio-analytics/ # Метрики портфеля +│ ├── share-positions-table/ # Таблица позиций-акций +│ └── bond-positions-table/ # Таблица позиций-облигаций +├── pages/ # FSD page entrypoints +│ ├── home/ # Главная +│ ├── stock/ # Страница акции +│ ├── bond/ # Страница облигации +│ ├── LoginPage.tsx # Вход (не мигрирован) +│ ├── RegisterPage.tsx # Регистрация (не мигрирован) +│ ├── ProfilePage.tsx # Профиль (не мигрирован) +│ ├── portfolios/ # Список и детальная портфеля (не мигрирован) +│ ├── screener/ # Скринер (не мигрирован) │ ├── broker-accounts/ # FSD: page entrypoint │ ├── broker-account/ # FSD: page entrypoint │ ├── broker-positions/ # FSD: page entrypoint │ └── broker-operations/ # FSD: page entrypoint +├── api/ +│ └── screener.ts # Screener API helpers (не мигрирован) +├── hooks/ +│ └── useScreener.ts # Screener hook (не мигрирован) +├── components/ +│ └── screener/ # Screener UI (не мигрирован) ├── test/ +│ ├── factories.ts # Фабрики тестовых данных │ ├── handlers.ts # MSW handlers -│ └── test-utils.tsx -├── api/ # historical paths + compatibility shims around shared/entities -├── context/ # historical compatibility layer -├── hooks/ # historical compatibility layer -└── components/ # historical compatibility layer +│ ├── server.ts # MSW server +│ ├── test-utils.tsx # Обёртка рендера +│ ├── setup.ts # Настройка jsdom +│ └── README.md └── styles.css ``` ## FSD-миграция -### app-слой и session-сущность +### app-слой Создан `app/` слой FSD, в который перенесены инфраструктурные модули: @@ -94,52 +102,50 @@ apps/frontend/src/ - `app/layouts/` — AppLayout (шапка + Outlet) - `app/App.tsx` — BrowserRouter → AppRoutes -Домен auth переведён в `entities/session/`: +### entities -- `entities/session/api/` — login, register, logout, refresh, getMe, updateProfile -- `entities/session/model/` — SessionContext, useSession +Домены бизнес-сущностей переведены в FSD: -Старые файлы (`api/auth.ts`, `hooks/useAuth.ts`, `context/AuthContext.tsx`, `routes.tsx`, `components/Layout.tsx`, `components/ProtectedRoute.tsx`, `App.tsx`) сохранены как ре-экспорт шмы для обратной совместимости. +| Сущность | api | model | ui | +|----------|-----|-------|----| +| `session` | login, register, refresh, logout, getMe, updateProfile | SessionContext, useSession | — | +| `stock` | getStock, getStockCandles, getStockDividends | useStock, useStockCandles, useStockDividends | — | +| `bond` | getBond, getBondCandles | useBond, useBondCandles | — | +| `portfolio` | CRUD портфелей и позиций, аналитика | usePortfolio, usePortfolios, usePortfolioAnalytics, usePortfolioMutations, usePositionMutations | — | +| `search` | — | useSearch | — | +| `broker-account` | API брокерских счетов | useBrokerAccounts, useBrokerAccountPortfolios | BrokerAccountLayout | +| `broker-position` | API брокерских позиций | useBrokerPositions | — | +| `broker-operation` | API брокерских операций | useBrokerOperations | — | -### broker-домен (пилот) +Каждая сущность имеет barrel-файл `index.ts`, реэкспортирующий публичное API. -Broker-домен переведён в пилотный FSD срез: +### widgets -- `pages/broker-*` — тонкие route entrypoints -- `widgets/broker-*` — screen-level композиция -- `entities/broker-*` — доменные срезы (api, model, ui) +Композиционные блоки UI. Каждый виджет — директория с `index.ts` и `ui/`: -### market pages (следующая итерация) +- `search-bar` — поиск с автодополнением +- `price-chart` — график цены (lightweight-charts) +- `stock-details`, `bond-details` — детальные карточки бумаг +- `dividends-table` — таблица дивидендов +- `broker-*-*` — UI брокерского домена +- `portfolio-card`, `portfolio-form`, `portfolio-summary`, `portfolio-analytics` — UI портфелей +- `share-positions-table`, `bond-positions-table` — таблицы позиций -После broker pilot market-раздел также переведён на FSD entrypoints: +### pages -- `pages/home`, `pages/stock`, `pages/bond` — primary route entrypoints; -- `widgets/search-bar`, `widgets/price-chart`, `widgets/stock-details`, - `widgets/bond-details`, `widgets/dividends-table` — primary UI entrypoints; -- `entities/search` — search query slice; -- `entities/stock` и `entities/bond` — query hooks и domain API для market pages. +- `pages/home`, `pages/stock`, `pages/bond` — FSD page entrypoints для market pages +- `pages/broker-*` — FSD page entrypoints для брокерского домена +- Временно не мигрированы: `portfolios/`, `screener/`, `LoginPage.tsx`, `RegisterPage.tsx`, `ProfilePage.tsx` -При этом orchestration остаётся в page-layer: route params, вычисление диапазонов дат, загрузка -данных и loading/not-found состояния не переносятся в widgets. +### Не мигрировано -### Остальные домены +Скринер остаётся в исторической структуре: -`screener` в основном остаётся в historical технической структуре. `portfolio` находится в -промежуточном состоянии: page-level структура ещё не полностью унифицирована, но domain API/model -слой уже вынесен в `entities/portfolio`. +- `api/screener.ts` — API-вызовы +- `hooks/useScreener.ts` — логика с URLSearchParams +- `components/screener/` — FilterPanel, FilterPanelBond, FilterPanelShare, ScreenerTable +- `pages/screener/ScreenerPage.tsx` — страница -### Legacy coexistence +Страницы аутентификации (`LoginPage`, `RegisterPage`, `ProfilePage`) — плоские, но используют FSD-импорты из `entities/session`. -После app/session, broker и market migration в проекте ещё остаются top-level `api/`, `context/`, -`hooks/`, `components/` и плоские `pages/*.tsx`. Для уже мигрированных зон они служат главным -образом как compatibility shim-слой: - -- `components/SearchBar.tsx` → `widgets/search-bar` -- `components/PriceChart.tsx` → `widgets/price-chart` -- `components/StockDetails.tsx` → `widgets/stock-details` -- `components/BondDetails.tsx` → `widgets/bond-details` -- `hooks/useSearch.ts` → `entities/search` -- `pages/HomePage.tsx`, `pages/StockPage.tsx`, `pages/BondPage.tsx` → новые page entrypoints - -Published docs описывают primary FSD entrypoints; legacy paths остаются временной поверхностью -совместимости. +ESLint-правила на границы импортов FSD пока не введены.