@masterportal/masterportalapi 2.23.0 → 2.24.0

package/CHANGELOG.md

@@ -3,10 +3,38 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## 2.24.0 - 2023-08-03
+### Added
+- The following packages have been installed:
+    - @swc/jest: 0.2.27
+- Add a function to convertUnits in drawInteractions.
+
+### Changed
+- The following packages have been updated:
+    - dependencies:
+        - core-js: 3.30.2 to 3.32.0
+        - dayjs: 1.11.7 to 1.11.9
+        - olcs: 2.14.0 to 2.15.0
+        - xml2js: 0.5.0 to 0.6.2
+    - devDependencies:
+        - @babel/core: 7.21.8 to 7.22.9
+        - @babel/plugin-transform-modules-commonjs: 7.21.5 to 7.21.5
+        - @parcel/transformer-sass: 2.8.3 to 2.9.3
+        - buffer: 5.7.1 to 6.0.3
+        - eslint: 8.40.0 to 8.46.0
+        - jest: 29.5.0 to 29.6.2
+        - jest-canvas-mock: 2.5.0 to 2.5.2
+        - jest-environment-jsdom: 29.5.0 to 29.6.2
+        - parcel: 2.8.3 to 2.9.3
+        - sass: 1.62.1 to 1.64.2
+
+### Fixed
+- Changed peerDependency from cesium 1.106.0 to @cesium/engine 2.4.1.
+
+---
+
 ## 2.23.0 - 2023-08-02
 ### Added
-- VectorStyle: Add Styling rules for Geoemtries of type `Circle`.
-- Add Styling and zIndex to draw interactions and improve the draw behavior.
 - Add select and modify interactions for editing ol features.
 
 ### Fixed
@@ -15,8 +43,15 @@
 ---
 
 ## 2.22.0 - 2023-07-25
+### Changed
+- Replace derprecated cesium tileset and terrain loading functions.
+- WFST Refactoring
+
+---
+
+## 2.21.0 - 2023-07-21
 ### Added
-- VectorStyle: Add Styling rules for Geoemtries of type `Circle`.
+- VectorStyle: Add Styling rules for Geometries of type `Circle`.
 - Add Styling and zIndex to draw interactions and improve the draw behavior.
 
 ### Changed
@@ -24,9 +59,6 @@
 - WFS:
     - Migrated writeTransaction and sendTransaction from masterportal the masterportalAPI.
     - Exports in src/layer/wfs.js changed to export default {} to provide  ES-Syntax.
-### Deprecated
-
-### Removed
 
 ### Fixed
 - WFS: fixed a bug that prevented parsing GeoServer responses.

package/example/config/portal.json

@@ -77,6 +77,6 @@
       }
     }
   ],
-  "cesiumLib":"https://geoportal-hamburg.de/mastercode/cesium/1_99/Cesium.js",
+  "cesiumLib":"https://geoportal-hamburg.de/mastercode/cesium/latest/Cesium.js",
   "wfsImgPath": "https://geodienste.hamburg.de/lgv-config/img/"
 }

package/example/index.js

@@ -249,7 +249,7 @@ document.getElementById("enable").addEventListener("click", function () {
         document.getElementById("layer-visibility").style.display = "none";
     }
     else {
-        const lib = portalConfig.cesiumLib ? portalConfig.cesiumLib : "https://geoportal-hamburg.de/mastercode/cesium/1_99/index.js";
+        const lib = portalConfig.cesiumLib ? portalConfig.cesiumLib : "https://geoportal-hamburg.de/mastercode/cesium/latest/index.js";
 
         document.getElementById("layer-visibility").style.display = "block";
 

package/jest.config.js

@@ -1,5 +1,8 @@
 /* eslint-env node */
 module.exports = {
+    "transform": {
+        "^.+\\.(t|j)sx?$": "@swc/jest"
+    },
     /** ol prints errors without HTMLCanvasElement being available in test environment */
     "setupFiles": ["jest-canvas-mock"],
     /** node_modules are usually ignored by babel-jest, but ol is published in ES6 */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.23.0",
+  "version": "2.24.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -19,30 +19,31 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "core-js": "^3.30.2",
-    "dayjs": "^1.11.7",
+    "core-js": "^3.32.0",
+    "dayjs": "^1.11.9",
     "ol": "7.4.0",
-    "olcs": "^2.14.0",
+    "olcs": "^2.15.0",
     "proj4": "^2.9.0",
-    "xml2js": "^0.5.0"
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
-    "@parcel/transformer-sass": "^2.8.3",
-    "buffer": "^5.7.1",
+    "@babel/core": "^7.22.9",
+    "@babel/plugin-transform-modules-commonjs": "^7.22.5",
+    "@parcel/transformer-sass": "^2.9.3",
+    "@swc/jest": "^0.2.27",
+    "buffer": "^6.0.3",
     "canvas": "^2.11.2",
-    "eslint": "^8.40.0",
+    "eslint": "^8.46.0",
     "events": "^3.3.0",
     "husky": "^8.0.3",
-    "jest": "^29.5.0",
-    "jest-canvas-mock": "^2.5.0",
-    "jest-environment-jsdom": "^29.5.0",
+    "jest": "^29.6.2",
+    "jest-canvas-mock": "^2.5.2",
+    "jest-environment-jsdom": "^29.6.2",
     "jest-fetch-mock": "^3.0.3",
     "jsdoc": "^4.0.2",
-    "parcel": "^2.8.3",
+    "parcel": "^2.9.3",
     "process": "^0.11.10",
-    "sass": "^1.62.1",
+    "sass": "^1.64.2",
     "stream-browserify": "^3.0.0",
     "timers-browserify": "^2.0.12",
     "use-resize-observer": "^9.1.0"

package/src/layer/terrain.js

@@ -5,14 +5,15 @@
  * @param {string} [rawLayer.cesiumTerrainProviderOptions] - see https://cesiumjs.org/Cesium/Build/Documentation/CesiumTerrainProvider.html
  * @returns {void}
  */
-function createTerrainProvider (rawLayer) {
-    const options = {};
+async function createTerrainProvider (rawLayer) {
+    const options = {},
+        terrainProvider = await Cesium.CesiumTerrainProvider.fromUrl(rawLayer.url, options);
 
     if (rawLayer.cesiumTerrainProviderOptions) {
         Object.assign(options, rawLayer.cesiumTerrainProviderOptions);
     }
-    options.url = rawLayer.url;
-    return new Cesium.CesiumTerrainProvider(options);
+
+    return terrainProvider;
 }
 
 /**
@@ -24,10 +25,10 @@ function createTerrainProvider (rawLayer) {
  * @param {OLCesium} map ol cesium map
  * @returns {void}
  */
-export function setVisible (value, rawLayer, map) {
+async function setVisible (value, rawLayer, map) {
     if (map && typeof map.getCesiumScene === "function") {
         if (value) {
-            map.getCesiumScene().terrainProvider = createTerrainProvider(rawLayer);
+            map.getCesiumScene().terrainProvider = await createTerrainProvider(rawLayer);
         }
         else {
             map.getCesiumScene().terrainProvider = new Cesium.EllipsoidTerrainProvider({});
@@ -63,3 +64,4 @@ export function get (key) {
     return this.values[key];
 }
 
+module.exports.setVisible = setVisible;

package/src/layer/tileset.js

@@ -9,11 +9,12 @@ function createTileSet (rawLayer) {
     const url = rawLayer.url.split("?")[0] + "/tileset.json",
         options = {};
 
+
     if (rawLayer.cesium3DTilesetOptions) {
         Object.assign(options, rawLayer.cesium3DTilesetOptions);
     }
-    options.url = url;
-    return new Cesium.Cesium3DTileset(options);
+
+    return Promise.resolve(Cesium.Cesium3DTileset.fromUrl(url, options));
 }
 
 /**
@@ -24,6 +25,7 @@ function createTileSet (rawLayer) {
  * @param {string} [rawLayer.cesiumTerrainProviderOptions] - see https://cesiumjs.org/Cesium/Build/Documentation/CesiumTerrainProvider.html
  * @returns {void}
  */
+
 export default function Tileset (rawLayer) {
     this.values = {
         name: rawLayer.name,
@@ -31,8 +33,13 @@ export default function Tileset (rawLayer) {
         typ: rawLayer.typ
     };
     if (Cesium) {
-        this.tileset = createTileSet(rawLayer);
-        this.tileset.layerReferenceId = rawLayer.id;
+        this.tileset = Promise.resolve(createTileSet(rawLayer));
+        this.tileset.then(function (tileset) {
+            if (tileset) {
+                tileset.layerReferenceId = rawLayer.id;
+            }
+        });
+
     }
 }
 
@@ -69,7 +76,9 @@ Tileset.prototype.setVisible = function (value, map) {
     if (map && typeof map.getCesiumScene === "function") {
         if (value) {
             if (!map.getCesiumScene().primitives.contains(this.tileset)) {
-                map.getCesiumScene().primitives.add(this.tileset);
+                this.tileset.then(function (tileset) {
+                    map.getCesiumScene().primitives.add(tileset);
+                });
             }
             this.tileset.show = true;
         }

package/src/maps/interactions/drawInteraction.js

@@ -38,6 +38,26 @@ let styleObject = null,
     styleObjectOuterCircle = null,
     zIndex = 0;
 
+/**
+ * Converts a value from one unit to another.
+ * @param {Number} value The value to convert.
+ * @param {String} sourceUnit The source unit.
+ * @param {String} targetUnit The target unit.
+ * @returns {Number} The converted value.
+ */
+function convertUnits (value, sourceUnit, targetUnit) {
+    if (sourceUnit === targetUnit) {
+        return value;
+    }
+    else if (sourceUnit === "m" && targetUnit === "km") {
+        return value / 1000;
+    }
+    else if (sourceUnit === "km" && targetUnit === "m") {
+        return value * 1000;
+    }
+    return value;
+}
+
 /**
  * Transform the radius to map projection unit.
  * @param {Number} radius The radius.
@@ -70,8 +90,10 @@ function transformMapUnitRadius (radius, mapProjection) {
  */
 function drawOuterCircle (feature, mapProjection, source, options = {}) {
     const innerCircleFeature = feature.clone(),
-        mapUnitInnerRadius = transformMapUnitRadius(options.innerRadius, mapProjection),
-        mapUnitOuterRadius = transformMapUnitRadius(options.outerRadius, mapProjection),
+        innerRadius = convertUnits(options.innerRadius, options.unit, "m"),
+        outerRadius = convertUnits(options.outerRadius, options.unit, "m"),
+        mapUnitInnerRadius = transformMapUnitRadius(innerRadius, mapProjection),
+        mapUnitOuterRadius = transformMapUnitRadius(outerRadius, mapProjection),
         innerStyle = createStyle.createStyle(styleObject, innerCircleFeature, false),
         outerStyle = createStyle.createStyle(styleObjectOuterCircle, feature, false);
 
@@ -95,7 +117,8 @@ function drawOuterCircle (feature, mapProjection, source, options = {}) {
  * @returns {void}
  */
 function drawInnerCircle (feature, mapProjection, options = {}) {
-    const mapUnitInnerRadius = transformMapUnitRadius(options.innerRadius, mapProjection);
+    const innerRadius = convertUnits(options.innerRadius, options.unit, "m"),
+        mapUnitInnerRadius = transformMapUnitRadius(innerRadius, mapProjection);
 
     feature.getGeometry().setRadius(mapUnitInnerRadius);
 }
@@ -205,6 +228,7 @@ function createDrawInteraction (drawType, source) {
 export {styleObject};
 
 export default {
+    convertUnits,
     createDrawInteraction,
     drawCircle,
     drawInnerCircle,

package/src/maps/olcs/3dUtils/wmsRasterSynchronizer.js

@@ -6,8 +6,8 @@ import {getUid} from "olcs/util.js";
 import TileWMS from "ol/source/TileWMS.js";
 import ImageWMS from "ol/source/ImageWMS.js";
 import WMTS from "ol/source/WMTS.js";
-import olcsAbstractSynchronizer from "olcs/AbstractSynchronizer.js";
-import {extentToRectangle, tileLayerToImageryLayer, updateCesiumLayerProperties} from "olcs/core.js";
+import olcsAbstractSynchronizer from "olcs/AbstractSynchronizer.ts";
+import {extentToRectangle, tileLayerToImageryLayer, updateCesiumLayerProperties} from "olcs/core.ts";
 import {Tile, Image as ImageLayer} from "ol/layer.js";
 import {stableSort} from "ol/array.js";
 import {getBottomLeft, getBottomRight, getTopRight, getTopLeft} from "ol/extent.js";

package/src/maps/olcs/olcsMap.js

@@ -1,6 +1,6 @@
-import OLCesium from "olcs/OLCesium.js";
+import OLCesium from "olcs/OLCesium.ts";
 import {transform, get} from "ol/proj.js";
-import VectorSynchronizer from "olcs/VectorSynchronizer.js";
+import VectorSynchronizer from "olcs/VectorSynchronizer.ts";
 
 import FixedOverlaySynchronizer from "./3dUtils/fixedOverlaySynchronizer.js";
 import WMSRasterSynchronizer from "./3dUtils/wmsRasterSynchronizer.js";

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

@@ -10,8 +10,10 @@ const features = [new Feature(), new Feature()];
 jest.mock("../../../src/renderer/webgl.js", () => {
     const original = jest.requireActual("../../../src/renderer/webgl.js");
 
-    original.afterLoading = jest.fn();
-    return original;
+    return {
+        ...original,
+        afterLoading: jest.fn()
+    };
 });
 
 describe("geojson/index", function () {

package/test/layer/oaf.test.js

@@ -19,8 +19,10 @@ jest.mock("../../src/rawLayerList.js", () => {
 jest.mock("../../src/renderer/webgl.js", () => {
     const original = jest.requireActual("../../src/renderer/webgl.js");
 
-    original.afterLoading = jest.fn();
-    return original;
+    return {
+        ...original,
+        afterLoading: jest.fn()
+    };
 });
 
 
@@ -272,4 +274,4 @@ describe("oaf.js", function () {
             expect(webgl.afterLoading).toHaveBeenCalled();
         });
     });
-});
+});

package/test/layer/terrain.test.js

@@ -5,8 +5,10 @@ describe("terrain.js", function () {
 
     beforeEach(() => {
         global.Cesium = {};
-        global.Cesium.CesiumTerrainProvider = jest.fn();
+        global.Cesium.CesiumTerrainProvider = {};
+        global.Cesium.CesiumTerrainProvider.fromUrl = jest.fn();
         global.Cesium.EllipsoidTerrainProvider = jest.fn();
+
         attr = {
             id: "12883",
             name: "Gelaende",
@@ -21,7 +23,7 @@ describe("terrain.js", function () {
                 return {};
             }
         };
-        cesiumTerrainProviderSpy = jest.spyOn(global.Cesium, "CesiumTerrainProvider");
+        cesiumTerrainProviderSpy = jest.spyOn(global.Cesium.CesiumTerrainProvider, "fromUrl");
     });
 
     afterEach(() => {

package/test/layer/tileset.test.js

@@ -6,7 +6,8 @@ describe("tileset.js", function () {
 
     beforeEach(() => {
         global.Cesium = {};
-        global.Cesium.Cesium3DTileset = jest.fn();
+        global.Cesium.Cesium3DTileset = {};
+        global.Cesium.Cesium3DTileset.fromUrl = jest.fn();
         global.Cesium.Cesium3DTileStyle = jest.fn(color => color);
         attr = {
             id: "4002",
@@ -28,7 +29,9 @@ describe("tileset.js", function () {
                 };
             }
         };
-        cesium3DTilesetSpy = jest.spyOn(global.Cesium, "Cesium3DTileset");
+        cesium3DTilesetSpy = jest.spyOn(global.Cesium.Cesium3DTileset, "fromUrl").mockImplementation(() => {
+            return Promise.resolve({});
+        });
         console.warn = jest.fn();
     });
 
@@ -38,21 +41,23 @@ describe("tileset.js", function () {
         console.warn = consoleWarn;
     });
 
-    function checkAttributes (layer, attrs) {
+    async function checkAttributes (layer, attrs) {
+        const tileset = await layer.tileset;
+
         expect(layer.get("name")).toEqual(attrs.name);
         expect(layer.get("typ")).toEqual(attrs.typ);
         expect(layer.get("id")).toEqual(attrs.id);
-        expect(layer.tileset.layerReferenceId).toEqual(attrs.id);
+        expect(tileset.layerReferenceId).toEqual(attrs.id);
     }
 
     describe("createLayer", function () {
         it("creates tileset layer without map", function () {
             const layer = new Tileset(attr);
 
-            checkAttributes(layer, attr);
             expect(layer.tileSet).toEqual(undefined);
             expect(layer.tileset.show).toEqual(undefined);
             expect(cesium3DTilesetSpy).toHaveBeenCalledTimes(1);
+            checkAttributes(layer, attr);
         });
         it("creates 2 tileset layers  with map and checks attributes", function () {
             const attr2 = {

package/test/layer/vectorBase.test.js

@@ -9,8 +9,10 @@ import * as webgl from "../../src/renderer/webgl.js";
 jest.mock("../../src/renderer/webgl.js", () => {
     const original = jest.requireActual("../../src/renderer/webgl.js");
 
-    original.afterLoading = jest.fn();
-    return original;
+    return {
+        ...original,
+        afterLoading: jest.fn()
+    };
 });
 
 describe("vectorBase.js", function () {

package/test/layer/wfs.test.js

@@ -24,8 +24,10 @@ jest.mock("../../src/rawLayerList.js", () => {
 jest.mock("../../src/renderer/webgl.js", () => {
     const original = jest.requireActual("../../src/renderer/webgl.js");
 
-    original.afterLoading = jest.fn();
-    return original;
+    return {
+        ...original,
+        afterLoading: jest.fn()
+    };
 });
 
 

package/test/maps/interactions/drawInteraction.test.js

@@ -6,6 +6,40 @@ import VectorSource from "ol/source/Vector";
 import drawInteractions, {styleObject} from "../../../src/maps/interactions/drawInteraction";
 
 describe("src/maps/interactions/drawInteraction.js", () => {
+    describe("convertUnits", () => {
+        it("shold return 1000 for sourceUnit === 'm' and targetUnit === 'm'", () =>{
+            const value = 1000,
+                sourceUnit = "m",
+                targetUnit = "m";
+
+            expect(drawInteractions.convertUnits(value, sourceUnit, targetUnit)).toEqual(1000);
+        });
+
+        it("shold return 1000 for sourceUnit === 'm' and targetUnit === 'km'", () =>{
+            const value = 1000,
+                sourceUnit = "m",
+                targetUnit = "km";
+
+            expect(drawInteractions.convertUnits(value, sourceUnit, targetUnit)).toEqual(1);
+        });
+
+        it("shold return 1000 for sourceUnit === 'km' and targetUnit === 'm'", () =>{
+            const value = 1000,
+                sourceUnit = "km",
+                targetUnit = "m";
+
+            expect(drawInteractions.convertUnits(value, sourceUnit, targetUnit)).toEqual(1000000);
+        });
+
+        it("shold return 1000 for sourceUnit === 'abc' and targetUnit === 'def'", () =>{
+            const value = 1000,
+                sourceUnit = "abc",
+                targetUnit = "def";
+
+            expect(drawInteractions.convertUnits(value, sourceUnit, targetUnit)).toEqual(1000);
+        });
+    });
+
     describe("transformMapUnitRadius", () => {
         it("should return the input meter radius in meter ", () => {
             const radius = 100,