supabase-kt

The Storage client is multiplatform and supports the following targets:

Note: Linux does not support persistent resumable upload URL caching.

The auth-kt module is multiplatform. Support status varies by target:

Note: Targets marked with ☑️ have no built-in OAuth support.

Supabase-kt is a multiplatform library supporting the following targets:

The authentication module is multiplatform. Support status varies by target:

Note: For Apple, Windows, and Linux targets, built-in OAuth support is not available.

The Desktop implementation uses Conveyor for protocol registration and unique4j to manage single-instance behavior.

When a user completes a login (e.g., via Google), they are redirected to the registered URL protocol. If the application is already running, unique4j allows the new instance (triggered by the redirect) to communicate the authentication data to the existing instance before closing itself. This ensures the user is logged in within the primary application window.

Plugins can be installed using the createSupabaseClient function to extend functionality. Key plugins include:

• Apollo GraphQL integration: Creates an Apollo GraphQL Client for interacting with the Supabase API.
• Compose Auth: Provides native Google & Apple Auth for Compose Multiplatform.
• Compose Auth UI: Provides UI components for Compose Multiplatform.
• Coil3 Integration: Provides integration for displaying images stored in Supabase Storage across all Compose Multiplatform targets.

After adding the dependency, you must install the Postgrest plugin within your createSupabaseClient configuration block to enable Postgrest functionality.

val supabase = createSupabaseClient(
    supabaseUrl = "https://id.supabase.co",
    supabaseKey = "apikey"
) {
    install(Postgrest) {
        // settings
    }
}

If you are using multiple Supabase modules, it is recommended to use the Bill of Materials (BOM) to ensure all modules use compatible versions.

implementation(platform("io.github.jan-tennert.supabase:bom:VERSION"))
implementation("io.github.jan-tennert.supabase:[module]")

To use Moshi as the JSON serialization engine in your supabase-kt project, add the serializer-moshi module to your dependencies. Replace VERSION with the version of the supabase-kt library you are currently using.

dependencies {
    implementation("io.github.jan-tennert.supabase:serializer-moshi:VERSION")
}

After adding the dependency, you must install the Storage plugin when creating your SupabaseClient instance using the install(Storage) block.

val supabase = createSupabaseClient(
    supabaseUrl = "https://id.supabase.co",
    supabaseKey = "apikey"
) {
    //... 

    install(Storage) {
        // settings
    }
}

To use Realtime features, add the realtime-kt dependency to your project. Ensure you replace VERSION with the latest available version.

Supported targets include JVM, Android, JS (Browser/NodeJS), Wasm, Apple (iOS, tvOS, watchOS, MacOS), Windows, and Linux.

dependencies {
    implementation("io.github.jan-tennert.supabase:realtime-kt:VERSION")
}