@masterportal/masterportalapi 2.60.0 → 2.62.0

package/.editorconfig

@@ -6,7 +6,7 @@ root = true
 [*]
 indent_style = space
 indent_size = 4
-end_of_line = crlf
+end_of_line = lf
 charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true

package/.eslintrc

@@ -104,7 +104,6 @@
         "no-void": "error",
         "no-with": "error",
         "radix": "error",
-        "vars-on-top": "error",
         "yoda": "error",
         "no-delete-var": "error",
         "no-label-var": "error",
@@ -159,7 +158,6 @@
         "no-whitespace-before-property": "error",
         "object-curly-spacing": "error",
         "object-property-newline": 0,
-        "one-var": "error",
         "one-var-declaration-per-line": "error",
         "quotes": "error",
         "require-jsdoc": 0,

package/CHANGELOG.md

@@ -3,6 +3,40 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## 2.62.0 - 2026-06-11
+
+### Added
+- Allow to override the OpenLayers Map class for 2D maps.
+
+### Changed
+- Linting: Removed one-var and vars-on-top rules.
+- Changed end_of_line to lf in editorconfig file.
+- Issue #17: Replaced package xml2js with native DomParser for parsing xml of search result.
+
+### Removed
+- The following packages have been removed:
+    - dependencies:
+        - xml2js
+
+---
+
+## 2.61.0 - 2026-04-21
+
+### Changed
+- VectorTile with `vtStyles`: `setStyle` is not reading from url, if  `options.readStyleFromUrl = false`. Is also passed by `options` in `createLayer`.
+- The following packages have been updated:
+    - dependencies:
+        - ol-mapbox-style: 12.5.0 to 13.3.0
+        - olcs: 2.22.1 to 2.23.0
+        - ol: 10.8.0 to 10.9.0
+
+### Removed
+- The following overwrites have been removed:
+        - geotiff in ol
+- The unused babel dev dependencies were removed
+
+---
+
 ## 2.60.0 - 2026-04-10
 
 ### Added

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at geodatenanwendungen@gv.hamburg.de. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project’s leadership.
+
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

package/CONTRIBUTING.md

@@ -0,0 +1,70 @@
+# Contributing to masterportalAPI
+
+Thank you for your interest in contributing to masterportalAPI. This document is the entry point for contributors.
+
+If a policy, workflow, or convention is not defined in this repository, the corresponding rules from the [main Masterportal project](https://bitbucket.org/geowerkstatt-hamburg/masterportal/src/dev/) apply.
+
+## Code of Conduct
+
+All participants are expected to follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
+
+## Developer Documentation
+
+The main developer documentation for this repository is available in these places:
+
+- **[Project overview and usage](./README.md)** — Installation, package usage, error handling, and available scripts
+- **[Example setup](./example/README.md)** — How to use the example application for manual testing
+- **[API documentation generation](./README.md#scripts)** — Generate local JSDoc output with `npm run generate-jsdoc`
+- **[Changelog](./CHANGELOG.md)** — Add your changes under `Unreleased`
+- **[Package metadata](./package.json)** — Supported Node.js and npm versions, scripts, dependencies, and repository metadata
+
+If you need guidance that is not documented in this repository, follow the corresponding documentation and contribution rules from the [main Masterportal project](https://bitbucket.org/geowerkstatt-hamburg/masterportal/src/dev/).
+
+## Quick Reference
+
+| What | Where |
+|---|---|
+| Install dependencies | `npm install` |
+| Start the example dev server | `npm run example` |
+| Run tests | `npm test` |
+| Pre-push check (ESLint + tests) | `npm run prePushHook` |
+| Generate API docs | `npm run generate-jsdoc` |
+
+## Asking Questions
+
+If you have questions about using or developing with masterportalAPI, start by checking the [README](./README.md).
+
+## Getting Familiar with the Code in the Repository
+
+The repository is organized into a few main areas:
+
+- `src/` contains the library source code
+- `test/` contains the automated test suite
+- `example/` contains a Parcel-based example app for manual testing
+- `public/` contains public assets used by the example and runtime utilities
+
+If you are new to the codebase, begin with [README.md](./README.md), then inspect the relevant modules in `src/` and the corresponding test files in `test/`.
+
+## How to Contribute
+
+1. **Fork the repository** — external developers do not receive write access. See Forks.
+2. **Branch from dev** and follow the Git workflow.
+3. **Write code** that adheres to the coding conventions.
+4. **Add tests** for new or changed functionality.
+5. **Update the changelog** — add an entry under `Unreleased` in [CHANGELOG.md](./CHANGELOG.md).
+6. **Open a Pull Request** against dev. Reviewers will check against the Definition of Done.
+
+## Reporting Issues
+
+Use the [Bitbucket Issue Tracker](https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues). Please include:
+
+- A clear description of the problem or feature request
+- Steps to reproduce (for bugs)
+- Expected vs. actual behavior
+- npm and Node.js version
+- Relevant configuration
+- Screenshots, logs if they help explain the problem
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the [MIT License](./License.txt).

package/README.md

@@ -25,7 +25,3 @@ 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. |
-
-## About Babel
-
-The Babel dev dependencies are purely added for development tests and jest tests. Babel is required for testing since Node does not support ES6 in .js files so far.

package/jest.config.js

@@ -14,7 +14,7 @@ module.exports = {
     /** mapping svg to string representation since jest can't handle svg and mapping olcs paths*/
     "moduleNameMapper": {
         "marker.svg": "<rootDir>/public/stringMarker.js",
-        "olcs/lib/olcs/(.*)$": "<rootDir>/node_modules/olcs/lib/olcs/$1",
+        "olcs/lib/olcs/util.js": "<rootDir>/node_modules/olcs/lib/olcs/util.js",
         "ol-mapbox-style$": "<rootDir>/node_modules/ol-mapbox-style/src/$1"
     },
     "testEnvironment": "jsdom",

package/package.json

@@ -1,26 +1,27 @@
 {
   "name": "@masterportal/masterportalapi",
-  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.60.0",
-  "license": "MIT",
+  "version": "2.62.0",
   "description": "Basic functions of the Masterportal as api",
+  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
+  "bugs": {
+    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git"
   },
-  "source": "src/index.js",
-  "main": "src/index.js",
+  "license": "MIT",
+  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
+  "type": "commonjs",
   "exports": {
     ".": "./src/index.js",
     "./src/*": "./src/*"
   },
-  "targets": {
-    "library": {
-      "source": "src/index.js",
-      "distDir": "dist",
-      "outputFormat": "commonjs"
-    },
-    "main": false
+  "main": "src/index.js",
+  "directories": {
+    "doc": "docs",
+    "example": "example",
+    "test": "test"
   },
   "scripts": {
     "test": "jest .test.js --config ./jest.config.js --collectCoverage",
@@ -34,15 +35,12 @@
   "dependencies": {
     "core-js": "^3.33.1",
     "dayjs": "^1.11.10",
-    "ol": "10.8.0",
+    "ol": "10.9.0",
     "ol-mapbox-style": "13.3.0",
-    "olcs": "^2.22.1",
-    "proj4": "^2.10.0",
-    "xml2js": "^0.6.2"
+    "olcs": "^2.23.0",
+    "proj4": "^2.10.0"
   },
   "devDependencies": {
-    "@babel/core": "7.26.0",
-    "@babel/plugin-transform-modules-commonjs": "^7.23.0",
     "@parcel/config-default": "^2.15.4",
     "@parcel/transformer-sass": "^2.15.4",
     "@swc/jest": "^0.2.39",
@@ -72,22 +70,23 @@
   "peerDependencies": {
     "@cesium/engine": "^23.0.0"
   },
-  "overrides": {
-    "ol": {
-      "geotiff": "^2.1.3"
-    }
-  },
   "engines": {
     "node": "^22.19.0 || ^24.11.1",
     "npm": "^10.5.0 || ^11.6.2"
   },
-  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
-  "directories": {
-    "doc": "docs",
-    "example": "example",
-    "test": "test"
+  "source": "src/index.js",
+  "targets": {
+    "library": {
+      "source": "src/index.js",
+      "distDir": "dist",
+      "outputFormat": "commonjs"
+    },
+    "main": false
   },
-  "bugs": {
-    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
+  "@parcel/resolver-default": {
+    "packageExports": true
+  },
+  "alias": {
+    "olcs/lib/olcs/util.js": "./node_modules/olcs/lib/olcs/util.js"
   }
 }

package/publiccode.yml

@@ -81,8 +81,8 @@ maintenance:
 name: Masterportal
 platforms:
   - web
-releaseDate: '2026-04-10'
+releaseDate: '2026-06-11'
 roadmap: 'https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/src/master/'
 softwareType: api
-softwareVersion: 2.60.0
+softwareVersion: 2.62.0
 url: 'https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git'

package/src/api/ogcApiProcesses.js

@@ -202,7 +202,7 @@ async function jobResults (processUrl, jobId, format = "json") {
  * @param {number?} [pollParameters.timeout=5000] – how long to try polling in ms
  * @param {number?} [pollParameters.stallFor=100] – how long to wait between retries
  * @returns {object} job results as json
- * @throws
+ * @throws {Error}
  */
 async function pollJobResults (processUrl, jobId, {timeout = 5000, stallFor = 100} = {}) {
     const start = Date.now();

package/src/layer/vectorTile.js

@@ -141,7 +141,9 @@ export function createLayerSource (url, options = {}) {
  * @returns {void}
  */
 export function setStyle (layer, glStyle, {options = {}} = {}, url) {
-    if (url) {
+    const readStyleFromUrl = typeof options.readStyleFromUrl === "boolean" ? options.readStyleFromUrl : true;
+
+    if (url && readStyleFromUrl) {
         fetch(url)
             .then(response => response.json())
             .then(style => {
@@ -224,7 +226,7 @@ export function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {
     if (rawLayer.vtStyles) {
         const vtStyle = rawLayer.vtStyles.filter((style) => style.defaultStyle)[0] || rawLayer.vtStyles[0];
 
-        setStyle(layer, {}, {options: {layers: rawLayer.layers}}, vtStyle.url);
+        setStyle(layer, {}, {options: {layers: rawLayer.layers, readStyleFromUrl: options.readStyleFromUrl}}, vtStyle.url);
 
     }
     return layer;

package/src/maps/ol/olMap.js

@@ -146,16 +146,16 @@ Map.prototype.addLayer = addLayer;
  * @param {object} [settings.mapParams] - additional parameter object that is spread into the ol.Map constructor object
  * @param {function} [settings.callback] - optional callback for layer list loading
  * @param {function} [settings.errorCallback] – method called on error events
- * @param {String} [mapMode = "2D"] The map mode. '2D' to craete a 2D-map and '3D' to create a 3D-map.
+ * @param {class} [OlMap] - The OpenLayers map class
  * @returns {object} map object from ol
  */
-export function createMap (config = defaults, {mapParams, callback, errorCallback} = {}) {
+export function createMap (config = defaults, {mapParams, callback, errorCallback} = {}, OlMap = Map) {
     crs.registerProjections(config.namedProjections);
     setBackgroundImage(config);
     setGazetteerUrl(config.gazetteerUrl);
 
     const selectedInteractions = Object.assign({}, {dragPan: false, altShiftDragRotate: false, pinchRotate: false}, config.mapInteractions?.interactionModes),
-        map = new Map(Object.assign({
+        map = new OlMap(Object.assign({
             target: config.target || defaults.target,
             interactions: olDefaultInteractions(selectedInteractions).extend([
                 new DragPan({

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

@@ -1,4 +1,4 @@
-import OverlaySynchronizer from "olcs/lib/olcs/OverlaySynchronizer.js";
+import {OverlaySynchronizer} from "olcs";
 
 /**
  * Represents a FixedOverlaySynchronizer.

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

@@ -2,12 +2,11 @@
  * @module olcs.WMSRasterSynchronizer
  */
 import olLayerGroup from "ol/layer/Group.js";
-import {getUid} from "olcs/lib/olcs/util.js";
+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 AbstractSynchronizer from "olcs/lib/olcs/AbstractSynchronizer.js";
-import {extentToRectangle, tileLayerToImageryLayer, updateCesiumLayerProperties} from "olcs/lib/olcs/core.js";
+import {AbstractSynchronizer, extentToRectangle, tileLayerToImageryLayer, updateCesiumLayerProperties} from "olcs";
 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";
 import {transform, get} from "ol/proj.js";
-import VectorSynchronizer from "olcs/lib/olcs/VectorSynchronizer.js";
+import {VectorSynchronizer} from "olcs";
 
 import FixedOverlaySynchronizer from "./3dUtils/fixedOverlaySynchronizer.js";
 import WMSRasterSynchronizer from "./3dUtils/wmsRasterSynchronizer.js";

package/src/searchAddress/parse.js

@@ -1,11 +1,9 @@
-import xml2js from "xml2js";
-
 import {searchTypes} from "./types";
 import {getShowGeographicIdentifier} from "./showGeographicIdentifier";
 
 /**
- * Flattens xml2js result a little to avoid unnecessary one-element arrays.
- * NOTE currently keeping special properties ($, _) of xml2js to keep attributes.
+ * Flattens result a little to avoid unnecessary one-element arrays.
+ * NOTE currently keeping special properties ($, _) to keep attributes.
  * @param {*} a anything
  * @returns {*} a's first element if one-element array, else a
  * @ignore
@@ -40,7 +38,7 @@ function findKey (o, key) {
 
 /**
  * Simply copies over all properties it can find.
- * @param {object} entry xml2js-parsed result entry
+ * @param {object} entry parsed result entry
  * @returns {object} copied and flattened properties
  * @ignore
  */
@@ -73,7 +71,7 @@ function parseCoordinatesFromWkt (wkt) {
 
 /**
  * Parses result entries; uses type-specific rules to determine name/geometry.
- * @param {object} entry xml2js-parsed result entry
+ * @param {object} entry parsed result entry
  * @param {string} type type string
  * @returns {SearchResult} parsed search result for districts
  * @ignore
@@ -162,6 +160,72 @@ function parseEntry (entry, type) {
     return searchResult;
 }
 
+/**
+ * Converts a DOM element to an object structure.
+ * Strips namespace prefixes from tag names.
+ * @param {Element} node DOM element to convert
+ * @returns {object|string} converted object or text content
+ * @ignore
+ */
+function domNodeToObject (node) {
+    const elementChildren = Array.from(node.children),
+        obj = {};
+
+    // handle attributes
+    if (node.attributes.length > 0) {
+        obj.$ = {};
+        for (const attr of node.attributes) {
+            obj.$[attr.localName] = attr.value;
+        }
+    }
+
+    if (elementChildren.length === 0) {
+        const text = node.textContent?.trim() ?? "";
+
+        if (obj.$) {
+            obj._ = text;
+            return obj;
+        }
+        return text;
+    }
+
+    elementChildren.forEach(child => {
+        const key = child.localName,
+            value = domNodeToObject(child);
+
+        if (obj[key]) {
+            obj[key].push(value);
+        }
+        else {
+            obj[key] = [value];
+        }
+    });
+
+    return obj;
+}
+
+/**
+ * Parses an XML string using DOMParser.
+ * @param {string} xmlString xml to parse
+ * @returns {object} parsed object structure
+ * @ignore
+ */
+function parseXmlString (xmlString) {
+    const parser = new DOMParser(),
+        doc = parser.parseFromString(xmlString, "text/xml"),
+        parseError = doc.querySelector("parsererror");
+
+    if (parseError) {
+        throw new Error(`XML parse error: ${parseError.textContent}`);
+    }
+
+    const root = doc.documentElement,
+        result = {};
+
+    result[root.localName] = domNodeToObject(root);
+    return result;
+}
+
 /**
  * Parses gazetteer xml to search objects.
  * @param {string} key internal name for query froms searchTypes
@@ -171,26 +235,20 @@ function parseEntry (entry, type) {
  */
 export function parse (key, xmlString) {
     return new Promise((resolve, reject) => {
-        // tag processor "stripPrefix" removes e.g. "dog:" prefix on properties
-        xml2js.parseString(xmlString, {tagNameProcessors: [xml2js.processors.stripPrefix]},
-            (err, source) => {
-                if (err) {
-                    reject(err);
-                    return;
-                }
-
-                try {
-                    const searchResults = source.FeatureCollection?.member
-                        ? source.FeatureCollection.member
-                            .map(entry => parseEntry(entry, key))
-                            .sort((a, b) => a.name.localeCompare(b.name))
-                        : [];
-
-                    resolve(searchResults);
-                }
-                catch (e) {
-                    reject(e);
-                }
-            });
+        try {
+            const source = parseXmlString(xmlString),
+                searchResults = source.FeatureCollection?.member
+                    ? source.FeatureCollection.member
+                        .map(entry => parseEntry(entry, key))
+                        .sort((a, b) => a.name.localeCompare(b.name))
+                    : [];
+
+            resolve(searchResults);
+        }
+        catch (e) {
+            reject(e);
+        }
     });
 }
+
+

package/test/searchAddress/parse.test.js

@@ -106,5 +106,42 @@ describe("searchAddress", function () {
                     done();
                 });
         });
+
+        describe("domNodeToObject - strips namespace prefixes from tag names", () => {
+            it("should not contain colon in any parsed key", async () => {
+                const x = await parse(searchTypes.DISTRICT, gazetteerSearchResults.districtResult);
+                // eslint-disable-next-line func-style
+                const allKeys = (obj) => {
+                    if (typeof obj !== "object" || obj === null) {
+                        return [];
+                    }
+                    // eslint-disable-next-line max-nested-callbacks
+                    return Object.keys(obj).flatMap(k => [k, ...allKeys(obj[k])]);
+                };
+
+                allKeys(x[0]).forEach(key => {
+                    expect(key).not.toContain(":");
+                });
+            });
+
+            it("should parse namespace-prefixed XML and return localName as key", () => {
+                const parser = new DOMParser();
+                const xml = `
+                    <wfs:FeatureCollection xmlns:wfs="http://www.opengis.net/wfs"
+                                           xmlns:gml="http://www.opengis.net/gml">
+                        <wfs:member>
+                            <gml:Point>
+                                <gml:pos>10.0 53.5</gml:pos>
+                            </gml:Point>
+                        </wfs:member>
+                    </wfs:FeatureCollection>`;
+                const doc = parser.parseFromString(xml, "text/xml");
+
+                expect(doc.documentElement.localName).toBe("FeatureCollection");
+                expect(doc.documentElement.children[0].localName).toBe("member");
+                expect(doc.documentElement.children[0].children[0].localName).toBe("Point");
+                expect(doc.documentElement.children[0].children[0].children[0].localName).toBe("pos");
+            });
+        });
     });
 });

package/babel.config.json

@@ -1,6 +0,0 @@
-{
-  "presets": [],
-    "plugins": [
-        "@babel/plugin-transform-modules-commonjs"
-    ]
-  }