@gridsuite/commons-ui 0.142.0 → 0.143.0

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 {};

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

@@ -12,7 +12,6 @@ import { snackWithFallback } from "../../../utils/error.js";
 import "@mui/icons-material";
 import { ElementType } from "../../../utils/types/elementType.js";
 import { updateParameter } from "../../../services/explore.js";
-import { setStudyShortCircuitParameters, invalidateStudyShortCircuitStatus } from "../../../services/study.js";
 import "localized-countries";
 import "localized-countries/data/fr";
 import "localized-countries/data/en";
@@ -33,135 +32,143 @@ import "../../inputs/reactQueryBuilder/CustomReactQueryBuilder.js";
 import "uuid";
 import "../../inputs/reactQueryBuilder/PropertyValueEditor.js";
 import "react-querybuilder";
-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_PREDEFINED_PARAMS, PredefinedParameters, SHORT_CIRCUIT_WITH_FEEDER_RESULT } from "./constants.js";
+import { SHORT_CIRCUIT_PREDEFINED_PARAMS, PredefinedParameters, InitialVoltage, SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, 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_VOLTAGE_RANGES } from "./constants.js";
 import "../../filter/HeaderFilterForm.js";
 import { getNameElementEditorSchema, getNameElementEditorEmptyFormData } from "../common/name-element-editor/name-element-editor-utils.js";
-import { fetchShortCircuitParameters } from "../../../services/short-circuit-analysis.js";
+import { SPECIFIC_PARAMETERS, COMMON_PARAMETERS, VERSION_PARAMETER, PROVIDER } from "../common/constant.js";
+import "../../dialogs/descriptionModificationDialog/DescriptionModificationDialog.js";
+import "../../dialogs/elementSaveDialog/ElementSaveDialog.js";
+import "../common/widget/parameter-line-slider.js";
+import "../common/limitreductions/columns-definitions.js";
+import { getCommonShortCircuitParametersFormSchema, resetSpecificParameters } from "./short-circuit-parameters-utils.js";
+import { getDefaultSpecificParamsValues, getSpecificParametersFormSchema, getAllSpecificParametersValues, formatSpecificParameters } from "../common/utils.js";
 const useShortCircuitParametersForm = ({
+  parametersBackend,
   parametersUuid,
   name,
-  description,
-  studyUuid,
-  studyShortCircuitParameters
+  description
 }) => {
+  const [, provider, , , , params, , updateParameters, , specificParamsDescriptions] = parametersBackend;
+  const [paramsLoaded, setParamsLoaded] = useState(false);
   const { snackError } = useSnackMessage();
-  const [paramsLoading, setParamsLoading] = useState(false);
-  const [shortCircuitParameters, setShortCircuitParameters] = useState();
+  const specificParametersDescriptionForProvider = useMemo(() => {
+    return provider && specificParamsDescriptions?.[provider] ? specificParamsDescriptions[provider] : [];
+  }, [provider, specificParamsDescriptions]);
+  const specificParametersDefaultValues = useMemo(() => {
+    return getDefaultSpecificParamsValues(specificParametersDescriptionForProvider);
+  }, [specificParametersDescriptionForProvider]);
   const formSchema = useMemo(() => {
-    return yup.object().shape({
-      [SHORT_CIRCUIT_WITH_FEEDER_RESULT]: yup.boolean().required(),
+    return yup.object({
       [SHORT_CIRCUIT_PREDEFINED_PARAMS]: yup.mixed().oneOf(Object.values(PredefinedParameters)).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()
-    }).required().concat(getNameElementEditorSchema(name));
-  }, [name]);
-  const emptyFormData = useMemo(() => {
-    return {
+      ...getCommonShortCircuitParametersFormSchema().fields,
+      ...getSpecificParametersFormSchema(specificParametersDescriptionForProvider).fields
+    }).concat(getNameElementEditorSchema(name));
+  }, [name, specificParametersDescriptionForProvider]);
+  const formMethods = useForm({
+    defaultValues: {
       ...getNameElementEditorEmptyFormData(name, description),
-      [SHORT_CIRCUIT_WITH_FEEDER_RESULT]: false,
       [SHORT_CIRCUIT_PREDEFINED_PARAMS]: PredefinedParameters.ICC_MAX_WITH_CEI909,
-      [SHORT_CIRCUIT_WITH_LOADS]: false,
-      [SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS]: false,
-      [SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS]: false,
-      [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: false,
-      [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: InitialVoltage.CEI909
-    };
-  }, [name, description]);
-  const formMethods = useForm({
-    defaultValues: emptyFormData,
+      [COMMON_PARAMETERS]: {
+        ...params?.commonParameters
+      },
+      [SPECIFIC_PARAMETERS]: {
+        ...specificParametersDefaultValues
+      }
+    },
     resolver: yupResolver(formSchema)
   });
-  const { getValues, reset, setValue } = formMethods;
+  const { reset, setValue } = formMethods;
   const resetAll = useCallback(
     (predefinedParameter) => {
       const dirty = { shouldDirty: true };
-      setValue(SHORT_CIRCUIT_WITH_FEEDER_RESULT, false, dirty);
-      setValue(SHORT_CIRCUIT_WITH_LOADS, false, dirty);
       setValue(
-        SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS,
-        predefinedParameter !== PredefinedParameters.ICC_MIN_WITH_NOMINAL_VOLTAGE_MAP,
+        COMMON_PARAMETERS,
+        {
+          ...params?.commonParameters,
+          // for VERSION_PARAMETER and other non managed params
+          [SHORT_CIRCUIT_WITH_FEEDER_RESULT]: false,
+          [SHORT_CIRCUIT_WITH_LOADS]: false,
+          [SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS]: predefinedParameter !== PredefinedParameters.ICC_MIN_WITH_NOMINAL_VOLTAGE_MAP,
+          [SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS]: false,
+          [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: false,
+          [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: predefinedParameter === PredefinedParameters.ICC_MAX_WITH_CEI909 ? InitialVoltage.CEI909 : InitialVoltage.NOMINAL
+        },
         dirty
       );
-      setValue(SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, false, dirty);
-      setValue(SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, false, dirty);
-      const initialVoltageProfileMode = predefinedParameter === PredefinedParameters.ICC_MAX_WITH_CEI909 ? InitialVoltage.CEI909 : InitialVoltage.NOMINAL;
-      setValue(SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, initialVoltageProfileMode, dirty);
       setValue(SHORT_CIRCUIT_PREDEFINED_PARAMS, predefinedParameter, dirty);
+      setValue(
+        SPECIFIC_PARAMETERS,
+        resetSpecificParameters(specificParametersDefaultValues, predefinedParameter),
+        dirty
+      );
     },
-    [setValue]
+    [specificParametersDefaultValues, params?.commonParameters, setValue]
   );
-  const prepareDataToSend = (shortCircuitParams, newParameters) => {
-    const oldParameters = { ...shortCircuitParams.parameters };
-    const {
-      predefinedParameters: omit,
-      [NAME]: omit2,
-      [DESCRIPTION]: omit3,
-      ...newParametersWithoutPredefinedParameters
-    } = newParameters;
-    let parameters = {
-      ...oldParameters,
-      ...newParametersWithoutPredefinedParameters,
-      // we need to add voltageRanges to the parameters only when initialVoltageProfileMode is equals to CEI909
-      voltageRanges: void 0,
-      withNeutralPosition: !newParameters.withNeutralPosition
-    };
-    if (newParameters.initialVoltageProfileMode === InitialVoltage.CEI909) {
-      parameters = {
-        ...parameters,
-        voltageRanges: shortCircuitParams.cei909VoltageRanges,
-        initialVoltageProfileMode: InitialVoltage.CONFIGURED
+  const formatNewParams = useCallback(
+    (formData) => {
+      if (!provider) {
+        return {};
+      }
+      return {
+        provider: formData[PROVIDER],
+        predefinedParameters: formData[SHORT_CIRCUIT_PREDEFINED_PARAMS],
+        commonParameters: {
+          [VERSION_PARAMETER]: formData[COMMON_PARAMETERS][VERSION_PARAMETER],
+          // PowSyBl requires that "version" appears first
+          ...formData[COMMON_PARAMETERS],
+          // this should be inverted for API compatibility
+          [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: !formData[COMMON_PARAMETERS][SHORT_CIRCUIT_WITH_NEUTRAL_POSITION],
+          [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: formData[COMMON_PARAMETERS][SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE] === InitialVoltage.CEI909 ? InitialVoltage.CONFIGURED : formData[COMMON_PARAMETERS][SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE],
+          // we need to add voltageRanges to the parameters only when initialVoltageProfileMode is equals to CEI909
+          [SHORT_CIRCUIT_VOLTAGE_RANGES]: formData[COMMON_PARAMETERS][SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE] === InitialVoltage.CEI909 ? params?.cei909VoltageRanges : void 0
+        },
+        specificParametersPerProvider: {
+          [provider]: getAllSpecificParametersValues(formData, specificParametersDefaultValues)
+        }
       };
-    }
-    return {
-      predefinedParameters: newParameters.predefinedParameters,
-      parameters
-    };
-  };
-  const getCurrentValues = useCallback(() => {
-    if (shortCircuitParameters) {
-      const currentValues = getValues();
-      return { ...prepareDataToSend(shortCircuitParameters, currentValues) };
-    }
-    return {};
-  }, [shortCircuitParameters, getValues]);
-  const formatShortCircuitParameters = (parameters, predefinedParameters) => {
-    return {
-      [SHORT_CIRCUIT_WITH_FEEDER_RESULT]: parameters.withFeederResult,
-      [SHORT_CIRCUIT_PREDEFINED_PARAMS]: predefinedParameters,
-      [SHORT_CIRCUIT_WITH_LOADS]: parameters.withLoads,
-      [SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS]: parameters.withVSCConverterStations,
-      [SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS]: parameters.withShuntCompensators,
-      [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: !parameters.withNeutralPosition,
-      [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: parameters.initialVoltageProfileMode === InitialVoltage.CONFIGURED ? InitialVoltage.CEI909 : parameters.initialVoltageProfileMode
-    };
-  };
+    },
+    [params?.cei909VoltageRanges, provider, specificParametersDefaultValues]
+  );
+  const toShortCircuitFormValues = useCallback(
+    (_params) => {
+      if (!provider) {
+        return {};
+      }
+      const specificParamsListForCurrentProvider = _params.specificParametersPerProvider[provider];
+      return {
+        [PROVIDER]: _params.provider,
+        [SHORT_CIRCUIT_PREDEFINED_PARAMS]: _params.predefinedParameters,
+        [COMMON_PARAMETERS]: {
+          ..._params.commonParameters,
+          [SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE]: _params.commonParameters.initialVoltageProfileMode === InitialVoltage.CONFIGURED ? InitialVoltage.CEI909 : _params.commonParameters.initialVoltageProfileMode,
+          // invert back the value for the form
+          [SHORT_CIRCUIT_WITH_NEUTRAL_POSITION]: !_params.commonParameters.withNeutralPosition
+        },
+        [SPECIFIC_PARAMETERS]: {
+          ...formatSpecificParameters(
+            specificParametersDescriptionForProvider,
+            specificParamsListForCurrentProvider
+          )
+        }
+      };
+    },
+    [provider, specificParametersDescriptionForProvider]
+  );
+  const onValidationError = useCallback((_errors) => {
+  }, []);
   const onSaveInline = useCallback(
     (formData) => {
-      if (studyUuid && shortCircuitParameters) {
-        const oldParams = shortCircuitParameters;
-        setStudyShortCircuitParameters(studyUuid, {
-          ...prepareDataToSend(shortCircuitParameters, formData)
-        }).then(() => {
-          invalidateStudyShortCircuitStatus(studyUuid).catch((error) => {
-            snackWithFallback(snackError, error, { headerId: "invalidateShortCircuitStatusError" });
-          });
-        }).catch((error) => {
-          setShortCircuitParameters(oldParams);
-          snackWithFallback(snackError, error, { headerId: "paramsChangingError" });
-        });
-      }
+      const data = formatNewParams(formData);
+      updateParameters(data);
     },
-    [shortCircuitParameters, setShortCircuitParameters, snackError, studyUuid]
+    [updateParameters, formatNewParams]
   );
   const onSaveDialog = useCallback(
     (formData) => {
-      if (parametersUuid && shortCircuitParameters) {
+      if (parametersUuid) {
         updateParameter(
           parametersUuid,
-          prepareDataToSend(shortCircuitParameters, formData),
+          formatNewParams(formData),
           formData[NAME],
           ElementType.SHORT_CIRCUIT_PARAMETERS,
           formData[DESCRIPTION] ?? ""
@@ -170,42 +177,28 @@ const useShortCircuitParametersForm = ({
         });
       }
     },
-    [parametersUuid, shortCircuitParameters, snackError]
+    [formatNewParams, parametersUuid, snackError]
   );
   useEffect(() => {
-    if (parametersUuid) {
-      const timer = setTimeout(() => {
-        setParamsLoading(true);
-      }, 700);
-      fetchShortCircuitParameters(parametersUuid).then((params) => {
-        setShortCircuitParameters(params);
-      }).catch((error) => {
-        snackWithFallback(snackError, error, { headerId: "paramsRetrievingError" });
-      }).finally(() => {
-        clearTimeout(timer);
-        setParamsLoading(false);
-      });
-    }
-  }, [parametersUuid, snackError]);
-  useEffect(() => {
-    if (studyShortCircuitParameters) {
-      setShortCircuitParameters(studyShortCircuitParameters);
-    }
-  }, [studyShortCircuitParameters]);
-  useEffect(() => {
-    if (shortCircuitParameters) {
-      const { parameters, predefinedParameters } = shortCircuitParameters;
-      reset(formatShortCircuitParameters(parameters, predefinedParameters));
+    if (!params || !provider || !specificParamsDescriptions) {
+      return;
     }
-  }, [reset, shortCircuitParameters]);
+    reset(toShortCircuitFormValues(params));
+    setParamsLoaded(true);
+  }, [provider, params, reset, specificParamsDescriptions, toShortCircuitFormValues]);
   return {
     formMethods,
     formSchema,
-    paramsLoading,
+    specificParametersDescriptionForProvider,
+    toShortCircuitFormValues,
+    formatNewParams,
+    params,
+    provider,
+    paramsLoaded,
+    onValidationError,
     onSaveInline,
     onSaveDialog,
-    resetAll,
-    getCurrentValues
+    resetAll
   };
 };
 export {

package/dist/hooks/use-parameters-backend.d.ts

@@ -2,10 +2,10 @@ import { UUID } from 'node:crypto';
 import { User } from 'oidc-client';
 import { ComputingType } from '../components/parameters/common/computing-type';
 import { ILimitReductionsByVoltageLevel } from '../components/parameters/common/limitreductions/columns-definitions';
-import { ParametersInfos, SpecificParametersInfos, UseParametersBackendReturnProps } from '../utils/types/parameters.type';
+import { ParametersInfos, SpecificParametersDescription, UseParametersBackendReturnProps } from '../utils/types/parameters.type';
 export declare enum OptionalServicesStatus {
     Up = "UP",
     Down = "DOWN",
     Pending = "PENDING"
 }
-export declare const useParametersBackend: <T extends ComputingType>(user: User | null, studyUuid: UUID | null, type: T, optionalServiceStatus: OptionalServicesStatus | undefined, backendFetchProviders: () => Promise<string[]>, backendFetchProvider: ((studyUuid: UUID) => Promise<string>) | null, backendFetchDefaultProvider: () => Promise<string>, backendUpdateProvider: ((studyUuid: UUID, newProvider: string) => Promise<any>) | null, backendFetchParameters: (studyUuid: UUID) => Promise<ParametersInfos<T>>, backendUpdateParameters?: (studyUuid: UUID, newParam: ParametersInfos<T> | null) => Promise<any>, backendFetchSpecificParametersDescription?: () => Promise<SpecificParametersInfos>, backendFetchDefaultLimitReductions?: () => Promise<ILimitReductionsByVoltageLevel[]>) => UseParametersBackendReturnProps<T>;
+export declare const useParametersBackend: <T extends ComputingType>(user: User | null, studyUuid: UUID | null, type: T, optionalServiceStatus: OptionalServicesStatus | undefined, backendFetchProviders: (() => Promise<string[]>) | null, backendFetchProvider: ((studyUuid: UUID) => Promise<string>) | null, backendFetchDefaultProvider: (() => Promise<string>) | null, backendUpdateProvider: ((studyUuid: UUID, newProvider: string) => Promise<any>) | null, backendFetchParameters: (studyUuid: UUID) => Promise<ParametersInfos<T>>, backendUpdateParameters?: (studyUuid: UUID, newParam: ParametersInfos<T> | null) => Promise<any>, backendFetchSpecificParametersDescription?: () => Promise<SpecificParametersDescription>, backendFetchDefaultLimitReductions?: () => Promise<ILimitReductionsByVoltageLevel[]>) => UseParametersBackendReturnProps<T>;

package/dist/hooks/use-parameters-backend.js

@@ -17,7 +17,9 @@ const useParametersBackend = (user, studyUuid, type, optionalServiceStatus, back
   const providerRef = useRef(provider);
   providerRef.current = provider;
   const [params, setParams] = useState(null);
-  const [specificParamsDescription, setSpecificParamsDescription] = useState(null);
+  const [specificParamsDescription, setSpecificParamsDescription] = useState(
+    null
+  );
   const [defaultLimitReductions, setDefaultLimitReductions] = useState([]);
   const optionalServiceStatusRef = useRef(optionalServiceStatus);
   optionalServiceStatusRef.current = optionalServiceStatus;
@@ -44,7 +46,7 @@ const useParametersBackend = (user, studyUuid, type, optionalServiceStatus, back
     [backendUpdateProvider, studyUuid, snackError, type]
   );
   const resetProvider = useCallback(() => {
-    backendFetchDefaultProvider().then((defaultProvider) => {
+    backendFetchDefaultProvider?.().then((defaultProvider) => {
       const providerNames = Object.keys(providersRef.current);
       if (providerNames.length > 0) {
         const newProvider = defaultProvider in providersRef.current ? defaultProvider : providerNames[0];
@@ -59,7 +61,7 @@ const useParametersBackend = (user, studyUuid, type, optionalServiceStatus, back
     });
   }, [backendFetchDefaultProvider, updateProvider, snackError, type]);
   const fetchAvailableProviders = useCallback(() => {
-    return backendFetchProviders().then((providers) => {
+    return backendFetchProviders?.().then((providers) => {
       const providersObj = providers.reduce((acc, v) => {
         return {
           ...acc,
@@ -91,7 +93,7 @@ const useParametersBackend = (user, studyUuid, type, optionalServiceStatus, back
   );
   useEffect(() => {
     if (user !== null && studyUuid && optionalServiceStatus === "UP") {
-      fetchAvailableProviders().then(() => fetchProvider(studyUuid));
+      fetchAvailableProviders()?.then(() => fetchProvider(studyUuid));
     }
   }, [fetchAvailableProviders, fetchProvider, optionalServiceStatus, studyUuid, user]);
   const fetchSpecificParametersDescription = useCallback(() => {

package/dist/index.js

@@ -134,7 +134,7 @@ import { DeviceHubIcon } from "./components/icons/DeviceHubIcon.js";
 import { TuneIcon } from "./components/icons/TuneIcon.js";
 import { PhotoLibraryIcon } from "./components/icons/PhotoLibraryIcon.js";
 import { ComputingType, formatComputingTypeLabel, isValidComputingType } from "./components/parameters/common/computing-type.js";
-import { PARAM_SA_FLOW_PROPORTIONAL_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_LOW_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_LOW_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_PROVIDER, PROVIDER, ReactivePowerAdornment, VOLTAGE_LEVEL, VoltageAdornment } from "./components/parameters/common/constant.js";
+import { COMMON_PARAMETERS, PARAM_SA_FLOW_PROPORTIONAL_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_LOW_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_LOW_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_PROVIDER, PROVIDER, ReactivePowerAdornment, SPECIFIC_PARAMETERS, VERSION_PARAMETER, VOLTAGE_LEVEL, VoltageAdornment } from "./components/parameters/common/constant.js";
 import { LineSeparator } from "./components/parameters/common/line-separator.js";
 import { LabelledButton, SwitchWithLabel, TabPanel } from "./components/parameters/common/parameters.js";
 import { CreateParameterDialog } from "./components/parameters/common/parameters-creation-dialog.js";
@@ -156,10 +156,10 @@ import { CENTER_LABEL, COMPONENT_LIBRARY, DIAGONAL_LABEL, INTL_LINE_FLOW_MODE_OP
 import { MAP_BASEMAP_CARTO, MAP_BASEMAP_CARTO_NOLABEL, MAP_BASEMAP_ETALAB, MAP_BASEMAP_MAPBOX, NadPositionsGenerationMode, SubstationLayout } from "./components/parameters/network-visualizations/network-visualizations.types.js";
 import { NetworkVisualizationParametersInline } from "./components/parameters/network-visualizations/network-visualizations-parameters-inline.js";
 import { NetworkVisualizationsParametersEditionDialog } from "./components/parameters/network-visualizations/network-visualizations-parameters-dialog.js";
-import { BALANCE_TYPE, COMMON_PARAMETERS, CONNECTED_COMPONENT_MODE, COUNTRIES_TO_BALANCE, DC, DC_POWER_FACTOR, DC_USE_TRANSFORMER_RATIO, DEFAULT_LIMIT_REDUCTION_VALUE, DISTRIBUTED_SLACK, HVDC_AC_EMULATION, MAX_VALUE_ALLOWED_FOR_LIMIT_REDUCTION, MIN_VALUE_ALLOWED_FOR_LIMIT_REDUCTION, PARAM_LIMIT_REDUCTION, PARAM_PROVIDER_OPENLOADFLOW, PHASE_SHIFTER_REGULATION_ON, READ_SLACK_BUS, SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON, SPECIFIC_PARAMETERS, TWT_SPLIT_SHUNT_ADMITTANCE, USE_REACTIVE_LIMITS, VERSION_PARAMETER, VOLTAGE_INIT_MODE, WRITE_SLACK_BUS, alertThresholdMarks } from "./components/parameters/loadflow/constants.js";
+import { BALANCE_TYPE, CONNECTED_COMPONENT_MODE, COUNTRIES_TO_BALANCE, DC, DC_POWER_FACTOR, DC_USE_TRANSFORMER_RATIO, DEFAULT_LIMIT_REDUCTION_VALUE, DISTRIBUTED_SLACK, HVDC_AC_EMULATION, MAX_VALUE_ALLOWED_FOR_LIMIT_REDUCTION, MIN_VALUE_ALLOWED_FOR_LIMIT_REDUCTION, PARAM_LIMIT_REDUCTION, PARAM_PROVIDER_OPENLOADFLOW, PHASE_SHIFTER_REGULATION_ON, READ_SLACK_BUS, SHUNT_COMPENSATOR_VOLTAGE_CONTROL_ON, TWT_SPLIT_SHUNT_ADMITTANCE, USE_REACTIVE_LIMITS, VOLTAGE_INIT_MODE, WRITE_SLACK_BUS, alertThresholdMarks } from "./components/parameters/loadflow/constants.js";
 import { LoadFlowParametersInline } from "./components/parameters/loadflow/load-flow-parameters-inline.js";
 import { LoadFlowParametersEditionDialog } from "./components/parameters/loadflow/load-flow-parameters-dialog.js";
-import { InitialVoltage, PredefinedParameters, SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, SHORT_CIRCUIT_PREDEFINED_PARAMS, SHORT_CIRCUIT_WITH_FEEDER_RESULT, SHORT_CIRCUIT_WITH_LOADS, SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS, intlInitialVoltageProfileMode, intlPredefinedParametersOptions } from "./components/parameters/short-circuit/constants.js";
+import { InitialVoltage, PredefinedParameters, SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE, SHORT_CIRCUIT_ONLY_STARTED_GENERATORS, SHORT_CIRCUIT_PREDEFINED_PARAMS, SHORT_CIRCUIT_VOLTAGE_RANGES, SHORT_CIRCUIT_WITH_FEEDER_RESULT, SHORT_CIRCUIT_WITH_LOADS, SHORT_CIRCUIT_WITH_NEUTRAL_POSITION, SHORT_CIRCUIT_WITH_SHUNT_COMPENSATORS, SHORT_CIRCUIT_WITH_VSC_CONVERTER_STATIONS, intlInitialVoltageProfileMode, intlPredefinedParametersOptions, onlyStartedGeneratorsOptions } from "./components/parameters/short-circuit/constants.js";
 import { ShortCircuitParametersInLine } from "./components/parameters/short-circuit/short-circuit-parameters-inline.js";
 import { ShortCircuitParametersEditionDialog } from "./components/parameters/short-circuit/short-circuit-parameters-dialog.js";
 import { DEFAULT_GENERAL_APPLY_MODIFICATIONS, DEFAULT_REACTIVE_SLACKS_THRESHOLD, DEFAULT_SHUNT_COMPENSATOR_ACTIVATION_THRESHOLD, DEFAULT_UPDATE_BUS_VOLTAGE, GENERAL, GENERAL_APPLY_MODIFICATIONS, GENERATORS_SELECTION_TYPE, HIGH_VOLTAGE_LIMIT, LEG_SIDE, LOW_VOLTAGE_LIMIT, PRIORITY, RATIO_TAP_CHANGER_POSITION, RATIO_TAP_CHANGER_TARGET_V, REACTIVE_SLACKS_THRESHOLD, SELECTION_TYPE, SHUNT_COMPENSATORS_SELECTION_TYPE, SHUNT_COMPENSATOR_ACTIVATION_THRESHOLD, TRANSFORMERS_SELECTION_TYPE, UPDATE_BUS_VOLTAGE, VARIABLE_Q_GENERATORS, VARIABLE_SHUNT_COMPENSATORS, VARIABLE_TRANSFORMERS, VOLTAGE_LIMITS_DEFAULT, VOLTAGE_LIMITS_MODIFICATION, VoltageInitTabValues } from "./components/parameters/voltage-init/constants.js";
@@ -200,11 +200,12 @@ import { createFilter, createParameter, fetchElementsInfos, saveFilter, updatePa
 import { PREFIX_STUDY_QUERIES, fetchLoadFlowParameters, getDefaultLoadFlowProvider, getLoadFlowDefaultLimitReductions, getLoadFlowProviders, getLoadFlowSpecificParametersDescription, getLoadFlowUrl, setLoadFlowParameters } from "./services/loadflow.js";
 import { getPccMinStudyParameters, updatePccMinParameters } from "./services/pcc-min.js";
 import { fetchDefaultSecurityAnalysisProvider, fetchSecurityAnalysisParameters, fetchSecurityAnalysisProviders, getSecurityAnalysisDefaultLimitReductions, getSecurityAnalysisParameters, getStudyUrl, safeEncodeURIComponent, setSecurityAnalysisParameters, updateSecurityAnalysisParameters, updateSecurityAnalysisProvider } from "./services/security-analysis.js";
-import { exportFilter, getAvailableComponentLibraries, getStudyNetworkVisualizationsParameters, getStudyShortCircuitParameters, invalidateStudyShortCircuitStatus, setStudyNetworkVisualizationParameters, setStudyShortCircuitParameters, updateVoltageInitParameters } from "./services/study.js";
+import { exportFilter, getAvailableComponentLibraries, getStudyNetworkVisualizationsParameters, getStudyShortCircuitParameters, setStudyNetworkVisualizationParameters, updateVoltageInitParameters } from "./services/study.js";
 import { getNetworkVisualizationsParameters } from "./services/study-config.js";
 import { fetchCurrentAnnouncement, fetchUserDetails } from "./services/userAdmin.js";
 import { NetworkTimeoutError, backendFetch, backendFetchFile, backendFetchJson, backendFetchText, getRequestParamFromList } from "./services/utils.js";
 import { getVoltageInitParameters, getVoltageInitUrl } from "./services/voltage-init.js";
+import { fetchShortCircuitParameters, getShortCircuitSpecificParametersDescription, updateShortCircuitParameters } from "./services/short-circuit-analysis.js";
 import { equalsArray } from "./utils/algos.js";
 import { FetchStatus } from "./utils/constants/fetchStatus.js";
 import { FieldConstants } from "./utils/constants/fieldConstants.js";
@@ -597,7 +598,9 @@ export {
   SELECTION_TYPE,
   SENSITIVITY_TYPES,
   SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE,
+  SHORT_CIRCUIT_ONLY_STARTED_GENERATORS,
   SHORT_CIRCUIT_PREDEFINED_PARAMS,
+  SHORT_CIRCUIT_VOLTAGE_RANGES,
   SHORT_CIRCUIT_WITH_FEEDER_RESULT,
   SHORT_CIRCUIT_WITH_LOADS,
   SHORT_CIRCUIT_WITH_NEUTRAL_POSITION,
@@ -757,6 +760,7 @@ export {
   fetchRootFolders,
   fetchSecurityAnalysisParameters,
   fetchSecurityAnalysisProviders,
+  fetchShortCircuitParameters,
   fetchStudyMetadata,
   fetchUserDetails,
   filterEn,
@@ -794,6 +798,7 @@ export {
   getSAParametersFromSchema,
   getSecurityAnalysisDefaultLimitReductions,
   getSecurityAnalysisParameters,
+  getShortCircuitSpecificParametersDescription,
   getStudyNetworkVisualizationsParameters,
   getStudyShortCircuitParameters,
   getStudyUrl,
@@ -815,7 +820,6 @@ export {
   inputsFr,
   intlInitialVoltageProfileMode,
   intlPredefinedParametersOptions,
-  invalidateStudyShortCircuitStatus,
   isBlankOrEmpty,
   isFieldRequired,
   isFloatNumber,
@@ -836,6 +840,7 @@ export {
   multipleSelectionDialogFr,
   networkModificationsEn,
   networkModificationsFr,
+  onlyStartedGeneratorsOptions,
   parametersEn,
   parametersFr,
   queryValidator,
@@ -858,7 +863,6 @@ export {
   setShowAuthenticationRouterLogin,
   setSignInCallbackError,
   setStudyNetworkVisualizationParameters,
-  setStudyShortCircuitParameters,
   setUnauthorizedUserInfo,
   setUserValidationError,
   snackWithFallback,
@@ -884,6 +888,7 @@ export {
   updatePccMinParameters,
   updateSecurityAnalysisParameters,
   updateSecurityAnalysisProvider,
+  updateShortCircuitParameters,
   updateVoltageInitParameters,
   useConfidentialityWarning,
   useConvertValue,

package/dist/services/index.d.ts

@@ -16,3 +16,4 @@ export * from './study-config';
 export * from './userAdmin';
 export * from './utils';
 export * from './voltage-init';
+export * from './short-circuit-analysis';