mapricot 0.12.0 → 0.13.0

package/README.md

@@ -25,7 +25,7 @@ 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 |
 | --- | --- |
@@ -35,9 +35,9 @@ 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, 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 |
 
@@ -77,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
@@ -94,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

@@ -60,6 +60,8 @@ 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;
@@ -202,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 & {
@@ -209,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/package.json

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