Shipping Labels: Display correct HAZMAT category on purchased label (#16081)

Author: itsmeichigo

Modules/Sources/Fakes/NetworkingCore.generated.swift

@@ -456,7 +456,8 @@ extension NetworkingCore.ShippingLabel {
             productNames: .fake(),
             commercialInvoiceURL: .fake(),
             usedDate: .fake(),
-            expiryDate: .fake()
+            expiryDate: .fake(),
+            hazmatCategory: .fake()
         )
     }
 }

Modules/Sources/Networking/Mapper/WooShippingConfigMapper.swift

@@ -48,6 +48,7 @@ extension WooShippingConfigMapper {
         "config.shipments",
         "config.shippingLabelData.currentOrderLabels",
         "config.shippingLabelData.storedData.selected_destination",
-        "config.shippingLabelData.storedData.selected_origin"
+        "config.shippingLabelData.storedData.selected_origin",
+        "config.shippingLabelData.storedData.selected_hazmat"
     ].joined(separator: ", ")
 }

Modules/Sources/Networking/Model/ShippingLabel/Shipments/WooShippingConfigResponse.swift

@@ -111,11 +111,13 @@ public struct WooShippingLabelData: Decodable, Equatable {
 
         let destinations = storedData?.selectedDestinations
         let origins = storedData?.selectedOrigins
+        let hazmatSelections = storedData?.selectedHazmat
 
         if destinations?.isEmpty == false || origins?.isEmpty == false {
             orderLabels = WooShippingLabelData.mapAddresses(
                 origins: origins,
                 destinations: destinations,
+                hazmatSelections: hazmatSelections,
                 into: decodedOrderLabels
             )
         } else {
@@ -136,14 +138,17 @@ public struct WooShippingLabelData: Decodable, Equatable {
 
 public extension WooShippingLabelData {
     typealias WooShippingLabelAddressMap = [String: WooShippingAddress]
+    typealias WooShippingHazmatMap = [String: HazmatSelection]
 
     struct StoredData: Decodable, Equatable {
         let selectedDestinations: WooShippingLabelAddressMap?
         let selectedOrigins: WooShippingLabelAddressMap?
+        let selectedHazmat: WooShippingHazmatMap?
 
         public enum CodingKeys: String, CodingKey {
             case selectedDestination = "selected_destination"
             case selectedOrigin = "selected_origin"
+            case selectedHazmat = "selected_hazmat"
         }
 
         public init(from decoder: any Decoder) throws {
@@ -156,6 +161,7 @@ public extension WooShippingLabelData {
                 WooShippingLabelAddressMap.self,
                 forKey: CodingKeys.selectedOrigin
             )
+            selectedHazmat = try? container.decodeIfPresent(WooShippingHazmatMap.self, forKey: .selectedHazmat)
         }
     }
 }
@@ -166,3 +172,7 @@ enum WooShippingConfigDecodingError: Error {
     case missingSiteID
     case missingOrderID
 }
+
+public struct HazmatSelection: Decodable, Equatable {
+    public let category: String
+}

Modules/Sources/Networking/Model/ShippingLabel/Shipments/WooShippingLabelData+mapDestinations.swift

@@ -4,6 +4,7 @@ extension WooShippingLabelData {
     static func mapAddresses(
         origins: WooShippingLabelAddressMap?,
         destinations: WooShippingLabelAddressMap?,
+        hazmatSelections: WooShippingHazmatMap?,
         into labels: [ShippingLabel]
     ) -> [ShippingLabel] {
         return labels.map { label in
@@ -14,10 +15,12 @@ extension WooShippingLabelData {
             let formattedID = WooShippingShipmentIDFormatter.formattedShipmentID(shipmentID)
             let originAddress = origins?[formattedID] ?? origins?[shipmentID]
             let destinationAddress = destinations?[formattedID] ?? destinations?[shipmentID]
+            let hazmat = hazmatSelections?[formattedID] ?? hazmatSelections?[shipmentID]
 
             return label.copy(
                 originAddress: originAddress?.toShippingLabelAddress() ?? .copy,
-                destinationAddress: destinationAddress?.toShippingLabelAddress() ?? .copy
+                destinationAddress: destinationAddress?.toShippingLabelAddress() ?? .copy,
+                hazmatCategory: hazmat?.category
             )
         }
     }

Modules/Sources/NetworkingCore/Model/Copiable/Models+Copiable.generated.swift

@@ -716,7 +716,8 @@ extension NetworkingCore.ShippingLabel {
         productNames: CopiableProp<[String]> = .copy,
         commercialInvoiceURL: NullableCopiableProp<String> = .copy,
         usedDate: NullableCopiableProp<Date> = .copy,
-        expiryDate: NullableCopiableProp<Date> = .copy
+        expiryDate: NullableCopiableProp<Date> = .copy,
+        hazmatCategory: NullableCopiableProp<String> = .copy
     ) -> NetworkingCore.ShippingLabel {
         let siteID = siteID ?? self.siteID
         let orderID = orderID ?? self.orderID
@@ -739,6 +740,7 @@ extension NetworkingCore.ShippingLabel {
         let commercialInvoiceURL = commercialInvoiceURL ?? self.commercialInvoiceURL
         let usedDate = usedDate ?? self.usedDate
         let expiryDate = expiryDate ?? self.expiryDate
+        let hazmatCategory = hazmatCategory ?? self.hazmatCategory
 
         return NetworkingCore.ShippingLabel(
             siteID: siteID,
@@ -761,7 +763,8 @@ extension NetworkingCore.ShippingLabel {
             productNames: productNames,
             commercialInvoiceURL: commercialInvoiceURL,
             usedDate: usedDate,
-            expiryDate: expiryDate
+            expiryDate: expiryDate,
+            hazmatCategory: hazmatCategory
         )
     }
 }

Modules/Sources/NetworkingCore/Model/ShippingLabel/ShippingLabel.swift

@@ -71,6 +71,9 @@ public struct ShippingLabel: Equatable, Sendable, GeneratedCopiable, GeneratedFa
     /// Expiry date of the label
     public let expiryDate: Date?
 
+    /// Selected HAZMAT category of the label
+    public let hazmatCategory: String?
+
     public init(siteID: Int64,
                 orderID: Int64,
                 shippingLabelID: Int64,
@@ -91,7 +94,8 @@ public struct ShippingLabel: Equatable, Sendable, GeneratedCopiable, GeneratedFa
                 productNames: [String],
                 commercialInvoiceURL: String?,
                 usedDate: Date?,
-                expiryDate: Date?) {
+                expiryDate: Date?,
+                hazmatCategory: String?) {
         self.siteID = siteID
         self.orderID = orderID
         self.shippingLabelID = shippingLabelID
@@ -113,6 +117,7 @@ public struct ShippingLabel: Equatable, Sendable, GeneratedCopiable, GeneratedFa
         self.commercialInvoiceURL = commercialInvoiceURL
         self.usedDate = usedDate
         self.expiryDate = expiryDate
+        self.hazmatCategory = hazmatCategory
     }
 }
 
@@ -177,7 +182,8 @@ extension ShippingLabel: Decodable {
                   productNames: productNames,
                   commercialInvoiceURL: commercialInvoiceURL,
                   usedDate: usedDate,
-                  expiryDate: expiryDate)
+                  expiryDate: expiryDate,
+                  hazmatCategory: nil) // hazmat category is not available in label details, will be updated later
     }
 
     private enum CodingKeys: String, CodingKey {

Modules/Sources/Storage/Model/MIGRATIONS.md

@@ -2,6 +2,10 @@
 
 This file documents changes in the WCiOS Storage data model. Please explain any changes to the data model as well as any custom migrations.
 
+## Model 125 (Release 23.2.0.0)
+- @itsmeichigo 2025-09-04
+  - Added `hazmatCategory` attribute to `ShippingLabel` entity.
+
 ## Model 124 (Release 22.9.0.0)
 - @itsmeichigo 2025-07-11
   - Added `WooShippingShipment` entity.

Modules/Sources/Storage/Model/ShippingLabel+CoreDataProperties.swift

@@ -31,5 +31,6 @@ extension ShippingLabel {
     @NSManaged public var commercialInvoiceURL: String?
     @NSManaged public var usedDate: Date?
     @NSManaged public var expiryDate: Date?
+    @NSManaged public var hazmatCategory: String?
 
 }

Modules/Sources/Storage/Resources/WooCommerce.xcdatamodeld/.xccurrentversion

@@ -3,6 +3,6 @@
 <plist version="1.0">
 <dict>
 	<key>_XCCurrentVersionName</key>
-	<string>Model 124.xcdatamodel</string>
+	<string>Model 125.xcdatamodel</string>
 </dict>
 </plist>