@gridsuite/commons-ui 0.142.0 → 0.144.0

package/dist/components/parameters/short-circuit/short-circuit-parameters-dialog.js

@@ -13,11 +13,13 @@ import "notistack";
 import "../../../utils/conversionUtils.js";
 import "../../../utils/types/equipmentType.js";
 import "../../../utils/yupConfig.js";
+import { getShortCircuitSpecificParametersDescription, updateShortCircuitParameters, fetchShortCircuitParameters } from "../../../services/short-circuit-analysis.js";
 import { NameElementEditorForm } from "../common/name-element-editor/name-element-editor-form.js";
 import "../../overflowableText/OverflowableText.js";
 import "localized-countries";
 import "localized-countries/data/fr";
 import "localized-countries/data/en";
+import { useParametersBackend, OptionalServicesStatus } from "../../../hooks/use-parameters-backend.js";
 import "../../inputs/reactHookForm/provider/CustomFormProvider.js";
 import "yup";
 import "../../inputs/reactHookForm/agGridTable/BottomRightButtons.js";
@@ -34,6 +36,9 @@ import "../../inputs/reactQueryBuilder/PropertyValueEditor.js";
 import "react-querybuilder";
 import { useShortCircuitParametersForm } from "./use-short-circuit-parameters-form.js";
 import { ShortCircuitParametersForm } from "./short-circuit-parameters-form.js";
+import { ComputingType } from "../common/computing-type.js";
+import "../common/widget/parameter-line-slider.js";
+import "../common/limitreductions/columns-definitions.js";
 function ShortCircuitParametersEditionDialog({
   id,
   open,
@@ -42,15 +47,28 @@ function ShortCircuitParametersEditionDialog({
   name,
   description,
   activeDirectory,
+  user,
   language,
   enableDeveloperMode
 }) {
+  const parametersBackend = useParametersBackend(
+    user,
+    id,
+    ComputingType.SHORT_CIRCUIT,
+    OptionalServicesStatus.Up,
+    null,
+    null,
+    null,
+    null,
+    fetchShortCircuitParameters,
+    updateShortCircuitParameters,
+    getShortCircuitSpecificParametersDescription
+  );
   const shortCircuitMethods = useShortCircuitParametersForm({
+    parametersBackend,
     parametersUuid: id,
     name,
-    description,
-    studyUuid: null,
-    studyShortCircuitParameters: null
+    description
   });
   const {
     formState: { errors, dirtyFields }
@@ -62,6 +80,7 @@ function ShortCircuitParametersEditionDialog({
       open,
       onClose,
       onSave: shortCircuitMethods.onSaveDialog,
+      onValidationError: shortCircuitMethods.onValidationError,
       formSchema: shortCircuitMethods.formSchema,
       formMethods: shortCircuitMethods.formMethods,
       titleId,
@@ -72,6 +91,7 @@ function ShortCircuitParametersEditionDialog({
         ShortCircuitParametersForm,
         {
           shortCircuitMethods,
+          enableDeveloperMode,
           renderTitleFields: () => {
             return /* @__PURE__ */ jsx(
               NameElementEditorForm,
@@ -81,8 +101,7 @@ function ShortCircuitParametersEditionDialog({
                 elementType: ElementType.SHORT_CIRCUIT_PARAMETERS
               }
             );
-          },
-          enableDeveloperMode: enableDeveloperMode ?? false
+          }
         }
       )
     }

package/dist/components/parameters/short-circuit/short-circuit-parameters-form.js

@@ -2,12 +2,12 @@ import { jsx, jsxs } from "react/jsx-runtime";
 import { Box, Grid, LinearProgress } from "@mui/material";
 import "react-intl";
 import "../../overflowableText/OverflowableText.js";
-import "react";
-import "react-hook-form";
-import "../../../utils/types/equipmentType.js";
 import "../../../utils/conversionUtils.js";
 import "@mui/icons-material";
+import "../../../utils/types/equipmentType.js";
 import "../../../utils/yupConfig.js";
+import "react";
+import "react-hook-form";
 import "localized-countries";
 import "localized-countries/data/fr";
 import "localized-countries/data/en";
@@ -35,7 +35,7 @@ function ShortCircuitParametersForm({
   renderActions,
   enableDeveloperMode
 }) {
-  const { formMethods, formSchema, paramsLoading, resetAll } = shortCircuitMethods;
+  const { formMethods, formSchema, paramsLoaded, resetAll } = shortCircuitMethods;
   return /* @__PURE__ */ jsx(CustomFormProvider, { validationSchema: formSchema, ...formMethods, removeOptional: true, children: /* @__PURE__ */ jsxs(
     Box,
     {
@@ -47,7 +47,7 @@ function ShortCircuitParametersForm({
       },
       children: [
         /* @__PURE__ */ jsx(Grid, { item: true, container: true, direction: "column", children: renderTitleFields?.() }),
-        paramsLoading ? /* @__PURE__ */ jsx(LinearProgress, {}) : /* @__PURE__ */ jsx(Grid, { sx: parametersStyles.scrollableGrid, children: /* @__PURE__ */ jsx(ShortCircuitFields, { enableDeveloperMode, resetAll }) }),
+        paramsLoaded ? /* @__PURE__ */ jsx(Grid, { sx: parametersStyles.scrollableGrid, children: /* @__PURE__ */ jsx(ShortCircuitFields, { enableDeveloperMode, resetAll }) }) : /* @__PURE__ */ jsx(LinearProgress, {}),
         /* @__PURE__ */ jsx(
           Grid,
           {

package/dist/components/parameters/short-circuit/short-circuit-parameters-inline.d.ts

@@ -1,8 +1,9 @@
 import { UUID } from 'node:crypto';
-import { ShortCircuitParametersInfos } from './short-circuit-parameters.type';
-export declare function ShortCircuitParametersInLine({ studyUuid, setHaveDirtyFields, shortCircuitParameters, enableDeveloperMode, }: Readonly<{
+import { UseParametersBackendReturnProps } from '../../../utils';
+import { ComputingType } from '../common';
+export declare function ShortCircuitParametersInLine({ studyUuid, setHaveDirtyFields, parametersBackend, enableDeveloperMode, }: Readonly<{
     studyUuid: UUID | null;
     setHaveDirtyFields: (isDirty: boolean) => void;
-    shortCircuitParameters: ShortCircuitParametersInfos | null;
+    parametersBackend: UseParametersBackendReturnProps<ComputingType.SHORT_CIRCUIT>;
     enableDeveloperMode: boolean;
 }>): import("react/jsx-runtime").JSX.Element;

package/dist/components/parameters/short-circuit/short-circuit-parameters-inline.js

@@ -8,6 +8,7 @@ import { snackWithFallback } from "../../../utils/error.js";
 import "@mui/icons-material";
 import { ElementType } from "../../../utils/types/elementType.js";
 import "../../../utils/yupConfig.js";
+import { fetchShortCircuitParameters } from "../../../services/short-circuit-analysis.js";
 import "localized-countries";
 import "localized-countries/data/fr";
 import "localized-countries/data/en";
@@ -34,60 +35,42 @@ 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 { SHORT_CIRCUIT_WITH_FEEDER_RESULT, SHORT_CIRCUIT_PREDEFINED_PARAMS, SHORT_CIRCUIT_WITH_LOADS, SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS, SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, InitialVoltage } from "./constants.js";
-import { fetchShortCircuitParameters } from "../../../services/short-circuit-analysis.js";
 import { ShortCircuitParametersForm } from "./short-circuit-parameters-form.js";
 import { useShortCircuitParametersForm } from "./use-short-circuit-parameters-form.js";
 function ShortCircuitParametersInLine({
   studyUuid,
   setHaveDirtyFields,
-  shortCircuitParameters,
+  parametersBackend,
   enableDeveloperMode
 }) {
   const shortCircuitMethods = useShortCircuitParametersForm({
+    parametersBackend,
     parametersUuid: null,
     name: null,
-    description: null,
-    studyUuid,
-    studyShortCircuitParameters: shortCircuitParameters
+    description: null
   });
   const intl = useIntl();
   const [openCreateParameterDialog, setOpenCreateParameterDialog] = useState(false);
   const [openSelectParameterDialog, setOpenSelectParameterDialog] = useState(false);
   const { snackError } = useSnackMessage();
-  const { getCurrentValues, formMethods } = shortCircuitMethods;
-  const { setValue, formState, handleSubmit } = formMethods;
-  const replaceFormValues = useCallback(
-    (param) => {
-      const dirty = { shouldDirty: true };
-      setValue(SHORT_CIRCUIT_WITH_FEEDER_RESULT, param.parameters.withFeederResult, dirty);
-      setValue(SHORT_CIRCUIT_PREDEFINED_PARAMS, param.predefinedParameters, dirty);
-      setValue(SHORT_CIRCUIT_WITH_LOADS, param.parameters.withLoads, dirty);
-      setValue(SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS, param.parameters.withVSCConverterStations, dirty);
-      setValue(SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, param.parameters.withShuntCompensators, dirty);
-      setValue(SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, !param.parameters.withNeutralPosition, dirty);
-      setValue(
-        SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE,
-        param.parameters.initialVoltageProfileMode === InitialVoltage.CONFIGURED ? InitialVoltage.CEI909 : param.parameters.initialVoltageProfileMode,
-        dirty
-      );
-    },
-    [setValue]
-  );
+  const { formMethods } = shortCircuitMethods;
+  const { getValues, formState, handleSubmit, reset } = formMethods;
   const handleLoadParameters = useCallback(
     (newParams) => {
       if (newParams?.length) {
         setOpenSelectParameterDialog(false);
         const paramUuid = newParams[0].id;
         fetchShortCircuitParameters(paramUuid).then((parameters) => {
-          replaceFormValues(parameters);
+          reset(shortCircuitMethods.toShortCircuitFormValues(parameters), {
+            keepDefaultValues: true
+          });
         }).catch((error) => {
           snackWithFallback(snackError, error, { headerId: "paramsRetrievingError" });
         });
       }
       setOpenSelectParameterDialog(false);
     },
-    [snackError, replaceFormValues]
+    [snackError, shortCircuitMethods, reset]
   );
   useEffect(() => {
     setHaveDirtyFields(!!Object.keys(formState.dirtyFields).length);
@@ -108,7 +91,17 @@ function ShortCircuitParametersInLine({
               }
             ),
             /* @__PURE__ */ jsx(LabelledButton, { callback: () => setOpenCreateParameterDialog(true), label: "save" }),
-            /* @__PURE__ */ jsx(SubmitButton, { onClick: handleSubmit(shortCircuitMethods.onSaveInline), variant: "outlined", children: /* @__PURE__ */ jsx(FormattedMessage, { id: "validate" }) })
+            /* @__PURE__ */ jsx(
+              SubmitButton,
+              {
+                onClick: handleSubmit(
+                  shortCircuitMethods.onSaveInline,
+                  shortCircuitMethods.onValidationError
+                ),
+                variant: "outlined",
+                children: /* @__PURE__ */ jsx(FormattedMessage, { id: "validate" })
+              }
+            )
           ] }),
           openCreateParameterDialog && /* @__PURE__ */ jsx(
             CreateParameterDialog,
@@ -116,7 +109,7 @@ function ShortCircuitParametersInLine({
               studyUuid,
               open: openCreateParameterDialog,
               onClose: () => setOpenCreateParameterDialog(false),
-              parameterValues: () => getCurrentValues(),
+              parameterValues: () => shortCircuitMethods.formatNewParams(getValues()),
               parameterFormatter: (newParams) => newParams,
               parameterType: ElementType.SHORT_CIRCUIT_PARAMETERS
             }

package/dist/components/parameters/short-circuit/short-circuit-parameters-utils.d.ts

@@ -0,0 +1,27 @@
+import { InitialVoltage, PredefinedParameters } from './constants';
+import { default as yup } from '../../../utils/yupConfig';
+import { SpecificParametersValues } from '../../../utils';
+export declare const getCommonShortCircuitParametersFormSchema: () => yup.ObjectSchema<{
+    commonParameters: {
+        withFeederResult: NonNullable<boolean | undefined>;
+        withLoads: NonNullable<boolean | undefined>;
+        withVSCConverterStations: NonNullable<boolean | undefined>;
+        withShuntCompensators: NonNullable<boolean | undefined>;
+        withNeutralPosition: NonNullable<boolean | undefined>;
+        initialVoltageProfileMode: NonNullable<InitialVoltage | undefined>;
+    };
+}, yup.AnyObject, {
+    commonParameters: {
+        withFeederResult: undefined;
+        withLoads: undefined;
+        withVSCConverterStations: undefined;
+        withShuntCompensators: undefined;
+        withNeutralPosition: undefined;
+        initialVoltageProfileMode: undefined;
+    };
+}, "">;
+export declare const resetSpecificParameters: (specificDefaultValues: SpecificParametersValues, predefinedParameter: PredefinedParameters) => {
+    onlyStartedGenerators: boolean;
+} | {
+    [x: string]: any;
+};

package/dist/components/parameters/short-circuit/short-circuit-parameters-utils.js

@@ -0,0 +1,61 @@
+import { SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, InitialVoltage, SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS, SHORT_CIRCUIT_WITH_LOADS, SHORT_CIRCUIT_WITH_FEEDER_RESULT, SHORT_CIRCUIT_ONLY_STARTED_GENERATORS, PredefinedParameters } from "./constants.js";
+import "../../../utils/yupConfig.js";
+import { COMMON_PARAMETERS } from "../common/constant.js";
+import "react/jsx-runtime";
+import "@mui/material";
+import "react-intl";
+import "react";
+import "../../../utils/types/equipmentType.js";
+import "../../../utils/conversionUtils.js";
+import "@mui/icons-material";
+import "localized-countries";
+import "localized-countries/data/fr";
+import "localized-countries/data/en";
+import "notistack";
+import "react-hook-form";
+import "../../inputs/reactHookForm/provider/CustomFormProvider.js";
+import "../../dialogs/descriptionModificationDialog/DescriptionModificationDialog.js";
+import "../../dialogs/elementSaveDialog/ElementSaveDialog.js";
+import "../../treeViewFinder/TreeViewFinder.js";
+import "../../overflowableText/OverflowableText.js";
+import * as yup from "yup";
+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";
+const getCommonShortCircuitParametersFormSchema = () => {
+  return yup.object().shape({
+    [COMMON_PARAMETERS]: yup.object().shape({
+      [SHORT_CIRCUIT_WITH_FEEDER_RESULT]: yup.boolean().required(),
+      [SHORT_CIRCUIT_WITH_LOADS]: yup.boolean().required(),
+      [SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS]: yup.boolean().required(),
+      [SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS]: yup.boolean().required(),
+      [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: yup.boolean().required(),
+      [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: yup.mixed().oneOf(Object.values(InitialVoltage)).required()
+    })
+  });
+};
+const resetSpecificParameters = (specificDefaultValues, predefinedParameter) => {
+  if (Object.hasOwn(specificDefaultValues, SHORT_CIRCUIT_ONLY_STARTED_GENERATORS)) {
+    return {
+      ...specificDefaultValues,
+      // Forced to override specificly this param here because its default value depends of the PredefinedParameters value
+      [SHORT_CIRCUIT_ONLY_STARTED_GENERATORS]: predefinedParameter === PredefinedParameters.ICC_MIN_WITH_NOMINAL_VOLTAGE_MAP
+    };
+  }
+  return { ...specificDefaultValues };
+};
+export {
+  getCommonShortCircuitParametersFormSchema,
+  resetSpecificParameters
+};

package/dist/components/parameters/short-circuit/short-circuit-parameters.type.d.ts

@@ -1,7 +1,10 @@
+import { SpecificParametersPerProvider } from '../../../utils';
 import { InitialVoltage, PredefinedParameters } from './constants';
 export interface VoltageRange {
     minimumNominalVoltage: number;
     maximumNominalVoltage: number;
+    voltage: number;
+    voltageRangeCoefficient: number;
 }
 export interface ShortCircuitParametersDto {
     withFeederResult: boolean;
@@ -13,26 +16,9 @@ export interface ShortCircuitParametersDto {
     voltageRanges?: VoltageRange[];
 }
 export interface ShortCircuitParametersInfos {
-    parameters: ShortCircuitParametersDto;
+    provider: string;
     predefinedParameters: PredefinedParameters;
-    cei909VoltageRanges?: any;
-}
-interface VoltageRanges {
-    maximumNominalVoltage: number;
-    minimumNominalVoltage: number;
-    voltage: number;
-    voltageRangeCoefficient: number;
-}
-export interface ShortCircuitParameters {
-    predefinedParameters: NonNullable<PredefinedParameters | undefined>;
-    parameters: {
-        withFeederResult: boolean;
-        withLoads: boolean;
-        withVSCConverterStations: boolean;
-        withShuntCompensators: boolean;
-        withNeutralPosition: boolean;
-        initialVoltageProfileMode: NonNullable<InitialVoltage | undefined>;
-        voltageRanges?: VoltageRanges;
-    };
+    commonParameters: ShortCircuitParametersDto;
+    specificParametersPerProvider: SpecificParametersPerProvider;
+    cei909VoltageRanges?: VoltageRange[];
 }
-export {};

package/dist/components/parameters/short-circuit/use-short-circuit-parameters-form.d.ts

@@ -1,29 +1,29 @@
-import { FieldValues, UseFormReturn } from 'react-hook-form';
+import { FieldErrors, UseFormReturn } from 'react-hook-form';
 import { ObjectSchema } from 'yup';
 import { UUID } from 'node:crypto';
 import { PredefinedParameters } from './constants';
+import { SpecificParameterInfos, UseParametersBackendReturnProps } from '../../../utils';
 import { ShortCircuitParametersInfos } from './short-circuit-parameters.type';
+import { ComputingType } from '../common';
 export interface UseShortCircuitParametersFormReturn {
     formMethods: UseFormReturn;
     formSchema: ObjectSchema<any>;
-    paramsLoading: boolean;
+    resetAll: (predefinedParameter: PredefinedParameters) => void;
+    specificParametersDescriptionForProvider: SpecificParameterInfos[];
+    toShortCircuitFormValues: (_params: ShortCircuitParametersInfos) => any;
+    formatNewParams: (formData: Record<string, any>) => ShortCircuitParametersInfos;
+    params: ShortCircuitParametersInfos | null;
+    provider: string | undefined;
+    paramsLoaded: boolean;
+    onValidationError: (errors: FieldErrors) => void;
     onSaveInline: (formData: Record<string, any>) => void;
     onSaveDialog: (formData: Record<string, any>) => void;
-    resetAll: (predefinedParameter: PredefinedParameters) => void;
-    getCurrentValues: () => FieldValues;
 }
 type UseShortCircuitParametersFormProps = {
-    parametersUuid: UUID;
-    name: string;
+    parametersBackend: UseParametersBackendReturnProps<ComputingType.SHORT_CIRCUIT>;
+    parametersUuid: UUID | null;
+    name: string | null;
     description: string | null;
-    studyUuid: null;
-    studyShortCircuitParameters: null;
-} | {
-    parametersUuid: null;
-    name: null;
-    description: null;
-    studyUuid: UUID | null;
-    studyShortCircuitParameters: ShortCircuitParametersInfos | null;
 };
-export declare const useShortCircuitParametersForm: ({ parametersUuid, name, description, studyUuid, studyShortCircuitParameters, }: UseShortCircuitParametersFormProps) => UseShortCircuitParametersFormReturn;
+export declare const useShortCircuitParametersForm: ({ parametersBackend, parametersUuid, name, description, }: UseShortCircuitParametersFormProps) => UseShortCircuitParametersFormReturn;
 export {};