# ddanielcruz/serverless-clean-architecture architecture

> Architecture diagram of the GitHub repository ddanielcruz/serverless-clean-architecture, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ddanielcruz/serverless-clean-architecture
- Repository: https://github.com/ddanielcruz/serverless-clean-architecture

## Overview

##### Main Components

a) Client-Facing Layer:
- API Gateway (entry point for HTTP requests)
- Authentication/Authorization layer (shown by the authorizer function)

b) Application Core:
- Lambda Functions (organized by domain)
- User management (sign-up, sign-in)
- Session management
- Notes management
- Audio processing

c) Domain Services:
- Notes Domain
- Security Domain
- Users Domain

d) Infrastructure Services:
- AWS Services
- S3 (audio storage)
- SES (email service)
- Transcribe (speech-to-text)
- RDS PostgreSQL (data persistence)
- OpenAI GPT-4 (summarization)

**┌─────────────────────────────────────────────────────────────┐**
- Client Applications                      │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- API Gateway                           │
- Custom Authorizer                        │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- Lambda Functions                         │
- ┬────────────────┬────────────────┬─────────┤
- User Functions │Session Functions│ Note Functions │  Queue  │
- ┴────────────────┴────────────────┴─────────┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- Domain Services                         │
- ┬────────────────┬────────────────┬─────────┤
- User Domain   │Security Domain │  Notes Domain  │         │
- ┴────────────────┴────────────────┴─────────┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- Infrastructure Layer                      │
- ┬──────────┬──────────┬──────────────┬───────────┤
- S3    │   SES    │Transcribe│  PostgreSQL  │  GPT-4    │
- ┴──────────┴──────────┴──────────────┴───────────┘

##### Important Flows to Highlight

a) Authentication Flow:
- Client → API Gateway → Authorizer → Session Management
- Token refresh and validation paths

b) Creation Flow:
- Audio upload → S3 → Lambda trigger
- Transcription request → AWS Transcribe
- Summarization → GPT-4
- Storage → PostgreSQL

##### Additional Elements

- Version/environment indicators
- Scaling points and serverless boundaries
- Configuration dependencies
- Monitoring and logging points

##### Implementation Details

- Rectangles: Services and main components
- Hexagons: Lambda functions
- Diamonds: Decision points

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        CL[Client Applications]
    end

    subgraph API
        APIG[API Gateway]
        AUTH[Custom Authorizer]:::security
    end

    subgraph Controllers
        direction TB
        SIGN_IN[Sign In Controller]:::controller
        SIGN_UP[Sign Up Controller]:::controller
        SIGN_OUT[Sign Out Controller]:::controller
        REFRESH[Refresh Session Controller]:::controller
        CONFIRM[Confirm Token Controller]:::controller
        CREATE_NOTE[Create Note Controller]:::controller
    end

    subgraph Lambda
        direction TB
        NOTES_CREATE[Notes Create]:::lambda
        NOTES_TRANS[Notes Transcribed]:::lambda
        NOTES_UP[Notes Uploaded]:::lambda
        SESS_CREATE[Sessions Create]:::lambda
        SESS_CONF[Sessions Confirm]:::lambda
        SESS_DEL[Sessions Delete]:::lambda
        SESS_REF[Sessions Refresh]:::lambda
        USER_CREATE[Users Create]:::lambda
    end

    subgraph Domain
        direction TB
        NOTES_DOM[Notes Domain]:::domain
        SEC_DOM[Security Domain]:::domain
        USER_DOM[Users Domain]:::domain
    end

    subgraph Queue
        direction TB
        PERSIST_Q[Persist Note Transcription]:::queue
        REQUEST_Q[Request Note Transcription]:::queue
    end

    subgraph Infrastructure
        direction TB
        S3[S3 Storage]:::infra
        SES[Email Service]:::infra
        TRANS[Transcribe Service]:::infra
        DB[(PostgreSQL)]:::database
        GPT[OpenAI GPT-4]:::infra
    end

    %% Connections
    CL --> APIG
    APIG --> AUTH
    AUTH --> |Validate| SEC_DOM

    %% Controller Flows
    APIG --> Controllers
    Controllers --> Lambda

    %% Lambda to Domain
    Lambda --> Domain
    Domain --> Infrastructure

    %% Queue Flows
    NOTES_CREATE --> Queue
    Queue --> TRANS
    TRANS --> PERSIST_Q
    PERSIST_Q --> DB

    %% Infrastructure Connections
    NOTES_DOM --> S3
    SEC_DOM --> SES
    USER_DOM --> DB

    %% Styles
    classDef controller fill:#a8e6cf
    classDef lambda fill:#dcedc1
    classDef domain fill:#ffd3b6
    classDef queue fill:#ffaaa5
    classDef infra fill:#ff8b94
    classDef database fill:#957dad
    classDef security fill:#ff6b6b

    %% Click Events
    click AUTH "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/authorizer/"
    click NOTES_DOM "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/domain/notes/"
    click SEC_DOM "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/domain/security/"
    click USER_DOM "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/domain/users/"
    click S3 "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/s3/"
    click SES "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/ses/"
    click TRANS "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/transcribe/"
    click DB "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/database/drizzle/"
    click GPT "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/openai/"
    click NOTES_CREATE "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/notes-create/"
    click NOTES_TRANS "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/notes-transcribed/"
    click NOTES_UP "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/notes-uploaded/"
    click SESS_CREATE "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/sessions-create/"
    click SESS_CONF "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/sessions-confirm/"
    click SESS_DEL "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/sessions-delete/"
    click SESS_REF "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/sessions-refresh/"
    click USER_CREATE "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/aws/lambda/functions/users-create/"
    click SIGN_IN "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/sign-in/"
    click SIGN_UP "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/sign-up/"
    click SIGN_OUT "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/sign-out/"
    click REFRESH "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/refresh-session/"
    click CONFIRM "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/confirm-token/"
    click CREATE_NOTE "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/http/controllers/create-note/"
    click PERSIST_Q "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/queue/controllers/persist-note-transcription/"
    click REQUEST_Q "https://github.com/ddanielcruz/serverless-clean-architecture/tree/main/src/infrastructure/queue/controllers/request-note-transcription/"
```
