Fix Types in statemanager and in search

contribs/gmf/apps/desktop_alt/Controller.js

@@ -144,7 +144,7 @@ olUtilInherits(Controller, gmfControllersAbstractDesktopController);
 
 
 /**
- * @param {jQuery.Event} event keydown event.
+ * @param {JQueryEventObject} event keydown event.
  * @export
  */
 Controller.prototype.onKeydown = function(event) {

contribs/gmf/examples/search.js

@@ -89,7 +89,7 @@ function MainController(gmfThemes, ngeoFeatureOverlayMgr, ngeoNotification) {
   };
 
   /**
-   * @type {TypeaheadOptions}
+   * @type {Twitter.Typeahead.Options}
    * @export
    */
   this.searchOptions = {

contribs/gmf/externs/gmf-themes.js

@@ -6,10 +6,9 @@
 
 
 /**
- * @typedef {{
- *     field: (string),
- *     value: (string|undefined)
- * }} DimensionFilterConfig
+ * @typedef {Object} DimensionFilterConfig
+ * @property {string} field
+ * @property {string} [value]
  */
 
 

contribs/gmf/src/authentication/Service.js

@@ -31,20 +31,18 @@ import olEventsEventTarget from 'ol/events/Target.js';
 
 
 /**
- * @typedef {{
- *     functionalities: (AuthenticationFunctionalities|undefined),
- *     is_password_changed: (boolean|undefined),
- *     role_id: (number|undefined),
- *     role_name: (string|undefined),
- *     username: (string|undefined)
- * }} AuthenticationLoginResponse
+ * @typedef {Object} AuthenticationLoginResponse
+ * @property {AuthenticationFunctionalities} [functionalities]
+ * @property {boolean} [is_password_changed]
+ * @property {number} [role_id]
+ * @property {string} [role_name]
+ * @property {string} [username]
  */
 
 
 /**
- * @typedef {{
- *     success: boolean
- * }} AuthenticationDefaultResponse
+ * @typedef {Object} AuthenticationDefaultResponse
+ * @property {boolean} success
  */
 
 

contribs/gmf/src/search/component.js

@@ -36,7 +36,7 @@ import {appendParams as olUriAppendParams} from 'ol/uri.js';
  * @property {Array.<string>} [groupActions] List of allowed actions. The list may contain a
  * combination of `add_theme`, `add_group` or `add_layer`
  * @property {string} [projection] The geometry's projection for this set of data.
- * @property {TypeaheadDataset} [typeaheadDatasetOptions] The optional Typeahead configuration for
+ * @property {Twitter.Typeahead.Dataset} [typeaheadDatasetOptions] The optional Twitter.Typeahead. configuration for
  * this dataset. See: https://github.com/twitter/typeahead.js/blob/master/
  * @property {string} url URL of the search service. Must contain a '%QUERY' term that will be
  * replaced by the input string.
@@ -147,7 +147,7 @@ function gmfSearchTemplateUrl($element, $attrs, gmfSearchTemplateUrl) {
  *
  * @htmlAttribute {string} gmf-search-input-value The input value (read only).
  * @htmlAttribute {import("ol/Map.js").default} gmf-search-map The map.
- * @htmlAttribute {TypeaheadOptions|undefined} gmf-search-options Addition Typeahead options.
+ * @htmlAttribute {Twitter.Typeahead.Options|undefined} gmf-search-options Addition Twitter.Typeahead. options.
  * @htmlAttribute {SearchComponentDatasource} gmf-search-datasource
  *      The datasources.
  * @htmlAttribute {Object.<string, import("ol/style/Style.js").default>}
@@ -376,16 +376,16 @@ class SearchController {
     this.datasources = [];
 
     /**
-     * @type {TypeaheadOptions}
+     * @type {Twitter.Typeahead.Options}
      * @export
      */
     this.typeaheadOptions;
 
     /**
-     * @type {TypeaheadOptions}
+     * @type {Twitter.Typeahead.Options}
      * @export
      */
-    this.options = /** @type {TypeaheadOptions} */ ({
+    this.options = /** @type {Twitter.Typeahead.Options} */ ({
       highlight: true
     });
 
@@ -396,7 +396,7 @@ class SearchController {
     this.featuresStyles;
 
     /**
-     * @type {Array.<TypeaheadDataset>}
+     * @type {Array.<Twitter.Typeahead.Dataset>}
      * @export
      */
     this.datasets = [];
@@ -618,22 +618,22 @@ class SearchController {
    * @param {SearchComponentDatasource} config The config of the dataset.
    * @param {(function(GeoJSONFeature): boolean)=} opt_filter A filter function
    *     based on a GeoJSONFeaturesCollection's array.
-   * @return {TypeaheadDataset} A typeahead dataset.
+   * @return {Twitter.Typeahead.Dataset} A typeahead dataset.
    * @private
    */
   createDataset_(config, opt_filter) {
     const gettextCatalog = this.gettextCatalog_;
     const componentScope = this.scope_;
     const compile = this.compile_;
     const bloodhoundEngine = this.createAndInitBloodhound_(config, opt_filter);
-    const typeaheadDataset = /** @type {TypeaheadDataset} */ ({
+    const typeaheadDataset = /** @type {Twitter.Typeahead.Dataset} */ ({
       limit: Infinity,
       source: bloodhoundEngine.ttAdapter(),
       display: (suggestion) => {
         const feature = /** @type {import("ol/Feature.js").default} */ (suggestion);
         return feature.get(config.labelKey);
       },
-      templates: /* TypeaheadTemplates */ ({
+      templates: /* Twitter.Typeahead.Templates */ ({
         header: () => {
           if (config.datasetTitle === undefined) {
             return '';
@@ -935,9 +935,9 @@ class SearchController {
 
 
   /**
-   * @param {jQuery.Event} event Event.
+   * @param {JQueryEventObject} event Event.
    * @param {Object|import("ol/Feature.js").default} suggestion Suggestion.
-   * @param {TypeaheadDataset} dataset Dataset.
+   * @param {Twitter.Typeahead.Dataset} dataset Dataset.
    * @private
    */
   select_(event, suggestion, dataset) {
@@ -959,9 +959,9 @@ class SearchController {
 
 
   /**
-   * @param {jQuery.Event} event Event.
+   * @param {JQueryEventObject} event Event.
    * @param {import("ol/Feature.js").default} feature Feature.
-   * @param {TypeaheadDataset} dataset Dataset.
+   * @param {Twitter.Typeahead.Dataset} dataset Dataset.
    * @private
    */
   selectFromGMF_(event, feature, dataset) {
@@ -1028,7 +1028,7 @@ class SearchController {
 
 
   /**
-   * @param {jQuery.Event} event Event.
+   * @param {JQueryEventObject} event Event.
    * @private
    */
   close_(event) {
@@ -1039,7 +1039,7 @@ class SearchController {
 
 
   /**
-   * @param {jQuery.Event} event Event.
+   * @param {JQueryEventObject} event Event.
    * @param {string} query Query.
    * @param {boolean} empty Empty.
    * @private

examples/locationsearch.js

@@ -56,17 +56,17 @@ function SearchController(ngeoCreateLocationSearchBloodhound) {
     ngeoCreateLocationSearchBloodhound, limit);
 
   /**
-   * @type {TypeaheadOptions}
+   * @type {Twitter.Typeahead.Options}
    * @export
    */
-  this.options = /** @type {TypeaheadOptions} */ ({
+  this.options = /** @type {Twitter.Typeahead.Options} */ ({
     highlight: true,
     hint: undefined,
     minLength: undefined
   });
 
   /**
-   * @type {Array.<TypeaheadDataset>}
+   * @type {Array.<Twitter.Typeahead.Dataset>}
    * @export
    */
   this.datasets = [{
@@ -123,9 +123,9 @@ SearchController.prototype.createAndInitBloodhound_ = function(ngeoCreateLocatio
 
 
 /**
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @param {Object} suggestion Suggestion.
- * @param {TypeaheadDataset} dataset Dataset.
+ * @param {Twitter.Typeahead.Dataset} dataset Dataset.
  * @this {app.locationsearch.SearchController}
  * @private
  */

examples/search.js

@@ -75,17 +75,17 @@ function SearchController($element, $rootScope, $compile, ngeoSearchCreateGeoJSO
     ngeoSearchCreateGeoJSONBloodhound);
 
   /**
-   * @type {TypeaheadOptions}
+   * @type {Twitter.Typeahead.Options}
    * @export
    */
-  this.options = /** @type {TypeaheadOptions} */ ({
+  this.options = /** @type {Twitter.Typeahead.Options} */ ({
     highlight: true,
     hint: undefined,
     minLength: undefined
   });
 
   /**
-   * @type {Array.<TypeaheadDataset>}
+   * @type {Array.<Twitter.Typeahead.Dataset>}
    * @export
    */
   this.datasets = [{

package.json

@@ -39,7 +39,9 @@
     "@types/angular": "1.6.53",
     "@types/angular-gettext": "2.1.34",
     "@types/d3": "5.7.0",
+    "@types/jquery": "3.3.29",
     "@types/proj4": "2.5.0",
+    "@types/typeahead": "0.11.32",
     "angular": "1.7.6",
     "angular-animate": "1.7.6",
     "angular-dynamic-locale": "0.1.37",

src/editing/exportfeaturesComponent.js

@@ -186,7 +186,7 @@ Controller.prototype.handleElementClick_ = function() {
  * Called when a menu item is clicked. Export the features to the selected
  * format.
  * @param {string} format Format.
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @private
  */
 Controller.prototype.handleMenuItemClick_ = function(format, event) {

src/grid/component.js

@@ -166,7 +166,7 @@ Controller.prototype.sort = function(columnName) {
 /**
  * Handler for clicks on a row.
  * @param {Object} attributes An entry/row.
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @export
  */
 Controller.prototype.clickRow = function(attributes, event) {
@@ -260,7 +260,7 @@ Controller.prototype.selectRange_ = function(attributes) {
 /**
  * Prevent the default browser behaviour of selecting text
  * when selecting multiple rows with SHIFT or CTRL/Meta.
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @export
  */
 Controller.prototype.preventTextSelection = function(event) {
@@ -275,7 +275,7 @@ Controller.prototype.preventTextSelection = function(event) {
 
 /**
  * Same as `ol.events.condition.platformModifierKeyOnly`.
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @return {boolean} True if only the platform modifier key is pressed.
  * @private
  */
@@ -288,7 +288,7 @@ Controller.prototype.isPlatformModifierKeyOnly_ = function(event) {
 
 /**
  * Same as `ol.events.condition.shiftKeyOnly`.
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @return {boolean} True if only the shift key is pressed.
  * @private
  */

src/message/popupComponent.js

@@ -61,7 +61,7 @@ function directive(ngeoPopupTemplateUrl) {
       element.addClass('popover');
 
       /**
-       * @param {jQuery.Event} evt Event.
+       * @param {JQueryEventObject} evt Event.
        */
       scope.close = function(evt) {
         if (evt) {

src/routing/NominatimInputComponent.js

@@ -84,17 +84,17 @@ function Controller($element, $injector, $scope, ngeoNominatimService) {
   this.inputValue;
 
   /**
-   * @type {TypeaheadOptions}
+   * @type {Twitter.Typeahead.Options}
    * @export
    */
-  this.options = /** @type {TypeaheadOptions} */ ({
+  this.options = /** @type {Twitter.Typeahead.Options} */ ({
   });
 
   /**
-   * @type {Array.<TypeaheadDataset>}
+   * @type {Array.<Twitter.Typeahead.Dataset>}
    * @export
    */
-  this.datasets = [/** @type {TypeaheadDataset} */({
+  this.datasets = [/** @type {Twitter.Typeahead.Dataset} */({
     name: 'nominatim',
     display: 'name',
     source: this.ngeoNominatimService.typeaheadSourceDebounced
@@ -117,9 +117,9 @@ function Controller($element, $injector, $scope, ngeoNominatimService) {
 }
 
 /**
- * @param {jQuery.Event} event Event.
+ * @param {JQueryEventObject} event Event.
  * @param {NominatimSearchResult} suggestion Suggestion.
- * @param {TypeaheadDataset} dataset Dataset.
+ * @param {Twitter.Typeahead.Dataset} dataset Dataset.
  * @this {import("ngeo/routing/NominatimInputComponent.js").default.Controller}
  * @private
  */

src/rule/Text.js

@@ -5,15 +5,14 @@ import ngeoRuleRule from 'ngeo/rule/Rule.js';
 /**
  * The options for creating a text style.
  *
- * @typedef {{
- *     text: (string),
- *     size: (number|undefined),
- *     angle: (number|undefined),
- *     color: (ol.Color|undefined),
- *     width: (number|undefined),
- *     offsetX: (number|undefined),
- *     offsetY: (number|undefined)
- * }} TextOptions
+ * @typedef {Object} TextOptions
+ * @property {string} text
+ * @property {number} [size]
+ * @property {number} [angle]
+ * @property {ol.Color} [color]
+ * @property {number} [width]
+ * @property {number} [offsetX]
+ * @property {number} [offsetY]
  */
 
 export default class extends ngeoRuleRule {