Changes

Postgrest

• Fix custom headers being ignored by Postgrest#rpc

Note

The documentation has also been updated. Checkout the third-party auth overview page if you want to use Firebase Auth, AWS Cognito or Auth0 instead of Supabase Auth.

Changes

Core

• Update Kotlin to 2.0.10

Postgrest

• Expose headers and params in PostgrestRequestBuilder by @jan-tennert in #689
  You can now set custom headers & url parameters while making a postgrest request

Auth

• Add support for third-party auth by @jan-tennert in #688
  You can now use third-party auth providers like Firebase Auth instead of Supabase Auth by specifying a AccessTokenProvider in the SupabaseClientBuilder:

  val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
      accessToken = {
            //fetch the third party token
           "my-token"
      }
  }
  

  This will be used for the Authorization header and other modules like Realtime and Storage integrations!
  Note: The Auth plugin cannot be used in combination and will throw an exception if used when setting accessToken.
• Changes to Multi-Factor-Authentication by @jan-tennert in #681
  • Refactor the syntax for enrolling MFA factors and add support for the Phone factor type:

    //Enrolling a phone factor
    val factor = client.auth.mfa.enroll(FactorType.Phone, friendlyName) {
        phone = "+123456789"
    }
    
    //Enrolling a TOTP factor
    val factor = client.auth.mfa.enroll(FactorType.TOTP, friendlyName) {
        issuer = "Issuer"
    }
    

  • Add a channel parameter to MfaApi#createChallenge to allow sending phone MFA messages to either SMS or WHATSAPP.
  • Deprecate MfaApi#loggedInUsingMfa and MfaApi#isMfaEnabled & their flow variants in favor of MfaApi#status and MfaApi#statusFlow:

    val (enabled, active) = client.auth.mfa.status
    
    //Flow variant
    client.auth.mfa.statusFlow.collect { (enabled, active) ->
        processChange(enabled, active)
    }
    

• Add SlackOIDC OAuthProvider by @jan-tennert in #688

Realtime

• Remove client-side rate-limiting in #678 by @jan-tennert
• Fix broadcasting to a private channel via the HTTP API in #673 by @jan-tennert
• Fix callbacks not getting removed correctly in the CallbackManager in #673 by @jan-tennert
• Change internal realtime implementation to be more robust and testable in #673 by @jan-tennert
  • Add Realtime.Config#websocketFactory: This is highly internal and should be only modified if you know what you are doing

Storage

• The StorageApi#authenticatedRequest method is now suspending
• All uploading methods will now return a FileUploadResponse instead of a String, which includes the actual path and some other properties.

Changes

Core

• Update Kotlin to 2.0.10

Postgrest

• Expose headers and params in PostgrestRequestBuilder by @jan-tennert in #689
  You can now set custom headers & url parameters while making a postgrest request

Auth

• Add support for third-party auth by @jan-tennert in #688
  You can now use third-party auth providers like Firebase Auth instead of Supabase Auth by specifying a AccessTokenProvider in the SupabaseClientBuilder:

  val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
      accessToken = {
            //fetch the third party token
           "my-token"
      }
  }
  

  This will be used for the Authorization header and other modules like Realtime and Storage integrations!
  Note: The Auth plugin cannot be used in combination and will throw an exception if used when setting accessToken.
• Changes to Multi-Factor-Authentication by @jan-tennert in #681
  • Refactor the syntax for enrolling MFA factors and add support for the Phone factor type:

    //Enrolling a phone factor
    val factor = client.auth.mfa.enroll(FactorType.Phone, friendlyName) {
        phone = "+123456789"
    }
    
    //Enrolling a TOTP factor
    val factor = client.auth.mfa.enroll(FactorType.TOTP, friendlyName) {
        issuer = "Issuer"
    }
    

  • Add a channel parameter to MfaApi#createChallenge to allow sending phone MFA messages to either SMS or WHATSAPP.
  • Deprecate MfaApi#loggedInUsingMfa and MfaApi#isMfaEnabled & their flow variants in favor of MfaApi#status and MfaApi#statusFlow:

    val (enabled, active) = client.auth.mfa.status
    
    //Flow variant
    client.auth.mfa.statusFlow.collect { (enabled, active) ->
        processChange(enabled, active)
    }
    

• Add SlackOIDC OAuthProvider by @jan-tennert in #688

Storage

• The StorageApi#authenticatedRequest method is now suspending
• All uploading methods will now return a FileUploadResponse instead of a String, which includes the actual path and some other properties.

Changes

Realtime

• Remove client-side rate-limiting in #678 by @jan-tennert
• Fix broadcasting to a private channel via the HTTP API in #673 by @jan-tennert
• Fix callbacks not getting removed correctly in the CallbackManager in #673 by @jan-tennert
• Change internal realtime implementation to be more robust and testable in #673 by @jan-tennert
  • Add Realtime.Config#websocketFactory: This is highly internal and should be only modified if you know what you are doing.

Changes

Realtime

• Fix deletion in postgresListDataFlow not working correctly by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/671

Note

The Ktor EAP repository is no longer required as a new official beta of Ktor 3.0.0 has been released. You will also need to use this exact Ktor version for your engines.

Changes

• Migrate to Ktor 3.0.0-beta-2
• Merge 2.4.2-2.5.3 changes into wasm

Changes

Auth

• Add support for verifying a token hash by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/657

Miscellaneous

• Add link to a RESTful service sample built with supabase-kt by @hieuwu in https://github.com/supabase-community/supabase-kt/pull/664

Changes

(maven central release pending)

Realtime

• fix(realtime): add private to Realtime by @grdsdev in https://github.com/supabase-community/supabase-kt/pull/642
  Add support for specifying if a channel is private via RealtimeChannelBuilder#isPrivate

Compose Auth

• Fix Google sign in prompt in composeAuth by @Aaron246 in https://github.com/supabase-community/supabase-kt/pull/648
• fix(auth): fix sign in with Apple in ComposeAuth by @grdsdev in https://github.com/supabase-community/supabase-kt/pull/654

New Contributors

• @grdsdev made their first contribution in https://github.com/supabase-community/supabase-kt/pull/642
• @Aaron246 made their first contribution in https://github.com/supabase-community/supabase-kt/pull/648

Note

Thanks to @manriif you can now write & deploy Supabase Edge Functions completely in Kotlin via Kotlin/JS! Check out the supabase-edge-functions-kt repository for more information!

Changes

Auth

• Ignore certain status codes when signing out a user by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/633
  Failure of signing out because of invalid/expired JWTs will now be ignored and the local session cleared.

Changes

Auth

• Add error code enum for Auth API errors by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/618
  All rest errors containing a error_code field will now throw a AuthRestException rather than generic BadRequestExceptions, etc.
  AuthRestExceptions contain a errorCode field of the type AuthErrorCode containing all known error codes.
  Two error codes have their own exceptions (but obviously inherit from AuthRestException): AuthWeakPasswordException and AuthSessionMissingException.
  API errors not containing this field will throw the generic exceptions.

• Handle weak_password and session_not_found auth error codes by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/596
  There is now a new subclass of RestException: AuthRestExcepton which will be a super class for exceptions based on error codes. Currently, there are two new exceptions: AuthWeakPasswordException and AuthSessionMissingException

• Fix/improve session expiry calculation by @JOsacky in #610

Postgrest

• Add columns header to PostgrestQueryBuilder#insert by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/611
  This fixes an issue when inserting a list of objects where some objects might not have all keys.
• Add defaultToNull parameter to PostgrestQueryBuilder#insert

Realtime

• Use Postgrests propertyConversionMethod for getting the property name of primary keys
• Add the possibility to have a multi-column PK in realtime by @iruizmar in https://github.com/supabase-community/supabase-kt/pull/614
• Fix presences updates for RealtimeChannel#presenceDataFlow working incorrectly by @JOsacky in https://github.com/supabase-community/supabase-kt/pull/607

Compose Auth Ui

• Add isError parameter to Compose Auth Ui fields by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/612
• Add AuthUiExperimental annotation by @iruizmar in https://github.com/supabase-community/supabase-kt/pull/603
  All composables now have a AuthUiExperimental annotation instead of SupabaseExperimental

Misc

• Update README.md by @rafalgawlik in https://github.com/supabase-community/supabase-kt/pull/605

New Contributors

• @rafalgawlik made their first contribution in https://github.com/supabase-community/supabase-kt/pull/605

Changes

Auth

• Add error code enum for Auth API errors by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/618
  All rest errors containing a error_code field will now throw a AuthRestException rather than generic BadRequestExceptions, etc.
  AuthRestExceptions contain a errorCode field of the type AuthErrorCode containing all known error codes.
  Two error codes have their own exceptions (but obviously inherit from AuthRestException): AuthWeakPasswordException and AuthSessionMissingException.
  API errors not containing this field will throw the generic exceptions.
• Fix a major bug causing sessions to be refreshed later than they should be in https://github.com/supabase-community/supabase-kt/commit/9b73c03686f582d9069777b97caccfd006cc7c2f by @jan-tennert
  The expiresAt property was saved incorrectly, delaying the expiry date.

Realtime

• Use Postgrests propertyConversionMethod for getting the property name of primary keys

Changes

Auth

• Fix a major bug causing sessions to be refreshed later than they should be in https://github.com/supabase-community/supabase-kt/commit/af9143d6f32c9c97c38870e8bdd20863edcbc38e by @jan-tennert
  The expiresAt property was saved incorrectly, delaying the expiry date.

Changes

Postgrest

• Add columns header to PostgrestQueryBuilder#insert by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/611
  This fixes an issue when inserting a list of objects where some objects might not have all keys.
• Add defaultToNull parameter to PostgrestQueryBuilder#insert

Compose Auth Ui

• Add isError parameter to Compose Auth Ui fields by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/612

Realtime

• Add the possibility to have a multi-column PK in realtime by @iruizmar in https://github.com/supabase-community/supabase-kt/pull/614

Changes

Compose Auth Ui

• Add AuthUiExperimental annotation by @iruizmar in https://github.com/supabase-community/supabase-kt/pull/603
  All composables now have a AuthUiExperimental annotation instead of SupabaseExperimental

Auth

• Handle weak_password and session_not_found auth error codes by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/596
  There is now a new subclass of RestException: AuthRestExcepton which will be a super class for exceptions based on error codes. Currently, there are two new exceptions: AuthWeakPasswordException and AuthSessionMissingException
  More changes will follow.
• Fix/improve session expiry calculation by @JOsacky in #610

Realtime

• Fix presences updates for RealtimeChannel#presenceDataFlow working incorrectly by @JOsacky in https://github.com/supabase-community/supabase-kt/pull/607

Misc

• Update README.md by @rafalgawlik in https://github.com/supabase-community/supabase-kt/pull/605

New Contributors

• @rafalgawlik made their first contribution in https://github.com/supabase-community/supabase-kt/pull/605

Changes

Auth

• Remove OtpType deprecation notice and clarify documentation by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/595
  The SIGNUP and MAGIC_LINK OtpTypes are no longer deprecated as they are used for resending OTPs.
• Store session before emitting Authenticated state by @iruizmar in https://github.com/supabase-community/supabase-kt/pull/600
  This fixes a bug where it's possible to cancel any sign-in method and the sessionStatus gets set to Authenticated without the session actually saving to storage due to the cancellation.

Changes

• Merge 2.3.1-2.4.1 changes into wasm

Changes

Compose Auth UI

• Fix "Login in with" typo by @JOsacky in https://github.com/supabase-community/supabase-kt/pull/588

Postgrest

• Include columns in upsert request & change default parameter value for defaultToNull to true by @jan-tennert in https://github.com/supabase-community/supabase-kt/pull/590
  This fixes an issue when upserting a list of objects where some objects might not have all keys.

New Contributors

• @JOsacky made their first contribution in https://github.com/supabase-community/supabase-kt/pull/588

Changes

Core

• Update Kotlin to 2.0.0-RC2 and Compose to 1.6.10-rc01 by @jan-tennert in #581
• Rethrow CancellationExceptions in network requests by @jan-tennert in #578
• Log the actual error if a network request fails by @jan-tennert in https://github.com/supabase-community/supabase-kt/commit/0c93053e9ddb192f7238d719617d96eb71702bfd

Auth

• Auth changes & fixes by @jan-tennert in #568
  • The method Auth#linkIdentity will now return the OAuth URL if the config value ExternalAuthConfigDefaults.automaticallyOpenUrl is set to false.
    Otherwise, null.
  • Fix the autoRefresh default value for Auth#importSession not being set to config.alwaysAutoRefresh
  • Add codeVerifier parameter to MemoryCodeVerifierCache to be able to set an initial value
  • Add missing captchaToken config option in the OTP auth provider
• Change the default session key for the SettingsSessionManager to work with multiple instances on the same device and add a key parameter to the constructor in case you want a custom key by @MohamedRejeb in #572

Realtime

• Add new experimental extension functions to retrieve initial data and listen for updates without using realtime channels by @jan-tennert #579:

//Not a suspending function, subscribing and unsubscribing is handled internally
val myProductFlow: Flow<Product> = supabase.from("products").selectSingleValueAsFlow(Product::id) {
    Product::id eq 2
}.collect {
    println(it)
}

val productsFlow: Flow<List<Product>> = supabase.from("products").selectAsFlow(Product::id, filter = FilterOperation("id", FilterOperator.GT, 2)).collect {
    println(it)
}

This requires both Realtime and Postgrest to be installed within the SupabaseClient.

Storage

• Prohibit uploading empty data to a bucket by @hieuwu in #577

Functions

• Add new region parameter to invoke functions which allows changing the region where the Edge Function will be invoked in. Defaults to Functions.Config#defaultRegion (which is FunctionRegion.ANY) by @jan-tennert in #580

Note

Documentation will update shortly, after that I'll release the version.

Changes

Core

• Rework & clean up build files by @jan-tennert in #586

Changes

Core

• Update Kotlin to 2.0.0-RC2 and Compose to 1.6.10-rc01 by @jan-tennert in #581
• Rethrow CancellationExceptions in network requests by @jan-tennert in #578
• Log the actual error if a network request fails by @jan-tennert in https://github.com/supabase-community/supabase-kt/commit/0c93053e9ddb192f7238d719617d96eb71702bfd

Auth

• Auth changes & fixes by @jan-tennert in #568
  • The method Auth#linkIdentity will now return the OAuth URL if the config value ExternalAuthConfigDefaults.automaticallyOpenUrl is set to false.
    Otherwise, null.
  • Fix the autoRefresh default value for Auth#importSession not being set to config.alwaysAutoRefresh
  • Add codeVerifier parameter to MemoryCodeVerifierCache to be able to set an initial value
  • Add missing captchaToken config option in the OTP auth provider
• Change the default session key for the SettingsSessionManager to work with multiple instances on the same device and add a key parameter to the constructor in case you want a custom key by @MohamedRejeb in #572

Realtime

• Add new experimental extension functions to retrieve initial data and listen for updates without using realtime channels by @jan-tennert #579:

//Not a suspending function, subscribing and unsubscribing is handled internally
val myProductFlow: Flow<Product> = supabase.from("products").selectSingleValueAsFlow(Product::id) {
    Product::id eq 2
}.collect {
    println(it)
}

val productsFlow: Flow<List<Product>> = supabase.from("products").selectAsFlow(Product::id, filter = FilterOperation("id", FilterOperator.GT, 2)).collect {
    println(it)
}

This requires both Realtime and Postgrest to be installed within the SupabaseClient.

Storage

• Prohibit uploading empty data to a bucket by @hieuwu in #577

Functions

• Add new region parameter to invoke functions which allows changing the region where the Edge Function will be invoked in. Defaults to Functions.Config#defaultRegion (which is FunctionRegion.ANY) by @jan-tennert in #580