How alarmouseuepg2023/server works
Alarmouse is a backend for alarm-device management. Its apparent user workflow is to authenticate, manage devices and access permissions, and request device status changes; MQTT carries device messages and status notifications. The README provides no feature details, so several product branches below are represented from the source tree without speculative connections. Evidence is strongest for device status changes and MQTT dispatch; unsampled service relationships are intentionally left unspecified.
Main entry points: device Device services · MQTTClient.ts MQTT client · UserAuthenticationAtDeviceService.ts Device authentication · toNumber.ts Number conversion
Components 29
HTTP interface
- HTTP API
src/infra/http/app/index.ts - Device controller
src/infra/http/controllers/DeviceController.ts - Invite controller
src/infra/http/controllers/InviteController.ts - User controller
src/infra/http/controllers/UserController.ts
Application services
- Device services
src/application/services/device - Device authentication
src/application/services/device/UserAuthenticationAtDeviceService.ts - Device status rules
src/application/domains/DeviceStatusDomain.ts - Alarm event queries
src/application/services/alarmEvents - Invite lifecycle
src/application/services/invite - Guest access
src/application/services/guest - User lifecycle
src/application/services/user - Authentication
src/application/services/auth - Number conversion
src/helpers/toNumber.ts
Device messaging
- MQTT client
src/infra/mqtt/client/MQTTClient.ts - Device message handlers
src/infra/mqtt/controllers/DeviceMQTTController.ts - Push notification client
src/infra/notifications/client/NotificationClient.ts - Subscription callbacks
src/infra/mqtt/models/IMqttSubscriptionMap.ts - Message callback type
src/infra/mqtt/models/OnMQTTMessageCallback.ts
Persistence and providers
- Device repository
src/infra/database/repositories/device/implementations/PostgreSQL/Prisma/DeviceRepository.ts - Access-control repository
src/infra/database/repositories/deviceAccessControl/implementations/PostgreSQL/Prisma/DeviceAccessControlRepository.ts - Alarm-event repository
src/infra/database/repositories/alarmEvents/implementatios/PostgreSQL/Prisma/AlarmEventsRepository.ts - PostgreSQL
src/infra/database/client/index.ts - Token provider
src/providers/authToken/implementations/jsonwebtoken/AuthTokenProvider.ts - Mask provider
src/providers/mask/implementations/MaskProvider.ts - Token types
src/providers/authToken/models/AuthTokenType.ts - Mask provider interface
src/providers/mask/models/IMaskProvider.ts - Validator interface
src/providers/validators/models/IValidatorsProvider.ts
Other components
- User
- MQTT broker
Connections 15
- User → HTTP API: sends requests
- MQTT client → MQTT broker: connects and publishes
src/infra/mqtt/client/MQTTClient.ts - MQTT client → Subscription callbacks: stores subscriptions
src/infra/mqtt/client/MQTTClient.ts - MQTT client → Message callback type: invokes callback
- Device message handlers → Device services: dispatches messages
src/infra/mqtt/controllers/DeviceMQTTController.ts - Device services → Device authentication: inherits authentication
src/application/services/device/ChangeDeviceStatusService.ts - Device services → Device status rules: validates status
src/application/services/device/ChangeDeviceStatusService.ts - Device services → Device repository: reads and updates device
src/application/services/device/ChangeDeviceStatusService.ts - Device services → Access-control repository: checks access control
src/application/services/device/UserAuthenticationAtDeviceService.ts - Device services → Alarm-event repository: records status event
src/application/services/device/ChangeDeviceStatusService.ts - Device services → MQTT client: publishes status
src/application/services/device/ChangeDeviceStatusService.ts - Device services → Mask provider: masks device data
src/application/services/device/ChangeDeviceStatusService.ts - Device authentication → Access-control repository: updates access attempts
src/application/services/device/UserAuthenticationAtDeviceService.ts - Number conversion → Number conversion
src/helpers/toNumber.ts - Token provider → Token types: uses token type