geoserver-node-client 1.5.2 → 1.6.1

package/README.md

@@ -117,14 +117,14 @@ A request either succeeds or throws the custom `GeoServerResponseError`. It has
 First start a test setup using this Docker compose file:
 
 ```shell
-docker-compose -f test/docker-compose.yml up
+GEOSERVER_VERSION=2.28.0 TEMP_DIR=/tmp/gs docker compose -f test/docker-compose.yml up
 ```
 
 Then, in an other terminal, run:
 
 ```shell
 # specify the GeoServer version and run the test suite
-GEOSERVER_VERSION=2.20.4 npm run test
+GEOSERVER_VERSION=2.28.0 npm run test
 ```
 
 ## Release
@@ -148,7 +148,7 @@ npm login
 # then enter your credentials
 ```
 
-3. Locally checkout the latest `master` branch that you would like to release, then run:
+3. Locally checkout the latest `main` branch that you would like to release, then run:
 
 ```shell
 npm run release

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "description": "Node.js client for GeoServer REST API",
   "type": "commonjs",
   "main": "geoserver-rest-client.js",
@@ -44,14 +44,14 @@
     "@babel/core": "^7.27.4",
     "@babel/plugin-transform-runtime": "^7.27.4",
     "@babel/preset-env": "^7.22.20",
-    "@eslint/compat": "^1.2.9",
+    "@eslint/compat": "^2.0.0",
     "chai": "^6.0.1",
     "eslint": "^9.29.0",
     "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^5.5.1",
     "jsdoc": "^4.0.2",
     "mocha": "^11.7.1",
-    "neostandard": "^0.12.1",
+    "neostandard": "^0.13.0",
     "prettier": "^3.6.1",
     "release-it": "^19.0.3"
   }

package/dist/src/security.js

@@ -242,26 +242,26 @@ var SecurityClient = exports["default"] = /*#__PURE__*/function () {
       return deleteUser;
     }()
     /**
-     * Associates the given role to the user.
-     *
-     * @param {String} username The name of the user to add the role to
-     * @param {String} role The role to associate
+     * Returns all roles registered in GeoServer.
      *
      * @throws Error if request fails
+     *
+     * @returns {Object} An object with all roles like { "roles": ["ADMIN", "GROUP_ADMIN"] }
      */
     )
   }, {
-    key: "associateUserRole",
+    key: "getAllRoles",
     value: (function () {
-      var _associateUserRole = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee5(username, role) {
-        var response, geoServerResponse;
+      var _getAllRoles = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee5() {
+        var url, response, geoServerResponse;
         return _regenerator["default"].wrap(function (_context5) {
           while (1) switch (_context5.prev = _context5.next) {
             case 0:
+              url = "".concat(this.url, "security/roles.json");
               _context5.next = 1;
-              return (0, _nodeFetch["default"])("".concat(this.url, "security/roles/role/").concat(role, "/user/").concat(username), {
+              return (0, _nodeFetch["default"])(url, {
                 credentials: 'include',
-                method: 'POST',
+                method: 'GET',
                 headers: {
                   Authorization: this.auth
                 }
@@ -278,15 +278,330 @@ var SecurityClient = exports["default"] = /*#__PURE__*/function () {
               geoServerResponse = _context5.sent;
               throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
             case 3:
+              return _context5.abrupt("return", response.json());
+            case 4:
             case "end":
               return _context5.stop();
           }
         }, _callee5, this);
       }));
-      function associateUserRole(_x7, _x8) {
+      function getAllRoles() {
+        return _getAllRoles.apply(this, arguments);
+      }
+      return getAllRoles;
+    }()
+    /**
+     * Creates a new role.
+     *
+     * @param {String} role The name of the role to be created
+     *
+     * @throws Error if request fails
+     */
+    )
+  }, {
+    key: "createRole",
+    value: (function () {
+      var _createRole = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee6(role) {
+        var url, response, geoServerResponse, _t2;
+        return _regenerator["default"].wrap(function (_context6) {
+          while (1) switch (_context6.prev = _context6.next) {
+            case 0:
+              url = "".concat(this.url, "security/roles/role/").concat(role);
+              _context6.next = 1;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'POST',
+                headers: {
+                  Authorization: this.auth
+                }
+              });
+            case 1:
+              response = _context6.sent;
+              if (response.ok) {
+                _context6.next = 5;
+                break;
+              }
+              _context6.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context6.sent;
+              _t2 = response.status;
+              _context6.next = _t2 === 404 ? 3 : 4;
+              break;
+            case 3:
+              throw new _geoserver.GeoServerResponseError("Role ".concat(role, " might already exist."), geoServerResponse);
+            case 4:
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 5:
+            case "end":
+              return _context6.stop();
+          }
+        }, _callee6, this);
+      }));
+      function createRole(_x7) {
+        return _createRole.apply(this, arguments);
+      }
+      return createRole;
+    }()
+    /**
+     * Deletes an existing role.
+     *
+     * @param {String} role The name of the role to be deleted
+     *
+     * @throws Error if request fails
+     */
+    )
+  }, {
+    key: "deleteRole",
+    value: (function () {
+      var _deleteRole = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee7(role) {
+        var url, response, geoServerResponse, _t3;
+        return _regenerator["default"].wrap(function (_context7) {
+          while (1) switch (_context7.prev = _context7.next) {
+            case 0:
+              url = "".concat(this.url, "security/roles/role/").concat(role);
+              _context7.next = 1;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'DELETE',
+                headers: {
+                  Authorization: this.auth
+                }
+              });
+            case 1:
+              response = _context7.sent;
+              if (response.ok) {
+                _context7.next = 5;
+                break;
+              }
+              _context7.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context7.sent;
+              _t3 = response.status;
+              _context7.next = _t3 === 404 ? 3 : 4;
+              break;
+            case 3:
+              throw new _geoserver.GeoServerResponseError("Role ".concat(role, " not existing."), geoServerResponse);
+            case 4:
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 5:
+            case "end":
+              return _context7.stop();
+          }
+        }, _callee7, this);
+      }));
+      function deleteRole(_x8) {
+        return _deleteRole.apply(this, arguments);
+      }
+      return deleteRole;
+    }()
+    /**
+     * Associates the given role to the user.
+     *
+     * @param {String} username The name of the user to add the role to
+     * @param {String} role The role to associate
+     *
+     * @throws Error if request fails
+     */
+    )
+  }, {
+    key: "associateUserRole",
+    value: (function () {
+      var _associateUserRole = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee8(username, role) {
+        var response, geoServerResponse;
+        return _regenerator["default"].wrap(function (_context8) {
+          while (1) switch (_context8.prev = _context8.next) {
+            case 0:
+              _context8.next = 1;
+              return (0, _nodeFetch["default"])("".concat(this.url, "security/roles/role/").concat(role, "/user/").concat(username), {
+                credentials: 'include',
+                method: 'POST',
+                headers: {
+                  Authorization: this.auth
+                }
+              });
+            case 1:
+              response = _context8.sent;
+              if (response.ok) {
+                _context8.next = 3;
+                break;
+              }
+              _context8.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context8.sent;
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 3:
+            case "end":
+              return _context8.stop();
+          }
+        }, _callee8, this);
+      }));
+      function associateUserRole(_x9, _x0) {
         return _associateUserRole.apply(this, arguments);
       }
       return associateUserRole;
+    }()
+    /**
+     * Returns all data access rules registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all data access rules like { "*.*.r": ["ADMIN", "GROUP_ADMIN"] }
+     */
+    )
+  }, {
+    key: "getAllAccessRules",
+    value: (function () {
+      var _getAllAccessRules = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee9() {
+        var url, response, geoServerResponse;
+        return _regenerator["default"].wrap(function (_context9) {
+          while (1) switch (_context9.prev = _context9.next) {
+            case 0:
+              url = "".concat(this.url, "security/acl/layers.json");
+              _context9.next = 1;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'GET',
+                headers: {
+                  Authorization: this.auth
+                }
+              });
+            case 1:
+              response = _context9.sent;
+              if (response.ok) {
+                _context9.next = 3;
+                break;
+              }
+              _context9.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context9.sent;
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 3:
+              return _context9.abrupt("return", response.json());
+            case 4:
+            case "end":
+              return _context9.stop();
+          }
+        }, _callee9, this);
+      }));
+      function getAllAccessRules() {
+        return _getAllAccessRules.apply(this, arguments);
+      }
+      return getAllAccessRules;
+    }()
+    /**
+     * Creates a new data access rule.
+     *
+     * @param {String} rule The rule in the form '<MY_WS>.<MY_LAYER>.r'
+     * @param {String[]} roles The roles to allow access to rule
+     *
+     * @throws Error if request fails
+     */
+    )
+  }, {
+    key: "createDataAccessRule",
+    value: (function () {
+      var _createDataAccessRule = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee0(rule, roles) {
+        var url, body, response, geoServerResponse, _t4;
+        return _regenerator["default"].wrap(function (_context0) {
+          while (1) switch (_context0.prev = _context0.next) {
+            case 0:
+              url = "".concat(this.url, "security/acl/layers");
+              body = {};
+              body[rule] = roles.join(',');
+              _context0.next = 1;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'POST',
+                headers: {
+                  Authorization: this.auth,
+                  'Content-Type': 'application/json'
+                },
+                body: JSON.stringify(body)
+              });
+            case 1:
+              response = _context0.sent;
+              if (response.ok) {
+                _context0.next = 5;
+                break;
+              }
+              _context0.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context0.sent;
+              _t4 = response.status;
+              _context0.next = _t4 === 404 ? 3 : 4;
+              break;
+            case 3:
+              throw new _geoserver.GeoServerResponseError("Rule ".concat(rule, " might already exists."), geoServerResponse);
+            case 4:
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 5:
+            case "end":
+              return _context0.stop();
+          }
+        }, _callee0, this);
+      }));
+      function createDataAccessRule(_x1, _x10) {
+        return _createDataAccessRule.apply(this, arguments);
+      }
+      return createDataAccessRule;
+    }()
+    /**
+     * Deletes an existing data access rule.
+     *
+     * @param {String} rule The rule to be deleted, like '<MY_WS>.<MY_LAYER>.r'
+     *
+     * @throws Error if request fails
+     */
+    )
+  }, {
+    key: "deleteDataAccessRule",
+    value: (function () {
+      var _deleteDataAccessRule = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee1(rule) {
+        var url, response, geoServerResponse, _t5;
+        return _regenerator["default"].wrap(function (_context1) {
+          while (1) switch (_context1.prev = _context1.next) {
+            case 0:
+              url = "".concat(this.url, "security/acl/layers/").concat(rule);
+              _context1.next = 1;
+              return (0, _nodeFetch["default"])(url, {
+                credentials: 'include',
+                method: 'DELETE',
+                headers: {
+                  Authorization: this.auth
+                }
+              });
+            case 1:
+              response = _context1.sent;
+              if (response.ok) {
+                _context1.next = 5;
+                break;
+              }
+              _context1.next = 2;
+              return (0, _geoserver.getGeoServerResponseText)(response);
+            case 2:
+              geoServerResponse = _context1.sent;
+              _t5 = response.status;
+              _context1.next = _t5 === 404 ? 3 : 4;
+              break;
+            case 3:
+              throw new _geoserver.GeoServerResponseError("Rule ".concat(rule, " not existing."), geoServerResponse);
+            case 4:
+              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
+            case 5:
+            case "end":
+              return _context1.stop();
+          }
+        }, _callee1, this);
+      }));
+      function deleteDataAccessRule(_x11) {
+        return _deleteDataAccessRule.apply(this, arguments);
+      }
+      return deleteDataAccessRule;
     }())
   }]);
 }();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.5.2",
+  "version": "1.6.1",
   "description": "Node.js client for GeoServer REST API",
   "type": "module",
   "main": "geoserver-rest-client.js",
@@ -44,14 +44,14 @@
     "@babel/core": "^7.27.4",
     "@babel/plugin-transform-runtime": "^7.27.4",
     "@babel/preset-env": "^7.22.20",
-    "@eslint/compat": "^1.2.9",
+    "@eslint/compat": "^2.0.0",
     "chai": "^6.0.1",
     "eslint": "^9.29.0",
     "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^5.5.1",
     "jsdoc": "^4.0.2",
     "mocha": "^11.7.1",
-    "neostandard": "^0.12.1",
+    "neostandard": "^0.13.0",
     "prettier": "^3.6.1",
     "release-it": "^19.0.3"
   }

package/src/security.js

@@ -138,6 +138,89 @@ export default class SecurityClient {
     }
   }
 
+  /**
+   * Returns all roles registered in GeoServer.
+   *
+   * @throws Error if request fails
+   *
+   * @returns {Object} An object with all roles like { "roles": ["ADMIN", "GROUP_ADMIN"] }
+   */
+  async getAllRoles() {
+    const url = `${this.url}security/roles.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();
+  }
+
+  /**
+   * Creates a new role.
+   *
+   * @param {String} role The name of the role to be created
+   *
+   * @throws Error if request fails
+   */
+  async createRole(role) {
+    const url = `${this.url}security/roles/role/${role}`;
+
+    const response = await fetch(url, {
+      credentials: 'include',
+      method: 'POST',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 404:
+          throw new GeoServerResponseError(`Role ${role} might already exist.`, geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
+      }
+    }
+  }
+
+  /**
+   * Deletes an existing role.
+   *
+   * @param {String} role The name of the role to be deleted
+   *
+   * @throws Error if request fails
+   */
+  async deleteRole(role) {
+    const url = `${this.url}security/roles/role/${role}`;
+
+    const response = await fetch(url, {
+      credentials: 'include',
+      method: 'DELETE',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 404:
+          throw new GeoServerResponseError(`Role ${role} not existing.`, geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
+      }
+    }
+  }
+
   /**
    * Associates the given role to the user.
    *
@@ -160,4 +243,92 @@ export default class SecurityClient {
       throw new GeoServerResponseError(null, geoServerResponse);
     }
   }
+
+  /**
+   * Returns all data access rules registered in GeoServer.
+   *
+   * @throws Error if request fails
+   *
+   * @returns {Object} An object with all data access rules like { "*.*.r": ["ADMIN", "GROUP_ADMIN"] }
+   */
+  async getAllAccessRules() {
+    const url = `${this.url}security/acl/layers.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();
+  }
+
+  /**
+   * Creates a new data access rule.
+   *
+   * @param {String} rule The rule in the form '<MY_WS>.<MY_LAYER>.r'
+   * @param {String[]} roles The roles to allow access to rule
+   *
+   * @throws Error if request fails
+   */
+  async createDataAccessRule(rule, roles) {
+    const url = `${this.url}security/acl/layers`;
+    const body = {};
+    body[rule] = roles.join(',');
+
+    const response = await fetch(url, {
+      credentials: 'include',
+      method: 'POST',
+      headers: {
+        Authorization: this.auth,
+        'Content-Type': 'application/json'
+      },
+      body: JSON.stringify(body)
+    });
+
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 404:
+          throw new GeoServerResponseError(`Rule ${rule} might already exists.`, geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
+      }
+    }
+  }
+
+  /**
+   * Deletes an existing data access rule.
+   *
+   * @param {String} rule The rule to be deleted, like '<MY_WS>.<MY_LAYER>.r'
+   *
+   * @throws Error if request fails
+   */
+  async deleteDataAccessRule(rule) {
+    const url = `${this.url}security/acl/layers/${rule}`;
+
+    const response = await fetch(url, {
+      credentials: 'include',
+      method: 'DELETE',
+      headers: {
+        Authorization: this.auth
+      }
+    });
+
+    if (!response.ok) {
+      const geoServerResponse = await getGeoServerResponseText(response);
+      switch (response.status) {
+        case 404:
+          throw new GeoServerResponseError(`Rule ${rule} not existing.`, geoServerResponse);
+        default:
+          throw new GeoServerResponseError(null, geoServerResponse);
+      }
+    }
+  }
 }