lichess-kmp-client

0.1.2-alphaindexed

Type-safe access to the Lichess API enabling anonymous or token-based usage, streaming event flows, OAuth with auto-refresh, and typed services covering all endpoints.

AndroidJSJVMNativeWasm·VIPlearner/lichess-kmp-client

Stars

—

Used by

dependents

—

Health

/ 100

Lichess Kotlin Multiplatform Client

Clean, type-safe Kotlin SDK for the Lichess API. Supports Android, iOS, JVM, Linux, and JS.

Installation

dependencies {
    implementation("io.github.viplearner:lichess-kmp-client:0.1.1-alpha")
}

Usage

Anonymous Access

val client = LichessClient.anonymous()
val tvGames = client.tv.getCurrentTvGames()
client.close()

With Authentication

val client = LichessClient.withToken("lip_yourAccessToken")

client.games.listUserGames("username").onSuccess { games ->
    games.collect { game -> println(game.id) }
}

client.close()

Streaming

client.bot.streamEvent().onSuccess { flow ->
    flow.collect { event -> 
        println("Event: $event") 
    }
}

OAuth with Auto-Refresh

val oauthManager = DefaultOAuthManager(
    redirectUri = "https://myapp.com/callback",
    scopes = listOf("board:play", "puzzle:read"),
    onAuthorizationRequired = { authUrl, _ ->
        // Direct user to authUrl, return authorization code
        getCodeFromCallback()
    }
)

val client = LichessClient.withClientIdAndOAuth(oauthManager)