Switching to Online Route (#4127)

* vk-1802-1830-mm-switch: updated public API to use IndexedRouteResponse as route source; updated RoutingProvider to return correctly set up IndexedROuteResponse; Added support for switching to online route feature; added support of navigation using MapMatching response; Unit tests updated for deprecated methods; Added MapMatching requesting option to Example App. added unit tst for switching to online route. CHNAGELOG updated; updated Jazzy table of contents
Co-authored-by: Minh Nguyễn <[email protected]>

Author: Udumft

CHANGELOG.md

@@ -8,6 +8,11 @@
 * MapboxCoreNavigation now requires [MapboxDirections v2.8.0-alpha.1](https://github.com/mapbox/mapbox-directions-swift/releases/tag/v2.8.0-alpha.1). ([#4142](https://github.com/mapbox/mapbox-navigation-ios/pull/4142))
 * MapboxNavigation now requires [MapboxSpeech v2._x_](https://github.com/mapbox/mapbox-speech-swift/releases/tag/v2.1.0). ([#4142](https://github.com/mapbox/mapbox-navigation-ios/pull/4142))
 
+### Routing
+
+* Added the `RouteController.prefersOnlineRoute` property, which lets you automatically switch from a route generated on the device to one generated by the Mapbox Directions API if the geometries match. Use `NavigationViewControllerDelegate.navigationViewController(_:didSwitchToCoincidentOnlineRoute:)`, `NavigationServiceDelegate.navigationService(_:didSwitchToCoincidentOnlineRoute:)`, `RouterDelegate.router(_:didSwitchToCoincidentOnlineRoute:)` or `.routeControllerDidSwitchToCoincidentOnlineRoute` notification to track such events. ([#4127](https://github.com/mapbox/mapbox-navigation-ios/pull/4127))
+* Added the `NavigationViewController(for:routeIndex:navigationOptions:)` initializer to start turn-by-turn navigation using map matching response. ([#4127](https://github.com/mapbox/mapbox-navigation-ios/pull/4127))
+
 ### Map
 
 * `NavigationMapView.removeAlternativeRoutes()` and `NavigationMapView.removeContinuousAlternativeRoutesDurations()` were made public to provide a way to remove previously shown alternative routes and alternative routes duration annotations, respectively. ([#4134](https://github.com/mapbox/mapbox-navigation-ios/pull/4134))
@@ -19,6 +24,7 @@
 ### Other changes
 
 * Additional parameters were added to `FloatingButton.rounded(image:selectedImage:size:type:imageEdgeInsets:cornerRadius)` to be able to provide button type, button image edge insets and corner radius. ([#4060](https://github.com/mapbox/mapbox-navigation-ios/pull/4060), [#4157](https://github.com/mapbox/mapbox-navigation-ios/pull/4157))
+* `IndexedRouteResponse` is now the preferred way for setting up routing information for navigation. `NavigationViewController`, `MapboxNavigationService`, `Router` and `RoutingProvider` are updated to accomodate this change. ([#4127](https://github.com/mapbox/mapbox-navigation-ios/pull/4127))
 * `FloatingButton` no longer contains corner radius shadow, border is applied instead. ([#4060](https://github.com/mapbox/mapbox-navigation-ios/pull/4060))
 
 ## v2.8.0

Example/AppDelegate+CarPlay.swift

@@ -71,19 +71,15 @@ extension AppDelegate: CPApplicationDelegate {
 extension AppDelegate: CarPlayManagerDelegate {
 
     func carPlayManager(_ carPlayManager: CarPlayManager,
-                        navigationServiceFor routeResponse: RouteResponse,
-                        routeIndex: Int,
-                        routeOptions: RouteOptions,
+                        navigationServiceFor indexedRouteResponse: IndexedRouteResponse,
                         desiredSimulationMode: SimulationMode) -> NavigationService? {
         if let navigationViewController = self.window?.rootViewController?.presentedViewController as? NavigationViewController,
            let navigationService = navigationViewController.navigationService {
             // Do not set simulation mode if we already have an active navigation session.
             return navigationService
         }
 
-        return MapboxNavigationService(routeResponse: routeResponse,
-                                       routeIndex: routeIndex,
-                                       routeOptions: routeOptions,
+        return MapboxNavigationService(indexedRouteResponse: indexedRouteResponse,
                                        customRoutingProvider: nil,
                                        credentials: NavigationSettings.shared.directions.credentials,
                                        simulating: desiredSimulationMode)

Example/CustomViewController.swift

@@ -19,8 +19,6 @@ class CustomViewController: UIViewController {
     var currentLegIndex: Int = 0
 
     var indexedUserRouteResponse: IndexedRouteResponse?
-        
-    var userRouteOptions: RouteOptions?
 
     var stepsViewController: StepsViewController?
 
@@ -47,9 +45,7 @@ class CustomViewController: UIViewController {
         navigationMapView.userLocationStyle = .courseView()
 
         let locationManager = simulateLocation ? SimulatedLocationManager(route: indexedUserRouteResponse!.routeResponse.routes!.first!) : NavigationLocationManager()
-        navigationService = MapboxNavigationService(routeResponse: indexedUserRouteResponse!.routeResponse,
-                                                    routeIndex: indexedUserRouteResponse!.routeIndex,
-                                                    routeOptions: userRouteOptions!,
+        navigationService = MapboxNavigationService(indexedRouteResponse: indexedUserRouteResponse!,
                                                     customRoutingProvider: nil,
                                                     credentials: NavigationSettings.shared.directions.credentials,
                                                     locationSource: locationManager,