@openeo/js-client 2.3.1 → 2.4.0

package/openeo.js

@@ -1840,6 +1840,7 @@ class AuthProvider {
   /**
    * Abstract method that extending classes implement the login process with.
    * 
+   * @async
    * @param {...*} args 
    * @throws {Error}
    */
@@ -2460,19 +2461,19 @@ class Builder {
     this.id = id;
     /**
      * The parent builder.
-     * @type {?Builder}
+     * @type {Builder | null}
      */
 
     this.parent = parent;
     /**
      * The parent node.
-     * @type {?BuilderNode}
+     * @type {BuilderNode | null}
      */
 
     this.parentNode = null;
     /**
      * The parent parameter name.
-     * @type {?string}
+     * @type {string | null}
      */
 
     this.parentParameter = null;
@@ -2808,7 +2809,7 @@ class Formula {
 
     this.tree = parser.parse(formula);
     /**
-     * @type {?Builder}
+     * @type {Builder | null}
      */
 
     this.builder = null;
@@ -4328,7 +4329,7 @@ class Connection {
      * Auth Provider cache
      * 
      * @protected
-     * @type {?Array.<AuthProvider>}
+     * @type {Array.<AuthProvider> | null}
      */
 
     this.authProviderList = null;
@@ -4336,7 +4337,7 @@ class Connection {
      * Current auth provider
      * 
      * @protected
-     * @type {?AuthProvider}
+     * @type {AuthProvider | null}
      */
 
     this.authProvider = null;
@@ -4344,7 +4345,7 @@ class Connection {
      * Capability cache
      * 
      * @protected
-     * @type {?Capabilities}
+     * @type {Capabilities | null}
      */
 
     this.capabilitiesObject = null;
@@ -4598,6 +4599,26 @@ class Connection {
       nextUrl = this._getLinkHref(response.data.links);
     }
   }
+  /**
+   * Normalisation of the namespace to a value that is compatible with the OpenEO specs - EXPERIMENTAL.
+   *
+   * This is required to support UDP that are shared as public. These can only be executed with providing the full URL
+   * (e.g. https://<backend>/processes/<namespace>/<process_id>) as the namespace value in the processing graph. For other
+   * parts of the API (such as the listing of the processes, only the name of the namespace is required.
+   *
+   * This function will extract the short name of the namespace from a shareable URL.
+   * 
+   * @protected
+   * @param {?string} namespace - Namespace of the process
+   * @returns {?string}
+   */
+
+
+  normalizeNamespace(namespace) {
+    // The pattern in https://github.com/Open-EO/openeo-api/pull/348 doesn't include the double colon yet - the regexp may change in the future
+    const matches = namespace.match(/^https?:\/\/.*\/processes\/(@?[\w\-.~:]+)\/?/i);
+    return matches && matches.length > 1 ? matches[1] : namespace;
+  }
   /**
    * List processes available on the back-end.
    * 
@@ -4621,7 +4642,7 @@ class Connection {
       namespace = 'backend';
     }
 
-    let path = namespace === 'backend' ? '/processes' : `/processes/${namespace}`;
+    let path = namespace === 'backend' ? '/processes' : `/processes/${this.normalizeNamespace(namespace)}`;
     let response = await this._get(path);
 
     if (!Utils.isObject(response.data) || !Array.isArray(response.data.processes)) {
@@ -4657,7 +4678,7 @@ class Connection {
     if (namespace === 'backend') {
       await this.listProcesses();
     } else {
-      let response = await this._get(`/processes/${namespace}/${processId}`);
+      let response = await this._get(`/processes/${this.normalizeNamespace(namespace)}/${processId}`);
 
       if (!Utils.isObject(response.data) || typeof response.data.id !== 'string') {
         throw new Error('Invalid response received for process');
@@ -5723,7 +5744,7 @@ class Job extends BaseEntity {
      * The process chain to be executed.
      * @public
      * @readonly
-     * @type {Process}
+     * @type {?Process}
      */
 
     this.process = undefined;
@@ -5732,7 +5753,7 @@ class Job extends BaseEntity {
      * One of "created", "queued", "running", "canceled", "finished" or "error".
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.status = undefined;
@@ -5740,7 +5761,7 @@ class Job extends BaseEntity {
      * Indicates the process of a running batch job in percent. 
      * @public
      * @readonly
-     * @type {number}
+     * @type {?number}
      */
 
     this.progress = undefined;
@@ -5748,7 +5769,7 @@ class Job extends BaseEntity {
      * Date and time of creation, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.created = undefined;
@@ -5756,7 +5777,7 @@ class Job extends BaseEntity {
      * Date and time of the last status change, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.updated = undefined;
@@ -5764,7 +5785,7 @@ class Job extends BaseEntity {
      * The billing plan to process and charge the batch job with.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.plan = undefined;
@@ -6216,7 +6237,7 @@ class OidcProvider extends AuthProvider {
     /**
      * The client ID to use for authentication.
      * 
-     * @type {?string}
+     * @type {string | null}
      */
 
     this.clientId = null;
@@ -6244,6 +6265,13 @@ class OidcProvider extends AuthProvider {
      */
 
     this.scopes = Array.isArray(options.scopes) && options.scopes.length > 0 ? options.scopes : ['openid'];
+    /**
+     * The scope that is used to request a refresh token.
+     * 
+     * @type {string}
+     */
+
+    this.refreshTokenScope = "offline_access";
     /**
      * Any additional links.
      * 
@@ -6304,21 +6332,25 @@ class OidcProvider extends AuthProvider {
    * 
    * Supported only in Browser environments.
    * 
+   * @async
    * @param {object.<string, *>} [options={}] - Object with authentication options.
+   * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
    * @returns {Promise<void>}
    * @throws {Error}
    * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
+   * @see {OidcProvider#refreshTokenScope}
    */
 
 
   async login() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let requestRefreshToken = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
 
     if (!this.issuer || typeof this.issuer !== 'string') {
       throw new Error("No Issuer URL available for OpenID Connect");
     }
 
-    this.manager = new Oidc.UserManager(this.getOptions(options));
+    this.manager = new Oidc.UserManager(this.getOptions(options, requestRefreshToken));
     this.addListener('UserLoaded', async () => this.setUser(await this.manager.getUser()), 'js-client');
     this.addListener('AccessTokenExpired', () => this.setUser(null), 'js-client');
 
@@ -6363,18 +6395,27 @@ class OidcProvider extends AuthProvider {
    * 
    * @protected
    * @param {object.<string, *>} options 
+   * @param {boolean} [requestRefreshToken=false] - If set to `true`, adds a scope to request a refresh token.
    * @returns {object.<string, *>}
+   * @see {OidcProvider#refreshTokenScope}
    */
 
 
   getOptions() {
     let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+    let requestRefreshToken = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
     let response_type = this.getResponseType();
+    let scope = this.scopes.slice(0);
+
+    if (requestRefreshToken && !scope.includes(this.refreshTokenScope)) {
+      scope.push(this.refreshTokenScope);
+    }
+
     return Object.assign({
       client_id: this.clientId,
       redirect_uri: OidcProvider.redirectUrl,
       authority: this.issuer.replace('/.well-known/openid-configuration', ''),
-      scope: this.scopes.join(' '),
+      scope,
       validateSubOnSilentRenew: true,
       response_type,
       response_mode: response_type.includes('code') ? 'query' : 'fragment'
@@ -6652,7 +6693,7 @@ class OpenEO {
 
 
   static clientVersion() {
-    return "2.3.1";
+    return "2.4.0";
   }
 
 }
@@ -6728,7 +6769,7 @@ class Service extends BaseEntity {
      * The process chain to be executed.
      * @public
      * @readonly
-     * @type {Process}
+     * @type {?Process}
      */
 
     this.process = undefined;
@@ -6736,7 +6777,7 @@ class Service extends BaseEntity {
      * URL at which the secondary web service is accessible
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.url = undefined;
@@ -6744,14 +6785,14 @@ class Service extends BaseEntity {
      * Web service type (protocol / standard) that is exposed.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.type = undefined;
     /**
      * @public
      * @readonly
-     * @type {boolean}
+     * @type {?boolean}
      */
 
     this.enabled = undefined;
@@ -6759,7 +6800,7 @@ class Service extends BaseEntity {
      * Map of configuration settings, i.e. the setting names supported by the secondary web service combined with actual values. 
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.configuration = undefined;
@@ -6767,7 +6808,7 @@ class Service extends BaseEntity {
      * Additional attributes of the secondary web service, e.g. available layers for a WMS based on the bands in the underlying GeoTiff.
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.attributes = undefined;
@@ -6775,7 +6816,7 @@ class Service extends BaseEntity {
      * Date and time of creation, formatted as a RFC 3339 date-time.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.created = undefined;
@@ -6783,7 +6824,7 @@ class Service extends BaseEntity {
      * The billing plan to process and charge the service with.
      * @public
      * @readonly
-     * @type {string}
+     * @type {?string}
      */
 
     this.plan = undefined;
@@ -7134,7 +7175,7 @@ class UserProcess extends BaseEntity {
      * A list of categories.
      * @public
      * @readonly
-     * @type {Array.<string>}
+     * @type {?Array.<string>}
      */
 
     this.categories = undefined;
@@ -7159,7 +7200,7 @@ class UserProcess extends BaseEntity {
      * Specifies that the process or parameter is deprecated with the potential to be removed in any of the next versions. 
      * @public
      * @readonly
-     * @type {boolean}
+     * @type {?boolean}
      */
 
     this.deprecated = undefined;
@@ -7167,7 +7208,7 @@ class UserProcess extends BaseEntity {
      * 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}
+     * @type {?boolean}
      */
 
     this.experimental = undefined;
@@ -7175,14 +7216,14 @@ class UserProcess extends BaseEntity {
      * Declares any exceptions (errors) that might occur during execution of this process.
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.exceptions = undefined;
     /**
      * @public
      * @readonly
-     * @type {Array.<object.<string, *>>}
+     * @type {?Array.<object.<string, *>>}
      */
 
     this.examples = undefined;
@@ -7190,14 +7231,14 @@ class UserProcess extends BaseEntity {
      * Links related to this process.
      * @public
      * @readonly
-     * @type {Array.<Link>}
+     * @type {?Array.<Link>}
      */
 
     this.links = undefined;
     /**
      * @public
      * @readonly
-     * @type {object.<string, *>}
+     * @type {?object.<string, *>}
      */
 
     this.processGraph = undefined;