[Woo POS] Modularization: Create PointOfSale module

Modules/.swiftpm/xcode/xcshareddata/xcschemes/PointOfSale.xcscheme

@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Scheme
+   LastUpgradeVersion = "2600"
+   version = "1.7">
+   <BuildAction
+      parallelizeBuildables = "YES"
+      buildImplicitDependencies = "YES"
+      buildArchitectures = "Automatic">
+      <BuildActionEntries>
+         <BuildActionEntry
+            buildForTesting = "YES"
+            buildForRunning = "YES"
+            buildForProfiling = "YES"
+            buildForArchiving = "YES"
+            buildForAnalyzing = "YES">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "PointOfSale"
+               BuildableName = "PointOfSale"
+               BlueprintName = "PointOfSale"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </BuildActionEntry>
+      </BuildActionEntries>
+   </BuildAction>
+   <TestAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      shouldAutocreateTestPlan = "YES">
+   </TestAction>
+   <LaunchAction
+      buildConfiguration = "Debug"
+      selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
+      selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
+      launchStyle = "0"
+      useCustomWorkingDirectory = "NO"
+      ignoresPersistentStateOnLaunch = "NO"
+      debugDocumentVersioning = "YES"
+      debugServiceExtension = "internal"
+      allowLocationSimulation = "YES">
+   </LaunchAction>
+   <ProfileAction
+      buildConfiguration = "Release"
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      savedToolIdentifier = ""
+      useCustomWorkingDirectory = "NO"
+      debugDocumentVersioning = "YES">
+      <MacroExpansion>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "PointOfSale"
+            BuildableName = "PointOfSale"
+            BlueprintName = "PointOfSale"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </MacroExpansion>
+   </ProfileAction>
+   <AnalyzeAction
+      buildConfiguration = "Debug">
+   </AnalyzeAction>
+   <ArchiveAction
+      buildConfiguration = "Release"
+      revealArchiveInOrganizer = "YES">
+   </ArchiveAction>
+</Scheme>

Modules/Package.swift

@@ -67,6 +67,10 @@ let package = Package(
             name: "Yosemite",
             targets: ["Yosemite"]
         ),
+        .library(
+            name: "PointOfSale",
+            targets: ["PointOfSale"]
+        ),
     ],
     dependencies: [
         .package(url: "https://github.com/Alamofire/Alamofire", from: "5.2.0"),
@@ -230,6 +234,17 @@ let package = Package(
                 .product(name: "WordPressEditor", package: "AztecEditor-iOS"),
             ]
         ),
+        .target(
+            name: "PointOfSale",
+            dependencies: [
+                "Experiments",
+                "WooFoundation",
+                "Yosemite",
+                .product(name: "CocoaLumberjackSwift", package: "CocoaLumberjack"),
+                .product(name: "Shimmer", package: "SwiftUI-Shimmer"),
+                .product(name: "Kingfisher", package: "Kingfisher"),
+            ]
+        ),
         .testTarget(
             name: "ExperimentsTests",
             dependencies: [
@@ -295,7 +310,13 @@ let package = Package(
                 .process("Resources"),
                 .process("../NetworkingTests/Responses")
             ]
-        )
+        ),
+        .testTarget(
+            name: "PointOfSaleTests",
+            dependencies: [
+                "PointOfSale"
+            ]
+        ),
     ]
 )
 
@@ -374,6 +395,7 @@ enum XcodeSupport {
                     "WordPressUI",
                     "WPMediaPicker",
                     "Yosemite",
+                    "PointOfSale",
                     .product(name: "Alamofire", package: "Alamofire"),
                     .product(name: "Algorithms", package: "swift-algorithms"),
                     .product(name: "AutomatticAbout", package: "AutomatticAbout-swift"),

WooCommerce/Classes/POS/Analytics/WooAnalyticsEvent+PointOfSale.swift → Modules/Sources/PointOfSale/Analytics/WooAnalyticsEvent+PointOfSale.swift

@@ -5,6 +5,7 @@ import struct Yosemite.POSSimpleProduct
 import struct Yosemite.POSVariation
 import enum WooFoundation.CountryCode
 import enum Yosemite.PaymentMethod
+import struct WooFoundation.WooAnalyticsEvent
 
 extension WooAnalyticsEvent {
     enum PointOfSale {
@@ -125,7 +126,7 @@ extension WooAnalyticsEvent {
                 Key.cardReaderModel: readerModel(for: cardReaderModel),
                 Key.countryCode: countryCode.rawValue,
                 Key.gatewayID: safeGatewayID(for: forGatewayID),
-                Key.paymentMethodType: paymentMethod.analyticsValue,
+                Key.paymentMethodType: analyticsValue(for: paymentMethod),
                 Key.millisecondsSinceCustomerInteractionStarted: "\(millisecondsSinceCustomerIteractionStarted)",
                 Key.millisecondsSinceOrderSyncSuccess: "\(millisecondsSinceOrderSyncSuccess)",
                 Key.millisecondsSinceReaderReadyToCollect: "\(millisecondsSinceReaderReadyToCollect)",
@@ -134,6 +135,17 @@ extension WooAnalyticsEvent {
             ])
         }
 
+        static func analyticsValue(for paymentMethod: PaymentMethod) -> String {
+            switch paymentMethod {
+            case .card, .cardPresent:
+                return "card"
+            case .interacPresent:
+                return "card_interac"
+            case .unknown:
+                return "unknown"
+            }
+        }
+
         static func cashCollectPaymentSuccess(millisecondsSinceCustomerIteractionStarted: Double) -> WooAnalyticsEvent {
             WooAnalyticsEvent(statName: .pointOfSaleCashCollectPaymentSuccess, properties: [
                 Key.millisecondsSinceCustomerInteractionStarted: "\(millisecondsSinceCustomerIteractionStarted)",

WooCommerce/Classes/POS/Analytics/WooAnalyticsEvent+PointOfSaleIneligibleUI.swift → Modules/Sources/PointOfSale/Analytics/WooAnalyticsEvent+PointOfSaleIneligibleUI.swift

@@ -1,3 +1,5 @@
+import struct WooFoundation.WooAnalyticsEvent
+
 extension WooAnalyticsEvent {
     enum PointOfSaleIneligibleUI {
         /// Event property key.

WooCommerce/Classes/POS/Controllers/POSEntryPointController.swift → Modules/Sources/PointOfSale/Controllers/POSEntryPointController.swift

@@ -1,6 +1,17 @@
 import SwiftUI
 import protocol Experiments.FeatureFlagService
 
+public protocol POSEntryPointEligibilityCheckerProtocol {
+    /// Checks the initial visibility of the POS tab.
+    func checkInitialVisibility() -> Bool
+    /// Checks the final visibility of the POS tab.
+    func checkVisibility() async -> Bool
+    /// Determines whether the site is eligible for POS.
+    func checkEligibility() async -> POSEligibilityState
+    /// Refreshes the eligibility state based on the provided ineligible reason.
+    func refreshEligibility(ineligibleReason: POSIneligibleReason) async throws -> POSEligibilityState
+}
+
 @Observable final class POSEntryPointController {
     private(set) var eligibilityState: POSEligibilityState?
     private let posEligibilityChecker: POSEntryPointEligibilityCheckerProtocol

WooCommerce/Classes/POS/Controllers/POSOrderListController.swift → Modules/Sources/PointOfSale/Controllers/POSOrderListController.swift

@@ -8,6 +8,7 @@ import struct Yosemite.POSOrder
 import struct Yosemite.POSOrderItem
 import struct Yosemite.POSOrderRefund
 import class Yosemite.Store
+import class Yosemite.AsyncPaginationTracker
 
 protocol POSOrderListControllerProtocol {
     var ordersViewState: POSOrderListState { get }

WooCommerce/Classes/POS/Controllers/PointOfSaleCouponsController.swift → Modules/Sources/PointOfSale/Controllers/PointOfSaleCouponsController.swift

@@ -5,6 +5,7 @@ import protocol Yosemite.PointOfSaleItemServiceProtocol
 import protocol Yosemite.PointOfSaleCouponServiceProtocol
 import struct Yosemite.PointOfSaleCouponFetchStrategyFactory
 import protocol Yosemite.PointOfSaleCouponFetchStrategy
+import class Yosemite.AsyncPaginationTracker
 
 protocol PointOfSaleCouponsControllerProtocol: PointOfSaleSearchingItemsControllerProtocol {
     /// Enables coupons in store settings

WooCommerce/Classes/POS/Controllers/PointOfSaleItemsController.swift → Modules/Sources/PointOfSale/Controllers/PointOfSaleItemsController.swift

@@ -9,6 +9,7 @@ import enum Yosemite.PointOfSaleItemServiceError
 import struct Yosemite.POSVariableParentProduct
 import class Yosemite.Store
 import enum Yosemite.POSItemType
+import class Yosemite.AsyncPaginationTracker
 
 protocol PointOfSaleItemsControllerProtocol {
     ///

WooCommerce/Classes/POS/Controllers/PointOfSaleOrderController.swift → Modules/Sources/PointOfSale/Controllers/PointOfSaleOrderController.swift

@@ -5,6 +5,8 @@ import class WooFoundation.VersionHelpers
 import protocol Yosemite.POSOrderServiceProtocol
 import protocol Yosemite.POSReceiptServiceProtocol
 import protocol Yosemite.PluginsServiceProtocol
+import protocol Yosemite.PaymentCaptureCelebrationProtocol
+import class Yosemite.PaymentCaptureCelebration
 import struct Yosemite.Order
 import struct Yosemite.POSCart
 import struct Yosemite.POSCartItem
@@ -20,6 +22,8 @@ import enum WooFoundation.CurrencyCode
 import protocol WooFoundation.Analytics
 import enum Alamofire.AFError
 import class Yosemite.OrderTotalsCalculator
+import struct WooFoundation.WooAnalyticsEvent
+import protocol WooFoundationCore.WooAnalyticsEventPropertyType
 
 enum SyncOrderState {
     case newOrder
@@ -281,3 +285,34 @@ private extension POSCart {
         self.init(items: items, coupons: coupons)
     }
 }
+
+private extension WooAnalyticsEvent {
+    struct Orders {
+        // MARK: - Order Creation Events
+
+        /// Matches errors on Android for consistency
+        /// Only coupon tracking is relevant for now
+        enum OrderCreationErrorType: String {
+            case invalidCoupon = "INVALID_COUPON"
+        }
+
+        static func orderCreationFailed(
+            usesGiftCard: Bool,
+            errorContext: String,
+            errorDescription: String,
+            errorType: OrderCreationErrorType? = nil
+        ) -> WooAnalyticsEvent {
+            var properties: [String: WooAnalyticsEventPropertyType] = [
+                "use_gift_card": usesGiftCard,
+                "error_context": errorContext,
+                "error_description": errorDescription
+            ]
+
+            if let errorType {
+                properties["error_type"] = errorType.rawValue
+            }
+
+            return WooAnalyticsEvent(statName: .orderCreationFailed, properties: properties)
+        }
+    }
+}

WooCommerce/Classes/POS/Models/POSIneligibleReason.swift → Modules/Sources/PointOfSale/Models/POSIneligibleReason.swift

@@ -3,7 +3,7 @@ import enum WooFoundation.CountryCode
 import enum WooFoundation.CurrencyCode
 
 /// Represents the reasons why a site may be ineligible for POS.
-enum POSIneligibleReason: Equatable {
+public enum POSIneligibleReason: Equatable {
     case unsupportedIOSVersion
     case unsupportedWooCommerceVersion(minimumVersion: String)
     case siteSettingsNotAvailable
@@ -14,7 +14,7 @@ enum POSIneligibleReason: Equatable {
 }
 
 /// Represents the eligibility state for POS.
-enum POSEligibilityState: Equatable {
+public enum POSEligibilityState: Equatable {
     case eligible
     case ineligible(reason: POSIneligibleReason)
 }

WooCommerce/Classes/POS/Presentation/Card Present Payments/PointOfSaleCardPresentPaymentEventPresentationStyle.swift → Modules/Sources/PointOfSale/Presentation/Card Present Payments/PointOfSaleCardPresentPaymentEventPresentationStyle.swift

@@ -1,4 +1,6 @@
 import Foundation
+import enum Yosemite.CollectOrderPaymentUseCaseError
+import enum Yosemite.CollectOrderPaymentUseCaseNotValidAmountError
 
 enum PointOfSaleCardPresentPaymentEventPresentationStyle {
     case message(PointOfSaleCardPresentPaymentMessageType)

WooCommerce/Classes/POS/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentValidatingOrderErrorMessageViewModel.swift → Modules/Sources/PointOfSale/Presentation/Card Present Payments/Reader Messages/PointOfSaleCardPresentPaymentValidatingOrderErrorMessageViewModel.swift

@@ -1,5 +1,6 @@
 import Foundation
 import enum Networking.DotcomError
+import enum Yosemite.CollectOrderPaymentUseCaseNotValidAmountError
 
 struct PointOfSaleCardPresentPaymentValidatingOrderErrorMessageViewModel: Equatable {
     let title: String

WooCommerce/Classes/POS/Presentation/CardReaderConnection/UI States/Connection Alerts/PointOfSaleCardPresentPaymentConnectingFailedUpdateAddressView.swift → Modules/Sources/PointOfSale/Presentation/CardReaderConnection/UI States/Connection Alerts/PointOfSaleCardPresentPaymentConnectingFailedUpdateAddressView.swift

@@ -3,6 +3,7 @@ import SwiftUI
 struct PointOfSaleCardPresentPaymentConnectingFailedUpdateAddressView: View {
     @StateObject var viewModel: PointOfSaleCardPresentPaymentConnectingFailedUpdateAddressAlertViewModel
     let animation: POSCardPresentPaymentAlertAnimation
+    @Environment(\.posExternalViews) private var externalViews
 
     var body: some View {
         VStack(spacing: PointOfSaleReaderConnectionModalLayout.contentButtonSpacing) {
@@ -29,8 +30,8 @@ struct PointOfSaleCardPresentPaymentConnectingFailedUpdateAddressView: View {
         .multilineTextAlignment(.center)
         .accessibilityElement(children: .contain)
         .posSheet(isPresented: $viewModel.shouldShowSettingsWebView) {
-            WCSettingsWebView(adminUrl: viewModel.settingsAdminUrl,
-                              completion: viewModel.settingsWebViewWasDismissed)
+            externalViews.createWCWebView(adminUrl: viewModel.settingsAdminUrl,
+                                          completion: viewModel.settingsWebViewWasDismissed)
         }
     }
 }

WooCommerce/Classes/POS/Presentation/Item Selector/PointOfSaleItemListAnalyticsTracker.swift → Modules/Sources/PointOfSale/Presentation/Item Selector/PointOfSaleItemListAnalyticsTracker.swift

@@ -1,5 +1,6 @@
 import Foundation
 import enum Yosemite.POSItemType
+import struct WooFoundation.WooAnalyticsEvent
 
 struct PointOfSaleItemListAnalyticsTracker {
     private let sourceView: WooAnalyticsEvent.PointOfSale.SourceView

WooCommerce/Classes/POS/Presentation/PointOfSaleEntryPointView.swift → Modules/Sources/PointOfSale/Presentation/PointOfSaleEntryPointView.swift

@@ -129,7 +129,7 @@ struct PointOfSaleEntryPointView: View {
                               searchHistoryService: PointOfSalePreviewHistoryService(),
                               popularPurchasableItemsController: PointOfSalePreviewItemsController(),
                               barcodeScanService: PointOfSalePreviewBarcodeScanService(),
-                              posEligibilityChecker: POSTabEligibilityChecker(siteID: 0),
+                              posEligibilityChecker: PointOfSalePreviewTabEligibilityChecker(),
                               services: POSPreviewServices())
 }
 

WooCommerce/Classes/POS/Presentation/Settings/PointOfSaleSettingsHardwareDetailView.swift → Modules/Sources/PointOfSale/Presentation/Settings/PointOfSaleSettingsHardwareDetailView.swift

@@ -156,7 +156,9 @@ struct PointOfSaleSettingsHardwareDetailView: View {
         }
         .navigationBarBackButtonHidden(true)
         .posFullScreenCover(isPresented: $showCardReaderDocumentationModal) {
-            SafariView(url: WooConstants.URLs.inPersonPaymentsLearnMoreWCPay.asURL())
+            if let url = URL(string: Constants.inPersonPaymentsLearnMoreWCPay.rawValue) {
+                SafariView(url: url)
+            }
         }
     }
 
@@ -383,6 +385,13 @@ private extension PointOfSaleSettingsHardwareDetailView {
     }
 }
 
+private extension PointOfSaleSettingsHardwareDetailView {
+    enum Constants: String {
+        case inPersonPaymentsLearnMoreWCPay =
+                "https://woocommerce.com/document/woocommerce-payments/in-person-payments/getting-started-with-in-person-payments/"
+    }
+}
+
 #if DEBUG
 #Preview {
     PointOfSaleSettingsHardwareDetailView(settingsController: PointOfSaleSettingsPreviewController())

WooCommerce/Classes/POS/Protocols/POSDependencyProviding.swift → Modules/Sources/PointOfSale/Protocols/POSDependencyProviding.swift

@@ -59,6 +59,7 @@ protocol POSExternalViewProviding {
                                           title: String,
                                           cancelButtonTitle: String,
                                           onSelection: @escaping (Coupon.DiscountType) -> Void) -> AnyView
+    func createWCWebView(adminUrl: URL, completion: @escaping () -> Void) -> AnyView
 }
 
 /// Main protocol that combines all POS dependency providers

WooCommerce/Classes/POS/Utils/POSEnvironmentKeys.swift → Modules/Sources/PointOfSale/Utils/POSEnvironmentKeys.swift

@@ -142,5 +142,8 @@ struct EmptyPOSExternalView: POSExternalViewProviding {
                                           onSelection: @escaping (Coupon.DiscountType) -> Void) -> AnyView {
         AnyView(EmptyView())
     }
+    func createWCWebView(adminUrl: URL, completion: @escaping () -> Void) -> AnyView {
+        AnyView(EmptyView())
+    }
     init() {}
 }

WooCommerce/Classes/POS/Utils/PreviewHelpers.swift → Modules/Sources/PointOfSale/Utils/PreviewHelpers.swift

@@ -400,6 +400,13 @@ final class PointOfSalePreviewBarcodeScanService: PointOfSaleBarcodeScanServiceP
     }
 }
 
+final class PointOfSalePreviewTabEligibilityChecker: POSEntryPointEligibilityCheckerProtocol {
+    func checkInitialVisibility() -> Bool { true }
+    func checkVisibility() async -> Bool { true }
+    func checkEligibility() async -> POSEligibilityState { .eligible }
+    func refreshEligibility(ineligibleReason: POSIneligibleReason) async throws -> POSEligibilityState { .eligible }
+}
+
 final class POSReceiptSenderPreview: POSReceiptSending {
     func sendReceipt(orderID: Int64, recipientEmail: String) async throws {}
 }