Merge pull request #4938 from woocommerce/issue/4599-form-view-model-multi-package

Shipping Labels: Update purchase form view model to support multi-package

Author: itsmeichigo

WooCommerce/Classes/Model/ShippingLabelPackageAttributes.swift

@@ -0,0 +1,15 @@
+import Foundation
+
+/// A structure to hold the basic details for a selected package on Package Details screen of Shipping Label purchase flow.
+///
+struct ShippingLabelPackageAttributes: Hashable, Equatable {
+
+    /// ID of the selected package.
+    let packageID: String
+
+    /// Total weight of the package in string value.
+    let totalWeight: String
+
+    /// List of product or variation IDs for items in the package.
+    let productIDs: [Int64]
+}

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Package Selection/ShippingLabelPackageList.swift

@@ -96,8 +96,7 @@ struct ShippingLabelPackageList_Previews: PreviewProvider {
     static var previews: some View {
         let viewModel = ShippingLabelPackageDetailsViewModel(order: ShippingLabelPackageDetailsViewModel.sampleOrder(),
                                                              packagesResponse: ShippingLabelPackageDetailsViewModel.samplePackageDetails(),
-                                                             selectedPackageID: nil,
-                                                             totalWeight: nil)
+                                                             selectedPackages: [])
 
         ShippingLabelPackageList(viewModel: viewModel)
     }

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Package Selection/ShippingLabelPackageSelection.swift

@@ -18,12 +18,10 @@ struct ShippingLabelPackageSelection_Previews: PreviewProvider {
     static var previews: some View {
         let viewModelWithPackages = ShippingLabelPackageDetailsViewModel(order: ShippingLabelPackageDetailsViewModel.sampleOrder(),
                                                              packagesResponse: ShippingLabelPackageDetailsViewModel.samplePackageDetails(),
-                                                             selectedPackageID: nil,
-                                                             totalWeight: nil)
+                                                             selectedPackages: [])
         let viewModelWithoutPackages = ShippingLabelPackageDetailsViewModel(order: ShippingLabelPackageDetailsViewModel.sampleOrder(),
                                                              packagesResponse: nil,
-                                                             selectedPackageID: nil,
-                                                             totalWeight: nil)
+                                                             selectedPackages: [])
 
         ShippingLabelPackageSelection(viewModel: viewModelWithPackages)
 

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/ShippingLabelPackageDetails.swift

@@ -8,7 +8,7 @@ struct ShippingLabelPackageDetails: View {
 
     /// Completion callback
     ///
-    typealias Completion = (_ selectedPackageID: String?, _ totalPackageWeight: String?) -> Void
+    typealias Completion = (_ selectedPackages: [ShippingLabelPackageAttributes]) -> Void
     private let onCompletion: Completion
 
     init(viewModel: ShippingLabelPackageDetailsViewModel, completion: @escaping Completion) {
@@ -82,7 +82,7 @@ struct ShippingLabelPackageDetails: View {
         .navigationBarItems(trailing: Button(action: {
             ServiceLocator.analytics.track(.shippingLabelPurchaseFlow,
                                            withProperties: ["state": "packages_selected"])
-            onCompletion(viewModel.selectedPackageID, viewModel.totalWeight)
+            onCompletion(viewModel.selectedPackagesDetails)
             presentation.wrappedValue.dismiss()
         }, label: {
             Text(Localization.doneButton)
@@ -117,15 +117,14 @@ struct ShippingLabelPackageDetails_Previews: PreviewProvider {
 
         let viewModel = ShippingLabelPackageDetailsViewModel(order: ShippingLabelPackageDetailsViewModel.sampleOrder(),
                                                              packagesResponse: ShippingLabelPackageDetailsViewModel.samplePackageDetails(),
-                                                             selectedPackageID: nil,
-                                                             totalWeight: nil)
+                                                             selectedPackages: [])
 
-        ShippingLabelPackageDetails(viewModel: viewModel, completion: { (selectedPackageID, totalPackageWeight) in
+        ShippingLabelPackageDetails(viewModel: viewModel, completion: { _ in
         })
         .environment(\.colorScheme, .light)
         .previewDisplayName("Light")
 
-        ShippingLabelPackageDetails(viewModel: viewModel, completion: { (selectedPackageID, totalPackageWeight) in
+        ShippingLabelPackageDetails(viewModel: viewModel, completion: { _ in
         })
         .environment(\.colorScheme, .dark)
         .previewDisplayName("Dark")

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/ShippingLabelPackageDetailsViewModel.swift

@@ -56,6 +56,16 @@ final class ShippingLabelPackageDetailsViewModel: ObservableObject {
     ///
     @Published var selectedPackageID: String?
 
+    /// List of selected package with basic info.
+    /// TODO-4599: update this to properly support multi-package.
+    ///
+    var selectedPackagesDetails: [ShippingLabelPackageAttributes] {
+        guard let id = selectedPackageID, totalWeight.isNotEmpty else {
+            return []
+        }
+        return [ShippingLabelPackageAttributes(packageID: id, totalWeight: totalWeight, productIDs: orderItems.map { $0.productOrVariationID })]
+    }
+
     /// The title of the selected package, if any.
     ///
     var selectedPackageName: String {
@@ -87,8 +97,7 @@ final class ShippingLabelPackageDetailsViewModel: ObservableObject {
 
     init(order: Order,
          packagesResponse: ShippingLabelPackagesResponse?,
-         selectedPackageID: String?,
-         totalWeight: String?,
+         selectedPackages: [ShippingLabelPackageAttributes],
          formatter: CurrencyFormatter = CurrencyFormatter(currencySettings: ServiceLocator.currencySettings),
          stores: StoresManager = ServiceLocator.stores,
          storageManager: StorageManagerType = ServiceLocator.storageManager,
@@ -101,14 +110,14 @@ final class ShippingLabelPackageDetailsViewModel: ObservableObject {
         self.storageManager = storageManager
         self.weightUnit = weightUnit
         self.packagesResponse = packagesResponse
-        self.selectedPackageID = selectedPackageID
+        self.selectedPackageID = selectedPackages.first?.packageID // TODO-4599: fix this
 
         configureResultsControllers()
         setDefaultPackage()
         syncProducts()
         syncProductVariations()
         configureItemRows()
-        configureTotalWeights(initialTotalWeight: totalWeight)
+        configureTotalWeights(initialTotalWeight: selectedPackages.first?.totalWeight) // TODO-4599: fix this
     }
 
     /// Observe changes in products and variations to update item rows.

WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/ShippingLabelFormViewController.swift

@@ -159,8 +159,7 @@ extension ShippingLabelFormViewController: UITableViewDelegate {
         case Row(type: .shipTo, dataState: .validated, displayMode: .editable):
             displayEditAddressFormVC(address: viewModel.destinationAddress, validationError: nil, type: .destination)
         case Row(type: .packageDetails, dataState: .validated, displayMode: .editable):
-            displayPackageDetailsVC(selectedPackageID: viewModel.selectedPackageID,
-                                    totalPackageWeight: viewModel.totalPackageWeight)
+            displayPackageDetailsVC(inputPackages: viewModel.selectedPackagesDetails)
         case Row(type: .customs, dataState: .validated, displayMode: .editable):
             displayCustomsFormListVC(customsForms: viewModel.customsForms)
         case Row(type: .shippingCarrierAndRates, dataState: .validated, displayMode: .editable):
@@ -278,8 +277,8 @@ private extension ShippingLabelFormViewController {
                        title: Localization.packageDetailsCellTitle,
                        body: viewModel.getPackageDetailsBody(),
                        buttonTitle: Localization.continueButtonInCells) { [weak self] in
-            self?.displayPackageDetailsVC(selectedPackageID: self?.viewModel.selectedPackageID,
-                                          totalPackageWeight: self?.viewModel.totalPackageWeight)
+            guard let self = self else { return }
+            self.displayPackageDetailsVC(inputPackages: self.viewModel.selectedPackagesDetails)
         }
     }
 
@@ -417,13 +416,12 @@ private extension ShippingLabelFormViewController {
         navigationController?.pushViewController(vc, animated: true)
     }
 
-    func displayPackageDetailsVC(selectedPackageID: String?, totalPackageWeight: String?) {
+    func displayPackageDetailsVC(inputPackages: [ShippingLabelPackageAttributes]) {
         let vm = ShippingLabelPackageDetailsViewModel(order: viewModel.order,
                                                       packagesResponse: viewModel.packagesResponse,
-                                                      selectedPackageID: selectedPackageID,
-                                                      totalWeight: totalPackageWeight)
-        let packageDetails = ShippingLabelPackageDetails(viewModel: vm) { [weak self] (selectedPackageID, totalPackageWeight) in
-            self?.viewModel.handlePackageDetailsValueChanges(selectedPackageID: selectedPackageID, totalPackageWeight: totalPackageWeight)
+                                                      selectedPackages: inputPackages)
+        let packageDetails = ShippingLabelPackageDetails(viewModel: vm) { [weak self] selectedPackages in
+            self?.viewModel.handlePackageDetailsValueChanges(details: selectedPackages)
         }
 
         let hostingVC = UIHostingController(rootView: packageDetails)
@@ -451,14 +449,14 @@ private extension ShippingLabelFormViewController {
                                    selectedAdultSignatureRate: ShippingLabelCarrierRate?) {
         guard let originAddress = viewModel.originAddress,
               let destinationAddress = viewModel.destinationAddress,
-              let selectedPackage = viewModel.selectedPackage else {
+              viewModel.selectedPackages.isNotEmpty else {
             return
         }
 
         let vm = ShippingLabelCarriersViewModel(order: viewModel.order,
                                                 originAddress: originAddress,
                                                 destinationAddress: destinationAddress,
-                                                packages: [selectedPackage],
+                                                packages: viewModel.selectedPackages,
                                                 selectedRate: selectedRate,
                                                 selectedSignatureRate: selectedSignatureRate,
                                                 selectedAdultSignatureRate: selectedAdultSignatureRate)
@@ -500,9 +498,10 @@ private extension ShippingLabelFormViewController {
 
     /// Removes the Shipping Label Form from the navigation stack and displays the Print Shipping Label screen.
     /// This prevents navigating back to the purchase form after successfully purchasing the label.
+    /// TODO-4599: Update for multi-package support
     ///
     func displayPrintShippingLabelVC() {
-        guard let purchasedShippingLabel = viewModel.purchasedShippingLabel,
+        guard let purchasedShippingLabel = viewModel.purchasedShippingLabels.first,
               let navigationController = navigationController else {
             return
         }