# jhonjoel/ytrackwebsocket architecture

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

- Interactive diagram: https://gitdiagram.com/jhonjoel/ytrackwebsocket
- Repository: https://github.com/jhonjoel/ytrackwebsocket

## Overview

##### Project type and purpose
- YtrackWebSocket is a backend Node.js/TypeScript microservice. It exposes REST endpoints, WebSocket channels for real-time updates, runs scheduled ETL jobs (eggRows, nanoEggRows), integrates with Azure Blob Storage, an electronic-document provider, and two databases (Azure SQL and GrupoMaehara).

##### File structure
- Top-level: Dockerfile (containerized), src/ (all code).
- src/routes: HTTP routing.
- src/controllers → src/services → src/models (ORM) → src/database: standard layered API architecture.
- src/websocket: WebSocket server and handlers.
- src/services/eggRowsETL & cronProcedimientos.ts: scheduled ETL pipelines.
- src/services/uploadImage: Azure Blob upload.
- src/config/swaggerConfig.ts: OpenAPI docs.

##### README
- General project template; no architecture details.

##### Elements
- Green for services/business logic
- Orange for databases/storage
- Purple for external services

##### Detail is crucial
- Domain module as a sub-component.
- Dual database connections (Azure vs GrupoMaehara).
- CronProcedimientos.ts invoking ETL modules.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Request Handling Layer
    subgraph "Request Handling" 
        direction TB
        Clients["Clients (HTTP/WebSocket)"]:::external
        APIGateway["API Gateway\n(src/index.ts)"]:::httpWs
        RoutesManager["Routes Manager\n(src/routes/RoutesManager.ts)"]:::httpWs
        Swagger["Swagger Middleware\n(src/config/swaggerConfig.ts)"]:::httpWs
        WSHandler["WebSocket Server\n(src/websocket/webSocketHandler.ts)"]:::httpWs
        WSFacturas["WebSocket Facturas\n(src/websocket/webSocketFacturas.ts)"]:::httpWs
        WSSincro["WebSocket Sincro\n(src/websocket/webSocketSincro.ts)"]:::httpWs
        WSUsuarios["WebSocket Usuarios\n(src/websocket/webSocketUsuarios.ts)"]:::httpWs
        WSVisitas["WebSocket Visitas\n(src/websocket/webSocketVisitas.ts)"]:::httpWs
    end

    %% Business Logic Layer
    subgraph "Business Logic" 
        direction TB
        Controllers["Controllers Layer\n(src/controllers/)"]:::service
        Services["Service Layer\n(src/services/)"]:::service
    end

    %% Persistence & ETL Layer
    subgraph "Persistence & ETL" 
        direction TB
        ORM["ORM Models\n(src/models/)"]:::db
        DBManager["Database Manager\n(src/database/DatabaseManager.ts)"]:::db
        AzureSQL["Azure SQL DB"]:::db
        GrupoDB["GrupoMaehara SQL DB"]:::db
        Scheduler["ETL Scheduler\n(src/services/cronProcedimientos.ts)"]:::service
        subgraph "EggRows ETL Pipeline" 
            direction TB
            EggCron["cronEggETL.ts"]:::service
            EggExtract["eggRowsExtraction.ts"]:::service
            EggTransform["eggRowsTransform.ts"]:::service
            EggLoad["eggRowsLoad.ts"]:::service
            EggRun["runEggRowsETL.ts"]:::service
        end
        subgraph "NanoEggRows ETL Pipeline"
            direction TB
            NanoExtract["nanoEggRowsExtraction.ts"]:::service
            NanoTransform["nanoEggRowsTransform.ts"]:::service
            NanoLoad["nanoEggRowsLoad.ts"]:::service
            NanoRun["nanoRunEggRowsETL.ts"]:::service
        end
    end

    %% External Integrations
    subgraph "External Services"
        direction TB
        AzureBlob["Azure Blob Storage"]:::external
        DocAPI["Electronic Document API"]:::external
        RUCService["RUC External Service"]:::external
        XMLSign["XML Signing Service\n(xmlSign.service.ts)"]:::external
    end

    %% Flows
    Clients -->|HTTP Request| APIGateway
    APIGateway --> RoutesManager
    RoutesManager --> Swagger
    Swagger --> Controllers
    Controllers --> Services
    Services --> ORM
    ORM --> DBManager
    DBManager --> AzureSQL
    DBManager --> GrupoDB

    Clients -->|WebSocket| WSHandler
    WSHandler --> WSFacturas
    WSHandler --> WSSincro
    WSHandler --> WSUsuarios
    WSHandler --> WSVisitas
    WSFacturas --> Services
    WSSincro --> Services
    WSUsuarios --> Services
    WSVisitas --> Services

    Scheduler --> EggCron
    EggCron --> EggExtract
    EggExtract --> EggTransform
    EggTransform --> EggLoad
    EggLoad --> EggRun
    EggRun --> ORM

    Scheduler --> NanoExtract
    NanoExtract --> NanoTransform
    NanoTransform --> NanoLoad
    NanoLoad --> NanoRun
    NanoRun --> ORM

    Services -->|upload| AzureBlob
    Controllers -->|invoke| XMLSign
    Services -->|call| DocAPI
    Services -->|query| RUCService

    %% Click Events
    click APIGateway "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/index.ts"
    click RoutesManager "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/routes/RoutesManager.ts"
    click Swagger "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/config/swaggerConfig.ts"
    click WSHandler "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/websocket/webSocketHandler.ts"
    click WSFacturas "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/websocket/webSocketFacturas.ts"
    click WSSincro "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/websocket/webSocketSincro.ts"
    click WSUsuarios "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/websocket/webSocketUsuarios.ts"
    click WSVisitas "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/websocket/webSocketVisitas.ts"
    click Controllers "https://github.com/jhonjoel/ytrackwebsocket/tree/main/src/controllers/"
    click Services "https://github.com/jhonjoel/ytrackwebsocket/tree/main/src/services/"
    click ORM "https://github.com/jhonjoel/ytrackwebsocket/tree/main/src/models/"
    click DBManager "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/database/DatabaseManager.ts"
    click Scheduler "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/cronProcedimientos.ts"
    click EggCron "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/cronEggETL.ts"
    click EggExtract "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/eggRowsExtraction.ts"
    click EggTransform "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/eggRowsTransform.ts"
    click EggLoad "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/eggRowsLoad.ts"
    click EggRun "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/runEggRowsETL.ts"
    click NanoExtract "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/nanoEggRowsETL/nanoEggRowsExtraction.ts"
    click NanoTransform "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/nanoEggRowsETL/nanoEggRowsTransform.ts"
    click NanoLoad "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/nanoEggRowsETL/nanoEggRowsLoad.ts"
    click NanoRun "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/eggRowsETL/nanoEggRowsETL/nanoRunEggRowsETL.ts"
    click AzureBlob "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/uploadImage/azureBlobStorage.ts"
    click XMLSign "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/documentoElectronico/firmador/xmlSign.service.ts"
    click DocAPI "https://github.com/jhonjoel/ytrackwebsocket/tree/main/src/services/documentoElectronico/"
    click RUCService "https://github.com/jhonjoel/ytrackwebsocket/blob/main/src/services/documentoElectronico/consultas/consultaRuc.service.ts"

    %% Styles
    classDef httpWs fill:#D0E6FF,stroke:#3B82F6,color:#1E3A8A
    classDef service fill:#D1FAE5,stroke:#10B981,color:#065F46
    classDef db fill:#FFD8A8,stroke:#F97316,color:#9A3412
    classDef external fill:#E9D5FF,stroke:#8B5CF6,color:#4C1D95
```
