@masterportal/masterportalapi 2.11.0 → 2.13.0

package/CHANGELOG.md

@@ -3,6 +3,47 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+### Added
+### Changed
+- GeoJSON now also register a featuresloadend function if the source is a cluster.
+### Deprecated
+### Removed
+### Fixed
+
+---
+
+## 2.13.0 - 2022-02-16
+### Changed
+- GeoJSON now also register a featuresloadend function if the source is a cluster.
+
+---
+
+## 2.12.0 - 2022-01-24
+### Added
+- Added support for Node LTS version 18.
+- Add possibility to specify additional layerparams for a wmts layer, like opacity for example.
+- Add possibility to make a 3DTilset layer transparent/opaque.
+- In the gazetteer search the prefix `*` can now be switched off with the attribute `searchStreetBeforeWord`
+
+### Changed
+- The following packages have been updated:
+    - dependencies:
+        - core-js: 3.24.0 to 3.27.1
+        - proj4: 2.8.0 to 2.8.1
+    - devDependencies:
+        - @babel/core: 7.18.9 to 7.20.12
+        - @babel/plugin-transform-modules-commonjs: 7.18.6 to 7.20.11
+        - canvas: 2.9.3 to 2.11.0
+        - eslint: 8.20.0 to 8.31.0
+        - husky: 8.0.1 to 8.0.3
+        - jest: 28.1.3 to 29.3.1
+        - jest-environment-jsdom: 28.1.3 to 29.3.1
+        - jsdoc: 3.6.11 to 4.0.0
+        - sass: 1.54.0 to 1.57.1
+
+---
+
 ## 2.11.0 - 2022-11-24
 ### Added
 - crossOrigin settings can now be passed to WMSSources (TileWMS, ImageWMS) via config.json or services.json

package/License.txt

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2018-2020 Freie und Hansestadt Hamburg, Landesbetrieb Geoinformation und Vermessung
+Copyright (c) 2018-2023 Freie und Hansestadt Hamburg, Landesbetrieb Geoinformation und Vermessung
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/example/config/portal.json

@@ -31,5 +31,5 @@
       "id": "1001"
     }
   ],
-  "cesiumLib":"https://geoportal-hamburg.de/mastercode/cesium/1_95/Cesium.js"
+  "cesiumLib":"https://geoportal-hamburg.de/mastercode/cesium/1_99/Cesium.js"
 }

package/example/index.js

@@ -51,7 +51,7 @@ document.getElementById("enable").addEventListener("click", function () {
         document.getElementById("layer-visibility").style.display = "none";
     }
     else {
-        const lib = portalConfig.cesiumLib ? portalConfig.cesiumLib : "https://geoportal-hamburg.de/mastercode/cesium/1_95/index.js";
+        const lib = portalConfig.cesiumLib ? portalConfig.cesiumLib : "https://geoportal-hamburg.de/mastercode/cesium/1_99/index.js";
 
         document.getElementById("layer-visibility").style.display = "block";
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.11.0",
+  "version": "2.13.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -19,28 +19,28 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "core-js": "^3.24.0",
+    "core-js": "^3.27.1",
     "ol": "7.1.0",
     "olcs": "^2.13.1",
-    "proj4": "^2.8.0",
+    "proj4": "^2.8.1",
     "xml2js": "^0.4.23"
   },
   "devDependencies": {
-    "@babel/core": "^7.18.9",
-    "@babel/plugin-transform-modules-commonjs": "^7.18.6",
-    "@parcel/transformer-sass": "^2.6.2",
+    "@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.9.3",
-    "eslint": "^8.20.0",
+    "canvas": "^2.11.0",
+    "eslint": "^8.31.0",
     "events": "^3.3.0",
-    "husky": "^8.0.1",
-    "jest": "^28.1.3",
+    "husky": "^8.0.3",
+    "jest": "^29.3.1",
     "jest-canvas-mock": "^2.4.0",
-    "jest-environment-jsdom": "^28.1.3",
-    "jsdoc": "^3.6.11",
-    "parcel": "^2.6.2",
+    "jest-environment-jsdom": "^29.3.1",
+    "jsdoc": "^4.0.0",
+    "parcel": "^2.6.0",
     "process": "^0.11.10",
-    "sass": "^1.54.0",
+    "sass": "^1.57.1",
     "stream-browserify": "^3.0.0",
     "timers-browserify": "^2.0.12"
   },
@@ -48,12 +48,11 @@
     "cesium": "^1.95.0"
   },
   "engines": {
-    "node": "^16.13.2",
+    "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"
   },

package/src/layer/geojson/index.js

@@ -22,11 +22,11 @@ export function createLayerSource ({url, features, clusterDistance}, options) {
 
     source = createVectorSource(url || features, options.loadingStrategy, format);
 
-    if (clusterDistance) {
-        return createClusterVectorSource(source, clusterDistance, options.clusterGeometryFunction);
+    if (typeof clusterDistance === "number") {
+        source = createClusterVectorSource(source, clusterDistance, options.clusterGeometryFunction);
     }
 
-    source.once("featuresloadend", event => {
+    (typeof clusterDistance === "number" ? source.getSource() : source).once("featuresloadend", event => {
         if (typeof options.afterLoading === "function") {
             options.afterLoading(event?.features);
         }

package/src/layer/tileset.js

@@ -15,6 +15,7 @@ function createTileSet (rawLayer) {
     options.url = url;
     return new Cesium.Cesium3DTileset(options);
 }
+
 /**
  * Creates an terrain layer to use in ol-Cesium map. Sets the id of the rawlayer to tileset.layerReferenceId.
  * @param {Object} rawLayer - layer specification as in services.json
@@ -34,6 +35,30 @@ export default function Tileset (rawLayer) {
         this.tileset.layerReferenceId = rawLayer.id;
     }
 }
+
+/**
+ * Sets the opacity to the tilset.
+ * @param {Numbe} opacity the opacity
+ * @returns {void}
+ */
+Tileset.prototype.setOpacity = function (opacity) {
+    let color = "rgba(255, 255, 255, " + opacity + ")";
+
+    if (this.tileset.style !== undefined) {
+        const splitValues = this.tileset.style.style.color.split(",");
+
+        if (!splitValues[0].startsWith("rgba") && splitValues[0].startsWith("rgb")) {
+            splitValues[0] = splitValues[0].replace("rgb", "rgba");
+            splitValues[2] = splitValues[2].split(")")[0];
+        }
+
+        splitValues[3] = ` ${opacity})`;
+        color = splitValues.toString();
+    }
+
+    this.tileset.style = new Cesium.Cesium3DTileStyle({color});
+};
+
 /**
  *
  * @param {boolean} value  if true, terrainProvider is set to map and terrain will be visible
@@ -53,6 +78,7 @@ Tileset.prototype.setVisible = function (value, map) {
         }
     }
 };
+
 /**
  * Returns the value for the given key of the rawlayer.
  * @param {String} key to get the value for

package/src/layer/wmts.js

@@ -165,29 +165,30 @@ export function createLayerSourceByCapabilities (attrs, tileLayer) {
 
 /**
  * Creates the WMTSLayer.
- * @param {Object} attrs  attributes of the layer
+ * @param {object} rawLayer - layer specification as in services.json
+ * @param {object} layerParams - additional layer params
  * @returns {void}
  */
-export function createLayer (attrs) {
-    const tileLayer = new TileLayer({
-        id: attrs.id,
+export function createLayer (rawLayer, layerParams = {}) {
+    const tileLayer = new TileLayer(Object.assign({
+        id: rawLayer.id,
         source: new WMTS({}),
-        name: attrs.name,
-        minResolution: attrs.minScale,
-        maxResolution: attrs.maxScale,
+        name: rawLayer.name,
+        minResolution: rawLayer.minScale,
+        maxResolution: rawLayer.maxScale,
         supported: ["2D", "3D"],
         showSettings: true,
         extent: null,
-        typ: attrs.typ,
-        legendURL: attrs.legendURL,
-        infoFormat: attrs.infoFormat
-    });
+        typ: rawLayer.typ,
+        legendURL: rawLayer.legendURL,
+        infoFormat: rawLayer.infoFormat
+    }, layerParams));
 
-    if (attrs.optionsFromCapabilities === undefined) {
-        createLayerSourceByDefinitions(attrs, tileLayer);
+    if (rawLayer.optionsFromCapabilities === undefined) {
+        createLayerSourceByDefinitions(rawLayer, tileLayer);
     }
     else {
-        createLayerSourceByCapabilities(attrs, tileLayer);
+        createLayerSourceByCapabilities(rawLayer, tileLayer);
     }
 
     return tileLayer;

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

@@ -118,6 +118,9 @@ class WMSRasterSynchronizer extends olcsAbstractSynchronizer {
             provider = this.createProviderForStaticImageSource(source);
         }
         else if (source instanceof WMTS) {
+            if (typeof source.getUrls !== "function" || !Array.isArray(source.getUrls())) {
+                return null;
+            }
             provider = new Cesium.WebMapTileServiceImageryProvider({
                 url: source.getUrls()[0],
                 format: source.getFormat(),

package/src/searchAddress/search.js

@@ -12,12 +12,13 @@ let abortController = null;
  * @param {(string|string[])} values one or multiple strings, depending on type
  * @param {function} sortFunction a function with two parameters which can be used to sort all results
  * @param {function} filterFunction a function which will be executed to filter results
+ * @param {boolean} searchStreetBeforeWord whether to put an star in front of the search for streets (full text search)
  * @returns {Promise<SearchResult[]>} parsed response
  * @ignore
  */
-function searchAndParse (type, values, sortFunction = (a, b) => a.name.localeCompare(b.name), filterFunction = () => true) {
+function searchAndParse (type, values, sortFunction = (a, b) => a.name.localeCompare(b.name), filterFunction = () => true, searchStreetBeforeWord) {
     return new Promise((resolve, reject) => {
-        searchGazetteer(type, values, abortController)
+        searchGazetteer(type, values, abortController, searchStreetBeforeWord)
             .then(results => {
                 parse(type, results).then(parsed => {
                     resolve(parsed.filter(filterFunction)
@@ -33,12 +34,13 @@ function searchAndParse (type, values, sortFunction = (a, b) => a.name.localeCom
  * Combines streets with their available house numbers before returning.
  * @param {string} searchstring string to search for
  * @param {boolean} searchHouseNumbers whether to additionally search for house numbers
+ * @param {boolean} searchStreetBeforeWord whether to put an star in front of the search for streets (full text search)
  * @returns {Promise<SearchResult[]>} parsed response
  * @ignore
  */
-function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers) {
+function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers, searchStreetBeforeWord) {
     return new Promise((resolve, reject) => {
-        searchGazetteer(searchTypes.STREET, searchstring, abortController)
+        searchGazetteer(searchTypes.STREET, searchstring, abortController, searchStreetBeforeWord)
             .then(streetResults => parse(searchTypes.STREET, streetResults))
             .then(parsedStreetResults => {
                 const allSearches = [],
@@ -48,7 +50,7 @@ function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers) {
                     // put street in front of street's street+hnr as ordering
                     allSearches.push([parsedStreetResults[i]]);
                     if (searchHouseNumbers) {
-                        allSearches.push(searchAndParse(searchTypes.HOUSE_NUMBERS_FOR_STREET, parsedStreetResults[i].name));
+                        allSearches.push(searchAndParse(searchTypes.HOUSE_NUMBERS_FOR_STREET, parsedStreetResults[i].name, undefined, undefined, searchStreetBeforeWord));
                     }
                 }
 
@@ -56,7 +58,8 @@ function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers) {
                     allSearches.push(searchAndParse(searchTypes.HOUSE_NUMBERS_FOR_STREET,
                         matches[1],
                         (a, b) => parseInt(a.properties?.hausnummer, 10) - parseInt(b.properties?.hausnummer, 10),
-                        item => item.properties?.hausnummerkomplett?.indexOf(matches[2]) === 0)); // check longer housenumbers and suffixes!
+                        item => item.properties?.hausnummerkomplett?.indexOf(matches[2]) === 0, // check longer housenumbers and suffixes!,
+                        searchStreetBeforeWord));
                 }
 
                 return Promise.all(allSearches);
@@ -98,6 +101,7 @@ export function search (searchstring, params, abortPreviousSearch = false) {
                 zoomToParams,
                 searchAddress = false,
                 searchStreets = false,
+                searchStreetBeforeWord = true,
                 searchDistricts = false,
                 searchParcels = false,
                 searchStreetKey = false,
@@ -133,14 +137,23 @@ export function search (searchstring, params, abortPreviousSearch = false) {
         }
 
         if (searchStreets) {
-            searches.push(searchAndParseStreetAndHouseNumber(searchstring, searchHouseNumbers));
+            searches.push(searchAndParseStreetAndHouseNumber(searchstring, searchHouseNumbers, searchStreetBeforeWord));
         }
 
         if (searchAddress) {
             // assume pattern like "Streetname 41b", split to ["Streetname", "41", "b"]
-            const values = searchstring.split(/(\d+)/).map(s => s.trim()).filter(x => x),
-                // if neither two (no affix like b) or three (with affix like b) parts found, not enough (or too many) params for method - don't search
-                type = [false, false, searchTypes.ADDRESS_UNAFFIXED, searchTypes.ADDRESS_AFFIXED][values.length];
+            let values = searchstring.split(/(\d+)/).map(s => s.trim()).filter(x => x);
+
+            if (values.length > 3) {
+                const streetName = values[0],
+                    houseNum = values[1],
+                    appendix = searchstring.replace(values[0], "").replace(values[1], "").trim();
+
+                values = [streetName, houseNum, appendix];
+            }
+
+            // if neither two (no affix like b) or three (with affix like b) parts found, not enough (or too many) params for method - don't search
+            const type = [false, false, searchTypes.ADDRESS_UNAFFIXED, searchTypes.ADDRESS_AFFIXED][values.length];
 
             if (type) {
                 searches.push(searchAndParse(type, values));

package/src/searchAddress/searchGazetteer.js

@@ -16,11 +16,12 @@ export function encode (v) {
  * @param {string} key internal name for query froms searchTypes
  * @param {(string[]|string)} v string for single-value queries, string[] for multi-value queries, strings in order of appearance in URL
  * @returns {string} URL query part like "&StoryQuery_ID=queryName&param=value"
+ * @param {boolean} searchStreetBeforeWord whether to put an star in front of the search for streets (full text search)
  * @ignore
  */
-export function getIdQuery (key, v) {
+export function getIdQuery (key, v, searchStreetBeforeWord = true) {
     return {
-        [searchTypes.STREET]: encodedValue => `&StoredQuery_ID=findeStrasse&strassenname=*${encodedValue}`,
+        [searchTypes.STREET]: encodedValue => searchStreetBeforeWord ? `&StoredQuery_ID=findeStrasse&strassenname=*${encodedValue}` : `&StoredQuery_ID=findeStrasse&strassenname=${encodedValue}`,
         [searchTypes.DISTRICT]: encodedValue => `&StoredQuery_ID=findeStadtteil&stadtteilname=${encodedValue}`,
         [searchTypes.PARCEL]: encodedValue => `&StoredQuery_ID=Flurstueck&gemarkung=${encodedValue[0]}&flurstuecksnummer=${encodedValue[1]}`,
         [searchTypes.STREET_KEY]: encodedValue => `&StoredQuery_ID=findeStrassenSchluessel&strassenschluessel=${encodedValue}`,
@@ -35,12 +36,13 @@ export function getIdQuery (key, v) {
  * @param {string} key internal name for query froms searchTypes
  * @param {(string[]|string)} value value to search for
  * @param {AbortController} abortController the controller to abort the search
+ * @param {boolean} searchStreetBeforeWord whether to put an star in front of the search for streets (full text search)
  * @returns {Promise<string>} xhr response text
  * @ignore
  */
-export function searchGazetteer (key, value, abortController) {
+export function searchGazetteer (key, value, abortController, searchStreetBeforeWord) {
     return new Promise((resolve, reject) => {
-        const url = getGazetteerUrl() + getIdQuery(key, value);
+        const url = getGazetteerUrl() + getIdQuery(key, value, searchStreetBeforeWord);
 
         fetch(url, {
             signal: abortController?.signal,

package/test/layer/tileset.test.js

@@ -7,6 +7,7 @@ describe("tileset.js", function () {
     beforeEach(() => {
         global.Cesium = {};
         global.Cesium.Cesium3DTileset = jest.fn();
+        global.Cesium.Cesium3DTileStyle = jest.fn(color => color);
         attr = {
             id: "4002",
             name: "Gebäude LoD2",
@@ -68,6 +69,15 @@ describe("tileset.js", function () {
             expect(cesium3DTilesetSpy).toHaveBeenCalledTimes(2);
         });
     });
+    describe("setOpacity", function () {
+        it("calls setOpacity sets opacity to terrain style", function () {
+            const layer = new Tileset(attr, map);
+
+            layer.setOpacity(0.5);
+
+            expect(layer.tileset.style).toEqual({color: "rgba(255, 255, 255, 0.5)"});
+        });
+    });
     describe("setVisible", function () {
         it("calls setVisible without map shall not fail", function () {
             const layer = new Tileset(attr, map);

package/test/searchAddress/search.test.js

@@ -33,7 +33,7 @@ jest.mock("../../src/searchAddress/searchGazetteer", () => {
 
 import {searchGazetteer as mockedSearchGazetteer} from "../../src/searchAddress/searchGazetteer";
 
-describe("searchAddress", function () {
+describe.only("searchAddress", function () {
     describe("search", function () {
         it("rejects if missing configuration of what to search for", function (done) {
             search("Pflugacker", {}).catch(e => {
@@ -77,15 +77,15 @@ describe("searchAddress", function () {
                 .then(results => {
                     // order of calls may vary, hence using expect.arrayContaining
                     const expected = [
-                        [types.ADDRESS_UNAFFIXED, ["Address", "7"], abortController],
-                        [types.ADDRESS_AFFIXED, ["Address", "7", "b"], abortController],
-                        [types.STREET, "Streetname", abortController],
-                        [types.STREET, "StreetnameAndHnrs", abortController],
-                        [types.HOUSE_NUMBERS_FOR_STREET, "Bargkoppelweg", abortController],
-                        [types.DISTRICT, "Districtname", abortController],
-                        [types.PARCEL, ["1234", "1234"], abortController],
-                        [types.PARCEL, ["1234", "5678"], abortController],
-                        [types.STREET_KEY, "A12345", abortController]
+                        [types.ADDRESS_UNAFFIXED, ["Address", "7"], abortController, undefined],
+                        [types.ADDRESS_AFFIXED, ["Address", "7", "b"], abortController, undefined],
+                        [types.STREET, "Streetname", abortController, true],
+                        [types.STREET, "StreetnameAndHnrs", abortController, true],
+                        [types.HOUSE_NUMBERS_FOR_STREET, "Bargkoppelweg", abortController, true],
+                        [types.DISTRICT, "Districtname", abortController, undefined],
+                        [types.PARCEL, ["1234", "1234"], abortController, undefined],
+                        [types.PARCEL, ["1234", "5678"], abortController, undefined],
+                        [types.STREET_KEY, "A12345", abortController, undefined]
                     ];
 
                     expect(results[0]).toHaveLength(1);

package/test/searchAddress/searchGazetteer.test.js

@@ -15,7 +15,8 @@ describe("searchAddress", function () {
 
     describe("getIdQuery", function () {
         it("encodes given search phrase(s) and builds query fragment from it", function () {
-            expect(getIdQuery(searchTypes.STREET, "hello world")).toEqual("&StoredQuery_ID=findeStrasse&strassenname=*hello%20world");
+            expect(getIdQuery(searchTypes.STREET, "hello world", true)).toEqual("&StoredQuery_ID=findeStrasse&strassenname=*hello%20world");
+            expect(getIdQuery(searchTypes.STREET, "hello world", false)).toEqual("&StoredQuery_ID=findeStrasse&strassenname=hello%20world");
             expect(getIdQuery(searchTypes.DISTRICT, "hello world")).toEqual("&StoredQuery_ID=findeStadtteil&stadtteilname=hello%20world");
             expect(getIdQuery(searchTypes.PARCEL, ["1 a", "1 b"])).toEqual("&StoredQuery_ID=Flurstueck&gemarkung=1%20a&flurstuecksnummer=1%20b");
             expect(getIdQuery(searchTypes.STREET_KEY, "A12345")).toEqual("&StoredQuery_ID=findeStrassenSchluessel&strassenschluessel=A12345");