Merge branch 'trunk' into woomob-1335-woo-poslocal-catalog-perform-full-sync-on-cellular-data

Author: joshheald

Modules/Sources/Experiments/DefaultFeatureFlagService.swift

@@ -102,6 +102,8 @@ public struct DefaultFeatureFlagService: FeatureFlagService {
             return buildConfig == .localDeveloper || buildConfig == .alpha
         case .pointOfSaleSettingsCardReaderFlow:
             return buildConfig == .localDeveloper || buildConfig == .alpha
+        case .pointOfSaleCatalogAPI:
+            return false
         default:
             return true
         }

Modules/Sources/Experiments/FeatureFlag.swift

@@ -211,4 +211,8 @@ public enum FeatureFlag: Int {
     /// Enables card reader connection flow within POS settings
     ///
     case pointOfSaleSettingsCardReaderFlow
+
+    /// Enables using the catalog API endpoint for Point of Sale catalog full sync
+    ///
+    case pointOfSaleCatalogAPI
 }

Modules/Sources/Networking/Remote/BookingsRemote.swift

@@ -9,8 +9,7 @@ public protocol BookingsRemoteProtocol {
     func loadAllBookings(for siteID: Int64,
                          pageNumber: Int,
                          pageSize: Int,
-                         startDateBefore: String?,
-                         startDateAfter: String?,
+                         filters: BookingFilters?,
                          searchQuery: String?,
                          order: BookingsRemote.Order) async throws -> [Booking]
 
@@ -31,6 +30,35 @@ public protocol BookingsRemoteProtocol {
                         pageSize: Int) async throws -> [BookingResource]
 }
 
+/// Filters for booking queries
+public struct BookingFilters {
+    public let productIDs: [Int64]
+    public let customerIDs: [Int64]
+    public let resourceIDs: [Int64]
+    public let startDateBefore: String?
+    public let startDateAfter: String?
+    public let bookingStatuses: [String]
+    public let attendanceStatuses: [String]
+
+    public init(
+        productIDs: [Int64] = [],
+        customerIDs: [Int64] = [],
+        resourceIDs: [Int64] = [],
+        startDateBefore: String? = nil,
+        startDateAfter: String? = nil,
+        bookingStatuses: [String] = [],
+        attendanceStatuses: [String] = []
+    ) {
+        self.productIDs = productIDs
+        self.customerIDs = customerIDs
+        self.resourceIDs = resourceIDs
+        self.startDateBefore = startDateBefore
+        self.startDateAfter = startDateAfter
+        self.bookingStatuses = bookingStatuses
+        self.attendanceStatuses = attendanceStatuses
+    }
+}
+
 /// Booking: Remote Endpoints
 ///
 public final class BookingsRemote: Remote, BookingsRemoteProtocol {
@@ -43,30 +71,51 @@ public final class BookingsRemote: Remote, BookingsRemoteProtocol {
     ///     - siteID: Site for which we'll fetch remote bookings.
     ///     - pageNumber: Number of page that should be retrieved.
     ///     - pageSize: Number of bookings to be retrieved per page.
-    ///     - startDateBefore: Filter bookings with start date before this timestamp.
-    ///     - startDateAfter: Filter bookings with start date after this timestamp.
+    ///     - filters: Optional filters for bookings (products, customers, resources, dates, statuses).
     ///     - searchQuery: Search query to filter bookings.
     ///     - order: Sort order for bookings (ascending or descending).
     ///
     public func loadAllBookings(for siteID: Int64,
                                 pageNumber: Int = Default.pageNumber,
                                 pageSize: Int = Default.pageSize,
-                                startDateBefore: String? = nil,
-                                startDateAfter: String? = nil,
+                                filters: BookingFilters? = nil,
                                 searchQuery: String? = nil,
                                 order: Order) async throws -> [Booking] {
-        var parameters = [
+        var parameters: [String: Any] = [
             ParameterKey.page: String(pageNumber),
             ParameterKey.perPage: String(pageSize),
             ParameterKey.order: order.rawValue
         ]
 
-        if let startDateBefore = startDateBefore {
-            parameters[ParameterKey.startDateBefore] = startDateBefore
-        }
+        // Apply filters if provided
+        if let filters {
+            if filters.productIDs.isNotEmpty {
+                parameters[ParameterKey.product] = filters.productIDs.map(String.init)
+            }
+
+            if filters.customerIDs.isNotEmpty {
+                parameters[ParameterKey.customer] = filters.customerIDs.map(String.init)
+            }
+
+            if filters.resourceIDs.isNotEmpty {
+                parameters[ParameterKey.resource] = filters.resourceIDs.map(String.init)
+            }
+
+            if let startDateBefore = filters.startDateBefore {
+                parameters[ParameterKey.startDateBefore] = startDateBefore
+            }
+
+            if let startDateAfter = filters.startDateAfter {
+                parameters[ParameterKey.startDateAfter] = startDateAfter
+            }
+
+            if filters.bookingStatuses.isNotEmpty {
+                parameters[ParameterKey.bookingStatus] = filters.bookingStatuses
+            }
 
-        if let startDateAfter = startDateAfter {
-            parameters[ParameterKey.startDateAfter] = startDateAfter
+            if filters.attendanceStatuses.isNotEmpty {
+                parameters[ParameterKey.attendanceStatus] = filters.attendanceStatuses
+            }
         }
 
         if let searchQuery = searchQuery, !searchQuery.isEmpty {
@@ -195,6 +244,10 @@ public extension BookingsRemote {
         static let startDateAfter: String  = "start_date_after"
         static let search: String          = "search"
         static let order: String           = "order"
+        static let product: String         = "product"
+        static let customer: String        = "customer"
+        static let resource: String        = "resource"
+        static let bookingStatus: String   = "booking_status"
         static let attendanceStatus        = "attendance_status"
     }
 }

Modules/Sources/Networking/Remote/POSCatalogSyncRemote.swift

@@ -24,6 +24,25 @@ public protocol POSCatalogSyncRemoteProtocol {
     // periphery:ignore
     func loadProductVariations(modifiedAfter: Date, siteID: Int64, pageNumber: Int) async throws -> PagedItems<POSProductVariation>
 
+    /// Starts generation of a POS catalog.
+    /// The catalog is generated asynchronously and a download URL may be returned when the file is ready.
+    ///
+    /// - Parameters:
+    ///   - siteID: Site ID to generate catalog for.
+    ///   - forceGeneration: Whether to always generate a catalog.
+    /// - Returns: Catalog job response with job ID.
+    ///
+    // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
+    func requestCatalogGeneration(for siteID: Int64, forceGeneration: Bool) async throws -> POSCatalogRequestResponse
+
+    /// 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 endpoint is integrated with catalog sync
+    func downloadCatalog(for siteID: Int64, downloadURL: String) async throws -> POSCatalogResponse
+
     /// Loads POS products for full sync.
     ///
     /// - Parameters:
@@ -127,6 +146,53 @@ public class POSCatalogSyncRemote: Remote, POSCatalogSyncRemoteProtocol {
 
     // MARK: - Full Sync Endpoints
 
+    /// Starts generation of a POS catalog.
+    /// The catalog is generated asynchronously and a download URL may be returned immediately or via the status response endpoint associated with a job ID.
+    ///
+    /// - Parameters:
+    ///   - siteID: Site ID to generate catalog for.
+    /// - Returns: Catalog job response with job ID.
+    ///
+    // periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
+    public func requestCatalogGeneration(for siteID: Int64, forceGeneration: Bool) async throws -> POSCatalogRequestResponse {
+        let path = "products/catalog"
+        let parameters: [String: Any] = [
+            ParameterKey.fullSyncFields: POSProduct.requestFields,
+            ParameterKey.forceGenerate: forceGeneration
+        ]
+        let request = JetpackRequest(
+            wooApiVersion: .mark3,
+            method: .post,
+            siteID: siteID,
+            path: path,
+            parameters: parameters,
+            availableAsRESTRequest: true
+        )
+        let mapper = SingleItemMapper<POSCatalogRequestResponse>(siteID: siteID)
+        return try await enqueue(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 endpoint is integrated with catalog sync
+    public func downloadCatalog(for siteID: Int64, downloadURL: String) async throws -> POSCatalogResponse {
+        // 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 POSCatalogResponse(products: products, variations: variations)
+    }
+
     /// Loads POS products for full sync.
     ///
     /// - Parameters:
@@ -252,10 +318,69 @@ private extension POSCatalogSyncRemote {
         static let page = "page"
         static let perPage = "per_page"
         static let fields = "_fields"
+        static let fullSyncFields = "fields"
+        static let forceGenerate = "force_generate"
     }
 
     enum Path {
         static let products = "products"
         static let variations = "variations"
     }
 }
+
+// MARK: - Response Models
+
+/// Response from catalog generation request.
+// periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
+public struct POSCatalogRequestResponse: Decodable {
+    /// Current status of the catalog generation job.
+    public let status: POSCatalogStatus
+    /// Download URL when it is already available.
+    public let downloadURL: String?
+
+    private enum CodingKeys: String, CodingKey {
+        case status
+        case downloadURL = "download_url"
+    }
+}
+
+/// Catalog generation status.
+public enum POSCatalogStatus: String, Decodable {
+    case pending
+    case processing
+    case complete
+    case failed
+}
+
+/// POS catalog from download.
+// periphery:ignore - TODO - remove this periphery ignore comment when this endpoint is integrated with catalog sync
+public struct POSCatalogResponse {
+    public let products: [POSProduct]
+    public let variations: [POSProductVariation]
+}
+
+private extension POSProduct {
+    var toVariation: POSProductVariation {
+        let variationAttributes = attributes.compactMap { attribute in
+            try? attribute.toProductVariationAttribute()
+        }
+
+        let firstImage = images.first
+
+        return .init(
+            siteID: siteID,
+            productID: parentID,
+            productVariationID: productID,
+            attributes: variationAttributes,
+            image: firstImage,
+            fullDescription: fullDescription,
+            sku: sku,
+            globalUniqueID: globalUniqueID,
+            price: price,
+            downloadable: downloadable,
+            manageStock: manageStock,
+            stockQuantity: stockQuantity,
+            stockStatusKey: stockStatusKey
+        )
+    }
+}

Modules/Sources/Networking/Remote/ProductsRemote.swift

@@ -23,6 +23,7 @@ public protocol ProductsRemoteProtocol {
                          excludedProductIDs: [Int64]) async throws -> [Product]
     func searchProducts(for siteID: Int64,
                         keyword: String,
+                        searchFields: [ProductSearchField],
                         pageNumber: Int,
                         pageSize: Int,
                         stockStatus: ProductStockStatus?,
@@ -291,7 +292,7 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
     }
 
     /// Remote search of products for the Point of Sale. Simple and variable products are loaded for WC version 9.6+, otherwise only simple products are loaded.
-    /// `search` is used, which searches in `name`, `description`, `short_description` fields.
+    /// `search` is used, which searches in `name`, `sku`, `globalUniqueID` fields.
     /// We also send `search_name_or_sku`, which will be used in preference to `search` when implemented on a site (in future.)
     ///
     /// - Parameter siteID: Site for which we'll fetch remote products.
@@ -313,7 +314,11 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
         parameters.updateValue(query, forKey: ParameterKey.searchNameOrSKU)
 
         // Takes precedence over `search_name_or_sku` from WC 10.1+ and is combined with `search` value
-        parameters.updateValue([SearchField.name, SearchField.sku, SearchField.globalUniqueID], forKey: ParameterKey.searchFields)
+        parameters.updateValue([
+            ProductSearchField.name.rawValue,
+            ProductSearchField.sku.rawValue,
+            ProductSearchField.globalUniqueID.rawValue
+        ], forKey: ParameterKey.searchFields)
 
         return try await makePagedPointOfSaleProductsRequest(
             for: siteID,
@@ -429,6 +434,7 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
     ///
     public func searchProducts(for siteID: Int64,
                                keyword: String,
+                               searchFields: [ProductSearchField],
                                pageNumber: Int,
                                pageSize: Int,
                                stockStatus: ProductStockStatus? = nil,
@@ -447,10 +453,11 @@ public final class ProductsRemote: Remote, ProductsRemoteProtocol {
             ParameterKey.exclude: stringOfExcludedProductIDs
             ].filter({ $0.value.isEmpty == false })
 
-        let parameters = [
+        let parameters: [String: Any] = [
             ParameterKey.page: String(pageNumber),
             ParameterKey.perPage: String(pageSize),
             ParameterKey.search: keyword,
+            ParameterKey.searchFields: searchFields.map { $0.rawValue },
             ParameterKey.exclude: stringOfExcludedProductIDs,
             ParameterKey.contextKey: Default.context
         ].merging(filterParameters, uniquingKeysWith: { (first, _) in first })
@@ -774,12 +781,12 @@ public extension ProductsRemote {
         static let productSegment = "product"
         static let itemsSold = "items_sold"
     }
+}
 
-    private enum SearchField {
-        static let name = "name"
-        static let sku = "sku"
-        static let globalUniqueID = "global_unique_id"
-    }
+public enum ProductSearchField: String {
+    case name
+    case sku
+    case globalUniqueID = "global_unique_id"
 }
 
 private extension ProductsRemote {

Modules/Sources/PointOfSale/Presentation/Settings/POSSettingsLocalCatalogViewModel.swift

@@ -53,7 +53,7 @@ final class POSSettingsLocalCatalogViewModel {
         defer { isRefreshingCatalog = false }
 
         do {
-            try await catalogSyncCoordinator.performFullSync(for: siteID)
+            try await catalogSyncCoordinator.performFullSync(for: siteID, regenerateCatalog: true)
             await loadCatalogData()
         } catch {
             DDLogError("⛔️ POSSettingsLocalCatalog: Failed to refresh catalog: \(error)")

Modules/Sources/PointOfSale/Utils/PreviewHelpers.swift

@@ -617,7 +617,7 @@ final class POSPreviewCatalogSettingsService: POSCatalogSettingsServiceProtocol
 }
 
 final class POSPreviewCatalogSyncCoordinator: POSCatalogSyncCoordinatorProtocol {
-    func performFullSyncIfApplicable(for siteID: Int64, maxAge: TimeInterval) async throws {
+    func performFullSyncIfApplicable(for siteID: Int64, maxAge: TimeInterval, regenerateCatalog: Bool) async throws {
         // Simulates a full sync operation with a 1 second delay.
         try await Task.sleep(nanoseconds: 1_000_000_000)
     }

Modules/Sources/Yosemite/Actions/BookingAction.swift

@@ -13,8 +13,7 @@ public enum BookingAction: Action {
     case synchronizeBookings(siteID: Int64,
                              pageNumber: Int,
                              pageSize: Int = BookingsRemote.Default.pageSize,
-                             startDateBefore: String? = nil,
-                             startDateAfter: String? = nil,
+                             filters: BookingFilters? = nil,
                              order: BookingsRemote.Order = .descending,
                              shouldClearCache: Bool = false,
                              onCompletion: (Result<Bool, Error>) -> Void)
@@ -40,8 +39,7 @@ public enum BookingAction: Action {
                         searchQuery: String,
                         pageNumber: Int,
                         pageSize: Int = BookingsRemote.Default.pageSize,
-                        startDateBefore: String? = nil,
-                        startDateAfter: String? = nil,
+                        filters: BookingFilters? = nil,
                         order: BookingsRemote.Order = .descending,
                         onCompletion: (Result<[Booking], Error>) -> Void)