@masterportal/masterportalapi 2.8.0 → 2.10.0

package/CHANGELOG.md

@@ -14,6 +14,34 @@
 
 ### Fixed
 
+---
+## 2.10.0 - 2022-03-11
+### 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, 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
+### Added
+
+### 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.
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
 ---
 
 ## 2.8.0 - 2022-10-04

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.8.0",
+  "version": "2.10.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -58,9 +58,5 @@
   },
   "bugs": {
     "url": "https://bitbucket.org/geowerkstatt-hamburg/masterportalapi/issues"
-  },
-  "keywords": [
-    "geo",
-    "map"
-  ]
+  }
 }

package/src/crs.js

@@ -22,7 +22,7 @@ function addAliasForWFSFromGeoserver (epsgCode) {
  * @param {string} name - projection name as written in [0] position of namedProjections
  * @returns {(object|undefined)} proj4 projection object or undefined
  */
-export function getProjection (name) {
+function getProjection (name) {
     return proj4.defs(name);
 }
 
@@ -33,7 +33,7 @@ export function getProjection (name) {
     ]] - projection name, projection definition string
  * @returns {undefined}
  */
-export function registerProjections (namedProjections = defaults.namedProjections) {
+function registerProjections (namedProjections = defaults.namedProjections) {
     proj4.defs(namedProjections);
     register(proj4);
     namedProjections.forEach(projection => {
@@ -48,7 +48,7 @@ export function registerProjections (namedProjections = defaults.namedProjection
  * Returns all known projections.
  * @returns {object[]} array of projection objects with their name added
  */
-export function getProjections () {
+function getProjections () {
     const projections = Object
         .keys(proj4.defs)
         .map(name => Object.assign(proj4.defs(name), {name}));
@@ -64,7 +64,7 @@ export function getProjections () {
  * @param {ol.Map} map - map to get projection of
  * @returns {string} active projection name of map
  */
-export function getMapProjection (map) {
+function getMapProjection (map) {
     return map.getView().getProjection().getCode();
 }
 
@@ -87,7 +87,7 @@ function getProj4Projection (projection) {
  * @param {number[]} point - point to project
  * @returns {number[]|undefined} transformed point
  */
-export function transform (sourceProjection, targetProjection, point) {
+function transform (sourceProjection, targetProjection, point) {
     const source = getProj4Projection(sourceProjection),
         target = getProj4Projection(targetProjection);
 
@@ -106,7 +106,7 @@ export function transform (sourceProjection, targetProjection, point) {
  * @param {number[]} point - point to project
  * @returns {number[]|undefined} new point or undefined
  */
-export function transformToMapProjection (map, sourceProjection, point) {
+function transformToMapProjection (map, sourceProjection, point) {
     return transform(sourceProjection, getMapProjection(map), point);
 }
 
@@ -117,6 +117,16 @@ export function transformToMapProjection (map, sourceProjection, point) {
  * @param {number[]} point - point to project
  * @returns {(number[]|undefined)} new point or undefined
  */
-export function transformFromMapProjection (map, targetProjection, point) {
+function transformFromMapProjection (map, targetProjection, point) {
     return transform(getMapProjection(map), targetProjection, point);
 }
+
+export default {
+    transformFromMapProjection,
+    transformToMapProjection,
+    transform,
+    getMapProjection,
+    getProjections,
+    registerProjections,
+    getProjection
+};

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 {getLayerWhere} from "../rawLayerList";
+import rawLayerList from "../rawLayerList";
 
 const OLCS_DEFAULT_OLCS_PROJECTION_CRS = "EPSG:3857";
 
@@ -176,7 +176,7 @@ export function updateSource (layer) {
  * @returns {(string|undefined)} the gfiURL, or undefined if it could not be constructed
  */
 export function getGfiURL (layer, map, coordinate) {
-    const rawLayer = getLayerWhere({Id: layer.get("id")}),
+    const rawLayer = rawLayerList.getLayerWhere({Id: layer.get("id")}),
         resolution = map.getView().getResolution(),
         projection = map.getView().getProjection(),
         params = Object.assign({

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 {initializeLayerList, getLayerWhere} from "../../rawLayerList";
-import {registerProjections} from "../../crs";
+import rawLayerList from "../../rawLayerList";
+import crs from "../../crs";
 import {setGazetteerUrl} from "../../searchAddress";
 
 let mapIdCounter = 0;
@@ -97,7 +97,7 @@ function addLayer (layerOrId, params = {visibility: true, transparency: 0, error
 
     // if parameter is id, create and add layer with masterportalAPI mechanisms
     if (typeof layerOrId === "string") {
-        const rawLayer = getLayerWhere({id: layerOrId});
+        const rawLayer = rawLayerList.getLayerWhere({id: layerOrId});
 
         if (!rawLayer) {
             console.error("Layer with id '" + layerOrId + "' not found. No layer added to map.");
@@ -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));
@@ -160,7 +166,7 @@ export function createMap (config = defaults, {mapParams, callback, errorCallbac
     map.set("id", `map2D_${mapIdCounter++}`);
 
     // extend callback to load configured initial layers
-    initializeLayerList(config.layerConf, (param, error) => {
+    rawLayerList.initializeLayerList(config.layerConf, (param, error) => {
         getInitialLayers(config)
             .forEach(layer => {
                 map.addLayer(layer.id, {errorCallback});

package/src/rawLayerList.js

@@ -14,7 +14,7 @@ let layerList = [];
  * @param {function} [callback] - called with services after loaded; called with false and error on error
  * @returns {undefined} nothing, add callback to receive layerList
  */
-export function initializeLayerList (layerConf = defaults.layerConf, callback) {
+function initializeLayerList (layerConf = defaults.layerConf, callback) {
     if (Array.isArray(layerConf)) {
         // case: parameter was services.json contents
         layerList = layerConf;
@@ -55,14 +55,14 @@ export function initializeLayerList (layerConf = defaults.layerConf, callback) {
  * @param {object} searchAttributes - key/value-pairs to be searched for, e.g. { typ: "WMS" } to get the first WMS
  * @returns {?object} first layer matching the searchAttributes or null if none was found
  */
-export function getLayerWhere (searchAttributes) {
+function getLayerWhere (searchAttributes) {
     const keys = Object.keys(searchAttributes);
 
     return layerList.find(entry => keys.every(key => entry[key] === searchAttributes[key])) || null;
 }
 
 /** @returns {object[]} complete layerList as initialized */
-export function getLayerList () {
+function getLayerList () {
     return layerList;
 }
 
@@ -72,7 +72,7 @@ export function getLayerList () {
  * @param {string} [featureAttribute] - if given, only one entry of map is returned
  * @returns {?(object|string)} - map of originalName->displayName or name of featureAttribute if specified; if layer or featureAttribute not found, null
  */
-export function getDisplayNamesOfFeatureAttributes (layerId, featureAttribute) {
+function getDisplayNamesOfFeatureAttributes (layerId, featureAttribute) {
     const attributes = getLayerWhere({id: layerId});
 
     if (attributes && typeof featureAttribute === "string") {
@@ -86,3 +86,11 @@ export function getDisplayNamesOfFeatureAttributes (layerId, featureAttribute) {
 
     return null;
 }
+
+
+export default {
+    getLayerWhere,
+    getDisplayNamesOfFeatureAttributes,
+    initializeLayerList,
+    getLayerList
+};

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/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 = [