@masterportal/masterportalapi 2.6.0 → 2.7.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 
  The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
 
+## Unreleased - in development
+### Added
+### Changed
+
+### Deprecated
+
+### Removed
+### Fixed
+
+## 2.7.0 - 2022-09-14
+### Changed
+- The following packages have been updated:
+    - dependencies:
+        - ol: 6.15.1 to 7.1.0
+        - olcs: 2.13.0 to 2.13.1
+
+---
+
 ## 2.6.0 - 2022-09-06
 ### Added
 - Added possibility to set initial features for layer vectorBase.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@masterportal/masterportalapi",
   "author": "Implementierungspartnerschaft Masterportal <info@masterportal.org> (https://www.masterportal.org)",
-  "version": "2.6.0",
+  "version": "2.7.0",
   "license": "MIT",
   "description": "Basic functions of the Masterportal as api",
   "repository": {
@@ -20,8 +20,8 @@
   },
   "dependencies": {
     "core-js": "^3.24.0",
-    "ol": "6.15.1",
-    "olcs": "^2.13.0",
+    "ol": "7.1.0",
+    "olcs": "^2.13.1",
     "proj4": "^2.8.0",
     "xml2js": "^0.4.23"
   },

package/src/layer/vectorTile.js

@@ -21,7 +21,7 @@ const OL_DEFAULT_VECTOR_TILE_GRID_CRS = "EPSG:3857";
  * @property {number[]} [extent] - extent
  * @property {number} [maxZoom=22] - min zoom level
  * @property {number} [minZoom] - max zoom level
- * @property {function} [olAttribution] - optional function that takes a module:ol/PluggableMap~FrameState and returns a string or an array of strings representing source attributions
+ * @property {function} [olAttribution] - optional function that takes a module:ol/Map~FrameState and returns a string or an array of strings representing source attributions
  * @property {number[]} [origin] - The tile grid origin, i.e. where the x and y axes meet ([z, 0, 0]). Tile coordinates increase left to right and downwards
  * @property {number[][]} [origins] - Tile grid origins, i.e. where the x and y axes meet ([z, 0, 0]), for each zoom level. If given, the array length should match the length of the resolutions array, i.e. each resolution can have a different origin. Tile coordinates increase left to right and downwards. If not specified, extent or origin must be provided.
  * @property {number[]} [resolutions] - Resolutions. The array index of each resolution needs to match the zoom level. This means that even if a minZoom is configured, the resolutions array will have a length of maxZoom + 1.

package/src/layer/wms.js

@@ -80,7 +80,7 @@ export function makeParams (rawLayer) {
  * @param {string} [rawLayer.url] - WMS service URL
  * @param {string} [rawLayer.serverType] - optional servertype definition: "geoserver" or "mapserver" or "qgis"
  * @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/PluggableMap~FrameState and returns a string or an array of strings representing source attributions
+ * @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 {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
@@ -128,7 +128,7 @@ export function createLayerSource (rawLayer, options) {
  * @param {string} [rawLayer.maxScale] - optional the maximal resolution
  * @param {string} [rawLayer.serverType] - optional servertype definition: "geoserver" or "mapserver" or "qgis"
  * @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/PluggableMap~FrameState and returns a string or an array of strings representing source attributions
+ * @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 {object} layerParams - additional layer params
  * @param {object} options - optional resolutions and origin to create the TileGrid

package/src/maps/map.js

@@ -20,7 +20,7 @@ export default {
     * @param {object}  [settings={}] - settings object
     * @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
-    * @returns {module:ol/PluggableMap~PluggableMap} The map.
+    * @returns {module:ol/Map~Map} The map.
     */
     createMap: function (config, mapMode = "2D", settings = {}) {
         const createMapFunctions = {

package/src/maps/ol/olMap.js

@@ -1,4 +1,4 @@
-import {Map, PluggableMap} from "ol";
+import {Map} from "ol";
 import {defaults as olDefaultInteractions} from "ol/interaction.js";
 import setBackgroundImage from "../../lib/setBackgroundImage";
 import getInitialLayers from "../../lib/getInitialLayers";
@@ -30,7 +30,7 @@ const layerBuilderMap = {
         vectortile,
         oaf
     },
-    originalAddLayer = PluggableMap.prototype.addLayer;
+    originalAddLayer = Map.prototype.addLayer;
 
 /**
  * Adds a layer to the map, or adds a layer to the map by id.
@@ -73,7 +73,7 @@ function addLayer (layerOrId, params = {visibility: true, transparency: 0}) {
     return originalAddLayer.call(this, layerOrId);
 }
 
-PluggableMap.prototype.addLayer = addLayer;
+Map.prototype.addLayer = addLayer;
 
 /**
  * Creates an openlayers map according to configuration. Does not set many default values itself, but uses function that do.

package/src/maps/olcs/olcsMap.js

@@ -99,7 +99,7 @@ export function setCameraParameter (params, map3D, cesium) {
 /**
  * Creates a 3D-map.
  * @param {object} [settings] The settings for the 3D-map.
- * @param {module:ol/PluggableMap~PluggableMap} [settings.map2D] The 2D-Map
+ * @param {module:ol/Map~Map} [settings.map2D] The 2D-Map
  * @param {Cesium.JulianDate} [settings.shadowTime] The shadow time in julian date format if undefined olcs default is Cesium.JulianDate.now().
  * @returns {module:OLCesium} the 3d-map
  */

package/test/map.test.js

@@ -1,4 +1,4 @@
-import {PluggableMap, Map} from "ol";
+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";
@@ -86,12 +86,12 @@ describe("map.js", function () {
         });
     });
 
-    // NOTE: loading map.js monkey patches PluggableMap.prototype.addLayer - testing result here
+    // NOTE: loading map.js monkey patches Map.prototype.addLayer - testing result here
     describe("addLayer", function () {
         it("logs an error for unknown ids", function () {
             console.error = jest.fn();
             const consoleError = console.error,
-                result = PluggableMap.prototype.addLayer("999999999999999");
+                result = Map.prototype.addLayer("999999999999999");
 
             expect(console.error).toHaveBeenCalled();
             expect(result).toBeNull();
@@ -101,7 +101,7 @@ describe("map.js", function () {
         it("logs an error for unknown types", function () {
             console.error = jest.fn();
             const consoleError = console.error,
-                result = PluggableMap.prototype.addLayer("exists");
+                result = Map.prototype.addLayer("exists");
 
             expect(result).toBeNull();
             expect(console.error).toHaveBeenCalledWith("Layer with id 'exists' has unknown type 'doesntExist'. No layer added to map.");
@@ -109,17 +109,17 @@ describe("map.js", function () {
         });
 
         it("creates existing layers that have a known builder", function () {
-            const result = PluggableMap.prototype.addLayer("works");
+            const result = Map.prototype.addLayer("works");
 
             expect(result).toBeInstanceOf(TileLayer);
         });
 
         it("sets visibility and transparency", function () {
-            const result1 = PluggableMap.prototype.addLayer("works"),
-                result2 = PluggableMap.prototype.addLayer("works", {}),
-                result3 = PluggableMap.prototype.addLayer("works", {visibility: false}),
-                result4 = PluggableMap.prototype.addLayer("works", {transparency: 50}),
-                result5 = PluggableMap.prototype.addLayer("works", {visibility: false, transparency: 20});
+            const result1 = Map.prototype.addLayer("works"),
+                result2 = Map.prototype.addLayer("works", {}),
+                result3 = Map.prototype.addLayer("works", {visibility: false}),
+                result4 = Map.prototype.addLayer("works", {transparency: 50}),
+                result5 = Map.prototype.addLayer("works", {visibility: false, transparency: 20});
 
             expect(result1.getOpacity()).toBe(1);
             expect(result1.getVisible()).toBe(true);