[Payments] Display card inserted status for card-present payments (#15591)

Author: staskus

WooCommerce/Classes/POS/Card Present Payments/CardPresentPaymentCollectOrderPaymentUseCaseAdaptor.swift

@@ -148,6 +148,7 @@ private extension CardPresentPaymentCollectOrderPaymentUseCaseAdaptor {
             return
         case .preparingForPayment(cancelPayment: let cancelPayment),
                 .tapSwipeOrInsertCard(_, cancelPayment: let cancelPayment),
+                .cardInserted(cancelPayment: let cancelPayment),
                 .paymentError(_, _, cancelPayment: let cancelPayment),
                 .paymentCaptureError(cancelPayment: let cancelPayment),
                 .paymentIntentCreationError(_, cancelPayment: let cancelPayment):

WooCommerce/Classes/POS/Card Present Payments/CardPresentPaymentEventDetails.swift

@@ -43,6 +43,7 @@ enum CardPresentPaymentEventDetails {
     case connectionSuccess(done: () -> Void)
     case tapSwipeOrInsertCard(inputMethods: CardReaderInput,
                               cancelPayment: () -> Void)
+    case cardInserted(cancelPayment: () -> Void)
     case paymentSuccess(done: () -> Void)
     case paymentError(error: any Error,
                       retryApproach: CardPresentPaymentRetryApproach,

WooCommerce/Classes/POS/Card Present Payments/CardPresentPaymentInvalidatablePaymentOrchestrator.swift

@@ -17,6 +17,7 @@ final class CardPresentPaymentInvalidatablePaymentOrchestrator: PaymentCaptureOr
                         channel: PaymentChannel,
                         onPreparingReader: @escaping () -> Void,
                         onWaitingForInput: @escaping (CardReaderInput) -> Void,
+                        onCardInserted: @escaping () -> Void,
                         onProcessingMessage: @escaping () -> Void,
                         onDisplayMessage: @escaping (String) -> Void,
                         onProcessingCompletion: @escaping (PaymentIntent) -> Void,
@@ -32,6 +33,7 @@ final class CardPresentPaymentInvalidatablePaymentOrchestrator: PaymentCaptureOr
                                            channel: channel,
                                            onPreparingReader: onPreparingReader,
                                            onWaitingForInput: onWaitingForInput,
+                                           onCardInserted: onCardInserted,
                                            onProcessingMessage: onProcessingMessage,
                                            onDisplayMessage: onDisplayMessage,
                                            onProcessingCompletion: onProcessingCompletion,

WooCommerce/Classes/POS/Card Present Payments/CardPresentPaymentsTransactionAlertsProvider.swift

@@ -20,6 +20,12 @@ struct CardPresentPaymentsTransactionAlertsProvider: CardReaderTransactionAlerts
                               cancelPayment: onCancel)
     }
 
+    func cardInserted(title: String,
+                      amount: String,
+                      onCancel: @escaping () -> Void) -> CardPresentPaymentEventDetails {
+        .cardInserted(cancelPayment: onCancel)
+    }
+
     func displayReaderMessage(message: String) -> CardPresentPaymentEventDetails {
         .displayReaderMessage(message: message)
     }

WooCommerce/Classes/POS/Models/PointOfSalePaymentState.swift

@@ -8,6 +8,7 @@ enum PointOfSalePaymentState: Equatable {
 enum PointOfSaleCardPaymentState: Equatable {
     case idle
     case acceptingCard
+    case cardInserted
     case validatingOrder
     case validatingOrderError
     case preparingReader
@@ -33,6 +34,8 @@ extension PointOfSalePaymentState {
             self = .card(.preparingReader)
         case .show(.tapSwipeOrInsertCard):
             self = .card(.acceptingCard)
+        case .show(.cardInserted):
+            self = .card(.cardInserted)
         case .show(.processing),
                 .show(.displayReaderMessage):
             self = .card(.processingPayment)
@@ -65,7 +68,8 @@ extension PointOfSalePaymentState {
                 .card(.validatingOrder),
                 .card(.validatingOrderError),
                 .card(.preparingReader),
-                .card(.acceptingCard):
+                .card(.acceptingCard),
+                .card(.cardInserted):
             return false
         case .cash:
             return true

WooCommerce/Classes/POS/Presentation/Card Present Payments/PointOfSaleCardPresentPaymentEventPresentationStyle.swift

@@ -187,6 +187,8 @@ enum PointOfSaleCardPresentPaymentEventPresentationStyle {
             self = .message(.tapSwipeOrInsertCard(
                 viewModel: PointOfSaleCardPresentPaymentTapSwipeInsertCardMessageViewModel(
                     inputMethods: inputMethods)))
+        case .cardInserted:
+            self = .message(.cardInserted(viewModel: PointOfSaleCardPresentPaymentCardInsertedMessageViewModel()))
         case .paymentSuccess:
             self = .message(.paymentSuccess(viewModel: PointOfSalePaymentSuccessViewModel(
                 formattedOrderTotal: dependencies.formattedOrderTotalPrice,
@@ -241,7 +243,9 @@ enum PointOfSaleCardPresentPaymentEventPresentationStyle {
 
         case .cancelledOnReader:
             self = .message(.cancelledOnReader(
-                viewModel: PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel()))
+                viewModel: PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel(
+                    tryPaymentAgainButtonAction: dependencies.tryPaymentAgainBackToCheckoutAction))
+            )
 
             /// Not-yet supported types
         case .selectSearchType:

WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel.swift

@@ -2,6 +2,12 @@ import Foundation
 
 struct PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel: Equatable {
     let title = Localization.cancelledOnReader
+    let tryAgainButtonViewModel: CardPresentPaymentsModalButtonViewModel
+
+    init(tryPaymentAgainButtonAction: @escaping () -> Void) {
+        self.tryAgainButtonViewModel = .init(title: Localization.tryPaymentAgain,
+                                             actionHandler: tryPaymentAgainButtonAction)
+    }
 }
 
 private extension PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel {
@@ -11,5 +17,12 @@ private extension PointOfSaleCardPresentPaymentCancelledOnReaderMessageViewModel
             value: "Payment cancelled on reader",
             comment: "Indicates the status of a card reader. Presented to users when payment collection starts"
         )
+
+        static let tryPaymentAgain =  NSLocalizedString(
+            "pointOfSale.cardPresent.cancelledOnReader.tryPaymentAgain.button.title",
+            value: "Try payment again",
+            comment: "Button to try to collect a payment again. Presented to users after " +
+            "card reader cancelled on the Point of Sale Checkout"
+        )
     }
 }

WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentCardInsertedMessageViewModel.swift

@@ -0,0 +1,23 @@
+import Foundation
+
+struct PointOfSaleCardPresentPaymentCardInsertedMessageViewModel: Equatable {
+    let title = Localization.title
+    let subtitle = Localization.subtitle
+    let imageName = PointOfSaleAssets.readyForPayment.imageName
+}
+
+private extension PointOfSaleCardPresentPaymentCardInsertedMessageViewModel {
+    enum Localization {
+        static let title = NSLocalizedString(
+            "pointOfSale.cardPresent.cardInserted.title",
+            value: "Ready for payment",
+            comment: "Indicates the status of a card reader. Presented to merchants when the card is inserted to the reader"
+        )
+
+        static let subtitle = NSLocalizedString(
+            "pointOfSale.cardPresent.cardInserted.subtitle",
+            value: "Card inserted",
+            comment: "Indicates the status of a card reader. Presented to merchants when the card is inserted to the reader"
+        )
+    }
+}

WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentMessageType.swift

@@ -5,6 +5,7 @@ enum PointOfSaleCardPresentPaymentMessageType: Equatable {
     case validatingOrderError(viewModel: PointOfSaleCardPresentPaymentValidatingOrderErrorMessageViewModel)
     case preparingForPayment(viewModel: PointOfSaleCardPresentPaymentPreparingForPaymentMessageViewModel)
     case tapSwipeOrInsertCard(viewModel: PointOfSaleCardPresentPaymentTapSwipeInsertCardMessageViewModel)
+    case cardInserted(viewModel: PointOfSaleCardPresentPaymentCardInsertedMessageViewModel)
     case processing(viewModel: PointOfSaleCardPresentPaymentProcessingMessageViewModel)
     case displayReaderMessage(viewModel: PointOfSaleCardPresentPaymentDisplayReaderMessageMessageViewModel)
     case paymentSuccess(viewModel: PointOfSalePaymentSuccessViewModel)

WooCommerce/Classes/POS/Presentation/CardReaderConnection/UI States/PointOfSaleCardPresentPaymentInLineMessage.swift

@@ -18,6 +18,8 @@ struct PointOfSaleCardPresentPaymentInLineMessage: View {
             PointOfSaleCardPresentPaymentActivityIndicatingMessageView(title: viewModel.title, message: viewModel.message, animation: animation)
         case .tapSwipeOrInsertCard(let viewModel):
             PointOfSaleCardPresentPaymentTapSwipeInsertCardMessageView(viewModel: viewModel, animation: animation)
+        case .cardInserted(viewModel: let viewModel):
+            PointOfSaleCardPresentPaymentCardInsertedMessageView(viewModel: viewModel, animation: animation)
         case .processing(let viewModel):
             PointOfSaleCardPresentPaymentProcessingMessageView(viewModel: viewModel, animation: animation)
         case .displayReaderMessage(let viewModel):