feat(core): implement NameType for name validation

crates/api_models/Cargo.toml

@@ -47,6 +47,7 @@ common_utils = { version = "0.1.0", path = "../common_utils" }
 euclid = { version = "0.1.0", path = "../euclid" }
 masking = { version = "0.1.0", path = "../masking", default-features = false, features = ["alloc", "serde"] }
 router_derive = { version = "0.1.0", path = "../router_derive" }
+router_env = { version = "0.1.0", path = "../router_env", features = ["log_extra_implicit_fields", "log_custom_entries_to_extra"] }
 
 [lints]
 workspace = true

crates/api_models/src/customers.rs

@@ -18,7 +18,7 @@ pub struct CustomerRequest {
     pub merchant_id: id_type::MerchantId,
     /// The customer's name
     #[schema(max_length = 255, value_type = Option<String>, example = "Jon Test")]
-    pub name: Option<Secret<String>>,
+    pub name: Option<common_utils::types::NameType>,
     /// The customer's email address
     #[schema(value_type = Option<String>, max_length = 255, example = "[email protected]")]
     pub email: Option<pii::Email>,

crates/api_models/src/mandates.rs

@@ -57,7 +57,7 @@ pub struct MandateCardDetails {
     pub card_exp_year: Option<Secret<String>>,
     /// The card holder name
     #[schema(value_type = Option<String>)]
-    pub card_holder_name: Option<Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
     /// The token from card locker
     #[schema(value_type = Option<String>)]
     pub card_token: Option<Secret<String>>,
@@ -79,7 +79,7 @@ pub struct MandateCardDetails {
     pub card_type: Option<String>,
     /// The nick_name of the card holder
     #[schema(value_type = Option<String>)]
-    pub nick_name: Option<Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 }
 
 #[derive(Clone, Debug, Deserialize, ToSchema, Serialize)]
@@ -151,7 +151,7 @@ pub struct NetworkTransactionIdAndCardDetails {
 
     /// The card holder's name
     #[schema(value_type = String, example = "John Test")]
-    pub card_holder_name: Option<Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// The name of the issuer of card
     #[schema(example = "chase")]
@@ -172,7 +172,7 @@ pub struct NetworkTransactionIdAndCardDetails {
 
     /// The card holder's nick name
     #[schema(value_type = Option<String>, example = "John Test")]
-    pub nick_name: Option<Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     /// The network transaction ID provided by the card network during a CIT (Customer Initiated Transaction),
     /// where `setup_future_usage` is set to `off_session`.

crates/api_models/src/payment_methods.rs

@@ -525,11 +525,11 @@ pub struct CardDetail {
 
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     /// Card Issuing Country
     pub card_issuing_country: Option<String>,
@@ -573,11 +573,11 @@ pub struct CardDetail {
 
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     /// Card Issuing Country
     #[schema(value_type = CountryAlpha2)]
@@ -611,11 +611,11 @@ pub struct MigrateCardDetail {
 
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     /// Card Issuing Country
     pub card_issuing_country: Option<String>,
@@ -648,11 +648,11 @@ pub struct MigrateNetworkTokenData {
 
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     /// Card Issuing Country
     pub card_issuing_country: Option<String>,
@@ -695,11 +695,11 @@ pub struct CardDetailUpdate {
 
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 }
 
 #[cfg(all(
@@ -722,10 +722,7 @@ impl CardDetailUpdate {
                 .card_holder_name
                 .clone()
                 .or(card_data_from_locker.name_on_card),
-            nick_name: self
-                .nick_name
-                .clone()
-                .or(card_data_from_locker.nick_name.map(masking::Secret::new)),
+            nick_name: self.nick_name.clone().or(card_data_from_locker.nick_name),
             card_issuing_country: None,
             card_network: None,
             card_issuer: None,
@@ -740,11 +737,11 @@ impl CardDetailUpdate {
 pub struct CardDetailUpdate {
     /// Card Holder Name
     #[schema(value_type = String,example = "John Doe")]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     /// Card Holder's Nick Name
     #[schema(value_type = Option<String>,example = "John Doe")]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 }
 
 #[cfg(all(feature = "v2", feature = "payment_methods_v2"))]
@@ -758,10 +755,7 @@ impl CardDetailUpdate {
                 .card_holder_name
                 .clone()
                 .or(card_data_from_locker.name_on_card),
-            nick_name: self
-                .nick_name
-                .clone()
-                .or(card_data_from_locker.nick_name.map(masking::Secret::new)),
+            nick_name: self.nick_name.clone().or(card_data_from_locker.nick_name),
             card_issuing_country: None,
             card_network: None,
             card_issuer: None,
@@ -901,8 +895,8 @@ pub struct CardDetailsPaymentMethod {
     pub issuer_country: Option<String>,
     pub expiry_month: Option<masking::Secret<String>>,
     pub expiry_year: Option<masking::Secret<String>>,
-    pub nick_name: Option<masking::Secret<String>>,
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
     pub card_isin: Option<String>,
     pub card_issuer: Option<String>,
     pub card_network: Option<api_enums::CardNetwork>,
@@ -975,12 +969,12 @@ pub enum BankAccountAccessCreds {
 #[derive(Debug, serde::Deserialize, serde::Serialize, Clone)]
 pub struct Card {
     pub card_number: CardNumber,
-    pub name_on_card: Option<masking::Secret<String>>,
+    pub name_on_card: Option<common_utils::types::NameType>,
     pub card_exp_month: masking::Secret<String>,
     pub card_exp_year: masking::Secret<String>,
     pub card_brand: Option<String>,
     pub card_isin: Option<String>,
-    pub nick_name: Option<String>,
+    pub nick_name: Option<common_utils::types::NameType>,
 }
 
 #[cfg(all(
@@ -1006,13 +1000,13 @@ pub struct CardDetailFromLocker {
     pub card_token: Option<masking::Secret<String>>,
 
     #[schema(value_type=Option<String>)]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     #[schema(value_type=Option<String>)]
     pub card_fingerprint: Option<masking::Secret<String>>,
 
     #[schema(value_type=Option<String>)]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     #[schema(value_type = Option<CardNetwork>)]
     pub card_network: Option<api_enums::CardNetwork>,
@@ -1040,13 +1034,13 @@ pub struct CardDetailFromLocker {
     pub expiry_year: Option<masking::Secret<String>>,
 
     #[schema(value_type=Option<String>)]
-    pub card_holder_name: Option<masking::Secret<String>>,
+    pub card_holder_name: Option<common_utils::types::NameType>,
 
     #[schema(value_type=Option<String>)]
     pub card_fingerprint: Option<masking::Secret<String>>,
 
     #[schema(value_type=Option<String>)]
-    pub nick_name: Option<masking::Secret<String>>,
+    pub nick_name: Option<common_utils::types::NameType>,
 
     #[schema(value_type = Option<CardNetwork>)]
     pub card_network: Option<api_enums::CardNetwork>,
@@ -2171,8 +2165,8 @@ pub struct TokenizedCardValue1 {
     pub card_number: String,
     pub exp_year: String,
     pub exp_month: String,
-    pub name_on_card: Option<String>,
-    pub nickname: Option<String>,
+    pub name_on_card: Option<common_utils::types::NameType>,
+    pub nickname: Option<common_utils::types::NameType>,
     pub card_last_four: Option<String>,
     pub card_token: Option<String>,
 }
@@ -2240,14 +2234,14 @@ pub struct TokenizedBankRedirectValue2 {
 #[derive(Debug, Clone, serde::Deserialize, serde::Serialize)]
 pub struct PaymentMethodRecord {
     pub customer_id: id_type::CustomerId,
-    pub name: Option<masking::Secret<String>>,
+    pub name: Option<common_utils::types::NameType>,
     pub email: Option<pii::Email>,
     pub phone: Option<masking::Secret<String>>,
     pub phone_country_code: Option<String>,
     pub merchant_id: Option<id_type::MerchantId>,
     pub payment_method: Option<api_enums::PaymentMethod>,
     pub payment_method_type: Option<api_enums::PaymentMethodType>,
-    pub nick_name: masking::Secret<String>,
+    pub nick_name: common_utils::types::NameType,
     pub payment_instrument_id: Option<masking::Secret<String>>,
     pub card_number_masked: masking::Secret<String>,
     pub card_expiry_month: masking::Secret<String>,
@@ -2256,8 +2250,8 @@ pub struct PaymentMethodRecord {
     pub original_transaction_id: Option<String>,
     pub billing_address_zip: masking::Secret<String>,
     pub billing_address_state: masking::Secret<String>,
-    pub billing_address_first_name: masking::Secret<String>,
-    pub billing_address_last_name: masking::Secret<String>,
+    pub billing_address_first_name: common_utils::types::NameType,
+    pub billing_address_last_name: common_utils::types::NameType,
     pub billing_address_city: String,
     pub billing_address_country: Option<api_enums::CountryAlpha2>,
     pub billing_address_line1: masking::Secret<String>,