@openeo/js-client 2.9.0 → 2.11.0

package/README.md

@@ -4,7 +4,7 @@ JavaScript/TypeScript client for the openEO API.
 
 * [Documentation](https://open-eo.github.io/openeo-js-client/latest/).
 
-The version of this client is **2.9.0** and supports **openEO API versions 1.x.x**.
+The version of this client is **2.10.0** and supports **openEO API versions 1.x.x**.
 Legacy versions are available as releases.
 See the [CHANGELOG](CHANGELOG.md) for recent changes.
 
@@ -75,7 +75,7 @@ Run tests:
 * `npm test browser` (browser tests)
 * `npm test node` (node tests)
 * `npm test builder` (tests only the process builder)
-* `npm test earthengine` (full test suite using the Google Earth Engine back-end as server)
+* `npm test test-api` (full test suite using the openeo-test-api back-end as server)
 
 # Contributions
 

package/openeo.d.ts

@@ -70,6 +70,8 @@ declare namespace OpenEO {
          * Returns the access token that is used as Bearer Token in API requests.
          *
          * Returns `null` if no access token has been set yet (i.e. not authenticated any longer).
+         * 
+         * Checks whether the server supports the JWT conformance class.
          *
          * @returns {string | null}
          */
@@ -84,6 +86,13 @@ declare namespace OpenEO {
          * @param {?string} token
          */
         setToken(token: string | null): void;
+        /**
+         * Tries to resume an existing session.
+         *
+         * @param  {...any} args
+         * @returns {boolean} `true` if the session could be resumed, `false` otherwise
+         */
+        resume(...args: any[]): boolean;
         /**
          * Abstract method that extending classes implement the login process with.
          *
@@ -528,10 +537,18 @@ declare namespace OpenEO {
          * @type {string | null}
          */
         clientId: string | null;
+        /**
+         * The client secret to use for authentication.
+         *
+         * Only used for the `client_credentials` grant type.
+         *
+         * @type {string | null}
+         */
+        clientSecret: string | null;
         /**
          * The grant type (flow) to use for this provider.
          *
-         * Either "authorization_code+pkce" (default) or "implicit"
+         * Either "authorization_code+pkce" (default), "implicit" or "client_credentials"
          *
          * @type {string}
          */
@@ -567,12 +584,27 @@ declare namespace OpenEO {
          * @type {Array.<OidcClient>}
          */
         defaultClients: Array<OidcClient>;
+        /**
+         * Additional parameters to include in authorization requests.
+         *
+         * As defined by the API, these parameters MUST be included when
+         * requesting the authorization endpoint.
+         *
+         * @type {object.<string, *>}
+         */
+        authorizationParameters: Record<string, any>;
         /**
          * The detected default Client.
          *
          * @type {OidcClient}
          */
         defaultClient: OidcClient;
+        /**
+         * The cached OpenID Connect well-known configuration document.
+         *
+         * @type {object.<string, *> | null}
+         */
+        wellKnownDocument: Record<string, any> | null;
         /**
          * Adds a listener to one of the following events:
          *
@@ -596,7 +628,8 @@ declare namespace OpenEO {
         /**
          * Authenticate with OpenID Connect (OIDC).
          *
-         * Supported only in Browser environments.
+         * Supported in Browser environments for `authorization_code+pkce` and `implicit` grants.
+         * The `client_credentials` grant is supported in all environments.
          *
          * @async
          * @param {object.<string, *>} [options={}] - Object with authentication options.
@@ -607,6 +640,53 @@ declare namespace OpenEO {
          * @see {OidcProvider#refreshTokenScope}
          */
         login(options?: Record<string, any>, requestRefreshToken?: boolean): Promise<void>;
+        /**
+         * Authenticate using the OIDC Client Credentials grant.
+         *
+         * Requires `clientId` and `clientSecret` to be set.
+         * This flow does not use the oidc-client library and works in all environments.
+         *
+         * @async
+         * @protected
+         * @returns {Promise<void>}
+         * @throws {Error}
+         */
+        protected loginClientCredentials(): Promise<void>;
+        /**
+         * Retrieves the OpenID Connect well-known configuration document.
+         *
+         * @async
+         * @returns {Promise<object.<str, *>> | null} The well-known configuration document, or `null` if the issuer URL is not set.
+         */
+        getWellKnownDocument(): Promise<Record<string, any>> | null;
+        /**
+         * Discovers the token endpoint from the OpenID Connect issuer.
+         *
+         * @async
+         * @protected
+         * @returns {Promise<string>} The token endpoint URL.
+         * @throws {Error}
+         */
+        protected getTokenEndpoint(): Promise<string>;
+        /**
+         * Checks whether the OpenID Connect provider supports the Client Credentials grant.
+         *
+         * @async
+         * @returns {Promise<boolean|null>} `true` if the Client Credentials grant is supported, `false` otherwise. `null` if unknown.
+         */
+        supportsClientCredentials(): Promise<boolean | null>;
+        /**
+         * Restores a previously established OIDC session from storage.
+         *
+         * Not supported for the `client_credentials` grant as credentials
+         * are not persisted. Use `login()` to re-authenticate instead.
+         *
+         * @async
+         * @param {object.<string, *>} [options={}] - Additional options passed to the OIDC UserManager.
+         * @returns {Promise<boolean>} `true` if the session could be resumed, `false` otherwise.
+         * @see https://github.com/IdentityModel/oidc-client-js/wiki#usermanager
+         */
+        resume(options?: Record<string, any>): Promise<boolean>;
         /**
          * Returns the options for the OIDC client library.
          *
@@ -642,6 +722,14 @@ declare namespace OpenEO {
          * @param {string | null} clientId
          */
         setClientId(clientId: string | null): void;
+        /**
+         * Sets the Client Secret for OIDC authentication.
+         *
+         * Only used for the `client_credentials` grant type.
+         *
+         * @param {string | null} clientSecret
+         */
+        setClientSecret(clientSecret: string | null): void;
         /**
          * Sets the OIDC User.
          *