# json-logic/json-logic-engine architecture

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

- Interactive diagram: https://gitdiagram.com/json-logic/json-logic-engine
- Repository: https://github.com/json-logic/json-logic-engine

## Overview

##### Core Components (Main Layer)
- Key modules as interconnected components:
- Compiler (compiler.js)
- Optimizer (optimizer.js, async_optimizer.js)
- Logic Processor (logic.js, asLogic.js)
- Async Handler (asyncLogic.js, async_iterators.js)

##### Supporting Layers

a. Utilities Layer (Bottom):
- Path Processing (splitPath.js)
- Array Handling (coerceArray.js)
- Argument Processing (countArguments.js)
- Chaining Support (chainingSupported.js)
- Data Traversal (traverseCopy.js)

b. Error Handling Layer (Side):
- An "Error Handlers" component connecting to the core
- Connection to InvalidControlInput handler

c. Default Operations Layer (Top):
- Connection to the core engine

##### Flow Representation

- Input JSON → Compiler → Optimizer → Logic Processor → Output
- Alternative flow for async operations:
Input JSON → Compiler → Async Optimizer → Async Handler → Output

**[Default Operations Layer]**
- ↓
**[Core Engine Components] ← [Error Handlers]**
- ↓
**[Utilities Layer]**

##### Component Relationships
- Bidirectional connections between the compiler and optimizer
- Async/sync pathway splits
- Demonstrate error handler integration points

##### Performance monitoring points

Remember to include notes about the system's ability to handle both simple operations (like basic arithmetic) and complex operations (like reduce and map), as these are core features of the engine.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Default Operations"
        DefaultMethods["Default Methods"]:::defaultOps
    end

    subgraph "Core Engine"
        Compiler["Compiler"]:::core
        SyncOptimizer["Sync Optimizer"]:::core
        AsyncOptimizer["Async Optimizer"]:::core
        LogicProcessor["Logic Processor"]:::core
        AsyncHandler["Async Handler"]:::core
    end

    subgraph "Error Handling"
        ErrorHandlers["Error Handlers"]:::error
        InvalidInput["Invalid Control Input"]:::error
    end

    subgraph "Utilities"
        PathProc["Path Processing"]:::util
        ArrayHandle["Array Handling"]:::util
        ArgProc["Argument Processing"]:::util
        ChainSupport["Chaining Support"]:::util
        DataTraversal["Data Traversal"]:::util
    end

    subgraph "Performance Layer"
        PerfOpt["Performance Optimization"]:::perf
    end

    subgraph "Compatibility"
        Compat["Compatibility Layer"]:::compat
    end

    Input[/"JSON Input"/]:::input
    Output[/"Output"/]:::output

    Input --> Compiler
    Compiler --> SyncOptimizer
    Compiler --> AsyncOptimizer
    SyncOptimizer --> LogicProcessor
    AsyncOptimizer --> AsyncHandler
    LogicProcessor --> Output
    AsyncHandler --> Output
    
    DefaultMethods --> Compiler
    ErrorHandlers --> Compiler
    ErrorHandlers --> LogicProcessor
    ErrorHandlers --> AsyncHandler
    InvalidInput --> ErrorHandlers
    
    PerfOpt -.-> LogicProcessor
    PerfOpt -.-> AsyncHandler
    Compat -.-> LogicProcessor

    PathProc --> LogicProcessor
    ArrayHandle --> LogicProcessor
    ArgProc --> LogicProcessor
    ChainSupport --> LogicProcessor
    DataTraversal --> LogicProcessor

    %% Click Events
    click Compiler "https://github.com/json-logic/json-logic-engine/blob/master/compiler.js"
    click SyncOptimizer "https://github.com/json-logic/json-logic-engine/blob/master/optimizer.js"
    click AsyncOptimizer "https://github.com/json-logic/json-logic-engine/blob/master/async_optimizer.js"
    click LogicProcessor "https://github.com/json-logic/json-logic-engine/blob/master/logic.js"
    click AsyncHandler "https://github.com/json-logic/json-logic-engine/blob/master/asyncLogic.js"
    click PathProc "https://github.com/json-logic/json-logic-engine/blob/master/utilities/splitPath.js"
    click ArrayHandle "https://github.com/json-logic/json-logic-engine/blob/master/utilities/coerceArray.js"
    click ArgProc "https://github.com/json-logic/json-logic-engine/blob/master/utilities/countArguments.js"
    click ChainSupport "https://github.com/json-logic/json-logic-engine/blob/master/utilities/chainingSupported.js"
    click DataTraversal "https://github.com/json-logic/json-logic-engine/blob/master/utilities/traverseCopy.js"
    click InvalidInput "https://github.com/json-logic/json-logic-engine/blob/master/errors/InvalidControlInput.js"
    click DefaultMethods "https://github.com/json-logic/json-logic-engine/blob/master/defaultMethods.js"
    click PerfOpt "https://github.com/json-logic/json-logic-engine/blob/master/perf.js"
    click Compat "https://github.com/json-logic/json-logic-engine/blob/master/compatibility.js"

    %% Styles
    classDef core fill:#2374ab,stroke:#2374ab,color:#fff
    classDef error fill:#d64045,stroke:#d64045,color:#fff
    classDef util fill:#2a9d8f,stroke:#2a9d8f,color:#fff
    classDef defaultOps fill:#7209b7,stroke:#7209b7,color:#fff
    classDef perf fill:#f4a261,stroke:#f4a261,color:#000
    classDef compat fill:#8ecae6,stroke:#8ecae6,color:#000
    classDef input fill:#95d5b2,stroke:#95d5b2,color:#000
    classDef output fill:#95d5b2,stroke:#95d5b2,color:#000
```
