mapricot 0.10.0 → 0.11.0

package/README.md

@@ -35,6 +35,7 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | `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, steps, lang })` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.routing.optimize(waypoints, { mode, geometries, steps, lang })` | [`POST /routing/v1/optimize`](https://mapricot.com/docs/routing/#optimize-the-order-of-stops) |
 | `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 |
@@ -57,6 +58,8 @@ controller.abort();
 
 A route's path comes as an encoded `polyline` with five decimal places, which polyline decoders assume. Pass `geometries: "geojson"` to get it as a GeoJSON `LineString` in `geometry` instead, which maps draw without decoding, or `geometries: "polyline6"` for six decimal places.
 
+`routing.optimize` takes the same options as `routing.route` and returns the route that visits the waypoints in a fast order, keeping the first and last in place. It adds `waypointOrder`: the indexes of your waypoints in visiting order, which `legs` follow. Every pair of waypoints must be within 400 km of each other for `drive`, or 200 km for `walk` and `bicycle`.
+
 An isochrone is a GeoJSON `FeatureCollection` with one polygon per time, largest first, so a map that draws them in order shows the smaller ones on top:
 
 ```js

package/dist/index.d.ts

@@ -55,6 +55,8 @@ export interface Step {
     lon: number;
 }
 export interface Route {
+    /** From `routing.optimize` only: the indexes of the waypoints you sent, in the order the route visits them. */
+    waypointOrder?: number[];
     distanceMeters: number;
     durationSeconds: number;
     /** Encoded polyline, with five decimal places unless `geometries` was `polyline6`. Absent for `geojson`. */
@@ -178,6 +180,13 @@ export declare class Mapricot {
             steps?: boolean;
             lang?: string;
         }) => Promise<Routes>;
+        /** Find a fast route through 2 to 20 waypoints, keeping the first and last in place and reordering the rest. */
+        optimize: (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 & {
             mode?: "drive" | "walk" | "bicycle";

package/dist/index.js

@@ -44,6 +44,8 @@ export class Mapricot {
         this.routing = {
             /** Find a route through 2 to 20 waypoints. */
             route: (waypoints, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/route", {}, signal, { waypoints, ...options }),
+            /** Find a fast route through 2 to 20 waypoints, keeping the first and last in place and reordering the rest. */
+            optimize: (waypoints, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/optimize", {}, signal, { waypoints, ...options }),
             /** The areas reachable from a location within 1 to 4 times, each 1 to 60 minutes. */
             isochrone: (location, minutes, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/isochrone", {}, signal, { location, minutes, ...options }),
         };

package/package.json

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