@openeo/js-client 2.5.1 → 2.6.0

package/src/basicprovider.js

@@ -1,49 +1,70 @@
-const Environment = require('./env');
-const Utils = require('@openeo/js-commons/src/utils');
-const AuthProvider = require('./authprovider');
-
-/**
- * The Authentication Provider for HTTP Basic.
- * 
- * @augments AuthProvider
- */
-class BasicProvider extends AuthProvider {
-
-	/**
-	 * Creates a new BasicProvider instance to authenticate using HTTP Basic.
-	 * 
-	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
-	 */
-	constructor(connection) {
-		super("basic", connection, {
-			id: null,
-			title: "HTTP Basic",
-			description: "Login with username and password using the method HTTP Basic."
-		});
-	}
-
-	/**
-	 * Authenticate with HTTP Basic.
-	 * 
-	 * @async
-	 * @param {string} username 
-	 * @param {string} password 
-	 * @returns {Promise<void>}
-	 * @throws {Error}
-	 */
-	async login(username, password) {
-		let response = await this.connection._send({
-			method: 'get',
-			responseType: 'json',
-			url: '/credentials/basic',
-			headers: {'Authorization': 'Basic ' + Environment.base64encode(username + ':' + password)}
-		});
-		if (!Utils.isObject(response.data) || typeof response.data.access_token !== 'string') {
-			throw new Error("No access_token returned.");
-		}
-		this.setToken(response.data.access_token);
-	}
-
-}
-
+const Environment = require('./env');
+const Utils = require('@openeo/js-commons/src/utils');
+const AuthProvider = require('./authprovider');
+
+/**
+ * The Authentication Provider for HTTP Basic.
+ * 
+ * @augments AuthProvider
+ */
+class BasicProvider extends AuthProvider {
+
+	/**
+	 * Creates a new BasicProvider instance to authenticate using HTTP Basic.
+	 * 
+	 * @param {Connection} connection - A Connection object representing an established connection to an openEO back-end.
+	 */
+	constructor(connection) {
+		super("basic", connection, {
+			id: null,
+			title: "HTTP Basic",
+			description: "Login with username and password using the method HTTP Basic."
+		});
+		this.username = null;
+	}
+
+	/**
+	 * Authenticate with HTTP Basic.
+	 * 
+	 * @async
+	 * @param {string} username 
+	 * @param {string} password 
+	 * @returns {Promise<void>}
+	 * @throws {Error}
+	 */
+	async login(username, password) {
+		let response = await this.connection._send({
+			method: 'get',
+			responseType: 'json',
+			url: '/credentials/basic',
+			headers: {'Authorization': 'Basic ' + Environment.base64encode(username + ':' + password)}
+		});
+		if (!Utils.isObject(response.data) || typeof response.data.access_token !== 'string') {
+			throw new Error("No access_token returned.");
+		}
+		this.username = username;
+		this.setToken(response.data.access_token);
+	}
+
+	/**
+	 * Returns a display name for the authenticated user.
+	 * 
+	 * @returns {string?} Name of the user or `null`
+	 */
+	getDisplayName() {
+		return this.username;
+	}
+
+	/**
+	 * Logout from the established session.
+	 * 
+	 * @async
+	 */
+	async logout() {
+		this.username = null;
+		await super.logout();
+	}
+
+}
+
 module.exports = BasicProvider;

package/src/browser.js

@@ -1,168 +1,168 @@
-/**
- * Platform dependant utilities for the openEO JS Client.
- * 
- * Browser implementation, don't use in other environments.
- * 
- * @hideconstructor
- */
-class Environment {
-
-	/**
-	 * Returns the name of the Environment, here `Browser`.
-	 * 
-	 * @returns {string}
-	 * @static
-	 */
-	static getName() {
-		return 'Browser';
-	}
-
-	/**
-	 * Returns the current URL of the browser window.
-	 * 
-	 * @returns {string}
-	 * @static
-	 */
-	static getUrl() {
-		return window.location.toString();
-	}
-
-	/**
-	 * Sets the URL.
-	 * 
-	 * Not supported in Browsers and only throws an Error!
-	 * 
-	 * @param {string} uri
-	 * @static
-	 */
-	static setUrl(uri) { // eslint-disable-line no-unused-vars
-		throw new Error("setUrl is not supported in a browser environment.");
-	}
-
-	/**
-	 * Handles errors from the API that are returned as Blobs.
-	 * 
-	 * @ignore
-	 * @static
-	 * @param {Blob} error 
-	 * @returns {Promise<void>}
-	 */
-	static handleErrorResponse(error) {
-		return new Promise((resolve, reject) => {
-			let fileReader = new FileReader();
-			fileReader.onerror = event => {
-				fileReader.abort();
-				reject(event.target.error);
-			};
-			fileReader.onload = () => {
-				// ArrayBuffer to String conversion is from https://developers.google.com/web/updates/2012/06/How-to-convert-ArrayBuffer-to-and-from-String
-				let res = fileReader.result instanceof ArrayBuffer ? String.fromCharCode.apply(null, new Uint16Array(fileReader.result)) : fileReader.result;
-				let obj = typeof res === 'string' ? JSON.parse(res) : res;
-				resolve(obj);
-			};
-			fileReader.readAsText(error.response.data);
-		});
-	}
-
-	/**
-	 * Returns how binary responses from the servers are returned (`stream` or `blob`).
-	 * 
-	 * @returns {string}
-	 * @static
-	 */
-	static getResponseType() {
-		return 'blob';
-	}
-
-	/**
-	 * Encodes a string into Base64 encoding.
-	 * 
-	 * @static
-	 * @param {string} str - String to encode.
-	 * @returns {string} String encoded in Base64.
-	 */
-	static base64encode(str) {
-		// btoa is JS's ugly name for encodeBase64
-		return btoa(str);
-	}
-
-	/**
-	 * Detect the file name for the given data source.
-	 * 
-	 * @ignore
-	 * @static
-	 * @param {*} source - An object from a file upload form.
-	 * @returns {string}
-	 */
-	static fileNameForUpload(source) {
-		return source.name.split(/(\\|\/)/g).pop();
-	}
-
-	/**
-	 * Get the data from the source that should be uploaded.
-	 * 
-	 * @ignore
-	 * @static
-	 * @param {*} source - An object from a file upload form.
-	 * @returns {*}
-	 */
-	static dataForUpload(source) {
-		return source;
-	}
-
-	/**
-	 * Downloads files to local storage and returns a list of file paths.
-	 * 
-	 * Not supported in Browsers and only throws an Error!
-	 * 
-	 * @static
-	 * @param {Connection} con 
-	 * @param {Array.<object.<string, *>>} assets 
-	 * @param {string} targetFolder 
-	 * @throws {Error}
-	 */
-	static async downloadResults(con, assets, targetFolder) { // eslint-disable-line no-unused-vars
-		throw new Error("downloadResults is not supported in a browser environment.");
-	}
-
-	/**
-	 * Offers data to download in the browser.
-	 * 
-	 * This method may fail with overly big data.
-	 * 
-	 * @async
-	 * @static
-	 * @param {*} data - Data to download.
-	 * @param {string} filename - File name that is suggested to the user.
-	 * @returns {Promise<void>}
-	 * @see https://github.com/kennethjiang/js-file-download/blob/master/file-download.js
-	 */
-	static saveToFile(data, filename) {
-		/* istanbul ignore next */
-		return new Promise((resolve, reject) => {
-			try {
-				if (!(data instanceof Blob)) {
-					data = new Blob([data], {type: 'application/octet-stream'});
-				}
-				let blobURL = window.URL.createObjectURL(data);
-				let tempLink = document.createElement('a');
-				tempLink.style.display = 'none';
-				tempLink.href = blobURL;
-				tempLink.setAttribute('download', filename || 'download');
-				if (typeof tempLink.download === 'undefined') {
-					tempLink.setAttribute('target', '_blank');
-				}
-				document.body.appendChild(tempLink);
-				tempLink.click();
-				document.body.removeChild(tempLink);
-				window.URL.revokeObjectURL(blobURL);
-				resolve();
-			} catch (error) {
-				console.error(error);
-				reject(error);
-			}
-		});
-	}
-}
-
-module.exports = Environment;
+/**
+ * Platform dependant utilities for the openEO JS Client.
+ * 
+ * Browser implementation, don't use in other environments.
+ * 
+ * @hideconstructor
+ */
+class Environment {
+
+	/**
+	 * Returns the name of the Environment, here `Browser`.
+	 * 
+	 * @returns {string}
+	 * @static
+	 */
+	static getName() {
+		return 'Browser';
+	}
+
+	/**
+	 * Returns the current URL of the browser window.
+	 * 
+	 * @returns {string}
+	 * @static
+	 */
+	static getUrl() {
+		return window.location.toString();
+	}
+
+	/**
+	 * Sets the URL.
+	 * 
+	 * Not supported in Browsers and only throws an Error!
+	 * 
+	 * @param {string} uri
+	 * @static
+	 */
+	static setUrl(uri) { // eslint-disable-line no-unused-vars
+		throw new Error("setUrl is not supported in a browser environment.");
+	}
+
+	/**
+	 * Handles errors from the API that are returned as Blobs.
+	 * 
+	 * @ignore
+	 * @static
+	 * @param {Blob} error 
+	 * @returns {Promise<void>}
+	 */
+	static handleErrorResponse(error) {
+		return new Promise((resolve, reject) => {
+			let fileReader = new FileReader();
+			fileReader.onerror = event => {
+				fileReader.abort();
+				reject(event.target.error);
+			};
+			fileReader.onload = () => {
+				// ArrayBuffer to String conversion is from https://developers.google.com/web/updates/2012/06/How-to-convert-ArrayBuffer-to-and-from-String
+				let res = fileReader.result instanceof ArrayBuffer ? String.fromCharCode.apply(null, new Uint16Array(fileReader.result)) : fileReader.result;
+				let obj = typeof res === 'string' ? JSON.parse(res) : res;
+				resolve(obj);
+			};
+			fileReader.readAsText(error.response.data);
+		});
+	}
+
+	/**
+	 * Returns how binary responses from the servers are returned (`stream` or `blob`).
+	 * 
+	 * @returns {string}
+	 * @static
+	 */
+	static getResponseType() {
+		return 'blob';
+	}
+
+	/**
+	 * Encodes a string into Base64 encoding.
+	 * 
+	 * @static
+	 * @param {string} str - String to encode.
+	 * @returns {string} String encoded in Base64.
+	 */
+	static base64encode(str) {
+		// btoa is JS's ugly name for encodeBase64
+		return btoa(str);
+	}
+
+	/**
+	 * Detect the file name for the given data source.
+	 * 
+	 * @ignore
+	 * @static
+	 * @param {*} source - An object from a file upload form.
+	 * @returns {string}
+	 */
+	static fileNameForUpload(source) {
+		return source.name.split(/(\\|\/)/g).pop();
+	}
+
+	/**
+	 * Get the data from the source that should be uploaded.
+	 * 
+	 * @ignore
+	 * @static
+	 * @param {*} source - An object from a file upload form.
+	 * @returns {*}
+	 */
+	static dataForUpload(source) {
+		return source;
+	}
+
+	/**
+	 * Downloads files to local storage and returns a list of file paths.
+	 * 
+	 * Not supported in Browsers and only throws an Error!
+	 * 
+	 * @static
+	 * @param {Connection} con 
+	 * @param {Array.<object.<string, *>>} assets 
+	 * @param {string} targetFolder 
+	 * @throws {Error}
+	 */
+	static async downloadResults(con, assets, targetFolder) { // eslint-disable-line no-unused-vars
+		throw new Error("downloadResults is not supported in a browser environment.");
+	}
+
+	/**
+	 * Offers data to download in the browser.
+	 * 
+	 * This method may fail with overly big data.
+	 * 
+	 * @async
+	 * @static
+	 * @param {*} data - Data to download.
+	 * @param {string} filename - File name that is suggested to the user.
+	 * @returns {Promise<void>}
+	 * @see https://github.com/kennethjiang/js-file-download/blob/master/file-download.js
+	 */
+	static saveToFile(data, filename) {
+		/* istanbul ignore next */
+		return new Promise((resolve, reject) => {
+			try {
+				if (!(data instanceof Blob)) {
+					data = new Blob([data], {type: 'application/octet-stream'});
+				}
+				let blobURL = window.URL.createObjectURL(data);
+				let tempLink = document.createElement('a');
+				tempLink.style.display = 'none';
+				tempLink.href = blobURL;
+				tempLink.setAttribute('download', filename || 'download');
+				if (typeof tempLink.download === 'undefined') {
+					tempLink.setAttribute('target', '_blank');
+				}
+				document.body.appendChild(tempLink);
+				tempLink.click();
+				document.body.removeChild(tempLink);
+				window.URL.revokeObjectURL(blobURL);
+				resolve();
+			} catch (error) {
+				console.error(error);
+				reject(error);
+			}
+		});
+	}
+}
+
+module.exports = Environment;