[Woo POS][Modularization] Batch 1: Make Woo app dependencies reusable for PointOfSale module (#15968)

Author: staskus

BuildTools/Package.resolved

@@ -404,3 +404,34 @@ public extension PaymentMethod {
         }
     }
 }
+
+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)
+        }
+    }
+}

Modules/Sources/PointOfSale/Analytics/POSAnalyticsEvent.swift

@@ -1,17 +1,19 @@
 import Foundation
+import SwiftUI
 import WooFoundation
 import Experiments
 import protocol Yosemite.Action
 import struct Yosemite.Site
 
 /// Main dependency provider protocol for POS module
-/// This abstracts away direct ServiceLocator access
+/// This abstracts away dependencies from the main Woo app
 public protocol POSDependencyProviding {
     var analytics: POSAnalyticsProviding { get }
     var currency: POSCurrencySettingsProviding { get }
     var featureFlags: POSFeatureFlagProviding { get }
-    var session: POSSessionManagerProviding { get }
     var connectivity: POSConnectivityProviding { get }
+    var externalNavigation: POSExternalNavigationProviding { get }
+    var externalViews: POSExternalViewProviding { get }
 }
 
 public protocol POSAnalyticsProviding {
@@ -21,10 +23,6 @@ public protocol POSAnalyticsProviding {
     func track(_ stat: WooAnalyticsStat)
 }
 
-public protocol POSSessionManagerProviding {
-    var defaultSite: Site? { get }
-}
-
 public protocol POSFeatureFlagProviding {
     func isFeatureFlagEnabled(_ flag: FeatureFlag) -> Bool
 }
@@ -36,3 +34,13 @@ public protocol POSCurrencySettingsProviding {
 public protocol POSConnectivityProviding {
     var connectivityObserver: ConnectivityObserver { get }
 }
+
+/// Navigation to the Woo app service abstraction
+public protocol POSExternalNavigationProviding {
+    func navigateToCreateOrder()
+}
+
+/// External view service abstraction
+public protocol POSExternalViewProviding {
+    func createSupportFormView(isPresented: Binding<Bool>) -> AnyView
+}

Modules/Sources/PointOfSale/DependencyProviders/POSDependencyProviding.swift

@@ -20,16 +20,21 @@ public struct POSFeatureFlagsKey: EnvironmentKey {
     public static let defaultValue: POSFeatureFlagProviding = EmptyPOSFeatureFlags()
 }
 
-/// Environment key for POS session manager
-public struct POSSessionManagerKey: EnvironmentKey {
-    public static let defaultValue: POSSessionManagerProviding = EmptyPOSSessionManager()
-}
-
 /// Environment key for POS connectivity
 public struct POSConnectivityKey: EnvironmentKey {
     public static let defaultValue: POSConnectivityProviding = EmptyPOSConnectivityProvider()
 }
 
+/// Environment key for POS navigation service
+public struct POSExternalNavigationKey: EnvironmentKey {
+    public static let defaultValue: POSExternalNavigationProviding = EmptyPOSExternalNavigation()
+}
+
+/// Environment key for POS external view service
+public struct POSExternalViewKey: EnvironmentKey {
+    public static let defaultValue: POSExternalViewProviding = EmptyPOSExternalView()
+}
+
 public extension EnvironmentValues {
     var posAnalytics: POSAnalyticsProviding {
         get { self[POSAnalyticsKey.self] }
@@ -46,21 +51,26 @@ public extension EnvironmentValues {
         set { self[POSFeatureFlagsKey.self] = newValue }
     }
 
-    var posSession: POSSessionManagerProviding {
-        get { self[POSSessionManagerKey.self] }
-        set { self[POSSessionManagerKey.self] = newValue }
-    }
-
     var posConnectivityProvider: POSConnectivityProviding {
         get { self[POSConnectivityKey.self] }
         set { self[POSConnectivityKey.self] = newValue }
     }
+
+    var posExternalNavigation: POSExternalNavigationProviding {
+        get { self[POSExternalNavigationKey.self] }
+        set { self[POSExternalNavigationKey.self] = newValue }
+    }
+
+    var posExternalViews: POSExternalViewProviding {
+        get { self[POSExternalViewKey.self] }
+        set { self[POSExternalViewKey.self] = newValue }
+    }
 }
 
 // MARK: - Empty Default Values
 
-public struct EmptyPOSSessionManager: POSSessionManagerProviding {
-    public var defaultSite: Site? = nil
+public struct EmptyPOSExternalNavigation: POSExternalNavigationProviding {
+    public func navigateToCreateOrder() {}
     public init() {}
 }
 
@@ -94,3 +104,8 @@ public struct EmptyPOSAnalytics: POSAnalyticsProviding {
     public func track(_ stat: WooFoundationCore.WooAnalyticsStat, parameters: [String: WooAnalyticsEventPropertyType], error: any Error) {}
     public init() {}
 }
+
+public struct EmptyPOSExternalView: POSExternalViewProviding {
+    public func createSupportFormView(isPresented: Binding<Bool>) -> AnyView { AnyView(EmptyView()) }
+    public init() {}
+}

Modules/Sources/PointOfSale/Environment/POSEnvironmentKeys.swift

@@ -0,0 +1,24 @@
+import UIKit
+
+/// Point of Sale specific UIImage extensions
+/// Contains only the UIImage extensions needed by the POS module to minimize external dependencies
+extension UIImage {
+
+    /// App icon (iPhone size) - used in receipt eligibility banner
+    ///
+    static var appIconDefault: UIImage {
+        return UIImage(named: "AppIcon60x60", in: .main, compatibleWith: nil)!
+    }
+
+    /// Card Reader Update arrow - used in reader update progress
+    ///
+    static var cardReaderUpdateProgressArrow: UIImage {
+        return UIImage(named: "card-reader-update-progress-arrow", in: .main, compatibleWith: nil)!
+    }
+
+    /// Card Reader Update checkmark - used in reader update progress completion
+    ///
+    static var cardReaderUpdateProgressCheckmark: UIImage {
+        return UIImage(named: "card-reader-update-progress-checkmark", in: .main, compatibleWith: nil)!
+    }
+}

Modules/Sources/PointOfSale/Extensions/UIImage+POS.swift

@@ -1,9 +1,8 @@
 import Foundation
 
-
 // MARK: - Array Helpers
 //
-extension Array {
+public extension Array {
     /// Removes and returns the first element in the array. If any!
     ///
     mutating func popFirst() -> Element? {
@@ -27,7 +26,7 @@ extension Array {
 
 // MARK: - Sequence Helpers
 //
-extension Sequence {
+public extension Sequence {
     /// Get the keypaths for a elemtents in a sequence.
     ///
     func map<T>(_ keyPath: KeyPath<Element, T>) -> [T] {
@@ -40,12 +39,12 @@ extension Sequence {
     }
 }
 
-extension Sequence where Element: Numeric {
+public extension Sequence where Element: Numeric {
     /// Returns the sum of all elements in the collection.
     func sum() -> Element { return reduce(0, +) }
 }
 
-extension Sequence where Element: Equatable {
+public extension Sequence where Element: Equatable {
     /// Returns the sequence with any duplicate elements after the first one removed.
     func removingDuplicates() -> [Element] {
         var result = [Element]()

WooCommerce/Classes/Extensions/Array+Helpers.swift renamed to Modules/Sources/WooFoundation/Extensions/Array+Helpers.swift

@@ -0,0 +1,23 @@
+import SwiftUI
+import SafariServices
+
+/// SwiftUI interface for UIKit SFSafariViewController
+/// Provides a visible interface for web browsing, and Safari features
+///
+public struct SafariView: UIViewControllerRepresentable {
+
+    public let url: URL
+
+    public init(url: URL) {
+        self.url = url
+    }
+
+    public func makeUIViewController(context: UIViewControllerRepresentableContext<SafariView>) -> SFSafariViewController {
+        return SFSafariViewController(url: url)
+    }
+
+    public func updateUIViewController(_ uiViewController: SFSafariViewController,
+                                context: UIViewControllerRepresentableContext<SafariView>) {
+
+    }
+}

Modules/Sources/WooFoundation/UI Components/SafariView.swift

@@ -15,6 +15,28 @@ public struct IndefiniteCircularProgressViewStyle: ProgressViewStyle {
     @State private var viewRotation: Angle = .radians(0)
     @State private var arcTimer: Timer?
 
+    public init(
+        size: CGFloat,
+        lineWidth: CGFloat = Constants.lineWidth,
+        lineCap: CGLineCap = .round,
+        circleColor: Color = Color(.primaryButtonBackground).opacity(Constants.backgroundOpacity),
+        fillColor: Color = Color(.primaryButtonBackground),
+        arcEnd: Double = Constants.initialArcEnd,
+        rotation: Angle = Constants.threeQuarterRotation,
+        viewRotation: Angle = .radians(0),
+        arcTimer: Timer? = nil
+    ) {
+        self.size = size
+        self.lineWidth = lineWidth
+        self.lineCap = lineCap
+        self.circleColor = circleColor
+        self.fillColor = fillColor
+        self.arcEnd = arcEnd
+        self.rotation = rotation
+        self.viewRotation = viewRotation
+        self.arcTimer = arcTimer
+    }
+
     public func makeBody(configuration: ProgressViewStyleConfiguration) -> some View {
         VStack {
             ZStack {
@@ -78,17 +100,17 @@ public struct IndefiniteCircularProgressViewStyle: ProgressViewStyle {
     }
 }
 
-private extension IndefiniteCircularProgressViewStyle {
+public extension IndefiniteCircularProgressViewStyle {
     enum Constants {
-        static let lineWidth: CGFloat = 10.0
-        static let backgroundOpacity: CGFloat = 0.2
+        public static let lineWidth: CGFloat = 10.0
+        public static let backgroundOpacity: CGFloat = 0.2
 
-        static let initialArcStart: Double = 0
-        static let initialArcEnd: Double = 0.05
-        static let fullCircle: Double = 1
+        public static let initialArcStart: Double = 0
+        public static let initialArcEnd: Double = 0.05
+        public static let fullCircle: Double = 1
 
-        static let threeQuarterRotation: Angle = .radians((9 * Double.pi)/6)
-        static let fullRotation: Angle = .radians(Double.pi * 2)
+        public static let threeQuarterRotation: Angle = .radians((9 * Double.pi)/6)
+        public static let fullRotation: Angle = .radians(Double.pi * 2)
     }
 
     enum Localization {

WooCommerce/Classes/ViewRelated/ReusableViews/SwiftUI Components/IndefiniteCircularProgressViewStyle.swift renamed to Modules/Sources/WooFoundation/Utilities/IndefiniteCircularProgressViewStyle.swift

@@ -3,22 +3,22 @@ import Combine
 
 @available(iOS 17.0, *)
 @Observable
-final class KeyboardObserver {
-    private(set) var isKeyboardVisible: Bool = false
-    private(set) var keyboardHeight: CGFloat = 0
+public final class KeyboardObserver {
+    private(set) public var isKeyboardVisible: Bool = false
+    private(set) public var keyboardHeight: CGFloat = 0
 
     /// When an external keyboard is in use, iPadOS shows a quicktype bar at the bottom of the screen.
     /// This is reported as a keyboard with height, so `isKeyboardVisible` will be true and
     /// keyboard height will be > 0.
     /// However, it's much less of an impingement on the view, so there may be no modification to the view required.
     /// `isFullSizeKeyboardVisible` is true when the full software keyboard is shown.
-    var isFullSizeKeyboardVisible: Bool {
+    public var isFullSizeKeyboardVisible: Bool {
         return keyboardHeight > Constants.hardwareKeyboardHelperBarHeightThreshold
     }
 
     private var cancellables = Set<AnyCancellable>()
 
-    init() {
+    public init() {
         NotificationCenter.Publisher(center: .default, name: UIResponder.keyboardWillShowNotification)
             .merge(with: NotificationCenter.Publisher(center: .default, name: UIResponder.keyboardDidShowNotification))
             .receive(on: DispatchQueue.main)
@@ -64,24 +64,24 @@ private struct KeyboardObserverKey: EnvironmentKey {
 }
 
 @available(iOS 17.0, *)
-extension EnvironmentValues {
+public extension EnvironmentValues {
     var keyboardObserver: KeyboardObserver {
         get { self[KeyboardObserverKey.self] }
         set { self[KeyboardObserverKey.self] = newValue }
     }
 }
 
 @available(iOS 17.0, *)
-struct KeyboardObserverProvider: ViewModifier {
+public struct KeyboardObserverProvider: ViewModifier {
     @State private var observer = KeyboardObserver()
 
-    func body(content: Content) -> some View {
+    public func body(content: Content) -> some View {
         content.environment(\.keyboardObserver, observer)
     }
 }
 
 @available(iOS 17.0, *)
-extension View {
+public extension View {
     func injectKeyboardObserver() -> some View {
         modifier(KeyboardObserverProvider())
     }

WooCommerce/Classes/ViewRelated/ReusableViews/SwiftUI Components/KeyboardObserver.swift renamed to Modules/Sources/WooFoundation/Utilities/KeyboardObserver.swift

@@ -1,14 +1,15 @@
 import SwiftUI
+import struct WooFoundation.ScrollableVStack
 
 /// Wraps a VStack inside a ScrollView, ensuring the content expands to fill the available space
 ///
-struct ScrollableVStack<Content: View>: View {
+public struct ScrollableVStack<Content: View>: View {
     let alignment: HorizontalAlignment
     let padding: CGFloat
     let spacing: CGFloat?
     let content: Content
 
-    init(
+    public init(
         alignment: HorizontalAlignment = .center,
         padding: CGFloat = 24,
         spacing: CGFloat? = nil,
@@ -20,7 +21,7 @@ struct ScrollableVStack<Content: View>: View {
         self.content = content()
     }
 
-    var body: some View {
+    public var body: some View {
         GeometryReader { geometry in
             ScrollView {
                 VStack(alignment: alignment, spacing: spacing) {