@masterportal/masterportalapi 2.15.0 → 2.15.2

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+###
+Added
+###
+Changed
+###
+Deprecated
+### 
+Removed
+### 
+Fixed
+---
+
+## 2.15.2 - 2023-03-14
+###
+Changed
+- Update parameters for getGeometryTypeFromService.getGeometryTypeFromWFS and getGeometryTypeFromService.getGeometryTypeFromOAF to pass wfsImgPath.
+### Fixed
+- Fix imports in createLegendInfo.js
+---
+
+## 2.15.1 - 2023-03-09
+### Fixed
+- The `labelField` attribute is now evaluated correctly for a text style.
+- The styling for clustered features works now.
+
+---
+
 ## 2.15.0 - 2023-02-28
 ### Added
 - WebGL Render-Pipeline for all VectorLayer types can be called using {"renderer": "webgl"} in config.json

package/package.json

@@ -1,64 +1,63 @@
-{
-  "name": "@masterportal/masterportalapi",
-  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.15.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.27.1",
-    "ol": "7.2.2",
-    "olcs": "^2.13.1",
-    "proj4": "^2.8.1",
-    "xml2js": "^0.4.23"
-  },
-  "devDependencies": {
-    "@babel/core": "^7.20.12",
-    "@babel/plugin-transform-modules-commonjs": "^7.20.11",
-    "@parcel/transformer-sass": "^2.6.0",
-    "buffer": "^6.0.3",
-    "canvas": "^2.11.0",
-    "eslint": "^8.31.0",
-    "events": "^3.3.0",
-    "husky": "^8.0.3",
-    "jest": "^29.3.1",
-    "jest-canvas-mock": "^2.4.0",
-    "jest-environment-jsdom": "^29.3.1",
-    "jsdoc": "^4.0.0",
-    "parcel": "^2.6.0",
-    "process": "^0.11.10",
-    "sass": "^1.57.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"
-  },
-  "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.15.2",
+  "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.27.1",
+    "ol": "7.2.2",
+    "olcs": "^2.13.1",
+    "proj4": "^2.8.1",
+    "xml2js": "^0.4.23"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/plugin-transform-modules-commonjs": "^7.20.11",
+    "@parcel/transformer-sass": "^2.6.0",
+    "buffer": "^6.0.3",
+    "canvas": "^2.11.0",
+    "eslint": "^8.31.0",
+    "events": "^3.3.0",
+    "husky": "^8.0.3",
+    "jest": "^29.3.1",
+    "jest-canvas-mock": "^2.4.0",
+    "jest-environment-jsdom": "^29.3.1",
+    "jsdoc": "^4.0.0",
+    "parcel": "^2.6.0",
+    "process": "^0.11.10",
+    "sass": "^1.57.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"
+  },
+  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
+  "directories": {
+    "example": "example",
+    "test": "test"
+  },
+  "bugs": {
+    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
+  }
+}

package/src/vectorStyle/lib/createLegendInfo.js

@@ -1,28 +1,29 @@
-import {getSimpleGeometryStyle, getMultiGeometryStyle} from "../createStyle";
+import createStyle from "../createStyle";
 /**
  * Creates the style objects for the layer
  * @param   {object[]} rules styling rules from the styleObject
  * @param   {string[]} geometryType Array of geometry types
+ * @param   {String} wfsImgPath path to wfsImg from Config
  * @returns {void}
  */
-export function createLegendInfo (rules, geometryType) {
+export function createLegendInfo (rules, geometryType, wfsImgPath) {
     let styleObject,
         simpleGeom;
 
     geometryType.forEach(geom => rules.forEach(rule => {
         if (geom === "MultiSurface") {
             simpleGeom = "Polygon";
-            styleObject = getSimpleGeometryStyle(simpleGeom, "", rule, false);
+            styleObject = createStyle.getSimpleGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
             return styleObject;
         }
         else if (geom.includes("Multi")) {
             simpleGeom = geom.replace("Multi", "");
-            styleObject = getMultiGeometryStyle(simpleGeom, "", rule, false);
+            styleObject = createStyle.getMultiGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
             return styleObject;
         }
 
         simpleGeom = geom;
-        styleObject = getSimpleGeometryStyle(simpleGeom, "", rule, false);
+        styleObject = createStyle.getSimpleGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
         return styleObject;
     }));
 }

package/src/vectorStyle/lib/getGeometryTypeFromService.js

@@ -86,11 +86,12 @@ function getTypeAttributesFromSubelements (subElements = [], styleGeometryType =
 * @param   {string} featureType wfs feature type from layer
 * @param   {string[] | string} styleGeometryType The configured geometry type of the layer
 * @param   {boolean} isSecured true if wfs is secured
+* @param   {String} wfsImgPath path to wfsImg from Config
 * @param {function} [callback] - called with services after loaded; called with false and error on error
 * @returns {void}
 */
 // eslint-disable-next-line max-params
-function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeometryType, isSecured, callback) {
+function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeometryType, isSecured, wfsImgPath, callback) {
     const params = {
         "SERVICE": "WFS",
         "VERSION": version,
@@ -114,7 +115,7 @@ function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeome
             const subElements = getSubelementsFromXML(responseXML, featureType),
                 geometryTypes = getTypeAttributesFromSubelements(subElements, styleGeometryType);
 
-            createLegendInfo(rules, geometryTypes);
+            createLegendInfo(rules, geometryTypes, wfsImgPath);
         }).catch(error => {
             return callback(error);
         });
@@ -125,10 +126,11 @@ function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeome
  * @param   {object[]} rules styling rules from the styleObject
  * @param   {string} oafURL url from layer
  * @param   {String} collection the collection name to fetch geometry type for
+ * @param   {String} wfsImgPath path to wfsImg from Config
  * @param {function} [callback] - called with services after loaded; called with false and error on error
  * @returns {void}
  */
-function getGeometryTypeFromOAF (rules, oafURL, collection, callback) {
+function getGeometryTypeFromOAF (rules, oafURL, collection, wfsImgPath, callback) {
     const url = oafURL + "/collections/" + collection + "/items?limit=1";
 
     fetch(url, {
@@ -140,7 +142,7 @@ function getGeometryTypeFromOAF (rules, oafURL, collection, callback) {
         const geometryType = response.data?.features[0]?.geometry?.type;
 
         if (geometryType) {
-            createLegendInfo(rules, [geometryType]);
+            createLegendInfo(rules, [geometryType], wfsImgPath);
         }
     }).catch(error => {
         return callback(error);

package/src/vectorStyle/styles/point/stylePoint.js

@@ -46,8 +46,12 @@ class PointStyle extends StyleClass {
      * @returns {ol/style} - The created style.
      */
     getStyle () {
-        const type = this.attributes.type.toLowerCase(),
-            isClustered = this.isClustered;
+        const isClustered = this.isClustered;
+        let type = this.attributes.type.toLowerCase();
+
+        if (isClustered && this.feature.get("features")?.length > 1) {
+            type = this.attributes.clusterType.toLowerCase();
+        }
 
         if (type === "icon") {
             return createIconStyle(this.attributes, this.feature, isClustered);

package/src/vectorStyle/styles/point/stylePointIcon.js

@@ -52,7 +52,7 @@ export function createIconStyle (attributes, feature, isClustered) {
     if (!showCluster) {
         iconOptions.anchorXUnits = attributes.imageOffsetXUnit;
         iconOptions.anchorYUnits = attributes.imageOffsetYUnit;
-        iconOptions.rotation = getRotationValue(attributes.rotation, feature.getProperties());
+        iconOptions.rotation = feature ? getRotationValue(attributes.rotation, feature.getProperties()) : 0;
     }
 
     return new Style({

package/src/vectorStyle/styles/styleText.js

@@ -38,7 +38,7 @@ class TextStyle extends StyleClass {
     getStyle () {
         const isClustered = this.isClustered,
             feature = this.feature,
-            labelField = this.labelField;
+            labelField = this.attributes.labelField;
 
         if (isClustered && feature.get("features")?.length > 1 && this.attributes.clusterTextType !== "none") {
             return this.createClusteredTextStyle();

package/test/vectorStyle/styles/point/stylePoint.test.js

@@ -1,19 +1,26 @@
 import PointStyle from "../../../../src/vectorStyle/styles/point/stylePoint";
-import {Style} from "ol/style.js";
+import {Circle as CircleStyle, Style} from "ol/style.js";
 
 describe("stylePoint", () => {
-    const feature = {
+    let feature,
+        isClustered,
+        style,
+        stylePointClass;
+
+    beforeEach(() => {
+        feature = {
             geometryName: "geom",
             id: "DE.HH.UP_GESUNDHEIT_KRANKENHAEUSER_2"
-        },
+        };
         style = {
             type: "icon",
             clusterType: "icon",
             legendValue: "Krankenhaus",
             imageName: "krankenhaus.png"
-        },
-        isClustered = false,
+        };
+        isClustered = false;
         stylePointClass = new PointStyle(feature, style, isClustered);
+    });
 
     describe("setSize", function () {
         it("defines setSize()", () => {
@@ -24,5 +31,18 @@ describe("stylePoint", () => {
         it("returns an instance of openlayers style", () => {
             expect(stylePointClass.getStyle()).toBeInstanceOf(Style);
         });
+        it("returns an instance of openlayers circleStyle", () => {
+            isClustered = true;
+            style = {
+                type: "icon",
+                clusterType: "circle",
+                legendValue: "Krankenhaus",
+                imageName: "krankenhaus.png"
+            };
+
+            expect(stylePointClass.getStyle()).toBeInstanceOf(Style);
+            expect(stylePointClass.getStyle().getImage()).toBeInstanceOf(CircleStyle);
+        });
     });
+
 });

package/test/vectorStyle/styles/styleText.test.js

@@ -16,7 +16,8 @@ describe("styleText", () => {
             type: "icon",
             clusterType: "icon",
             legendValue: "Krankenhaus",
-            imageName: "krankenhaus.png"
+            imageName: "krankenhaus.png",
+            labelField: ""
         },
         isClustered = false,
         styleTextClass = new TextStyle(feature, style, isClustered);