Include image in OrderItem object

staskus · staskus · commit 8a5a2bfef3d4 · 2025-09-04T14:26:01.000+03:00
diff --git a/Modules/Sources/Fakes/NetworkingCore.generated.swift b/Modules/Sources/Fakes/NetworkingCore.generated.swift
@@ -270,6 +270,7 @@ extension NetworkingCore.OrderItem {
             totalTax: .fake(),
             attributes: .fake(),
             addOns: .fake(),
+            image: .fake(),
             parent: .fake(),
             bundleConfiguration: .fake()
         )
diff --git a/Modules/Sources/Networking/Model/Copiable/Models+Copiable.generated.swift b/Modules/Sources/Networking/Model/Copiable/Models+Copiable.generated.swift
@@ -5,6 +5,7 @@ import Codegen
 import Foundation
 import WooFoundation
 import struct Alamofire.JSONEncoding
+import struct NetworkingCore.JetpackSite
 
 
 extension Networking.AIProduct {
diff --git a/Modules/Sources/NetworkingCore/Model/Copiable/Models+Copiable.generated.swift b/Modules/Sources/NetworkingCore/Model/Copiable/Models+Copiable.generated.swift
@@ -444,6 +444,7 @@ extension NetworkingCore.OrderItem {
         totalTax: CopiableProp<String> = .copy,
         attributes: CopiableProp<[OrderItemAttribute]> = .copy,
         addOns: CopiableProp<[OrderItemProductAddOn]> = .copy,
+        image: NullableCopiableProp<OrderItemProductImage> = .copy,
         parent: NullableCopiableProp<Int64> = .copy,
         bundleConfiguration: CopiableProp<[OrderItemBundleItem]> = .copy
     ) -> NetworkingCore.OrderItem {
@@ -462,6 +463,7 @@ extension NetworkingCore.OrderItem {
         let totalTax = totalTax ?? self.totalTax
         let attributes = attributes ?? self.attributes
         let addOns = addOns ?? self.addOns
+        let image = image ?? self.image
         let parent = parent ?? self.parent
         let bundleConfiguration = bundleConfiguration ?? self.bundleConfiguration
 
@@ -481,6 +483,7 @@ extension NetworkingCore.OrderItem {
             totalTax: totalTax,
             attributes: attributes,
             addOns: addOns,
+            image: image,
             parent: parent,
             bundleConfiguration: bundleConfiguration
         )
diff --git a/Modules/Sources/NetworkingCore/Model/OrderItem.swift b/Modules/Sources/NetworkingCore/Model/OrderItem.swift
@@ -30,6 +30,8 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
 
     public let addOns: [OrderItemProductAddOn]
 
+    public let image: OrderItemProductImage?
+
     /// Item ID of parent `OrderItem`, if any.
     ///
     /// An `OrderItem` can have a parent if, for example, it is a bundled item within a product bundle.
@@ -58,6 +60,7 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
                 totalTax: String,
                 attributes: [OrderItemAttribute],
                 addOns: [OrderItemProductAddOn],
+                image: OrderItemProductImage?,
                 parent: Int64?,
                 bundleConfiguration: [OrderItemBundleItem]) {
         self.itemID = itemID
@@ -75,6 +78,7 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
         self.totalTax = totalTax
         self.attributes = attributes
         self.addOns = addOns
+        self.image = image
         self.parent = parent
         self.bundleConfiguration = bundleConfiguration
     }
@@ -123,6 +127,9 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
                                                               forKey: .attributes)
             .first(where: { $0.key == "_pao_ids" })?.value ?? []
 
+        // Order item product image
+        let image = try container.decodeIfPresent(OrderItemProductImage.self, forKey: .image)
+
         // Product Bundle extension properties:
         // If the order item is part of a product bundle, `bundledBy` is the parent order item (product bundle).
         // If it's not a bundled item, the API returns an empty string for `bundledBy` and the value will be `nil`.
@@ -149,6 +156,7 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
                   totalTax: totalTax,
                   attributes: attributes,
                   addOns: productAddOns,
+                  image: image,
                   parent: bundledBy ?? compositeParent,
                   bundleConfiguration: [])
     }
@@ -174,6 +182,10 @@ public struct OrderItem: Codable, Equatable, Hashable, Sendable, GeneratedFakeab
             try container.encode(total, forKey: .total)
         }
 
+        if let image = image {
+            try container.encode(image, forKey: .image)
+        }
+
         if !bundleConfiguration.isEmpty {
             try container.encode(bundleConfiguration, forKey: .bundleConfiguration)
         }
@@ -204,6 +216,7 @@ extension OrderItem {
         case bundledBy      = "bundled_by"
         case compositeParent = "composite_parent"
         case bundleConfiguration = "bundle_configuration"
+        case image
     }
 }
 
@@ -222,3 +235,16 @@ private struct OrderItemProductAddOnContainer: Decodable {
     let key: String
     let value: [OrderItemProductAddOn]
 }
+
+
+// MARK: - Order Item Product Image
+//
+public struct OrderItemProductImage: Codable, Equatable, Hashable, Sendable {
+    public let id: String
+    public let src: String
+
+    public init(id: String, src: String) {
+        self.id = id
+        self.src = src
+    }
+}
diff --git a/Modules/Sources/Yosemite/Model/Mocks/MockObjectGraph.swift b/Modules/Sources/Yosemite/Model/Mocks/MockObjectGraph.swift
@@ -222,6 +222,7 @@ extension MockObjectGraph {
             totalTax: "0",
             attributes: [],
             addOns: [],
+            image: nil,
             parent: nil,
             bundleConfiguration: []
         )
diff --git a/Modules/Sources/Yosemite/Model/Storage/OrderItem+ReadOnlyConvertible.swift b/Modules/Sources/Yosemite/Model/Storage/OrderItem+ReadOnlyConvertible.swift
@@ -55,6 +55,7 @@ extension Storage.OrderItem: ReadOnlyConvertible {
                          totalTax: totalTax ?? "",
                          attributes: attributes,
                          addOns: addOns,
+                         image: nil,
                          parent: parent?.int64Value,
                          bundleConfiguration: [])
     }
diff --git a/Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrderItem.swift b/Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrderItem.swift
@@ -10,6 +10,7 @@ public struct POSOrderItem: Equatable, Hashable {
     public let quantity: Decimal
     public let formattedPrice: String
     public let formattedTotal: String
+    public let imageSrc: String?
     public let attributes: [OrderItemAttribute]
 
     public init(itemID: Int64,
@@ -19,6 +20,7 @@ public struct POSOrderItem: Equatable, Hashable {
                 quantity: Decimal,
                 formattedPrice: String,
                 formattedTotal: String,
+                imageSrc: String?,
                 attributes: [OrderItemAttribute]) {
         self.itemID = itemID
         self.name = name
@@ -27,6 +29,7 @@ public struct POSOrderItem: Equatable, Hashable {
         self.quantity = quantity
         self.formattedPrice = formattedPrice
         self.formattedTotal = formattedTotal
+        self.imageSrc = imageSrc
         self.attributes = attributes
     }
 }
diff --git a/Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrderMapper.swift b/Modules/Sources/Yosemite/PointOfSale/OrderList/POSOrderMapper.swift
@@ -61,6 +61,7 @@ struct POSOrderMapper {
             quantity: orderItem.quantity,
             formattedPrice: currencyFormatter.formatAmount(orderItem.price, with: currency) ?? "",
             formattedTotal: currencyFormatter.formatAmount(orderItem.total, with: currency) ?? "",
+            imageSrc: orderItem.image?.src,
             attributes: orderItem.attributes
         )
     }
diff --git a/Modules/Sources/Yosemite/Stores/Order/ProductInputTransformer.swift b/Modules/Sources/Yosemite/Stores/Order/ProductInputTransformer.swift
@@ -241,6 +241,7 @@ private extension ProductInputTransformer {
                          totalTax: "",
                          attributes: [],
                          addOns: [],
+                         image: nil,
                          parent: nil,
                          bundleConfiguration: input.bundleConfiguration.map {
             switch $0.productOrVariation {
diff --git a/Modules/Tests/YosemiteTests/PointOfSale/POSOrderMapperTests.swift b/Modules/Tests/YosemiteTests/PointOfSale/POSOrderMapperTests.swift
@@ -193,7 +193,8 @@ private extension POSOrderMapperTests {
             quantity: quantity,
             price: price,
             subtotal: subtotal,
-            total: total
+            total: total,
+            image: nil
         )
     }
 
diff --git a/Modules/Tests/YosemiteTests/Stores/Order/OrdersUpsertUseCaseTests.swift b/Modules/Tests/YosemiteTests/Stores/Order/OrdersUpsertUseCaseTests.swift
@@ -549,6 +549,7 @@ private extension OrdersUpsertUseCaseTests {
                   totalTax: "",
                   attributes: [],
                   addOns: [],
+                  image: nil,
                   parent: nil,
                   bundleConfiguration: [])
     }
@@ -573,6 +574,7 @@ private extension OrdersUpsertUseCaseTests {
               totalTax: "0.00",
               attributes: attributes,
               addOns: [],
+              image: nil,
               parent: nil,
               bundleConfiguration: [])
     }
diff --git a/Modules/Tests/YosemiteTests/Stores/OrderStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/OrderStoreTests.swift
@@ -1848,6 +1848,7 @@ private extension OrderStoreTests {
                               totalTax: "1.20",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -1866,6 +1867,7 @@ private extension OrderStoreTests {
                               totalTax: "0.00",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -1888,6 +1890,7 @@ private extension OrderStoreTests {
                               totalTax: "4.00",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -1906,6 +1909,7 @@ private extension OrderStoreTests {
                               totalTax: "0.40",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -1924,6 +1928,7 @@ private extension OrderStoreTests {
                               totalTax: "10.40",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -1946,6 +1951,7 @@ private extension OrderStoreTests {
                               totalTax: "4.00",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
diff --git a/Modules/Tests/YosemiteTests/Stores/ProductVariationStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/ProductVariationStoreTests.swift
@@ -1099,6 +1099,7 @@ private extension ProductVariationStoreTests {
               totalTax: "1.20",
               attributes: [],
               addOns: [],
+              image: nil,
               parent: nil,
               bundleConfiguration: [])
     }
diff --git a/Modules/Tests/YosemiteTests/Stores/ReceiptStoreTests.swift b/Modules/Tests/YosemiteTests/Stores/ReceiptStoreTests.swift
@@ -645,6 +645,7 @@ private extension ReceiptStoreTests {
                            totalTax: "",
                            attributes: [],
                            addOns: [],
+                           image: nil,
                            parent: nil,
                            bundleConfiguration: [])
     }
diff --git a/WooCommerce/Classes/POS/Utils/PreviewHelpers.swift b/WooCommerce/Classes/POS/Utils/PreviewHelpers.swift
@@ -260,6 +260,7 @@ struct POSPreviewHelpers {
                              quantity: 2.0,
                              formattedPrice: "$12.50",
                              formattedTotal: "$25.00",
+                             imageSrc: nil,
                              attributes: []),
                 POSOrderItem(
                     itemID: 2,
@@ -269,6 +270,7 @@ struct POSPreviewHelpers {
                     quantity: 1.0,
                     formattedPrice: "$15.99",
                     formattedTotal: "$15.99",
+                    imageSrc: nil,
                     attributes: [
                         OrderItemAttribute(metaID: 1, name: "Size", value: "Large"),
                         OrderItemAttribute(metaID: 2, name: "Type", value: "Loose Leaf")
@@ -306,6 +308,7 @@ final class PointOfSalePreviewOrderListController: PointOfSaleOrderListControlle
                                  quantity: 2.0,
                                  formattedPrice: "$12.50",
                                  formattedTotal: "$25.00",
+                                 imageSrc: nil,
                                  attributes: []),
                     POSOrderItem(
                         itemID: 2,
@@ -315,6 +318,7 @@ final class PointOfSalePreviewOrderListController: PointOfSaleOrderListControlle
                         quantity: 1.0,
                         formattedPrice: "$15.99",
                         formattedTotal: "$15.99",
+                        imageSrc: nil,
                         attributes: [
                             OrderItemAttribute(metaID: 1, name: "Size", value: "Large"),
                             OrderItemAttribute(metaID: 2, name: "Type", value: "Loose Leaf")
@@ -346,6 +350,7 @@ final class PointOfSalePreviewOrderListController: PointOfSaleOrderListControlle
                         quantity: 3.0,
                         formattedPrice: "$19.99",
                         formattedTotal: "$59.97",
+                        imageSrc: nil,
                         attributes: []
                     ),
                     POSOrderItem(
@@ -356,6 +361,7 @@ final class PointOfSalePreviewOrderListController: PointOfSaleOrderListControlle
                         quantity: 1.0,
                         formattedPrice: "$29.99",
                         formattedTotal: "$29.99",
+                        imageSrc: nil,
                         attributes: [
                             OrderItemAttribute(metaID: 3, name: "Flavor", value: "Mixed"),
                             OrderItemAttribute(metaID: 4, name: "Packaging", value: "Gift Box")
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Multi-package/ShippingLabelPackagesFormViewModel.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/Multi-package/ShippingLabelPackagesFormViewModel.swift
@@ -541,6 +541,7 @@ extension ShippingLabelPackagesFormViewModel {
                               totalTax: "1.20",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -559,6 +560,7 @@ extension ShippingLabelPackagesFormViewModel {
                               totalTax: "0.00",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
diff --git a/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/ShippingLabelSampleData.swift b/WooCommerce/Classes/ViewRelated/Orders/Order Details/Shipping Labels/Create Shipping Label Form/Package Details/ShippingLabelSampleData.swift
@@ -123,6 +123,7 @@ private extension ShippingLabelSampleData {
                               totalTax: "1.20",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
@@ -141,6 +142,7 @@ private extension ShippingLabelSampleData {
                               totalTax: "0.00",
                               attributes: [],
                               addOns: [],
+                              image: nil,
                               parent: nil,
                               bundleConfiguration: [])
 
diff --git a/WooCommerce/WooCommerceTests/POS/Mocks/MockPointOfSaleOrderListService.swift b/WooCommerce/WooCommerceTests/POS/Mocks/MockPointOfSaleOrderListService.swift
@@ -85,6 +85,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 2,
                     formattedPrice: "$10.00",
                     formattedTotal: "$20.00",
+                    imageSrc: nil,
                     attributes: []
                 ),
                 POSOrderItem(
@@ -95,6 +96,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 1,
                     formattedPrice: "$5.99",
                     formattedTotal: "$5.99",
+                    imageSrc: nil,
                     attributes: []
                 )
             ],
@@ -124,6 +126,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 1,
                     formattedPrice: "$15.50",
                     formattedTotal: "$15.50",
+                    imageSrc: nil,
                     attributes: []
                 )
             ],
@@ -159,6 +162,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 1,
                     formattedPrice: "$12.00",
                     formattedTotal: "$12.00",
+                    imageSrc: nil,
                     attributes: []
                 ),
                 POSOrderItem(
@@ -169,6 +173,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 2,
                     formattedPrice: "$15.38",
                     formattedTotal: "$30.75",
+                    imageSrc: nil,
                     attributes: []
                 )
             ],
@@ -198,6 +203,7 @@ extension MockPointOfSaleOrderListService {
                     quantity: 1,
                     formattedPrice: "$12.00",
                     formattedTotal: "$12.00",
+                    imageSrc: nil,
                     attributes: []
                 )
             ],
diff --git a/WooCommerce/WooCommerceTests/Tools/MockOrderItem.swift b/WooCommerce/WooCommerceTests/Tools/MockOrderItem.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Details/OrderDetailsDataSourceTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Details/OrderDetailsDataSourceTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Details/ProductDetailsCellViewModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Orders/Order Details/ProductDetailsCellViewModelTests.swift
diff --git a/WooCommerce/WooCommerceTests/ViewRelated/Products/Product Loader/ProductLoaderViewControllerModelTests.swift b/WooCommerce/WooCommerceTests/ViewRelated/Products/Product Loader/ProductLoaderViewControllerModelTests.swift

Original file line number	Diff line number	Diff line change
`@@ -270,6 +270,7 @@ extension NetworkingCore.OrderItem {`
`270`	`270`	`totalTax: .fake(),`
`271`	`271`	`attributes: .fake(),`
`272`	`272`	`addOns: .fake(),`
	`273`	`+ image: .fake(),`
`273`	`274`	`parent: .fake(),`
`274`	`275`	`bundleConfiguration: .fake()`
`275`	`276`	`)`
Original file line number	Diff line number	Diff line change
`@@ -222,6 +222,7 @@ extension MockObjectGraph {`
`222`	`222`	`totalTax: "0",`
`223`	`223`	`attributes: [],`
`224`	`224`	`addOns: [],`
	`225`	`+ image: nil,`
`225`	`226`	`parent: nil,`
`226`	`227`	`bundleConfiguration: []`
`227`	`228`	`)`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ extension Storage.OrderItem: ReadOnlyConvertible {`
`55`	`55`	`totalTax: totalTax ?? "",`
`56`	`56`	`attributes: attributes,`
`57`	`57`	`addOns: addOns,`
	`58`	`+ image: nil,`
`58`	`59`	`parent: parent?.int64Value,`
`59`	`60`	`bundleConfiguration: [])`
`60`	`61`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,6 +61,7 @@ struct POSOrderMapper {`
`61`	`61`	`quantity: orderItem.quantity,`
`62`	`62`	`formattedPrice: currencyFormatter.formatAmount(orderItem.price, with: currency) ?? "",`
`63`	`63`	`formattedTotal: currencyFormatter.formatAmount(orderItem.total, with: currency) ?? "",`
	`64`	`+ imageSrc: orderItem.image?.src,`
`64`	`65`	`attributes: orderItem.attributes`
`65`	`66`	`)`
`66`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -193,7 +193,8 @@ private extension POSOrderMapperTests {`
`193`	`193`	`quantity: quantity,`
`194`	`194`	`price: price,`
`195`	`195`	`subtotal: subtotal,`
`196`		`- total: total`
	`196`	`+ total: total,`
	`197`	`+ image: nil`
`197`	`198`	`)`
`198`	`199`	`}`
`199`	`200`