[optimize] Replace Nav2 with Nav3

Author: SkyD666

gradle/libs.versions.toml

@@ -13,7 +13,7 @@ compose-materialIconsExtended = "1.7.3"
 lifecycle = "2.9.6"
 navigation3 = "1.0.1"
 ktor = "3.4.0"
-koin = "4.1.1"
+koin = "4.2.0-RC1"
 ksoup = "0.2.5"
 coil = "3.3.0"
 paging = "3.4.1"
@@ -50,6 +50,7 @@ jetbrains-compose-components-resources = { module = "org.jetbrains.compose.compo
 
 jetbrains-navigation3-ui = { module = "org.jetbrains.androidx.navigation3:navigation3-ui", version = "1.1.0-alpha02" }
 jetbrains-lifecycle-viewmodel = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel", version.ref = "lifecycle" }
+jetbrains-lifecycle-viewmodel-navigation3 = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-navigation3", version = "2.10.0-alpha08" }
 jetbrains-lifecycle-runtime-compose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-runtime-compose", version.ref = "lifecycle" }
 
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin" }
@@ -71,7 +72,6 @@ androidx-work-runtime-ktx = { module = "androidx.work:work-runtime-ktx", version
 androidx-paging-common = { module = "androidx.paging:paging-common", version.ref = "paging" }
 androidx-paging-compose = { module = "androidx.paging:paging-compose", version.ref = "paging" }
 androidx-navigation3-runtime = { module = "androidx.navigation3:navigation3-runtime", version.ref = "navigation3" }
-androidx-lifecycle-viewmodel-navigation3 = { module = "androidx.lifecycle:lifecycle-viewmodel-navigation3", version = "2.10.0" }
 
 androidx-room-runtime = { module = "androidx.room:room-runtime", version.ref = "room" }
 androidx-room-ktx = { module = "androidx.room:room-ktx", version.ref = "room" }
@@ -82,7 +82,7 @@ koin-core = { module = "io.insert-koin:koin-core", version.ref = "koin" }
 koin-android = { module = "io.insert-koin:koin-android", version.ref = "koin" }
 koin-compose = { module = "io.insert-koin:koin-compose", version.ref = "koin" }
 koin-compose-viewmodel = { module = "io.insert-koin:koin-compose-viewmodel", version.ref = "koin" }
-koin-compose-viewmodel-navigation = { module = "io.insert-koin:koin-compose-viewmodel-navigation", version.ref = "koin" }
+koin-compose-navigation3 = { module = "io.insert-koin:koin-compose-navigation3", version.ref = "koin" }
 
 kermit = { module = "co.touchlab:kermit", version = "2.0.8" }
 kotlincrypto-hash-md = { module = "org.kotlincrypto.hash:md", version = "0.8.0" }
@@ -126,7 +126,7 @@ icu4j = { module = "com.ibm.icu:icu4j", version = "78.1" }
 ocpsoft-prettytime = { module = "org.ocpsoft.prettytime:prettytime", version = "5.0.9.Final" }
 
 skyd666-settings = { module = "io.github.skyd666:settings", version = "1.0-beta08" }
-skyd666-compone = { module = "io.github.skyd666:compone", version = "1.0-beta21" }
+skyd666-compone = { module = "io.github.skyd666:compone", version = "1.0-beta22" }
 skyd666-mvi = { module = "io.github.skyd666:mvi", version = "1.0-beta05" }
 
 junit = { module = "junit:junit", version = "4.13.2" }

platform/android/app/build.gradle.kts

@@ -220,7 +220,7 @@ dependencies {
     implementation(libs.koin.android)
     implementation(libs.koin.compose)
     implementation(libs.koin.compose.viewmodel)
-    implementation(libs.koin.compose.viewmodel.navigation)
+    implementation(libs.koin.compose.navigation3)
 
     implementation(libs.kotlinx.coroutines.guava)
 

shared/build.gradle.kts

@@ -74,6 +74,7 @@ kotlin {
             implementation(libs.jetbrains.compose.materialIconsExtended)
             implementation(libs.jetbrains.compose.components.resources)
             implementation(libs.jetbrains.lifecycle.viewmodel)
+            implementation(libs.jetbrains.lifecycle.viewmodel.navigation3)
             implementation(libs.jetbrains.lifecycle.runtime.compose)
             implementation(libs.jetbrains.navigation3.ui)
 
@@ -82,11 +83,10 @@ kotlin {
             implementation(libs.androidx.paging.compose)
             implementation(libs.androidx.constraintlayout.compose)
             implementation(libs.androidx.navigation3.runtime)
-            implementation(libs.androidx.lifecycle.viewmodel.navigation3)
 
             implementation(libs.koin.core)
             implementation(libs.koin.compose.viewmodel)
-            implementation(libs.koin.compose.viewmodel.navigation)
+            implementation(libs.koin.compose.navigation3)
 
             implementation(libs.kotlinx.coroutines.core)
             implementation(libs.kotlinx.serialization.json)

shared/src/commonMain/kotlin/com/skyd/podaura/ui/component/Navigation.kt

@@ -1,5 +1,7 @@
 package com.skyd.podaura.ui.component
 
+import androidx.compose.animation.AnimatedContentTransitionScope
+import androidx.compose.animation.ContentTransform
 import androidx.compose.animation.core.FiniteAnimationSpec
 import androidx.compose.animation.core.tween
 import androidx.compose.animation.fadeIn
@@ -17,48 +19,28 @@ import androidx.compose.material3.adaptive.layout.PaneScaffoldRole
 import androidx.compose.material3.adaptive.layout.PaneScaffoldValue
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
-import androidx.compose.ui.Modifier.Companion
 import androidx.compose.ui.unit.IntRect
 import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator
-import androidx.navigation.NavType
 import androidx.navigation3.runtime.NavEntry
 import androidx.navigation3.runtime.NavEntryDecorator
 import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
+import androidx.navigation3.scene.Scene
 import androidx.navigation3.scene.SceneStrategy
 import androidx.navigation3.scene.SinglePaneSceneStrategy
 import androidx.navigation3.ui.NavDisplay
-import com.skyd.podaura.ui.component.UuidListType.Companion.decodeUuidList
+import androidx.navigationevent.NavigationEvent
 import com.skyd.podaura.ui.component.navigation.deeplink.TypeParser
 import kotlinx.io.Buffer
 import kotlinx.io.readByteArray
 import kotlinx.serialization.Serializable
 import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.encodeToJsonElement
 import kotlin.io.encoding.Base64
 import kotlin.uuid.Uuid
 
 
-inline fun <reified T> serializableType(
-    json: Json = Json,
-): TypeParser {
-    return { value ->
-        json.decodeFromString(value.hexToByteArray().decodeToString())
-    }
-}
-
-inline fun <reified T> listType(
-    json: Json = Json,
-): TypeParser {
-    return {
-        serializableType<List<T>>(json)
-    }
-}
-
 @Serializable
-data class UuidList(val uuids: List<String>)
-
-abstract class UuidListType<T>(
-    isNullableAllowed: Boolean = false,
-) : NavType<T>(isNullableAllowed) {
+data class UuidList(val uuids: List<String>) {
     companion object {
         fun encodeUuidList(uuidList: List<Uuid>): String {
             val buffer = Buffer()
@@ -88,7 +70,7 @@ abstract class UuidListType<T>(
 
 fun uuidListType(): TypeParser {
     return { value ->
-        UuidList(decodeUuidList(value).map { it.toString() })
+        Json.encodeToJsonElement(UuidList(UuidList.decodeUuidList(value).map { it.toString() }))
     }
 }
 
@@ -123,16 +105,27 @@ fun <T : Any> PodAuraNavDisplay(
         rememberViewModelStoreNavEntryDecorator()
     ),
     sceneStrategy: SceneStrategy<T> = SinglePaneSceneStrategy(),
+    transitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = {
+        EnterTransition togetherWith ExitTransition
+    },
+    popTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.() -> ContentTransform = {
+        PopEnterTransition togetherWith PopExitTransition
+    },
+    predictivePopTransitionSpec: AnimatedContentTransitionScope<Scene<T>>.(
+        @NavigationEvent.SwipeEdge Int
+    ) -> ContentTransform = {
+        PopEnterTransition togetherWith PopExitTransition
+    },
     entryProvider: (key: T) -> NavEntry<T>,
 ) = NavDisplay(
     backStack = backStack,
     modifier = modifier.background(MaterialTheme.colorScheme.background),
     onBack = onBack,
     entryDecorators = entryDecorators,
     sceneStrategy = sceneStrategy,
-    transitionSpec = { EnterTransition togetherWith ExitTransition },
-    popTransitionSpec = { PopEnterTransition togetherWith PopExitTransition },
-    predictivePopTransitionSpec = { PopEnterTransition togetherWith PopExitTransition },
+    transitionSpec = transitionSpec,
+    popTransitionSpec = popTransitionSpec,
+    predictivePopTransitionSpec = predictivePopTransitionSpec,
     entryProvider = entryProvider,
 )
 

shared/src/commonMain/kotlin/com/skyd/podaura/ui/component/navigation/ExternalUrlHandler.kt

@@ -5,11 +5,13 @@ import androidx.compose.runtime.DisposableEffect
 import androidx.navigation3.runtime.NavKey
 import com.skyd.podaura.ui.component.navigation.deeplink.DeepLinkMatcher
 import com.skyd.podaura.ui.component.navigation.deeplink.DeepLinkRequest
-import com.skyd.podaura.ui.component.navigation.deeplink.KeyDecoder
 import com.skyd.podaura.ui.screen.deepLinkPatterns
 import io.ktor.http.URLBuilder
 import kotlinx.serialization.SerialName
 import kotlinx.serialization.Serializable
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.JsonPrimitive
+import kotlinx.serialization.json.buildJsonObject
 
 object ExternalUrlHandler {
     // Storage for when a Url arrives before the listener is set up
@@ -83,12 +85,19 @@ internal fun ExternalUrlHandler.UrlData.toNavKey(): NavKey? {
     val match = deepLinkPatterns.firstNotNullOfOrNull { pattern ->
         DeepLinkMatcher(request, pattern).match()
     }
+
+    val json = Json {
+        isLenient = true
+        ignoreUnknownKeys = true
+    }
     return match?.let {
-        KeyDecoder(buildMap {
-            putAll(match.args)
-            url?.let { put(ExternalUrlHandler.UrlData.URL_NAME, it) }
-            mimeType?.let { put(ExternalUrlHandler.UrlData.MIMETYPE_NAME, it) }
-            action?.let { put(ExternalUrlHandler.UrlData.ACTION_NAME, it) }
-        }).decodeSerializableValue(match.serializer)
+        json.decodeFromJsonElement(match.serializer, buildJsonObject {
+            for (entry in match.args) {
+                put(entry.key, entry.value)
+            }
+            url?.let { put(ExternalUrlHandler.UrlData.URL_NAME, JsonPrimitive(it)) }
+            mimeType?.let { put(ExternalUrlHandler.UrlData.MIMETYPE_NAME, JsonPrimitive(it)) }
+            action?.let { put(ExternalUrlHandler.UrlData.ACTION_NAME, JsonPrimitive(it)) }
+        })
     }
 }

shared/src/commonMain/kotlin/com/skyd/podaura/ui/component/navigation/PodAuraSerializersModule.kt

@@ -10,6 +10,7 @@ import com.skyd.podaura.ui.screen.calendar.CalendarRoute
 import com.skyd.podaura.ui.screen.download.DownloadDeepLinkRoute
 import com.skyd.podaura.ui.screen.download.DownloadRoute
 import com.skyd.podaura.ui.screen.feed.FeedListRoute
+import com.skyd.podaura.ui.screen.feed.FeedRoute
 import com.skyd.podaura.ui.screen.feed.autodl.AutoDownloadRuleRoute
 import com.skyd.podaura.ui.screen.feed.mute.MuteFeedRoute
 import com.skyd.podaura.ui.screen.feed.reorder.feed.ReorderFeedRoute
@@ -18,8 +19,11 @@ import com.skyd.podaura.ui.screen.feed.requestheaders.RequestHeadersRoute
 import com.skyd.podaura.ui.screen.filepicker.FilePickerRoute
 import com.skyd.podaura.ui.screen.history.HistoryRoute
 import com.skyd.podaura.ui.screen.history.search.HistorySearchRoute
+import com.skyd.podaura.ui.screen.media.MediaRoute
 import com.skyd.podaura.ui.screen.media.search.MediaSearchRoute
 import com.skyd.podaura.ui.screen.media.sub.SubMediaRoute
+import com.skyd.podaura.ui.screen.more.MoreRoute
+import com.skyd.podaura.ui.screen.playlist.PlaylistRoute
 import com.skyd.podaura.ui.screen.playlist.medialist.PlaylistMediaListRoute
 import com.skyd.podaura.ui.screen.read.ReadRoute
 import com.skyd.podaura.ui.screen.search.SearchRoute
@@ -50,8 +54,10 @@ import kotlinx.serialization.modules.subclass
 val PodAuraSerializersModule = SerializersModule {
     polymorphic(baseClass = NavKey::class) {
         subclass(MainRoute::class)
+        subclass(FeedRoute::class)
         subclass(FeedListRoute::class)
         subclass(ArticleRoute::class)
+        subclass(MoreRoute::class)
         subclass(LicenseRoute::class)
         subclass(AboutRoute::class)
         subclass(TermsOfServiceRoute::class)
@@ -80,6 +86,7 @@ val PodAuraSerializersModule = SerializersModule {
         subclass(AutoDownloadRuleRoute::class)
         subclass(MuteFeedRoute::class)
         subclass(DeleteConstraintRoute::class)
+        subclass(PlaylistRoute::class)
         subclass(PlaylistMediaListRoute::class)
         subclass(RequestHeadersRoute::class)
         subclass(FilePickerRoute::class)
@@ -88,6 +95,7 @@ val PodAuraSerializersModule = SerializersModule {
         subclass(ReadRoute::class)
         subclass(SearchRoute.Feed::class)
         subclass(SearchRoute.Article::class)
+        subclass(MediaRoute::class)
         subclass(MediaSearchRoute::class)
         subclass(SubMediaRoute::class)
         subclass(HistorySearchRoute::class)

shared/src/commonMain/kotlin/com/skyd/podaura/ui/component/navigation/deeplink/DeepLinkMatcher.kt

@@ -4,6 +4,8 @@ import androidx.navigation3.runtime.NavKey
 import co.touchlab.kermit.Logger
 import io.ktor.http.authority
 import kotlinx.serialization.KSerializer
+import kotlinx.serialization.json.JsonElement
+import kotlinx.serialization.json.JsonObject
 
 internal class DeepLinkMatcher<T : NavKey>(
     val request: DeepLinkRequest,
@@ -44,12 +46,12 @@ internal class DeepLinkMatcher<T : NavKey>(
                 }
                 // exact match (url does not contain any arguments)
                 if (request.uri == deepLinkPattern.urlPattern) {
-                    return DeepLinkMatchResult(deepLinkPattern.serializer, mapOf())
+                    return DeepLinkMatchResult(deepLinkPattern.serializer, JsonObject(mapOf()))
                 }
             }
         }
 
-        val args = mutableMapOf<String, Any>()
+        val args = mutableMapOf<String, JsonElement>()
         // match the path
         request.pathSegments
             .asSequence()
@@ -91,7 +93,7 @@ internal class DeepLinkMatcher<T : NavKey>(
             args[name] = queryParsedValue
         }
         // provide the serializer of the matching key and map of arg names to parsed arg values
-        return DeepLinkMatchResult(deepLinkPattern.serializer, args)
+        return DeepLinkMatchResult(deepLinkPattern.serializer, JsonObject(args))
     }
 }
 
@@ -101,11 +103,9 @@ internal class DeepLinkMatcher<T : NavKey>(
  *
  * @param [T] the backstack key associated with the deeplink that matched with the requested deeplink
  * @param serializer serializer for [T]
- * @param args The map of argument name to argument value. The value is expected to have already
- * been parsed from the raw url string back into its proper KType as declared in [T].
- * Includes arguments for all parts of the uri - path, query, etc.
+ * @param args The JsonObject of argument name to argument value.
  * */
 internal data class DeepLinkMatchResult<T : NavKey>(
     val serializer: KSerializer<T>,
-    val args: Map<String, Any>
+    val args: JsonObject
 )

shared/src/commonMain/kotlin/com/skyd/podaura/ui/component/navigation/deeplink/DeepLinkPattern.kt

@@ -1,11 +1,16 @@
 package com.skyd.podaura.ui.component.navigation.deeplink
 
 import androidx.navigation3.runtime.NavKey
+import com.skyd.podaura.util.from
 import io.ktor.http.Url
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.descriptors.PrimitiveKind
 import kotlinx.serialization.descriptors.SerialKind
+import kotlinx.serialization.descriptors.StructureKind
 import kotlinx.serialization.encoding.CompositeDecoder
+import kotlinx.serialization.json.JsonArray
+import kotlinx.serialization.json.JsonElement
+import kotlinx.serialization.json.JsonPrimitive
 
 /**
  * Parse a supported deeplink and stores its metadata as a easily readable format
@@ -112,26 +117,27 @@ class DeepLinkPattern<T : NavKey>(
 }
 
 /**
- * Parses a String into a Primitive
+ * Parses a String into a JsonElement
  */
-typealias TypeParser = (String) -> Any
+typealias TypeParser = (String) -> JsonElement
 
 private fun getTypeParser(kind: SerialKind, additional: Map<SerialKind, TypeParser>): TypeParser {
-    additional[kind]?.let {
-        return it
-    }
+    additional[kind]?.let { return it }
     return when (kind) {
-        PrimitiveKind.STRING -> Any::toString
-        PrimitiveKind.INT -> String::toInt
-        PrimitiveKind.BOOLEAN -> String::toBoolean
-        PrimitiveKind.BYTE -> String::toByte
-        PrimitiveKind.CHAR -> String::toCharArray
-        PrimitiveKind.DOUBLE -> String::toDouble
-        PrimitiveKind.FLOAT -> String::toFloat
-        PrimitiveKind.LONG -> String::toLong
-        PrimitiveKind.SHORT -> String::toShort
+        PrimitiveKind.STRING -> ::JsonPrimitive
+        PrimitiveKind.INT -> ::JsonPrimitive
+        PrimitiveKind.BOOLEAN -> ::JsonPrimitive
+        PrimitiveKind.DOUBLE -> ::JsonPrimitive
+        PrimitiveKind.FLOAT -> ::JsonPrimitive
+        PrimitiveKind.LONG -> ::JsonPrimitive
+        PrimitiveKind.SHORT -> ::JsonPrimitive
+        StructureKind.LIST -> { value: Any? ->
+            val list = value as? List<*> ?: throw IllegalArgumentException("Expected List")
+            JsonArray.from(list)
+        }
+
         else -> throw IllegalArgumentException(
-            "Unsupported argument type of SerialKind:$kind. The argument type must be a Primitive."
+            "Unsupported argument type of SerialKind:$kind. The argument type must be a Primitive or in the additional."
         )
     }
 }