geoserver-node-client 0.0.5 → 1.0.0

package/dist/src/workspace.js

@@ -0,0 +1,321 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+
+var _regenerator = _interopRequireDefault(require("@babel/runtime/regenerator"));
+
+var _asyncToGenerator2 = _interopRequireDefault(require("@babel/runtime/helpers/asyncToGenerator"));
+
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+
+var _nodeFetch = _interopRequireDefault(require("node-fetch"));
+
+var _geoserver = require("./util/geoserver.js");
+
+var _about = _interopRequireDefault(require("./about.js"));
+
+/**
+ * Client for GeoServer workspaces
+ *
+ * @module WorkspaceClient
+ */
+var WorkspaceClient = /*#__PURE__*/function () {
+  /**
+   * Creates a GeoServer REST WorkspaceClient instance.
+   *
+   * WARNING: For most cases the 'NameSpaceClient' seems to fit better.
+   *
+   * @param {String} url The URL of the GeoServer REST API endpoint
+   * @param {String} auth The Basic Authentication string
+   */
+  function WorkspaceClient(url, auth) {
+    (0, _classCallCheck2["default"])(this, WorkspaceClient);
+    this.url = url;
+    this.auth = auth;
+  }
+  /**
+   * Returns all workspaces.
+   *
+   * @throws Error if request fails
+   *
+   * @returns {Object} An Object describing the workspaces
+   */
+
+
+  (0, _createClass2["default"])(WorkspaceClient, [{
+    key: "getAll",
+    value: function () {
+      var _getAll = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee() {
+        var response, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) {
+            switch (_context.prev = _context.next) {
+              case 0:
+                _context.next = 2;
+                return (0, _nodeFetch["default"])(this.url + 'workspaces.json', {
+                  credentials: 'include',
+                  method: 'GET',
+                  headers: {
+                    Authorization: this.auth
+                  }
+                });
+
+              case 2:
+                response = _context.sent;
+
+                if (response.ok) {
+                  _context.next = 8;
+                  break;
+                }
+
+                _context.next = 6;
+                return (0, _geoserver.getGeoServerResponseText)(response);
+
+              case 6:
+                geoServerResponse = _context.sent;
+                throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+
+              case 8:
+                return _context.abrupt("return", response.json());
+
+              case 9:
+              case "end":
+                return _context.stop();
+            }
+          }
+        }, _callee, this);
+      }));
+
+      function getAll() {
+        return _getAll.apply(this, arguments);
+      }
+
+      return getAll;
+    }()
+    /**
+     * Returns a workspace.
+     *
+     * @param {String} name Name of the workspace
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object describing the workspaces
+     */
+
+  }, {
+    key: "get",
+    value: function () {
+      var _get = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(name) {
+        var response, grc, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee2$(_context2) {
+          while (1) {
+            switch (_context2.prev = _context2.next) {
+              case 0:
+                _context2.next = 2;
+                return (0, _nodeFetch["default"])(this.url + 'workspaces/' + name + '.json', {
+                  credentials: 'include',
+                  method: 'GET',
+                  headers: {
+                    Authorization: this.auth
+                  }
+                });
+
+              case 2:
+                response = _context2.sent;
+
+                if (response.ok) {
+                  _context2.next = 15;
+                  break;
+                }
+
+                grc = new _about["default"](this.url, this.auth);
+                _context2.next = 7;
+                return grc.exists();
+
+              case 7:
+                if (!_context2.sent) {
+                  _context2.next = 11;
+                  break;
+                }
+
+                return _context2.abrupt("return");
+
+              case 11:
+                _context2.next = 13;
+                return (0, _geoserver.getGeoServerResponseText)(response);
+
+              case 13:
+                geoServerResponse = _context2.sent;
+                throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+
+              case 15:
+                return _context2.abrupt("return", response.json());
+
+              case 16:
+              case "end":
+                return _context2.stop();
+            }
+          }
+        }, _callee2, this);
+      }));
+
+      function get(_x) {
+        return _get.apply(this, arguments);
+      }
+
+      return get;
+    }()
+    /**
+     * Creates a new workspace.
+     *
+     * @param {String} name Name of the new workspace
+     *
+     * @throws Error if request fails
+     *
+     * @returns {String} The name of the created workspace
+     */
+
+  }, {
+    key: "create",
+    value: function () {
+      var _create = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(name) {
+        var body, response, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
+          while (1) {
+            switch (_context3.prev = _context3.next) {
+              case 0:
+                body = {
+                  workspace: {
+                    name: name
+                  }
+                };
+                _context3.next = 3;
+                return (0, _nodeFetch["default"])(this.url + 'workspaces', {
+                  credentials: 'include',
+                  method: 'POST',
+                  headers: {
+                    Authorization: this.auth,
+                    'Content-Type': 'application/json'
+                  },
+                  body: JSON.stringify(body)
+                });
+
+              case 3:
+                response = _context3.sent;
+
+                if (response.ok) {
+                  _context3.next = 13;
+                  break;
+                }
+
+                _context3.next = 7;
+                return (0, _geoserver.getGeoServerResponseText)(response);
+
+              case 7:
+                geoServerResponse = _context3.sent;
+                _context3.t0 = response.status;
+                _context3.next = _context3.t0 === 409 ? 11 : 12;
+                break;
+
+              case 11:
+                throw new _geoserver.GeoServerResponseError('Unable to add workspace as it already exists', geoServerResponse);
+
+              case 12:
+                throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+
+              case 13:
+                return _context3.abrupt("return", response.text());
+
+              case 14:
+              case "end":
+                return _context3.stop();
+            }
+          }
+        }, _callee3, this);
+      }));
+
+      function create(_x2) {
+        return _create.apply(this, arguments);
+      }
+
+      return create;
+    }()
+    /**
+     * Deletes a workspace.
+     *
+     * @param {String} name Name of the workspace to delete
+     * @param {Boolean} recurse Flag to enable recursive deletion
+     *
+     * @throws Error if request fails
+     */
+
+  }, {
+    key: "delete",
+    value: function () {
+      var _delete2 = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee4(name, recurse) {
+        var response, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee4$(_context4) {
+          while (1) {
+            switch (_context4.prev = _context4.next) {
+              case 0:
+                _context4.next = 2;
+                return (0, _nodeFetch["default"])(this.url + 'workspaces/' + name + '?recurse=' + recurse, {
+                  credentials: 'include',
+                  method: 'DELETE',
+                  headers: {
+                    Authorization: this.auth
+                  }
+                });
+
+              case 2:
+                response = _context4.sent;
+
+                if (response.ok) {
+                  _context4.next = 13;
+                  break;
+                }
+
+                _context4.next = 6;
+                return (0, _geoserver.getGeoServerResponseText)(response);
+
+              case 6:
+                geoServerResponse = _context4.sent;
+                _context4.t0 = response.status;
+                _context4.next = _context4.t0 === 400 ? 10 : _context4.t0 === 404 ? 11 : 12;
+                break;
+
+              case 10:
+                throw new _geoserver.GeoServerResponseError('Workspace or related Namespace is not empty (and recurse not true)', geoServerResponse);
+
+              case 11:
+                throw new _geoserver.GeoServerResponseError('Workspace doesn\'t exist', geoServerResponse);
+
+              case 12:
+                throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+
+              case 13:
+              case "end":
+                return _context4.stop();
+            }
+          }
+        }, _callee4, this);
+      }));
+
+      function _delete(_x3, _x4) {
+        return _delete2.apply(this, arguments);
+      }
+
+      return _delete;
+    }()
+  }]);
+  return WorkspaceClient;
+}();
+
+exports["default"] = WorkspaceClient;

package/geoserver-rest-client.js

@@ -1,4 +1,3 @@
-import fetch from 'node-fetch';
 import LayerClient from './src/layer.js';
 import StyleClient from './src/style.js';
 import WorkspaceClient from './src/workspace.js';
@@ -7,6 +6,9 @@ import ImageMosaicClient from './src/imagemosaic.js';
 import SecurityClient from './src/security.js';
 import SettingsClient from './src/settings.js';
 import NamespaceClient from './src/namespace.js';
+import AboutClient from './src/about.js';
+
+export { GeoServerResponseError } from './src/util/geoserver.js'
 
 /**
  * Client for GeoServer REST API.
@@ -15,7 +17,7 @@ import NamespaceClient from './src/namespace.js';
  *
  * @module GeoServerRestClient
  */
-export default class GeoServerRestClient {
+export class GeoServerRestClient {
   /**
    * Creates a GeoServerRestClient instance.
    *
@@ -25,64 +27,25 @@ export default class GeoServerRestClient {
    */
   constructor (url, user, password) {
     this.url = url.endsWith('/') ? url : url + '/';
-    this.user = user;
-    this.password = password;
+    this.auth = 'Basic ' + Buffer.from(user + ':' + password).toString('base64');
 
     /** @member {LayerClient} layers GeoServer REST client instance for layers */
-    this.layers = new LayerClient(this.url, this.user, this.password);
+    this.layers = new LayerClient(this.url, this.auth);
     /** @member {StyleClient} styles GeoServer REST client instance for styles */
-    this.styles = new StyleClient(this.url, this.user, this.password);
+    this.styles = new StyleClient(this.url, this.auth);
     /** @member {WorkspaceClient} workspaces GeoServer REST client instance for workspaces */
-    this.workspaces = new WorkspaceClient(this.url, this.user, this.password);
+    this.workspaces = new WorkspaceClient(this.url, this.auth);
     /** @member {NamespaceClient} namespaces GeoServer REST client instance for namespaces */
-    this.namespaces = new NamespaceClient(this.url, this.user, this.password);
+    this.namespaces = new NamespaceClient(this.url, this.auth);
     /** @member {DatastoreClient} datastores GeoServer REST client instance for data stores */
-    this.datastores = new DatastoreClient(this.url, this.user, this.password);
+    this.datastores = new DatastoreClient(this.url, this.auth);
     /** @member {ImageMosaicClient} imagemosaics GeoServer REST client instance for image mosaics */
-    this.imagemosaics = new ImageMosaicClient(this.url, this.user, this.password);
+    this.imagemosaics = new ImageMosaicClient(this.url, this.auth);
     /** @member {SecurityClient} security GeoServer REST client instance for security related modifications */
-    this.security = new SecurityClient(this.url, this.user, this.password);
+    this.security = new SecurityClient(this.url, this.auth);
     /** @member {SettingsClient} settings GeoServer REST client instance for settings */
-    this.settings = new SettingsClient(this.url, this.user, this.password);
-  }
-
-  /**
-   * Get the GeoServer version.
-   *
-   * @returns {String|Boolean} The version of GeoServer or 'false'
-   */
-  async getVersion () {
-    try {
-      const auth =
-        Buffer.from(this.user + ':' + this.password).toString('base64');
-      const response = await fetch(this.url + 'about/version.json', {
-        credentials: 'include',
-        method: 'GET',
-        headers: {
-          Authorization: 'Basic ' + auth
-        }
-      });
-      return await response.json();
-    } catch (error) {
-      return false;
-    }
-  }
-
-  /**
-   * Checks if the configured GeoServer REST connection exists.
-   *
-   * @returns {Boolean} If the connection exists
-   */
-  async exists () {
-    try {
-      const versionInfo = await this.getVersion();
-      if (versionInfo) {
-        return true;
-      } else {
-        return false;
-      }
-    } catch (error) {
-      return false;
-    }
+    this.settings = new SettingsClient(this.url, this.auth);
+    /** @member {AboutClient} about GeoServer REST client instance for about endpoint */
+    this.about = new AboutClient(this.url, this.auth);
   }
 }

package/package.json

@@ -1,17 +1,31 @@
 {
   "name": "geoserver-node-client",
-  "version": "0.0.5",
+  "version": "1.0.0",
   "description": "Node.js client for GeoServer REST API",
   "type": "module",
   "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",
-    "lint": "eslint src/*.js demo/index.js test/test.js",
+    "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",
     "test": "mocha --timeout 10000",
-    "release": "release-it"
+    "release": "release-it",
+    "build": "npm run build:clean && npm run build:babel && npm run build:fixup",
+    "build:clean": "rm -rf dist",
+    "build:babel": "babel geoserver-rest-client.js -d dist && babel src -d dist/src",
+    "build:fixup": "node scripts/create-custom-package-json.js"
   },
+  "exports": {
+    "import": "./geoserver-rest-client.js",
+    "require": "./dist/geoserver-rest-client.js"
+  },
+  "files": [
+    "geoserver-rest-client.js",
+    "src",
+    "dist"
+  ],
   "keywords": [
     "GeoServer",
     "REST",
@@ -20,18 +34,22 @@
   "author": "C. Mayer, meggsimum (info_at*meggsimum?dot?de)",
   "license": "BSD-2-Clause",
   "dependencies": {
-    "node-fetch": "^2.6.1"
+    "node-fetch": "^2.6.5"
   },
   "devDependencies": {
-    "chai": "^4.3.0",
-    "eslint": "^7.21.0",
+    "@babel/cli": "^7.17.10",
+    "@babel/core": "^7.17.12",
+    "@babel/plugin-transform-runtime": "^7.18.0",
+    "@babel/preset-env": "^7.17.12",
+    "chai": "^4.3.4",
+    "eslint": "^7.32.0",
     "eslint-config-standard": "^14.1.1",
-    "eslint-plugin-import": "^2.22.1",
+    "eslint-plugin-import": "^2.25.2",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.3.1",
     "eslint-plugin-standard": "^4.1.0",
-    "jsdoc": "^3.6.6",
-    "mocha": "^8.3.0",
-    "release-it": "^14.10.0"
+    "jsdoc": "^3.6.10",
+    "mocha": "^9.1.3",
+    "release-it": "^14.14.3"
   }
 }

package/src/about.js

@@ -0,0 +1,59 @@
+import fetch from 'node-fetch';
+import { GeoServerResponseError, getGeoServerResponseText } from './util/geoserver.js';
+
+/**
+ * Client for GeoServer "about" endpoint
+ *
+ * @module AboutClient
+ */
+export default class AboutClient {
+  /**
+   * Creates a GeoServer REST AboutClient instance.
+   *
+   * @param {String} url The URL of the GeoServer REST API endpoint
+   * @param {String} auth The Basic Authentication string
+   */
+  constructor (url, auth) {
+    this.url = url;
+    this.auth = auth;
+  }
+
+  /**
+   * Get the GeoServer version.
+   *
+   * @throws Error if request fails
+   *
+   * @returns {Object} The version of GeoServer
+   */
+  async getVersion () {
+    const url = this.url + 'about/version.json';
+    const response = await fetch(url, {
+      credentials: 'include',
+      method: 'GET',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      throw new GeoServerResponseError(null, geoServerResponse);
+    }
+    return response.json();
+  }
+
+  /**
+   * Checks if the configured GeoServer REST connection exists.
+   *
+   * @returns {Boolean} If the connection exists
+   */
+  async exists () {
+    let versionInfo;
+    try {
+      versionInfo = await this.getVersion();
+      return !!versionInfo
+    } catch (error) {
+      return false;
+    }
+  }
+}