Merge branch 'trunk' into woomob-1210-remove-unused-properties-from-pos-entities

Author: joshheald

Modules/Sources/Networking/Remote/POSCatalogSyncRemote.swift

@@ -5,6 +5,8 @@ import Foundation
 public class POSCatalogSyncRemote: Remote {
     private let dateFormatter = ISO8601DateFormatter()
 
+    // MARK: - Incremental Sync Endpoints
+
     /// Loads POS products modified after the specified date.
     ///
     /// - Parameters:
@@ -16,7 +18,7 @@ public class POSCatalogSyncRemote: Remote {
     // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
     public func loadProducts(modifiedAfter: Date, siteID: Int64, pageNumber: Int)
     async throws -> PagedItems<POSProduct> {
-        let path = "products"
+        let path = Path.products
         let parameters = [
             ParameterKey.modifiedAfter: dateFormatter.string(from: modifiedAfter),
             ParameterKey.page: String(pageNumber),
@@ -41,7 +43,7 @@ public class POSCatalogSyncRemote: Remote {
     ///
     // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
     public func loadProductVariations(modifiedAfter: Date, siteID: Int64, pageNumber: Int) async throws -> PagedItems<POSProductVariation> {
-        let path = "variations"
+        let path = Path.variations
         let parameters = [
             ParameterKey.modifiedAfter: dateFormatter.string(from: modifiedAfter),
             ParameterKey.page: String(pageNumber),
@@ -56,62 +58,52 @@ public class POSCatalogSyncRemote: Remote {
         return createPagedItems(items: variations, responseHeaders: responseHeaders, currentPageNumber: pageNumber)
     }
 
-    /// Generates a POS catalog. The catalog is generated asynchronously and a download URL is returned in the
-    /// status response endpoint associated with a job ID.
+    // MARK: - Full Sync Endpoints
+
+    /// Loads POS products for full sync.
     ///
     /// - Parameters:
-    ///   - siteID: Site ID to generate catalog for.
-    ///   - fields: Optional array of fields to include in catalog.
-    ///   - forceGenerate: Whether to force generation of a new catalog.
-    /// - Returns: Catalog job response with job ID.
+    ///   - siteID: Site ID to load products from.
+    ///   - pageNumber: Page number for pagination.
+    /// - Returns: Paginated list of POS products.
     ///
     // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
-    public func generateCatalog(for siteID: Int64, forceGenerate: Bool = false) async throws -> POSCatalogGenerationResponse {
-        let path = "catalog"
-        let parameters: [String: Any] = [
-            ParameterKey.fullSyncFields: POSProduct.requestFields
+    public func loadProducts(siteID: Int64, pageNumber: Int) async throws -> PagedItems<POSProduct> {
+        let path = Path.products
+        let parameters = [
+            ParameterKey.page: String(pageNumber),
+            ParameterKey.perPage: String(Constants.defaultPageSize),
+            ParameterKey.fields: POSProduct.requestFields.joined(separator: ",")
         ]
 
-        let request = JetpackRequest(wooApiVersion: .mark3, method: .post, siteID: siteID, path: path, parameters: parameters, availableAsRESTRequest: true)
-        let mapper = SingleItemMapper<POSCatalogGenerationResponse>(siteID: siteID)
-        return try await enqueue(request, mapper: mapper)
+        let request = JetpackRequest(wooApiVersion: .mark3, method: .get, siteID: siteID, path: path, parameters: parameters)
+        let mapper = ListMapper<POSProduct>(siteID: siteID)
+        let (products, responseHeaders) = try await enqueueWithResponseHeaders(request, mapper: mapper)
+
+        return createPagedItems(items: products, responseHeaders: responseHeaders, currentPageNumber: pageNumber)
     }
 
-    /// Checks the status of a catalog generation job. A download URL is returned when the job is complete.
+    /// Loads POS product variations for full sync.
     ///
     /// - Parameters:
-    ///   - siteID: Site ID for the catalog job.
-    ///   - jobID: Job ID to check status for.
-    /// - Returns: Catalog status response.
+    ///   - siteID: Site ID to load variations from.
+    ///   - pageNumber: Page number for pagination.
+    /// - Returns: Paginated list of POS product variations.
     ///
     // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
-    public func checkCatalogStatus(for siteID: Int64, jobID: String) async throws -> POSCatalogStatusResponse {
-        let path = "catalog/status/\(jobID)"
+    public func loadProductVariations(siteID: Int64, pageNumber: Int) async throws -> PagedItems<POSProductVariation> {
+        let path = Path.variations
+        let parameters = [
+            ParameterKey.page: String(pageNumber),
+            ParameterKey.perPage: String(Constants.defaultPageSize),
+            ParameterKey.fields: POSProductVariation.requestFields.joined(separator: ",")
+        ]
 
-        let request = JetpackRequest(wooApiVersion: .mark3, method: .get, siteID: siteID, path: path, availableAsRESTRequest: true)
-        let mapper = SingleItemMapper<POSCatalogStatusResponse>(siteID: siteID)
-        return try await enqueue(request, mapper: mapper)
-    }
+        let request = JetpackRequest(wooApiVersion: .wcAnalytics, method: .get, siteID: siteID, path: path, parameters: parameters)
+        let mapper = ListMapper<POSProductVariation>(siteID: siteID)
+        let (variations, responseHeaders) = try await enqueueWithResponseHeaders(request, mapper: mapper)
 
-    /// Downloads the generated catalog at the specified download URL.
-    /// - Parameters:
-    ///   - siteID: Site ID to download catalog for.
-    ///   - downloadURL: Download URL of the catalog file.
-    /// - Returns: List of products and variations in the POS catalog.
-    // periphery:ignore - TODO - remove this periphery ignore comment when this method is integrated with catalog sync
-    public func downloadCatalog(for siteID: Int64, downloadURL: String) async throws -> POSCatalog {
-        // TODO: WOOMOB-1173 - move download task to the background using `URLSessionConfiguration.background`
-        guard let url = URL(string: downloadURL) else {
-            throw NetworkError.invalidURL
-        }
-        let request = URLRequest(url: url)
-        let mapper = ListMapper<POSProduct>(siteID: siteID)
-        let items = try await enqueue(request, mapper: mapper)
-        let variationProductTypeKey = "variation"
-        let products = items.filter { $0.productTypeKey != variationProductTypeKey }
-        let variations = items.filter { $0.productTypeKey == variationProductTypeKey }
-            .map { $0.toVariation }
-        return POSCatalog(products: products, variations: variations)
+        return createPagedItems(items: variations, responseHeaders: responseHeaders, currentPageNumber: pageNumber)
     }
 }
 
@@ -127,54 +119,14 @@ private extension POSCatalogSyncRemote {
         static let page = "page"
         static let perPage = "per_page"
         static let fields = "_fields"
-        static let fullSyncFields = "fields"
-    }
-}
-
-// MARK: - Response Models
-
-/// Response from catalog generation request.
-// periphery:ignore - TODO - remove this periphery ignore comment when the corresponding endpoint is integrated with catalog sync
-public struct POSCatalogGenerationResponse: Decodable {
-    /// Unique identifier for tracking the catalog generation job.
-    public let jobID: String
-
-    private enum CodingKeys: String, CodingKey {
-        case jobID = "job_id"
     }
-}
 
-/// Response from catalog status check.
-// periphery:ignore - TODO - remove this periphery ignore comment when the corresponding endpoint is integrated with catalog sync
-public struct POSCatalogStatusResponse: Decodable {
-    /// Current status of the catalog generation job.
-    public let status: POSCatalogStatus
-    /// Download URL for the completed catalog (available when status is complete).
-    public let downloadURL: String?
-    /// Progress percentage of the catalog generation (0.0 to 100.0).
-    public let progress: Double
-
-    private enum CodingKeys: String, CodingKey {
-        case status
-        case downloadURL = "download_url"
-        case progress
+    enum Path {
+        static let products = "products"
+        static let variations = "variations"
     }
 }
 
-/// Catalog generation status.
-public enum POSCatalogStatus: String, Decodable {
-    case pending
-    case processing
-    case complete
-}
-
-/// POS catalog from download.
-// periphery:ignore - TODO - remove this periphery ignore comment when the corresponding endpoint is integrated with catalog sync
-public struct POSCatalog {
-    public let products: [POSProduct]
-    public let variations: [POSProductVariation]
-}
-
 private extension POSProduct {
     var toVariation: POSProductVariation {
         let variationAttributes = attributes.compactMap { attribute in
@@ -199,4 +151,4 @@ private extension POSProduct {
             stockStatusKey: stockStatusKey
         )
     }
-}
+}

Modules/Sources/Yosemite/PointOfSale/POSReceiptInformation.swift

@@ -0,0 +1,24 @@
+
+public struct POSReceiptInformation: Equatable {
+    public let storeName: String?
+    public let storeAddress: String?
+    public let phone: String?
+    public let email: String?
+    public let refundReturnsPolicy: String?
+
+    public init(storeName: String?, storeAddress: String?, phone: String?, email: String?, refundReturnsPolicy: String?) {
+        self.storeName = storeName
+        self.storeAddress = storeAddress
+        self.phone = phone
+        self.email = email
+        self.refundReturnsPolicy = refundReturnsPolicy
+    }
+
+    public static let empty = POSReceiptInformation(
+        storeName: nil,
+        storeAddress: nil,
+        phone: nil,
+        email: nil,
+        refundReturnsPolicy: nil
+    )
+}

Modules/Sources/Yosemite/Tools/POS/PointOfSaleSettingsService.swift

@@ -3,8 +3,7 @@ import Networking
 import Storage
 
 public protocol PointOfSaleSettingsServiceProtocol {
-    var siteID: Int64 { get }
-    func retrievePointOfSaleSettings() async throws -> [SiteSetting]
+    func retrievePointOfSaleSettings() async throws -> POSReceiptInformation
 }
 
 public final class PointOfSaleSettingsService: PointOfSaleSettingsServiceProtocol {
@@ -25,7 +24,19 @@ public final class PointOfSaleSettingsService: PointOfSaleSettingsServiceProtoco
                                                                            network: network))
     }
 
-    public func retrievePointOfSaleSettings() async throws -> [SiteSetting] {
-        return try await settingStoreMethods.retrievePointOfSaleSettings(siteID: siteID)
+    public func retrievePointOfSaleSettings() async throws -> POSReceiptInformation {
+        let siteSettings = try await settingStoreMethods.retrievePointOfSaleSettings(siteID: siteID)
+        return POSReceiptInformation(
+            storeName: settingValue(from: siteSettings, settingID: "woocommerce_pos_store_name"),
+            storeAddress: settingValue(from: siteSettings, settingID: "woocommerce_pos_store_address"),
+            phone: settingValue(from: siteSettings, settingID: "woocommerce_pos_store_phone"),
+            email: settingValue(from: siteSettings, settingID: "woocommerce_pos_store_email"),
+            refundReturnsPolicy: settingValue(from: siteSettings, settingID: "woocommerce_pos_refund_returns_policy")
+        )
+    }
+
+    private func settingValue(from siteSettings: [SiteSetting], settingID: String) -> String? {
+        let value = siteSettings.first { $0.settingID == settingID }?.value
+        return value?.isEmpty == true ? nil : value
     }
 }