@gridsuite/commons-ui 0.138.0 → 0.139.0

package/dist/utils/index.js

@@ -6,12 +6,14 @@ 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 { 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 +24,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 +37,7 @@ export {
   BusBar,
   COMMON_APP_NAME,
   COMMON_CONFIG_PARAMS_NAMES,
+  CustomError,
   DARK_THEME,
   DEGREE,
   DanglingLine,
@@ -95,11 +99,15 @@ export {
   VSC,
   VoltageLevel,
   areArrayElementsUnique,
+  catchErrorHandler,
   convertInputValue,
   convertOutputValue,
   equalsArray,
   equipmentStyles,
   equipmentTypesForPredefinedPropertiesMapper,
+  formatMessageValues,
+  getEquipmentTypeShortLabel,
+  getEquipmentTypeTagLabel,
   getEquipmentsInfosForSearchBar,
   getFileIcon,
   isBlankOrEmpty,
@@ -111,6 +119,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/{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.139.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
-};