v6.0.0

Added

• BREAKING: Renamed models containing Valhalla and Pelias in their names to be generic. These now have rout(e|ing) or geocod(e|ing) prefixes.
• Explicitly documented more properties to the geocoding feature model.
• Adds support for the foursquare data source.
• Documents the elevation_interval parameter on certain routing requests.

Full Changelog: v5.0.0...v6.0.0

v5.0.0

Version 5.0.0 - 2024-09-04

Removed

• BREAKING: Removed isRouteResponse and isOsrmRouteResponse helper functions as these were duplicated. h/t to @louwers for noticing this!

You can migrate to the equivalent instanceOfRouteResponse and instanceOfOsrmRouteResponse methods.

v4.0.0

Added

• Support for the OSRM format and navigation aids
• BREAKING: To support the new format, the response type of directions APIs has changed

TypeScript users will need to use a type guard
in order to check the type of the response for directions APIs,
as the response type is now a union.
The response format will depend on the value of the format parameter in your request.

Here is an example of how to do the check in your code.
The guard helper function is included in this SDK and exported publicly.

const res = await api.route({ routeRequest: routeRequest });

if (isRouteResponse(res)) {
  // TODO: Process the response
} else {
  fail("Expected a Valhalla JSON format route response");
}

Alternately, you can guard for OSRM format responses like this:

const res = await api.route({ routeRequest: osrmFormatRouteRequest });

if (isOsrmRouteResponse(res)) {
  // TODO: Process the response
} else {
  fail("Expected an OSRM format route response");
}

v3.2.2

Fixed

• Improve modeling of bulk geocoding

v3.2.1

Fixed

• Isochrone request models now support all costing models

v3.2.0

Added

• Add support for bulk geocoding

Full Changelog: v3.1.0...v3.2.0

v3.1.0

Added

• Add support for elevation in route responses

v3.0.0

Version 3.0.0 - 2024-04-30

Note that most code should not actually break unless you are referencing explicit models. However, this is technically a set of breaking changes.

Added

• Add support for low-speed vehicle routing
• The matrix endpoint now accepts its own model rather than coordinate. This includes a search cutoff and paves the way for future expansion.

Changed

• Improved the documentation of the matrix endpoint failure modes

Fixed

• The time and distance field on matrix source to target models are now marked as nullable

v2.1.0

Added

• ignore_ options for ignoring various restrictions (useful for certain map matching applications)

Changed

• Mark package as pure to enable webpack tree shaking (contributed by @haysmike)

v2.0.0

Changed

• BREAKING: Directions Options are moved from a nested object to the root of all turn-by-turn directions APIs. Simply remove the nesting.
• FIXED: Reflect upstream changes to the time/distance matrix API returning a single dimensional list of sources and targets; the extra layer of nesting is removed and may break existing code (this was a bug fix).
• Improved documentation strings.

Added

• Alley factor for auto costing
• Resample distance parameter to height (elevation) requests
• Support for requesting alternate routes