Implement processing parameters extension (#74)

Author: m-mohr

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `Capabilities`: Added `hasConformance` function and `Conformance` URI object
+- `Connection`: Added `listProcessingParameters` function
+
 ## [2.8.0] - 2025-04-25
 
 ### Added

openeo.d.ts

@@ -437,6 +437,15 @@ declare namespace OpenEO {
          * @returns {boolean} `true` if the feature is supported, otherwise `false`.
          */
         hasFeature(methodName: string): boolean;
+        /**
+         * 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: string | Array<string>): boolean;
         /**
          * Get the billing currency.
          *
@@ -457,6 +466,8 @@ declare namespace OpenEO {
          * @returns {AxiosResponse}
          */
         protected migrate(response: AxiosResponse): AxiosResponse;
+
+        static Conformance: Record<string, string | Array<string>>;
     }
     /**
      * The Authentication Provider for OpenID Connect.
@@ -2167,6 +2178,14 @@ declare namespace OpenEO {
          * @throws {Error}
          */
         listFileTypes(): Promise<FileTypes>;
+        /**
+         * List the supported output file formats.
+         *
+         * @async
+         * @returns {Promise<ProcessingParameters>} A response compatible to the API specification.
+         * @throws {Error}
+         */
+        listProcessingParameters(): Promise<ProcessingParameters>;
         /**
          * List the supported secondary service types.
          *
@@ -3078,6 +3097,27 @@ declare namespace OpenEO {
      * An openEO processing chain.
      */
     export type Process = Record<string, any>;
+    /**
+     * A specific processing parameter.
+     */
+    type ProcessingParameter = object<string, any>;
+    /**
+     * All types of processing parameters.
+     */
+    type ProcessingParameters = {
+        /**
+         * Processing parameters for batch jobs.
+         */
+        create_job_parameters: Array<ProcessingParameter>;
+        /**
+         * Processing parameters for secondary web services.
+         */
+        create_service_parameters: Array<ProcessingParameter>;
+        /**
+         * Processing parameters for synchronous processing.
+         */
+        create_synchronous_parameters: Array<ProcessingParameter>;
+    };
     /**
      * A back-end in the federation.
      */

package.json

@@ -55,7 +55,8 @@
     "@openeo/js-commons": "^1.5.0",
     "@radiantearth/stac-migrate": "^1.0.0",
     "axios": "^1.0.0",
-    "oidc-client": "^1.11.5"
+    "oidc-client": "^1.11.5",
+    "regexp.escape": "^2.0.1"
   },
   "scripts": {
     "docs": "jsdoc -r -d docs/ -P package.json -R README.md -c .jsdoc",

src/capabilities.js

@@ -1,11 +1,15 @@
 const Utils = require('@openeo/js-commons/src/utils');
+if (typeof RegExp.escape !== 'function') {
+	require('regexp.escape').shim();
+}
 
 const FEATURE_MAP = {
 	// Discovery
 	capabilities: true,
 	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;

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.
 	 * 

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.
  * 

tests/vito.test.js

@@ -5,7 +5,7 @@ const { Utils } = require('@openeo/js-commons');
 jest.setTimeout(30*1000);
 
 describe('VITO back-end', () => {
-	const TESTBACKEND = 'https://openeo.vito.be';
+	const TESTBACKEND = 'https://openeo-dev.vito.be';
 
 	let con;
 	test('Connect', async () => {
@@ -37,6 +37,18 @@ describe('VITO back-end', () => {
 		});
 	});
 
+	describe('Processing Parameters', () => {
+		test('conformance class', async () => {
+			let cap = await con.capabilities();
+			expect(cap.hasConformance(Capabilities.Conformance.processingParameters)).toBeTruthy();
+		});
+		test('listProcessingParameters', async () => {
+			let params = await con.listProcessingParameters();
+			expect(Array.isArray(params.create_job_parameters)).toBeTruthy();
+			expect(Array.isArray(params.create_synchronous_parameters)).toBeTruthy();
+		});
+	});
+
 	describe('Request processes from namespace', () => {
 
 		// Not implemented yet by VITO