@openeo/js-client 2.1.0 → 2.4.0

package/src/connection.js

@@ -26,12 +26,22 @@ class Connection {
 	/**
 	 * Creates a new Connection.
 	 * 
-	 * @param {string} baseUrl - URL to the back-end.
+	 * @param {string} baseUrl - The versioned URL or the back-end instance.
 	 * @param {Options} [options={}] - Additional options for the connection.
+	 * @param {?string} [url=null] - User-provided URL of the backend connected to.
 	 */
-	constructor(baseUrl, options = {}) {
+	constructor(baseUrl, options = {}, url = null) {
 		/**
-		 * URL of the backend connected to.
+		 * User-provided URL of the backend connected to.
+		 * 
+		 * `null` if not given and the connection was directly made to a versioned instance of the back-end.
+		 * 
+		 * @protected
+		 * @type {string | null}
+		 */
+		this.url = url;
+		/**
+		 * The versioned URL or the back-end instance.
 		 * 
 		 * @protected
 		 * @type {string}
@@ -41,31 +51,23 @@ class Connection {
 		 * Auth Provider cache
 		 * 
 		 * @protected
-		 * @type {?Array.<AuthProvider>}
+		 * @type {Array.<AuthProvider> | null}
 		 */
 		this.authProviderList = null;
 		/**
 		 * Current auth provider
 		 * 
 		 * @protected
-		 * @type {?AuthProvider}
+		 * @type {AuthProvider | null}
 		 */
 		this.authProvider = null;
 		/**
 		 * Capability cache
 		 * 
 		 * @protected
-		 * @type {?Capabilities}
+		 * @type {Capabilities | null}
 		 */
 		this.capabilitiesObject = null;
-		/**
-		 * Process cache
-		 * 
-		 * @protected
-		 * @type {ProcessRegistry}
-		 */
-		this.processes = new ProcessRegistry([], Boolean(options.addNamespaceToProcess));
-		this.processes.listeners.push((...args) => this.emit('processesChanged', ...args));
 		/**
 		 * Listeners for events.
 		 * 
@@ -80,12 +82,21 @@ class Connection {
 		 * @type {Options}
 		 */
 		this.options = options;
+		/**
+		 * Process cache
+		 * 
+		 * @protected
+		 * @type {ProcessRegistry}
+		 */
+		this.processes = new ProcessRegistry([], Boolean(options.addNamespaceToProcess));
+		this.processes.listeners.push((...args) => this.emit('processesChanged', ...args));
 	}
 
 	/**
 	 * Initializes the connection by requesting the capabilities.
 	 * 
 	 * @async
+	 * @protected
 	 * @returns {Promise<Capabilities>} Capabilities
 	 */
 	async init() {
@@ -95,14 +106,52 @@ class Connection {
 	}
 
 	/**
-	 * Returns the URL of the back-end currently connected to.
+	 * Refresh the cache for processes.
 	 * 
-	 * @returns {string} The URL or the back-end.
+	 * @async
+	 * @protected
+	 * @returns {Promise}
+	 */
+	async refreshProcessCache() {
+		if (this.processes.count() === 0) {
+			return;
+		}
+		let promises = this.processes.namespaces().map(namespace => {
+			let fn = () => Promise.resolve();
+			if (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();
+				}
+			}
+			else if (this.capabilities().hasFeature('listProcesses')) {
+				fn = () => this.listProcesses(namespace);
+			}
+			return fn().catch(error => console.warn(`Could not update processes for namespace '${namespace}' due to an error: ${error.message}`));
+		});
+		return await Promise.all(promises);
+	}
+
+	/**
+	 * Returns the URL of the versioned back-end instance currently connected to.
+	 * 
+	 * @returns {string} The versioned URL or the back-end instance.
 	 */
 	getBaseUrl() {
 		return this.baseUrl;
 	}
 
+	/**
+	 * Returns the user-provided URL of the back-end currently connected to.
+	 * 
+	 * @returns {string} The URL or the back-end.
+	 */
+	getUrl() {
+		return this.url || this.baseUrl;
+	}
+
 	/**
 	 * Returns the capabilities of the back-end.
 	 * 
@@ -241,6 +290,25 @@ class Connection {
 		}
 	}
 
+	/**
+	 * 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.
 	 * 
@@ -259,7 +327,7 @@ class Connection {
 		if (!namespace) {
 			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)) {
@@ -291,7 +359,7 @@ class Connection {
 			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');
 			}
@@ -492,6 +560,8 @@ class Connection {
 			this.authProvider = null;
 		}
 		this.emit('authProviderChanged', this.authProvider);
+		// Update process cache on auth changes: https://github.com/Open-EO/openeo-js-client/issues/55
+		this.refreshProcessCache();
 	}
 
 	/**
@@ -547,12 +617,12 @@ class Connection {
 		);
 	}
 
-
 	/**
 	 * A callback that is executed on upload progress updates.
 	 * 
 	 * @callback uploadStatusCallback
 	 * @param {number} percentCompleted - The percent (0-100) completed.
+	 * @param {UserFile} file - The file object corresponding to the callback.
 	 */
 
 	/**
@@ -567,15 +637,16 @@ class Connection {
 	 * @param {*} source - The source, see method description for details.
 	 * @param {?string} [targetPath=null] - The target path on the server, relative to the user workspace. Defaults to the file name of the source file.
 	 * @param {?uploadStatusCallback} [statusCallback=null] - Optionally, a callback that is executed on upload progress updates.
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the upload process.
 	 * @returns {Promise<UserFile>}
 	 * @throws {Error}
 	 */
-	async uploadFile(source, targetPath = null, statusCallback = null) {
+	async uploadFile(source, targetPath = null, statusCallback = null, abortController = null) {
 		if (targetPath === null) {
 			targetPath = Environment.fileNameForUpload(source);
 		}
 		let file = await this.getFile(targetPath);
-		return await file.uploadFile(source, statusCallback);
+		return await file.uploadFile(source, statusCallback, abortController);
 	}
 
 	/**
@@ -692,9 +763,10 @@ class Connection {
 	 * @param {Process} process - A user-defined process.
 	 * @param {?string} [plan=null] - The billing plan to use for this computation.
 	 * @param {?number} [budget=null] - The maximum budget allowed to spend for this computation.
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
 	 * @returns {Promise<SyncResult>} - An object with the data and some metadata.
 	 */
-	async computeResult(process, plan = null, budget = null) {
+	async computeResult(process, plan = null, budget = null, abortController = null) {
 		let requestBody = this._normalizeUserProcess(
 			process,
 			{
@@ -702,7 +774,7 @@ class Connection {
 				budget: budget
 			}
 		);
-		let response = await this._post('/result', requestBody, Environment.getResponseType());
+		let response = await this._post('/result', requestBody, Environment.getResponseType(), abortController);
 		let syncResult = {
 			data: response.data,
 			costs: null,
@@ -753,10 +825,11 @@ class Connection {
 	 * @param {string} targetPath - The target, see method description for details.
 	 * @param {?string} [plan=null] - The billing plan to use for this computation.
 	 * @param {?number} [budget=null] - The maximum budget allowed to spend for this computation.
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the processing request.
 	 * @throws {Error}
 	 */
-	async downloadResult(process, targetPath, plan = null, budget = null) {
-		let response = await this.computeResult(process, plan, budget);
+	async downloadResult(process, targetPath, plan = null, budget = null, abortController = null) {
+		let response = await this.computeResult(process, plan, budget, abortController);
 		// @ts-ignore
 		await Environment.saveToFile(response.data, targetPath);
 	}
@@ -801,7 +874,7 @@ class Connection {
 			throw new Error("Response did not contain a Job ID. Job has likely been created, but may not show up yet.");
 		}
 		let job = new Job(this, response.headers['openeo-identifier']).setAll(requestBody);
-		if (this.capabilitiesObject.hasFeature('describeJob')) {
+		if (this.capabilities().hasFeature('describeJob')) {
 			return await job.describeJob();
 		}
 		else {
@@ -867,7 +940,7 @@ class Connection {
 			throw new Error("Response did not contain a Service ID. Service has likely been created, but may not show up yet.");
 		}
 		let service = new Service(this, response.headers['openeo-identifier']).setAll(requestBody);
-		if (this.capabilitiesObject.hasFeature('describeService')) {
+		if (this.capabilities().hasFeature('describeService')) {
 			return service.describeService();
 		}
 		else {
@@ -936,17 +1009,19 @@ class Connection {
 	 * @param {string} path 
 	 * @param {*} body 
 	 * @param {string} responseType - Response type according to axios, defaults to `json`.
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
 	 * @returns {Promise<AxiosResponse>}
 	 * @throws {Error}
 	 * @see https://github.com/axios/axios#request-config
 	 */
-	async _post(path, body, responseType) {
-		return await this._send({
+	async _post(path, body, responseType, abortController = null) {
+		let options = {
 			method: 'post',
 			responseType: responseType,
 			url: path,
 			data: body
-		});
+		};
+		return await this._send(options, abortController);
 	}
 
 	/**
@@ -1032,11 +1107,12 @@ class Connection {
 	 * 
 	 * @async
 	 * @param {object.<string, *>} options 
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the request.
 	 * @returns {Promise<AxiosResponse>}
 	 * @throws {Error}
 	 * @see https://github.com/axios/axios
 	 */
-	async _send(options) {
+	async _send(options, abortController = null) {
 		options.baseURL = this.baseUrl;
 		if (this.isAuthenticated() && (typeof options.authorization === 'undefined' || options.authorization === true)) {
 			if (!options.headers) {
@@ -1047,6 +1123,9 @@ class Connection {
 		if (!options.responseType) {
 			options.responseType = 'json';
 		}
+		if (abortController) {
+			options.signal = abortController.signal;
+		}
 
 		try {
 			return await axios(options);

package/src/job.js

@@ -44,7 +44,7 @@ class Job extends BaseEntity {
 		 * The process chain to be executed.
 		 * @public
 		 * @readonly
-		 * @type {Process}
+		 * @type {?Process}
 		 */
 		this.process = undefined;
 		/**
@@ -52,35 +52,35 @@ class Job extends BaseEntity {
 		 * One of "created", "queued", "running", "canceled", "finished" or "error".
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.status = undefined;
 		/**
 		 * Indicates the process of a running batch job in percent. 
 		 * @public
 		 * @readonly
-		 * @type {number}
+		 * @type {?number}
 		 */
 		this.progress = undefined;
 		/**
 		 * Date and time of creation, formatted as a RFC 3339 date-time.
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.created = undefined;
 		/**
 		 * Date and time of the last status change, formatted as a RFC 3339 date-time.
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.updated = undefined;
 		/**
 		 * The billing plan to process and charge the batch job with.
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.plan = undefined;
 		/**

package/src/oidcprovider.js

@@ -78,7 +78,7 @@ class OidcProvider extends AuthProvider {
 		/**
 		 * The client ID to use for authentication.
 		 * 
-		 * @type {?string}
+		 * @type {string | null}
 		 */
 		this.clientId = null;
 
@@ -105,6 +105,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.
 		 * 
@@ -132,8 +139,8 @@ class OidcProvider extends AuthProvider {
 	 * Adds a listener to one of the following events:
 	 * 
 	 * - AccessTokenExpiring: Raised prior to the access token expiring.
-	 * - accessTokenExpired: Raised after the access token has expired.
-	 * - silentRenewError: Raised when the automatic silent renew has failed.
+	 * - AccessTokenExpired: Raised after the access token has expired.
+	 * - SilentRenewError: Raised when the automatic silent renew has failed.
 	 * 
 	 * @param {string} event 
 	 * @param {Function} callback
@@ -161,17 +168,20 @@ 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(options = {}) {
+	async login(options = {}, requestRefreshToken = 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');
 		if (OidcProvider.uiMethod === 'popup') {
@@ -216,15 +226,22 @@ 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(options = {}) {
+	getOptions(options = {}, requestRefreshToken = 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,
 			validateSubOnSilentRenew: true,
 			response_type,
 			response_mode: response_type.includes('code') ? 'query' : 'fragment'

package/src/openeo.js

@@ -1,4 +1,5 @@
 const axios = require('axios').default;
+const { AbortController } = require("node-abort-controller");
 const Utils = require('@openeo/js-commons/src/utils');
 const Versions = require('@openeo/js-commons/src/versions');
 
@@ -50,6 +51,7 @@ class OpenEO {
 	 */
 	static async connect(url, options = {}) {
 		let wellKnownUrl = Utils.normalizeUrl(url, '/.well-known/openeo');
+		let versionedUrl = url;
 		let response = null;
 		try {
 			response = await axios.get(wellKnownUrl, {timeout: 5000});
@@ -64,14 +66,16 @@ class OpenEO {
 		if (Utils.isObject(response)) {
 			let version = Versions.findLatest(response.data.versions, true, MIN_API_VERSION, MAX_API_VERSION);
 			if (version !== null) {
-				url = version.url;
+				versionedUrl = version.url;
 			}
 			else {
 				throw new Error("Server not supported. Client only supports the API versions between " + MIN_API_VERSION + " and " + MAX_API_VERSION);
 			}
 		}
 
-		return await OpenEO.connectDirect(url, options);
+		let connection = await OpenEO.connectDirect(versionedUrl, options);
+		connection.url = url;
+		return connection;
 	}
 
 	/**
@@ -106,7 +110,7 @@ class OpenEO {
 	 * @returns {string} Version number (according to SemVer).
 	 */
 	static clientVersion() {
-		return "2.1.0";
+		return "2.4.0";
 	}
 
 }
@@ -114,6 +118,7 @@ class OpenEO {
 OpenEO.Environment = require('./env');
 
 module.exports = {
+	AbortController,
 	AuthProvider,
 	BasicProvider,
 	Capabilities,

package/src/service.js

@@ -39,55 +39,55 @@ class Service extends BaseEntity {
 		 * The process chain to be executed.
 		 * @public
 		 * @readonly
-		 * @type {Process}
+		 * @type {?Process}
 		 */
 		this.process = undefined;
 		/**
 		 * URL at which the secondary web service is accessible
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.url = undefined;
 		/**
 		 * 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;
 		/**
 		 * 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;
 		/**
 		 * 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;
 		/**
 		 * Date and time of creation, formatted as a RFC 3339 date-time.
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.created = undefined;
 		/**
 		 * The billing plan to process and charge the service with.
 		 * @public
 		 * @readonly
-		 * @type {string}
+		 * @type {?string}
 		 */
 		this.plan = undefined;
 		/**

package/src/userfile.js

@@ -90,10 +90,11 @@ class UserFile extends BaseEntity {
 	 * @async
 	 * @param {*} source - The source, see method description for details.
 	 * @param {?uploadStatusCallback} statusCallback - Optionally, a callback that is executed on upload progress updates.
+	 * @param {?AbortController} [abortController=null] - An AbortController object that can be used to cancel the upload process.
 	 * @returns {Promise<UserFile>}
 	 * @throws {Error}
 	 */
-	async uploadFile(source, statusCallback = null) {
+	async uploadFile(source, statusCallback = null, abortController = null) {
 		let options = {
 			method: 'put',
 			url: '/files/' + this.path,
@@ -109,7 +110,7 @@ class UserFile extends BaseEntity {
 			};
 		}
 
-		let response = await this.connection._send(options);
+		let response = await this.connection._send(options, abortController);
 		return this.setAll(response.data);
 	}
 

package/src/userprocess.js

@@ -52,7 +52,7 @@ class UserProcess extends BaseEntity {
 		 * A list of categories.
 		 * @public
 		 * @readonly
-		 * @type {Array.<string>}
+		 * @type {?Array.<string>}
 		 */
 		this.categories = undefined;
 		/**
@@ -74,40 +74,40 @@ 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;
 		/**
 		 * 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;
 		/**
 		 * 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;
 		/**
 		 * 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;
 	}