@openeo/js-client 2.5.1 → 2.6.0

package/src/userfile.js

@@ -1,128 +1,128 @@
-const Environment = require('./env');
-const BaseEntity = require('./baseentity');
-
-/**
- * A File on the user workspace.
- * 
- * @augments BaseEntity
- */
-class UserFile extends BaseEntity {
-
-	/**
-	 * Creates an object representing a file on the user workspace.
-	 * 
-	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
-	 * @param {string} path - The path to the file, relative to the user workspace and without user ID.
-	 */
-	constructor(connection, path) {
-		super(connection, ["path", "size", "modified"]);
-		/**
-		 * Path to the file, relative to the user's directory.
-		 * @readonly
-		 * @public
-		 * @type {string}
-		 */
-		this.path = path;
-		/** 
-		 * File size in bytes as integer.
-		 * @readonly
-		 * @public
-		 * @type {number}
-		 */
-		this.size = undefined;
-		/**
-		 * Date and time the file has lastly been modified, formatted as a RFC 3339 date-time.
-		 * @readonly
-		 * @public
-		 * @type {string}
-		 */
-		this.modified = undefined;
-	}
-
-	/**
-	 * Downloads a file from the user workspace into memory.
-	 * 
-	 * This method has different behaviour depending on the environment.
-	 * Returns a stream in a NodeJS environment or a Blob in a browser environment.
-	 * 
-	 * @async
-	 * @returns {Promise<Stream.Readable|Blob>} - Return value depends on the target and environment, see method description for details.
-	 * @throws {Error}
-	 */
-	async retrieveFile() {
-		return await this.connection.download('/files/' + this.path, true);
-	}
-
-	/**
-	 * Downloads a file from the user workspace and saves it.
-	 * 
-	 * This method has different behaviour depending on the environment.
-	 * In a NodeJS environment writes the downloaded file to the target location on the file system.
-	 * In a browser environment offers the file for downloading using the specified name (folders are not supported).
-	 * 
-	 * @async
-	 * @param {string} target - The target, see method description for details.
-	 * @returns {Promise<Array.<string>|void>} - Return value depends on the target and environment, see method description for details.
-	 * @throws {Error}
-	 */
-	async downloadFile(target) {
-		let data = await this.connection.download('/files/' + this.path, true);
-		// @ts-ignore
-		return await Environment.saveToFile(data, target);
-	}
-
-	/**
-	 * 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.
-	 */
-
-	/**
-	 * Uploads a file to the user workspace.
-	 * If a file with the name exists, overwrites it.
-	 * 
-	 * This method has different behaviour depending on the environment.
-	 * In a nodeJS environment the source must be a path to a file as string.
-	 * In a browser environment the source must be an object from a file upload form.
-	 * 
-	 * @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, abortController = null) {
-		let options = {
-			method: 'put',
-			url: '/files/' + this.path,
-			data: Environment.dataForUpload(source),
-			headers: {
-				'Content-Type': 'application/octet-stream'
-			}
-		};
-		if (typeof statusCallback === 'function') {
-			options.onUploadProgress = (progressEvent) => {
-				let percentCompleted = Math.round( (progressEvent.loaded * 100) / progressEvent.total );
-				statusCallback(percentCompleted, this);
-			};
-		}
-
-		let response = await this.connection._send(options, abortController);
-		return this.setAll(response.data);
-	}
-
-	/**
-	 * Deletes the file from the user workspace.
-	 * 
-	 * @async
-	 * @throws {Error}
-	 */
-	async deleteFile() {
-		await this.connection._delete('/files/' + this.path);
-	}
-}
-
-module.exports = UserFile;
+const Environment = require('./env');
+const BaseEntity = require('./baseentity');
+
+/**
+ * A File on the user workspace.
+ * 
+ * @augments BaseEntity
+ */
+class UserFile extends BaseEntity {
+
+	/**
+	 * Creates an object representing a file on the user workspace.
+	 * 
+	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
+	 * @param {string} path - The path to the file, relative to the user workspace and without user ID.
+	 */
+	constructor(connection, path) {
+		super(connection, ["path", "size", "modified"]);
+		/**
+		 * Path to the file, relative to the user's directory.
+		 * @readonly
+		 * @public
+		 * @type {string}
+		 */
+		this.path = path;
+		/** 
+		 * File size in bytes as integer.
+		 * @readonly
+		 * @public
+		 * @type {number}
+		 */
+		this.size = undefined;
+		/**
+		 * Date and time the file has lastly been modified, formatted as a RFC 3339 date-time.
+		 * @readonly
+		 * @public
+		 * @type {string}
+		 */
+		this.modified = undefined;
+	}
+
+	/**
+	 * Downloads a file from the user workspace into memory.
+	 * 
+	 * This method has different behaviour depending on the environment.
+	 * Returns a stream in a NodeJS environment or a Blob in a browser environment.
+	 * 
+	 * @async
+	 * @returns {Promise<Stream.Readable|Blob>} - Return value depends on the target and environment, see method description for details.
+	 * @throws {Error}
+	 */
+	async retrieveFile() {
+		return await this.connection.download('/files/' + this.path, true);
+	}
+
+	/**
+	 * Downloads a file from the user workspace and saves it.
+	 * 
+	 * This method has different behaviour depending on the environment.
+	 * In a NodeJS environment writes the downloaded file to the target location on the file system.
+	 * In a browser environment offers the file for downloading using the specified name (folders are not supported).
+	 * 
+	 * @async
+	 * @param {string} target - The target, see method description for details.
+	 * @returns {Promise<Array.<string>|void>} - Return value depends on the target and environment, see method description for details.
+	 * @throws {Error}
+	 */
+	async downloadFile(target) {
+		let data = await this.connection.download('/files/' + this.path, true);
+		// @ts-ignore
+		return await Environment.saveToFile(data, target);
+	}
+
+	/**
+	 * 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.
+	 */
+
+	/**
+	 * Uploads a file to the user workspace.
+	 * If a file with the name exists, overwrites it.
+	 * 
+	 * This method has different behaviour depending on the environment.
+	 * In a nodeJS environment the source must be a path to a file as string.
+	 * In a browser environment the source must be an object from a file upload form.
+	 * 
+	 * @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, abortController = null) {
+		let options = {
+			method: 'put',
+			url: '/files/' + this.path,
+			data: Environment.dataForUpload(source),
+			headers: {
+				'Content-Type': 'application/octet-stream'
+			}
+		};
+		if (typeof statusCallback === 'function') {
+			options.onUploadProgress = (progressEvent) => {
+				let percentCompleted = Math.round( (progressEvent.loaded * 100) / progressEvent.total );
+				statusCallback(percentCompleted, this);
+			};
+		}
+
+		let response = await this.connection._send(options, abortController);
+		return this.setAll(response.data);
+	}
+
+	/**
+	 * Deletes the file from the user workspace.
+	 * 
+	 * @async
+	 * @throws {Error}
+	 */
+	async deleteFile() {
+		await this.connection._delete('/files/' + this.path);
+	}
+}
+
+module.exports = UserFile;

package/src/userprocess.js

@@ -1,166 +1,166 @@
-const BaseEntity = require('./baseentity');
-const Utils = require('@openeo/js-commons/src/utils');
-
-/**
- * A Stored Process Graph.
- * 
- * @augments BaseEntity
- */
-class UserProcess extends BaseEntity {
-
-	/**
-	 * Creates an object representing a process graph stored at the back-end.
-	 * 
-	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
-	 * @param {string} id - ID of a stored process graph.
-	 */
-	constructor(connection, id) {
-		super(connection, [
-			"id",
-			"summary",
-			"description",
-			"categories",
-			"parameters",
-			"returns",
-			"deprecated",
-			"experimental",
-			"exceptions",
-			"examples",
-			"links",
-			["process_graph", "processGraph"]
-		]);
-		/**
-		 * The identifier of the process.
-		 * @public
-		 * @readonly
-		 * @type {string}
-		 */
-		this.id = id;
-		/**
-		 * @public
-		 * @readonly
-		 * @type {?string}
-		 */
-		this.summary = undefined;
-		/**
-		 * @public
-		 * @readonly
-		 * @type {?string}
-		 */
-		this.description = undefined;
-		/**
-		 * A list of categories.
-		 * @public
-		 * @readonly
-		 * @type {?Array.<string>}
-		 */
-		this.categories = undefined;
-		/**
-		 * A list of parameters.
-		 * 
-		 * @public
-		 * @readonly
-		 * @type {?Array.<object.<string, *>>}
-		 */
-		this.parameters = undefined;
-		/**
-		 * Description of the data that is returned by this process.
-		 * @public
-		 * @readonly
-		 * @type {?object.<string, *>}
-		 */
-		this.returns = undefined;
-		/**
-		 * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions. 
-		 * @public
-		 * @readonly
-		 * @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}
-		 */
-		this.experimental = undefined;
-		/**
-		 * Declares any exceptions (errors) that might occur during execution of this process.
-		 * @public
-		 * @readonly
-		 * @type {?object.<string, *>}
-		 */
-		this.exceptions = undefined;
-		/**
-		 * @public
-		 * @readonly
-		 * @type {?Array.<object.<string, *>>}
-		 */
-		this.examples = undefined;
-		/**
-		 * Links related to this process.
-		 * @public
-		 * @readonly
-		 * @type {?Array.<Link>}
-		 */
-		this.links = undefined;
-		/**
-		 * @public
-		 * @readonly
-		 * @type {?object.<string, *>}
-		 */
-		this.processGraph = undefined;
-	}
-
-	/**
-	 * Updates the data stored in this object by requesting the process graph metadata from the back-end.
-	 * 
-	 * @async
-	 * @returns {Promise<UserProcess>} The updated process graph object (this).
-	 * @throws {Error}
-	 */
-	async describeUserProcess() {
-		let response = await this.connection._get('/process_graphs/' + this.id);
-		if (!Utils.isObject(response.data) || typeof response.data.id !== 'string') {
-			throw new Error('Invalid response received for user process');
-		}
-		this.connection.processes.add(response.data, 'user');
-		return this.setAll(response.data);
-	}
-
-	/**
-	 * Modifies the stored process graph at the back-end and afterwards updates this object, too.
-	 * 
-	 * @async
-	 * @param {object} parameters - An object with properties to update, each of them is optional, but at least one of them must be specified. Additional properties can be set if the server supports them.
-	 * @param {Process} parameters.process - A new process.
-	 * @param {string} parameters.title - A new title.
-	 * @param {string} parameters.description - A new description.
-	 * @returns {Promise<UserProcess>} The updated process graph object (this).
-	 * @throws {Error}
-	 */
-	async replaceUserProcess(parameters) {
-		await this.connection._put('/process_graphs/' + this.id, this._convertToRequest(parameters));
-		if (this._supports('describeUserProcess')) {
-			return this.describeUserProcess();
-		}
-		else {
-			let obj = this.setAll(parameters);
-			this.connection.processes.add(obj.toJSON(), 'user');
-			return obj;
-		}
-	}
-
-	/**
-	 * Deletes the stored process graph from the back-end.
-	 * 
-	 * @async
-	 * @throws {Error}
-	 */
-	async deleteUserProcess() {
-		await this.connection._delete('/process_graphs/' + this.id);
-		this.connection.processes.remove(this.id, 'user');
-	}
-}
-
-module.exports = UserProcess;
+const BaseEntity = require('./baseentity');
+const Utils = require('@openeo/js-commons/src/utils');
+
+/**
+ * A Stored Process Graph.
+ * 
+ * @augments BaseEntity
+ */
+class UserProcess extends BaseEntity {
+
+	/**
+	 * Creates an object representing a process graph stored at the back-end.
+	 * 
+	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
+	 * @param {string} id - ID of a stored process graph.
+	 */
+	constructor(connection, id) {
+		super(connection, [
+			"id",
+			"summary",
+			"description",
+			"categories",
+			"parameters",
+			"returns",
+			"deprecated",
+			"experimental",
+			"exceptions",
+			"examples",
+			"links",
+			["process_graph", "processGraph"]
+		]);
+		/**
+		 * The identifier of the process.
+		 * @public
+		 * @readonly
+		 * @type {string}
+		 */
+		this.id = id;
+		/**
+		 * @public
+		 * @readonly
+		 * @type {?string}
+		 */
+		this.summary = undefined;
+		/**
+		 * @public
+		 * @readonly
+		 * @type {?string}
+		 */
+		this.description = undefined;
+		/**
+		 * A list of categories.
+		 * @public
+		 * @readonly
+		 * @type {?Array.<string>}
+		 */
+		this.categories = undefined;
+		/**
+		 * A list of parameters.
+		 * 
+		 * @public
+		 * @readonly
+		 * @type {?Array.<object.<string, *>>}
+		 */
+		this.parameters = undefined;
+		/**
+		 * Description of the data that is returned by this process.
+		 * @public
+		 * @readonly
+		 * @type {?object.<string, *>}
+		 */
+		this.returns = undefined;
+		/**
+		 * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions. 
+		 * @public
+		 * @readonly
+		 * @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}
+		 */
+		this.experimental = undefined;
+		/**
+		 * Declares any exceptions (errors) that might occur during execution of this process.
+		 * @public
+		 * @readonly
+		 * @type {?object.<string, *>}
+		 */
+		this.exceptions = undefined;
+		/**
+		 * @public
+		 * @readonly
+		 * @type {?Array.<object.<string, *>>}
+		 */
+		this.examples = undefined;
+		/**
+		 * Links related to this process.
+		 * @public
+		 * @readonly
+		 * @type {?Array.<Link>}
+		 */
+		this.links = undefined;
+		/**
+		 * @public
+		 * @readonly
+		 * @type {?object.<string, *>}
+		 */
+		this.processGraph = undefined;
+	}
+
+	/**
+	 * Updates the data stored in this object by requesting the process graph metadata from the back-end.
+	 * 
+	 * @async
+	 * @returns {Promise<UserProcess>} The updated process graph object (this).
+	 * @throws {Error}
+	 */
+	async describeUserProcess() {
+		let response = await this.connection._get('/process_graphs/' + this.id);
+		if (!Utils.isObject(response.data) || typeof response.data.id !== 'string') {
+			throw new Error('Invalid response received for user process');
+		}
+		this.connection.processes.add(response.data, 'user');
+		return this.setAll(response.data);
+	}
+
+	/**
+	 * Modifies the stored process graph at the back-end and afterwards updates this object, too.
+	 * 
+	 * @async
+	 * @param {object} parameters - An object with properties to update, each of them is optional, but at least one of them must be specified. Additional properties can be set if the server supports them.
+	 * @param {Process} parameters.process - A new process.
+	 * @param {string} parameters.title - A new title.
+	 * @param {string} parameters.description - A new description.
+	 * @returns {Promise<UserProcess>} The updated process graph object (this).
+	 * @throws {Error}
+	 */
+	async replaceUserProcess(parameters) {
+		await this.connection._put('/process_graphs/' + this.id, this._convertToRequest(parameters));
+		if (this._supports('describeUserProcess')) {
+			return this.describeUserProcess();
+		}
+		else {
+			let obj = this.setAll(parameters);
+			this.connection.processes.add(obj.toJSON(), 'user');
+			return obj;
+		}
+	}
+
+	/**
+	 * Deletes the stored process graph from the back-end.
+	 * 
+	 * @async
+	 * @throws {Error}
+	 */
+	async deleteUserProcess() {
+		await this.connection._delete('/process_graphs/' + this.id);
+		this.connection.processes.remove(this.id, 'user');
+	}
+}
+
+module.exports = UserProcess;