@openeo/js-client 2.3.1 → 2.5.0

package/openeo.js

@@ -7,7 +7,7 @@
 		var a = typeof exports === 'object' ? factory(require("Oidc"), require("axios"), (function webpackLoadOptionalExternalModule() { try { return require("multihashes"); } catch(e) {} }())) : factory(root["Oidc"], root["axios"], root["multihashes"]);
 		for(var i in a) (typeof exports === 'object' ? exports : root)[i] = a[i];
 	}
-})(self, function(__WEBPACK_EXTERNAL_MODULE__6__, __WEBPACK_EXTERNAL_MODULE__300__, __WEBPACK_EXTERNAL_MODULE__263__) {
+})(self, (__WEBPACK_EXTERNAL_MODULE__6__, __WEBPACK_EXTERNAL_MODULE__300__, __WEBPACK_EXTERNAL_MODULE__263__) => {
 return /******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
@@ -1263,7 +1263,15 @@ var Catalog = {
 
 		_.ensure(catalog, 'stac_extensions', []) && DONE;
 		V.before('0.8.0') && _.populateExtensions(catalog, 'catalog') && DONE;
-	}
+	},
+
+	openeo(obj) {
+		_.rename(obj, 'api_version', 'openeo:api_version') && DONE;
+		_.rename(obj, 'backend_version', 'openeo:backend_version') && DONE;
+		_.rename(obj, 'production', 'openeo:production') && DONE;
+		_.rename(obj, 'endpoints', 'openeo:endpoints') && DONE;
+		_.rename(obj, 'billing', 'openeo:billing') && DONE;
+	},
 
 };
 
@@ -1297,6 +1305,8 @@ var Collection = {
 	},
 
 	extent(collection) {
+		_.ensure(collection, "extent", {});
+
 		if (V.before('0.8.0')) {
 			// Restructure spatial extent
 			if (Array.isArray(collection.extent.spatial)) {
@@ -1316,9 +1326,14 @@ var Collection = {
 			}
 		}
 
+		_.ensure(collection.extent, "spatial", {});
+		_.ensure(collection.extent.spatial, "bbox", []);
+		_.ensure(collection.extent, "temporal", {});
+		_.ensure(collection.extent.temporal, "interval", []);
+
 		if (V.before('1.0.0-rc.3')) {
 			// The first extent in a Collection is always the overall extent, followed by more specific extents.
-			if (Array.isArray(collection.extent.temporal.interval) && collection.extent.temporal.interval.length > 1) {
+			if (collection.extent.temporal.interval.length > 1) {
 				let min, max;
 				for(let interval of collection.extent.temporal.interval) {
 					if (interval[0] === null) {
@@ -1350,7 +1365,7 @@ var Collection = {
 					max ? _.toISOString(max) : null
 				]);
 			}
-			if (Array.isArray(collection.extent.spatial.bbox) && collection.extent.spatial.bbox.length > 1) {
+			if (collection.extent.spatial.bbox.length > 1) {
 				let count = collection.extent.spatial.bbox.reduce((val, bbox) => Array.isArray(bbox) ? Math.max(bbox.length, val) : val, 4);
 				if (count >= 4) {
 					let union = new Array(count).fill(null);
@@ -1840,6 +1855,7 @@ class AuthProvider {
   /**
    * Abstract method that extending classes implement the login process with.
    * 
+   * @async
    * @param {...*} args 
    * @throws {Error}
    */
@@ -1885,7 +1901,7 @@ class BaseEntity {
    * Creates an instance of this object.
    * 
    * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
-   * @param {Array} properties - A mapping from the API property names to the JS client property names (usually to convert between snake_case and camelCase), e.g. `["id", "title", ["process_graph", "processGraph"]]`
+   * @param {Array.<string|Array.<string>>} properties - A mapping from the API property names to the JS client property names (usually to convert between snake_case and camelCase), e.g. `["id", "title", ["process_graph", "processGraph"]]`
    */
   constructor(connection) {
     let properties = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
@@ -2460,19 +2476,19 @@ class Builder {
     this.id = id;
     /**
      * The parent builder.
-     * @type {?Builder}
+     * @type {Builder | null}
      */
 
     this.parent = parent;
     /**
      * The parent node.
-     * @type {?BuilderNode}
+     * @type {BuilderNode | null}
      */
 
     this.parentNode = null;
     /**
      * The parent parameter name.
-     * @type {?string}
+     * @type {string | null}
      */
 
     this.parentParameter = null;
@@ -2589,7 +2605,7 @@ class Builder {
   /**
    * Gets the callback parameter specifics from the parent process.
    * 
-   * @returns {Array}
+   * @returns {Array.<object.<string,*>>}
    * @todo Should this also pass callback parameters from parents until root is reached?
    */
 
@@ -2808,7 +2824,7 @@ class Formula {
 
     this.tree = parser.parse(formula);
     /**
-     * @type {?Builder}
+     * @type {Builder | null}
      */
 
     this.builder = null;
@@ -3083,7 +3099,7 @@ class BuilderNode {
   /**
    * Converts a sorted array of arguments to an object with the respective parameter names.
    * 
-   * @param {Array} processArgs 
+   * @param {Array.<object.<string, *>>} processArgs 
    * @returns {object.<string, *>}
    * @throws {Error}
    */
@@ -4328,7 +4344,7 @@ class Connection {
      * Auth Provider cache
      * 
      * @protected
-     * @type {?Array.<AuthProvider>}
+     * @type {Array.<AuthProvider> | null}
      */
 
     this.authProviderList = null;
@@ -4336,7 +4352,7 @@ class Connection {
      * Current auth provider
      * 
      * @protected
-     * @type {?AuthProvider}
+     * @type {AuthProvider | null}
      */
 
     this.authProvider = null;
@@ -4344,7 +4360,7 @@ class Connection {
      * Capability cache
      * 
      * @protected
-     * @type {?Capabilities}
+     * @type {Capabilities | null}
      */
 
     this.capabilitiesObject = null;
@@ -4412,10 +4428,12 @@ class Connection {
       let fn = () => Promise.resolve();
 
       if (namespace === 'user') {
+        let userProcesses = this.processes.namespace('user');
+
         if (!this.isAuthenticated()) {
           fn = () => this.processes.remove(null, 'user') ? Promise.resolve() : Promise.reject(new Error("Can't clear user processes"));
         } else if (this.capabilities().hasFeature('listUserProcesses')) {
-          fn = () => this.listUserProcesses();
+          fn = () => this.listUserProcesses(userProcesses);
         }
       } else if (this.capabilities().hasFeature('listProcesses')) {
         fn = () => this.listProcesses(namespace);
@@ -4545,7 +4563,7 @@ class Connection {
    * 2. Lower left corner, coordinate axis 2
    * 3. Upper right corner, coordinate axis 1
    * 4. Upper right corner, coordinate axis 2
-   * @param {?Array.<*>} [temporalExtent=null] - Limits the items to the specified temporal interval.
+   * @param {?Array} [temporalExtent=null] - Limits the items to the specified temporal interval.
    * The interval has to be specified as an array with exactly two elements (start, end) and
    * each must be either an RFC 3339 compatible string or a Date object.
    * Also supports open intervals by setting one of the boundaries to `null`, but never both.
@@ -4598,6 +4616,26 @@ class Connection {
       nextUrl = this._getLinkHref(response.data.links);
     }
   }
+  /**
+   * Normalisation of the namespace to a value that is compatible with the OpenEO specs - EXPERIMENTAL.
+   *
+   * This is required to support UDP that are shared as public. These can only be executed with providing the full URL
+   * (e.g. https://<backend>/processes/<namespace>/<process_id>) as the namespace value in the processing graph. For other
+   * parts of the API (such as the listing of the processes, only the name of the namespace is required.
+   *
+   * This function will extract the short name of the namespace from a shareable URL.
+   * 
+   * @protected
+   * @param {?string} namespace - Namespace of the process
+   * @returns {?string}
+   */
+
+
+  normalizeNamespace(namespace) {
+    // The pattern in https://github.com/Open-EO/openeo-api/pull/348 doesn't include the double colon yet - the regexp may change in the future
+    const matches = namespace.match(/^https?:\/\/.*\/processes\/(@?[\w\-.~:]+)\/?/i);
+    return matches && matches.length > 1 ? matches[1] : namespace;
+  }
   /**
    * List processes available on the back-end.
    * 
@@ -4621,7 +4659,7 @@ class Connection {
       namespace = 'backend';
     }
 
-    let path = namespace === 'backend' ? '/processes' : `/processes/${namespace}`;
+    let path = namespace === 'backend' ? '/processes' : `/processes/${this.normalizeNamespace(namespace)}`;
     let response = await this._get(path);
 
     if (!Utils.isObject(response.data) || !Array.isArray(response.data.processes)) {
@@ -4657,7 +4695,7 @@ class Connection {
     if (namespace === 'backend') {
       await this.listProcesses();
     } else {
-      let response = await this._get(`/processes/${namespace}/${processId}`);
+      let response = await this._get(`/processes/${this.normalizeNamespace(namespace)}/${processId}`);
 
       if (!Utils.isObject(response.data) || typeof response.data.id !== 'string') {
         throw new Error('Invalid response received for process');
@@ -4924,14 +4962,15 @@ class Connection {
    * Lists all files from the user workspace. 
    * 
    * @async
-   * @returns {Promise<Array.<UserFile>>} A list of files.
+   * @returns {Promise<ResponseArray.<UserFile>>} A list of files.
    * @throws {Error}
    */
 
 
   async listFiles() {
     let response = await this._get('/files');
-    return response.data.files.map(f => new UserFile(this, f.path).setAll(f));
+    let files = response.data.files.map(f => new UserFile(this, f.path).setAll(f));
+    return this._toResponseArray(files, response.data);
   }
   /**
    * A callback that is executed on upload progress updates.
@@ -5036,22 +5075,36 @@ class Connection {
    * Lists all user-defined processes of the authenticated user.
    * 
    * @async
-   * @returns {Promise<Array.<UserProcess>>} A list of user-defined processes.
+   * @param {Array.<UserProcess>} [oldProcesses=[]] - A list of existing user-defined processes to update.
+   * @returns {Promise<ResponseArray.<UserProcess>>} A list of user-defined processes.
    * @throws {Error}
    */
 
 
   async listUserProcesses() {
+    let oldProcesses = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
     let response = await this._get('/process_graphs');
 
     if (!Utils.isObject(response.data) || !Array.isArray(response.data.processes)) {
       throw new Error('Invalid response received for processes');
-    } // Store processes in cache
+    } // Remove existing processes from cache
 
 
-    this.processes.remove(null, 'user');
-    this.processes.addAll(response.data.processes, 'user');
-    return response.data.processes.map(pg => new UserProcess(this, pg.id).setAll(pg));
+    this.processes.remove(null, 'user'); // Update existing processes if needed
+
+    let newProcesses = response.data.processes.map(newProcess => {
+      let process = oldProcesses.find(oldProcess => oldProcess.id === newProcess.id);
+
+      if (!process) {
+        process = new UserProcess(this, newProcess.id);
+      }
+
+      return process.setAll(newProcess);
+    }); // Store plain JS variant (i.e. no Job objects involved) of processes in cache
+
+    let jsonProcesses = oldProcesses.length > 0 ? newProcesses.map(p => p.toJSON()) : response.data.processes;
+    this.processes.addAll(jsonProcesses, 'user');
+    return this._toResponseArray(newProcesses, response.data);
   }
   /**
    * Creates a new stored user-defined process at the back-end.
@@ -5177,14 +5230,26 @@ class Connection {
    * Lists all batch jobs of the authenticated user.
    * 
    * @async
-   * @returns {Promise<Array.<Job>>} A list of jobs.
+   * @param {Array.<Job>} [oldJobs=[]] - A list of existing jobs to update.
+   * @returns {Promise<ResponseArray.<Job>>} A list of jobs.
    * @throws {Error}
    */
 
 
   async listJobs() {
+    let oldJobs = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
     let response = await this._get('/jobs');
-    return response.data.jobs.map(j => new Job(this, j.id).setAll(j));
+    let newJobs = response.data.jobs.map(newJob => {
+      delete newJob.status;
+      let job = oldJobs.find(oldJob => oldJob.id === newJob.id);
+
+      if (!job) {
+        job = new Job(this, newJob.id);
+      }
+
+      return job.setAll(newJob);
+    });
+    return this._toResponseArray(newJobs, response.data);
   }
   /**
    * Creates a new batch job at the back-end.
@@ -5248,14 +5313,25 @@ class Connection {
    * Lists all secondary web services of the authenticated user.
    * 
    * @async
-   * @returns {Promise<Array.<Job>>} A list of services.
+   * @param {Array.<Service>} [oldServices=[]] - A list of existing services to update.
+   * @returns {Promise<ResponseArray.<Job>>} A list of services.
    * @throws {Error}
    */
 
 
   async listServices() {
+    let oldServices = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : [];
     let response = await this._get('/services');
-    return response.data.services.map(s => new Service(this, s.id).setAll(s));
+    let newServices = response.data.services.map(newService => {
+      let service = oldServices.find(oldService => oldService.id === newService.id);
+
+      if (!service) {
+        service = new Service(this, newService.id);
+      }
+
+      return service.setAll(newService);
+    });
+    return this._toResponseArray(newServices, response.data);
   }
   /**
    * Creates a new secondary web service at the back-end. 
@@ -5322,9 +5398,27 @@ class Connection {
     let service = new Service(this, id);
     return await service.describeService();
   }
+  /**
+   * Adds additional response details to the array.
+   * 
+   * Adds links and federation:missing.
+   * 
+   * @protected
+   * @param {Array.<*>} arr 
+   * @param {object.<string, *>} response 
+   * @returns {ResponseArray}
+   */
+
+
+  _toResponseArray(arr, response) {
+    arr.links = Array.isArray(response.links) ? response.links : [];
+    arr['federation:missing'] = Array.isArray(response['federation:missing']) ? response['federation:missing'] : [];
+    return arr;
+  }
   /**
    * Get the a link with the given rel type.
    * 
+   * @protected
    * @param {Array.<Link>} links - An array of links.
    * @param {string} rel - Relation type to find, defaults to `next`.
    * @returns {string | null}
@@ -5348,6 +5442,7 @@ class Connection {
   /**
    * Sends a GET request.
    * 
+   * @protected
    * @async
    * @param {string} path 
    * @param {object.<string, *>} query 
@@ -5372,6 +5467,7 @@ class Connection {
   /**
    * Sends a POST request.
    * 
+   * @protected
    * @async
    * @param {string} path 
    * @param {*} body 
@@ -5396,6 +5492,7 @@ class Connection {
   /**
    * Sends a PUT request.
    * 
+   * @protected
    * @async
    * @param {string} path 
    * @param {*} body 
@@ -5414,6 +5511,7 @@ class Connection {
   /**
    * Sends a PATCH request.
    * 
+   * @protected
    * @async
    * @param {string} path 
    * @param {*} body 
@@ -5432,6 +5530,7 @@ class Connection {
   /**
    * Sends a DELETE request.
    * 
+   * @protected
    * @async
    * @param {string} path 
    * @returns {Promise<AxiosResponse>}
@@ -5478,6 +5577,7 @@ class Connection {
    * Tries to smoothly handle error responses by providing an object for all response types,
    * instead of Streams or Blobs for non-JSON response types.
    * 
+   * @protected
    * @async
    * @param {object.<string, *>} options 
    * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
@@ -5565,6 +5665,7 @@ class FileTypes {
    */
   constructor(data) {
     /**
+     * @protected
      * @type {FileTypesAPI}
      */
     this.data = {
@@ -5585,6 +5686,15 @@ class FileTypes {
         this.data[io][type.toUpperCase()] = data[io][type];
       }
     }
+    /**
+     * A list of backends from the federation that are missing in the response data.
+     * 
+     * @public
+     * @type {Array.<string>}
+     */
+
+
+    this['federation:missing'] = data['federation:missing'];
   }
   /**
    * Returns the file types response as a JSON serializable representation of the data that is API compliant.
@@ -5723,7 +5833,7 @@ class Job extends BaseEntity {
      * The process chain to be executed.
      * @public
      * @readonly
-     * @type {Process}
+     * @type {?Process}
      */
 
     this.process = undefined;
@@ -5732,7 +5842,7 @@ class Job extends BaseEntity {
      * One of "created", "queued", "running", "canceled", "finished" or "error".
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.status = undefined;
@@ -5740,7 +5850,7 @@ class Job extends BaseEntity {
      * Indicates the process of a running batch job in percent. 
      * @public
      * @readonly
-     * @type {number}
+     * @type {?number}
      */
 
     this.progress = undefined;
@@ -5748,7 +5858,7 @@ class Job extends BaseEntity {
      * Date and time of creation, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.created = undefined;
@@ -5756,7 +5866,7 @@ class Job extends BaseEntity {
      * Date and time of the last status change, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.updated = undefined;
@@ -5764,7 +5874,7 @@ class Job extends BaseEntity {
      * The billing plan to process and charge the batch job with.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.plan = undefined;
@@ -6216,7 +6326,7 @@ class OidcProvider extends AuthProvider {
     /**
      * The client ID to use for authentication.
      * 
-     * @type {?string}
+     * @type {string | null}
      */
 
     this.clientId = null;
@@ -6244,6 +6354,13 @@ class OidcProvider extends AuthProvider {
      */
 
     this.scopes = Array.isArray(options.scopes) && options.scopes.length > 0 ? options.scopes : ['openid'];
+    /**
+     * The scope that is used to request a refresh token.
+     * 
+     * @type {string}
+     */
+
+    this.refreshTokenScope = "offline_access";
     /**
      * Any additional links.
      * 
@@ -6304,21 +6421,25 @@ class OidcProvider extends AuthProvider {
    * 
    * Supported only in Browser environments.
    * 
+   * @async
    * @param {object.<string, *>} [options={}] - Object with authentication options.
+   * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
    * @returns {Promise<void>}
    * @throws {Error}
    * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
+   * @see {OidcProvider#refreshTokenScope}
    */
 
 
   async login() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let requestRefreshToken = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
 
     if (!this.issuer || typeof this.issuer !== 'string') {
       throw new Error("No Issuer URL available for OpenID Connect");
     }
 
-    this.manager = new Oidc.UserManager(this.getOptions(options));
+    this.manager = new Oidc.UserManager(this.getOptions(options, requestRefreshToken));
     this.addListener('UserLoaded', async () => this.setUser(await this.manager.getUser()), 'js-client');
     this.addListener('AccessTokenExpired', () => this.setUser(null), 'js-client');
 
@@ -6363,18 +6484,27 @@ class OidcProvider extends AuthProvider {
    * 
    * @protected
    * @param {object.<string, *>} options 
+   * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
    * @returns {object.<string, *>}
+   * @see {OidcProvider#refreshTokenScope}
    */
 
 
   getOptions() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let requestRefreshToken = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     let response_type = this.getResponseType();
+    let scope = this.scopes.slice(0);
+
+    if (requestRefreshToken && !scope.includes(this.refreshTokenScope)) {
+      scope.push(this.refreshTokenScope);
+    }
+
     return Object.assign({
       client_id: this.clientId,
       redirect_uri: OidcProvider.redirectUrl,
       authority: this.issuer.replace('/.well-known/openid-configuration', ''),
-      scope: this.scopes.join(' '),
+      scope: scope.join(' '),
       validateSubOnSilentRenew: true,
       response_type,
       response_mode: response_type.includes('code') ? 'query' : 'fragment'
@@ -6652,7 +6782,7 @@ class OpenEO {
 
 
   static clientVersion() {
-    return "2.3.1";
+    return "2.5.0";
   }
 
 }
@@ -6728,7 +6858,7 @@ class Service extends BaseEntity {
      * The process chain to be executed.
      * @public
      * @readonly
-     * @type {Process}
+     * @type {?Process}
      */
 
     this.process = undefined;
@@ -6736,7 +6866,7 @@ class Service extends BaseEntity {
      * URL at which the secondary web service is accessible
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.url = undefined;
@@ -6744,14 +6874,14 @@ class Service extends BaseEntity {
      * Web service type (protocol / standard) that is exposed.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.type = undefined;
     /**
      * @public
      * @readonly
-     * @type {boolean}
+     * @type {?boolean}
      */
 
     this.enabled = undefined;
@@ -6759,7 +6889,7 @@ class Service extends BaseEntity {
      * Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values. 
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.configuration = undefined;
@@ -6767,7 +6897,7 @@ class Service extends BaseEntity {
      * Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.attributes = undefined;
@@ -6775,7 +6905,7 @@ class Service extends BaseEntity {
      * Date and time of creation, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.created = undefined;
@@ -6783,7 +6913,7 @@ class Service extends BaseEntity {
      * The billing plan to process and charge the service with.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.plan = undefined;
@@ -7134,7 +7264,7 @@ class UserProcess extends BaseEntity {
      * A list of categories.
      * @public
      * @readonly
-     * @type {Array.<string>}
+     * @type {?Array.<string>}
      */
 
     this.categories = undefined;
@@ -7159,7 +7289,7 @@ class UserProcess extends BaseEntity {
      * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions. 
      * @public
      * @readonly
-     * @type {boolean}
+     * @type {?boolean}
      */
 
     this.deprecated = undefined;
@@ -7167,7 +7297,7 @@ class UserProcess extends BaseEntity {
      * Declares the process or parameter to be experimental, which means that it is likely to change or may produce unpredictable behaviour. 
      * @public
      * @readonly
-     * @type {boolean}
+     * @type {?boolean}
      */
 
     this.experimental = undefined;
@@ -7175,14 +7305,14 @@ class UserProcess extends BaseEntity {
      * Declares any exceptions (errors) that might occur during execution of this process.
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.exceptions = undefined;
     /**
      * @public
      * @readonly
-     * @type {Array.<object.<string, *>>}
+     * @type {?Array.<object.<string, *>>}
      */
 
     this.examples = undefined;
@@ -7190,14 +7320,14 @@ class UserProcess extends BaseEntity {
      * Links related to this process.
      * @public
      * @readonly
-     * @type {Array.<Link>}
+     * @type {?Array.<Link>}
      */
 
     this.links = undefined;
     /**
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.processGraph = undefined;