# fabioluizrodrigues/ctrl-api architecture

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

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

## Overview

This is an Express API for managing organizations, users, businesses, people, vehicles, cities, accounts, roles, and permissions. Requests enter through the server and router, then pass route-level authentication and validation before controller handlers invoke database providers. Sign-in and sign-up are public routes; most management routes require authentication. The graph groups related handlers and providers rather than listing every CRUD operation. Evidence is limited to the README (empty), the supplied excerpts, and SOURCE INDEX references; unsampled details and uncertain provider-to-database calls are omitted.

Main entry points: [`src/server/routes/index.ts`](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/routes/index.ts) (Route dispatch), [`src/server/database/providers/empresas`](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/empresas) (Business providers), [`src/server/server.ts`](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/server.ts) (Express server), [`src/index.ts`](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/index.ts) (Process entry)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_runtime["HTTP runtime"]
  node_entry["Process entry<br/>[index.ts]"]
  node_server["Express server<br/>[server.ts]"]
  node_router["Route dispatch<br/>[index.ts]"]
end

subgraph group_security["Security"]
  node_auth["Token authentication"]
  node_validation["Request validation<br/>[Validation.ts]"]
  node_jwt["JWT service<br/>[JWTService.ts]"]
end

subgraph group_domains["Domain APIs"]
  node_identity["User identity"]
  node_organizations["Organization records"]
  node_businesses["Business records"]
  node_people["People records"]
  node_fleet["Fleet and cities"]
  node_access["Roles and permissions"]
  node_assignments["Access assignments"]
  node_accounts["Account controls"]
end

subgraph group_persistence["Persistence"]
  node_orgproviders["Organization providers"]
  node_businessproviders["Business providers"]
  node_peopleproviders["People providers"]
  node_accessproviders["Access providers"]
  node_accountproviders["Account providers"]
  node_knex["Knex configuration"]
  node_tables["Table names<br/>[ETableNames.ts]"]
end

node_client(("API client"))

node_client -->|"sends requests"| node_server
node_entry -->|"starts"| node_server
node_entry -->|"runs migrations"| node_knex
node_server -->|"mounts routes"| node_router
node_router -->|"guards routes"| node_auth
node_router -->|"validates requests"| node_validation
node_router -->|"dispatches identity"| node_identity
node_router -->|"dispatches requests"| node_organizations
node_router -->|"dispatches requests"| node_businesses
node_router -->|"dispatches requests"| node_people
node_router -->|"dispatches requests"| node_fleet
node_router -->|"dispatches requests"| node_access
node_router -->|"dispatches requests"| node_assignments
node_router -->|"dispatches requests"| node_accounts
node_auth -->|"verifies tokens"| node_jwt
node_identity -->|"uses service"| node_jwt
node_organizations -.->|"uses providers"| node_orgproviders
node_businesses -->|"calls provider"| node_businessproviders
node_people -.->|"uses providers"| node_peopleproviders
node_access -->|"uses providers"| node_accessproviders
node_assignments -.->|"uses providers"| node_accessproviders
node_accounts -->|"uses providers"| node_accountproviders
node_businessproviders -->|"imports configuration"| node_knex
node_businessproviders -->|"uses table names"| node_tables

click node_entry "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/index.ts"
click node_server "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/server.ts"
click node_router "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/routes/index.ts"
click node_auth "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/middleware/EnsureAuthenticated.ts"
click node_validation "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/middleware/Validation.ts"
click node_jwt "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/services/JWTService.ts"
click node_identity "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/usuarios"
click node_organizations "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/organizacoes"
click node_businesses "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/empresas"
click node_people "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/pessoas"
click node_fleet "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/veiculos"
click node_access "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/permissoes"
click node_assignments "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/usuarios_permissoes"
click node_accounts "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/contas"
click node_orgproviders "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/oganizacoes"
click node_businessproviders "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/empresas"
click node_peopleproviders "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/pessoas"
click node_accessproviders "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/permissoes"
click node_accountproviders "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/Contas"
click node_knex "https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/knex"
click node_tables "https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/database/ETableNames.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_entry,node_server,node_router,node_client toneBlue
class node_auth,node_validation,node_jwt toneAmber
class node_identity,node_organizations,node_businesses,node_people,node_fleet,node_access,node_assignments,node_accounts toneMint
class node_orgproviders,node_businessproviders,node_peopleproviders,node_accessproviders,node_accountproviders,node_knex,node_tables toneRose
```

## Components

### HTTP runtime

- [Process entry](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/index.ts): `src/index.ts`
- [Express server](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/server.ts): `src/server/server.ts`
- [Route dispatch](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/routes/index.ts): `src/server/routes/index.ts`

### Security

- [Token authentication](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/middleware/EnsureAuthenticated.ts): `src/server/shared/middleware/EnsureAuthenticated.ts`
- [Request validation](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/middleware/Validation.ts): `src/server/shared/middleware/Validation.ts`
- [JWT service](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/shared/services/JWTService.ts): `src/server/shared/services/JWTService.ts`

### Domain APIs

- [User identity](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/usuarios): `src/server/controllers/usuarios`
- [Organization records](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/organizacoes): `src/server/controllers/organizacoes`
- [Business records](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/empresas): `src/server/controllers/empresas`
- [People records](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/pessoas): `src/server/controllers/pessoas`
- [Fleet and cities](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/veiculos): `src/server/controllers/veiculos`
- [Roles and permissions](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/permissoes): `src/server/controllers/permissoes`
- [Access assignments](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/usuarios_permissoes): `src/server/controllers/usuarios_permissoes`
- [Account controls](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/controllers/contas): `src/server/controllers/contas`

### Persistence

- [Organization providers](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/oganizacoes): `src/server/database/providers/oganizacoes`
- [Business providers](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/empresas): `src/server/database/providers/empresas`
- [People providers](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/pessoas): `src/server/database/providers/pessoas`
- [Access providers](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/permissoes): `src/server/database/providers/permissoes`
- [Account providers](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/providers/Contas): `src/server/database/providers/Contas`
- [Knex configuration](https://github.com/fabioluizrodrigues/ctrl-api/tree/master/src/server/database/knex): `src/server/database/knex`
- [Table names](https://github.com/fabioluizrodrigues/ctrl-api/blob/master/src/server/database/ETableNames.ts): `src/server/database/ETableNames.ts`

### Other components

- **API client**

## Connections

- API client → Express server: sends requests
- Process entry → Express server: starts (evidence: `src/index.ts`)
- Process entry → Knex configuration: runs migrations (evidence: `src/index.ts`)
- Express server → Route dispatch: mounts routes (evidence: `src/server/server.ts`)
- Route dispatch → Token authentication: guards routes (evidence: `src/server/routes/index.ts`)
- Route dispatch → Request validation: validates requests (evidence: `src/server/routes/index.ts`)
- Route dispatch → User identity: dispatches identity (evidence: `src/server/routes/index.ts`)
- Route dispatch → Organization records: dispatches requests (evidence: `src/server/routes/index.ts`)
- Route dispatch → Business records: dispatches requests (evidence: `src/server/routes/index.ts`)
- Route dispatch → People records: dispatches requests
- Route dispatch → Fleet and cities: dispatches requests
- Route dispatch → Roles and permissions: dispatches requests (evidence: `src/server/routes/index.ts`)
- Route dispatch → Access assignments: dispatches requests (evidence: `src/server/routes/index.ts`)
- Route dispatch → Account controls: dispatches requests (evidence: `src/server/routes/index.ts`)
- Token authentication → JWT service: verifies tokens (evidence: `src/server/shared/middleware/EnsureAuthenticated.ts`)
- User identity → JWT service: uses service (evidence: `src/server/controllers/usuarios/SignIn.ts`)
- Organization records → Organization providers: uses providers (evidence: `src/server/controllers/organizacoes/GetAll.ts`)
- Business records → Business providers: calls provider (evidence: `src/server/controllers/empresas/Create.ts`)
- People records → People providers: uses providers (evidence: `src/server/controllers/pessoas/Create.ts`)
- Roles and permissions → Access providers: uses providers (evidence: `src/server/controllers/permissoes/GetAll.ts`)
- Access assignments → Access providers: uses providers
- Account controls → Account providers: uses providers (evidence: `src/server/controllers/contas/Create.ts`)
- Business providers → Knex configuration: imports configuration (evidence: `src/server/database/providers/empresas/Create.ts`)
- Business providers → Table names: uses table names (evidence: `src/server/database/providers/empresas/Create.ts`)
