# eyad-abdelmohsen/library_api architecture

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

- Interactive diagram: https://gitdiagram.com/eyad-abdelmohsen/library_api
- Repository: https://github.com/eyad-abdelmohsen/library_api

## Overview

##### Project type and purpose
- This is a NestJS‐based monolithic backend REST API.
- It manages users, authors, books, and book rating statistics, and it supports JWT authentication and file uploads (images) stored under `/uploads`.

##### File structure
- Top‐level modules in `src/`:
- auth – authentication (login, token issuance)
- user – user management
- author – author CRUD
- book – book CRUD
- book-stats – rating/upsert statistics
- Each module follows the NestJS pattern:
Controllers → Services → Repositories → Models
- Cross-cutting code in `src/common`: Multer interceptor & pipe for file uploads.
- Utility code in `src/utils/jwt.ts` for signing/verifying JWTs.
- Models under `src/models` represent database schemas/entities.
- Upload directory holds persisted images.
- E2E/integration tests under `test/`.

##### README
- Uses TypeScript, Node.js, Nest CLI, and typical commands (start, test).

a. Components to include
- HTTP Gateway (NestJS Application)
- Controllers: AuthController, UserController, AuthorController, BookController, BookStatsController
- Global/Middleware: MulterInterceptor, MulterPipe
- Business Logic Layer
- Services: AuthService, UserService, AuthorService, BookService, BookStatsService
- Persistence Layer
- Repositories: UserRepository, AuthorRepository, BookRepository, BookStatsRepository
- Database (e.g., PostgreSQL/MySQL)
- Utilities
- JWT Utility (sign/verify tokens)
- File Storage
- Local FS (`/uploads`) or external blob storage
b. Relationships & data flow
1. Client ▶ HTTP request ▶ appropriate Controller
2. Controller ▶ Service (business logic)
3. Service ▶ Repository (data access) ▶ Database
4. Database ▶ Repository ▶ Service ▶ Controller ▶ HTTP response ▶ Client
5. Auth paths use JWT util to sign/validate tokens
6. File upload endpoints go through MulterInterceptor ▶ MulterPipe ▶ local storage
c. Architectural patterns & design principles
- Modular structure: each domain area is its own NestJS module.
- Layered architecture: Controller → Service → Repository → Model.
- Dependency Injection: controllers inject services; services inject repositories/utilities.
- DTOs for input validation (in `src/*/dto`).
- Cross‐cutting concerns (interceptors, pipes).
d. Key technologies
- NestJS (Modules, Controllers, Services, Interceptors, Pipes)
- TypeScript
- JWT for auth
- Multer for file uploads
- ORM/Query builder (inferred from repositories—could be TypeORM, Prisma, etc.)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% API Layer
    subgraph "API Layer"
        direction TB
        Main["HTTP Gateway"]:::api
        AppModule["AppModule"]:::api
        subgraph Controllers
            direction TB
            AuthController["AuthController"]:::api
            UserController["UserController"]:::api
            AuthorController["AuthorController"]:::api
            BookController["BookController"]:::api
            BookStatsController["BookStatsController"]:::api
        end
        subgraph "Interceptors & Pipes"
            direction TB
            MulterInterceptor["MulterInterceptor"]:::api
            MulterPipe["MulterPipe"]:::api
        end
    end

    %% Business Layer
    subgraph "Business Layer"
        direction TB
        AuthService["AuthService"]:::service
        UserService["UserService"]:::service
        AuthorService["AuthorService"]:::service
        BookService["BookService"]:::service
        BookStatsService["BookStatsService"]:::service
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        UserRepository["UserRepository"]:::repo
        AuthorRepository["AuthorRepository"]:::repo
        BookRepository["BookRepository"]:::repo
        BookStatsRepository["BookStatsRepository"]:::repo
        Database["Database"]:::repo
    end

    %% Utilities
    subgraph "Utilities"
        direction TB
        JWTUtil["JWT Utility"]:::util
    end

    %% File Storage
    FileStorage["File Storage (/uploads)"]:::storage

    %% Connections
    Client["Client"] -->|HTTP Request| Main
    Main --> AppModule
    AppModule -->|routes to| AuthController
    AppModule --> UserController
    AppModule --> AuthorController
    AppModule --> BookController
    AppModule --> BookStatsController

    AuthController -->|calls| AuthService
    UserController -->|calls| UserService
    AuthorController -->|calls| AuthorService
    BookController -->|calls| BookService
    BookStatsController -->|calls| BookStatsService

    AuthController --> MulterInterceptor
    AuthorController --> MulterInterceptor
    BookController --> MulterInterceptor
    BookStatsController --> MulterInterceptor

    MulterInterceptor --> MulterPipe
    MulterPipe --> FileStorage

    AuthService -->|uses| UserService
    AuthService --> JWTUtil
    UserService --> UserRepository
    AuthorService --> AuthorRepository
    BookService --> BookRepository
    BookStatsService --> BookStatsRepository
    BookStatsService --> BookRepository
    BookStatsService --> UserRepository

    UserRepository --> Database
    AuthorRepository --> Database
    BookRepository --> Database
    BookStatsRepository --> Database

    Database -->|returns data| BookStatsService
    Database -->|returns data| BookService
    Database -->|returns data| AuthorService
    Database -->|returns data| UserService

    AuthService -->|"issues/verifies"| JWTUtil
    AuthController -->|Token validation| JWTUtil

    Main -->|serves static| FileStorage

    Client -->|receives response| Main

    %% Click Events
    click Main "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/main.ts"
    click AppModule "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/app.module.ts"
    click AuthController "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/auth/auth.controller.ts"
    click UserController "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/user/user.controller.ts"
    click AuthorController "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/author/author.controller.ts"
    click BookController "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book/book.controller.ts"
    click BookStatsController "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book-stats/book-stats.controller.ts"
    click MulterInterceptor "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/common/interceptors/multer.interceptor.ts"
    click MulterPipe "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/common/pipes/multer.pipe.ts"
    click AuthService "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/auth/auth.service.ts"
    click UserService "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/user/user.service.ts"
    click AuthorService "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/author/author.service.ts"
    click BookService "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book/book.service.ts"
    click BookStatsService "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book-stats/book-stats.service.ts"
    click UserRepository "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/user/user.repository.ts"
    click AuthorRepository "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/author/author.repository.ts"
    click BookRepository "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book/book.repository.ts"
    click BookStatsRepository "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/book-stats/book-stats.repository.ts"
    click JWTUtil "https://github.com/eyad-abdelmohsen/library_api/blob/master/src/utils/jwt.ts"

    %% Styles
    classDef api fill:#E0F7FA,stroke:#006064,color:#006064
    classDef service fill:#E8F5E9,stroke:#1B5E20,color:#1B5E20
    classDef repo fill:#F3E5F5,stroke:#4A148C,color:#4A148C
    classDef util fill:#FFF3E0,stroke:#E65100,color:#E65100
    classDef storage fill:#FFFDE7,stroke:#F57F17,color:#F57F17
```
