@masterportal/masterportalapi 2.1.1

package/.editorconfig

@@ -0,0 +1,15 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.{json,yaml}]
+indent_size = 2

package/.eslintignore

@@ -0,0 +1,6 @@
+/node_modules
+/example
+/dist
+/docs
+/.cache
+/coverage

package/.eslintrc

@@ -0,0 +1,184 @@
+{
+    "env": {
+        // browser global variables
+        "browser": true,
+        "node": true,
+        "es6": true
+    },
+    "parserOptions": {
+        "ecmaVersion": 2020,
+        "sourceType": "module"
+    },
+    "extends": [
+        "eslint:recommended"
+    ],
+    "rules": {
+        "for-direction": "error",
+        "getter-return": "error",
+        "no-compare-neg-zero": "error",
+        "no-cond-assign": ["error", "always"],
+        "no-console": ["error", { "allow": ["warn", "error"] }],
+        "no-constant-condition": "error",
+        "no-debugger": "error",
+        "no-dupe-args": "error",
+        "no-dupe-keys": "error",
+        "no-duplicate-case": "error",
+        "no-empty": "error",
+        "no-empty-character-class": "error",
+        "no-ex-assign": "error",
+        "no-extra-boolean-cast": "error",
+        "no-extra-parens": ["error", "all", { "nestedBinaryExpressions": false }],
+        "no-extra-semi": "error",
+        "no-func-assign": "error",
+        "no-inner-declarations": "error",
+        "no-invalid-regexp": "error",
+        "no-irregular-whitespace": "error",
+        "no-obj-calls": "error",
+        "no-regex-spaces": "error",
+        "no-sparse-arrays": "error",
+        "no-unexpected-multiline": "error",
+        "no-unreachable": "error",
+        "no-unsafe-finally": "error",
+        "no-unsafe-negation": "error",
+        "use-isnan": "error",
+        "valid-jsdoc": "error",
+        "valid-typeof": "error",
+        "accessor-pairs": "error",
+        "array-callback-return": "error",
+        "block-scoped-var": "error",
+        "consistent-return": "error",
+        "curly": "error",
+        "default-case": "error",
+        "dot-notation": "error",
+        "eqeqeq": "error",
+        "no-alert": "error",
+        "no-caller": "error",
+        "no-case-declarations": "error",
+        "no-div-regex": "error",
+        "no-else-return": "error",
+        "no-empty-function": "error",
+        "no-empty-pattern": "error",
+        "no-eq-null": "error",
+        "no-eval": "error",
+        "no-extra-bind": "error",
+        "no-extra-label": "error",
+        "no-fallthrough": "error",
+        "no-floating-decimal": "error",
+        "no-global-assign": "error",
+        "no-implicit-coercion": "error",
+        "no-implicit-globals": "error",
+        "no-implied-eval": "error",
+        "no-iterator": "error",
+        "no-labels": "error",
+        "no-lone-blocks": "error",
+        "no-loop-func": "error",
+        "no-multi-spaces": "error",
+        "no-multi-str": "error",
+        "no-new-func": "error",
+        "no-new-wrappers": "error",
+        "no-octal": "error",
+        "no-octal-escape": "error",
+        "no-param-reassign": "error",
+        "no-proto": "error",
+        "no-redeclare": "error",
+        "no-restricted-properties": "error",
+        "no-return-assign": "error",
+        "no-return-await": "error",
+        "no-script-url": "error",
+        "no-self-assign": "error",
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-throw-literal": "error",
+        "no-unmodified-loop-condition": "error",
+        "no-unused-expressions": 0,
+        "no-unused-labels": "error",
+        "no-useless-call": "error",
+        "no-useless-concat": "error",
+        "no-useless-escape": "error",
+        "no-useless-return": "error",
+        "no-void": "error",
+        "no-with": "error",
+        "radix": "error",
+        "vars-on-top": "error",
+        "yoda": "error",
+        "no-delete-var": "error",
+        "no-label-var": "error",
+        "no-shadow": "error",
+        "no-shadow-restricted-names": "error",
+        "no-undef": "error",
+        "no-undef-init": "error",
+        "no-unused-vars": "error",
+        "no-use-before-define": "error",
+        "callback-return": "error",
+        "global-require": "error",
+        "handle-callback-err": "error",
+        "no-buffer-constructor": "error",
+        "no-new-require": "error",
+        "no-path-concat": "error",
+        "no-process-env": "error",
+        "no-process-exit": "error",
+        "no-sync": "error",
+        "array-bracket-spacing": "error",
+        "block-spacing": "error",
+        "brace-style": ["error", "stroustrup"],
+        "comma-dangle": "error",
+        "comma-spacing": "error",
+        "comma-style": "error",
+        "computed-property-spacing": "error",
+        "consistent-this": "error",
+        "func-call-spacing": ["error", "never"],
+        "func-style": ["error", "declaration"],
+        "function-paren-newline": ["error", "never"],
+        "implicit-arrow-linebreak": "error",
+        "indent": ["error", 4, { "SwitchCase": 1 }],
+        "jsx-quotes": "error",
+        "key-spacing": "error",
+        "keyword-spacing": "error",
+        "max-depth": "error",
+        "max-nested-callbacks": ["error", 4],
+        "max-params": ["warn", 6],
+        "max-statements-per-line": "error",
+        "new-cap": "error",
+        "new-parens": "error",
+        "no-array-constructor": "error",
+        "no-lonely-if": "error",
+        "no-mixed-operators": "error",
+        "no-mixed-spaces-and-tabs": "error",
+        "no-multiple-empty-lines": ["error", { "max": 2, "maxBOF": 1}],
+        "no-nested-ternary": "error",
+        "no-new-object": "error",
+        "no-tabs": "error",
+        "no-trailing-spaces": "error",
+        "no-underscore-dangle": "error",
+        "no-unneeded-ternary": "error",
+        "no-whitespace-before-property": "error",
+        "object-curly-spacing": "error",
+        "object-property-newline": 0,
+        "one-var": "error",
+        "one-var-declaration-per-line": "error",
+        "quotes": "error",
+        "require-jsdoc": 0,
+        "semi": "error",
+        "semi-spacing": "error",
+        "semi-style": "error",
+        "space-before-blocks": "error",
+        "space-before-function-paren": "error",
+        "space-in-parens": "error",
+        "space-infix-ops": "error",
+        "space-unary-ops": "error",
+        "spaced-comment": "error",
+        "switch-colon-spacing": "error",
+        "wrap-regex": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-constructor": "error",
+        "no-useless-rename": "error",
+        "prefer-const": "error",
+        "prefer-numeric-literals": "error",
+        "prefer-rest-params": "error",
+        "padding-line-between-statements": [
+            "error",
+            {"blankLine": "always", "prev": ["const", "let", "var"], "next": "*"},
+            {"blankLine": "any", "prev": ["const", "let", "var"], "next": ["const", "let", "var"]}
+        ]
+    }
+}

package/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run prePushHook

package/CHANGELOG.md

@@ -0,0 +1,217 @@
+# Changelog masterportalAPI
+ All important changes in this project are stored in this file.
+
+ The [Semantic Versioning](https://semver.org/spec/v2.0.0.html) is used.
+
+## Unreleased - in development
+### Added
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
+---
+
+## 2.1.1 - 2022-04-20
+
+### Fixed
+- Allow searchAddress to find street names with a prefix.
+
+---
+
+## 2.1.0 - 2022-04-04
+### Added
+- Add a new layer type OAf (Open API Features).
+
+### Changed
+- The WMS layer respects crs code at rawlayer. The WMS request now contains the attribute CRS. If not available, projection of the map is used.
+- OAF
+    - Changing the OAF attribute "featureType" into "collection"
+    - Setting OAF output format only in GeoJSON
+    - Removing unnecessary parameters
+
+### Fixed
+- Fix a vulnerability of third party libraries.
+
+---
+
+## 2.0.0 - 2022-03-18
+### Added
+- 3D functions are added to olcsMap.js.
+- Gazetteer search:
+    - Previous gazetteer searches can now be aborted by means of an `AbortController`.
+    - Added the possibility to use the `geographicIdentifier` to display the search result.
+- A new layer typ OAF (OGC API features) is implemented and integrated into MaterportalAPI
+    - Features as parameter can be parsed as filter
+- A new parameter "doNotLoadInitially" for WFS layer so that for the external filter, the filtering of feature will be first loaded
+
+### Changed
+- Gazetteer search:
+    - The search now always returns points as coordinates, since the extent is used for polygons, which is not desired in the rule.
+    - For `STREETS`, the point coordinate of the `STREET-AXIS` is now returned.
+    - In the `"gazetteerUrl"` attribute the `service`, `request` and `version` URL parameters must now be specified. The default value has been changed from `"https://geodienste.hamburg.de/HH_WFS_GAGES"` to `"https://geodienste.hamburg.de/HH_WFS_GAGES?service=WFS&request=GetFeature&version=2.0.0"`.
+- The following packages have been updated
+    - ol: from 6.11.0 to version 6.13.0
+- Changed required node version to `^16.13.2`.
+- Changed required npm version to `^8.1.2`.
+
+### Fixed
+- The createVectorSource function now allows passing features as an argument.
+- Gazetteer search: `strassenname`, `hausnummer` and `hausnummernzusatz ` are now also processed if they are returned by the gazetteer as strings.
+
+---
+
+## 1.10.0 - 2022-02-17
+### Changed
+- Folder abstraction renamed to maps and moved into src.
+- WFS layer can now be loaded in the versions allowed by `ol`: 1.0.0, 1.1.0 and 2.0.0.
+
+---
+
+## 1.9.0 - 2022-02-10
+### Added
+- Added 3D tileset-Layer to layers and adapted example.
+- Added 3D terrain-Layer to layers and adapted example.
+
+### Changed
+- The options.beforeLoading function is now only executed once in wfs before loading the features.
+
+---
+
+## 1.8.0 - 2022-01-14
+### Added
+- An alias is added to the coordinate system. This is required by GeoServer services.
+- Added possibility to add any rawLayer attribute to wms layer request.
+- Added VectorBaseLayer to layers
+- The follow package were added
+    - @parcel/transformer-sass version 2.2.0
+    - parcel version 2.2.0
+    - regenerator-runtime 0.13.9
+
+### Changed
+- The following packages have been updated
+    - ol: from 6.9.0 to version 6.11.0
+    - @babel/core: from 7.15.0 to version 7.16.7
+    - @babel/plugin-transform-modules-commonjs: from 7.15.0 to version 7.16.8
+    - jest: from 27.0.6 to version 27.4.0
+- babel.config.js was replaced by babel.config.json. Now it can be watched for changes, and Babel transformations can be cached.
+- The overall script tag needs the attribute type="module" to enable module usage. Look at the index.html in example-folder.
+
+### Removed
+- The follow package were removed
+    - @babel/preset-env: because Parcel includes transpilation by default
+    - babel-jest
+    - babel-polyfill
+    - parcel-bundler: replaced by parcel
+
+---
+
+## 1.7.1 - 2022-01-11
+### Fixed
+- WFS-Layer: the WFS version is taken into account when generating the WFS format.
+
+---
+
+## 1.7.0 - 2021-12-27
+### Added
+- An alias is added to the coordinate system. This is required by GeoServer services.
+- Added WFS Layer that creates a VectorLayer and a VectorSource. Layer-params and loading-params can be passed as function parameters, options may contain functions to filter and style features. Clustering and WFS-filter are supported.
+- Added possibility to add the parameter TIME to the wms layer request.
+- Examples were extended by WFS-Layer.
+
+### Changed
+- The constructor of createMap in the abstraction layer changed. The order of the parameters (config, settings = {}, mapMode = "2D") changes to (config, mapMode = "2D", settings = {}).
+- abstraction\ol\map.js was renamed to abstraction\ol\olMap.js and abstraction\olcs\map.js was renamed to abstraction\olcs\olcsMap.js
+
+---
+
+## 1.6.1 - 2021-12-07
+### Changed
+- SessionID from the WMS layer was removed and replaced by the CacheID in order to deal with deegree services.
+
+---
+
+## 1.6.0 - 2021-11-10
+### Added
+- The library Cesium is loaded on demand to generate a 3D map. Cesium must be provided by the user of this library.
+- A 3D map can be generated. The generation of 2D and 3D maps is controlled by an abstraction layer.
+- The example allows to switch between 2d and 3d map.
+### Changed
+- OpenLayers package updated from 6.6.1 to 6.9.0
+- The WMS layer has been extended with layerParams and options. The LayerSource now contains a TileGrid if there are resolutions in the options. The source can also contain attributions.
+
+---
+
+## 1.5.0 - 2021-08-16
+### Added
+- The engine for npm version ">= 6.13.4" was added in the package.json
+- The package "@babel/preset-env" version 7.15.0 was added.
+- The package "core-js" version 3.16.1 was added.
+- The package "husky" version 7.0.1 was added. In this case a pre-push hook to run unit tests and eslint before every git push.
+
+### Changed
+- The engine for node was updated to ">= 10.18.0" in the package.json
+- The follow package were updated and in this case the eslint rules and the babel.config were adjusted
+    - ol: from 6.5.0 to version 6.6.1
+    - proj4: from 2.5.0 to version 2.7.5
+    - xml2js: from 0.4.19 to version 0.4.23
+    - @babel/core: from 7.1.6 to version 7.15.0
+    - @babel/plugin-transform-modules-commonjs: from 7.1.0 to version 7.15.0
+    - babel-jest: from 23.6.0 to version 27.0.6
+    - canvas: from 2.1.0 to version 2.8.0
+    - eslint: from 5.12.0 to version 7.32.0
+    - jest-canvas-mock: from 1.1.0 to version 2.3.1
+    - jsdoc: from 3.5.5 to version 3.6.7
+    - parcel-bundler: from 1.10.3 to version 1.12.5
+    - sass: from 1.14.3 to version 1.37.5
+
+### Removed
+- The package "babel-core" was removed.
+- The package "babel-preset-es2015" was removed.
+
+---
+
+## 1.4.0 - 2021-05-27
+### Changed
+- OpenLayers package from 6.3.1 to 6.5.0
+- Default backgroundImage is changed to ""
+
+---
+
+## 1.3.0 - 2020-05-25
+### Added
+- New parameters constrainResolution and constrainOnlyCenter to create the map view
+
+---
+
+## 1.2.0 - 2020-05-14
+### Changed
+- The dependency on the OL package has been updated to version 6:
+    - The function getGetFeatureInfoUrl is changed into getFeatureInfoUrl
+    - The function ol/source/Vector#clear() is changed into ol/source/Vector#refresh() to re-render a vector layer
+
+### Fixed
+- Loading layer form separat Layer file in unit test
+
+---
+
+## 1.1.0 - 2020-04-14
+### Added
+- New function to set the start resolution by resolution or zoom level
+- An error handling during initial loading of the LayerList was added
+
+### Changed
+- The function getMapProjection is now available globally
+
+### Fixed
+- Fixes a timeout problem that occurred when initializing the layerList
+- The projections have delivered duplicates, these are now filtered out
+
+---
+
+## 1.0.0 - 2019-07-29
+- Initial implementation.

package/License.txt

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2018-2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,24 @@
+# masterportalapi
+
+The masterportalAPI is an API to include and show map-content on your webpage. It's based on OpenLayers and extended with functions to easily use configuration and infrastructure files from the masterportal, a feature-rich mapping app developed by geowerkstatt hamburg. It also provides the creation of a 3d map by using olcs and cesium. Check masterportal.org for further information.
+
+## Usage
+
+Install the masterportalAPI in your project with ``npm install masterportalapi``. The project does not have a default export, but various named exports. Generate and check the documentation as described below for details.
+
+If you want to create a 3d map, you have to provide the peer dependency cesium.
+
+By importing the project by module name like ``import ... from "masterportalAPI"``, most bundlers and bundler configurations will include the whole masterportalAPI. If you only need a subset of the provided functions and want to keep your build clean, directly import the needed functions like ``import {createMap} from "masterportalAPI/src/map.js``.
+
+## Scripts
+
+|Script|Effect|
+|-|-|
+|``npm run example``|Starts a dev server with a running example. Please mind that the page seen is _not_ part of the masterportalAPI, but merely an environment for manual testing. Change code within ``./example/index.js`` to try things. Free hot reloading thanks to parcel.|
+|``npm run generate-jsdoc``|Generates the project documentation within the folder ``./docs``.|
+|``npm test``|Runs all tests. Prints code coverage to console.|
+|``npm run test:watch``|Runs all tests in watch mode. Good practive to let this run during development in a separate terminal. |
+
+## About Babel
+
+The Babel dev dependencies are purely added for development tests and jest tests. Babel is required for testing since Node does not support ES6 in .js files so far.

package/babel.config.json

@@ -0,0 +1,6 @@
+{
+    "presets": [],
+    "plugins": [
+        "@babel/plugin-transform-modules-commonjs"
+    ]
+  }

package/example/README.md

@@ -0,0 +1,7 @@
+# Example
+
+The files in this folder do _not_ belong to the masterportalAPI, but are here for
+* manual testing during development
+* checking how to use masterportalAPI
+
+Files/code in the folder are not supposed to be included in any product.