mapbox-directions-swift

No public changes since v2.8.0-beta.1.

Documentation is available online or within Xcode.

Changes since v2.8.0-alpha.2:

• Expanded AttributeOptions to allow user options with custom values. See AttributeOptions.customOptionsByRawValue for reference. (#748)
• Fixed incorrect shape indicies in RouteLeg.incidents after route refresh. (#752)

Documentation is available online or within Xcode.

Changes since v2.8.0-alpha.1:

• Added the Waypoint.layer property, which can ensure that the route begins on the correct road if it is above or below another road. (#745)

Documentation is available online or within Xcode.

v2.7.0

Changes since v2.6.0:

Packaging

• Xcode 13.0 or above and Swift 5.5 or above are now required to build MapboxDirections from source. (#725, #727)

Command line tool

• Removed the --config option. Instead, pass in either the path to a JSON configuration file or the full URL to a Mapbox Directions API or Mapbox Map Matching API request. (#726)
• When the MAPBOX_ACCESS_TOKEN environment variable is unset, the tool exits with an error code instead of crashing. (#728)
• The tool now connects to the API endpoint in the MAPBOX_HOST environment variable, if specified. (#728)

Other changes

• Added Waypoint.allowsSnappingToStaticallyClosedRoad property to allow snapping the waypoint’s location to a statically (long-term) closed part of a road. (#721)
• RouteOptions(url:) now returns nil if given a Mapbox Map Matching API request URL, and MatchOptions(url:) returns nil if given a Mapbox Directions API request URL. (#728)
• Added the Directions.refreshRoute(responseIdentifier:routeIndex:fromLegAtIndex:currentRouteShapeIndex:completionHandler:) method, which takes the index into the route geometry at which to begin refreshing, as well as corresponding Directions.urlRequest(forRefreshing responseIdentifier:routeIndex:fromLegAtIndex:currentRouteShapeIndex:), RouteRefreshResponse.refreshLegAttributes(from:legIndex:legShapeIndex:), and RouteRefreshResponse.refreshLegIncidents(from:legIndex:legShapeIndex:) methods. (#733)

Documentation is available online or within Xcode.

Changes since v2.7.0-rc.2:

Packaging

• This library now requires a minimum deployment target of iOS 12.0 or above, macOS 10.14.0 or above, tvOS 12.0 or above, or watchOS 5.0 or above. Older operating system versions are no longer supported. (#736)

Documentation is available online or within Xcode.

Changes since v2.7.0-rc.1:

• Added the Directions.refreshRoute(responseIdentifier:routeIndex:fromLegAtIndex:currentRouteShapeIndex:completionHandler:) method, which takes the index into the route geometry at which to begin refreshing, as well as corresponding Directions.urlRequest(forRefreshing responseIdentifier:routeIndex:fromLegAtIndex:currentRouteShapeIndex:), RouteRefreshResponse.refreshLegAttributes(from:legIndex:legShapeIndex:), and RouteRefreshResponse.refreshLegIncidents(from:legIndex:legShapeIndex:) methods. (#733)

Documentation is available online or within Xcode.

Changes since v2.7.0-beta.1:

Packaging

• Xcode 13.0 or above and Swift 5.5 or above are now required to build MapboxDirections from source. (#725, #727)

Command line tool

• Removed the --config option. Instead, pass in either the path to a JSON configuration file or the full URL to a Mapbox Directions API or Mapbox Map Matching API request. (#726)
• When the MAPBOX_ACCESS_TOKEN environment variable is unset, the tool exits with an error code instead of crashing. (#728)
• The tool now connects to the API endpoint in the MAPBOX_HOST environment variable, if specified. (#728)

Other changes

• RouteOptions(url:) now returns nil if given a Mapbox Map Matching API request URL, and MatchOptions(url:) returns nil if given a Mapbox Directions API request URL. (#728)

Documentation is available online or within Xcode.

Changes since v2.6.0:

• Added Waypoint.allowsSnappingToStaticallyClosedRoad property to allow snapping the waypoint’s location to a statically (long-term) closed part of a road. (#721)

Documentation is available online or within Xcode.

v2.6.0

Changes since v2.5.0:

• MapboxDirections now requires Turf v2.4. (#703)
• Added the RouteOptions.maximumWeight property to compute routes that excludes roads with a lower weight limit. (#694)
• Added Route.refreshLegIncidents(from:) method to allow refreshing RouteLeg.incidents during a route refresh. (#704)
• Added the Intersection.railroadCrossing, Intersection.trafficSignal, Intersection.stopSign and Intersection.yieldSign properties to indicate the kind of traffic control devices at an intersection along the route. (#706)

Documentation is available online or within Xcode.

No public changes since v2.6.0-beta.2.

Documentation is available online or within Xcode.

Changes since v2.6.0-beta.1:

• Added the Intersection.railroadCrossing, Intersection.trafficSignal, Intersection.stopSign and Intersection.yieldSign properties to indicate the kind of traffic control devices at an intersection along the route. #706

Documentation is available online or within Xcode.

Changes since v2.5.0:

• MapboxDirections now requires Turf v2.4. (#703)
• Added the RouteOptions.maximumWeight property to compute routes that excludes roads with a lower weight limit. (#694)
• Added Route.refreshLegIncidents(from:) method to allow refreshing RouteLeg.incidents during a route refresh. (#704)

Documentation is available online or within Xcode.

Changes since v2.4.0:

• Added the RestStop.name property. (#689)
• Added the TollCollection.name property. (#691)
• Types that correspond to objects in the Mapbox Directions API response, such as RouteResponse, RouteRefreshResponse, MatchResponse, and RouteStep, now conform to the ForeignMemberContainer and ForeignMemberClassContainer protocols. Types that conform to these protocols can persist unrecognized properties in the response, such as properties that are in beta, even after coding and decoding. You can access these properties using the ForeignMemberContainer.foreignMembers and ForeignMemberClassContainer.foreignMembers properties. (#669)
• Fixed an issue where RouteStep.distance, RouteStep.expectedTravelTime and RouteStep.typicalTravelTime were rounded to one decimal place when being encoded. (#697)
• Fixed an issue where decoding a RouteResponse incorrectly set the Waypoint.snappedDistance property to nil. (#669)
• The mapbox-directions-swift command line tool now requests routes from the Mapbox Directions API if no input file is specified. (#576)

Documentation is available online or within Xcode.

No changes since v2.5.0-beta.1.

Documentation is available online or within Xcode.

Changes since v2.4.0:

• Added the RestStop.name property. (#689)
• Added the TollCollection.name property. (#691)
• Types that correspond to objects in the Mapbox Directions API response, such as RouteResponse, RouteRefreshResponse, MatchResponse, and RouteStep, now conform to the ForeignMemberContainer and ForeignMemberClassContainer protocols. Types that conform to these protocols can persist unrecognized properties in the response, such as properties that are in beta, even after coding and decoding. You can access these properties using the ForeignMemberContainer.foreignMembers and ForeignMemberClassContainer.foreignMembers properties. (#669)
• Fixed an issue where decoding a RouteResponse incorrectly set the Waypoint.snappedDistance property to nil. (#669)
• The mapbox-directions-swift command line tool now requests routes from the Mapbox Directions API if no input file is specified. (#576)

Documentation is available online or within Xcode.

Changes since v2.3.0:

• Fixed a crash that occurred when RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties contained multiple road classes.
• RoadClasses.tunnel and RoadClasses.restricted are no longer supported in RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties
• Added DirectionsOptions(url:), RouteOptions(url:) and extended existing DirectionsOptions(waypoints:profileIdentifier:queryItems:), RouteOptions(waypoints:profileIdentifier:queryItems:), MatchOptions(waypoints:profileIdentifier:queryItems:) and related convenience init methods for deserializing corresponding options object using appropriate request URL or it's query items. (#655)
• Added Incident properties: countryCode, countryCodeAlpha3, roadIsClosed, longDescription, numberOfBlockedLanes, congestionLevel, affectedRoadNames. (#672)
• Added departAt and arriveBy properties to RouteOptions to allow configuring Directions routes calculation. (#673)
• Removed url request's .json suffix for Directions and Isochrones to follow V5 scheme. (#678)

Documentation is available online or within Xcode.

Changes since v2.4.0-rc.1:

• Added Incident properties: countryCode, countryCodeAlpha3, roadIsClosed, longDescription, numberOfBlockedLanes, congestionLevel, affectedRoadNames. (#672)
• Added departAt and arriveBy properties to RouteOptions to allow configuring Directions routes calculation. (#673)

Documentation is available online or within Xcode.

No changes since v2.4.0-beta.1.

Documentation is available online or within Xcode.

Changes since v2.3.0:

• Fixed a crash that occurred when RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties contained multiple road classes. (#664)
• RoadClasses.tunnel and RoadClasses.restricted are no longer supported in RouteOptions.roadClassesToAvoid or RouteOptions.roadClassesToAllow properties (#664)
• Added DirectionsOptions(url:), RouteOptions(url:) and extended existing DirectionsOptions(waypoints:profileIdentifier:queryItems:), RouteOptions(waypoints:profileIdentifier:queryItems:), MatchOptions(waypoints:profileIdentifier:queryItems:) and related convenience init methods for deserializing corresponding options object using appropriate request URL or it's query items. (#655)

Documentation is available online or within Xcode.

Changes since v2.2.0:

• Added VisualInstruction.Component.ShieldRepresentation struct and the VisualInstruction.Component.ImageRepresentation.shield property containing metadata for displaying a highway shield consistent with map styles used by the Mapbox Maps SDK. (#644, #647)
• Added a RouteLeg.viaWaypoints property that lists the non-leg-separating waypoints (also known as “silent waypoints”) along a RouteLeg. Previously, you had to filter DirectionsOptions.waypoints to include only the items whose Waypoints.separatesLegs property was set to true, then zip them with RouteResponse.routes. This approach still works in some cases but is not guaranteed to be reliable for all Mapbox Directions API responses in the future. (#656)

Documentation is available online or within Xcode.