@cosmotech/core 1.18.1 → 1.19.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+## **1.19.0** <sub><sup>2024-10-22 (07716f7...07716f7)</sup></sub>
+
+### Features
+
+- add configuration option `rolesJwtClaim` in `AuthKeycloakRedirect` provider ([07716f7](https://github.com/Cosmo-Tech/webapp-component-core/commit/07716f7))
+
+## **1.18.2** <sub><sup>2024-09-23 (e619d7e...e619d7e)</sup></sub>
+
+### Bug Fixes
+
+- fix empty user roles when using Keycloak auth provider ([e619d7e](https://github.com/Cosmo-Tech/webapp-component-core/commit/e619d7e))
+
 ## **1.18.1** <sub><sup>2024-09-17 (3629ee8...3629ee8)</sup></sub>
 
 ### Bug Fixes

package/dist/index.cjs.js

@@ -57287,7 +57287,6 @@ var readFromStorage = key => localStorage.getItem(key);
 var clearFromStorage = key => localStorage.removeItem(key);
 var name = 'auth-keycloakRedirect';
 var authData = {
-  authenticated: readFromStorage('authAuthenticated') === 'true',
   accountId: undefined,
   userEmail: undefined,
   username: undefined,
@@ -57351,20 +57350,19 @@ var acquireTokens = /*#__PURE__*/function () {
     var _msalApp$getAllAccoun;
     var forceRefresh = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     if (!checkInit()) return;
-    if (!forceRefresh) {
+    if (!forceRefresh && readFromStorage('authAuthenticated') === 'true') {
       var idToken = readFromStorage('authIdToken');
       var accessToken = readFromStorage('authAccessToken');
-      var authenticated = readFromStorage('authAuthenticated') === 'true';
-      if (authenticated && idToken != null && accessToken != null) {
-        return {
-          accessToken,
-          idToken
-        };
-      }
+      return {
+        accessToken,
+        idToken
+      };
     }
     var account = (_msalApp$getAllAccoun = msalApp.getAllAccounts()) === null || _msalApp$getAllAccoun === void 0 ? void 0 : _msalApp$getAllAccoun[0];
     if (account === undefined) return;
-    return yield _acquireTokensByRequestAndAccount(config.accessRequest, account);
+    var tokens = yield _acquireTokensByRequestAndAccount(config.accessRequest, account);
+    _updateTokensInStorage(tokens);
+    return tokens;
   });
   return function acquireTokens() {
     return _ref3.apply(this, arguments);
@@ -57373,12 +57371,10 @@ var acquireTokens = /*#__PURE__*/function () {
 var handleResponse = response => {
   if (response != null) {
     var account = response.account;
+    _updateTokensInStorage(response);
     writeToStorage('authIdTokenPopup', response.idToken);
-    writeToStorage('authIdToken', response.idToken);
-    writeToStorage('authAccessToken', response.accessToken);
     writeToStorage('authAuthenticated', 'true');
     writeToStorage('authAccountId', account.homeAccountId);
-    authData.authenticated = true;
     authData.accountId = account.homeAccountId;
     authData.userEmail = account.username; // In MSAL account data, username property contains user email
     authData.username = account.name;
@@ -57420,23 +57416,39 @@ var isAsync = () => {
 };
 var _updateTokensInStorage = tokens => {
   if (tokens !== null && tokens !== void 0 && tokens.idToken) writeToStorage('authIdToken', tokens.idToken);
-  if (tokens !== null && tokens !== void 0 && tokens.accessToken) writeToStorage('authAccessToken', tokens.accessToken);
+  if (tokens !== null && tokens !== void 0 && tokens.accessToken) {
+    writeToStorage('authAccessToken', tokens.accessToken);
+    authData.roles = _extractRolesFromAccessToken(tokens.accessToken);
+  }
 };
 var _extractRolesFromAccessToken = accessToken => {
-  var result = [];
-  if (accessToken) {
-    var decodedToken = JSON.parse(atob(accessToken.split('.')[1]));
-    if (decodedToken !== null && decodedToken !== void 0 && decodedToken.roles) {
-      result = decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.roles;
-    }
-  }
-  return result;
+  var _config2;
+  if (!accessToken) return [];
+  var decodedToken = JSON.parse(atob(accessToken.split('.')[1]));
+  // The exact key to use may depend from keycloak client & Cosmo Tech API configuration (c.f. the value of
+  // csm.platform.authorization.roles-jwt-claim in your k8s tenant secrets)
+  var rolesTokenAttribute = (_config2 = config) === null || _config2 === void 0 ? void 0 : _config2.rolesJwtClaim;
+  if (rolesTokenAttribute) {
+    if (decodedToken !== null && decodedToken !== void 0 && decodedToken[rolesTokenAttribute]) return decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken[rolesTokenAttribute];
+    console.warn("Authentication provider configuration defined rolesJwtClaim=\"".concat(rolesTokenAttribute, "\" ") + 'but this key was not found in the access token. Please check your webapp and API configuration.');
+  }
+  if (decodedToken !== null && decodedToken !== void 0 && decodedToken.roles) return decodedToken.roles; // Legacy default key in token
+
+  if (decodedToken !== null && decodedToken !== void 0 && decodedToken.userRoles) {
+    console.warn("DEPRECATED: the token claim for API roles was automatically found in 'userRoles', but the lookup " + 'for this specific key will be removed in a future version. Please update your webapp configuration to ' + "explicitly set AUTH_KEYCLOAK_ROLES_JWT_CLAIM to 'userRoles'.");
+    return decodedToken.userRoles;
+  }
+  console.warn("Couldn't extract roles from access token. Please check your webapp and API configuration.");
+  return [];
 };
 var isUserSignedIn = /*#__PURE__*/function () {
   var _ref4 = _asyncToGenerator(function* () {
-    if (authData.authenticated) return true;
     if (readFromStorage('authAuthenticated') === 'true') {
-      authData.authenticated = true;
+      // Restore roles from access token if necessary (roles in auhtData may be lost after login redirection)
+      if (authData.roles.length === 0) {
+        var accessToken = readFromStorage('authAccessToken');
+        if (accessToken) authData.roles = _extractRolesFromAccessToken(accessToken);
+      }
       return true;
     }
     try {
@@ -57445,12 +57457,12 @@ var isUserSignedIn = /*#__PURE__*/function () {
         clearFromStorage('authInteractionInProgress');
         var locationHashParameters = new URLSearchParams(window.location.hash.substring(1));
         if (locationHashParameters.has('state')) {
-          var _config2;
-          if (locationHashParameters.has('iss', (_config2 = config) === null || _config2 === void 0 || (_config2 = _config2.msalConfig) === null || _config2 === void 0 || (_config2 = _config2.auth) === null || _config2 === void 0 || (_config2 = _config2.authorityMetadata) === null || _config2 === void 0 ? void 0 : _config2.issuer)) {
+          var _config3;
+          if (locationHashParameters.has('iss', (_config3 = config) === null || _config3 === void 0 || (_config3 = _config3.msalConfig) === null || _config3 === void 0 || (_config3 = _config3.auth) === null || _config3 === void 0 || (_config3 = _config3.authorityMetadata) === null || _config3 === void 0 ? void 0 : _config3.issuer)) {
             msalApp.handleRedirectPromise().then(handleResponse); // Resume redirect workflow process
           } else if (locationHashParameters.has('iss')) {
-            var _config3;
-            var configIssuer = (_config3 = config) === null || _config3 === void 0 || (_config3 = _config3.msalConfig) === null || _config3 === void 0 || (_config3 = _config3.auth) === null || _config3 === void 0 || (_config3 = _config3.authorityMetadata) === null || _config3 === void 0 ? void 0 : _config3.issuer;
+            var _config4;
+            var configIssuer = (_config4 = config) === null || _config4 === void 0 || (_config4 = _config4.msalConfig) === null || _config4 === void 0 || (_config4 = _config4.auth) === null || _config4 === void 0 || (_config4 = _config4.authorityMetadata) === null || _config4 === void 0 ? void 0 : _config4.issuer;
             var urlIssuer = locationHashParameters.get('iss');
             console.warn("Issuer found in url \"".concat(urlIssuer, "\" does not match keycloak configuration: \"").concat(configIssuer, "\""));
           }
@@ -57460,10 +57472,7 @@ var isUserSignedIn = /*#__PURE__*/function () {
       // Otherwise, try to acquire a token silently to implement SSO
       var tokens = yield acquireTokens();
       _updateTokensInStorage(tokens);
-      if ((tokens === null || tokens === void 0 ? void 0 : tokens.accessToken) !== undefined) {
-        authData.roles = _extractRolesFromAccessToken(tokens.accessToken);
-        return true;
-      }
+      if ((tokens === null || tokens === void 0 ? void 0 : tokens.accessToken) !== undefined) return true;
     } catch (e) {
       console.error(e);
     }

package/dist/index.esm.js

@@ -57285,7 +57285,6 @@ var readFromStorage = key => localStorage.getItem(key);
 var clearFromStorage = key => localStorage.removeItem(key);
 var name = 'auth-keycloakRedirect';
 var authData = {
-  authenticated: readFromStorage('authAuthenticated') === 'true',
   accountId: undefined,
   userEmail: undefined,
   username: undefined,
@@ -57349,20 +57348,19 @@ var acquireTokens = /*#__PURE__*/function () {
     var _msalApp$getAllAccoun;
     var forceRefresh = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
     if (!checkInit()) return;
-    if (!forceRefresh) {
+    if (!forceRefresh && readFromStorage('authAuthenticated') === 'true') {
       var idToken = readFromStorage('authIdToken');
       var accessToken = readFromStorage('authAccessToken');
-      var authenticated = readFromStorage('authAuthenticated') === 'true';
-      if (authenticated && idToken != null && accessToken != null) {
-        return {
-          accessToken,
-          idToken
-        };
-      }
+      return {
+        accessToken,
+        idToken
+      };
     }
     var account = (_msalApp$getAllAccoun = msalApp.getAllAccounts()) === null || _msalApp$getAllAccoun === void 0 ? void 0 : _msalApp$getAllAccoun[0];
     if (account === undefined) return;
-    return yield _acquireTokensByRequestAndAccount(config.accessRequest, account);
+    var tokens = yield _acquireTokensByRequestAndAccount(config.accessRequest, account);
+    _updateTokensInStorage(tokens);
+    return tokens;
   });
   return function acquireTokens() {
     return _ref3.apply(this, arguments);
@@ -57371,12 +57369,10 @@ var acquireTokens = /*#__PURE__*/function () {
 var handleResponse = response => {
   if (response != null) {
     var account = response.account;
+    _updateTokensInStorage(response);
     writeToStorage('authIdTokenPopup', response.idToken);
-    writeToStorage('authIdToken', response.idToken);
-    writeToStorage('authAccessToken', response.accessToken);
     writeToStorage('authAuthenticated', 'true');
     writeToStorage('authAccountId', account.homeAccountId);
-    authData.authenticated = true;
     authData.accountId = account.homeAccountId;
     authData.userEmail = account.username; // In MSAL account data, username property contains user email
     authData.username = account.name;
@@ -57418,23 +57414,39 @@ var isAsync = () => {
 };
 var _updateTokensInStorage = tokens => {
   if (tokens !== null && tokens !== void 0 && tokens.idToken) writeToStorage('authIdToken', tokens.idToken);
-  if (tokens !== null && tokens !== void 0 && tokens.accessToken) writeToStorage('authAccessToken', tokens.accessToken);
+  if (tokens !== null && tokens !== void 0 && tokens.accessToken) {
+    writeToStorage('authAccessToken', tokens.accessToken);
+    authData.roles = _extractRolesFromAccessToken(tokens.accessToken);
+  }
 };
 var _extractRolesFromAccessToken = accessToken => {
-  var result = [];
-  if (accessToken) {
-    var decodedToken = JSON.parse(atob(accessToken.split('.')[1]));
-    if (decodedToken !== null && decodedToken !== void 0 && decodedToken.roles) {
-      result = decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken.roles;
-    }
-  }
-  return result;
+  var _config2;
+  if (!accessToken) return [];
+  var decodedToken = JSON.parse(atob(accessToken.split('.')[1]));
+  // The exact key to use may depend from keycloak client & Cosmo Tech API configuration (c.f. the value of
+  // csm.platform.authorization.roles-jwt-claim in your k8s tenant secrets)
+  var rolesTokenAttribute = (_config2 = config) === null || _config2 === void 0 ? void 0 : _config2.rolesJwtClaim;
+  if (rolesTokenAttribute) {
+    if (decodedToken !== null && decodedToken !== void 0 && decodedToken[rolesTokenAttribute]) return decodedToken === null || decodedToken === void 0 ? void 0 : decodedToken[rolesTokenAttribute];
+    console.warn("Authentication provider configuration defined rolesJwtClaim=\"".concat(rolesTokenAttribute, "\" ") + 'but this key was not found in the access token. Please check your webapp and API configuration.');
+  }
+  if (decodedToken !== null && decodedToken !== void 0 && decodedToken.roles) return decodedToken.roles; // Legacy default key in token
+
+  if (decodedToken !== null && decodedToken !== void 0 && decodedToken.userRoles) {
+    console.warn("DEPRECATED: the token claim for API roles was automatically found in 'userRoles', but the lookup " + 'for this specific key will be removed in a future version. Please update your webapp configuration to ' + "explicitly set AUTH_KEYCLOAK_ROLES_JWT_CLAIM to 'userRoles'.");
+    return decodedToken.userRoles;
+  }
+  console.warn("Couldn't extract roles from access token. Please check your webapp and API configuration.");
+  return [];
 };
 var isUserSignedIn = /*#__PURE__*/function () {
   var _ref4 = _asyncToGenerator(function* () {
-    if (authData.authenticated) return true;
     if (readFromStorage('authAuthenticated') === 'true') {
-      authData.authenticated = true;
+      // Restore roles from access token if necessary (roles in auhtData may be lost after login redirection)
+      if (authData.roles.length === 0) {
+        var accessToken = readFromStorage('authAccessToken');
+        if (accessToken) authData.roles = _extractRolesFromAccessToken(accessToken);
+      }
       return true;
     }
     try {
@@ -57443,12 +57455,12 @@ var isUserSignedIn = /*#__PURE__*/function () {
         clearFromStorage('authInteractionInProgress');
         var locationHashParameters = new URLSearchParams(window.location.hash.substring(1));
         if (locationHashParameters.has('state')) {
-          var _config2;
-          if (locationHashParameters.has('iss', (_config2 = config) === null || _config2 === void 0 || (_config2 = _config2.msalConfig) === null || _config2 === void 0 || (_config2 = _config2.auth) === null || _config2 === void 0 || (_config2 = _config2.authorityMetadata) === null || _config2 === void 0 ? void 0 : _config2.issuer)) {
+          var _config3;
+          if (locationHashParameters.has('iss', (_config3 = config) === null || _config3 === void 0 || (_config3 = _config3.msalConfig) === null || _config3 === void 0 || (_config3 = _config3.auth) === null || _config3 === void 0 || (_config3 = _config3.authorityMetadata) === null || _config3 === void 0 ? void 0 : _config3.issuer)) {
             msalApp.handleRedirectPromise().then(handleResponse); // Resume redirect workflow process
           } else if (locationHashParameters.has('iss')) {
-            var _config3;
-            var configIssuer = (_config3 = config) === null || _config3 === void 0 || (_config3 = _config3.msalConfig) === null || _config3 === void 0 || (_config3 = _config3.auth) === null || _config3 === void 0 || (_config3 = _config3.authorityMetadata) === null || _config3 === void 0 ? void 0 : _config3.issuer;
+            var _config4;
+            var configIssuer = (_config4 = config) === null || _config4 === void 0 || (_config4 = _config4.msalConfig) === null || _config4 === void 0 || (_config4 = _config4.auth) === null || _config4 === void 0 || (_config4 = _config4.authorityMetadata) === null || _config4 === void 0 ? void 0 : _config4.issuer;
             var urlIssuer = locationHashParameters.get('iss');
             console.warn("Issuer found in url \"".concat(urlIssuer, "\" does not match keycloak configuration: \"").concat(configIssuer, "\""));
           }
@@ -57458,10 +57470,7 @@ var isUserSignedIn = /*#__PURE__*/function () {
       // Otherwise, try to acquire a token silently to implement SSO
       var tokens = yield acquireTokens();
       _updateTokensInStorage(tokens);
-      if ((tokens === null || tokens === void 0 ? void 0 : tokens.accessToken) !== undefined) {
-        authData.roles = _extractRolesFromAccessToken(tokens.accessToken);
-        return true;
-      }
+      if ((tokens === null || tokens === void 0 ? void 0 : tokens.accessToken) !== undefined) return true;
     } catch (e) {
       console.error(e);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmotech/core",
-  "version": "1.18.1",
+  "version": "1.19.0",
   "description": "",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",