pocketbase-kotlin

1.0.0indexed

A versatile SDK offers seamless integration with Pocketbase, enabling full type safety, coroutine support, real-time subscriptions, DSL for queries, and comprehensive API access for CRUD operations and authentication.

AndroidNative·abd3lraouf/pocketbase-kotlin

Stars

—

Used by

dependents

—

Health

/ 100

Pocketbase Kotlin

A multiplatform Kotlin SDK for Pocketbase designed to work seamlessly across multiple platforms with full type safety and coroutine support.

Features

Supported Platforms

Platform	Support
Android	✅
iOS (ARM64)	✅
iOS (x64)

Installation

Add the dependency to your build.gradle.kts:

dependencies {
    implementation("dev.abd3lraouf:pocketbase-kotlin:1.0.0")
}

Note: This library requires the Kotlinx Serialization plugin.

Quick Start

1. Create a Client

import dev.abd3lraouf.libs.pocketbase.kotlin.PocketbaseClient
import io.ktor.http.*

val client = PocketbaseClient(
    baseUrl = {
        protocol = URLProtocol.HTTP
        host = "localhost"
        port = 8090
    }
)

2. Authentication

import dev.abd3lraouf.libs.pocketbase.kotlin.dsl.login
import dev.abd3lraouf.libs.pocketbase.kotlin.models.AuthRecord

// Authenticate with email and password
val authResponse = client.records.authWithPassword<AuthRecord>(
    collection = "users",
    email = "user@example.com",
    password = "password123"
)

// Login with the received token
client.login {
    token = authResponse.token
}

3. Working with Records

4. Query DSL

import dev.abd3lraouf.libs.pocketbase.kotlin.dsl.query.*

// Advanced querying with DSL
val results = client.records.getList<Task>(
    collection = "tasks",
    page = 1,
    perPage = 10,
    filter = Filter("title ~ 'Learn' && completed = false"),
    sort = Sort("-created", "title"),
    expand = Expand("user", "category"),
    fields = ShowFields("id", "title", "completed", )
)

5. Real-time Subscriptions

// Subscribe to real-time changes
client.realtime.subscribe("tasks") { event ->
    when (event.action) {
        "create" -> println("New task created: ${event.record}")
        "update" -> println("Task updated: ${event.record}")
        "delete" -> println("Task deleted: ${event.record}")
    }
}

6. Batch Operations

import dev.abd3lraouf.libs.pocketbase.kotlin.dsl.BatchRequestBuilder

// Perform multiple operations in a single request
val results = client.batch.send {
    create("tasks", Task("Task 1", false))
    create("tasks", Task("Task 2", true))
    update("tasks", "RECORD_ID", Task("Updated Task", true))
    delete("tasks", "RECORD_ID_TO_DELETE")
}

Advanced Usage

File Uploads

import dev.abd3lraouf.libs.pocketbase.kotlin.FileUpload

@Serializable
data class Post(
    val title: String,
    val content: String,
    val image: String? = 
) : Record()


 post = client.records.create<Post>(
    collection = ,
    body = mapOf(
         to .toJsonPrimitive(),
         to .toJsonPrimitive()
    ),
    files = listOf(
        FileUpload(
            fieldName = ,
             = imageByteArray,
            fileName = 
        )
    )
)

Expanding Relations

@Serializable
data class User(val name: String, val email: String) : Record()


  (
     title: String,
     content: String,
     author: String  
) : ExpandRecord<User>()


 posts = client.records.getList<Post>(
    collection = ,
    expandRelations = ExpandRelations()
)


 authorName = posts.items.first().expand?.()?.name

Authentication Providers

// OAuth2 authentication
val oauthResponse = client.records.authWithOauth2<AuthRecord>(
    collection = "users",
    provider = "google",
    code = "oauth_code",
    codeVerifier = "code_verifier",
    redirectUrl = "https://your-app.com/callback"
)