geoserver-node-client 1.6.1 → 2.0.0

package/README.md

@@ -18,8 +18,9 @@ Detailed [API-Docs](https://meggsimum.github.io/geoserver-node-client/) are auto
 
 Compatible with [GeoServer](https://geoserver.org)
 
+- v3.0.x
 - v2.28.x
-- v2.27.x
+- v2.27.x (no more maintained and officially deprecated)
 - v2.26.x (no more maintained and officially deprecated)
 - v2.25.x (no more maintained and officially deprecated)
 - v2.24.x (no more maintained and officially deprecated)
@@ -37,39 +38,39 @@ Compatible with [GeoServer](https://geoserver.org)
 npm i geoserver-node-client
 ```
 
-usage with require (ES5):
+usage as ES module (ES6)
 
 ```js
-var grcImport = require('geoserver-node-client');
-var GeoServerRestClient = grcImport.GeoServerRestClient;
+import {GeoServerRestClient} from 'geoserver-node-client';
 
-var url = 'http://localhost:8080/geoserver/rest/';
-var user = 'admin';
-var pw = 'geoserver';
-var grc = new GeoServerRestClient(url, user, pw);
+const url = 'http://localhost:8080/geoserver/rest/';
+const user = 'admin';
+const pw = 'geoserver';
+const grc = new GeoServerRestClient(url, user, pw);
 
-function main () {
-    grc.about.exists().then(function (result) {
-      console.log(result);
-    });
+async function main () {
+  const result =  await grc.about.exists();
+  console.log(result);
 };
 
 main();
 ```
 
-usage as ES module (ES6)
+usage with require (ES5):
 
 ```js
-import {GeoServerRestClient} from 'geoserver-node-client';
+var grcImport = require('geoserver-node-client');
+var GeoServerRestClient = grcImport.GeoServerRestClient;
 
-const url = 'http://localhost:8080/geoserver/rest/';
-const user = 'admin';
-const pw = 'geoserver';
-const grc = new GeoServerRestClient(url, user, pw);
+var url = 'http://localhost:8080/geoserver/rest/';
+var user = 'admin';
+var pw = 'geoserver';
+var grc = new GeoServerRestClient(url, user, pw);
 
-async function main () {
-    const result =  await grc.about.exists();
+function main () {
+  grc.about.exists().then(function (result) {
     console.log(result);
+  });
 };
 
 main();
@@ -117,14 +118,14 @@ A request either succeeds or throws the custom `GeoServerResponseError`. It has
 First start a test setup using this Docker compose file:
 
 ```shell
-GEOSERVER_VERSION=2.28.0 TEMP_DIR=/tmp/gs docker compose -f test/docker-compose.yml up
+GEOSERVER_VERSION=3.0.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.28.0 npm run test
+GEOSERVER_VERSION=3.0.0 npm run test
 ```
 
 ## Release

package/dist/geoserver-rest-client.js

@@ -1,18 +1,16 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
 Object.defineProperty(exports, "GeoServerResponseError", {
   enumerable: true,
-  get: function get() {
+  get: function () {
     return _geoserver.GeoServerResponseError;
   }
 });
 exports.GeoServerRestClient = void 0;
-var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
-var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _layer = _interopRequireDefault(require("./src/layer.js"));
 var _style = _interopRequireDefault(require("./src/style.js"));
 var _workspace = _interopRequireDefault(require("./src/workspace.js"));
@@ -32,39 +30,40 @@ var _geoserver = require("./src/util/geoserver.js");
  *
  * @module GeoServerRestClient
  */
-var GeoServerRestClient = exports.GeoServerRestClient = /*#__PURE__*/(0, _createClass2["default"])(
-/**
- * Creates a GeoServerRestClient instance.
- *
- * @param {String} url The URL of the GeoServer REST API endpoint
- * @param {String} user The user for the GeoServer REST API
- * @param {String} password The password for the GeoServer REST API
- */
-function GeoServerRestClient(url, user, password) {
-  (0, _classCallCheck2["default"])(this, GeoServerRestClient);
-  this.url = url.endsWith('/') ? url : url + '/';
-  this.auth = 'Basic ' + Buffer.from(user + ':' + password).toString('base64');
+class GeoServerRestClient {
+  /**
+   * Creates a GeoServerRestClient instance.
+   *
+   * @param {String} url The URL of the GeoServer REST API endpoint
+   * @param {String} user The user for the GeoServer REST API
+   * @param {String} password The password for the GeoServer REST API
+   */
+  constructor(url, user, password) {
+    this.url = url.endsWith('/') ? url : url + '/';
+    this.auth = 'Basic ' + Buffer.from(user + ':' + password).toString('base64');
 
-  /** @member {LayerClient} layers GeoServer REST client instance for layers */
-  this.layers = new _layer["default"](this.url, this.auth);
-  /** @member {LayerGroupClient} layers GeoServer REST client instance for layergroups */
-  this.layergroups = new _layergroup["default"](this.url, this.auth);
-  /** @member {StyleClient} styles GeoServer REST client instance for styles */
-  this.styles = new _style["default"](this.url, this.auth);
-  /** @member {WorkspaceClient} workspaces GeoServer REST client instance for workspaces */
-  this.workspaces = new _workspace["default"](this.url, this.auth);
-  /** @member {NamespaceClient} namespaces GeoServer REST client instance for namespaces */
-  this.namespaces = new _namespace["default"](this.url, this.auth);
-  /** @member {DatastoreClient} datastores GeoServer REST client instance for data stores */
-  this.datastores = new _datastore["default"](this.url, this.auth);
-  /** @member {ImageMosaicClient} imagemosaics GeoServer REST client instance for image mosaics */
-  this.imagemosaics = new _imagemosaic["default"](this.url, this.auth);
-  /** @member {SecurityClient} security GeoServer REST client instance for security related modifications */
-  this.security = new _security["default"](this.url, this.auth);
-  /** @member {SettingsClient} settings GeoServer REST client instance for settings */
-  this.settings = new _settings["default"](this.url, this.auth);
-  /** @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);
-});
+    /** @member {LayerClient} layers GeoServer REST client instance for layers */
+    this.layers = new _layer.default(this.url, this.auth);
+    /** @member {LayerGroupClient} layers GeoServer REST client instance for layergroups */
+    this.layergroups = new _layergroup.default(this.url, this.auth);
+    /** @member {StyleClient} styles GeoServer REST client instance for styles */
+    this.styles = new _style.default(this.url, this.auth);
+    /** @member {WorkspaceClient} workspaces GeoServer REST client instance for workspaces */
+    this.workspaces = new _workspace.default(this.url, this.auth);
+    /** @member {NamespaceClient} namespaces GeoServer REST client instance for namespaces */
+    this.namespaces = new _namespace.default(this.url, this.auth);
+    /** @member {DatastoreClient} datastores GeoServer REST client instance for data stores */
+    this.datastores = new _datastore.default(this.url, this.auth);
+    /** @member {ImageMosaicClient} imagemosaics GeoServer REST client instance for image mosaics */
+    this.imagemosaics = new _imagemosaic.default(this.url, this.auth);
+    /** @member {SecurityClient} security GeoServer REST client instance for security related modifications */
+    this.security = new _security.default(this.url, this.auth);
+    /** @member {SettingsClient} settings GeoServer REST client instance for settings */
+    this.settings = new _settings.default(this.url, this.auth);
+    /** @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,9 +1,10 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.6.1",
+  "version": "2.0.0",
   "description": "Node.js client for GeoServer REST API",
   "type": "commonjs",
   "main": "geoserver-rest-client.js",
+  "types": "./dist/types/geoserver-rest-client.d.ts",
   "scripts": {
     "demo": "node demo/index.js",
     "docs": "./node_modules/.bin/jsdoc geoserver-rest-client.js src/*.js DOCS_HOME.md && cp img/*.png out/",
@@ -14,14 +15,18 @@
     "test:reset-gs": "node test/reset-gs.js",
     "release": "release-it",
     "release:dry": "release-it --dry-run",
-    "build": "npm run build:clean && npm run build:babel && npm run build:fixup",
+    "build": "npm run build:clean && npm run build:babel && npm run build:types && npm run build:fixup",
     "build:clean": "rm -rf dist",
     "build:babel": "babel geoserver-rest-client.js -d dist && babel src -d dist/src",
+    "build:types": "tsc -p tsconfig.json",
     "build:fixup": "node scripts/create-custom-package-json.js"
   },
   "exports": {
-    "import": "./geoserver-rest-client.js",
-    "require": "./dist/geoserver-rest-client.js"
+    ".": {
+      "types": "./dist/types/geoserver-rest-client.d.ts",
+      "import": "./geoserver-rest-client.js",
+      "require": "./dist/geoserver-rest-client.js"
+    }
   },
   "files": [
     "geoserver-rest-client.js",
@@ -36,15 +41,16 @@
   "author": "C. Mayer, meggsimum (info_at*meggsimum?dot?de)",
   "license": "BSD-2-Clause",
   "dependencies": {
-    "@babel/runtime": "^7.27.6",
+    "@babel/runtime": "^8.0.0",
     "node-fetch": "^3.3.2"
   },
   "devDependencies": {
-    "@babel/cli": "^7.23.0",
-    "@babel/core": "^7.27.4",
-    "@babel/plugin-transform-runtime": "^7.27.4",
-    "@babel/preset-env": "^7.22.20",
+    "@babel/cli": "^8.0.0",
+    "@babel/core": "^8.0.0",
+    "@babel/plugin-transform-runtime": "^8.0.0",
+    "@babel/preset-env": "^8.0.0",
     "@eslint/compat": "^2.0.0",
+    "@types/node": "^26.0.0",
     "chai": "^6.0.1",
     "eslint": "^9.29.0",
     "eslint-config-prettier": "^10.1.5",
@@ -53,6 +59,7 @@
     "mocha": "^11.7.1",
     "neostandard": "^0.13.0",
     "prettier": "^3.6.1",
-    "release-it": "^19.0.3"
+    "release-it": "^20.0.0",
+    "typescript": "^6.0.3"
   }
 }

package/dist/src/about.js

@@ -1,14 +1,10 @@
 "use strict";
 
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
 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"));
+exports.default = void 0;
 var _nodeFetch = _interopRequireDefault(require("node-fetch"));
 var _geoserver = require("./util/geoserver.js");
 /**
@@ -16,15 +12,14 @@ var _geoserver = require("./util/geoserver.js");
  *
  * @module AboutClient
  */
-var AboutClient = exports["default"] = /*#__PURE__*/function () {
+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
    */
-  function AboutClient(url, auth) {
-    (0, _classCallCheck2["default"])(this, AboutClient);
+  constructor(url, auth) {
     this.url = url;
     this.auth = auth;
   }
@@ -36,81 +31,35 @@ var AboutClient = exports["default"] = /*#__PURE__*/function () {
    *
    * @returns {Object} The version of GeoServer
    */
-  return (0, _createClass2["default"])(AboutClient, [{
-    key: "getVersion",
-    value: (function () {
-      var _getVersion = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee() {
-        var url, response, geoServerResponse;
-        return _regenerator["default"].wrap(function (_context) {
-          while (1) switch (_context.prev = _context.next) {
-            case 0:
-              url = this.url + 'about/version.json';
-              _context.next = 1;
-              return (0, _nodeFetch["default"])(url, {
-                credentials: 'include',
-                method: 'GET',
-                headers: {
-                  Authorization: this.auth
-                }
-              });
-            case 1:
-              response = _context.sent;
-              if (response.ok) {
-                _context.next = 3;
-                break;
-              }
-              _context.next = 2;
-              return (0, _geoserver.getGeoServerResponseText)(response);
-            case 2:
-              geoServerResponse = _context.sent;
-              throw new _geoserver.GeoServerResponseError(null, geoServerResponse);
-            case 3:
-              return _context.abrupt("return", response.json());
-            case 4:
-            case "end":
-              return _context.stop();
-          }
-        }, _callee, this);
-      }));
-      function getVersion() {
-        return _getVersion.apply(this, arguments);
+  async getVersion() {
+    const url = this.url + 'about/version.json';
+    const response = await (0, _nodeFetch.default)(url, {
+      credentials: 'include',
+      method: 'GET',
+      headers: {
+        Authorization: this.auth
       }
-      return getVersion;
-    }()
-    /**
-     * Checks if the configured GeoServer REST connection exists.
-     *
-     * @returns {Boolean} If the connection exists
-     */
-    )
-  }, {
-    key: "exists",
-    value: (function () {
-      var _exists = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee2() {
-        var versionInfo, _t;
-        return _regenerator["default"].wrap(function (_context2) {
-          while (1) switch (_context2.prev = _context2.next) {
-            case 0:
-              _context2.prev = 0;
-              _context2.next = 1;
-              return this.getVersion();
-            case 1:
-              versionInfo = _context2.sent;
-              return _context2.abrupt("return", !!versionInfo);
-            case 2:
-              _context2.prev = 2;
-              _t = _context2["catch"](0);
-              return _context2.abrupt("return", false);
-            case 3:
-            case "end":
-              return _context2.stop();
-          }
-        }, _callee2, this, [[0, 2]]);
-      }));
-      function exists() {
-        return _exists.apply(this, arguments);
-      }
-      return exists;
-    }())
-  }]);
-}();
+    });
+    if (!response.ok) {
+      const geoServerResponse = await (0, _geoserver.getGeoServerResponseText)(response);
+      throw new _geoserver.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 {
+      return false;
+    }
+  }
+}
+exports.default = AboutClient;