fix: better TypeScript inference for createGeocoder, geocode and geod…

…ecode (#19)
universal-geocoder · Jun 26, 2021 · 3454903 · 3454903
1 parent d934f78
commit 3454903
Show file tree

Hide file tree

Showing 37 changed files with 642 additions and 232 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## 0.14.0
+
+* Better TypeScript inference for `createGeocoder`, `geocode` and `geodecode`
+
 ## 0.13.0
 
 * [Nominatim] Add `shape` and `shapeThreshold` geocode and geodecode parameters

diff --git a/example/node/bing.ts b/example/node/bing.ts
@@ -1,9 +1,10 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
-import GeoJsonDumper from "../../dist/cjs/GeoJsonDumper";
+import UniversalGeocoder from "UniversalGeocoder";
+import GeoJsonDumper from "GeoJsonDumper";
 
 const bingGeocoder = UniversalGeocoder.createGeocoder({
   provider: "bing",
+  apiKey: "api_key",
 });
 
 bingGeocoder.geocode("1600 Pennsylvania Ave NW, Washington, DC", (result) => {

diff --git a/example/node/chain.ts b/example/node/chain.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const yandexGeocoder = UniversalGeocoder.createGeocoder("yandex");
 const openStreetMapGeocoder = UniversalGeocoder.createGeocoder({

diff --git a/example/node/geoplugin.ts b/example/node/geoplugin.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const geoPluginGeocoder = UniversalGeocoder.createGeocoder({
   provider: "geoplugin",

diff --git a/example/node/googlemaps.ts b/example/node/googlemaps.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const googleGeocoder = UniversalGeocoder.createGeocoder({
   provider: "googlemaps",

diff --git a/example/node/locationiq.ts b/example/node/locationiq.ts
@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const locationIQGeocoder = UniversalGeocoder.createGeocoder({
   provider: "locationiq",
+  apiKey: "api_key",
 });
 
 const asyncGeocode = async () => {

diff --git a/example/node/mapbox.ts b/example/node/mapbox.ts
@@ -1,7 +1,10 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
-const mapboxGeocoder = UniversalGeocoder.createGeocoder({ provider: "mapbox" });
+const mapboxGeocoder = UniversalGeocoder.createGeocoder({
+  provider: "mapbox",
+  apiKey: "api_key",
+});
 
 mapboxGeocoder.geocode("1600 Pennsylvania Ave NW, Washington, DC", (result) => {
   console.log("geocode", result);

diff --git a/example/node/mapquest.ts b/example/node/mapquest.ts
@@ -1,13 +1,11 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
-import Geocoded from "../../dist/cjs/Geocoded";
-import {
-  MapQuestGeocodeQuery,
-  MapQuestLocation,
-} from "../../dist/cjs/provider";
+import UniversalGeocoder from "UniversalGeocoder";
+import Geocoded from "Geocoded";
+import { MapQuestGeocodeQuery, MapQuestLocation } from "provider";
 
 let mapQuestGeocoder = UniversalGeocoder.createGeocoder({
   provider: "mapquest",
+  apiKey: "api_key",
 });
 
 mapQuestGeocoder.geocode(
@@ -36,7 +34,7 @@ asyncGeodecode();
 mapQuestGeocoder.geocode(
   MapQuestGeocodeQuery.create({
     location: Geocoded.create({
-      streetNumber: 1600,
+      streetNumber: "1600",
       streetName: "Pennsylvania Ave NW",
       locality: "Washington",
     }),

diff --git a/example/node/opencage.ts b/example/node/opencage.ts
@@ -1,8 +1,9 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const openCageGeocoder = UniversalGeocoder.createGeocoder({
   provider: "opencage",
+  apiKey: "api_key",
 });
 
 openCageGeocoder.geocode(

diff --git a/example/node/openstreetmap.ts b/example/node/openstreetmap.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const openStreetMapGeocoder = UniversalGeocoder.createGeocoder({
   provider: "openstreetmap",

diff --git a/example/node/tsconfig.json b/example/node/tsconfig.json
diff --git a/example/node/yandex.ts b/example/node/yandex.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import UniversalGeocoder from "../../dist/cjs/UniversalGeocoder";
+import UniversalGeocoder from "UniversalGeocoder";
 
 const yandexGeocoder = UniversalGeocoder.createGeocoder("yandex");
 

diff --git a/package.json b/package.json
@@ -95,7 +95,7 @@
     "serve": "http-server",
     "test": "ts-node --project tsconfig-cjs.json --compiler ttypescript -r tsconfig-paths/register node_modules/.bin/jasmine",
     "test-record": "POLLY_RECORD=1 npm test",
-    "ts-node": "ts-node --project example/node/tsconfig.json",
+    "ts-node": "ts-node --project tsconfig-cjs.json --compiler ttypescript -r tsconfig-paths/register",
     "watch": "concurrently -k \"webpack --config webpack.dev.js --watch\" \"ttsc -p tsconfig-cjs.json --watch\" \"ttsc --watch\""
   },
   "lint-staged": {

diff --git a/spec/GeocoderProviderFactory.spec.ts b/spec/GeocoderProviderFactory.spec.ts
@@ -1,7 +1,4 @@
-import ProviderFactory, {
-  GeocoderProviderFactoryOptions,
-} from "GeocoderProviderFactory";
-import { OpenStreetMapProviderOptionsInterface } from "provider";
+import ProviderFactory from "GeocoderProviderFactory";
 
 describe("Geocoder Factory", () => {
   it("expects createProvider method to return undefined for an unregistered provider", () => {
@@ -15,9 +12,10 @@ describe("Geocoder Factory", () => {
   });
 
   it("expects createProvider method to return an OpenStreetMap Provider", () => {
-    const provider = ProviderFactory.createProvider(<
-      GeocoderProviderFactoryOptions & OpenStreetMapProviderOptionsInterface
-    >{ provider: "openstreetmap", userAgent: "Test User-Agent" });
+    const provider = ProviderFactory.createProvider({
+      provider: "openstreetmap",
+      userAgent: "Test User-Agent",
+    });
     expect(provider).toBeDefined();
   });
 });
diff --git a/spec/provider/BingProvider.spec.ts b/spec/provider/BingProvider.spec.ts
@@ -30,7 +30,7 @@ describe("Bing Geocoder Provider", () => {
     });
 
     expect(() =>
-      provider?.geocode(
+      provider.geocode(
         "66.147.244.214",
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {}
@@ -48,7 +48,7 @@ describe("Bing Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geocode(
+    provider.geocode(
       "1600 Pennsylvania Ave, Washington, DC",
       (results: BingGeocoded[]) => {
         const geocoded = results[0];
@@ -102,7 +102,7 @@ describe("Bing Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geodecode(48.8631507, 2.388911, (results: BingGeocoded[]) => {
+    provider.geodecode(48.8631507, 2.388911, (results: BingGeocoded[]) => {
       const geocoded = results[0];
 
       expect(geocoded).toBeDefined();
@@ -153,7 +153,7 @@ describe("Bing Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geocode(
+    provider.geocode(
       "1600 Pennsylvania Ave, Washington, DC",
       () => {
         done();

diff --git a/spec/provider/ChainProvider.spec.ts b/spec/provider/ChainProvider.spec.ts
@@ -135,7 +135,7 @@ describe("Chain Geocoder Provider", () => {
       providers: [yandexGeocoder, openStreetMapGeocoder],
     });
 
-    provider?.geocode(
+    provider.geocode(
       { text: "1600 Pennsylvania Ave, Washington, DC", locale: "en_US" },
       (results: Geocoded[]) => {
         const geocoded = results[0];
@@ -163,7 +163,7 @@ describe("Chain Geocoder Provider", () => {
       providers: [yandexGeocoder, openStreetMapGeocoder],
     });
 
-    provider?.geocode(
+    provider.geocode(
       { text: "1600 Pennsylvania Ave, Washington, DC", locale: "en_US" },
       (results: Geocoded[]) => {
         const geocoded = results[0];
@@ -192,7 +192,7 @@ describe("Chain Geocoder Provider", () => {
       parallelize: true,
     });
 
-    provider?.geocode(
+    provider.geocode(
       { text: "1600 Pennsylvania Ave, Washington, DC", locale: "en_US" },
       (results: Geocoded[]) => {
         const geocoded = results[0];
@@ -221,7 +221,7 @@ describe("Chain Geocoder Provider", () => {
       parallelize: true,
     });
 
-    provider?.geocode(
+    provider.geocode(
       { text: "1600 Pennsylvania Ave, Washington, DC", locale: "en_US" },
       (results: Geocoded[]) => {
         const geocoded = results[0];
@@ -250,7 +250,7 @@ describe("Chain Geocoder Provider", () => {
       first: true,
     });
 
-    provider?.geocode(
+    provider.geocode(
       { text: "1600 Pennsylvania Ave, Washington, DC", locale: "en_US" },
       (results: Geocoded[]) => {
         const geocoded = results[0];
@@ -278,7 +278,7 @@ describe("Chain Geocoder Provider", () => {
       providers: [yandexGeocoder, openStreetMapGeocoder],
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       {
         coordinates: { latitude: 48.8631507, longitude: 2.388911 },
         locale: "en_US",
@@ -309,7 +309,7 @@ describe("Chain Geocoder Provider", () => {
       providers: [yandexGeocoder, openStreetMapGeocoder],
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       {
         coordinates: { latitude: 48.8631507, longitude: 2.388911 },
         locale: "en_US",
@@ -341,7 +341,7 @@ describe("Chain Geocoder Provider", () => {
       parallelize: true,
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       {
         coordinates: { latitude: 48.8631507, longitude: 2.388911 },
         locale: "en_US",
@@ -373,7 +373,7 @@ describe("Chain Geocoder Provider", () => {
       parallelize: true,
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       {
         coordinates: { latitude: 48.8631507, longitude: 2.388911 },
         locale: "en_US",
@@ -405,7 +405,7 @@ describe("Chain Geocoder Provider", () => {
       first: true,
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       {
         coordinates: { latitude: 48.8631507, longitude: 2.388911 },
         locale: "en_US",

diff --git a/spec/provider/GeoPluginProvider.spec.ts b/spec/provider/GeoPluginProvider.spec.ts
@@ -20,7 +20,7 @@ describe("GeoPlugin Geocoder Provider", () => {
     });
 
     expect(() =>
-      provider?.geocode(
+      provider.geocode(
         "1600 Pennsylvania Ave, Washington, DC",
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {}
@@ -37,7 +37,7 @@ describe("GeoPlugin Geocoder Provider", () => {
     });
 
     expect(() =>
-      provider?.geodecode(
+      provider.geodecode(
         48.8631507,
         2.388911,
         // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -54,7 +54,7 @@ describe("GeoPlugin Geocoder Provider", () => {
       provider: "geoplugin",
     });
 
-    provider?.geocode("190.226.155.134", (results: GeoPluginGeocoded[]) => {
+    provider.geocode("190.226.155.134", (results: GeoPluginGeocoded[]) => {
       const geocoded = results[0];
 
       expect(geocoded).toBeDefined();
@@ -85,7 +85,7 @@ describe("GeoPlugin Geocoder Provider", () => {
       provider: "geoplugin",
     });
 
-    provider?.geocode("127.0.0.1", (results: GeoPluginGeocoded[]) => {
+    provider.geocode("127.0.0.1", (results: GeoPluginGeocoded[]) => {
       const geocoded = results[0];
 
       expect(geocoded).toBeDefined();
@@ -111,7 +111,7 @@ describe("GeoPlugin Geocoder Provider", () => {
       provider: "geoplugin",
     });
 
-    provider?.geocode(
+    provider.geocode(
       "192.168.1.10",
       () => {
         done();

diff --git a/spec/provider/GoogleMapsProvider.spec.ts b/spec/provider/GoogleMapsProvider.spec.ts
@@ -55,7 +55,7 @@ describe("Google Maps Geocoder Provider", () => {
     });
 
     expect(() =>
-      provider?.geocode(
+      provider.geocode(
         "66.147.244.214",
         // eslint-disable-next-line @typescript-eslint/no-empty-function
         () => {}
@@ -73,7 +73,7 @@ describe("Google Maps Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geocode("1600 Pennsylvania Ave, Washington, DC", (results) => {
+    provider.geocode("1600 Pennsylvania Ave, Washington, DC", (results) => {
       const geocoded = results[0];
 
       expect(geocoded).toBeDefined();
@@ -126,7 +126,7 @@ describe("Google Maps Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geodecode(
+    provider.geodecode(
       48.8631507,
       2.388911,
       (results: GoogleMapsGeocoded[]) => {
@@ -183,7 +183,7 @@ describe("Google Maps Geocoder Provider", () => {
       apiKey: "api_key",
     });
 
-    provider?.geocode(
+    provider.geocode(
       "1600 Pennsylvania Ave, Washington, DC",
       () => {
         done();