refactor: changes in API design docs

demolaf · demolaf · commit 19787dfee18a · 2025-09-18T09:58:15.000+01:00
replaced sealed with abstract class, data with regular class

use isXX prefix for booleans
diff --git a/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthProvider.kt b/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthProvider.kt
@@ -16,7 +16,6 @@ package com.firebase.ui.auth.compose.configuration
 
 import android.graphics.Color
 import androidx.compose.ui.graphics.vector.ImageVector
-import com.firebase.ui.auth.util.data.ProviderAvailability
 import com.google.firebase.auth.ActionCodeSettings
 import com.google.firebase.auth.EmailAuthProvider
 import com.google.firebase.auth.FacebookAuthProvider
@@ -53,7 +52,7 @@ internal enum class Provider(val id: String) {
 }
 
 /**
- * Base class for OAuth authentication providers with common properties.
+ * Base abstract class for OAuth authentication providers with common properties.
  */
 abstract class OAuthProvider(
     override val providerId: String,
@@ -62,22 +61,22 @@ abstract class OAuthProvider(
 ) : AuthProvider(providerId)
 
 /**
- * Base sealed class for authentication providers.
+ * Base abstract class for authentication providers.
  */
-sealed class AuthProvider(open val providerId: String) {
+abstract class AuthProvider(open val providerId: String) {
     /**
      * Email/Password authentication provider configuration.
      */
-    data class Email(
+    class Email(
         /**
          * Requires the user to provide a display name. Defaults to true.
          */
-        val requireDisplayName: Boolean = true,
+        val isDisplayNameRequired: Boolean = true,
 
         /**
          * Enables email link sign-in, Defaults to false.
          */
-        val enableEmailLinkSignIn: Boolean = false,
+        val isEmailLinkSignInEnabled: Boolean = false,
 
         /**
          * Settings for email link actions.
@@ -87,7 +86,7 @@ sealed class AuthProvider(open val providerId: String) {
         /**
          * Allows new accounts to be created. Defaults to true.
          */
-        val allowNewAccounts: Boolean = true,
+        val isNewAccountsAllowed: Boolean = true,
 
         /**
          * The minimum length for a password. Defaults to 6.
@@ -100,7 +99,7 @@ sealed class AuthProvider(open val providerId: String) {
         val passwordValidationRules: List<PasswordRule>
     ) : AuthProvider(providerId = Provider.EMAIL.id) {
         fun validate() {
-            if (enableEmailLinkSignIn) {
+            if (isEmailLinkSignInEnabled) {
                 val actionCodeSettings = actionCodeSettings
                     ?: requireNotNull(actionCodeSettings) {
                         "ActionCodeSettings cannot be null when using " +
@@ -118,7 +117,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Phone number authentication provider configuration.
      */
-    data class Phone(
+    class Phone(
         /**
          * The default country code to pre-select.
          */
@@ -142,18 +141,18 @@ sealed class AuthProvider(open val providerId: String) {
         /**
          * Enables instant verification of the phone number. Defaults to true.
          */
-        val enableInstantVerification: Boolean = true,
+        val isInstantVerificationEnabled: Boolean = true,
 
         /**
          * Enables automatic retrieval of the SMS code. Defaults to true.
          */
-        val enableAutoRetrieval: Boolean = true
+        val isAutoRetrievalEnabled: Boolean = true
     ) : AuthProvider(providerId = Provider.PHONE.id)
 
     /**
      * Google Sign-In provider configuration.
      */
-    data class Google(
+    class Google(
         /**
          * The list of scopes to request.
          */
@@ -192,7 +191,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Facebook Login provider configuration.
      */
-    data class Facebook(
+    class Facebook(
         /**
          * The list of scopes (permissions) to request. Defaults to email and public_profile.
          */
@@ -216,7 +215,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Twitter/X authentication provider configuration.
      */
-    data class Twitter(
+    class Twitter(
         /**
          * A map of custom OAuth parameters.
          */
@@ -229,7 +228,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Github authentication provider configuration.
      */
-    data class Github(
+    class Github(
         /**
          * The list of scopes to request. Defaults to user:email.
          */
@@ -248,7 +247,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Microsoft authentication provider configuration.
      */
-    data class Microsoft(
+    class Microsoft(
         /**
          * The list of scopes to request. Defaults to openid, profile, email.
          */
@@ -272,7 +271,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Yahoo authentication provider configuration.
      */
-    data class Yahoo(
+    class Yahoo(
         /**
          * The list of scopes to request. Defaults to openid, profile, email.
          */
@@ -291,7 +290,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * Apple Sign-In provider configuration.
      */
-    data class Apple(
+    class Apple(
         /**
          * The list of scopes to request. Defaults to name and email.
          */
@@ -320,7 +319,7 @@ sealed class AuthProvider(open val providerId: String) {
     /**
      * A generic OAuth provider for any unsupported provider.
      */
-    data class GenericOAuth(
+    class GenericOAuth(
         /**
          * The provider ID as configured in the Firebase console.
          */
diff --git a/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUIConfiguration.kt b/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUIConfiguration.kt
@@ -37,16 +37,16 @@ class AuthUIConfigurationBuilder {
     var theme: AuthUITheme = AuthUITheme.Default
     var stringProvider: AuthUIStringProvider? = null
     var locale: Locale? = null
-    var enableCredentialManager: Boolean = true
-    var enableMfa: Boolean = true
-    var enableAnonymousUpgrade: Boolean = false
+    var isCredentialManagerEnabled: Boolean = true
+    var isMfaEnabled: Boolean = true
+    var isAnonymousUpgradeEnabled: Boolean = false
     var tosUrl: String? = null
     var privacyPolicyUrl: String? = null
     var logo: ImageVector? = null
     var actionCodeSettings: ActionCodeSettings? = null
-    var allowNewEmailAccounts: Boolean = true
-    var requireDisplayName: Boolean = true
-    var alwaysShowProviderChoice: Boolean = false
+    var isNewEmailAccountsAllowed: Boolean = true
+    var isDisplayNameRequired: Boolean = true
+    var isProviderChoiceAlwaysShown: Boolean = false
 
     fun providers(block: AuthProvidersBuilder.() -> Unit) {
         val builder = AuthProvidersBuilder()
@@ -61,16 +61,16 @@ class AuthUIConfigurationBuilder {
             theme = theme,
             stringProvider = stringProvider,
             locale = locale,
-            enableCredentialManager = enableCredentialManager,
-            enableMfa = enableMfa,
-            enableAnonymousUpgrade = enableAnonymousUpgrade,
+            isCredentialManagerEnabled = isCredentialManagerEnabled,
+            isMfaEnabled = isMfaEnabled,
+            isAnonymousUpgradeEnabled = isAnonymousUpgradeEnabled,
             tosUrl = tosUrl,
             privacyPolicyUrl = privacyPolicyUrl,
             logo = logo,
             actionCodeSettings = actionCodeSettings,
-            allowNewEmailAccounts = allowNewEmailAccounts,
-            requireDisplayName = requireDisplayName,
-            alwaysShowProviderChoice = alwaysShowProviderChoice
+            isNewEmailAccountsAllowed = isNewEmailAccountsAllowed,
+            isDisplayNameRequired = isDisplayNameRequired,
+            isProviderChoiceAlwaysShown = isProviderChoiceAlwaysShown
         )
     }
 
@@ -119,7 +119,7 @@ class AuthUIConfigurationBuilder {
 /**
  * Configuration object for the authentication flow.
  */
-data class AuthUIConfiguration(
+class AuthUIConfiguration(
     /**
      * The list of enabled authentication providers.
      */
@@ -143,17 +143,17 @@ data class AuthUIConfiguration(
     /**
      * Enables integration with Android's Credential Manager API. Defaults to true.
      */
-    val enableCredentialManager: Boolean = true,
+    val isCredentialManagerEnabled: Boolean = true,
 
     /**
      * Enables Multi-Factor Authentication support. Defaults to true.
      */
-    val enableMfa: Boolean = true,
+    val isMfaEnabled: Boolean = true,
 
     /**
      * Allows upgrading an anonymous user to a new credential.
      */
-    val enableAnonymousUpgrade: Boolean = false,
+    val isAnonymousUpgradeEnabled: Boolean = false,
 
     /**
      * The URL for the terms of service.
@@ -178,15 +178,15 @@ data class AuthUIConfiguration(
     /**
      * Allows new email accounts to be created. Defaults to true.
      */
-    val allowNewEmailAccounts: Boolean = true,
+    val isNewEmailAccountsAllowed: Boolean = true,
 
     /**
      * Requires the user to provide a display name on sign-up. Defaults to true.
      */
-    val requireDisplayName: Boolean = true,
+    val isDisplayNameRequired: Boolean = true,
 
     /**
      * Always shows the provider selection screen, even if only one is enabled.
      */
-    val alwaysShowProviderChoice: Boolean = false,
+    val isProviderChoiceAlwaysShown: Boolean = false,
 )
diff --git a/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUITheme.kt b/auth/src/main/java/com/firebase/ui/auth/compose/configuration/AuthUITheme.kt
@@ -33,7 +33,7 @@ private val LocalAuthUITheme = staticCompositionLocalOf { AuthUITheme.Default }
 /**
  * Theming configuration for the entire Auth UI.
  */
-data class AuthUITheme(
+class AuthUITheme(
     /**
      * The color scheme to use.
      */
@@ -56,10 +56,10 @@ data class AuthUITheme(
 ) {
 
     /**
-     * A data class nested within AuthUITheme that defines the visual appearance of a specific
+     * A class nested within AuthUITheme that defines the visual appearance of a specific
      * provider button, allowing for per-provider branding and customization.
      */
-    data class ProviderStyle(
+    class ProviderStyle(
         /**
          * The background color of the button.
          */
diff --git a/auth/src/main/java/com/firebase/ui/auth/compose/configuration/PasswordRule.kt b/auth/src/main/java/com/firebase/ui/auth/compose/configuration/PasswordRule.kt
@@ -15,14 +15,14 @@
 package com.firebase.ui.auth.compose.configuration
 
 /**
- * A sealed class representing a set of validation rules that can be applied to a password field,
+ * An abstract class representing a set of validation rules that can be applied to a password field,
  * typically within the [AuthProvider.Email] configuration.
  */
-sealed class PasswordRule {
+abstract class PasswordRule {
     /**
      * Requires the password to have at least a certain number of characters.
      */
-    data class MinimumLength(val value: Int) : PasswordRule()
+    class MinimumLength(val value: Int) : PasswordRule()
 
     /**
      * Requires the password to contain at least one uppercase letter (A-Z).
@@ -48,5 +48,5 @@ sealed class PasswordRule {
      * Defines a custom validation rule using a regular expression and provides a specific error
      * message on failure.
      */
-    data class Custom(val regex: Regex, val errorMessage: String)
+    class Custom(val regex: Regex, val errorMessage: String)
 }
diff --git a/auth/src/test/java/com/firebase/ui/auth/compose/configuration/AuthUIConfigurationTest.kt b/auth/src/test/java/com/firebase/ui/auth/compose/configuration/AuthUIConfigurationTest.kt
@@ -43,16 +43,16 @@ class AuthUIConfigurationTest {
         assertThat(config.theme).isEqualTo(AuthUITheme.Default)
         assertThat(config.stringProvider).isNull()
         assertThat(config.locale).isNull()
-        assertThat(config.enableCredentialManager).isTrue()
-        assertThat(config.enableMfa).isTrue()
-        assertThat(config.enableAnonymousUpgrade).isFalse()
+        assertThat(config.isCredentialManagerEnabled).isTrue()
+        assertThat(config.isMfaEnabled).isTrue()
+        assertThat(config.isAnonymousUpgradeEnabled).isFalse()
         assertThat(config.tosUrl).isNull()
         assertThat(config.privacyPolicyUrl).isNull()
         assertThat(config.logo).isNull()
         assertThat(config.actionCodeSettings).isNull()
-        assertThat(config.allowNewEmailAccounts).isTrue()
-        assertThat(config.requireDisplayName).isTrue()
-        assertThat(config.alwaysShowProviderChoice).isFalse()
+        assertThat(config.isNewEmailAccountsAllowed).isTrue()
+        assertThat(config.isDisplayNameRequired).isTrue()
+        assertThat(config.isProviderChoiceAlwaysShown).isFalse()
     }
 
     @Test
@@ -87,32 +87,32 @@ class AuthUIConfigurationTest {
             theme = customTheme
             stringProvider = customStringProvider
             locale = customLocale
-            enableCredentialManager = false
-            enableMfa = false
-            enableAnonymousUpgrade = true
+            isCredentialManagerEnabled = false
+            isMfaEnabled = false
+            isAnonymousUpgradeEnabled = true
             tosUrl = "https://example.com/tos"
             privacyPolicyUrl = "https://example.com/privacy"
             logo = Icons.Default.AccountCircle
             actionCodeSettings = customActionCodeSettings
-            allowNewEmailAccounts = false
-            requireDisplayName = false
-            alwaysShowProviderChoice = true
+            isNewEmailAccountsAllowed = false
+            isDisplayNameRequired = false
+            isProviderChoiceAlwaysShown = true
         }
 
         assertThat(config.providers).hasSize(2)
         assertThat(config.theme).isEqualTo(customTheme)
         assertThat(config.stringProvider).isEqualTo(customStringProvider)
         assertThat(config.locale).isEqualTo(customLocale)
-        assertThat(config.enableCredentialManager).isFalse()
-        assertThat(config.enableMfa).isFalse()
-        assertThat(config.enableAnonymousUpgrade).isTrue()
+        assertThat(config.isCredentialManagerEnabled).isFalse()
+        assertThat(config.isMfaEnabled).isFalse()
+        assertThat(config.isAnonymousUpgradeEnabled).isTrue()
         assertThat(config.tosUrl).isEqualTo("https://example.com/tos")
         assertThat(config.privacyPolicyUrl).isEqualTo("https://example.com/privacy")
         assertThat(config.logo).isEqualTo(Icons.Default.AccountCircle)
         assertThat(config.actionCodeSettings).isEqualTo(customActionCodeSettings)
-        assertThat(config.allowNewEmailAccounts).isFalse()
-        assertThat(config.requireDisplayName).isFalse()
-        assertThat(config.alwaysShowProviderChoice).isTrue()
+        assertThat(config.isNewEmailAccountsAllowed).isFalse()
+        assertThat(config.isDisplayNameRequired).isFalse()
+        assertThat(config.isProviderChoiceAlwaysShown).isTrue()
     }
 
     // ===========================================================================================
@@ -184,7 +184,7 @@ class AuthUIConfigurationTest {
         authUIConfiguration {
             providers {
                 provider(AuthProvider.Email(
-                    enableEmailLinkSignIn = true,
+                    isEmailLinkSignInEnabled = true,
                     actionCodeSettings = null,
                     passwordValidationRules = listOf()
                 ))
@@ -201,7 +201,7 @@ class AuthUIConfigurationTest {
         authUIConfiguration {
             providers {
                 provider(AuthProvider.Email(
-                    enableEmailLinkSignIn = true,
+                    isEmailLinkSignInEnabled = true,
                     actionCodeSettings = customActionCodeSettings,
                     passwordValidationRules = listOf()
                 ))
@@ -232,9 +232,7 @@ class AuthUIConfigurationTest {
                     )
                 )
             }
-
-            enableCredentialManager = true
-            enableCredentialManager = false
+            isCredentialManagerEnabled = true
         }
 
         assertThat(config.providers).hasSize(2)
