[CP] MAPSIOS-1674: Style imports color-theme (#2481)

Author: aleksproger

Sources/Examples/SwiftUI Examples/StandardStyleImportExample.swift

@@ -17,6 +17,7 @@ struct StandardStyleImportExample: View {
                 /// This enables the greater encapsulation and allows to reload the basemap without reloading of the fragment.
                 let importId = "real-estate-fragment"
                 StyleImport(id: importId, uri: StyleURI(url: styleURL)!)
+                    .colorTheme(ColorTheme(uiimage: monochromeTheme))
 
                 /// The contents of the imported style are private, meaning all the implementation details such as layers and sources are not accessible at runtime.
                 /// However the style defines a "hotels-price" featureset that represents a portion of features available for interaction.
@@ -151,6 +152,7 @@ private extension FeaturesetFeature {
 }
 
 private let styleURL = Bundle.main.url(forResource: "fragment-realestate-NY", withExtension: "json")!
+private let monochromeTheme = UIImage(named: "monochrome_lut")!
 
 struct StandardStyleImportExample_Previews: PreviewProvider {
     static var previews: some View {

Sources/MapboxMaps/ContentBuilders/MapStyleContent/MountedStyleImport.swift

@@ -6,7 +6,8 @@ extension StyleImport: MapStyleContent, PrimitiveMapContent {
         node.mount(MountedStyleImport(
             id: id ?? node.id.stringId,
             styleData: style.data,
-            configuration: style.configuration
+            configuration: style.configuration,
+            colorTheme: colorTheme
         ))
     }
 }
@@ -15,6 +16,7 @@ struct MountedStyleImport: MapContentMountedComponent {
     let id: String
     let styleData: MapStyle.Data
     let configuration: JSONObject?
+    let colorTheme: ColorTheme?
 
     func mount(with context: MapContentNodeContext) throws {
         let importPosition = context.resolveImportPosition()
@@ -38,6 +40,10 @@ struct MountedStyleImport: MapContentMountedComponent {
                     importPosition: importPosition.corePosition)
             }
         }
+
+        if let colorTheme, let coreColorTheme = colorTheme.core {
+            try handleExpected { context.style.styleManager.setImportColorThemeForImportId(id, colorTheme: coreColorTheme) }
+        }
     }
 
     func unmount(with context: MapContentNodeContext) throws {
@@ -84,6 +90,12 @@ struct MountedStyleImport: MapContentMountedComponent {
             }
         }
 
+        if colorTheme != old.colorTheme {
+            try handleExpected {
+                context.style.styleManager.setImportColorThemeForImportId(id, colorTheme: colorTheme?.core)
+            }
+        }
+
         return true
     }
 

Sources/MapboxMaps/Style/StyleImport.swift

@@ -32,6 +32,7 @@
 public struct StyleImport: Sendable {
     let id: String?
     let style: MapStyle
+    var colorTheme: ColorTheme?
 
     /// Creates a ``StyleImport`` using a Mapbox Style JSON.
     ///
@@ -77,3 +78,13 @@ public struct StyleImport: Sendable {
         self.style = style
     }
 }
+
+extension StyleImport {
+    /// The color theme to apply on ``StyleImport``. Overrides any config values for color-theme and allow to set theme different from the root style in the import.
+    /// Default value: none
+    @_documentation(visibility: public)
+    @_spi(Experimental)
+    public func colorTheme(_ colorTheme: ColorTheme?) -> Self {
+        with(self, setter(\.colorTheme, colorTheme))
+    }
+}

Sources/MapboxMaps/Style/StyleManager.swift

@@ -1535,6 +1535,41 @@ public class StyleManager {
         }
     }
 
+    /// Set coolor theme for the style import with specified `importId`.
+    ///
+    ///  - Parameters:
+    ///   - importId: Identifier of the style import to remove.
+    ///   - colorTheme: Color theme to set for style import.
+    ///
+    ///  - Throws:
+    ///   - An error describing why the operation was unsuccessful.
+    @_spi(Experimental)
+    @_documentation(visibility: public)
+    public func setStyleImportColorTheme(importId: String, colorTheme: ColorTheme) throws {
+        guard let coreTheme = colorTheme.core else {
+            throw StyleError(message: "Cannot construct UIImage object.")
+        }
+
+        try handleExpected {
+            return styleManager.setImportColorThemeForImportId(importId, colorTheme: coreTheme)
+        }
+    }
+
+    /// Remove color theme from the style import.
+    ///
+    ///  - Parameters:
+    ///   - importId: Identifier of the style import to remove color theme from.
+    ///
+    ///  - Throws:
+    ///   - An error describing why the operation was unsuccessful.
+    @_spi(Experimental)
+    @_documentation(visibility: public)
+    public func removeStyleImportColorTheme(importId: String) throws {
+        try handleExpected {
+            return styleManager.setImportColorThemeForImportId(importId, colorTheme: nil)
+        }
+    }
+
 }
 
 extension StyleManagerProtocol {

Sources/MapboxMaps/Style/StyleManagerProtocol.swift

@@ -214,6 +214,7 @@ internal protocol StyleManagerProtocol {
 
     func setStyleColorThemeFor(_ colorTheme: CoreColorTheme?) -> Expected<NSNull, NSString>
     func setInitialStyleColorTheme()
+    func setImportColorThemeForImportId(_ importId: String, colorTheme: CoreColorTheme?) -> Expected<NSNull, NSString>
 }
 
 // MARK: Conformance

Tests/MapboxMapsTests/Foundation/Mocks/MockStyleManager.swift

@@ -3,6 +3,15 @@ import Foundation
 @_implementationOnly import MapboxCommon_Private
 
 class MockStyleManager: StyleManagerProtocol {
+    struct ImportColorThemeParameters {
+        var importId: String
+        var colorTheme: CoreColorTheme?
+    }
+    let setImportColorThemeStub = Stub<ImportColorThemeParameters, Expected<NSNull, NSString>>( defaultReturnValue: .init(value: NSNull()))
+    func setImportColorThemeForImportId(_ importId: String, colorTheme: CoreColorTheme?) -> Expected<NSNull, NSString> {
+        setImportColorThemeStub(with: ImportColorThemeParameters(importId: importId, colorTheme: colorTheme))
+    }
+
     let setStyleColorThemeForStub = Stub<CoreColorTheme?, Expected<NSNull, NSString>>(
         defaultReturnValue: .init(value: NSNull())
     )