geoserver-node-client 1.6.1 → 2.0.0

package/dist/types/src/reset-reload.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Client for GeoServer "Reset/Reload" to clear internal caches and reload
+ * configuration from disk endpoint.
+ *
+ * @module ResetReloadClient
+ */
+export default class ResetReloadClient {
+    /**
+     * Creates a GeoServer REST ResetReloadClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Resets all store, raster, and schema caches. This operation is used to
+     * force GeoServer to drop all caches and store connections and reconnect to
+     * each of them the next time they are needed by a request.
+     * This is useful in case the stores themselves cache some information about
+     * the data structures they manage that may have changed in the meantime.
+     *
+     * @throws Error if request fails
+     */
+    reset(): Promise<void>;
+    /**
+     * Reloads the GeoServer catalog and configuration from disk. This operation
+     * is used in cases where an external tool has modified the on-disk
+     * configuration. This operation will also force GeoServer to drop any
+     * internal caches and reconnect to all data stores.
+     *
+     * @throws Error if request fails
+     */
+    reload(): Promise<void>;
+}

package/dist/types/src/security.d.ts

@@ -0,0 +1,110 @@
+/**
+ * Client for GeoServer security.
+ *
+ * @module SecurityClient
+ */
+export default class SecurityClient {
+    /**
+     * Creates a GeoServer REST SecurityClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all users registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all users
+     */
+    getAllUsers(): Object;
+    /**
+     * Creates a new user.
+     *
+     * @param {String} username The name of the user to be created
+     * @param {String} password The password of the user to be created
+     *
+     * @throws Error if request fails
+     */
+    createUser(username: string, password: string): Promise<void>;
+    /**
+     * Updates an existing user. User name is only taken for identification and
+     * cannot be changed with this API call.
+     *
+     * @param {String} username The name of the user to be created
+     * @param {String} password The password of the user to be created
+     * @param {Boolean} enabled Enable / disable the user
+     *
+     * @throws Error if request fails
+     */
+    updateUser(username: string, password: string, enabled: boolean): Promise<void>;
+    /**
+     * Deletes an existing user.
+     *
+     * @param {String} username The name of the user to be deleted
+     *
+     * @throws Error if request fails
+     */
+    deleteUser(username: string): Promise<void>;
+    /**
+     * Returns all roles registered in GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all roles like { "roles": ["ADMIN", "GROUP_ADMIN"] }
+     */
+    getAllRoles(): Object;
+    /**
+     * Creates a new role.
+     *
+     * @param {String} role The name of the role to be created
+     *
+     * @throws Error if request fails
+     */
+    createRole(role: string): Promise<void>;
+    /**
+     * Deletes an existing role.
+     *
+     * @param {String} role The name of the role to be deleted
+     *
+     * @throws Error if request fails
+     */
+    deleteRole(role: string): Promise<void>;
+    /**
+     * 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
+     */
+    associateUserRole(username: string, role: string): Promise<void>;
+    /**
+     * 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"] }
+     */
+    getAllAccessRules(): Object;
+    /**
+     * 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
+     */
+    createDataAccessRule(rule: string, roles: string[]): Promise<void>;
+    /**
+     * 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
+     */
+    deleteDataAccessRule(rule: string): Promise<void>;
+}

package/dist/types/src/settings.d.ts

@@ -0,0 +1,62 @@
+/**
+ * Client for GeoServer settings.
+ *
+ * @module SettingsClient
+ */
+export default class SettingsClient {
+    /**
+     * Creates a GeoServer REST SettingsClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Get the complete GeoServer settings object.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} Settings object
+     */
+    getSettings(): Object;
+    /**
+     * Update the global GeoServer settings.
+     *
+     * @param {Object} settings The adapted GeoServer settings object
+     */
+    updateSettings(settings: Object): Promise<void>;
+    /**
+     * Update the global proxyBaseUrl setting.
+     *
+     * @param {String} proxyBaseUrl The proxy base URL
+     */
+    updateProxyBaseUrl(proxyBaseUrl: string): Promise<false | undefined>;
+    /**
+     * Get the contact information of the GeoServer.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with contact information
+     */
+    getContactInformation(): Object;
+    /**
+     * Update the contact information.
+     *
+     * Deleting is not supported.
+     *
+     * @param {String} [address] The contact's address
+     * @param {String} [city] The contact's city
+     * @param {String} [country] The contact's country
+     * @param {String} [postalCode] The contact's postCode
+     * @param {String} [state] The contact's state
+     * @param {String} [email] The contact's email
+     * @param {String} [organization] The contact's organization
+     * @param {String} [contactPerson] The contact person
+     * @param {String} [phoneNumber] The contact's phone number
+     *
+     * @throws Error if request fails
+     */
+    updateContactInformation(address?: string, city?: string, country?: string, postalCode?: string, state?: string, email?: string, organization?: string, contactPerson?: string, phoneNumber?: string): Promise<void>;
+}

package/dist/types/src/style.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Client for GeoServer styles
+ *
+ * @module StyleClient
+ */
+export default class StyleClient {
+    /**
+     * Creates a GeoServer REST StyleClient instance.
+     *
+     * @param {String} url The URL of the GeoServer REST API endpoint
+     * @param {String} auth The Basic Authentication string
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all default styles.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with the default styles
+     */
+    getDefaults(): Object;
+    /**
+     * Returns all styles in a workspace.
+     *
+     * @param {String} workspace Workspace name to get styles for
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with all styles
+     */
+    getInWorkspace(workspace: string): Object;
+    /**
+     * Returns all styles defined in workspaces.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object[]} An array with all style objects
+     */
+    getAllWorkspaceStyles(): Object[];
+    /**
+     * Returns all styles as combined object (default ones and those in
+     * workspaces).
+     *
+     * @returns {Object[]} An array with all style objects
+     */
+    getAll(): Object[];
+    /**
+     * Publishes a new SLD style.
+     *
+     * @param {String} workspace The workspace to publish the style in
+     * @param {String} name Name of the style
+     * @param {String} sldBody SLD style (as XML text)
+     *
+     * @throws Error if request fails
+     */
+    publish(workspace: string, name: string, sldBody: string): Promise<void>;
+    /**
+     * Deletes a style.
+     *
+     * @param {String} workspace The name of the workspace, can be undefined if style is not assigned to a workspace
+     * @param {String} name The name of the style to delete
+     * @param {Boolean} [recurse=false] If references to the specified style in existing layers should be deleted
+     * @param {Boolean} [purge=false] Whether the underlying file containing the style should be deleted on disk
+     */
+    delete(workspace: string, name: string, recurse?: boolean, purge?: boolean): Promise<void>;
+    /**
+     * Assigns a style to a layer.
+     *
+     * @param {String} workspaceOfLayer The name of the layer's workspace, can be undefined
+     * @param {String} layerName The name of the layer to query
+     * @param {String} workspaceOfStyle The workspace of the style, can be undefined
+     * @param {String} styleName The name of the style
+     * @param {Boolean} [isDefaultStyle=true] If the style should be the default style of the layer
+     *
+     * @throws Error if request fails
+     */
+    assignStyleToLayer(workspaceOfLayer: string, layerName: string, workspaceOfStyle: string, styleName: string, isDefaultStyle?: boolean): Promise<void>;
+    /**
+     * Get information about a style.
+     *
+     * @param {String} workspace The name of the workspace, can be undefined
+     * @param {String} styleName The name of the style
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object about the style or undefined if it cannot be found
+     */
+    getStyleInformation(workspace: string, styleName: string): Object;
+}

package/dist/types/src/util/geoserver.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Utility functions and classes
+ */
+/**
+ * Return the GeoServer response text if available.
+ *
+ * @param {Response} response The response of the GeoServer
+ *
+ * @returns {String} The response text if available
+ */
+export function getGeoServerResponseText(response: Response): string;
+/**
+ * Generic GeoServer error
+ */
+export class GeoServerResponseError extends Error {
+    /**
+     * @param {String} [message=GeoServer Response Error] The error message
+     * @param {String} [geoServerOutput] The error output from GeoServer (useful for debugging)
+     */
+    constructor(message?: string, geoServerOutput?: string);
+    geoServerOutput: string | undefined;
+}

package/dist/types/src/workspace.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Client for GeoServer workspaces
+ *
+ * @module WorkspaceClient
+ */
+export default class WorkspaceClient {
+    /**
+     * 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
+     */
+    constructor(url: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Returns all workspaces.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An Object describing the workspaces
+     */
+    getAll(): Object;
+    /**
+     * Returns a workspace.
+     *
+     * @param {String} name Name of the workspace
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object describing the workspaces
+     */
+    get(name: string): Object;
+    /**
+     * 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
+     */
+    create(name: string): string;
+    /**
+     * 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
+     */
+    delete(name: string, recurse: boolean): Promise<void>;
+}

package/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": "module",
   "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/src/datastore.js

@@ -214,7 +214,7 @@ export default class DatastoreClient {
    * @param {String} coverageStore The name of the new GeoTIFF store
    * @param {String} layerName The published name of the new layer
    * @param {String} layerTitle The published title of the new layer
-   * @param {Stream} readStream The stream of the GeoTIFF file
+   * @param {fs.ReadStream} readStream The stream of the GeoTIFF file
    * @param {Number} fileSizeInBytes The number of bytes of the stream
    *
    * @throws Error if request fails

package/src/layer.js

@@ -254,11 +254,11 @@ export default class LayerClient {
    * Publishes a FeatureType in the default data store of the workspace.
    *
    * @param {String} workspace Workspace to publish FeatureType in
-   * @param {String} [nativeName] Native name of FeatureType
-   * @param {String} name Published name of FeatureType
-   * @param {String} [title] Published title of FeatureType
+   * @param {String} nativeName Native name of FeatureType
+   * @param {String} [name] Published name of FeatureType, defaults to `nativeName`
+   * @param {String} [title] Published title of FeatureType, defaults to `name` or `nativeName`
    * @param {String} [srs="EPSG:4326"] The SRS of the FeatureType
-   * @param {String} enabled Flag to enable FeatureType by default
+   * @param {Boolean} [enabled=true] Flag to enable FeatureType by default
    * @param {String} [abstract] The abstract of the layer
    *
    * @throws Error if request fails
@@ -274,11 +274,11 @@ export default class LayerClient {
   ) {
     const body = {
       featureType: {
-        name: name,
-        nativeName: nativeName || name,
-        title: title || name,
+        nativeName: nativeName,
+        name: name || nativeName,
+        title: title || name || nativeName,
         srs: srs || 'EPSG:4326',
-        enabled: enabled,
+        enabled: typeof enabled === 'boolean' ? enabled : true,
         abstract: abstract || ''
       }
     };
@@ -304,11 +304,11 @@ export default class LayerClient {
    *
    * @param {String} workspace Workspace to publish FeatureType in
    * @param {String} dataStore The datastore where the FeatureType's data is in
-   * @param {String} [nativeName] Native name of FeatureType
-   * @param {String} name Published name of FeatureType
-   * @param {String} [title] Published title of FeatureType
+   * @param {String} nativeName Native name of FeatureType
+   * @param {String} [name] Published name of FeatureType, defaults to `nativeName`
+   * @param {String} [title] Published title of FeatureType, defaults to `name` or `nativeName`
    * @param {String} [srs="EPSG:4326"] The SRS of the FeatureType
-   * @param {String} enabled Flag to enable FeatureType by default
+   * @param {Boolean} [enabled=true] Flag to enable FeatureType by default
    * @param {String} [abstract] The abstract of the layer
    * @param {String} [nativeBoundingBox] The native BoundingBox of the FeatureType (has to be set if no data is in store at creation time)
    *
@@ -335,11 +335,11 @@ export default class LayerClient {
 
     const body = {
       featureType: {
-        name: name || nativeName,
         nativeName: nativeName,
-        title: title || name,
+        name: name || nativeName,
+        title: title || name || nativeName,
         srs: srs || 'EPSG:4326',
-        enabled: enabled,
+        enabled: typeof enabled === 'boolean' ? enabled : true,
         abstract: abstract || '',
         nativeBoundingBox: nativeBoundingBox
       }
@@ -449,10 +449,10 @@ export default class LayerClient {
    * @param {String} workspace Workspace to publish WMS layer in
    * @param {String} dataStore The datastore where the WMS is connected
    * @param {String} nativeName Native name of WMS layer
-   * @param {String} [name] Published name of WMS layer
-   * @param {String} [title] Published title of WMS layer
+   * @param {String} [name] Published name of WMS layer, defaults to `nativeName`
+   * @param {String} [title] Published title of WMS layer, defaults to `name` or `nativeName`
    * @param {String} [srs="EPSG:4326"] The SRS of the WMS layer
-   * @param {String} enabled Flag to enable WMS layer by default
+   * @param {Boolean} [enabled=true] Flag to enable WMS layer by default
    * @param {String} [abstract] The abstract of the layer
    *
    * @throws Error if request fails
@@ -460,11 +460,11 @@ export default class LayerClient {
   async publishWmsLayer(workspace, dataStore, nativeName, name, title, srs, enabled, abstract) {
     const body = {
       wmsLayer: {
-        name: name || nativeName,
         nativeName: nativeName,
+        name: name || nativeName,
         title: title || name || nativeName,
         srs: srs || 'EPSG:4326',
-        enabled: enabled,
+        enabled: typeof enabled === 'boolean' ? enabled : true,
         abstract: abstract || ''
       }
     };
@@ -494,10 +494,10 @@ export default class LayerClient {
    * @param {String} workspace Workspace to publish layer in
    * @param {String} coverageStore The coveragestore where the layer's data is in
    * @param {String} nativeName Native name of raster
-   * @param {String} name Published name of layer
-   * @param {String} [title] Published title of layer
+   * @param {String} [name] Published name of layer, defaults to `nativeName`
+   * @param {String} [title] Published title of layer, defaults to `name` or `nativeName`
    * @param {String} [srs="EPSG:4326"] The SRS of the layer
-   * @param {String} enabled Flag to enable layer by default
+   * @param {Boolean} [enabled=true] Flag to enable layer by default
    * @param {String} [abstract] The abstract of the layer
    *
    * @throws Error if request fails
@@ -505,9 +505,9 @@ export default class LayerClient {
   async publishDbRaster(workspace, coverageStore, nativeName, name, title, srs, enabled, abstract) {
     const body = {
       coverage: {
-        name: name || nativeName,
         nativeName: nativeName,
-        title: title || name,
+        name: name || nativeName,
+        title: title || name || nativeName,
         srs: srs,
         enabled: enabled,
         abstract: abstract || ''