# vasisouv/painter architecture

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

- Interactive diagram: https://gitdiagram.com/vasisouv/painter
- Repository: https://github.com/vasisouv/painter

## Overview

##### Main Components Identification
The system consists of these key components:

a) API Layer
- Express.js server handling REST endpoints
- Two main routes: /api/paint/email and /api/paint/pdf

b) Template Engine Layer
- Eta template engine for composition
- Template file system structure
- Separate layouts for emails and PDFs

c) Rendering Engines
- MJML for email rendering
- Playwright for PDF rendering

##### Component Relationships

**Client Request → API Router → Template Resolver → Rendering Engine → Response**
- ↓
- Template Storage System

##### Specific Implementation Details

- Blue: API/HTTP components
- Green: Template processing
- Orange: Rendering engines
- Gray: Storage system

Specific elements:
- Express.js REST API endpoints
- Template resolution flow
- MJML email rendering pipeline
- Playwright PDF generation pipeline
- File system template structure

##### Key Architectural Patterns to Highlight

- REST API architecture
- Template composition pattern
- Pipeline processing pattern
- File-based routing system

##### Technical Stack Indicators

Clear demarcation of:
- Node.js/TypeScript runtime
- Express.js web framework
- Eta template engine
- MJML email framework
- Playwright browser automation

##### Important Details

- Template directory structure (/views/email and /views/pdf)
- Layout composition system
- Error handling flow
- Content type transformations

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client
        HTTP[HTTP POST Request]
    end

    subgraph "API Layer"
        Server["Server"]:::server
        App["Application"]:::app
        Router["Router"]:::router
    end

    subgraph "Core Service Layer"
        Types["Type Definitions"]:::core
        Constants["Constants"]:::core
        Utils["Utilities"]:::core
        Vendors["Vendor Config"]:::core
    end

    subgraph "Template Engine Layer"
        TemplateResolver["Template Resolver"]
        
        subgraph "Email Templates"
            EmailLayout["Base Layout"]:::template
            EmailHeader["Header"]:::template
            EmailFooter["Footer"]:::template
            EmailTemplates["Templates"]:::template
            EmailSchema["Schema"]:::template
        end
        
        subgraph "PDF Templates"
            PDFLayout["Base Layout"]:::template
            PDFHeader["Header"]:::template
            PDFFooter["Footer"]:::template
            PDFTemplates["Templates"]:::template
            PDFSchema["Schema"]:::template
        end
    end

    subgraph "Rendering Layer"
        EmailRenderer["MJML Email Renderer"]:::renderer
        PDFRenderer["Playwright PDF Renderer"]:::renderer
    end

    %% Relationships
    HTTP --> Server
    Server --> App
    App --> Router
    Router --> |Email Request| EmailRenderer
    Router --> |PDF Request| PDFRenderer
    
    EmailRenderer --> EmailLayout
    EmailRenderer --> EmailHeader
    EmailRenderer --> EmailFooter
    EmailRenderer --> EmailTemplates
    EmailTemplates --> EmailSchema
    
    PDFRenderer --> PDFLayout
    PDFRenderer --> PDFHeader
    PDFRenderer --> PDFFooter
    PDFRenderer --> PDFTemplates
    PDFTemplates --> PDFSchema

    %% Core Service Connections
    Router --> Types
    Router --> Constants
    Router --> Utils
    Router --> Vendors

    %% Click Events
    click Server "https://github.com/vasisouv/painter/blob/master/src/server.ts"
    click App "https://github.com/vasisouv/painter/blob/master/src/app.ts"
    click Router "https://github.com/vasisouv/painter/blob/master/src/router.ts"
    click EmailRenderer "https://github.com/vasisouv/painter/blob/master/src/render/email.ts"
    click PDFRenderer "https://github.com/vasisouv/painter/blob/master/src/render/pdf.ts"
    click EmailLayout "https://github.com/vasisouv/painter/blob/master/src/views/email/layout/base.mjml"
    click EmailHeader "https://github.com/vasisouv/painter/blob/master/src/views/email/layout/header.mjml"
    click EmailFooter "https://github.com/vasisouv/painter/blob/master/src/views/email/layout/footer.mjml"
    click EmailTemplates "https://github.com/vasisouv/painter/blob/master/src/views/email/templates/example.mjml"
    click EmailSchema "https://github.com/vasisouv/painter/blob/master/src/views/email/templates/example.json"
    click PDFLayout "https://github.com/vasisouv/painter/blob/master/src/views/pdf/layout/base.html"
    click PDFHeader "https://github.com/vasisouv/painter/blob/master/src/views/pdf/layout/header.html"
    click PDFFooter "https://github.com/vasisouv/painter/blob/master/src/views/pdf/layout/footer.html"
    click PDFTemplates "https://github.com/vasisouv/painter/blob/master/src/views/pdf/templates/example.html"
    click PDFSchema "https://github.com/vasisouv/painter/blob/master/src/views/pdf/templates/example.json"
    click Types "https://github.com/vasisouv/painter/blob/master/src/types/index.ts"
    click Constants "https://github.com/vasisouv/painter/blob/master/src/constants.ts"
    click Utils "https://github.com/vasisouv/painter/blob/master/src/utils.ts"
    click Vendors "https://github.com/vasisouv/painter/blob/master/src/vendors.ts"

    %% Styles
    classDef server fill:#2196F3,color:white
    classDef app fill:#1976D2,color:white
    classDef router fill:#0D47A1,color:white
    classDef core fill:#4CAF50,color:white
    classDef template fill:#FF9800,color:white
    classDef renderer fill:#E91E63,color:white

    %% Legend
    subgraph Legend
        L1["API Components"]:::server
        L2["Core Services"]:::core
        L3["Templates"]:::template
        L4["Renderers"]:::renderer
    end
```
