# alarmouseuepg2023/server architecture

> Architecture diagram of the GitHub repository alarmouseuepg2023/server, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/alarmouseuepg2023/server
- Repository: https://github.com/alarmouseuepg2023/server

## Overview

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: [`src/application/services/device`](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/device) (Device services), [`src/infra/mqtt/client/MQTTClient.ts`](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/client/MQTTClient.ts) (MQTT client), [`src/application/services/device/UserAuthenticationAtDeviceService.ts`](https://github.com/alarmouseuepg2023/server/blob/master/src/application/services/device/UserAuthenticationAtDeviceService.ts) (Device authentication), [`src/helpers/toNumber.ts`](https://github.com/alarmouseuepg2023/server/blob/master/src/helpers/toNumber.ts) (Number conversion)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["HTTP interface"]
  node_http["HTTP API<br/>[index.ts]"]
  node_device_controller["Device controller"]
  node_invite_controller["Invite controller"]
  node_user_controller["User controller<br/>[UserController.ts]"]
end

subgraph group_application["Application services"]
  node_device_services["Device services"]
  node_device_auth["Device authentication"]
  node_status_domain["Device status rules"]
  node_alarm_services["Alarm event queries"]
  node_invite_services["Invite lifecycle"]
  node_guest_services["Guest access"]
  node_user_services["User lifecycle"]
  node_auth_services["Authentication"]
  node_number_helper["Number conversion<br/>[toNumber.ts]"]
end

subgraph group_messaging["Device messaging"]
  node_mqtt_client["MQTT client<br/>[MQTTClient.ts]"]
  node_mqtt_device["Device message handlers"]
  node_notification_client["Push notification client"]
  node_mqtt_subscription_map["Subscription callbacks"]
  node_mqtt_callback["Message callback type"]
end

subgraph group_persistence["Persistence and providers"]
  node_device_repository["Device repository"]
  node_access_repository["Access-control repository"]
  node_alarm_repository["Alarm-event repository"]
  node_database[("PostgreSQL<br/>[index.ts]")]
  node_auth_token["Token provider"]
  node_mask_provider["Mask provider<br/>[MaskProvider.ts]"]
  node_auth_token_types["Token types<br/>[AuthTokenType.ts]"]
  node_mask_interface["Mask provider interface<br/>[IMaskProvider.ts]"]
  node_validator_interface["Validator interface"]
end

node_user(("User"))
node_mqtt_broker(("MQTT broker"))

node_user -.->|"sends requests"| node_http
node_mqtt_client -->|"connects and publishes"| node_mqtt_broker
node_mqtt_client -->|"stores subscriptions"| node_mqtt_subscription_map
node_mqtt_client -.->|"invokes callback"| node_mqtt_callback
node_mqtt_device -->|"dispatches messages"| node_device_services
node_device_services -->|"inherits authentication"| node_device_auth
node_device_services -->|"validates status"| node_status_domain
node_device_services -->|"reads and updates device"| node_device_repository
node_device_services -->|"checks access control"| node_access_repository
node_device_services -->|"records status event"| node_alarm_repository
node_device_services -->|"publishes status"| node_mqtt_client
node_device_services -->|"masks device data"| node_mask_provider
node_device_auth -->|"updates access attempts"| node_access_repository
node_number_helper --> node_number_helper
node_auth_token -.->|"uses token type"| node_auth_token_types

click node_http "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/app/index.ts"
click node_device_controller "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/DeviceController.ts"
click node_invite_controller "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/InviteController.ts"
click node_user_controller "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/UserController.ts"
click node_device_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/device"
click node_device_auth "https://github.com/alarmouseuepg2023/server/blob/master/src/application/services/device/UserAuthenticationAtDeviceService.ts"
click node_status_domain "https://github.com/alarmouseuepg2023/server/blob/master/src/application/domains/DeviceStatusDomain.ts"
click node_alarm_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/alarmEvents"
click node_invite_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/invite"
click node_guest_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/guest"
click node_user_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/user"
click node_auth_services "https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/auth"
click node_mqtt_client "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/client/MQTTClient.ts"
click node_mqtt_device "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/controllers/DeviceMQTTController.ts"
click node_device_repository "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/device/implementations/PostgreSQL/Prisma/DeviceRepository.ts"
click node_access_repository "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/deviceAccessControl/implementations/PostgreSQL/Prisma/DeviceAccessControlRepository.ts"
click node_alarm_repository "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/alarmEvents/implementatios/PostgreSQL/Prisma/AlarmEventsRepository.ts"
click node_database "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/client/index.ts"
click node_notification_client "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/notifications/client/NotificationClient.ts"
click node_auth_token "https://github.com/alarmouseuepg2023/server/blob/master/src/providers/authToken/implementations/jsonwebtoken/AuthTokenProvider.ts"
click node_mask_provider "https://github.com/alarmouseuepg2023/server/blob/master/src/providers/mask/implementations/MaskProvider.ts"
click node_mqtt_subscription_map "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/models/IMqttSubscriptionMap.ts"
click node_mqtt_callback "https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/models/OnMQTTMessageCallback.ts"
click node_number_helper "https://github.com/alarmouseuepg2023/server/blob/master/src/helpers/toNumber.ts"
click node_auth_token_types "https://github.com/alarmouseuepg2023/server/blob/master/src/providers/authToken/models/AuthTokenType.ts"
click node_mask_interface "https://github.com/alarmouseuepg2023/server/blob/master/src/providers/mask/models/IMaskProvider.ts"
click node_validator_interface "https://github.com/alarmouseuepg2023/server/blob/master/src/providers/validators/models/IValidatorsProvider.ts"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_http,node_device_controller,node_invite_controller,node_user_controller,node_user toneBlue
class node_device_services,node_device_auth,node_status_domain,node_alarm_services,node_invite_services,node_guest_services,node_user_services,node_auth_services,node_number_helper toneAmber
class node_mqtt_client,node_mqtt_device,node_notification_client,node_mqtt_subscription_map,node_mqtt_callback toneMint
class node_device_repository,node_access_repository,node_alarm_repository,node_database,node_auth_token,node_mask_provider,node_auth_token_types,node_mask_interface,node_validator_interface toneRose
class node_mqtt_broker toneIndigo
```

## Components

### HTTP interface

- [HTTP API](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/app/index.ts): `src/infra/http/app/index.ts`
- [Device controller](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/DeviceController.ts): `src/infra/http/controllers/DeviceController.ts`
- [Invite controller](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/InviteController.ts): `src/infra/http/controllers/InviteController.ts`
- [User controller](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/http/controllers/UserController.ts): `src/infra/http/controllers/UserController.ts`

### Application services

- [Device services](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/device): `src/application/services/device`
- [Device authentication](https://github.com/alarmouseuepg2023/server/blob/master/src/application/services/device/UserAuthenticationAtDeviceService.ts): `src/application/services/device/UserAuthenticationAtDeviceService.ts`
- [Device status rules](https://github.com/alarmouseuepg2023/server/blob/master/src/application/domains/DeviceStatusDomain.ts): `src/application/domains/DeviceStatusDomain.ts`
- [Alarm event queries](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/alarmEvents): `src/application/services/alarmEvents`
- [Invite lifecycle](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/invite): `src/application/services/invite`
- [Guest access](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/guest): `src/application/services/guest`
- [User lifecycle](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/user): `src/application/services/user`
- [Authentication](https://github.com/alarmouseuepg2023/server/tree/master/src/application/services/auth): `src/application/services/auth`
- [Number conversion](https://github.com/alarmouseuepg2023/server/blob/master/src/helpers/toNumber.ts): `src/helpers/toNumber.ts`

### Device messaging

- [MQTT client](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/client/MQTTClient.ts): `src/infra/mqtt/client/MQTTClient.ts`
- [Device message handlers](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/controllers/DeviceMQTTController.ts): `src/infra/mqtt/controllers/DeviceMQTTController.ts`
- [Push notification client](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/notifications/client/NotificationClient.ts): `src/infra/notifications/client/NotificationClient.ts`
- [Subscription callbacks](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/models/IMqttSubscriptionMap.ts): `src/infra/mqtt/models/IMqttSubscriptionMap.ts`
- [Message callback type](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/mqtt/models/OnMQTTMessageCallback.ts): `src/infra/mqtt/models/OnMQTTMessageCallback.ts`

### Persistence and providers

- [Device repository](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/device/implementations/PostgreSQL/Prisma/DeviceRepository.ts): `src/infra/database/repositories/device/implementations/PostgreSQL/Prisma/DeviceRepository.ts`
- [Access-control repository](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/deviceAccessControl/implementations/PostgreSQL/Prisma/DeviceAccessControlRepository.ts): `src/infra/database/repositories/deviceAccessControl/implementations/PostgreSQL/Prisma/DeviceAccessControlRepository.ts`
- [Alarm-event repository](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/repositories/alarmEvents/implementatios/PostgreSQL/Prisma/AlarmEventsRepository.ts): `src/infra/database/repositories/alarmEvents/implementatios/PostgreSQL/Prisma/AlarmEventsRepository.ts`
- [PostgreSQL](https://github.com/alarmouseuepg2023/server/blob/master/src/infra/database/client/index.ts): `src/infra/database/client/index.ts`
- [Token provider](https://github.com/alarmouseuepg2023/server/blob/master/src/providers/authToken/implementations/jsonwebtoken/AuthTokenProvider.ts): `src/providers/authToken/implementations/jsonwebtoken/AuthTokenProvider.ts`
- [Mask provider](https://github.com/alarmouseuepg2023/server/blob/master/src/providers/mask/implementations/MaskProvider.ts): `src/providers/mask/implementations/MaskProvider.ts`
- [Token types](https://github.com/alarmouseuepg2023/server/blob/master/src/providers/authToken/models/AuthTokenType.ts): `src/providers/authToken/models/AuthTokenType.ts`
- [Mask provider interface](https://github.com/alarmouseuepg2023/server/blob/master/src/providers/mask/models/IMaskProvider.ts): `src/providers/mask/models/IMaskProvider.ts`
- [Validator interface](https://github.com/alarmouseuepg2023/server/blob/master/src/providers/validators/models/IValidatorsProvider.ts): `src/providers/validators/models/IValidatorsProvider.ts`

### Other components

- **User**
- **MQTT broker**

## Connections

- User → HTTP API: sends requests
- MQTT client → MQTT broker: connects and publishes (evidence: `src/infra/mqtt/client/MQTTClient.ts`)
- MQTT client → Subscription callbacks: stores subscriptions (evidence: `src/infra/mqtt/client/MQTTClient.ts`)
- MQTT client → Message callback type: invokes callback
- Device message handlers → Device services: dispatches messages (evidence: `src/infra/mqtt/controllers/DeviceMQTTController.ts`)
- Device services → Device authentication: inherits authentication (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device services → Device status rules: validates status (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device services → Device repository: reads and updates device (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device services → Access-control repository: checks access control (evidence: `src/application/services/device/UserAuthenticationAtDeviceService.ts`)
- Device services → Alarm-event repository: records status event (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device services → MQTT client: publishes status (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device services → Mask provider: masks device data (evidence: `src/application/services/device/ChangeDeviceStatusService.ts`)
- Device authentication → Access-control repository: updates access attempts (evidence: `src/application/services/device/UserAuthenticationAtDeviceService.ts`)
- Number conversion → Number conversion (evidence: `src/helpers/toNumber.ts`)
- Token provider → Token types: uses token type
