@masterportal/masterportalapi 2.63.0 → 2.64.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
  
+## 2.64.0 - 2026-09-23
+
+### Added
+- Readme: Information and link to issues in opencode added.
+- Draw: Added functions to draw and modify features: write text and draw square. Integrated wfsImgPath to apply configured styles.
+- Export: Added functions to export drawn features in kml, geojson, gpx and csv formats.
+
+### Changed
+- The following packages have been updated:
+  - dependencies:
+    - ol: 10.9.0 to 10.10.0
+    - ol-mapbox-style: 13.4.1 to 13.5.0
+    - olcs: 2.23.0 to 2.23.1
+  - peerDependencies:
+    - @cesium/engine: 26.0.0 to 26.3.0
+
+### Fixed
+- AttributeMapper: prevented mapping of empty strings for GFI.
+
+---
+ 
 ## 2.63.0 - 2026-07-17
 
 ### Changed
@@ -11,6 +32,7 @@
     - core-js: 3.33.1 to 3.49.0
     - dayjs: 1.11.10 to 1.11.21
     - proj4: 2.10.0 to 2.20.9
+    - ol-mapbox-style: 13.3.0 to 13.4.1
   - devDependencies:
     - @parcel/config-default: 2.15.4 to 2.16.4
     - @parcel/transformer-sass: 2.15.4 to 2.16.4

package/README.md

@@ -25,3 +25,11 @@ Both methods may be required for useful user feedback. For example, a WMS may an
 |``npm run generate-jsdoc``|Generates the project documentation within the folder ``./docs``.|
 |``npm test``|Runs all tests. Prints code coverage to console.|
 |``npm run test:watch``|Runs all tests in watch mode. Good practive to let this run during development in a separate terminal. |
+
+## Community
+
+The Bitbucket issue tracker is being removed on August 20, 2026. All issues have been migrated to openCode. You can access them via the link listed below, where you can also create new issues.
+
+* [Issue tracker](https://gitlab.opencode.de/lgvhh/urban-data-solutions/masterportalapi/-/work_items)
+
+**Please do not report security vulnerabilities via the public issue tracker.** Instead, report them privately by email as described in our [Security Policy](./SECURITY.md).

package/bitbucket-pipelines.yml

@@ -8,15 +8,15 @@ pipelines:
     tags:
         'v2.*.*':
             -   step:
-                    name: deploy on openCode
+                    name: deploy on new openCode
                     script:
-                        - echo 'deploy to opencode:'$BITBUCKET_TAG
+                        - echo 'deploy to new opencode:'$BITBUCKET_TAG
                         - git fetch --all --tags
                         - git checkout tags/$BITBUCKET_TAG
-                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/geowerkstatt-hamburg/masterportalapi.git $BITBUCKET_TAG
+                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/lgvhh/urban-data-solutions/masterportalapi.git $BITBUCKET_TAG
                         - git clone --single-branch --branch master https://geowerkstatt@bitbucket.org/geowerkstatt-hamburg/masterportalapi.git
                         - cd masterportalapi
-                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/geowerkstatt-hamburg/masterportalapi.git -f
+                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/lgvhh/urban-data-solutions/masterportalapi.git -f
     custom: # Pipelines that are triggered manually
         npm audit:
             -   step:
@@ -26,18 +26,18 @@ pipelines:
                     script:
                         - npm install
                         - npm audit --json
-        deploy last tag on openCode:
+        deploy last tag on new openCode:
             - variables:
                 - name: BITBUCKET_TAG
                   description: tag to publish docs for
             -   step:
-                    name: deploy last tag on openCode
+                    name: deploy last tag on new openCode
                     script:
                         - apt-get update && apt-get install -y curl wput jq
                         - git fetch --all --tags
-                        - echo 'deply to opencode:'$BITBUCKET_TAG
+                        - echo 'deploy to new opencode:'$BITBUCKET_TAG
                         - git checkout tags/$BITBUCKET_TAG
-                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/geowerkstatt-hamburg/masterportalapi.git $BITBUCKET_TAG
+                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/lgvhh/urban-data-solutions/masterportalapi.git $BITBUCKET_TAG
                         - git clone --single-branch --branch master https://geowerkstatt@bitbucket.org/geowerkstatt-hamburg/masterportalapi.git
                         - cd masterportalapi
-                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/geowerkstatt-hamburg/masterportalapi.git -f
+                        - git push https://$OpenCode_User:$OpenCode_Password@gitlab.opencode.de/lgvhh/urban-data-solutions/masterportalapi.git -f

package/example/config/services.json

@@ -58,7 +58,7 @@
   {
     "id": "4001",
     "name": "Gelaende",
-    "url": "https://daten-hamburg.de/gdi3d/datasource-data/Gelaende",
+    "url": "https://www.daten-hamburg.de/gdi3d/datasource-data/Gelaende",
     "typ": "Terrain3D",
     "cesiumTerrainProviderOptions": {
       "requestVertexNormals": true
@@ -67,7 +67,7 @@
   {
     "id": "4002",
     "name": "Gebäude LoD2",
-    "url": "https://daten-hamburg.de/gdi3d/datasource-data/LoD2",
+    "url": "https://www.daten-hamburg.de/gdi3d/datasource-data/LoD2",
     "typ": "TileSet3D",
     "styleId": "3DTileSetStyle",
     "cesium3DTilesetOptions": {
@@ -80,7 +80,7 @@
     "typ": "Entities3D",
     "entities": [
       {
-        "url": "https://daten-hamburg.de/gdi3d/datasource-data/Simple_Building.glb",
+        "url": "https://www.daten-hamburg.de/gdi3d/datasource-data/Simple_Building.glb",
         "attributes": {
           "name": "einfaches Haus in Planten und Blomen"
         },
@@ -95,7 +95,7 @@
         "show": true
       },
       {
-        "url": "https://daten-hamburg.de/gdi3d/datasource-data/Simple_Building.glb",
+        "url": "https://www.daten-hamburg.de/gdi3d/datasource-data/Simple_Building.glb",
         "attributes": {
           "name": "einfaches Haus im See"
         },

package/jest.setup.js

@@ -1,4 +1,8 @@
 import "regenerator-runtime/runtime";
+import {TextEncoder, TextDecoder} from "util";
+
+global.TextEncoder = TextEncoder;
+global.TextDecoder = TextDecoder;
 
 class Worker {
     constructor (stringUrl) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@masterportal/masterportalapi",
-  "version": "2.63.0",
+  "version": "2.64.0",
   "description": "Basic functions of the Masterportal as api",
   "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
   "bugs": {
@@ -35,9 +35,9 @@
   "dependencies": {
     "core-js": "^3.49.0",
     "dayjs": "^1.11.21",
-    "ol": "10.9.0",
-    "ol-mapbox-style": "13.3.0",
-    "olcs": "^2.23.0",
+    "ol": "^10.10.0",
+    "ol-mapbox-style": "^13.5.0",
+    "olcs": "^2.23.1",
     "proj4": "^2.20.9"
   },
   "devDependencies": {
@@ -68,7 +68,7 @@
     "util": "^0.12.5"
   },
   "peerDependencies": {
-    "@cesium/engine": "^26.0.0"
+    "@cesium/engine": "^26.3.0"
   },
   "engines": {
     "node": "^22.19.0 || ^24.11.1",

package/publiccode.yml

@@ -81,8 +81,8 @@ maintenance:
 name: Masterportal
 platforms:
   - web
-releaseDate: '2026-07-17'
+releaseDate: '2026-09-23'
 roadmap: 'https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/'
 softwareType: api
-softwareVersion: 2.63.0
+softwareVersion: 2.64.0
 url: 'https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git'

package/src/index.js

@@ -16,6 +16,8 @@ import {search, setGazetteerUrl} from "./searchAddress";
 import setBackgroundImage from "./lib/setBackgroundImage";
 import ping from "./lib/ping";
 import ogcApiProcesses from "./api/ogcApiProcesses";
+import * as exportItem from "./shared/exportItem";
+import * as kmlExport from "./shared/kmlExport";
 
 export {
     createMapView,
@@ -36,5 +38,7 @@ export {
     search,
     crs,
     webgl,
-    ogcApiProcesses
+    ogcApiProcesses,
+    exportItem,
+    kmlExport
 };

package/src/lib/attributeMapper.js

@@ -266,7 +266,7 @@ function mapAttributes (properties, mappingObject, isNested = true) {
                 value = prepareValueFromObject(key, newKey, properties);
                 newKey = newKey.name;
             }
-            if (value && value !== "undefined") {
+            if (value !== undefined && value !== null && value !== "" && value !== "undefined") {
                 mappedProperties[newKey] = value;
             }
         });

package/src/maps/interactions/drawInteraction.js

@@ -1,4 +1,6 @@
-import {createBox} from "ol/interaction/Draw.js";
+import {createBox, createRegularPolygon} from "ol/interaction/Draw.js";
+import {Circle as CircleStyle, Icon, Style, Fill} from "ol/style.js";
+import Text from "ol/style/Text.js";
 import {Draw} from "ol/interaction.js";
 
 import createStyle from "../../vectorStyle/createStyle";
@@ -32,12 +34,29 @@ const earthRadius = 6378137,
         },
         polygon: {
             type: "Polygon"
+        },
+        writeText: {
+            type: "Point"
+        },
+        square: {
+            type: "Circle",
+            options: {
+                geometryFunction: createRegularPolygon(4)
+            }
         }
     };
 let styleObject = null,
     styleObjectOuterCircle = null,
     zIndex = 0;
 
+/**
+ * Returns the current style rule from styleObject.
+ * @returns {Object|null} The current style rule or null.
+ */
+function getCurrentStyleRule () {
+    return styleObject?.rules?.[0]?.style || null;
+}
+
 /**
  * Converts a value from one unit to another.
  * @param {Number} value The value to convert.
@@ -66,12 +85,9 @@ function convertUnits (value, sourceUnit, targetUnit) {
  */
 function transformMapUnitRadius (radius, mapProjection) {
     const unit = mapProjection.getUnits();
-    let mapUnitRadius;
+    let mapUnitRadius = radius;
 
-    if (unit === "m") {
-        mapUnitRadius = radius;
-    }
-    else if (unit === "degrees") {
+    if (unit === "degrees") {
         mapUnitRadius = radius * roh / earthRadius;
     }
 
@@ -86,6 +102,7 @@ function transformMapUnitRadius (radius, mapProjection) {
  * @param {Object} [options={}] The options for drawing features.
  * @param {Number} [options.innerRadius] The radius for the inner circle.
  * @param {Number} [options.outerRadius] The radius for the outer circle.
+ * @param {String} [options.unit] The unit for the radii (e.g. "m", "km").
  * @returns {void}
  */
 function drawOuterCircle (feature, mapProjection, source, options = {}) {
@@ -110,10 +127,11 @@ function drawOuterCircle (feature, mapProjection, source, options = {}) {
 
 /**
  * Create a feature for the (inner) circle of draw type: circle or double circle.
- * @param {ol/feature} feature The ol feature.vb
+ * @param {ol/feature} feature The ol feature.
  * @param {Object} mapProjection The map projection.
  * @param {Object} [options={}] The options for drawing features.
  * @param {Number} [options.innerRadius] The radius for the (inner) circle.
+ * @param {String} [options.unit] The unit for the radius (e.g. "m", "km").
  * @returns {void}
  */
 function drawInnerCircle (feature, mapProjection, options = {}) {
@@ -133,6 +151,7 @@ function drawInnerCircle (feature, mapProjection, options = {}) {
  * @param {Number} [options.innerRadius] The radius for the inner circle.
  * @param {Boolean} [options.interactive] Circle is drawn interactively or not.
  * @param {Number} [options.outerRadius] The radius for the outer circle.
+ * @param {String} [options.unit] The unit for the radii (e.g. "m", "km").
  * @returns {void}
  */
 function drawCircle (drawInteraction, drawType, mapProjection, source, options = {}) {
@@ -157,7 +176,9 @@ function drawCircle (drawInteraction, drawType, mapProjection, source, options =
  */
 function setStyleObject (currentLayout, outerCircle = false) {
     const fillOpacity = 1 - (currentLayout.fillTransparency / 100),
+        strokeOpacity = fillOpacity,
         fillColorRgba = [...currentLayout.fillColor, fillOpacity],
+        strokeColorRgba = [...currentLayout.strokeColor, strokeOpacity],
         style = {
             rules: [
                 {
@@ -165,13 +186,16 @@ function setStyleObject (currentLayout, outerCircle = false) {
                         circleFillColor: fillColorRgba,
                         circleStrokeColor: currentLayout.strokeColor,
                         circleStrokeWidth: currentLayout.strokeWidth,
-                        lineStrokeColor: currentLayout.strokeColor,
+                        lineStrokeColor: strokeColorRgba,
                         lineStrokeWidth: currentLayout.strokeWidth,
                         polygonFillColor: fillColorRgba,
                         polygonStrokeColor: currentLayout.strokeColor,
                         polygonStrokeDash: currentLayout.polygonDash,
                         polygonStrokeDashOffset: currentLayout.polygonStrokeDashOffset,
-                        polygonStrokeWidth: currentLayout.strokeWidth
+                        polygonStrokeWidth: currentLayout.strokeWidth,
+                        text: currentLayout.text || "Text",
+                        textFont: currentLayout.font || "Arial",
+                        textFontSize: currentLayout.fontSize || 10
                     }
                 }
             ]
@@ -188,11 +212,12 @@ function setStyleObject (currentLayout, outerCircle = false) {
 /**
  * Sets the style to overlay and feature.
  * @param {ol/interaction/Draw} drawInteraction The draw interaction.
+ * @param {String} wfsImgPath Path to the image folder from Config.
  * @returns {void}
  */
-function setStyleToDrawInteraction (drawInteraction) {
+function setStyleToDrawInteraction (drawInteraction, wfsImgPath) {
     drawInteraction.on("drawstart", event => {
-        const style = createStyle.createStyle(styleObject, event.feature, false);
+        const style = createStyle.createStyle(styleObject, event.feature, false, wfsImgPath);
 
         style.setZIndex(zIndex++);
         drawInteraction.getOverlay().setStyle(style);
@@ -200,16 +225,139 @@ function setStyleToDrawInteraction (drawInteraction) {
     });
 }
 
+/**
+ * Sets the style to the text.
+ * @param {ol/interaction/Draw} drawInteraction The draw interaction.
+ * @returns {void}
+ */
+function setStyleToDrawText (drawInteraction) {
+    drawInteraction.on("drawstart", event => {
+        const style = getCurrentStyleRule();
+
+        event.feature.set("drawType", "writeText");
+
+        if (!style?.text) {
+            console.error("Style object for text is not properly initialized.");
+            return;
+        }
+
+        const textStyle = new Text({
+                text: style.text ?? "",
+                font: `${style.textFontSize}px ${style.textFont}`,
+                fill: new Fill({color: style.polygonFillColor || "black"}),
+                textAlign: style.textAlign || "left",
+                textBaseline: "bottom"
+            }),
+            olStyle = new Style({text: textStyle});
+
+        olStyle.setZIndex(zIndex++);
+        event.feature.set("textContent", style.text);
+        event.feature.set("textFontSize", style.textFontSize);
+        event.feature.set("textFont", style.textFont);
+        event.feature.set("textFillColor", style.polygonFillColor);
+        event.feature.setStyle(olStyle);
+    });
+}
+
+/**
+ * Returns the current text style from the styleObject for use as sketch/preview.
+ * @returns {ol/style/Style|null} The text style or null.
+ */
+function getTextStyle () {
+    const style = getCurrentStyleRule();
+
+    if (!style) {
+        return null;
+    }
+
+    if (!style.text || style.text === "Text") {
+        return null;
+    }
+
+    return new Style({
+        text: new Text({
+            text: style.text,
+            font: `${style.textFontSize}px ${style.textFont}`,
+            fill: new Fill({color: style.polygonFillColor || "black"}),
+            textAlign: style.textAlign || "left",
+            textBaseline: "bottom"
+        })
+    });
+}
+
+/**
+ * Returns a style for simple point features without stroke.
+ * Uses the current circleFillColor from the styleObject.
+ * @returns {ol/style/Style} The point style.
+ */
+function getSimplePointStyle () {
+    const rawColor = getCurrentStyleRule()?.circleFillColor || [0, 0, 0, 1],
+        fillColor = [rawColor[0], rawColor[1], rawColor[2], 1];
+
+    return new Style({
+        image: new CircleStyle({
+            radius: 8,
+            fill: new Fill({color: fillColor})
+        })
+    });
+}
+
 /**
  * Create the draw interaction.
  * @param {String} drawType The current draw type.
  * @param {ol/source} source The vector layer source for draw features.
+ * @param {Object[]} [iconList=[]] The list of symbols for the draw type symbols.
+ * @param {String} [wfsImgPath=""] Path to the image folder, used as prefix when symbol value is not an absolute path.
  * @returns {ol/interaction/Draw|null} The draw interaction.
  */
-function createDrawInteraction (drawType, source) {
+function createDrawInteraction (drawType, source, iconList, wfsImgPath = "") {
     let drawInteraction = null;
+    const symbol = iconList?.length > 0 ? iconList.find(val => val.id === drawType) : null;
+
+    if (symbol) {
+        if (symbol.type === "image") {
+            const iconSrc = symbol.value.startsWith("/") || symbol.value.startsWith("http") || symbol.value.startsWith(".")
+                    ? symbol.value
+                    : `${wfsImgPath}${symbol.value}`,
+                svgStyle = new Style({
+                    image: new Icon({
+                        src: iconSrc,
+                        scale: symbol.scale || 1,
+                        anchor: [0.5, 1]
+                    })
+                });
 
-    if (typeof mappingDrawTypes[drawType] === "object") {
+            drawInteraction = new Draw({
+                source: source,
+                type: "Point",
+                style: svgStyle
+            });
+        }
+        else if (symbol.type === "simple_point") {
+            drawInteraction = new Draw({
+                source: source,
+                type: "Point",
+                style: getSimplePointStyle
+            });
+            drawInteraction.on("drawstart", event => {
+                const style = getSimplePointStyle();
+
+                style.setZIndex(zIndex++);
+                event.feature.setStyle(style);
+            });
+        }
+        else {
+            drawInteraction = new Draw({
+                source: source,
+                type: "Point"
+            });
+            if (styleObject !== null) {
+                setStyleToDrawInteraction(drawInteraction, wfsImgPath);
+            }
+            drawInteraction.getOverlay().setStyle([]);
+        }
+    }
+    else if (typeof mappingDrawTypes[drawType] === "object") {
         const options = mappingDrawTypes[drawType].options || {};
 
         drawInteraction = new Draw({
@@ -219,8 +367,16 @@ function createDrawInteraction (drawType, source) {
             type: mappingDrawTypes[drawType].type
         });
 
-        if (styleObject !== null && drawType !== "doubleCircle") {
-            setStyleToDrawInteraction(drawInteraction);
+        if (styleObject !== null && drawType !== "doubleCircle" && drawType !== "writeText") {
+            setStyleToDrawInteraction(drawInteraction, wfsImgPath);
+        }
+
+        if (drawType === "writeText") {
+            setStyleToDrawText(drawInteraction);
+            drawInteraction.getOverlay().setStyle(getTextStyle() ?? []);
+        }
+        else {
+            drawInteraction.getOverlay().setStyle([]);
         }
     }
 
@@ -235,6 +391,7 @@ export default {
     drawCircle,
     drawInnerCircle,
     drawOuterCircle,
+    getTextStyle,
     setStyleObject,
     transformMapUnitRadius
 };

package/src/maps/interactions/modifyInteraction.js

@@ -3,11 +3,24 @@ import {Modify} from "ol/interaction.js";
 /**
  * Create the modify interaction.
  * @param {ol/source} source The vector layer source containing the features to be modified.
+ * @param {Object} [options={}] Optional object to register watchers for modification of features.
+ * @param {Function} [options.onModifyEnd] Callback function triggered when a modify operation ends.
+ * @param {Function} [options.onModifyStart] Callback function triggered when a modify operation starts.
  * @returns {ol/interaction/Modify} The modify interaction.
  */
-function createModifyInteraction (source) {
+function createModifyInteraction (source, options = {}) {
     const modifyInteraction = new Modify({
-        source: source
+            source: source
+        }),
+        watcherMap = {
+            modifyend: options.onModifyEnd,
+            modifystart: options.onModifyStart
+        };
+
+    Object.entries(watcherMap).forEach(([eventName, callback]) => {
+        if (typeof callback === "function") {
+            modifyInteraction.on(eventName, callback);
+        }
     });
 
     return modifyInteraction;