@gridsuite/commons-ui 0.61.1 → 0.62.0

package/README.md

@@ -33,13 +33,12 @@ you need to follow the steps below:
 -   Update to the new version in [package.json](https://github.com/gridsuite/commons-ui/blob/main/package.json) (example `0.6.0`)
 -   Build it: `npm install`
 -   Commit the package.json and package-lock.json files, push to a branch, make a PR, have it reviewed and merged to main.
--   Pull and checkout main on your last commit.
--   [Tag your last commit](https://semver.org/) : `git tag <tag>` (example: `v0.6.0`)
--   Push tag : `git push origin <tag>`
--   Checkout the tag in a fresh repo copy : `cd $(mktemp -d) && git clone https://github.com/gridsuite/commons-ui.git` then `cd commons-ui && git checkout <tag>`
--   [Test your package](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages#testing-your-package): `npm install`
--   [Login on the command line to the npm registry](https://docs.npmjs.com/logging-in-to-an-npm-enterprise-registry-from-the-command-line): `npm login`
--   [Publish the package](https://docs.npmjs.com/creating-and-publishing-scoped-public-packages#publishing-scoped-public-packages): `npm publish`
+-   [Make a release](https://github.com/gridsuite/commons-ui/releases/new) on GitHub by creating a new tag on the last commit. On the release creation page:
+    - In "Choose a tag": type the tag you want to create (ex.: v0.6.0) and select "create new tag"
+    - In "Target": click on "recent commit" tab and select your release commit
+    - Click on "Generate release note"
+    - Click on "Publish release"
+-   It will trigger a job that will publish the release on NPM
 
 #### License Headers and dependencies checking
 

package/dist/components/TopBar/AboutDialog.js

@@ -1,5 +1,5 @@
 import { jsxs, jsx, Fragment } from "react/jsx-runtime";
-import { useState, useEffect, useMemo, useCallback } from "react";
+import { useState, useEffect, useCallback } from "react";
 import { useTheme, Dialog, useMediaQuery, DialogTitle, Collapse, Alert, Box, Fade, CircularProgress, Typography, DialogContent, Accordion, AccordionSummary, AccordionDetails, Grid, DialogActions, Button, Tooltip, Zoom, Stack, tooltipClasses } from "@mui/material";
 import { LoadingButton } from "@mui/lab";
 import { Refresh, ExpandMore, Gavel, Apps, WidgetsOutlined, DnsOutlined, QuestionMark } from "@mui/icons-material";
@@ -115,18 +115,15 @@ const AboutDialog = ({
   }, [open, globalVersionPromise]);
   const [loadingAdditionalModules, setLoadingAdditionalModules] = useState(false);
   const [modules, setModules] = useState(null);
-  const currentApp = useMemo(
-    () => ({
-      name: !!logo && appName || `Grid${appName}`,
-      type: "app",
-      version: appVersion,
-      gitTag: appGitTag,
-      license: appLicense
-    }),
-    [logo, appName, appVersion, appGitTag, appLicense]
-  );
   useEffect(() => {
     if (open) {
+      const currentApp = {
+        name: `Grid${appName}`,
+        type: "app",
+        version: appVersion,
+        gitTag: appGitTag,
+        license: appLicense
+      };
       (additionalModulesPromise ? Promise.resolve(setLoadingAdditionalModules(true)).then(
         () => additionalModulesPromise()
       ) : Promise.reject(new Error("no getter"))).then(
@@ -136,7 +133,14 @@ const AboutDialog = ({
         setModules([currentApp, ...values]);
       }).finally(() => setLoadingAdditionalModules(false));
     }
-  }, [open, additionalModulesPromise, currentApp]);
+  }, [
+    open,
+    additionalModulesPromise,
+    appName,
+    appVersion,
+    appGitTag,
+    appLicense
+  ]);
   const handleClose = useCallback(() => {
     if (onClose) {
       onClose();

package/dist/index.d.ts

@@ -35,6 +35,7 @@ export { ElementType } from './utils/ElementType';
 export type { ElementAttributes, Option, Equipment } from './utils/types';
 export { EQUIPMENT_TYPE, EquipmentType, getEquipmentsInfosForSearchBar, equipmentStyles, } from './utils/EquipmentType';
 export { initializeAuthenticationDev, initializeAuthenticationProd, logout, dispatchUser, getPreLoginPath, } from './utils/AuthService';
+export type * from './utils/AuthService';
 export { getFileIcon } from './utils/ElementIcon';
 export { DEFAULT_CELL_PADDING, DEFAULT_HEADER_HEIGHT, DEFAULT_ROW_HEIGHT, } from './components/MuiVirtualizedTable/MuiVirtualizedTable';
 export { DARK_THEME, LIGHT_THEME, LANG_SYSTEM, LANG_ENGLISH, LANG_FRENCH, } from './components/TopBar/TopBar';

package/dist/utils/AuthService.d.ts

@@ -3,18 +3,27 @@ import { Dispatch } from 'react';
 import { User, UserManager } from 'oidc-client';
 
 type UserValidationFunc = (user: User) => Promise<boolean>;
+type IdpSettingsGetter = () => Promise<IdpSettings>;
+export type IdpSettings = {
+    authority: string;
+    client_id: string;
+    redirect_uri: string;
+    post_logout_redirect_uri: string;
+    silent_redirect_uri: string;
+    scope: string;
+    maxExpiresIn?: number;
+};
 type CustomUserManager = UserManager & {
-    authorizationCodeFlowEnabled?: boolean;
     idpSettings?: {
         maxExpiresIn?: number;
     };
 };
-declare function initializeAuthenticationDev(dispatch: Dispatch<unknown>, isSilentRenew: boolean, validateUser: UserValidationFunc, isSigninCallback: boolean): Promise<UserManager>;
-declare function initializeAuthenticationProd(dispatch: Dispatch<unknown>, isSilentRenew: boolean, idpSettings: Promise<Response>, validateUser: UserValidationFunc, authorizationCodeFlowEnabled: boolean, isSigninCallback: boolean): Promise<CustomUserManager>;
-declare function login(location: Location, userManagerInstance: UserManager): Promise<void>;
-declare function logout(dispatch: Dispatch<unknown>, userManagerInstance: UserManager): Promise<void | undefined>;
-declare function dispatchUser(dispatch: Dispatch<unknown>, userManagerInstance: CustomUserManager, validateUser: UserValidationFunc): Promise<void | undefined>;
-declare function getPreLoginPath(): string | null;
-declare function handleSigninCallback(dispatch: Dispatch<unknown>, navigate: NavigateFunction, userManagerInstance: UserManager): void;
-declare function handleSilentRenewCallback(userManagerInstance: UserManager): void;
-export { initializeAuthenticationDev, initializeAuthenticationProd, handleSilentRenewCallback, login, logout, dispatchUser, handleSigninCallback, getPreLoginPath, };
+export declare function initializeAuthenticationDev(dispatch: Dispatch<unknown>, isSilentRenew: boolean, validateUser: UserValidationFunc, isSigninCallback: boolean): Promise<UserManager>;
+export declare function initializeAuthenticationProd(dispatch: Dispatch<unknown>, isSilentRenew: boolean, idpSettingsGetter: IdpSettingsGetter, validateUser: UserValidationFunc, isSigninCallback: boolean): Promise<CustomUserManager>;
+export declare function login(location: Location, userManagerInstance: UserManager): Promise<void>;
+export declare function logout(dispatch: Dispatch<unknown>, userManagerInstance: UserManager): Promise<void | undefined>;
+export declare function dispatchUser(dispatch: Dispatch<unknown>, userManagerInstance: CustomUserManager, validateUser: UserValidationFunc): Promise<void | undefined>;
+export declare function getPreLoginPath(): string | null;
+export declare function handleSigninCallback(dispatch: Dispatch<unknown>, navigate: NavigateFunction, userManagerInstance: UserManager): void;
+export declare function handleSilentRenewCallback(userManagerInstance: UserManager): void;
+export {};

package/dist/utils/AuthService.js

@@ -6,7 +6,7 @@ window.OIDCLog = Log;
 const hackAuthorityKey = "oidc.hack.authority";
 const oidcHackReloadedKey = "gridsuite-oidc-hack-reloaded";
 const pathKey = "powsybl-gridsuite-current-path";
-function isIssuerErrorForCodeFlow(error) {
+function isIssuerError(error) {
   return error.message.includes("Invalid issuer in token");
 }
 function extractIssuerToSessionStorage(error) {
@@ -33,19 +33,15 @@ function handleSigninSilent(dispatch, userManager) {
     if (user == null || getIdTokenExpiresIn(user) < 0) {
       return userManager.signinSilent().catch((error) => {
         dispatch(setShowAuthenticationRouterLogin(true));
-        const errorIssuerCodeFlow = isIssuerErrorForCodeFlow(error);
-        const errorIssuerImplicitFlow = error.message === "authority mismatch on settings vs. signin state";
-        if (errorIssuerCodeFlow) {
+        if (isIssuerError(error)) {
           extractIssuerToSessionStorage(error);
-        }
-        if (errorIssuerCodeFlow || errorIssuerImplicitFlow) {
           reload();
         }
       });
     }
   });
 }
-function initializeAuthenticationDev(dispatch, isSilentRenew, validateUser, isSigninCallback) {
+async function initializeAuthenticationDev(dispatch, isSilentRenew, validateUser, isSigninCallback) {
   let userManager = new UserManagerMock(
     {}
   );
@@ -55,76 +51,25 @@ function initializeAuthenticationDev(dispatch, isSilentRenew, validateUser, isSi
       handleSigninSilent(dispatch, userManager);
     }
   }
-  return Promise.resolve(userManager);
+  return userManager;
 }
 const accessTokenExpiringNotificationTime = 60;
-function initializeAuthenticationProd(dispatch, isSilentRenew, idpSettings, validateUser, authorizationCodeFlowEnabled, isSigninCallback) {
-  return idpSettings.then((r) => r.json()).then((idpSettings2) => {
-    const regextoken = /id_token=[^&]*/;
-    const regexstate = /state=[^&]*/;
-    const regexexpires = /expires_in=[^&]*/;
-    let authority;
-    if (window.location.hash) {
-      const matched_id_token = window.location.hash.match(regextoken);
-      const matched_state = window.location.hash.match(regexstate);
-      if (matched_id_token != null && matched_state != null) {
-        const id_token = matched_id_token[0].split("=")[1];
-        const state = matched_state[0].split("=")[1];
-        const strState = localStorage.getItem("oidc." + state);
-        if (strState != null) {
-          const decoded = jwtDecode(id_token);
-          authority = decoded.iss;
-          const storedState = JSON.parse(strState);
-          console.debug(
-            "Replacing authority in storedState. Before: ",
-            storedState.authority,
-            "after: ",
-            authority
-          );
-          storedState.authority = authority;
-          localStorage.setItem(
-            "oidc." + state,
-            JSON.stringify(storedState)
-          );
-          if (authority !== void 0) {
-            sessionStorage.setItem(hackAuthorityKey, authority);
-          }
-          const matched_expires = window.location.hash.match(regexexpires);
-          if (matched_expires != null) {
-            const expires_in = parseInt(
-              matched_expires[0].split("=")[1]
-            );
-            window.location.hash = window.location.hash.replace(
-              matched_expires[0],
-              "expires_in=" + computeMinExpiresIn(
-                expires_in,
-                id_token,
-                idpSettings2.maxExpiresIn
-              )
-            );
-          }
-        }
-      }
-    }
-    authority = authority || sessionStorage.getItem(hackAuthorityKey) || idpSettings2.authority;
-    const responseSettings = authorizationCodeFlowEnabled ? { response_type: "code" } : {
-      response_type: "id_token token",
-      response_mode: "fragment"
-    };
+async function initializeAuthenticationProd(dispatch, isSilentRenew, idpSettingsGetter, validateUser, isSigninCallback) {
+  const idpSettings = await idpSettingsGetter();
+  try {
     const settings = {
-      authority,
-      client_id: idpSettings2.client_id,
-      redirect_uri: idpSettings2.redirect_uri,
-      post_logout_redirect_uri: idpSettings2.post_logout_redirect_uri,
-      silent_redirect_uri: idpSettings2.silent_redirect_uri,
-      scope: idpSettings2.scope,
+      authority: sessionStorage.getItem(hackAuthorityKey) || idpSettings.authority,
+      client_id: idpSettings.client_id,
+      redirect_uri: idpSettings.redirect_uri,
+      post_logout_redirect_uri: idpSettings.post_logout_redirect_uri,
+      silent_redirect_uri: idpSettings.silent_redirect_uri,
+      scope: idpSettings.scope,
       automaticSilentRenew: !isSilentRenew,
       accessTokenExpiringNotificationTime,
-      ...responseSettings
+      response_type: "code"
     };
     let userManager = new UserManager(settings);
-    userManager.idpSettings = idpSettings2;
-    userManager.authorizationCodeFlowEnabled = authorizationCodeFlowEnabled;
+    userManager.idpSettings = idpSettings;
     if (!isSilentRenew) {
       handleUser(dispatch, userManager, validateUser);
       if (!isSigninCallback) {
@@ -132,11 +77,11 @@ function initializeAuthenticationProd(dispatch, isSilentRenew, idpSettings, vali
       }
     }
     return userManager;
-  }).catch((error) => {
+  } catch (error) {
     console.debug("error when importing the idp settings", error);
     dispatch(setShowAuthenticationRouterLogin(true));
     throw error;
-  });
+  }
 }
 function computeMinExpiresIn(expiresIn, idToken, maxExpiresIn) {
   const now = Date.now() / 1e3;
@@ -171,6 +116,7 @@ function login(location, userManagerInstance) {
 }
 function logout(dispatch, userManagerInstance) {
   sessionStorage.removeItem(hackAuthorityKey);
+  sessionStorage.removeItem(oidcHackReloadedKey);
   return userManagerInstance.getUser().then((user) => {
     if (user) {
       return userManagerInstance.signoutRedirect({
@@ -221,17 +167,15 @@ function dispatchUser(dispatch, userManagerInstance, validateUser) {
         console.debug(
           "User has been successfully loaded from store."
         );
-        if (userManagerInstance.authorizationCodeFlowEnabled) {
-          reloadTimerOnExpiresIn(
-            user,
-            userManagerInstance,
-            computeMinExpiresIn(
-              user.expires_in,
-              user.id_token,
-              (_b = userManagerInstance.idpSettings) == null ? void 0 : _b.maxExpiresIn
-            )
-          );
-        }
+        reloadTimerOnExpiresIn(
+          user,
+          userManagerInstance,
+          computeMinExpiresIn(
+            user.expires_in,
+            user.id_token,
+            (_b = userManagerInstance.idpSettings) == null ? void 0 : _b.maxExpiresIn
+          )
+        );
         return dispatch(setLoggedUser(user));
       }).catch((e) => {
         var _a;
@@ -259,7 +203,7 @@ function navigateToPreLoginPath(navigate) {
 function handleSigninCallback(dispatch, navigate, userManagerInstance) {
   let reloadAfterNavigate = false;
   userManagerInstance.signinRedirectCallback().catch(function(e) {
-    if (isIssuerErrorForCodeFlow(e)) {
+    if (isIssuerError(e)) {
       extractIssuerToSessionStorage(e);
       reloadAfterNavigate = true;
     } else {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gridsuite/commons-ui",
-    "version": "0.61.1",
+    "version": "0.62.0",
     "description": "common react components for gridsuite applications",
     "engines": {
         "npm": ">=9",