new TwintSDK integration

.github/workflows/test-SPM-integration.yml

@@ -11,7 +11,7 @@ on:
 jobs:
 
   SPM:
-    runs-on: macos-13
+    runs-on: macos-13-xlarge # Apple Silicon Runner
     steps:
     - uses: actions/checkout@v4
     - uses: n1hility/cancel-previous-runs@v3

.github/workflows/test-carthage-integration.yml

@@ -11,7 +11,7 @@ on:
 jobs:
 
   carthage:
-    runs-on: macos-12-xl
+    runs-on: macos-13-xlarge # Apple Silicon Runner
     steps:
     - uses: actions/checkout@v4
     - uses: n1hility/cancel-previous-runs@v3

Adyen.podspec

@@ -41,6 +41,13 @@ Pod::Spec.new do |s|
     plugin.dependency 'CashAppPayKitUI', '0.5.1'
   end
 
+  s.subspec 'AdyenTwint' do |plugin|
+    plugin.source_files = 'AdyenTwint/**/*.swift'
+    plugin.dependency 'Adyen/Core'
+    plugin.dependency 'Adyen/Actions'
+    plugin.vendored_frameworks = 'XCFramework/Dynamic/TwintSDK.xcframework'
+  end
+
   s.subspec 'Card' do |plugin|
     plugin.dependency 'Adyen/Core'
     plugin.dependency 'Adyen/Encryption'

Adyen/Core/Components/Base/PresentableComponentWrapper.swift

@@ -24,7 +24,7 @@ public final class PresentableComponentWrapper: PresentableComponent,
     /// The wrapped component.
     public let component: Component
 
-    public let requiresModalPresentation: Bool = true
+    public var requiresModalPresentation: Bool = true
 
     @_spi(AdyenInternal)
     public var navBarType: NavigationBarType

Adyen/Core/Components/InstantPaymentComponent.swift

@@ -6,6 +6,12 @@
 
 import Foundation
 
+@_spi(AdyenInternal)
+public protocol PaymentInitiable {
+    /// Initiate the payment flow
+    func initiatePayment()
+}
+
 /// A component that handles payment methods that don't need any payment detail to be filled.
 public final class InstantPaymentComponent: PaymentComponent {
 
@@ -62,6 +68,9 @@ public final class InstantPaymentComponent: PaymentComponent {
     }
 }
 
+@_spi(AdyenInternal)
+extension InstantPaymentComponent: PaymentInitiable {}
+
 /// Describes a payment details that contains nothing but the payment method type name.
 public struct InstantPaymentDetails: PaymentMethodDetails {
 

Adyen/Core/Core Protocols/PaymentComponentBuilder.swift

@@ -88,6 +88,9 @@ public protocol PaymentComponentBuilder: AdyenContextAware {
     /// Builds a certain `PaymentComponent` based on a `StoredCashAppPayPaymentMethod`.
     func build(paymentMethod: StoredCashAppPayPaymentMethod) -> PaymentComponent?
 
+    /// Builds a certain `PaymentComponent` based on a `TwintPaymentMethod`.
+    func build(paymentMethod: TwintPaymentMethod) -> PaymentComponent?
+
     /// Builds a certain `PaymentComponent` based on any `PaymentMethod`, as a default case.
     func build(paymentMethod: PaymentMethod) -> PaymentComponent?
 

Adyen/Core/Payment Methods/Abstract/AnyPaymentMethod.swift

@@ -39,7 +39,8 @@ internal enum AnyPaymentMethod: Codable {
     case onlineBanking(OnlineBankingPaymentMethod)
     case upi(UPIPaymentMethod)
     case cashAppPay(CashAppPayPaymentMethod)
-
+    case twint(TwintPaymentMethod)
+
     case none
 
     internal var value: PaymentMethod? {
@@ -75,6 +76,7 @@ internal enum AnyPaymentMethod: Codable {
         case let .onlineBanking(paymentMethod): return paymentMethod
         case let .upi(paymentMethod): return paymentMethod
         case let .cashAppPay(paymentMethod): return paymentMethod
+        case let .twint(paymentMethod): return paymentMethod
         case .none: return nil
         }
     }

Adyen/Core/Payment Methods/Abstract/AnyPaymentMethodDecoder.swift

@@ -27,7 +27,6 @@ private struct PaymentMethodField: Decodable {
     private enum CodingKeys: String, CodingKey {
         case key, type, isOptional = "optional"
     }
-
 }
 
 internal enum AnyPaymentMethodDecoder {
@@ -83,7 +82,8 @@ internal enum AnyPaymentMethodDecoder {
         .onlineBankingCZ: OnlineBankingPaymentMethodDecoder(),
         .onlineBankingSK: OnlineBankingPaymentMethodDecoder(),
         .upi: UPIPaymentMethodDecoder(),
-        .cashAppPay: CashAppPayPaymentMethodDecoder()
+        .cashAppPay: CashAppPayPaymentMethodDecoder(),
+        .twint: TwintPaymentMethodDecoder()
     ]
 
     private static var defaultDecoder: PaymentMethodDecoder = InstantPaymentMethodDecoder()
@@ -479,3 +479,22 @@ private struct CashAppPayPaymentMethodDecoder: PaymentMethodDecoder {
         return nil
     }
 }
+
+private struct TwintPaymentMethodDecoder: PaymentMethodDecoder {
+
+    func decode(from decoder: Decoder, isStored: Bool) throws -> AnyPaymentMethod {
+        #if canImport(TwintSDK)
+            try .twint(TwintPaymentMethod(from: decoder))
+        #else
+            return AnyPaymentMethod(InstantPaymentMethod(type: .twint, name: "Twint"))
+        #endif
+    }
+
+    func anyPaymentMethod(from paymentMethod: any PaymentMethod) -> AnyPaymentMethod? {
+        #if canImport(TwintSDK)
+            (paymentMethod as? TwintPaymentMethod).map { .twint($0) }
+        #else
+            return nil
+        #endif
+    }
+}

Adyen/Core/Payment Methods/Abstract/PaymentMethodType.swift

@@ -60,6 +60,7 @@ public enum PaymentMethodType: RawRepresentable, Hashable, Codable {
     case upi
     case cashAppPay
     case bizum
+    case twint
     case other(String)
 
     // swiftlint:disable cyclomatic_complexity function_body_length
@@ -119,6 +120,8 @@ public enum PaymentMethodType: RawRepresentable, Hashable, Codable {
         case "upi": self = .upi
         case "cashapp": self = .cashAppPay
         case "bizum": self = .bizum
+        case "twint": self = .twint
+
         default: self = .other(rawValue)
         }
     }
@@ -177,6 +180,8 @@ public enum PaymentMethodType: RawRepresentable, Hashable, Codable {
         case .upi: return "upi"
         case .cashAppPay: return "cashapp"
         case .bizum: return "bizum"
+        case .twint: return "twint"
+
         case let .other(value): return value
         }
     }
@@ -242,6 +247,8 @@ extension PaymentMethodType {
         case .upi: return "UPI"
         case .cashAppPay: return "cash app"
         case .bizum: return "bizum"
+        case .twint: return "twint"
+
         case let .other(name): return name.replacingOccurrences(of: "_", with: " ")
         }
     }

Adyen/Core/Payment Methods/TwintPaymentMethod.swift

@@ -0,0 +1,29 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+// Twint payment method
+public struct TwintPaymentMethod: PaymentMethod {
+
+    public var type: PaymentMethodType
+
+    public var name: String
+
+    public var merchantProvidedDisplayInformation: MerchantCustomDisplayInformation?
+
+    @_spi(AdyenInternal)
+    public func buildComponent(using builder: PaymentComponentBuilder) -> PaymentComponent? {
+        builder.build(paymentMethod: self)
+    }
+
+    // MARK: - Private
+
+    private enum CodingKeys: String, CodingKey {
+        case type
+        case name
+    }
+}

AdyenActions/Actions/AwaitAction.swift

@@ -17,6 +17,9 @@ public enum AwaitPaymentMethod: String, Decodable {
 
     /// upi
     case upicollect = "upi_collect"
+
+    /// Twint payment method
+    case twint
 }
 
 /// Describes an action in which the SDK is waiting for user action.

AdyenActions/Actions/SDKAction.swift

@@ -12,13 +12,18 @@ public enum SDKAction: Decodable {
     /// Indicates a WeChat Pay SDK action.
     case weChatPay(WeChatPaySDKAction)
 
+    /// Indicates a Twint SDK action.
+    case twint(TwintSDKAction)
+
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
         let type = try container.decode(SDKType.self, forKey: CodingKeys.type)
 
         switch type {
         case .weChatPay:
             self = try .weChatPay(WeChatPaySDKAction(from: decoder))
+        case .twint:
+            self = try .twint(TwintSDKAction(from: decoder))
         }
     }
 
@@ -28,5 +33,6 @@ public enum SDKAction: Decodable {
 
     private enum SDKType: String, Decodable {
         case weChatPay = "wechatpaySDK"
+        case twint = "twint"
     }
 }

AdyenActions/Actions/TwintSDKAction.swift

@@ -0,0 +1,50 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+/// Describes an action in which the user is redirected to the Twint SDK.
+public final class TwintSDKAction: PaymentDataAware, Decodable {
+
+    /// The TwintSDK specific data.
+    public let sdkData: TwintSDKData
+
+    /// The server-generated payment data that should be submitted to the `/payments/details` endpoint.
+    public let paymentData: String
+
+    // The payment method type
+    public let paymentMethodType: String
+
+    // The payment method subtype
+    public let type: String
+
+    internal enum CodingKeys: CodingKey {
+        case sdkData
+        case paymentData
+        case paymentMethodType
+        case type
+    }
+
+    public init(from decoder: any Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        self.sdkData = try container.decode(TwintSDKData.self, forKey: .sdkData)
+        self.paymentData = try container.decode(String.self, forKey: .paymentData)
+        self.paymentMethodType = try container.decode(String.self, forKey: .paymentMethodType)
+        self.type = try container.decode(String.self, forKey: .type)
+    }
+
+    internal init(
+        sdkData: TwintSDKData,
+        paymentData: String,
+        paymentMethodType: String,
+        type: String
+    ) {
+        self.sdkData = sdkData
+        self.paymentData = paymentData
+        self.paymentMethodType = paymentMethodType
+        self.type = type
+    }
+}

AdyenActions/Actions/TwintSDKData.swift

@@ -0,0 +1,27 @@
+//
+// Copyright (c) 2024 Adyen N.V.
+//
+// This file is open source and available under the MIT license. See the LICENSE file for more info.
+//
+
+import Foundation
+
+/// Describes the data required by the Twint SDK to complete the payment.
+public struct TwintSDKData: Decodable {
+
+    /// SDK token.
+    public let token: String
+
+    private enum CodingKeys: String, CodingKey {
+        case token
+    }
+
+    public init(from decoder: Decoder) throws {
+        let container = try decoder.container(keyedBy: CodingKeys.self)
+        token = try container.decode(String.self, forKey: .token)
+    }
+
+    internal init(token: String) {
+        self.token = token
+    }
+}