feat: added context AuthUIConfiguration and default string provider

Author: demolaf

auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUIConfiguration.kt

@@ -14,29 +14,27 @@
 
 package com.firebase.ui.auth.compose.configuration
 
+import android.content.Context
 import java.util.Locale
 import com.google.firebase.auth.ActionCodeSettings
 import androidx.compose.ui.graphics.vector.ImageVector
 
-fun actionCodeSettings(
-    block: ActionCodeSettings.Builder.() -> Unit
-) = ActionCodeSettings.newBuilder().apply(block).build()
+fun actionCodeSettings(block: ActionCodeSettings.Builder.() -> Unit) =
+    ActionCodeSettings.newBuilder().apply(block).build()
 
-fun authUIConfiguration(block: AuthUIConfigurationBuilder.() -> Unit): AuthUIConfiguration {
-    val builder = AuthUIConfigurationBuilder()
-    builder.block()
-    return builder.build()
-}
+fun authUIConfiguration(block: AuthUIConfigurationBuilder.() -> Unit) =
+    AuthUIConfigurationBuilder().apply(block).build()
 
 @DslMarker
 annotation class AuthUIConfigurationDsl
 
 @AuthUIConfigurationDsl
 class AuthUIConfigurationBuilder {
+    var context: Context? = null
     private val providers = mutableListOf<AuthProvider>()
     var theme: AuthUITheme = AuthUITheme.Default
-    var stringProvider: AuthUIStringProvider? = null
     var locale: Locale? = null
+    var stringProvider: AuthUIStringProvider? = null
     var isCredentialManagerEnabled: Boolean = true
     var isMfaEnabled: Boolean = true
     var isAnonymousUpgradeEnabled: Boolean = false
@@ -48,36 +46,18 @@ class AuthUIConfigurationBuilder {
     var isDisplayNameRequired: Boolean = true
     var isProviderChoiceAlwaysShown: Boolean = false
 
-    fun providers(block: AuthProvidersBuilder.() -> Unit) {
-        val builder = AuthProvidersBuilder()
-        builder.block()
-        providers.addAll(builder.build())
-    }
+    fun providers(block: AuthProvidersBuilder.() -> Unit) =
+        providers.addAll(AuthProvidersBuilder().apply(block).build())
 
     internal fun build(): AuthUIConfiguration {
-        validate()
-        return AuthUIConfiguration(
-            providers = providers.toList(),
-            theme = theme,
-            stringProvider = stringProvider,
-            locale = locale,
-            isCredentialManagerEnabled = isCredentialManagerEnabled,
-            isMfaEnabled = isMfaEnabled,
-            isAnonymousUpgradeEnabled = isAnonymousUpgradeEnabled,
-            tosUrl = tosUrl,
-            privacyPolicyUrl = privacyPolicyUrl,
-            logo = logo,
-            actionCodeSettings = actionCodeSettings,
-            isNewEmailAccountsAllowed = isNewEmailAccountsAllowed,
-            isDisplayNameRequired = isDisplayNameRequired,
-            isProviderChoiceAlwaysShown = isProviderChoiceAlwaysShown
-        )
-    }
+        // Context is not null
+        val context = requireNotNull(context) {
+            "Application context is required"
+        }
 
-    private fun validate() {
         // At least one provider
-        if (providers.isEmpty()) {
-            throw IllegalArgumentException("At least one provider must be configured")
+        require(providers.isNotEmpty()) {
+            "At least one provider must be configured"
         }
 
         // No unsupported providers
@@ -113,13 +93,36 @@ class AuthUIConfigurationBuilder {
                 else -> null
             }
         }
+
+        return AuthUIConfiguration(
+            context = context,
+            providers = providers.toList(),
+            theme = theme,
+            locale = locale,
+            stringProvider = stringProvider ?: DefaultAuthUIStringProvider(context, locale),
+            isCredentialManagerEnabled = isCredentialManagerEnabled,
+            isMfaEnabled = isMfaEnabled,
+            isAnonymousUpgradeEnabled = isAnonymousUpgradeEnabled,
+            tosUrl = tosUrl,
+            privacyPolicyUrl = privacyPolicyUrl,
+            logo = logo,
+            actionCodeSettings = actionCodeSettings,
+            isNewEmailAccountsAllowed = isNewEmailAccountsAllowed,
+            isDisplayNameRequired = isDisplayNameRequired,
+            isProviderChoiceAlwaysShown = isProviderChoiceAlwaysShown
+        )
     }
 }
 
 /**
  * Configuration object for the authentication flow.
  */
 class AuthUIConfiguration(
+    /**
+     * Application context
+     */
+    val context: Context,
+
     /**
      * The list of enabled authentication providers.
      */
@@ -131,14 +134,14 @@ class AuthUIConfiguration(
     val theme: AuthUITheme = AuthUITheme.Default,
 
     /**
-     * A custom provider for localized strings.
+     * The locale for internationalization.
      */
-    val stringProvider: AuthUIStringProvider? = null,
+    val locale: Locale? = null,
 
     /**
-     * The locale for internationalization.
+     * A custom provider for localized strings.
      */
-    val locale: Locale? = null,
+    val stringProvider: AuthUIStringProvider = DefaultAuthUIStringProvider(context, locale),
 
     /**
      * Enables integration with Android's Credential Manager API. Defaults to true.

auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUIStringProvider.kt

@@ -15,7 +15,9 @@
 package com.firebase.ui.auth.compose.configuration
 
 import android.content.Context
+import android.content.res.Configuration
 import com.firebase.ui.auth.R
+import java.util.Locale
 
 /**
  * An interface for providing localized string resources. This interface defines methods for all
@@ -29,6 +31,33 @@ interface AuthUIStringProvider {
     /** Button text for Google sign-in option */
     val signInWithGoogle: String
 
+    /** Button text for Facebook sign-in option */
+    val signInWithFacebook: String
+
+    /** Button text for Twitter sign-in option */
+    val signInWithTwitter: String
+
+    /** Button text for Github sign-in option */
+    val signInWithGithub: String
+
+    /** Button text for Email sign-in option */
+    val signInWithEmail: String
+
+    /** Button text for Phone sign-in option */
+    val signInWithPhone: String
+
+    /** Button text for Anonymous sign-in option */
+    val signInAnonymously: String
+
+    /** Button text for Apple sign-in option */
+    val signInWithApple: String
+
+    /** Button text for Microsoft sign-in option */
+    val signInWithMicrosoft: String
+
+    /** Button text for Yahoo sign-in option */
+    val signInWithYahoo: String
+
     /** Error message when email address field is empty */
     val missingEmailAddress: String
 
@@ -57,25 +86,72 @@ interface AuthUIStringProvider {
     val passwordMissingSpecialCharacter: String
 }
 
-internal class DefaultAuthUIStringProvider(private val context: Context) : AuthUIStringProvider {
-    override val initializing: String get() = ""
+internal class DefaultAuthUIStringProvider(
+    private val context: Context,
+    private val locale: Locale? = null,
+) : AuthUIStringProvider {
+
+    private val localizedContext = locale?.let { locale ->
+        context.createConfigurationContext(
+            Configuration(context.resources.configuration).apply {
+                setLocale(locale)
+            }
+        )
+    } ?: context
+
+    /**
+     * General Strings
+     */
+    override val initializing: String
+        get() = ""
+
+    /**
+     * Auth Provider Button Strings
+     */
     override val signInWithGoogle: String
-        get() = context.getString(R.string.fui_sign_in_with_google)
+        get() = localizedContext.getString(R.string.fui_sign_in_with_google)
+    override val signInWithFacebook: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_facebook)
+    override val signInWithTwitter: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_twitter)
+    override val signInWithGithub: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_github)
+    override val signInWithEmail: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_email)
+    override val signInWithPhone: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_phone)
+    override val signInAnonymously: String
+        get() = localizedContext.getString(R.string.fui_sign_in_anonymously)
+    override val signInWithApple: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_apple)
+    override val signInWithMicrosoft: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_microsoft)
+    override val signInWithYahoo: String
+        get() = localizedContext.getString(R.string.fui_sign_in_with_yahoo)
+
+    /**
+     * Email Validator Strings
+     */
     override val missingEmailAddress: String
-        get() = context.getString(R.string.fui_missing_email_address)
+        get() = localizedContext.getString(R.string.fui_missing_email_address)
     override val invalidEmailAddress: String
-        get() = context.getString(R.string.fui_invalid_email_address)
+        get() = localizedContext.getString(R.string.fui_invalid_email_address)
+
+    /**
+     * Password Validator Strings
+     */
     override val invalidPassword: String
-        get() = context.getString(R.string.fui_error_invalid_password)
-    override val passwordsDoNotMatch: String get() = ""
+        get() = localizedContext.getString(R.string.fui_error_invalid_password)
+    override val passwordsDoNotMatch: String
+        get() = localizedContext.getString(R.string.fui_passwords_do_not_match)
     override val passwordTooShort: String
-        get() = context.getString(R.string.fui_error_password_too_short)
+        get() = localizedContext.getString(R.string.fui_error_password_too_short)
     override val passwordMissingUppercase: String
-        get() = context.getString(R.string.fui_error_password_missing_uppercase)
+        get() = localizedContext.getString(R.string.fui_error_password_missing_uppercase)
     override val passwordMissingLowercase: String
-        get() = context.getString(R.string.fui_error_password_missing_lowercase)
+        get() = localizedContext.getString(R.string.fui_error_password_missing_lowercase)
     override val passwordMissingDigit: String
-        get() = context.getString(R.string.fui_error_password_missing_digit)
+        get() = localizedContext.getString(R.string.fui_error_password_missing_digit)
     override val passwordMissingSpecialCharacter: String
-        get() = context.getString(R.string.fui_error_password_missing_special_character)
+        get() = localizedContext.getString(R.string.fui_error_password_missing_special_character)
 }

auth/src/main/res/values/strings.xml

@@ -94,6 +94,7 @@
     <string name="fui_error_invalid_password" translation_description="Error message for when the user enters an invalid or wrong password.">Incorrect password.</string>
 
     <!-- Password validation messages -->
+    <string name="fui_passwords_do_not_match" translation_description="Error message when password don't match">Passwords do not match</string>
     <string name="fui_error_password_too_short" translation_description="Error message when password is too short">Password must be at least %1$d characters long</string>
     <string name="fui_error_password_missing_uppercase" translation_description="Error message when password is missing uppercase letter">Password must contain at least one uppercase letter</string>
     <string name="fui_error_password_missing_lowercase" translation_description="Error message when password is missing lowercase letter">Password must contain at least one lowercase letter</string>