Add KMP ViewModel

Author: mlykotom

gradle/libs.versions.toml

@@ -130,6 +130,7 @@ androidx-lifecycle-runtime = { module = "androidx.lifecycle:lifecycle-runtime-kt
 androidx-lifecycle-runtime-compose = { module = "androidx.lifecycle:lifecycle-runtime-compose", version.ref = "androidx-lifecycle-runtime-compose" }
 androidx-lifecycle-service = { module = "androidx.lifecycle:lifecycle-service", version.ref = "lifecycleService" }
 androidx-lifecycle-viewModelCompose = { module = "androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle-compose" }
+androidx-lifecycle-viewmodel = { module = "androidx.lifecycle:lifecycle-viewmodel", version.ref = "androidx-lifecycle-compose" }
 androidx-lifecycle-viewmodel-ktx = { module = "androidx.lifecycle:lifecycle-viewmodel-ktx", version.ref = "androidx-lifecycle-compose" }
 androidx-material-icons-core = { module = "androidx.compose.material:material-icons-core" }
 androidx-media3-common = { module = "androidx.media3:media3-common", version.ref = "media3" }
@@ -179,7 +180,7 @@ horologist-compose-layout = { module = "com.google.android.horologist:horologist
 horologist-compose-material = { module = "com.google.android.horologist:horologist-compose-material", version.ref = "horologist" }
 junit = { module = "junit:junit", version.ref = "junit" }
 kotlin-coroutines-okhttp = { module = "ru.gildor.coroutines:kotlin-coroutines-okhttp", version.ref = "kotlinCoroutinesOkhttp" }
-kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
+kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin" }
 kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-android", version.ref = "coroutines" }
 kotlinx-coroutines-guava = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-guava", version.ref = "kotlinxCoroutinesGuava" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutines" }
@@ -199,10 +200,10 @@ compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "
 gradle-versions = { id = "com.github.ben-manes.versions", version.ref = "gradle-versions" }
 hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
 kotlin-android = "org.jetbrains.kotlin.android:2.2.10"
+kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
+android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.library", version.ref = "androidGradlePlugin" }
 kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlin" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 ksp = { id = "com.google.devtools.ksp", version.ref = "ksp" }
 version-catalog-update = { id = "nl.littlerobots.version-catalog-update", version.ref = "version-catalog-update" }
-kotlin-multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
-android-kotlin-multiplatform-library = { id = "com.android.kotlin.multiplatform.library", version.ref = "androidGradlePlugin" }
 android-lint = { id = "com.android.lint", version.ref = "androidGradlePlugin" }

kmp/kmp-shared/build.gradle.kts

@@ -31,23 +31,15 @@ kotlin {
     // A step-by-step guide on how to include this library in an XCode
     // project can be found here:
     // https://developer.android.com/kotlin/multiplatform/migrate
-    val xcfName = "kmp-sharedKit"
 
-    iosX64 {
-        binaries.framework {
-            baseName = xcfName
-        }
-    }
-
-    iosArm64 {
-        binaries.framework {
-            baseName = xcfName
-        }
-    }
-
-    iosSimulatorArm64 {
-        binaries.framework {
-            baseName = xcfName
+    listOf(
+        iosX64(),
+        iosArm64(),
+        iosSimulatorArm64(),
+    ).forEach {
+        it.binaries.framework {
+            export(libs.androidx.lifecycle.viewmodel)
+            baseName = "KmpKit"
         }
     }
 
@@ -60,7 +52,7 @@ kotlin {
         commonMain {
             dependencies {
                 implementation(libs.jetbrains.kotlin.stdlib)
-                // Add KMP dependencies here
+                api(libs.androidx.lifecycle.viewmodel)
             }
         }
 

kmp/kmp-shared/src/commonMain/kotlin/com/example/kmp/kmp_shared/MainViewModel.kt

@@ -0,0 +1,22 @@
+package com.example.kmp.kmp_shared
+
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.viewmodel.initializer
+import androidx.lifecycle.viewmodel.viewModelFactory
+
+
+class MainViewModel(
+    private val repository: DataRepository,
+) : ViewModel() { /* some logic */ }
+
+// ViewModelFactory that retrieves the data repository for your app.
+val mainViewModelFactory = viewModelFactory {
+    initializer {
+        MainViewModel(repository = getDataRepository())
+    }
+}
+
+fun getDataRepository(): DataRepository = TODO()
+
+
+class DataRepository

kmp/kmp-shared/src/iosMain/kotlin/com/example/kmp/kmp_shared/ViewModelResolver.ios.kt

@@ -0,0 +1,31 @@
+package com.example.kmp.snipets
+
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.ViewModelProvider
+import androidx.lifecycle.ViewModelStore
+import androidx.lifecycle.viewmodel.CreationExtras
+import kotlinx.cinterop.BetaInteropApi
+import kotlinx.cinterop.ObjCClass
+import kotlinx.cinterop.getOriginalKotlinClass
+import kotlin.reflect.KClass
+
+/**
+ *   This function allows retrieving any ViewModel from Swift Code with generics. We only get
+ *   [kotlinx.cinterop.ObjCClass] type for the [modelClass], because the interop between Kotlin and Swift code
+ *   doesn't preserve the generic class, but we can retrieve the original KClass in Kotlin.
+ */
+@BetaInteropApi
+@Throws(IllegalArgumentException::class)
+fun ViewModelStore.resolveViewModel(
+    modelClass: ObjCClass,
+    factory: ViewModelProvider.Factory,
+    key: String?,
+    extras: CreationExtras? = null,
+): ViewModel {
+    @Suppress("UNCHECKED_CAST")
+    val vmClass = getOriginalKotlinClass(modelClass) as? KClass<ViewModel>
+    require(vmClass != null) { "The modelClass parameter must be a ViewModel type." }
+
+    val provider = ViewModelProvider.Companion.create(this, factory, extras ?: CreationExtras.Empty)
+    return key?.let { provider[key, vmClass] } ?: provider[vmClass]
+}