Enable use of MapboxCommon's location manager in MapView (#7769)

GitOrigin-RevId: 05997fe40cbe7eabff8df68b3e4e54c958548338

Author: persidskiy

CHANGELOG.md

@@ -20,6 +20,31 @@ let mapView = MapView(frame: view.bounds, mapInitOptions: options)
 ```
 * Add `StyleReloadPolicy` to control style reload behavior. Use `reloadPolicy: .always` parameter in `loadStyle()` methods or `MapStyle` initializers to always reload the style even when the URI or JSON matches the currently loaded style. Defaults to `.onlyIfChanged` for optimal performance.
 
+* Introduce the `LocationManager.locationDataModel` and make it possible to use location provider from MapboxCommon. Deprecate the `LocationManager.override*` methods.
+Now you can choose to use the location provider from MapboxCommon.
+```swift
+@_spi(Experimental) import MapboxMaps
+
+// UIKit
+let initOptions = MapInitOptions(
+    locationDataModel: .createCore()
+)
+let mapView = MapView(mapInitOptions: initOptions) // specify at init time (recommended)
+mapView.mapboxMap.locationDataModel = .createCore() // or, override it at runtime
+
+
+// SwiftUI
+struct MyView: View {
+   @State var locationDataModel = LocationDataModel.createCore()
+   var body: some View {
+       Map(viewport: $viewport) {
+           Puck2D(bearing: .heading)
+       }
+       .locationDataModel(locationDataModel)
+   }
+}
+```
+
 ## 11.16.0 - 21 October, 2025
 
 ## 11.16.0-rc.2 - 14 October, 2025

Sources/Examples/All Examples/VoiceOverAccessibilityExample.swift

@@ -1,4 +1,5 @@
 import UIKit
+import Combine
 import CoreLocation
 import MapboxMaps
 
@@ -51,7 +52,7 @@ final class VoiceOverAccessibilityExample: UIViewController, ExampleProtocol {
         mapView.accessibilityElements = []
 
         let location = Location(coordinate: centerCoordinate)
-        mapView.location.override(locationProvider: Signal(just: [location]))
+        mapView.location.dataModel = LocationDataModel(location: Just([location]).eraseToAnyPublisher())
         mapView.location.options.puckType = .puck2D(.makeDefault())
 
         // create point annotation manager to house point annotations

Sources/Examples/Info.plist

@@ -100,16 +100,10 @@
 	</array>
 	<key>UISupportedInterfaceOrientations</key>
 	<array>
-		<string>UIInterfaceOrientationPortrait</string>
 		<string>UIInterfaceOrientationLandscapeLeft</string>
 		<string>UIInterfaceOrientationLandscapeRight</string>
-	</array>
-	<key>UISupportedInterfaceOrientations~ipad</key>
-	<array>
 		<string>UIInterfaceOrientationPortrait</string>
 		<string>UIInterfaceOrientationPortraitUpsideDown</string>
-		<string>UIInterfaceOrientationLandscapeLeft</string>
-		<string>UIInterfaceOrientationLandscapeRight</string>
 	</array>
 </dict>
 </plist>

Sources/Examples/SwiftUI Examples/LocateMeExample.swift

@@ -1,21 +1,60 @@
 import SwiftUI
-import MapboxMaps
+@_spi(Experimental) import MapboxMaps
+import CoreLocation
 
+/// The example demonstrates Puck and Viewport configuration that allow to follow user location.
 struct LocateMeExample: View {
     @State var viewport: Viewport = .followPuck(zoom: 13, bearing: .constant(0))
 
     var body: some View {
-        Map(viewport: $viewport) {
-            Puck2D(bearing: .heading)
+        MapReader { proxy in
+            Map(viewport: $viewport) {
+                Puck2D(bearing: .heading)
+                    .showsAccuracyRing(true)
+            }
+            .mapStyle(.standard)
+            .ignoresSafeArea()
+            .overlay(alignment: .trailing) {
+                LocateMeButton(viewport: $viewport)
+            }
         }
+    }
+}
+
+
+/// The example demonstrates Puck and Viewport configuration that allow to follow user location.
+/// In this example the CoreLocationProvider is use instead of default `AppleLocationProvider`.
+struct LocateMeCoreLocationProviderExample: View {
+    @State var locaionModel = LocationDataModel.createCore()
+    @State var viewport: Viewport = .followPuck(zoom: 13, bearing: .constant(0))
+
+    var body: some View {
+        MapReader { proxy in
+            Map(viewport: $viewport) {
+                Puck2D(bearing: .heading)
+                    .showsAccuracyRing(true)
+
+            }
             .mapStyle(.standard)
+            .locationDataModel(locaionModel)
             .ignoresSafeArea()
             .overlay(alignment: .trailing) {
                 LocateMeButton(viewport: $viewport)
             }
+            .onAppear {
+                /// The core location provider doesn't automatically initiate the location authorization request.
+                /// Instead, the application is responsible for that.
+                let locationManager = CLLocationManager()
+                if locationManager.authorizationStatus == .notDetermined {
+                    locationManager.requestWhenInUseAuthorization()
+                }
+            }
+
+        }
     }
 }
 
+
 struct LocateMeButton: View {
     @Binding var viewport: Viewport
 

Sources/Examples/SwiftUI Examples/LocationOverrideExample.swift

@@ -6,6 +6,12 @@ struct LocationOverrideExample: View {
     private class LocationProvider {
         @Published var location = Location(coordinate: .zero)
         @Published var heading = Heading(direction: 0, accuracy: 0)
+
+        lazy var model = {
+            LocationDataModel(
+                location: $location.map {[$0]}.eraseToAnyPublisher(),
+                heading: $heading.eraseToAnyPublisher())
+        }()
     }
 
     @State private var provider = LocationProvider()
@@ -26,12 +32,7 @@ struct LocationOverrideExample: View {
                     return false
                 }
             }
-            .onAppear {
-                /// Override the location and Heading provider with Combine publishers.
-                proxy.location?.override(
-                    locationProvider: provider.$location.map {[$0]}.eraseToSignal(),
-                    headingProvider: provider.$heading.eraseToSignal())
-            }
+            .locationDataModel(provider.model)
         }
         .ignoresSafeArea()
         .overlay(alignment: .bottom) {

Sources/Examples/SwiftUI Examples/SwiftUIRoot.swift

@@ -42,6 +42,7 @@ struct SwiftUIExamples {
             Example("Puck playground", note: "Display user location using puck.", destination: PuckPlayground())
             Example("Annotation Order", note: "Test the rendering order of annotations.", destination: AnnotationsOrderTestExample())
             Example("Snapshot Map", note: "Make a snapshot of the map.", destination: SnapshotMapExample())
+            Example("Locate Me (Core Location Provider)", note: "Use Viewport to create user location control. This example uses Location Provider from MabpoxCommon", destination: LocateMeCoreLocationProviderExample())
 
             Example("Attribution url via callback", note: "Works on iOS 13+", destination: AttributionManualURLOpen())
             Example("Raster particles", note: "Rendering of raster particles.", destination: RasterParticleExample())

Sources/MapboxMaps/Documentation.docc/API Catalogs/Location APIs.md

@@ -5,6 +5,7 @@
 ### Location
 
 - ``LocationManager``
+- ``LocationDataModel``
 - ``LocationOptions``
 - ``PuckType``
 - ``Puck2DConfiguration``

Sources/MapboxMaps/Foundation/InterfaceOrientationProvider.swift

@@ -2,9 +2,7 @@ import Foundation
 import UIKit
 import CoreLocation
 
-#if swift(>=5.9)
-    @available(visionOS, unavailable)
-#endif
+@available(visionOS, unavailable)
 internal final class DefaultInterfaceOrientationProvider {
     var onInterfaceOrientationChange: Signal<UIInterfaceOrientation> { subject.signal }
 
@@ -29,6 +27,11 @@ internal final class DefaultInterfaceOrientationProvider {
         self.notificationCenter = notificationCenter
         self.device = device
     }
+    
+    convenience init() {
+        self.init(notificationCenter: NotificationCenter.default, device: UIDevice.current)
+    }
+
 
     private func startUpdatingInterfaceOrientation() {
         device.beginGeneratingDeviceOrientationNotifications()

Sources/MapboxMaps/Foundation/MapInitOptions.swift

@@ -37,6 +37,8 @@ public final class MapInitOptions: NSObject {
     /// - SeeAlso: [`Improving edge-rendering quality with multisample antialiasing (MSAA)`](https://developer.apple.com/documentation/metal/metal_sample_code_library/improving_edge-rendering_quality_with_multisample_antialiasing_msaa)
     public let antialiasingSampleCount: Int
 
+    public let locationDataModel: LocationDataModel?
+
     /// Creates new instance of ``MapInitOptions``.
     ///
     /// - Parameters:
@@ -53,7 +55,8 @@ public final class MapInitOptions: NSObject {
         cameraOptions: CameraOptions? = nil,
         styleURI: StyleURI? = .standard,
         styleJSON: String? = nil,
-        antialiasingSampleCount: Int = 1
+        antialiasingSampleCount: Int = 1,
+        locationDataModel: LocationDataModel? = nil
     ) {
         let mapStyle: MapStyle? = if let styleJSON {
             MapStyle(json: styleJSON)
@@ -65,7 +68,8 @@ public final class MapInitOptions: NSObject {
         self.init(mapStyle: mapStyle,
                   mapOptions: mapOptions,
                   cameraOptions: cameraOptions,
-                  antialiasingSampleCount: antialiasingSampleCount)
+                  antialiasingSampleCount: antialiasingSampleCount,
+                  locationDataModel: locationDataModel)
     }
 
     /// Creates new map init options.
@@ -79,12 +83,14 @@ public final class MapInitOptions: NSObject {
         mapStyle: MapStyle?,
         mapOptions: MapOptions = MapOptions(),
         cameraOptions: CameraOptions? = nil,
-        antialiasingSampleCount: Int = 1
+        antialiasingSampleCount: Int = 1,
+        locationDataModel: LocationDataModel? = nil
     ) {
         self.mapOptions = mapOptions
         self.cameraOptions = cameraOptions
         self.mapStyle = mapStyle
         self.antialiasingSampleCount = antialiasingSampleCount
+        self.locationDataModel = locationDataModel
     }
 
     /// :nodoc:
@@ -144,7 +150,8 @@ extension MapInitOptions {
             return MapInitOptions(
                 mapStyle: resolvedStyle,
                 mapOptions: resolvedMapOptions,
-                cameraOptions: cameraOptions)
+                cameraOptions: cameraOptions,
+                locationDataModel: locationDataModel)
         } else {
             return self
         }

Sources/MapboxMaps/Foundation/MapView.swift

@@ -439,7 +439,7 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         sendInitialTelemetryEvents()
 
         // Set up managers
-        setupManagers()
+        setupManagers(initOptions: resolvedMapInitOptions)
     }
 
     private func makeMapboxMap(resolvedMapInitOptions: MapInitOptions) -> MapboxMap {
@@ -456,7 +456,7 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
     }
 
     // swiftlint:disable:next function_body_length
-    internal func setupManagers() {
+    internal func setupManagers(initOptions: MapInitOptions) {
 
         // Initialize/Configure camera manager first since Gestures needs it as dependency
         cameraAnimatorsRunner = dependencyProvider.makeCameraAnimatorsRunner(
@@ -501,9 +501,11 @@ open class MapView: UIView, SizeTrackingLayerDelegate {
         // Initialize/Configure location source and location manager
         location = LocationManager(
             interfaceOrientationView: .weakRef(self),
-            displayLink: displayLinkSignalSubject.signal,
             styleManager: mapboxMap,
-            mapboxMap: mapboxMap
+            mapboxMap: mapboxMap,
+            displayLink: displayLinkSignalSubject.signal,
+            dataModel: initOptions.locationDataModel ?? .createDefault(),
+            nowTimestamp: .now
         )
 
         // Initialize/Configure view annotations manager