mapricot 0.11.0 → 0.13.0

package/README.md

@@ -25,18 +25,19 @@ In a web page, use a browser key, which works only from the origins you allow, a
 
 ## Methods
 
-Methods are grouped by product, the same way as the API's paths. Each returns the API's JSON, typed, with the same field names as the [API reference](https://mapricot.com/api-reference/).
+Methods are grouped by product, the same way as the API's paths. Each returns the API's JSON, typed, with the same field names as the [API reference](https://mapricot.com/docs/api-reference/).
 
 | 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.routing.route(waypoints, { mode, geometries, steps, lang, costing })` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.routing.optimize(waypoints, { mode, geometries, steps, lang, costing })` | [`POST /routing/v1/optimize`](https://mapricot.com/docs/routing/#optimize-the-order-of-stops) |
+| `client.routing.isochrone(location, minutes, { mode, costing })` | [`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 |
 
@@ -48,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
@@ -69,6 +77,8 @@ 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"`.
 
+`costing` changes how a route, optimized route, or isochrone picks its roads, with Valhalla's [costing options](https://mapricot.com/docs/routing/#costing-options) for the mode, such as `{ useTolls: 0, useHighways: 0 }` to drive avoiding tolls and highways where it can.
+
 If your app shows results, show the credits in each response's `attribution`.
 
 ## Errors and retries
@@ -86,11 +96,11 @@ try {
 }
 ```
 
-The client retries `503` responses and `429 concurrency_exceeded`, up to twice, waiting longer each time. Errors aren't billed. Set `maxRetries` and `timeout` (milliseconds) in the constructor's options to change this. The [API reference](https://mapricot.com/api-reference/#errors) lists every status.
+The client retries `503` responses and `429 concurrency_exceeded`, up to twice, waiting longer each time. Errors aren't billed. Set `maxRetries` and `timeout` (milliseconds) in the constructor's options to change this. The [API reference](https://mapricot.com/docs/api-reference/#errors) lists every status.
 
 ## Links
 
 - [Mapricot](https://mapricot.com/)
 - [Node.js docs](https://mapricot.com/docs/node/)
-- [API reference](https://mapricot.com/api-reference/)
+- [API reference](https://mapricot.com/docs/api-reference/)
 - [Pricing](https://mapricot.com/pricing/)

package/dist/index.d.ts

@@ -35,10 +35,33 @@ 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[];
 }
+/** Valhalla's costing options for the mode, named in camelCase, such as `{ useTolls: 0 }`. See https://mapricot.com/docs/routing/#costing-options. */
+export type Costing = Record<string, number | boolean | string>;
 export interface Leg {
     distanceMeters: number;
     durationSeconds: number;
@@ -159,6 +182,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. */
@@ -179,6 +204,7 @@ export declare class Mapricot {
             geometries?: "polyline" | "polyline6" | "geojson";
             steps?: boolean;
             lang?: string;
+            costing?: Costing;
         }) => 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 & {
@@ -186,10 +212,12 @@ export declare class Mapricot {
             geometries?: "polyline" | "polyline6" | "geojson";
             steps?: boolean;
             lang?: string;
+            costing?: Costing;
         }) => 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";
+            costing?: Costing;
         }) => Promise<Isochrones>;
     };
     readonly ipGeolocation: {

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. */

package/package.json

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