geocodio-library-node 1.6.1 → 1.7.0

package/README.md

@@ -41,7 +41,7 @@ $ yarn add geocodio-library-node
 ```javascript
 const Geocodio = require('geocodio-library-node');
 const geocoder = new Geocodio('YOUR_API_KEY');
-// const geocoder = new Geocodio('YOUR_API_KEY', 'api-hipaa.geocod.io'); // optionally overwrite the API hostname
+// const geocoder = new Geocodio('YOUR_API_KEY', 'api.enterprise.geocod.io'); // optionally overwrite the API hostname
 
 geocoder
   .geocode('1109 N Highland St, Arlington, VA')
@@ -311,5 +311,5 @@ If you discover any security related issues, please email security@geocod.io ins
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
 
-[npm-image]: https://badge.fury.io/js/geocodio-library-node.svg
+[npm-image]: https://img.shields.io/npm/v/geocodio-library-node
 [npm-url]: https://npmjs.org/package/geocodio-library-node

package/lib/index.d.ts

@@ -0,0 +1,87 @@
+declare module 'geocodio-library-node' {
+  export interface AddressComponents {
+    number?: string;
+    predirectional?: string;
+    street?: string;
+    suffix?: string;
+    formatted_street?: string;
+    city?: string;
+    county?: string;
+    state?: string;
+    zip?: string;
+    country?: string;
+    postal_code?: string; // Alternative to zip used in some API calls
+  }
+
+  export type GeocodeAccuracyType =
+    | 'rooftop'
+    | 'street'
+    | 'intersection'
+    | 'city'
+    | 'state'
+    | 'county';
+
+  export interface GeocodedAddress {
+    address_components: AddressComponents;
+    formatted_address: string;
+    location: {
+      lat: number;
+      lng: number;
+    };
+    accuracy: number;
+    accuracy_type: GeocodeAccuracyType;
+    source?: string;
+    fields?: Fields;
+  }
+
+  export interface Fields {
+    timezone?: {
+      abbreviation: string;
+      [key: string]: unknown;
+    };
+    [key: string]: unknown;
+  }
+
+  export interface SingleGeocodeResponse {
+    input: {
+      address_components: AddressComponents;
+      formatted_address: string;
+    };
+    results: GeocodedAddress[];
+  }
+
+  export interface BatchGeocodeResponse {
+    results: {
+      [key: string]: {
+        response: SingleGeocodeResponse;
+      };
+    };
+  }
+
+  // List API types
+  export interface ListResponse {
+    id: number;
+    file: {
+      filename: string;
+    };
+  }
+
+  export default class Geocodio {
+    constructor(apiKey?: string, hostname?: string, apiVersion?: string);
+
+    geocode(query: string | AddressComponents, fields?: string[], limit?: number): Promise<SingleGeocodeResponse>;
+    geocode(query: (string | AddressComponents)[] | Record<string, string | AddressComponents>, fields?: string[], limit?: number): Promise<BatchGeocodeResponse>;
+
+    reverse(query: string | [number, number], fields?: string[], limit?: number): Promise<SingleGeocodeResponse>;
+    reverse(query: (string | [number, number])[], fields?: string[], limit?: number): Promise<BatchGeocodeResponse>;
+
+    list: {
+      create(filename: string, direction: string, format: string, callback: string): Promise<ListResponse>;
+      status(listId: number): Promise<unknown>;
+      all(): Promise<unknown>;
+      download(listId: number, output: string): Promise<unknown>;
+      delete(listId: number): Promise<unknown>;
+      deleteList(listId: number): Promise<unknown>; // Alias for delete
+    };
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geocodio-library-node",
-  "version": "1.6.1",
+  "version": "1.7.0",
   "description": "geocod.io geocoding API library",
   "homepage": "https://github.com/Geocodio/geocodio-library-node",
   "author": {
@@ -12,6 +12,7 @@
     "lib"
   ],
   "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "keywords": [
     "geocoding",
     "geocode",