@gridsuite/commons-ui 0.107.1 → 0.109.0

package/dist/components/parameters/voltage-init/voltage-init-parameters-inline.js

@@ -0,0 +1,173 @@
+import { jsx, jsxs } from "react/jsx-runtime";
+import { useState, useCallback, useEffect } from "react";
+import { Box, Grid } from "@mui/material";
+import { useIntl, FormattedMessage } from "react-intl";
+import "../../../utils/types/equipmentType.js";
+import { updateVoltageInitParameters } from "../../../services/study.js";
+import { getVoltageInitParameters } from "../../../services/voltage-init.js";
+import "localized-countries";
+import "localized-countries/data/fr";
+import "localized-countries/data/en";
+import { useSnackMessage } from "../../../hooks/useSnackMessage.js";
+import "react-hook-form";
+import "../../inputs/reactHookForm/provider/CustomFormProvider.js";
+import { SubmitButton } from "../../inputs/reactHookForm/utils/SubmitButton.js";
+import "@mui/icons-material";
+import "yup";
+import "../../overflowableText/OverflowableText.js";
+import { DirectoryItemSelector } from "../../directoryItemSelector/DirectoryItemSelector.js";
+import "../../inputs/reactHookForm/agGridTable/BottomRightButtons.js";
+import "../../customAGGrid/customAggrid.js";
+import "ag-grid-community";
+import "react-papaparse";
+import "react-csv-downloader";
+import "../../inputs/reactHookForm/numbers/RangeInput.js";
+import { PopupConfirmationDialog } from "../../dialogs/popupConfirmationDialog/PopupConfirmationDialog.js";
+import "../../../utils/conversionUtils.js";
+import { ElementType } from "../../../utils/types/elementType.js";
+import "../../../utils/yupConfig.js";
+import "@react-querybuilder/material";
+import "../../filter/expert/expertFilterConstants.js";
+import "../../inputs/reactQueryBuilder/CustomReactQueryBuilder.js";
+import "uuid";
+import "../../inputs/reactQueryBuilder/PropertyValueEditor.js";
+import "react-querybuilder";
+import { LabelledButton } from "../common/parameters.js";
+import { CreateParameterDialog } from "../common/parameters-creation-dialog.js";
+import "../common/widget/parameter-line-slider.js";
+import "../common/limitreductions/columns-definitions.js";
+import { useVoltageInitParametersForm } from "./use-voltage-init-parameters-form.js";
+import { VoltageInitParametersForm } from "./voltage-init-parameters-form.js";
+import { fromVoltageInitParamsDataToFormValues, fromVoltageInitParametersFormToParamValues } from "./voltage-init-form-utils.js";
+import { DEFAULT_GENERAL_APPLY_MODIFICATIONS } from "./constants.js";
+import "../../dialogs/descriptionModificationDialog/DescriptionModificationDialog.js";
+import "../../dialogs/elementSaveDialog/ElementSaveDialog.js";
+function VoltageInitParametersInLine({
+  studyUuid,
+  setHaveDirtyFields,
+  voltageInitParameters
+}) {
+  const voltageInitMethods = useVoltageInitParametersForm({
+    parametersUuid: null,
+    name: null,
+    description: null,
+    studyUuid,
+    parameters: voltageInitParameters
+  });
+  const intl = useIntl();
+  const [openCreateParameterDialog, setOpenCreateParameterDialog] = useState(false);
+  const [openSelectParameterDialog, setOpenSelectParameterDialog] = useState(false);
+  const [openResetConfirmation, setOpenResetConfirmation] = useState(false);
+  const { snackError } = useSnackMessage();
+  const { formState, getValues, handleSubmit, reset, trigger } = voltageInitMethods.formMethods;
+  const handleLoadParameters = useCallback(
+    (newParams) => {
+      if (newParams == null ? void 0 : newParams.length) {
+        setOpenSelectParameterDialog(false);
+        const parametersUuid = newParams[0].id;
+        getVoltageInitParameters(parametersUuid).then((params) => {
+          reset(fromVoltageInitParamsDataToFormValues(params), {
+            keepDefaultValues: true
+          });
+        }).catch((error) => {
+          snackError({
+            messageTxt: error.message,
+            headerId: "paramsRetrievingError"
+          });
+        });
+      }
+      setOpenSelectParameterDialog(false);
+    },
+    [reset, snackError]
+  );
+  const resetVoltageInitParameters = useCallback(() => {
+    updateVoltageInitParameters(studyUuid, {
+      applyModifications: DEFAULT_GENERAL_APPLY_MODIFICATIONS,
+      computationParameters: null
+      // null means Reset
+    }).catch((error) => {
+      snackError({
+        messageTxt: error.message,
+        headerId: "updateVoltageInitParametersError"
+      });
+    });
+    setOpenResetConfirmation(false);
+  }, [studyUuid, snackError]);
+  const handleResetClick = useCallback(() => {
+    setOpenResetConfirmation(true);
+  }, []);
+  const handleCancelReset = useCallback(() => {
+    setOpenResetConfirmation(false);
+  }, []);
+  useEffect(() => {
+    setHaveDirtyFields(!!Object.keys(formState.dirtyFields).length);
+  }, [formState, setHaveDirtyFields]);
+  const handleOpenSaveDialog = useCallback(() => {
+    trigger().then((isValid) => {
+      if (isValid) {
+        setOpenCreateParameterDialog(true);
+      }
+    });
+  }, [trigger]);
+  return /* @__PURE__ */ jsx(
+    VoltageInitParametersForm,
+    {
+      voltageInitMethods,
+      renderActions: () => {
+        return /* @__PURE__ */ jsxs(Box, { children: [
+          /* @__PURE__ */ jsxs(Grid, { container: true, item: true, children: [
+            /* @__PURE__ */ jsx(
+              LabelledButton,
+              {
+                callback: () => setOpenSelectParameterDialog(true),
+                label: "settings.button.chooseSettings"
+              }
+            ),
+            /* @__PURE__ */ jsx(LabelledButton, { callback: handleOpenSaveDialog, label: "save" }),
+            /* @__PURE__ */ jsx(LabelledButton, { callback: handleResetClick, label: "resetToDefault" }),
+            /* @__PURE__ */ jsx(SubmitButton, { onClick: handleSubmit(voltageInitMethods.onSaveInline), variant: "outlined", children: /* @__PURE__ */ jsx(FormattedMessage, { id: "validate" }) })
+          ] }),
+          openCreateParameterDialog && /* @__PURE__ */ jsx(
+            CreateParameterDialog,
+            {
+              studyUuid,
+              open: openCreateParameterDialog,
+              onClose: () => setOpenCreateParameterDialog(false),
+              parameterValues: getValues,
+              parameterFormatter: (params) => fromVoltageInitParametersFormToParamValues(params).computationParameters,
+              parameterType: ElementType.VOLTAGE_INIT_PARAMETERS
+            }
+          ),
+          openSelectParameterDialog && /* @__PURE__ */ jsx(
+            DirectoryItemSelector,
+            {
+              open: openSelectParameterDialog,
+              onClose: handleLoadParameters,
+              types: [ElementType.VOLTAGE_INIT_PARAMETERS],
+              title: intl.formatMessage({
+                id: "showSelectParameterDialog"
+              }),
+              multiSelect: false,
+              validationButtonText: intl.formatMessage({
+                id: "validate"
+              })
+            }
+          ),
+          openResetConfirmation && /* @__PURE__ */ jsx(
+            PopupConfirmationDialog,
+            {
+              message: "resetParamsConfirmation",
+              validateButtonLabel: "validate",
+              openConfirmationPopup: openResetConfirmation,
+              setOpenConfirmationPopup: handleCancelReset,
+              handlePopupConfirmation: resetVoltageInitParameters
+            }
+          )
+        ] });
+      }
+    }
+  );
+}
+export {
+  VoltageInitParametersInLine
+};

package/dist/components/parameters/voltage-init/voltage-init.type.d.ts

@@ -0,0 +1,33 @@
+import { UUID } from 'crypto';
+import { FILTER_ID, FILTER_NAME, FILTERS, GENERATORS_SELECTION_TYPE, HIGH_VOLTAGE_LIMIT, LOW_VOLTAGE_LIMIT, REACTIVE_SLACKS_THRESHOLD, SHUNT_COMPENSATOR_ACTIVATION_THRESHOLD, SHUNT_COMPENSATORS_SELECTION_TYPE, TRANSFORMERS_SELECTION_TYPE, UPDATE_BUS_VOLTAGE, VARIABLE_Q_GENERATORS, VARIABLE_SHUNT_COMPENSATORS, VARIABLE_TRANSFORMERS, VOLTAGE_LIMITS_DEFAULT, VOLTAGE_LIMITS_MODIFICATION } from './constants';
+export declare enum EquipmentsSelectionType {
+    ALL_EXCEPT = "ALL_EXCEPT",
+    NONE_EXCEPT = "NONE_EXCEPT"
+}
+type FilterIdentifier = {
+    [FILTER_ID]: UUID;
+    [FILTER_NAME]: string;
+};
+type VoltageLimitParam = {
+    [FILTERS]: FilterIdentifier[];
+    [LOW_VOLTAGE_LIMIT]: number;
+    [HIGH_VOLTAGE_LIMIT]: number;
+};
+export type VoltageInitParameters = {
+    [UPDATE_BUS_VOLTAGE]: boolean;
+    [REACTIVE_SLACKS_THRESHOLD]: number;
+    [SHUNT_COMPENSATOR_ACTIVATION_THRESHOLD]: number;
+    [VOLTAGE_LIMITS_MODIFICATION]: VoltageLimitParam[];
+    [VOLTAGE_LIMITS_DEFAULT]: VoltageLimitParam[];
+    [GENERATORS_SELECTION_TYPE]: EquipmentsSelectionType;
+    [VARIABLE_Q_GENERATORS]: FilterIdentifier[];
+    [TRANSFORMERS_SELECTION_TYPE]: EquipmentsSelectionType;
+    [VARIABLE_TRANSFORMERS]: FilterIdentifier[];
+    [SHUNT_COMPENSATORS_SELECTION_TYPE]: EquipmentsSelectionType;
+    [VARIABLE_SHUNT_COMPENSATORS]: FilterIdentifier[];
+};
+export type VoltageInitStudyParameters = {
+    applyModifications: boolean;
+    computationParameters: VoltageInitParameters | null;
+};
+export {};

package/dist/components/parameters/voltage-init/voltage-init.type.js

@@ -0,0 +1,8 @@
+var EquipmentsSelectionType = /* @__PURE__ */ ((EquipmentsSelectionType2) => {
+  EquipmentsSelectionType2["ALL_EXCEPT"] = "ALL_EXCEPT";
+  EquipmentsSelectionType2["NONE_EXCEPT"] = "NONE_EXCEPT";
+  return EquipmentsSelectionType2;
+})(EquipmentsSelectionType || {});
+export {
+  EquipmentsSelectionType
+};

package/dist/components/parameters/voltage-init/voltage-limits-parameters.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2023, 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 VoltageLimitsParameters(): import("react/jsx-runtime").JSX.Element;

package/dist/components/parameters/voltage-init/voltage-limits-parameters.js

@@ -0,0 +1,188 @@
+import { jsx, jsxs } from "react/jsx-runtime";
+import { useMemo } from "react";
+import { useFieldArray } from "react-hook-form";
+import { Info } from "@mui/icons-material";
+import { Tooltip, IconButton, Grid, Typography } from "@mui/material";
+import { useIntl, FormattedMessage } from "react-intl";
+import { FILTERS, LOW_VOLTAGE_LIMIT, HIGH_VOLTAGE_LIMIT, VOLTAGE_LIMITS_MODIFICATION, VOLTAGE_LIMITS_DEFAULT } from "./constants.js";
+import "../../../utils/conversionUtils.js";
+import { ElementType } from "../../../utils/types/elementType.js";
+import { EquipmentType } from "../../../utils/types/equipmentType.js";
+import "../../../utils/yupConfig.js";
+import { VoltageAdornment } from "../common/constant.js";
+import "localized-countries";
+import "localized-countries/data/fr";
+import "localized-countries/data/en";
+import "notistack";
+import "../../inputs/reactHookForm/provider/CustomFormProvider.js";
+import "../../dialogs/descriptionModificationDialog/DescriptionModificationDialog.js";
+import "../../dialogs/elementSaveDialog/ElementSaveDialog.js";
+import "../../treeViewFinder/TreeViewFinder.js";
+import "yup";
+import "../../overflowableText/OverflowableText.js";
+import "../../inputs/reactHookForm/agGridTable/BottomRightButtons.js";
+import "../../customAGGrid/customAggrid.js";
+import "ag-grid-community";
+import "react-papaparse";
+import "react-csv-downloader";
+import "../../inputs/reactHookForm/numbers/RangeInput.js";
+import "@react-querybuilder/material";
+import "../../filter/expert/expertFilterConstants.js";
+import "../../inputs/reactQueryBuilder/CustomReactQueryBuilder.js";
+import "uuid";
+import "../../inputs/reactQueryBuilder/PropertyValueEditor.js";
+import "react-querybuilder";
+import "../common/widget/parameter-line-slider.js";
+import "../common/limitreductions/columns-definitions.js";
+import { DndTable } from "../../dnd-table/dnd-table.js";
+import { DndColumnType, SELECTED } from "../../dnd-table/dnd-table.type.js";
+function VoltageLimitsParameters() {
+  const intl = useIntl();
+  const VoltageLevelFilterTooltip = useMemo(() => {
+    return /* @__PURE__ */ jsx(
+      Tooltip,
+      {
+        title: intl.formatMessage({
+          id: "VoltageLevelFilterTooltip"
+        }),
+        children: /* @__PURE__ */ jsx(IconButton, { children: /* @__PURE__ */ jsx(Info, {}) })
+      }
+    );
+  }, [intl]);
+  const VOLTAGE_LIMITS_MODIFICATION_COLUMNS_DEFINITIONS = useMemo(() => {
+    return [
+      {
+        label: "VoltageLevelFilter",
+        dataKey: FILTERS,
+        initialValue: [],
+        editable: true,
+        type: DndColumnType.DIRECTORY_ITEMS,
+        equipmentTypes: [EquipmentType.VOLTAGE_LEVEL],
+        elementType: ElementType.FILTER,
+        titleId: "FiltersListsSelection",
+        extra: VoltageLevelFilterTooltip
+      },
+      {
+        label: "LowVoltageLimitAdjustment",
+        dataKey: LOW_VOLTAGE_LIMIT,
+        initialValue: null,
+        editable: true,
+        type: DndColumnType.NUMERIC,
+        adornment: VoltageAdornment,
+        textAlign: "right"
+      },
+      {
+        label: "HighVoltageLimitAdjustment",
+        dataKey: HIGH_VOLTAGE_LIMIT,
+        initialValue: null,
+        editable: true,
+        type: DndColumnType.NUMERIC,
+        adornment: VoltageAdornment,
+        textAlign: "right"
+      }
+    ].map((column) => ({
+      ...column,
+      label: intl.formatMessage({ id: column.label }).toLowerCase().replace(/^\w/, (c) => c.toUpperCase())
+    }));
+  }, [VoltageLevelFilterTooltip, intl]);
+  const VOLTAGE_LIMITS_DEFAULT_COLUMNS_DEFINITIONS = useMemo(() => {
+    return [
+      {
+        label: "VoltageLevelFilter",
+        dataKey: FILTERS,
+        initialValue: [],
+        editable: true,
+        type: DndColumnType.DIRECTORY_ITEMS,
+        equipmentTypes: [EquipmentType.VOLTAGE_LEVEL],
+        elementType: ElementType.FILTER,
+        titleId: "FiltersListsSelection",
+        extra: VoltageLevelFilterTooltip
+      },
+      {
+        label: "LowVoltageLimitDefault",
+        dataKey: LOW_VOLTAGE_LIMIT,
+        initialValue: null,
+        editable: true,
+        type: DndColumnType.NUMERIC,
+        adornment: VoltageAdornment,
+        textAlign: "right"
+      },
+      {
+        label: "HighVoltageLimitDefault",
+        dataKey: HIGH_VOLTAGE_LIMIT,
+        initialValue: null,
+        editable: true,
+        type: DndColumnType.NUMERIC,
+        adornment: VoltageAdornment,
+        textAlign: "right"
+      }
+    ].map((column) => ({
+      ...column,
+      label: intl.formatMessage({ id: column.label }).toLowerCase().replace(/^\w/, (c) => c.toUpperCase())
+    }));
+  }, [VoltageLevelFilterTooltip, intl]);
+  const newModificationRowData = useMemo(() => {
+    const newRowData = {};
+    newRowData[SELECTED] = false;
+    VOLTAGE_LIMITS_MODIFICATION_COLUMNS_DEFINITIONS.forEach((column) => {
+      newRowData[column.dataKey] = column.initialValue;
+    });
+    return newRowData;
+  }, [VOLTAGE_LIMITS_MODIFICATION_COLUMNS_DEFINITIONS]);
+  const createVoltageLimitModificationRows = () => [newModificationRowData];
+  const newDefaultRowData = useMemo(() => {
+    const newRowData = {};
+    newRowData[SELECTED] = false;
+    VOLTAGE_LIMITS_DEFAULT_COLUMNS_DEFINITIONS.forEach((column) => {
+      newRowData[column.dataKey] = column.initialValue;
+    });
+    return newRowData;
+  }, [VOLTAGE_LIMITS_DEFAULT_COLUMNS_DEFINITIONS]);
+  const createVoltageLimitDefaultRows = () => [newDefaultRowData];
+  const useVoltageLimitsModificationFieldArrayOutput = useFieldArray({
+    name: `${VOLTAGE_LIMITS_MODIFICATION}`
+  });
+  const useVoltageLimitsDefaultFieldArrayOutput = useFieldArray({
+    name: `${VOLTAGE_LIMITS_DEFAULT}`
+  });
+  return /* @__PURE__ */ jsxs(Grid, { container: true, children: [
+    /* @__PURE__ */ jsxs(Grid, { container: true, alignItems: "center", children: [
+      /* @__PURE__ */ jsx(Typography, { component: "span", variant: "h6", children: /* @__PURE__ */ jsx(FormattedMessage, { id: "AdjustExistingLimits" }) }),
+      /* @__PURE__ */ jsx(
+        Tooltip,
+        {
+          title: /* @__PURE__ */ jsx(FormattedMessage, { id: "AdjustExistingLimitsInfo" }),
+          placement: "right-start",
+          sx: { marginLeft: 1 },
+          children: /* @__PURE__ */ jsx(Info, {})
+        }
+      )
+    ] }),
+    /* @__PURE__ */ jsx(
+      DndTable,
+      {
+        arrayFormName: `${VOLTAGE_LIMITS_MODIFICATION}`,
+        columnsDefinition: VOLTAGE_LIMITS_MODIFICATION_COLUMNS_DEFINITIONS,
+        useFieldArrayOutput: useVoltageLimitsModificationFieldArrayOutput,
+        createRows: createVoltageLimitModificationRows,
+        tableHeight: 270,
+        withAddRowsDialog: false
+      }
+    ),
+    /* @__PURE__ */ jsx(Typography, { component: "span", variant: "h6", children: /* @__PURE__ */ jsx(FormattedMessage, { id: "SetDefaultLimits" }) }),
+    /* @__PURE__ */ jsx(
+      DndTable,
+      {
+        arrayFormName: `${VOLTAGE_LIMITS_DEFAULT}`,
+        columnsDefinition: VOLTAGE_LIMITS_DEFAULT_COLUMNS_DEFINITIONS,
+        useFieldArrayOutput: useVoltageLimitsDefaultFieldArrayOutput,
+        createRows: createVoltageLimitDefaultRows,
+        tableHeight: 270,
+        withAddRowsDialog: false
+      }
+    )
+  ] });
+}
+export {
+  VoltageLimitsParameters
+};