@masterportal/masterportalapi 2.37.0 → 2.39.0

package/CHANGELOG.md

@@ -3,6 +3,48 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+### __Breaking Changes__
+
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+---
+## 2.39.0 - 2024-06-18
+
+### Changed
+    - peerDependencies:
+        - @cesium/engine: 6.2.0 to 9.2.0
+
+---
+## 2.38.0 - 2024-06-04
+
+### Added
+- Added support for Node LTS version ^20.12.2 and npm Version ^10.5.0.
+- OAF, GeoJSON: added function loadFeaturesManually.
+
+### Changed
+- The following packages have been updated:
+    - dependencies:
+        - ol: 9.1.0 to 9.2.4
+        - olcs: 2.19.3 to 2.20.0
+- Exports in src/layer/oaf.js changed to export default {} to provide  ES-Syntax.
+
+### Fixed
+- The mitigation for issue 666 in ol-cesium since version 2.37.0 is removed
+- Webgl: vectorTiles were not displayed.
+- WMS-Layer: special loadFunction is only used if layer's attribute `isSecured` is true.
+- Issue#1170: checkProperty was not negated, although it should be, so that styling-rules can be properly excluded.
+
+---
+
 ## 2.37.0 - 2024-04-23
 
 ### Fixed

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.37.0",
+  "version": "2.39.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -21,9 +21,9 @@
   "dependencies": {
     "core-js": "^3.33.1",
     "dayjs": "^1.11.10",
-    "ol": "9.1.0",
+    "ol": "9.2.4",
     "ol-mapbox-style": "12.2.1",
-    "olcs": "2.19.3",
+    "olcs": "2.20.0",
     "proj4": "^2.10.0",
     "xml2js": "^0.6.2"
   },
@@ -56,11 +56,11 @@
     "util": "^0.12.5"
   },
   "peerDependencies": {
-    "@cesium/engine": "^6.2.0"
+    "@cesium/engine": "^9.2.0"
   },
   "engines": {
-    "node": "^16.13.2 || ^18.12.0 || ^20.9.0",
-    "npm": "^8.1.2 || ^9.3.1 || ^10.1.0"
+    "node": "^16.13.2 || ^18.12.0 || ^20.12.2",
+    "npm": "^8.1.2 || ^9.3.1 || ^10.5.0"
   },
   "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
   "directories": {

package/src/index.js

@@ -6,7 +6,7 @@ import wmts from "./layer/wmts";
 import wfs from "./layer/wfs";
 import * as geojson from "./layer/geojson";
 import * as vectorTile from "./layer/vectorTile";
-import * as oaf from "./layer/oaf";
+import oaf from "./layer/oaf";
 import * as terrain from "./layer/terrain";
 import * as entities from "./layer/entities";
 import * as webgl from "./renderer/webgl";

package/src/layer/geojson/index.js

@@ -167,3 +167,28 @@ export function showFeaturesById (layer, featureIdList) {
     hideAllFeatures(layer);
     setFeatureStyle(features, undefined);
 }
+
+/**
+ * Load the features manually.
+ * @param {Object} layerAttributes raw layer attributes.
+ * @param {module:ol/vector/Source} layerSource - the source of the layer
+ * @returns {void}
+ */
+export function loadFeaturesManually (layerAttributes, layerSource) {
+    const getUrl = layerAttributes.url;
+
+    fetch(getUrl, layerSource)
+        .then(response => response.text())
+        .then(responseString => {
+            const features = layerSource.getFormat().readFeatures(responseString);
+
+            layerSource.addFeatures(features);
+            layerSource.dispatchEvent({
+                type: "featuresloadend",
+                features: layerSource.getFeatures()
+            });
+        })
+        .catch(error => {
+            console.error(error);
+        });
+}

package/src/layer/oaf.js

@@ -178,7 +178,7 @@ function createUrl (rawLayer) {
  * {@link https://openlayers.org/en/latest/apidoc/module-ol_source_Vector-VectorSource.html failure/success see}
  * @returns {(ol.source.VectorSource|ol.source.Cluster)} VectorSource or Cluster, depending on whether clusterDistance is set.
  */
-export function createLayerSource (rawLayer, options = {}) {
+function createLayerSource (rawLayer, options = {}) {
     if (!options.loadingStrategy) {
         options.loadingStrategy = bbox;
     }
@@ -203,7 +203,7 @@ export function createLayerSource (rawLayer, options = {}) {
  * @param {options} [optionalParams.options] - additional options
  * @returns {ol.Layer} Layer that can be added to map.
  */
-export function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {}) {
+function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {}) {
     let layer, source;
 
     // use WebGL render pipeline, if specified
@@ -239,3 +239,26 @@ export function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {
     }
     return layer;
 }
+
+/**
+ * Load the features manually.
+ * @param {Object} layerAttributes raw layer attributes.
+ * @param {module:ol/vector/Source} layerSource - the source of the layer
+ * @returns {void}
+ */
+function loadFeaturesManually (layerAttributes, layerSource) {
+    const getUrl = createUrl(layerAttributes, layerAttributes.version, {getCode: () => layerAttributes.crs}, "");
+
+    fetch(getUrl, layerSource)
+        .then(response => {
+            return response.text();
+        })
+        .then(responseString => {
+            layerSource.addFeatures(layerSource.getFormat().readFeatures(responseString));
+        })
+        .catch(error => {
+            console.error(error);
+        });
+}
+
+export default {createLayer, createLayerSource, loadFeaturesManually};

package/src/layer/wms.js

@@ -77,13 +77,12 @@ export function makeParams (rawLayer) {
 }
 
 /**
- * Return a ol tile or image load function for the rawLayer.
- * @param {object} rawLayer - layer specification as in services.json
+ * Return a ol tile or image load function for the rawLayer. Fetches with credentials: 'include'.
  * @returns {function} tile/image load function
  */
-export function defaultLoadFunction ({isSecured}) {
+export function loadFunctionWithCredentials () {
     return async (image, src) => {
-        const response = await fetch(src, {credentials: isSecured ? "include" : "omit"}),
+        const response = await fetch(src, {credentials: "include"}),
             data = await response.blob();
 
         image.getImage().src = URL.createObjectURL(data);
@@ -100,7 +99,7 @@ export function defaultLoadFunction ({isSecured}) {
  * @param {string|number} [rawLayer.tilesize] - optional needed to create the tileGrid
  * @param {string|"anonymous"} [rawLayer.crossOrigin] - optional needed for CORS requests of image data, to enable canvas export
  * @param {string} [rawLayer.cqlFilter] - optional CQL filter to add to the request
- * @param {boolean} [rawLayer.isSecured] - whether the layer is secured by BasicAuth and should include or omit the credentials prompt
+ * @param {boolean} [rawLayer.isSecured] - if the layer is secured by BasicAuth, images are loaded with credentials: 'include'.
  * @param {object} options - optional resolutions and origin to create the TileGrid
  * @param {Array} [options.resolutions] - optional resolutions to create the TileGrid, must be in descending order
  * @param {Array} [options.origin] - optional origin to create the TileGrid
@@ -120,8 +119,8 @@ export function createLayerSource (rawLayer, options) {
             projection: projection,
             attributions: rawLayer.olAttribution,
             crossOrigin: rawLayer.crossOrigin,
-            ...rawLayer.isSecured ? { // TODO: Remove this guard when olcs#666 is resolved
-                imageLoadFunction: defaultLoadFunction(rawLayer)
+            ...rawLayer.isSecured ? {
+                imageLoadFunction: loadFunctionWithCredentials()
             } : {}
         });
     }
@@ -140,7 +139,9 @@ export function createLayerSource (rawLayer, options) {
         projection: projection,
         attributions: rawLayer.olAttribution,
         crossOrigin: rawLayer.crossOrigin,
-        tileLoadFunction: defaultLoadFunction(rawLayer)
+        ...rawLayer.isSecured ? {
+            tileLoadFunction: loadFunctionWithCredentials()
+        } : {}
     });
 }
 

package/src/maps/ol/olMap.js

@@ -8,7 +8,7 @@ import wmts from "../../layer/wmts";
 import * as geojson from "../../layer/geojson";
 import wfs from "../../layer/wfs";
 import * as vectortile from "../../layer/vectorTile";
-import * as oaf from "../../layer/oaf";
+import oaf from "../../layer/oaf";
 import {createMapView} from "../../maps/mapView";
 import rawLayerList from "../../rawLayerList";
 import crs from "../../crs";
@@ -148,7 +148,8 @@ export function createMap (config = defaults, {mapParams, callback, errorCallbac
     crs.registerProjections(config.namedProjections);
     setBackgroundImage(config);
     setGazetteerUrl(config.gazetteerUrl);
-    const selectedInteractions = config.mapInteractions?.interactionModes ? config.mapInteractions?.interactionModes : {dragPan: false, altShiftDragRotate: false, pinchRotate: false},
+
+    const selectedInteractions = Object.assign({}, {dragPan: false, altShiftDragRotate: false, pinchRotate: false}, config.mapInteractions?.interactionModes),
         map = new Map(Object.assign({
             target: config.target || defaults.target,
             interactions: olDefaultInteractions(selectedInteractions).extend([
@@ -157,7 +158,7 @@ export function createMap (config = defaults, {mapParams, callback, errorCallbac
                         if (event.originalEvent.shiftKey) {
                             return false;
                         }
-                        return (!event.originalEvent.pointerType || event.originalEvent.pointerType === "mouse") || (config.twoFingerPan && this.getPointerCount() === 2) || !config.twoFingerPan;
+                        return (!event.originalEvent.pointerType || event.originalEvent.pointerType === "mouse") || (config.mapInteractions?.interactionModes?.twoFingerPan && this.getPointerCount() === 2) || !config.mapInteractions?.interactionModes?.twoFingerPan;
                     }
                 })
             ]),

package/src/renderer/webgl.js

@@ -107,6 +107,7 @@ export function createVectorTileLayerRenderer () {
                         fragment: result.builder.getSymbolFragmentShader(),
                         vertex: result.builder.getSymbolVertexShader()
                     },
+                    builder: result.builder,
                     attributes: {
                         fillColor: {
                             size: 2,

package/src/vectorStyle/lib/valueOperations.js

@@ -152,7 +152,7 @@ export function checkProperties (feature, rule) {
 
                 key = properties[i].attrName;
 
-                if (checkProperty(featureProperties, key, value)) {
+                if (!checkProperty(featureProperties, key, value)) {
                     return false;
                 }
             }

package/tall

@@ -0,0 +1,59 @@
+v1.0.0
+v1.1.0
+v1.10.0
+v1.2.0
+v1.3.0
+v1.4.0
+v1.5.0
+v1.6.0
+v1.6.1
+v1.7.0
+v1.7.1
+v1.8.0
+v1.9.0
+v2.0.0
+v2.1.0
+v2.1.1
+v2.10.0
+v2.11.0
+v2.12.0
+v2.13.0
+v2.14.0
+v2.15.0
+v2.15.1
+v2.15.2
+v2.16.0
+v2.17.0
+v2.18.0
+v2.19.0
+v2.19.1
+v2.19.2
+v2.2.0
+v2.20.0
+v2.21.0
+v2.22.0
+v2.23.0
+v2.24.0
+v2.25.0
+v2.26.0
+v2.27.0
+v2.28.0
+v2.29.0
+v2.3.0
+v2.30.0
+v2.31.0
+v2.32.0
+v2.33.0
+v2.34.0
+v2.35.0
+v2.36.0
+v2.37.0
+v2.38.0
+v2.39.0
+v2.4.0
+v2.5.0
+v2.5.1
+v2.6.0
+v2.7.0
+v2.8.0
+v2.9.0

package/test/layer/geojson/index.test.js

@@ -167,4 +167,34 @@ describe("geojson/index", function () {
             expect(features[1].getStyle()()).toBeNull();
         });
     });
+    describe("loadFeaturesManually", function () {
+        it("loadFeaturesManually shall call fetch", function () {
+            console.error = jest.fn();
+            global.fetch = jest.fn().mockImplementationOnce(() => {
+                return new Promise((resolve) => {
+                    resolve({
+                        ok: true,
+                        status: 200,
+                        json: () => {
+                            return [];
+                        }
+                    });
+                });
+            });
+
+            const layerParams = {
+                    id: "id",
+                    url: "url",
+                    featureNS: "http://www.deegree.org/app",
+                    featureType: "krankenhaeuser_hh",
+                    version: "1.0.0"
+                },
+                options = {},
+                layer = geojson.createLayer(layerParams, {options});
+
+            geojson.loadFeaturesManually(layerParams, layer.getSource());
+
+            expect(global.fetch.mock.calls.length).toBe(1);
+        });
+    });
 });

package/test/layer/oaf.test.js

@@ -5,7 +5,7 @@ import {Style, Icon} from "ol/style.js";
 import map from "../../src/maps/map.js";
 import defaults from "../../src/defaults";
 import GeoJSON from "ol/format/GeoJSON.js";
-import * as oaf from "../../src/layer/oaf";
+import oaf from "../../src/layer/oaf";
 import {featureCollection} from "./resources/oafFeatures";
 import * as webgl from "../../src/renderer/webgl.js";
 
@@ -287,4 +287,34 @@ describe("oaf.js", function () {
             expect(webgl.afterLoading).toHaveBeenCalledWith(features, layerParams.styleId, layerParams.excludeTypesFromParsing, layerParams.isPointLayer);
         });
     });
+    describe("loadFeaturesManually", function () {
+        it("loadFeaturesManually shall call fetch", function () {
+            console.error = jest.fn();
+            global.fetch = jest.fn().mockImplementationOnce(() => {
+                return new Promise((resolve) => {
+                    resolve({
+                        ok: true,
+                        status: 200,
+                        json: () => {
+                            return featureCollection;
+                        }
+                    });
+                });
+            });
+
+            const rawLayer = {
+                    id: "id",
+                    url: "url",
+                    featureNS: "http://www.deegree.org/app",
+                    featureType: "krankenhaeuser_hh",
+                    version: "1.0.0"
+                },
+                options = {},
+                layer = oaf.createLayer(rawLayer, {options});
+
+            oaf.loadFeaturesManually(rawLayer, layer.getSource());
+
+            expect(global.fetch.mock.calls.length).toBe(1);
+        });
+    });
 });

package/test/layer/wms.test.js

@@ -102,7 +102,7 @@ describe("wms.js", function () {
         });
     });
 
-    describe("defaultLoadFunction", function () {
+    describe("loadFunctionWithCredentials", function () {
         beforeEach(() => {
             const blob = new Blob();
 
@@ -121,19 +121,12 @@ describe("wms.js", function () {
         });
 
         it("passes credentials if isSecured is set", async function () {
-            const result = wms.defaultLoadFunction({isSecured: true}),
+            const result = wms.loadFunctionWithCredentials(),
                 input = {src: ""};
 
             await result({getImage: () => input}, "SECURE_WMS");
             expect(input.src).toEqual("blob:BLOB");
         });
-        it("does not pass credentials if isSecured is not set", async function () {
-            const result = wms.defaultLoadFunction({isSecured: false}),
-                input = {src: ""};
-
-            await result({getImage: () => input}, "INSECURE_WMS");
-            expect(input.src).toEqual("blob:BLOB");
-        });
     });
 
     describe("createLayerSource", function () {