# victorsigma/ui-crafter architecture

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

- Interactive diagram: https://gitdiagram.com/victorsigma/ui-crafter
- Repository: https://github.com/victorsigma/ui-crafter

## Overview

##### Project type and purpose
- This is a single‐page full-feature frontend application (no custom backend code).
- Purpose: Provide a React-based visual editor ("UI Crafter") for designing Minecraft Bedrock UI forms and linking them to game functions via a node-based system. It also lets users write and manage game code snippets and export them.

##### File structure
- Top‐level:
- public/         → static assets, themes, index.html for Firebase Hosting
- src/            → main source: assets, components, libs, models, services, view, entry point (main.tsx)
- config files    → package.json, tsconfig, vite.config, firebase.json
- src/components: UI controls (cards, dropdowns, sliders, modals, headers, editor nodes)
- src/services: business logic (ProjectDB, ExportManager, UndoRedoStack)
- src/libs: utility functions (file manager, string manager, node editor)
- src/models: TypeScript interfaces for domain objects (ProjectModel, Form, MenuItem, etc.)
- src/view: high-level views (ProjectView)
- Routing: react-router.config.ts
- Styles: ore-styles.css, tool-styles.css

##### README for additional insights
- Tech stack: React, Vite, Styled Components, TypeScript, React Router
- Mentions Minecraft Bedrock UI API integration (`@minecraft/server-ui`)
- Demo hosted on Firebase → uses Firebase Hosting (no backend functions)

##### Main components and their interactions
a. Components
- Browser / Client (served via Firebase Hosting)
- React SPA core (App → Router → ProjectView)
- UI Layer (src/components/**): Editor Canvas, Node Editor, Form Panels, Modals, Toolbars
- Services Layer (src/services):
– ProjectDB: load/save project definitions (IndexedDB or localStorage)
– ExportManager: generate TS/JS code for Minecraft UI and functions
– UndoRedoStack: command history for UI changes
- Libraries (src/libs): utility functions for file I/O simulation, theming, string building, node graph management
- Models (src/models): shared type definitions
- Assets (public/assets): theme JSON files, images, fonts
- External API: Minecraft Bedrock UI API (used in generated code, not at runtime)

b. Relationships / Data flow
1. User interacts with UI components → triggers actions in Services
2. Services update Models → propagate back to UI (via React state/context)
3. UI Canvas renders components based on Models
4. ExportManager reads Models → produces code artifact → user downloads or copies
5. ProjectDB persists Models state between sessions
6. UndoRedoStack intercepts commands → enables rollback in UI

##### Architectural patterns and design principles
- Layered architecture:
- Presentation (React components)
- Domain (Models + Services)
- Infrastructure/Utilities (libs + ProjectDB storage)
- Unidirectional data flow (React + context/state + custom services)
- Modular component design (atomic card, dropdown, slider, editor nodes)
- Plugin/extension points: themes folder, custom node editor modules
- Code-generation pattern: UI Model → AST/string builder → export

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Hosting and Client
    subgraph "Firebase Hosting" 
        direction TB
        Hosting["Cloud: Firebase Hosting"]:::external
    end
    Hosting --> Client["Browser / Client"]:::external

    %% SPA Core Bootstrap
    Client --> Main["Main Bootstrap\n(src/main.tsx)"]:::presentation
    Main --> App["App Component"]:::presentation
    App --> Router["React Router Configuration"]:::presentation
    Router --> ProjectView["Project View"]:::presentation

    %% Presentation Layer
    subgraph "Presentation Layer\n(src/components)" 
        direction TB
        Cards["Card UI Controls"]:::presentation
        Dropdowns["Dropdown UI Controls"]:::presentation
        Slider["Slider UI Controls"]:::presentation
        Confirm["Confirmation Modal"]:::presentation
        Modals["Generic Modals"]:::presentation
        Headers["Headers / Toolbars"]:::presentation
        Explorer["Entry Explorer & Context Menu"]:::presentation
        subgraph "Editor Canvas & Node Editor"
            direction TB
            NodeEditor["Node Editor"]:::presentation
            CodeEditor["Code Editor Panel"]:::presentation
            Preview["Preview Panel"]:::presentation
            EntryNode["Entry Node"]:::presentation
        end
        Renderers["Editor Control Renderers"]:::presentation
        Buttons["Editor Button Renderers"]:::presentation
        Texts["Editor Text Renderers"]:::presentation
    end

    ProjectView --> Cards
    ProjectView --> Dropdowns
    ProjectView --> Slider
    ProjectView --> Confirm
    ProjectView --> Modals
    ProjectView --> Headers
    ProjectView --> Explorer
    ProjectView --> NodeEditor
    ProjectView --> CodeEditor
    ProjectView --> Preview
    ProjectView --> EntryNode
    ProjectView --> Renderers
    ProjectView --> Buttons
    ProjectView --> Texts

    %% Services Layer
    subgraph "Services Layer\n(src/services)" 
        direction TB
        ProjectDB["ProjectDB"]:::services
        ExportMgr["ExportManager"]:::services
        UndoRedo["UndoRedoStack"]:::services
    end

    %% Models Layer
    subgraph "Domain Models\n(src/models)" 
        direction TB
        ProjectModel["ProjectModel"]:::models
        FormModel["Form Definition"]:::models
        MenuItem["Menu Item Definition"]:::models
        RawMessage["Raw Message Type"]:::models
        ComponentProps["Component Props"]:::models
    end

    %% Utilities / Libs
    subgraph "Utilities / Libs\n(src/libs)" 
        direction TB
        FileMgr["File I/O & FS"]:::utils
        StringMgr["String/AST Builder"]:::utils
        NodeUtils["Node Graph Utilities"]:::utils
        ThemeDef["Theme Definition"]:::utils
        BaseMap["Component Base Mapping"]:::utils
        EntriesLib["Entry Definitions"]:::utils
        BedrockTypes["Bedrock API Declarations"]:::utils
    end

    %% Assets and Storage
    subgraph "Static Assets\n(public/assets)" 
        direction TB
        Themes["Theme JSON Files"]:::assets
        Images["Image Assets"]:::assets
        Fonts["Fonts & Static Files"]:::assets
    end

    subgraph "Browser Storage" 
        direction TB
        Storage["IndexedDB / localStorage"]:::storage
    end

    %% External Runtime
    subgraph "External API (Target Runtime)" 
        direction TB
        BedrockAPI["Minecraft Bedrock UI API"]:::external
    end

    %% Data Flows
    Cards -->|interact| ProjectDB
    Dropdowns --> ProjectDB
    Slider --> UndoRedo
    Confirm --> UndoRedo
    Modals --> UndoRedo
    Headers --> ProjectDB
    Explorer --> ProjectDB
    NodeEditor --> ExportMgr
    CodeEditor --> ExportMgr
    ExportMgr --> Generated["Generated Code Artifact"]:::document
    ProjectDB -->|persist| Storage
    Storage -->|load/save| ProjectDB
    ProjectDB --> ProjectModel
    ProjectDB --> FormModel
    ProjectDB --> MenuItem
    ProjectDB --> RawMessage
    ProjectDB --> ComponentProps
    ExportMgr --> StringMgr
    ExportMgr --> FileMgr
    StringMgr --> BaseMap
    NodeEditor --> NodeUtils
    ThemeDef --> Cards
    Themes --> ThemeDef
    BedrockAPI -.-> ExportMgr
    Generated -.->|download| Client

    %% Click Events
    click App "https://github.com/victorsigma/ui-crafter/blob/main/src/App.tsx"
    click Router "https://github.com/victorsigma/ui-crafter/blob/main/react-router.config.ts"
    click ProjectView "https://github.com/victorsigma/ui-crafter/blob/main/src/view/ProjectView.tsx"
    click Cards "https://github.com/victorsigma/ui-crafter/tree/main/src/components/card/"
    click Dropdowns "https://github.com/victorsigma/ui-crafter/tree/main/src/components/dropdown/"
    click Slider "https://github.com/victorsigma/ui-crafter/blob/main/src/components/slider/InlineSlider.tsx"
    click Confirm "https://github.com/victorsigma/ui-crafter/blob/main/src/components/confirm/OreConfirm.tsx"
    click Modals "https://github.com/victorsigma/ui-crafter/tree/main/src/components/modal/"
    click Headers "https://github.com/victorsigma/ui-crafter/tree/main/src/components/header/"
    click Explorer "https://github.com/victorsigma/ui-crafter/tree/main/src/components/entrie/"
    click NodeEditor "https://github.com/victorsigma/ui-crafter/blob/main/src/components/editor/NodeEditor.tsx"
    click CodeEditor "https://github.com/victorsigma/ui-crafter/blob/main/src/components/editor/CodeEditor.tsx"
    click Preview "https://github.com/victorsigma/ui-crafter/blob/main/src/components/editor/PreView.tsx"
    click EntryNode "https://github.com/victorsigma/ui-crafter/blob/main/src/components/editor/EntrieNode.tsx"
    click ProjectDB "https://github.com/victorsigma/ui-crafter/blob/main/src/services/ProjectDB.ts"
    click ExportMgr "https://github.com/victorsigma/ui-crafter/blob/main/src/services/ExportManager.ts"
    click UndoRedo "https://github.com/victorsigma/ui-crafter/blob/main/src/services/UndoRedoStack.ts"
    click FileMgr "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/fileManager.ts"
    click StringMgr "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/stringManager.ts"
    click NodeUtils "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/nodeEditor.ts"
    click ThemeDef "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/defineTheme.ts"
    click BaseMap "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/componentBaseMap.ts"
    click EntriesLib "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/entries.ts"
    click BedrockTypes "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/utils/bedrock-system.d.ts"
    click BedrockTypes "https://github.com/victorsigma/ui-crafter/blob/main/src/libs/utils/minecraft-server.d.ts"
    click ProjectModel "https://github.com/victorsigma/ui-crafter/blob/main/src/models/ProjectModel.ts"
    click FormModel "https://github.com/victorsigma/ui-crafter/blob/main/src/models/Form.ts"
    click MenuItem "https://github.com/victorsigma/ui-crafter/blob/main/src/models/MenuItem.ts"
    click RawMessage "https://github.com/victorsigma/ui-crafter/blob/main/src/models/RawMessage.ts"
    click ComponentProps "https://github.com/victorsigma/ui-crafter/blob/main/src/models/ComponentProps.ts"
    click Main "https://github.com/victorsigma/ui-crafter/blob/main/src/main.tsx"

    %% Styles
    classDef presentation fill:#D0E8FF,stroke:#3399FF,color:#000
    classDef services fill:#DFF2D8,stroke:#4CAF50,color:#000
    classDef utils fill:#FFE5B4,stroke:#FF9800,color:#000
    classDef models fill:#E8F5E9,stroke:#8BC34A,color:#000
    classDef assets fill:#F5F5F5,stroke:#9E9E9E,color:#000
    classDef storage fill:#ECEFF1,stroke:#546E7A,color:#000
    classDef external fill:#F5F5F5,stroke-dasharray: 5 5,stroke:#9E9E9E,color:#000
    classDef document fill:#FFFFFF,stroke:#000,color:#000
```
