add branch type

Tristan-WorkGH · Tristan-WorkGH · commit da88f3a74616 · 2025-07-25T16:54:51.000+02:00
diff --git a/src/components/spreadsheet-view/add-spreadsheet/types.d.ts b/src/components/spreadsheet-view/add-spreadsheet/types.d.ts
@@ -0,0 +1,7 @@
+/*
+ * Copyright © 2025, RTE (http://www.rte-france.com)
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
diff --git a/src/components/spreadsheet-view/spreadsheet/spreadsheet-content/hooks/use-equipment-modification.tsx b/src/components/spreadsheet-view/spreadsheet/spreadsheet-content/hooks/use-equipment-modification.tsx
@@ -25,6 +25,7 @@ export type UseEquipmentModificationProps = {
 
 type EditableEquipmentType = Exclude<
     SpreadsheetEquipmentType,
+    | SpreadsheetEquipmentType.BRANCH
     | SpreadsheetEquipmentType.BUS
     | SpreadsheetEquipmentType.BUSBAR_SECTION
     | SpreadsheetEquipmentType.DANGLING_LINE
diff --git a/src/components/spreadsheet-view/spreadsheet/spreadsheet-content/hooks/use-spreadsheet-equipments.ts b/src/components/spreadsheet-view/spreadsheet/spreadsheet-content/hooks/use-spreadsheet-equipments.ts
@@ -16,9 +16,10 @@ import {
     resetEquipments,
     resetEquipmentsByTypes,
     updateEquipments,
+    type UpdateEquipmentsAction,
 } from 'redux/actions';
 import { type AppState } from 'redux/reducer';
-import { SpreadsheetEquipmentType } from '../../../types/spreadsheet.type';
+import { isSpreadsheetEquipmentType, SpreadsheetEquipmentType } from '../../../types/spreadsheet.type';
 import { fetchAllEquipments } from 'services/study/network-map';
 import type { NodeAlias } from '../../../types/node-alias.type';
 import { isStatusBuilt } from '../../../../graph/util/model-functions';
@@ -27,6 +28,7 @@ import { type DeletedEquipment, isStudyNotification, type NetworkImpactsInfos }
 import { NodeType } from '../../../../graph/tree-node.type';
 import { validAlias } from '../../../hooks/use-node-aliases';
 import { fetchNetworkElementInfos } from 'services/study/network';
+import { EQUIPMENT_INFOS_TYPES } from '../../../../utils/equipment-types';
 
 export const useSpreadsheetEquipments = (
     type: SpreadsheetEquipmentType,
@@ -45,10 +47,8 @@ export const useSpreadsheetEquipments = (
     const currentRootNetworkUuid = useSelector((state: AppState) => state.currentRootNetworkUuid);
     const currentNode = useSelector((state: AppState) => state.currentTreeNode);
     const treeNodes = useSelector((state: AppState) => state.networkModificationTreeModel?.treeNodes);
-    const [builtAliasedNodesIds, setBuiltAliasedNodesIds] = useState<UUID[]>();
-
+    const [builtAliasedNodesIds, setBuiltAliasedNodesIds] = useState<UUID[]>([]);
     const [isFetching, setIsFetching] = useState<boolean>(false);
-
     const { fetchNodesEquipmentData } = useFetchEquipment(type);
 
     // effect to keep builtAliasedNodesIds up-to-date (when we add/remove an alias or build/unbuild an aliased node)
@@ -61,25 +61,20 @@ export const useSpreadsheetEquipments = (
             .filter((nodeAlias) => validAlias(nodeAlias))
             .map((nodeAlias) => nodeAlias.id);
         if (aliasedNodesIds.length > 0) {
-            treeNodes?.forEach((treeNode) => {
-                if (
-                    aliasedNodesIds.includes(treeNode.id) &&
-                    (treeNode.type === NodeType.ROOT || isStatusBuilt(treeNode.data.globalBuildStatus))
-                ) {
-                    computedIds.push(treeNode.id);
-                }
-            });
+            computedIds =
+                treeNodes
+                    ?.filter(
+                        (treeNode) =>
+                            aliasedNodesIds.includes(treeNode.id) &&
+                            (treeNode.type === NodeType.ROOT || isStatusBuilt(treeNode.data.globalBuildStatus))
+                    )
+                    .map((treeNode) => treeNode.id) ?? [];
         }
+        computedIds.sort((a, b) => a.localeCompare(b));
         // Because of treeNodes: update the state only on real values changes (to avoid multiple effects for the watchers)
-        setBuiltAliasedNodesIds((prevState) => {
-            const currentIds = prevState;
-            currentIds?.sort((a, b) => a.localeCompare(b));
-            computedIds.sort((a, b) => a.localeCompare(b));
-            if (JSON.stringify(currentIds) !== JSON.stringify(computedIds)) {
-                return computedIds;
-            }
-            return prevState;
-        });
+        setBuiltAliasedNodesIds((prevState) =>
+            JSON.stringify(prevState) !== JSON.stringify(computedIds) ? computedIds : prevState
+        );
     }, [nodeAliases, treeNodes]);
 
     const nodesIdToFetch = useMemo(() => {
@@ -92,17 +87,17 @@ export const useSpreadsheetEquipments = (
             nodesIdToFetch.add(currentNode.id);
         }
         // Then we do the same for the other nodes we need the data of (the ones defined in aliases)
-        builtAliasedNodesIds.forEach((builtAliasNodeId) => {
+        for (const builtAliasNodeId of builtAliasedNodesIds) {
             if (equipments.nodesId.find((nodeId) => nodeId === builtAliasNodeId) === undefined) {
                 nodesIdToFetch.add(builtAliasNodeId);
             }
-        });
+        }
         return nodesIdToFetch;
     }, [currentNode?.id, equipments.nodesId, builtAliasedNodesIds]);
 
     // effect to unload equipment data when we remove an alias or unbuild an aliased node
     useEffect(() => {
-        if (!equipments || !builtAliasedNodesIds || !currentNode?.id) {
+        if (!equipments || !builtAliasedNodesIds.length || !currentNode?.id) {
             return;
         }
         const currentNodeId = currentNode.id;
@@ -121,7 +116,7 @@ export const useSpreadsheetEquipments = (
                 return;
             }
             // updating data related to impacted elements
-            const nodeId = currentNode?.id as UUID;
+            const nodeId = currentNode?.id as UUID; //TODO maybe do nothing if no current node?
 
             // Handle updates and resets based on impacted element types
             if (impactedElementTypes.length > 0) {
@@ -133,7 +128,9 @@ export const useSpreadsheetEquipments = (
                     Object.keys(allEquipments).includes(type)
                 );
                 if (impactedSpreadsheetEquipmentsTypes.length > 0) {
-                    dispatch(resetEquipmentsByTypes(impactedSpreadsheetEquipmentsTypes as SpreadsheetEquipmentType[]));
+                    dispatch(
+                        resetEquipmentsByTypes(impactedSpreadsheetEquipmentsTypes.filter(isSpreadsheetEquipmentType))
+                    );
                 }
             }
 
@@ -154,17 +151,51 @@ export const useSpreadsheetEquipments = (
                     );
                 } else {
                     // here, we can fetch only the data for the modified equipment
-                    fetchNetworkElementInfos(
-                        studyUuid,
-                        nodeId,
-                        currentRootNetworkUuid,
-                        type,
-                        'TAB',
-                        equipmentToUpdateId,
-                        false
-                    ).then((value: Identifiable) => {
-                        highlightUpdatedEquipment();
-                        dispatch(updateEquipments({ [type]: [value] }, nodeId));
+                    const promises = [
+                        fetchNetworkElementInfos(
+                            studyUuid,
+                            nodeId,
+                            currentRootNetworkUuid,
+                            type,
+                            EQUIPMENT_INFOS_TYPES.TAB.type,
+                            equipmentToUpdateId,
+                            false
+                        ),
+                    ];
+                    if (
+                        type === SpreadsheetEquipmentType.LINE ||
+                        type === SpreadsheetEquipmentType.TWO_WINDINGS_TRANSFORMER
+                    ) {
+                        promises.push(
+                            fetchNetworkElementInfos(
+                                studyUuid,
+                                nodeId,
+                                currentRootNetworkUuid,
+                                SpreadsheetEquipmentType.BRANCH,
+                                EQUIPMENT_INFOS_TYPES.TAB.type,
+                                equipmentToUpdateId,
+                                false
+                            )
+                        );
+                    }
+                    Promise.allSettled(promises).then((results) => {
+                        const updates: UpdateEquipmentsAction['equipments'] = {};
+                        if (results[0].status === 'rejected') {
+                            //TODO show snackbar error?
+                        } else {
+                            updates[type] = results[0].value;
+                        }
+                        if (results.length > 1) {
+                            if (results[1].status === 'rejected') {
+                                //TODO show snackbar error?
+                            } else {
+                                updates[SpreadsheetEquipmentType.BRANCH] = results[1].value;
+                            }
+                        }
+                        if (Object.keys(updates).length > 1) {
+                            highlightUpdatedEquipment();
+                            dispatch(updateEquipments(updates, nodeId));
+                        }
                     });
                 }
             }
@@ -183,11 +214,12 @@ export const useSpreadsheetEquipments = (
                     });
 
                 if (equipmentsToDelete.length > 0) {
-                    const equipmentsToDeleteArray: EquipmentToDelete[] = equipmentsToDelete.map((equipment) => ({
-                        equipmentType: equipment.equipmentType as SpreadsheetEquipmentType,
-                        equipmentId: equipment.equipmentId,
-                        nodeId: nodeId,
-                    }));
+                    const equipmentsToDeleteArray = equipmentsToDelete
+                        .filter((e) => isSpreadsheetEquipmentType(e.equipmentType))
+                        .map<EquipmentToDelete>((equipment) => ({
+                            equipmentType: equipment.equipmentType as unknown as SpreadsheetEquipmentType,
+                            equipmentId: equipment.equipmentId,
+                        }));
                     dispatch(deleteEquipments(equipmentsToDeleteArray, nodeId));
                 }
             }
diff --git a/src/components/spreadsheet-view/spreadsheet/spreadsheet-toolbar/save/save-spreadsheet-button.tsx b/src/components/spreadsheet-view/spreadsheet/spreadsheet-toolbar/save/save-spreadsheet-button.tsx
@@ -5,21 +5,21 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 
-import { useState, MouseEvent, useCallback, useMemo, RefObject } from 'react';
+import { type MouseEvent, type RefObject, useCallback, useMemo, useState } from 'react';
 import { Button, Menu, MenuItem } from '@mui/material';
 import { FormattedMessage } from 'react-intl';
 import SaveIcon from '@mui/icons-material/Save';
 import SaveSpreadsheetDialog from './save-spreadsheet-dialog';
-import { useCsvExport, useStateBoolean, FILTER_EQUIPMENTS } from '@gridsuite/commons-ui';
+import { EquipmentType, FILTER_EQUIPMENTS, useCsvExport, useStateBoolean } from '@gridsuite/commons-ui';
 import { SaveSpreadsheetCollectionDialog } from './save-spreadsheet-collection-dialog';
-import { NodeAlias } from '../../../types/node-alias.type';
+import type { NodeAlias } from '../../../types/node-alias.type';
 import { ROW_INDEX_COLUMN_ID } from '../../../constants';
-import { SpreadsheetTabDefinition } from '../../../types/spreadsheet.type';
-import { AgGridReact } from 'ag-grid-react';
-import { ColDef } from 'ag-grid-community';
+import { SpreadsheetEquipmentType, type SpreadsheetTabDefinition } from '../../../types/spreadsheet.type';
+import type { AgGridReact } from 'ag-grid-react';
+import type { ColDef } from 'ag-grid-community';
 import { spreadsheetStyles } from '../../../spreadsheet.style';
 import { useSelector } from 'react-redux';
-import { AppState } from '../../../../../redux/reducer';
+import type { AppState } from '../../../../../redux/reducer';
 import SaveNamingFilterDialog from './save-naming-filter-dialog';
 
 enum SpreadsheetSaveOptionId {
@@ -60,15 +60,10 @@ export default function SaveSpreadsheetButton({
     const { downloadCSVData } = useCsvExport();
     const language = useSelector((state: AppState) => state.computedLanguage);
 
-    const handleClick = useCallback((event: MouseEvent<HTMLButtonElement>) => {
-        setAnchorEl(event.currentTarget);
-    }, []);
+    const handleClick = useCallback((event: MouseEvent<HTMLButtonElement>) => setAnchorEl(event.currentTarget), []);
+    const handleClose = useCallback(() => setAnchorEl(null), []);
 
-    const handleClose = useCallback(() => {
-        setAnchorEl(null);
-    }, []);
-
-    const spreadsheetOptions = useMemo(
+    const spreadsheetOptions = useMemo<Record<SpreadsheetSaveOptionId, SpreadsheetSaveOption>>(
         () => ({
             [SpreadsheetSaveOptionId.SAVE_MODEL]: {
                 id: SpreadsheetSaveOptionId.SAVE_MODEL,
@@ -84,16 +79,14 @@ export default function SaveSpreadsheetButton({
                 id: SpreadsheetSaveOptionId.EXPORT_CSV,
                 label: 'spreadsheet/save/options/csv',
                 action: () => {
-                    // Filter out the rowIndex column before exporting to CSV
-                    const columnsForExport = columns.filter((col) => col.colId !== ROW_INDEX_COLUMN_ID);
-
                     const exportDataAsCsv = gridRef.current?.api.exportDataAsCsv;
                     if (!exportDataAsCsv) {
                         console.error('Export API is not available.');
                         return;
                     }
                     downloadCSVData({
-                        columns: columnsForExport,
+                        // Filter out the rowIndex column before exporting to CSV
+                        columns: columns.filter((col) => col.colId !== ROW_INDEX_COLUMN_ID),
                         tableName: tableDefinition.name,
                         language: language,
                         exportDataAsCsv,
@@ -105,7 +98,12 @@ export default function SaveSpreadsheetButton({
                 id: SpreadsheetSaveOptionId.SAVE_FILTER,
                 label: 'spreadsheet/save/options/filter',
                 action: saveFilterDialogOpen.setTrue,
-                disabled: dataSize === 0 || !FILTER_EQUIPMENTS[tableDefinition.type],
+                disabled:
+                    dataSize === 0 ||
+                    (tableDefinition.type === SpreadsheetEquipmentType.BRANCH
+                        ? !FILTER_EQUIPMENTS[EquipmentType.LINE] ||
+                          !FILTER_EQUIPMENTS[EquipmentType.TWO_WINDINGS_TRANSFORMER]
+                        : !FILTER_EQUIPMENTS[tableDefinition.type as unknown as EquipmentType]),
             },
         }),
         [
@@ -130,25 +128,22 @@ export default function SaveSpreadsheetButton({
         [spreadsheetOptions, handleClose]
     );
 
-    const renderMenuItem = useCallback(
-        (option: SpreadsheetSaveOption) => {
-            return (
-                <MenuItem key={option.id} onClick={() => handleMenuItemClick(option.id)} disabled={option?.disabled}>
-                    <FormattedMessage id={option.label} />
-                </MenuItem>
-            );
-        },
-        [handleMenuItemClick]
-    );
-
     return (
         <>
             <Button sx={spreadsheetStyles.spreadsheetButton} size={'small'} onClick={handleClick} disabled={disabled}>
                 <SaveIcon />
                 <FormattedMessage id="spreadsheet/save/button" />
             </Button>
             <Menu anchorEl={anchorEl} open={Boolean(anchorEl)} onClose={handleClose}>
-                {Object.values(spreadsheetOptions).map(renderMenuItem)}
+                {Object.values(spreadsheetOptions).map((option) => (
+                    <MenuItem
+                        key={option.id}
+                        onClick={() => handleMenuItemClick(option.id)}
+                        disabled={option?.disabled}
+                    >
+                        <FormattedMessage id={option.label} />
+                    </MenuItem>
+                ))}
             </Menu>
             <SaveSpreadsheetDialog
                 tableDefinition={tableDefinition}
diff --git a/src/components/spreadsheet-view/types/spreadsheet.type.ts b/src/components/spreadsheet-view/types/spreadsheet.type.ts
@@ -12,6 +12,7 @@ import type { GlobalFilter } from '../../results/common/global-filter/global-fil
 
 export enum SpreadsheetEquipmentType {
     BATTERY = 'BATTERY',
+    BRANCH = 'BRANCH', // LINE + TWO_WINDINGS_TRANSFORMER
     BUS = 'BUS',
     BUSBAR_SECTION = 'BUSBAR_SECTION',
     DANGLING_LINE = 'DANGLING_LINE',
@@ -30,6 +31,10 @@ export enum SpreadsheetEquipmentType {
     VSC_CONVERTER_STATION = 'VSC_CONVERTER_STATION',
 }
 
+export function isSpreadsheetEquipmentType(type: string): type is SpreadsheetEquipmentType {
+    return type in SpreadsheetEquipmentType;
+}
+
 export interface SpreadsheetTabDefinition {
     uuid: UUID;
     index: number;
diff --git a/src/redux/reducer.ts b/src/redux/reducer.ts
@@ -259,7 +259,7 @@ import {
 } from '../utils/store-sort-filter-fields';
 import type { UUID } from 'crypto';
 import type { GlobalFilter } from '../components/results/common/global-filter/global-filter-types';
-import type { ValueOf } from 'type-fest';
+import type { Entries, ValueOf } from 'type-fest';
 import { CopyType, StudyDisplayMode } from '../components/network-modification.type';
 import { CurrentTreeNode, NetworkModificationNodeData, RootNodeData } from '../components/graph/tree-node.type';
 import { COMPUTING_AND_NETWORK_MODIFICATION_TYPE } from '../utils/report/report.constant';
@@ -519,6 +519,7 @@ const emptySpreadsheetEquipmentsByNodes: SpreadsheetEquipmentsByNodes = {
 export type SpreadsheetNetworkState = Record<SpreadsheetEquipmentType, SpreadsheetEquipmentsByNodes>;
 const initialSpreadsheetNetworkState: SpreadsheetNetworkState = {
     [SpreadsheetEquipmentType.BATTERY]: emptySpreadsheetEquipmentsByNodes,
+    [SpreadsheetEquipmentType.BRANCH]: emptySpreadsheetEquipmentsByNodes,
     [SpreadsheetEquipmentType.BUS]: emptySpreadsheetEquipmentsByNodes,
     [SpreadsheetEquipmentType.BUSBAR_SECTION]: emptySpreadsheetEquipmentsByNodes,
     [SpreadsheetEquipmentType.DANGLING_LINE]: emptySpreadsheetEquipmentsByNodes,
@@ -1252,7 +1253,11 @@ export const reducer = createReducer(initialState, (builder) => {
     });
 
     builder.addCase(LOAD_EQUIPMENTS, (state, action: LoadEquipmentsAction) => {
-        Object.entries(action.spreadsheetEquipmentByNodes.equipmentsByNodeId).forEach(([nodeId, equipments]) => {
+        (
+            Object.entries(action.spreadsheetEquipmentByNodes.equipmentsByNodeId) as Entries<
+                LoadEquipmentsAction['spreadsheetEquipmentByNodes']['equipmentsByNodeId']
+            >
+        ).forEach(([nodeId, equipments]) => {
             state.spreadsheetNetwork[action.equipmentType].equipmentsByNodeId[nodeId] = equipments;
         });
         //to remove duplicate
diff --git a/src/translations/en.json b/src/translations/en.json
@@ -557,6 +557,7 @@
     "Type": "Type",
     "SUBSTATION": "Substation",
     "VOLTAGE_LEVEL": "Voltage Level",
+    "BRANCH": "Branch",
     "LINE": "Line",
     "TIE_LINE": "Tie line",
     "SWITCH": "Switch",
diff --git a/src/translations/fr.json b/src/translations/fr.json
@@ -554,6 +554,7 @@
     "Type": "Type",
     "SUBSTATION": "Site",
     "VOLTAGE_LEVEL": "Poste",
+    "BRANCH": "Quadripôle",
     "LINE": "Ligne",
     "TIE_LINE": "Ligne d'interconnexion",
     "SWITCH": "disjoncteur",
diff --git a/src/utils/spreadsheet-equipments-mapper.ts b/src/utils/spreadsheet-equipments-mapper.ts
