geoserver-node-client 1.6.2 → 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/package.json

@@ -1,9 +1,10 @@
 {
   "name": "geoserver-node-client",
-  "version": "1.6.2",
+  "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",
@@ -45,6 +50,7 @@
     "@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": "^20.0.0"
+    "release-it": "^20.0.0",
+    "typescript": "^6.0.3"
   }
 }

package/dist/src/datastore.js

@@ -211,7 +211,7 @@ 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/dist/src/layer.js

@@ -227,11 +227,11 @@ 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
@@ -239,11 +239,11 @@ class LayerClient {
   async publishFeatureTypeDefaultDataStore(workspace, nativeName, name, title, srs, enabled, abstract) {
     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 || ''
       }
     };
@@ -267,11 +267,11 @@ 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)
    *
@@ -287,11 +287,11 @@ 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
       }
@@ -381,10 +381,10 @@ 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
@@ -392,11 +392,11 @@ 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 || ''
       }
     };
@@ -421,10 +421,10 @@ 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
@@ -432,9 +432,9 @@ 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 || ''

package/dist/types/geoserver-rest-client.d.ts

@@ -0,0 +1,53 @@
+export { GeoServerResponseError } from "./src/util/geoserver.js";
+/**
+ * Client for GeoServer REST API.
+ * Has minimal basic functionality and offers REST client instances for
+ * sub-entities, like workspaces or datastores as member variables.
+ *
+ * @module GeoServerRestClient
+ */
+export 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: string, user: string, password: string);
+    url: string;
+    auth: string;
+    /** @member {LayerClient} layers GeoServer REST client instance for layers */
+    layers: LayerClient;
+    /** @member {LayerGroupClient} layers GeoServer REST client instance for layergroups */
+    layergroups: LayerGroupClient;
+    /** @member {StyleClient} styles GeoServer REST client instance for styles */
+    styles: StyleClient;
+    /** @member {WorkspaceClient} workspaces GeoServer REST client instance for workspaces */
+    workspaces: WorkspaceClient;
+    /** @member {NamespaceClient} namespaces GeoServer REST client instance for namespaces */
+    namespaces: NamespaceClient;
+    /** @member {DatastoreClient} datastores GeoServer REST client instance for data stores */
+    datastores: DatastoreClient;
+    /** @member {ImageMosaicClient} imagemosaics GeoServer REST client instance for image mosaics */
+    imagemosaics: ImageMosaicClient;
+    /** @member {SecurityClient} security GeoServer REST client instance for security related modifications */
+    security: SecurityClient;
+    /** @member {SettingsClient} settings GeoServer REST client instance for settings */
+    settings: SettingsClient;
+    /** @member {AboutClient} about GeoServer REST client instance for about endpoint */
+    about: AboutClient;
+    /** @member {ResetReloadClient} about GeoServer REST client instance for reset/reload endpoints */
+    resetReload: ResetReloadClient;
+}
+import LayerClient from './src/layer.js';
+import LayerGroupClient from './src/layergroup.js';
+import StyleClient from './src/style.js';
+import WorkspaceClient from './src/workspace.js';
+import NamespaceClient from './src/namespace.js';
+import DatastoreClient from './src/datastore.js';
+import ImageMosaicClient from './src/imagemosaic.js';
+import SecurityClient from './src/security.js';
+import SettingsClient from './src/settings.js';
+import AboutClient from './src/about.js';
+import ResetReloadClient from './src/reset-reload.js';

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

@@ -0,0 +1,30 @@
+/**
+ * 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: string, auth: string);
+    url: string;
+    auth: string;
+    /**
+     * Get the GeoServer version.
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} The version of GeoServer
+     */
+    getVersion(): Object;
+    /**
+     * Checks if the configured GeoServer REST connection exists.
+     *
+     * @returns {Boolean} If the connection exists
+     */
+    exists(): boolean;
+}

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

@@ -0,0 +1,241 @@
+/**
+ * Client for GeoServer data stores
+ *
+ * @module DatastoreClient
+ */
+export default class DatastoreClient {
+    /**
+     * Creates a GeoServer REST DatastoreClient 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 all DataStores in a workspace.
+     *
+     * @param {String} workspace The workspace to get DataStores for
+     *
+     * @returns {Object} An object containing store details
+     */
+    getDataStores(workspace: string): Object;
+    /**
+     * Get all CoverageStores in a workspace.
+     *
+     * @param {String} workspace The workspace to get CoverageStores for
+     *
+     * @returns {Object} An object containing store details
+     */
+    getCoverageStores(workspace: string): Object;
+    /**
+     * Get all WmsStores in a workspace.
+     *
+     * @param {String} workspace The workspace to get WmsStores for
+     *
+     * @returns {Object} An object containing store details
+     */
+    getWmsStores(workspace: string): Object;
+    /**
+     * Get all WmtsStores in a workspace.
+     *
+     * @param {String} workspace The workspace to get WmtsStores for
+     *
+     * @returns {Object} An object containing store details
+     */
+    getWmtsStores(workspace: string): Object;
+    /**
+     * Get information about various store types in a workspace.
+     *
+     * @param {String} workspace The workspace name
+     * @param {String} storeType The type of store
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     * @private
+     */
+    private getStores;
+    /**
+     * Get specific DataStore by name in a workspace.
+     *
+     * @param {String} workspace The workspace to search DataStore in
+     * @param {String} dataStore DataStore name
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     */
+    getDataStore(workspace: string, dataStore: string): Object;
+    /**
+     * Get specific CoverageStore by name in a workspace.
+     *
+     * @param {String} workspace The workspace to search CoverageStore in
+     * @param {String} covStore CoverageStore name
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     */
+    getCoverageStore(workspace: string, covStore: string): Object;
+    /**
+     * Get specific WmsStore by name in a workspace.
+     *
+     * @param {String} workspace The workspace to search WmsStore in
+     * @param {String} wmsStore WmsStore name
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     *
+     */
+    getWmsStore(workspace: string, wmsStore: string): Object;
+    /**
+     * Get specific WmtsStore by name in a workspace.
+     *
+     * @param {String} workspace The workspace to search WmtsStore in
+     * @param {String} wmtsStore WmtsStore name
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     */
+    getWmtsStore(workspace: string, wmtsStore: string): Object;
+    /**
+     * Get GeoServer store by type
+     *
+     * @param {String} workspace The name of the workspace
+     * @param {String} storeName The name of the store
+     * @param {String} storeType The type of the store
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object containing store details or undefined if it cannot be found
+     * @private
+     */
+    private getStore;
+    /**
+     * Creates a GeoTIFF store from a file by path and publishes it as layer.
+     * The GeoTIFF file has to be placed on the server, where your GeoServer
+     * is running.
+     *
+     * @param {String} workspace The workspace to create GeoTIFF store in
+     * @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 {String} filePath The path to the GeoTIFF file on the server
+     *
+     * @throws Error if request fails
+     *
+     * @returns {String} The successful response text
+     */
+    createGeotiffFromFile(workspace: string, coverageStore: string, layerName: string, layerTitle: string, filePath: string): string;
+    /**
+     * Creates a GeoTIFF store from a file by stream and publishes it as layer.
+     * The GeoTIFF file is placed on the server, where your GeoServer
+     * is running.
+     *
+     * @param {String} workspace The workspace to create GeoTIFF store in
+     * @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 {fs.ReadStream} readStream The stream of the GeoTIFF file
+     * @param {Number} fileSizeInBytes The number of bytes of the stream
+     *
+     * @throws Error if request fails
+     *
+     * @returns {String} The successful response text
+     */
+    createGeotiffFromStream(workspace: string, coverageStore: string, layerName: string, layerTitle: string, readStream: fs.ReadStream, fileSizeInBytes: number): string;
+    /**
+     * Creates a PostGIS based data store.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} namespaceUri The namespace URI of the workspace
+     * @param {String} dataStore The data store name to be created
+     * @param {String} pgHost The PostGIS DB host
+     * @param {Number} pgPort The PostGIS DB port
+     * @param {String} pgUser The PostGIS DB user
+     * @param {String} pgPassword The PostGIS DB password
+     * @param {String} pgSchema The PostGIS DB schema
+     * @param {String} pgDb The PostGIS DB name
+     * @param {Boolean} [exposePk] expose primary key, defaults to false
+     *
+     * @throws Error if request fails
+     */
+    createPostgisStore(workspace: string, namespaceUri: string, dataStore: string, pgHost: string, pgPort: number, pgUser: string, pgPassword: string, pgSchema: string, pgDb: string, exposePk?: boolean): Promise<void>;
+    /**
+     * Creates an ImageMosaic store from a zip archive with the 3 necessary files
+     *   - datastore.properties
+     *   - indexer.properties
+     *   - timeregex.properties
+     *
+     * The zip archive has to be given as absolute path, so before it has to be
+     * placed on the server, where your GeoServer is running.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} zipArchivePath Absolute path to zip archive with the 3 properties files
+     *
+     * @throws Error if request fails
+     *
+     * @returns {String} The response text
+     */
+    createImageMosaicStore(workspace: string, coverageStore: any, zipArchivePath: string): string;
+    /**
+     * Creates a WMS based data store.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} wmsCapabilitiesUrl Base WMS capabilities URL
+     *
+     * @throws Error if request fails
+     */
+    createWmsStore(workspace: string, dataStore: string, wmsCapabilitiesUrl: string): Promise<void>;
+    /**
+     * Creates a WMTS based data store.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} wmtsCapabilitiesUrl Base WMTS capabilities URL
+     *
+     * @throws Error if request fails
+     */
+    createWmtsStore(workspace: string, dataStore: string, wmtsCapabilitiesUrl: string): Promise<void>;
+    /**
+     * Creates a WFS based data store.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} wfsCapabilitiesUrl WFS capabilities URL
+     * @param {String} namespaceUrl URL of the GeoServer namespace
+     * @param {Boolean} [useHttpConnectionPooling=true] use HTTP connection pooling for WFS connection
+     *
+     * @throws Error if request fails
+     */
+    createWfsStore(workspace: string, dataStore: string, wfsCapabilitiesUrl: string, namespaceUrl: string, useHttpConnectionPooling?: boolean): Promise<void>;
+    /**
+     * Deletes a data store.
+     *
+     * @param {String} workspace The workspace where the data store is in
+     * @param {String} coverageStore Name of data store to delete
+     * @param {String} recurse Flag to enable recursive deletion
+     *
+     * @throws Error if request fails
+     */
+    deleteDataStore(workspace: string, dataStore: any, recurse: string): Promise<void>;
+    /**
+     * Deletes a CoverageStore.
+     *
+     * @param {String} workspace The workspace where the CoverageStore is in
+     * @param {String} coverageStore Name of CoverageStore to delete
+     * @param {String} recurse Flag to enable recursive deletion
+     *
+     * @throws Error if request fails
+     */
+    deleteCoverageStore(workspace: string, coverageStore: string, recurse: string): Promise<void>;
+    /**
+     * Creates a GeoPackage store from a file placed in the geoserver_data dir.
+     *
+     * @param {String} workspace The WS to create the data store in
+     * @param {String} dataStore The data store name
+     * @param {String} gpkgPath Relative path to GeoPackage file within geoserver_data dir
+     *
+     * @throws Error if request fails
+     */
+    createGpkgStore(workspace: string, dataStore: string, gpkgPath: string): Promise<void>;
+}
+import fs from 'fs';

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

@@ -0,0 +1,61 @@
+/**
+ * Client for GeoServer image mosaics
+ *
+ * @module ImageMosaicClient
+ */
+export default class ImageMosaicClient {
+    /**
+     * Creates a GeoServer REST ImageMosaicClient 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 granules of an image mosaic.
+     *
+     * @param {String} workspace Workspace of image mosaic
+     * @param {String} coverageStore CoverageStore of image mosaic
+     * @param {String} coverage Name of image mosaic
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with the granules
+     */
+    getGranules(workspace: string, coverageStore: string, coverage: string): Object;
+    /**
+     * Harvests all granules in the given folder for an image mosaic.
+     *
+     * @param {String} workspace Workspace of image mosaic
+     * @param {String} coverageStore CoverageStore of image mosaic
+     * @param {String} filePath Server path of folder to harvest
+     *
+     * @throws Error if request fails
+     *
+     * @returns {Object} An object with the granules
+     */
+    harvestGranules(workspace: string, coverageStore: string, filePath: string): Object;
+    /**
+     * Adds a granule (defined by a server file) to an image mosaic.
+     *
+     * @param {String} workspace Workspace of image mosaic
+     * @param {String} coverageStore CoverageStore of image mosaic
+     * @param {String} filePath Server file path of new granule
+     *
+     * @throws Error if request fails
+     */
+    addGranuleByServerFile(workspace: string, coverageStore: string, filePath: string): Promise<void>;
+    /**
+     * Deletes a single granule of an image mosaic.
+     *
+     * @param {String} workspace Workspace of image mosaic
+     * @param {String} coverageStore CoverageStore of image mosaic
+     * @param {String} coverage Name of image mosaic
+     * @param {String} covFileLocation Location of coverage file
+     *
+     * @throws Error if request fails
+     */
+    deleteSingleGranule(workspace: string, coverageStore: string, coverage: string, covFileLocation: string): Promise<boolean>;
+}