Use WooShippingAddress instead of legacy type

rachelmcr · rachelmcr · commit 5d7964739755 · 2025-02-19T14:55:45.000Z
diff --git a/Networking/Networking/Remote/WooShippingRemote.swift b/Networking/Networking/Remote/WooShippingRemote.swift
@@ -10,8 +10,8 @@ public protocol WooShippingRemoteProtocol {
                        completion: @escaping (Result<WooShippingCreatePackageResponse, Error>) -> Void)
     func loadLabelRates(siteID: Int64,
                         orderID: Int64,
-                        originAddress: ShippingLabelAddress,
-                        destinationAddress: ShippingLabelAddress,
+                        originAddress: WooShippingAddress,
+                        destinationAddress: WooShippingAddress,
                         packages: [ShippingLabelPackageSelected],
                         completion: @escaping (Result<[ShippingLabelCarriersAndRates], Error>) -> Void)
     func loadPackages(siteID: Int64,
@@ -20,8 +20,8 @@ public protocol WooShippingRemoteProtocol {
                              completion: @escaping (Result<WooShippingAccountSettings, Error>) -> Void)
     func purchaseShippingLabel(siteID: Int64,
                                orderID: Int64,
-                               originAddress: ShippingLabelAddress,
-                               destinationAddress: ShippingLabelAddress,
+                               originAddress: WooShippingAddress,
+                               destinationAddress: WooShippingAddress,
                                package: WooShippingPackagePurchase,
                                completion: @escaping (Result<[ShippingLabelPurchase], Error>) -> Void)
     func checkLabelStatus(siteID: Int64,
@@ -36,7 +36,7 @@ public protocol WooShippingRemoteProtocol {
     func loadOriginAddresses(siteID: Int64,
                              completion: @escaping (Result<[WooShippingOriginAddress], Error>) -> Void)
     func addressValidation(siteID: Int64,
-                           address: ShippingLabelAddress,
+                           address: WooShippingAddress,
                            completion: @escaping (Result<WooShippingAddressValidationSuccess, Error>) -> Void)
     func updateOriginAddress(siteID: Int64,
                              address: WooShippingOriginAddress,
@@ -122,8 +122,8 @@ public final class WooShippingRemote: Remote, WooShippingRemoteProtocol {
     ///   - completion: Closure to be executed upon completion.
     public func loadLabelRates(siteID: Int64,
                                orderID: Int64,
-                               originAddress: ShippingLabelAddress,
-                               destinationAddress: ShippingLabelAddress,
+                               originAddress: WooShippingAddress,
+                               destinationAddress: WooShippingAddress,
                                packages: [ShippingLabelPackageSelected],
                                completion: @escaping (Result<[ShippingLabelCarriersAndRates], Error>) -> Void) {
         do {
@@ -203,8 +203,8 @@ public final class WooShippingRemote: Remote, WooShippingRemoteProtocol {
     ///   - completion: Closure to be executed upon completion.
     public func purchaseShippingLabel(siteID: Int64,
                                       orderID: Int64,
-                                      originAddress: ShippingLabelAddress,
-                                      destinationAddress: ShippingLabelAddress,
+                                      originAddress: WooShippingAddress,
+                                      destinationAddress: WooShippingAddress,
                                       package: WooShippingPackagePurchase,
                                       completion: @escaping (Result<[ShippingLabelPurchase], Error>) -> Void) {
         do {
@@ -301,7 +301,7 @@ public final class WooShippingRemote: Remote, WooShippingRemoteProtocol {
     ///   - address: The address that should be verified.
     ///   - completion: Closure to be executed upon completion.
     public func addressValidation(siteID: Int64,
-                                  address: ShippingLabelAddress,
+                                  address: WooShippingAddress,
                                   completion: @escaping (Result<WooShippingAddressValidationSuccess, Error>) -> Void) {
         do {
             let parameters = [
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShipping Package and Rate Selection/WooShippingServiceViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShipping Package and Rate Selection/WooShippingServiceViewModel.swift
@@ -3,8 +3,8 @@ import Yosemite
 final class WooShippingServiceViewModel: ObservableObject {
     private let siteID: Int64
     private let orderID: Int64
-    private let originAddress: ShippingLabelAddress?
-    private let destinationAddress: ShippingLabelAddress?
+    private let originAddress: WooShippingAddress?
+    private let destinationAddress: WooShippingAddress?
     private let stores: StoresManager
 
     /// Whether the destination address is present and with non-empty fields.
@@ -36,8 +36,8 @@ final class WooShippingServiceViewModel: ObservableObject {
     let onSelectRate: ((_ selectedRate: WooShippingSelectedRate) -> Void)?
 
     init(order: Order,
-         originAddress: ShippingLabelAddress?,
-         destinationAddress: ShippingLabelAddress?,
+         originAddress: WooShippingAddress?,
+         destinationAddress: WooShippingAddress?,
          stores: StoresManager = ServiceLocator.stores,
          onSelectRate: ((_ selectedRate: WooShippingSelectedRate) -> Void)? = nil) {
         self.siteID = order.siteID
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingAddresses/WooShippingEditAddressViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingAddresses/WooShippingEditAddressViewModel.swift
@@ -269,15 +269,15 @@ final class WooShippingEditAddressViewModel: ObservableObject, Identifiable {
     /// Validates the address remotely.
     @MainActor
     func remotelyValidateAddress() async {
-        let addressToValidate = ShippingLabelAddress(company: company.value,
-                                                     name: name.value,
-                                                     phone: phone.value,
-                                                     country: country.value,
-                                                     state: state.value,
-                                                     address1: address.value,
-                                                     address2: "",
-                                                     city: city.value,
-                                                     postcode: postalCode.value)
+        let addressToValidate = WooShippingAddress(company: company.value,
+                                                   name: name.value,
+                                                   phone: phone.value,
+                                                   country: country.value,
+                                                   state: state.value,
+                                                   address1: address.value,
+                                                   address2: "",
+                                                   city: city.value,
+                                                   postcode: postalCode.value)
         do {
             let validation = try await remotelyValidateAddress(addressToValidate)
             normalizeAddressVM = WooShippingNormalizeAddressViewModel(enteredAddress: validation.originalAddress,
@@ -459,7 +459,7 @@ private extension WooShippingEditAddressViewModel {
 
     /// Remotely validates the provided address.
     @MainActor
-    func remotelyValidateAddress(_ address: ShippingLabelAddress) async throws -> WooShippingAddressValidationSuccess {
+    func remotelyValidateAddress(_ address: WooShippingAddress) async throws -> WooShippingAddressValidationSuccess {
         try await withCheckedThrowingContinuation { continuation in
             isLoading = true
             let action = WooShippingAction.validateAddress(siteID: siteID,
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingCreateLabelsViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/WooShipping Create Shipping Labels/WooShippingCreateLabelsViewModel.swift
@@ -236,8 +236,8 @@ final class WooShippingCreateLabelsViewModel: ObservableObject {
                                                          productIDs: itemsDataSource.items.map(\.productOrVariationID))
         let action = WooShippingAction.purchaseShippingLabel(siteID: order.siteID,
                                                              orderID: order.orderID,
-                                                             originAddress: selectedOriginAddress.toShippingLabelAddress(),
-                                                             destinationAddress: destinationAddress.toShippingLabelAddress(),
+                                                             originAddress: selectedOriginAddress.toWooShippingAddress(),
+                                                             destinationAddress: destinationAddress,
                                                              package: packagePurchase) { [weak self] result in
             guard let self else { return }
             isPurchasingLabel = false
@@ -331,8 +331,8 @@ private extension WooShippingCreateLabelsViewModel {
                 guard let self else { return }
                 originAddress = selectedOriginAddress?.formattedPostalAddress ?? ""
                 shippingService = WooShippingServiceViewModel(order: order,
-                                                              originAddress: selectedOriginAddress?.toShippingLabelAddress(),
-                                                              destinationAddress: destinationAddress?.toShippingLabelAddress(),
+                                                              originAddress: selectedOriginAddress?.toWooShippingAddress(),
+                                                              destinationAddress: destinationAddress,
                                                               stores: stores) { [weak self] selectedRate in
                     self?.selectedRate = selectedRate
                 }
@@ -468,38 +468,20 @@ private extension WooShippingCreateLabelsViewModel {
 }
 
 private extension WooShippingOriginAddress {
-    /// Converts the origin address to a `ShippingLabelAddress`.
+    /// Converts the origin address to a `WooShippingAddress`.
     ///
     /// This prepares the address for use in e.g. fetching available shipping rates or purchasing the label.
     ///
-    func toShippingLabelAddress() -> ShippingLabelAddress {
-        ShippingLabelAddress(company: company,
-                             name: fullName,
-                             phone: phone,
-                             country: country,
-                             state: state,
-                             address1: address1,
-                             address2: address2,
-                             city: city,
-                             postcode: postcode)
-    }
-}
-
-private extension WooShippingAddress {
-    /// Converts the address to a `ShippingLabelAddress`.
-    ///
-    /// This prepares the address for use in e.g. fetching available shipping rates or purchasing the label.
-    ///
-    func toShippingLabelAddress() -> ShippingLabelAddress {
-        ShippingLabelAddress(company: company,
-                             name: name,
-                             phone: phone,
-                             country: country,
-                             state: state,
-                             address1: address1,
-                             address2: address2,
-                             city: city,
-                             postcode: postcode)
+    func toWooShippingAddress() -> WooShippingAddress {
+        WooShippingAddress(company: company,
+                           name: fullName,
+                           phone: phone,
+                           country: country,
+                           state: state,
+                           address1: address1,
+                           address2: address2,
+                           city: city,
+                           postcode: postcode)
     }
 }
 
diff --git a/Yosemite/Yosemite/Actions/WooShippingAction.swift b/Yosemite/Yosemite/Actions/WooShippingAction.swift
@@ -18,8 +18,8 @@ public enum WooShippingAction: Action {
     ///
     case loadLabelRates(siteID: Int64,
                         orderID: Int64,
-                        originAddress: ShippingLabelAddress,
-                        destinationAddress: ShippingLabelAddress,
+                        originAddress: WooShippingAddress,
+                        destinationAddress: WooShippingAddress,
                         packages: [ShippingLabelPackageSelected],
                         completion: (Result<[ShippingLabelCarriersAndRates], Error>) -> Void)
 
@@ -37,8 +37,8 @@ public enum WooShippingAction: Action {
     ///
     case purchaseShippingLabel(siteID: Int64,
                                orderID: Int64,
-                               originAddress: ShippingLabelAddress,
-                               destinationAddress: ShippingLabelAddress,
+                               originAddress: WooShippingAddress,
+                               destinationAddress: WooShippingAddress,
                                package: WooShippingPackagePurchase,
                                backendProcessingDelay: TimeInterval = 2.0,
                                pollingDelay: TimeInterval = 1.0,
@@ -60,7 +60,7 @@ public enum WooShippingAction: Action {
     /// Validate a shipping address.
     ///
     case validateAddress(siteID: Int64,
-                         address: ShippingLabelAddress,
+                         address: WooShippingAddress,
                          completion: (Result<WooShippingAddressValidationSuccess, Error>) -> Void)
 
     /// Update an origin address.
diff --git a/Yosemite/Yosemite/Stores/WooShippingStore.swift b/Yosemite/Yosemite/Stores/WooShippingStore.swift
@@ -109,8 +109,8 @@ private extension WooShippingStore {
 
     func loadLabelRates(siteID: Int64,
                         orderID: Int64,
-                        originAddress: ShippingLabelAddress,
-                        destinationAddress: ShippingLabelAddress,
+                        originAddress: WooShippingAddress,
+                        destinationAddress: WooShippingAddress,
                         packages: [ShippingLabelPackageSelected],
                         completion: @escaping (Result<[ShippingLabelCarriersAndRates], Error>) -> Void) {
         remote.loadLabelRates(siteID: siteID,
@@ -142,8 +142,8 @@ private extension WooShippingStore {
 
     func purchaseShippingLabel(siteID: Int64,
                                orderID: Int64,
-                               originAddress: ShippingLabelAddress,
-                               destinationAddress: ShippingLabelAddress,
+                               originAddress: WooShippingAddress,
+                               destinationAddress: WooShippingAddress,
                                package: WooShippingPackagePurchase,
                                backendProcessingDelay: TimeInterval,
                                pollingDelay: TimeInterval,
@@ -256,7 +256,7 @@ private extension WooShippingStore {
     }
 
     func validateAddress(siteID: Int64,
-                         address: ShippingLabelAddress,
+                         address: WooShippingAddress,
                          completion: @escaping (Result<WooShippingAddressValidationSuccess, Error>) -> Void) {
         remote.addressValidation(siteID: siteID, address: address, completion: completion)
     }
