mapricot 0.14.0 → 0.15.0

package/README.md

@@ -29,7 +29,7 @@ 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.search(q or { address, locality, county, region, postalCode }, { 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) |
@@ -49,7 +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.
+When you already have an address in parts, such as a spreadsheet's columns, pass them in place of the text. Search ignores a blank part:
+
+```js
+const { results } = await client.geocoding.search({ address: "10 Downing Street", locality: "London", postalCode: "SW1A 2AA" }, { country: "GB" });
+```
+
+`searchBatch` runs up to 100 searches in one request. Each query is an object of `search`'s parameters, with `q` or the address parts, 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 }]);

package/dist/index.d.ts

@@ -35,9 +35,20 @@ export interface Places {
     results: Place[];
     attribution: Attribution[];
 }
-/** One search in a batch, with the same parameters as `geocoding.search`. */
-export interface SearchQuery {
-    q: string;
+/** An address in parts, such as a spreadsheet's columns, which search takes in place of free text. */
+export interface AddressParts {
+    /** The street line: house number, street, and any unit or building. */
+    address?: string;
+    /** The town or city. */
+    locality?: string;
+    county?: string;
+    /** The state, province, or region. */
+    region?: string;
+    postalCode?: string;
+}
+/** One search in a batch, with the same parameters as `geocoding.search`: `q`, or an address in parts. */
+export interface SearchQuery extends AddressParts {
+    q?: string;
     focus?: Point;
     country?: string | string[];
     limit?: number;
@@ -180,8 +191,8 @@ export declare class Mapricot {
     #private;
     constructor(options: ClientOptions);
     readonly geocoding: {
-        /** Find addresses and places matching free text. */
-        search: (q: string, { signal, ...options }?: SearchOptions) => Promise<Places>;
+        /** Find addresses and places matching free text, or an address given in parts. */
+        search: (query: string | AddressParts, { 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. */

package/dist/index.js

@@ -28,8 +28,8 @@ export class Mapricot {
         _Mapricot_timeout.set(this, void 0);
         _Mapricot_maxRetries.set(this, void 0);
         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),
+            /** Find addresses and places matching free text, or an address given in parts. */
+            search: (query, { signal, ...options } = {}) => __classPrivateFieldGet(this, _Mapricot_instances, "m", _Mapricot_request).call(this, "GET", "/geocoding/v1/search", { ...(typeof query === "string" ? { q: query } : query), ...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)]))),

package/package.json

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