@openeo/js-client 2.7.0 → 2.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/src/connection.js CHANGED
@@ -194,6 +194,18 @@ class Connection {
194
194
  return new FileTypes(response.data);
195
195
  }
196
196
 
197
+ /**
198
+ * List the supported output file formats.
199
+ *
200
+ * @async
201
+ * @returns {Promise<ProcessingParameters>} A response compatible to the API specification.
202
+ * @throws {Error}
203
+ */
204
+ async listProcessingParameters() {
205
+ const response = await this._get('/processing_parameters');
206
+ return response.data;
207
+ }
208
+
197
209
  /**
198
210
  * List the supported secondary service types.
199
211
  *
@@ -948,7 +960,7 @@ class Connection {
948
960
  *
949
961
  * @async
950
962
  * @param {Array.<Service>} [oldServices=[]] - A list of existing services to update.
951
- * @returns {Promise<ResponseArray.<Job>>} A list of services.
963
+ * @returns {Promise<ResponseArray.<Service>>} A list of services.
952
964
  * @throws {Error}
953
965
  */
954
966
  async listServices(oldServices = []) {
package/src/openeo.js CHANGED
@@ -109,7 +109,7 @@ class OpenEO {
109
109
  * @returns {string} Version number (according to SemVer).
110
110
  */
111
111
  static clientVersion() {
112
- return "2.7.0";
112
+ return "2.9.0";
113
113
  }
114
114
 
115
115
  }
package/src/pages.js CHANGED
@@ -21,7 +21,7 @@ class Pages {
21
21
  * @param {Connection} connection
22
22
  * @param {string} endpoint
23
23
  * @param {string} key
24
- * @param {Constructor} cls
24
+ * @param {Constructor} cls - Class
25
25
  * @param {object} [params={}]
26
26
  * @param {string} primaryKey
27
27
  */
package/src/typedefs.js CHANGED
@@ -196,14 +196,32 @@
196
196
  */
197
197
 
198
198
  /**
199
- * An array of backends in the federation.
199
+ * A specific processing parameter.
200
+ *
201
+ * @typedef ProcessingParameter
202
+ * @type {object.<string, *>}
203
+ */
204
+
205
+ /**
206
+ * All types of processing parameters.
207
+ *
208
+ * @typedef ProcessingParameters
209
+ * @type {object}
210
+ * @property {Array.<ProcessingParameter>} create_job_parameters Processing parameters for batch jobs.
211
+ * @property {Array.<ProcessingParameter>} create_service_parameters Processing parameters for secondary web services.
212
+ * @property {Array.<ProcessingParameter>} create_synchronous_parameters Processing parameters for synchronous processing.
213
+ */
214
+
215
+ /**
216
+ * A back-end in the federation.
200
217
  *
201
218
  * @typedef FederationBackend
202
219
  * @type {object}
220
+ * @property {string} id ID of the back-end within the federation.
203
221
  * @property {string} url URL to the versioned API endpoint of the back-end.
204
222
  * @property {string} title Name of the back-end.
205
223
  * @property {string} description A description of the back-end and its specifics.
206
- * @property {string} status Current status of the back-ends (online or offline).
224
+ * @property {string} status Current status of the back-end (online or offline).
207
225
  * @property {string} last_status_check The time at which the status of the back-end was checked last, formatted as a RFC 3339 date-time.
208
226
  * @property {string} last_successful_check If the `status` is `offline`: The time at which the back-end was checked and available the last time. Otherwise, this is equal to the property `last_status_check`. Formatted as a RFC 3339 date-time.
209
227
  * @property {boolean} experimental Declares the back-end to be experimental.
@@ -213,7 +231,7 @@
213
231
  /**
214
232
  * An array, but enriched with additional details from an openEO API response.
215
233
  *
216
- * Adds three properties: `links` and `federation:missing`.
234
+ * Adds two properties: `links` and `federation:missing`.
217
235
  *
218
236
  * @typedef ResponseArray
219
237
  * @augments Array