# novumlogic/android-offline-first-supabase-library architecture

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

- Interactive diagram: https://gitdiagram.com/novumlogic/android-offline-first-supabase-library
- Repository: https://github.com/novumlogic/android-offline-first-supabase-library

## Overview

##### Project Type and Purpose
- This is an Android “offline-first” library module (`SupabaseOfflineSupport`) plus a sample Todo application (`sample`).
- The library provides generic synchronization between a local Room database and remote Supabase tables.
- The sample app demonstrates usage in a full-stack mobile MVVM architecture: UI → ViewModel → Repository → Data Sources → Sync Layer → Supabase.

##### File Structure Analysis
- Top level:
- `SupabaseOfflineSupport/` – Kotlin library module with source under `src/main/java/com/example/supabaseofflinesupport`.
- `sample/` – Android application module implementing a Todo MVVM app under `src/main/java/com/novumlogic/todo`.
- Gradle configs (`build.gradle`, `settings.gradle`, wrappers).
- Library module contains:
- Core sync abstractions: `BaseDataSyncer`, `SyncManager`, `BaseSyncableEntity`, `BaseRemoteEntity`, `GenericDao`.
- Helpers: `NetworkHelper`, `RetrofitClient`, `SupabaseApiService`, converters and extensions.
- Sample app module contains:
- Presentation: Activities/Fragments (`MainActivity`, `NewTaskFragment`), ViewModels, adapters.
- Data layer: `TaskRepository`, local datasources/DAOs/entities, remote datasources (`TaskRemoteDataSource`, `CategoryRemoteDataSource`), DTOs.
- Room database schema (`TodoDatabase`) and entity/DAO packages.
- Resources: layouts, drawables, menus, XML, values.

##### Key Insights from README
- Architecture: MVVM + Repository + Data Source layers + Sync Manager.
- Sync algorithm overview: last-write-wins conflict resolution, two-way merge, timestamp-based.
- Technical stack: Kotlin, Room, Supabase Kotlin client, Kotlinx Serialization.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Presentation Layer
    subgraph "Presentation Layer"
        direction TB
        MA["MainActivity"]:::presentation
        NTF["NewTaskFragment"]:::presentation
        CTA["CompleteTaskAdapter"]:::presentation
        ITA["IncompleteTaskAdapter"]:::presentation
    end

    %% ViewModel Layer
    subgraph "ViewModel Layer"
        direction TB
        MVM["MainViewModel"]:::viewmodel
        NTVM["NewTaskViewModel"]:::viewmodel
    end

    %% Repository Layer
    subgraph "Repository Layer"
        direction TB
        TR["TaskRepository"]:::repository
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        subgraph "Local Data Sources" 
            direction TB
            TLD["TaskLocalDataSource"]:::local
            CLD["CategoryLocalDataSource"]:::local
            PLD["PriorityLocalDataSource"]:::local
            DBS["TodoDatabase"]:::local
            DAOs["All DAOs (TaskDao, CategoryDao, PriorityDao)"]:::local
        end

        subgraph "Sync Layer"
            direction TB
            BD["BaseDataSyncer"]:::sync
            SM["SyncManager"]:::sync
            BSE["BaseSyncableEntity"]:::sync
            BRE["BaseRemoteEntity"]:::sync
            GD["GenericDao"]:::sync
            OCT["OfflineCrudType"]:::sync
            NH["NetworkHelper"]:::sync
        end

        subgraph "Remote Data Sources"
            direction TB
            RC["RetrofitClient"]:::remote
            SAS["SupabaseApiService"]:::remote
            CRS["CategoryRemoteDataSource"]:::remote
            TRS["TaskRemoteDataSource"]:::remote
            DTOs["DTOs (TaskDto, CategoryDto)"]:::remote
        end
    end

    %% External
    SUP["Supabase PostgreSQL"]:::external

    %% Connections
    MA -->|user events| MVM
    NTF -->|user events| NTVM

    MVM -->|calls| TR
    NTVM -->|calls| TR

    TR -->|reads/writes| TLD
    TR -->|reads/writes| CLD
    TR -->|reads/writes| PLD

    TR -->|triggers sync| SM

    NH -->|on network available| SM

    SM -->|query/update| DAOs
    DAOs -->|data| SM
    SM -->|push/pull| SAS
    SAS -->|HTTP REST| SUP

    RC -->|provides client| SAS
    CRS -->|uses| SAS
    TRS -->|uses| SAS
    DTOs -->|data mapping| CRS
    DTOs -->|data mapping| TRS

    %% Click Events
    click MA "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/MainActivity.kt"
    click NTF "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/NewTaskFragment.kt"
    click CTA "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/adapters/CompleteTaskAdapter.kt"
    click ITA "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/adapters/IncompleteTaskAdapter.kt"
    click MVM "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/viewmodels/MainViewModel.kt"
    click NTVM "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/ui/viewmodels/NewTaskViewModel.kt"
    click TR "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/TaskRepository.kt"
    click TLD "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/TaskLocalDataSource.kt"
    click CLD "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/CategoryLocalDataSource.kt"
    click PLD "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/PriorityLocalDataSource.kt"
    click DBS "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/TodoDatabase.kt"
    click DAOs "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/TaskDao.kt"
    click DAOs "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/CategoryDao.kt"
    click DAOs "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/sample/src/main/java/com/novumlogic/todo/data/local/PriorityDao.kt"
    click BD "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/BaseDataSyncer.kt"
    click SM "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/SyncManager.kt"
    click BSE "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/BaseSyncableEntity.kt"
    click BRE "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/BaseRemoteEntity.kt"
    click GD "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/GenericDao.kt"
    click OCT "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/OfflineCrudType.kt"
    click NH "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/helpers/NetworkHelper.kt"
    click RC "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/helpers/RetrofitClient.kt"
    click SAS "https://github.com/novumlogic/android-offline-first-supabase-library/blob/main/SupabaseOfflineSupport/src/main/java/com/example/supabaseofflinesupport/helpers/SupabaseApiService.kt"
    classDef presentation fill:#D0E6FF,stroke:#0366d6,color:#0366d6
    classDef viewmodel fill:#E0F7FA,stroke:#00796B,color:#00796B
    classDef repository fill:#E6F4EA,stroke:#2E7D32,color:#2E7D32
    classDef local fill:#E8F5E9,stroke:#388E3C,color:#388E3C
    classDef sync fill:#FFF3E0,stroke:#F57C00,color:#F57C00
    classDef remote fill:#F3E5F5,stroke:#8E24AA,color:#8E24AA
    classDef external fill:#ECEFF1,stroke:#607D8B,color:#607D8B
```
