appwrite-kmp
0.1.1indexedType-safe client for Appwrite offering coroutine-based APIs: errors-as-values, typed IDs, query DSL, Flow realtime with auto-reconnect, chunked upload progress, modular services.
5
Stars
—
Used by
dependents
—
Health
/ 100
Appwrite KMP SDK
A Kotlin Multiplatform SDK for Appwrite — built from scratch with type safety, coroutines, and multiplatform support at its core.
Targets: Android, iOS, JVM
Why another SDK?
The official Appwrite Android SDK is tightly coupled to Android (OkHttp, Gson, SharedPreferences). This SDK is designed for Kotlin Multiplatform from day one:
Installation
dependencies {
implementation("io.github.androidpoet:appwrite-client:<version>")
implementation("io.github.androidpoet:appwrite-auth:<version>")
implementation("io.github.androidpoet:appwrite-database:<version>")
implementation("io.github.androidpoet:appwrite-storage:<version>")
implementation("io.github.androidpoet:appwrite-realtime:<version>")
implementation("io.github.androidpoet:appwrite-teams:<version>")
implementation("io.github.androidpoet:appwrite-functions:<version>")
implementation("io.github.androidpoet:appwrite-locale:<version>")
implementation("io.github.androidpoet:appwrite-avatars:<version>")
}
Quick Start
Initialize
val appwrite = Appwrite("your-project-id") {
endpoint = "https://cloud.appwrite.io/v1"
}
appwrite.sessionStore = SessionStore()
Authentication
import io.appwrite.auth.auth
val user = appwrite.auth.signUp(
email = "user@example.com",
password = "password123",
name = "Jane Doe",
)
when (val result = appwrite.auth.signInWithEmail("user@example.com", "password123")) {
is AppwriteResult.Success -> println()
AppwriteResult.Failure -> println()
}
appwrite.auth.mfa.enable()
appwrite.auth.mfa.createAuthenticator(AuthenticationFactor.Totp)
appwrite.auth.mfa.verifyAuthenticator(AuthenticationFactor.Totp, otp = )
appwrite.auth.signOut()
Databases
import io.appwrite.database.databases
db = appwrite.databases
users = db[DatabaseId()][CollectionId()]
users.create(
= mapOf( to , to , to ),
)
result = users.list {
( greaterThan )
( equal )
orderBy()
limit()
}
users.update(
documentId = DocumentId(),
= mapOf( to ),
)
Storage
Realtime
import io.appwrite.realtime.realtime
appwrite.realtime
.documents(DatabaseId("main"), CollectionId("messages"))
.onEach { event -> updateUI(event.payload) }
.launchIn(viewModelScope) // auto-cleanup on scope cancellation
appwrite.realtime.account()
.collect { event -> handleAccountEvent(event) }
Teams
import io.appwrite.teams.teams
appwrite.teams.create(TeamId.unique(), name = "Engineering")
appwrite.teams.createMembership(
teamId = TeamId("eng-team"),
roles = listOf("developer"),
email = "dev@example.com",
)
Functions
import io.appwrite.functions.functions
val execution = appwrite.functions.createExecution(
functionId = FunctionId("send-welcome-email"),
body = """{"userId": "abc123"}""",
)
Architecture
┌─────────────────────────────────────┐
│ Public API (what devs touch) │ DSL builders, typed IDs, Flows
├─────────────────────────────────────┤
│ Domain (business logic) │ Session management, query builder,
│ │ chunked upload orchestration
├─────────────────────────────────────┤
│ Protocol (Appwrite specifics) │ Header injection, error mapping,
│ │ response deserialization
├─────────────────────────────────────┤
│ Transport (HTTP/WS engine) │ Ktor client, expect/actual
└─────────────────────────────────────┘
Modules
Key Design Decisions
Errors as values, not exceptions
sealed interface AppwriteResult<out T> {
data class Success<T>(val data: T) : AppwriteResult<T>
data class Failure(val error: AppwriteError) : AppwriteResult<Nothing>
}
Value class IDs prevent string mix-ups
fun getDocument(databaseId: DatabaseId, collectionId: CollectionId, documentId: DocumentId)
Session persistence is opt-in and platform-aware
appwrite.sessionStore = SessionStore()
Tech Stack
| Concern | Library |
|---|
Compatibility
- Appwrite Server: 1.8.x+
- Kotlin: 2.1+
- Platforms: Android, iOS (arm64, x64, simulator), JVM
Contributing
- Fork the repo
- Create a feature branch (
git checkout -b feature/amazing-thing) - Make your changes
- Run tests:
./gradlew jvmTest - Open a PR
Find this repository useful? :heart:
Support it by joining stargazers for this repository. :star:
Also, follow me on GitHub for my next creations! 🤩