mapricot 0.6.0 → 0.7.0

package/README.md

@@ -35,6 +35,7 @@ Each method returns the API's JSON, typed, with the same field names as the [API
 | `client.nearby(lat, lon, { category, radius, limit, lang })` | [`GET /places/v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
 | `client.place(id, { lang })` | [`GET /places/v1/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
 | `client.route(waypoints, { mode, geometries })` | [`POST /routing/v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
+| `client.isochrone(location, minutes, { mode })` | [`POST /routing/v1/isochrone`](https://mapricot.com/docs/routing/#get-an-isochrone) |
 | `client.ip(address)` | [`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 |
 
@@ -56,6 +57,13 @@ 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.
 
+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
+const area = await client.isochrone({ lat: 45.5189, lon: -122.6793 }, [5, 10], { mode: "walk" });
+map.addSource("reach", { type: "geojson", data: area });
+```
+
 If your app shows results, show the credits in each response's `attribution`.
 
 ## Errors and retries

package/dist/index.d.ts

@@ -55,6 +55,26 @@ export interface Routes {
     routes: Route[];
     attribution?: Attribution[];
 }
+export interface Isochrone {
+    type: "Feature";
+    properties: {
+        minutes: number;
+    };
+    /** [longitude, latitude] rings, as GeoJSON. */
+    geometry: {
+        type: "Polygon";
+        coordinates: [number, number][][];
+    } | {
+        type: "MultiPolygon";
+        coordinates: [number, number][][][];
+    };
+}
+export interface Isochrones {
+    type: "FeatureCollection";
+    /** One area per time, largest first. Empty when there is no road near the location. */
+    features: Isochrone[];
+    attribution?: Attribution[];
+}
 export interface IpLocation {
     ip: string;
     found: boolean;
@@ -134,6 +154,10 @@ export declare class Mapricot {
         mode?: "drive" | "walk" | "bicycle";
         geometries?: "polyline" | "polyline6" | "geojson";
     }): 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";
+    }): Promise<Isochrones>;
     /** Approximate location of a public IP address. */
     ip(address: string, { signal }?: RequestOptions): Promise<IpLocation>;
     /** The key's account. Not billed, so it checks a key for free. */

package/dist/index.js

@@ -58,6 +58,10 @@ export class Mapricot {
     route(waypoints, { signal, ...options } = {}) {
         return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/route", {}, signal, { waypoints, ...options });
     }
+    /** The areas reachable from a location within 1 to 4 times, each 1 to 60 minutes. */
+    isochrone(location, minutes, { signal, ...options } = {}) {
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/isochrone", {}, signal, { location, minutes, ...options });
+    }
     /** Approximate location of a public IP address. */
     ip(address, { signal } = {}) {
         return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", `/ip-geolocation/v1/${encodeURIComponent(address)}`, {}, signal);

package/package.json

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