Merge pull request #39 from Adyen/feature/adjustFieldVisiblity

Introduced FieldVisibility for kcp and social security number fields

android/src/main/kotlin/com/adyen/adyen_checkout/PlatformApi.kt

@@ -151,6 +151,17 @@ enum class DropInResultType(val raw: Int) {
   }
 }
 
+enum class FieldVisibility(val raw: Int) {
+  SHOW(0),
+  HIDE(1);
+
+  companion object {
+    fun ofRaw(raw: Int): FieldVisibility? {
+      return values().firstOrNull { it.raw == raw }
+    }
+  }
+}
+
 /** Generated class from Pigeon that represents data sent in messages. */
 data class SessionDTO (
   val id: String,
@@ -289,8 +300,8 @@ data class CardsConfigurationDTO (
   val showStorePaymentField: Boolean,
   val showCvcForStoredCard: Boolean,
   val showCvc: Boolean,
-  val showKcpField: Boolean,
-  val showSocialSecurityNumberField: Boolean,
+  val kcpFieldVisibility: FieldVisibility,
+  val socialSecurityNumberFieldVisibility: FieldVisibility,
   val supportedCardTypes: List<String?>
 
 ) {
@@ -302,10 +313,10 @@ data class CardsConfigurationDTO (
       val showStorePaymentField = list[2] as Boolean
       val showCvcForStoredCard = list[3] as Boolean
       val showCvc = list[4] as Boolean
-      val showKcpField = list[5] as Boolean
-      val showSocialSecurityNumberField = list[6] as Boolean
+      val kcpFieldVisibility = FieldVisibility.ofRaw(list[5] as Int)!!
+      val socialSecurityNumberFieldVisibility = FieldVisibility.ofRaw(list[6] as Int)!!
       val supportedCardTypes = list[7] as List<String?>
-      return CardsConfigurationDTO(holderNameRequired, addressMode, showStorePaymentField, showCvcForStoredCard, showCvc, showKcpField, showSocialSecurityNumberField, supportedCardTypes)
+      return CardsConfigurationDTO(holderNameRequired, addressMode, showStorePaymentField, showCvcForStoredCard, showCvc, kcpFieldVisibility, socialSecurityNumberFieldVisibility, supportedCardTypes)
     }
   }
   fun toList(): List<Any?> {
@@ -315,8 +326,8 @@ data class CardsConfigurationDTO (
       showStorePaymentField,
       showCvcForStoredCard,
       showCvc,
-      showKcpField,
-      showSocialSecurityNumberField,
+      kcpFieldVisibility.raw,
+      socialSecurityNumberFieldVisibility.raw,
       supportedCardTypes,
     )
   }

android/src/main/kotlin/com/adyen/adyen_checkout/utils/ConfigurationMapper.kt

@@ -7,6 +7,7 @@ import CashAppPayConfigurationDTO
 import CashAppPayEnvironment
 import DropInConfigurationDTO
 import Environment
+import FieldVisibility
 import GooglePayConfigurationDTO
 import GooglePayEnvironment
 import OrderResponseDTO
@@ -99,9 +100,9 @@ object ConfigurationMapper {
             .setShowStorePaymentField(cardsConfigurationDTO.showStorePaymentField)
             .setHideCvcStoredCard(!cardsConfigurationDTO.showCvcForStoredCard)
             .setHideCvc(!cardsConfigurationDTO.showCvc)
-            .setKcpAuthVisibility(determineKcpAuthVisibility(cardsConfigurationDTO.showKcpField))
+            .setKcpAuthVisibility(determineKcpAuthVisibility(cardsConfigurationDTO.kcpFieldVisibility))
             .setSocialSecurityNumberVisibility(
-                determineSocialSecurityNumberVisibility(cardsConfigurationDTO.showSocialSecurityNumberField)
+                determineSocialSecurityNumberVisibility(cardsConfigurationDTO.socialSecurityNumberFieldVisibility)
             )
             .setSupportedCardTypes(*mapToSupportedCardTypes(cardsConfigurationDTO.supportedCardTypes))
             .setHolderNameRequired(cardsConfigurationDTO.holderNameRequired)
@@ -142,17 +143,17 @@ object ConfigurationMapper {
         }
     }
 
-    private fun determineKcpAuthVisibility(visible: Boolean?): KCPAuthVisibility {
-        return when (visible) {
-            true -> KCPAuthVisibility.SHOW
-            else -> KCPAuthVisibility.HIDE
+    private fun determineKcpAuthVisibility(fieldVisibility: FieldVisibility): KCPAuthVisibility {
+        return when (fieldVisibility) {
+            FieldVisibility.SHOW -> KCPAuthVisibility.SHOW
+            FieldVisibility.HIDE -> KCPAuthVisibility.HIDE
         }
     }
 
-    private fun determineSocialSecurityNumberVisibility(visible: Boolean?): SocialSecurityNumberVisibility {
+    private fun determineSocialSecurityNumberVisibility(visible: FieldVisibility): SocialSecurityNumberVisibility {
         return when (visible) {
-            true -> SocialSecurityNumberVisibility.SHOW
-            else -> SocialSecurityNumberVisibility.HIDE
+            FieldVisibility.SHOW -> SocialSecurityNumberVisibility.SHOW
+            FieldVisibility.HIDE -> SocialSecurityNumberVisibility.HIDE
         }
     }
 

ios/Classes/PlatformApi.swift

@@ -93,6 +93,11 @@ enum DropInResultType: Int {
   case error = 2
 }
 
+enum FieldVisibility: Int {
+  case show = 0
+  case hide = 1
+}
+
 /// Generated class from Pigeon that represents data sent in messages.
 struct SessionDTO {
   var id: String
@@ -247,8 +252,8 @@ struct CardsConfigurationDTO {
   var showStorePaymentField: Bool
   var showCvcForStoredCard: Bool
   var showCvc: Bool
-  var showKcpField: Bool
-  var showSocialSecurityNumberField: Bool
+  var kcpFieldVisibility: FieldVisibility
+  var socialSecurityNumberFieldVisibility: FieldVisibility
   var supportedCardTypes: [String?]
 
   static func fromList(_ list: [Any?]) -> CardsConfigurationDTO? {
@@ -257,8 +262,8 @@ struct CardsConfigurationDTO {
     let showStorePaymentField = list[2] as! Bool
     let showCvcForStoredCard = list[3] as! Bool
     let showCvc = list[4] as! Bool
-    let showKcpField = list[5] as! Bool
-    let showSocialSecurityNumberField = list[6] as! Bool
+    let kcpFieldVisibility = FieldVisibility(rawValue: list[5] as! Int)!
+    let socialSecurityNumberFieldVisibility = FieldVisibility(rawValue: list[6] as! Int)!
     let supportedCardTypes = list[7] as! [String?]
 
     return CardsConfigurationDTO(
@@ -267,8 +272,8 @@ struct CardsConfigurationDTO {
       showStorePaymentField: showStorePaymentField,
       showCvcForStoredCard: showCvcForStoredCard,
       showCvc: showCvc,
-      showKcpField: showKcpField,
-      showSocialSecurityNumberField: showSocialSecurityNumberField,
+      kcpFieldVisibility: kcpFieldVisibility,
+      socialSecurityNumberFieldVisibility: socialSecurityNumberFieldVisibility,
       supportedCardTypes: supportedCardTypes
     )
   }
@@ -279,8 +284,8 @@ struct CardsConfigurationDTO {
       showStorePaymentField,
       showCvcForStoredCard,
       showCvc,
-      showKcpField,
-      showSocialSecurityNumberField,
+      kcpFieldVisibility.rawValue,
+      socialSecurityNumberFieldVisibility.rawValue,
       supportedCardTypes,
     ]
   }

ios/Classes/utils/ConfigurationMapper.swift

@@ -11,8 +11,8 @@ class ConfigurationMapper {
         dropInConfiguration.paymentMethodsList.allowDisablingStoredPaymentMethods = dropInConfigurationDTO.isRemoveStoredPaymentMethodEnabled
 
         if let cardsConfigurationDTO = dropInConfigurationDTO.cardsConfigurationDTO {
-            let koreanAuthenticationMode = determineFieldVisibility(visible: cardsConfigurationDTO.showKcpField)
-            let socialSecurityNumberMode = determineFieldVisibility(visible: cardsConfigurationDTO.showSocialSecurityNumberField)
+            let koreanAuthenticationMode = cardsConfigurationDTO.kcpFieldVisibility.toCardFieldVisibility()
+            let socialSecurityNumberMode = cardsConfigurationDTO.socialSecurityNumberFieldVisibility.toCardFieldVisibility()
             let storedCardConfiguration = createStoredCardConfiguration(showCvcForStoredCard: cardsConfigurationDTO.showCvcForStoredCard)
             let allowedCardTypes = determineAllowedCardTypes(cardTypes: cardsConfigurationDTO.supportedCardTypes)
             let billingAddressConfiguration = determineBillingAddressConfiguration(addressMode: cardsConfigurationDTO.addressMode)
@@ -42,11 +42,7 @@ class ConfigurationMapper {
         return dropInConfiguration
     }
 
-    private func determineFieldVisibility(visible: Bool) -> CardComponent.FieldVisibility {
-        return visible ? .show : .hide
-    }
-
-    private func createStoredCardConfiguration(showCvcForStoredCard: Bool) -> StoredCardConfiguration {
+    private func createStoredCardConfiguration(showCvcForStoredCard: Bool?) -> StoredCardConfiguration {
         var storedCardConfiguration = StoredCardConfiguration()
         storedCardConfiguration.showsSecurityCodeField = showCvcForStoredCard
         return storedCardConfiguration;
@@ -94,3 +90,16 @@ class ConfigurationMapper {
                                                     merchantIdentifier: applePayConfigurationDTO.merchantId)
     }
 }
+
+
+extension FieldVisibility {
+
+    func toCardFieldVisibility() -> CardComponent.FieldVisibility {
+        switch self {
+        case .show:
+            return .show
+        case .hide:
+            return .hide
+        }
+    }
+}

lib/adyen_checkout.dart

@@ -3,6 +3,7 @@ export 'src/generated/platform_api.g.dart'
     show
         Environment,
         AddressMode,
+        FieldVisibility,
         CardAuthMethod,
         TotalPriceStatus,
         PaymentResultEnum,

lib/src/generated/platform_api.g.dart

@@ -63,6 +63,11 @@ enum DropInResultType {
   error,
 }
 
+enum FieldVisibility {
+  show,
+  hide,
+}
+
 class SessionDTO {
   SessionDTO({
     required this.id,
@@ -239,8 +244,8 @@ class CardsConfigurationDTO {
     required this.showStorePaymentField,
     required this.showCvcForStoredCard,
     required this.showCvc,
-    required this.showKcpField,
-    required this.showSocialSecurityNumberField,
+    required this.kcpFieldVisibility,
+    required this.socialSecurityNumberFieldVisibility,
     required this.supportedCardTypes,
   });
 
@@ -254,9 +259,9 @@ class CardsConfigurationDTO {
 
   bool showCvc;
 
-  bool showKcpField;
+  FieldVisibility kcpFieldVisibility;
 
-  bool showSocialSecurityNumberField;
+  FieldVisibility socialSecurityNumberFieldVisibility;
 
   List<String?> supportedCardTypes;
 
@@ -267,8 +272,8 @@ class CardsConfigurationDTO {
       showStorePaymentField,
       showCvcForStoredCard,
       showCvc,
-      showKcpField,
-      showSocialSecurityNumberField,
+      kcpFieldVisibility.index,
+      socialSecurityNumberFieldVisibility.index,
       supportedCardTypes,
     ];
   }
@@ -281,8 +286,8 @@ class CardsConfigurationDTO {
       showStorePaymentField: result[2]! as bool,
       showCvcForStoredCard: result[3]! as bool,
       showCvc: result[4]! as bool,
-      showKcpField: result[5]! as bool,
-      showSocialSecurityNumberField: result[6]! as bool,
+      kcpFieldVisibility: FieldVisibility.values[result[5]! as int],
+      socialSecurityNumberFieldVisibility: FieldVisibility.values[result[6]! as int],
       supportedCardTypes: (result[7] as List<Object?>?)!.cast<String?>(),
     );
   }

lib/src/models/payment_method_configurations/cards_configuration.dart

@@ -7,17 +7,18 @@ class CardsConfiguration extends CardsConfigurationDTO {
     bool showStorePaymentField = false,
     bool showCvcForStoredCard = false,
     bool showCvc = true,
-    bool showKcpField = false,
-    bool showSocialSecurityNumberField = false,
+    FieldVisibility kcpFieldVisibility = FieldVisibility.hide,
+    FieldVisibility socialSecurityNumberFieldVisibility = FieldVisibility.hide,
     List<String?> supportedCardTypes = const [],
   }) : super(
           holderNameRequired: holderNameRequired,
           addressMode: addressMode,
           showStorePaymentField: showStorePaymentField,
           showCvcForStoredCard: showCvcForStoredCard,
           showCvc: showCvc,
-          showKcpField: showKcpField,
-          showSocialSecurityNumberField: showSocialSecurityNumberField,
+          kcpFieldVisibility: kcpFieldVisibility,
+          socialSecurityNumberFieldVisibility:
+              socialSecurityNumberFieldVisibility,
           supportedCardTypes: supportedCardTypes,
         );
 }

lib/src/utils/dto_mapper.dart

@@ -16,8 +16,9 @@ extension CardsConfigurationMapper on CardsConfiguration {
         showStorePaymentField: showStorePaymentField,
         showCvcForStoredCard: showCvcForStoredCard,
         showCvc: showCvc,
-        showKcpField: showKcpField,
-        showSocialSecurityNumberField: showSocialSecurityNumberField,
+        kcpFieldVisibility: kcpFieldVisibility,
+        socialSecurityNumberFieldVisibility:
+            socialSecurityNumberFieldVisibility,
         supportedCardTypes: supportedCardTypes,
       );
 }
@@ -99,8 +100,8 @@ extension CardsConfigurationDTOCopy on CardsConfigurationDTO {
     bool? showStorePaymentField,
     bool? showCvcForStoredCard,
     bool? showCvc,
-    bool? showKcpField,
-    bool? showSocialSecurityNumberField,
+    FieldVisibility? kcpFieldVisibility,
+    FieldVisibility? socialSecurityNumberFieldVisibility,
     List<String?>? supportedCardTypes,
   }) =>
       CardsConfigurationDTO(
@@ -110,9 +111,10 @@ extension CardsConfigurationDTOCopy on CardsConfigurationDTO {
             showStorePaymentField ?? this.showStorePaymentField,
         showCvcForStoredCard: showCvcForStoredCard ?? this.showCvcForStoredCard,
         showCvc: showCvc ?? this.showCvc,
-        showKcpField: showKcpField ?? this.showKcpField,
-        showSocialSecurityNumberField:
-            showSocialSecurityNumberField ?? this.showSocialSecurityNumberField,
+        kcpFieldVisibility: kcpFieldVisibility ?? this.kcpFieldVisibility,
+        socialSecurityNumberFieldVisibility:
+            socialSecurityNumberFieldVisibility ??
+                this.socialSecurityNumberFieldVisibility,
         supportedCardTypes: supportedCardTypes ?? this.supportedCardTypes,
       );
 }

pigeons/platform_api.dart

@@ -65,6 +65,11 @@ enum DropInResultType {
   error,
 }
 
+enum FieldVisibility {
+  show,
+  hide,
+}
+
 class SessionDTO {
   final String id;
   final String sessionData;
@@ -133,8 +138,8 @@ class CardsConfigurationDTO {
   final bool showStorePaymentField;
   final bool showCvcForStoredCard;
   final bool showCvc;
-  final bool showKcpField;
-  final bool showSocialSecurityNumberField;
+  final FieldVisibility kcpFieldVisibility;
+  final FieldVisibility socialSecurityNumberFieldVisibility;
   final List<String?> supportedCardTypes;
 
   CardsConfigurationDTO(
@@ -143,8 +148,8 @@ class CardsConfigurationDTO {
     this.showStorePaymentField,
     this.showCvcForStoredCard,
     this.showCvc,
-    this.showKcpField,
-    this.showSocialSecurityNumberField,
+    this.kcpFieldVisibility,
+    this.socialSecurityNumberFieldVisibility,
     this.supportedCardTypes,
   );
 }