create Promise based client for JS (#137)

Author: sargunv

build.gradle.kts

@@ -33,6 +33,7 @@ kotlin {
   jvmToolchain(21)
   explicitApiWarning()
   compilerOptions {
+    optIn = listOf("kotlin.js.ExperimentalJsExport")
     allWarningsAsErrors = true
     freeCompilerArgs.addAll("-Xexpect-actual-classes", "-Xconsistent-data-class-copy-visibility")
   }
@@ -42,6 +43,9 @@ kotlin {
   js(IR) {
     browser { testTask { useMocha { timeout = "10min" } } }
     nodejs { testTask { useMocha { timeout = "10min" } } }
+
+    binaries.library()
+    generateTypeScriptDefinitions()
   }
 
   wasmJs {
@@ -84,12 +88,29 @@ kotlin {
       implementation(libs.ktorfit)
     }
 
-    jvmMain.dependencies { implementation(libs.ktor.client.okhttp) }
-    appleMain.dependencies { implementation(libs.ktor.client.darwin) }
-    linuxMain.dependencies { implementation(libs.ktor.client.curl) }
-    mingwMain.dependencies { implementation(libs.ktor.client.winhttp) }
-    jsMain.dependencies { implementation(libs.ktor.client.js) }
-    wasmJsMain.dependencies { implementation(libs.ktor.client.js) }
+    val nonJsMain by creating { dependsOn(commonMain.get()) }
+
+    jvmMain {
+      dependsOn(nonJsMain)
+      dependencies { implementation(libs.ktor.client.okhttp) }
+    }
+    appleMain {
+      dependsOn(nonJsMain)
+      dependencies { implementation(libs.ktor.client.darwin) }
+    }
+    linuxMain {
+      dependsOn(nonJsMain)
+      dependencies { implementation(libs.ktor.client.curl) }
+    }
+    mingwMain {
+      dependsOn(nonJsMain)
+      dependencies { implementation(libs.ktor.client.winhttp) }
+    }
+    jsMain { dependencies { implementation(libs.ktor.client.js) } }
+    wasmJsMain {
+      dependsOn(nonJsMain)
+      dependencies { implementation(libs.ktor.client.js) }
+    }
 
     commonTest.dependencies {
       implementation(kotlin("test"))

src/commonMain/kotlin/co/pokeapi/pokekotlin/PokeApi.kt

@@ -10,10 +10,8 @@ import de.jensklingenberg.ktorfit.http.Query
 import io.ktor.client.*
 import io.ktor.client.engine.*
 import io.ktor.client.plugins.cache.storage.*
-import kotlin.jvm.JvmName
 
-@JvmName("create")
-public fun PokeApi(
+public fun createPokeApi(
   baseUrl: String = "https://pokeapi.co/api/v2/",
   cacheStorage: CacheStorage? = null,
   engine: HttpClientEngine = getDefaultEngine(),
@@ -31,7 +29,7 @@ public fun PokeApi(
 }
 
 public interface PokeApi {
-  public companion object : PokeApi by PokeApi()
+  public companion object : PokeApi by createPokeApi()
 
   // region Resource Lists
 

src/commonMain/kotlin/co/pokeapi/pokekotlin/internal/ApiResourceSerializer.kt

@@ -0,0 +1,15 @@
+package co.pokeapi.pokekotlin.internal
+
+import co.pokeapi.pokekotlin.model.ApiResource
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+
+internal class ApiResourceSerializer :
+  KSerializer<ApiResource> by DelegatingSerializer(
+    serialName = "co.pokeapi.pokekotlin.model.ApiResource",
+    delegate = Delegate.serializer(),
+    fromDelegate = { ApiResource(url = it.url) },
+    toDelegate = { Delegate(url = it.url) },
+  ) {
+  @Serializable internal data class Delegate(val url: String)
+}

src/commonMain/kotlin/co/pokeapi/pokekotlin/internal/JsOnlyExport.kt

@@ -0,0 +1,13 @@
+package co.pokeapi.pokekotlin.internal
+
+import kotlin.annotation.AnnotationTarget.*
+import kotlin.js.ExperimentalJsExport
+
+@ExperimentalJsExport
+@Retention(AnnotationRetention.BINARY)
+@Target(CLASS, PROPERTY, FUNCTION, FILE)
+internal expect annotation class JsOnlyExport()
+
+@Retention(AnnotationRetention.BINARY)
+@Target(CLASS, PROPERTY, FUNCTION, FILE)
+internal annotation class NoOpExport()

src/commonMain/kotlin/co/pokeapi/pokekotlin/internal/NamedApiResourceSerializer.kt

@@ -0,0 +1,15 @@
+package co.pokeapi.pokekotlin.internal
+
+import co.pokeapi.pokekotlin.model.NamedApiResource
+import kotlinx.serialization.KSerializer
+import kotlinx.serialization.Serializable
+
+internal class NamedApiResourceSerializer :
+  KSerializer<NamedApiResource> by DelegatingSerializer(
+    serialName = "co.pokeapi.pokekotlin.model.NamedApiResource",
+    delegate = Delegate.serializer(),
+    fromDelegate = { NamedApiResource(name = it.name, url = it.url) },
+    toDelegate = { Delegate(name = it.name, url = it.url) },
+  ) {
+  @Serializable internal data class Delegate(val name: String, val url: String)
+}

src/commonMain/kotlin/co/pokeapi/pokekotlin/model/berries.kt

@@ -1,8 +1,10 @@
 package co.pokeapi.pokekotlin.model
 
+import co.pokeapi.pokekotlin.internal.JsOnlyExport
 import kotlinx.serialization.Serializable
 
 @Serializable
+@JsOnlyExport
 public data class Berry(
   val id: Int,
   val name: String,
@@ -18,9 +20,12 @@ public data class Berry(
   val naturalGiftType: NamedApiResource,
 )
 
-@Serializable public data class BerryFlavorMap(val potency: Int, val flavor: NamedApiResource)
+@Serializable
+@JsOnlyExport
+public data class BerryFlavorMap(val potency: Int, val flavor: NamedApiResource)
 
 @Serializable
+@JsOnlyExport
 public data class BerryFirmness(
   val id: Int,
   val name: String,
@@ -29,6 +34,7 @@ public data class BerryFirmness(
 )
 
 @Serializable
+@JsOnlyExport
 public data class BerryFlavor(
   val id: Int,
   val name: String,
@@ -37,4 +43,6 @@ public data class BerryFlavor(
   val names: List<Name>,
 )
 
-@Serializable public data class FlavorBerryMap(val potency: Int, val berry: NamedApiResource)
+@Serializable
+@JsOnlyExport
+public data class FlavorBerryMap(val potency: Int, val berry: NamedApiResource)

src/commonMain/kotlin/co/pokeapi/pokekotlin/model/contests.kt

@@ -1,8 +1,10 @@
 package co.pokeapi.pokekotlin.model
 
+import co.pokeapi.pokekotlin.internal.JsOnlyExport
 import kotlinx.serialization.Serializable
 
 @Serializable
+@JsOnlyExport
 public data class ContestType(
   val id: Int,
   val name: String,
@@ -11,9 +13,11 @@ public data class ContestType(
 )
 
 @Serializable
+@JsOnlyExport
 public data class ContestName(val name: String, val color: String, val language: NamedApiResource)
 
 @Serializable
+@JsOnlyExport
 public data class ContestEffect(
   val id: Int,
   val appeal: Int,
@@ -23,6 +27,7 @@ public data class ContestEffect(
 )
 
 @Serializable
+@JsOnlyExport
 public data class SuperContestEffect(
   val id: Int,
   val appeal: Int,

src/commonMain/kotlin/co/pokeapi/pokekotlin/model/encounters.kt

@@ -1,8 +1,10 @@
 package co.pokeapi.pokekotlin.model
 
+import co.pokeapi.pokekotlin.internal.JsOnlyExport
 import kotlinx.serialization.Serializable
 
 @Serializable
+@JsOnlyExport
 public data class EncounterMethod(
   val id: Int,
   val name: String,
@@ -11,6 +13,7 @@ public data class EncounterMethod(
 )
 
 @Serializable
+@JsOnlyExport
 public data class EncounterCondition(
   val id: Int,
   val name: String,
@@ -19,6 +22,7 @@ public data class EncounterCondition(
 )
 
 @Serializable
+@JsOnlyExport
 public data class EncounterConditionValue(
   val id: Int,
   val name: String,

src/commonMain/kotlin/co/pokeapi/pokekotlin/model/evolution.kt

@@ -1,15 +1,18 @@
 package co.pokeapi.pokekotlin.model
 
+import co.pokeapi.pokekotlin.internal.JsOnlyExport
 import kotlinx.serialization.Serializable
 
 @Serializable
+@JsOnlyExport
 public data class EvolutionChain(
   val id: Int,
   val babyTriggerItem: NamedApiResource?,
   val chain: ChainLink,
 )
 
 @Serializable
+@JsOnlyExport
 public data class ChainLink(
   val isBaby: Boolean,
   val species: NamedApiResource,
@@ -18,6 +21,7 @@ public data class ChainLink(
 )
 
 @Serializable
+@JsOnlyExport
 public data class EvolutionDetail(
   val trigger: NamedApiResource,
   val item: NamedApiResource? = null,
@@ -40,6 +44,7 @@ public data class EvolutionDetail(
 )
 
 @Serializable
+@JsOnlyExport
 public data class EvolutionTrigger(
   val id: Int,
   val name: String,

src/commonMain/kotlin/co/pokeapi/pokekotlin/model/games.kt

@@ -1,8 +1,10 @@
 package co.pokeapi.pokekotlin.model
 
+import co.pokeapi.pokekotlin.internal.JsOnlyExport
 import kotlinx.serialization.Serializable
 
 @Serializable
+@JsOnlyExport
 public data class Generation(
   val id: Int,
   val name: String,
@@ -16,6 +18,7 @@ public data class Generation(
 )
 
 @Serializable
+@JsOnlyExport
 public data class Pokedex(
   val id: Int,
   val name: String,
@@ -28,9 +31,11 @@ public data class Pokedex(
 )
 
 @Serializable
+@JsOnlyExport
 public data class PokemonEntry(val entryNumber: Int, val pokemonSpecies: NamedApiResource)
 
 @Serializable
+@JsOnlyExport
 public data class Version(
   val id: Int,
   val name: String,
@@ -39,6 +44,7 @@ public data class Version(
 )
 
 @Serializable
+@JsOnlyExport
 public data class VersionGroup(
   val id: Int,
   val name: String,