# gannettdigital/jstransform architecture

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

- Interactive diagram: https://gitdiagram.com/gannettdigital/jstransform
- Repository: https://github.com/gannettdigital/jstransform

## Overview

##### Main Components

a) Input Processing Layer:
- JSON Schema Parser
- XML Input Parser
- JSON Input Parser
- Schema Reference Resolver

b) Core Transform Engine:
- Transform Operations Processor
- Instance Transformer
- Schema Validator
- Schema Walker

c) Code Generation Layer:
- Struct Generator
- Avro Generator
- MessagePack Generator
- GraphQL Generator

d) Output Handlers:
- Generated Go Structs
- Serialization Code
- Schema Files

**[Input Layer]**
- ↓
**[Processing Layer]**
- ↓
**[Generation Layer]**
- ↓
**[Output Layer]**

##### Component Relationships

**[JSON Schema + Transform Extensions] → [Schema Parser] → [Schema Validator]**
- ↘ [Transform Engine] ← [Input Data (JSON/XML)]
- ↓
- [Code Generation Engine]
- ↓
- [Generated Code & Schemas]

##### Important Details

a) Input Processing:
- Support for both JSON and XML inputs
- JSON Schema extension handling
- Reference resolution system

b) Transform Engine:
- Transform operations processor
- Validation flow
- Instance transformation process

c) Code Generation:
- Parallel outputs for different formats (Avro, MessagePack, GraphQL)
- Go struct generation flow
- Serialization code generation

##### Additional Elements

- Version/metadata information
- External dependencies (Go modules)
- Test data flow

##### Technical Notes

- Validation checkpoints

##### Implementation Details

- Main entry points (main.go)
- Configuration points
- Test coverage paths
- Error handling flows

This design should reflect the tool's nature as both a library and a code generation utility, with clear separation between transform operations and code generation capabilities.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph Input
        JS["JSON Schema + Extensions"]
        JI["JSON Input"]
        XI["XML Input"]
    end

    subgraph "Processing Layer"
        direction TB
        SP["Schema Parser"]:::parser
        RR["Reference Resolver"]:::resolver
        SV["Schema Validator"]:::validator
        SW["Schema Walker"]:::walker
    end

    subgraph "Transform Layer"
        direction TB
        TOP["Transform Operations"]:::transform
        IT["Instance Transformer"]:::transform
        TU["Transform Utils"]:::transform
        TPC["Transform Pipeline Controller"]:::transform
        MTE["Main Transform Engine"]:::transform
    end

    subgraph "Generation Layer"
        direction TB
        MCG["Main Code Generation Engine"]:::generator
        SG["Struct Generator"]:::generator
        AG["Avro Generator"]:::generator
        GG["GraphQL Generator"]:::generator
    end

    subgraph Output
        GS["Generated Structs"]
        SC["Serialization Code"]
        SF["Schema Files"]
    end

    %% Relationships
    JS --> SP
    JI --> IT
    XI --> IT
    
    SP --> RR
    RR --> SV
    SV --> SW
    
    SW --> TOP
    TOP --> IT
    IT --> TU
    TU --> TPC
    TPC --> MTE
    
    MTE --> MCG
    MCG --> SG
    MCG --> AG
    MCG --> GG
    
    SG --> GS
    AG --> SF
    GG --> SF

    %% Click Events
    click SP "https://github.com/GannettDigital/jstransform/blob/master/jsonschema/schema.go"
    click RR "https://github.com/GannettDigital/jstransform/blob/master/jsonschema/reference.go"
    click SV "https://github.com/GannettDigital/jstransform/blob/master/jsonschema/validator.go"
    click SW "https://github.com/GannettDigital/jstransform/blob/master/jsonschema/walk.go"
    click TOP "https://github.com/GannettDigital/jstransform/blob/master/transform/operations.go"
    click IT "https://github.com/GannettDigital/jstransform/blob/master/transform/instance.go"
    click MTE "https://github.com/GannettDigital/jstransform/blob/master/transform/transform.go"
    click SG "https://github.com/GannettDigital/jstransform/blob/master/generate/struct.go"
    click AG "https://github.com/GannettDigital/jstransform/blob/master/generate/avro.go"
    click GG "https://github.com/GannettDigital/jstransform/blob/master/generate/graphql.go"
    click MCG "https://github.com/GannettDigital/jstransform/blob/master/generate/generate.go"
    click TU "https://github.com/GannettDigital/jstransform/blob/master/transform/utils.go"
    click TPC "https://github.com/GannettDigital/jstransform/blob/master/transform/transformer.go"

    %% Styles
    classDef parser fill:#2196F3,stroke:#1565C0,color:white
    classDef resolver fill:#2196F3,stroke:#1565C0,color:white
    classDef validator fill:#2196F3,stroke:#1565C0,color:white
    classDef walker fill:#2196F3,stroke:#1565C0,color:white
    classDef transform fill:#4CAF50,stroke:#2E7D32,color:white
    classDef generator fill:#FF9800,stroke:#EF6C00,color:white

    %% Legend
    subgraph Legend
        L1["Parser Components"]:::parser
        L2["Transform Components"]:::transform
        L3["Generator Components"]:::generator
    end
```
