@gridsuite/commons-ui 0.178.0 → 0.180.0

package/dist/components/parameters/dynamic-security-analysis/use-dynamic-security-analysis-parameters-form.js

@@ -0,0 +1,181 @@
+import { useForm } from "react-hook-form";
+import { useMemo, useEffect } from "react";
+import { yupResolver } from "@hookform/resolvers/yup";
+import "../../../utils/yupConfig.js";
+import { ID } from "../../../utils/constants/filterConstant.js";
+import "../../../utils/conversionUtils.js";
+import "../../../utils/types/equipmentType.js";
+import "react/jsx-runtime";
+import "@mui/icons-material";
+import { PROVIDER } from "../common/constants.js";
+import "@mui/material";
+import "react-intl";
+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 "../../overflowableText/OverflowableText.js";
+import * as yup from "yup";
+import { NAME } from "../../inputs/reactHookForm/constants.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 "@material-symbols/svg-400/outlined/left_panel_open.svg?react";
+import "@material-symbols/svg-400/outlined/arrows_output.svg?react";
+import "@material-symbols/svg-400/outlined/left_panel_close.svg?react";
+import "@material-symbols/svg-400/outlined/add_notes.svg?react";
+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 "../common/contingency-table/columns-definitions.js";
+import "../../filter/HeaderFilterForm.js";
+import { getNameElementEditorSchema, getNameElementEditorEmptyFormData } from "../common/name-element-editor/name-element-editor-utils.js";
+import { SCENARIO_DURATION, CONTINGENCIES_LIST_INFOS, CONTINGENCIES_START_TIME } from "./constants.js";
+import { useTabs } from "../common/utils.js";
+var TabValues = /* @__PURE__ */ ((TabValues2) => {
+  TabValues2["SCENARIO"] = "scenario";
+  TabValues2["CONTINGENCY"] = "contingency";
+  return TabValues2;
+})(TabValues || {});
+const scenarioFormSchema = yup.object().shape({
+  [SCENARIO_DURATION]: yup.number().required()
+}).required();
+const contingencyFormSchema = yup.object().shape({
+  [CONTINGENCIES_START_TIME]: yup.number().required(),
+  [CONTINGENCIES_LIST_INFOS]: yup.array().of(
+    yup.object().shape({
+      [ID]: yup.string().required(),
+      [NAME]: yup.string().required()
+    })
+  ).required()
+});
+const formSchema = yup.object().shape({
+  [PROVIDER]: yup.string().required(),
+  [
+    "scenario"
+    /* SCENARIO */
+  ]: scenarioFormSchema,
+  [
+    "contingency"
+    /* CONTINGENCY */
+  ]: contingencyFormSchema
+});
+const scenarioEmptyFormData = {
+  [SCENARIO_DURATION]: 0
+};
+const contingencyEmptyFormData = {
+  [CONTINGENCIES_START_TIME]: 0,
+  [CONTINGENCIES_LIST_INFOS]: []
+};
+const emptyFormData = {
+  [PROVIDER]: "",
+  [
+    "scenario"
+    /* SCENARIO */
+  ]: { ...scenarioEmptyFormData },
+  [
+    "contingency"
+    /* CONTINGENCY */
+  ]: { ...contingencyEmptyFormData }
+};
+const toFormValues = (_params) => ({
+  [PROVIDER]: _params.provider,
+  [
+    "scenario"
+    /* SCENARIO */
+  ]: {
+    [SCENARIO_DURATION]: _params.scenarioDuration
+  },
+  [
+    "contingency"
+    /* CONTINGENCY */
+  ]: {
+    [CONTINGENCIES_START_TIME]: _params.contingenciesStartTime,
+    [CONTINGENCIES_LIST_INFOS]: _params.contingencyListInfos
+  }
+});
+const toParamsInfos = (_formData) => ({
+  provider: _formData[PROVIDER],
+  scenarioDuration: _formData[
+    "scenario"
+    /* SCENARIO */
+  ][SCENARIO_DURATION],
+  contingenciesStartTime: _formData[
+    "contingency"
+    /* CONTINGENCY */
+  ][CONTINGENCIES_START_TIME],
+  contingencyListInfos: _formData[
+    "contingency"
+    /* CONTINGENCY */
+  ][CONTINGENCIES_LIST_INFOS]
+});
+function useDynamicSecurityAnalysisParametersForm({
+  providers,
+  params,
+  name: initialName,
+  description: initialDescription
+}) {
+  const paramsLoaded = useMemo(() => !!params, [params]);
+  const formattedProviders = useMemo(
+    () => Object.entries(providers).map(([key, value]) => ({
+      id: key,
+      label: value
+    })),
+    [providers]
+  );
+  const returnFormSchema = useMemo(() => {
+    return initialName === null ? formSchema : formSchema.concat(getNameElementEditorSchema(initialName));
+  }, [initialName]);
+  const newEmptyFormData = useMemo(() => {
+    return {
+      ...initialName === null ? {} : getNameElementEditorEmptyFormData(initialName, initialDescription),
+      ...emptyFormData
+    };
+  }, [initialName, initialDescription]);
+  const returnFormMethods = useForm({
+    defaultValues: newEmptyFormData,
+    resolver: yupResolver(returnFormSchema)
+  });
+  const { reset } = returnFormMethods;
+  useEffect(() => {
+    if (params) {
+      console.log("xxx Resetting form with params:", params);
+      reset(toFormValues(params));
+    }
+  }, [params, paramsLoaded, reset]);
+  const { selectedTab, tabsWithError, onTabChange, onError } = useTabs({
+    defaultTab: "scenario",
+    tabEnum: TabValues
+  });
+  return {
+    formMethods: returnFormMethods,
+    formSchema: returnFormSchema,
+    paramsLoaded,
+    formattedProviders,
+    /* tab-related handling */
+    selectedTab,
+    tabsWithError,
+    onTabChange,
+    onError
+  };
+}
+export {
+  TabValues,
+  emptyFormData,
+  formSchema,
+  toFormValues,
+  toParamsInfos,
+  useDynamicSecurityAnalysisParametersForm
+};

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

@@ -13,3 +13,4 @@ export * from './pcc-min';
 export * from './security-analysis';
 export * from './sensi';
 export * from './dynamic-margin-calculation';
+export * from './dynamic-security-analysis';

package/dist/components/parameters/index.js

@@ -41,6 +41,8 @@ import { SensitivityAnalysisParametersDialog } from "./sensi/sensitivity-analysi
 import { COLUMNS_DEFINITIONS_HVDCS, COLUMNS_DEFINITIONS_INJECTIONS, COLUMNS_DEFINITIONS_INJECTIONS_SET, COLUMNS_DEFINITIONS_NODES, COLUMNS_DEFINITIONS_PSTS, EQUIPMENTS_IN_VOLTAGE_REGULATION_TYPES, HVDC_EQUIPMENT_TYPES, INJECTIONS_EQUIPMENT_TYPES, INJECTION_DISTRIBUTION_TYPES, MONITORED_BRANCHES_EQUIPMENT_TYPES, MONITORED_VOLTAGE_LEVELS_EQUIPMENT_TYPES, PSTS_EQUIPMENT_TYPES, SENSITIVITY_TYPES, SensiBranchesTabValues, SensiHvdcs, SensiInjection, SensiInjectionsSet, SensiNodes, SensiPsts, SensiTabValues } from "./sensi/columns-definitions.js";
 import { ACCURACY, ACTIVE, CALCULATION_TYPE, LOADS_VARIATIONS, LOAD_FILTERS, LOAD_INCREASE_START_TIME, LOAD_INCREASE_STOP_TIME, LOAD_MODELS_RULE, MARGIN_CALCULATION_START_TIME, START_TIME, STOP_TIME, VARIATION } from "./dynamic-margin-calculation/constants.js";
 import { DynamicMarginCalculationInline } from "./dynamic-margin-calculation/dynamic-margin-calculation-inline.js";
+import { CONTINGENCIES_LIST_INFOS, CONTINGENCIES_START_TIME, SCENARIO_DURATION } from "./dynamic-security-analysis/constants.js";
+import { DynamicSecurityAnalysisInline } from "./dynamic-security-analysis/dynamic-security-analysis-inline.js";
 export {
   ACCURACY,
   ACTIVE,
@@ -58,6 +60,8 @@ export {
   COMPONENT_LIBRARY,
   CONNECTED_MODE,
   CONTINGENCIES,
+  CONTINGENCIES_LIST_INFOS,
+  CONTINGENCIES_START_TIME,
   CONTINGENCY_LISTS,
   CONTINGENCY_LISTS_INFOS,
   COUNTRIES_TO_BALANCE,
@@ -78,6 +82,7 @@ export {
   DIAGONAL_LABEL,
   DISTRIBUTED_SLACK,
   DynamicMarginCalculationInline,
+  DynamicSecurityAnalysisInline,
   EQUIPMENTS_IN_VOLTAGE_REGULATION_TYPES,
   EquipmentsSelectionType,
   GENERAL,
@@ -165,6 +170,7 @@ export {
   RATIO_TAP_CHANGER_TARGET_V,
   REACTIVE_SLACKS_THRESHOLD,
   READ_SLACK_BUS,
+  SCENARIO_DURATION,
   SELECTION_TYPE,
   SENSITIVITY_TYPES,
   SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE,

package/dist/components/parameters/sensi/use-sensitivity-analysis-parameters.js

@@ -12,6 +12,7 @@ import { ElementType } from "../../../utils/types/elementType.js";
 import "../../../utils/types/equipmentType.js";
 import "@mui/icons-material";
 import "../../../utils/yupConfig.js";
+import { DEFAULT_TIMEOUT_MS, IGNORE_SIGNAL } from "../../../services/utils.js";
 import { updateParameter } from "../../../services/explore.js";
 import "localized-countries";
 import "localized-countries/data/fr";
@@ -63,6 +64,7 @@ const useSensitivityAnalysisParametersForm = ({
   const [factorsCount, setFactorsCount] = useState(DEFAULT_FACTOR_COUNT);
   const [isLoading, setIsLoading] = useState(false);
   const [isSubmitAction, setIsSubmitAction] = useState(false);
+  const [factorCountParams, setFactorCountParams] = useState(null);
   const emptyFormData = useMemo(() => {
     return {
       ...getNameElementEditorEmptyFormData(name, description),
@@ -108,6 +110,7 @@ const useSensitivityAnalysisParametersForm = ({
   const resetFactorsCount = useCallback(() => {
     setIsLoading(false);
     setFactorsCount(DEFAULT_FACTOR_COUNT);
+    setFactorCountParams(null);
   }, []);
   const updateFactorCount = useCallback(() => {
     if (!currentNodeUuid || !currentRootNetworkUuid) {
@@ -132,23 +135,40 @@ const useSensitivityAnalysisParametersForm = ({
       [PARAMETER_SENSI_PST]: filteredPst,
       [PARAMETER_SENSI_NODES]: filteredNodes
     };
+    setFactorCountParams(formatNewParams(filteredFormValues));
+  }, [currentNodeUuid, currentRootNetworkUuid, formatNewParams, getValues, resetFactorsCount]);
+  useEffect(() => {
+    if (!factorCountParams || !currentNodeUuid || !currentRootNetworkUuid) {
+      return () => {
+      };
+    }
+    let loadingTimeoutId;
+    const controller = new AbortController();
+    const abortSignal = AbortSignal.any([controller.signal, AbortSignal.timeout(DEFAULT_TIMEOUT_MS)]);
     setIsLoading(true);
     getSensitivityAnalysisFactorsCount(
       studyUuid,
       currentNodeUuid,
       currentRootNetworkUuid,
-      formatNewParams(filteredFormValues)
+      factorCountParams,
+      abortSignal
     ).then((factorsCountResponse) => {
       setFactorsCount(factorsCountResponse);
-      const timeoutId = setTimeout(() => {
+      loadingTimeoutId = setTimeout(() => {
         setIsLoading(false);
       }, 500);
-      return () => clearTimeout(timeoutId);
     }).catch((error) => {
+      if (abortSignal.aborted && abortSignal.reason?.message === IGNORE_SIGNAL) {
+        return;
+      }
       setIsLoading(false);
       snackWithFallback(snackError, error, { headerId: "getSensitivityAnalysisFactorsCountError" });
     });
-  }, [snackError, studyUuid, currentRootNetworkUuid, formatNewParams, currentNodeUuid, getValues, resetFactorsCount]);
+    return () => {
+      controller?.abort(new Error(IGNORE_SIGNAL));
+      clearTimeout(loadingTimeoutId);
+    };
+  }, [snackError, studyUuid, currentRootNetworkUuid, currentNodeUuid, factorCountParams]);
   const onFormChanged = useCallback(() => {
     updateFactorCount();
   }, [updateFactorCount]);

package/dist/components/parameters/util/make-component-utils.d.ts

@@ -0,0 +1,17 @@
+import { ReactElement } from 'react';
+import { Option } from '../../../utils';
+export declare enum TYPES {
+    ENUM = "ENUM",
+    BOOL = "BOOL",
+    INTEGER = "INTEGER",
+    FLOAT = "FLOAT",
+    STRING = "STRING"
+}
+export type DefParam = {
+    type: TYPES;
+    label: string;
+    options?: Option[];
+    render?: (defParam: DefParam, path: string, key: string) => ReactElement;
+};
+export declare const makeComponent: (defParam: DefParam, path: string, key: string) => import("react/jsx-runtime").JSX.Element;
+export declare const makeComponents: (defParams: Record<string, DefParam>, path: string) => import("react/jsx-runtime").JSX.Element[];

package/dist/components/parameters/util/make-component-utils.js

@@ -0,0 +1,96 @@
+import { jsxs, Fragment, jsx } from "react/jsx-runtime";
+import { Grid } from "@mui/material";
+import { FormattedMessage } from "react-intl";
+import { parametersStyles } from "./styles.js";
+import { LineSeparator } from "../common/line-separator.js";
+import "react";
+import "../../../utils/conversionUtils.js";
+import "../../../utils/types/equipmentType.js";
+import "@mui/icons-material";
+import "../../../utils/yupConfig.js";
+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 "yup";
+import "../../inputs/reactHookForm/agGridTable/BottomRightButtons.js";
+import "../../customAGGrid/customAggrid.js";
+import "ag-grid-community";
+import "react-papaparse";
+import "react-csv-downloader";
+import { SwitchInput } from "../../inputs/reactHookForm/booleans/SwitchInput.js";
+import { FloatInput } from "../../inputs/reactHookForm/numbers/FloatInput.js";
+import { IntegerInput } from "../../inputs/reactHookForm/numbers/IntegerInput.js";
+import "../../inputs/reactHookForm/numbers/RangeInput.js";
+import { SelectInput } from "../../inputs/reactHookForm/selectInputs/SelectInput.js";
+import { TextInput } from "../../inputs/reactHookForm/text/TextInput.js";
+import "@material-symbols/svg-400/outlined/left_panel_open.svg?react";
+import "@material-symbols/svg-400/outlined/arrows_output.svg?react";
+import "@material-symbols/svg-400/outlined/left_panel_close.svg?react";
+import "@material-symbols/svg-400/outlined/add_notes.svg?react";
+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 "../common/contingency-table/columns-definitions.js";
+var TYPES = /* @__PURE__ */ ((TYPES2) => {
+  TYPES2["ENUM"] = "ENUM";
+  TYPES2["BOOL"] = "BOOL";
+  TYPES2["INTEGER"] = "INTEGER";
+  TYPES2["FLOAT"] = "FLOAT";
+  TYPES2["STRING"] = "STRING";
+  return TYPES2;
+})(TYPES || {});
+const defaultParamRender = (defParam, path, key) => {
+  switch (defParam.type) {
+    case "ENUM":
+      return /* @__PURE__ */ jsx(
+        SelectInput,
+        {
+          name: `${path}.${key}`,
+          label: "",
+          options: defParam?.options ?? [],
+          fullWidth: true,
+          size: "small"
+        }
+      );
+    case "BOOL":
+      return /* @__PURE__ */ jsx(SwitchInput, { name: `${path}.${key}`, label: "" });
+    case "INTEGER":
+      return /* @__PURE__ */ jsx(IntegerInput, { name: `${path}.${key}`, label: "" });
+    case "FLOAT":
+      return /* @__PURE__ */ jsx(FloatInput, { name: `${path}.${key}`, label: "" });
+    case "STRING":
+      return /* @__PURE__ */ jsx(TextInput, { name: `${path}.${key}`, label: "" });
+    default:
+      return /* @__PURE__ */ jsx(Fragment, {});
+  }
+};
+const makeComponent = (defParam, path, key) => {
+  const render = defParam?.render ?? defaultParamRender;
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsx(Grid, { item: true, xs: 8, sx: parametersStyles.parameterName, children: /* @__PURE__ */ jsx(FormattedMessage, { id: defParam.label }) }),
+    /* @__PURE__ */ jsx(Grid, { item: true, container: true, xs: 4, sx: parametersStyles.controlItem, children: render(defParam, path, key) })
+  ] });
+};
+const makeComponents = (defParams, path) => {
+  return Object.keys(defParams).map((key) => /* @__PURE__ */ jsxs(Grid, { container: true, spacing: 1, paddingTop: 1, children: [
+    makeComponent(defParams[key], path, key),
+    /* @__PURE__ */ jsx(LineSeparator, {})
+  ] }, key));
+};
+export {
+  TYPES,
+  makeComponent,
+  makeComponents
+};

package/dist/components/parameters/util/styles.d.ts

@@ -0,0 +1,38 @@
+import { Theme } from '@mui/material';
+export declare const parametersStyles: {
+    readonly parameterName: (theme: Theme) => {
+        fontWeight: string;
+        marginTop: string;
+    };
+    readonly scrollableGrid: (theme: Theme) => {
+        overflowY: "auto";
+        overflowX: "hidden";
+        maxHeight: string;
+        paddingRight: string;
+        paddingTop: string;
+        paddingBottom: string;
+        flexGrow: number;
+    };
+    readonly controlItem: {
+        readonly justifyContent: "flex-end";
+        readonly flexGrow: 1;
+    };
+    readonly controlParametersItem: {
+        readonly justifyContent: "flex-start";
+        readonly flexGrow: 1;
+        readonly height: "fit-content";
+        readonly paddingBottom: 4;
+    };
+    readonly marginTopButton: {
+        readonly marginTop: "10px";
+        readonly position: "sticky";
+        readonly bottom: 0;
+    };
+    readonly panel: (theme: Theme) => {
+        marginTop: string;
+        marginBottom: string;
+    };
+    readonly title: (theme: Theme) => {
+        padding: string;
+    };
+};

package/dist/components/parameters/util/styles.js

@@ -0,0 +1,41 @@
+const parametersStyles = {
+  parameterName: (theme) => ({
+    fontWeight: "bold",
+    marginTop: theme.spacing(1)
+  }),
+  scrollableGrid: (theme) => ({
+    overflowY: "auto",
+    overflowX: "hidden",
+    maxHeight: "85%",
+    // TODO This needs to be refactored
+    paddingRight: theme.spacing(2),
+    paddingTop: theme.spacing(2),
+    paddingBottom: theme.spacing(1),
+    flexGrow: 1
+  }),
+  controlItem: {
+    justifyContent: "flex-end",
+    flexGrow: 1
+  },
+  controlParametersItem: {
+    justifyContent: "flex-start",
+    flexGrow: 1,
+    height: "fit-content",
+    paddingBottom: 4
+  },
+  marginTopButton: {
+    marginTop: "10px",
+    position: "sticky",
+    bottom: 0
+  },
+  panel: (theme) => ({
+    marginTop: theme.spacing(2),
+    marginBottom: theme.spacing(1)
+  }),
+  title: (theme) => ({
+    padding: theme.spacing(2)
+  })
+};
+export {
+  parametersStyles
+};