# itissid/privyloci architecture

> Architecture diagram of the GitHub repository itissid/privyloci, 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/itissid/privyloci
- Repository: https://github.com/itissid/privyloci

## Overview

##### Main Components Identification

The system should be represented with these key components:

a. Core Application Layer:
- Main Application (MainApplication.kt)
- Foreground Service (PrivyForegroundService.kt)
- Service Management Components

b. Data Layer:
- Local Database (AppDatabase.kt)
- Key-Value Repository
- Data Models and DAOs

c. Sensor Layer:
- Location Sensors
- Bluetooth Sensors
- Sensor Management System

d. UI Layer:
- Main Activity
- Compose UI Components
- ViewModels
- Permission Handlers

e. Event Processing Layer:
- Event Processors
- Geofence Processors

##### Component Relationships

a. Use a layered architecture approach with:
- Business Logic in the middle
- Sensor Layer as a parallel component

- User interactions → ViewModels → Business Logic
- Sensor data → Event Processors → Storage
- Storage → ViewModels → UI

##### Specific Implementation Details

a. Privacy-First Architecture:
- Data encryption points
- Local-only storage
- Permission boundaries

b. Sensor Integration:
- Google Fused Location Provider
- BLE scanning components
- Geofencing components

c. Data Flow Control:
- Permission-gated operations
- Event processing pipeline
- Subscription management

##### Key Architectural Patterns

Patterns:
- MVVM architecture (ViewModels folder structure)
- Repository Pattern (kvrepository)
- Service-based background processing
- Event-driven architecture (eventprocessors)

##### Component Grouping

Related components:
**UI Layer:**
- MainActivity
- Compose UI Components
- Permission Dialogs
- Theme Components

**Core Services:**
- PrivyForegroundService
- ServiceStarter
- ServiceStoppedWorker

**Data Management:**
- AppDatabase
- Repositories
- DAOs

**Sensor Framework:**
- SensorManager
- GoogleFusedLocationSensor
- BLE Components

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef data fill:#2ecc71,stroke:#27ae60,color:white
    classDef sensor fill:#f1c40f,stroke:#f39c12,color:black
    classDef service fill:#9b59b6,stroke:#8e44ad,color:white
    classDef event fill:#e67e22,stroke:#d35400,color:white
    classDef permission fill:#e74c3c,stroke:#c0392b,color:white
    classDef config fill:#95a5a6,stroke:#7f8c8d,color:white

    %% UI Layer
    subgraph UI
        MA["MainActivity"]:::ui
        UI["UI Components"]:::ui
        VM["ViewModels"]:::ui
        TH["Theme"]:::ui
        SC["Subscription Cards"]:::ui
    end

    %% Permission Layer
    subgraph Permissions
        BPH["BLE Permission Handler"]:::permission
        LPH["Location Permission Handler"]:::permission
    end

    %% Core Application Layer
    subgraph Core
        MAP["Main Application"]:::service
        PFS["Privy Foreground Service"]:::service
        SM["Service Management"]:::service
    end

    %% Event Processing Layer
    subgraph EventProcessing
        EP["Event Processor"]:::event
        GP["Geofence Processor"]:::event
    end

    %% Sensor Layer
    subgraph Sensors
        SENS["Sensor Manager"]:::sensor
        GLS["Google Fused Location Sensor"]:::sensor
        SI["Sensor Interface"]:::sensor
        SMOD["Sensor Module"]:::sensor
    end

    %% Data Layer
    subgraph Data
        DB["App Database"]:::data
        KVR["Key-Value Repository"]:::data
        DM["Data Models"]:::data
        DAO["DAOs"]:::data
    end

    %% Configuration
    CF["Config Files"]:::config
    MD["Mock Data"]:::config

    %% Relationships
    MA --> VM
    VM --> UI
    VM --> EP
    EP --> DB
    EP --> GP
    SENS --> EP
    GLS --> SENS
    SI --> SENS
    SMOD --> SENS
    PFS --> SENS
    MAP --> PFS
    SM --> PFS
    DB --> DAO
    KVR --> VM
    BPH --> MA
    LPH --> MA
    CF --> MAP
    MD --> EP
    SC --> VM

    %% Click Events
    click MA "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/MainActivity.kt"
    click UI "https://github.com/itissid/privyloci/tree/master/app/src/main/java/me/itissid/privyloci/ui/"
    click VM "https://github.com/itissid/privyloci/tree/master/app/src/main/java/me/itissid/privyloci/viewmodels/"
    click TH "https://github.com/itissid/privyloci/tree/master/app/src/main/java/me/itissid/privyloci/ui/theme/"
    click SC "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/ui/SubscriptionCards.kt"
    click BPH "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/ui/BlePermissionHandler.kt"
    click LPH "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/ui/LocationPermissionRationaleDialogue.kt"
    click MAP "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/MainApplication.kt"
    click PFS "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/service/PrivyForegroundService.kt"
    click SM "https://github.com/itissid/privyloci/tree/master/app/src/main/java/me/itissid/privyloci/service/"
    click EP "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/eventprocessors/EventProcessor.kt"
    click GP "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/eventprocessors/GeofenceEventProcessor.kt"
    click SENS "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/SensorManager.kt"
    click GLS "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/sensors/GoogleFusedLocationSensor.kt"
    click SI "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/sensors/ISensor.kt"
    click SMOD "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/SensorModule.kt"
    click DB "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/db/AppDatabase.kt"
    click KVR "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/kvrepository/Repository.kt"
    click DM "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/datamodels/DataModels.kt"
    click DAO "https://github.com/itissid/privyloci/blob/master/app/src/main/java/me/itissid/privyloci/datamodels/Dao.kt"
    click CF "https://github.com/itissid/privyloci/blob/master/app/src/main/assets/config.json"
    click MD "https://github.com/itissid/privyloci/blob/master/app/src/main/assets/mock_data.json"
```
