@vaadin/bundles 25.3.0-alpha13 → 25.3.0-alpha14

package/vendors-node_modules_vaadin_map_node_modules_ol_source_Vector_js.js

@@ -27,13 +27,14 @@ let withCredentials = false;
  * {@link module:ol/source/Vector~VectorSource} sources use a function of this type to
  * load features.
  *
- * This function takes up to 5 arguments. These are an {@link module:ol/extent~Extent} representing
- * the area to be loaded, a `{number}` representing the resolution (map units per pixel), a
- * {@link module:ol/proj/Projection~Projection} for the projection, an optional success callback that should get
- * the loaded features passed as an argument and an optional failure callback with no arguments. If
- * the callbacks are not used, the corresponding vector source will not fire `'featuresloadend'` and
- * `'featuresloaderror'` events. `this` within the function is bound to the
- * {@link module:ol/source/Vector~VectorSource} it's called from.
+ * This function takes 3 arguments: an {@link module:ol/extent~Extent} representing
+ * the area to be loaded, a `{number}` representing the resolution (map units per pixel), and a
+ * {@link module:ol/proj/Projection~Projection} for the projection. The function is expeced to return
+ * a promise that resolves to an array of features.
+ *
+ * There are also a deprecated signature, with `void` as
+ * return, and two additional arguments: an optional success callback that should get
+ * the loaded features passed as an argument and an optional failure callback with no arguments.
  *
  * The function is responsible for loading the features and adding them to the
  * source.
@@ -44,7 +45,7 @@ let withCredentials = false;
  *           resolution: number,
  *           projection: import("./proj/Projection.js").default,
  *           success?: (features: Array<FeatureType>) => void,
- *           failure?: () => void) => void} FeatureLoader
+ *           failure?: () => void) => void|Promise<Array<FeatureType>>} FeatureLoader
  * @api
  */
 
@@ -381,8 +382,8 @@ class Source extends _Object_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
 
     /**
      * This source is currently loading data. Sources that defer loading to the
-     * map's tile queue never set this to `true`.
-     * @type {boolean}
+     * map's tile queue never set this to a `truthy` value.
+     * @type {boolean|number}
      */
     this.loading = false;
 
@@ -454,7 +455,7 @@ class Source extends _Object_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
   }
 
   /**
-   * @param {import("../proj/Projection").default} [projection] Projection.
+   * @param {import("../proj/Projection.js").default} [projection] Projection.
    * @return {Array<number>|null} Resolutions.
    */
   getResolutions(projection) {
@@ -468,6 +469,37 @@ class Source extends _Object_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
     return this.viewPromise_;
   }
 
+  /**
+   * Resolve once the source is ready to be used (its state is `ready`), or
+   * reject if it fails to load (its state is `error`). Sources that configure
+   * asynchronously can use this to expose data (e.g. dimensions) through a
+   * promise instead of the `change` event.
+   * @return {Promise<void>} Resolves when the source is ready.
+   * @protected
+   */
+  ready() {
+    const state = this.getState();
+    if (state === 'ready') {
+      return Promise.resolve();
+    }
+    if (state === 'error') {
+      return Promise.reject(new Error('Source failed to load'));
+    }
+    return new Promise((resolve, reject) => {
+      const onChange = () => {
+        const changedState = this.getState();
+        if (changedState === 'ready') {
+          this.un('change', onChange);
+          resolve();
+        } else if (changedState === 'error') {
+          this.un('change', onChange);
+          reject(new Error('Source failed to load'));
+        }
+      };
+      this.on('change', onChange);
+    });
+  }
+
   /**
    * Get the state of the source, see {@link import("./Source.js").State} for possible states.
    * @return {import("./Source.js").State} State.
@@ -560,9 +592,9 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _ObjectEventType_js__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__(/*! ../ObjectEventType.js */ "./node_modules/@vaadin/map/node_modules/ol/ObjectEventType.js");
 /* harmony import */ var _array_js__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__(/*! ../array.js */ "./node_modules/@vaadin/map/node_modules/ol/array.js");
 /* harmony import */ var _asserts_js__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ../asserts.js */ "./node_modules/@vaadin/map/node_modules/ol/asserts.js");
+/* harmony import */ var _events_js__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(/*! ../events.js */ "./node_modules/@vaadin/map/node_modules/ol/events.js");
 /* harmony import */ var _events_Event_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! ../events/Event.js */ "./node_modules/@vaadin/map/node_modules/ol/events/Event.js");
 /* harmony import */ var _events_EventType_js__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(/*! ../events/EventType.js */ "./node_modules/@vaadin/map/node_modules/ol/events/EventType.js");
-/* harmony import */ var _events_js__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(/*! ../events.js */ "./node_modules/@vaadin/map/node_modules/ol/events.js");
 /* harmony import */ var _extent_js__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__(/*! ../extent.js */ "./node_modules/@vaadin/map/node_modules/ol/extent.js");
 /* harmony import */ var _featureloader_js__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ../featureloader.js */ "./node_modules/@vaadin/map/node_modules/ol/featureloader.js");
 /* harmony import */ var _functions_js__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ../functions.js */ "./node_modules/@vaadin/map/node_modules/ol/functions.js");
@@ -644,11 +676,11 @@ class VectorSourceEvent extends _events_Event_js__WEBPACK_IMPORTED_MODULE_0__["d
 /***
  * @template Return
  * @template {import("../Feature.js").FeatureLike} [FeatureType=import("../Feature.js").default]
- * @typedef {import("../Observable").OnSignature<import("../Observable").EventTypes, import("../events/Event.js").default, Return> &
- *   import("../Observable").OnSignature<import("../ObjectEventType").Types, import("../Object").ObjectEvent, Return> &
- *   import("../Observable").OnSignature<import("./VectorEventType").VectorSourceEventTypes, VectorSourceEvent<FeatureType>, Return> &
- *   import("../Observable").CombinedOnSignature<import("../Observable").EventTypes|import("../ObjectEventType").Types|
- *     import("./VectorEventType").VectorSourceEventTypes, Return>} VectorSourceOnSignature
+ * @typedef {import("../Observable.js").OnSignature<import("../Observable.js").EventTypes, import("../events/Event.js").default, Return> &
+ *   import("../Observable.js").OnSignature<import("../ObjectEventType.js").Types, import("../Object.js").ObjectEvent, Return> &
+ *   import("../Observable.js").OnSignature<import("./VectorEventType.js").VectorSourceEventTypes, VectorSourceEvent<FeatureType>, Return> &
+ *   import("../Observable.js").CombinedOnSignature<import("../Observable.js").EventTypes|import("../ObjectEventType.js").Types|
+ *     import("./VectorEventType.js").VectorSourceEventTypes, Return>} VectorSourceOnSignature
  */
 
 /**
@@ -674,34 +706,31 @@ class VectorSourceEvent extends _events_Event_js__WEBPACK_IMPORTED_MODULE_0__["d
  * import {bbox} from 'ol/loadingstrategy.js';
  *
  * const vectorSource = new Vector({
- *   format: new GeoJSON(),
- *   loader: function(extent, resolution, projection, success, failure) {
- *      const proj = projection.getCode();
+ *   loader: async (extent, resolution, projection) => {
  *      const url = 'https://ahocevar.com/geoserver/wfs?service=WFS&' +
  *          'version=1.1.0&request=GetFeature&typename=osm:water_areas&' +
- *          'outputFormat=application/json&srsname=' + proj + '&' +
- *          'bbox=' + extent.join(',') + ',' + proj;
- *      const xhr = new XMLHttpRequest();
- *      xhr.open('GET', url);
- *      const onError = function() {
- *        vectorSource.removeLoadedExtent(extent);
- *        failure();
+ *          'outputFormat=application/json' +
+ *          'bbox=' + extent.join(',') + ',' + projection.getCode();
+ *      const response = await fetch(url);
+ *      if (!response.ok) {
+ *        throw new Error('Network response was not ok');
  *      }
- *      xhr.onerror = onError;
- *      xhr.onload = function() {
- *        if (xhr.status == 200) {
- *          const features = vectorSource.getFormat().readFeatures(xhr.responseText);
- *          vectorSource.addFeatures(features);
- *          success(features);
- *        } else {
- *          onError();
- *        }
- *      }
- *      xhr.send();
+ *      const json = await response.json();
+ *      const features = new GeoJSON().readFeatures(json, {
+ *        featureProjection: projection,
+ *      });
+ *      return features;
  *    },
  *    strategy: bbox,
  *  });
  * ```
+ *
+ * When you want to retry a failed request, use
+ * ```js
+ * vectorSource.removeLoadedExtent(extent);
+ * vectorSource.changed();
+ * ```
+ *
  * @property {boolean} [overlaps=true] This source may have overlapping geometries.
  * Setting this to `false` (e.g. for sources with polygons that represent administrative
  * boundaries or TopoJSON sources) allows the renderer to optimise fill and
@@ -770,12 +799,12 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
     });
 
     /***
-     * @type {VectorSourceOnSignature<import("../events").EventsKey, FeatureType>}
+     * @type {VectorSourceOnSignature<import("../events.js").EventsKey, FeatureType>}
      */
     this.on;
 
     /***
-     * @type {VectorSourceOnSignature<import("../events").EventsKey, FeatureType>}
+     * @type {VectorSourceOnSignature<import("../events.js").EventsKey, FeatureType>}
      */
     this.once;
 
@@ -838,12 +867,6 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
      */
     this.loadedExtentsRtree_ = new _structs_RBush_js__WEBPACK_IMPORTED_MODULE_6__["default"]();
 
-    /**
-     * @type {number}
-     * @private
-     */
-    this.loadingExtentsCount_ = 0;
-
     /**
      * @private
      * @type {!Object<string, FeatureType>}
@@ -1416,15 +1439,15 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
   /**
    * Get the extent of the features currently in the source.
    *
-   * This method is not available when the source is configured with
+   * This will return `null` when the source is configured with
    * `useSpatialIndex` set to `false`.
    * @param {import("../extent.js").Extent} [extent] Destination extent. If provided, no new extent
    *     will be created. Instead, that extent's coordinates will be overwritten.
-   * @return {import("../extent.js").Extent} Extent.
+   * @return {import("../extent.js").Extent | null} Extent.
    * @api
    */
   getExtent(extent) {
-    return this.featuresRtree_.getExtent(extent);
+    return this.featuresRtree_?.getExtent(extent) ?? null;
   }
 
   /**
@@ -1540,7 +1563,11 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
   hasFeature(feature) {
     const id = feature.getId();
     if (id !== undefined) {
-      return id in this.idIndex_;
+      const indexed = this.idIndex_[String(id)];
+      if (Array.isArray(indexed)) {
+        return indexed.includes(feature);
+      }
+      return indexed === feature;
     }
     return (0,_util_js__WEBPACK_IMPORTED_MODULE_8__.getUid)(feature) in this.uidIndex_;
   }
@@ -1581,40 +1608,59 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
         },
       );
       if (!alreadyLoaded) {
-        ++this.loadingExtentsCount_;
+        this.loading = Number(this.loading) + 1;
         this.dispatchEvent(
           new VectorSourceEvent(_VectorEventType_js__WEBPACK_IMPORTED_MODULE_9__["default"].FEATURESLOADSTART),
         );
-        this.loader_.call(
+
+        /**
+         * @param {Array<FeatureType>} features Loaded features
+         */
+        const success = (features) => {
+          this.loading = Number(this.loading) - 1;
+          this.dispatchEvent(
+            new VectorSourceEvent(
+              _VectorEventType_js__WEBPACK_IMPORTED_MODULE_9__["default"].FEATURESLOADEND,
+              undefined,
+              features,
+            ),
+          );
+        };
+
+        const failure = () => {
+          this.changed();
+          this.loading = Number(this.loading) - 1;
+          this.dispatchEvent(
+            new VectorSourceEvent(_VectorEventType_js__WEBPACK_IMPORTED_MODULE_9__["default"].FEATURESLOADERROR),
+          );
+        };
+
+        //TODO Remove this when the deprecatedsuccess and failure arguments are removed
+        let disableCallbacks = false;
+
+        const loaded = this.loader_.call(
           this,
           extentToLoad,
           resolution,
           projection,
-          /**
-           * @param {Array<FeatureType>} features Loaded features
-           */
-          (features) => {
-            --this.loadingExtentsCount_;
-            this.dispatchEvent(
-              new VectorSourceEvent(
-                _VectorEventType_js__WEBPACK_IMPORTED_MODULE_9__["default"].FEATURESLOADEND,
-                undefined,
-                features,
-              ),
-            );
-          },
-          () => {
-            --this.loadingExtentsCount_;
-            this.dispatchEvent(
-              new VectorSourceEvent(_VectorEventType_js__WEBPACK_IMPORTED_MODULE_9__["default"].FEATURESLOADERROR),
-            );
-          },
+          (features) => disableCallbacks || success(features),
+          () => disableCallbacks || failure(),
         );
+        if (loaded instanceof Promise) {
+          //TODO Remove this when the deprecatedsuccess and failure arguments are removed
+          disableCallbacks = true;
+          loaded
+            .then((features) => {
+              this.addFeatures(features);
+              success(features);
+            })
+            .catch(failure);
+        } else if (this.loader_.length < 4) {
+          this.loading = false;
+        }
         loadedExtentsRtree.insert(extentToLoad, {extent: extentToLoad.slice()});
       }
     }
-    this.loading =
-      this.loader_.length < 4 ? false : this.loadingExtentsCount_ > 0;
   }
 
   /**
@@ -1627,20 +1673,28 @@ class VectorSource extends _Source_js__WEBPACK_IMPORTED_MODULE_1__["default"] {
   }
 
   /**
-   * Remove an extent from the list of loaded extents.
-   * @param {import("../extent.js").Extent} extent Extent.
+   * Marks an extent as not loaded, preserving any loaded areas outside it.
+   *
+   * Any previously loaded extent overlapping the given extent is split into its
+   * remaining non-overlapping parts using {@link module:ol/extent~getDifference getDifference()},
+   * which are then re-inserted into the tree.
+   *
+   * @param {import("../extent.js").Extent} extent Extent to mark as not loaded.
    * @api
    */
   removeLoadedExtent(extent) {
     const loadedExtentsRtree = this.loadedExtentsRtree_;
-    const obj = loadedExtentsRtree.forEachInExtent(extent, function (object) {
-      if ((0,_extent_js__WEBPACK_IMPORTED_MODULE_17__.equals)(object.extent, extent)) {
-        return object;
+    const intersectingExtents = [];
+    loadedExtentsRtree.forEachInExtent(extent, function (object) {
+      intersectingExtents.push(object);
+    });
+    intersectingExtents.forEach((intersectingExtent) => {
+      loadedExtentsRtree.remove(intersectingExtent);
+      const remainders = (0,_extent_js__WEBPACK_IMPORTED_MODULE_17__.getDifference)(intersectingExtent.extent, extent);
+      for (const remainder of remainders) {
+        loadedExtentsRtree.insert(remainder, {extent: remainder});
       }
     });
-    if (obj) {
-      loadedExtentsRtree.remove(obj);
-    }
   }
 
   /**