@masterportal/masterportalapi 2.51.0 → 2.52.0

package/CHANGELOG.md

@@ -2,8 +2,8 @@
  All important changes in this project are stored in this file.
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
-
-## Unreleased - in development
+ 
+ ## Unreleased - in development
 ### __Breaking Changes__
 
 ### Added
@@ -18,6 +18,17 @@
 
 ---
 
+## 2.52.0 - 2025-11-13
+
+### Added
+- wfs: Normalize WFS-T transaction XML to ensure WFS 2.0.0 compatibility.
+- OGC API: Added a polling function that polls until either result is ready or process failed.
+
+### Fixed
+- wfs: Fixed handling of the fetch option `credentials` for `loadWFSFilter`, `loadWFS`, and `getGeometryTypeFromWFS`.
+
+---
+
 ## 2.51.0 - 2025-09-18
 
 ### __Breaking Changes__

package/example/index.js

@@ -253,8 +253,14 @@ async function testOgcApiProcesses (processUrl) {
     console.log("Execute Process:", await window.mpapi.ogcApiProcesses.executeProcess(processUrl, processList[0].id, data)); // eslint-disable-line
 
     console.log("Job List:", jobList); // eslint-disable-line
+
+    // option one: check status and results separately
     console.log("Job Status of last job:", await window.mpapi.ogcApiProcesses.jobStatus(processUrl, jobList.at(-1).jobID)); // eslint-disable-line
     console.log("Job Results of last job:", await window.mpapi.ogcApiProcesses.jobResults(processUrl, jobList.at(-1).jobID)); // eslint-disable-line
+
+    // option two: poll until failure (throws) or success (returns results)
+    console.log("Job Results of last job:", await window.mpapi.ogcApiProcesses.pollJobResults(processUrl, jobList.at(-1).jobID)); // eslint-disable-line
+
     console.log("Cancle the last Job:", await window.mpapi.ogcApiProcesses.cancelJob(processUrl, jobList.at(-1).jobID)); // eslint-disable-line
     console.log("Job list:", await window.mpapi.ogcApiProcesses.jobList(processUrl)); // eslint-disable-line
 }

package/package.json

@@ -1,85 +1,85 @@
-{
-  "name": "@masterportal/masterportalapi",
-  "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.51.0",
-  "license": "MIT",
-  "description": "Basic functions of the Masterportal as api",
-  "repository": {
-    "type": "git",
-    "url": "git+https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git"
-  },
-  "source": "src/index.js",
-  "main": "src/index.js",
-  "exports": {
-    ".": "./src/index.js"
-  },
-  "targets": {
-    "library": {
-      "source": "src/index.js",
-      "distDir": "dist",
-      "outputFormat": "commonjs"
-    }
-  },
-  "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.33.1",
-    "dayjs": "^1.11.10",
-    "ol": "^10.6.0",
-    "ol-mapbox-style": "12.5.0",
-    "olcs": "^2.22.1",
-    "proj4": "^2.10.0",
-    "xml2js": "^0.6.2"
-  },
-  "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",
-    "assert": "^2.1.0",
-    "browserify-zlib": "^0.2.0",
-    "buffer": "^6.0.3",
-    "canvas": "3.2.0",
-    "eslint": "8.57.1",
-    "events": "^3.3.0",
-    "https-browserify": "^1.0.0",
-    "husky": "8.0.3",
-    "jest": "30.1.3",
-    "jest-canvas-mock": "2.5.2",
-    "jest-environment-jsdom": "30.1.2",
-    "jest-fetch-mock": "^3.0.3",
-    "jsdoc": "4.0.2",
-    "parcel": "^2.15.4",
-    "process": "^0.11.10",
-    "sass": "1.69.4",
-    "stream-browserify": "^3.0.0",
-    "stream-http": "^3.2.0",
-    "timers-browserify": "^2.0.12",
-    "url": "^0.11.3",
-    "use-resize-observer": "^9.1.0",
-    "util": "^0.12.5"
-  },
-  "peerDependencies": {
-    "@cesium/engine": "^20.0.1"
-  },
-  "engines": {
-    "node": "^22.19.0",
-    "npm": "^10.5.0"
-  },
-  "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.52.0",
+  "license": "MIT",
+  "description": "Basic functions of the Masterportal as api",
+  "repository": {
+    "type": "git",
+    "url": "git+https://bitbucket.org/geowerkstatt-hamburg/masterportalapi.git"
+  },
+  "source": "src/index.js",
+  "exports": {
+    ".": "./src/index.js"
+  },
+  "targets": {
+    "library": {
+      "source": "src/index.js",
+      "distDir": "dist",
+      "outputFormat": "commonjs"
+    }
+  },
+  "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.33.1",
+    "dayjs": "^1.11.10",
+    "ol": "^10.6.0",
+    "ol-mapbox-style": "12.5.0",
+    "olcs": "^2.22.1",
+    "proj4": "^2.10.0",
+    "xml2js": "^0.6.2"
+  },
+  "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",
+    "assert": "^2.1.0",
+    "browserify-zlib": "^0.2.0",
+    "buffer": "^6.0.3",
+    "canvas": "3.2.0",
+    "eslint": "8.57.1",
+    "events": "^3.3.0",
+    "https-browserify": "^1.0.0",
+    "husky": "8.0.3",
+    "jest": "30.1.3",
+    "jest-canvas-mock": "2.5.2",
+    "jest-environment-jsdom": "30.1.2",
+    "jest-fetch-mock": "^3.0.3",
+    "jsdoc": "4.0.2",
+    "parcel": "^2.15.4",
+    "process": "^0.11.10",
+    "sass": "1.69.4",
+    "stream-browserify": "^3.0.0",
+    "stream-http": "^3.2.0",
+    "timers-browserify": "^2.0.12",
+    "url": "^0.11.3",
+    "use-resize-observer": "^9.1.0",
+    "util": "^0.12.5"
+  },
+  "peerDependencies": {
+    "@cesium/engine": "^20.0.1"
+  },
+  "engines": {
+    "node": "^22.19.0",
+    "npm": "^10.5.0"
+  },
+  "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
+  "directories": {
+    "example": "example",
+    "test": "test"
+  },
+  "bugs": {
+    "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
+  },
+  "main": "jest.config.js"
+}

package/src/api/ogcApiProcesses.js

@@ -194,6 +194,39 @@ async function jobResults (processUrl, jobId, format = "json") {
     return responseJson;
 }
 
+/**
+ * Polls status for a job until it is successful and then returns its results.
+ * @param {string} processUrl – URL of the OGC API process
+ * @param {string} jobId – ID of the job to poll results to
+ * @param {object} pollParameters – how to poll
+ * @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
+ */
+async function pollJobResults (processUrl, jobId, {timeout = 5000, stallFor = 100} = {}) {
+    const start = Date.now();
+
+    // exit through throw/return/timeout
+    for (;;) {
+        const jobStatusResponse = await jobStatus(processUrl, jobId);
+
+        if (jobStatusResponse?.status === "successful") {
+            return jobResults(processUrl, jobId);
+        }
+
+        if (["failed", "dismissed"].includes(jobStatusResponse?.status)) {
+            throw new Error(`Polling job ${jobId} at ${processUrl} resulted in status "${jobStatusResponse?.status}".`);
+        }
+
+        if (Date.now() - start >= timeout) {
+            throw new Error(`Polling job ${jobId} at ${processUrl} timed out after ${timeout} ms with last status "${jobStatusResponse?.status}".`);
+        }
+
+        await new Promise(res => setTimeout(res, stallFor));
+    }
+}
+
 export default {
     processList,
     processDescription,
@@ -201,5 +234,6 @@ export default {
     jobList,
     cancelJob,
     jobStatus,
-    jobResults
+    jobResults,
+    pollJobResults
 };

package/src/layer/geojson/style.js

@@ -1,5 +1,5 @@
 import {Style, Icon, Stroke, Fill} from "ol/style.js";
-import markerSvg from "../../../public/marker.svg";
+
 
 let customStyles = {};
 
@@ -15,7 +15,7 @@ export function setCustomStyles (styles) {
 // // // STYLE PARTS
 const marker = new Icon({
         crossOrigin: "anonymous",
-        src: markerSvg,
+        src: "../../../public/marker.svg",
         // center bottom of marker 📍 is intended to show the spot
         anchor: [0.5, 1]
     }),

package/src/layer/wfs.js

@@ -81,7 +81,13 @@ function getFilterRequestParams (payload) {
  * @returns {void}
  */
 function loadWFS (url, params, source, {onErrorFn, success, failure}, options) {
-    fetch(url, params)
+    const xhrParameters = options?.loadingParams?.xhrParameters ?? {},
+        mergedParams = {
+            ...params,
+            ...xhrParameters
+        };
+
+    fetch(url, mergedParams)
         .then((response) => handleErrors(response, onErrorFn, options, failure))
         .then((response) => response.text())
         .then(responseString => source.getFormat().readFeatures(responseString))
@@ -175,13 +181,11 @@ function createLayerSource (rawLayer, options = {}) {
         }
         else {
             const bboxParam = options.loadingStrategy === bbox ? `&bbox=${extent.join(",")},${projection.getCode()}` : "";
-            let url = createUrl(rawLayer, version, projection, bboxParam),
-                params = {};
+            let url = createUrl(rawLayer, version, projection, bboxParam);
 
             if (options.loadingParams) {
                 for (const key in options.loadingParams) {
                     if (key === "xhrParameters") {
-                        params = options.loadingParams.xhrParameters;
                         continue;
                     }
                     const option = Array.isArray(options.loadingParams[key]) ? options.loadingParams[key].join(",") : options.loadingParams[key];
@@ -194,7 +198,7 @@ function createLayerSource (rawLayer, options = {}) {
                     }
                 }
             }
-            loadWFS(url, params, source, {onErrorFn: onError, success, failure}, options);
+            loadWFS(url, {}, source, {onErrorFn: onError, success, failure}, options);
         }
     }
     format.featureType = rawLayer.featureType;
@@ -266,6 +270,50 @@ function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {}) {
     return layer;
 }
 
+/**
+ * Ensures that the WFS-T transaction is compatible with a specific WFS version.
+ *
+ * Updates for WFS 2.0.0:
+ * - Filter needs fes namespace (Filter Encoding Standard)
+ * - Filter FeatureId (fid) must be replaced by ResourceId (rid)
+ *
+ * @param {string} version - WFS-T version
+ * @param {string} xml - Original WFS-T transaction xml
+ * @returns {string} Normalized WFS-T transaction xml
+ */
+function normalizeWfsTransaction (version, xml) {
+    if (version === "2.0.0") {
+        const domParser = new DOMParser(),
+            xmlDocument = domParser.parseFromString(xml, "application/xml");
+
+        xmlDocument.querySelectorAll("Filter").forEach(filterNode => {
+            const newFilter = xmlDocument.createElementNS("http://www.opengis.net/fes/2.0", "fes:Filter");
+
+            while (filterNode.firstChild) {
+                const child = filterNode.firstChild;
+
+                if (child.nodeType === 1 && child.localName === "FeatureId") {
+                    const fidAttribute = child.getAttribute("fid"),
+                        resourceIdNode = xmlDocument.createElementNS("http://www.opengis.net/fes/2.0", "fes:ResourceId");
+
+                    resourceIdNode.setAttribute("rid", fidAttribute);
+                    newFilter.appendChild(resourceIdNode);
+                    filterNode.removeChild(child);
+                }
+                else {
+                    newFilter.appendChild(child);
+                }
+            }
+
+            filterNode.parentNode.replaceChild(newFilter, filterNode);
+        });
+
+        return new XMLSerializer().serializeToString(xmlDocument);
+    }
+
+    return xml;
+}
+
 /**
  * Writes a wfs transaction including the given feature for given layer
  * inserting, updated or deleting the feature depending on the given selectedInteraction.
@@ -273,10 +321,9 @@ function createLayer (rawLayer = {}, {layerParams = {}, options = {}} = {}) {
  * @param {ol/Feature} feature Feature to be inserted, updated or deleted.
  * @param {Object} transactionOptions Information about the layer to be manipulated.
  * @param {string} transactionMethod Which transaction to perform. Possible values are: "insert"|"delete"|"selectedUpdate"
- * @param {string} srsName EPSG code currently used by the map.
+ * @param {string} version WFS-T version
  * @returns {string} WFS Transaction as an XML Node as String.
  */
-
 function writeTransactionBody (feature, transactionOptions, transactionMethod, version = "1.1.0") {
     const transactionPosition = {
             insert: 0,
@@ -290,9 +337,10 @@ function writeTransactionBody (feature, transactionOptions, transactionMethod, v
     }
 
     transaction[transactionPosition[transactionMethod]].push(feature);
-    return new XMLSerializer()
+
+    return normalizeWfsTransaction(version, new XMLSerializer()
         .serializeToString(new WFS({version})
-            .writeTransaction(...transaction, transactionOptions));
+            .writeTransaction(...transaction, transactionOptions)));
 }
 
 /**

package/src/vectorStyle/lib/getGeometryTypeFromService.js

@@ -130,11 +130,9 @@ function getGeometryTypeFromWFS (rules, wfsURL, version, featureType, styleGeome
     });
     url = url.slice(0, -1);
 
-
     return fetch(url, {
         method: "get",
-        withCredentials: isSecured,
-        responseType: "text"
+        credentials: isSecured ? "include" : "omit"
     }).then(response => response.text())
         .then(responseAsString => new window.DOMParser().parseFromString(responseAsString, "text/xml"))
         .then(responseXML => {

package/test/api/ogcApiProcesses.test.js

@@ -5,22 +5,26 @@ describe("ogcApiProcesses.js", () => {
         processId = "process-id",
         jobId = "job-id";
 
-    beforeEach(() => {
-        if (global.fetch) {
-            fetch.mockClear();
-        }
-
-        global.fetch = jest.fn().mockImplementationOnce(() => {
+    function mockFetch (returnValue = {}) {
+        global.fetch = jest.fn().mockImplementation(() => {
             return new Promise((resolve) => {
                 resolve({
                     ok: true,
                     status: 200,
                     json: () => {
-                        return {};
+                        return returnValue;
                     }
                 });
             });
         });
+    }
+
+    beforeEach(() => {
+        if (global.fetch) {
+            fetch.mockClear();
+        }
+
+        mockFetch();
     });
 
     describe("processList", () => {
@@ -110,4 +114,34 @@ describe("ogcApiProcesses.js", () => {
             expect(fetch).toHaveBeenCalledWith(`${processUrl}/jobs/${jobId}/results?f=html`, {method: "GET"});
         });
     });
+
+    describe("pollJobResults", () => {
+        it("returns job results when status is successful", async () => {
+            mockFetch({status: "successful", result: "It worked!"});
+
+            const result = await ogcApiProcesses.pollJobResults(processUrl, jobId);
+
+            expect(result).toEqual({result: "It worked!", status: "successful"});
+            expect(fetch).toHaveBeenCalledWith(`${processUrl}/jobs/${jobId}`, {method: "GET"});
+            expect(fetch).toHaveBeenCalledWith(`${processUrl}/jobs/${jobId}/results?f=json`, {method: "GET"});
+        });
+
+        it("throws error when status is failed", async () => {
+            mockFetch({status: "failed"});
+
+            await expect(ogcApiProcesses.pollJobResults(processUrl, jobId)).rejects.toThrow("Polling job job-id at https://example.de resulted in status \"failed\".");
+        });
+
+        it("throws error when status is dismissed", async () => {
+            mockFetch({status: "dismissed"});
+
+            await expect(ogcApiProcesses.pollJobResults(processUrl, jobId)).rejects.toThrow("Polling job job-id at https://example.de resulted in status \"dismissed\".");
+        });
+
+        it("throws error when polling times out", async () => {
+            mockFetch({status: "running"});
+
+            await expect(ogcApiProcesses.pollJobResults(processUrl, jobId, {timeout: 10, stallFor: 1})).rejects.toThrow(/timed out/);
+        });
+    });
 });

package/test/layer/wfs.test.js

@@ -676,6 +676,20 @@ describe("wfs.js", function () {
             expect(() => wfs.writeTransactionBody(feature, transactionOptions, "remove")).toThrow(Error);
             expect(() => wfs.writeTransactionBody(feature, transactionOptions, "remove")).toThrow("transactionMethod has to be \"insert\", \"selectedUpdate\" or \"delete\".");
         });
+
+        it("should change WFS-T 2.0.0 filter namespace to fes and filter featureId (fid) to resourceId (rid) for selectedUpdate", async () => {
+            const transactionBody = wfs.writeTransactionBody(feature, transactionOptions, "selectedUpdate", "2.0.0"),
+                expectedBody = "<Transaction xmlns=\"http://www.opengis.net/wfs/2.0\" service=\"WFS\" version=\"2.0.0\" xmlns:ns1=\"http://www.w3.org/2001/XMLSchema-instance\" ns1:schemaLocation=\"http://www.opengis.net/wfs/2.0 http://schemas.opengis.net/wfs/2.0/wfs.xsd\"><Update typeName=\"myPrefix:Polygon\" xmlns:myPrefix=\"myNS\"><Property><ValueReference>geometry</ValueReference><Value><Polygon xmlns=\"http://www.opengis.net/gml/3.2\" srsName=\"EPSG:4326\"><exterior><LinearRing srsName=\"EPSG:4326\"><posList srsDimension=\"2\">50.20836600730087 9.17782024967994 50.20836600730087 9.200676227149245 50.20873353776312 9.200676227149245 50.20873353776312 9.17782024967994 50.20836600730087 9.17782024967994</posList></LinearRing></exterior></Polygon></Value></Property><Property><ValueReference>name</ValueReference><Value>My Polygon</Value></Property><fes:Filter xmlns:fes=\"http://www.opengis.net/fes/2.0\"><fes:ResourceId rid=\"1\"/></fes:Filter></Update></Transaction>";
+
+            expect(transactionBody).toEqual(expectedBody);
+        });
+
+        it("should change WFS-T 2.0.0 filter namespace to fes and filter featureId (fid) to resourceId (rid) for delete", async () => {
+            const transactionBody = wfs.writeTransactionBody(feature, transactionOptions, "delete", "2.0.0"),
+                expectedBody = "<Transaction xmlns=\"http://www.opengis.net/wfs/2.0\" service=\"WFS\" version=\"2.0.0\" xmlns:ns1=\"http://www.w3.org/2001/XMLSchema-instance\" ns1:schemaLocation=\"http://www.opengis.net/wfs/2.0 http://schemas.opengis.net/wfs/2.0/wfs.xsd\"><Delete typeName=\"myPrefix:Polygon\" xmlns:myPrefix=\"myNS\"><fes:Filter xmlns:fes=\"http://www.opengis.net/fes/2.0\"><fes:ResourceId rid=\"1\"/></fes:Filter></Delete></Transaction>";
+
+            expect(transactionBody).toEqual(expectedBody);
+        });
     });
 
     describe("receivePossibleProperties", () => {