index
@mineflow/client-react / EAM
EAM
EAM (активы) — рукописные хуки. Тривиальные read'ы (useAssets/useAsset)
генерятся в ./eam.generated и ре-экспортируются ниже; здесь — write-хуки
жизненного цикла актива (register/transfer/decommission + FSM-переходы),
каждый инвалидирует список активов на успехе через useDomainMutation.
Формы тел выводятся из @mineflow/api-client (codegen из OpenAPI) → не дрейфуют.
IDEMPOTENT — плейсхолдер под required header-param; реальный ключ проставит
fetch-слой (makeAuthenticatedFetch).
Type Aliases
| Type Alias | Description |
|---|---|
| AddMaintenancePlanRepairBody | Тело добавления планового простоя (ППР): assetId, date, hours, опц. kind, description. |
| AssetComponentRow | Строка узла/агрегата (id, name, kind, state, installedAt?, warrantyUntil?, note?). |
| AssetPenetrationEntry | Проходка одного станка в пачечном ответе. |
| AssetPenetrationQuery | Опц. период проходки (from/to, ISO-даты). |
| AssetsPenetrationQuery | Опц. период проходки пачки (from/to, ISO-даты) без обязательного ids. |
| CreateAssetComponentBody | Тело добавления узла (name, kind, опц. state/installedAt/warrantyUntil/note). |
| CreateMaintenancePlanBody | Тело создания черновика графика (year, month, опц. `scopeObjectId |
| DecommissionAssetBody | Тело списания актива (coApprovedBy, reason — double-approval). |
| RecordMeterReadingBody | Тело ручного ввода показания счётчика (value, measuredAt). |
| RegisterAssetBody | Тело регистрации актива (инвентарный номер, имя, класс, текущий объект, …). |
| RejectMaintenancePlanBody | Тело отклонения графика (reason, ≥ 2 символов). |
| ScheduleMaintenanceBody | Тело планирования ТО (assetId, scheduledAt ISO-datetime, reason). |
| TransferAssetBody | Тело передачи актива (toObjectId, опц. reason). |
| UpdateAssetBody | Тело правки карточки ак тива (паспортное наименование). |
| UpdateAssetComponentBody | Тело обновления узла (все поля опциональны, в т.ч. смена state). |
| UpdateAssetPassportBody | Тело редактирования паспорта (паспортная табличка, характеристики, гарантия — все опциональны). |
| UpdateMaintenancePlanRepairBody | Тело обновления планового простоя (date/hours/kind/description — все опциональны). |
Запись
| Function | Description |
|---|---|
| useAddAssetComponent | Добавление узла актива (POST). Авто-Idempotency-Key; на успехе инвалидирует список узлов. |
| useAddMaintenancePlanRepair | Добавление планового простоя (ремонт/консервация) в черновик графика: POST /eam/maintenance-plans/:id/repairs. Только в статусе draft. Роли: Mechanic, Engineer. |
| useAgreeMaintenancePlan | Согласование графика главным механиком: FSM pending_agreement → agreed (POST /eam/maintenance-plans/:id/agree, без тела). Роли: Mechanic. Авто-Idempotency-Key; на успехе инвалидирует раздел. |
| useAmendMaintenancePlan | Пересмотр утверждённого графика: FSM approved → draft (POST /eam/maintenance-plans/:id/amend, без тела). Новая версия будет создана на следующем submit; подписи очищаются. Роли: Engineer. Авто-Idempotency-Key; на успехе инвалидирует раздел. |
| useApproveMaintenancePlan | Утверждение графика техническим директором: FSM agreed → approved (POST /eam/maintenance-plans/:id/approve, без тела). Снимок версии зафиксирован. Роли: CEO. Авто-Idempotency-Key; на успехе инвалидирует раздел. |
| useCancelMaintenance | Отмена ТО из scheduled/inProgress (POST /eam/maintenance/:id/cancel). reason обязателен. Авто-Idempotency-Key. На успехе инвалидирует список ТО. |
| useCompleteMaintenance | Завершение ТО: FSM maintenance → operational (событие COMPLETE_MAINTENANCE). ADR-0045: dedicated PATCH /eam/assets/:id/complete-maintenance; реактивно завершает открытую запись MaintenanceRecord. Тело не требуется. |
| useCompleteMaintenanceRecord | Завершение ТО: FSM inProgress → completed (PATCH /eam/maintenance/:id/complete). notes опционально. Авто-Idempotency-Key. На успехе инвалидирует список ТО. |
| useConserveAsset | Консервация актива: FSM operational → conserved (событие CONSERVE, ADR-0022). ADR-0045 (asset-centric): dedicated PATCH /eam/assets/:id/conserve. reason обязателен (OPS_REQUIRING_REASON). Запись журнала движений создаётся РЕАКТИВНО по событию eam.asset.status-changed. На успехе инвалидируется список активов. |
| useCreateMaintenancePlan | Создание черновика графика ТО/ППР на период (POST /eam/maintenance-plans, статус draft). Роли: Engineer. Авто-Idempotency-Key; на успехе инвалидирует раздел графиков. |
| useDecommissionAsset | Списание актива (double-approval). Синхронная операция — отдаёт 200, это НЕ сага. На успехе инвалидирует список активов. |
| useReactivateAsset | Расконсервация актива: FSM conserved → operational (событие REACTIVATE). ADR-0045: dedicated PATCH /eam/assets/:id/reactivate (тело не требуется). |
| useRecordMeterReading | Ручной ввод показания счётчика (EAM 1.3): POST /eam/assets/:id/meter-readings. Авто-Idempotency-Key. На успехе инвалидирует статус ТО актива. |
| useRegisterAsset | Регистрация (создание) нового актива. Авто-Idempotency-Key; на успехе инвалидирует список активов. |
| useRejectMaintenancePlan | Отклонение графика с возвратом в черновик: FSM pending_agreement |
| useRemoveAssetComponent | Удаление узла (DELETE, 204 No Content). На успехе инвалидирует список узлов. |
| useRemoveMaintenancePlanRepair | Удаление планового простоя (soft-delete): DELETE /eam/maintenance-plans/:id/repairs/:repairId. Только в статусе draft. |
| useScheduleMaintenance | Планирование ТО актива: создаёт MaintenanceRecord в статусе scheduled (POST /eam/maintenance). Авто-Idempotency-Key. На успехе инвалидирует список ТО. |
| useSendToMaintenance | Отправка актива в ТО: FSM operational → maintenance (событие SEND_TO_MAINTENANCE). ADR-0045: dedicated PATCH /eam/assets/:id/send-to-maintenance. reason обязателен. Открытая запись MaintenanceRecord заводится реактивно по событию eam.asset.status-changed. На успехе инвалидируется список активов. |
| useStartMaintenance | Начало ТО: FSM scheduled → inProgress (PATCH /eam/maintenance/:id/start, пустое тело). Авто-Idempotency-Key. На успехе инвалидирует список ТО. |
| useSubmitMaintenancePlan | Отправка графика на согласование: FSM draft → pending_agreement (POST /eam/maintenance-plans/:id/submit, без тела). Замораживает снимок проекции в версию. Роли: Engineer. Авто-Idempotency-Key; на успехе инвалидирует раздел. |
| useTransferAsset | Перемещение/передача актива на другой объект (PATCH). На успехе инвалидирует список активов. |
| useUpdateAsset | Правка карточки актива: паспортное наименование из реестра заказчика. PATCH /eam/assets/:id. Инвентарный (гаражный) номер этим хуком не меняется — он natural key реестра и в тело запроса не входит. Авто-Idempotency-Key; на успехе инвалидирует карточку и список активов. |
| useUpdateAssetComponent | Обновление узла (PATCH), в т.ч. смена состояния. Авто-Idempotency-Key; на успехе инвалидирует список узлов. |
| useUpdateAssetPassport | Редактирование паспорта актива (EAM 1.2 доработка, Задача 3a/3c): паспортная табличка, типизированные характеристики (по классу) и гарантия. PATCH /eam/assets/:id/passport, частичное обновление. Авто-Idempotency-Key; на успехе инвалидирует карточку и список активов. |
| useUpdateMaintenancePlanRepair | Изменение планового простоя (часы/дата/описание): PATCH /eam/maintenance-plans/:id/repairs/:repairId. Только в статусе draft. |
Чтение
| Function | Description |
|---|---|
| useAsset | Один актив EAM по id. |
| useAssetComponents | Узлы/агрегаты актива (Задача 3b): GET /eam/assets/:id/components. |
| useAssetHierarchy | Дерево реестра активов EAM «объект → класс → единица» (ADR-0059; серверная агрегация, фильтры objectId/status). |
| useAssetMeterReadings | История показаний счётчика актива (источник: manual/shift_report/telematics + автор). |
| useAssetMeterStatus | Статус ТО актива по наработке (EAM 1.6): остаток до ТО, средняя суточная, прогноз и статус Норма/Критично/Просрочено/Нет данных. GET /eam/assets/:id/meter-status. |
| useAssetPenetration | Помесячная проходка станка — Σ пробуренных п/м по месяцам (Задача 3d). GET /eam/assets/:id/penetration. Только для буровых (у прочих классов пусто). Не запускается при пустом id. |
| useAssets | Список активов EAM (cursor-пагинация, фильтры status/objectId/responsibleMechanicId). |
| useAssetsAll | Полный список активов: стягивает ВСЕ страницы курсора (в отличие от useAssets, который отдаёт одну страницу ≤200 и молча обрезал бы пикер на участке с >200 единицами). Курсор/лимит хук гонит сам — caller передаёт только фильтры (objectId/status/responsibleMechanicId). Ключ отдельный (…list({…, all: true})), чтобы не пересекаться с кэшем одностраничного useAssets. |
| useAssetsPenetration | Помесячная проходка ПАЧКИ станков одним запросом. Брать её здесь, а не звать useAssetPenetration из компонента строки: N строк × пер-станочный роут — это N+1 на клиенте, который упирается в rate limit (график ТО/ППР на 23 буровых давал 429). Пер-станочный хук остаётся для экрана ОДНОГО актива. |
| useMaintenancePlan | Один график ТО/ППР EAM по id (frozen-снимок для approved, живой пересчёт для draft; ADR-0070). |
| useMaintenancePlans | Список графиков ТО/ППР EAM (cursor-пагинация, фильтры year/month/status; ADR-0070). |
| useMaintenanceRecord | Одна запись ТО EAM по id. |
| useMaintenanceRecords | Список записей ТО EAM (cursor-пагинация, фильтры assetId/status). |
| useMovement | Одна запись журнала движений EAM по id. |
| useMovements | Журнал движений актива EAM (read-only, cursor-пагинация; фильтры assetId/objectId/op/status/dateFrom/dateTo). |