@gridsuite/commons-ui 0.61.1 → 0.61.4

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/AuthenticationRouter/AuthenticationRouter.d.ts

@@ -1,28 +1,29 @@
+import { AuthenticationActions } from '../../redux/authActions';
 import { UserManager } from 'oidc-client';
+import { Location, NavigateFunction } from 'react-router-dom';
 import { Dispatch } from 'react';
 
-export interface AuthenticationRouterProps {
-    userManager: {
-        instance: UserManager;
-        error: string;
-    };
-    signInCallbackError: {
-        message: string;
+export type AuthenticationRouterErrorState = {
+    userName?: string;
+    userValidationError?: {
+        error: Error;
     };
-    authenticationRouterError: {
-        userName: string;
-        userValidationError?: {
-            error: Error;
-        };
-        logoutError?: {
-            error: Error;
-        };
-        unauthorizedUserInfo?: string;
-        error: string;
+    logoutError?: {
+        error: Error;
     };
+    unauthorizedUserInfo?: string;
+};
+export type UserManagerState = {
+    instance: UserManager | null;
+    error: string | null;
+};
+export interface AuthenticationRouterProps {
+    userManager: UserManagerState;
+    signInCallbackError: Error | null;
+    authenticationRouterError: AuthenticationRouterErrorState | null;
     showAuthenticationRouterLogin: boolean;
-    dispatch: Dispatch<unknown>;
-    navigate: () => void;
+    dispatch: Dispatch<AuthenticationActions>;
+    navigate: NavigateFunction;
     location: Location;
 }
 declare const AuthenticationRouter: ({ userManager, signInCallbackError, authenticationRouterError, showAuthenticationRouterLogin, dispatch, navigate, location, }: AuthenticationRouterProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/AuthenticationRouter/AuthenticationRouter.js

@@ -17,14 +17,16 @@ const AuthenticationRouter = ({
   navigate,
   location
 }) => {
-  const handleSigninCallbackClosure = useCallback(
-    () => handleSigninCallback(dispatch, navigate, userManager.instance),
-    [dispatch, navigate, userManager.instance]
-  );
-  const handleSilentRenewCallbackClosure = useCallback(
-    () => handleSilentRenewCallback(userManager.instance),
-    [userManager.instance]
-  );
+  const handleSigninCallbackClosure = useCallback(() => {
+    if (userManager.instance != null) {
+      handleSigninCallback(dispatch, navigate, userManager.instance);
+    }
+  }, [dispatch, navigate, userManager.instance]);
+  const handleSilentRenewCallbackClosure = useCallback(() => {
+    if (userManager.instance != null) {
+      handleSilentRenewCallback(userManager.instance);
+    }
+  }, [userManager.instance]);
   return /* @__PURE__ */ jsxs(
     Grid,
     {

package/dist/components/AuthenticationRouter/index.d.ts

@@ -5,3 +5,4 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 export { default } from './AuthenticationRouter';
+export type { AuthenticationRouterErrorState, AuthenticationRouterProps, UserManagerState, } from './AuthenticationRouter';

package/dist/components/SignInCallbackHandler/SignInCallbackHandler.d.ts

@@ -1,7 +1,7 @@
 import { UserManager } from 'oidc-client';
 
 export interface SignInCallbackHandlerProps {
-    userManager: UserManager;
+    userManager: UserManager | null;
     handleSignInCallback: () => void;
 }
 declare const SignInCallbackHandler: ({ userManager, handleSignInCallback, }: SignInCallbackHandlerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/SilentRenewCallbackHandler/SilentRenewCallbackHandler.d.ts

@@ -1,7 +1,7 @@
 import { UserManager } from 'oidc-client';
 
 export interface SilentRenewCallbackHandlerProps {
-    userManager: UserManager;
+    userManager: UserManager | null;
     handleSilentRenewCallback: () => void;
 }
 declare const SilentRenewCallbackHandler: ({ userManager, handleSilentRenewCallback, }: SilentRenewCallbackHandlerProps) => import("react/jsx-runtime").JSX.Element;

package/dist/components/TopBar/AboutDialog.d.ts

@@ -6,7 +6,7 @@ declare const moduleTypeSort: {
     other: number;
 };
 type ModuleType = keyof typeof moduleTypeSort;
-type GridSuiteModule = {
+export type GridSuiteModule = {
     name: string;
     type: ModuleType;
     version?: string;

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/components/TopBar/TopBar.d.ts

@@ -11,12 +11,13 @@ export declare const LIGHT_THEME = "Light";
 export declare const LANG_SYSTEM = "sys";
 export declare const LANG_ENGLISH = "en";
 export declare const LANG_FRENCH = "fr";
-export type GsLang = typeof LANG_ENGLISH | typeof LANG_FRENCH | typeof LANG_SYSTEM;
+export type GsLangUser = typeof LANG_ENGLISH | typeof LANG_FRENCH;
+export type GsLang = GsLangUser | typeof LANG_SYSTEM;
 export type GsTheme = typeof LIGHT_THEME | typeof DARK_THEME;
 export type TopBarProps = Omit<GridLogoProps, 'onClick'> & Omit<LogoutProps, 'disabled'> & Omit<AboutDialogProps, 'open' | 'onClose'> & {
     onParametersClick?: () => void;
     onLogoClick: GridLogoProps['onClick'];
-    user: User;
+    user?: User;
     onAboutClick?: () => void;
     logoAboutDialog?: ReactNode;
     appsAndUrls: CommonMetadata[];

package/dist/index.d.ts

@@ -7,8 +7,10 @@
 export { default as TreeViewFinder } from './components/TreeViewFinder';
 export { default as TopBar } from './components/TopBar';
 export { default as AboutDialog } from './components/TopBar/AboutDialog';
+export type { GridSuiteModule } from './components/TopBar/AboutDialog';
 export { default as SnackbarProvider } from './components/SnackbarProvider';
 export { default as AuthenticationRouter } from './components/AuthenticationRouter';
+export type { AuthenticationRouterErrorState, AuthenticationRouterProps, UserManagerState, } from './components/AuthenticationRouter';
 export { default as MuiVirtualizedTable } from './components/MuiVirtualizedTable';
 export { KeyedColumnsRowIndexer, CHANGE_WAYS, } from './components/MuiVirtualizedTable';
 export { default as ReportViewer } from './components/ReportViewer';
@@ -38,7 +40,9 @@ export { initializeAuthenticationDev, initializeAuthenticationProd, logout, disp
 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';
-export { USER, setLoggedUser, SIGNIN_CALLBACK_ERROR, setSignInCallbackError, UNAUTHORIZED_USER_INFO, LOGOUT_ERROR, USER_VALIDATION_ERROR, RESET_AUTHENTICATION_ROUTER_ERROR, SHOW_AUTH_INFO_LOGIN, } from './redux/actions';
+export type { GsLang, GsLangUser, GsTheme } from './components/TopBar/TopBar';
+export { USER, setLoggedUser, SIGNIN_CALLBACK_ERROR, setSignInCallbackError, UNAUTHORIZED_USER_INFO, LOGOUT_ERROR, USER_VALIDATION_ERROR, RESET_AUTHENTICATION_ROUTER_ERROR, SHOW_AUTH_INFO_LOGIN, } from './redux/authActions';
+export type { AuthenticationActions, AuthenticationRouterErrorBase, AuthenticationRouterErrorAction, LogoutErrorAction, ShowAuthenticationRouterLoginAction, SignInCallbackErrorAction, UnauthorizedUserAction, UserAction, UserValidationErrorAction, } from './redux/authActions';
 export { default as report_viewer_en } from './components/translations/report-viewer-en';
 export { default as report_viewer_fr } from './components/translations/report-viewer-fr';
 export { default as login_en } from './components/translations/login-en';
@@ -119,6 +123,7 @@ export type { FormEquipment } from './components/filter/utils/filter-form-utils'
 export { getCriteriaBasedFormData, getCriteriaBasedSchema, } from './components/filter/criteria-based/criteria-based-filter-utils';
 export { mergeSx } from './utils/styles';
 export { setCommonStore } from './redux/commonStore';
+export type { CommonStoreState } from './redux/commonStore';
 export type { EquipmentInfos } from './utils/EquipmentType';
 export * from './services';
 export type * from './services';

package/dist/index.js

@@ -32,7 +32,7 @@ import { ElementType } from "./utils/ElementType.js";
 import { EQUIPMENT_TYPE, EquipmentType, equipmentStyles, getEquipmentsInfosForSearchBar } from "./utils/EquipmentType.js";
 import { dispatchUser, getPreLoginPath, initializeAuthenticationDev, initializeAuthenticationProd, logout } from "./utils/AuthService.js";
 import { getFileIcon } from "./utils/ElementIcon.js";
-import { LOGOUT_ERROR, RESET_AUTHENTICATION_ROUTER_ERROR, SHOW_AUTH_INFO_LOGIN, SIGNIN_CALLBACK_ERROR, UNAUTHORIZED_USER_INFO, USER, USER_VALIDATION_ERROR, setLoggedUser, setSignInCallbackError } from "./redux/actions.js";
+import { LOGOUT_ERROR, RESET_AUTHENTICATION_ROUTER_ERROR, SHOW_AUTH_INFO_LOGIN, SIGNIN_CALLBACK_ERROR, UNAUTHORIZED_USER_INFO, USER, USER_VALIDATION_ERROR, setLoggedUser, setSignInCallbackError } from "./redux/authActions.js";
 import { default as default17 } from "./components/translations/report-viewer-en.js";
 import { default as default18 } from "./components/translations/report-viewer-fr.js";
 import { default as default19 } from "./components/translations/login-en.js";

package/dist/redux/authActions.d.ts

@@ -0,0 +1,56 @@
+import { User } from 'oidc-client';
+
+export interface Action<T> {
+    type: T;
+}
+type ReadonlyAction<T> = Readonly<Action<T>>;
+export declare const USER = "USER";
+export type UserAction = ReadonlyAction<typeof USER> & {
+    user: User | null;
+};
+export declare function setLoggedUser(user: User | null): UserAction;
+export declare const SIGNIN_CALLBACK_ERROR = "SIGNIN_CALLBACK_ERROR";
+export type SignInCallbackErrorAction = ReadonlyAction<typeof SIGNIN_CALLBACK_ERROR> & {
+    signInCallbackError: Error | null;
+};
+export declare function setSignInCallbackError(signInCallbackError: Error | null): SignInCallbackErrorAction;
+export type AuthenticationRouterErrorBase<T> = {
+    authenticationRouterError: {
+        userName?: string;
+    } & T;
+};
+export declare const UNAUTHORIZED_USER_INFO = "UNAUTHORIZED_USER_INFO";
+export type UnauthorizedUserAction = ReadonlyAction<typeof UNAUTHORIZED_USER_INFO> & AuthenticationRouterErrorBase<{
+    unauthorizedUserInfo: string;
+}>;
+export declare function setUnauthorizedUserInfo(userName: string | undefined, unauthorizedUserInfo: string): UnauthorizedUserAction;
+export declare const LOGOUT_ERROR = "LOGOUT_ERROR";
+export type LogoutErrorAction = ReadonlyAction<typeof LOGOUT_ERROR> & AuthenticationRouterErrorBase<{
+    logoutError: {
+        error: Error;
+    };
+}>;
+export declare function setLogoutError(userName: string | undefined, logoutError: {
+    error: Error;
+}): LogoutErrorAction;
+export declare const USER_VALIDATION_ERROR = "USER_VALIDATION_ERROR";
+export type UserValidationErrorAction = ReadonlyAction<typeof USER_VALIDATION_ERROR> & AuthenticationRouterErrorBase<{
+    userValidationError: {
+        error: Error;
+    };
+}>;
+export declare function setUserValidationError(userName: string | undefined, userValidationError: {
+    error: Error;
+}): UserValidationErrorAction;
+export declare const RESET_AUTHENTICATION_ROUTER_ERROR = "RESET_AUTHENTICATION_ROUTER_ERROR";
+export type AuthenticationRouterErrorAction = ReadonlyAction<typeof RESET_AUTHENTICATION_ROUTER_ERROR> & {
+    authenticationRouterError: null;
+};
+export declare function resetAuthenticationRouterError(): AuthenticationRouterErrorAction;
+export declare const SHOW_AUTH_INFO_LOGIN = "SHOW_AUTH_INFO_LOGIN";
+export type ShowAuthenticationRouterLoginAction = ReadonlyAction<typeof SHOW_AUTH_INFO_LOGIN> & {
+    showAuthenticationRouterLogin: boolean;
+};
+export declare function setShowAuthenticationRouterLogin(showAuthenticationRouterLogin: boolean): ShowAuthenticationRouterLoginAction;
+export type AuthenticationActions = UserAction | SignInCallbackErrorAction | UnauthorizedUserAction | LogoutErrorAction | UserValidationErrorAction | AuthenticationRouterErrorAction | ShowAuthenticationRouterLoginAction;
+export {};

package/dist/redux/commonStore.d.ts

@@ -1,9 +1,10 @@
 import { User } from 'oidc-client';
 
+export type CommonStoreState = {
+    user: User | null;
+};
 interface CommonStore {
-    getState: () => {
-        user: User;
-    };
+    getState: () => CommonStoreState;
 }
 /**
  * Set a copy of the reference to the store to be able to access it from this library.

package/dist/redux/commonStore.js

@@ -3,7 +3,8 @@ function setCommonStore(store) {
   commonStore = store;
 }
 function getUserToken() {
-  return commonStore == null ? void 0 : commonStore.getState().user.id_token;
+  var _a;
+  return (_a = commonStore == null ? void 0 : commonStore.getState().user) == null ? void 0 : _a.id_token;
 }
 export {
   getUserToken,

package/dist/utils/AuthService.d.ts

@@ -1,5 +1,6 @@
-import { NavigateFunction } from 'react-router-dom';
+import { Location, NavigateFunction } from 'react-router-dom';
 import { Dispatch } from 'react';
+import { AuthenticationActions } from '../redux/authActions';
 import { User, UserManager } from 'oidc-client';
 
 type UserValidationFunc = (user: User) => Promise<boolean>;
@@ -9,12 +10,12 @@ type CustomUserManager = UserManager & {
         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 initializeAuthenticationDev(dispatch: Dispatch<AuthenticationActions>, isSilentRenew: boolean, validateUser: UserValidationFunc, isSigninCallback: boolean): Promise<UserManager>;
+declare function initializeAuthenticationProd(dispatch: Dispatch<AuthenticationActions>, isSilentRenew: boolean, idpSettings: Promise<Response>, validateUser: UserValidationFunc, authorizationCodeFlowEnabled: boolean, isSigninCallback: boolean): Promise<CustomUserManager>;
+declare function login(location: Location, userManagerInstance: UserManager | null): Promise<void> | undefined;
+declare function logout(dispatch: Dispatch<AuthenticationActions>, userManagerInstance: UserManager | null): Promise<void | undefined> | undefined;
+declare function dispatchUser(dispatch: Dispatch<AuthenticationActions>, 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 handleSigninCallback(dispatch: Dispatch<AuthenticationActions>, navigate: NavigateFunction, userManagerInstance: UserManager): void;
 declare function handleSilentRenewCallback(userManagerInstance: UserManager): void;
 export { initializeAuthenticationDev, initializeAuthenticationProd, handleSilentRenewCallback, login, logout, dispatchUser, handleSigninCallback, getPreLoginPath, };

package/dist/utils/AuthService.js

@@ -1,6 +1,6 @@
 import { Log, UserManager } from "oidc-client";
 import { UserManagerMock } from "./UserManagerMock.js";
-import { setShowAuthenticationRouterLogin, setLoggedUser, setLogoutError, setUnauthorizedUserInfo, setUserValidationError, setSignInCallbackError, resetAuthenticationRouterError } from "../redux/actions.js";
+import { setShowAuthenticationRouterLogin, setLoggedUser, setLogoutError, setUnauthorizedUserInfo, setUserValidationError, setSignInCallbackError, resetAuthenticationRouterError } from "../redux/authActions.js";
 import { jwtDecode } from "jwt-decode";
 window.OIDCLog = Log;
 const hackAuthorityKey = "oidc.hack.authority";
@@ -167,11 +167,11 @@ function computeMinExpiresIn(expiresIn, idToken, maxExpiresIn) {
 }
 function login(location, userManagerInstance) {
   sessionStorage.setItem(pathKey, location.pathname + location.search);
-  return userManagerInstance.signinRedirect().then(() => console.debug("login"));
+  return userManagerInstance == null ? void 0 : userManagerInstance.signinRedirect().then(() => console.debug("login"));
 }
 function logout(dispatch, userManagerInstance) {
   sessionStorage.removeItem(hackAuthorityKey);
-  return userManagerInstance.getUser().then((user) => {
+  return userManagerInstance == null ? void 0 : userManagerInstance.getUser().then((user) => {
     if (user) {
       return userManagerInstance.signoutRedirect({
         extraQueryParams: {

package/package.json

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

package/dist/redux/actions.d.ts

@@ -1,54 +0,0 @@
-import { User } from 'oidc-client';
-
-export declare const USER = "USER";
-export declare function setLoggedUser(user: User | null): {
-    type: string;
-    user: User | null;
-};
-export declare const SIGNIN_CALLBACK_ERROR = "SIGNIN_CALLBACK_ERROR";
-export declare function setSignInCallbackError(signInCallbackError: string | null): {
-    type: string;
-    signInCallbackError: string | null;
-};
-export declare const UNAUTHORIZED_USER_INFO = "UNAUTHORIZED_USER_INFO";
-export declare function setUnauthorizedUserInfo(userName: string | undefined, unauthorizedUserInfo: string): {
-    type: string;
-    authenticationRouterError: {
-        userName: string | undefined;
-        unauthorizedUserInfo: string;
-    };
-};
-export declare const LOGOUT_ERROR = "LOGOUT_ERROR";
-export declare function setLogoutError(userName: string | undefined, logoutError: {
-    error: Error;
-}): {
-    type: string;
-    authenticationRouterError: {
-        userName: string | undefined;
-        logoutError: {
-            error: Error;
-        };
-    };
-};
-export declare const USER_VALIDATION_ERROR = "USER_VALIDATION_ERROR";
-export declare function setUserValidationError(userName: string | undefined, userValidationError: {
-    error: Error;
-}): {
-    type: string;
-    authenticationRouterError: {
-        userName: string | undefined;
-        userValidationError: {
-            error: Error;
-        };
-    };
-};
-export declare const RESET_AUTHENTICATION_ROUTER_ERROR = "RESET_AUTHENTICATION_ROUTER_ERROR";
-export declare function resetAuthenticationRouterError(): {
-    type: string;
-    authenticationRouterError: null;
-};
-export declare const SHOW_AUTH_INFO_LOGIN = "SHOW_AUTH_INFO_LOGIN";
-export declare function setShowAuthenticationRouterLogin(showAuthenticationRouterLogin: boolean): {
-    type: string;
-    showAuthenticationRouterLogin: boolean;
-};