@masterportal/masterportalapi 2.8.0 → 2.9.0

package/CHANGELOG.md

@@ -16,6 +16,20 @@
 
 ---
 
+## 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
 ### Added
 - Issue #814: Adding optional error callbacks and availability detection to layers.

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.9.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);
 }
+
+module.exports = {
+    transformFromMapProjection,
+    transformToMapProjection,
+    transform,
+    getMapProjection,
+    getProjections,
+    registerProjections,
+    getProjection
+};

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 "../index.js";
 
 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/maps/ol/olMap.js

@@ -11,7 +11,7 @@ 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 {rawLayerList} from "../../index.js";
 import {registerProjections} from "../../crs";
 import {setGazetteerUrl} from "../../searchAddress";
 
@@ -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.");
@@ -160,7 +160,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;
 }
+
+
+module.exports = {
+    getLayerWhere,
+    getDisplayNamesOfFeatureAttributes,
+    initializeLayerList,
+    getLayerList
+};