@gridsuite/commons-ui 0.142.0 → 0.143.0

package/dist/services/index.js

@@ -5,11 +5,12 @@ import { createFilter, createParameter, fetchElementsInfos, saveFilter, updatePa
 import { PREFIX_STUDY_QUERIES, fetchLoadFlowParameters, getDefaultLoadFlowProvider, getLoadFlowDefaultLimitReductions, getLoadFlowProviders, getLoadFlowSpecificParametersDescription, getLoadFlowUrl, setLoadFlowParameters } from "./loadflow.js";
 import { getPccMinStudyParameters, updatePccMinParameters } from "./pcc-min.js";
 import { fetchDefaultSecurityAnalysisProvider, fetchSecurityAnalysisParameters, fetchSecurityAnalysisProviders, getSecurityAnalysisDefaultLimitReductions, getSecurityAnalysisParameters, getStudyUrl, safeEncodeURIComponent, setSecurityAnalysisParameters, updateSecurityAnalysisParameters, updateSecurityAnalysisProvider } from "./security-analysis.js";
-import { exportFilter, getAvailableComponentLibraries, getStudyNetworkVisualizationsParameters, getStudyShortCircuitParameters, invalidateStudyShortCircuitStatus, setStudyNetworkVisualizationParameters, setStudyShortCircuitParameters, updateVoltageInitParameters } from "./study.js";
+import { exportFilter, getAvailableComponentLibraries, getStudyNetworkVisualizationsParameters, getStudyShortCircuitParameters, setStudyNetworkVisualizationParameters, updateVoltageInitParameters } from "./study.js";
 import { getNetworkVisualizationsParameters } from "./study-config.js";
 import { fetchCurrentAnnouncement, fetchUserDetails } from "./userAdmin.js";
 import { NetworkTimeoutError, backendFetch, backendFetchFile, backendFetchJson, backendFetchText, getRequestParamFromList } from "./utils.js";
 import { getVoltageInitParameters, getVoltageInitUrl } from "./voltage-init.js";
+import { fetchShortCircuitParameters, getShortCircuitSpecificParametersDescription, updateShortCircuitParameters } from "./short-circuit-analysis.js";
 export {
   NetworkTimeoutError,
   PREFIX_STUDY_QUERIES,
@@ -38,6 +39,7 @@ export {
   fetchRootFolders,
   fetchSecurityAnalysisParameters,
   fetchSecurityAnalysisProviders,
+  fetchShortCircuitParameters,
   fetchStudyMetadata,
   fetchUserDetails,
   getAppName,
@@ -52,24 +54,24 @@ export {
   getRequestParamFromList,
   getSecurityAnalysisDefaultLimitReductions,
   getSecurityAnalysisParameters,
+  getShortCircuitSpecificParametersDescription,
   getStudyNetworkVisualizationsParameters,
   getStudyShortCircuitParameters,
   getStudyUrl,
   getVoltageInitParameters,
   getVoltageInitUrl,
   hasElementPermission,
-  invalidateStudyShortCircuitStatus,
   isStudyMetadata,
   safeEncodeURIComponent,
   saveFilter,
   setLoadFlowParameters,
   setSecurityAnalysisParameters,
   setStudyNetworkVisualizationParameters,
-  setStudyShortCircuitParameters,
   updateConfigParameter,
   updateParameter,
   updatePccMinParameters,
   updateSecurityAnalysisParameters,
   updateSecurityAnalysisProvider,
+  updateShortCircuitParameters,
   updateVoltageInitParameters
 };

package/dist/services/short-circuit-analysis.d.ts

@@ -1,2 +1,5 @@
+import { UUID } from 'node:crypto';
 import { ShortCircuitParametersInfos } from '../components/parameters/short-circuit/short-circuit-parameters.type';
+export declare function getShortCircuitSpecificParametersDescription(): Promise<any>;
 export declare function fetchShortCircuitParameters(parameterUuid: string): Promise<ShortCircuitParametersInfos>;
+export declare function updateShortCircuitParameters(parameterUuid: UUID, newParams: any): Promise<Response>;

package/dist/services/short-circuit-analysis.js

@@ -1,13 +1,34 @@
-import { backendFetchJson } from "./utils.js";
+import { backendFetchJson, backendFetch } from "./utils.js";
 const PREFIX_SHORT_CIRCUIT_SERVER_QUERIES = `${"api/gateway"}/shortcircuit`;
 function getShortCircuitUrl() {
-  return `${PREFIX_SHORT_CIRCUIT_SERVER_QUERIES}/v1`;
+  return `${PREFIX_SHORT_CIRCUIT_SERVER_QUERIES}/v1/`;
+}
+function getShortCircuitSpecificParametersDescription() {
+  console.info("get short circuit specific parameters description");
+  const getShortCircuitSpecificParametersUrl = `${getShortCircuitUrl()}parameters/specific-parameters`;
+  console.debug(getShortCircuitSpecificParametersUrl);
+  return backendFetchJson(getShortCircuitSpecificParametersUrl);
 }
 function fetchShortCircuitParameters(parameterUuid) {
   console.info("get short circuit analysis parameters");
-  const url = `${getShortCircuitUrl()}/parameters/${encodeURIComponent(parameterUuid)}`;
+  const url = `${getShortCircuitUrl()}parameters/${encodeURIComponent(parameterUuid)}`;
   return backendFetchJson(url);
 }
+function updateShortCircuitParameters(parameterUuid, newParams) {
+  console.info("set short circuit parameters");
+  const setShortCircuitParametersUrl = `${getShortCircuitUrl()}parameters/${parameterUuid}`;
+  console.debug(setShortCircuitParametersUrl);
+  return backendFetch(setShortCircuitParametersUrl, {
+    method: "PUT",
+    headers: {
+      Accept: "application/json",
+      "Content-Type": "application/json"
+    },
+    body: newParams ? JSON.stringify(newParams) : null
+  });
+}
 export {
-  fetchShortCircuitParameters
+  fetchShortCircuitParameters,
+  getShortCircuitSpecificParametersDescription,
+  updateShortCircuitParameters
 };

package/dist/services/study.d.ts

@@ -1,12 +1,10 @@
 import { UUID } from 'node:crypto';
 import { NetworkVisualizationParameters } from '../components/parameters/network-visualizations/network-visualizations.types';
-import { ShortCircuitParameters, ShortCircuitParametersInfos } from '../components/parameters/short-circuit/short-circuit-parameters.type';
+import { ShortCircuitParametersInfos } from '../components/parameters/short-circuit/short-circuit-parameters.type';
 import { VoltageInitStudyParameters } from '../components/parameters/voltage-init/voltage-init.type';
 export declare function exportFilter(studyUuid: UUID, filterUuid?: UUID, token?: string): Promise<any>;
 export declare function getAvailableComponentLibraries(): Promise<string[]>;
 export declare function getStudyNetworkVisualizationsParameters(studyUuid: UUID): Promise<NetworkVisualizationParameters>;
 export declare function setStudyNetworkVisualizationParameters(studyUuid: UUID, newParams: Record<string, any>): Promise<Response>;
 export declare function getStudyShortCircuitParameters(studyUuid: UUID): Promise<ShortCircuitParametersInfos>;
-export declare function setStudyShortCircuitParameters(studyUuid: UUID, newParams: ShortCircuitParameters): Promise<Response>;
-export declare function invalidateStudyShortCircuitStatus(studyUuid: UUID): Promise<Response>;
 export declare function updateVoltageInitParameters(studyUuid: UUID | null, newParams: VoltageInitStudyParameters): Promise<Response>;

package/dist/services/study.js

@@ -34,23 +34,6 @@ function getStudyShortCircuitParameters(studyUuid) {
   console.info("get study short-circuit parameters");
   return backendFetchJson(`${PREFIX_STUDY_QUERIES}/v1/studies/${studyUuid}/short-circuit-analysis/parameters`);
 }
-function setStudyShortCircuitParameters(studyUuid, newParams) {
-  console.info("set study short-circuit parameters", newParams);
-  return backendFetch(`${PREFIX_STUDY_QUERIES}/v1/studies/${studyUuid}/short-circuit-analysis/parameters`, {
-    method: "POST",
-    headers: {
-      Accept: "application/json",
-      "Content-Type": "application/json"
-    },
-    body: newParams ? JSON.stringify(newParams) : null
-  });
-}
-function invalidateStudyShortCircuitStatus(studyUuid) {
-  console.info("invalidate study short circuit status");
-  return backendFetch(`${PREFIX_STUDY_QUERIES}/v1/studies/${studyUuid}/short-circuit/invalidate-status`, {
-    method: "PUT"
-  });
-}
 function updateVoltageInitParameters(studyUuid, newParams) {
   console.info("set study voltage init parameters");
   const url = `${PREFIX_STUDY_QUERIES}/v1/studies/${studyUuid}/voltage-init/parameters`;
@@ -69,8 +52,6 @@ export {
   getAvailableComponentLibraries,
   getStudyNetworkVisualizationsParameters,
   getStudyShortCircuitParameters,
-  invalidateStudyShortCircuitStatus,
   setStudyNetworkVisualizationParameters,
-  setStudyShortCircuitParameters,
   updateVoltageInitParameters
 };

package/dist/translations/en/parameters.d.ts

@@ -112,6 +112,9 @@ export declare const parametersEn: {
     ShortCircuitPredefinedParameters: string;
     ShortCircuitCharacteristics: string;
     ShortCircuitVoltageProfileMode: string;
+    ShortCircuitStartedGeneratorsMode: string;
+    ShortCircuitStartedLabel: string;
+    ShortCircuitAllLabel: string;
     shortCircuitLoads: string;
     shortCircuitHvdc: string;
     shortCircuitShuntCompensators: string;

package/dist/translations/en/parameters.js

@@ -106,6 +106,9 @@ const parametersEn = {
   ShortCircuitPredefinedParameters: "Preset parameters",
   ShortCircuitCharacteristics: "Features considered",
   ShortCircuitVoltageProfileMode: "Initial voltage profile",
+  ShortCircuitStartedGeneratorsMode: "Generators started",
+  ShortCircuitStartedLabel: "Started",
+  ShortCircuitAllLabel: "All",
   shortCircuitLoads: "Loads",
   shortCircuitHvdc: "HVDC (VSC)",
   shortCircuitShuntCompensators: "Shunt compensators",

package/dist/translations/fr/parameters.d.ts

@@ -112,6 +112,9 @@ export declare const parametersFr: {
     ShortCircuitPredefinedParameters: string;
     ShortCircuitCharacteristics: string;
     ShortCircuitVoltageProfileMode: string;
+    ShortCircuitStartedGeneratorsMode: string;
+    ShortCircuitStartedLabel: string;
+    ShortCircuitAllLabel: string;
     shortCircuitLoads: string;
     shortCircuitHvdc: string;
     shortCircuitShuntCompensators: string;

package/dist/translations/fr/parameters.js

@@ -106,6 +106,9 @@ const parametersFr = {
   ShortCircuitPredefinedParameters: "Paramètres prédéfinis",
   ShortCircuitCharacteristics: "Caractéristiques prises en compte",
   ShortCircuitVoltageProfileMode: "Plan de tension initial",
+  ShortCircuitStartedGeneratorsMode: "Démarrage des groupes",
+  ShortCircuitStartedLabel: "Démarrés",
+  ShortCircuitAllLabel: "Tous",
   shortCircuitLoads: "Charges",
   shortCircuitHvdc: "HVDC (VSC)",
   shortCircuitShuntCompensators: "MCS",

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

@@ -1,5 +1,6 @@
 import { UUID } from 'node:crypto';
 import { ILimitReductionsByVoltageLevel } from '../../components/parameters/common/limitreductions/columns-definitions';
+import { SpecificParametersPerProvider } from '../types/parameters.type';
 export interface LoadFlowParametersInfos {
     uuid?: UUID;
     provider: string;
@@ -8,4 +9,3 @@ export interface LoadFlowParametersInfos {
     specificParametersPerProvider: SpecificParametersPerProvider;
     limitReductions: ILimitReductionsByVoltageLevel[];
 }
-export type SpecificParametersPerProvider = Record<string, Record<string, string>>;

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

@@ -5,6 +5,7 @@ import { DynamicSecurityAnalysisParametersFetchReturn } from './dynamic-security
 import { ILimitReductionsByVoltageLevel, ISAParameters } from '../../components/parameters/common/limitreductions/columns-definitions';
 import { DynamicSimulationParametersFetchReturn } from './dynamic-simulation.type';
 import { SensitivityAnalysisParametersInfos } from './sensitivity-analysis.type';
+import { ShortCircuitParametersInfos } from '../../components/parameters/short-circuit/short-circuit-parameters.type';
 export declare enum ParameterType {
     BOOLEAN = "BOOLEAN",
     STRING = "STRING",
@@ -23,8 +24,10 @@ export type SpecificParameterInfos = {
     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.LOAD_FLOW ? LoadFlowParametersInfos : T extends ComputingType.DYNAMIC_SIMULATION ? DynamicSimulationParametersFetchReturn : T extends ComputingType.DYNAMIC_SECURITY_ANALYSIS ? DynamicSecurityAnalysisParametersFetchReturn : Record<string, any>;
+export type SpecificParametersDescription = Record<string, SpecificParameterInfos[]>;
+export type SpecificParametersValues = Record<string, any>;
+export type SpecificParametersPerProvider = Record<string, SpecificParametersValues>;
+export type ParametersInfos<T extends ComputingType> = T extends ComputingType.SENSITIVITY_ANALYSIS ? SensitivityAnalysisParametersInfos : T extends ComputingType.SECURITY_ANALYSIS ? ISAParameters : T extends ComputingType.LOAD_FLOW ? LoadFlowParametersInfos : T extends ComputingType.DYNAMIC_SIMULATION ? DynamicSimulationParametersFetchReturn : T extends ComputingType.DYNAMIC_SECURITY_ANALYSIS ? DynamicSecurityAnalysisParametersFetchReturn : T extends ComputingType.SHORT_CIRCUIT ? ShortCircuitParametersInfos : Record<string, any>;
 export type UseParametersBackendReturnProps<T extends ComputingType> = [
     Record<string, string>,
     string | undefined,
@@ -35,6 +38,6 @@ export type UseParametersBackendReturnProps<T extends ComputingType> = [
     (studyUuid: UUID) => void,
     (newParams: ParametersInfos<T>) => void,
     () => Promise<void> | undefined,
-    Record<string, any> | null,
+    SpecificParametersDescription | null,
     ILimitReductionsByVoltageLevel[]
 ];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gridsuite/commons-ui",
-    "version": "0.142.0",
+    "version": "0.143.0",
     "description": "common react components for gridsuite applications",
     "author": "gridsuite team",
     "homepage": "https://github.com/gridsuite",
@@ -141,7 +141,7 @@
         "typescript": "~5.9.3",
         "typescript-eslint": "^8.46.2",
         "vite": "^7.1.12",
-        "vite-plugin-checker": "^0.8.0",
+        "vite-plugin-checker": "^0.11.0",
         "vite-plugin-dts": "^4.5.4",
         "vite-plugin-lib-inject-css": "^2.2.2",
         "vite-plugin-svgr": "^4.5.0",