Add Identity interface (#62)

Author: MV-GH

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/Identity.kt

@@ -0,0 +1,10 @@
+package it.vercruysse.lemmyapi
+
+/**
+ * This declares a property to compare the identity of two objects of the same type
+ *
+ * This is useful to create to define uniqueness when the other fields can be different
+ */
+interface Identity {
+    val id: Long
+}

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunity.kt

@@ -1,12 +1,13 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgeCommunity(
-    val id: Long,
+    override val id: Long,
     val admin_person_id: PersonId,
     val reason: String? = null,
     val when_: String,
-) : DatatypeRoot
+) : DatatypeRoot, Identity

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgeCommunityView.kt

@@ -1,10 +1,14 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgeCommunityView(
     val admin_purge_community: AdminPurgeCommunity,
     val admin: Person? = null,
-) : DatatypeRoot
+) : DatatypeRoot, Identity {
+    override val id: Long
+        get() = admin_purge_community.id
+}

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePerson.kt

@@ -1,12 +1,13 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgePerson(
-    val id: Long,
+    override val id: Long,
     val admin_person_id: PersonId,
     val reason: String? = null,
     val when_: String,
-) : DatatypeRoot
+) : DatatypeRoot, Identity

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePersonView.kt

@@ -1,10 +1,14 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgePersonView(
     val admin_purge_person: AdminPurgePerson,
     val admin: Person? = null,
-) : DatatypeRoot
+) : DatatypeRoot, Identity {
+    override val id: Long
+        get() = admin_purge_person.id
+}

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePost.kt

@@ -1,13 +1,14 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgePost(
-    val id: Long,
+    override val id: Long,
     val admin_person_id: PersonId,
     val community_id: CommunityId,
     val reason: String? = null,
     val when_: String,
-) : DatatypeRoot
+) : DatatypeRoot, Identity

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/AdminPurgePostView.kt

@@ -1,11 +1,15 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class AdminPurgePostView(
     val admin_purge_post: AdminPurgePost,
     val admin: Person? = null,
     val community: Community,
-) : DatatypeRoot
+) : DatatypeRoot, Identity {
+    override val id: Long
+        get() = admin_purge_post.id
+}

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/Comment.kt

@@ -1,11 +1,12 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class Comment(
-    val id: CommentId,
+    override val id: CommentId,
     val creator_id: PersonId,
     val post_id: PostId,
     val content: String,
@@ -18,4 +19,4 @@ data class Comment(
     val path: String,
     val distinguished: Boolean,
     val language_id: LanguageId,
-) : DatatypeRoot
+) : DatatypeRoot, Identity

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/CommentReply.kt

@@ -1,13 +1,14 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import kotlinx.serialization.Serializable
 
 @Serializable
 data class CommentReply(
-    val id: CommentReplyId,
+    override val id: CommentReplyId,
     val recipient_id: PersonId,
     val comment_id: CommentId,
     val read: Boolean,
     val published: String,
-) : DatatypeRoot
+) : DatatypeRoot, Identity

app/src/commonMain/kotlin/it/vercruysse/lemmyapi/datatypes/CommentReplyView.kt

@@ -1,6 +1,7 @@
 package it.vercruysse.lemmyapi.datatypes
 
 import it.vercruysse.lemmyapi.DatatypeRoot
+import it.vercruysse.lemmyapi.Identity
 import it.vercruysse.lemmyapi.dto.SubscribedType
 import kotlinx.serialization.Serializable
 
@@ -21,4 +22,7 @@ data class CommentReplyView(
     val saved: Boolean,
     val creator_blocked: Boolean,
     val my_vote: Int = 0,
-) : DatatypeRoot
+) : DatatypeRoot, Identity {
+    override val id: Long
+        get() = comment_reply.id
+}