@openeo/js-client 2.8.0 → 2.10.0

package/src/capabilities.js

@@ -1,4 +1,7 @@
 const Utils = require('@openeo/js-commons/src/utils');
+if (typeof RegExp.escape !== 'function') {
+	require('regexp.escape').shim();
+}
 
 const FEATURE_MAP = {
 	// Discovery
@@ -6,6 +9,7 @@ const FEATURE_MAP = {
 	listFileTypes: 'get /file_formats',
 	listServiceTypes: 'get /service_types',
 	listUdfRuntimes: 'get /udf_runtimes',
+	listProcessingParameters: 'get /processing_parameters',
 	// Collections
 	listCollections: 'get /collections',
 	describeCollection: 'get /collections/{}',
@@ -58,6 +62,22 @@ const FEATURE_MAP = {
 	debugService: 'get /services/{}/logs',
 };
 
+const CONFORMANCE_CLASSES = {
+	openeo: "https://api.openeo.org/extensions/openeo/v1.*",
+	// STAC API
+	stacCollections: [
+		'https://api.stacspec.org/v1.*/collections',
+		'https://api.stacspec.org/v1.*/ogcapi-features'
+	],
+	stacItems: 'https://api.stacspec.org/v1.*/ogcapi-features',
+	// openEO API Extensions
+	commercialData: 'https://api.openeo.org/extensions/commercial-data/0.1.*',
+	federation: 'https://api.openeo.org/extensions/federation/0.1.*',
+	processingParameters: "https://api.openeo.org/extensions/processing-parameters/0.1.*",
+	remoteProcessDefinition: 'https://api.openeo.org/extensions/remote-process-definition/0.1.*',
+	workspaces: 'https://api.openeo.org/extensions/workspaces/0.1.*'
+};
+
 /**
  * Capabilities of a back-end.
  */
@@ -261,6 +281,29 @@ class Capabilities {
 		return feature === true || this.features.some(e => e === feature);
 	}
 
+	/**
+	 * Check whether a conformance class is supported by the back-end.
+	 * 
+	 * Use `*` as a wildcard character for e.g. version numbers.
+	 * 
+	 * @param {string|Array.<string>} uris - Conformance class URI(s) - any of them must match.
+	 * @returns {boolean} `true` if any of the conformance classes is supported, otherwise `false`.
+	 */
+	hasConformance(uris) {
+		if (typeof uris === 'string') {
+			uris = [uris];
+		}
+		if(!Array.isArray(this.data.conformsTo) || !Array.isArray(uris)) {
+			return false;
+		}
+
+		const classRegexp = uris
+			.map(uri => RegExp.escape(uri).replaceAll('\\*', '[^/]+'))
+			.join('|');
+		const regexp = new RegExp('^(' + classRegexp + ')$');
+		return Boolean(this.data.conformsTo.find(uri => uri.match(regexp)));
+	}
+
 	/**
 	 * Get the billing currency.
 	 * 
@@ -302,4 +345,6 @@ class Capabilities {
 	}
 }
 
+Capabilities.Conformance = CONFORMANCE_CLASSES;
+
 module.exports = Capabilities;

package/src/connection.js

@@ -194,6 +194,18 @@ class Connection {
 		return new FileTypes(response.data);
 	}
 
+	/**
+	 * List the supported output file formats.
+	 * 
+	 * @async
+	 * @returns {Promise<ProcessingParameters>} A response compatible to the API specification.
+	 * @throws {Error}
+	 */
+	async listProcessingParameters() {
+		const response = await this._get('/processing_parameters');
+		return response.data;
+	}
+
 	/**
 	 * List the supported secondary service types.
 	 * 
@@ -733,7 +745,7 @@ class Connection {
 		const response = await this._post('/validation', this._normalizeUserProcess(process).process);
 		if (Array.isArray(response.data.errors)) {
 			const errors = response.data.errors;
-			errors['federation:backends'] = Array.isArray(response.data['federation:missing']) ? response.data['federation:missing'] : [];
+			errors['federation:backends'] = Array.isArray(response.data['federation:backends']) ? response.data['federation:backends'] : [];
 			return errors;
 		}
 		else {
@@ -948,7 +960,7 @@ class Connection {
 	 * 
 	 * @async
 	 * @param {Array.<Service>} [oldServices=[]] - A list of existing services to update.
-	 * @returns {Promise<ResponseArray.<Job>>} A list of services.
+	 * @returns {Promise<ResponseArray.<Service>>} A list of services.
 	 * @throws {Error}
 	 */
 	async listServices(oldServices = []) {

package/src/oidcprovider.js

@@ -127,6 +127,16 @@ class OidcProvider extends AuthProvider {
 		 */
 		this.defaultClients = Array.isArray(options.default_clients) ? options.default_clients : [];
 
+		/**
+		 * Additional parameters to include in authorization requests.
+		 * 
+		 * As defined by the API, these parameters MUST be included when
+		 * requesting the authorization endpoint.
+		 * 
+		 * @type {object.<string, *>}
+		 */
+		this.authorizationParameters = Utils.isObject(options.authorization_parameters) ? options.authorization_parameters : {};
+
 		/**
 		 * The detected default Client.
 		 * 
@@ -244,7 +254,8 @@ class OidcProvider extends AuthProvider {
 			scope: scope.join(' '),
 			validateSubOnSilentRenew: true,
 			response_type,
-			response_mode: response_type.includes('code') ? 'query' : 'fragment'
+			response_mode: response_type.includes('code') ? 'query' : 'fragment',
+			extraQueryParams: this.authorizationParameters
 		}, options);
 	}
 

package/src/openeo.js

@@ -109,7 +109,7 @@ class OpenEO {
 	 * @returns {string} Version number (according to SemVer).
 	 */
 	static clientVersion() {
-		return "2.8.0";
+		return "2.10.0";
 	}
 
 }

package/src/typedefs.js

@@ -195,6 +195,23 @@
  * @type {object.<string, *>} 
  */
 
+/**
+ * A specific processing parameter.
+ * 
+ * @typedef ProcessingParameter
+ * @type {object.<string, *>}
+ */
+
+/**
+ * All types of processing parameters.
+ * 
+ * @typedef ProcessingParameters
+ * @type {object}
+ * @property {Array.<ProcessingParameter>} create_job_parameters Processing parameters for batch jobs.
+ * @property {Array.<ProcessingParameter>} create_service_parameters Processing parameters for secondary web services.
+ * @property {Array.<ProcessingParameter>} create_synchronous_parameters Processing parameters for synchronous processing.
+ */
+
 /**
  * A back-end in the federation.
  *