@masterportal/masterportalapi 2.18.0 → 2.19.1

package/CHANGELOG.md

@@ -3,6 +3,41 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+### Added
+### Changed
+### Deprecated
+### Removed
+### Fixed
+
+---
+## 2.19.1 - 2023-06-02
+### Added
+### Changed
+- Exports in src/layer/wmts.js changed to export default {} to provide  ES-Syntax.
+### Deprecated
+### Removed
+### Fixed
+
+---
+
+## 2.19.0 - 2023-05-26
+### Added
+- The following package has been added:
+    - dependencies:
+        - dayjs: "^1.11.7"
+
+### Changed
+- AttributeMapper: Object keys are supported with dot notation.
+- WFS: hardcoded URL changed to dynamic url creation.
+- Issue Masterportal #1021: extend vectorStyle in order to handle geometryCollections.
+- Issue Masterportal #1022: attributeMapper supports additional time formats.
+
+### Fixed
+- Issue Masterportal # 1028: set cesium scene parameter recursively.
+
+---
+
 ## 2.18.0 - 2023-05-10
 ### Changed
 - The following packages have been updated:
@@ -18,7 +53,7 @@
         - jest-canvas-mock: 2.4.0 to 2.5.0
         - parcel: 2.6.0 to 2.8.3
         - sass: 1.59.3 to 1.62.1
-- The devDependency `buffer` ist downgrade from 6.0.3 to 5.7.1 because parcel requires a version 5
+- The devDependency `buffer` ist downgrade from 6.0.3 to 5.7.1 because parcel requires a version 5.
 
 ---
 

package/package.json

@@ -1,64 +1,64 @@
-{
-  "name": "@masterportal/masterportalapi",
-  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.18.0",
-  "license": "MIT",
-  "description": "Basic functions of the Masterportal as api",
-  "repository": {
-    "type": "git",
-    "url": "git+https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git"
-  },
-  "main": "src/index.js",
-  "scripts": {
-    "test": "jest .test.js --config ./jest.config.js --collectCoverage",
-    "test:trace": "node --trace-warnings node_modules/jest/bin/jest.js ./test/layer/wfs.test.js --config ./jest.config.js",
-    "test:watch": "jest .test.js --config ./jest.config.js --watch",
-    "example": "parcel example/index.html",
-    "generate-jsdoc": "jsdoc ./src -r -d ./docs/ -R ./README.md -c jsdoc.json",
-    "prePushHook": "eslint --max-warnings 0 \"./**/*.js\" && npm run test",
-    "prepare": "husky install"
-  },
-  "dependencies": {
-    "core-js": "^3.30.2",
-    "ol": "7.3.0",
-    "olcs": "^2.14.0",
-    "proj4": "^2.9.0",
-    "xml2js": "^0.5.0"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.21.8",
-    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
-    "@parcel/transformer-sass": "^2.8.3",
-    "buffer": "^5.7.1",
-    "canvas": "^2.11.2",
-    "eslint": "^8.40.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",
-    "jsdoc": "^4.0.2",
-    "parcel": "^2.8.3",
-    "process": "^0.11.10",
-    "sass": "^1.62.1",
-    "stream-browserify": "^3.0.0",
-    "timers-browserify": "^2.0.12",
-    "use-resize-observer": "^9.1.0"
-  },
-  "peerDependencies": {
-    "cesium": "^1.95.0"
-  },
-  "engines": {
-    "node": "^16.13.2 || ^18.12.0",
-    "npm": "^8.1.2 || ^9.3.1"
-  },
-  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
-  "directories": {
-    "doc": "docs",
-    "example": "example",
-    "test": "test"
-  },
-  "bugs": {
-    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
-  }
-}
+{
+  "name": "@masterportal/masterportalapi",
+  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
+  "version": "2.19.1",
+  "license": "MIT",
+  "description": "Basic functions of the Masterportal as api",
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git"
+  },
+  "main": "src/index.js",
+  "scripts": {
+    "test": "jest .test.js --config ./jest.config.js --collectCoverage",
+    "test:trace": "node --trace-warnings node_modules/jest/bin/jest.js ./test/layer/wfs.test.js --config ./jest.config.js",
+    "test:watch": "jest .test.js --config ./jest.config.js --watch",
+    "example": "parcel example/index.html",
+    "generate-jsdoc": "jsdoc ./src -r -d ./docs/ -R ./README.md -c jsdoc.json",
+    "prePushHook": "eslint --max-warnings 0 \"./**/*.js\" && npm run test",
+    "prepare": "husky install"
+  },
+  "dependencies": {
+    "core-js": "^3.30.2",
+    "dayjs": "^1.11.7",
+    "ol": "7.3.0",
+    "olcs": "^2.14.0",
+    "proj4": "^2.9.0",
+    "xml2js": "^0.5.0"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.21.8",
+    "@babel/plugin-transform-modules-commonjs": "^7.21.5",
+    "@parcel/transformer-sass": "^2.8.3",
+    "buffer": "^5.7.1",
+    "canvas": "^2.11.2",
+    "eslint": "^8.40.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",
+    "jsdoc": "^4.0.2",
+    "parcel": "^2.8.3",
+    "process": "^0.11.10",
+    "sass": "^1.62.1",
+    "stream-browserify": "^3.0.0",
+    "timers-browserify": "^2.0.12",
+    "use-resize-observer": "^9.1.0"
+  },
+  "peerDependencies": {
+    "cesium": "^1.95.0"
+  },
+  "engines": {
+    "node": "^16.13.2 || ^18.12.0",
+    "npm": "^8.1.2 || ^9.3.1"
+  },
+  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
+  "directories": {
+    "example": "example",
+    "test": "test"
+  },
+  "bugs": {
+    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
+  }
+}

package/src/index.js

@@ -2,7 +2,7 @@ import {createMapView} from "./maps/mapView";
 import crs from "./crs";
 import rawLayerList from "./rawLayerList";
 import * as wms from "./layer/wms";
-import * as wmts from "./layer/wmts";
+import wmts from "./layer/wmts";
 import * as wfs from "./layer/wfs";
 import * as geojson from "./layer/geojson";
 import * as vectorBase from "./layer/vectorBase";

package/src/layer/wfs.js

@@ -126,16 +126,21 @@ function loadWFSFilter (filter, url, source, {onErrorFn, success, failure}, opti
  * @returns {string} the url
  */
 function createUrl (rawLayer, version, projection, bboxParam) {
-    let url = `${rawLayer.url}?service=WFS&version=${version}&request=GetFeature&srsName=${projection.getCode()}${bboxParam}`;
+    const url = new URL(rawLayer.url);
+
+    url.searchParams.set("service", "WFS");
+    url.searchParams.set("version", version);
+    url.searchParams.set("request", "GetFeature");
+    url.searchParams.set("srsName", projection.getCode());
 
     if (version === "1.0.0" || version === "1.1.0") {
-        url = `${url}&typeName=${rawLayer.featureType}`;
+        url.searchParams.set("typeName", rawLayer.featureType);
     }
     else if (version === "2.0.0") {
-        url = `${url}&typeNames=${rawLayer.featureType}`;
+        url.searchParams.set("typeNames", rawLayer.featureType);
     }
 
-    return url;
+    return `${url.toString()}${bboxParam}`;
 }
 
 /**

package/src/layer/wmts.js

@@ -12,7 +12,7 @@ import {get as getProjection} from "ol/proj";
  * @param {String} layerName layerName
  * @returns {void}
  */
-export function showErrorMessage (errorMessage, layerName) {
+function showErrorMessage (errorMessage, layerName) {
     console.error("content: Layer " + layerName + ": " + errorMessage);
 }
 
@@ -24,7 +24,7 @@ export function showErrorMessage (errorMessage, layerName) {
  * @param {Number} size The tileSize depending on the extent.
  * @returns {void}
  */
-export function generateArrays (resolutions, matrixIds, length, size) {
+function generateArrays (resolutions, matrixIds, length, size) {
     for (let i = 0; i < length; ++i) {
         resolutions[i] = size / Math.pow(2, i);
         matrixIds[i] = i;
@@ -37,7 +37,7 @@ export function generateArrays (resolutions, matrixIds, length, size) {
  * @throws {Error} on unexpected return
  * @returns {promise} promise resolves to parsed WMTS-GetCapabilities object
  */
-export function getWMTSCapabilities (url) {
+function getWMTSCapabilities (url) {
     return fetch(url)
         .then(response => {
             if (response && response.status === 200) {
@@ -55,7 +55,7 @@ export function getWMTSCapabilities (url) {
 * @param {WMTS} tileLayer layer object
 * @returns {void}
 */
-export function createLayerSourceByDefinitions (attrs, tileLayer) {
+function createLayerSourceByDefinitions (attrs, tileLayer) {
     const projection = getProjection(attrs.coordinateSystem),
         extent = projection.getExtent(),
         style = attrs.style,
@@ -108,7 +108,7 @@ export function createLayerSourceByDefinitions (attrs, tileLayer) {
 * @param {WMTS} tileLayer layer object
 * @returns {void}
 */
-export function createLayerSourceByCapabilities (attrs, tileLayer) {
+function createLayerSourceByCapabilities (attrs, tileLayer) {
     const layerIdentifier = attrs.layers,
         url = attrs.capabilitiesUrl,
         matrixSet = attrs.tileMatrixSet,
@@ -169,7 +169,7 @@ export function createLayerSourceByCapabilities (attrs, tileLayer) {
  * @param {object} layerParams - additional layer params
  * @returns {void}
  */
-export function createLayer (rawLayer, layerParams = {}) {
+function createLayer (rawLayer, layerParams = {}) {
     const tileLayer = new TileLayer(Object.assign({
         id: rawLayer.id,
         source: new WMTS({}),
@@ -193,3 +193,12 @@ export function createLayer (rawLayer, layerParams = {}) {
 
     return tileLayer;
 }
+
+export default {
+    createLayer,
+    createLayerSourceByCapabilities,
+    createLayerSourceByDefinitions,
+    getWMTSCapabilities,
+    generateArrays,
+    showErrorMessage
+};

package/src/lib/attributeMapper.js

@@ -1,5 +1,6 @@
 import {getValueFromObjectByPath} from "./getValueFromObjectByPath.js";
 import thousandsSeparator from "./thousandsSeparator";
+import dayjs from "dayjs";
 /**
  * checks if value starts with special prefix to determine if value is a object path
  * @param   {string} value string to check
@@ -11,16 +12,25 @@ function isObjectPath (value) {
 /**
  * Returns the value of the given key. Also considers, that the key may be an object path.
  * @param {Object} properties properties.
- * @param {String} key Key to derive value from.
+ * @param {String} propertyKey Key to derive value from.
  * @returns {*} - Value from key.
  */
-function prepareValue (properties, key) {
-    const isPath = isObjectPath(key);
-    let value = properties[Object.keys(properties).find(propertiesKey => propertiesKey.toLowerCase() === key.toLowerCase())];
+function prepareValue (properties, propertyKey) {
+    Object.keys(properties).forEach((parentKey) => {
+        if (properties[parentKey] && typeof properties[parentKey] === "object") {
+            Object.keys(properties[parentKey]).forEach((key) => {
+                properties[parentKey + "." + key] = properties[parentKey][key];
+            });
+        }
+    });
+
+    const isPath = isObjectPath(propertyKey);
+    let value = properties[Object.keys(properties).find(propertiesKey => propertiesKey.toLowerCase() === propertyKey.toLowerCase())];
 
     if (isPath) {
-        value = getValueFromObjectByPath(properties, key);
+        value = getValueFromObjectByPath(properties, propertyKey);
     }
+
     return value;
 }
 
@@ -128,30 +138,21 @@ function prepareValueFromObject (key, mappingObj, properties) {
     switch (type) {
         case "date": {
             date = new Date(String(preparedValue));
-            if (!isNaN(date.getTime())) {
-                const year = date.getFullYear(),
-                    month = ("0" + (date.getMonth() + 1)).slice(-2),
-                    day = ("0" + date.getDate()).slice(-2);
-
-                if (format === "YYYY-MM-DDTHH:mm:ss.SSSZ") {
-                    const offset = date.getTimezoneOffset();
-
-                    let offsetHours = (offset / 60) % 24,
-                        offsetMinutes = offset % 60;
-
-                    offsetHours = offsetHours < 0 ? "+" + ("0" + Math.abs(offsetHours)).slice(-2) : "-" + ("0" + Math.abs(offsetHours)).slice(-2);
-                    offsetMinutes = offsetMinutes < 0 ? ":" + ("0" + Math.abs(offsetMinutes)).slice(-2) : ":" + ("0" + offsetMinutes).slice(-2);
-                    preparedValue = date.toISOString().slice(0, -1) + offsetHours + offsetMinutes;
-                }
-                else if (format === "YYYY-MM-DD") {
-                    preparedValue = year + "-" + month + "-" + day;
-                }
-                else if (format === "DD-MM-YYYY") {
-                    preparedValue = day + "-" + month + "-" + year;
-                }
-                else {
-                    console.error("The format must be 'YYYY-MM-DD' or 'DD-MM-YYYY', if the attribute is missing, ISO 8601 is used.");
-                }
+            if (format === "YYYY-MM-DDTHH:mm:ss.SSSZ") {
+                const offset = date.getTimezoneOffset();
+
+                let offsetHours = (offset / 60) % 24,
+                    offsetMinutes = offset % 60;
+
+                offsetHours = offsetHours < 0 ? "+" + ("0" + Math.abs(offsetHours)).slice(-2) : "-" + ("0" + Math.abs(offsetHours)).slice(-2);
+                offsetMinutes = offsetMinutes < 0 ? ":" + ("0" + Math.abs(offsetMinutes)).slice(-2) : ":" + ("0" + offsetMinutes).slice(-2);
+                preparedValue = date.toISOString().slice(0, -1) + offsetHours + offsetMinutes;
+            }
+            else if (!isNaN(date.getDay())) {
+                preparedValue = dayjs(String(preparedValue)).format(format);
+            }
+            else {
+                console.warn("If the attribute is missing, ISO 8601 is used.");
             }
             break;
         }

package/src/maps/olcs/olcsMap.js

@@ -9,6 +9,7 @@ import defaults from "../../defaults";
 let mapIdCounter = 0;
 
 /**
+ * Recursive function.
  * Sets the cesium default scene params.
  * @param {Cesium.scene} scene The cesium scene.
  * @param {Object} params Optional configuration parameters.
@@ -21,7 +22,7 @@ export function setCesiumSceneParams (scene, params) {
         if (typeof paramValue === "object") {
             Object.keys(paramValue).forEach(paramSubKey => {
                 if (paramSubKey !== "heading" && paramSubKey !== "tilt" && paramSubKey !== "altitude") {
-                    scene[paramKey][paramSubKey] = paramValue[paramSubKey];
+                    setCesiumSceneParams(scene[paramKey], paramValue);
                 }
             });
         }

package/src/vectorStyle/createStyle.js

@@ -228,9 +228,16 @@ function createStyle (styleObject, feature, isClustered, wfsImgPathFromConfig) {
         hasLabelField = style?.labelField,
         geometryStyle = getGeometryStyle(feature, rules, isClustered, wfsImgPathFromConfig),
         legendInformation = Array.isArray(geometryStyle) ? geometryStyle[0].legendInfos : geometryStyle.legendInfos,
-        styleObjectGeometry = Array.isArray(geometryStyle) ? geometryStyle[0].getStyle() : geometryStyle.getStyle();
+        styleObjectGeometry = Array.isArray(geometryStyle) ? geometryStyle.map(styleItem => styleItem.getStyle()) : geometryStyle.getStyle();
 
-    captureLegendFromFeature(styleObject.styleId, legendInformation);
+    if (geometryStyle.length > 1) {
+        for (const i in geometryStyle) {
+            captureLegendFromFeature(styleObject.styleId, geometryStyle[i].legendInfos);
+        }
+    }
+    else {
+        captureLegendFromFeature(styleObject.styleId, legendInformation);
+    }
 
     // label style is optional and depends on some fields
     if (isClustered || hasLabelField) {

package/test/layer/wmts.test.js

@@ -1,7 +1,7 @@
 import {get as getProjection} from "ol/proj";
 import {getWidth} from "ol/extent";
 
-import * as wmts from "../../src/layer/wmts";
+import wmts from "../../src/layer/wmts";
 
 describe("wmts.js", function () {
     describe("generateArrays", function () {

package/test/lib/attributeMapper.test.js

@@ -1,4 +1,4 @@
-import {mapAttributes, isObjectPath} from "../../src/lib/attributeMapper";
+import {mapAttributes, isObjectPath, prepareValue} from "../../src/lib/attributeMapper";
 
 const props = {
     random_text: "foobar",
@@ -287,4 +287,26 @@ describe("src/utils/attributeMapper.js", () => {
             expect(isObjectPath(true)).toBe(false);
         });
     });
+    describe("prepareValue", () => {
+        it("returns value from object by dot notation key", () => {
+            const properties = {
+                    address: {
+                        street: "Platz"
+                    }
+                },
+                testkey = "Address.Street";
+
+            expect(prepareValue(properties, testkey)).toEqual("Platz");
+        });
+        it("returns undefined from object by dot notation key if parentkey is not found", () => {
+            const properties = {
+                    address: {
+                        street: "Platz"
+                    }
+                },
+                testkey = "Location.Street";
+
+            expect(prepareValue(properties, testkey)).toBeUndefined();
+        });
+    });
 });

package/test/map.test.js

@@ -292,5 +292,68 @@ describe("map.js", function () {
             });
         });
     });
+    describe("setCesiumSceneParams", function () {
+        it("set the cesium scene parameter from config", function () {
+            global.Cesium = {};
+            global.Cesium.Color = {};
+            global.Cesium.Rectangle = {};
+            global.Cesium.Color.WHITE = {
+                "red": 1,
+                "green": 1,
+                "blue": 1,
+                "alpha": 1
+            };
+            global.Cesium.Rectangle.fromDegrees = function fromDegrees () {
+                return {
+                    "west": 0.18151424220741028,
+                    "south": 0.9107128036906411,
+                    "east": 0.1858775653373961,
+                    "north": 0.9138543963442309
+                };
+            };
+
+            const config = {
+                map2D: {
+                    getView: () => {
+                        return {
+                            getProjection: () => {
+                                return {getCode: () => "code"};
+                            }
+                        };
+                    },
+                    getViewport: () => {
+                        return {
+                            appendChild: jest.fn()
+                        };
+                    }
+                },
+                cesiumParameter: {
+                    globe: {
+                        showGroundAtmosphere: true,
+                        baseColor: global.Cesium.Color.WHITE,
+                        translucency: {
+                            frontFaceAlpha: 0.50,
+                            enabled: true,
+                            rectangle: global.Cesium.Rectangle.fromDegrees(10.40, 52.18, 10.65, 52.36)
+                        },
+                        undergroundColor: undefined
+                    }
+                },
+                cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
+            };
+
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
+                const map3D = map.createMap(config, "3D");
+
+                expect(map3D.mapMode).toBe("3D");
+                expect(map3D.getCesiumScene().globe.showGroundAtmosphere).toBe(config.cameraParameter.globe.showGroundAtmosphere);
+                expect(map3D.getCesiumScene().globe.baseColor).toBe(config.cameraParameter.globe.baseColor);
+                expect(map3D.getCesiumScene().globe.translucency.frontFaceAlpha).toBe(config.cameraParameter.globe.translucency.frontFaceAlpha);
+                expect(map3D.getCesiumScene().globe.translucency.enabled).toBe(config.cameraParameter.globe.translucency.enabled);
+                expect(map3D.getCesiumScene().globe.translucency.rectangle).toBe(config.cameraParameter.globe.translucency.rectangle);
+                expect(map3D.getCesiumScene().globe.undergroundColor()).toBe(config.cameraParameter.globe.undergroundColor);
+            });
+        });
+    });
 
 });