:core:preferences/dev.atick.core.preferences.data/UserPreferencesDataSource

UserPreferencesDataSource

Data source for managing user preferences using DataStore (Proto DataStore pattern).

This interface provides type-safe access to user preferences stored via Jetpack DataStore. Unlike SharedPreferences, DataStore offers:

Type safety through Protocol Buffers (Proto DataStore)
Reactive updates via Flow
Coroutine support for all operations
Data consistency with transactional updates
Crash safety with atomic read/write operations

Design Pattern

This follows the DataStore Pattern:

All reads return Flow for reactive UI updates
All writes are suspend functions (transactional and async)
Preferences are strongly typed via UserDataPreferences
No blocking I/O operations

Common Use Cases

Store user session data (user ID, profile info)
Manage UI preferences (theme, dynamic colors)
Persist app settings that survive app restarts
Track onboarding state or first-run flags

Usage in Repositories

class UserRepository @Inject constructor(
    private val userPreferencesDataSource: UserPreferencesDataSource
) {
    // Reactive query for UI
    fun observeUserData(): Flow<UserData> =
        userPreferencesDataSource.getUserDataPreferences()
            .map { it.toDomainModel() }

    // Check authentication
    suspend fun requireUserId(): String =
        userPreferencesDataSource.getUserIdOrThrow()

    // Update theme
    suspend fun setDarkMode(enabled: Boolean): Result<Unit> = suspendRunCatching {
        val config = if (enabled) DarkThemeConfigPreferences.DARK
                     else DarkThemeConfigPreferences.LIGHT
        userPreferencesDataSource.setDarkThemeConfig(config)
    }
}

Usage in ViewModels

@HiltViewModel
class SettingsViewModel @Inject constructor(
    private val userPreferencesDataSource: UserPreferencesDataSource
) : ViewModel() {
    val userData = userPreferencesDataSource.getUserDataPreferences()
        .stateIn(viewModelScope, SharingStarted.WhileSubscribed(5000), UserDataPreferences())

    fun toggleDarkMode() {
        _uiState.updateWith {
            val newConfig = when (userData.value.darkThemeConfigPreferences) {
                DarkThemeConfigPreferences.LIGHT -> DarkThemeConfigPreferences.DARK
                DarkThemeConfigPreferences.DARK -> DarkThemeConfigPreferences.LIGHT
                DarkThemeConfigPreferences.FOLLOW_SYSTEM -> DarkThemeConfigPreferences.DARK
            }
            userPreferencesDataSource.setDarkThemeConfig(newConfig)
        }
    }
}