@gridsuite/commons-ui 0.110.0 → 0.111.0

package/dist/components/csvDownloader/csv-export.d.ts

@@ -0,0 +1,2 @@
+import { CsvExportProps } from './csv-export.type';
+export declare function CsvExport({ gridRef, columns, tableNamePrefix, tableName, disabled, skipColumnHeaders, language, exportDataAsCsv, }: CsvExportProps): JSX.Element;

package/dist/components/csvDownloader/csv-export.js

@@ -0,0 +1,23 @@
+import { jsx } from "react/jsx-runtime";
+import { useCallback } from "react";
+import { useCsvExport } from "./use-csv-export.js";
+import { ExportCsvButton } from "./export-csv-button.js";
+function CsvExport({
+  gridRef,
+  columns,
+  tableNamePrefix = "",
+  tableName,
+  disabled,
+  skipColumnHeaders = false,
+  language,
+  exportDataAsCsv
+}) {
+  const { downloadCSVData } = useCsvExport();
+  const download = useCallback(() => {
+    downloadCSVData({ gridRef, columns, tableName, tableNamePrefix, skipColumnHeaders, language, exportDataAsCsv });
+  }, [downloadCSVData, gridRef, columns, tableName, tableNamePrefix, skipColumnHeaders, language, exportDataAsCsv]);
+  return /* @__PURE__ */ jsx(ExportCsvButton, { disabled, onClick: download });
+}
+export {
+  CsvExport
+};

package/dist/components/csvDownloader/csv-export.type.d.ts

@@ -0,0 +1,16 @@
+import { RefObject } from 'react';
+import { AgGridReact } from 'ag-grid-react';
+import { ColDef, CsvExportParams } from 'ag-grid-community';
+import { GsLang } from '../../utils';
+export type CsvDownloadProps = {
+    gridRef: RefObject<AgGridReact>;
+    columns: ColDef[];
+    tableName: string;
+    tableNamePrefix?: string;
+    skipColumnHeaders?: boolean;
+    language: GsLang;
+    exportDataAsCsv: (params?: CsvExportParams) => void;
+};
+export type CsvExportProps = CsvDownloadProps & {
+    disabled: boolean;
+};

package/dist/components/csvDownloader/csv-export.type.js

@@ -0,0 +1 @@
+

package/dist/components/csvDownloader/export-csv-button.d.ts

@@ -0,0 +1,7 @@
+export interface ExportButtonProps {
+    disabled?: boolean;
+    onClick: () => void;
+    isDownloadLoading?: boolean;
+    isDownloadSuccessful?: boolean;
+}
+export declare function ExportCsvButton({ onClick, disabled, isDownloadLoading: isCsvLoading, isDownloadSuccessful, }: Readonly<ExportButtonProps>): import("react/jsx-runtime").JSX.Element;

package/dist/components/csvDownloader/export-csv-button.js

@@ -0,0 +1,33 @@
+import { jsxs, jsx } from "react/jsx-runtime";
+import { Box, IconButton, CircularProgress } from "@mui/material";
+import { FormattedMessage } from "react-intl";
+import { Check, GetApp } from "@mui/icons-material";
+function ExportCsvButton({
+  onClick,
+  disabled = false,
+  isDownloadLoading: isCsvLoading = false,
+  isDownloadSuccessful = false
+}) {
+  return /* @__PURE__ */ jsxs(Box, { sx: { display: "flex", alignItems: "center" }, children: [
+    /* @__PURE__ */ jsx(FormattedMessage, { id: "MuiVirtualizedTable/exportCSV" }),
+    /* @__PURE__ */ jsxs(Box, { sx: { position: "relative" }, children: [
+      /* @__PURE__ */ jsx(IconButton, { disabled, "aria-label": "exportCSVButton", onClick, children: isDownloadSuccessful ? /* @__PURE__ */ jsx(Check, {}) : /* @__PURE__ */ jsx(GetApp, {}) }),
+      isCsvLoading && /* @__PURE__ */ jsx(
+        CircularProgress,
+        {
+          size: 30,
+          sx: {
+            position: "absolute",
+            top: "50%",
+            left: "50%",
+            marginTop: "-15px",
+            marginLeft: "-15px"
+          }
+        }
+      )
+    ] })
+  ] });
+}
+export {
+  ExportCsvButton
+};

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

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 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/.
+ */
+export * from './csv-export';
+export * from './csv-export.type';
+export * from './export-csv-button';
+export * from './use-csv-export';

package/dist/components/csvDownloader/index.js

@@ -0,0 +1,8 @@
+import { CsvExport } from "./csv-export.js";
+import { ExportCsvButton } from "./export-csv-button.js";
+import { useCsvExport } from "./use-csv-export.js";
+export {
+  CsvExport,
+  ExportCsvButton,
+  useCsvExport
+};

package/dist/components/csvDownloader/use-csv-export.d.ts

@@ -0,0 +1,4 @@
+import { CsvDownloadProps } from './csv-export.type';
+export declare const useCsvExport: () => {
+    downloadCSVData: (props: CsvDownloadProps) => void;
+};

package/dist/components/csvDownloader/use-csv-export.js

@@ -0,0 +1,52 @@
+import { useCallback } from "react";
+import { useIntl } from "react-intl";
+import "../../utils/conversionUtils.js";
+import { LANG_FRENCH } from "../../utils/langs.js";
+import "react/jsx-runtime";
+import "@mui/icons-material";
+import "../../utils/types/equipmentType.js";
+import "../../utils/yupConfig.js";
+const NA_VALUE = "N/A";
+const formatNAValue = (value, intl) => {
+  return value === NA_VALUE ? intl.formatMessage({ id: "export/undefined" }) : value;
+};
+const useCsvExport = () => {
+  const intl = useIntl();
+  const getCSVFilename = useCallback((tableName) => {
+    return tableName.trim().replace(/[\\/:"*?<>|\s]/g, "-").substring(0, 27);
+  }, []);
+  const downloadCSVData = useCallback(
+    (props) => {
+      const hasColId = (colId) => {
+        return colId !== void 0;
+      };
+      const processCell = (params) => {
+        if (params.column.getColId() === "limitName") {
+          return formatNAValue(params.value, intl);
+        }
+        if (props.language === LANG_FRENCH && typeof params.value === "number") {
+          return params.value.toString().replace(".", ",");
+        }
+        return params.value;
+      };
+      const prefix = props.tableNamePrefix ?? "";
+      props.exportDataAsCsv({
+        suppressQuotes: false,
+        columnSeparator: props.language === LANG_FRENCH ? ";" : ",",
+        columnKeys: props.columns.map((col) => col.colId).filter(hasColId),
+        skipColumnHeaders: props.skipColumnHeaders,
+        processHeaderCallback: (params) => {
+          var _a;
+          return ((_a = params.column.getColDef().headerComponentParams) == null ? void 0 : _a.displayName) ?? params.column.getColDef().headerName ?? params.column.getColId();
+        },
+        fileName: prefix.concat(getCSVFilename(props.tableName)),
+        processCellCallback: processCell
+      });
+    },
+    [getCSVFilename, intl]
+  );
+  return { downloadCSVData };
+};
+export {
+  useCsvExport
+};

package/dist/components/index.d.ts

@@ -8,6 +8,7 @@ export * from './announcement';
 export * from './authentication';
 export * from './cardErrorBoundary';
 export * from './checkBoxList';
+export * from './csvDownloader';
 export * from './customAGGrid';
 export * from './dialogs';
 export * from './directoryItemSelector/DirectoryItemSelector';

package/dist/components/index.js

@@ -14,6 +14,9 @@ import { dispatchUser, getPreLoginPath, handleSigninCallback, handleSilentRenewC
 import { UserManagerMock } from "./authentication/utils/userManagerMock.js";
 import { CardErrorBoundary } from "./cardErrorBoundary/CardErrorBoundary.js";
 import { CheckBoxList } from "./checkBoxList/CheckBoxList.js";
+import { CsvExport } from "./csvDownloader/csv-export.js";
+import { ExportCsvButton } from "./csvDownloader/export-csv-button.js";
+import { useCsvExport } from "./csvDownloader/use-csv-export.js";
 import { CUSTOM_AGGRID_THEME, styles } from "./customAGGrid/customAggrid.style.js";
 import { CustomAGGrid } from "./customAGGrid/customAggrid.js";
 import { CustomMuiDialog, unscrollableDialogStyles } from "./dialogs/customMuiDialog/CustomMuiDialog.js";
@@ -197,6 +200,7 @@ export {
   CountryValueEditor,
   CreateParameterDialog,
   CriteriaBasedForm,
+  CsvExport,
   CsvUploader,
   CustomAGGrid,
   CustomAgGridTable,
@@ -252,6 +256,7 @@ export {
   ExpertFilterForm,
   ExplicitNamingFilterEditionDialog,
   ExplicitNamingFilterForm,
+  ExportCsvButton,
   FIELDS_OPTIONS,
   FILTERS,
   FILTER_EQUIPMENTS,
@@ -487,6 +492,7 @@ export {
   toFormValuesLimitReductions,
   unscrollableDialogStyles,
   useConvertValue,
+  useCsvExport,
   useCustomFormContext,
   useElementSearch,
   useGlobalAnnouncement,

package/dist/index.js

@@ -15,6 +15,9 @@ import { dispatchUser, getPreLoginPath, handleSigninCallback, handleSilentRenewC
 import { UserManagerMock } from "./components/authentication/utils/userManagerMock.js";
 import { CardErrorBoundary } from "./components/cardErrorBoundary/CardErrorBoundary.js";
 import { CheckBoxList } from "./components/checkBoxList/CheckBoxList.js";
+import { CsvExport } from "./components/csvDownloader/csv-export.js";
+import { ExportCsvButton } from "./components/csvDownloader/export-csv-button.js";
+import { useCsvExport } from "./components/csvDownloader/use-csv-export.js";
 import { CUSTOM_AGGRID_THEME, styles } from "./components/customAGGrid/customAggrid.style.js";
 import { CustomAGGrid } from "./components/customAGGrid/customAggrid.js";
 import { CustomMuiDialog, unscrollableDialogStyles } from "./components/dialogs/customMuiDialog/CustomMuiDialog.js";
@@ -301,6 +304,7 @@ export {
   CountryValueEditor,
   CreateParameterDialog,
   CriteriaBasedForm,
+  CsvExport,
   CsvUploader,
   CustomAGGrid,
   CustomAgGridTable,
@@ -364,6 +368,7 @@ export {
   ExpertFilterForm,
   ExplicitNamingFilterEditionDialog,
   ExplicitNamingFilterForm,
+  ExportCsvButton,
   ExtendedEquipmentType,
   FIELDS_OPTIONS,
   FILTERS,
@@ -786,6 +791,7 @@ export {
   updateVoltageInitParameters,
   useConfidentialityWarning,
   useConvertValue,
+  useCsvExport,
   useCustomFormContext,
   useDebounce,
   useElementSearch,

package/dist/translations/en/tableEn.d.ts

@@ -6,4 +6,5 @@
  */
 export declare const tableEn: {
     'MuiVirtualizedTable/exportCSV': string;
+    'export/undefined': string;
 };

package/dist/translations/en/tableEn.js

@@ -1,5 +1,6 @@
 const tableEn = {
-  "MuiVirtualizedTable/exportCSV": "Download CSV"
+  "MuiVirtualizedTable/exportCSV": "Download CSV",
+  "export/undefined": "Undefined"
 };
 export {
   tableEn

package/dist/translations/fr/tableFr.d.ts

@@ -6,4 +6,5 @@
  */
 export declare const tableFr: {
     'MuiVirtualizedTable/exportCSV': string;
+    'export/undefined': string;
 };

package/dist/translations/fr/tableFr.js

@@ -1,5 +1,6 @@
 const tableFr = {
-  "MuiVirtualizedTable/exportCSV": "Télécharger un CSV"
+  "MuiVirtualizedTable/exportCSV": "Télécharger un CSV",
+  "export/undefined": "Non défini"
 };
 export {
   tableFr

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gridsuite/commons-ui",
-    "version": "0.110.0",
+    "version": "0.111.0",
     "description": "common react components for gridsuite applications",
     "author": "gridsuite team",
     "homepage": "https://github.com/gridsuite",