@topconsultnpm/sdkui-react-beta 6.15.12 → 6.15.13

package/lib/components/base/TMDataGridExportForm.js

@@ -22,61 +22,78 @@ const TMDataGridExportForm = (props) => {
     const [exportSelectedOnly, setExportSelectedOnly] = useState(selectedRowKeys.length > 0 ? true : false);
     // Boolean state to indicate whether to export the "description" fields in data lists
     const [exportDescriptionsForDataLists, setExportDescriptionsForDataLists] = useState(true);
-    // Boolean state to indicate whether to hide the selection during export
-    const [hideSelection, setHideSelection] = useState(false);
+    // Boolean state to indicate whether to hide the selection and format during export
+    const [exportSelectedFormatColumns, setExportSelectedFormatColumns] = useState(true);
     const onStatusValueChange = (e) => {
         if (!e?.target?.value)
             return;
         setFormatSelected(e.target.value);
     };
+    // Function to trigger download of a file represented by a Blob with the given file extension
     const downloadFile = (blob, extension) => {
+        // Helper function to ensure numbers (e.g., 4 -> '04') are two digits
         const formatNumber = (n) => n.toString().padStart(2, '0');
+        // Helper function to generate a timestamp string in the format 'YYYY-MM-DD_HH-MM-SS'
         const getTimestamp = () => {
             const now = new Date();
             const date = `${now.getFullYear()}-${formatNumber(now.getMonth() + 1)}-${formatNumber(now.getDate())}`;
             const time = `${formatNumber(now.getHours())}-${formatNumber(now.getMinutes())}-${formatNumber(now.getSeconds())}`;
             return `${date}_${time}`;
         };
+        // Create a temporary URL representing the file Blob
         const url = URL.createObjectURL(blob);
+        // Create an anchor element to trigger the download
         const a = document.createElement('a');
         a.href = url;
+        // Set the filename using a localized prefix and the generated timestamp
         a.download = `${SDKUI_Localizator.SearchResult}_${getTimestamp()}.${extension}`;
+        // Append the anchor to the document, click it to start download, then remove it
         document.body.appendChild(a);
         a.click();
         document.body.removeChild(a);
+        // Revoke the created URL to release memory
         URL.revokeObjectURL(url);
     };
     const handleExport = async () => {
+        // Exit early if dataSource or dataColumns are not defined to avoid errors
         if (!dataSource || !dataColumns)
             return;
         let result = [];
         try {
             TMSpinner.show({ description: SDKUI_Localizator.Loading });
-            // Exit early if dataSource or dataColumns are not defined to avoid errors
+            // Retrieve columns from the search result, or use an empty array if not available
             const columns = searchResult?.dtdResult?.columns ?? [];
+            // If exportDescriptionsForDataLists is true, build a map of values to labels for the columns; otherwise use an empty Map
             const valueToNameMap = exportDescriptionsForDataLists ? await buildValueToLabelMapFromDataColumns(columns) : new Map();
+            // Create a Set from selectedRowKeys for efficient lookup
             const selectedSet = new Set(selectedRowKeys);
+            // If exporting only selected rows, filter the dataSource accordingly; otherwise use the full dataSource
             const rowsToExport = exportSelectedOnly ? dataSource.filter((_, idx) => selectedSet.has(idx)) : dataSource;
-            const visibleColumns = dataColumns.filter(col => hideSelection ? col.visible !== false && col.dataType !== 'object' : col.visible !== false);
+            // Filter columns to only those that are visible; optionally hide 'object' data types based on the `hideSelection` flag
+            const visibleColumns = dataColumns.filter(col => exportSelectedFormatColumns ? col.visible !== false && col.dataType !== 'object' : col.visible !== false);
+            // Function to get the value for a column and its value in a row
             const getValue = (col, value) => {
+                // Replace raw value with corresponding label from the map if applicable
                 let result = exportDescriptionsForDataLists ? valueToNameMap.get(value) ?? value : value;
+                // If the column is a datetime type, attempt to format it as a locale date string
                 if (col.dataType === 'datetime' && result) {
                     const parsedDate = new Date(result);
                     if (!isNaN(parsedDate.getTime())) {
                         result = parsedDate.toLocaleDateString();
                     }
                 }
+                // Return the cleaned string value, stripping double quotes to avoid CSV formatting issues
                 return (result ?? '').toString().replace(/"/g, '');
             };
             switch (formatSelected) {
                 case 'csv': {
-                    const headers = hideSelection ? visibleColumns.map(col => col.caption !== undefined ? col.caption : col.dataField) : [SDKUI_Localizator.SelectedSingular, ...visibleColumns.map(col => col.caption !== undefined ? col.caption : col.dataField)];
+                    const headers = exportSelectedFormatColumns ? visibleColumns.map(col => col.caption !== undefined ? col.caption : col.dataField) : [SDKUI_Localizator.SelectedSingular, ...visibleColumns.map(col => col.caption !== undefined ? col.caption : col.dataField)];
                     const csvRows = [];
                     csvRows.push(headers.join(';'));
                     rowsToExport.forEach((item, idx) => {
                         const originalIndex = exportSelectedOnly ? selectedRowKeys[idx] : dataSource.indexOf(item);
                         const rowValues = [];
-                        if (!hideSelection) {
+                        if (!exportSelectedFormatColumns) {
                             const status = selectedSet.has(originalIndex) ? SDKUI_Localizator.SelectedSingular : SDKUI_Localizator.Deselected;
                             rowValues.push(status || '');
                         }
@@ -99,7 +116,7 @@ const TMDataGridExportForm = (props) => {
                     // Map visible columns to worksheet column definitions
                     const baseColumns = visibleColumns.map(col => ({ header: col.caption !== undefined ? col.caption : col.dataField, key: col.dataField, width: 10, style: { numFmt: '@' } }));
                     // Add a selection status column at the beginning if hideSelection is false
-                    worksheet.columns = hideSelection ? baseColumns : [{ header: SDKUI_Localizator.SelectedSingular, key: '_selected', width: 10, style: { numFmt: '@' } }, ...baseColumns];
+                    worksheet.columns = exportSelectedFormatColumns ? baseColumns : [{ header: SDKUI_Localizator.SelectedSingular, key: '_selected', width: 10, style: { numFmt: '@' } }, ...baseColumns];
                     // Style the header row cells: font, fill color, and border
                     worksheet.getRow(1).eachCell({ includeEmpty: true }, cell => {
                         cell.font = { name: 'Segoe UI', size: 9 };
@@ -112,7 +129,7 @@ const TMDataGridExportForm = (props) => {
                         const originalIndex = exportSelectedOnly ? selectedRowKeys[idx] : dataSource.indexOf(item);
                         const rowObj = {};
                         // Add selection status if hideSelection is false
-                        if (!hideSelection) {
+                        if (!exportSelectedFormatColumns) {
                             rowObj._selected = selectedSet.has(originalIndex) ? SDKUI_Localizator.SelectedSingular : SDKUI_Localizator.Deselected;
                         }
                         // Add data for each visible column
@@ -170,7 +187,7 @@ const TMDataGridExportForm = (props) => {
     return _jsx(TMModal, { title: `${SDKUI_Localizator.Export}`, width: '400px', height: '230px', onClose: onCloseExportForm, children: _jsxs("div", { style: { display: 'flex', flexDirection: 'column', gap: '16px', padding: '6px 12px', height: '100%', width: '100%' }, children: [_jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMDropDown, { label: SDKUI_Localizator.Format, value: formatSelected, dataSource: formatDataSource, onValueChanged: onStatusValueChange }) }), _jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMCheckBox, { elementStyle: {
                             opacity: selectedRowKeys.length === 0 ? 0.5 : 1,
                             cursor: selectedRowKeys.length === 0 ? 'not-allowed' : 'pointer'
-                        }, label: `${SDKUI_Localizator.ExportOnlySelectedDocuments} (${selectedRowKeys.length})`, value: exportSelectedOnly, disabled: selectedRowKeys.length === 0, onValueChanged: () => { setExportSelectedOnly(prev => !prev); } }) }), _jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMCheckBox, { label: SDKUI_Localizator.ExportDataListsDescriptionField, value: exportDescriptionsForDataLists, onValueChanged: () => { setExportDescriptionsForDataLists(prev => !prev); } }) }), _jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMCheckBox, { label: SDKUI_Localizator.HideSelectionColumnsAndIcons, value: hideSelection, onValueChanged: () => { setHideSelection(prev => !prev); } }) }), _jsx("div", { style: {
+                        }, label: `${SDKUI_Localizator.ExportOnlySelectedDocuments} (${selectedRowKeys.length})`, value: exportSelectedOnly, disabled: selectedRowKeys.length === 0, onValueChanged: () => { setExportSelectedOnly(prev => !prev); } }) }), _jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMCheckBox, { label: SDKUI_Localizator.ExportDataListsDescriptionField, value: exportDescriptionsForDataLists, onValueChanged: () => { setExportDescriptionsForDataLists(prev => !prev); } }) }), _jsx("div", { style: { display: 'flex', alignItems: 'center', gap: '12px' }, children: _jsx(TMCheckBox, { label: SDKUI_Localizator.ExportSelectedColumnsAndFormatLabel, value: exportSelectedFormatColumns, onValueChanged: () => { setExportSelectedFormatColumns(prev => !prev); } }) }), _jsx("div", { style: {
                         display: 'flex',
                         justifyContent: 'center',
                         gap: '10px',

package/lib/helper/SDKUI_Localizator.d.ts

@@ -153,6 +153,7 @@ export declare class SDKUI_Localizator {
     static get ErrorParsingFileContent(): "Fehler beim Parsen des Dateiinhalts. Stellen Sie sicher, dass die Datei im richtigen Format vorliegt." | "Error parsing the file content. Ensure the file is in the correct format." | "Error al analizar el contenido del archivo. Asegúrese de que el archivo esté en el formato correcto." | "Erreur lors de l'analyse du contenu du fichier. Assurez-vous que le fichier est dans le bon format." | "Erro ao analisar o conteúdo do arquivo. Certifique-se de que o arquivo está no formato correto." | "Errore durante l'analisi del contenuto del file. Assicurati che il file sia nel formato corretto.";
     static get ExportDataListsDescriptionField(): "Exportiere die \"Beschreibung\"-Felder der Datenlisten" | "Export the \"description\" fields of data lists" | "Exportar los campos \"descripción\" de las listas de datos" | "Exporter les champs \"description\" des listes de données" | "Exportar os campos \"descrição\" das listas de dados" | "Esporta la \"Descrizione\" delle liste dati";
     static get ExportOnlySelectedDocuments(): "Nur ausgewählte Dokumente exportieren" | "Export only selected documents" | "Exportar solo los documentos seleccionados" | "Exporter uniquement les documents sélectionnés" | "Exportar apenas os documentos selecionados" | "Esporta solo i documenti selezionati";
+    static get ExportSelectedColumnsAndFormatLabel(): string;
     static get ExtractedBy(): "Ausgezogen von" | "Extracted by" | "Extraído por" | "Extrait par" | "Estratto da";
     static get ExtractedFromOtherUser(): string;
     static get ExtractedOn(): "Ausgezogen am" | "Extracted on" | "Extraído el" | "Extrait le" | "Extraído em" | "Estratto il";
@@ -215,7 +216,6 @@ export declare class SDKUI_Localizator {
     static get HideFormattingOptions(): "Formatierungsoptionen ausblenden" | "Hide formatting options" | "Ocultar opciones de formato" | "Masquer les options de formatage" | "Ocultar opções de formatação" | "Nascondi opzioni di formattazione";
     static get HideMetadata(): string;
     static get HideSearch(): "Suche ausblenden" | "Hide search" | "Ocultar búsqueda" | "Masquer la recherche" | "Ocultar pesquisa" | "Nascondi ricerca";
-    static get HideSelectionColumnsAndIcons(): "Auswahlspalten und Symbole ausblenden" | "Hide selection columns and icons" | "Ocultar columnas de selección e iconos" | "Masquer les colonnes de sélection et les icônes" | "Ocultar colunas de seleção e ícones" | "Non esportare le colonne di selezione e formato";
     static get HistoryActionLabel(): string;
     static get HistoryLabel(): string;
     static get ID_Hide(): "Ausblenden ID" | "Hide ID" | "Ocultar ID" | "Masquer ID" | "Nascondi ID";

package/lib/helper/SDKUI_Localizator.js

@@ -1497,6 +1497,16 @@ export class SDKUI_Localizator {
             default: return "Esporta solo i documenti selezionati";
         }
     }
+    static get ExportSelectedColumnsAndFormatLabel() {
+        switch (this._cultureID) {
+            case CultureIDs.De_DE: return "Ausgewählte Spalten und Format exportieren";
+            case CultureIDs.En_US: return "Export selected columns and format";
+            case CultureIDs.Es_ES: return "Exportar columnas seleccionadas y formato";
+            case CultureIDs.Fr_FR: return "Exporter les colonnes sélectionnées et le format";
+            case CultureIDs.Pt_PT: return "Exportar colunas selecionadas e formato";
+            default: return "Esporta le colonne selezione e formato";
+        }
+    }
     static get ExtractedBy() {
         switch (this._cultureID) {
             case CultureIDs.De_DE: return "Ausgezogen von";
@@ -2116,16 +2126,6 @@ export class SDKUI_Localizator {
             default: return "Nascondi ricerca";
         }
     }
-    static get HideSelectionColumnsAndIcons() {
-        switch (this._cultureID) {
-            case CultureIDs.De_DE: return "Auswahlspalten und Symbole ausblenden";
-            case CultureIDs.En_US: return "Hide selection columns and icons";
-            case CultureIDs.Es_ES: return "Ocultar columnas de selección e iconos";
-            case CultureIDs.Fr_FR: return "Masquer les colonnes de sélection et les icônes";
-            case CultureIDs.Pt_PT: return "Ocultar colunas de seleção e ícones";
-            default: return "Non esportare le colonne di selezione e formato";
-        }
-    }
     static get HistoryActionLabel() {
         switch (this._cultureID) {
             case CultureIDs.De_DE: return "Archivieren";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@topconsultnpm/sdkui-react-beta",
-    "version": "6.15.12",
+    "version": "6.15.13",
     "description": "",
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",