Add AndroidTarget and Parcel Support (#64)

MV-GH · Jun 28, 2024 · 1c4fa27 · 1c4fa27
1 parent a33ec67
commit 1c4fa27
Show file tree

Hide file tree

Showing 229 changed files with 716 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -44,6 +44,8 @@ bin/
 .DS_Store
 
 temp
+/local.properties
+local.properties
 
 # TODO temp
 **/Secrets.kt
diff --git a/README.md b/README.md
@@ -4,6 +4,7 @@
 ![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/it.vercruysse.lemmyapi/lemmy-api?server=https%3A%2F%2Fs01.oss.sonatype.org)
 ![badge][badge-js]
 ![badge][badge-jvm]
+![badge][badge-android]
 ![badge][badge-linux]
 ![badge][badge-windows]
 ![badge][badge-mac]
@@ -38,11 +39,16 @@ api.getSupportedEntries<SortType>()
 ```
 
 ## Installation
-```
-implementation("it.vercruysse.lemmyapi:lemmy-api:VERSION")
 
+```kts
+implementation("it.vercruysse.lemmyapi:lemmy-api:VERSION")
 ```
+It is currently in beta, so only snapshots are available.
 
+Add the following repository
+```kts
+maven { url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots") }
+```
 
 ## Goals
 
@@ -95,7 +101,10 @@ Now to prevent having to manually write the definition file, we can generate it
 And these are generated by comparing the datatypes from the given source package version and the given target package version.
 Datatypes, which exist in both, will have a mapping generated.
 
+## Extra features
 
+- JVM datatypes implement `Serializable`
+- Android datatypes implement `Parcelable` and `Serializable`
 
 
 [badge-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat

diff --git a/app/build.gradle.kts b/app/build.gradle.kts
@@ -10,11 +10,22 @@ plugins {
     id("com.google.devtools.ksp") version ("2.0.0-1.0.22")
     id("com.vanniktech.maven.publish") version "0.29.0"
     id("com.github.ben-manes.versions") version "0.51.0"
+    id("com.android.library")
+    id("kotlin-parcelize")
 }
 
 repositories {
     mavenCentral()
     gradlePluginPortal()
+    google()
+}
+
+android {
+    namespace = "it.vercruysse.lemmyapi"
+    compileSdk = 34
+    defaultConfig {
+        minSdk = 21
+    }
 }
 
 kotlin {
@@ -28,6 +39,12 @@ kotlin {
         }
     }
 
+    androidTarget {
+        compilerOptions {
+            freeCompilerArgs.addAll("-P", "plugin:org.jetbrains.kotlin.parcelize:additionalAnnotation=it.vercruysse.lemmyapi.CommonParcelize")
+        }
+    }
+
     linuxX64()
     linuxArm64()
     mingwX64()
@@ -53,7 +70,7 @@ kotlin {
 
         commonMain.dependencies {
             implementation("io.ktor:ktor-client-core:$ktorVersion")
-            implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.0")
+            implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.8.1")
             implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.1")
 
             implementation("io.ktor:ktor-client-content-negotiation:$ktorVersion")
@@ -97,9 +114,12 @@ kotlin {
             api("io.ktor:ktor-client-cio:$ktorVersion")
         }
 
+        androidMain.dependencies {
+            api("io.ktor:ktor-client-okhttp:$ktorVersion")
+        }
     }
 
-    val publicationsFromMainHost = listOf(jvm(), js()).map { it.name } + "kotlinMultiplatform"
+    val publicationsFromMainHost = listOf(jvm(), js(), androidTarget()).map { it.name } + "kotlinMultiplatform"
 
     publishing {
         publications {

diff --git a/app/src/androidMain/kotlin/it/vercruysse/lemmyapi/DatatypeRoot.kt b/app/src/androidMain/kotlin/it/vercruysse/lemmyapi/DatatypeRoot.kt
@@ -0,0 +1,5 @@
+package it.vercruysse.lemmyapi
+
+actual interface DatatypeRoot :
+    android.os.Parcelable,
+    java.io.Serializable
diff --git a/app/src/androidMain/kotlin/it/vercruysse/lemmyapi/LemmyApi.kt b/app/src/androidMain/kotlin/it/vercruysse/lemmyapi/LemmyApi.kt
@@ -0,0 +1,9 @@
+package it.vercruysse.lemmyapi
+
+import io.ktor.client.HttpClientConfig
+import io.ktor.client.engine.okhttp.OkHttpConfig
+
+fun LemmyApi.setDefaultClientConfig(block: HttpClientConfig<OkHttpConfig>.() -> Unit) {
+    @Suppress("UNCHECKED_CAST")
+    defaultClient = defaultClient.config(block as HttpClientConfig<*>.() -> Unit)
+}
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/CommonParcelize.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/CommonParcelize.kt
@@ -0,0 +1,3 @@
+package it.vercruysse.lemmyapi
+
+annotation class CommonParcelize
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/DatatypeRoot.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/DatatypeRoot.kt
@@ -1,4 +1,4 @@
 package it.vercruysse.lemmyapi
 
-// The sole purpose is to be defined by another platform
+// Enables platform-specific implementation of all the datatypes
 expect interface DatatypeRoot
diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddAdmin.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddAdmin.kt
@@ -2,7 +2,9 @@ package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
+import it.vercruysse.lemmyapi.CommonParcelize
 
+@CommonParcelize
 @Serializable
 data class AddAdmin(
     val person_id: PersonId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddAdminResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddAdminResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AddAdminResponse(
     val admins: List<PersonView>,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddModToCommunity.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddModToCommunity.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AddModToCommunity(
     val community_id: CommunityId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddModToCommunityResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AddModToCommunityResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AddModToCommunityResponse(
     val moderators: List<CommunityModeratorView>,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeComment.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeComment.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgeComment(
     val id: Long,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommentView.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommentView.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgeCommentView(
     val admin_purge_comment: AdminPurgeComment,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunity.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunity.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgeCommunity(
     override val id: Long,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunityView.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunityView.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgeCommunityView(
     val admin_purge_community: AdminPurgeCommunity,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePerson.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePerson.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgePerson(
     override val id: Long,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePersonView.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePersonView.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgePersonView(
     val admin_purge_person: AdminPurgePerson,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePost.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePost.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgePost(
     override val id: Long,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePostView.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePostView.kt
@@ -4,6 +4,9 @@ import it.vercruysse.lemmyapi.DatatypeRoot
 import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class AdminPurgePostView(
     val admin_purge_post: AdminPurgePost,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/ApproveRegistrationApplication.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/ApproveRegistrationApplication.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class ApproveRegistrationApplication(
     val id: Long,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanFromCommunity.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanFromCommunity.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BanFromCommunity(
     val community_id: CommunityId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanFromCommunityResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanFromCommunityResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BanFromCommunityResponse(
     val person_view: PersonView,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanPerson.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanPerson.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BanPerson(
     val person_id: PersonId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanPersonResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BanPersonResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BanPersonResponse(
     val person_view: PersonView,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BannedPersonsResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BannedPersonsResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BannedPersonsResponse(
     val banned: List<PersonView>,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockCommunity.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockCommunity.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockCommunity(
     val community_id: CommunityId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockCommunityResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockCommunityResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockCommunityResponse(
     val community_view: CommunityView,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockInstance.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockInstance.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockInstance(
     val instance_id: InstanceId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockInstanceResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockInstanceResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockInstanceResponse(
     val blocked: Boolean,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockPerson.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockPerson.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockPerson(
     val person_id: PersonId,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockPersonResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/BlockPersonResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class BlockPersonResponse(
     val person_view: PersonView,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/CaptchaResponse.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/CaptchaResponse.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class CaptchaResponse(
     val png: String,

diff --git a/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/ChangePassword.kt b/app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/ChangePassword.kt
@@ -3,6 +3,9 @@ package it.vercruysse.lemmyapi.datatypes
 import it.vercruysse.lemmyapi.DatatypeRoot
 import kotlinx.serialization.Serializable
 
+import it.vercruysse.lemmyapi.CommonParcelize
+
+@CommonParcelize
 @Serializable
 data class ChangePassword(
     val new_password: String,