Use geocodingQueryParams in all geocoders

perliedman · Nov 25, 2020 · 84d764a · 84d764a
1 parent 1013a03
commit 84d764a
Show file tree

Hide file tree

Showing 13 changed files with 180 additions and 146 deletions.
diff --git a/src/geocoders/api.ts b/src/geocoders/api.ts
@@ -35,3 +35,10 @@ export interface GeocoderOptions {
   reverseQueryParams?: Record<string, unknown>;
   apiKey?: string;
 }
+
+export function geocodingParams(
+  options: GeocoderOptions,
+  params: Record<string, unknown>
+): Record<string, unknown> {
+  return L.Util.extend(params, options.geocodingQueryParams);
+}
diff --git a/src/geocoders/arcgis.ts b/src/geocoders/arcgis.ts
@@ -4,6 +4,7 @@ import {
   GeocoderAPI,
   GeocoderOptions,
   GeocodingCallback,
+  geocodingParams,
   GeocodingResult,
   ReverseGeocodingResult
 } from './api';
@@ -21,39 +22,35 @@ export class ArcGis implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    const params = {
+    const params = geocodingParams(this.options, {
       token: this.options.apiKey,
       SingleLine: query,
       outFields: 'Addr_Type',
       forStorage: false,
       maxLocations: 10,
       f: 'json'
-    };
+    });
 
-    getJSON(
-      this.options.serviceUrl + '/findAddressCandidates',
-      L.Util.extend(params, this.options.geocodingQueryParams),
-      data => {
-        const results: GeocodingResult[] = [];
-        if (data.candidates && data.candidates.length) {
-          for (let i = 0; i <= data.candidates.length - 1; i++) {
-            const loc = data.candidates[i];
-            const latLng = L.latLng(loc.location.y, loc.location.x);
-            const latLngBounds = L.latLngBounds(
-              L.latLng(loc.extent.ymax, loc.extent.xmax),
-              L.latLng(loc.extent.ymin, loc.extent.xmin)
-            );
-            results[i] = {
-              name: loc.address,
-              bbox: latLngBounds,
-              center: latLng
-            };
-          }
+    getJSON(this.options.serviceUrl + '/findAddressCandidates', params, data => {
+      const results: GeocodingResult[] = [];
+      if (data.candidates && data.candidates.length) {
+        for (let i = 0; i <= data.candidates.length - 1; i++) {
+          const loc = data.candidates[i];
+          const latLng = L.latLng(loc.location.y, loc.location.x);
+          const latLngBounds = L.latLngBounds(
+            L.latLng(loc.extent.ymax, loc.extent.xmax),
+            L.latLng(loc.extent.ymin, loc.extent.xmin)
+          );
+          results[i] = {
+            name: loc.address,
+            bbox: latLngBounds,
+            center: latLng
+          };
         }
-
-        cb.call(context, results);
       }
-    );
+
+      cb.call(context, results);
+    });
   }
 
   suggest(query: string, cb: GeocodingCallback, context?: any): void {

diff --git a/src/geocoders/bing.ts b/src/geocoders/bing.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { jsonp } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface BingOptions extends GeocoderOptions {}
 
@@ -14,13 +20,13 @@ export class Bing implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    const params = {
+    const params = geocodingParams(this.options, {
       query: query,
       key: this.options.apiKey
-    };
+    });
     jsonp(
       this.options.apiKey,
-      L.Util.extend(params, this.options.geocodingQueryParams),
+      params,
       data => {
         const results: GeocodingResult[] = [];
         if (data.resourceSets.length > 0) {

diff --git a/src/geocoders/google.ts b/src/geocoders/google.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface GoogleOptions extends GeocoderOptions {}
 
@@ -14,13 +20,10 @@ export class Google implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    let params = {
+    const params = geocodingParams(this.options, {
       key: this.options.apiKey,
       address: query
-    };
-
-    params = L.Util.extend(params, this.options.geocodingQueryParams);
-
+    });
     getJSON(this.options.serviceUrl, params, data => {
       const results: GeocodingResult[] = [];
       if (data.results && data.results.length) {

diff --git a/src/geocoders/here.ts b/src/geocoders/here.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface HereOptions extends GeocoderOptions {
   app_id: string;
@@ -22,14 +28,13 @@ export class HERE implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    let params = {
+    const params = geocodingParams(this.options, {
       searchtext: query,
       gen: 9,
       app_id: this.options.app_id,
       app_code: this.options.app_code,
       jsonattributes: 1
-    };
-    params = L.Util.extend(params, this.options.geocodingQueryParams);
+    });
     this.getJSON(this.options.serviceUrl + 'geocode.json', params, cb, context);
   }
 

diff --git a/src/geocoders/mapbox.ts b/src/geocoders/mapbox.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface MapboxOptions extends GeocoderOptions {}
 
@@ -32,10 +38,9 @@ export class Mapbox implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    const params: any = L.Util.extend(
-      { access_token: this.options.apiKey },
-      this.options.geocodingQueryParams
-    );
+    const params: any = geocodingParams(this.options, {
+      access_token: this.options.apiKey
+    });
     if (
       params.proximity !== undefined &&
       params.proximity.lat !== undefined &&

diff --git a/src/geocoders/mapquest.ts b/src/geocoders/mapquest.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface MapQuestOptions extends GeocoderOptions {}
 
@@ -21,14 +27,15 @@ export class MapQuest implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
+    const params = geocodingParams(this.options, {
+      key: this.options.apiKey,
+      location: query,
+      limit: 5,
+      outFormat: 'json'
+    });
     getJSON(
       this.options.serviceUrl + '/address',
-      {
-        key: this.options.apiKey,
-        location: query,
-        limit: 5,
-        outFormat: 'json'
-      },
+      params,
       L.Util.bind(function(data) {
         const results: GeocodingResult[] = [];
         if (data.results && data.results[0].locations) {

diff --git a/src/geocoders/neutrino.ts b/src/geocoders/neutrino.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface NeutrinoOptions extends GeocoderOptions {
   userId: string;
@@ -19,30 +25,27 @@ export class Neutrino implements GeocoderAPI {
 
   // https://www.neutrinoapi.com/api/geocode-address/
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    getJSON(
-      this.options.serviceUrl + 'geocode-address',
-      {
-        apiKey: this.options.apiKey,
-        userId: this.options.userId,
-        //get three words and make a dot based string
-        address: query.split(/\s+/).join('.')
-      },
-      data => {
-        const results: GeocodingResult[] = [];
-        if (data.locations) {
-          data.geometry = data.locations[0];
-          const center = L.latLng(data.geometry['latitude'], data.geometry['longitude']);
-          const bbox = L.latLngBounds(center, center);
-          results[0] = {
-            name: data.geometry.address,
-            bbox: bbox,
-            center: center
-          };
-        }
-
-        cb.call(context, results);
+    const params = geocodingParams(this.options, {
+      apiKey: this.options.apiKey,
+      userId: this.options.userId,
+      //get three words and make a dot based string
+      address: query.split(/\s+/).join('.')
+    });
+    getJSON(this.options.serviceUrl + 'geocode-address', params, data => {
+      const results: GeocodingResult[] = [];
+      if (data.locations) {
+        data.geometry = data.locations[0];
+        const center = L.latLng(data.geometry['latitude'], data.geometry['longitude']);
+        const bbox = L.latLngBounds(center, center);
+        results[0] = {
+          name: data.geometry.address,
+          bbox: bbox,
+          center: center
+        };
       }
-    );
+
+      cb.call(context, results);
+    });
   }
 
   suggest(query: string, cb: GeocodingCallback, context?: any): void {

diff --git a/src/geocoders/nominatim.ts b/src/geocoders/nominatim.ts
@@ -4,6 +4,7 @@ import {
   GeocoderAPI,
   GeocoderOptions,
   GeocodingCallback,
+  geocodingParams,
   GeocodingResult,
   ReverseGeocodingResult
 } from './api';
@@ -78,34 +79,28 @@ export class Nominatim implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any) {
-    getJSON(
-      this.options.serviceUrl + 'search',
-      L.Util.extend(
-        {
-          q: query,
-          limit: 5,
-          format: 'json',
-          addressdetails: 1
-        },
-        this.options.geocodingQueryParams
-      ),
-      data => {
-        const results: GeocodingResult[] = [];
-        for (let i = data.length - 1; i >= 0; i--) {
-          const bbox = data[i].boundingbox;
-          for (let j = 0; j < 4; j++) bbox[j] = parseFloat(bbox[j]);
-          results[i] = {
-            icon: data[i].icon,
-            name: data[i].display_name,
-            html: this.options.htmlTemplate ? this.options.htmlTemplate(data[i]) : undefined,
-            bbox: L.latLngBounds([bbox[0], bbox[2]], [bbox[1], bbox[3]]),
-            center: L.latLng(data[i].lat, data[i].lon),
-            properties: data[i]
-          };
-        }
-        cb.call(context, results);
+    const params = geocodingParams(this.options, {
+      q: query,
+      limit: 5,
+      format: 'json',
+      addressdetails: 1
+    });
+    getJSON(this.options.serviceUrl + 'search', params, data => {
+      const results: GeocodingResult[] = [];
+      for (let i = data.length - 1; i >= 0; i--) {
+        const bbox = data[i].boundingbox;
+        for (let j = 0; j < 4; j++) bbox[j] = parseFloat(bbox[j]);
+        results[i] = {
+          icon: data[i].icon,
+          name: data[i].display_name,
+          html: this.options.htmlTemplate ? this.options.htmlTemplate(data[i]) : undefined,
+          bbox: L.latLngBounds([bbox[0], bbox[2]], [bbox[1], bbox[3]]),
+          center: L.latLng(data[i].lat, data[i].lon),
+          properties: data[i]
+        };
       }
-    );
+      cb.call(context, results);
+    });
   }
 
   reverse(location: L.LatLngLiteral, scale: number, cb: (result: any) => void, context?: any) {

diff --git a/src/geocoders/opencage.ts b/src/geocoders/opencage.ts
@@ -1,6 +1,12 @@
 import * as L from 'leaflet';
 import { getJSON } from '../util';
-import { GeocoderAPI, GeocoderOptions, GeocodingCallback, GeocodingResult } from './api';
+import {
+  GeocoderAPI,
+  GeocoderOptions,
+  GeocodingCallback,
+  geocodingParams,
+  GeocodingResult
+} from './api';
 
 export interface OpenCageOptions extends GeocoderOptions {}
 
@@ -14,10 +20,10 @@ export class OpenCage implements GeocoderAPI {
   }
 
   geocode(query: string, cb: GeocodingCallback, context?: any): void {
-    const params = L.Util.extend(
-      { key: this.options.apiKey, q: query },
-      this.options.geocodingQueryParams
-    );
+    const params = geocodingParams(this.options, {
+      key: this.options.apiKey,
+      q: query
+    });
     getJSON(this.options.serviceUrl, params, data => {
       const results: GeocodingResult[] = [];
       if (data.results && data.results.length) {