MVI BaseViewModel file template

mviBaseVm

1. Main one - ViewModel

NAME: MVI BaseViewModell
FILE NAME: BaseViewModel
EXTENSION: kt

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME} #end

import androidx.lifecycle.ViewModel
import androidx.lifecycle.viewModelScope
import kotlinx.coroutines.channels.Channel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.SharingStarted
import kotlinx.coroutines.flow.onStart
import kotlinx.coroutines.flow.receiveAsFlow
import kotlinx.coroutines.flow.stateIn
import kotlinx.coroutines.flow.update

abstract class BaseViewModel<STATE, ACTION: UiAction>(
    initialState: STATE,
    stateFlowSubscriptionStopTimeoutMillis: Long = STATE_FLOW_SUBSCRIPTION_STOP_TIMEOUT_MILLIS
): ViewModel() {

    protected val _uiState: MutableStateFlow<STATE> = MutableStateFlow(initialState)
    val uiState = _uiState
        .onStart { loadData() }
        .stateIn(
            scope = viewModelScope,
            started = SharingStarted.WhileSubscribed(stateFlowSubscriptionStopTimeoutMillis),
            initialValue = initialState
        )

    protected val _uiEvent = Channel<UiEvent>()
    val uiEvent = _uiEvent.receiveAsFlow()

    val currentState: STATE
        get() = uiState.value

    abstract fun loadData()
    abstract fun onAction(action: ACTION)

    companion object {
        private const val STATE_FLOW_SUBSCRIPTION_STOP_TIMEOUT_MILLIS = 5000L
    }
}

2. UiEvent marker interface

FILE NAME: UiEvent
EXTENSION: kt

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME} #end

interface UiEvent


3. UiAction marker interface

FILE NAME: UiAction
EXTENSION: kt

#if (${PACKAGE_NAME} && ${PACKAGE_NAME} != "")package ${PACKAGE_NAME} #end

interface UiAction