mapricot 0.8.0 → 0.10.0

package/README.md

@@ -34,7 +34,7 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | `client.geocoding.reverse(lat, lon, { limit, lang })` | [`GET /geocoding/v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
 | `client.places.nearby(lat, lon, { category, radius, limit, lang })` | [`GET /places/v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
 | `client.places.get(id, { lang })` | [`GET /places/v1/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
-| `client.routing.route(waypoints, { mode, geometries })` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.routing.route(waypoints, { mode, geometries, steps, lang })` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
 | `client.routing.isochrone(location, minutes, { mode })` | [`POST /routing/v1/isochrone`](https://mapricot.com/docs/routing/#get-an-isochrone) |
 | `client.ipGeolocation.lookup(ip)` | [`GET /ip-geolocation/v1/{ip}`](https://mapricot.com/docs/ip-geolocation/#look-up-an-address) |
 | `client.account()` | `GET /account`, which checks a key and is never billed |
@@ -64,6 +64,8 @@ const area = await client.routing.isochrone({ lat: 45.5189, lon: -122.6793 }, [5
 map.addSource("reach", { type: "geojson", data: area });
 ```
 
+Pass `steps: true` and each leg's `steps` has its turn-by-turn directions: an `instruction`, its distance and time, and its `lat` and `lon`. They're in English unless you pass `lang`, such as `lang: "fr"`.
+
 If your app shows results, show the credits in each response's `attribution`.
 
 ## Errors and retries

package/dist/index.d.ts

@@ -22,6 +22,12 @@ export interface Place {
     lon: number;
     address?: Address;
     categories?: string[];
+    phones?: string[];
+    websites?: string[];
+    socials?: string[];
+    brand?: string;
+    /** OpenStreetMap's `opening_hours` syntax, such as `Mo-Fr 08:00-18:00`. */
+    openingHours?: string;
     distanceMeters?: number;
     source: string;
 }
@@ -36,6 +42,17 @@ export interface PlaceResult {
 export interface Leg {
     distanceMeters: number;
     durationSeconds: number;
+    /** Turn-by-turn directions, in order, when the route was asked for with `steps: true`. The last step is the arrival. */
+    steps?: Step[];
+}
+/** One maneuver, and the stretch from it to the next. */
+export interface Step {
+    instruction: string;
+    distanceMeters: number;
+    durationSeconds: number;
+    /** Where the maneuver is, on the route's path. */
+    lat: number;
+    lon: number;
 }
 export interface Route {
     distanceMeters: number;
@@ -158,6 +175,8 @@ export declare class Mapricot {
         route: (waypoints: Point[], { signal, ...options }?: RequestOptions & {
             mode?: "drive" | "walk" | "bicycle";
             geometries?: "polyline" | "polyline6" | "geojson";
+            steps?: boolean;
+            lang?: string;
         }) => Promise<Routes>;
         /** The areas reachable from a location within 1 to 4 times, each 1 to 60 minutes. */
         isochrone: (location: Point, minutes: number[], { signal, ...options }?: RequestOptions & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mapricot",
-  "version": "0.8.0",
+  "version": "0.10.0",
   "description": "Official client for the Mapricot API: geocoding, places, routing, and IP geolocation.",
   "keywords": [
     "geocoding",