mapricot 0.10.0 → 0.12.0

package/README.md

@@ -30,11 +30,13 @@ Methods are grouped by product, the same way as the API's paths. Each returns th
 | Method | Endpoint |
 | --- | --- |
 | `client.geocoding.search(q, { focus, country, limit, lang })` | [`GET /geocoding/v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
+| `client.geocoding.searchBatch(queries)` | [`POST /geocoding/v1/search/batch`](https://mapricot.com/docs/geocoding/#search-a-list-of-addresses) |
 | `client.geocoding.autocomplete(q, { focus, country, limit, lang })` | [`GET /geocoding/v1/autocomplete`](https://mapricot.com/docs/geocoding/#suggest-as-people-type) |
 | `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, 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 |
@@ -47,6 +49,13 @@ const { routes } = await client.routing.route([{ lat: 45.5189, lon: -122.6793 },
 console.log(routes[0].durationSeconds);
 ```
 
+`searchBatch` runs up to 100 searches in one request. Each query is an object of `search`'s parameters, and `responses` answers them in the same order, each with `results` and `attribution`, or an `error` with the `code` and `message` that search would get, without rejecting. Each completed search is billed as one request; errors aren't.
+
+```js
+const { responses } = await client.geocoding.searchBatch([{ q: "128 SW 3rd Ave, Portland", limit: 1 }, { q: "10 Downing Street, London", limit: 1 }]);
+for (const response of responses) console.log(response.error?.message ?? response.results[0].label);
+```
+
 To cancel a request, such as an autocomplete request for text that has since changed, pass an `AbortSignal` as `signal` to any method. The request then rejects with an `AbortError`:
 
 ```js
@@ -57,6 +66,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

@@ -35,6 +35,27 @@ export interface Places {
     results: Place[];
     attribution: Attribution[];
 }
+/** One search in a batch, with the same parameters as `geocoding.search`. */
+export interface SearchQuery {
+    q: string;
+    focus?: Point;
+    country?: string | string[];
+    limit?: number;
+    lang?: string;
+}
+/** One search's answer in a batch: results and attribution, or the error the search would get on its own, unbilled. */
+export interface SearchResponse {
+    results?: Place[];
+    attribution?: Attribution[];
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+export interface SearchBatch {
+    /** One per query, in the queries' order. */
+    responses: SearchResponse[];
+}
 export interface PlaceResult {
     result: Place;
     attribution: Attribution[];
@@ -55,6 +76,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`. */
@@ -157,6 +180,8 @@ export declare class Mapricot {
     readonly geocoding: {
         /** Find addresses and places matching free text. */
         search: (q: string, { signal, ...options }?: SearchOptions) => Promise<Places>;
+        /** Run up to 100 searches in one request. Each completed search is billed as one request. */
+        searchBatch: (queries: SearchQuery[], { signal }?: RequestOptions) => Promise<SearchBatch>;
         /** Suggest addresses and places as someone types. */
         autocomplete: (q: string, { signal, ...options }?: SearchOptions) => Promise<Places>;
         /** Find the address nearest a coordinate, or the area around it. */
@@ -178,6 +203,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

@@ -30,6 +30,10 @@ export class Mapricot {
         this.geocoding = {
             /** Find addresses and places matching free text. */
             search: (q, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/geocoding/v1/search", { q, ...options }, signal),
+            /** Run up to 100 searches in one request. Each completed search is billed as one request. */
+            searchBatch: (queries, { signal } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/geocoding/v1/search/batch", {}, signal, {
+                queries: queries.map((query) => Object.fromEntries(Object.entries(query).map(([name, value]) => [name, format(value)]))),
+            }),
             /** Suggest addresses and places as someone types. */
             autocomplete: (q, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/geocoding/v1/autocomplete", { q, ...options }, signal),
             /** Find the address nearest a coordinate, or the area around it. */
@@ -44,6 +48,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.12.0",
   "description": "Official client for the Mapricot API: geocoding, places, routing, and IP geolocation.",
   "keywords": [
     "geocoding",