@gridsuite/commons-ui 0.139.0 → 0.140.0

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

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

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

@@ -10,29 +10,20 @@ function CsvExport({
   skipColumnHeaders = false,
   skipPinnedBottom = false,
   language,
-  exportDataAsCsv
+  getData
 }) {
-  const { downloadCSVData } = useCsvExport();
+  const csvExport = useCsvExport();
   const download = useCallback(() => {
-    downloadCSVData({
+    csvExport.getData({
       columns,
       tableName,
       tableNamePrefix,
       skipColumnHeaders,
       skipPinnedBottom,
       language,
-      exportDataAsCsv
+      getData
     });
-  }, [
-    downloadCSVData,
-    columns,
-    tableName,
-    tableNamePrefix,
-    skipColumnHeaders,
-    skipPinnedBottom,
-    language,
-    exportDataAsCsv
-  ]);
+  }, [columns, csvExport, tableName, tableNamePrefix, skipColumnHeaders, skipPinnedBottom, language, getData]);
   return /* @__PURE__ */ jsx(ExportCsvButton, { disabled, onClick: download });
 }
 export {

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

@@ -7,7 +7,7 @@ export type CsvDownloadProps = {
     skipColumnHeaders?: boolean;
     skipPinnedBottom?: boolean;
     language: GsLang;
-    exportDataAsCsv: (params?: CsvExportParams) => void;
+    getData: (params?: CsvExportParams) => string | undefined | void;
 };
 export type CsvExportProps = CsvDownloadProps & {
     disabled: boolean;

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

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

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

@@ -7,30 +7,30 @@ 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(
+  const getData = useCallback(
     (props) => {
+      const formatNAValue = (value) => {
+        return value === NA_VALUE ? intl.formatMessage({ id: "export/undefined" }) : value;
+      };
       const hasColId = (colId) => {
         return colId !== void 0;
       };
       const processCell = (params) => {
         if (params.column.getColId() === "limitName") {
-          return formatNAValue(params.value, intl);
+          return formatNAValue(params.value);
         }
         if (props.language === LANG_FRENCH && typeof params.value === "number") {
           return params.value.toString().replace(".", ",");
         }
         return params.value;
       };
+      const getCSVFilename = (tableName) => {
+        return tableName.trim().replace(/[\\/:"*?<>|\s]/g, "-").substring(0, 27);
+      };
       const prefix = props.tableNamePrefix ?? "";
-      props.exportDataAsCsv({
+      return props.getData({
         suppressQuotes: false,
         skipPinnedBottom: props.skipPinnedBottom,
         columnSeparator: props.language === LANG_FRENCH ? ";" : ",",
@@ -41,9 +41,9 @@ const useCsvExport = () => {
         processCellCallback: processCell
       });
     },
-    [getCSVFilename, intl]
+    [intl]
   );
-  return { downloadCSVData };
+  return { getData };
 };
 export {
   useCsvExport

package/dist/components/filter/FilterCreationDialog.js

@@ -111,7 +111,8 @@ function FilterCreationDialog({
           creation: true,
           activeDirectory,
           filterType,
-          sourceFilterForExplicitNamingConversion
+          sourceFilterForExplicitNamingConversion,
+          language
         }
       )
     }

package/dist/components/filter/FilterForm.d.ts

@@ -1,2 +1,16 @@
-import { FilterFormProps } from './HeaderFilterForm';
-export declare function FilterForm({ sourceFilterForExplicitNamingConversion, creation, activeDirectory, filterType, }: Readonly<FilterFormProps>): import("react/jsx-runtime").JSX.Element;
+import { UUID } from 'node:crypto';
+import { GsLang } from '../../utils';
+export interface FilterFormProps {
+    creation?: boolean;
+    activeDirectory?: UUID;
+    filterType?: {
+        id: string;
+        label: string;
+    };
+    sourceFilterForExplicitNamingConversion?: {
+        id: UUID;
+        equipmentType: string;
+    };
+    language?: GsLang;
+}
+export declare function FilterForm({ sourceFilterForExplicitNamingConversion, creation, activeDirectory, filterType, language, }: Readonly<FilterFormProps>): import("react/jsx-runtime").JSX.Element;

package/dist/components/filter/FilterForm.js

@@ -20,21 +20,16 @@ function FilterForm({
   sourceFilterForExplicitNamingConversion,
   creation,
   activeDirectory,
-  filterType
+  filterType,
+  language
 }) {
   return /* @__PURE__ */ jsxs(Fragment, { children: [
-    /* @__PURE__ */ jsx(Box, { sx: unscrollableDialogStyles.unscrollableHeader, children: /* @__PURE__ */ jsx(
-      HeaderFilterForm,
-      {
-        creation,
-        activeDirectory,
-        sourceFilterForExplicitNamingConversion
-      }
-    ) }),
+    /* @__PURE__ */ jsx(Box, { sx: unscrollableDialogStyles.unscrollableHeader, children: /* @__PURE__ */ jsx(HeaderFilterForm, { creation, activeDirectory }) }),
     filterType?.id === FilterType.EXPLICIT_NAMING.id && /* @__PURE__ */ jsx(
       ExplicitNamingFilterForm,
       {
-        sourceFilterForExplicitNamingConversion
+        sourceFilterForExplicitNamingConversion,
+        language
       }
     ),
     filterType?.id === FilterType.EXPERT.id && /* @__PURE__ */ jsx(ExpertFilterForm, {})

package/dist/components/filter/HeaderFilterForm.d.ts

@@ -10,21 +10,17 @@ export declare const filterStyles: {
         readonly width: "50%";
     };
 };
-export interface FilterFormProps {
+export declare const HeaderFilterSchema: {
+    name: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+    equipmentType: yup.StringSchema<string, yup.AnyObject, undefined, "">;
+    description: yup.StringSchema<string | undefined, yup.AnyObject, undefined, "">;
+};
+export interface HeaderFilterFormProps {
     creation?: boolean;
     activeDirectory?: UUID;
-    filterType?: {
-        id: string;
-        label: string;
-    };
     sourceFilterForExplicitNamingConversion?: {
         id: UUID;
         equipmentType: string;
     };
 }
-export declare const HeaderFilterSchema: {
-    name: yup.StringSchema<string, yup.AnyObject, undefined, "">;
-    equipmentType: yup.StringSchema<string, yup.AnyObject, undefined, "">;
-    description: yup.StringSchema<string | undefined, yup.AnyObject, undefined, "">;
-};
-export declare function HeaderFilterForm({ creation, activeDirectory }: Readonly<FilterFormProps>): import("react/jsx-runtime").JSX.Element;
+export declare function HeaderFilterForm({ creation, activeDirectory }: Readonly<HeaderFilterFormProps>): import("react/jsx-runtime").JSX.Element;

package/dist/components/filter/explicitNaming/ExplicitNamingFilterEditionDialog.js

@@ -102,7 +102,14 @@ function ExplicitNamingFilterEditionDialog({
       isDataFetching: dataFetchStatus === FetchStatus.FETCHING,
       language,
       unscrollableFullHeight: true,
-      children: isDataReady && /* @__PURE__ */ jsx(FilterForm, { activeDirectory, filterType: FilterType.EXPLICIT_NAMING })
+      children: isDataReady && /* @__PURE__ */ jsx(
+        FilterForm,
+        {
+          activeDirectory,
+          filterType: FilterType.EXPLICIT_NAMING,
+          language
+        }
+      )
     }
   );
 }

package/dist/components/filter/explicitNaming/ExplicitNamingFilterForm.d.ts

@@ -2,6 +2,7 @@ import { UUID } from 'node:crypto';
 import { FieldConstants } from '../../../utils/constants/fieldConstants';
 import { default as yup } from '../../../utils/yupConfig';
 import { DISTRIBUTION_KEY } from '../constants/FilterConstants';
+import { GsLang } from '../../../utils';
 export declare const explicitNamingFilterSchema: {
     filterEquipmentsAttributes: yup.ArraySchema<{
         equipmentID?: string | null | undefined;
@@ -22,6 +23,7 @@ export interface FilterForExplicitConversionProps {
 }
 interface ExplicitNamingFilterFormProps {
     sourceFilterForExplicitNamingConversion?: FilterForExplicitConversionProps;
+    language?: GsLang;
 }
-export declare function ExplicitNamingFilterForm({ sourceFilterForExplicitNamingConversion }: ExplicitNamingFilterFormProps): import("react/jsx-runtime").JSX.Element;
+export declare function ExplicitNamingFilterForm({ sourceFilterForExplicitNamingConversion, language, }: Readonly<ExplicitNamingFilterFormProps>): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/filter/explicitNaming/ExplicitNamingFilterForm.js

@@ -23,7 +23,10 @@ import "../../dialogs/descriptionModificationDialog/DescriptionModificationDialo
 import "../../dialogs/elementSaveDialog/ElementSaveDialog.js";
 import { FILTER_EQUIPMENTS_ATTRIBUTES } from "./ExplicitNamingFilterConstants.js";
 import { filterStyles } from "../HeaderFilterForm.js";
+import "../../../utils/conversionUtils.js";
 import { snackWithFallback } from "../../../utils/error.js";
+import "@mui/icons-material";
+import "../../../utils/types/equipmentType.js";
 import * as yup from "yup";
 function isGeneratorOrLoad(equipmentType) {
   return equipmentType === Generator.type || equipmentType === Load.type;
@@ -58,7 +61,10 @@ function getExplicitNamingFilterEmptyFormData() {
     [FILTER_EQUIPMENTS_ATTRIBUTES]: makeDefaultTableRows()
   };
 }
-function ExplicitNamingFilterForm({ sourceFilterForExplicitNamingConversion }) {
+function ExplicitNamingFilterForm({
+  sourceFilterForExplicitNamingConversion,
+  language
+}) {
   const intl = useIntl();
   const { snackError } = useSnackMessage();
   const { getValues, setValue } = useFormContext();
@@ -203,7 +209,8 @@ function ExplicitNamingFilterForm({ sourceFilterForExplicitNamingConversion }) {
             id: "filterCsvFileName"
           }),
           fileHeaders: csvFileHeaders,
-          getDataFromCsv: getDataFromCsvFile
+          getDataFromCsv: getDataFromCsvFile,
+          language
         },
         cssProps: {
           padding: 1,

package/dist/index.js

@@ -213,6 +213,7 @@ import { areArrayElementsUnique, isObjectEmpty, keyGenerator } from "./utils/fun
 import { LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM } from "./utils/langs.js";
 import { getFileIcon } from "./utils/mapper/getFileIcon.js";
 import { equipmentTypesForPredefinedPropertiesMapper } from "./utils/mapper/equipmentTypesForPredefinedPropertiesMapper.js";
+import { copyToClipboard } from "./utils/navigator-clipboard.js";
 import { NotificationsUrlKeys, PREFIX_CONFIG_NOTIFICATION_WS, PREFIX_DIRECTORY_NOTIFICATION_WS, PREFIX_STUDY_NOTIFICATION_WS } from "./utils/constants/notificationsProvider.js";
 import { DARK_THEME, LIGHT_THEME, makeComposeClasses, mergeSx, toNestedGlobalSelectors } from "./utils/styles.js";
 import { CustomError, formatMessageValues } from "./utils/types/CustomError.js";
@@ -687,6 +688,7 @@ export {
   componentsFr,
   convertInputValue,
   convertOutputValue,
+  copyToClipboard,
   countRules,
   createFilter,
   createParameter,

package/dist/utils/index.d.ts

@@ -11,6 +11,7 @@ export * from './error';
 export * from './functions';
 export * from './langs';
 export * from './mapper';
+export * from './navigator-clipboard';
 export * from './constants/notificationsProvider';
 export * from './styles';
 export * from './types';

package/dist/utils/index.js

@@ -11,6 +11,7 @@ import { areArrayElementsUnique, isObjectEmpty, keyGenerator } from "./functions
 import { LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM } from "./langs.js";
 import { getFileIcon } from "./mapper/getFileIcon.js";
 import { equipmentTypesForPredefinedPropertiesMapper } from "./mapper/equipmentTypesForPredefinedPropertiesMapper.js";
+import { copyToClipboard } from "./navigator-clipboard.js";
 import { NotificationsUrlKeys, PREFIX_CONFIG_NOTIFICATION_WS, PREFIX_DIRECTORY_NOTIFICATION_WS, PREFIX_STUDY_NOTIFICATION_WS } from "./constants/notificationsProvider.js";
 import { DARK_THEME, LIGHT_THEME, makeComposeClasses, mergeSx, toNestedGlobalSelectors } from "./styles.js";
 import { CustomError, formatMessageValues } from "./types/CustomError.js";
@@ -102,6 +103,7 @@ export {
   catchErrorHandler,
   convertInputValue,
   convertOutputValue,
+  copyToClipboard,
   equalsArray,
   equipmentStyles,
   equipmentTypesForPredefinedPropertiesMapper,

package/dist/utils/navigator-clipboard.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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 declare function copyToClipboard(valueToCopy: string, onSuccess?: () => void, onError?: () => void): void;

package/dist/utils/navigator-clipboard.js

@@ -0,0 +1,16 @@
+function copyToClipboard(valueToCopy, onSuccess, onError) {
+  if ("clipboard" in navigator) {
+    navigator.clipboard.writeText(valueToCopy).then(() => {
+      if (onSuccess) onSuccess();
+    }).catch((error) => {
+      console.error("Clipboard copy error: ", error);
+      if (onError) onError();
+    });
+  } else {
+    console.error("navigator.clipboard is not supported by your current navigator");
+    if (onError) onError();
+  }
+}
+export {
+  copyToClipboard
+};

package/package.json

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