Shared architecture primitives for clean, layered apps: lifecycle-aware BaseViewModel exposing StateFlow with native-coroutines observation, ViewModelState marker, and sync/suspend/flow UseCase variants.
A Kotlin Multiplatform architecture library providing shared base classes and patterns for building clean, layered apps on iOS and Android.
architecture-coreKMP module (commonMain + androidMain + iosMain) containing:
The library is published to Maven Central. Add the dependency to your project.
Kotlin DSL (build.gradle.kts)
In your shared KMP module’s build.gradle.kts:
kotlin {
sourceSets {
commonMain.dependencies {
api("io.github.foshlabs.kmp.architecturekit:architecture-core:0.1.0")
}
}
}
For iOS, if you build a framework that re-exports this library, add the export in your framework block:
iosTarget.binaries.framework {
baseName = "YourFramework"
export("io.github.foshlabs.kmp.architecturekit:architecture-core:0.1.0")
}
Check Maven Central for the latest version.
Define a state class and a ViewModel that extends BaseViewModel:
data class CounterState(val count: Int = 0) : ViewModelState
class CounterViewModel : BaseViewModel<CounterState>(CounterState()) {
fun increment() {
state = state.copy(count = state.count + 1)
}
}
On iOS, observe the ViewModel’s states flow via the generated async sequence or callback APIs from KMP-NativeCoroutines.
Sync:
class GetUserNameUseCase : UseCase<UserId, String>() {
override fun invoke(input: UserId): String = input.name
}
Suspend:
class LoadUserUseCase : SuspendUseCase<UserId, User>() {
override suspend fun invoke(input: UserId): User = api.getUser(input)
}
Flow:
class ObserveMessagesUseCase : FlowUseCase<ChannelId, Message>() {
override fun invoke(input: ChannelId): Flow<Message> = repo.messagesFor(input)
}
Use the Unit* variants when there is no input (e.g. UnitSuspendUseCase<Result>).
MIT License. See the artifact POM for details.
BaseViewModel<S> — Base ViewModel with lifecycle-aware state management. Exposes state via a StateFlow<S> and uses @NativeCoroutinesState so Swift can observe it on iOS.ViewModelState — Marker interface for ViewModel state classes.UseCase<Input, Output> — Synchronous use case base class.UnitUseCase<Output> — Synchronous use case with no input.SuspendUseCase<Input, Output> — Suspend (async) use case base class.UnitSuspendUseCase<Output> — Suspend use case with no input.FlowUseCase<Input, Output> — Reactive Flow use case base class.UnitFlowUseCase<Output> — Flow use case with no input.Surfaced from shared tags and platforms — no rankings paid for.