Supabase KT

https://github.com/supabase-community/supabase-kt
Admin
A Kotlin Multiplatform client library for interacting with Supabase, offering modules for...
Tokens:175,779
Snippets:1,254
Trust Score:9.7
License:MIT
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install the plugin

Source: https://github.com/supabase-community/supabase-kt/wiki/Creating-Plugins

Shows how to install the plugin during client creation using the install function and configure it with the config initializer.

```kotlin
val client = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {
    install(MyPlugin) {
        someSetting = true
    }
}
```

--------------------------------

### Install GoTrue Plugin

Source: https://github.com/supabase-community/supabase-kt/wiki/Getting-Started

Example of installing the GoTrue module into the Supabase client.

```kotlin
val client = createSupabaseClient(
    supabaseUrl = "https://PROJECT_ID.supabase.co",
    supabaseKey = "YOUR_KEY"
) {
    install(GoTrue)
}
```

--------------------------------

### Install Realtime plugin in SupabaseClient

Source: https://github.com/supabase-community/supabase-kt/blob/master/Realtime/README.md

Creates a SupabaseClient and installs the Realtime plugin. Replace the supabaseUrl and supabaseKey with your project's credentials.

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

    //...

    install(Realtime) {
        // settings
    }

}
```

--------------------------------

### Install Auth plugin in SupabaseClient

Source: https://github.com/supabase-community/supabase-kt/blob/master/GoTrue/README.md

Create a SupabaseClient and install the Auth plugin. Replace the supabaseUrl and supabaseKey with your project credentials. The Auth plugin can be configured with settings inside the install block.

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

    //...

    install(Auth) {
        // settings
    }

}
```

--------------------------------

### Create Supabase client and install Auth plugin

Source: https://github.com/supabase-community/supabase-kt/blob/master/Supabase/README.md

Create a Supabase client with custom serializer and log level, install the Auth plugin, and access it via the client.

```kotlin
//Create a Supabase client
val supabase = createSupabaseClient(
    supabaseUrl = "https://id.supabase.co",
    supabaseKey = "apikey"
) {
    //Change default settings
    defaultSerializer = MyCustomSerializer()
    defaultLogLevel = LogLevel.DEBUG
    
    //Install a plugin
    install(Auth) //from auth-kt

}

//Access a plugin via the client
val auth = supabase.auth
```

--------------------------------

### Install Storage plugin in SupabaseClient

Source: https://github.com/supabase-community/supabase-kt/blob/master/Storage/README.md

Install the Storage plugin in your SupabaseClient. Configure settings inside the install block.

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

    //...

    install(Storage) {
        // settings
    }

}
```

--------------------------------

### Install Realtime plugin in Supabase client

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Realtime

Installs the Realtime plugin in the main Supabase client using the install function.

```kotlin
val client = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {
    
    //...
    
    install(Realtime) {
        // settings
    }
    
}
```

--------------------------------

### Initialize SupabaseClient with Postgrest

Source: https://github.com/supabase-community/supabase-kt/blob/master/Postgrest/README.md

Install the Postgrest plugin when creating the SupabaseClient instance.

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

    //...

    install(Postgrest) {
        // settings
    }

}
```

--------------------------------

### Install Postgrest plugin in Supabase client

Source: https://github.com/supabase-community/supabase-kt/wiki/Postgrest/Postgrest

Install the Postgrest plugin in the main Supabase client. Configure settings inside the install block.

```kotlin
val client = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {
    
    //...
    
    install(Postgrest) {
        // settings
    }
    
}
```

--------------------------------

### New Postgrest builder methods example

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

An example showing the new builder methods available on Postgrest queries, including single, count, limit, range, select, csv, geojson, explain, and filter.

```kotlin
val result = supabase.postgrest["messages"].select {
     single() //receive an object rather than an array
     count(Count.EXACT) //receive amount of database entries
     limit(10) //limit amount of results
     range(2, 3) //change range of results
     select() //return the data when updating/deleting/upserting (same as settings 'returning' to REPRESENTATION before)
     csv() //Receive the data as csv
     geojson() //Receive the data as geojson
     explain(/* */) //Debug queries
     filter {
          eq("id", 1)
     }
}
```

--------------------------------

### OAuth on Web

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Login

Create a Supabase client with GoTrue installed and login with Discord in a click callback.

```kotlin
val client = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {
    supabaseUrl = ""
    supabaseKey = ""

    install(GoTrue)
}

//somewhere in an onClick callback:
client.gotrue.loginWith(Discord)
```

--------------------------------

### Install Functions plugin in SupabaseClient

Source: https://github.com/supabase-community/supabase-kt/blob/master/Functions/README.md

Install the Functions plugin in your SupabaseClient. Configure settings inside the install block.

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

--------------------------------

### Install ImageLoaderIntegration plugin in SupabaseClient

Source: https://github.com/supabase-community/supabase-kt/blob/master/plugins/ImageLoaderIntegration/README.md

Install the ImageLoaderIntegration plugin in the main SupabaseClient. This is required for the integration to work.

```kotlin
val client = createSupabaseClient(
    supabaseUrl = "https://id.supabase.co",
    supabaseKey = "apikey"
) {
    //...
    install(Storage) {
        //your config
    }
    install(ImageLoaderIntegration)
}
```

--------------------------------

### Install Auth.withNative()

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Installs the native authentication module, enabling platform-specific features like OAuth, passkeys, and lifecycle management. This is required for using native auth methods.

```kotlin
install(Auth.withNative())
```

--------------------------------

### Initial login with provider

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/MFA

Start the login process using a standard provider to reach AAL1.

```kotlin
supabaseClient.gotrue.loginWith(Email) {
    email = "example@email.com"
    password = "12345"
}
```

--------------------------------

### Start or resume upload with startOrResumeUploading

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Resumable uploads

Starts or resumes the upload after it has been created or paused.

```kotlin
upload.startOrResumeUploading()
```

--------------------------------

### Configure Ktor engines for Multiplatform

Source: https://github.com/supabase-community/supabase-kt/blob/master/README.md

Example configuration for setting up different Ktor client engines across jvm, android, js, and ios targets in a multiplatform project.

```kotlin
sourceSets {
    commonMain {
        dependencies {
            //Supabase modules
        }
    }
    jvmMain {
        dependencies {
            implementation("io.ktor:ktor-client-cio:KTOR_VERSION")
        }
    }
    androidMain {
        dependsOn(jvmMain.get())
    }
    jsMain {
        dependencies {
            implementation("io.ktor:ktor-client-js:KTOR_VERSION")
        }
    }
    iosMain {
        dependencies {
            implementation("io.ktor:ktor-client-darwin:KTOR_VERSION")
        }
    }
}
```

--------------------------------

### File download with options DSL

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

Example of using the new options DSL for file downloads in supabase-kt 3.0.0. Configure image transformation.

```kotlin
supabase.storage.from("test").downloadAuthenticated("test.jpg") {
    transform {
        size(100, 100)
    }
}
```

--------------------------------

### Implement SupabasePlugin and SupabasePluginProvider

Source: https://github.com/supabase-community/supabase-kt/wiki/Creating-Plugins

Defines a custom plugin class with a configuration data class and companion object implementing SupabasePluginProvider. The key 'myplugin' identifies the plugin. Override createConfig, setup, and create to configure and instantiate the plugin.

```kotlin
class MyPlugin(private val config: MyPlugin.Config): SupabasePlugin {

    fun doSomethingCool() {
        println("something cool")
    }
    
    data class Config(var someSetting: Boolean = false)

    companion object : SupabasePluginProvider<Config, MyPlugin> {

        override val key = "myplugin" //this key is used to identify the plugin when retrieving it

        override fun createConfig(init: Config.() -> Unit): Config {
            //used to create the configuration object for the plugin
            return Config().apply(init)
        }

        override fun setup(builder: SupabaseClientBuilder, config: Config) {
            //modify the supabase client builder
        }

        override fun create(supabaseClient: SupabaseClient, config: Config): MyPlugin {
            //modify the supabase client and return the final plugin instance
            return MyPlugin(config)
        }

    }

}
```

--------------------------------

### Run desktop and JS Canvas targets

Source: https://github.com/supabase-community/supabase-kt/blob/master/sample/chat-demo-mpp/README.md

Run the desktop and JS Canvas targets from the project root. The desktop command launches a distributable build, while the JS Canvas command starts the development server.

```shell
./gradlew :sample:chat-demo-mpp:desktop:runDistributable (Desktop)
./gradlew :sample:chat-demo-mpp:web:jsBrowserDevelopmentRun (JS Canvas)
```

--------------------------------

### Configure GoTrue Plugin

Source: https://github.com/supabase-community/supabase-kt/wiki/Getting-Started

Configuring a plugin during installation, such as setting a custom URL.

```kotlin
val client = createSupabaseClient(
    supabaseUrl = "https://PROJECT_ID.supabase.co",
    supabaseKey = "YOUR_KEY"
) {
    install(GoTrue) {
        customUrl = "https://my-custom-auth-url.com"
    }
}
```

--------------------------------

### Configure iOS OAuth scheme in Auth install

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Set the app scheme in the Auth configuration for iOS. The scheme entry in PList.info is still required.

```kotlin
install(Auth) {
     appScheme = "myScheme" 
}
```

--------------------------------

### GET /storage/{bucketId}/downloadTo

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a file to a local file.

```APIDOC
## [GET] /storage/{bucketId}/downloadTo

### Description
Downloads a file to a local file.

### Method
GET

### Endpoint
/storage/{bucketId}/downloadTo

### Parameters
#### Path Parameters
- **bucketId** (string) - Required - The ID of the bucket.

#### Query Parameters
- **filePath** (string) - Required - The path/name of the file to download.
- **destination** (File) - Required - The local file to write to.

### Request Example
```kotlin
bucket.downloadTo("landscape.png", File("landscape.png"))
```

### Response
#### Success Response (200)
No response body is documented.

```

--------------------------------

### File upload with options DSL

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

Example of using the new options DSL for file uploads in supabase-kt 3.0.0. Configure contentType, upsert, and additional HTTP request configurations.

```kotlin
supabase.storage.from("test").upload("test.txt", "Hello World!".encodeToByteArray()) {
    contentType = ContentType.Text.Plain
    upsert = true
}
```

--------------------------------

### Initialize GoTrue client with service role secret

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Sets up a Supabase client with GoTrue installed, disabling auto-refresh and auto-loading from storage, then imports the service role secret for admin access. The secret must never be shared or included in the app.

```kotlin
val client = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {
    //[...]

    install(GoTrue) {
        alwaysAutoRefresh = false
        autoLoadFromStorage = false
    }

}

client.gotrue.importAuthToken("service role secret") 
```

--------------------------------

### Postgrest upsert with request DSL

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

Example of moving optional function parameters for PostgrestQueryBuilder#upsert() to the request DSL in supabase-kt 3.0.0.

```kotlin
supabase.from("table").upsert(myValue) {
    defaultToNull = false
    ignoreDuplicates = false
}
```

--------------------------------

### GET /storage/{bucketId}/downloadPublicAsFlow

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a public file as a flow, allowing progress tracking.

```APIDOC
## [GET] /storage/{bucketId}/downloadPublicAsFlow

### Description
Downloads a public file as a flow, allowing progress tracking.

### Method
GET

### Endpoint
/storage/{bucketId}/downloadPublicAsFlow

### Parameters
#### Path Parameters
- **bucketId** (string) - Required - The ID of the bucket.

#### Query Parameters
- **filePath** (string) - Required - The path/name of the file to download.

### Request Example
```kotlin
client.storage["icons"].downloadPublicAsFlow("1654898740006.jpg").collect { status ->
    when(status) {
        is DownloadStatus.Progress -> println("Percent done: ${status.received.toDouble() / status.total.toDouble() * 100}")
        is DownloadStatus.Success -> println("Done: ${status.data.size} bytes")
    }
}
```

### Response
#### Success Response (200)
- **DownloadStatus.Progress** - Contains `received` and `total` bytes.
- **DownloadStatus.Success** - Contains the downloaded data.

```

--------------------------------

### GET /storage/{bucketId}/downloadPublic (with transformation)

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a public file with image transformation options.

```APIDOC
## [GET] /storage/{bucketId}/downloadPublic (with transformation)

### Description
Downloads a public file with image transformation options.

### Method
GET

### Endpoint
/storage/{bucketId}/downloadPublic

### Parameters
#### Path Parameters
- **bucketId** (string) - Required - The ID of the bucket.

#### Query Parameters
- **filePath** (string) - Required - The path/name of the file to download.

#### Request Body
- **quality** (int) - Optional - Image quality percentage.
- **size** (int, int) - Optional - Resize dimensions.
- **fill** (boolean) - Optional - Whether to fill the image.

### Request Example
```kotlin
val bytes = bucket.downloadPublic("landscape.png") {
    quality = 80
    size(700, 400)
    fill()
}
```

### Response
#### Success Response (200)
- **data** (bytes) - The transformed image content.

```

--------------------------------

### Access GoTrue Extension Property

Source: https://github.com/supabase-community/supabase-kt/wiki/Getting-Started

Using the extension property on the SupabaseClient to access plugin methods. An exception is thrown if the plugin is not installed.

```kotlin
client.gotrue.loginWith(Email) {
    email = "example@email.com"
    password = "12345"
}
```

--------------------------------

### New Postgrest update with select() and filter block

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

The new syntax for updating data, using select() to get the data back and a filter block.

```kotlin
supabase.postgrest.from("countries").update(country) {
    select() //Without this the "returning" parameter is `MINIMAL`, meaning you will not receive the data. 
    filter {
        eq("id", 1)
    }
}
```

--------------------------------

### Sign up with email using signUpWith(Email)

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Signup

Creates a new user with an email and password. The user is not automatically logged in; they receive a confirmation email. The result's id is printed.

```kotlin
val result = supabaseClient.gotrue.signUpWith(Email) {
    email = "example@email.com"
    password = "12345"
}
println(result.id)
```

--------------------------------

### Sign up with email and password

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Signs up a new user with email and password. The response contains the session and user information.

```kotlin
val response = supabase.auth.signUp(Email("myEmail@example.com"), password = "12345") {
    // ...
}
println(response.session)
println(response.user)
```

--------------------------------

### Initialize Supabase Client

Source: https://github.com/supabase-community/supabase-kt/wiki/Getting-Started

Basic initialization of the Supabase client using the project URL and key.

```kotlin
val client = createSupabaseClient(
    supabaseUrl = "https://PROJECT_ID.supabase.co",
    supabaseKey = "YOUR_KEY"
)
```

--------------------------------

### Create a bucket with options

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing Buckets

Creates a new bucket named 'images' with public access, a file size limit of 20 megabytes, and allowed MIME types for JPG and PNG images.

```kotlin
client.storage.createBucket(name = "images", id = "images") {
    public = true
    fileSizeLimit = 20.megabytes
    allowedMimeTypes(ContentType.Image.JPG, ContentType.Image.PNG)
}
```

--------------------------------

### GET /storage/{bucketId}/downloadPublic

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a public file from a bucket.

```APIDOC
## [GET] /storage/{bucketId}/downloadPublic

### Description
Downloads a public file from a bucket.

### Method
GET

### Endpoint
/storage/{bucketId}/downloadPublic

### Parameters
#### Path Parameters
- **bucketId** (string) - Required - The ID of the bucket.

#### Query Parameters
- **filePath** (string) - Required - The path/name of the file to download.

### Request Example
```kotlin
val bytes = bucket.downloadPublic("landscape.png")
```

### Response
#### Success Response (200)
- **data** (bytes) - The file content.

```

--------------------------------

### Sign up with phone using signUpWith(Phone)

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Signup

Creates a new user with a phone number and password. The user is not automatically logged in; they receive a confirmation text message. The result's id is printed.

```kotlin
val result = supabaseClient.gotrue.signUpWith(Phone) {
    phoneNumber = "123456"
    password = "12345"
}
println(result.id)
```

--------------------------------

### OAuth on Android - MainActivity

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Login

Set up the Supabase client with GoTrue scheme and host for deeplinks. Call handleDeeplinks(intent) in onCreate and loginWith(Google) in a click callback.

```kotlin
class MainActivity : AppCompatActivity() {

    val supabaseClient = createSupabaseClient(supabaseUrl = "...", supabaseKey = "...") {

        supabaseUrl = "your supabase url"
        supabaseKey = "your supabase key"

        install(GoTrue) {
            scheme = "supacompose"
            host = "login"
        }
    }

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        supabaseClient.handleDeeplinks(intent) //without this no deeplinks will get recognized
        //somewhere in an onClick callback:
        supabaseClient.loginWith(Google) //this should go in a viewmodel
    }

}
```

--------------------------------

### Sign up with provider using signUpWith(Google)

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Signup

Signs up a user using a third-party provider, such as Google. This works like logging in with a provider.

```kotlin
supabaseClient.gotrue.signUpWith(Google)
```

--------------------------------

### Run Desktop App

Source: https://github.com/supabase-community/supabase-kt/blob/master/sample/multi-factor-auth/README.md

Command to run the desktop version of the app from the project root directory.

```bash
./gradlew :sample:multi-factor-auth:desktop:runDistributable
```

--------------------------------

### OAuth on Desktop

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Login

Configure GoTrue with timeout, htmlTitle, and htmlText for desktop OAuth. Add the redirect URL to Supabase settings. Then login with Discord.

```kotlin
suspend fun main() {
    val client = createSupabaseClient(
        supabaseUrl = System.getenv("SUPABASE_URL"),
        supabaseKey = System.getenv("SUPABASE_KEY")
    ) {

        install(GoTrue) {
            //as of 0.8.0
            timeout = 50.seconds
            htmlTitle = "Supabase"
            htmlText = "Logged in. You may continue in the app."
        }
    }
    client.gotrue.loginWith(Discord)
}
```

--------------------------------

### signUp

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Registers a new user with email or phone and password. Returns a response containing session and user.

```APIDOC
## signUp

### Description
Registers a new user with email or phone and password. Returns a response containing session and user.

### Method
signUp

### Parameters
- **identifier** (Email or Phone) - Required - The user's email or phone.
- **password** (String) - Required - The user's password.
- **config** (Builder) - Optional - Additional configuration.

### Request Example
```kotlin
val response = supabase.auth.signUp(Email("myEmail@example.com"), password = "12345") {
    // ...
}
println(response.session)
println(response.user)
```

### Response
Returns a response object with `session` and `user` properties.
```

--------------------------------

### Create new users with email or phone

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Registers a new user via email with optional auto-confirmation, and another via phone. Both use the admin API.

```kotlin
client.gotrue.admin.createUserWithEmail {
    email = "example@foo.bar"
    password = "12345678"
    autoConfirm = true //automatically confirm this email address
}
client.gotrue.admin.createUserWithPhone {
    phoneNumber = "123456789"
    password = "12345678"
}
```

--------------------------------

### Native Google Auth

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Performs native Google sign-in, falling back to OAuth if native is unavailable. Requires installing Auth.withNative() with a Google client ID on Android. The result is a GoogleSignInResult that can be Cancelled, OAuthInitiated, or Success.

```kotlin
// required for Android:
install(Auth.withNative()) {
    nativeAuth {
         googleClientId = "..."
    }
}
val result = supabase.auth.signWithGoogle()
when(result) {
    GoogleSignInResult.Cancelled -> TODO()
    GoogleSignInResult.OAuthInitiated -> TODO()
    is GoogleSignInResult.Success -> TODO()
}
```

--------------------------------

### Run Desktop App

Source: https://github.com/supabase-community/supabase-kt/blob/master/sample/file-upload/README.md

Command to run the desktop application from the root directory of the project.

```bash
./gradlew :sample:file-upload:desktop:runDistributable (Desktop)
```

--------------------------------

### Download files from a bucket

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a public file from the 'images' bucket, downloads to a local File, and demonstrates image transformation during download using quality, size, and fill options.

```kotlin
val bytes = bucket.downloadPublic("landscape.png") //download public for public buckets and download authenticated for private buckets

bucket.downloadTo("landscape.png", File("landscape.png"))

//transform the image when downloading
val bytes = bucket.downloadPublic("landscape.png") {
    quality = 80
    size(700, 400)
    fill()
}
```

--------------------------------

### Install Auth with custom SessionManager

Source: https://github.com/supabase-community/supabase-kt/blob/master/TROUBLESHOOTING.md

Pass a custom SessionManager implementation to the Auth plugin configuration. The interface requires saveSession, loadSession, and deleteSession methods. Note that if you serialize UserSession with kotlinx.serialization, the Json instance needs encodeDefaults = true to avoid missing fields on restore.

```kotlin
install(Auth) {
    sessionManager = MySessionManager()
}
```

--------------------------------

### Create User with Phone

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Registers a new user with a phone number and password.

```APIDOC
## Create User with Phone

### Description
Registers a new user with a phone number and password.

### Method
N/A (Kotlin function call)

### Endpoint
`client.gotrue.admin.createUserWithPhone { ... }`

### Parameters
#### Request Body (Kotlin lambda)
- **phoneNumber** (String) - Required - The phone number of the new user.
- **password** (String) - Required - The password for the new user.

### Request Example
```kotlin
client.gotrue.admin.createUserWithPhone {
    phoneNumber = "123456789"
    password = "12345678"
}
```

### Response
No return value specified.
```

--------------------------------

### Create User with Email

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Registers a new user with an email address and password. Optionally auto-confirms the email.

```APIDOC
## Create User with Email

### Description
Registers a new user with an email address and password. Optionally auto-confirms the email.

### Method
N/A (Kotlin function call)

### Endpoint
`client.gotrue.admin.createUserWithEmail { ... }`

### Parameters
#### Request Body (Kotlin lambda)
- **email** (String) - Required - The email address of the new user.
- **password** (String) - Required - The password for the new user.
- **autoConfirm** (Boolean) - Optional - If true, automatically confirms the email address.

### Request Example
```kotlin
client.gotrue.admin.createUserWithEmail {
    email = "example@foo.bar"
    password = "12345678"
    autoConfirm = true //automatically confirm this email address
}
```

### Response
No return value specified.
```

--------------------------------

### Create standalone Realtime module

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Realtime

Creates a standalone Realtime module if you only need this Supabase module.

```kotlin
val realtime = standaloneSupabaseModule(Realtime, url = "wss://your.realtime.url.com", apiKey = "your-api-key")
```

--------------------------------

### createBucket

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing Buckets

Creates a new storage bucket with optional configuration such as public access, file size limit, and allowed MIME types.

```APIDOC
## createBucket

### Description
Creates a new storage bucket with the given name and ID, and optional configuration.

### Method
createBucket

### Parameters
- **name** (String) - Required - The name of the bucket.
- **id** (String) - Required - The unique identifier for the bucket.
- **public** (Boolean) - Optional - Whether the bucket is public.
- **fileSizeLimit** (Long) - Optional - Maximum file size allowed in the bucket.
- **allowedMimeTypes** (List<ContentType>) - Optional - List of allowed MIME types.

### Request Example
```kotlin
client.storage.createBucket(name = "images", id = "images") {
    public = true
    fileSizeLimit = 20.megabytes
    allowedMimeTypes(ContentType.Image.JPG, ContentType.Image.PNG)
}
```

### Response
No response body is documented.
```

--------------------------------

### Sign in with OAuth

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Initiates OAuth sign-in with the specified provider (e.g., Google). This method is part of the native-auth module.

```kotlin
supabase.auth.signInWithOAuth(OAuthProviders.GOOGLE) {
    // ...
}
```

--------------------------------

### Create standalone Storage module

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Storage

Creates a standalone Storage module for use without the main Supabase client. Requires a URL and API key.

```kotlin
val storage = standaloneSupabaseModule(Storage, url = "https://your.storage.url.com", apiKey = "your-api-key")
```

--------------------------------

### Sign in with password

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Signs in a user with email and password. The session is returned as a UserSession object.

```kotlin
val session = supabase.auth.signInWithPassword(Email("myEmail@example.com"), password = "123345") {
        // ...
}
```

--------------------------------

### Connect to the realtime websocket

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Realtime

Connects to the realtime websocket using the realtime plugin.

```kotlin
client.realtime.connect()
```

--------------------------------

### Sign in with SSO

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Signs in using SSO with either a domain or a provider ID.

```kotlin
supabase.auth.signInWithSSO(SSODomain("domain")) 
supabase.auth.signInWithSSO(SSOProvider("providerId"))
```

--------------------------------

### Create standalone Postgrest module

Source: https://github.com/supabase-community/supabase-kt/wiki/Postgrest/Postgrest

Create a standalone Postgrest module if you only need this Supabase module. Requires a URL and API key.

```kotlin
val postgrest = standaloneSupabaseModule(Postgrest, url = "https://your.postgrest.url.com", apiKey = "your-api-key")
```

--------------------------------

### Launch iOS app with debug logging environment variables

Source: https://github.com/supabase-community/supabase-kt/blob/master/TROUBLESHOOTING.md

For physical iOS devices, launch the app with these environment variables to see debug logs in the console attached by xcrun devicectl. Replace <device-id> and <bundle-id> with actual values.

```bash
DEVICECTL_CHILD_OS_ACTIVITY_DT_MODE=YES DEVICECTL_CHILD_OS_ACTIVITY_MODE=debug \
  xcrun devicectl device process launch --console --terminate-existing \
  --device <device-id> <bundle-id>
```

--------------------------------

### Add Supabase Fetcher and Keyer to Compose-ImageLoader

Source: https://github.com/supabase-community/supabase-kt/blob/master/plugins/ImageLoaderIntegration/README.md

Create a new ImageLoader with the Supabase Fetcher and Keyer. The fetcher downloads data and the keyer enables in-memory and disk caching.

```kotlin
ImageLoader {
    //...
    components {
        add(keyer = supabaseClient.imageLoader)
        add(fetcherFactory = supabaseClient.imageLoader)
    }
    //...
}
```

--------------------------------

### Create a realtime channel

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Realtime

Creates a realtime channel with presence and broadcast options, then joins it after setting up flows.

```kotlin
val channel = supabaseClient.realtime.createChannel("#random") {

    presence {
        //presence options
    }

    broadcast {
        //broadcast options
    }

}

//after you called methods like broadcastFlow or postgrestChangeFlow, join the channel:
channel.join()
```

--------------------------------

### Sign in with OTP

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Sends a one-time password (OTP) to the given email address.

```kotlin
supabase.auth.signInWithOtp(Email("myEmail@example.com")) {
      // ...
}
```

--------------------------------

### Verify an MFA challenge

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/MFA

Verify the user's input against the challenge, or perform creation and verification in one step.

```kotlin
client.gotrue.mfa.verifyChallenge(factor.id, challenge.id, "123456") //123456 is the code the user entered

//or verify without creating a challenge
client.gotrue.mfa.createChallengeAndVerify(factor.id, "123456")
```

--------------------------------

### Download with progress listener as a flow

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Downloads a public file as a flow, allowing progress tracking. The flow emits DownloadStatus.Progress with received and total bytes, and DownloadStatus.Success with the data size.

```kotlin
client.storage["icons"].downloadPublicAsFlow("1654898740006.jpg").collect { status ->
    when(status) {
        is DownloadStatus.Progress -> println("Percent done: ${status.received.toDouble() / status.total.toDouble() * 100}")
        is DownloadStatus.Success -> println("Done: ${status.data.size} bytes")
    }
}
```

--------------------------------

### Upload with progress listener as a flow

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Uploads a file as a flow, allowing progress tracking. The flow emits UploadStatus.Progress with sent and total bytes, and UploadStatus.Success with the key.

```kotlin
client.storage["icons"].uploadAsFlow("test.png", File("test.png").readBytes()).collect {
    when(it) {
        is UploadStatus.Progress -> println("Percent done: ${it.sent.toDouble() / it.total.toDouble() * 100}")
        is UploadStatus.Success -> println("Done: ${it.key}")
    }
}
```

--------------------------------

### Login with email/phone and password

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Login

Use loginWith(Email) or loginWith(Phone) to authenticate with email or phone and password. After login, the current access token can be retrieved with currentAccessTokenOrNull().

```kotlin
supabaseClient.gotrue.loginWith(Email) {
    email = "example@email.com"
    password = "12345"
}
//with phone:
supabaseClient.gotrue.loginWith(Phone) {
    phone = "123456789"
    password = "12345"
}
println(supabaseClient.gotrue.currentAccessTokenOrNull())
```

--------------------------------

### Generate magic link or signup link

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Generates a magic link or signup link for a user, returning a link and user pair. The signup variant includes a password.

```kotlin
val (link, user) = client.gotrue.admin.generateLinkFor(LinkType.MagicLink) {
    email = "example@foo.bar"
}
val (link, user) = client.gotrue.admin.generateLinkFor(LinkType.Signup) {
    email = "example@foo.bar"
    password = "12345678"
}
```

--------------------------------

### Upload files to a bucket

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing files

Uploads a file to the 'images' bucket. Shows uploading raw bytes and uploading a File object (JVM only).

```kotlin
val bucket = client.storage["images"]

bucket.upload("landscape.png", bytes)

//upload a file (jvm)
bucket.upload("landscape.png", File("landscape.png"))
```

--------------------------------

### Publish changes to local Maven repository

Source: https://github.com/supabase-community/supabase-kt/blob/master/CONTRIBUTING.md

Run this Gradle command in the project root to publish your changes to a local Maven repository for testing in your own project. Replace `customVersion` with a unique version like `2.5.0-local-1` to prevent version clashing with official versions.

```shell
./gradlew -DLibrariesOnly=true -DDisableSigning=true -DSupabaseVersion="customVersion" publishToMavenLocal
```

--------------------------------

### Access Postgrest plugin

Source: https://github.com/supabase-community/supabase-kt/wiki/Postgrest/Postgrest

Access the Postgrest plugin instance from the Supabase client.

```kotlin
client.postgrest
```

--------------------------------

### Pause and resume upload with pause and startOrResumeUploading

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Resumable uploads

Pauses the upload, waits 2 seconds, then resumes it. Use this to temporarily halt and later continue the upload.

```kotlin
upload.pause()
delay(2000)
upload.startOrResumeUploading()
```

--------------------------------

### Create an MFA challenge

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/MFA

Generate a challenge for the user to verify their enrolled factor.

```kotlin
val challenge = client.gotrue.mfa.createChallenge(factor.id)
```

--------------------------------

### signInWithSSO

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Signs in a user using Single Sign-On (SSO) with a domain or provider ID.

```APIDOC
## signInWithSSO

### Description
Signs in a user using Single Sign-On (SSO) with a domain or provider ID.

### Method
signInWithSSO

### Parameters
- **identifier** (SSODomain or SSOProvider) - Required - The SSO domain or provider ID.

### Request Example
```kotlin
supabase.auth.signInWithSSO(SSODomain("domain")) 
supabase.auth.signInWithSSO(SSOProvider("providerId"))
```
```

--------------------------------

### Create standalone GoTrue module

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/GoTrue

Create a standalone GoTrue module if you only need this Supabase module.

```kotlin
val gotrue = standaloneSupabaseModule(GoTrue, url = "https://your.gotrue.url.com", apiKey = "your-api-key")
```

--------------------------------

### Configure Android OAuth scheme in build.gradle

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Set the app scheme and optionally the host in the build configuration. The library handles the rest, including magic links.

```kotlin
android {

    defaultConfig {
        manifestPlaceholders["supabaseAuthScheme"] = "myScheme"
        // optional: 
        manifestPlaceholders["supabaseAuthHost"] = "myHost"
    }
    
}
```

--------------------------------

### Select Data with Filters

Source: https://github.com/supabase-community/supabase-kt/wiki/Make-Database-Calls

Demonstrates selecting data from the messages table using property references or string-based column names, and combining filters with and/or.

```kotlin
val result = client.postgrest["messages"]
    .select {
        //you can use that syntax
        Message::authorId eq "someid"
        Message::text neq "This is a text!"
        Message::channelId isIn listOf("test", "test2")

        //or this. But they are the same
        eq("author_id", "someid")
        neq("text", "This is a text!")
        isIn("channel_id", listOf("test", "test2"))
        
        //use and + or to combine multiple filters
        or {
            eq("author_id", "someid")
            and {
                eq("author_id", "someid")
                neq("text", "This is a text!")
            }
        }
    }

println(result.decodeList<Message>())
```

--------------------------------

### getBucket

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing Buckets

Retrieves a storage bucket by its ID.

```APIDOC
## getBucket

### Description
Retrieves a storage bucket using its unique identifier.

### Method
getBucket

### Parameters
- **id** (String) - Required - The unique identifier of the bucket.

### Request Example
```kotlin
val bucket = client.getBucket(id = "id")
```

### Response
Returns the bucket object.
```

--------------------------------

### Create standalone Functions module

Source: https://github.com/supabase-community/supabase-kt/wiki/Functions/Functions

Create a standalone Functions module if you only need this Supabase module. Requires URL and API key.

```kotlin
val functions = standaloneSupabaseModule(Functions, url = "https://your.functions.url.com", apiKey = "your-api-key")
```

--------------------------------

### Old SSO login with loginWith(SSO)

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

The old way to log in with SSO using the GoTrue plugin's loginWith method, specifying either a provider or domain.

```kotlin
supabase.gotrue.loginWith(SSO.withProvider("provider"))
//or
supabase.gotrue.loginWith(SSO.withDomain("domain"))
```

--------------------------------

### Sign in with ID token

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Signs in using an ID token from the specified OAuth provider (e.g., Google).

```kotlin
val session = supabase.auth.signInWithIdToken(OAuthProviders.GOOGLE, token = "12343") {
    // ...
}
```

--------------------------------

### Listen for all database changes with postgresChangeFlow

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Listening for database changes

Use `postgresChangeFlow<PostgresAction>` to receive all change types (insert, update, delete, etc.) for the specified table.

```kotlin
val changeFlow: Flow<PostgresAction> = channel.postgresChangeFlow<PostgresAction>(schema = "public") {
    table = "test"
}
```

--------------------------------

### Xcode Run Script Phase for iOS framework

Source: https://github.com/supabase-community/supabase-kt/blob/master/sample/chat-demo-mpp/README.md

Add this as a Run Script Phase in Xcode before Compile Sources. It builds and embeds the common framework for iOS.

```cmd
cd "$SRCROOT/.."
./gradlew :sample:chat-demo-mpp:common:embedAndSignAppleFrameworkForXcode
```

--------------------------------

### signInWithOtp

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Sends an OTP to the user's email or phone for sign-in.

```APIDOC
## signInWithOtp

### Description
Sends an OTP to the user's email or phone for sign-in.

### Method
signInWithOtp

### Parameters
- **identifier** (Email or Phone) - Required - The user's email or phone.
- **config** (Builder) - Optional - Additional configuration.

### Request Example
```kotlin
supabase.auth.signInWithOtp(Email("myEmail@example.com")) {
    // ...
}
```
```

--------------------------------

### Generate Link

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Generates a magic link or signup link for a user. Returns the link and the user information.

```APIDOC
## Generate Link

### Description
Generates a magic link or signup link for a user. Returns the link and the user information.

### Method
N/A (Kotlin function call)

### Endpoint
`client.gotrue.admin.generateLinkFor(linkType: LinkType) { ... }`

### Parameters
#### Path Parameters
- **linkType** (LinkType) - Required - The type of link to generate. Possible values: `MagicLink`, `Signup`.

#### Request Body (Kotlin lambda)
- **email** (String) - Required - The email address for the link.
- **password** (String) - Optional - Required for `Signup` link type.

### Request Example
```kotlin
val (link, user) = client.gotrue.admin.generateLinkFor(LinkType.MagicLink) {
    email = "example@foo.bar"
}
val (link, user) = client.gotrue.admin.generateLinkFor(LinkType.Signup) {
    email = "example@foo.bar"
    password = "12345678"
}
```

### Response
- **link** (String) - The generated link.
- **user** (UserInfo) - The user information.
```

--------------------------------

### Verify email and phone OTPs

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/GoTrue

Verify email and phone OTPs for signup, invite, or recovery.

```kotlin
supabaseClient.gotrue.verifyEmailOtp(OtpType.Email.SIGNUP, token = "token", email = "example@email.com")
supabaseClient.gotrue.verifyPhoneOtp(OtpType.Phone.SMS, token = "token", phoneNumber = "123456")
```

--------------------------------

### Old Postgrest update with returning parameter

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

The old syntax for updating data, passing the returning parameter and applying filters directly.

```kotlin
supabase.postgrest.from("countries").update(country, returning = Returning.REPRESENTATION) { //Returning is representation by default
    eq("id", 1)
}
```

--------------------------------

### signWithGoogle

Source: https://github.com/supabase-community/supabase-kt/blob/master/refactor.MD

Performs native Google authentication, falling back to OAuth if native is unavailable. Requires native-auth module.

```APIDOC
## signWithGoogle

### Description
Performs native Google authentication, falling back to OAuth if native is unavailable. Requires native-auth module.

### Method
signWithGoogle

### Parameters
- **config** (Builder) - Optional - Configuration for native auth, e.g., `googleClientId`.

### Request Example
```kotlin
// required for Android:
install(Auth.withNative()) {
    nativeAuth {
         googleClientId = "..."
    }
}
val result = supabase.auth.signWithGoogle()
when(result) {
    GoogleSignInResult.Cancelled -> TODO()
    GoogleSignInResult.OAuthInitiated -> TODO()
    is GoogleSignInResult.Success -> TODO()
}
```

### Response
Returns a GoogleSignInResult which can be Cancelled, OAuthInitiated, or Success.
```

--------------------------------

### Access storage plugin via client

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Storage

Accesses the Storage plugin from the Supabase client instance.

```kotlin
client.storage
```

--------------------------------

### Retrieve a bucket

Source: https://github.com/supabase-community/supabase-kt/wiki/Storage/Managing Buckets

Fetches a bucket by its ID using the getBucket method.

```kotlin
val bucket = client.getBucket(id = "id")
```

--------------------------------

### New SSO sign-in with signInWith(SSO)

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

The new way to sign in with SSO using the Auth plugin's signInWith method and the SSO provider, using providerId or domain.

```kotlin
supabase.auth.signInWith(SSO) {
    providerId = "providerId"
    //or
    domain = "domain"
}
```

--------------------------------

### New OTP sign-in with signInWith(OTP)

Source: https://github.com/supabase-community/supabase-kt/blob/master/MIGRATION.md

The new way to sign in with OTP using the Auth plugin's signInWith method and the OTP provider, replacing sendOtpTo.

```kotlin
supabase.auth.signInWith(OTP) {
    email = "example@email.com"
    //or
    phone = "+123456789"
}
```

--------------------------------

### Access the realtime plugin

Source: https://github.com/supabase-community/supabase-kt/wiki/Realtime/Realtime

Accesses the realtime plugin from the Supabase client.

```kotlin
client.realtime
```

--------------------------------

### Add supabase-kt module dependency with Gradle (Groovy)

Source: https://github.com/supabase-community/supabase-kt/wiki/Installation

Adds a supabase-kt module (e.g., functions-kt or gotrue-kt) to a Gradle build using Groovy syntax. Also includes adding a Ktor client engine (CIO) if not already present. Replace VERSION and KTOR_VERSION with actual versions.

```groovy
dependencies {
    implementation 'io.github.jan-tennert.supabase:[module e.g. functions-kt or gotrue-kt]:VERSION'

    //add ktor client engine (if you don't already have one, see https://ktor.io/docs/http-client-engines.html for all engines)
    //e.g. the CIO engine
    implementation 'io.ktor:ktor-client-cio:KTOR_VERSION'
}
```

--------------------------------

### RPC call with parameters and filter

Source: https://github.com/supabase-community/supabase-kt/wiki/Postgrest/Execute Database functions

Calls the 'do_something' function with a parameter map and applies an equality filter on the 'id' column.

```kotlin
client.postgrest.rpc("do_something", mapOf("param1" to "value1")) {
    eq("id", 1) 
}
```

--------------------------------

### Run JS Canvas App

Source: https://github.com/supabase-community/supabase-kt/blob/master/sample/multi-factor-auth/README.md

Command to run the JS Canvas version of the app from the project root directory.

```bash
./gradlew :sample:multi-factor-auth:web:jsBrowserDevelopmentRun
```

--------------------------------

### Retrieve all users with GoTrue admin

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Admin API

Fetches a list of all users as List<UserInfo> using the admin API.

```kotlin
val users: List<UserInfo> = client.gotrue.admin.retrieveUsers()
```

--------------------------------

### Basic RPC call

Source: https://github.com/supabase-community/supabase-kt/wiki/Postgrest/Execute Database functions

Calls the 'do_something' database function without parameters.

```kotlin
client.postgrest.rpc("do_something")
```

--------------------------------

### Configure custom session manager on desktop

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/Session Saving

Use this snippet to override the default session storage on desktop by providing a custom Settings implementation. It uses PreferencesSettings with a custom node name 'custom_name'.

```kotlin
install(GoTrue) {
    sessionManager = SettingsSessionManager(PreferencesSettings(Preferences.userRoot().node("custom_name")))
}
```

--------------------------------

### Send OTP to phone/email

Source: https://github.com/supabase-community/supabase-kt/wiki/GoTrue/GoTrue

Send an OTP to an email address using the GoTrue plugin.

```kotlin
supabaseClient.gotrue.sendOtpTo(Email) {
    email = "example@email.com"
    password = "12345"
}
```
Tokens:
Raw