# libec/clipninja architecture

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

- Interactive diagram: https://gitdiagram.com/libec/clipninja
- Repository: https://github.com/libec/clipninja

## Overview

##### Project Type Analysis
This is a native macOS application built with Swift and SwiftUI, following a clean architecture pattern with clear separation of concerns. The project is organized using feature modules and follows SOLID principles.

##### Main Architectural Components

a. Core Features Layer:
- Clipboard Management
- Pasteboard Integration
- Settings Management
- Tutorial System
- Keyboard Handling

b. Infrastructure Layer:
- Instance Provider (DI Container)
- Navigation System
- Lifecycle Events
- Logger

c. System Integration Layer:
- macOS Pasteboard
- Launch at Login
- System Keyboard Events

**┌─────────────────────────────────────────────────────────────┐**
- UI Layer (SwiftUI)                      │
- ┬─────────────┬────────────────┬───────────────┤
- Clipboard  │  Settings   │    Tutorial    │ Paste Directly │
- View     │    View     │     View       │     View       │
- ┬──────┴──────┬──────┴───────┬────────┴───────┬───────┘

**┌──────▼──────┬──────▼──────┬──────▼──────┬─────────▼───────┐**
- Clipboard  │  Settings   │  Tutorial   │   Pasteboard    │
- Domain    │   Domain    │   Domain    │     Domain      │
- ┬──────┴──────┬──────┴──────┬──────┴───────┬────────┘

**┌──────▼──────┬──────▼──────┬──────▼──────┬──────▼────────┐**
- System    │  Keyboard   │  Launch At  │  Infrastructure│
- Integration │  Handling   │    Login    │     Layer      │
- ┴─────────────┴─────────────┴───────────────┘

##### Key Relationships to Highlight

a. Data Flow:
- User Interface → Domain Layer (Commands/Events)
- Domain Layer → System Integration (Actions)
- System Integration → macOS System (Native Integration)

b. Dependencies:
- Feature modules → Infrastructure
- UI → Domain Layer
- Domain Layer → System Resources

##### Important Implementation Details

Architectural patterns:
- Clean Architecture (Use Cases, Domain Models)
- MVVM Pattern (ViewModels for each feature)
- Dependency Injection (Instance Provider)
- Repository Pattern (Data Access)
- Observer Pattern (Keyboard and Pasteboard)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef domain fill:#2ecc71,stroke:#27ae60,color:white
    classDef system fill:#f1c40f,stroke:#f39c12,color:black
    classDef infra fill:#95a5a6,stroke:#7f8c8d,color:white

    %% UI Layer
    subgraph UI
        ClipboardView["Clipboard View"]
        SettingsView["Settings View"]
        TutorialView["Tutorial View"]
        PasteView["Paste Directly View"]
    end

    %% Domain Layer
    subgraph Domain
        ClipboardMgmt["Clipboard Management"]
        SettingsMgmt["Settings Management"]
        TutorialSystem["Tutorial System"]
        PasteboardIntg["Pasteboard Integration"]
    end

    %% System Integration Layer
    subgraph SystemIntegration
        SysKeyboard["System Keyboard Events"]
        LaunchLogin["Launch at Login"]
        WindowsMgmt["Windows Management"]
        Migration["Migration System"]
    end

    %% Infrastructure Layer
    subgraph Infrastructure
        InstanceProvider["Instance Provider"]
        Navigation["Navigation System"]
        Lifecycle["Lifecycle Events"]
        Logger["Logger"]
    end

    %% Relationships
    ClipboardView --> ClipboardMgmt
    SettingsView --> SettingsMgmt
    TutorialView --> TutorialSystem
    PasteView --> PasteboardIntg

    ClipboardMgmt --> SysKeyboard
    ClipboardMgmt --> PasteboardIntg
    SettingsMgmt --> LaunchLogin
    PasteboardIntg --> WindowsMgmt

    ClipboardMgmt --> InstanceProvider
    SettingsMgmt --> Navigation
    TutorialSystem --> Lifecycle
    PasteboardIntg --> Logger

    %% Styling
    class ClipboardView,SettingsView,TutorialView,PasteView ui
    class ClipboardMgmt,SettingsMgmt,TutorialSystem,PasteboardIntg domain
    class SysKeyboard,LaunchLogin,WindowsMgmt,Migration system
    class InstanceProvider,Navigation,Lifecycle,Logger infra

    %% Click Events
    click ClipboardMgmt "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Features/Clipboard"
    click PasteboardIntg "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Features/Pasteboard"
    click SettingsMgmt "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Features/Settings"
    click TutorialSystem "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Features/Tutorial"
    click SysKeyboard "https://github.com/libec/clipninja/blob/develop/App/Keyboard Handling/System/SystemKeyboardObserver.swift"
    click InstanceProvider "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Infrastructure/Instance Provider"
    click Navigation "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Infrastructure/Navigation"
    click Lifecycle "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Infrastructure/Lifecycle Events"
    click Logger "https://github.com/libec/clipninja/tree/develop/ClipNinja/Sources/Infrastructure/Logger"
    click LaunchLogin "https://github.com/libec/clipninja/tree/develop/App/Launch At Login"
    click WindowsMgmt "https://github.com/libec/clipninja/tree/develop/App/Windows"
    click Migration "https://github.com/libec/clipninja/tree/develop/App/Migration"
```
