# tritrackit/api architecture

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

- Interactive diagram: https://gitdiagram.com/tritrackit/api
- Repository: https://github.com/tritrackit/api

## Overview

Tri-TrackIT is a NestJS warehouse-tracking API for monitoring complete built units (CBUs) through RFID, with user and role management, reporting, and live updates. The principal workflow is a client or RFID device submitting tracking activity to the API, which supports unit operations and emits real-time updates; users can also request dashboards and reports. The README documents the product’s broader capabilities, while the excerpts directly confirm only selected controller calls and integrations, so unverified service wiring is left dashed or omitted.

Main entry points: [`src/services/auth.service.ts`](https://github.com/tritrackit/api/blob/main/src/services/auth.service.ts) (Authentication logic), [`src/services/employee-user.service.ts`](https://github.com/tritrackit/api/blob/main/src/services/employee-user.service.ts) (User management), [`src/db/entities`](https://github.com/tritrackit/api/tree/main/src/db/entities) (Warehouse and user entities), [`src/services/units.service.ts`](https://github.com/tritrackit/api/blob/main/src/services/units.service.ts) (Unit tracking operations)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API surface"]
  node_auth_api["Authentication API<br/>[auth.controller.ts]"]
  node_users_api["Employee user API"]
  node_roles_api["Roles API<br/>[role.controller.ts]"]
  node_units_api["Units API"]
  node_locations_api["Locations API"]
  node_models_api["Models API"]
  node_scanners_api["Scanners API"]
  node_stats_api["Statistics API"]
  node_metadata_api["Metadata API"]
  node_config_api["System configuration API"]
end

subgraph group_warehouse["Warehouse tracking"]
  node_unit_ops["Unit tracking operations<br/>[units.service.ts]"]
  node_locations["Location management"]
  node_models["Model management<br/>[model.service.ts]"]
  node_scanners["Scanner management<br/>[scanner.service.ts]"]
  node_statistics["Reports and dashboards"]
end

subgraph group_identity["Identity and access"]
  node_auth["Authentication logic<br/>[auth.service.ts]"]
  node_users["User management"]
  node_roles["Role management<br/>[roles.service.ts]"]
end

subgraph group_data["Persistence"]
  node_postgres[("PostgreSQL")]
  node_typeorm["TypeORM configuration<br/>[typeorm.service.ts]"]
  node_entities[("Warehouse and user entities")]
  node_cache["Application cache<br/>[cache.service.ts]"]
end

subgraph group_realtime["Notifications and integrations"]
  node_email["Email service<br/>[email.service.ts]"]
  node_pusher_service["Live update service<br/>[pusher.service.ts]"]
  node_gateway["RFID WebSocket gateway<br/>[rfid.gateway.ts]"]
end

node_client(("API client"))
node_rfid(("RFID device"))
node_pusher["Pusher"]

node_client -->|"requests"| node_auth_api
node_client -->|"requests"| node_users_api
node_client -->|"requests"| node_roles_api
node_client -->|"requests"| node_units_api
node_client -->|"requests"| node_locations_api
node_client -->|"requests"| node_models_api
node_client -->|"requests"| node_scanners_api
node_client -->|"requests"| node_stats_api
node_client -.->|"requests"| node_metadata_api
node_client -.->|"requests"| node_config_api
node_rfid -.->|"scans units"| node_units_api
node_auth_api -->|"invokes"| node_auth
node_users_api -->|"invokes"| node_users
node_stats_api -->|"requests reports"| node_statistics
node_units_api -.->|"invokes"| node_unit_ops
node_roles_api -.->|"invokes"| node_roles
node_locations_api -.->|"invokes"| node_locations
node_models_api -.->|"invokes"| node_models
node_scanners_api -.->|"invokes"| node_scanners
node_metadata_api -->|"queries"| node_entities
node_auth -->|"reads and writes"| node_entities
node_typeorm -->|"registers"| node_entities
node_typeorm -->|"configures connection"| node_postgres
node_auth -->|"uses"| node_cache
node_auth -.->|"uses"| node_email
node_users -->|"uses"| node_email
node_users -->|"uses"| node_cache
node_users -.->|"persists users"| node_entities
node_unit_ops -->|"uses"| node_cache
node_unit_ops -->|"publishes updates"| node_pusher_service
node_pusher_service -->|"references"| node_gateway
node_pusher_service -.->|"sends live updates"| node_pusher

click node_auth_api "https://github.com/tritrackit/api/blob/main/src/controller/auth/auth.controller.ts"
click node_users_api "https://github.com/tritrackit/api/blob/main/src/controller/employee-user/employee-user.controller.ts"
click node_roles_api "https://github.com/tritrackit/api/blob/main/src/controller/role/role.controller.ts"
click node_units_api "https://github.com/tritrackit/api/blob/main/src/controller/unit/units.controller.ts"
click node_locations_api "https://github.com/tritrackit/api/blob/main/src/controller/locations/locations.controller.ts"
click node_models_api "https://github.com/tritrackit/api/blob/main/src/controller/model/model.controller.ts"
click node_scanners_api "https://github.com/tritrackit/api/blob/main/src/controller/scanner/scanner.controller.ts"
click node_stats_api "https://github.com/tritrackit/api/blob/main/src/controller/statistics/statistics.controller.ts"
click node_metadata_api "https://github.com/tritrackit/api/blob/main/src/controller/meta-data/metadata.controller.ts"
click node_config_api "https://github.com/tritrackit/api/blob/main/src/controller/system-config/system-config.controller.ts"
click node_auth "https://github.com/tritrackit/api/blob/main/src/services/auth.service.ts"
click node_users "https://github.com/tritrackit/api/blob/main/src/services/employee-user.service.ts"
click node_roles "https://github.com/tritrackit/api/blob/main/src/services/roles.service.ts"
click node_unit_ops "https://github.com/tritrackit/api/blob/main/src/services/units.service.ts"
click node_locations "https://github.com/tritrackit/api/blob/main/src/services/locations.service.ts"
click node_models "https://github.com/tritrackit/api/blob/main/src/services/model.service.ts"
click node_scanners "https://github.com/tritrackit/api/blob/main/src/services/scanner.service.ts"
click node_statistics "https://github.com/tritrackit/api/blob/main/src/services/statistics.service.ts"
click node_typeorm "https://github.com/tritrackit/api/blob/main/src/db/typeorm/typeorm.service.ts"
click node_entities "https://github.com/tritrackit/api/tree/main/src/db/entities"
click node_cache "https://github.com/tritrackit/api/blob/main/src/services/cache.service.ts"
click node_email "https://github.com/tritrackit/api/blob/main/src/services/email.service.ts"
click node_pusher_service "https://github.com/tritrackit/api/blob/main/src/services/pusher.service.ts"
click node_gateway "https://github.com/tritrackit/api/blob/main/src/gateways/rfid.gateway.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_auth_api,node_users_api,node_roles_api,node_units_api,node_locations_api,node_models_api,node_scanners_api,node_stats_api,node_metadata_api,node_config_api,node_client toneBlue
class node_unit_ops,node_locations,node_models,node_scanners,node_statistics toneAmber
class node_auth,node_users,node_roles toneMint
class node_postgres,node_typeorm,node_entities,node_cache toneRose
class node_email,node_pusher_service,node_gateway,node_rfid,node_pusher toneIndigo
```

## Components

### API surface

- [Authentication API](https://github.com/tritrackit/api/blob/main/src/controller/auth/auth.controller.ts): `src/controller/auth/auth.controller.ts`
- [Employee user API](https://github.com/tritrackit/api/blob/main/src/controller/employee-user/employee-user.controller.ts): `src/controller/employee-user/employee-user.controller.ts`
- [Roles API](https://github.com/tritrackit/api/blob/main/src/controller/role/role.controller.ts): `src/controller/role/role.controller.ts`
- [Units API](https://github.com/tritrackit/api/blob/main/src/controller/unit/units.controller.ts): `src/controller/unit/units.controller.ts`
- [Locations API](https://github.com/tritrackit/api/blob/main/src/controller/locations/locations.controller.ts): `src/controller/locations/locations.controller.ts`
- [Models API](https://github.com/tritrackit/api/blob/main/src/controller/model/model.controller.ts): `src/controller/model/model.controller.ts`
- [Scanners API](https://github.com/tritrackit/api/blob/main/src/controller/scanner/scanner.controller.ts): `src/controller/scanner/scanner.controller.ts`
- [Statistics API](https://github.com/tritrackit/api/blob/main/src/controller/statistics/statistics.controller.ts): `src/controller/statistics/statistics.controller.ts`
- [Metadata API](https://github.com/tritrackit/api/blob/main/src/controller/meta-data/metadata.controller.ts): `src/controller/meta-data/metadata.controller.ts`
- [System configuration API](https://github.com/tritrackit/api/blob/main/src/controller/system-config/system-config.controller.ts): `src/controller/system-config/system-config.controller.ts`

### Warehouse tracking

- [Unit tracking operations](https://github.com/tritrackit/api/blob/main/src/services/units.service.ts): `src/services/units.service.ts`
- [Location management](https://github.com/tritrackit/api/blob/main/src/services/locations.service.ts): `src/services/locations.service.ts`
- [Model management](https://github.com/tritrackit/api/blob/main/src/services/model.service.ts): `src/services/model.service.ts`
- [Scanner management](https://github.com/tritrackit/api/blob/main/src/services/scanner.service.ts): `src/services/scanner.service.ts`
- [Reports and dashboards](https://github.com/tritrackit/api/blob/main/src/services/statistics.service.ts): `src/services/statistics.service.ts`

### Identity and access

- [Authentication logic](https://github.com/tritrackit/api/blob/main/src/services/auth.service.ts): `src/services/auth.service.ts`
- [User management](https://github.com/tritrackit/api/blob/main/src/services/employee-user.service.ts): `src/services/employee-user.service.ts`
- [Role management](https://github.com/tritrackit/api/blob/main/src/services/roles.service.ts): `src/services/roles.service.ts`

### Persistence

- **PostgreSQL**
- [TypeORM configuration](https://github.com/tritrackit/api/blob/main/src/db/typeorm/typeorm.service.ts): `src/db/typeorm/typeorm.service.ts`
- [Warehouse and user entities](https://github.com/tritrackit/api/tree/main/src/db/entities): `src/db/entities`
- [Application cache](https://github.com/tritrackit/api/blob/main/src/services/cache.service.ts): `src/services/cache.service.ts`

### Notifications and integrations

- [Email service](https://github.com/tritrackit/api/blob/main/src/services/email.service.ts): `src/services/email.service.ts`
- [Live update service](https://github.com/tritrackit/api/blob/main/src/services/pusher.service.ts): `src/services/pusher.service.ts`
- [RFID WebSocket gateway](https://github.com/tritrackit/api/blob/main/src/gateways/rfid.gateway.ts): `src/gateways/rfid.gateway.ts`

### Other components

- **API client**
- **RFID device**
- **Pusher**

## Connections

- API client → Authentication API: requests (evidence: `README.md`)
- API client → Employee user API: requests (evidence: `README.md`)
- API client → Roles API: requests (evidence: `README.md`)
- API client → Units API: requests (evidence: `README.md`)
- API client → Locations API: requests (evidence: `README.md`)
- API client → Models API: requests (evidence: `README.md`)
- API client → Scanners API: requests (evidence: `README.md`)
- API client → Statistics API: requests (evidence: `README.md`)
- API client → Metadata API: requests
- API client → System configuration API: requests
- RFID device → Units API: scans units
- Authentication API → Authentication logic: invokes (evidence: `src/controller/auth/auth.controller.ts`)
- Employee user API → User management: invokes (evidence: `src/controller/employee-user/employee-user.controller.ts`)
- Statistics API → Reports and dashboards: requests reports (evidence: `src/controller/statistics/statistics.controller.ts`)
- Units API → Unit tracking operations: invokes
- Roles API → Role management: invokes
- Locations API → Location management: invokes
- Models API → Model management: invokes
- Scanners API → Scanner management: invokes
- Metadata API → Warehouse and user entities: queries (evidence: `src/controller/meta-data/metadata.controller.ts`)
- Authentication logic → Warehouse and user entities: reads and writes (evidence: `src/services/auth.service.ts`)
- TypeORM configuration → Warehouse and user entities: registers (evidence: `src/db/typeorm/typeorm.service.ts`)
- TypeORM configuration → PostgreSQL: configures connection (evidence: `src/db/typeorm/typeorm.service.ts`)
- Authentication logic → Application cache: uses (evidence: `src/services/auth.service.ts`)
- Authentication logic → Email service: uses (evidence: `src/services/auth.service.ts`)
- User management → Email service: uses (evidence: `src/services/employee-user.service.ts`)
- User management → Application cache: uses (evidence: `src/services/employee-user.service.ts`)
- User management → Warehouse and user entities: persists users
- Unit tracking operations → Application cache: uses (evidence: `src/services/units.service.ts`)
- Unit tracking operations → Live update service: publishes updates (evidence: `src/services/units.service.ts`)
- Live update service → RFID WebSocket gateway: references (evidence: `src/services/pusher.service.ts`)
- Live update service → Pusher: sends live updates
