commonMain.enchant.flare.FirebaseAuth.kt Maven / Gradle / Ivy

Go to download
package enchant.flare

import kotlinx.coroutines.flow.Flow
import enchant.flare.AuthProvider.*

interface FirebaseAuth {

    suspend fun applyActionCode(code: String)
    suspend fun checkActionCode(code: String): ActionCodeInfo

    suspend fun confirmPasswordReset(code: String, newPassword: String)
    suspend fun fetchSignInProvidersForEmail(email: String): List
    val currentUser: FirebaseUser?

    suspend fun sendPasswordResetEmail(email: String, settings: ActionCodeSettings? = null)
    suspend fun sendSignInLinkToEmail(email: String, settings: ActionCodeSettings)
    suspend fun signIn(method: AuthMethod): AdditionalUserInfo
    suspend fun verifyPasswordResetCode(code: String): String

    fun isSignInWithEmailLink(link: String): Boolean
    fun signOut()

    val config: Config

    interface Config {
        var settings: FirebaseAuthSettings

        data class FirebaseAuthSettings(
            val appVerificationDisabledForTesting: Boolean = false,
        )

        fun onAuthStateChange(): Flow
        fun onIdTokenChange(): Flow
        fun useAppLanguage()
        fun useEmulator(host: String, port: Int)

        var tenantId: String?
        val languageCode: String?
    }

    companion object {
        val instance: FirebaseAuth = firebaseAuthInstance
        fun getInstance(app: FirebaseApp) = getAuthInstance(app)
    }
}

class AuthException(val code: Code, val description: String? = null) :
    Exception("Firebase auth operation failed with code ${code.name}: $description") {

    enum class Code {
        ActionCode,
        Email,
        InvalidCredentials,
        InvalidUser,
        MultiFactor,
        RecentLoginRequired,
        UserCollision,
        AuthWeb,
        WeakPassword,
        Unknown
    }
}

sealed class ActionCodeInfo {


    data class PasswordReset(val email: String) : ActionCodeInfo()
    class SignInWithEmailLink : ActionCodeInfo()
    data class RevertSecondFactorAddition(
        val email: String,
    ) : ActionCodeInfo()

    data class RecoverEmail(val email: String, val previousEmail: String) : ActionCodeInfo()
    data class VerifyBeforeChangeEmail(
        val email: String,
        val previousEmail: String
    ) : ActionCodeInfo()

    data class VerifyEmail(val email: String) : ActionCodeInfo()
}

sealed class AuthMethod(internal val provider: AuthProvider) {

    data class Apple(
        val ui: Any,
        val requestEmail: Boolean = false,
        val requestName: Boolean = false,
        val locale: String? = null
    ) : AuthMethod(Apple)

    object Anonymous : AuthMethod(AuthProvider.Anonymous)

    data class EmailPassword(val email: String, val password: String) : AuthMethod(EmailPassword)
    data class EmailLink(val email: String, val link: String) : AuthMethod(EmailLink)

    data class Custom(val token: String) : AuthMethod(Custom)

    data class GitHub(
        val activity: Any = Unit,
        val loginHint: String? = null,
        val allowSignUp: Boolean = false,
        val requestEmail: Boolean = false
    ) : AuthMethod(GitHub)

    data class Google(
        val ui: Any = Unit,
        val webClientId: String,
        val requestEmail: Boolean = false,
        val requestProfile: Boolean = false
    ) : AuthMethod(Google)

    data class Twitter(val activity: Any? = null, val locale: String? = null) : AuthMethod(Twitter)
    data class Yahoo(
        val activity: Any = Unit,
        val requestProfile: Boolean = false,
        val requestEmail: Boolean = false,
        val language: String? = null,
        val prompt: String? = null,
        val maxAge: Int? = null
    ) : AuthMethod(Yahoo)
}

enum class AuthProvider { Anonymous, Apple, Custom, EmailPassword, EmailLink, GitHub, Google, Twitter, Yahoo }

internal fun toAuthProvider(method: String): AuthProvider =
    when (method) {
        "apple.com" -> Apple
        "password" -> EmailPassword
        "emailLink" -> EmailLink
        "github.com" -> GitHub
        "google.com" -> Google
        "twitter.com" -> Twitter
        "yahoo.com" -> Yahoo
        else -> error("Unknown auth method encountered: $method")
    }

internal fun toAuthString(provider: AuthProvider): String =
    when (provider) {
        Anonymous -> "anonymous"
        Apple -> "apple.com"
        Custom -> "custom"
        EmailPassword -> "password"
        EmailLink -> "emailLink"
        GitHub -> "github.com"
        Google -> "google.com"
        Twitter -> "twitter.com"
        Yahoo -> "yahoo.com"
    }

data class AdditionalUserInfo(
    val profile: Map?,
    val username: String?,
    val isNewUser: Boolean,
)

interface FirebaseUser {

    suspend fun delete()
    val displayName: String?
    val email: String?
    suspend fun getIdToken(forceRefresh: Boolean): TokenResult
    val creationTimestamp: Long
    val lastSignInTimestamp: Long
    val phoneNumber: String?
    val photoUrl: String?
    val providerData: List
    val tenantId: String?
    val uid: String
    val isAnonymous: Boolean
    suspend fun linkMethod(method: AuthMethod): AdditionalUserInfo
    suspend fun reauthenticate(method: AuthMethod): AdditionalUserInfo
    suspend fun reload()
    suspend fun sendEmailVerification(settings: ActionCodeSettings? = null)

    suspend fun unlinkMethod(provider: AuthProvider)
    suspend fun updateEmail(email: String)
    suspend fun updatePassword(password: String)
    suspend fun updateProfile(displayName: String? = null, photoUrl: String? = null)
    suspend fun verifyBeforeUpdateEmail(newEmail: String, settings: ActionCodeSettings? = null)


}

data class ActionCodeSettings(
    val androidConfig: AndroidConfig? = null,
    val dynamicLinkDomain: String? = null,
    val handleCodeInApp: Boolean = false,
    val iOSBundleId: String? = null,
    val url: String? = null
) {
    data class AndroidConfig(
        val androidPackageName: String,
        val installIfNotAvailable: Boolean,
        val minimumVersion: String
    )
}

data class UserInfo(
    val displayName: String? = null,
    val email: String? = null,
    val phoneNumber: String? = null,
    val photoUrl: String? = null,
    val providerId: String,
    val uid: String,
    val isEmailVerified: Boolean = false
)

data class TokenResult(
    val authTimestamp: Long,
    val claims: Map,
    val expirationTimestamp: Long,
    val issuedAtTimestamp: Long,
    val signInProvider: AuthProvider?,
    val signInSecondFactor: AuthProvider?,
    val token: String?
)

internal expect val firebaseAuthInstance: FirebaseAuth
internal expect fun getAuthInstance(app: FirebaseApp): FirebaseAuth