geoserver-node-client 1.3.0 → 1.4.0

package/dist/src/layergroup.js

@@ -0,0 +1,275 @@
+"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 _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+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"));
+var _layer = _interopRequireDefault(require("./layer.js"));
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+/**
+ * Client for GeoServer layergroups
+ *
+ * @module LayerGroupClient
+ */
+var LayerGroupClient = /*#__PURE__*/function () {
+  /**
+   * Creates a GeoServer REST LayerGroupClient instance.
+   *
+   * @param {String} url The URL of the GeoServer REST API endpoint
+   * @param {String} auth The Basic Authentication string
+   */
+  function LayerGroupClient(url, auth) {
+    (0, _classCallCheck2["default"])(this, LayerGroupClient);
+    this.url = url;
+    this.auth = auth;
+  }
+
+  /**
+   * @typedef {object} bounds
+   * @property {number} minx The minimum x coordinates. Default: -180
+   * @property {number} miny The minimum y coordinates. Default: -90
+   * @property {number} maxx The maximum x coordinates. Default: 180
+   * @property {number} maxy The maximum y coordinates. Default: 90
+   * @property {String} crs The crs of the bounds. Default: 'EPSG:4326'
+   */
+
+  /**
+   * Create a GeoServer layergroup by the given workspace, layerGroupName, layers and options
+   * @param {String} workspace The name of the workspace
+   * @param {String} layerGroupName The name of the layer group
+   * @param {Array.<String>} layers List of layers to be added to the group. Must be in same workspace as layergroup
+   * @param {String} options.mode The mode of the layergroup. Default to SINGLE
+   * @param {String} options.layerGroupTitle The title of the layergroup.
+   * @param {bounds} options.bounds The bounds of the layer group.
+   *
+   * @throws Error if request fails
+   *
+   * @returns {string} A string with layer group location or undefined if not found
+   */
+  (0, _createClass2["default"])(LayerGroupClient, [{
+    key: "create",
+    value: function () {
+      var _create = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee(workspace, layerGroupName, layers, layerGroupOptions) {
+        var options, publishedLayers, styles, _iterator, _step, l, body, response, grc, geoServerResponse, location;
+        return _regenerator["default"].wrap(function _callee$(_context) {
+          while (1) switch (_context.prev = _context.next) {
+            case 0:
+              options = _objectSpread({
+                mode: 'SINGLE',
+                layerGroupTitle: '',
+                abstractTxt: '',
+                bounds: {
+                  minx: -180,
+                  maxx: -90,
+                  miny: 180,
+                  maxy: 90,
+                  crs: 'EPSG:4326'
+                }
+              }, layerGroupOptions);
+              publishedLayers = [];
+              styles = [];
+              _iterator = _createForOfIteratorHelper(layers);
+              try {
+                for (_iterator.s(); !(_step = _iterator.n()).done;) {
+                  l = _step.value;
+                  publishedLayers.push({
+                    '@type': 'layer',
+                    name: "".concat(workspace, ":").concat(l),
+                    href: "".concat(this.url, "/workspaces/").concat(workspace, "/layers/").concat(l, ".json")
+                  });
+                  // use default style by define empty string
+                  styles.push('');
+                }
+              } catch (err) {
+                _iterator.e(err);
+              } finally {
+                _iterator.f();
+              }
+              body = {
+                layerGroup: _objectSpread({
+                  name: layerGroupName,
+                  workspace: {
+                    name: workspace
+                  },
+                  publishables: {
+                    published: publishedLayers
+                  },
+                  styles: {
+                    style: styles
+                  }
+                }, options)
+              };
+              _context.next = 8;
+              return (0, _nodeFetch["default"])("".concat(this.url, "/workspaces/").concat(workspace, "/layergroups"), {
+                credentials: 'include',
+                method: 'POST',
+                headers: {
+                  Authorization: this.auth,
+                  'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body)
+              });
+            case 8:
+              response = _context.sent;
+              if (response.ok) {
+                _context.next = 21;
+                break;
+              }
+              grc = new _about["default"](this.url, this.auth);
+              _context.next = 13;
+              return grc.exists();
+            case 13:
+              if (!_context.sent) {
+                _context.next = 17;
+                break;
+              }
+              return _context.abrupt("return");
+            case 17:
+              _context.next = 19;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 19:
+              geoServerResponse = _context.sent;
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 21:
+              // get resource location from response header
+              location = response.headers.get('location'); // return resource location
+              return _context.abrupt("return", location);
+            case 23:
+            case "end":
+              return _context.stop();
+          }
+        }, _callee, this);
+      }));
+      function create(_x, _x2, _x3, _x4) {
+        return _create.apply(this, arguments);
+      }
+      return create;
+    }()
+    /**
+     * Returns a GeoServer layergroup by the given workspace and layergroup name,
+     * e.g. "myWs:myLayergroup".
+     *
+     * @param {String} workspace The name of the workspace
+     * @param {String} layerGroupName The name of the layer group to query
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with layer group information or undefined if it cannot be found
+     */
+  }, {
+    key: "get",
+    value: function () {
+      var _get = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee2(workspace, layerGroupName) {
+        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"])("".concat(this.url, "/workspaces/").concat(workspace, "/layergroups/").concat(layerGroupName, ".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(_x5, _x6) {
+        return _get.apply(this, arguments);
+      }
+      return get;
+    }()
+    /**
+     * Updates an existing GeoServer layergroup
+     *
+     * @param {String} workspace The name of the workspace
+     * @param {String} layerName The name of the layergroup to update
+     * @param {Object} layerGroupDefinition The updated definiton of the layergroup
+     *
+     * @throws Error if request fails
+     */
+  }, {
+    key: "update",
+    value: function () {
+      var _update = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regenerator["default"].mark(function _callee3(workspace, layerGroupName, layerGroupDefinition) {
+        var url, response, geoServerResponse;
+        return _regenerator["default"].wrap(function _callee3$(_context3) {
+          while (1) switch (_context3.prev = _context3.next) {
+            case 0:
+              url = "".concat(this.url, "/workspaces/").concat(workspace, "/layergroups/").concat(layerGroupName, ".json");
+              _context3.next = 3;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'PUT',
+                headers: {
+                  Authorization: this.auth,
+                  'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(layerGroupDefinition)
+              });
+            case 3:
+              response = _context3.sent;
+              if (response.ok) {
+                _context3.next = 9;
+                break;
+              }
+              _context3.next = 7;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 7:
+              geoServerResponse = _context3.sent;
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 9:
+            case "end":
+              return _context3.stop();
+          }
+        }, _callee3, this);
+      }));
+      function update(_x7, _x8, _x9) {
+        return _update.apply(this, arguments);
+      }
+      return update;
+    }()
+  }]);
+  return LayerGroupClient;
+}();
+exports["default"] = LayerGroupClient;