@gridsuite/commons-ui 0.138.0 → 0.140.0

package/dist/services/index.js

@@ -1,4 +1,4 @@
-import { NetworkTimeoutError, backendFetch, backendFetchFile, backendFetchJson, backendFetchText, catchErrorHandler, getRequestParamFromList } from "./utils.js";
+import { NetworkTimeoutError, backendFetch, backendFetchFile, backendFetchJson, backendFetchText, getRequestParamFromList } from "./utils.js";
 import { createFilter, createParameter, fetchElementsInfos, saveFilter, updateParameter } from "./explore.js";
 import { fetchAppsMetadata, fetchDefaultCountry, fetchEnv, fetchFavoriteAndDefaultCountries, fetchStudyMetadata, isStudyMetadata } from "./appsMetadata.js";
 import { elementAlreadyExists, fetchConfigParameter, fetchConfigParameters, fetchDirectoryContent, fetchDirectoryElementPath, fetchRootFolders, getAppName, updateConfigParameter } from "./directory.js";
@@ -9,16 +9,13 @@ import { fetchCurrentAnnouncement, fetchUserDetails } from "./userAdmin.js";
 import { getVoltageInitParameters, getVoltageInitUrl } from "./voltage-init.js";
 import { getPccMinStudyParameters, updatePccMinParameters } from "./pcc-min.js";
 import { fetchDefaultSecurityAnalysisProvider, fetchSecurityAnalysisParameters, fetchSecurityAnalysisProviders, getSecurityAnalysisDefaultLimitReductions, getSecurityAnalysisParameters, getStudyUrl, safeEncodeURIComponent, setSecurityAnalysisParameters, updateSecurityAnalysisParameters, updateSecurityAnalysisProvider } from "./security-analysis.js";
-import { CustomError } from "./businessErrorCode.js";
 export {
-  CustomError,
   NetworkTimeoutError,
   PREFIX_STUDY_QUERIES,
   backendFetch,
   backendFetchFile,
   backendFetchJson,
   backendFetchText,
-  catchErrorHandler,
   createFilter,
   createParameter,
   elementAlreadyExists,

package/dist/services/utils.d.ts

@@ -18,5 +18,4 @@ export declare const backendFetchJson: (url: string, init?: FetchInitWithTimeout
 export declare function backendFetchText(url: string, init?: FetchInitWithTimeout, token?: string): Promise<string>;
 export declare const backendFetchFile: (url: string, init: RequestInit, token?: string) => Promise<Blob>;
 export declare const getRequestParamFromList: (paramName: string, params?: string[]) => URLSearchParams;
-export declare const catchErrorHandler: (error: unknown, callback: (message: string) => void) => void;
 export {};

package/dist/services/utils.js

@@ -1,5 +1,5 @@
 import { getUserToken } from "../redux/commonStore.js";
-import { CustomError } from "./businessErrorCode.js";
+import { CustomError } from "../utils/types/CustomError.js";
 const DEFAULT_TIMEOUT_MS = 5e4;
 class NetworkTimeoutError extends Error {
   constructor(messageKey = "errors.network.timeout") {
@@ -38,7 +38,12 @@ const handleError = (response) => {
     const errorJson = parseError(text);
     let customError;
     if (errorJson?.businessErrorCode != null) {
-      throw new CustomError(errorJson.message, errorJson.status, errorJson.businessErrorCode);
+      throw new CustomError(
+        errorJson.message,
+        errorJson.status,
+        errorJson.businessErrorCode,
+        errorJson.businessErrorValues
+      );
     }
     if (errorJson && errorJson.status && errorJson.error && errorJson.message) {
       customError = new CustomError(
@@ -82,19 +87,11 @@ const backendFetchFile = (url, init, token) => {
 const getRequestParamFromList = (paramName, params = []) => {
   return new URLSearchParams(params.map((param) => [paramName, param]));
 };
-const catchErrorHandler = (error, callback) => {
-  if (error instanceof Object && "message" in error && typeof error.message === "string") {
-    callback(error.message);
-  } else {
-    callback("unknown error");
-  }
-};
 export {
   NetworkTimeoutError,
   backendFetch,
   backendFetchFile,
   backendFetchJson,
   backendFetchText,
-  catchErrorHandler,
   getRequestParamFromList
 };

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

@@ -15,6 +15,24 @@ export declare const businessErrorsEn: {
     'explore.permissionDenied': string;
     'explore.maxElementsExceeded': string;
     'explore.incorrectCaseFile': string;
+    'study.notFound': string;
+    'study.computationRunning': string;
+    'study.loadflowError': string;
+    'study.notAllowed': string;
+    'study.cantDeleteRootNode': string;
+    'study.moveNetworkModificationForbidden': string;
+    'study.badNodeType': string;
+    'study.nodeNotBuilt': string;
+    'study.nodeNameAlreadyExist': string;
+    'study.timeSeriesBadType': string;
+    'study.noVoltageInitResultsForNode': string;
+    'study.maxNodeBuildsExceeded': string;
+    'study.rootNetworkDeleteForbidden': string;
+    'study.maximumRootNetworkByStudyReached': string;
+    'study.maximumTagLengthExceeded': string;
+    'study.networkExportFailed': string;
+    'study.tooManyNadConfigs': string;
+    'study.tooManyMapCards': string;
     'useradmin.permissionDenied': string;
     'useradmin.userNotFound': string;
     'useradmin.userAlreadyExists': string;

package/dist/translations/en/businessErrorsEn.js

@@ -9,6 +9,24 @@ const businessErrorsEn = {
   "explore.permissionDenied": "You are not allowed to perform this action.",
   "explore.maxElementsExceeded": "The number of allowed elements has been exceeded.",
   "explore.incorrectCaseFile": "The provided case file is incorrect.",
+  "study.notFound": "Study was not found.",
+  "study.computationRunning": "The operation cannot be performed because a computation is running.",
+  "study.loadflowError": "Loadflow error.",
+  "study.notAllowed": "Operation not allowed.",
+  "study.cantDeleteRootNode": "A root node cannot be deleted.",
+  "study.moveNetworkModificationForbidden": "Impossible to move this network modification.",
+  "study.badNodeType": "Bad node type.",
+  "study.nodeNotBuilt": "Node not built.",
+  "study.nodeNameAlreadyExist": "Node name already exists.",
+  "study.timeSeriesBadType": "Bad timeseries type.",
+  "study.noVoltageInitResultsForNode": "No voltage initialization results found.",
+  "study.maxNodeBuildsExceeded": "Maximum number of built nodes exceeded.",
+  "study.rootNetworkDeleteForbidden": "Impossible to delete this root network.",
+  "study.maximumRootNetworkByStudyReached": "Maximum number of root network per study exceeded.",
+  "study.maximumTagLengthExceeded": "Tag length exceeded.",
+  "study.networkExportFailed": "Failed to export network.",
+  "study.tooManyNadConfigs": "Maximum number of NAD configuration exceeded.",
+  "study.tooManyMapCards": "Maximum number of cards exceeded.",
   "useradmin.permissionDenied": "You don't have permission to perform this action.",
   "useradmin.userNotFound": "User not found.",
   "useradmin.userAlreadyExists": "User already exists.",
@@ -18,7 +36,7 @@ const businessErrorsEn = {
   "useradmin.groupAlreadyExists": "User group already exists.",
   "useradmin.announcementInvalidPeriod": "The announcement has an invalid time period.",
   "useradmin.announcementOverlap": "The announcement period overlaps with an existing one.",
-  "filter.filterCycleDetected": "Filter cycle detected."
+  "filter.filterCycleDetected": "Filter cycle detected: {filters}"
 };
 export {
   businessErrorsEn

package/dist/translations/en/equipmentShortEn.js

@@ -11,11 +11,11 @@ const equipmentShortEn = {
   "equipment_short/svc": "Static var compensators",
   "equipment_short/hvdcLine": "HVDC",
   "equipment_short/hvdcStation": "HVDC stations",
-  "equipment_short/vscConverterStation": "VSC",
-  "equipment_short/lccConverterStation": "LCC",
+  "equipment_short/vscConverterStation": "VSC stations",
+  "equipment_short/lccConverterStation": "LCC stations",
   "equipment_short/busbarSection": "BBS",
   "equipment_short/bus": "Bus",
-  "equipment_short/switch": "Switch",
+  "equipment_short/switch": "Switches",
   "equipment_short/danglingLine": "Dangling lines",
   "equipment_short/hvdcLineLcc": "HVDC LCC",
   "equipment_short/hvdcLineVsc": "HVDC VSC"

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

@@ -15,6 +15,24 @@ export declare const businessErrorsFr: {
     'explore.permissionDenied': string;
     'explore.maxElementsExceeded': string;
     'explore.incorrectCaseFile': string;
+    'study.notFound': string;
+    'study.computationRunning': string;
+    'study.loadflowError': string;
+    'study.notAllowed': string;
+    'study.cantDeleteRootNode': string;
+    'study.moveNetworkModificationForbidden': string;
+    'study.badNodeType': string;
+    'study.nodeNotBuilt': string;
+    'study.nodeNameAlreadyExist': string;
+    'study.timeSeriesBadType': string;
+    'study.noVoltageInitResultsForNode': string;
+    'study.maxNodeBuildsExceeded': string;
+    'study.rootNetworkDeleteForbidden': string;
+    'study.maximumRootNetworkByStudyReached': string;
+    'study.maximumTagLengthExceeded': string;
+    'study.networkExportFailed': string;
+    'study.tooManyNadConfigs': string;
+    'study.tooManyMapCards': string;
     'useradmin.permissionDenied': string;
     'useradmin.userNotFound': string;
     'useradmin.userAlreadyExists': string;

package/dist/translations/fr/businessErrorsFr.js

@@ -9,6 +9,24 @@ const businessErrorsFr = {
   "explore.permissionDenied": "Vous n'êtes pas autorisé à effectuer cette action.",
   "explore.maxElementsExceeded": "Le nombre d'éléments autorisés a été dépassé.",
   "explore.incorrectCaseFile": "Le fichier réseau fourni est incorrect.",
+  "study.notFound": "Étude non trouvée.",
+  "study.computationRunning": "L'opération ne peut être menée car un calcul est en cours.",
+  "study.loadflowError": "Erreur de calcul de répartition.",
+  "study.notAllowed": "Opération non permise.",
+  "study.cantDeleteRootNode": "Un noeud racine ne peut être supprimé.",
+  "study.moveNetworkModificationForbidden": "Impossible de déplacer cette modification de réseau.",
+  "study.badNodeType": "Mauvais type de noeud.",
+  "study.nodeNotBuilt": "Noeud non réalisé.",
+  "study.nodeNameAlreadyExist": "Ce nom de noeud existe déjà.",
+  "study.timeSeriesBadType": "Série temporelle de mauvais type.",
+  "study.noVoltageInitResultsForNode": "Pas de résultats pour l'initialisation du plan de tension.",
+  "study.maxNodeBuildsExceeded": "Nombre maximal de noeuds réalisés atteint.",
+  "study.rootNetworkDeleteForbidden": "Impossible de supprimer ce réseau racine.",
+  "study.maximumRootNetworkByStudyReached": "Nombre maximal de réseau racine par étude atteint.",
+  "study.maximumTagLengthExceeded": "Taille maximale d'étiquette atteinte.",
+  "study.networkExportFailed": "Échec de l'export de réseau.",
+  "study.tooManyNadConfigs": "Nombre maximal de configurations d'image nodale de zone atteint.",
+  "study.tooManyMapCards": "Nombre maximal de carte atteint.",
   "useradmin.permissionDenied": "Vous n'avez pas la permission d'effectuer cette action.",
   "useradmin.userNotFound": "Utilisateur introuvable.",
   "useradmin.userAlreadyExists": "L'utilisateur existe déjà.",
@@ -18,7 +36,7 @@ const businessErrorsFr = {
   "useradmin.groupAlreadyExists": "Le groupe d'utilisateurs existe déjà.",
   "useradmin.announcementInvalidPeriod": "La période de l'annonce est invalide.",
   "useradmin.announcementOverlap": "La période de l'annonce chevauche une autre annonce existante.",
-  "filter.filterCycleDetected": "Cycle de filtre détecté."
+  "filter.filterCycleDetected": "Cycle de filtre détecté: {filters}"
 };
 export {
   businessErrorsFr

package/dist/translations/fr/equipmentShortFr.js

@@ -11,11 +11,11 @@ const equipmentShortFr = {
   "equipment_short/svc": "CSPR",
   "equipment_short/hvdcLine": "HVDC",
   "equipment_short/hvdcStation": "Stations HVDC",
-  "equipment_short/vscConverterStation": "VSC",
-  "equipment_short/lccConverterStation": "LCC",
+  "equipment_short/vscConverterStation": "Stations VSC",
+  "equipment_short/lccConverterStation": "Stations LCC",
   "equipment_short/busbarSection": "SJB",
   "equipment_short/bus": "Noeud",
-  "equipment_short/switch": "Switch",
+  "equipment_short/switch": "OC",
   "equipment_short/danglingLine": "Frontières",
   "equipment_short/hvdcLineLcc": "HVDC LCC",
   "equipment_short/hvdcLineVsc": "HVDC VSC"

package/dist/utils/error.d.ts

@@ -0,0 +1,4 @@
+import { SnackInputs, UseSnackMessageReturn } from '../hooks/useSnackMessage';
+export type HeaderSnackInputs = Pick<SnackInputs, 'headerId' | 'headerTxt' | 'headerValues'>;
+export declare function catchErrorHandler(error: unknown, callback: (message: string) => void): void;
+export declare function snackWithFallback(snackError: UseSnackMessageReturn['snackError'], error: unknown, headerInputs?: HeaderSnackInputs): void;

package/dist/utils/error.js

@@ -0,0 +1,28 @@
+import { CustomError, formatMessageValues } from "./types/CustomError.js";
+function catchErrorHandler(error, callback) {
+  if (error instanceof Object && "message" in error && typeof error.message === "string") {
+    callback(error.message);
+  } else {
+    callback("unknown error");
+  }
+}
+function snackWithFallback(snackError, error, headerInputs) {
+  if (error instanceof CustomError && error.businessErrorCode) {
+    snackError({
+      messageId: error.businessErrorCode,
+      messageValues: error.businessErrorValues ? formatMessageValues(error.businessErrorValues) : void 0,
+      ...headerInputs
+    });
+  } else {
+    catchErrorHandler(error, (message) => {
+      snackError({
+        messageTxt: message,
+        ...headerInputs
+      });
+    });
+  }
+}
+export {
+  catchErrorHandler,
+  snackWithFallback
+};

package/dist/utils/index.d.ts

@@ -7,11 +7,14 @@
 export * from './algos';
 export * from './constants';
 export * from './conversionUtils';
+export * from './error';
 export * from './functions';
 export * from './langs';
 export * from './mapper';
+export * from './navigator-clipboard';
 export * from './constants/notificationsProvider';
 export * from './styles';
 export * from './types';
 export * from './validation-functions';
+export * from './labelUtils';
 export { default as yupConfig } from './yupConfig';

package/dist/utils/index.js

@@ -6,12 +6,15 @@ import { AMPERE, DEGREE, KILO_AMPERE, KILO_METER, KILO_VOLT, MEGA_VAR, MEGA_VOLT
 import { COMMON_APP_NAME, COMMON_CONFIG_PARAMS_NAMES, LAST_SELECTED_DIRECTORY, PARAM_DEVELOPER_MODE, PARAM_LANGUAGE, PARAM_THEME } from "./constants/configConstants.js";
 import { FILTERS, FILTER_ID, FILTER_NAME, ID } from "./constants/filterConstant.js";
 import { GRIDSUITE_DEFAULT_PRECISION, convertInputValue, convertOutputValue, isBlankOrEmpty, kiloUnitToUnit, microUnitToUnit, roundToDefaultPrecision, roundToPrecision, unitToKiloUnit, unitToMicroUnit } from "./conversionUtils.js";
+import { catchErrorHandler, snackWithFallback } from "./error.js";
 import { areArrayElementsUnique, isObjectEmpty, keyGenerator } from "./functions.js";
 import { LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM } from "./langs.js";
 import { getFileIcon } from "./mapper/getFileIcon.js";
 import { equipmentTypesForPredefinedPropertiesMapper } from "./mapper/equipmentTypesForPredefinedPropertiesMapper.js";
+import { copyToClipboard } from "./navigator-clipboard.js";
 import { NotificationsUrlKeys, PREFIX_CONFIG_NOTIFICATION_WS, PREFIX_DIRECTORY_NOTIFICATION_WS, PREFIX_STUDY_NOTIFICATION_WS } from "./constants/notificationsProvider.js";
 import { DARK_THEME, LIGHT_THEME, makeComposeClasses, mergeSx, toNestedGlobalSelectors } from "./styles.js";
+import { CustomError, formatMessageValues } from "./types/CustomError.js";
 import { ElementType } from "./types/elementType.js";
 import { ALL_EQUIPMENTS, BASE_EQUIPMENTS, EquipmentType, ExtendedEquipmentType, HvdcType, OperatingStatus, SEARCH_EQUIPMENTS, TYPE_TAG_MAX_SIZE, VL_TAG_MAX_SIZE, equipmentStyles, getEquipmentsInfosForSearchBar } from "./types/equipmentType.js";
 import { Battery, BusBar, DanglingLine, Generator, Hvdc, LCC, Line, Load, SVC, ShuntCompensator, Substation, ThreeWindingTransfo, TwoWindingTransfo, VSC, VoltageLevel } from "./types/equipmentTypes.js";
@@ -22,6 +25,7 @@ import { ParameterType } from "./types/parameters.type.js";
 import { SolverTypeInfos } from "./types/dynamic-simulation.type.js";
 import { DistributionType, SensitivityType } from "./types/sensitivity-analysis.type.js";
 import { toNumber, validateValueIsANumber } from "./validation-functions.js";
+import { getEquipmentTypeShortLabel, getEquipmentTypeTagLabel } from "./labelUtils.js";
 import "./yupConfig.js";
 import * as yup from "yup";
 export {
@@ -34,6 +38,7 @@ export {
   BusBar,
   COMMON_APP_NAME,
   COMMON_CONFIG_PARAMS_NAMES,
+  CustomError,
   DARK_THEME,
   DEGREE,
   DanglingLine,
@@ -95,11 +100,16 @@ export {
   VSC,
   VoltageLevel,
   areArrayElementsUnique,
+  catchErrorHandler,
   convertInputValue,
   convertOutputValue,
+  copyToClipboard,
   equalsArray,
   equipmentStyles,
   equipmentTypesForPredefinedPropertiesMapper,
+  formatMessageValues,
+  getEquipmentTypeShortLabel,
+  getEquipmentTypeTagLabel,
   getEquipmentsInfosForSearchBar,
   getFileIcon,
   isBlankOrEmpty,
@@ -111,6 +121,7 @@ export {
   microUnitToUnit,
   roundToDefaultPrecision,
   roundToPrecision,
+  snackWithFallback,
   toNestedGlobalSelectors,
   toNumber,
   unitToKiloUnit,

package/dist/utils/labelUtils.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2025, 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 function getEquipmentTypeShortLabel(equipmentType: string | undefined): string;
+export declare function getEquipmentTypeTagLabel(equipmentType: string | undefined): string;

package/dist/utils/labelUtils.js

@@ -0,0 +1,17 @@
+import { ALL_EQUIPMENTS } from "./types/equipmentType.js";
+function getEquipmentTypeShortLabel(equipmentType) {
+  if (!equipmentType) {
+    return "";
+  }
+  return ALL_EQUIPMENTS[equipmentType]?.shortLabel ?? "";
+}
+function getEquipmentTypeTagLabel(equipmentType) {
+  if (!equipmentType) {
+    return "";
+  }
+  return ALL_EQUIPMENTS[equipmentType]?.tagLabel ?? "";
+}
+export {
+  getEquipmentTypeShortLabel,
+  getEquipmentTypeTagLabel
+};

package/dist/utils/navigator-clipboard.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Copyright (c) 2025, 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 function copyToClipboard(valueToCopy: string, onSuccess?: () => void, onError?: () => void): void;

package/dist/utils/navigator-clipboard.js

@@ -0,0 +1,16 @@
+function copyToClipboard(valueToCopy, onSuccess, onError) {
+  if ("clipboard" in navigator) {
+    navigator.clipboard.writeText(valueToCopy).then(() => {
+      if (onSuccess) onSuccess();
+    }).catch((error) => {
+      console.error("Clipboard copy error: ", error);
+      if (onError) onError();
+    });
+  } else {
+    console.error("navigator.clipboard is not supported by your current navigator");
+    if (onError) onError();
+  }
+}
+export {
+  copyToClipboard
+};

package/dist/{services/businessErrorCode.d.ts → utils/types/CustomError.d.ts}

@@ -7,5 +7,7 @@
 export declare class CustomError extends Error {
     status: number;
     businessErrorCode?: string;
-    constructor(message: string, status: number, businessErrorCode?: string);
+    businessErrorValues?: Record<string, unknown>;
+    constructor(message: string, status: number, businessErrorCode?: string, businessErrorValues?: Record<string, unknown>);
 }
+export declare function formatMessageValues(properties: Record<string, unknown>): Record<string, string>;

package/dist/utils/types/CustomError.js

@@ -0,0 +1,20 @@
+class CustomError extends Error {
+  constructor(message, status, businessErrorCode, businessErrorValues) {
+    super(message);
+    this.status = status;
+    this.businessErrorCode = businessErrorCode;
+    this.businessErrorValues = businessErrorValues;
+  }
+}
+function formatMessageValues(properties) {
+  return Object.fromEntries(
+    Object.entries(properties).map(([key, value]) => [
+      key,
+      typeof value === "object" && value !== null ? JSON.stringify(value) : String(value)
+    ])
+  );
+}
+export {
+  CustomError,
+  formatMessageValues
+};

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

@@ -4,6 +4,7 @@
  * 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 * from './CustomError';
 export * from './elementType';
 export * from './equipmentType';
 export * from './equipmentTypes';

package/dist/utils/types/index.js

@@ -1,3 +1,4 @@
+import { CustomError, formatMessageValues } from "./CustomError.js";
 import { ElementType } from "./elementType.js";
 import { ALL_EQUIPMENTS, BASE_EQUIPMENTS, 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";
@@ -14,6 +15,7 @@ export {
   BASE_EQUIPMENTS,
   Battery,
   BusBar,
+  CustomError,
   DanglingLine,
   DistributionType,
   ElementType,
@@ -43,5 +45,6 @@ export {
   VSC,
   VoltageLevel,
   equipmentStyles,
+  formatMessageValues,
   getEquipmentsInfosForSearchBar
 };

package/package.json

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

package/dist/services/businessErrorCode.js

@@ -1,10 +0,0 @@
-class CustomError extends Error {
-  constructor(message, status, businessErrorCode) {
-    super(message);
-    this.status = status;
-    this.businessErrorCode = businessErrorCode;
-  }
-}
-export {
-  CustomError
-};