# c4illin/convertx architecture

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

- Interactive diagram: https://gitdiagram.com/c4illin/convertx
- Repository: https://github.com/c4illin/convertx

## Overview

##### Main Components

a. Frontend Layer:
- Web Interface (React/TypeScript components in src/components)
- Static Assets (public directory)
- Client-side Scripts (public/script.js, public/results.js)

b. Backend Layer:
- Elysia Server (src/index.tsx)
- Authentication System (JWT-based)
- File Processing System

c. Converter Layer:
- Multiple Converter Services (src/converters/*)
- Format Normalization (src/helpers/normalizeFiletype.ts)

d. Storage Layer:
- File System Storage (/app/data volume)
- Database (for user management)

##### Client-Server Flow
- HTTP/HTTPS connections between client and server
- Authentication flow with JWT
- File upload/download paths

##### Converter Integration
- File routing to appropriate converters
- Parallel processing capabilities
- Result handling and delivery

**┌─────────────────────────────────────────────────────────┐**
- Client Layer                         │
- ┌─────────────┐ ┌─────────────┐ ┌─────────────┐       │
- Web UI     │ │   Static    │ │  Browser    │       │
- (React/TSX) │ │   Assets    │ │  Scripts    │       │
- ┘ └─────────────┘ └─────────────┘       │
- ┬───────────────────────────┘

**┌─────────────────────────────▼───────────────────────────┐**
- Server Layer                         │
- ┌─────────────┐ ┌─────────────┐ ┌─────────────┐       │
- Elysia    │ │    Auth     │ │   File      │       │
- Server    │ │   System    │ │  Handler    │       │
- ┘ └─────────────┘ └─────────────┘       │
- ┬───────────────────────────┘

**┌─────────────────────────────▼───────────────────────────┐**
- Converter Layer                        │
- ┌─────────────┐ ┌─────────────┐ ┌─────────────┐       │
- FFmpeg    │ │  Pandoc     │ │   Other     │       │
- Converter  │ │  Converter  │ │ Converters  │       │
- ┘ └─────────────┘ └─────────────┘       │
- ┬───────────────────────────┘

**┌─────────────────────────────▼───────────────────────────┐**
- Storage Layer                          │
- ┌─────────────┐ ┌─────────────┐                        │
- File     │ │  User DB    │                        │
- Storage   │ │             │                        │
- ┘ └─────────────┘                        │
- ┘

##### Important Elements

- Docker container boundary
- Environment variable configuration points
- File format support for each converter
- Auto-deletion workflow
- Security boundaries
- Volume mounts
- Network interfaces

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef backend fill:#2ecc71,stroke:#27ae60,color:white
    classDef converter fill:#f1c40f,stroke:#f39c12,color:black
    classDef storage fill:#9b59b6,stroke:#8e44ad,color:white
    classDef security fill:#e74c3c,stroke:#c0392b,color:white

    %% Client Layer
    subgraph ClientLayer
        WebUI["Web Interface"]:::frontend
        StaticAssets["Static Assets"]:::frontend
        ClientScripts["Browser Scripts"]:::frontend
    end

    %% Server Layer
    subgraph ServerLayer
        ElysiaServer["Elysia Server"]:::backend
        AuthSystem["Auth System"]:::security
        FileHandler["File Handler"]:::backend
    end

    %% Converter Layer
    subgraph ConverterLayer
        MainConverter["Main Converter"]:::converter
        FFmpeg["FFmpeg Converter"]:::converter
        Pandoc["Pandoc Converter"]:::converter
        Calibre["Calibre Converter"]:::converter
        GraphicsMagick["Graphics Magick"]:::converter
        Inkscape["Inkscape"]:::converter
        Vips["VIPS"]:::converter
        XeLaTeX["XeLaTeX"]:::converter
        Assimp["Assimp"]:::converter
        LibJXL["LibJXL"]:::converter
        Resvg["Resvg"]:::converter
        FormatNormalizer["Format Normalizer"]:::converter
    end

    %% Storage Layer
    subgraph StorageLayer
        FileStorage[("File Storage")]:::storage
        UserDB[("User Database")]:::storage
    end

    %% Relationships
    WebUI --> ElysiaServer
    ClientScripts --> ElysiaServer
    StaticAssets --> WebUI
    ElysiaServer --> AuthSystem
    ElysiaServer --> FileHandler
    FileHandler --> MainConverter
    MainConverter --> FormatNormalizer
    MainConverter --> FFmpeg
    MainConverter --> Pandoc
    MainConverter --> Calibre
    MainConverter --> GraphicsMagick
    MainConverter --> Inkscape
    MainConverter --> Vips
    MainConverter --> XeLaTeX
    MainConverter --> Assimp
    MainConverter --> LibJXL
    MainConverter --> Resvg
    FileHandler --> FileStorage
    AuthSystem --> UserDB

    %% Click Events
    click WebUI "https://github.com/C4illin/ConvertX/blob/main/src/components/base.tsx"
    click ClientScripts "https://github.com/C4illin/ConvertX/blob/main/public/script.js"
    click ElysiaServer "https://github.com/C4illin/ConvertX/blob/main/src/index.tsx"
    click MainConverter "https://github.com/C4illin/ConvertX/blob/main/src/converters/main.ts"
    click FFmpeg "https://github.com/C4illin/ConvertX/blob/main/src/converters/ffmpeg.ts"
    click Pandoc "https://github.com/C4illin/ConvertX/blob/main/src/converters/pandoc.ts"
    click Calibre "https://github.com/C4illin/ConvertX/blob/main/src/converters/calibre.ts"
    click GraphicsMagick "https://github.com/C4illin/ConvertX/blob/main/src/converters/graphicsmagick.ts"
    click Inkscape "https://github.com/C4illin/ConvertX/blob/main/src/converters/inkscape.ts"
    click Vips "https://github.com/C4illin/ConvertX/blob/main/src/converters/vips.ts"
    click XeLaTeX "https://github.com/C4illin/ConvertX/blob/main/src/converters/xelatex.ts"
    click Assimp "https://github.com/C4illin/ConvertX/blob/main/src/converters/assimp.ts"
    click LibJXL "https://github.com/C4illin/ConvertX/blob/main/src/converters/libjxl.ts"
    click Resvg "https://github.com/C4illin/ConvertX/blob/main/src/converters/resvg.ts"
    click FormatNormalizer "https://github.com/C4illin/ConvertX/blob/main/src/helpers/normalizeFiletype.ts"
```
