@masterportal/masterportalapi 2.42.2 → 2.44.0

package/CHANGELOG.md

@@ -3,11 +3,49 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+### __Breaking Changes__
 
-## 2.42.2 - 2024-12-05
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+---
+
+## 2.44.0 - 2025-01-22
+
+### Added
+- Tileset.js: The tileset layer knows now the rawLayer transparency.
+
+### Fixed
+- Transparency and visibility information in `addLayer` is now interpreted correctly again
+- WMS-Layer: special loadFunction is used for every value attribute `isSecured` (behaviour equals <2.38.0)
+
+---
+
+## 2.43.0 - 2025-01-17
 
 ### Changed
--Revert Change, because of problems with Routing:
+- The following packages have been updated:
+    - dependencies:
+        - ol: 10.2.1 to 10.3.1
+    - peerDependencies:
+        - cesium/engine: 12.0.1 to 13.0.0
+
+### Fixed
+- 3D mesh layer was covered on level 0 by setting globe depthTestAgainstTerrain to false
+
+---
+
+## 2.42.2 - 2024-12-05
+### Changed
+- Revert Change, because of problems with Routing:
     - The following packages have been updated:
         - dependencies:
             - ol: 9.2.4 to 10.2.1
@@ -16,6 +54,7 @@
         - peerDependencies:
             - cesium/engine: 9.2.0 to 12.0.1
 
+---
 
 ## 2.42.1 - 2024-11-28
 
@@ -36,7 +75,7 @@
         - cesium/engine: 9.2.0 to 12.0.1
 
 ### Fixed
-- Issue #1275: Layers without capabilitiesURL are now working. 
+- Issue #1275: Layers without capabilitiesURL are now working.
 
 ---
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.42.2",
+  "version": "2.44.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.2.4",
-    "ol-mapbox-style": "12.2.1",
-    "olcs": "2.20.0",
+    "ol": "^10.3.1",
+    "ol-mapbox-style": "^12.3.5",
+    "olcs": "^2.22.1",
     "proj4": "^2.10.0",
     "xml2js": "^0.6.2"
   },
@@ -56,7 +56,7 @@
     "util": "^0.12.5"
   },
   "peerDependencies": {
-    "@cesium/engine": "^9.2.0"
+    "@cesium/engine": "^13.0.0"
   },
   "engines": {
     "node": "^16.13.2 || ^18.12.0 || ^20.12.2",

package/src/defaults.js

@@ -40,7 +40,7 @@ export default {
             enableTerrainAdjustmentWhenLoading: true
         },
         globe: {
-            depthTestAgainstTerrain: true // is necessary for scene.pickedPosition and correct height of the terrain. @see {https://github.com/CesiumGS/cesium/issues/5676}
+            depthTestAgainstTerrain: false
         },
         highDynamicRange: false,
         pickTranslucentDepth: true,

package/src/layer/tileset.js

@@ -33,7 +33,8 @@ export default function Tileset (rawLayer) {
     this.values = {
         name: rawLayer.name,
         id: rawLayer.id,
-        typ: rawLayer.typ
+        typ: rawLayer.typ,
+        transparency: rawLayer.transparency
     };
     if (Cesium) {
         this.tileset = Promise.resolve(createTileSet(this, rawLayer));

package/src/layer/wms.js

@@ -77,12 +77,13 @@ export function makeParams (rawLayer) {
 }
 
 /**
- * Return a ol tile or image load function for the rawLayer. Fetches with credentials: 'include'.
+ * Return a ol tile or image load function for the rawLayer.
+ * @param {object} rawLayer - layer specification as in services.json
  * @returns {function} tile/image load function
  */
-export function loadFunctionWithCredentials () {
+export function defaultLoadFunction ({isSecured}) {
     return async (image, src) => {
-        const response = await fetch(src, {credentials: "include"}),
+        const response = await fetch(src, {credentials: isSecured ? "include" : "omit"}),
             data = await response.blob();
 
         image.getImage().src = URL.createObjectURL(data);
@@ -99,7 +100,7 @@ export function loadFunctionWithCredentials () {
  * @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] - if the layer is secured by BasicAuth, images are loaded with credentials: 'include'.
+ * @param {boolean} [rawLayer.isSecured] - whether the layer is secured by BasicAuth and should include or omit the credentials prompt
  * @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
@@ -119,9 +120,7 @@ export function createLayerSource (rawLayer, options) {
             projection: projection,
             attributions: rawLayer.olAttribution,
             crossOrigin: rawLayer.crossOrigin,
-            ...rawLayer.isSecured ? {
-                imageLoadFunction: loadFunctionWithCredentials()
-            } : {}
+            imageLoadFunction: defaultLoadFunction(rawLayer)
         });
     }
     if (options && options.resolutions) {
@@ -139,9 +138,7 @@ export function createLayerSource (rawLayer, options) {
         projection: projection,
         attributions: rawLayer.olAttribution,
         crossOrigin: rawLayer.crossOrigin,
-        ...rawLayer.isSecured ? {
-            tileLoadFunction: loadFunctionWithCredentials()
-        } : {}
+        tileLoadFunction: defaultLoadFunction(rawLayer)
     });
 }
 

package/src/maps/ol/olMap.js

@@ -83,15 +83,20 @@ function injectErrorCallback (layer, errorCallback) {
  * @param {(string|ol/layer/Base)} layerOrId - if of layer to add to map
  * @param {object} [params] - optional parameter object
  * @param {boolean} [params.layerParams={}] - additional layerParams specified in portalConfig
- * @param {boolean} [params.visibility=true] - whether added layer is initially visible
- * @param {Number} [params.transparency=0] - how visible the layer is initially
+ * @param {boolean} [params.layerParams.visibility=true] - if params.visibility not given, this is used
+ * @param {Number} [params.layerParams.transparency=0] - if params.transparency not given, this is used
+ * @param {boolean} [params.visibility=params.layerParams.visibility] - whether added layer is initially visible
+ * @param {Number} [params.transparency=params.layerParams.transparency] - how visible the layer is initially
  * @param {Function} [params.errorCallback=console.error] - callback for layer source error events
  * @returns {?ol.Layer} added layer
  */
-function addLayer (layerOrId, params = {layerParams: {}, visibility: true, transparency: 0, errorCallback: console.error}) {
-    const errorCallback = typeof params.errorCallback === "function"
-        ? params.errorCallback
-        : console.error;
+function addLayer (layerOrId, params) {
+    const visibility = params?.visibility ?? params?.layerParams?.visibility ?? true,
+        transparency = params?.transparency ?? params?.layerParams?.transparency ?? 0,
+        layerParams = {...params?.layerParams || {}, visibility, transparency},
+        errorCallback = typeof params?.errorCallback === "function"
+            ? params?.errorCallback
+            : console.error;
     let layer, layerBuilder;
 
     // if parameter is id, create and add layer with masterportalAPI mechanisms
@@ -107,9 +112,9 @@ function addLayer (layerOrId, params = {layerParams: {}, visibility: true, trans
             console.error("Layer with id '" + layerOrId + "' has unknown type '" + rawLayer.typ + "'. No layer added to map.");
             return null;
         }
-        layer = layerBuilder.createLayer(rawLayer, {layerParams: params.layerParams}, {map: this});
-        layer.setVisible(typeof params.visibility === "boolean" ? params.visibility : true);
-        layer.setOpacity(typeof params.transparency === "number" ? (100 - params.transparency) / 100 : 1);
+        layer = layerBuilder.createLayer(rawLayer, {layerParams}, {map: this});
+        layer.setVisible(typeof visibility === "boolean" ? visibility : true);
+        layer.setOpacity(typeof transparency === "number" ? (100 - transparency) / 100 : 1);
         injectErrorCallback(layer, errorCallback);
         originalAddLayer.call(this, layer);
         return layer;

package/test/layer/wms.test.js

@@ -102,7 +102,7 @@ describe("wms.js", function () {
         });
     });
 
-    describe("loadFunctionWithCredentials", function () {
+    describe("defaultLoadFunction", function () {
         beforeEach(() => {
             const blob = new Blob();
 
@@ -121,12 +121,19 @@ describe("wms.js", function () {
         });
 
         it("passes credentials if isSecured is set", async function () {
-            const result = wms.loadFunctionWithCredentials(),
+            const result = wms.defaultLoadFunction({isSecured: true}),
                 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 () {

package/test/map.test.js

@@ -122,9 +122,9 @@ describe("map.js", function () {
         it("sets visibility and transparency", function () {
             const result1 = Map.prototype.addLayer("works"),
                 result2 = Map.prototype.addLayer("works", {}),
-                result3 = Map.prototype.addLayer("works", {visibility: false}),
-                result4 = Map.prototype.addLayer("works", {transparency: 50}),
-                result5 = Map.prototype.addLayer("works", {visibility: false, transparency: 20});
+                result3 = Map.prototype.addLayer("works", {layerParams: {visibility: false}}),
+                result4 = Map.prototype.addLayer("works", {layerParams: {transparency: 50}}),
+                result5 = Map.prototype.addLayer("works", {layerParams: {visibility: false, transparency: 20}});
 
             expect(result1.getOpacity()).toBe(1);
             expect(result1.getVisible()).toBe(true);