Skip to content

meggsimum/geoserver-node-client

Repository files navigation

GeoServer Node Client

npm version Website GitHub Release Date GitHub last commit CI Badge

GeoSever Node Client Logo

Node.js / JavaScript Client for the GeoServer REST API.

API-Docs

Detailed API-Docs are automatically created with JSDoc.

Meta information

Compatible with GeoServer

  • v2.24.x
  • v2.23.x
  • v2.22.x (no more maintained and officially deprecated)
  • v2.21.x (no more maintained and officially deprecated)
  • 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

npm i geoserver-node-client

usage with require (ES5):

var grcImport = require('geoserver-node-client');
var GeoServerRestClient = grcImport.GeoServerRestClient;

var url = 'http://localhost:8080/geoserver/rest/';
var user = 'admin';
var pw = 'geoserver';
var grc = new GeoServerRestClient(url, user, pw);

function main () {
    grc.about.exists().then(function (result) {
      console.log(result);
    });
};

main();

usage as ES module (ES6)

import {GeoServerRestClient} from 'geoserver-node-client';

const url = 'http://localhost:8080/geoserver/rest/';
const user = 'admin';
const pw = 'geoserver';
const grc = new GeoServerRestClient(url, user, pw);

async function main () {
    const result =  await grc.about.exists();
    console.log(result);
};

main();

Setup

Run as local checkout (mainly for development purposes)

git clone https://github.com/meggsimum/geoserver-node-client

cd geoserver-node-client

npm install

npm run demo

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:

  try {
      // call any function from this library
      await grc.styles.publish(workspace, styleName, sldBody)
    } catch (error) {
      // the standard error message
      console.error(error.message);

      // the whole error including stack trace and (if available) the property 'geoServerOutput'
      console.error(error);

      if (error instanceof GeoServerResponseError) {
        // a GeoServer specific error happened
      } else {
        // another error happened
      }
    }

Unit Tests

First start a test setup using this Docker compose file:

docker-compose -f test/docker-compose.yml up

Then, in an other terminal, run:

# specify the GeoServer version and run the test suite
GEOSERVER_VERSION=2.20.4 npm run test

Release

Setting a git tag and increasing the version in the package.json as well as releasing to npm is done via release-it.

The GitHub release has to be performed manually based on the tag created by release-it.

This is the workflow for releasing:

  1. Make sure a GITHUB_TOKEN is available as environment variable. See here for more information.
export GITHUB_TOKEN=ADD-YOUR-TOKEN-HERE
  1. Make sure you are logged in to npm and ensure you have the rights to make a release.
npm login
# then enter your credentials
  1. Locally checkout the latest master branch that you would like to release, then run:
npm run release
  1. Follow the questions in the commandline.
  • automatically upgrades the version in package.json
  • makes a release commit and pushes it to GitHub
  • publishes the new version to npm

Who do I talk to?

  • meggsimum (Christian Mayer) - info __at## meggsimum ~~dot** de

Credits

This project was initiated by meggsimum within the mFund research project SAUBER and is further developed in the mFund research project KLIPS:

SAUBER Logo

.

KLIPS Logo

.

mFund Logo

BMVI Logo