# chaturrved/booker-backend architecture

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

- Interactive diagram: https://gitdiagram.com/chaturrved/booker-backend
- Repository: https://github.com/chaturrved/booker-backend

## Overview

##### Main Components

a. Client Layer:
- GraphQL Client Interface
- Authentication Endpoints

b. Application Layer:
- NestJS Core Components
- Module Structure:
- Auth Module
- Users Module
- Bookmarks Module
- Links Module
- Database Module

c. Data Layer:
- MongoDB (indicated by the presence of schemas)
- Repositories

**┌─────────────────────────────────┐**
- GraphQL Endpoint         │
- REST Authentication API     │
- ┘

**┌─────────────────────────────────┐**
- NestJS Modules          │

- ┌──────┐ ┌────────┐ ┌───────┐ │
- Auth │ │ Users  │ │ Links │ │
- ┘ └────────┘ └───────┘ │
- ┌─────────────┐            │
- Bookmarks  │            │
- ┘            │
- ┘

**┌─────────────────────────────────┐**
- Database (MongoDB)         │
- ┌────────┐  ┌────────────┐   │
- Users  │  │ Bookmarks  │   │
- ┘  └────────────┘   │
- ┘

##### Key Relationships to Highlight

- Authentication flow (JWT Strategy)
- GraphQL resolver connections to services
- Repository pattern implementation
- Database interactions

##### Special Architectural Elements

Specific NestJS architectural patterns:
- Guards (AuthGuard, GqlAuthGuard)
- Decorators (CurrentUser)
- Resolvers
- Services
- Repositories
- DTOs and Models

##### Component Interaction Details

Specific flows:
**Client → GraphQL/REST → Guards → Resolvers → Services → Repositories → Database**

##### Technical Stack Indicators

- NestJS
- GraphQL
- MongoDB
- TypeScript
- JWT

- How the modules interact
- The authentication flow
- The data flow from client to database
- The separation of concerns in the application
- The role of each architectural component

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        GQL[GraphQL Client]:::client
        REST[REST Auth Endpoints]:::client
    end

    subgraph "Application Layer"
        subgraph "Core Modules"
            AuthMod[Auth Module]
            UsersMod[Users Module]
            BookmarksMod[Bookmarks Module]
            LinksMod[Links Module]
            DBMod[Database Module]
        end

        subgraph "Authentication"
            JWT[JWT Strategy]
            Local[Local Strategy]
            Guards[Auth Guards]
            UserDec[Current User Decorator]
        end

        subgraph "GraphQL Layer"
            UserRes[User Resolver]
            BookRes[Bookmarks Resolver]
            LinksRes[Links Resolver]
            GQLGuard[GraphQL Auth Guard]
        end

        subgraph "Service Layer"
            AuthSvc[Auth Service]
            UsersSvc[Users Service]
            BookmarksSvc[Bookmarks Service]
            LinksSvc[Links Service]
        end

        subgraph "Repository Layer"
            AbstractRepo[Abstract Repository]
            UsersRepo[Users Repository]
            BookmarksRepo[Bookmarks Repository]
        end
    end

    subgraph "Data Layer"
        AbstractSchema[Abstract Schema]
        UserSchema[User Schema]
        BookmarkSchema[Bookmark Schema]
        MongoDB[(MongoDB)]:::database
    end

    %% Client to Application connections
    GQL --> GQLGuard
    REST --> Guards

    %% Auth flow
    Guards --> AuthMod
    GQLGuard --> AuthMod
    AuthMod --> JWT
    AuthMod --> Local
    AuthMod --> UserDec
    AuthMod --> AuthSvc

    %% Module connections
    UsersMod --> UsersSvc
    BookmarksMod --> BookmarksSvc
    LinksMod --> LinksSvc

    %% GraphQL to Service connections
    UserRes --> UsersSvc
    BookRes --> BookmarksSvc
    LinksRes --> LinksSvc

    %% Service to Repository connections
    UsersSvc --> UsersRepo
    BookmarksSvc --> BookmarksRepo

    %% Repository to Database connections
    AbstractRepo --> AbstractSchema
    UsersRepo --> UserSchema
    BookmarksRepo --> BookmarkSchema
    UserSchema --> MongoDB
    BookmarkSchema --> MongoDB

    %% Click events
    click AuthMod "https://github.com/chaturrved/booker-backend/blob/main/src/auth/auth.module.ts"
    click UsersMod "https://github.com/chaturrved/booker-backend/blob/main/src/users/users.module.ts"
    click BookmarksMod "https://github.com/chaturrved/booker-backend/blob/main/src/bookmarks/bookmarks.module.ts"
    click LinksMod "https://github.com/chaturrved/booker-backend/blob/main/src/links/links.module.ts"
    click DBMod "https://github.com/chaturrved/booker-backend/blob/main/src/database/database.module.ts"
    click JWT "https://github.com/chaturrved/booker-backend/blob/main/src/auth/strategies/jwt.strategy.ts"
    click Local "https://github.com/chaturrved/booker-backend/blob/main/src/auth/strategies/local.strategy.ts"
    click Guards "https://github.com/chaturrved/booker-backend/tree/main/src/auth/guards"
    click UserDec "https://github.com/chaturrved/booker-backend/blob/main/src/auth/current-user.decorator.ts"
    click AbstractRepo "https://github.com/chaturrved/booker-backend/blob/main/src/database/abstract.repository.ts"
    click AbstractSchema "https://github.com/chaturrved/booker-backend/blob/main/src/database/abstract.schema.ts"
    click UserSchema "https://github.com/chaturrved/booker-backend/blob/main/src/users/models/user.schema.ts"
    click BookmarkSchema "https://github.com/chaturrved/booker-backend/blob/main/src/bookmarks/models/bookmark.schema.ts"
    click UserRes "https://github.com/chaturrved/booker-backend/blob/main/src/users/users.resolver.ts"
    click BookRes "https://github.com/chaturrved/booker-backend/blob/main/src/bookmarks/bookmarks.resolver.ts"
    click LinksRes "https://github.com/chaturrved/booker-backend/blob/main/src/links/links.resolver.ts"
    click GQLGuard "https://github.com/chaturrved/booker-backend/blob/main/src/auth/guards/gql-auth.guard.ts"
    click AuthSvc "https://github.com/chaturrved/booker-backend/blob/main/src/auth/auth.service.ts"
    click UsersSvc "https://github.com/chaturrved/booker-backend/blob/main/src/users/users.service.ts"
    click BookmarksSvc "https://github.com/chaturrved/booker-backend/blob/main/src/bookmarks/bookmarks.service.ts"
    click LinksSvc "https://github.com/chaturrved/booker-backend/blob/main/src/links/links.service.ts"
    click UsersRepo "https://github.com/chaturrved/booker-backend/blob/main/src/users/users.repository.ts"
    click BookmarksRepo "https://github.com/chaturrved/booker-backend/blob/main/src/bookmarks/bookmarks.repository.ts"

    %% Styling
    classDef client fill:#2374ab
    classDef database fill:#ff7f50
    classDef module fill:#95c623
    classDef auth fill:#e84855
    classDef repository fill:#916dd5

    class GQL,REST client
    class MongoDB database
    class AuthMod,UsersMod,BookmarksMod,LinksMod,DBMod module
    class JWT,Local,Guards,GQLGuard,UserDec auth
    class AbstractRepo,UsersRepo,BookmarksRepo repository
```
