Merge pull request #732 from supabase-community/rename-gotrue-new

Rename GoTrue to Auth

.github/labeler.yml

@@ -16,7 +16,7 @@ postgrest:
 
 auth:
   - changed-files:
-      - any-glob-to-any-file: GoTrue/src/**
+      - any-glob-to-any-file: Auth/src/**
 
 storage:
   - changed-files:

Auth/README.md

@@ -0,0 +1,70 @@
+# Supabase-kt Auth
+
+**Only available for versions 3.0.0 and above. For versions below 3.0.0, checkout the [old README](/GoTrue)**
+
+Extends Supabase-kt with a multiplatform Auth client.
+
+Supported targets:
+
+| Target | **JVM** | **Android** | **JS** | **Wasm** | **Apple** | **Windows** | **Linux** |
+|--------|---------|-------------|--------|----------|-----------|-------------|-----------|
+| Status | ✅       | ✅           | ✅      | ✅        | ☑️*       | ☑️          | ☑️        |
+
+> ☑️ = No built-in OAuth support. Linux has no support for persistent session storage.
+
+\* **iOS and macOS are fully supported**
+
+<details>
+
+<summary>In-depth Kotlin targets</summary>
+
+**JS**: Browser, NodeJS
+
+**Wasm**: wasm-js
+
+**Apple:**
+
+- iOS: iosArm64, iosSimulatorArm64, iosX64
+
+- tvOS: tvosArm64, tvosX64, tvosSimulatorArm64
+
+- watchOS: watchosArm64, watchosX64, watchosSimulatorArm64
+
+- MacOS: macosX64, macosArm64
+
+**Windows**: mingwX64
+
+**Linux**: linuxX64
+
+</details>
+
+# Installation
+
+Newest version: [![](https://img.shields.io/github/release/supabase-community/supabase-kt?label=)](https://github.com/supabase-community/supabase-kt/releases)
+
+```kotlin
+dependencies {
+    implementation("io.github.jan-tennert.supabase:auth-kt:VERSION")
+}
+```
+
+Install the plugin in your SupabaseClient. See the [documentation](https://supabase.com/docs/reference/kotlin/initializing) for more information
+
+```kotlin
+val supabase = createSupabaseClient(
+    supabaseUrl = "https://id.supabase.co",
+    supabaseKey = "apikey"
+) {
+
+    //...
+
+    install(Auth) {
+        // settings
+    }
+
+}
+```
+
+# Usage
+
+See [Auth documentation](https://supabase.com/docs/reference/kotlin/auth-signup) for usage

GoTrue/src/androidMain/AndroidManifest.xml → Auth/src/androidMain/AndroidManifest.xml

@@ -9,7 +9,7 @@
                 android:exported="false"
                 tools:node="merge">
             <meta-data
-                    android:name="io.github.jan.supabase.gotrue.SupabaseInitializer"
+                    android:name="io.github.jan.supabase.auth.SupabaseInitializer"
                     android:value="androidx.startup" />
         </provider>
     </application>

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/Android.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/Android.kt

@@ -1,11 +1,11 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import android.content.Intent
 import android.net.Uri
 import androidx.browser.customtabs.CustomTabsIntent
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.annotations.SupabaseInternal
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.user.UserSession
 import kotlinx.coroutines.launch
 
 internal fun openUrl(uri: Uri, action: ExternalAuthAction) {

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/AuthConfig.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/AuthConfig.kt

@@ -1,7 +1,7 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import androidx.browser.customtabs.CustomTabsIntent
-import io.github.jan.supabase.gotrue.providers.ExternalAuthConfig
+import io.github.jan.supabase.auth.providers.ExternalAuthConfig
 import io.github.jan.supabase.plugins.CustomSerializationConfig
 
 /**

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/RedirectUrl.android.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/RedirectUrl.android.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.annotations.SupabaseInternal
 

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/Utils.android.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/Utils.android.kt

@@ -1,9 +1,9 @@
 @file:Suppress("RedundantSuspendModifier")
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import android.net.Uri
 import io.github.jan.supabase.SupabaseClient
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.user.UserSession
 
 internal actual suspend fun SupabaseClient.openExternalUrl(url: String) {
     openUrl(Uri.parse(url), auth.config.defaultExternalAuthAction)

GoTrue/src/jsMain/kotlin/io/github/jan/supabase/gotrue/providers/ExternalAuthConfig.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/providers/ExternalAuthConfig.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue.providers
+package io.github.jan.supabase.auth.providers
 
 /**
  * Configuration for external authentication providers like Google, Twitter, etc.

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/setupPlatform.kt → Auth/src/androidMain/kotlin/io/github/jan/supabase/auth/setupPlatform.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import android.content.Context
 import androidx.lifecycle.DefaultLifecycleObserver

GoTrue/src/androidUnitTest/kotlin/platformSettings.kt → Auth/src/androidUnitTest/kotlin/platformSettings.kt

@@ -1,4 +1,4 @@
-import io.github.jan.supabase.gotrue.AuthConfig
+import io.github.jan.supabase.auth.AuthConfig
 
 actual fun AuthConfig.platformSettings() {
     enableLifecycleCallbacks = false

GoTrue/src/appleMain/kotlin/io/github/jan/supabase/gotrue/Apple.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/Apple.kt

@@ -1,7 +1,7 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.user.UserSession
 import io.github.jan.supabase.logging.d
 import kotlinx.coroutines.launch
 import platform.Foundation.NSURL

GoTrue/src/appleMain/kotlin/io/github/jan/supabase/gotrue/RedirectUrl.apple.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/RedirectUrl.apple.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.annotations.SupabaseInternal
 

GoTrue/src/appleMain/kotlin/io/github/jan/supabase/gotrue/Utils.apple.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/Utils.apple.kt

@@ -1,7 +1,7 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
-import io.github.jan.supabase.gotrue.providers.openUrl
+import io.github.jan.supabase.auth.providers.openUrl
 import platform.Foundation.NSURL
 
 internal actual suspend fun SupabaseClient.openExternalUrl(url: String) {

GoTrue/src/androidMain/kotlin/io/github/jan/supabase/gotrue/providers/ExternalAuthConfig.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/providers/ExternalAuthConfig.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue.providers
+package io.github.jan.supabase.auth.providers
 
 /**
  * Configuration for external authentication providers like Google, Twitter, etc.

GoTrue/src/appleMain/kotlin/io/github/jan/supabase/gotrue/providers/OAuthProvider.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/providers/OAuthProvider.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue.providers
+package io.github.jan.supabase.auth.providers
 
 import platform.Foundation.NSURL
 

GoTrue/src/jvmMain/kotlin/io/github/jan/supabase/gotrue/setupPlatform.kt → Auth/src/appleMain/kotlin/io/github/jan/supabase/auth/setupPlatform.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.annotations.SupabaseInternal
 

GoTrue/src/linuxTest/kotlin/platformSettings.kt → Auth/src/appleTest/kotlin/platformSettings.kt

@@ -1,3 +1,3 @@
-import io.github.jan.supabase.gotrue.AuthConfig
+import io.github.jan.supabase.auth.AuthConfig
 
 actual fun AuthConfig.platformSettings() = Unit

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/AccessToken.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/AccessToken.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.annotations.SupabaseInternal

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/Auth.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/Auth.kt

@@ -1,22 +1,22 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
+import io.github.jan.supabase.auth.admin.AdminApi
+import io.github.jan.supabase.auth.exception.AuthRestException
+import io.github.jan.supabase.auth.exception.AuthWeakPasswordException
+import io.github.jan.supabase.auth.mfa.MfaApi
+import io.github.jan.supabase.auth.providers.AuthProvider
+import io.github.jan.supabase.auth.providers.ExternalAuthConfigDefaults
+import io.github.jan.supabase.auth.providers.Google
+import io.github.jan.supabase.auth.providers.OAuthProvider
+import io.github.jan.supabase.auth.providers.builtin.Email
+import io.github.jan.supabase.auth.providers.builtin.Phone
+import io.github.jan.supabase.auth.providers.builtin.SSO
+import io.github.jan.supabase.auth.user.UserInfo
+import io.github.jan.supabase.auth.user.UserSession
+import io.github.jan.supabase.auth.user.UserUpdateBuilder
 import io.github.jan.supabase.exceptions.HttpRequestException
 import io.github.jan.supabase.exceptions.RestException
-import io.github.jan.supabase.gotrue.admin.AdminApi
-import io.github.jan.supabase.gotrue.exception.AuthRestException
-import io.github.jan.supabase.gotrue.exception.AuthWeakPasswordException
-import io.github.jan.supabase.gotrue.mfa.MfaApi
-import io.github.jan.supabase.gotrue.providers.AuthProvider
-import io.github.jan.supabase.gotrue.providers.ExternalAuthConfigDefaults
-import io.github.jan.supabase.gotrue.providers.Google
-import io.github.jan.supabase.gotrue.providers.OAuthProvider
-import io.github.jan.supabase.gotrue.providers.builtin.Email
-import io.github.jan.supabase.gotrue.providers.builtin.Phone
-import io.github.jan.supabase.gotrue.providers.builtin.SSO
-import io.github.jan.supabase.gotrue.user.UserInfo
-import io.github.jan.supabase.gotrue.user.UserSession
-import io.github.jan.supabase.gotrue.user.UserUpdateBuilder
 import io.github.jan.supabase.logging.SupabaseLogger
 import io.github.jan.supabase.logging.e
 import io.github.jan.supabase.plugins.CustomSerializationPlugin

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/AuthConfig.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/AuthConfig.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClientBuilder
 import io.github.jan.supabase.SupabaseSerializer

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/AuthExtensions.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/AuthExtensions.kt

@@ -1,7 +1,7 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
+import io.github.jan.supabase.auth.user.UserSession
 import io.github.jan.supabase.encodeToJsonElement
-import io.github.jan.supabase.gotrue.user.UserSession
 import io.github.jan.supabase.logging.d
 import kotlinx.serialization.json.jsonObject
 

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/AuthImpl.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/AuthImpl.kt

@@ -1,28 +1,28 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.annotations.SupabaseExperimental
 import io.github.jan.supabase.annotations.SupabaseInternal
+import io.github.jan.supabase.auth.admin.AdminApi
+import io.github.jan.supabase.auth.admin.AdminApiImpl
+import io.github.jan.supabase.auth.exception.AuthRestException
+import io.github.jan.supabase.auth.exception.AuthSessionMissingException
+import io.github.jan.supabase.auth.exception.AuthWeakPasswordException
+import io.github.jan.supabase.auth.mfa.MfaApi
+import io.github.jan.supabase.auth.mfa.MfaApiImpl
+import io.github.jan.supabase.auth.providers.AuthProvider
+import io.github.jan.supabase.auth.providers.ExternalAuthConfigDefaults
+import io.github.jan.supabase.auth.providers.OAuthProvider
+import io.github.jan.supabase.auth.providers.builtin.OTP
+import io.github.jan.supabase.auth.providers.builtin.SSO
+import io.github.jan.supabase.auth.user.UserInfo
+import io.github.jan.supabase.auth.user.UserSession
+import io.github.jan.supabase.auth.user.UserUpdateBuilder
 import io.github.jan.supabase.bodyOrNull
 import io.github.jan.supabase.exceptions.BadRequestRestException
 import io.github.jan.supabase.exceptions.RestException
 import io.github.jan.supabase.exceptions.UnauthorizedRestException
 import io.github.jan.supabase.exceptions.UnknownRestException
-import io.github.jan.supabase.gotrue.admin.AdminApi
-import io.github.jan.supabase.gotrue.admin.AdminApiImpl
-import io.github.jan.supabase.gotrue.exception.AuthRestException
-import io.github.jan.supabase.gotrue.exception.AuthSessionMissingException
-import io.github.jan.supabase.gotrue.exception.AuthWeakPasswordException
-import io.github.jan.supabase.gotrue.mfa.MfaApi
-import io.github.jan.supabase.gotrue.mfa.MfaApiImpl
-import io.github.jan.supabase.gotrue.providers.AuthProvider
-import io.github.jan.supabase.gotrue.providers.ExternalAuthConfigDefaults
-import io.github.jan.supabase.gotrue.providers.OAuthProvider
-import io.github.jan.supabase.gotrue.providers.builtin.OTP
-import io.github.jan.supabase.gotrue.providers.builtin.SSO
-import io.github.jan.supabase.gotrue.user.UserInfo
-import io.github.jan.supabase.gotrue.user.UserSession
-import io.github.jan.supabase.gotrue.user.UserUpdateBuilder
 import io.github.jan.supabase.logging.d
 import io.github.jan.supabase.logging.e
 import io.github.jan.supabase.logging.i

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/AuthenticatedSupabaseApi.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/AuthenticatedSupabaseApi.kt

@@ -1,5 +1,5 @@
 @file:Suppress("UndocumentedPublicClass", "UndocumentedPublicFunction")
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.annotations.SupabaseInternal

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/CodeVerifierCache.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/CodeVerifierCache.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import kotlinx.atomicfu.AtomicRef
 import kotlinx.atomicfu.atomic

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/GoTrueErrorResponse.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/GoTrueErrorResponse.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.Serializable

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/JsonUtils.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/JsonUtils.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import kotlinx.serialization.json.JsonObjectBuilder
 import kotlinx.serialization.json.put

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/OtpType.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/OtpType.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 /**
  * OTPs (One Time Passwords) are used to authenticate users via email or phone.

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/PKCE.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/PKCE.kt

@@ -1,5 +1,5 @@
 @file:Suppress("MatchingDeclarationName")
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import korlibs.crypto.SHA256
 import korlibs.crypto.SecureRandom

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/PostgrestFilterDSL.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/PostgrestFilterDSL.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 /**
  * Used to mark Postgrest filter DSL functions

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/RedirectUrl.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/RedirectUrl.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.annotations.SupabaseInternal
 

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/SessionManager.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/SessionManager.kt

@@ -1,6 +1,6 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.user.UserSession
 import kotlinx.atomicfu.AtomicRef
 import kotlinx.atomicfu.atomic
 

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/SessionStatus.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/SessionStatus.kt

@@ -1,7 +1,7 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
-import io.github.jan.supabase.gotrue.providers.AuthProvider
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.providers.AuthProvider
+import io.github.jan.supabase.auth.user.UserSession
 
 /**
  * Represents the status of the current session in [Auth]

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/SignOutScope.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/SignOutScope.kt

@@ -1,4 +1,4 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 /**
  * Represents the scope of a sign-out action.

GoTrue/src/commonMain/kotlin/io/github/jan/supabase/gotrue/Utils.kt → Auth/src/commonMain/kotlin/io/github/jan/supabase/auth/Utils.kt

@@ -1,8 +1,8 @@
-package io.github.jan.supabase.gotrue
+package io.github.jan.supabase.auth
 
 import io.github.jan.supabase.SupabaseClient
 import io.github.jan.supabase.annotations.SupabaseInternal
-import io.github.jan.supabase.gotrue.user.UserSession
+import io.github.jan.supabase.auth.user.UserSession
 import io.github.jan.supabase.logging.d
 import io.ktor.client.request.HttpRequestBuilder
 import kotlinx.coroutines.launch