# raid-training-initiative/rti-api architecture

> Architecture diagram of the GitHub repository raid-training-initiative/rti-api, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/raid-training-initiative/rti-api
- Repository: https://github.com/raid-training-initiative/rti-api

## Overview

##### Main Components

a) Client Layer:
- External Clients (Web Interfaces, Third-party Applications)
- Discord Authentication Integration
- Postman Testing Environment

b) API Layer:
- Authentication Middleware
- Request Handlers (organized by domain)
- Error Handling Middleware

c) Data Layer:
- MongoDB Database
- Database Schemas
- Data Transfer Objects (DTOs)

##### External Interfaces
- HTTP endpoints grouped by domain (Categories, Comps, Members, Raids, etc.)
- Discord OAuth2 authentication flow
- Bearer token authentication path

##### Core API Components (from src/)
- Request Handlers
- Categories
- Comps
- Members
- Raids
- TrainingRequests
- GuildOptions

##### Authentication System
- Service Client Authentication
- Discord User Authentication
- Token Validation

##### Error Handling System
- Custom Exception Types
- Error Middleware
- HTTP Status Codes

##### Database Layer
- MongoDB Connection
- Schema Validation
- Data Models

##### Relationships and Data Flow

- Client requests flowing through authentication
- Request processing through middleware
- Database interactions
- Error handling paths
- Discord OAuth2 flow

##### Implementation Notes

Specific architectural patterns:
- RESTful endpoint structure
- Middleware pipeline
- DTO pattern for data transformation
- Repository pattern for database access
- Authentication strategy pattern

##### Technical Stack Highlights

Clear indicators for:
- Node.js runtime
- TypeScript implementation
- MongoDB database
- Express.js (implied by structure)
- Discord OAuth2 integration

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        WI[Web Interfaces]
        TPA[Third-party Applications]
        PT[Postman Testing]:::test
    end

    subgraph Authentication
        DA[Discord Auth]:::auth
        click DA "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/auth/discord/DiscordAuthService.ts"
        SC[Service Client]:::auth
        click SC "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/auth/clients/AuthenticatedServiceClient.ts"
        DU[Discord User]:::auth
        click DU "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/auth/clients/AuthenticatedDiscordUser.ts"
        AM[Auth Middleware]:::auth
        click AM "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/auth/Auth.ts"
    end

    subgraph "Request Handlers"
        CAT[Categories]:::handler
        click CAT "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/Categories.ts"
        COM[Comps]:::handler
        click COM "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/Comps.ts"
        MEM[Members]:::handler
        click MEM "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/Members.ts"
        RAI[Raids]:::handler
        click RAI "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/Raids.ts"
        TR[Training Requests]:::handler
        click TR "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/TrainingRequests.ts"
        GO[Guild Options]:::handler
        click GO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/GuildOptions.ts"
    end

    subgraph "Base HTTP"
        HR[HTTP Request]:::base
        click HR "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/base/HTTPRequest.ts"
        HG[HTTP Get]:::base
        click HG "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/base/HTTPGetRequest.ts"
        HP[HTTP Post]:::base
        click HP "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/base/HTTPPostRequest.ts"
        HD[HTTP Delete]:::base
        click HD "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/base/HTTPDeleteRequest.ts"
    end

    subgraph "Error Handling"
        EM[Error Middleware]:::error
        click EM "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/Error.middleware.ts"
        HE[HTTP Exceptions]:::error
        click HE "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/exceptions/base/HTTPException.ts"
    end

    subgraph "Data Layer"
        DB[(MongoDB)]:::db
        click DB "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/DB.ts"
        
        subgraph "DTOs"
            CDTO[Category DTO]:::dto
            click CDTO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/dto/category.dto.ts"
            CODTO[Comp DTO]:::dto
            click CODTO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/dto/comp.dto.ts"
            MDTO[Member DTO]:::dto
            click MDTO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/dto/member.dto.ts"
            RDTO[Raid DTO]:::dto
            click RDTO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/dto/raid.dto.ts"
            TDTO[Training Request DTO]:::dto
            click TDTO "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/requests/dto/trainingRequest.dto.ts"
        end
        
        subgraph "Schemas"
            DAS[Discord Auth Schema]:::schema
            click DAS "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/resources/schemas/discordauth.schema.json"
            CS[Comp Schema]:::schema
            click CS "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/resources/schemas/comp.schema.json"
        end
    end

    subgraph "Configuration"
        CF[Config]:::config
        click CF "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/Config.ts"
        UT[Utils]:::config
        click UT "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/Utils.ts"
        LG[Logger]:::config
        click LG "https://github.com/Raid-Training-Initiative/RTI-API/blob/master/src/util/Logger.ts"
    end

    WI & TPA & PT --> AM
    AM --> DA
    DA --> DU
    DA --> SC
    AM --> HR
    HR --> HG & HP & HD
    HG & HP & HD --> CAT & COM & MEM & RAI & TR & GO
    CAT & COM & MEM & RAI & TR & GO --> EM
    EM --> HE
    CAT & COM & MEM & RAI & TR & GO --> CDTO & CODTO & MDTO & RDTO & TDTO
    CDTO & CODTO & MDTO & RDTO & TDTO --> DB
    DB --> DAS & CS

    classDef auth fill:#FFE873
    classDef handler fill:#7CB9E8
    classDef base fill:#C4A484
    classDef error fill:#FF6961
    classDef db fill:#B4B4B4
    classDef dto fill:#98FB98
    classDef schema fill:#DEB887
    classDef config fill:#D8BFD8
    classDef test fill:#87CEEB
```
