Add new geocoding provider: Bing (Locations API)

gulpfile.js

@@ -256,6 +256,15 @@ gulp.task('images', function () {
     .pipe(gulp.dest(outputFolder + '/static/client/fonts/'))
 });
 
+/**
+ * Deploy geocoding providers (src/assets/geocoding-providers)
+ */
+gulp.task('geocoding-providers', function () {
+  return gulp.src(`${g3w.assetsFolder}/geocoding-providers/*`)
+    .pipe(flatten())
+    .pipe(gulp.dest(outputFolder + '/static/client/geocoding-providers/'));
+});
+
 /**
  * Compile client styles (src/assets/style/less/app.less --> app.min.css)
  */
@@ -331,10 +340,11 @@ gulp.task('browser-sync', function() {
   // gulp.watch(['./src/index.html', './src/**/*.html'], gulp.series('browser:reload'));
   //
 
-  gulp.watch([g3w.assetsFolder + '/style/**/*.less'], () => runSequence('less','browser:reload'));
-  gulp.watch('./src/**/*.{png,jpg}',                  () => runSequence('images','browser:reload'));
-  gulp.watch(['./src/index.html'],                    () => runSequence('html', 'browser:reload'));
-  gulp.watch(g3w.pluginsFolder + '/*/plugin.js',      (file) => {
+  gulp.watch([g3w.assetsFolder + '/style/**/*.less'],          () => runSequence('less',                'browser:reload'));
+  gulp.watch([g3w.assetsFolder + '/geocoding-providers/**/*'], () => runSequence('geocoding-providers', 'browser:reload'));
+  gulp.watch('./src/**/*.{png,jpg,gif,svg}',                   () => runSequence('images',              'browser:reload'));
+  gulp.watch(['./src/index.html'],                             () => runSequence('html',                'browser:reload'));
+  gulp.watch(g3w.pluginsFolder + '/*/plugin.js',               (file) => {
     const plugins = process.env.G3W_PLUGINS;
     process.env.G3W_PLUGINS = path.basename(path.dirname(file.path));
     runSequence('deploy-plugins', 'browser:reload', () => process.env.G3W_PLUGINS = plugins)
@@ -465,7 +475,7 @@ gulp.task('build:plugins', (done) => runSequence('clone:default_plugins', 'selec
 /**
  * Compile and deploy local developed client file assets (static and templates)
  */
-gulp.task('build:client', ['browserify:app', 'concatenate:vendor_js', 'concatenate:vendor_css', 'fonts', 'images', 'less', 'datatable-images', 'html']);
+gulp.task('build:client', ['browserify:app', 'concatenate:vendor_js', 'concatenate:vendor_css', 'fonts', 'images', 'less', 'datatable-images', 'geocoding-providers', 'html']);
 
 /**
  * [PROD] Compile and deploy client application

package.json

@@ -30,8 +30,8 @@
   "homepage": "https://github.com/g3w-suite/g3w-client.git",
   "dependencies": {
     "lodash.clonedeep": "^4.5.0",
-    "util-deprecate": "^1.0.2",
     "shp-write": "^0.3.2",
+    "util-deprecate": "^1.0.2",
     "vue": "2.6.12",
     "vue-color": "^2.8.1",
     "vue-cookie": "^1.1.4",

src/app/api.js

@@ -73,7 +73,7 @@ const Workflow = require('core/workflow/workflow');
  * GUI modules
  */
 const Panel = require('gui/panel');
-const ControlFactory = require('gui/map/control/factory');
+const { ControlFactory } = require('gui/map/mapservice');
 const ComponentsFactory = require('gui/component/componentsfactory');
 const FieldsService = require('gui/fields/fieldsservice');
 const Component = require('gui/component/component');

src/app/core/layers/utils/addToSelection.js

@@ -27,7 +27,7 @@ function _handleExternalVectorLayerSelection(map, layer, {
     return;
   }
   //Take in account array or single fid
-  fids = Array.iArray(fids) ? fids : [fid];
+  fids = Array.isArray(fids) ? fids : [fid];
   features = Array.isArray(features) ? features : [features];
   //check if layer.selection.features is undefined
   if (undefined === layer.selection.features) {

src/app/g3w-ol/controls/control.js

@@ -5,34 +5,75 @@ import MapControlButton from 'components/MapControlButton';
  */
 const layout = function ({ map, position, element }) {};
 
+/**
+ * @param {Object}  options 
+ * @param {string}  options.name
+ * @param {boolean} options.enabled 
+ */
 const Control = function(options={}) {
-  const {name="", visible=true, enabled=false} = options;
+
+  const {
+    name="",
+    visible=true,
+    enabled=false
+  } = options;
+
+  /**
+   * @FIXME add description
+   */
   this._enabled = enabled;
+
+  /**
+   * @FIXME add description
+   */
   this.offline = options.offline !== undefined ? options.offline : true;
+
+  /**
+   * @FIXME add description
+   */
   this.name = name.split(' ').join('-').toLowerCase();
+
+  /**
+   * @FIXME add description
+   */
   this.id = this.name+'_'+(Math.floor(Math.random() * 1000000));
-  this.eventKeys = {}; // store eventKey and original havenHandler
+
+  /**
+   * store eventKey and original havenHandler
+   */
+  this.eventKeys = {};
+
   /*
     tl: top-left
     tr: top-right
     bl: bottom-left
     bt: bottom-right
    */
   this.positionCode = options.position || 'tl';
+
+  /**
+   * @FIXME add description
+   */
   this.priority = options.priority || 0;
+
   if (!options.element) {
     const mapControlButtonVue =  Vue.extend(MapControlButton({
-      className: "ol-"+this.name.split(' ').join('-').toLowerCase(),
+      className:   "ol-"+this.name.split(' ').join('-').toLowerCase(),
       customClass: options.customClass,
-      tipLabel: options.tipLabel || this.name,
-      label: options.label || ''
+      tipLabel:    options.tipLabel || this.name,
+      label:       options.label    || '',
     }));
     options.element = new mapControlButtonVue().$mount().$el;
   }
-  const buttonClickHandler = options.buttonClickHandler || Control.prototype._handleClick.bind(this);
-  $(options.element).on('click',buttonClickHandler);
+
+  // button click handler
+  $(options.element).on('click', options.buttonClickHandler || Control.prototype._handleClick.bind(this));
+
+  // parent constructor
   ol.control.Control.call(this, options);
+
   this.setVisible(visible);
+
   this._postRender();
 };
 
@@ -41,15 +82,23 @@ ol.inherits(Control, ol.control.Control);
 const proto = Control.prototype;
 
 
-//return if clickmap
+/**
+ * return if clickmap
+ */
 proto.isClickMap = function(){
   return this.clickmap;
 };
 
+/**
+ * @FIXME add description
+ */
 proto.isToggled = function() {
   return this._toggled;
 };
 
+/**
+ * @FIXME add description
+ */
 proto.setEventKey = function({eventType, eventKey}){
   this.eventKeys[eventType] = {
     eventKey,
@@ -82,6 +131,9 @@ proto.overwriteEventHandler = function({eventType, handler}) {
   }
 };
 
+/**
+ * @FIXME add description
+ */
 proto.getPosition = function(positionCode) {
   positionCode = positionCode || this.positionCode;
   const position = {};
@@ -93,7 +145,8 @@ proto.getPosition = function(positionCode) {
 };
 
 /**
- * Method to handle toggle map controls
+ * Handle toggle of map controls
+ * 
  * @param event
  */
 proto._handleClick = function(event) {
@@ -112,12 +165,16 @@ proto._handleClick = function(event) {
   this.dispatchEvent('controlclick');
 };
 
-//shift of control position
+/**
+ * shift control's position
+ */
 proto.shiftPosition = function(position) {
   $(this.element).css(hWhere, position+'px');
 };
 
-// layout handler
+/**
+ * layout handler 
+ */
 proto.layout = function(map) {
   if (map) {
     const position =  this.getPosition();
@@ -126,24 +183,35 @@ proto.layout = function(map) {
   }
 };
 
-// change layout of controls // overwrite to customize beahviour
-proto.changelayout = function(map) {};
+/**
+ * change layout of controls
+ */
+proto.changelayout = function(map) {
+  // overwrite to customize beahviour
+};
 
-//called when a control is added ore removed to map (added: map is an ol.Map instance , removed map is null)
+/**
+ * Called when a control is added ore removed to map
+ * 
+ * @param {ol.Map | null} map instace to be added (null = remove from map)
+ */
 proto.setMap = function(map) {
   if (map) {
     this.layout(map);
     ol.control.Control.prototype.setMap.call(this, map);
   }
 };
+
 /**
- *
+ * @FIXME add description
  */
 proto.showControl = function(){
   $(this.element).show();
 };
 
-//hide control and move all controls that sit on his right position
+/**
+ * Hide control and move all controls that sit on his right position
+ */
 proto.hideControl = function() {
   let position = $(this.element).position().left;
   let controlWidth = $(this.element).outerWidth();
@@ -176,20 +244,31 @@ proto.setEnable = function(enabled) {
   this._enabled = enabled;
 };
 
+/**
+ * @FIXME add description
+ */
 proto.getEnable = function() {
   return this._enabled;
 };
 
+/**
+ * @FIXME add description
+ */
 proto.setVisible = function(visible=true){
   this._visible = visible;
   $(this.element)[visible ? 'show': 'hide']();
 };
 
+/**
+ * @FIXME add description
+ */
 proto.isVisible = function(){
   return this._visible;
 };
 
-
+/**
+ * @FIXME add description
+ */
 proto._postRender = function() {};
 
 module.exports = Control;