State management changes - MBway

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/ComponentFieldDelegateState.kt

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 14/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+data class ComponentFieldDelegateState<T>(
+    val value: T,
+    val validation: Validation? = null,
+    val hasFocus: Boolean = false,
+    val shouldHighlightValidationError: Boolean = false,
+)
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+fun <T> ComponentFieldDelegateState<T>.updateFieldState(
+    value: T? = null,
+    validation: Validation? = null,
+    hasFocus: Boolean? = null,
+    shouldHighlightValidationError: Boolean? = null,
+): ComponentFieldDelegateState<T> = copy(
+    value = value ?: this.value,
+    validation = validation ?: this.validation,
+    hasFocus = hasFocus ?: this.hasFocus,
+    shouldHighlightValidationError = shouldHighlightValidationError ?: this.shouldHighlightValidationError,
+)

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/ComponentFieldViewState.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 14/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model
+
+import androidx.annotation.RestrictTo
+import androidx.annotation.StringRes
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+data class ComponentFieldViewState<T>(
+    val value: T,
+    val hasFocus: Boolean = false,
+    @StringRes val errorMessageId: Int? = null,
+)

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/DefaultDelegateStateManager.kt

@@ -0,0 +1,98 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 6/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+import com.adyen.checkout.components.core.internal.ui.model.Validation
+import com.adyen.checkout.components.core.internal.ui.model.transformer.FieldTransformerRegistry
+import com.adyen.checkout.components.core.internal.ui.model.updateFieldState
+import com.adyen.checkout.components.core.internal.ui.model.validation.FieldValidatorRegistry
+import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
+import kotlinx.coroutines.flow.asStateFlow
+import kotlinx.coroutines.flow.update
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+class DefaultDelegateStateManager<S : DelegateState, FI>(
+    private val factory: DelegateStateFactory<S, FI>,
+    private val transformerRegistry: FieldTransformerRegistry<FI>,
+    private val validationRegistry: FieldValidatorRegistry<FI>,
+    private val stateUpdaterRegistry: StateUpdaterRegistry<FI, S>,
+) : DelegateStateManager<S, FI> {
+
+    private val _state = MutableStateFlow(factory.createDefaultDelegateState())
+    override val state: StateFlow<S> = _state.asStateFlow()
+
+    override val isValid
+        get() = run {
+            validateNonValidatedFields()
+            _state.value.isValid
+        }
+
+    private fun validateNonValidatedFields() {
+        factory.getFieldIds().forEach { fieldId ->
+            val fieldState = stateUpdaterRegistry.getFieldState<Any>(fieldId, _state.value)
+
+            if (fieldState.validation == null) {
+                updateField(
+                    fieldId = fieldId,
+                    value = fieldState.value, // Ensure the current value is validated
+                )
+            }
+        }
+    }
+
+    // A list can be added, which will show which other fields need to be validated or updated when a specific field is updated
+    override fun <T> updateField(
+        fieldId: FI,
+        value: T?,
+        hasFocus: Boolean?,
+        shouldHighlightValidationError: Boolean?,
+    ) {
+        val validation = value?.let {
+            validationRegistry.validate(
+                fieldId,
+                transformerRegistry.transform(fieldId, value),
+            )
+        }
+
+        val fieldState = stateUpdaterRegistry.getFieldState<T>(fieldId, _state.value)
+        val updatedFieldState = fieldState.updateFieldState(
+            value = value,
+            validation = validation,
+            hasFocus = hasFocus,
+            shouldHighlightValidationError = shouldHighlightValidationError,
+        )
+
+        _state.update {
+            stateUpdaterRegistry.updateFieldState(fieldId, _state.value, updatedFieldState)
+        }
+    }
+
+    override fun highlightAllFieldValidationErrors() {
+        // Flag to focus only the first invalid field
+        var isErrorFieldFocused = false
+
+        factory.getFieldIds().forEach { fieldId ->
+            val fieldState = stateUpdaterRegistry.getFieldState<Any>(fieldId, _state.value)
+
+            val shouldFocus = !isErrorFieldFocused && fieldState.validation is Validation.Invalid
+            if (shouldFocus) {
+                isErrorFieldFocused = true
+            }
+
+            updateField(
+                fieldId = fieldId,
+                value = fieldState.value, // Ensure the current value is validated
+                hasFocus = shouldFocus,
+                shouldHighlightValidationError = true,
+            )
+        }
+    }
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/DelegateState.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 6/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface DelegateState {
+    val isValid: Boolean
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/DelegateStateFactory.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 6/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface DelegateStateFactory<S, FI> {
+    fun createDefaultDelegateState(): S
+
+    fun getFieldIds(): List<FI>
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/DelegateStateManager.kt

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 4/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+import kotlinx.coroutines.flow.StateFlow
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface DelegateStateManager<S, FI> {
+
+    val state: StateFlow<S>
+
+    val isValid: Boolean
+
+    fun <T> updateField(
+        fieldId: FI,
+        value: T? = null,
+        hasFocus: Boolean? = null,
+        // Default value is false, to make sure that errors are cleared when field is updated
+        shouldHighlightValidationError: Boolean? = false,
+    )
+
+    fun highlightAllFieldValidationErrors()
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/StateUpdater.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 4/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface StateUpdater<S, FS> {
+    fun getFieldState(state: S): FS
+
+    fun updateFieldState(state: S, fieldState: FS): S
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/state/StateUpdaterRegistry.kt

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 4/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.state
+
+import androidx.annotation.RestrictTo
+import com.adyen.checkout.components.core.internal.ui.model.ComponentFieldDelegateState
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface StateUpdaterRegistry<K, S> {
+    fun <T> getFieldState(key: K, state: S): ComponentFieldDelegateState<T>
+
+    fun <T> updateFieldState(key: K, state: S, fieldState: ComponentFieldDelegateState<T>): S
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/transformer/DefaultTransformer.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 5/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.transformer
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+class DefaultTransformer : FieldTransformer<Any> {
+    override fun transform(value: Any) = value
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/transformer/FieldTransformer.kt

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 24/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.transformer
+
+import androidx.annotation.RestrictTo
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface FieldTransformer<T> {
+    fun transform(value: T): T
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/transformer/FieldTransformerRegistry.kt

@@ -0,0 +1,21 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 24/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.transformer
+
+import androidx.annotation.RestrictTo
+
+/**
+ * A [FieldTransformerRegistry] is being used to implement value transformation for fields. This is useful when the
+ * value should get transformed before validation is performed or before it is being processed further.
+ * State should hold the original value, while transformed value will be used for other operations.
+ */
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface FieldTransformerRegistry<K> {
+    fun <T> transform(key: K, value: T): T
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/validation/DefaultValidator.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 4/2/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.validation
+
+import androidx.annotation.RestrictTo
+import com.adyen.checkout.components.core.internal.ui.model.Validation
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+class DefaultValidator : FieldValidator<Any> {
+    override fun validate(input: Any) = Validation.Valid
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/validation/FieldValidator.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 15/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.validation
+
+import androidx.annotation.RestrictTo
+import com.adyen.checkout.components.core.internal.ui.model.Validation
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface FieldValidator<T> {
+    fun validate(input: T): Validation
+}

components-core/src/main/java/com/adyen/checkout/components/core/internal/ui/model/validation/FieldValidatorRegistry.kt

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) 2025 Adyen N.V.
+ *
+ * This file is open source and available under the MIT license. See the LICENSE file for more info.
+ *
+ * Created by ararat on 15/1/2025.
+ */
+
+package com.adyen.checkout.components.core.internal.ui.model.validation
+
+import androidx.annotation.RestrictTo
+import com.adyen.checkout.components.core.internal.ui.model.Validation
+
+@RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
+interface FieldValidatorRegistry<K> {
+    fun <T> validate(key: K, value: T): Validation
+}