@gridsuite/commons-ui 0.280.0 → 0.282.0

package/dist/features/network-modifications/tabular/tabularCreation.utils.js

@@ -0,0 +1,276 @@
+import { v4 } from "uuid";
+import { FieldConstants } from "../../../utils/constants/fieldConstants.js";
+import "../../../utils/conversionUtils.js";
+import { CONNECTION_DIRECTIONS, ENERGY_SOURCES } from "../../../utils/types/equipmentType.js";
+import { MODIFICATION_TYPES, ModificationType } from "../../../utils/types/modificationType.js";
+import "react/jsx-runtime";
+import "@mui/icons-material";
+import { SHUNT_COMPENSATOR_TYPES } from "../shunt-compensator/common/shuntCompensator.utils.js";
+import "@mui/material";
+import "react-hook-form";
+import "react";
+import "react-intl";
+import "../../../components/ui/overflowableText/OverflowableText.js";
+import "localized-countries";
+import "localized-countries/data/fr";
+import "localized-countries/data/en";
+import "notistack";
+import "../../../components/ui/reactHookForm/provider/CustomFormProvider.js";
+import "yup";
+import "../../../components/ui/treeViewFinder/TreeViewFinder.js";
+import "../../../components/ui/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/arrows_input.svg?react";
+import "@material-symbols/svg-400/outlined/left_panel_close.svg?react";
+import "@material-symbols/svg-400/outlined/add_notes-fill.svg?react";
+import "../../../components/ui/dialogs/descriptionModificationDialog/DescriptionModificationDialog.js";
+import "../../../components/ui/reactHookForm/expandableInput/ExpandableInput.js";
+import "../../../components/ui/reactHookForm/directory-item-input/directory-item-utils.js";
+import "@hello-pangea/dnd";
+import "../../../components/ui/dialogs/elementSaveDialog/ElementSaveDialog.js";
+import "../../../components/ui/snackbarProvider/SnackbarProvider.js";
+import "mui-nested-menu";
+import "react-resizable-panels";
+import "react-papaparse";
+import "../common/properties/propertyUtils.js";
+import "react-dom";
+import "autosuggest-highlight/match";
+import "autosuggest-highlight/parse";
+import "clsx";
+import "../../../components/composite/filter/FilterCreationDialog.js";
+import "../../../components/composite/filter/HeaderFilterForm.js";
+import "../../../components/composite/filter/explicitNaming/ExplicitNamingFilterForm.js";
+import "../../../components/composite/filter/expert/ExpertFilterForm.js";
+import "../../../components/composite/filter/expert/ExpertFilterEditionDialog.js";
+import "../../../components/composite/filter/expert/expertFilterConstants.js";
+import "react-querybuilder";
+import "../../../components/composite/filter/explicitNaming/ExplicitNamingFilterEditionDialog.js";
+import "../../../components/composite/filter/utils/filterFormUtils.js";
+import "@react-querybuilder/material";
+import "../../../components/composite/reactQueryBuilder/CustomReactQueryBuilder.js";
+import "../../../components/composite/reactQueryBuilder/PropertyValueEditor.js";
+import "../../../components/composite/agGridTable/BottomTableButtons.js";
+import "../../../components/composite/agGridTable/CustomAgGridTable.js";
+import "ag-grid-community";
+import "../../../components/composite/customAGGrid/customAggrid.js";
+import "../../../components/composite/customAGGrid/context/custom-aggrid-context.js";
+import "mathjs";
+import "../../../components/composite/report/report-viewer/log-table/log-table.js";
+import "react-window";
+import "../../../components/composite/report/report-treeview/treeview-item.js";
+import "../../../components/composite/report/report-viewer/context/report-viewer-context.js";
+import "../common/regulatingTerminal/RegulatingTerminalForm.js";
+import "@mui/material/colors";
+import "@mui/x-charts";
+import "../common/currentLimits/limitsPane.utils.js";
+import "../shunt-compensator/creation/shuntCompensatorCreation.utils.js";
+import "../shunt-compensator/modification/shuntCompensatorModification.utils.js";
+import { TABULAR_BOOLEAN, TabularFieldConstants, TABULAR_NUMBER, TABULAR_ENUM, REGULATING_TERMINAL_TYPES, LOAD_TYPES_FOR_LOAD_TABULAR_CREATION_MODIFICATION } from "./tabular.constants.js";
+import { convertReactiveCapabilityCurvePointsFromBackToFront, formatModification, addPropertiesFromBack, transformProperties, convertReactiveCapabilityCurvePointsFromFrontToBack } from "./tabular.utils.js";
+const REACTIVE_CAPABILITY_CURVE_FIELDS = [
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE, required: true, type: TABULAR_BOOLEAN },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_P_MIN, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MIN_P_MIN, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MAX_P_MIN, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_P_0, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MIN_P_0, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MAX_P_0, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_P_MAX, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MIN_P_MAX, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_Q_MAX_P_MAX, required: false, type: TABULAR_NUMBER }
+];
+const CONNECTION_FIELDS = [
+  { id: FieldConstants.CONNECTED, required: true, type: TABULAR_BOOLEAN },
+  { id: FieldConstants.CONNECTION_NAME, required: false },
+  {
+    id: FieldConstants.CONNECTION_DIRECTION,
+    required: false,
+    type: TABULAR_ENUM,
+    options: CONNECTION_DIRECTIONS.map((direction) => direction.id)
+  },
+  { id: FieldConstants.CONNECTION_POSITION, required: false, type: TABULAR_NUMBER }
+];
+const VOLTAGE_REGULATION_FIELDS = [
+  { id: TabularFieldConstants.VOLTAGE_REGULATION_ON, required: true, type: TABULAR_BOOLEAN },
+  { id: FieldConstants.TARGET_V, required: false, type: TABULAR_NUMBER },
+  { id: TabularFieldConstants.REGULATING_TERMINAL_ID, required: false },
+  {
+    id: TabularFieldConstants.REGULATING_TERMINAL_TYPE,
+    required: false,
+    type: TABULAR_ENUM,
+    options: REGULATING_TERMINAL_TYPES
+  },
+  { id: FieldConstants.REGULATING_TERMINAL_VOLTAGE_LEVEL_ID, required: false }
+];
+const TABULAR_CREATION_FIELDS = {
+  GENERATOR: [
+    { id: TabularFieldConstants.EQUIPMENT_ID, required: true },
+    { id: FieldConstants.EQUIPMENT_NAME, required: false },
+    {
+      id: FieldConstants.ENERGY_SOURCE,
+      required: true,
+      type: TABULAR_ENUM,
+      options: ENERGY_SOURCES.map((energy) => energy.id)
+    },
+    { id: FieldConstants.VOLTAGE_LEVEL_ID, required: true },
+    { id: TabularFieldConstants.BUS_OR_BUSBAR_SECTION_ID, required: true },
+    ...CONNECTION_FIELDS,
+    { id: TabularFieldConstants.MIN_P, required: true, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.MAX_P, required: true, type: TABULAR_NUMBER },
+    { id: FieldConstants.RATED_S, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.MIN_Q, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.MAX_Q, required: false, type: TABULAR_NUMBER },
+    ...REACTIVE_CAPABILITY_CURVE_FIELDS,
+    { id: TabularFieldConstants.TARGET_P, required: true, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.TARGET_Q, required: true, type: TABULAR_NUMBER },
+    ...VOLTAGE_REGULATION_FIELDS,
+    { id: FieldConstants.Q_PERCENT, required: false, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.PARTICIPATE, required: true, type: TABULAR_BOOLEAN },
+    { id: FieldConstants.DROOP, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.TRANSIENT_REACTANCE, required: false, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.STEP_UP_TRANSFORMER_REACTANCE, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.PLANNED_ACTIVE_POWER_SET_POINT, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.MARGINAL_COST, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.PLANNED_OUTAGE_RATE, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.FORCED_OUTAGE_RATE, required: false, type: TABULAR_NUMBER }
+  ],
+  LOAD: [
+    { id: TabularFieldConstants.EQUIPMENT_ID, required: true },
+    { id: FieldConstants.EQUIPMENT_NAME, required: false },
+    {
+      id: FieldConstants.LOAD_TYPE,
+      required: true,
+      type: TABULAR_ENUM,
+      options: LOAD_TYPES_FOR_LOAD_TABULAR_CREATION_MODIFICATION.map((load) => load.id)
+    },
+    { id: FieldConstants.VOLTAGE_LEVEL_ID, required: true },
+    { id: TabularFieldConstants.BUS_OR_BUSBAR_SECTION_ID, required: true },
+    ...CONNECTION_FIELDS,
+    { id: TabularFieldConstants.P0, required: true, type: TABULAR_NUMBER },
+    { id: FieldConstants.Q0, required: true, type: TABULAR_NUMBER }
+  ],
+  BATTERY: [
+    { id: TabularFieldConstants.EQUIPMENT_ID, required: true },
+    { id: FieldConstants.EQUIPMENT_NAME, required: false },
+    { id: FieldConstants.VOLTAGE_LEVEL_ID, required: true },
+    { id: TabularFieldConstants.BUS_OR_BUSBAR_SECTION_ID, required: true },
+    ...CONNECTION_FIELDS,
+    { id: TabularFieldConstants.MIN_P, required: true, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.MAX_P, required: true, type: TABULAR_NUMBER },
+    { id: FieldConstants.MIN_Q, required: false, type: TABULAR_NUMBER },
+    { id: FieldConstants.MAX_Q, required: false, type: TABULAR_NUMBER },
+    ...REACTIVE_CAPABILITY_CURVE_FIELDS,
+    { id: TabularFieldConstants.TARGET_P, required: true, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.TARGET_Q, required: true, type: TABULAR_NUMBER },
+    { id: TabularFieldConstants.PARTICIPATE, required: true, type: TABULAR_BOOLEAN },
+    { id: FieldConstants.DROOP, required: false, type: TABULAR_NUMBER },
+    ...VOLTAGE_REGULATION_FIELDS
+  ],
+  SHUNT_COMPENSATOR: [
+    { id: TabularFieldConstants.EQUIPMENT_ID, required: true },
+    { id: FieldConstants.EQUIPMENT_NAME, required: false },
+    { id: FieldConstants.VOLTAGE_LEVEL_ID, required: true },
+    { id: TabularFieldConstants.BUS_OR_BUSBAR_SECTION_ID, required: true },
+    ...CONNECTION_FIELDS,
+    { id: FieldConstants.MAXIMUM_SECTION_COUNT, required: true, type: TABULAR_NUMBER },
+    { id: FieldConstants.SECTION_COUNT, required: true, type: TABULAR_NUMBER },
+    {
+      id: FieldConstants.SHUNT_COMPENSATOR_TYPE,
+      requiredIf: { id: FieldConstants.MAX_Q_AT_NOMINAL_V },
+      type: TABULAR_ENUM,
+      options: Object.keys(SHUNT_COMPENSATOR_TYPES)
+    },
+    {
+      id: FieldConstants.MAX_Q_AT_NOMINAL_V,
+      requiredIf: { id: FieldConstants.SHUNT_COMPENSATOR_TYPE },
+      type: TABULAR_NUMBER
+    },
+    { id: FieldConstants.MAX_SUSCEPTANCE, required: false, type: TABULAR_NUMBER }
+  ]
+};
+const TABULAR_CREATION_TYPES = {
+  GENERATOR: MODIFICATION_TYPES.GENERATOR_CREATION.type,
+  BATTERY: MODIFICATION_TYPES.BATTERY_CREATION.type,
+  LOAD: MODIFICATION_TYPES.LOAD_CREATION.type,
+  SHUNT_COMPENSATOR: MODIFICATION_TYPES.SHUNT_COMPENSATOR_CREATION.type
+};
+const convertCreationFieldFromBackToFront = (key, value) => {
+  if (key === TabularFieldConstants.REACTIVE_CAPABILITY_CURVE_POINTS) {
+    return convertReactiveCapabilityCurvePointsFromBackToFront(value);
+  }
+  return { key, value };
+};
+const convertCreationFieldFromFrontToBack = (key, value) => {
+  if (key === FieldConstants.CONNECTION_DIRECTION) {
+    return { key, value: value ?? "UNDEFINED" };
+  }
+  return { key, value };
+};
+const getEquipmentTypeFromCreationType = (type) => {
+  return Object.keys(TABULAR_CREATION_TYPES).find((key) => TABULAR_CREATION_TYPES[key] === type);
+};
+const convertCreations = (creations) => {
+  return creations.map((creat) => {
+    const creation = {};
+    Object.keys(formatModification(creat)).forEach((key) => {
+      const entry = convertCreationFieldFromBackToFront(key, creat[key]);
+      (Array.isArray(entry) ? entry : [entry]).forEach((item) => {
+        creation[item.key] = item.value;
+      });
+    });
+    return addPropertiesFromBack(creation, creat?.[TabularFieldConstants.TABULAR_PROPERTIES]);
+  });
+};
+const transformRowToBackEndCreation = (row, modificationType) => {
+  const creation = {
+    type: modificationType
+  };
+  const propertiesModifications = transformProperties(row);
+  Object.keys(row).forEach((key) => {
+    const entry = convertCreationFieldFromFrontToBack(key, row[key]);
+    creation[entry.key] = entry.value;
+  });
+  if (modificationType === ModificationType.GENERATOR_CREATION || modificationType === ModificationType.BATTERY_CREATION) {
+    convertReactiveCapabilityCurvePointsFromFrontToBack(creation);
+  }
+  if (propertiesModifications.length > 0) {
+    creation[TabularFieldConstants.TABULAR_PROPERTIES] = propertiesModifications;
+  }
+  return creation;
+};
+const transformCreationsTable = (modificationType, creationsTable = []) => creationsTable.map((row) => transformRowToBackEndCreation(row, modificationType));
+const tabularCreationDtoToForm = (dto) => {
+  const creations = convertCreations(dto?.modifications ?? []).map((creation) => ({
+    [FieldConstants.AG_GRID_ROW_UUID]: v4(),
+    ...creation
+  }));
+  return {
+    [FieldConstants.TYPE]: getEquipmentTypeFromCreationType(dto?.modificationType) ?? "",
+    [TabularFieldConstants.MODIFICATIONS_TABLE]: creations,
+    [TabularFieldConstants.TABULAR_PROPERTIES]: dto?.properties,
+    [TabularFieldConstants.CSV_FILENAME]: dto?.csvFilename
+  };
+};
+const tabularCreationFormToDto = (form) => {
+  const modificationType = TABULAR_CREATION_TYPES[form[FieldConstants.TYPE]];
+  return {
+    type: ModificationType.TABULAR_CREATION,
+    modificationType,
+    modifications: transformCreationsTable(modificationType, form[TabularFieldConstants.MODIFICATIONS_TABLE]),
+    csvFilename: form[TabularFieldConstants.CSV_FILENAME],
+    properties: form[TabularFieldConstants.TABULAR_PROPERTIES]
+  };
+};
+export {
+  TABULAR_CREATION_FIELDS,
+  TABULAR_CREATION_TYPES,
+  convertCreationFieldFromBackToFront,
+  convertCreationFieldFromFrontToBack,
+  convertCreations,
+  getEquipmentTypeFromCreationType,
+  tabularCreationDtoToForm,
+  tabularCreationFormToDto,
+  transformCreationsTable,
+  transformRowToBackEndCreation
+};

package/dist/features/network-modifications/tabular/tabularModification.utils.d.ts

@@ -0,0 +1,43 @@
+import { TabularFieldConstants } from './tabular.constants';
+import { TabularFields, TabularFormDto, TabularModificationDto, TabularModificationRow } from './tabular.types';
+import { TabularFormType } from './tabular.utils';
+export declare const TABULAR_MODIFICATION_FIELDS: TabularFields;
+export declare const TABULAR_MODIFICATION_TYPES: {
+    [key: string]: string;
+};
+export declare const getEquipmentTypeFromModificationType: (type: string) => string | undefined;
+export declare const convertInputValues: (key: string, value: {
+    value: string | number;
+}) => any;
+export declare const convertOutputValues: (key: string, value: string | number) => string | number | import('../../..').AttributeModification<any> | null;
+export declare const getTabularFieldType: (modificationType: string, key: string) => string;
+export declare const convertGeneratorOrBatteryModificationFromBackToFront: (modification: TabularModificationRow) => TabularModificationRow;
+export declare const convertGeneratorOrBatteryModificationFromFrontToBack: (modification: TabularModificationRow) => TabularModificationRow;
+export declare const TWT_TAP_CHANGER_FIELDS: TabularFieldConstants[];
+export declare const convertTWTTapChangerModificationFromFrontToBack: (modification: TabularModificationRow) => TabularModificationRow;
+/**
+ * Type definition for modification transformation strategies
+ */
+export type ModificationTransformationStrategy = {
+    [key: string]: (row: TabularModificationRow, modificationType: string) => TabularModificationRow;
+};
+/**
+ * Transformation strategies from front-end to back-end for different modification types
+ */
+export declare const MODIFICATION_TRANSFORMATION_STRATEGIES: ModificationTransformationStrategy;
+/**
+ * Transforms a single row of form data into a modification object for the back-end
+ * @param row - The form data row to transform
+ * @param modificationType - The type of modification being performed
+ * @returns The transformed modification object
+ */
+export declare const transformRowToBackEndModification: (row: TabularModificationRow, modificationType: string) => TabularModificationRow;
+/**
+ * Transforms form data modifications table into an array of back-end modification objects
+ * @param modificationsTable - Array of form data rows
+ * @param modificationType - The type of modification being performed
+ * @returns Array of transformed modification objects
+ */
+export declare const transformModificationsTable: (modificationType: string, modificationsTable?: TabularModificationRow[]) => TabularModificationRow[];
+export declare const tabularModificationDtoToForm: (dto: TabularModificationDto) => TabularFormType;
+export declare const tabularModificationFormToDto: (form: TabularFormType) => TabularFormDto;