# noelmugnier/fhydia architecture

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

- Interactive diagram: https://gitdiagram.com/noelmugnier/fhydia
- Repository: https://github.com/noelmugnier/fhydia

## Overview

##### Main Components

a) Core Library Components (Central Focus):
- Configuration System
- Builders System
- Enrichment Pipeline
- Formatters System
- Filters System

b) Integration Points:
- ASP.NET Core Integration
- Client Application Integration

##### Top Layer (Client Integration)
- Configuration points (TypeConfiguration)
- Controller integration

##### Middle Layer (Core Processing)
- Divide into sub-components:
- Builder System (Left side)
- Enrichment Pipeline (Center)
- Formatters (Right side)

##### Bottom Layer (Runtime Processing)
- Endpoint Filters
- Response Transformation
- Format-Specific Output

##### Detailed Component Breakdown

Core Components (Show as interconnected modules):
**┌─ Configuration System ─┐    ┌─ Builder System ─┐**
- TypeConfiguration   │───▶│ - FhydiaBuilder  │
- HyperMediaConfig   │    │ - LinkBuilder    │
- ┘    └─────────────────┘
- ▼
**┌─ Enrichment Pipeline ─┐    ┌─ Formatters ─┐**
- ObjectEnricher     │───▶│ - HAL        │
- LinkInjection     │    │ - (Others)    │
- ┘    └─────────────┘

##### Implementation Details

Implementation aspects:
- EndpointFilter integration
- ExpandoObject transformation
- Accept header handling
- Formatter selection

##### The minimal impact on existing code

Keep the focus on the library's core purpose: enriching endpoint responses with HATEOAS features while maintaining a clean separation between configuration and runtime behavior.

Remember to include future planned components (like additional formatters) in a different shade or pattern to indicate their planned status.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Client["Client Layer"]
        SampleApp["Sample Application"]:::client
        Controller["Controller Integration"]:::client
        ConfigInt["Configuration Integration"]:::client
    end

    subgraph Core["Fhydia Core"]
        subgraph Config["Configuration System"]
            CoreConfig["Core Configuration"]:::config
            TypeConfig["Type Configuration"]:::config
            ConfigInterface["Configuration Interface"]:::config
        end

        subgraph Builders["Builders System"]
            MainBuilder["Fhydia Builder"]:::builder
            LinkBuilder["Link Builder"]:::builder
            TypeBuilder["Type Builder"]:::builder
        end

        subgraph Enrichment["Enrichment Pipeline"]
            ObjEnricher["Object Enricher"]:::enricher
        end

        subgraph Formatters["Formatters System"]
            HalFormatter["HAL Formatter"]:::formatter
            FormatterProvider["Formatter Provider"]:::formatter
        end

        subgraph Filters["Filters System"]
            EndpointFilter["Endpoint Filter"]:::filter
        end

        subgraph Results["Core Result Types"]
            HyperResult["HyperMedia Result"]:::result
            LinkType["HyperMedia HAL Link"]:::result
        end
    end

    %% Relationships
    SampleApp --> Controller
    Controller --> EndpointFilter
    ConfigInt --> CoreConfig
    
    CoreConfig --> MainBuilder
    TypeConfig --> TypeBuilder
    ConfigInterface --> CoreConfig
    
    MainBuilder --> LinkBuilder
    MainBuilder --> TypeBuilder
    
    EndpointFilter --> ObjEnricher
    ObjEnricher --> FormatterProvider
    FormatterProvider --> HalFormatter
    
    ObjEnricher --> HyperResult
    LinkBuilder --> LinkType
    
    %% Styles
    classDef client fill:#E1F5FE,stroke:#01579B
    classDef config fill:#E8F5E9,stroke:#1B5E20
    classDef builder fill:#FFF3E0,stroke:#E65100
    classDef enricher fill:#F3E5F5,stroke:#4A148C
    classDef formatter fill:#FFEBEE,stroke:#B71C1C
    classDef filter fill:#E8EAF6,stroke:#1A237E
    classDef result fill:#FFF8E1,stroke:#F57F17

    %% Click Events
    click SampleApp "https://github.com/noelmugnier/Fhydia/tree/main/Fhydia.Sample/"
    click Controller "https://github.com/noelmugnier/Fhydia/blob/main/Fhydia.Sample/Controllers/TestController.cs"
    click ConfigInt "https://github.com/noelmugnier/Fhydia/blob/main/Fhydia.Sample/Configurations/OtherTypeConfiguration.cs"
    click CoreConfig "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Configurations/HyperMediaConfiguration.cs"
    click TypeConfig "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Configurations/TypeConfiguration.cs"
    click ConfigInterface "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Configurations/IHyperMediaTypeConfigurator.cs"
    click MainBuilder "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Builders/FhydiaBuilder.cs"
    click LinkBuilder "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Builders/LinkConfigurationBuilder.cs"
    click TypeBuilder "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Builders/TypeConfigurationBuilder.cs"
    click ObjEnricher "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Enrichers/HyperMediaObjectEnricher.cs"
    click HalFormatter "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Formatters/JsonHalTypesFormatter.cs"
    click FormatterProvider "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Formatters/HyperMediaTypesFormatterProvider.cs"
    click EndpointFilter "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Filters/HyperMediaEndpointFilter.cs"
    click HyperResult "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/HyperMediaResult.cs"
    click LinkType "https://github.com/noelmugnier/Fhydia/blob/main/Fydhia.Core/Common/HyperMediaHalLink.cs"
```
