# squins/ooverkommelig architecture

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

- Interactive diagram: https://gitdiagram.com/squins/ooverkommelig
- Repository: https://github.com/squins/ooverkommelig

## Overview

##### Main Components

a) Core Framework Components:
- Object Graph Management System
- Definition System
- Platform-Specific Implementations (JVM/JS)
- Aspect System (JVM-specific)

b) Integration Points:
- External Application Code
- Configuration Interface
- Object Creation/Lifecycle Management

**┌─ Application Layer ─────────────────────┐**
- External Applications/Usage             │
- ┬────────────────────┬─┘

**┌──────────────────▼────────────────────▼─┐**
- Public API Layer                        │
- ┌─────────────┐  ┌──────────────────┐  │
- ObjectGraph  │  │Configuration API │  │
- ┘  └──────────────────┘  │
- ┬────────────────────┬─┘

**┌──────────────────▼────────────────────▼─┐**
- Core Implementation Layer               │
- ┌─────────────┐  ┌──────────────────┐  │
- Definition   │  │Object Lifecycle  │  │
- System      │  │Management        │  │
- ┘  └──────────────────┘  │
- ┬────────────────────┬─┘

**┌──────────────────▼────────────────────▼─┐**
- Platform-Specific Implementation Layer   │
- ┌─────────────┐          ┌───────────┐  │
- JVM Support  │          │JS Support │  │
- (+ Aspects)  │          │(Limited)  │  │
- ┘          └───────────┘  │
- ┘

##### Important Relationships

- Bidirectional relationships where appropriate (e.g., between Object Graph and Definition System)

##### Additional Elements

- Special symbols or notations
- Platform-specific indicators

##### Notes for Implementation

- Keep the main components visually distinct
- Use consistent sizing for similar components
- Brief descriptions for key components
- Clear boundaries between different layers
- Version information and platform support indicators

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef application fill:#gray,stroke:#333
    classDef api fill:#90EE90,stroke:#333
    classDef core fill:#87CEEB,stroke:#333
    classDef platform fill:#FFA500,stroke:#333
    classDef lifecycle fill:#DDA0DD,stroke:#333

    %% Application Layer
    subgraph AppLayer["Application Layer"]
        App[External Applications]:::application
    end

    %% Public API Layer
    subgraph APILayer["Public API Layer"]
        ObjGraph["Object Graph"]:::api
        Config["Configuration Interface"]:::api
    end
    click ObjGraph "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/ObjectGraph.kt"
    click Config "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/ObjectGraphConfiguration.kt"

    %% Core Implementation Layer
    subgraph CoreLayer["Core Implementation Layer"]
        DefSystem["Definition System"]:::core
        ObjLifecycle["Object Lifecycle Management"]:::core
        GraphMgmt["Graph Management System"]:::core
    end
    click DefSystem "https://github.com/squins/ooverkommelig/tree/master/main/src/commonMain/kotlin/org/ooverkommelig/definition/"
    click GraphMgmt "https://github.com/squins/ooverkommelig/tree/master/main/src/commonMain/kotlin/org/ooverkommelig/graph/"
    click ObjLifecycle "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/graph/ObjectGraphState.kt"

    %% Platform Layer
    subgraph PlatformLayer["Platform-Specific Implementation Layer"]
        JVMImpl["JVM Implementation"]:::platform
        JSImpl["JS Implementation"]:::platform
        AspectSystem["Aspect System<br>(JVM-only)"]:::platform
    end
    click JVMImpl "https://github.com/squins/ooverkommelig/tree/master/main/src/jvmMain/kotlin/org/ooverkommelig/"
    click JSImpl "https://github.com/squins/ooverkommelig/tree/master/main/src/jsMain/kotlin/org/ooverkommelig/"
    click AspectSystem "https://github.com/squins/ooverkommelig/tree/master/jvm-reflect/src/main/kotlin/org/ooverkommelig/jvmreflect/aspects/"

    %% Lifecycle States
    subgraph LifecycleStates["Lifecycle States"]
        Created["Created State"]:::lifecycle
        Initialized["Initialized State"]:::lifecycle
        Disposed["Disposed State"]:::lifecycle
    end
    click Created "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/graph/CreatedObjectGraphState.kt"
    click Initialized "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/graph/InitializedObjectGraphState.kt"
    click Disposed "https://github.com/squins/ooverkommelig/blob/master/main/src/commonMain/kotlin/org/ooverkommelig/graph/DisposedObjectGraphState.kt"

    %% Relationships
    App --> ObjGraph
    App --> Config
    ObjGraph <--> DefSystem
    ObjGraph --> GraphMgmt
    Config --> GraphMgmt
    GraphMgmt --> ObjLifecycle
    ObjLifecycle --> LifecycleStates
    DefSystem --> JVMImpl
    DefSystem --> JSImpl
    JVMImpl --> AspectSystem
    
    %% Legend
    subgraph Legend
        L1["Application Components"]:::application
        L2["API Components"]:::api
        L3["Core Components"]:::core
        L4["Platform-Specific"]:::platform
        L5["Lifecycle States"]:::lifecycle
    end
```
