arm-core/web/ARCHITECTURE.md
Andrey Epifancev b499787d10 docs(web): таблица корректировок — README, ARCHITECTURE, tasks (#206)
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-28 22:05:02 +04:00

8.4 KiB
Raw Blame History

Архитектура фронта arm-core/web

SPA поверх API arm-core (/api/v1). Своих данных и бизнес-вычислений нет: всё производное (чек-лист, сводная ОСВ, статусы) считает сервер, фронт показывает и отправляет действия пользователя. До 21.10.2026 фронт вёлся в отдельном репозитории RSHB/arm-web и переносился сюда синхронизацией; теперь — только здесь.

Модули

Модуль Ответственность Зависит от
src/api/ HTTP-клиент, токен, разбор ошибок conf/, auth/token
src/auth/ профиль /me, dev-вход, права для меню api/
src/services/api/ вызовы ресурсов arm-core api/, types/
src/store/ состояние экранов (Redux Toolkit) services/api/
src/utils/ чистые функции: деньги, подписи, скачивание, правила консолидаций types/
src/hooks/ общие React-хуки (виртуальный список, предупреждение beforeunload) React
src/types/ DTO API (повторяют ../api/src/schemas/) —
src/components/ примитивы UI (таблица, теги, заголовок) antd
src/widgets/ блоки экранов (DocumentReview — проверка документа со сканом, ConsolidatedOsv — сводная ОСВ, FilesDrawer; консолидации — см. ниже) components/, store/, services/api/, utils/
src/layouts/ страницы-маршруты widgets/

Виджеты экранов консолидаций

Требования — ../openspec/changes/consolidations-ui/ (после архивации — ../openspec/specs/consolidations-ui/), consolidation-setup, consolidated-osv-ui.

Виджет Экран Что делает
ConsoleTable/ConsoleTable.tsx [34] список консолидаций ГК: дерево версий, «Только в работе» (in_work_only), действия строки, меню «⋯»
ConsoleTable/LockModal.tsx [35] «Взять в работу» (POST …/lock) и перехват с причиной (takeover_reason)
../utils/consolidations.ts — правила без React: подписи и пояснения статусов версии, ручные переходы (MANUAL_TRANSITIONS — зеркало бэка), своя блокировка, «Версия», in_work_only, причина ≤ 1000
ConsoleTable/consts.ts — цвета бейджей статусов версии
ConsolidatedOsv/OsvTabs.tsx [30] вкладки шагов отчёта и модалка «Проверьте встречные записи участников» при уходе с «ОСВ» (список пар — counter_pairs сводки)
ConsolidatedOsv/CounterPairsView.tsx [30] режим «Встречные записи» вкладки «ОСВ»: пары, строки держателя, строки Б без ИНН с «Указать»
ConsolidatedOsv/counterPairs.ts — правила без React: подпись пары, параметры адреса режима (?view=pairs&holder=&missing=)
ConsolidatedOsv/useNumberDisplay.tsx [30] «Единицы» и «Знаков после запятой» сводной ОСВ (formatScaledAmount из utils/money.ts)
../hooks/useBeforeUnload.ts — предупреждение браузера о несохранённых правках в открытой модалке
ConsoleLegalEntities/ [34] панель «Организации» выбранной версии и чек-лист
NewConsoleModal/ (CompanyOptionRow.tsx) [42] «Новая консолидация»; строка ЮЛ с ИНН отдельной колонкой
StatusChangeModal/ChangeStatusModal.tsx [33-01] «Изменить статус» (POST …/status); открывается из шапки layouts/ConsolidationReportPage.tsx

Виджет «Таблица корректировки» (widgets/CorrectionTable/)

Требования — ../openspec/changes/corrections-table-ui/ (спека corrections-table-ui, решения — design.md). Контракт — ../../docs/dev/api-contract-corrections.md, типы — src/types/corrections.ts, вызовы — src/services/api/corrections.ts (под флагом REACT_APP_CORRECTIONS_MOCK вместо HTTP — correctionsFake.ts, см. README).

Поток данных: страница отчёта → CorrectionContent (вкладка: загрузка, ошибка с «Повторить», экспорт, полный экран) → хук useCorrectionTable (запрос; применяется только ответ последнего запроса, latestOnly) → таблица целиком хранится в родителе; CorrectionTable только рисует, фильтры/раскрытие/колонки — состояние родителя. Решение по строке (флажок, меню) → allocate → таблица заменяется ответом; «Корректировать» → CorrectionEditorModal → saveCorrection (PUT, expected_version_no) → подмена одного агрегата; отмена — RevokeModal → revokeCorrection. Черновик окна — localStorage (draftStorage).

Файл Тип Что делает
tableModel.ts чистый строки таблицы (агрегат, его строки ОСВ, нераспределённые), фильтры, пресет правила, итоги
editorModel.ts чистый состояние окна: исходное из агрегата, проверки ввода, контроль баланса, кандидаты в picker, пересборка
editorView.ts чистый тексты окна: ошибки сохранения, плашка черновика, строка контроля, подпись «Выбрать»
readOnly.ts чистый подсказки «только чтение», меню строки (allocationMenu), тело запроса разнесения
draftStorage.ts чистый черновик окна в localStorage (ключ: пользователь + версия + агрегат)
columns.ts чистый ключи и группы колонок для «Настройки таблицы»
useCorrectionTable.ts хук загрузка, reload/replace/replaceAggregate
CorrectionContent.tsx, CorrectionToolbar.tsx, CorrectionTable.tsx, HeaderFilter.tsx компоненты вкладка, панель, таблица с группами колонок, воронки в заголовках
CorrectionEditorModal.tsx, EditorSide.tsx, AllocationPicker.tsx, RevokeModal.tsx компоненты окно «Корректировка операции», сторона окна, выбор нераспределённой строки, отмена
mockData.ts, mockCalc.ts фейк данные дизайна и пересчёт агрегата; вырезаются при подключении API
../../utils/money.ts чистый деньги копейками (toCents, percentOfSmaller, порог 5 %)

Чистые модули покрыты vitest (*.test.ts); компоненты тестов не имеют (нет DOM-библиотеки), их проверяют в браузере.

Границы

  • Сетевые запросы — только через src/api/client.ts; fetch напрямую не вызывается.
  • components/ не знают про store и API; types/ ни от чего не зависят.
  • utils/ не импортирует React, store и API.

Сборка

npm run build → web/dist, Dockerfile ядра кладёт его в api/web/ и FastAPI отдаёт SPA (../README.md).