geoserver-node-client 1.2.2 → 1.2.4

package/README.md

@@ -4,34 +4,35 @@
 [![Website](https://img.shields.io/website?up_message=API-Docs&url=https%3A%2F%2Fmeggsimum.github.io%2Fgeoserver-node-client%2F)](https://meggsimum.github.io/geoserver-node-client)
 ![GitHub Release Date](https://img.shields.io/github/release-date/meggsimum/geoserver-node-client)
 ![GitHub last commit](https://img.shields.io/github/last-commit/meggsimum/geoserver-node-client)
-![](https://github.com/meggsimum/geoserver-node-client/actions/workflows/ci-geoserver-node-client.yml/badge.svg)
+![CI Badge](https://github.com/meggsimum/geoserver-node-client/actions/workflows/ci-geoserver-node-client.yml/badge.svg)
 
 ![GeoSever Node Client Logo](/img/geoserver-node-client-logo_150px.png)
 
 Node.js / JavaScript Client for the [GeoServer REST API](https://docs.geoserver.org/stable/en/user/rest/).
 
-### API-Docs ###
+## API-Docs
 
 Detailed [API-Docs](https://meggsimum.github.io/geoserver-node-client/) are automatically created with JSDoc.
 
-### Meta information
+## Meta information
 
 Compatible with [GeoServer](https://geoserver.org)
 
-  - v2.21.x
-  - v2.20.x
-  - v2.19.x (no more maintained and officially deprecated)
-  - v2.18.x (no more maintained and officially deprecated)
-  - v2.17.x (no more maintained and officially deprecated)
+- v2.22.x
+- v2.21.x
+- v2.20.x (no more maintained and officially deprecated)
+- v2.19.x (no more maintained and officially deprecated)
+- v2.18.x (no more maintained and officially deprecated)
+- v2.17.x (no more maintained and officially deprecated)
 
-
-### Usage
+## Usage
 
 ```shell
 npm i geoserver-node-client
 ```
 
 usage with require (ES5):
+
 ```js
 var grcImport = require('geoserver-node-client');
 var GeoServerRestClient = grcImport.GeoServerRestClient;
@@ -51,6 +52,7 @@ main();
 ```
 
 usage as ES module (ES6)
+
 ```js
 import {GeoServerRestClient} from 'geoserver-node-client';
 
@@ -67,7 +69,7 @@ async function main () {
 main();
 ```
 
-### Setup
+## Setup
 
 Run as local checkout (mainly for development purposes)
 
@@ -81,7 +83,7 @@ npm install
 npm run demo
 ```
 
-### Error Handling
+## Error Handling
 
 A request either succeeds or throws the custom `GeoServerResponseError`. It has the standard `message` property with a "human-readable" text. Additionally the error has the property `geoServerOutput` which contains the direct response from GeoServer. This output is not guaranteed to exist and can either be a simple text or a complete HTML document. The latter is difficult to read, but might still be helpful for debugging. This example shows how these error properties can be used. It also shows how to filter by error type:
 
@@ -104,14 +106,12 @@ A request either succeeds or throws the custom `GeoServerResponseError`. It has
     }
 ```
 
-### Unit Tests
+## Unit Tests
 
-First start a GeoServer, e.g. by using this Docker container:
+First start a test setup using this Docker compose file:
 
 ```shell
-docker run \
-  -p 8080:8080 \
-  meggsimum/geoserver:2.20.4
+docker-compose -f test/docker-compose.yml up
 ```
 
 Then, in an other terminal, run:
@@ -121,7 +121,7 @@ Then, in an other terminal, run:
 GEOSERVER_VERSION=2.20.4 npm run test
 ```
 
-### Release
+## Release
 
 Setting a git tag and increasing the version in the `package.json` as well as releasing to npm is done via [release-it](https://github.com/release-it/release-it).
 
@@ -153,11 +153,11 @@ npm run release
   - makes a release commit and pushes it to GitHub
   - publishes the new version to npm
 
-### Who do I talk to? ###
+## Who do I talk to?
 
-* meggsimum (Christian Mayer) - info __at## meggsimum ~~dot** de
+- meggsimum (Christian Mayer) - info __at## meggsimum ~~dot** de
 
-### Credits
+## Credits
 
 This project was initiated by [meggsimum](https://meggsimum.de) within the [mFund](https://www.bmvi.de/EN/Topics/Digital-Matters/mFund/mFund.html) research project [SAUBER](https://sauber-projekt.de/) and is further developed in the mFund research project [KLIPS](http://www.klips-projekt.de/):
 <p><img src="https://sauber-projekt.de/wp-content/uploads/2018/12/SAG_SAUBER_Logo_Dez3_transparent-1-e1543843688935.png" alt="SAUBER Logo" width="200"/></p>.

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Node.js client for GeoServer REST API",
   "type": "commonjs",
   "main": "geoserver-rest-client.js",
@@ -49,8 +49,8 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-standard": "^4.1.0",
-    "jsdoc": "^3.6.10",
+    "jsdoc": "^4.0.0",
     "mocha": "^9.1.3",
-    "release-it": "^14.14.3"
+    "release-it": "^15.4.2"
   }
 }

package/dist/src/datastore.js

@@ -170,7 +170,6 @@ var DatastoreClient = /*#__PURE__*/function () {
       return getWmtsStores;
     }()
     /**
-     * @private
      * Get information about various store types in a workspace.
      *
      * @param {String} workspace The workspace name
@@ -179,6 +178,7 @@ var DatastoreClient = /*#__PURE__*/function () {
      * @throws Error if request fails
      *
      * @returns {Object} An object containing store details or undefined if it cannot be found
+     * @private
      */
 
   }, {
@@ -365,7 +365,6 @@ var DatastoreClient = /*#__PURE__*/function () {
       return getWmtsStore;
     }()
     /**
-     * @private
      * Get GeoServer store by type
      *
      * @param {String} workspace The name of the workspace
@@ -375,6 +374,7 @@ var DatastoreClient = /*#__PURE__*/function () {
      * @throws Error if request fails
      *
      * @returns {Object} An object containing store details or undefined if it cannot be found
+     * @private
      */
 
   }, {
@@ -523,12 +523,12 @@ var DatastoreClient = /*#__PURE__*/function () {
      * @param {String} namespaceUri The namespace URI of the workspace
      * @param {String} dataStore The data store name to be created
      * @param {String} pgHost The PostGIS DB host
-     * @param {String} pgPort The PostGIS DB port
+     * @param {Number} pgPort The PostGIS DB port
      * @param {String} pgUser The PostGIS DB user
      * @param {String} pgPassword The PostGIS DB password
      * @param {String} pgSchema The PostGIS DB schema
      * @param {String} pgDb The PostGIS DB name
-     * @param {String} [exposePk] expose primary key, defaults to false
+     * @param {Boolean} [exposePk] expose primary key, defaults to false
      *
      * @throws Error if request fails
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.2.2",
+  "version": "1.2.4",
   "description": "Node.js client for GeoServer REST API",
   "type": "module",
   "main": "geoserver-rest-client.js",
@@ -49,8 +49,8 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-standard": "^4.1.0",
-    "jsdoc": "^3.6.10",
+    "jsdoc": "^4.0.0",
     "mocha": "^9.1.3",
-    "release-it": "^14.14.3"
+    "release-it": "^15.4.2"
   }
 }

package/src/datastore.js

@@ -65,7 +65,6 @@ export default class DatastoreClient {
   }
 
   /**
-   * @private
    * Get information about various store types in a workspace.
    *
    * @param {String} workspace The workspace name
@@ -74,6 +73,7 @@ export default class DatastoreClient {
    * @throws Error if request fails
    *
    * @returns {Object} An object containing store details or undefined if it cannot be found
+   * @private
    */
   async getStores (workspace, storeType) {
     const response = await fetch(this.url + 'workspaces/' + workspace + '/' + storeType + '.json', {
@@ -140,7 +140,6 @@ export default class DatastoreClient {
   }
 
   /**
-   * @private
    * Get GeoServer store by type
    *
    * @param {String} workspace The name of the workspace
@@ -150,6 +149,7 @@ export default class DatastoreClient {
    * @throws Error if request fails
    *
    * @returns {Object} An object containing store details or undefined if it cannot be found
+   * @private
    */
   async getStore (workspace, storeName, storeType) {
     const url = this.url + 'workspaces/' + workspace + '/' + storeType + '/' + storeName + '.json';
@@ -225,12 +225,12 @@ export default class DatastoreClient {
    * @param {String} namespaceUri The namespace URI of the workspace
    * @param {String} dataStore The data store name to be created
    * @param {String} pgHost The PostGIS DB host
-   * @param {String} pgPort The PostGIS DB port
+   * @param {Number} pgPort The PostGIS DB port
    * @param {String} pgUser The PostGIS DB user
    * @param {String} pgPassword The PostGIS DB password
    * @param {String} pgSchema The PostGIS DB schema
    * @param {String} pgDb The PostGIS DB name
-   * @param {String} [exposePk] expose primary key, defaults to false
+   * @param {Boolean} [exposePk] expose primary key, defaults to false
    *
    * @throws Error if request fails
    */