# rey9530/api_administracion architecture

> Architecture diagram of the GitHub repository rey9530/api_administracion, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rey9530/api_administracion
- Repository: https://github.com/rey9530/api_administracion

## Overview

##### Project Type and Purpose
- This is a Node.js + TypeScript monolithic backend service exposing RESTful endpoints for modules such as facturación (invoicing), inventario (inventory), reservas (reservations), usuarios (users), perfil (profiles) and authentication.
- It uses Express (via index.ts), Prisma ORM against a relational database (likely PostgreSQL via Docker Compose), file uploads, JWT auth, and includes a Jest-based test suite.

##### Main Architectural Components
a. API Server (Express.js + TypeScript)
- index.ts: boots the app, loads middleware, routes, error handlers
- src/routes/*.ts: define HTTP routes per domain (facturación, inventario, etc.)
- src/controllers/*.ts: handle route logic, call helpers or database
- src/middlewares: common concerns (JWT validation, input validation)
- src/helpers: JWT utilities, image upload/update logic

b. Persistence Layer
- Prisma schema (prisma/schema.prisma) & migrations folder
- prisma client invoked within controllers or a data-access layer
- Database container managed via docker-compose.yaml

c. File Storage
- uploads folder for storing user‐uploaded files (images, docs)
- helpers handle file naming/storing

d. Orchestration & DevOps
- docker-compose.yaml: brings up database and any auxiliary services
- .env.template: environment variables
- GitHub Actions workflows (.github/workflows/*.yml) for CI

e. Testing
- Jest config (jest.config.js) and test files (test/prisma.test.ts)

##### Component Interactions & Data Flows
- Client (frontend or API consumer) → (HTTP/S) → Express Router
- Router → Middleware (e.g., validar-jwt) → Controller
- Controller → Prisma Client → Database (CRUD operations)
- Controller → Helper (e.g., uploads) → File system
- DB migrations & seeding happen via CLI (npx prisma migrate, seed script)
- CI workflow triggers lint/test/build on push or PR

##### Architectural Patterns & Principles
- Layered structure:
1) Presentation (Routes)
2) Application (Controllers)
3) Domain/Utility (Helpers, Services)
4) Infrastructure (Prisma, File system, Docker, External services)
- Separation of concerns: each domain folder (facturación, inventario, reservas) encapsulates its routes & controllers
- Configuration-as-code: Docker Compose, .env, Prisma migrations
- Modular extensibility: adding a new domain simply involves new route/controller modules

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client"]:::external
    CI["CI/CD Pipeline"]:::ci

    subgraph "Orchestration"
        direction TB
        compose["Docker Compose"]:::docker
        subgraph "Containers"
            direction TB
            API["API Server"]:::api
            DB[(PostgreSQL Database)]:::db
        end
    end

    subgraph "API Server"
        direction TB
        index["index.ts"]:::api
        subgraph "Routes Layer"
            direction TB
            authRoutes["auth.ts"]:::routes
            factRoutes["facturacion/"]:::routes
            invRoutes["inventario/"]:::routes
            resRoutes["reservas/"]:::routes
            userRoutes["usuarios.ts"]:::routes
            perfRoutes["perfil.ts"]:::routes
            utilRoutes["utils.ts"]:::routes
        end
        subgraph "Middleware"
            direction TB
            jwt["validar-jwt.ts"]:::middleware
            campos["validar-campos.ts"]:::middleware
        end
        subgraph "Controllers Layer"
            direction TB
            authCtrl["auth.ts"]:::ctrl
            factCtrl["facturacion/"]:::ctrl
            invCtrl["inventario/"]:::ctrl
            resCtrl["reservas/"]:::ctrl
            userCtrl["usuarios.ts"]:::ctrl
            perfCtrl["perfil.ts"]:::ctrl
            uploadCtrl["uploads.ts"]:::ctrl
        end
        subgraph "Helpers"
            direction TB
            jwtHelper["jwt.ts"]:::helper
            imgHelper["actualizar-imagen.ts"]:::helper
        end
    end

    subgraph "Persistence Layer"
        direction TB
        schema["schema.prisma"]:::infra
        migrations["migrations/"]:::infra
        seed["seed.ts"]:::infra
    end

    fileStorage["uploads/"]:::storage
    public["public/index.html"]:::static
    env[".env.template"]:::env
    composeConfig["docker-compose.yaml"]:::env
    workflow1["main.yml"]:::workflow
    workflow2["pastaria.yml"]:::workflow
    jestCfg["jest.config.js"]:::test
    testPrisma["prisma.test.ts"]:::test

    Client -->|"HTTP Request"| authRoutes
    Client -->|"HTTP Request"| factRoutes
    authRoutes --> jwt
    factRoutes --> campos
    invRoutes --> campos
    resRoutes --> jwt
    userRoutes --> jwt
    perfRoutes --> jwt
    utilRoutes --> jwt

    authRoutes --> authCtrl
    factRoutes --> factCtrl
    invRoutes --> invCtrl
    resRoutes --> resCtrl
    userRoutes --> userCtrl
    perfRoutes --> perfCtrl
    utilRoutes --> uploadCtrl

    jwt --> authCtrl
    campos --> authCtrl

    authCtrl -->|Prisma Query| DB
    factCtrl -->|Prisma Query| DB
    invCtrl -->|Prisma Query| DB
    resCtrl -->|Prisma Query| DB
    userCtrl -->|Prisma Query| DB
    perfCtrl -->|Prisma Query| DB

    authCtrl --> jwtHelper
    uploadCtrl --> imgHelper
    imgHelper --> fileStorage

    API --> public

    CI -->|"Trigger Build/Test"| compose
    compose --> API
    compose --> DB
    compose --> schema
    compose --> migrations
    compose --> seed

    CI --> jestCfg
    CI --> testPrisma
    CI --> workflow1
    CI --> workflow2

    click index "https://github.com/rey9530/api_administracion/blob/main/index.ts"
    click authRoutes "https://github.com/rey9530/api_administracion/blob/main/src/routes/auth.ts"
    click factRoutes "https://github.com/rey9530/api_administracion/tree/main/src/routes/facturacion/"
    click invRoutes "https://github.com/rey9530/api_administracion/tree/main/src/routes/inventario/"
    click resRoutes "https://github.com/rey9530/api_administracion/tree/main/src/routes/reservas/"
    click userRoutes "https://github.com/rey9530/api_administracion/blob/main/src/routes/usuarios.ts"
    click perfRoutes "https://github.com/rey9530/api_administracion/blob/main/src/routes/perfil.ts"
    click utilRoutes "https://github.com/rey9530/api_administracion/blob/main/src/routes/utils.ts"
    click authCtrl "https://github.com/rey9530/api_administracion/blob/main/src/controllers/auth.ts"
    click factCtrl "https://github.com/rey9530/api_administracion/tree/main/src/controllers/facturacion/"
    click invCtrl "https://github.com/rey9530/api_administracion/tree/main/src/controllers/inventario/"
    click resCtrl "https://github.com/rey9530/api_administracion/tree/main/src/controllers/reservas/"
    click userCtrl "https://github.com/rey9530/api_administracion/blob/main/src/controllers/usuarios.ts"
    click perfCtrl "https://github.com/rey9530/api_administracion/blob/main/src/controllers/perfil.ts"
    click uploadCtrl "https://github.com/rey9530/api_administracion/blob/main/src/controllers/utils/uploads.ts"
    click jwt "https://github.com/rey9530/api_administracion/blob/main/src/middlewares/validar-jwt.ts"
    click campos "https://github.com/rey9530/api_administracion/blob/main/src/middlewares/validar-campos.ts"
    click jwtHelper "https://github.com/rey9530/api_administracion/blob/main/src/helpers/jwt.ts"
    click imgHelper "https://github.com/rey9530/api_administracion/blob/main/src/helpers/actualizar-imagen.ts"
    click schema "https://github.com/rey9530/api_administracion/blob/main/prisma/schema.prisma"
    click migrations "https://github.com/rey9530/api_administracion/tree/main/prisma/migrations/"
    click seed "https://github.com/rey9530/api_administracion/blob/main/src/database/seed.ts"
    click fileStorage "https://github.com/rey9530/api_administracion/tree/main/uploads/"
    click public "https://github.com/rey9530/api_administracion/blob/main/public/index.html"
    click env "https://github.com/rey9530/api_administracion/blob/main/.env.template"
    click composeConfig "https://github.com/rey9530/api_administracion/blob/main/docker-compose.yaml"
    click workflow1 "https://github.com/rey9530/api_administracion/blob/main/.github/workflows/main.yml"
    click workflow2 "https://github.com/rey9530/api_administracion/blob/main/.github/workflows/pastaria.yml"
    click jestCfg "https://github.com/rey9530/api_administracion/blob/main/jest.config.js"
    click testPrisma "https://github.com/rey9530/api_administracion/blob/main/test/prisma.test.ts"

    classDef external fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef api fill:#82cffe,stroke:#333,stroke-width:1px
    classDef routes fill:#3399FF,stroke:#333,stroke-width:1px
    classDef middleware fill:#CC99FF,stroke:#333,stroke-width:1px
    classDef ctrl fill:#33CC99,stroke:#333,stroke-width:1px
    classDef helper fill:#99FF99,stroke:#333,stroke-width:1px
    classDef infra fill:#66CC66,stroke:#333,stroke-width:1px
    classDef storage fill:#FFF5BA,stroke:#333,stroke-width:1px
    classDef db fill:#C3FDB8,stroke:#333,stroke-width:1px
    classDef docker fill:#B2EBF2,stroke:#333,stroke-width:1px
    classDef ci fill:#D3D3D3,stroke:#333,stroke-width:1px
    classDef env fill:#E0FFE0,stroke:#333,stroke-width:1px
    classDef workflow fill:#F0F0F0,stroke:#333,stroke-width:1px
    classDef test fill:#FFC0CB,stroke:#333,stroke-width:1px
    classDef static fill:#FFDAB9,stroke:#333,stroke-width:1px
```
