geoserver-node-client 1.0.0 → 1.2.1

package/README.md

@@ -1,8 +1,13 @@
 # GeoServer Node Client
 
 [![npm version](https://badge.fury.io/js/geoserver-node-client.svg)](https://www.npmjs.com/package/geoserver-node-client)
+[![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)
 
+![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 ###
@@ -13,8 +18,9 @@ Detailed [API-Docs](https://meggsimum.github.io/geoserver-node-client/) are auto
 
 Compatible with [GeoServer](https://geoserver.org)
 
+  - v2.21.x
   - v2.20.x
-  - v2.19.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)
 
@@ -27,17 +33,18 @@ npm i geoserver-node-client
 
 usage with require (ES5):
 ```js
-const grcImport = require('geoserver-node-client');
-const GeoServerRestClient = grcImport.GeoServerRestClient;
-
-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);
+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();
@@ -104,7 +111,6 @@ First start a GeoServer, e.g. by using this Docker container:
 ```shell
 docker run \
   -p 8080:8080 \
-  -v /path/to/geoserver_mnt:/opt/geoserver_data \
   meggsimum/geoserver:2.20.4
 ```
 

package/dist/geoserver-rest-client.js

@@ -35,6 +35,8 @@ var _namespace = _interopRequireDefault(require("./src/namespace.js"));
 
 var _about = _interopRequireDefault(require("./src/about.js"));
 
+var _resetReload = _interopRequireDefault(require("./src/reset-reload.js"));
+
 var _geoserver = require("./src/util/geoserver.js");
 
 /**
@@ -83,5 +85,8 @@ function GeoServerRestClient(url, user, password) {
   /** @member {AboutClient} about GeoServer REST client instance for about endpoint */
 
   this.about = new _about["default"](this.url, this.auth);
+  /** @member {ResetReloadClient} about GeoServer REST client instance for reset/reload endpoints */
+
+  this.resetReload = new _resetReload["default"](this.url, this.auth);
 });
 exports.GeoServerRestClient = GeoServerRestClient;

package/dist/package.json

@@ -1,12 +1,12 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.0.0",
+  "version": "1.2.1",
   "description": "Node.js client for GeoServer REST API",
   "type": "commonjs",
   "main": "geoserver-rest-client.js",
   "scripts": {
     "demo": "node demo/index.js",
-    "docs": "./node_modules/.bin/jsdoc geoserver-rest-client.js src/*.js DOCS_HOME.md",
+    "docs": "./node_modules/.bin/jsdoc geoserver-rest-client.js src/*.js DOCS_HOME.md && cp img/*.png out/",
     "lint": "eslint src/**/*.js test/**/*.js scripts/**/*.js geoserver-rest-client.js",
     "lint-fix": "eslint --fix  src/**/*.js test/**/*.js scripts/**/*.js geoserver-rest-client.js",
     "pretest": "npm run lint",
@@ -34,6 +34,7 @@
   "author": "C. Mayer, meggsimum (info_at*meggsimum?dot?de)",
   "license": "BSD-2-Clause",
   "dependencies": {
+    "@babel/runtime": "^7.18.3",
     "node-fetch": "^2.6.5"
   },
   "devDependencies": {

package/dist/src/datastore.js

@@ -762,6 +762,73 @@ var DatastoreClient = /*#__PURE__*/function () {
 
       return createWmsStore;
     }()
+    /**
+     * Creates a WMTS based data store.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} wmtsCapabilitiesUrl Base WMTS capabilities URL
+     *
+     * @throws Error if request fails
+     */
+
+  }, {
+    key: "createWmtsStore",
+    value: function () {
+      var _createWmtsStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee15(workspace, dataStore, wmtsCapabilitiesUrl) {
+        var body, url, response, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee15$(_context15) {
+          while (1) {
+            switch (_context15.prev = _context15.next) {
+              case 0:
+                body = {
+                  wmtsStore: {
+                    name: dataStore,
+                    type: 'WMTS',
+                    capabilitiesURL: wmtsCapabilitiesUrl
+                  }
+                };
+                url = this.url + 'workspaces/' + workspace + '/wmtsstores';
+                _context15.next = 4;
+                return (0, _nodeFetch["default"])(url, {
+                  credentials: 'include',
+                  method: 'POST',
+                  headers: {
+                    Authorization: this.auth,
+                    'Content-Type': 'application/json'
+                  },
+                  body: JSON.stringify(body)
+                });
+
+              case 4:
+                response = _context15.sent;
+
+                if (response.ok) {
+                  _context15.next = 10;
+                  break;
+                }
+
+                _context15.next = 8;
+                return (0, _geoserver.getGeoServerResponseText)(response);
+
+              case 8:
+                geoServerResponse = _context15.sent;
+                throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+
+              case 10:
+              case "end":
+                return _context15.stop();
+            }
+          }
+        }, _callee15, this);
+      }));
+
+      function createWmtsStore(_x39, _x40, _x41) {
+        return _createWmtsStore.apply(this, arguments);
+      }
+
+      return createWmtsStore;
+    }()
     /**
      * Creates a WFS based data store.
      *
@@ -777,11 +844,11 @@ var DatastoreClient = /*#__PURE__*/function () {
   }, {
     key: "createWfsStore",
     value: function () {
-      var _createWfsStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee15(workspace, dataStore, wfsCapabilitiesUrl, namespaceUrl, useHttpConnectionPooling) {
+      var _createWfsStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee16(workspace, dataStore, wfsCapabilitiesUrl, namespaceUrl, useHttpConnectionPooling) {
         var body, url, response, geoServerResponse;
-        return _regenerator["default"].wrap(function _callee15$(_context15) {
+        return _regenerator["default"].wrap(function _callee16$(_context16) {
           while (1) {
-            switch (_context15.prev = _context15.next) {
+            switch (_context16.prev = _context16.next) {
               case 0:
                 body = {
                   dataStore: {
@@ -802,7 +869,7 @@ var DatastoreClient = /*#__PURE__*/function () {
                   }
                 };
                 url = this.url + 'workspaces/' + workspace + '/datastores';
-                _context15.next = 4;
+                _context16.next = 4;
                 return (0, _nodeFetch["default"])(url, {
                   credentials: 'include',
                   method: 'POST',
@@ -814,29 +881,29 @@ var DatastoreClient = /*#__PURE__*/function () {
                 });
 
               case 4:
-                response = _context15.sent;
+                response = _context16.sent;
 
                 if (response.ok) {
-                  _context15.next = 10;
+                  _context16.next = 10;
                   break;
                 }
 
-                _context15.next = 8;
+                _context16.next = 8;
                 return (0, _geoserver.getGeoServerResponseText)(response);
 
               case 8:
-                geoServerResponse = _context15.sent;
+                geoServerResponse = _context16.sent;
                 throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
 
               case 10:
               case "end":
-                return _context15.stop();
+                return _context16.stop();
             }
           }
-        }, _callee15, this);
+        }, _callee16, this);
       }));
 
-      function createWfsStore(_x39, _x40, _x41, _x42, _x43) {
+      function createWfsStore(_x42, _x43, _x44, _x45, _x46) {
         return _createWfsStore.apply(this, arguments);
       }
 
@@ -855,15 +922,15 @@ var DatastoreClient = /*#__PURE__*/function () {
   }, {
     key: "deleteDataStore",
     value: function () {
-      var _deleteDataStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee16(workspace, dataStore, recurse) {
+      var _deleteDataStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee17(workspace, dataStore, recurse) {
         var url, response, geoServerResponse;
-        return _regenerator["default"].wrap(function _callee16$(_context16) {
+        return _regenerator["default"].wrap(function _callee17$(_context17) {
           while (1) {
-            switch (_context16.prev = _context16.next) {
+            switch (_context17.prev = _context17.next) {
               case 0:
                 url = this.url + 'workspaces/' + workspace + '/datastores/' + dataStore;
                 url += '?recurse=' + recurse;
-                _context16.next = 4;
+                _context17.next = 4;
                 return (0, _nodeFetch["default"])(url, {
                   credentials: 'include',
                   method: 'DELETE',
@@ -873,29 +940,29 @@ var DatastoreClient = /*#__PURE__*/function () {
                 });
 
               case 4:
-                response = _context16.sent;
+                response = _context17.sent;
 
                 if (response.ok) {
-                  _context16.next = 10;
+                  _context17.next = 10;
                   break;
                 }
 
-                _context16.next = 8;
+                _context17.next = 8;
                 return (0, _geoserver.getGeoServerResponseText)(response);
 
               case 8:
-                geoServerResponse = _context16.sent;
+                geoServerResponse = _context17.sent;
                 throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
 
               case 10:
               case "end":
-                return _context16.stop();
+                return _context17.stop();
             }
           }
-        }, _callee16, this);
+        }, _callee17, this);
       }));
 
-      function deleteDataStore(_x44, _x45, _x46) {
+      function deleteDataStore(_x47, _x48, _x49) {
         return _deleteDataStore.apply(this, arguments);
       }
 
@@ -914,15 +981,15 @@ var DatastoreClient = /*#__PURE__*/function () {
   }, {
     key: "deleteCoverageStore",
     value: function () {
-      var _deleteCoverageStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee17(workspace, coverageStore, recurse) {
+      var _deleteCoverageStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee18(workspace, coverageStore, recurse) {
         var url, response, geoServerResponse;
-        return _regenerator["default"].wrap(function _callee17$(_context17) {
+        return _regenerator["default"].wrap(function _callee18$(_context18) {
           while (1) {
-            switch (_context17.prev = _context17.next) {
+            switch (_context18.prev = _context18.next) {
               case 0:
                 url = this.url + 'workspaces/' + workspace + '/coveragestores/' + coverageStore;
                 url += '?recurse=' + recurse;
-                _context17.next = 4;
+                _context18.next = 4;
                 return (0, _nodeFetch["default"])(url, {
                   credentials: 'include',
                   method: 'DELETE',
@@ -932,20 +999,20 @@ var DatastoreClient = /*#__PURE__*/function () {
                 });
 
               case 4:
-                response = _context17.sent;
+                response = _context18.sent;
 
                 if (response.ok) {
-                  _context17.next = 14;
+                  _context18.next = 14;
                   break;
                 }
 
-                _context17.next = 8;
+                _context18.next = 8;
                 return (0, _geoserver.getGeoServerResponseText)(response);
 
               case 8:
-                geoServerResponse = _context17.sent;
-                _context17.t0 = response.status;
-                _context17.next = _context17.t0 === 401 ? 12 : 13;
+                geoServerResponse = _context18.sent;
+                _context18.t0 = response.status;
+                _context18.next = _context18.t0 === 401 ? 12 : 13;
                 break;
 
               case 12:
@@ -956,13 +1023,13 @@ var DatastoreClient = /*#__PURE__*/function () {
 
               case 14:
               case "end":
-                return _context17.stop();
+                return _context18.stop();
             }
           }
-        }, _callee17, this);
+        }, _callee18, this);
       }));
 
-      function deleteCoverageStore(_x47, _x48, _x49) {
+      function deleteCoverageStore(_x50, _x51, _x52) {
         return _deleteCoverageStore.apply(this, arguments);
       }
 
@@ -981,11 +1048,11 @@ var DatastoreClient = /*#__PURE__*/function () {
   }, {
     key: "createGpkgStore",
     value: function () {
-      var _createGpkgStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee18(workspace, dataStore, gpkgPath) {
+      var _createGpkgStore = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee19(workspace, dataStore, gpkgPath) {
         var body, url, response, geoServerResponse;
-        return _regenerator["default"].wrap(function _callee18$(_context18) {
+        return _regenerator["default"].wrap(function _callee19$(_context19) {
           while (1) {
-            switch (_context18.prev = _context18.next) {
+            switch (_context19.prev = _context19.next) {
               case 0:
                 body = {
                   dataStore: {
@@ -1003,7 +1070,7 @@ var DatastoreClient = /*#__PURE__*/function () {
                   }
                 };
                 url = this.url + 'workspaces/' + workspace + '/datastores';
-                _context18.next = 4;
+                _context19.next = 4;
                 return (0, _nodeFetch["default"])(url, {
                   credentials: 'include',
                   method: 'POST',
@@ -1015,29 +1082,29 @@ var DatastoreClient = /*#__PURE__*/function () {
                 });
 
               case 4:
-                response = _context18.sent;
+                response = _context19.sent;
 
                 if (response.ok) {
-                  _context18.next = 10;
+                  _context19.next = 10;
                   break;
                 }
 
-                _context18.next = 8;
+                _context19.next = 8;
                 return (0, _geoserver.getGeoServerResponseText)(response);
 
               case 8:
-                geoServerResponse = _context18.sent;
+                geoServerResponse = _context19.sent;
                 throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
 
               case 10:
               case "end":
-                return _context18.stop();
+                return _context19.stop();
             }
           }
-        }, _callee18, this);
+        }, _callee19, this);
       }));
 
-      function createGpkgStore(_x50, _x51, _x52) {
+      function createGpkgStore(_x53, _x54, _x55) {
         return _createGpkgStore.apply(this, arguments);
       }
 

package/dist/src/imagemosaic.js

@@ -41,7 +41,7 @@ var ImageMosaicClient = /*#__PURE__*/function () {
    *
    * @param {String} workspace Workspace of image mosaic
    * @param {String} coverageStore CoverageStore of image mosaic
-   * @param {*} coverage Name of image mosaic
+   * @param {String} coverage Name of image mosaic
    *
    * @throws Error if request fails
    *