@gridsuite/commons-ui 0.98.0 → 0.100.0

package/dist/utils/types/dynamic-simulation.type.d.ts

@@ -0,0 +1,111 @@
+import { UUID } from 'crypto';
+export declare enum SolverTypeInfos {
+    IDA = "IDA",
+    SIM = "SIM"
+}
+type CommonSolverInfos = {
+    id: string;
+    name: string;
+    type: SolverTypeInfos;
+    fNormTolAlg: number;
+    initialAddTolAlg: number;
+    scStepTolAlg: number;
+    mxNewTStepAlg: number;
+    msbsetAlg: number;
+    mxIterAlg: number;
+    printFlAlg: number;
+    fNormTolAlgJ: number;
+    initialAddTolAlgJ: number;
+    scStepTolAlgJ: number;
+    mxNewTStepAlgJ: number;
+    msbsetAlgJ: number;
+    mxIterAlgJ: number;
+    printFlAlgJ: number;
+    fNormTolAlgInit: number;
+    initialAddTolAlgInit: number;
+    scStepTolAlgInit: number;
+    mxNewTStepAlgInit: number;
+    msbsetAlgInit: number;
+    mxIterAlgInit: number;
+    printFlAlgInit: number;
+    maximumNumberSlowStepIncrease: number;
+    minimalAcceptableStep: number;
+};
+type IdaSolverInfos = CommonSolverInfos & {
+    name: 'IDA';
+    type: SolverTypeInfos.IDA;
+    order: number;
+    initStep: number;
+    minStep: number;
+    maxStep: number;
+    absAccuracy: number;
+    relAccuracy: number;
+};
+type SimSolverInfos = CommonSolverInfos & {
+    name: 'SIM';
+    type: SolverTypeInfos.SIM;
+    hMin: number;
+    hMax: number;
+    kReduceStep: number;
+    maxNewtonTry: number;
+    linearSolverName: string;
+    fNormTol: number;
+    initialAddTol: number;
+    scStepTol: number;
+    mxNewTStep: number;
+    msbset: number;
+    mxIter: number;
+    printFl: number;
+    optimizeAlgebraicResidualsEvaluations: boolean;
+    skipNRIfInitialGuessOK: boolean;
+    enableSilentZ: boolean;
+    optimizeReInitAlgebraicResidualsEvaluations: boolean;
+    minimumModeChangeTypeForAlgebraicRestoration: string;
+    minimumModeChangeTypeForAlgebraicRestorationInit: string;
+};
+type NetworkInfos = Record<string, number | string | boolean>;
+type CurveInfos = {
+    equipmentType?: string;
+    equipmentId: string;
+    variableId: string;
+};
+declare enum PropertyType {
+    ENUM = "ENUM",
+    BOOLEAN = "BOOLEAN",
+    INTEGER = "INTEGER",
+    FLOAT = "FLOAT",
+    STRING = "STRING"
+}
+type EventPropertyInfos = {
+    id: UUID;
+    name: string;
+    value: string;
+    type: PropertyType;
+};
+type EventInfos = {
+    id: UUID;
+    nodeId: UUID;
+    equipmentId: string;
+    equipmentType: string;
+    eventType: string;
+    properties: EventPropertyInfos[];
+};
+export type SolverInfos = IdaSolverInfos | SimSolverInfos;
+export type MappingInfos = {
+    name: string;
+};
+export type DynamicSimulationParametersInfos = {
+    provider?: string;
+    startTime?: number;
+    stopTime?: number;
+    mapping?: string;
+    solverId: string;
+    solvers?: SolverInfos[];
+    network?: NetworkInfos;
+    curves?: CurveInfos[] | null;
+    event?: EventInfos[];
+};
+export type DynamicSimulationParametersFetchReturn = DynamicSimulationParametersInfos & {
+    mappings?: MappingInfos[];
+};
+export {};

package/dist/utils/types/dynamic-simulation.type.js

@@ -0,0 +1,8 @@
+var SolverTypeInfos = /* @__PURE__ */ ((SolverTypeInfos2) => {
+  SolverTypeInfos2["IDA"] = "IDA";
+  SolverTypeInfos2["SIM"] = "SIM";
+  return SolverTypeInfos2;
+})(SolverTypeInfos || {});
+export {
+  SolverTypeInfos
+};

package/dist/utils/types/index.d.ts

@@ -11,3 +11,9 @@ export * from './metadata';
 export * from './types';
 export * from './modificationType';
 export * from './fieldType';
+export * from './parameters.type';
+export * from './dynamic-security-analysis.type';
+export * from './dynamic-simulation.type';
+export * from './loadflow.type';
+export * from './non-evacuated-energy.type';
+export * from './sensitivity-analysis.type';

package/dist/utils/types/index.js

@@ -1,15 +1,23 @@
 import { ElementType } from "./elementType.js";
 import { BASE_EQUIPMENTS, EQUIPMENT_TYPE, EquipmentType, ExtendedEquipmentType, HvdcType, OperatingStatus, SEARCH_EQUIPMENTS, TYPE_TAG_MAX_SIZE, VL_TAG_MAX_SIZE, equipmentStyles, getEquipmentsInfosForSearchBar } from "./equipmentType.js";
 import { Battery, BusBar, DanglingLine, Generator, Hvdc, LCC, Line, Load, SVC, ShuntCompensator, Substation, ThreeWindingTransfo, TwoWindingTransfo, VSC, VoltageLevel } from "./equipmentTypes.js";
+import { AnnouncementSeverity } from "./types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./modificationType.js";
 import { FieldType } from "./fieldType.js";
+import { ParameterType } from "./parameters.type.js";
+import { SolverTypeInfos } from "./dynamic-simulation.type.js";
+import { EnergySource } from "./non-evacuated-energy.type.js";
+import { DistributionType, SensitivityType } from "./sensitivity-analysis.type.js";
 export {
+  AnnouncementSeverity,
   BASE_EQUIPMENTS,
   Battery,
   BusBar,
   DanglingLine,
+  DistributionType,
   EQUIPMENT_TYPE,
   ElementType,
+  EnergySource,
   EquipmentType,
   ExtendedEquipmentType,
   FieldType,
@@ -22,9 +30,12 @@ export {
   MODIFICATION_TYPES,
   ModificationType,
   OperatingStatus,
+  ParameterType,
   SEARCH_EQUIPMENTS,
   SVC,
+  SensitivityType,
   ShuntCompensator,
+  SolverTypeInfos,
   Substation,
   TYPE_TAG_MAX_SIZE,
   ThreeWindingTransfo,

package/dist/utils/types/loadflow.type.d.ts

@@ -0,0 +1,11 @@
+import { UUID } from 'crypto';
+import { ILimitReductionsByVoltageLevel } from '../../components/parameters/common/limitreductions/columns-definitions';
+export interface LoadFlowParametersInfos {
+    uuid?: UUID;
+    provider: string;
+    limitReduction: number;
+    commonParameters: Record<string, boolean | string | string[] | number>;
+    specificParametersPerProvider: SpecificParametersPerProvider;
+    limitReductions: ILimitReductionsByVoltageLevel[];
+}
+export type SpecificParametersPerProvider = Record<string, Record<string, string>>;

package/dist/utils/types/loadflow.type.js

@@ -0,0 +1 @@
+

package/dist/utils/types/metadata.d.ts

@@ -21,5 +21,6 @@ export type StudyMetadata = Metadata & {
     };
     defaultCountry?: string;
     favoriteCountries?: string[];
+    substationPropertiesGlobalFilters?: Map<string, string[]>;
 };
 export {};

package/dist/utils/types/non-evacuated-energy.type.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Copyright (c) 2024, 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 enum EnergySource {
+    HYDRO = "HYDRO",
+    NUCLEAR = "NUCLEAR",
+    WIND = "WIND",
+    THERMAL = "THERMAL",
+    SOLAR = "SOLAR",
+    OTHER = "OTHER"
+}
+interface EquipmentsContainer {
+    containerId: string;
+    containerName: string;
+}
+interface NonEvacuatedEnergyGeneratorCappingsByType {
+    generators?: EquipmentsContainer[];
+    energySource: EnergySource;
+    activated: boolean;
+}
+interface NonEvacuatedEnergyStageDefinition {
+    generators?: EquipmentsContainer[];
+    energySource: EnergySource;
+    pMaxPercents?: (number | undefined)[];
+}
+interface NonEvacuatedEnergyStagesSelection {
+    name: string;
+    stagesDefinitionIndex?: (number | undefined)[];
+    pMaxPercentsIndex?: (number | undefined)[];
+    activated: boolean;
+}
+interface NonEvacuatedEnergyGeneratorsCappings {
+    sensitivityThreshold: number;
+    generators?: NonEvacuatedEnergyGeneratorCappingsByType[];
+}
+interface NonEvacuatedEnergyMonitoredBranches {
+    branches: EquipmentsContainer[];
+    activated: boolean;
+    istN: boolean;
+    limitNameN?: string | null;
+    nCoefficient: number;
+    istNm1: boolean;
+    limitNameNm1?: string | null;
+    nm1Coefficient: number;
+}
+interface NonEvacuatedEnergyContingencies {
+    contingencies: EquipmentsContainer[];
+    activated: boolean;
+}
+export interface NonEvacuatedEnergyParametersInfos {
+    stagesDefinition?: NonEvacuatedEnergyStageDefinition[];
+    stagesSelection?: NonEvacuatedEnergyStagesSelection[];
+    generatorsCappings?: NonEvacuatedEnergyGeneratorsCappings;
+    monitoredBranches?: NonEvacuatedEnergyMonitoredBranches[];
+    contingencies?: NonEvacuatedEnergyContingencies[];
+}
+export {};

package/dist/utils/types/non-evacuated-energy.type.js

@@ -0,0 +1,12 @@
+var EnergySource = /* @__PURE__ */ ((EnergySource2) => {
+  EnergySource2["HYDRO"] = "HYDRO";
+  EnergySource2["NUCLEAR"] = "NUCLEAR";
+  EnergySource2["WIND"] = "WIND";
+  EnergySource2["THERMAL"] = "THERMAL";
+  EnergySource2["SOLAR"] = "SOLAR";
+  EnergySource2["OTHER"] = "OTHER";
+  return EnergySource2;
+})(EnergySource || {});
+export {
+  EnergySource
+};

package/dist/utils/types/parameters.type.d.ts

@@ -0,0 +1,41 @@
+import { UUID } from 'crypto';
+import { ComputingType } from '../../components/parameters/common/computing-type';
+import { LoadFlowParametersInfos } from './loadflow.type';
+import { DynamicSecurityAnalysisParametersFetchReturn } from './dynamic-security-analysis.type';
+import { ILimitReductionsByVoltageLevel, ISAParameters } from '../../components/parameters/common/limitreductions/columns-definitions';
+import { DynamicSimulationParametersFetchReturn } from './dynamic-simulation.type';
+import { NonEvacuatedEnergyParametersInfos } from './non-evacuated-energy.type';
+import { SensitivityAnalysisParametersInfos } from './sensitivity-analysis.type';
+export declare enum ParameterType {
+    BOOLEAN = "BOOLEAN",
+    STRING = "STRING",
+    STRING_LIST = "STRING_LIST",
+    DOUBLE = "DOUBLE",
+    INTEGER = "INTEGER",
+    COUNTRIES = "COUNTRIES"
+}
+export type SpecificParameterInfos = {
+    name: string;
+    type: ParameterType;
+    names?: string[];
+    defaultValue?: any;
+    possibleValues?: any[];
+    categoryKey?: string;
+    description?: string;
+    label?: string;
+};
+export type SpecificParametersInfos = Record<string, SpecificParameterInfos>;
+export type ParametersInfos<T extends ComputingType> = T extends ComputingType.SENSITIVITY_ANALYSIS ? SensitivityAnalysisParametersInfos : T extends ComputingType.SECURITY_ANALYSIS ? ISAParameters : T extends ComputingType.NON_EVACUATED_ENERGY_ANALYSIS ? NonEvacuatedEnergyParametersInfos : T extends ComputingType.LOAD_FLOW ? LoadFlowParametersInfos : T extends ComputingType.DYNAMIC_SIMULATION ? DynamicSimulationParametersFetchReturn : T extends ComputingType.DYNAMIC_SECURITY_ANALYSIS ? DynamicSecurityAnalysisParametersFetchReturn : Record<string, any>;
+export type UseParametersBackendReturnProps<T extends ComputingType> = [
+    Record<string, string>,
+    string | undefined,
+    (studyUuid: UUID) => void,
+    (newProvider: string) => void,
+    () => void,
+    ParametersInfos<T> | null,
+    (studyUuid: UUID) => void,
+    (newParams: ParametersInfos<T>) => void,
+    () => Promise<void> | undefined,
+    Record<string, any> | null,
+    ILimitReductionsByVoltageLevel[]
+];

package/dist/utils/types/parameters.type.js

@@ -0,0 +1,12 @@
+var ParameterType = /* @__PURE__ */ ((ParameterType2) => {
+  ParameterType2["BOOLEAN"] = "BOOLEAN";
+  ParameterType2["STRING"] = "STRING";
+  ParameterType2["STRING_LIST"] = "STRING_LIST";
+  ParameterType2["DOUBLE"] = "DOUBLE";
+  ParameterType2["INTEGER"] = "INTEGER";
+  ParameterType2["COUNTRIES"] = "COUNTRIES";
+  return ParameterType2;
+})(ParameterType || {});
+export {
+  ParameterType
+};

package/dist/utils/types/sensitivity-analysis.type.d.ts

@@ -0,0 +1,101 @@
+import { UUID } from 'crypto';
+export declare enum DistributionType {
+    PROPORTIONAL = "PROPORTIONAL",
+    PROPORTIONAL_MAXP = "PROPORTIONAL_MAXP",
+    REGULAR = "REGULAR",
+    VENTILATION = "VENTILATION"
+}
+export declare enum SensitivityType {
+    DELTA_MW = "DELTA_MW",
+    DELTA_A = "DELTA_A"
+}
+interface EquipmentsContainer {
+    containerId: string;
+    containerName: string;
+}
+interface SensitivityParamsCommon {
+    contingencies?: EquipmentsContainer[];
+    activated?: boolean | null;
+}
+export interface SensitivityInjectionsSet extends SensitivityParamsCommon {
+    monitoredBranches?: EquipmentsContainer[];
+    injections?: EquipmentsContainer[];
+    distributionType?: DistributionType;
+}
+export interface SensitivityInjection extends SensitivityParamsCommon {
+    monitoredBranches?: EquipmentsContainer[];
+    injections?: EquipmentsContainer[];
+}
+export interface SensitivityHVDC extends SensitivityParamsCommon {
+    monitoredBranches?: EquipmentsContainer[];
+    sensitivityType?: SensitivityType;
+    hvdcs?: EquipmentsContainer[];
+}
+export interface SensitivityPST extends SensitivityParamsCommon {
+    monitoredBranches?: EquipmentsContainer[];
+    sensitivityType?: SensitivityType;
+    psts?: EquipmentsContainer[];
+}
+export interface SensitivityNodes extends SensitivityParamsCommon {
+    monitoredVoltageLevels?: EquipmentsContainer[];
+    equipmentsInVoltageRegulation?: EquipmentsContainer[];
+}
+export interface SensitivityAnalysisParametersInfos {
+    provider: string;
+    uuid?: UUID;
+    date?: Date;
+    name?: string;
+    flowFlowSensitivityValueThreshold: number;
+    angleFlowSensitivityValueThreshold: number;
+    flowVoltageSensitivityValueThreshold: number;
+    sensitivityInjectionsSet?: SensitivityInjectionsSet[];
+    sensitivityInjection?: SensitivityInjection[];
+    sensitivityHVDC?: SensitivityHVDC[];
+    sensitivityPST?: SensitivityPST[];
+    sensitivityNodes?: SensitivityNodes[];
+}
+export type SensitivityAnalysisFactorsCountParameters = {
+    injections?: string[];
+    monitoredBranches?: string[];
+    contingencies?: string[];
+    hvdcs?: string[];
+    psts?: string[];
+};
+export type SelectorFilterOptions = {
+    tabSelection: string;
+    functionType: string;
+};
+export type CsvConfig = {
+    csvHeaders: string[];
+    resultTab: string;
+    sensitivityFunctionType?: string;
+};
+export type SensitivityOfTo = {
+    type: 'SensitivityOfTo' | 'SensitivityWithContingency';
+    funcId: string;
+    varId: string;
+    varIsAFilter: boolean;
+    value: number;
+    functionReference: number;
+};
+export type SensitivityWithContingency = SensitivityOfTo & {
+    contingencyId: string;
+    valueAfter: number;
+    functionReferenceAfter: number;
+};
+export type Sensitivity = SensitivityOfTo | SensitivityWithContingency;
+export type SensitivityResult = {
+    resultTab: string;
+    functionType: string;
+    requestedChunkSize: number;
+    chunkOffset: number;
+    totalSensitivitiesCount: number;
+    filteredSensitivitiesCount: number;
+    sensitivities: Sensitivity[];
+};
+export type SensitivityResultFilterOptions = {
+    allContingencyIds?: string[];
+    allFunctionIds?: string[];
+    allVariableIds?: string[];
+};
+export {};

package/dist/utils/types/sensitivity-analysis.type.js

@@ -0,0 +1,16 @@
+var DistributionType = /* @__PURE__ */ ((DistributionType2) => {
+  DistributionType2["PROPORTIONAL"] = "PROPORTIONAL";
+  DistributionType2["PROPORTIONAL_MAXP"] = "PROPORTIONAL_MAXP";
+  DistributionType2["REGULAR"] = "REGULAR";
+  DistributionType2["VENTILATION"] = "VENTILATION";
+  return DistributionType2;
+})(DistributionType || {});
+var SensitivityType = /* @__PURE__ */ ((SensitivityType2) => {
+  SensitivityType2["DELTA_MW"] = "DELTA_MW";
+  SensitivityType2["DELTA_A"] = "DELTA_A";
+  return SensitivityType2;
+})(SensitivityType || {});
+export {
+  DistributionType,
+  SensitivityType
+};

package/dist/utils/types/types.d.ts

@@ -44,3 +44,15 @@ export type UserDetail = {
     numberCasesUsed: number;
     maxAllowedBuilds: number;
 };
+export declare enum AnnouncementSeverity {
+    INFO = "INFO",
+    WARN = "WARN"
+}
+export type AnnouncementDto = {
+    id: UUID;
+    startDate: Date;
+    endDate: Date;
+    message: string;
+    severity: AnnouncementSeverity;
+    remainingDuration: number;
+};

package/dist/utils/types/types.js

@@ -1 +1,8 @@
-
+var AnnouncementSeverity = /* @__PURE__ */ ((AnnouncementSeverity2) => {
+  AnnouncementSeverity2["INFO"] = "INFO";
+  AnnouncementSeverity2["WARN"] = "WARN";
+  return AnnouncementSeverity2;
+})(AnnouncementSeverity || {});
+export {
+  AnnouncementSeverity
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gridsuite/commons-ui",
-    "version": "0.98.0",
+    "version": "0.100.0",
     "description": "common react components for gridsuite applications",
     "author": "gridsuite team",
     "homepage": "https://github.com/gridsuite",
@@ -37,6 +37,7 @@
         "@ag-grid-community/locale": "^33.1.0",
         "@hello-pangea/dnd": "^18.0.1",
         "@material-symbols/svg-400": "^0.31.2",
+        "@mui/base": "^5.0.0-beta.40-0",
         "@react-querybuilder/dnd": "^8.2.0",
         "@react-querybuilder/material": "^8.2.0",
         "autosuggest-highlight": "^3.3.4",

package/dist/components/topBar/MessageBanner.d.ts

@@ -1,6 +0,0 @@
-import { ReactNode } from 'react';
-export interface MessageBannerProps {
-    children: ReactNode;
-}
-declare function MessageBanner({ children }: MessageBannerProps): false | import("react/jsx-runtime").JSX.Element;
-export default MessageBanner;

package/dist/components/topBar/MessageBanner.js

@@ -1,54 +0,0 @@
-import { jsxs, jsx } from "react/jsx-runtime";
-import { useState } from "react";
-import { Box } from "@mui/material";
-import { WarningAmber, Close } from "@mui/icons-material";
-const styles = {
-  banner: (theme) => ({
-    left: 0,
-    width: "100%",
-    backgroundColor: "#f6b26b",
-    color: "black",
-    padding: theme.spacing(1),
-    textAlign: "left",
-    boxShadow: "0px 2px 5px rgba(0, 0, 0, 0.1)",
-    zIndex: 1e3,
-    display: "flex",
-    justifyContent: "flex-start",
-    alignItems: "center"
-  }),
-  icon: (theme) => ({
-    paddingRight: theme.spacing(0.75),
-    color: "red",
-    marginTop: theme.spacing(0.5)
-  }),
-  message: {
-    flexGrow: 1
-  },
-  button: (theme) => ({
-    backgroundColor: "#f6b26b",
-    border: "none",
-    cursor: "pointer",
-    borderRadius: theme.spacing(0.5),
-    marginRight: theme.spacing(0.5),
-    width: theme.spacing(3.5),
-    height: theme.spacing(3.5),
-    "&:hover": {
-      backgroundColor: "#e39648"
-    },
-    "& svg": {
-      width: "100%",
-      height: "100%"
-    }
-  })
-};
-function MessageBanner({ children }) {
-  const [visible, setVisible] = useState(true);
-  return visible && /* @__PURE__ */ jsxs(Box, { sx: styles.banner, children: [
-    /* @__PURE__ */ jsx(Box, { sx: styles.icon, children: /* @__PURE__ */ jsx(WarningAmber, {}) }),
-    /* @__PURE__ */ jsx(Box, { sx: styles.message, children }),
-    /* @__PURE__ */ jsx(Box, { sx: styles.button, onClick: () => setVisible(false), children: /* @__PURE__ */ jsx(Close, {}) })
-  ] });
-}
-export {
-  MessageBanner as default
-};