@masterportal/masterportalapi 2.9.0 → 2.11.0

package/CHANGELOG.md

@@ -3,30 +3,27 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
-## Unreleased - in development
+## 2.11.0 - 2022-11-24
 ### Added
-
-### Changed
-
-### Deprecated
-
-### Removed
+- crossOrigin settings can now be passed to WMSSources (TileWMS, ImageWMS) via config.json or services.json
 
 ### Fixed
+- Issue #847(Masterportal): searchAddress now keeps searching for house numbers if a digit was entered at the end of the search string
 
 ---
 
-## 2.9.0 - 2022-10-25
+## 2.10.0 - 2022-11-03
 ### Added
+- DPS-1313: Added custom DragPan interaction to add ability to use 2-Finger-Pan instead of 1-Finger-Pan on mobile devices
 
 ### Changed
-- Exports in src/rawLayerList and src/crs.js changed to module.exports to provide the possibility to stub the functions with sinon in masterportal.
+- Exports in src/rawLayerList, src/crs.js and src/lib/load3DScript.js changed to export default {} to provide  ES-Syntax.
 
-### Deprecated
-
-### Removed
+---
 
-### Fixed
+## 2.9.0 - 2022-10-25
+### Changed
+- Exports in src/rawLayerList and src/crs.js changed to module.exports to provide the possibility to stub the functions with sinon in masterportal.
 
 ---
 

package/example/index.js

@@ -4,12 +4,12 @@ import {Style, Stroke, Fill, Icon} from "ol/style.js";
 
 import * as mpapi from "../src";
 import mapsAPI from "../src/maps/api.js";
-import {getLayerWhere} from "../src/rawLayerList";
+import rawLayerList from "../src/rawLayerList";
 
 import services from "./config/services.json";
 import portalConfig from "./config/portal.json";
 import localGeoJSON from "./config/localGeoJSON.js";
-import {load3DScript} from "../src/lib/load3DScript";
+import load3DScriptModule from "../src/lib/load3DScript";
 
 function errorCallback (errorEvent) {
     console.error("This is an error event:", errorEvent);
@@ -55,7 +55,7 @@ document.getElementById("enable").addEventListener("click", function () {
 
         document.getElementById("layer-visibility").style.display = "block";
 
-        load3DScript(lib, function Loaded3DCallback () {
+        load3DScriptModule.load3DScript(lib, function Loaded3DCallback () {
             let tilesetLayer = null;
 
             const settings3D = {
@@ -71,9 +71,9 @@ document.getElementById("enable").addEventListener("click", function () {
                     }
                 },
                 map3D = mapsAPI.map.createMap(settings3D, "3D"),
-                rawLayerTerrain = getLayerWhere({id: "4001"}),
-                rawLayerTileset = getLayerWhere({id: "4002"}),
-                rawLayerEntities = getLayerWhere({id: "4003"});
+                rawLayerTerrain = rawLayerList.getLayerWhere({id: "4001"}),
+                rawLayerTileset = rawLayerList.getLayerWhere({id: "4002"}),
+                rawLayerEntities = rawLayerList.getLayerWhere({id: "4003"});
 
             window.mpapi.map = map3D;
             tilesetLayer = new mpapi.Tileset(rawLayerTileset, window.mpapi.map);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.9.0",
+  "version": "2.11.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -53,6 +53,7 @@
   },
   "homepage": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi#readme",
   "directories": {
+    "doc": "docs",
     "example": "example",
     "test": "test"
   },

package/src/crs.js

@@ -121,7 +121,7 @@ function transformFromMapProjection (map, targetProjection, point) {
     return transform(getMapProjection(map), targetProjection, point);
 }
 
-module.exports = {
+export default {
     transformFromMapProjection,
     transformToMapProjection,
     transform,

package/src/index.js

@@ -1,6 +1,6 @@
 import {createMapView} from "./maps/mapView";
-import * as crs from "./crs";
-import * as rawLayerList from "./rawLayerList";
+import crs from "./crs";
+import rawLayerList from "./rawLayerList";
 import * as wms from "./layer/wms";
 import * as wmts from "./layer/wmts";
 import * as wfs from "./layer/wfs";

package/src/layer/wms.js

@@ -5,7 +5,7 @@ import TileGrid from "ol/tilegrid/TileGrid";
 import ImageWMS from "ol/source/ImageWMS.js";
 import {get as getProjection} from "ol/proj";
 
-import {rawLayerList} from "../index.js";
+import rawLayerList from "../rawLayerList";
 
 const OLCS_DEFAULT_OLCS_PROJECTION_CRS = "EPSG:3857";
 
@@ -82,6 +82,7 @@ export function makeParams (rawLayer) {
  * @param {string} [rawLayer.gutter] - optional the size in pixels of the gutter around image tiles to ignore
  * @param {function} [rawLayer.olAttribution] - optional function that takes a module:ol/Map~FrameState and returns a string or an array of strings representing source attributions
  * @param {string|number} [rawLayer.tilesize] - optional needed to create the tileGrid
+ * @param {string|"anonymous"} [rawLayer.crossOrigin] - optional needed for CORS requests of image data, to enable canvas export
  * @param {object} options - optional resolutions and origin to create the TileGrid
  * @param {Array} [options.resolutions] - optional resolutions to create the TileGrid, must be in descending order
  * @param {Array} [options.origin] - optional origin to create the TileGrid
@@ -99,7 +100,8 @@ export function createLayerSource (rawLayer, options) {
             params,
             serverType: rawLayer.serverType,
             projection: projection,
-            attributions: rawLayer.olAttribution
+            attributions: rawLayer.olAttribution,
+            crossOrigin: rawLayer.crossOrigin
         });
     }
     if (options && options.resolutions) {
@@ -115,7 +117,8 @@ export function createLayerSource (rawLayer, options) {
         gutter: rawLayer.gutter || 0,
         tileGrid: tileGrid,
         projection: projection,
-        attributions: rawLayer.olAttribution
+        attributions: rawLayer.olAttribution,
+        crossOrigin: rawLayer.crossOrigin
     });
 }
 
@@ -130,6 +133,7 @@ export function createLayerSource (rawLayer, options) {
  * @param {string} [rawLayer.gutter] - optional the size in pixels of the gutter around image tiles to ignore
  * @param {function} [rawLayer.olAttribution] - optional function that takes a module:ol/Map~FrameState and returns a string or an array of strings representing source attributions
  * @param {string|number} [rawLayer.tilesize] - optional needed to create the tileGrid
+ * @param {string|"anonymous"} [rawLayer.crossOrigin] - optional needed for CORS requests of image data, to enable canvas export
  * @param {object} layerParams - additional layer params
  * @param {object} options - optional resolutions and origin to create the TileGrid
  * @param {Array} [options.resolutions] - optional resolutions to create the TileGrid, must be in descending order

package/src/lib/load3DScript.js

@@ -4,7 +4,7 @@
  * @param {Function} callback - the Function to call after loading has completed
  * @returns {undefined}
  */
-export function load3DScript (fileName, callback) {
+function load3DScript (fileName, callback) {
     const head = document.getElementsByTagName("head")[0],
         script = document.createElement("script");
 
@@ -20,3 +20,7 @@ export function load3DScript (fileName, callback) {
     };
     head.appendChild(script);
 }
+
+export default {
+    load3DScript
+};

package/src/maps/ol/olMap.js

@@ -1,5 +1,5 @@
 import {Map} from "ol";
-import {defaults as olDefaultInteractions} from "ol/interaction.js";
+import {DragPan, defaults as olDefaultInteractions} from "ol/interaction.js";
 import setBackgroundImage from "../../lib/setBackgroundImage";
 import getInitialLayers from "../../lib/getInitialLayers";
 import defaults from "../../defaults";
@@ -11,8 +11,8 @@ import * as vectorBase from "../../layer/vectorBase";
 import * as vectortile from "../../layer/vectorTile";
 import * as oaf from "../../layer/oaf";
 import {createMapView} from "../../maps/mapView";
-import {rawLayerList} from "../../index.js";
-import {registerProjections} from "../../crs";
+import rawLayerList from "../../rawLayerList";
+import crs from "../../crs";
 import {setGazetteerUrl} from "../../searchAddress";
 
 let mapIdCounter = 0;
@@ -146,12 +146,18 @@ Map.prototype.addLayer = addLayer;
  * @returns {object} map object from ol
  */
 export function createMap (config = defaults, {mapParams, callback, errorCallback} = {}) {
-    registerProjections(config.namedProjections);
+    crs.registerProjections(config.namedProjections);
     setBackgroundImage(config);
     setGazetteerUrl(config.gazetteerUrl);
     const map = new Map(Object.assign({
         target: config.target || defaults.target,
-        interactions: olDefaultInteractions({altShiftDragRotate: false, pinchRotate: false}),
+        interactions: olDefaultInteractions({dragPan: false, altShiftDragRotate: false, pinchRotate: false}).extend([
+            new DragPan({
+                condition: function (event) {
+                    return (!event.originalEvent.pointerType || event.originalEvent.pointerType === "mouse") || (config.twoFingerPan && this.getPointerCount() === 2) || !config.twoFingerPan;
+                }
+            })
+        ]),
         controls: [],
         view: createMapView(config)
     }, mapParams));

package/src/rawLayerList.js

@@ -88,7 +88,7 @@ function getDisplayNamesOfFeatureAttributes (layerId, featureAttribute) {
 }
 
 
-module.exports = {
+export default {
     getLayerWhere,
     getDisplayNamesOfFeatureAttributes,
     initializeLayerList,

package/src/searchAddress/search.js

@@ -10,16 +10,19 @@ let abortController = null;
  * Chains gazetteer request and response parser.
  * @param {string} type from searchTypes
  * @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
  * @returns {Promise<SearchResult[]>} parsed response
  * @ignore
  */
-function searchAndParse (type, values) {
+function searchAndParse (type, values, sortFunction = (a, b) => a.name.localeCompare(b.name), filterFunction = () => true) {
     return new Promise((resolve, reject) => {
         searchGazetteer(type, values, abortController)
             .then(results => {
-                const parsed = parse(type, results);
-
-                resolve(parsed);
+                parse(type, results).then(parsed => {
+                    resolve(parsed.filter(filterFunction)
+                        .sort(sortFunction));
+                });
             })
             .catch(e => reject(e));
     });
@@ -38,7 +41,8 @@ function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers) {
         searchGazetteer(searchTypes.STREET, searchstring, abortController)
             .then(streetResults => parse(searchTypes.STREET, streetResults))
             .then(parsedStreetResults => {
-                const allSearches = [];
+                const allSearches = [],
+                    matches = searchstring.match(new RegExp("^(.+)[\\s,](\\d+|\\d.*)$"));
 
                 for (let i = 0; i < parsedStreetResults.length; i++) {
                     // put street in front of street's street+hnr as ordering
@@ -48,6 +52,13 @@ function searchAndParseStreetAndHouseNumber (searchstring, searchHouseNumbers) {
                     }
                 }
 
+                if (!parsedStreetResults.length && matches?.length && 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!
+                }
+
                 return Promise.all(allSearches);
             })
             .then(allResults => resolve([].concat(...allResults)))

package/test/crs.test.js

@@ -1,7 +1,7 @@
 import {Map, View} from "ol";
 import proj4 from "proj4";
 import * as Proj from "ol/proj.js";
-import * as crs from "../src/crs";
+import crs from "../src/crs";
 
 const namedProjections = [
     ["EPSG:31467", "+title=Bessel/Gauß-Krüger 3 +proj=tmerc +lat_0=0 +lon_0=9 +k=1 +x_0=3500000 +y_0=0 +ellps=bessel +datum=potsdam +units=m +no_defs"],

package/test/layer/vectorTile.test.js

@@ -6,7 +6,7 @@ import {Feature} from "ol";
 import Polygon from "ol/geom/Polygon";
 
 import * as vectorTile from "../../src/layer/vectorTile";
-import {registerProjections} from "../../src/crs";
+import crs from "../../src/crs";
 import defaults from "../../src/defaults";
 
 jest.mock("../../src/rawLayerList.js", () => {
@@ -18,7 +18,7 @@ jest.mock("../../src/rawLayerList.js", () => {
 
 describe("vectorTile.js", function () {
 
-    beforeAll(() => registerProjections());
+    beforeAll(() => crs.registerProjections());
 
     const layerParams = {
             name: "VT Test",

package/test/layer/wms.test.js

@@ -111,6 +111,16 @@ describe("wms.js", function () {
 
             expect(source).toBeInstanceOf(ImageWMS);
         });
+        it("creates a LayerSource with crossOrigin set to 'anonymous'", function () {
+            // only relevant for TileWMS and ImageWMS instances
+            const
+                tileWMS = wms.createLayerSource({singleTile: false, crossOrigin: "anonymous"}),
+                imageWMS = wms.createLayerSource({singleTile: true, crossOrigin: "anonymous"});
+
+            // eslint-disable-next-line no-underscore-dangle
+            expect(imageWMS.crossOrigin_).toEqual("anonymous");
+            expect(tileWMS.crossOrigin).toEqual("anonymous");
+        });
     });
     describe("createLayerSource with a tileGrid", function () {
         function attrFunction () {

package/test/map.test.js

@@ -2,12 +2,12 @@ import {Map} from "ol";
 import TileLayer from "ol/layer/Tile";
 import map from "../src/maps/map.js";
 import {createMap as create3DMap} from "../src/maps/olcs/olcsMap.js";
-import {initializeLayerList} from "../src/rawLayerList.js";
-import {registerProjections} from "../src/crs.js";
+import rawLayerList from "../src/rawLayerList.js";
+import crs from "../src/crs.js";
 import setBackgroundImage from "../src/lib/setBackgroundImage.js";
 import {createMapView} from "../src/maps/mapView";
 import defaults from "../src/defaults";
-import {load3DScript} from "../src/lib/load3DScript";
+import load3DScriptModule from "../src/lib/load3DScript";
 
 /*
  * This test is mocking a lot to check what functions are called with.
@@ -15,18 +15,23 @@ import {load3DScript} from "../src/lib/load3DScript";
  */
 jest.mock("ol");
 jest.mock("../src/rawLayerList.js", () => {
-    const original = jest.requireActual("../src/rawLayerList.js");
-
-    original.getLayerWhere = ({id}) => ({
-        exists: {
-            typ: "doesntExist"
-        },
-        works: {
-            typ: "WMS"
+    const originalModule = jest.requireActual("../src/rawLayerList.js");
+
+    return {
+        __esModule: true,
+        ...originalModule,
+        default: {
+            getLayerWhere: ({id}) => ({
+                exists: {
+                    typ: "doesntExist"
+                },
+                works: {
+                    typ: "WMS"
+                }
+            })[id],
+            initializeLayerList: jest.fn()
         }
-    })[id];
-    original.initializeLayerList = jest.fn();
-    return original;
+    };
 });
 jest.mock("../src/crs.js");
 jest.mock("../src/lib/setBackgroundImage.js");
@@ -38,8 +43,8 @@ describe("map.js", function () {
             const callback = jest.fn();
 
             map.createMap(defaults, "2D", {mapParams: {}, callback: callback});
-            expect(initializeLayerList).toHaveBeenCalledWith(defaults.layerConf, expect.any(Function));
-            expect(registerProjections).toHaveBeenCalledWith(defaults.namedProjections);
+            expect(rawLayerList.initializeLayerList).toHaveBeenCalledWith(defaults.layerConf, expect.any(Function));
+            expect(crs.registerProjections).toHaveBeenCalledWith(defaults.namedProjections);
             expect(setBackgroundImage).toHaveBeenCalledWith(defaults);
         });
 
@@ -70,7 +75,7 @@ describe("map.js", function () {
                 cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
             };
 
-            load3DScript(config.cesiumLib, function Loaded3DCallback () {
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
                 const map3D = map.createMap(config, "3D");
 
                 expect(create3DMap).toHaveBeenCalledWith(defaults);
@@ -163,7 +168,7 @@ describe("map.js", function () {
                 cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
             };
 
-            load3DScript(config.cesiumLib, function Loaded3DCallback () {
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
                 const map3D = map.createMap(config, "3D");
 
                 expect(map3D.mapMode).toBe("3D");
@@ -198,7 +203,7 @@ describe("map.js", function () {
                 cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
             };
 
-            load3DScript(config.cesiumLib, function Loaded3DCallback () {
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
                 const map3D = map.createMap(config, "3D");
 
                 expect(map3D.mapMode).toBe("3D");
@@ -243,7 +248,7 @@ describe("map.js", function () {
                 cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
             };
 
-            load3DScript(config.cesiumLib, function Loaded3DCallback () {
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
                 const map3D = map.createMap(config, "3D");
 
                 expect(map3D.mapMode).toBe("3D");
@@ -279,7 +284,7 @@ describe("map.js", function () {
                 cesiumLib: "https://lib.virtualcitymap.de/v3.6.x/lib/Cesium/Cesium.js"
             };
 
-            load3DScript(config.cesiumLib, function Loaded3DCallback () {
+            load3DScriptModule.load3DScript(config.cesiumLib, function Loaded3DCallback () {
                 const map3D = map.createMap(config, "3D");
 
                 expect(map3D.mapMode).toBe("3D");

package/test/rawLayerList.test.js

@@ -1,4 +1,4 @@
-import * as rll from "../src/rawLayerList";
+import rll from "../src/rawLayerList";
 
 const symbol = Symbol(),
     services = [