geocodio-library-node 1.15.1 → 2.0.0

package/README.md

@@ -54,19 +54,6 @@ geocoder
   })
     /*
     response => {
-      "input": {
-        "address_components": {
-          "number": "1109",
-          "predirectional": "N",
-          "street": "Highland",
-          "suffix": "St",
-          "formatted_street": "N Highland St",
-          "city": "Arlington",
-          "state": "VA",
-          "country": "US"
-        },
-        "formatted_address": "1109 N Highland St, Arlington, VA"
-      },
       "results": [
         {
           "address_components": {
@@ -77,8 +64,8 @@ geocoder
             "formatted_street": "N Highland St",
             "city": "Arlington",
             "county": "Arlington County",
-            "state": "VA",
-            "zip": "22201",
+            "state_province": "VA",
+            "postal_code": "22201",
             "country": "US"
           },
           "formatted_address": "1109 N Highland St, Arlington, VA 22201",
@@ -99,8 +86,8 @@ geocoder
             "formatted_street": "N Highland St",
             "city": "Arlington",
             "county": "Arlington County",
-            "state": "VA",
-            "zip": "22201",
+            "state_province": "VA",
+            "postal_code": "22201",
             "country": "US"
           },
           "formatted_address": "1109 N Highland St, Arlington, VA 22201",
@@ -196,7 +183,7 @@ For forward geocoding requests it is possible to supply [individual address comp
 geocoder.geocode({
       street: '1109 N Highland St',
       city: 'Arlington',
-      state: 'VA',
+      state_province: 'VA',
       postal_code: '22201'
   })
   .then(response => { ... })
@@ -206,12 +193,12 @@ geocoder.geocode([
       {
           street: '1109 N Highland St',
           city: 'Arlington',
-          state: 'VA'
+          state_province: 'VA'
       },
       {
           street: '525 University Ave',
           city: 'Toronto',
-          state: 'ON',
+          state_province: 'ON',
           country: 'Canada',
       },
   ])

package/lib/index.d.ts

@@ -178,18 +178,23 @@ declare module 'geocodio-library-node' {
     street?: string;
     suffix?: string;
     postdirectional?: string;
-    secondaryunit?: string;
-    secondarynumber?: string;
+    unit_type?: string;
+    unit_number?: string;
     formatted_street?: string;
     city?: string;
     county?: string;
-    state?: string;
-    zip?: string;
+    state_province?: string;
+    postal_code?: string;
     country?: string;
-    postal_code?: string; // Alternative to zip used in some API calls
   }
 
-  export type AddressInputComponents = Pick<AddressComponents, "street" | "city" | "county" | "state" | "postal_code" | "country">
+  // Address input components accepted by the geocode endpoint.
+  // `state` is still accepted by the API for backwards compatibility,
+  // but `state_province` is the v2 field name.
+  export type AddressInputComponents =
+    Pick<AddressComponents, "street" | "city" | "county" | "state_province" | "postal_code" | "country"> & {
+      state?: string;
+    }
 
   export type GeocodeAccuracyType =
     | 'rooftop'
@@ -393,10 +398,6 @@ declare module 'geocodio-library-node' {
     | 'acs-social';
 
   export interface SingleGeocodeResponse {
-    input: {
-      address_components: AddressComponents;
-      formatted_address: string;
-    };
     results: GeocodedAddress[];
     _warnings?: string[];
   }

package/lib/index.js

@@ -129,13 +129,13 @@ class Geocodio {
     this.apiKey = apiKey || process.env.GEOCODIO_API_KEY || null;
     this.hostname =
       hostname || process.env.GEOCODIO_HOSTNAME || "api.geocod.io";
-    this.apiVersion = apiVersion || process.env.GEOCODIO_API_VERSION || "v1.11";
+    this.apiVersion = apiVersion || process.env.GEOCODIO_API_VERSION || "v2";
 
     this.SINGLE_TIMEOUT_MS = 5000;
     this.BATCH_TIMEOUT_MS = 30 * 60 * 1000;
 
     this.HTTP_HEADERS = {
-      "User-Agent": "geocodio-library-node/1.15.0",
+      "User-Agent": "geocodio-library-node/2.0.0",
       Authorization: `Bearer ${this.apiKey}`
     };
 
@@ -143,6 +143,7 @@ class Geocodio {
       "street",
       "city",
       "state",
+      "state_province",
       "postal_code",
       "country"
     ];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geocodio-library-node",
-  "version": "1.15.1",
+  "version": "2.0.0",
   "description": "geocod.io geocoding API library",
   "homepage": "https://github.com/Geocodio/geocodio-library-node",
   "author": {