What's new in Mavericks 3.0

Experimental MavericksRepository

Mavericks 3.0 introduces an experimental module mvrx-common with new abstraction MavericksRepository designed to provide a base class for any stateful repository implementation that owns and manages its state. This module is pure Kotlin and has no Android dependencies. Primary goal of this module is to provide the same API and behaviour as MavericksViewModel in Android modules.

API Changes

Mavericks 3.0 introduces one breaking change: MavericksViewModelConfig.BlockExecutions is extracted into MavericksBlockExecutions. In order to migrate, you need to update your code to use MavericksBlockExecutions instead of MavericksViewModelConfig.BlockExecutions.

New Functionality

MavericksRepository

MavericksRepository behaves exactly like MavericksViewModel except it doesn't have any Android dependencies. Even more, under the hood MavericksViewModel uses MavericksRepository to manage its state. You can find that MavericksRepository and MavericksViewModel are very similar in terms of API and behaviour. As this is experimental module you have to opt in to use it by -opt-in=com.airbnb.mvrx.InternalMavericksApi compilation argument.

data class Forecast(
    val temperature: Int,
    val precipitation: Int,
    val wind: Int,
)

data class WeatherForecastState(
    val forecasts: Async<List<Forecast>> = Uninitialized,
) : MavericksState

interface WeatherApi {
    suspend fun getForecasts(): List<Forecast>
}

class WeatherForecastRepository(
    scope: CoroutineScope,
    private val api: WeatherApi,
) : MavericksRepository<WeatherForecastState>(
    initialState = WeatherForecastState(),
    coroutineScope = scope,
    performCorrectnessValidations = BuildConfig.DEBUG,
) {
    init {
        suspend { api.getForecasts() }.execute { copy(forecasts = it) }
    }

    fun refresh() {
        suspend { api.getForecasts() }.execute { copy(forecasts = it) }
    }
}

MavericksRepositoryConfig

In order to construct an instance of MavericksRepository you have to provide some configuration parameters, you can do that by:

1. providing instance of MavericksRepositoryConfig

class WeatherForecastRepository(
    scope: CoroutineScope,
    private val api: WeatherApi,
) : MavericksRepository<WeatherForecastState>(
    MavericksRepositoryConfig(...)

2. or via constructor arguments

class WeatherForecastRepository(
    scope: CoroutineScope,
    private val api: WeatherApi,
) : MavericksRepository<WeatherForecastState>(
    initialState = WeatherForecastState(),
    coroutineScope = scope,
    performCorrectnessValidations = BuildConfig.DEBUG,
)

Note: performCorrectnessValidations should be enabled in debug build only as it applies runtime checks to ensure the repository is used correctly. To avoid extra overhead this flag should be disabled in production build.

Checkout out integrate Mavericks into your app or docs for MavericksRepositoryConfig for more info.