# william-baldwin-paradox/oliviacemsplashanimation architecture

> Architecture diagram of the GitHub repository william-baldwin-paradox/oliviacemsplashanimation, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/william-baldwin-paradox/oliviacemsplashanimation
- Repository: https://github.com/william-baldwin-paradox/oliviacemsplashanimation

## Overview

##### Project type and purpose
- Type: iOS UI component/library built with SwiftUI.
- Purpose: Provide a production-ready splash screen animation (using Rive) that transitions into a login UI.

##### Main components
a. App Entry (SwiftUI App struct)
b. Splash Module
– SplashView (SwiftUI View)
– SplashViewModel (business logic + state)
– SplashConstants (configuration & magic numbers)
c. Login Module
– LoginView (SwiftUI View)
d. Shared UI Components
– Custom Button, InputField, Toggle, AppColors, AnimationProgressEnvironment
e. Resources
– Asset Catalog (Assets.xcassets)
– Rive File (olivia-cem-splash-prod.riv)
f. External Framework
– RiveRuntime.xcframework

##### Relationships and data flow
- The App Entry → injects topSafeArea into SplashView.
- SplashView ↔ binds to SplashViewModel (two‐way: view reads published state; viewModel receives animation events).
- SplashView → loads RiveRuntime.xcframework → renders .riv file, fires “logoDelta” events.
- SplashViewModel → monitors initializationPercent input, listens for events, updates “showLogin” state.
- When “logoDelta” fires → SplashViewModel toggles flag → SplashView transitions to LoginView.
- Shared Components → used by both SplashView and LoginView for styling and controls.

##### Architectural patterns and design principles
- MVVM: clear View / ViewModel separation.
- Environment injection: animation progress via AnimationProgressEnvironment.
- Constants centralization: SplashConstants.
- Thread safety: @MainActor annotations, Task usage.
- Error handling & fallback: Rive load failures trigger fallback UI in SplashView.

##### Technologies & frameworks
- SwiftUI (iOS 17+)
- Rive iOS Runtime v6.7.4 (xcframework or SPM)
- SwiftLint (build‐time quality checks)

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph "App Entry"
        AppEntry["OliviaCEMSplashApp.swift"]:::entry
    end

    subgraph "Splash Module"
        SplashView["SplashView.swift"]:::view
        SplashVM["SplashViewModel.swift"]:::viewmodel
        SplashConst["SplashConstants.swift"]:::viewmodel
    end

    subgraph "Login Module"
        LoginView["LoginView.swift"]:::view
    end

    subgraph "Shared UI Components"
        Button["Button.swift"]:::shared
        InputField["InputField.swift"]:::shared
        CustomToggle["CustomToggle.swift"]:::shared
        AppColors["AppColors.swift"]:::shared
        AnimationEnv["AnimationProgressEnvironment"]:::shared
    end

    subgraph "Resources"
        Assets[(Assets.xcassets)]:::resource
        RiveFile[(olivia-cem-splash-prod.riv)]:::resource
    end

    subgraph "External Framework"
        RiveRuntime[/RiveRuntime.xcframework/]:::framework
    end

    AppEntry -->|"topSafeArea injection"| SplashView
    SplashView --"binds to"--> SplashVM
    SplashVM --"published state updates"--> SplashView
    SplashView -->|"loads runtime"| RiveRuntime
    RiveRuntime -->|"renders file"| RiveFile
    SplashView -->|"logoDelta event"| SplashVM
    SplashVM -->|"showLogin toggled"| SplashView

    SplashView -->|"uses shared control"| Button
    SplashView --> InputField
    SplashView --> CustomToggle
    SplashView --> AppColors
    SplashView --> AnimationEnv

    LoginView --> Button
    LoginView --> InputField
    LoginView --> CustomToggle
    LoginView --> AppColors
    LoginView --> AnimationEnv

    SplashView --> Assets
    LoginView --> Assets

    click AppEntry "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/OliviaCEMSplashApp.swift"
    click SplashView "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Splash/SplashView.swift"
    click SplashVM "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Splash/SplashViewModel.swift"
    click SplashConst "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Splash/SplashConstants.swift"
    click LoginView "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Login/LoginView.swift"
    click Button "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Shared/Button.swift"
    click InputField "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Shared/InputField.swift"
    click CustomToggle "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Shared/CustomToggle.swift"
    click AppColors "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/App/Shared/AppColors.swift"
    click Assets "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/Assets.xcassets"
    click RiveFile "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/Resources/Rive/olivia-cem-splash-prod.riv"
    click RiveRuntime "https://github.com/william-baldwin-paradox/oliviacemsplashanimation/blob/main/Olivia CEM Splash Animation/RiveRuntime.xcframework"

    classDef entry fill:#f9f,stroke:#333,stroke-width:1px;
    classDef view fill:#bbdefb,stroke:#1e88e5,stroke-width:2px;
    classDef viewmodel fill:#c8e6c9,stroke:#388e3c,stroke-width:2px;
    classDef shared fill:#e3f2fd,stroke:#64b5f6,stroke-width:1px;
    classDef resource fill:#fff9c4,stroke:#fbc02d,stroke-width:2px,stroke-dasharray: 5 5;
    classDef framework fill:#eceff1,stroke:#607d8b,stroke-width:2px,stroke-dasharray: 2 2;
```
