# lucas-p-souza/bibliotech architecture

> Architecture diagram of the GitHub repository lucas-p-souza/bibliotech, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-25). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lucas-p-souza/bibliotech
- Repository: https://github.com/lucas-p-souza/bibliotech

## Overview

##### Project type and purpose
- BiblioTech is a RESTful backend API for library management, written in Node.js/TypeScript with Express and Prisma, using PostgreSQL as its data store. It does not include a UI, but is consumable by HTTP clients (Swagger UI, REST clients, front-end apps, etc.).

##### File structure
- Top-level folders:
- prisma/ – database schema, migrations, seed script
- src/ – application code, subdivided into controllers, middlewares, models (Swagger schemas), repositories, routes, domain entities and enums, plus the entry point (index.ts)
- http/ – sample HTTP calls for testing via VS Code REST Client
- Key config files: tsconfig.json, package.json, .env (not committed), Docker run for PostgreSQL
- Architectural patterns:
- MVC-style separation – routes → controllers → repositories/domain
- Layered architecture – HTTP layer, application layer (controllers, middleware), domain layer (entities/enums), data access layer (repositories + Prisma), persistence (PostgreSQL)

##### README for additional insights
- Confirms technologies: Express, TypeScript, Prisma ORM, JWT for auth, bcryptjs, Swagger
- Describes key flows: authentication, role-based authorization, CRUD for books/authors/categories/publishers, future loan/reservation features
- Mentions Docker for DB and Swagger UI

##### Elements
- HTTP layer = blue
- Application layer (routes/controllers/middleware) = green
- Domain layer = orange
- Data layer (repositories/Prisma) = purple
- External services (DB, JWT) = gray

##### Detail
- Middleware flows (auth checks) and where JWT validation occurs
- Where the Prisma Client is generated (prisma schema → client) and how migrations/seed fit in

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% HTTP Layer
    subgraph "HTTP Layer"
        HTTPClients["HTTP Clients\n(Swagger UI, REST, Front-End)"]:::http
    end

    %% Application Layer
    subgraph "Application Layer"
        subgraph "Routing Layer"
            Router["Express Router\n(src/routes/*.ts)"]:::routes
        end
        subgraph "Middleware Layer"
            AuthMiddleware["Auth Middleware\n(src/middlewares/auth.middleware.ts)"]:::middleware
        end
        subgraph "Controller Layer"
            AuthController["AuthController\n(src/controllers/auth.controller.ts)"]:::controller
            BookController["BookController\n(src/controllers/book.controller.ts)"]:::controller
            AuthorController["AuthorController\n(src/controllers/author.controller.ts)"]:::controller
            CategoryController["CategoryController\n(src/controllers/category.controller.ts)"]:::controller
            PublisherController["PublisherController\n(src/controllers/publisher.controller.ts)"]:::controller
            LibrarianController["LibrarianController\n(src/controllers/librarian.controller.ts)"]:::controller
        end
    end

    %% Domain Layer
    subgraph "Domain Layer"
        Entities["Domain Entities\n(src/domain/entities/)"]:::domain
        Enums["Domain Enums\n(src/domain/enums/)"]:::domain
    end

    %% Data Layer
    subgraph "Data Layer"
        Repositories["Repositories\n(src/repositories/)"]:::data
        PrismaClient["Prisma Client\n(prisma/schema.prisma)"]:::data
        SwaggerSchemas["Swagger Schemas\n(src/models/swagger.schemas.ts)"]:::data
    end

    %% Persistence & External
    subgraph "Persistence & External"
        Postgres["PostgreSQL DB\n(Docker Container)"]:::external
        Migrations["DB Migrations\n(prisma/migrations/)"]:::external
        Seed["DB Seed Script\n(prisma/seed.ts)"]:::external
    end

    %% Connections
    HTTPClients -->|"HTTP Requests"| Router
    Router -->|"Route Handling"| AuthMiddleware
    AuthMiddleware -->|"Auth & Role Check"| AuthController
    AuthMiddleware -->|"Auth & Role Check"| BookController
    AuthMiddleware -->|"Auth & Role Check"| AuthorController
    AuthMiddleware -->|"Auth & Role Check"| CategoryController
    AuthMiddleware -->|"Auth & Role Check"| PublisherController
    AuthMiddleware -->|"Auth & Role Check"| LibrarianController

    AuthController -->|"calls"| Repositories
    BookController -->|"calls"| Repositories
    AuthorController -->|"calls"| Repositories
    CategoryController -->|"calls"| Repositories
    PublisherController -->|"calls"| Repositories
    LibrarianController -->|"calls"| Repositories

    AuthController -->|"uses"| Entities
    BookController -->|"uses"| Entities
    AuthorController -->|"uses"| Entities
    CategoryController -->|"uses"| Entities
    PublisherController -->|"uses"| Entities
    LibrarianController -->|"uses"| Entities

    AuthController -->|"uses"| Enums
    BookController -->|"uses"| Enums
    AuthorController -->|"uses"| Enums
    CategoryController -->|"uses"| Enums
    PublisherController -->|"uses"| Enums
    LibrarianController -->|"uses"| Enums

    Repositories -->|"prisma.* API"| PrismaClient
    PrismaClient -->|"SQL Queries"| Postgres

    Migrations -->|"migrate"| Postgres
    Seed -->|"seed"| Postgres

    Router -->|"provides schemas"| SwaggerSchemas

    %% Click Events
    click HTTPClients "https://github.com/lucas-p-souza/bibliotech/tree/main/http/"
    click Router "https://github.com/lucas-p-souza/bibliotech/tree/main/src/routes/"
    click AuthMiddleware "https://github.com/lucas-p-souza/bibliotech/blob/main/src/middlewares/auth.middleware.ts"
    click AuthController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/auth.controller.ts"
    click BookController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/book.controller.ts"
    click AuthorController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/author.controller.ts"
    click CategoryController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/category.controller.ts"
    click PublisherController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/publisher.controller.ts"
    click LibrarianController "https://github.com/lucas-p-souza/bibliotech/blob/main/src/controllers/librarian.controller.ts"
    click Entities "https://github.com/lucas-p-souza/bibliotech/tree/main/src/domain/entities/"
    click Enums "https://github.com/lucas-p-souza/bibliotech/tree/main/src/domain/enums/"
    click Repositories "https://github.com/lucas-p-souza/bibliotech/tree/main/src/repositories/"
    click SwaggerSchemas "https://github.com/lucas-p-souza/bibliotech/blob/main/src/models/swagger.schemas.ts"
    click PrismaClient "https://github.com/lucas-p-souza/bibliotech/blob/main/prisma/schema.prisma"
    click Migrations "https://github.com/lucas-p-souza/bibliotech/tree/main/prisma/migrations/"
    click Seed "https://github.com/lucas-p-souza/bibliotech/blob/main/prisma/seed.ts"

    %% Styles
    classDef http fill:#D6E9FE,stroke:#1E70BF,stroke-width:2px;
    classDef routes fill:#DFFFE0,stroke:#2E8B57,stroke-width:2px;
    classDef middleware fill:#DFFFE0,stroke:#2E8B57,stroke-width:2px;
    classDef controller fill:#DFFFE0,stroke:#2E8B57,stroke-width:2px;
    classDef domain fill:#FFEBCD,stroke:#D2691E,stroke-width:2px;
    classDef data fill:#F3E8FF,stroke:#800080,stroke-width:2px;
    classDef external fill:#E0E0E0,stroke:#808080,stroke-width:2px;
```
