Add resume option for OIDC authentication

Author: m-mohr

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [unreleased]
 
+### Added
+
+- Resume previously authenticated sessions via `AuthProvider.resume()`
+
 ## [2.10.0] - 2026-02-25
 
 ### Added

openeo.d.ts

@@ -86,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.
          *
@@ -569,6 +576,15 @@ 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.
          *
@@ -608,7 +624,16 @@ declare namespace OpenEO {
          * @see https://github.com/IdentityModel/oidc-client-js/wiki#other-optional-settings
          * @see {OidcProvider#refreshTokenScope}
          */
-        login(options?: Record<string, any>, requestRefreshToken?: boolean): Promise<void>;
+        login(options?: object<string, any>, requestRefreshToken?: boolean): Promise<void>;
+        /**
+         * Restores a previously established OIDC session from storage.
+         *
+         * @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?: object<string, any>): Promise<boolean>;
         /**
          * Returns the options for the OIDC client library.
          *

src/authprovider.js

@@ -127,6 +127,16 @@ class AuthProvider {
 		}
 	}
 
+	/**
+	 * Tries to resume an existing session.
+	 * 
+	 * @param  {...any} args 
+	 * @returns {boolean} `true` if the session could be resumed, `false` otherwise
+	 */
+	async resume(...args) { // eslint-disable-line no-unused-vars
+		return false;
+	}
+
 	/**
 	 * Abstract method that extending classes implement the login process with.
 	 * 

src/oidcprovider.js

@@ -202,6 +202,32 @@ class OidcProvider extends AuthProvider {
 		}
 	}
 
+	/**
+	 * Restores a previously established OIDC session from storage.
+	 * 
+	 * @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
+	 */
+	async resume(options = {}) {
+		this.manager = new Oidc.UserManager(this.getOptions(options));
+		this.addListener('UserLoaded', async () => this.setUser(await this.manager.getUser()), 'js-client');
+		this.addListener('AccessTokenExpired', () => this.setUser(null), 'js-client');
+
+		let user = await this.manager.getUser();
+		if (user && user.expired && user.refresh_token) {
+			user = await this.manager.signinSilent();
+		}
+
+		if (user && !user.expired) {
+			this.setUser(user);
+			return true;
+		}
+
+		return false;
+	}
+
 	/**
 	 * Logout from the established session.
 	 * 
@@ -395,4 +421,15 @@ OidcProvider.grants = [
 	'implicit'
 ];
 
+/**
+ * The WebStorageStateStore class from oidc-client.
+ * 
+ * Can be used to configure the `userStore` option for the UserManager,
+ * e.g. to persist tokens in localStorage:
+ * `new OidcProvider.WebStorageStateStore({ store: window.localStorage })`
+ * 
+ * @type {Oidc.WebStorageStateStore}
+ */
+OidcProvider.WebStorageStateStore = Oidc.WebStorageStateStore;
+
 module.exports = OidcProvider;