Add support for spreadsheet config collections (#578)

Signed-off-by: Ayoub LABIDI <[email protected]>

Author: ayolab

package-lock.json

@@ -7,7 +7,7 @@
     "dependencies": {
         "@emotion/react": "^11.11.4",
         "@emotion/styled": "^11.11.5",
-        "@gridsuite/commons-ui": "0.74.0",
+        "@gridsuite/commons-ui": "0.75.0",
         "@hookform/resolvers": "^3.3.4",
         "@mui/icons-material": "^5.15.14",
         "@mui/lab": "5.0.0-alpha.169",

package.json

@@ -50,6 +50,7 @@ const getClickableRowStyle = (cellData: RowClassParams<ElementAttributes>) => {
             ElementType.VOLTAGE_INIT_PARAMETERS,
             ElementType.SHORT_CIRCUIT_PARAMETERS,
             ElementType.SPREADSHEET_CONFIG,
+            ElementType.SPREADSHEET_CONFIG_COLLECTION,
         ].includes(cellData.data.type)
     ) {
         style.cursor = 'pointer';

src/components/directory-content-table.tsx

@@ -38,6 +38,7 @@ import {
     deleteElements,
     duplicateElement,
     duplicateSpreadsheetConfig,
+    duplicateSpreadsheetConfigCollection,
     elementExists,
     moveElementsToDirectory,
     newScriptFromFilter,
@@ -169,6 +170,7 @@ export default function ContentContextualMenu(props: Readonly<ContentContextualM
                 case ElementType.LOADFLOW_PARAMETERS:
                 case ElementType.SHORT_CIRCUIT_PARAMETERS:
                 case ElementType.SPREADSHEET_CONFIG:
+                case ElementType.SPREADSHEET_CONFIG_COLLECTION:
                     console.info(
                         `${activeElement.type} with uuid ${activeElement.elementUuid} from directory ${selectedDirectory?.elementUuid} selected for copy`
                     );
@@ -241,6 +243,11 @@ export default function ContentContextualMenu(props: Readonly<ContentContextualM
                         handleDuplicateError(error.message);
                     });
                     break;
+                case ElementType.SPREADSHEET_CONFIG_COLLECTION:
+                    duplicateSpreadsheetConfigCollection(activeElement.elementUuid).catch((error) => {
+                        handleDuplicateError(error.message);
+                    });
+                    break;
                 default: {
                     handleLastError(intl.formatMessage({ id: 'unsupportedItem' }));
                 }
@@ -409,6 +416,7 @@ export default function ContentContextualMenu(props: Readonly<ContentContextualM
             ElementType.SHORT_CIRCUIT_PARAMETERS,
             ElementType.LOADFLOW_PARAMETERS,
             ElementType.SPREADSHEET_CONFIG,
+            ElementType.SPREADSHEET_CONFIG_COLLECTION,
         ];
 
         const hasMetadata = selectedElements[0]?.hasMetadata;
@@ -453,7 +461,11 @@ export default function ContentContextualMenu(props: Readonly<ContentContextualM
     );
 
     const allowsDownload = useCallback(() => {
-        const allowedTypes = [ElementType.CASE, ElementType.SPREADSHEET_CONFIG];
+        const allowedTypes = [
+            ElementType.CASE,
+            ElementType.SPREADSHEET_CONFIG,
+            ElementType.SPREADSHEET_CONFIG_COLLECTION,
+        ];
         // if selectedElements contains at least one of the allowed types
         return selectedElements.some((element) => allowedTypes.includes(element.type)) && noCreationInProgress();
     }, [selectedElements, noCreationInProgress]);

src/components/menus/content-contextual-menu.tsx

@@ -34,6 +34,7 @@ import {
     deleteElement,
     duplicateElement,
     duplicateSpreadsheetConfig,
+    duplicateSpreadsheetConfigCollection,
     elementExists,
     insertDirectory,
     insertRootDirectory,
@@ -172,6 +173,11 @@ export default function DirectoryTreeContextualMenu(props: Readonly<DirectoryTre
                         handlePasteError(error)
                     );
                     break;
+                case ElementType.SPREADSHEET_CONFIG_COLLECTION:
+                    duplicateSpreadsheetConfigCollection(selectionForPaste.sourceItemUuid, directoryUuid).catch(
+                        (error: any) => handlePasteError(error)
+                    );
+                    break;
                 default:
                     handleError(
                         intl.formatMessage({

src/components/menus/directory-tree-contextual-menu.tsx

@@ -120,7 +120,11 @@ export default function ContentToolbar(props: Readonly<ContentToolbarProps>) {
     );
 
     const allowsDownload = useMemo(() => {
-        const allowedTypes = [ElementType.CASE, ElementType.SPREADSHEET_CONFIG];
+        const allowedTypes = [
+            ElementType.CASE,
+            ElementType.SPREADSHEET_CONFIG,
+            ElementType.SPREADSHEET_CONFIG_COLLECTION,
+        ];
         // if selectedElements contains at least one of the allowed types
         return selectedElements.some((element) => allowedTypes.includes(element.type)) && noCreationInProgress;
     }, [selectedElements, noCreationInProgress]);

src/components/toolbars/content-toolbar.tsx

@@ -9,7 +9,13 @@ import { useIntl } from 'react-intl';
 import { ElementAttributes, ElementType, useSnackMessage } from '@gridsuite/commons-ui';
 import { useCallback, useState } from 'react';
 import { UUID } from 'crypto';
-import { downloadCase, downloadSpreadsheetConfig, fetchConvertedCase, getCaseOriginalName } from '../../utils/rest-api';
+import {
+    downloadCase,
+    downloadSpreadsheetConfig,
+    downloadSpreadsheetConfigCollection,
+    fetchConvertedCase,
+    getCaseOriginalName,
+} from '../../utils/rest-api';
 
 interface DownloadData {
     blob: Blob;
@@ -56,6 +62,23 @@ const downloadStrategies: { [key in ElementType]?: (element: ElementAttributes)
             return { blob: await result.blob(), filename };
         }
     },
+    [ElementType.SPREADSHEET_CONFIG_COLLECTION]: async (element: ElementAttributes) => {
+        const result = await downloadSpreadsheetConfigCollection(element.elementUuid);
+        const filename = `${element.elementName}.json`;
+        try {
+            // Parse the JSON to ensure it's valid
+            const jsonContent = await result.json();
+            // Stringify with indentation for pretty formatting
+            const prettyJson = JSON.stringify(jsonContent, null, 2);
+            // Create a new Blob with the pretty-formatted JSON
+            const blob = new Blob([prettyJson], { type: 'application/json' });
+            return { blob, filename };
+        } catch (error) {
+            // If parsing fails, fall back to the original blob
+            console.error('Error parsing JSON:', error);
+            return { blob: await result.blob(), filename };
+        }
+    },
 };
 
 export function useDownloadUtils() {

src/components/utils/downloadUtils.ts

@@ -75,6 +75,7 @@
     "editFilter": "Edit filter",
     "STUDY": "Study",
     "SPREADSHEET_CONFIG": "Spreadsheet model",
+    "SPREADSHEET_CONFIG_COLLECTION": "Spreadsheet model collection",
     "VOLTAGE_INIT_PARAMETERS": "Settings (Voltage profile initialization)",
     "SECURITY_ANALYSIS_PARAMETERS": "Settings (Security analysis)",
     "SENSITIVITY_PARAMETERS": "Settings (Sensitivity analysis)",

src/translations/en.json

@@ -74,6 +74,7 @@
     "editFilter": "Éditer le filtre",
     "STUDY": "Étude",
     "SPREADSHEET_CONFIG": "Modèle de tableur",
+    "SPREADSHEET_CONFIG_COLLECTION": "Modèles de tableur",
     "VOLTAGE_INIT_PARAMETERS": "Paramètres (Initialisation du plan de tension)",
     "SECURITY_ANALYSIS_PARAMETERS": "Paramètres (Analyse de sécurité)",
     "SENSITIVITY_PARAMETERS": "Paramètres (Analyse de sensibilité)",

src/translations/fr.json

@@ -432,6 +432,22 @@ export function duplicateSpreadsheetConfig(sourceCaseUuid: UUID, parentDirectory
     });
 }
 
+export function duplicateSpreadsheetConfigCollection(sourceCaseUuid: UUID, parentDirectoryUuid?: UUID) {
+    console.info('Duplicating a spreadsheet config collection...');
+    const queryParams = new URLSearchParams();
+    queryParams.append('duplicateFrom', sourceCaseUuid);
+    if (parentDirectoryUuid) {
+        queryParams.append('parentDirectoryUuid', parentDirectoryUuid);
+    }
+    const url = `${PREFIX_EXPLORE_SERVER_QUERIES}/v1/explore/spreadsheet-config-collections/duplicate?${queryParams.toString()}`;
+
+    console.debug(url);
+
+    return backendFetch(url, {
+        method: 'post',
+    });
+}
+
 export function downloadSpreadsheetConfig(configId: string) {
     console.info(`Downloading spreadsheet config with id: ${configId}`);
     const fetchUrl = `${PREFIX_SPREADSHEET_CONFIG_QUERIES}/v1/spreadsheet-configs/${configId}`;
@@ -444,6 +460,18 @@ export function downloadSpreadsheetConfig(configId: string) {
     });
 }
 
+export function downloadSpreadsheetConfigCollection(collectionId: string) {
+    console.info(`Downloading spreadsheet config collection with id: ${collectionId}`);
+    const fetchUrl = `${PREFIX_SPREADSHEET_CONFIG_QUERIES}/v1/spreadsheet-config-collections/${collectionId}`;
+
+    return backendFetch(fetchUrl, {
+        method: 'GET',
+        headers: {
+            'Content-Type': 'application/json',
+        },
+    });
+}
+
 export function elementExists(directoryUuid: UUID | null | undefined, elementName: string, type: string) {
     const elementNameEncoded = encodeURIComponent(elementName);
     const existsElementUrl = `${PREFIX_DIRECTORY_SERVER_QUERIES}/v1/directories/${directoryUuid}/elements/${elementNameEncoded}/types/${type}`;