@gridsuite/commons-ui 0.163.0 → 0.164.0

package/dist/utils/constants/adornments.js

@@ -0,0 +1,58 @@
+import { MICRO_SIEMENS, SIEMENS, OHM, AMPERE, KILO_AMPERE, MEGA_WATT, MEGA_VAR, MEGA_VOLT_AMPERE, KILO_VOLT, KILO_METER, PERCENTAGE } from "./unitsConstants.js";
+const MicroSusceptanceAdornment = {
+  position: "end",
+  text: MICRO_SIEMENS
+};
+const SusceptanceAdornment = {
+  position: "end",
+  text: SIEMENS
+};
+const OhmAdornment = {
+  position: "end",
+  text: OHM
+};
+const AmpereAdornment = {
+  position: "end",
+  text: AMPERE
+};
+const KiloAmpereAdornment = {
+  position: "end",
+  text: KILO_AMPERE
+};
+const ActivePowerAdornment = {
+  position: "end",
+  text: MEGA_WATT
+};
+const ReactivePowerAdornment = {
+  position: "end",
+  text: MEGA_VAR
+};
+const MVAPowerAdornment = {
+  position: "end",
+  text: MEGA_VOLT_AMPERE
+};
+const VoltageAdornment = {
+  position: "end",
+  text: KILO_VOLT
+};
+const KilometerAdornment = {
+  position: "end",
+  text: KILO_METER
+};
+const PercentageAdornment = {
+  position: "end",
+  text: PERCENTAGE
+};
+export {
+  ActivePowerAdornment,
+  AmpereAdornment,
+  KiloAmpereAdornment,
+  KilometerAdornment,
+  MVAPowerAdornment,
+  MicroSusceptanceAdornment,
+  OhmAdornment,
+  PercentageAdornment,
+  ReactivePowerAdornment,
+  SusceptanceAdornment,
+  VoltageAdornment
+};

package/dist/utils/constants/fieldConstants.d.ts

@@ -5,6 +5,8 @@
  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
  */
 export declare enum FieldConstants {
+    ADDED = "added",
+    ADDITIONAL_PROPERTIES = "AdditionalProperties",
     AG_GRID_ROW_UUID = "agGridRowUuid",
     API_CALL = "apiCall",
     CASE_FILE = "caseFile",
@@ -16,11 +18,14 @@ export declare enum FieldConstants {
     COUNTRIES_1 = "countries1",
     COUNTRIES_2 = "countries2",
     COUNTRIES = "countries",
+    COUNTRY = "country",
     CURRENT_PARAMETERS = "currentParameters",
+    DELETION_MARK = "deletionMark",
     DESCRIPTION = "description",
     DIRECTORY = "directory",
     ENERGY_SOURCE = "energySource",
     EQUIPMENT_ID = "equipmentID",
+    EQUIPMENT_NAME = "equipmentName",
     EQUIPMENT_IDS = "equipmentIDs",
     EQUIPMENT_TABLE = "equipmentTable",
     EQUIPMENT_TYPE = "equipmentType",
@@ -37,12 +42,14 @@ export declare enum FieldConstants {
     NOMINAL_VOLTAGE = "nominalVoltage",
     OPERATION_TYPE = "type",
     TYPE = "type",
+    PREVIOUS_VALUE = "previousValue",
     PROPERTY_NAME = "propertyName",
     PROPERTY_OPERATOR = "propertyOperator",
     PROPERTY = "PROPERTY",
     PROPERTY_VALUES = "propertyValues",
     SCRIPT = "script",
     STUDY_NAME = "studyName",
+    VALUE = "value",
     VALUE_1 = "value1",
     VALUE_2 = "value2"
 }

package/dist/utils/constants/fieldConstants.js

@@ -1,4 +1,6 @@
 var FieldConstants = /* @__PURE__ */ ((FieldConstants2) => {
+  FieldConstants2["ADDED"] = "added";
+  FieldConstants2["ADDITIONAL_PROPERTIES"] = "AdditionalProperties";
   FieldConstants2["AG_GRID_ROW_UUID"] = "agGridRowUuid";
   FieldConstants2["API_CALL"] = "apiCall";
   FieldConstants2["CASE_FILE"] = "caseFile";
@@ -10,11 +12,14 @@ var FieldConstants = /* @__PURE__ */ ((FieldConstants2) => {
   FieldConstants2["COUNTRIES_1"] = "countries1";
   FieldConstants2["COUNTRIES_2"] = "countries2";
   FieldConstants2["COUNTRIES"] = "countries";
+  FieldConstants2["COUNTRY"] = "country";
   FieldConstants2["CURRENT_PARAMETERS"] = "currentParameters";
+  FieldConstants2["DELETION_MARK"] = "deletionMark";
   FieldConstants2["DESCRIPTION"] = "description";
   FieldConstants2["DIRECTORY"] = "directory";
   FieldConstants2["ENERGY_SOURCE"] = "energySource";
   FieldConstants2["EQUIPMENT_ID"] = "equipmentID";
+  FieldConstants2["EQUIPMENT_NAME"] = "equipmentName";
   FieldConstants2["EQUIPMENT_IDS"] = "equipmentIDs";
   FieldConstants2["EQUIPMENT_TABLE"] = "equipmentTable";
   FieldConstants2["EQUIPMENT_TYPE"] = "equipmentType";
@@ -31,12 +36,14 @@ var FieldConstants = /* @__PURE__ */ ((FieldConstants2) => {
   FieldConstants2["NOMINAL_VOLTAGE"] = "nominalVoltage";
   FieldConstants2["OPERATION_TYPE"] = "type";
   FieldConstants2["TYPE"] = "type";
+  FieldConstants2["PREVIOUS_VALUE"] = "previousValue";
   FieldConstants2["PROPERTY_NAME"] = "propertyName";
   FieldConstants2["PROPERTY_OPERATOR"] = "propertyOperator";
   FieldConstants2["PROPERTY"] = "PROPERTY";
   FieldConstants2["PROPERTY_VALUES"] = "propertyValues";
   FieldConstants2["SCRIPT"] = "script";
   FieldConstants2["STUDY_NAME"] = "studyName";
+  FieldConstants2["VALUE"] = "value";
   FieldConstants2["VALUE_1"] = "value1";
   FieldConstants2["VALUE_2"] = "value2";
   return FieldConstants2;

package/dist/utils/constants/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 './adornments';
 export * from './fetchStatus';
 export * from './fieldConstants';
 export * from './uiConstants';

package/dist/utils/constants/index.js

@@ -1,3 +1,4 @@
+import { ActivePowerAdornment, AmpereAdornment, KiloAmpereAdornment, KilometerAdornment, MVAPowerAdornment, MicroSusceptanceAdornment, OhmAdornment, PercentageAdornment, ReactivePowerAdornment, SusceptanceAdornment, VoltageAdornment } from "./adornments.js";
 import { FetchStatus } from "./fetchStatus.js";
 import { FieldConstants } from "./fieldConstants.js";
 import { MAX_CHAR_DESCRIPTION } from "./uiConstants.js";
@@ -6,6 +7,8 @@ import { COMMON_APP_NAME, COMMON_CONFIG_PARAMS_NAMES, LAST_SELECTED_DIRECTORY, P
 import { FILTERS, FILTER_ID, FILTER_NAME, ID } from "./filterConstant.js";
 export {
   AMPERE,
+  ActivePowerAdornment,
+  AmpereAdornment,
   COMMON_APP_NAME,
   COMMON_CONFIG_PARAMS_NAMES,
   DEGREE,
@@ -18,16 +21,25 @@ export {
   KILO_AMPERE,
   KILO_METER,
   KILO_VOLT,
+  KiloAmpereAdornment,
+  KilometerAdornment,
   LAST_SELECTED_DIRECTORY,
   MAX_CHAR_DESCRIPTION,
   MEGA_VAR,
   MEGA_VOLT_AMPERE,
   MEGA_WATT,
   MICRO_SIEMENS,
+  MVAPowerAdornment,
+  MicroSusceptanceAdornment,
   OHM,
+  OhmAdornment,
   PARAM_DEVELOPER_MODE,
   PARAM_LANGUAGE,
   PARAM_THEME,
   PERCENTAGE,
-  SIEMENS
+  PercentageAdornment,
+  ReactivePowerAdornment,
+  SIEMENS,
+  SusceptanceAdornment,
+  VoltageAdornment
 };

package/dist/utils/error.d.ts

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

package/dist/utils/error.js

@@ -8,33 +8,37 @@ function catchErrorHandler(error, callback) {
     callback("unknown error");
   }
 }
-function snackWithFallback(snackError, error, headerInputs) {
+function extractErrorMessageDescriptor(error, errorMessageIdFallback) {
   if (error instanceof NetworkTimeoutError) {
-    snackError({
-      messageId: error.message,
-      ...headerInputs
-    });
-    return;
+    return { descriptor: { id: error.message } };
   }
   if (error instanceof ProblemDetailError) {
     if (error.businessErrorCode) {
-      snackError({
-        messageId: error.businessErrorCode,
-        messageValues: error.businessErrorValues,
-        ...headerInputs
-      });
-    } else {
-      snackError({
-        messageId: "errors.technicalError",
-        messageValues: {
-          message: error.message,
-          serverName: error.serverName,
-          timestamp: error.timestamp,
-          traceId: error.traceId
-        },
-        ...headerInputs
-      });
+      return {
+        descriptor: { id: error.businessErrorCode },
+        values: error.businessErrorValues
+      };
     }
+    return {
+      descriptor: { id: "errors.technicalError" },
+      values: {
+        message: error.message,
+        serverName: error.serverName,
+        timestamp: error.timestamp,
+        traceId: error.traceId
+      }
+    };
+  }
+  return { descriptor: { id: errorMessageIdFallback } };
+}
+function snackWithFallback(snackError, error, headerInputs) {
+  if (error instanceof NetworkTimeoutError || error instanceof ProblemDetailError) {
+    const { descriptor, values } = extractErrorMessageDescriptor(error, "");
+    snackError({
+      messageId: descriptor.id,
+      messageValues: values,
+      ...headerInputs
+    });
   } else {
     catchErrorHandler(error, (message) => {
       snackError({
@@ -46,5 +50,6 @@ function snackWithFallback(snackError, error, headerInputs) {
 }
 export {
   catchErrorHandler,
+  extractErrorMessageDescriptor,
   snackWithFallback
 };

package/dist/utils/index.d.ts

@@ -9,12 +9,13 @@ export * from './constants';
 export * from './conversionUtils';
 export * from './error';
 export * from './functions';
+export * from './labelUtils';
 export * from './langs';
 export * from './mapper';
 export * from './navigator-clipboard';
 export * from './constants/notificationsProvider';
 export * from './styles';
 export * from './types';
+export * from './ts-utils';
 export * from './validation-functions';
-export * from './labelUtils';
 export { default as yupConfig } from './yupConfig';

package/dist/utils/index.js

@@ -1,4 +1,5 @@
 import { equalsArray } from "./algos.js";
+import { ActivePowerAdornment, AmpereAdornment, KiloAmpereAdornment, KilometerAdornment, MVAPowerAdornment, MicroSusceptanceAdornment, OhmAdornment, PercentageAdornment, ReactivePowerAdornment, SusceptanceAdornment, VoltageAdornment } from "./constants/adornments.js";
 import { FetchStatus } from "./constants/fetchStatus.js";
 import { FieldConstants } from "./constants/fieldConstants.js";
 import { MAX_CHAR_DESCRIPTION } from "./constants/uiConstants.js";
@@ -6,8 +7,9 @@ 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 { catchErrorHandler, extractErrorMessageDescriptor, snackWithFallback } from "./error.js";
 import { areArrayElementsUnique, arraysContainIdenticalStrings, isEmpty, isObjectEmpty, keyGenerator } from "./functions.js";
+import { getEquipmentTypeShortLabel } from "./labelUtils.js";
 import { LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM } from "./langs.js";
 import { getFileIcon } from "./mapper/getFileIcon.js";
 import { equipmentTypesForPredefinedPropertiesMapper } from "./mapper/equipmentTypesForPredefinedPropertiesMapper.js";
@@ -26,13 +28,15 @@ import { FieldType } from "./types/fieldType.js";
 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 { getIdOrSelf, notNull, notUndefined, parseIntData, removeNullFields, sanitizeString } from "./ts-utils.js";
 import { toNumber, validateValueIsANumber } from "./validation-functions.js";
-import { getEquipmentTypeShortLabel, getEquipmentTypeTagLabel } from "./labelUtils.js";
 import "./yupConfig.js";
 import * as yup from "yup";
 export {
   ALL_EQUIPMENTS,
   AMPERE,
+  ActivePowerAdornment,
+  AmpereAdornment,
   AnnouncementSeverity,
   ArrayAction,
   BASE_EQUIPMENTS,
@@ -62,6 +66,8 @@ export {
   KILO_AMPERE,
   KILO_METER,
   KILO_VOLT,
+  KiloAmpereAdornment,
+  KilometerAdornment,
   LANG_ENGLISH,
   LANG_FRENCH,
   LANG_SYSTEM,
@@ -76,10 +82,13 @@ export {
   MEGA_WATT,
   MICRO_SIEMENS,
   MODIFICATION_TYPES,
+  MVAPowerAdornment,
+  MicroSusceptanceAdornment,
   ModificationType,
   NetworkTimeoutError,
   NotificationsUrlKeys,
   OHM,
+  OhmAdornment,
   OperatingStatus,
   PARAM_DEVELOPER_MODE,
   PARAM_LANGUAGE,
@@ -89,7 +98,9 @@ export {
   PREFIX_DIRECTORY_NOTIFICATION_WS,
   PREFIX_STUDY_NOTIFICATION_WS,
   ParameterType,
+  PercentageAdornment,
   ProblemDetailError,
+  ReactivePowerAdornment,
   SEARCH_EQUIPMENTS,
   SIEMENS,
   SVC,
@@ -97,11 +108,13 @@ export {
   ShuntCompensator,
   SolverTypeInfos,
   Substation,
+  SusceptanceAdornment,
   TYPE_TAG_MAX_SIZE,
   ThreeWindingTransfo,
   TwoWindingTransfo,
   VL_TAG_MAX_SIZE,
   VSC,
+  VoltageAdornment,
   VoltageLevel,
   areArrayElementsUnique,
   arraysContainIdenticalStrings,
@@ -112,10 +125,11 @@ export {
   equalsArray,
   equipmentStyles,
   equipmentTypesForPredefinedPropertiesMapper,
+  extractErrorMessageDescriptor,
   getEquipmentTypeShortLabel,
-  getEquipmentTypeTagLabel,
   getEquipmentsInfosForSearchBar,
   getFileIcon,
+  getIdOrSelf,
   isBlankOrEmpty,
   isEmpty,
   isObjectEmpty,
@@ -124,8 +138,13 @@ export {
   makeComposeClasses,
   mergeSx,
   microUnitToUnit,
+  notNull,
+  notUndefined,
+  parseIntData,
+  removeNullFields,
   roundToDefaultPrecision,
   roundToPrecision,
+  sanitizeString,
   snackWithFallback,
   toNestedGlobalSelectors,
   toNumber,

package/dist/utils/labelUtils.d.ts

@@ -5,4 +5,3 @@
  * 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

@@ -5,13 +5,6 @@ function getEquipmentTypeShortLabel(equipmentType) {
   }
   return ALL_EQUIPMENTS[equipmentType]?.shortLabel ?? "";
 }
-function getEquipmentTypeTagLabel(equipmentType) {
-  if (!equipmentType) {
-    return "";
-  }
-  return ALL_EQUIPMENTS[equipmentType]?.tagLabel ?? "";
-}
 export {
-  getEquipmentTypeShortLabel,
-  getEquipmentTypeTagLabel
+  getEquipmentTypeShortLabel
 };

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

@@ -0,0 +1,18 @@
+/**
+ * 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 type Nullable<T> = {
+    [K in keyof T]: T[K] | null;
+};
+export type DeepNullable<T> = {
+    [K in keyof T]: DeepNullable<T[K]> | null;
+};
+export declare function notUndefined<T>(value: T | undefined): value is T;
+export declare function notNull<T>(value: T | null): value is T;
+export declare const removeNullFields: <T extends Record<string, any>>(data: T) => T;
+export declare function parseIntData(val: string | number, defaultValue: string | number): string | number;
+export declare function sanitizeString(val: string | null | undefined): string | null;
+export declare const getIdOrSelf: (e: any) => any;

package/dist/utils/ts-utils.js

@@ -0,0 +1,40 @@
+function notUndefined(value) {
+  return value !== void 0;
+}
+function notNull(value) {
+  return value !== null;
+}
+const removeNullFields = (data) => {
+  const result = Object.entries(data).reduce((acc, [key, value]) => {
+    if (value === null) {
+      return acc;
+    }
+    if (typeof value === "object" && !Array.isArray(value)) {
+      const cleaned = removeNullFields(value);
+      if (Object.keys(cleaned).length > 0) {
+        acc[key] = cleaned;
+      }
+      return acc;
+    }
+    acc[key] = value;
+    return acc;
+  }, {});
+  return result;
+};
+function parseIntData(val, defaultValue) {
+  const intValue = Number.parseInt(String(val), 10);
+  return Number.isNaN(intValue) ? defaultValue : intValue;
+}
+function sanitizeString(val) {
+  const trimmedValue = val?.trim();
+  return trimmedValue === void 0 || trimmedValue === "" ? null : trimmedValue;
+}
+const getIdOrSelf = (e) => e?.id ?? e;
+export {
+  getIdOrSelf,
+  notNull,
+  notUndefined,
+  parseIntData,
+  removeNullFields,
+  sanitizeString
+};

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

@@ -1,4 +1,5 @@
 import { UUID } from 'node:crypto';
+import { IntlShape } from 'react-intl';
 import { ElementType } from './elementType';
 export type Input = string | number;
 export type ElementAttributes = {
@@ -60,3 +61,8 @@ export declare enum ArrayAction {
     ADD = "ADD",
     REMOVE = "REMOVE"
 }
+export type FormatValues = Parameters<IntlShape['formatMessage']>[1];
+export type ErrorMessageDescriptor = {
+    descriptor: Parameters<IntlShape['formatMessage']>[0];
+    values?: FormatValues;
+};

package/package.json

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