Перейти к основному содержимому

index

@mineflow/api-schemas


@mineflow/api-schemas

Enumerations

EnumerationDescription
FuelSupplyRequestStatusСтатусы заявки на поставку ГСМ (SCM FuelSupplyRequest) — значения совпадают с ключами состояний fuelSupplyRequestMachine. Для лейблов и фильтров в UI.
FuelTankDerivedStatusПроизводный статус топливного резервуара (SCM) — НЕ FSM-статус, а вычисляемый по остатку индикатор для UI (бейдж/цвет уровня заполнения). Считается функцией computeFuelTankDerivedStatus.
ShiftReportStatusСтатусы сменного рапорта (PRD ShiftReport) — центральный агрегат PRD 1.0.

Type Aliases

Type AliasDescription
AssetMovementOpТип-объединение значений AssetMovementOp.
AssetMovementStatusТип-объединение значений AssetMovementStatus.
AssetStatusТип-объединение значений AssetStatus (`'operational'
MaintenanceStatusТип-объединение значений MaintenanceStatus.
PersonnelStatusТип-объединение значений PersonnelStatus.
ProductionPlanHorizonТип-объединение значений ProductionPlanHorizon (`'year'
ProductionPlanStatusТип-объединение значений ProductionPlanStatus.
ProductionPlanVersionStatusТип-объединение значений ProductionPlanVersionStatus.
ShiftTypeТип-объединение значений ShiftType (`'day'
SupplierStatusТип-объединение значений SupplierStatus.
SystemRoleКанонический RBAC-контракт MineFlow — 7 системных ролей в PascalCase.
TimesheetEntryStatusТип-объединение значений TimesheetEntryStatus.
TmcInventoryStatusТип-объединение значений TmcInventoryStatus.
TmcRequestStatusТип-объединение значений TmcRequestStatus.
TmcTransferStatusТип-объединение значений TmcTransferStatus.
UserAccountStatusТип-объединение значений UserAccountStatus.
WatchAssignmentStatusТип-объединение значений WatchAssignmentStatus.

Variables

VariableDescription
assetAssignmentMachineFSM закрепления техники за сотрудником (HR AssetAssignment) — temporal-only.
assetMachineFSM жизненного цикла единицы техники/оборудования (EAM Asset).
assetMovementMachineFSM записи журнала движений техники (EAM AssetMovement).
AssetMovementOpТип операции в записи журнала движений техники (EAM AssetMovement) — что именно зафиксировано в аудит-журнале актива. Для лейблов и фильтров в UI.
AssetMovementStatusСтатусы записи журнала движений техники (EAM AssetMovement) — значения совпадают с ключами состояний assetMovementMachine. Запись создаётся в Draft и сразу применяется в Applied (ADR-0045). Для лейблов в UI.
AssetStatusСтатусы единицы техники (EAM Asset) — значения совпадают с ключами состояний assetMachine и со строкой status в REST-ответах. Для лейблов и фильтров в UI: ключи в PascalCase, значения — lowercase-строки.
fuelSupplyRequestMachineFSM заявки на поставку ГСМ (SCM FuelSupplyRequest).
maintenanceRecordMachineFSM записи об обслуживании техники (EAM MaintenanceRecord).
MaintenanceStatusСтатусы записи об обслуживании (EAM MaintenanceRecord) — значения совпадают с ключами состояний maintenanceRecordMachine. Для лейблов и фильтров в UI.
OPS_REQUIRING_REASONМножество операций, для которых обязательна причина (reason). Сейчас это только AssetMovementOp.Conservation. Используется доменной валидацией; на фронте полезно для условного показа поля «причина».
personnelMachineFSM жизненного цикла сотрудника (HR Personnel).
PersonnelStatusСтатусы сотрудника (HR Personnel) — значения совпадают с ключами состояний personnelMachine. Для лейблов и фильтров в UI.
ProductionPlanHorizonГоризонт планирования производственного плана. Для лейблов и фильтров в UI.
productionPlanMachineFSM производственного плана (PRD ProductionPlan) — годовой/месячный план добычи.
ProductionPlanStatusСтатусы производственного плана (PRD ProductionPlan) — значения совпадают с ключами состояний productionPlanMachine. Для лейблов и фильтров в UI.
ProductionPlanVersionStatusСтатусы версии производственного плана (sub-FSM согласования у CEO). В отличие от ProductionPlanStatus описывает не сам план, а конкретную его версию-поправку. Для лейблов и фильтров в UI.
ShiftTypeТип смены вахтового назначения. Для лейблов и фильтров в UI.
supplierMachineFSM поставщика (SCM Supplier) — жизненный цикл карточки контрагента от черновика до архива.
SupplierStatusСтатусы поставщика (SCM Supplier). NB: значения здесь в camelCase ('underReview'), тогда как состояния supplierMachine используют snake_case ('under_review') — это лейбл-энум для UI, не ключи FSM напрямую. Для лейблов и фильтров в UI.
timesheetEntryMachineFSM строки табеля учёта рабочего времени (HR TimesheetEntry).
TimesheetEntryStatusFSM-статусы TimesheetEntry (docs/modules/hr/timesheet/state-machines.md).
TMC_REQUEST_TERMINAL_STATUSESМножество терминальных статусов заявки на ТМЦ (Fulfilled, Rejected, TMC-INV-09). Из них переходы недоступны — на фронте удобно для проверки «заявка закрыта».
tmcInventoryMachineFSM инвентаризации ТМЦ (SCM TmcInventory).
TmcInventoryStatusСтатусы инвентаризации ТМЦ (SCM TmcInventory) — значения совпадают с ключами нетерминальных состояний tmcInventoryMachine. Для лейблов и фильтров в UI.
tmcRequestMachineFSM заявки на ТМЦ (SCM TmcRequest) — от черновика до исполнения.
TmcRequestStatusСтатусы заявки на ТМЦ (SCM TmcRequest) — значения совпадают с ключами состояний tmcRequestMachine. Для лейблов и фильтров в UI.
tmcTransferMachineFSM перемещения ТМЦ между складами (SCM TmcTransfer).
TmcTransferStatusСтатусы перемещения ТМЦ между складами (SCM TmcTransfer) — значения совпадают с ключами нетерминальных состояний tmcTransferMachine. Для лейблов и фильтров в UI.
userAccountMachineFSM учётной записи пользователя (HR UserAccount).
UserAccountStatusСтатусы учётной записи (HR UserAccount) — значения совпадают с ключами состояний userAccountMachine. Для лейблов и фильтров в UI.
watchAssignmentMachineFSM вахтового назначения сотрудника (HR WatchAssignment) — заезд на вахту, присутствие и отъезд.
WatchAssignmentStatusСтатусы вахтового назначения (HR WatchAssignment) — значения совпадают с ключами состояний watchAssignmentMachine. Для лейблов и фильтров в UI.

Functions

FunctionDescription
computeFuelTankDerivedStatusВычисляет производный статус резервуара по остатку относительно ёмкости и минимального уровня.
isShiftTypeType guard: является ли строка валидным ShiftType.
isTimesheetEntryStatusType guard: является ли произвольное значение валидным TimesheetEntryStatus. Полезно для безопасного сужения типа при разборе внешних данных (REST-ответ, query-параметр).
isWatchAssignmentStatusType guard: является ли строка валидным WatchAssignmentStatus.