v3.16.0-rc.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.16.0-rc.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.16.0-rc.1

API Deprecations

• ViewportState.routeProgress is deprecated and is always nil now. Use ViewportState.navigationProgress instead.
• ViewportState.heading is deprecated and is always nil now. Use ViewportState.navigationHeading instead.
• ViewportState.location is deprecated in favor of ViewportState.navigationLocation instead.
• ViewportState.init(location:routeProgress:viewportPadding:heading:) is deprecated in favor of ViewportState.init(navigationLocation:navigationProgress:viewportPadding:navigationHeading:).

Navigation Camera

• When implementing a custom ViewportDataSource for the navigation camera, migrate to viewportState.navigationProgress for tracking active guidance progress.

Other changes

• Fixed a possible race condition in NavigationCamera state updates.
• Fixed memory leaks caused by Task.detached usage in NavigationController.
• Fixed memory leaks in NWPathMonitor caused by a non-stopped monitor.
• Removed excessive Sendable conformance for types from Turf and Maps.

v3.12.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.15.2
• MapboxNavigationCore now requires MapboxNavigationNative v324.15.2

v3.11.4

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.14.7
• MapboxNavigationCore now requires MapboxNavigationNative v324.14.7

v3.16.0-beta.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.16.0-beta.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.16.0-beta.1

API Deprecations

• NavigationRoute.nativeRoute, NavigationRoute.init?(nativeRoute:), and AlternativeRoute.init?(mainRoute:alternativeRoute:) are deprecated and should no longer be used.
• CoreConfig.routeRequestConfig is deprecated. Configure request options directly using RouteOptions and MatchOptions.
• TelemetryAppMetadata.userId and TelemetryAppMetadata.sessionId are deprecated and no longer have any effect.

Routing

• Fixed an issue where request parameters could be lost on reroutes when using a custom RouteOptions subclass. If you subclass RouteOptions, make sure to implement urlQueryItems, init(from:), encode(to:), and init(waypoints:profileIdentifier:queryItems:).
• NavigationRouteOptions.init(waypoints:profileIdentifier:queryItems:) and NavigationMatchOptions.init(waypoints:profileIdentifier:queryItems:) set the default values for shapeFormat, locale, distanceMeasurementSystem, routeShapeResolution, includesSpokenInstructions, and includesVisualInstructions only if the values were not passed in queryItems.
• RoutingConfig.datasetProfileIdentifier was added to configure the dataset profile for routing tiles. It is important to set this value before initializing MapboxNavigationProvider and use the same value for the following ProfileIdentifier in route requests options.

Map

• Fixed the crash on an alternative map route annotation offset calculation when a deviation point is further than 80% of the main route.

CarPlay

• Fixed an incorrect CarPlayActivity value passed in CarPlayManagerDelegate function calls:

  • carPlayManager(_:, leadingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, trailingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, mapButtonsCompatibleWith traitCollection:, in:, for:).

  Now CarPlayActivity.panningInBrowsingMode and CarPlayActivity.panningInNavigationMode are passed in the above delegate function calls when the map is panned after showing the panning interface. Previously, those values were only passed at the moment of initial presentation of the panning interface and immediately after performing any panning (or any action that exits the map camera's follow mode), the passed CarPlayActivity was reverted to CarPlayActivity.browsing or CarPlayActivity.navigating even though the panning interface was still shown.

  In addition, CarPlayManager.currentActivity is also updated correctly in the mentioned scenarios.

• Fixed a problem that navigation bar buttons would not be updated properly for navigation mode when customized with CarPlayManagerDelegate implementation, because of too early execution of calls to CarPlayManagerDelegate functions:

  • carPlayManager(_:, leadingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, trailingNavigationBarButtonsCompatibleWith traitCollection:, in:, for:),
  • carPlayManager(_:, mapButtonsCompatibleWith traitCollection:, in:, for:).

  Those calls were previously executed before CarPlayNavigationViewController instantiation. Now they are performed after CarPlayNavigationViewController instantiation, right after calling CarPlayManagerDelegate.carPlayManager(_:, willPresent:).

Other changes

• StepsViewController.measurementSystem is now public.

v3.11.3

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.14.6
• MapboxNavigationCore now requires MapboxNavigationNative v324.14.6

v3.12.0

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.15.0
• MapboxNavigationCore now requires MapboxNavigationNative v324.15.0
• Added a separate MapboxDirections product for independent usage of Mapbox Directions API.

Electronic horizon

Note: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.

• RoadObject initializer is now optional.

Other changes

• Fixed NavigationController.bannerInstructions. Now a new event is published only when a new banner instruction is available and not with every route progress update.
• Avoid using precondition and preconditionFailure to avoid possible runtime crashes in Release builds.
• Updated default route line traffic colors to match the Mapbox Standard style.

User interface

• Removed an initial hardcoded call to StandardDayStyle().apply(). The StandardDayStyle and StandardNightStyle are still default values when initializing NavigationViewController and can be changed by setting NavigationOptions.styles value.

v3.11.2

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.14.3
• MapboxNavigationCore now requires MapboxNavigationNative v324.14.3

v3.12.0-rc.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.15.0-rc.1
• MapboxNavigationCore now requires MapboxNavigationNative v324.15.0-rc.1

v2.20.2

Changes since v2.20.1:

Routing

• Fixed the usage of the RouteOptions type from the initial route request instead of a hardcoded type, ensuring additional parameters are preserved on reroutes. (#4789)
• Fixed ProfileIdentifier comparison for the custom profile identifiers, so that route refresh is enabled for custom automobileAvoidingTraffic profiles.

Documentation is available online or within Xcode.

v3.12.0-beta.1

Packaging

• MapboxNavigationCore now requires MapboxMaps v11.15.0-beta.3
• MapboxNavigationCore now requires MapboxNavigationNative v324.15.0-beta.3
• Added a separate MapboxDirections product for independent usage of Mapbox Directions API.

Electronic horizon

Note: The Mapbox Electronic Horizon feature of the Mapbox Navigation SDK is in public beta and is subject to changes, including its pricing. Use of the feature is subject to the beta product restrictions in the Mapbox Terms of Service. Mapbox reserves the right to eliminate any free tier or free evaluation offers at any time and require customers to place an order to purchase the Mapbox Electronic Horizon feature, regardless of the level of use of the feature.

• RoadObject initializer is now optional.

Other changes

• Fixed NavigationController.bannerInstructions. Now a new event is published only when a new banner instruction is available and not with every route progress update.
• Avoid using precondition and preconditionFailure to avoid possible runtime crashes in Release builds.

User interface

• Removed an initial hardcoded call to StandardDayStyle().apply(). The StandardDayStyle and StandardNightStyle are still default values when initializing NavigationViewController and can be changed by setting NavigationOptions.styles value.