Merge pull request #4562 from camptocamp/fix-editing

Fix types in editing, draw, datasource and ngeo root

contribs/gmf/src/datasource/ExternalDataSourcesManager.js

@@ -70,7 +70,7 @@ export class ExternalDatSourcesManager {
     /**
      * The collection of DataSources from ngeo. When this service creates
      * a data source, its gets added to that collection.
-     * @type {!DataSources}
+     * @type {!import('ngeo/datasource/DataSource.js').DataSources}
      * @private
      */
     this.dataSources_ = ngeoDataSources.collection;
@@ -374,7 +374,7 @@ export class ExternalDatSourcesManager {
 
 
     // (2) Add data source in WMS group, unless it's already in there.
-    //     Will also add the data source to the `ngeo.DataSources` collection.
+    //     Will also add the data source to the `import('ngeo/datasource/DataSource.js').DataSources` collection.
     //     If the group is created, its inner OL layer is also added to the map.
     let wmsGroup = this.getWMSGroup(url);
     if (wmsGroup) {

contribs/gmf/src/datasource/Helper.js

@@ -44,7 +44,7 @@ class Helper {
     // === Other properties ===
 
     /**
-     * @type {DataSources}
+     * @type {import('ngeo/datasource/DataSource.js').DataSources}
      * @protected
      */
     this.collection_;
@@ -57,11 +57,11 @@ class Helper {
   }
 
   /**
-   * @return {DataSources} Data sources collection.
+   * @return {import('ngeo/datasource/DataSource.js').DataSources} Data sources collection.
    * @export
    */
   get collection() {
-    return /** @type {DataSources} */ (
+    return /** @type {import('ngeo/datasource/DataSource.js').DataSources} */ (
       this.ngeoDataSourcesHelper_.collection
     );
   }

contribs/gmf/src/datasource/Manager.js

@@ -124,7 +124,7 @@ export class DatasourceManager {
      * The collection of DataSources from ngeo, which gets updated by this
      * service. When the theme changes, first we remove all data sources, then
      * the 'active' data source are added here.
-     * @type {DataSources}
+     * @type {import('ngeo/datasource/DataSource.js').DataSources}
      * @private
      */
     this.dataSources_ = ngeoDataSources.collection;

contribs/gmf/src/filters/filterselectorComponent.js

@@ -234,7 +234,7 @@ class Controller {
     this.filtrableLayerNodeNames_ = null;
 
     /**
-     * @type {DataSources}
+     * @type {import('ngeo/datasource/DataSource.js').DataSources}
      * @private
      */
     this.gmfDataSources_ = gmfDataSourcesHelper.collection;

contribs/gmf/src/layertree/datasourceGroupTreeComponent.js

@@ -72,7 +72,7 @@ class Controller {
     this.scope_ = $scope;
 
     /**
-     * @type {!DataSources}
+     * @type {!import('ngeo/datasource/DataSource.js').DataSources}
      * @private
      */
     this.dataSources_ = ngeoDataSources.collection;
@@ -105,7 +105,7 @@ class Controller {
   }
 
   /**
-   * Remove all data sources from the `ngeo.datasource.DataSources` collection, which
+   * Remove all data sources from the `import('ngeo/datasource/DataSource.js').DataSources` collection, which
    * will automatically remove them from the Group. The group itself
    * is going to be removed as well, destroying this component in the process.
    * @export
@@ -118,7 +118,7 @@ class Controller {
 
   /**
    * @param {!import("ngeo/datasource/DataSource.js").default} dataSource Data source to remove from
-   *     the `ngeo.DataSources` collection.
+   *     the `import('ngeo/datasource/DataSource.js').DataSources` collection.
    * @export
    */
   removeDataSource(dataSource) {

contribs/gmf/src/themes.js

@@ -1,17 +1,5 @@
 /**
- * Externs for the GeoMapFish "themes" web service.
- */
-
-/**
- * @typedef {Object} DimensionFilterConfig
- * @property {string} field
- * @property {string} [value]
- */
-
-
-/**
- * Dimensions applied by filters configuration.
- * @typedef {Object.<string, DimensionFilterConfig>} DimensionsFiltersConfig
+ * The GeoMapFish "themes" web service.
  */
 
 

package.json

@@ -41,6 +41,7 @@
     "@types/bootstrap": "4.2.1",
     "@types/cesium": "1.47.3",
     "@types/d3": "5.7.0",
+    "@types/file-saver": "2.0.0",
     "@types/googlemaps": "3.30.16",
     "@types/jquery": "3.3.29",
     "@types/jquery.ui.datetimepicker": "0.3.29",

src/Menu.js

@@ -34,7 +34,7 @@ import olOverlayPositioning from 'ol/OverlayPositioning.js';
 export default class extends olOverlay {
   /**
    * @param {MenuOptions=} menuOptions Menu options.
-   * @param {olx.OverlayOptions=} options Overlay options.
+   * @param {import('ol/Overlay.js').Options=} options Overlay options.
    */
   constructor(menuOptions, options = {}) {
     super(options);
@@ -214,12 +214,8 @@ export default class extends olOverlay {
    */
   handleMapPointerMove_(evt) {
     const target = evt.originalEvent.target;
-    console.assert(target instanceof Element);
-
     const element = this.getElement();
-    console.assert(element instanceof Element);
-
-    if (element.contains(target)) {
+    if (target instanceof Element && element instanceof Element && element.contains(target)) {
       evt.coordinate = [Infinity, Infinity];
       evt.pixel = [Infinity, Infinity];
     }

src/Popover.js

@@ -5,9 +5,7 @@ import olOverlay from 'ol/Overlay.js';
  * An openlayers overlay that uses bootstrap popover to produce a popup
  * for maps.
  *
- * @constructor
- * @extends {import("ol/Overlay.js").default}
- * @param {olx.OverlayOptions=} opt_options Overlay options.
+ * @param {import('ol/Overlay.js').Options=} opt_options Overlay options.
  */
 export default class extends olOverlay {
   constructor(options = {}) {
@@ -60,18 +58,17 @@ export default class extends olOverlay {
       window.setTimeout(() => {
         $(element)
           .popover({
-            'content': contentEl,
-            'html': true,
-            'placement': 'top',
-            'template': [
+            content: contentEl.get()[0],
+            html: true,
+            placement: 'top',
+            template: [
               '<div class="popover ngeo-popover" role="tooltip">',
               '  <div class="arrow"></div>',
               '  <h3 class="popover-header"></h3>',
               '  <div class="popover-body"></div>',
               '</div>'
             ].join('')
-          })
-          .popover('show');
+          }).popover('show');
       }, 0);
 
       this.closeEl_.one('click', () => {

src/WFSDescribeFeatureType.js

@@ -13,72 +13,84 @@ const NAMESPACE_URIS_ = [
 ];
 
 
+/**
+ * @typedef {Object.<string, import("ol/xml.js").Parser>} parserStructure
+ */
+
+
+/**
+ * typedef {Object.<string, parserStructure>} parsersStructure
+ * @typedef {Object<string, Object<string, import("ol/xml.js").Parser>>} parsersStructure
+ */
+
+/**
+ * @param {Array<string>} namespaceURIs Namespace URIs.
+ * @param {parserStructure} structure Structure.
+ * @return {Object<string, parserStructure>} Namespaced structure.
+ */
+function makeStructureNS(namespaceURIs, structure) {
+  return /** @type {parsersStructure} */(/** @type {any} */(olXml.makeStructureNS(namespaceURIs, structure)));
+}
+
 /**
  * @const
- * @type {!Object.<string, !Object.<string, !import("ol/XmlParser.js").default>>}
+ * @type {parsersStructure}
  * @private
  */
-const PARSERS_ = olXml.makeStructureNS(
+const PARSERS_ = makeStructureNS(
   NAMESPACE_URIS_, {
-    'element': olXml.makeObjectPropertyPusher(
-      readElement_
-    ),
-    'complexType': olXml.makeObjectPropertyPusher(
-      readComplexType_
-    )
-  });
+    element: olXml.makeObjectPropertyPusher(readElement_),
+    complexType: olXml.makeObjectPropertyPusher(readComplexType_)
+  }
+);
 
 
 /**
  * @const
- * @type {!Object.<string, !Object.<string, !import("ol/XmlParser.js").default>>}
+ * @type {parsersStructure}
  * @private
  */
-const COMPLEX_TYPE_PARSERS_ = olXml.makeStructureNS(
+const COMPLEX_TYPE_PARSERS_ = makeStructureNS(
   NAMESPACE_URIS_, {
-    'complexContent': olXml.makeObjectPropertySetter(
-      readComplexContent_
-    )
-  });
+    complexContent: olXml.makeObjectPropertySetter(readComplexContent_)
+  }
+);
 
 
 /**
  * @const
- * @type {!Object.<string, !Object.<string, !import("ol/XmlParser.js").default>>}
+ * @type {parsersStructure}
  * @private
  */
-const COMPLEX_CONTENT_PARSERS_ = olXml.makeStructureNS(
+const COMPLEX_CONTENT_PARSERS_ = makeStructureNS(
   NAMESPACE_URIS_, {
-    'extension': olXml.makeObjectPropertySetter(
-      readExtension_
-    )
-  });
+    extension: olXml.makeObjectPropertySetter(readExtension_)
+  }
+);
 
 
 /**
  * @const
- * @type {!Object.<string, !Object.<string, !import("ol/XmlParser.js").default>>}
+ * @type {parsersStructure}
  * @private
  */
-const EXTENSION_PARSERS_ = olXml.makeStructureNS(
+const EXTENSION_PARSERS_ = makeStructureNS(
   NAMESPACE_URIS_, {
-    'sequence': olXml.makeObjectPropertySetter(
-      readSequence_
-    )
-  });
+    sequence: olXml.makeObjectPropertySetter(readSequence_)
+  }
+);
 
 
 /**
  * @const
- * @type {!Object.<string, !Object.<string, !import("ol/XmlParser.js").default>>}
+ * @type {parsersStructure}
  * @private
  */
-const SEQUENCE_PARSERS_ = olXml.makeStructureNS(
+const SEQUENCE_PARSERS_ = makeStructureNS(
   NAMESPACE_URIS_, {
-    'element': olXml.makeObjectPropertyPusher(
-      readElement_
-    )
-  });
+    element: olXml.makeObjectPropertyPusher(readElement_)
+  }
+);
 
 
 /**
@@ -132,11 +144,12 @@ WFSDescribeFeatureType.prototype.readFromNode = function(node) {
 
 /**
  * @private
- * @param {Node} node Node.
+ * @param {Element} node Node.
  * @param {Array.<*>} objectStack Object stack.
  * @return {!Object.<string, string>} Attributes.
  */
 function readElement_(node, objectStack) {
+  /** @type {!Object.<string, string>} */
   const attributes = {};
   for (let i = 0, len = node.attributes.length; i < len; i++) {
     const attribute = node.attributes.item(i);
@@ -152,7 +165,7 @@ function readElement_(node, objectStack) {
 
 /**
  * @private
- * @param {Node} node Node.
+ * @param {Element} node Node.
  * @param {Array.<*>} objectStack Object stack.
  * @return {!Object.<string, string>} Object.
  */
@@ -172,7 +185,7 @@ function readComplexType_(node, objectStack) {
 
 /**
  * @private
- * @param {Node} node Node.
+ * @param {Element} node Node.
  * @param {Array.<*>} objectStack Object stack.
  * @return {!Object.<string, string>} Object.
  */
@@ -190,7 +203,7 @@ function readComplexContent_(
 
 /**
  * @private
- * @param {Node} node Node.
+ * @param {Element} node Node.
  * @param {Array.<*>} objectStack Object stack.
  * @return {!Object.<string, string>} Object.
  */
@@ -206,7 +219,7 @@ function readExtension_(node, objectStack) {
 
 /**
  * @private
- * @param {Node} node Node.
+ * @param {Element} node Node.
  * @param {Array.<*>} objectStack Object stack.
  * @return {!Object.<string, string>} Object.
  */

src/datasource/DataSource.js

@@ -52,7 +52,7 @@ class DataSource {
      * required for the `inRange` property to be dynamic, otherwise its
      * value is always `true` by default.
      *
-     * The synchronization is made in the `ngeo.datasource.DataSources`
+     * The synchronization is made in the `import('ngeo/datasource/DataSource.js').DataSources`
      * service.
      *
      * @type {boolean}

src/datasource/DataSources.js

@@ -24,7 +24,7 @@ export class DataSource {
   constructor() {
 
     /**
-     * @type {DataSources}
+     * @type {import('ngeo/datasource/DataSource.js').DataSources}
      * @private
      */
     this.collection_ = new olCollection();
@@ -105,10 +105,11 @@ export class DataSource {
    */
   handleViewResolutionChange_(evt) {
     const view = evt.target;
-    console.assert(view instanceof olView);
-    const resolution = view.getResolution();
-    console.assert(typeof resolution == 'number');
-    this.syncDataSourcesToResolution_(resolution);
+    if (view instanceof olView) {
+      const resolution = view.getResolution();
+      console.assert(typeof resolution == 'number');
+      this.syncDataSourcesToResolution_(resolution);
+    }
   }
 
   /**

src/datasource/File.js

@@ -7,10 +7,19 @@ import olSourceVector from 'ol/source/Vector.js';
 /**
  * The options required to create a `File`.
  *
- * @typedef {Object} DataSourceOptions
+ * extends DataSourceOptions
+ * @typedef {Object} FileOptions
  * @property {import("ol/Collection.js").default.<!import("ol/Feature.js").default>} [features] Collection of `import("ol/Feature.js").default` objects.
- * @extends DataSourceOptions
- */
+ * @property {Array.<import('ngeo/format/Attribute.js').Attribute>} [attributes] (DataSourceOptions)
+ * @property {import('ngeo/datasource/OGC.js').DimensionsFiltersConfig} [dimensionsFiltersConfig] (DataSourceOptions)
+ * @property {number} id (DataSourceOptions)
+ * @property {string} [identifierAttribute] (DataSourceOptions)
+ * @property {boolean} [inRange] (DataSourceOptions)
+ * @property {number} [minResolution] (DataSourceOptions)
+ * @property {number} [maxResolution] (DataSourceOptions)
+ * @property {string} name (DataSourceOptions)
+ * @property {boolean} [visible=false] (DataSourceOptions)
+*/
 
 export default class extends ngeoDatasourceDataSource {