mapricot 0.4.0 → 0.6.0

package/README.md

@@ -29,14 +29,14 @@ Each method returns the API's JSON, typed, with the same field names as the [API
 
 | Method | Endpoint |
 | --- | --- |
-| `client.search(q, { focus, country, limit, lang })` | [`GET /v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
-| `client.autocomplete(q, { focus, country, limit, lang })` | [`GET /v1/autocomplete`](https://mapricot.com/docs/places/#suggest-as-people-type) |
-| `client.reverse(lat, lon, { limit, lang })` | [`GET /v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
-| `client.nearby(lat, lon, { category, radius, limit, lang })` | [`GET /v1/nearby`](https://mapricot.com/docs/places/#list-places-around-a-point) |
-| `client.place(id, { lang })` | [`GET /v1/places/{id}`](https://mapricot.com/docs/places/#look-up-a-saved-place) |
-| `client.route(waypoints, { mode })` | [`POST /v1/route`](https://mapricot.com/docs/routing/#get-a-route) |
-| `client.ip(address)` | [`GET /v1/ip/{ip}`](https://mapricot.com/docs/ip-geolocation/#look-up-an-address) |
-| `client.account()` | `GET /v1/account`, which checks a key and is never billed |
+| `client.search(q, { focus, country, limit, lang })` | [`GET /geocoding/v1/search`](https://mapricot.com/docs/geocoding/#find-an-address) |
+| `client.autocomplete(q, { focus, country, limit, lang })` | [`GET /geocoding/v1/autocomplete`](https://mapricot.com/docs/geocoding/#suggest-as-people-type) |
+| `client.reverse(lat, lon, { limit, lang })` | [`GET /geocoding/v1/reverse`](https://mapricot.com/docs/geocoding/#find-the-address-at-a-point) |
+| `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.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 |
 
 `focus` and each waypoint are `{ lat, lon }`. `country` and `category` take an array or a comma-separated string.
 
@@ -54,7 +54,7 @@ const request = client.autocomplete("1005 W Burn", { signal: controller.signal }
 controller.abort();
 ```
 
-A route's `polyline` is encoded with six decimal places. Decode it with precision 6, as [decoding a route polyline](https://mapricot.com/guides/polyline-decoder/) shows.
+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.
 
 If your app shows results, show the credits in each response's `attribution`.
 

package/dist/index.d.ts

@@ -40,10 +40,17 @@ export interface Leg {
 export interface Route {
     distanceMeters: number;
     durationSeconds: number;
-    /** Encoded polyline with six decimal places of precision. */
-    polyline: string;
+    /** Encoded polyline, with five decimal places unless `geometries` was `polyline6`. Absent for `geojson`. */
+    polyline?: string;
+    /** The path as GeoJSON, when `geometries` was `geojson`. */
+    geometry?: LineString;
     legs: Leg[];
 }
+export interface LineString {
+    type: "LineString";
+    /** [longitude, latitude] pairs. */
+    coordinates: [number, number][];
+}
 export interface Routes {
     routes: Route[];
     attribution?: Attribution[];
@@ -125,6 +132,7 @@ export declare class Mapricot {
     /** Find a route through 2 to 20 waypoints. */
     route(waypoints: Point[], { signal, ...options }?: RequestOptions & {
         mode?: "drive" | "walk" | "bicycle";
+        geometries?: "polyline" | "polyline6" | "geojson";
     }): Promise<Routes>;
     /** Approximate location of a public IP address. */
     ip(address: string, { signal }?: RequestOptions): Promise<IpLocation>;

package/dist/index.js

@@ -36,35 +36,35 @@ export class Mapricot {
     }
     /** Find addresses and places matching free text. */
     search(q, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/v1/search", { q, ...options }, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/geocoding/v1/search", { q, ...options }, signal);
     }
     /** Suggest addresses and places as someone types. */
     autocomplete(q, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/v1/autocomplete", { q, ...options }, signal);
+        return __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. */
     reverse(lat, lon, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/v1/reverse", { lat, lon, ...options }, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/geocoding/v1/reverse", { lat, lon, ...options }, signal);
     }
     /** List places around a coordinate, optionally by category. */
     nearby(lat, lon, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/v1/nearby", { lat, lon, ...options }, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/places/v1/nearby", { lat, lon, ...options }, signal);
     }
     /** Look up one place by its Mapricot ID. */
     place(id, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", `/v1/places/${encodeURIComponent(id)}`, options, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", `/places/v1/${encodeURIComponent(id)}`, options, signal);
     }
     /** Find a route through 2 to 20 waypoints. */
     route(waypoints, { signal, ...options } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/v1/route", {}, signal, { waypoints, ...options });
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "POST", "/routing/v1/route", {}, signal, { waypoints, ...options });
     }
     /** Approximate location of a public IP address. */
     ip(address, { signal } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", `/v1/ip/${encodeURIComponent(address)}`, {}, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", `/ip-geolocation/v1/${encodeURIComponent(address)}`, {}, signal);
     }
     /** The key's account. Not billed, so it checks a key for free. */
     account({ signal } = {}) {
-        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/v1/account", {}, signal);
+        return __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/account", {}, signal);
     }
 }
 _Mapricot_apiKey = new WeakMap(), _Mapricot_baseUrl = new WeakMap(), _Mapricot_timeout = new WeakMap(), _Mapricot_maxRetries = new WeakMap(), _Mapricot_instances = new WeakSet(), _Mapricot_request = async function _Mapricot_request(method, path, params, signal, body) {

package/package.json

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