@gridsuite/commons-ui 0.271.0 → 0.272.0

package/dist/features/results/shortcircuit/shortcircuit-analysis-result.js

@@ -0,0 +1,252 @@
+import { jsxs, Fragment, jsx } from "react/jsx-runtime";
+import { useState, useCallback, useEffect } from "react";
+import { useIntl } from "react-intl";
+import { Box, LinearProgress } from "@mui/material";
+import { RESULTS_LOADING_DELAY } from "../constants.js";
+import { FROM_COLUMN_TO_FIELD_ONE_BUS, FROM_COLUMN_TO_FIELD, convertFilterValues } from "./shortcircuit-analysis-result-content.js";
+import { ShortCircuitAnalysisType } from "./shortcircuit-analysis-result.type.js";
+import { ShortCircuitAnalysisResultTable } from "./shortcircuit-analysis-result-table.js";
+import "../../../utils/conversionUtils.js";
+import { snackWithFallback } from "../../../utils/error.js";
+import { RunningStatus } from "../../../utils/running-status.js";
+import "../../../utils/types/equipmentType.js";
+import { ComputingType } from "../../../utils/types/computing-type.js";
+import "@mui/icons-material";
+import "localized-countries";
+import "localized-countries/data/fr";
+import "localized-countries/data/en";
+import { useSnackMessage } from "../../../hooks/useSnackMessage.js";
+import { useOpenLoaderShortWait } from "../../../hooks/useOpenLoaderShortWait.js";
+import "../../../components/ui/overflowableText/OverflowableText.js";
+import "react-hook-form";
+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 { CustomTablePagination } from "../../../components/ui/tablepagination/custom-table-pagination.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 "uuid";
+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 { RESULT_PAGE_OPTIONS } from "../common/utils.js";
+function ShortCircuitAnalysisResult({
+  analysisType,
+  analysisStatus,
+  result,
+  updateResult,
+  customTablePaginationProps,
+  onGridColumnsChanged,
+  onRowDataUpdated,
+  onDisplayedColumnsChanged,
+  studyUuid,
+  currentNodeUuid,
+  currentRootNetworkUuid,
+  sortConfig,
+  columnFilters,
+  globalFilters,
+  pagination,
+  onPageChange,
+  onRowsPerPageChange,
+  fetchPagedResults,
+  fetchFilterEnumValues,
+  mapFieldsToColumnsFilter,
+  onVoltageLevelClick,
+  onGridReady
+}) {
+  const intl = useIntl();
+  const { snackError } = useSnackMessage();
+  const [count, setCount] = useState(0);
+  const [isFetching, setIsFetching] = useState(false);
+  const [filterEnums, setFilterEnums] = useState({});
+  const isOneBusShortCircuitAnalysisType = analysisType === ShortCircuitAnalysisType.ONE_BUS;
+  const fromFrontColumnToBackKeys = isOneBusShortCircuitAnalysisType ? FROM_COLUMN_TO_FIELD_ONE_BUS : FROM_COLUMN_TO_FIELD;
+  const { page, rowsPerPage } = pagination;
+  const handleChangePage = useCallback(
+    (_, newPage) => {
+      onPageChange(newPage);
+    },
+    [onPageChange]
+  );
+  const handleChangeRowsPerPage = useCallback(
+    (event) => {
+      const newRowsPerPage = Number.parseInt(event.target.value, 10);
+      onRowsPerPageChange(newRowsPerPage);
+    },
+    [onRowsPerPageChange]
+  );
+  useEffect(() => {
+    if (analysisStatus !== RunningStatus.SUCCEED) {
+      return;
+    }
+    if (!currentNodeUuid || !currentRootNetworkUuid) {
+      return;
+    }
+    let active = true;
+    setIsFetching(true);
+    updateResult(null);
+    const backSortConfig = sortConfig?.map((sort) => ({
+      ...sort,
+      colId: fromFrontColumnToBackKeys[sort.colId]
+    }));
+    const updatedFilters = columnFilters ? convertFilterValues(columnFilters) : null;
+    const selector = {
+      page,
+      size: rowsPerPage,
+      filter: updatedFilters && mapFieldsToColumnsFilter ? mapFieldsToColumnsFilter(updatedFilters, fromFrontColumnToBackKeys) : updatedFilters,
+      sort: backSortConfig
+    };
+    fetchPagedResults({
+      studyUuid,
+      currentNodeUuid,
+      currentRootNetworkUuid,
+      type: analysisType,
+      selector,
+      globalFilters
+    }).then((pagedResult) => {
+      if (active) {
+        const { content = [], totalElements = 0 } = pagedResult || {};
+        updateResult(content);
+        setCount(totalElements);
+      }
+    }).catch((error) => snackWithFallback(snackError, error, { headerId: "ShortCircuitAnalysisResultsError" })).finally(() => {
+      if (active) {
+        setIsFetching(false);
+      }
+    });
+    return () => {
+      active = false;
+    };
+  }, [
+    page,
+    rowsPerPage,
+    snackError,
+    analysisType,
+    analysisStatus,
+    updateResult,
+    studyUuid,
+    currentNodeUuid,
+    currentRootNetworkUuid,
+    intl,
+    columnFilters,
+    sortConfig,
+    fromFrontColumnToBackKeys,
+    globalFilters,
+    fetchPagedResults,
+    mapFieldsToColumnsFilter
+  ]);
+  useEffect(() => {
+    if (analysisStatus !== RunningStatus.SUCCEED || !studyUuid || !currentNodeUuid || !currentRootNetworkUuid) {
+      return;
+    }
+    const allBusesFilterTypes = ["fault-types", "limit-violation-types"];
+    const oneBusFilterTypes = ["branch-sides"];
+    const currentComputingType = isOneBusShortCircuitAnalysisType ? ComputingType.SHORT_CIRCUIT_ONE_BUS : ComputingType.SHORT_CIRCUIT;
+    const filterTypes = isOneBusShortCircuitAnalysisType ? oneBusFilterTypes : allBusesFilterTypes;
+    const promises = filterTypes.map(
+      (filterType) => fetchFilterEnumValues({
+        studyUuid,
+        currentNodeUuid,
+        currentRootNetworkUuid,
+        computingType: currentComputingType,
+        filterType
+      })
+    );
+    Promise.all(promises).then((results) => {
+      if (isOneBusShortCircuitAnalysisType) {
+        const [branchSidesResult] = results;
+        setFilterEnums({
+          side: branchSidesResult
+        });
+      } else {
+        const [faultTypesResult, limitViolationTypesResult] = results;
+        setFilterEnums({
+          limitType: limitViolationTypesResult,
+          faultType: faultTypesResult
+        });
+      }
+    }).catch((error) => snackWithFallback(snackError, error, { headerId: "ShortCircuitAnalysisResultsError" }));
+  }, [
+    analysisStatus,
+    intl,
+    snackError,
+    isOneBusShortCircuitAnalysisType,
+    studyUuid,
+    currentNodeUuid,
+    currentRootNetworkUuid,
+    fetchFilterEnumValues
+  ]);
+  const openLoader = useOpenLoaderShortWait({
+    isLoading: analysisStatus === RunningStatus.RUNNING || isFetching,
+    delay: RESULTS_LOADING_DELAY
+  });
+  return /* @__PURE__ */ jsxs(Fragment, { children: [
+    /* @__PURE__ */ jsx(Box, { sx: { height: "4px" }, children: openLoader && /* @__PURE__ */ jsx(LinearProgress, {}) }),
+    /* @__PURE__ */ jsx(
+      ShortCircuitAnalysisResultTable,
+      {
+        result,
+        analysisType,
+        isFetching,
+        filterEnums,
+        onDisplayedColumnsChanged,
+        onRowDataUpdated,
+        shortCircuitAnalysisStatus: analysisStatus,
+        columnFilters,
+        onGridReady: onGridReady ?? onGridColumnsChanged,
+        onVoltageLevelClick
+      }
+    ),
+    /* @__PURE__ */ jsx(
+      CustomTablePagination,
+      {
+        rowsPerPageOptions: RESULT_PAGE_OPTIONS,
+        count,
+        rowsPerPage,
+        page,
+        onPageChange: handleChangePage,
+        onRowsPerPageChange: handleChangeRowsPerPage,
+        ...customTablePaginationProps
+      }
+    )
+  ] });
+}
+export {
+  ShortCircuitAnalysisResult
+};

package/dist/features/results/shortcircuit/shortcircuit-analysis-result.type.d.ts

@@ -0,0 +1,41 @@
+import { Page } from '../../common';
+export interface SCAFault {
+    id: string;
+    elementId: string;
+    voltageLevelId: string;
+    faultType: string;
+}
+export interface SCALimitViolation {
+    subjectId: string;
+    limitType: string;
+    limit: number;
+    limitName: string;
+    value: number;
+}
+export interface SCAFeederResult {
+    connectableId: string;
+    current: number;
+    positiveMagnitude: number;
+    side: string;
+}
+interface SCAShortCircuitLimits {
+    ipMin: number;
+    ipMax: number;
+    deltaCurrentIpMax: number | null;
+    deltaCurrentIpMin: number | null;
+}
+export interface SCAFaultResult {
+    fault: SCAFault;
+    current: number;
+    positiveMagnitude: number;
+    shortCircuitPower: number;
+    shortCircuitLimits: SCAShortCircuitLimits;
+    limitViolations?: SCALimitViolation[];
+    feederResults?: SCAFeederResult[];
+}
+export type SCAPagedResults = Page<SCAFaultResult> | Page<SCAFeederResult>;
+export declare enum ShortCircuitAnalysisType {
+    ALL_BUSES = 0,
+    ONE_BUS = 1
+}
+export {};

package/dist/features/results/shortcircuit/shortcircuit-analysis-result.type.js

@@ -0,0 +1,8 @@
+var ShortCircuitAnalysisType = /* @__PURE__ */ ((ShortCircuitAnalysisType2) => {
+  ShortCircuitAnalysisType2[ShortCircuitAnalysisType2["ALL_BUSES"] = 0] = "ALL_BUSES";
+  ShortCircuitAnalysisType2[ShortCircuitAnalysisType2["ONE_BUS"] = 1] = "ONE_BUS";
+  return ShortCircuitAnalysisType2;
+})(ShortCircuitAnalysisType || {});
+export {
+  ShortCircuitAnalysisType
+};

package/dist/index.js

@@ -473,9 +473,15 @@ import { useGlobalAnnouncement } from "./features/announcement/useGlobalAnnounce
 import { SecurityAnalysisResultNmk } from "./features/results/securityanalysis/security-analysis-result-nmk.js";
 import { SecurityAnalysisTable } from "./features/results/securityanalysis/security-analysis-table.js";
 import { NmkType } from "./features/results/securityanalysis/security-analysis.type.js";
-import { PAGE_OPTIONS, flattenNmKResultsConstraints, flattenNmKResultsContingencies, handlePostSortRows, mapNmKResultsCutOffPower } from "./features/results/securityanalysis/utils.js";
+import { flattenNmKResultsConstraints, flattenNmKResultsContingencies, handlePostSortRows, mapNmKResultsCutOffPower } from "./features/results/securityanalysis/utils.js";
 import { LimitViolationResult } from "./features/results/loadflow/limit-violation-result.js";
 import { getNoRowsMessage } from "./features/results/utils/no-rows-message.js";
+import { RESULT_PAGE_OPTIONS, createMultiEnumFilterParams } from "./features/results/common/utils.js";
+import { ShortCircuitAnalysisType } from "./features/results/shortcircuit/shortcircuit-analysis-result.type.js";
+import { ALL_BUSES, FROM_COLUMN_TO_FIELD, FROM_COLUMN_TO_FIELD_ONE_BUS, ONE_BUS, convertFilterValues, mappingTabs } from "./features/results/shortcircuit/shortcircuit-analysis-result-content.js";
+import { SHORTCIRCUIT_ANALYSIS_RESULT_SORT_STORE, ShortCircuitAnalysisResultTable, numericFilterParams, resultsStyles, textFilterParams } from "./features/results/shortcircuit/shortcircuit-analysis-result-table.js";
+import { ShortCircuitAnalysisResult } from "./features/results/shortcircuit/shortcircuit-analysis-result.js";
+import { ShortCircuitAnalysisAllBusesResult } from "./features/results/shortcircuit/shortcircuit-analysis-all-buses-result.js";
 import { RESULTS_LOADING_DELAY } from "./features/results/constants.js";
 import { ProcessType } from "./features/process-configs/common/process-config.type.js";
 import { emptyProcessConfigModificationsFormData, getProcessConfigModificationsBackendFromFormData, getProcessConfigModificationsFormData, processConfigModificationsShape } from "./features/process-configs/common/process-config-modifications-edition.utils.js";
@@ -582,6 +588,7 @@ export {
   ACTIVE,
   ACTIVE_LIMITS_MIN_MAX_INVALID,
   ADVANCED_PARAMETERS,
+  ALL_BUSES,
   ALL_EQUIPMENTS,
   AMPERE,
   APPLICABILITY,
@@ -807,6 +814,8 @@ export {
   FILTER_NAME,
   FLOW_PROPORTIONAL_THRESHOLD,
   FORMULAS,
+  FROM_COLUMN_TO_FIELD,
+  FROM_COLUMN_TO_FIELD_ONE_BUS,
   FetchStatus,
   FieldConstants,
   FieldErrorAlert,
@@ -998,6 +1007,7 @@ export {
   NumericCellRenderer,
   NumericEditor,
   OHM,
+  ONE_BUS,
   OPERATIONAL_LIMITS_GROUPS_MODIFICATION_TYPE,
   OPERATOR,
   OPERATOR_OPTIONS,
@@ -1013,7 +1023,6 @@ export {
   OverflowableTableCell,
   OverflowableTableCellWithCheckbox,
   OverflowableText,
-  PAGE_OPTIONS,
   PARAM_CENTER_LABEL,
   PARAM_COMPONENT_LIBRARY,
   PARAM_DEVELOPER_MODE,
@@ -1089,6 +1098,7 @@ export {
   REPORT_SEVERITY,
   RESET_AUTHENTICATION_ROUTER_ERROR,
   RESULTS_LOADING_DELAY,
+  RESULT_PAGE_OPTIONS,
   RULES,
   RadioInput,
   RangeInput,
@@ -1124,6 +1134,7 @@ export {
   SELECTED,
   SELECTION_TYPE,
   SENSITIVITY_TYPES,
+  SHORTCIRCUIT_ANALYSIS_RESULT_SORT_STORE,
   SHORT_CIRCUIT_CURRENT_LIMIT_MUST_BE_GREATER_OR_EQUAL_TO_ZERO,
   SHORT_CIRCUIT_INITIAL_VOLTAGE_PROFILE_MODE,
   SHORT_CIRCUIT_MODEL_POWER_ELECTRONICS,
@@ -1179,6 +1190,10 @@ export {
   SensitivityType,
   SeparatorCellRenderer,
   SetPointsForm,
+  ShortCircuitAnalysisAllBusesResult,
+  ShortCircuitAnalysisResult,
+  ShortCircuitAnalysisResultTable,
+  ShortCircuitAnalysisType,
   ShortCircuitForm,
   ShortCircuitParametersEditionDialog,
   ShortCircuitParametersInLine,
@@ -1330,6 +1345,7 @@ export {
   computeSwitchedOnValue,
   computeTagMinSize,
   computeTolerance,
+  convertFilterValues,
   convertInputValue,
   convertLimitsToOperationalLimitsGroupFormSchema,
   convertOutputValue,
@@ -1350,6 +1366,7 @@ export {
   createFilter,
   createHeaderCellStyle,
   createModificationNameCellStyle,
+  createMultiEnumFilterParams,
   createNameCellLabelBoxSx,
   createNameCellRootStyle,
   createParameter,
@@ -1725,6 +1742,7 @@ export {
   mapSecurityAnalysisParameters,
   mapSensitivityAnalysisParameters,
   mapServerLimitsGroupsToFormInfos,
+  mappingTabs,
   markEditingGlobalFilter,
   markNotFoundGlobalFiltersAsDeletedInState,
   mergeModificationAndEquipmentProperties,
@@ -1750,6 +1768,7 @@ export {
   newEquipmentDeletionDto,
   notNull,
   notUndefined,
+  numericFilterParams,
   onlyStartedGeneratorsOptions,
   parametersEn,
   parametersFr,
@@ -1767,6 +1786,7 @@ export {
   reportViewerEn,
   reportViewerFr,
   resetAuthenticationRouterError,
+  resultsStyles,
   richTypeEquals,
   roundToDefaultPrecision,
   roundToPrecision,
@@ -1826,6 +1846,7 @@ export {
   tableFr,
   testQuery,
   testValueWithinPowerInterval,
+  textFilterParams,
   toBeEstimatedEmptyFormData,
   toFloatOrNullValue,
   toFormValuesContingencyListsInfos,

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

@@ -24,4 +24,4 @@ export * from './dynamic-margin-calculation.type';
 export * from './network-modification-types';
 export * from './pcc-min.type';
 export * from './network-modification-metadata';
-export { ComputingType } from './computing-type';
+export * from './computing-type';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gridsuite/commons-ui",
-    "version": "0.271.0",
+    "version": "0.272.0",
     "description": "common react components for gridsuite applications",
     "author": "gridsuite team",
     "homepage": "https://github.com/gridsuite",