Fix/clear on close type (#540)

capyq · web-flow · commit d8b1c91de401 · 2024-11-21T16:51:18.000+01:00
Signed-off-by: capyq &lt;quentin.capy@rte-france.com&gt;
Signed-off-by: Thang PHAM &lt;phamthang37@gmail.com&gt;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
     "dependencies": {
         "@emotion/react": "^11.11.4",
         "@emotion/styled": "^11.11.5",
-        "@gridsuite/commons-ui": "0.71.1",
+        "@gridsuite/commons-ui": "0.72.0",
         "@hookform/resolvers": "^3.3.4",
         "@mui/icons-material": "^5.15.14",
         "@mui/lab": "5.0.0-alpha.169",
diff --git a/src/components/dialogs/contingency-list/creation/contingency-list-creation-dialog.tsx b/src/components/dialogs/contingency-list/creation/contingency-list-creation-dialog.tsx
@@ -15,7 +15,6 @@ import {
 } from '@gridsuite/commons-ui';
 import { useForm } from 'react-hook-form';
 import { yupResolver } from '@hookform/resolvers/yup/dist/yup';
-import { SyntheticEvent } from 'react';
 import { createContingencyList } from '../../../../utils/rest-api';
 import ContingencyListCreationForm from './contingency-list-creation-form';
 import {
@@ -47,7 +46,7 @@ const schema = yup.object().shape({
 const emptyFormData = getContingencyListEmptyFormData();
 
 export interface ContingencyListCreationDialogProps {
-    onClose: (event?: SyntheticEvent) => void;
+    onClose: () => void;
     open: boolean;
     titleId: string;
 }
@@ -75,9 +74,9 @@ export default function ContingencyListCreationDialog({
     const nameError = errors[FieldConstants.NAME];
     const isValidating = errors.root?.isValidating;
 
-    const closeAndClear = (event?: SyntheticEvent) => {
+    const closeAndClear = () => {
         reset(emptyFormData);
-        onClose(event);
+        onClose();
     };
 
     const onSubmit = (data: ContingencyListFormDataWithRequiredCriteria) => {
diff --git a/src/components/dialogs/contingency-list/edition/criteria-based/criteria-based-edition-dialog.tsx b/src/components/dialogs/contingency-list/edition/criteria-based/criteria-based-edition-dialog.tsx
@@ -15,7 +15,7 @@ import {
 } from '@gridsuite/commons-ui';
 import { useForm } from 'react-hook-form';
 import { yupResolver } from '@hookform/resolvers/yup/dist/yup';
-import { SyntheticEvent, useEffect, useState } from 'react';
+import { useEffect, useState } from 'react';
 import { getContingencyList, saveCriteriaBasedContingencyList } from 'utils/rest-api';
 import { useDispatch, useSelector } from 'react-redux';
 import { AppState } from '../../../../../redux/types';
@@ -41,7 +41,7 @@ export interface CriteriaBasedEditionDialogProps {
     contingencyListId: string;
     contingencyListType: string;
     open: boolean;
-    onClose: (event?: SyntheticEvent) => void;
+    onClose: () => void;
     titleId: string;
     name: string;
     broadcastChannel: BroadcastChannel;
@@ -92,9 +92,9 @@ export default function CriteriaBasedEditionDialog({
             .finally(() => setIsFetching(false));
     }, [contingencyListId, contingencyListType, name, reset, snackError]);
 
-    const closeAndClear = (event?: SyntheticEvent) => {
+    const closeAndClear = () => {
         reset(emptyFormData());
-        onClose(event);
+        onClose();
     };
 
     const onSubmit = (contingencyList: CriteriaBasedEditionFormData) => {
diff --git a/src/components/dialogs/contingency-list/edition/explicit-naming/explicit-naming-edition-dialog.tsx b/src/components/dialogs/contingency-list/edition/explicit-naming/explicit-naming-edition-dialog.tsx
@@ -14,7 +14,7 @@ import {
 } from '@gridsuite/commons-ui';
 import { useForm } from 'react-hook-form';
 import { yupResolver } from '@hookform/resolvers/yup/dist/yup';
-import { SyntheticEvent, useEffect, useState } from 'react';
+import { useEffect, useState } from 'react';
 import { getContingencyList, saveExplicitNamingContingencyList } from 'utils/rest-api';
 import { prepareContingencyListForBackend } from 'components/dialogs/contingency-list-helper';
 import { useDispatch, useSelector } from 'react-redux';
@@ -48,7 +48,7 @@ export interface ExplicitNamingEditionDialogProps {
     contingencyListId: string;
     contingencyListType: string;
     open: boolean;
-    onClose: (event?: SyntheticEvent) => void;
+    onClose: () => void;
     titleId: string;
     name: string;
     broadcastChannel: BroadcastChannel;
@@ -97,9 +97,9 @@ export default function ExplicitNamingEditionDialog({
             .finally(() => setIsFetching(false));
     }, [contingencyListId, contingencyListType, name, reset, snackError]);
 
-    const closeAndClear = (event?: SyntheticEvent) => {
+    const closeAndClear = () => {
         reset(emptyFormData());
-        onClose(event);
+        onClose();
     };
 
     const editContingencyList = (contingencyListId2: string, contingencyList: ExplicitNamingEditionFormData) => {
diff --git a/src/components/dialogs/contingency-list/edition/script/script-edition-dialog.tsx b/src/components/dialogs/contingency-list/edition/script/script-edition-dialog.tsx
@@ -14,7 +14,7 @@ import {
 } from '@gridsuite/commons-ui';
 import { useForm } from 'react-hook-form';
 import { yupResolver } from '@hookform/resolvers/yup/dist/yup';
-import { SyntheticEvent, useEffect, useState } from 'react';
+import { useEffect, useState } from 'react';
 import { getContingencyList, saveScriptContingencyList } from 'utils/rest-api';
 import { useDispatch, useSelector } from 'react-redux';
 import { getContingencyListEmptyFormData, getScriptFormDataFromFetchedElement } from '../../contingency-list-utils';
@@ -40,7 +40,7 @@ export interface ScriptEditionDialogProps {
     contingencyListId: string;
     contingencyListType: string;
     open: boolean;
-    onClose: (event?: SyntheticEvent) => void;
+    onClose: () => void;
     titleId: string;
     name: string;
     broadcastChannel: BroadcastChannel;
@@ -91,9 +91,9 @@ export default function ScriptEditionDialog({
             .finally(() => setIsFetching(false));
     }, [contingencyListId, contingencyListType, name, reset, snackError]);
 
-    const closeAndClear = (event?: SyntheticEvent) => {
+    const closeAndClear = () => {
         reset(emptyFormData());
-        onClose(event);
+        onClose();
     };
 
     const editContingencyList = (contingencyListId2: string, contingencyList: ScriptEditionFormData) => {
diff --git a/src/components/dialogs/copy-to-script-dialog.tsx b/src/components/dialogs/copy-to-script-dialog.tsx
@@ -26,7 +26,7 @@ const emptyFormData = {
 export interface CopyToScriptDialogProps {
     id: string;
     open: boolean;
-    onClose: (...args: any[]) => void;
+    onClose: () => void;
     onValidate: (...args: any[]) => void;
     currentName: string;
     title: string;
@@ -83,10 +83,6 @@ export default function CopyToScriptDialog({
         onValidate(id, data[FieldConstants.NAME]);
     };
 
-    const handleClose = () => {
-        onClose();
-    };
-
     const handleGenerateNameError = useCallback(
         () => handleError(intl.formatMessage({ id: 'generateCopyScriptNameError' }, { itemName: currentName })),
         [currentName, handleError, intl]
@@ -112,7 +108,7 @@ export default function CopyToScriptDialog({
     return (
         <CustomMuiDialog
             open={open}
-            onClose={handleClose}
+            onClose={onClose}
             onSave={onSubmit}
             formSchema={schema}
             formMethods={methods}
diff --git a/src/components/dialogs/create-case-dialog/create-case-dialog.tsx b/src/components/dialogs/create-case-dialog/create-case-dialog.tsx
@@ -41,7 +41,7 @@ interface IFormData {
 }
 
 export interface CreateCaseDialogProps {
-    onClose: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: () => void;
     open: boolean;
 }
 
diff --git a/src/components/dialogs/create-directory-dialog.tsx b/src/components/dialogs/create-directory-dialog.tsx
@@ -14,7 +14,7 @@ import { useNameField } from './field-hook';
 
 export interface CreateDirectoryDialogProps {
     open: boolean;
-    onClose: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: () => void;
     onClick: (newName: string) => void;
     title: string;
     parentDirectory?: UUID;
diff --git a/src/components/dialogs/create-study-dialog/create-study-dialog.tsx b/src/components/dialogs/create-study-dialog/create-study-dialog.tsx
@@ -64,7 +64,7 @@ function formatCaseImportParameters(params: Parameter[]): Parameter[] {
 
 export interface CreateStudyDialogProps {
     open: boolean;
-    onClose: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: () => void;
     providedExistingCase?: ElementAttributes;
 }
 
diff --git a/src/components/dialogs/delete-dialog.tsx b/src/components/dialogs/delete-dialog.tsx
@@ -20,7 +20,7 @@ import { CancelButton, ElementAttributes, OverflowableText } from '@gridsuite/co
 
 export interface DeleteDialogProps {
     open: boolean;
-    onClose: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: () => void;
     onClick: () => void;
     items: ElementAttributes[];
     multipleDeleteFormatMessageId: string;
diff --git a/src/components/dialogs/rename-dialog.tsx b/src/components/dialogs/rename-dialog.tsx
@@ -17,7 +17,7 @@ export interface RenameDialogProps {
     /** Is the dialog open ? */
     open: boolean;
     /** Event to close the dialog */
-    onClose: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: () => void;
     /** Event to submit the renaming */
     onClick: (newName: string) => void;
     /** Title of the dialog */
diff --git a/src/components/menus/common-contextual-menu.tsx b/src/components/menus/common-contextual-menu.tsx
@@ -41,7 +41,6 @@ export type MenuItemType =
       };
 
 export interface CommonContextualMenuProps extends MenuProps {
-    onClose?: (e?: unknown, nextSelectedDirectoryId?: string | null) => void;
     menuItems?: MenuItemType[];
 }
 
@@ -57,9 +56,7 @@ export const defaultAnchorStates: AnchorStatesType = {
     anchorReference: 'anchorPosition',
 };
 
-export default function CommonContextualMenu(props: Readonly<CommonContextualMenuProps>) {
-    const { menuItems, ...others } = props;
-
+export default function CommonContextualMenu({ menuItems, ...menuProps }: Readonly<CommonContextualMenuProps>) {
     function makeMenuItem(
         key: number,
         messageDescriptorId?: string,
@@ -89,7 +86,7 @@ export default function CommonContextualMenu(props: Readonly<CommonContextualMen
 
     let dividerCount = 0;
     return (
-        <StyledMenu keepMounted {...others}>
+        <StyledMenu keepMounted {...menuProps}>
             {menuItems?.map((menuItem, index) => {
                 if (menuItem.isDivider) {
                     dividerCount += 1;
diff --git a/src/components/menus/directory-tree-contextual-menu.tsx b/src/components/menus/directory-tree-contextual-menu.tsx
@@ -52,16 +52,16 @@ import { AppState } from '../../redux/types';
 import MoveDialog from '../dialogs/move-dialog';
 import { buildPathToFromMap } from '../treeview-utils';
 
-export interface DirectoryTreeContextualMenuProps extends CommonContextualMenuProps {
+export interface DirectoryTreeContextualMenuProps extends Omit<CommonContextualMenuProps, 'onClose'> {
     directory: ElementAttributes | null;
-    onClose: (e: unknown, nextSelectedDirectoryId?: string | null) => void;
+    onClose: (nextSelectedDirectoryId?: string | null) => void;
     openDialog: string;
     setOpenDialog: (dialogId: string) => void;
     restrictMenuItems: boolean;
 }
 
 export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTreeContextualMenuProps>) {
-    const { directory, open, onClose, openDialog, setOpenDialog, restrictMenuItems, ...others } = props;
+    const { directory, open, onClose, openDialog, setOpenDialog, restrictMenuItems, ...otherProps } = props;
     const userId = useSelector((state: AppState) => state.user?.profile.sub);
 
     const intl = useIntl();
@@ -80,8 +80,8 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
     };
 
     const handleCloseDialog = useCallback(
-        (e: unknown, nextSelectedDirectoryId: string | null = null) => {
-            onClose(e, nextSelectedDirectoryId);
+        (nextSelectedDirectoryId: string | null = null) => {
+            onClose(nextSelectedDirectoryId);
             setOpenDialog(DialogsId.NONE);
             setHideMenu(false);
             setDeleteError('');
@@ -91,7 +91,7 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
 
     const [renameCB, renameState] = useDeferredFetch(
         renameElement,
-        () => handleCloseDialog(null, null),
+        handleCloseDialog,
         (HTTPStatusCode: number) => {
             if (HTTPStatusCode === 403) {
                 return intl.formatMessage({ id: 'renameDirectoryError' });
@@ -103,12 +103,12 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
     );
 
     const [insertDirectoryCB, insertDirectoryState] = useDeferredFetch(insertDirectory, (response: ElementAttributes) =>
-        handleCloseDialog(null, response?.elementUuid)
+        handleCloseDialog(response?.elementUuid)
     );
 
     const [insertRootDirectoryCB, insertRootDirectoryState] = useDeferredFetch(
         insertRootDirectory,
-        (response: ElementAttributes) => handleCloseDialog(null, response?.elementUuid)
+        (response: ElementAttributes) => handleCloseDialog(response?.elementUuid)
     );
 
     const selectionForCopy = useSelector((state: AppState) => state.selectionForCopy);
@@ -130,7 +130,7 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
     function pasteElement(directoryUuid: UUID, selectionForPaste: any) {
         if (!selectionForPaste.sourceItemUuid) {
             handleError(intl.formatMessage({ id: 'elementPasteFailed404' }));
-            handleCloseDialog(null);
+            handleCloseDialog();
         } else {
             console.info('Pasting element %s into directory %s', selectionForPaste.nameItem, directoryUuid);
 
@@ -180,15 +180,15 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
                     );
             }
 
-            handleCloseDialog(null);
+            handleCloseDialog();
         }
     }
 
     const handleDeleteElement = useCallback(
         (elementsUuid: UUID) => {
             setDeleteError('');
             deleteElement(elementsUuid)
-                .then(() => handleCloseDialog(null, directory?.parentUuid))
+                .then(() => handleCloseDialog(directory?.parentUuid))
                 .catch((error: any) => {
                     // show the error message and don't close the dialog
                     setDeleteError(error.message);
@@ -406,7 +406,12 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
     return (
         <>
             {open && (
-                <CommonContextualMenu {...others} menuItems={buildMenu()} open={open && !hideMenu} onClose={onClose} />
+                <CommonContextualMenu
+                    {...otherProps}
+                    menuItems={buildMenu()}
+                    open={open && !hideMenu}
+                    onClose={() => onClose()}
+                />
             )}
             {renderDialog()}
         </>

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ interface IFormData {`
`41`	`41`	`}`
`42`	`42`
`43`	`43`	`export interface CreateCaseDialogProps {`
`44`		`- onClose: (e?: unknown, nextSelectedDirectoryId?: string \| null) => void;`
	`44`	`+ onClose: () => void;`
`45`	`45`	`open: boolean;`
`46`	`46`	`}`
`47`	`47`
Original file line number	Diff line number	Diff line change
`@@ -64,7 +64,7 @@ function formatCaseImportParameters(params: Parameter[]): Parameter[] {`
`64`	`64`
`65`	`65`	`export interface CreateStudyDialogProps {`
`66`	`66`	`open: boolean;`
`67`		`- onClose: (e?: unknown, nextSelectedDirectoryId?: string \| null) => void;`
	`67`	`+ onClose: () => void;`
`68`	`68`	`providedExistingCase?: ElementAttributes;`
`69`	`69`	`}`
`70`	`70`