# jhoannpv/node-auth-clean-architecture architecture

> Architecture diagram of the GitHub repository jhoannpv/node-auth-clean-architecture, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-03-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/jhoannpv/node-auth-clean-architecture
- Repository: https://github.com/jhoannpv/node-auth-clean-architecture

## Overview

##### Main Components
- Core Layers:
- Domain: This layer contains business logic, entities, DTOs, use-cases, and domain errors. It encapsulates the core rules and processes.
- Infrastructure: This layer handles integration with external systems (like MongoDB), data mappers, and repository implementations.
- Presentation: This layer exposes the application’s API endpoints through controllers, routes, and middlewares.
- Data: Represents the database interaction configuration and models, specifically for MongoDB.
- Configuration: Contains environment configurations, security utilities (bcrypt, JWT), and validation logic.
- Supporting Components:
- The app/server bootstrap and Docker configuration (docker-compose, .env.template) that manage deployment and development setup.
- Utility files like package.json and tsconfig.json that aid in building and running the application.

##### Relationships & Interactions
- The Presentation Layer accepts incoming HTTP requests via controllers and routes. It forwards the requests to the Domain Layer.
- The Domain contains the core business logic through use cases, which use domain entities and DTOs to process input.
- Domain use cases rely on repository interfaces; these are implemented by the Infrastructure Layer.
- The Infrastructure Layer handles communication with the Data layer, mainly managing MongoDB operations via models and database configurations.
- Configuration settings are used by all layers, such as environment variables, JWT configurations, and validation utilities.
- From Presentation → Domain (Controller calls use cases)
- From Domain → Infrastructure (Use-case calls repository implementations)
- From Infrastructure → Data (Interaction with MongoDB)

##### Notable Architectural Patterns
- Clean Architecture: Clear separation of concerns with independent layers (domain, infrastructure, presentation) ensures maintainability and testability.
- Repository Pattern: Abstract data persistence through domain repositories with their concrete implementations in the infrastructure.
- Dependency Injection: Although not explicit, the structure suggests dependencies being inverted by abstracting repositories and datasources.

##### Technologies, Frameworks, or Libraries
- Node.js and TypeScript as core runtime and language.
- MongoDB for data persistence, with specific configuration and models.
- Bcrypt and JWT in the configuration folder, hinting at authentication and security.
- Docker for containerized deployment (docker-compose.yml is present).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% App/Server Bootstrap & Deployment
    subgraph "App/Server Bootstrap & Deployment"
        AppBootstrap["App Bootstrap"]
        Server["Server"]
        DockerCompose["Docker Compose"]
        EnvTemplate[".env Template"]
    end

    %% Presentation Layer
    subgraph "Presentation Layer"
        PT1["Auth Controller"]
        PT2["Auth Routes"]
        PT3["Main Routes"]
        PT4["Auth Middleware"]
    end

    %% Domain Layer
    subgraph "Domain Layer"
        DLayer["Domain Logic (Use Cases, Entities, DTOs, Domain Errors, Repositories)"]
    end

    %% Infrastructure Layer
    subgraph "Infrastructure Layer"
        ILayer["Repository Implementations & Datasources"]
    end

    %% Data Layer
    subgraph "Data Layer"
        DIndex["DB Index"]
        UModel["User Model"]
        MongoDBConfig["Mongo Database Configuration"]
    end

    %% Configuration
    subgraph "Configuration"
        ConfigEnvs["Envs"]
        ConfigBcrypt["Bcrypt"]
        ConfigJWT["JWT"]
        ConfigValidators["Validators"]
        ConfigIndex["Index Config"]
        ConfigMain["Configuration Settings"]
    end

    %% Utility Files
    subgraph "Utility Files"
        PackageJSON["Package.json"]
        TsConfig["tsconfig.json"]
    end

    %% Flow Connections
    AppBootstrap -->|"starts"| PT1
    PT1 -->|"calls"| DLayer
    DLayer -->|"invokes"| ILayer
    ILayer -->|"accesses"| DIndex

    %% Presentation internal flow
    PT1 -->|"triggers"| PT2
    PT2 -->|"leads to"| PT3
    PT3 -->|"funnels to"| PT4

    %% Data Layer internal flow
    DIndex --> UModel
    UModel --> MongoDBConfig

    %% Configuration usage (dotted arrows)
    AppBootstrap ---|"uses"| ConfigMain
    PT1 ---|"uses"| ConfigMain
    DLayer ---|"uses"| ConfigMain
    ILayer ---|"uses"| ConfigMain
    DIndex ---|"uses"| ConfigMain

    %% Click Events
    click DLayer "https://github.com/jhoannpv/node-auth-clean-architecture/tree/main/src/domain"
    click ILayer "https://github.com/jhoannpv/node-auth-clean-architecture/tree/main/src/infrastructure"
    click PT1 "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/presentation/auth/controller.ts"
    click PT2 "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/presentation/auth/routes.ts"
    click PT3 "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/presentation/routes.ts"
    click PT4 "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/presentation/middlewares/auth.middleware.ts"
    click DIndex "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/data/mongodb/index.ts"
    click UModel "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/data/mongodb/models/user.model.ts"
    click MongoDBConfig "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/data/mongodb/mongo-database.ts"
    click ConfigEnvs "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/config/envs.ts"
    click ConfigBcrypt "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/config/bcrypt.ts"
    click ConfigJWT "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/config/jwt.ts"
    click ConfigValidators "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/config/validators.ts"
    click ConfigIndex "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/config/index.ts"
    click AppBootstrap "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/app.ts"
    click Server "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/src/presentation/server.ts"
    click DockerCompose "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/docker-compose.yml"
    click EnvTemplate "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/.env.template"
    click PackageJSON "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/package.json"
    click TsConfig "https://github.com/jhoannpv/node-auth-clean-architecture/blob/main/tsconfig.json"

    %% Styles
    classDef presentation fill:#ADD8E6,stroke:#000,stroke-width:1px;
    classDef domain fill:#90EE90,stroke:#000,stroke-width:1px;
    classDef infrastructure fill:#FFFF99,stroke:#000,stroke-width:1px;
    classDef data fill:#FFB6C1,stroke:#000,stroke-width:1px;
    classDef config fill:#D3D3D3,stroke:#000,stroke-width:1px;
    classDef bootstrap fill:#FFDAB9,stroke:#000,stroke-width:1px;
    classDef utility fill:#FFA07A,stroke:#000,stroke-width:1px;

    class AppBootstrap,Server,DockerCompose,EnvTemplate bootstrap;
    class PT1,PT2,PT3,PT4 presentation;
    class DLayer domain;
    class ILayer infrastructure;
    class DIndex,UModel,MongoDBConfig data;
    class ConfigEnvs,ConfigBcrypt,ConfigJWT,ConfigValidators,ConfigIndex,ConfigMain config;
    class PackageJSON,TsConfig utility;
```
