docs: clarify domain and agent authority

This commit is contained in:
2026-08-25 12:06:41 +03:00
parent c68c978c91
commit 0c53c50c62
3 changed files with 66 additions and 7 deletions
+56 -4
View File
@@ -1,5 +1,30 @@
# Глоссарий домена
## User
Локальный владелец данных WealthLedger, идентифицируемый `id` и
нормализованным email. User владеет Session, T-Bank connection и видит только
свои Brokerage Accounts.
_Не использовать_: клиент T-Bank, инвестор T-Bank.
## Session
Локальная authenticated-сессия User: короткоживущий access token в браузере и
server-side refresh token rotation через cookie. Session не является
T-Bank connection и не подтверждает доступ к Brokerage Account без текущего
Bearer token.
_Не использовать_: T-Bank сессия, browser session.
## Money
Денежная сумма в одной ISO-валюте, передаваемая как `{ currency, value }`, где
`value` — decimal string без экспоненциальной записи. Backend выполняет точные
операции, frontend форматирует Money для отображения.
_Не использовать_: number amount, MoneyDto как доменный термин.
## T-Bank connection
Единственное принадлежащее User подключение к T-Bank Invest, содержащее
@@ -17,7 +42,8 @@ _Не использовать_: счёт T-Bank, банковский счёт.
## Investment Account Type
Нормализованная категория Brokerage Account, независимая от upstream enum
T-Bank.
T-Bank: `BROKERAGE`, `INDIVIDUAL_INVESTMENT`, `INVEST_BOX` или
`MONEY_MARKET_FUND`.
_Не использовать_: тип аккаунта T-Bank, protobuf type.
@@ -35,6 +61,14 @@ _Не использовать_: общий портфель, баланс сч
_Не использовать_: валютная позиция, виртуальная позиция.
## Portfolio Position Type
Нормализованный display type Portfolio Position, полученный из upstream
instrument type: `STOCK`, `BOND`, `FUND`, `CURRENCY`, `FUTURE`, `OPTION`,
`STRUCTURED_NOTE`, `DIGITAL_FINANCIAL_ASSET` или `OTHER`.
_Не использовать_: upstream instrument type как доменный enum.
## Instrument
Ценная бумага или иной торгуемый актив T-Bank, на который ссылается Portfolio
@@ -56,7 +90,7 @@ _Не использовать_: аватар актива, иконка бум
## Cash Balance
Ненулевой доступный денежный остаток Portfolio в одной валюте; не является
Portfolio Position.
Portfolio Position и передаётся отдельно от `positions` в `cashBalances`.
_Не использовать_: валютная позиция, заблокированные средства.
@@ -87,10 +121,19 @@ _Не использовать_: история Portfolio, баланс счёт
Нормализованное представление одной операции T-Bank в Account Ledger; хранит
исходные суммы и доступные детали операции, не создавая синтетических записей
для комиссии сделки.
для комиссии сделки. API/code сохраняют legacy names `BrokerageOperationDto`,
`BrokerageOperationsPageDto` и `/operations`; в доменной документации primary
term — Ledger Entry.
_Не использовать_: проводка, рассчитанная операция.
## Operation Category
Нормализованная категория Ledger Entry для фильтрации и отображения:
`trade`, `income`, `tax`, `fee`, `transfer` или `other`.
_Не использовать_: upstream operation type как category.
## Ledger Page Cache
Кэш страницы Account Ledger, отделённый от кэша отдельных операций.
@@ -124,6 +167,15 @@ _Не использовать_: активный refresh token, признак
Прогнозируемое на ближайший период денежное или связанное корпоративное
событие одного Brokerage Account, рассчитанное по текущей Portfolio Position;
не является исполненной Ledger Entry.
не является исполненной Ledger Entry. API/code сохраняют legacy names
`UpcomingEventDto`, `UpcomingEventsDto`, `/events` и frontend `BrokerageEvent`;
в доменной документации primary term — Future Cash Event.
_Не использовать_: будущая операция, гарантированная выплата.
## Future Cash Event Type
Нормализованный тип Future Cash Event: `coupon`, `dividend`, `maturity` или
`offer`.
_Не использовать_: upstream dividend type, MOEX row name.