@masterportal/masterportalapi 2.22.0 → 2.23.0

package/CHANGELOG.md

@@ -3,19 +3,17 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
-## Unreleased - in development
+## 2.23.0 - 2023-08-02
 ### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
+- 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
-
+- The legend for wfs is now created again via the Describefeaturetype.
 
 ---
+
 ## 2.22.0 - 2023-07-25
 ### Added
 - VectorStyle: Add Styling rules for Geoemtries of type `Circle`.
@@ -23,7 +21,7 @@
 
 ### Changed
 - Changed peerDependency from cesium 1.106.0 to @cesium/engine 2.4.1.
-- WFS: 
+- WFS:
     - Migrated writeTransaction and sendTransaction from masterportal the masterportalAPI.
     - Exports in src/layer/wfs.js changed to export default {} to provide  ES-Syntax.
 ### Deprecated

package/package.json

@@ -1,65 +1,65 @@
-{
-  "name": "@masterportal/masterportalapi",
-  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.22.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.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.4.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",
-    "jest-fetch-mock": "^3.0.3",
-    "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/engine": "^2.4.1"
-  },
-  "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"
-  }
-}
+{
+  "name": "@masterportal/masterportalapi",
+  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
+  "version": "2.23.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.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.4.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",
+    "jest-fetch-mock": "^3.0.3",
+    "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/engine": "^2.4.1"
+  },
+  "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

@@ -1,6 +1,5 @@
 import {createMapView} from "./maps/mapView";
 import crs from "./crs";
-import drawInteractions from "./maps/interactions/drawInteractions";
 import rawLayerList from "./rawLayerList";
 import * as wms from "./layer/wms";
 import wmts from "./layer/wmts";
@@ -37,6 +36,5 @@ export {
     ping,
     search,
     crs,
-    drawInteractions,
     webgl
 };

package/src/maps/interactions/modifyInteraction.js

@@ -0,0 +1,18 @@
+import {Modify} from "ol/interaction.js";
+
+/**
+ * Create the modify interaction.
+ * @param {ol/source} source The vector layer source containing the features to be modified.
+ * @returns {ol/interaction/Modify} The modify interaction.
+ */
+function createModifyInteraction (source) {
+    const modifyInteraction = new Modify({
+        source: source
+    });
+
+    return modifyInteraction;
+}
+
+export default {
+    createModifyInteraction
+};

package/src/maps/interactions/selectInteraction.js

@@ -0,0 +1,35 @@
+import {Select} from "ol/interaction.js";
+
+/**
+ * Remove the selected feature.
+ * @param {ol/interaction/Select} selectInteraction The select interaction.
+ * @param {ol/source} source The vector layer source containing the features to be selected.
+ * @returns {void}
+ */
+function removeSelectedFeature (selectInteraction, source) {
+    selectInteraction.on("select", event => {
+        source.removeFeature(event.selected[0]);
+        event.target.getFeatures().clear();
+    });
+}
+
+/**
+ * Create the select interaction.
+ * @param {ol/layer|ol/layer[]} layers The vector layers for select features.
+ * @param {ol/events/condition} [condition] The ol condition. Default from ol is "singleClick".
+ * @returns {ol/interaction/Select} The select interaction.
+ */
+function createSelectInteraction (layers, condition) {
+    const selectInteraction = new Select({
+        condition: condition,
+        layers: Array.isArray(layers) ? layers : [layers],
+        hitTolerance: 10
+    });
+
+    return selectInteraction;
+}
+
+export default {
+    createSelectInteraction,
+    removeSelectedFeature
+};

package/src/vectorStyle/lib/createLegendInfo.js

@@ -1,4 +1,5 @@
 import createStyle from "../createStyle";
+
 /**
  * Creates the style objects for the layer
  * @param   {object[]} rules styling rules from the styleObject
@@ -8,22 +9,29 @@ import createStyle from "../createStyle";
  */
 export function createLegendInfo (rules, geometryType, wfsImgPath) {
     let styleObject,
-        simpleGeom;
+        simpleGeom,
+        legendInfos = [];
 
     geometryType.forEach(geom => rules.forEach(rule => {
         if (geom === "MultiSurface") {
             simpleGeom = "Polygon";
             styleObject = createStyle.getSimpleGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
-            return styleObject;
+            legendInfos = legendInfos.concat(styleObject.legendInfos);
         }
         else if (geom.includes("Multi")) {
             simpleGeom = geom.replace("Multi", "");
             styleObject = createStyle.getMultiGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
-            return styleObject;
-        }
 
-        simpleGeom = geom;
-        styleObject = createStyle.getSimpleGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
-        return styleObject;
+            styleObject.forEach(singleStyleObject => {
+                legendInfos = legendInfos.concat(singleStyleObject.legendInfos);
+            });
+        }
+        else {
+            simpleGeom = geom;
+            styleObject = createStyle.getSimpleGeometryStyle(simpleGeom, "", rule, false, wfsImgPath);
+            legendInfos = legendInfos.concat(styleObject.legendInfos);
+        }
     }));
-}
+
+    return legendInfos;
+}

package/src/vectorStyle/lib/getGeometryTypeFromService.js

@@ -7,15 +7,15 @@ import {createLegendInfo} from "./createLegendInfo";
  * @returns {object[]} subElements of the xml element
  */
 function getSubelementsFromXMLOtherStructure (xml, featureType) {
-    const elements = xml ? Array.from(xml.getElementsByTagName("element")) : [];
+    const elements = xml ? Array.from(xml.getElementsByTagNameNS("*", "element")) : [];
     let subElements = [];
 
     elements.forEach(element => {
         if (element.getAttribute("name") === featureType) {
             const sibling = element.nextElementSibling;
 
-            if (sibling && sibling.tagName === "complexType" && sibling.hasAttribute("name")) {
-                subElements = Array.from(sibling.getElementsByTagName("element"));
+            if (sibling && sibling.tagName.endsWith("complexType") && sibling.hasAttribute("name")) {
+                subElements = Array.from(sibling.getElementsByTagNameNS("*", "element"));
             }
         }
     });
@@ -29,7 +29,8 @@ function getSubelementsFromXMLOtherStructure (xml, featureType) {
  * @returns {object[]} subElements of the xml element
  */
 function getSubelementsFromXML (xml, featureType) {
-    const elements = xml ? Array.from(xml.getElementsByTagName("element")) : [];
+    const elements = xml ? Array.from(xml.getElementsByTagNameNS("*", "element")) : [];
+
     let subElements = [],
         featureTypeWithoutNamespace = featureType;
 
@@ -39,9 +40,10 @@ function getSubelementsFromXML (xml, featureType) {
 
     elements.forEach(element => {
         if (element.getAttribute("name") === featureTypeWithoutNamespace) {
-            subElements = Array.from(element.getElementsByTagName("element"));
+            subElements = Array.from(element.getElementsByTagNameNS("*", "element"));
         }
     });
+
     if (subElements.length === 0) {
         subElements = getSubelementsFromXMLOtherStructure(xml, featureTypeWithoutNamespace);
     }
@@ -105,7 +107,7 @@ function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeome
     url = url.slice(0, -1);
 
 
-    fetch(url, {
+    return fetch(url, {
         method: "get",
         withCredentials: isSecured,
         responseType: "text"
@@ -115,7 +117,7 @@ function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeome
             const subElements = getSubelementsFromXML(responseXML, featureType),
                 geometryTypes = getTypeAttributesFromSubelements(subElements, styleGeometryType);
 
-            createLegendInfo(rules, geometryTypes, wfsImgPath);
+            return createLegendInfo(rules, geometryTypes, wfsImgPath);
         }).catch(error => {
             return callback(error);
         });
@@ -152,4 +154,4 @@ function getGeometryTypeFromOAF (rules, oafURL, collection, wfsImgPath, callback
 export default {
     getGeometryTypeFromWFS,
     getGeometryTypeFromOAF
-};
+};

package/test/maps/interactions/{drawInteractions.test.js → drawInteraction.test.js}

@@ -3,9 +3,9 @@ import Feature from "ol/Feature";
 import Circle from "ol/geom/Circle";
 import VectorSource from "ol/source/Vector";
 
-import drawInteractions, {styleObject} from "../../../src/maps/interactions/drawInteractions";
+import drawInteractions, {styleObject} from "../../../src/maps/interactions/drawInteraction";
 
-describe("src/maps/interactions/drawInteractions.js", () => {
+describe("src/maps/interactions/drawInteraction.js", () => {
     describe("transformMapUnitRadius", () => {
         it("should return the input meter radius in meter ", () => {
             const radius = 100,

package/test/maps/interactions/modifyInteraction.test.js

@@ -0,0 +1,18 @@
+import {Modify} from "ol/interaction.js";
+import VectorSource from "ol/source/Vector";
+
+import modifyInteractions from "../../../src/maps/interactions/modifyInteraction";
+
+describe("src/maps/interactions/modifyInteraction.js", () => {
+    describe("createModifyInteraction", () => {
+        it("should create a modify interaction", () => {
+            const source = new VectorSource(),
+                modifyInteraction = modifyInteractions.createModifyInteraction(source);
+
+            expect(modifyInteraction).not.toBeUndefined();
+            expect(modifyInteraction).not.toBeNull();
+            expect(modifyInteraction).toBeInstanceOf(Modify);
+        });
+    });
+
+});

package/test/maps/interactions/selectInteraction.test.js

@@ -0,0 +1,31 @@
+/* eslint-disable no-underscore-dangle */
+import {pointerMove, singleClick} from "ol/events/condition.js";
+import {Select} from "ol/interaction.js";
+import VectorLayer from "ol/layer/Vector";
+
+import selectInteractions from "../../../src/maps/interactions/selectInteraction";
+
+describe("src/maps/interactions/selectInteraction.js", () => {
+    describe("createSelectInteraction", () => {
+        it("should create a select interaction", () => {
+            const layers = new VectorLayer(),
+                selectInteraction = selectInteractions.createSelectInteraction(layers);
+
+            expect(selectInteraction).not.toBeUndefined();
+            expect(selectInteraction).not.toBeNull();
+            expect(selectInteraction).toBeInstanceOf(Select);
+            expect(selectInteraction.condition_).toEqual(singleClick);
+        });
+
+        it("should create a select interaction with condition === pointerMove", () => {
+            const layers = new VectorLayer(),
+                selectInteraction = selectInteractions.createSelectInteraction(layers, pointerMove);
+
+            expect(selectInteraction).not.toBeUndefined();
+            expect(selectInteraction).not.toBeNull();
+            expect(selectInteraction).toBeInstanceOf(Select);
+            expect(selectInteraction.condition_).toEqual(pointerMove);
+        });
+    });
+
+});