@gridsuite/commons-ui 0.179.0 → 0.181.0

package/dist/utils/index.js

@@ -21,7 +21,7 @@ import { CustomError } from "./types/CustomError.js";
 import { ProblemDetailError } from "./types/ProblemDetailError.js";
 import { NetworkTimeoutError } from "./types/NetworkTimeoutError.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 { ALL_EQUIPMENTS, BASE_EQUIPMENTS, CONNECTION_DIRECTIONS, EquipmentType, ExtendedEquipmentType, HvdcType, LOAD_TYPES, OperatingStatus, SEARCH_EQUIPMENTS, TYPE_TAG_MAX_SIZE, UNDEFINED_CONNECTION_DIRECTION, UNDEFINED_LOAD_TYPE, VL_TAG_MAX_SIZE, equipmentStyles, getConnectionDirectionLabel, getEquipmentsInfosForSearchBar, getLoadTypeLabel } from "./types/equipmentType.js";
 import { Battery, BusBar, DanglingLine, Generator, Hvdc, LCC, Line, Load, SVC, ShuntCompensator, Substation, ThreeWindingTransfo, TwoWindingTransfo, VSC, VoltageLevel } from "./types/equipmentTypes.js";
 import { AnnouncementSeverity, ArrayAction } from "./types/types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./types/modificationType.js";
@@ -31,7 +31,7 @@ import { SolverTypeInfos } from "./types/dynamic-simulation.type.js";
 import { DistributionType, SensitivityType } from "./types/sensitivity-analysis.type.js";
 import { CalculationType, LoadModelsRule } from "./types/dynamic-margin-calculation.type.js";
 import { OperationType } from "./types/network-modification-types.js";
-import { getIdOrSelf, notNull, notUndefined, parseIntData, removeNullFields, sanitizeString } from "./ts-utils.js";
+import { areIdsEqual, getIdOrSelf, getObjectId, notNull, notUndefined, parseIntData, removeNullFields, sanitizeString } from "./ts-utils.js";
 import { toNumber, validateValueIsANumber } from "./validation-functions.js";
 import "./yupConfig.js";
 import * as yup from "yup";
@@ -47,6 +47,7 @@ export {
   BusBar,
   COMMON_APP_NAME,
   COMMON_CONFIG_PARAMS_NAMES,
+  CONNECTION_DIRECTIONS,
   CalculationType,
   CustomError,
   DARK_THEME,
@@ -79,6 +80,7 @@ export {
   LAST_SELECTED_DIRECTORY,
   LCC,
   LIGHT_THEME,
+  LOAD_TYPES,
   Line,
   Load,
   LoadModelsRule,
@@ -119,12 +121,15 @@ export {
   TYPE_TAG_MAX_SIZE,
   ThreeWindingTransfo,
   TwoWindingTransfo,
+  UNDEFINED_CONNECTION_DIRECTION,
+  UNDEFINED_LOAD_TYPE,
   VL_TAG_MAX_SIZE,
   VSC,
   VoltageAdornment,
   VoltageLevel,
   YUP_REQUIRED,
   areArrayElementsUnique,
+  areIdsEqual,
   arraysContainIdenticalStrings,
   catchErrorHandler,
   convertInputValue,
@@ -134,10 +139,13 @@ export {
   equipmentStyles,
   equipmentTypesForPredefinedPropertiesMapper,
   extractErrorMessageDescriptor,
+  getConnectionDirectionLabel,
   getEquipmentTypeShortLabel,
   getEquipmentsInfosForSearchBar,
   getFileIcon,
   getIdOrSelf,
+  getLoadTypeLabel,
+  getObjectId,
   isBlankOrEmpty,
   isEmpty,
   isObjectEmpty,

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

@@ -1,9 +1,4 @@
-/**
- * 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/.
- */
+import { Option } from './types';
 export type Nullable<T> = {
     [K in keyof T]: T[K] | null;
 };
@@ -16,3 +11,7 @@ export declare function removeNullFields<T extends Record<string, any>>(data: 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;
+export declare const areIdsEqual: (val1: Option, val2: Option) => boolean;
+export declare const getObjectId: (object: string | {
+    id: string;
+}) => string;

package/dist/utils/ts-utils.js

@@ -27,8 +27,19 @@ function sanitizeString(val) {
   return trimmedValue === void 0 || trimmedValue === "" ? null : trimmedValue;
 }
 const getIdOrSelf = (e) => e?.id ?? e;
+const areIdsEqual = (val1, val2) => {
+  if (typeof val1 !== "string" && typeof val2 !== "string") {
+    return val1.id === val2.id;
+  }
+  return val1 === val2;
+};
+const getObjectId = (object) => {
+  return typeof object === "string" ? object : object?.id ?? null;
+};
 export {
+  areIdsEqual,
   getIdOrSelf,
+  getObjectId,
   notNull,
   notUndefined,
   parseIntData,

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

@@ -67,6 +67,24 @@ export declare enum HvdcType {
     LCC = "LCC",
     VSC = "VSC"
 }
+export declare const LOAD_TYPES: {
+    id: string;
+    label: string;
+}[];
+export declare const UNDEFINED_LOAD_TYPE = "UNDEFINED";
+export declare function getLoadTypeLabel(loadTypeId: string): string | undefined;
+export declare const UNDEFINED_CONNECTION_DIRECTION = "UNDEFINED";
+export declare const CONNECTION_DIRECTIONS: readonly [{
+    readonly id: "TOP";
+    readonly label: "Top";
+}, {
+    readonly id: "BOTTOM";
+    readonly label: "Bottom";
+}, {
+    readonly id: "UNDEFINED";
+    readonly label: "Undefined";
+}];
+export declare function getConnectionDirectionLabel(connectionDirectionId: string | null | undefined): "Top" | "Bottom" | "Undefined" | undefined;
 export declare enum ExtendedEquipmentType {
     HVDC_LINE_LCC = "HVDC_LINE_LCC",
     HVDC_LINE_VSC = "HVDC_LINE_VSC"

package/dist/utils/types/equipmentType.js

@@ -63,6 +63,26 @@ var HvdcType = /* @__PURE__ */ ((HvdcType2) => {
   HvdcType2["VSC"] = "VSC";
   return HvdcType2;
 })(HvdcType || {});
+const LOAD_TYPES = [
+  { id: "AUXILIARY", label: "Auxiliary" },
+  { id: "FICTITIOUS", label: "Fictitious" }
+];
+const UNDEFINED_LOAD_TYPE = "UNDEFINED";
+function getLoadTypeLabel(loadTypeId) {
+  return LOAD_TYPES.find(({ id }) => id === loadTypeId)?.label;
+}
+const UNDEFINED_CONNECTION_DIRECTION = "UNDEFINED";
+const CONNECTION_DIRECTIONS = [
+  { id: "TOP", label: "Top" },
+  { id: "BOTTOM", label: "Bottom" },
+  { id: UNDEFINED_CONNECTION_DIRECTION, label: "Undefined" }
+];
+function getConnectionDirectionLabel(connectionDirectionId) {
+  if (connectionDirectionId === UNDEFINED_CONNECTION_DIRECTION) {
+    return "Undefined";
+  }
+  return CONNECTION_DIRECTIONS.find(({ id }) => id === connectionDirectionId)?.label;
+}
 var ExtendedEquipmentType = /* @__PURE__ */ ((ExtendedEquipmentType2) => {
   ExtendedEquipmentType2["HVDC_LINE_LCC"] = "HVDC_LINE_LCC";
   ExtendedEquipmentType2["HVDC_LINE_VSC"] = "HVDC_LINE_VSC";
@@ -375,13 +395,19 @@ function getEquipmentsInfosForSearchBar(equipmentsInfos, getNameOrId) {
 export {
   ALL_EQUIPMENTS,
   BASE_EQUIPMENTS,
+  CONNECTION_DIRECTIONS,
   EquipmentType,
   ExtendedEquipmentType,
   HvdcType,
+  LOAD_TYPES,
   OperatingStatus,
   SEARCH_EQUIPMENTS,
   TYPE_TAG_MAX_SIZE,
+  UNDEFINED_CONNECTION_DIRECTION,
+  UNDEFINED_LOAD_TYPE,
   VL_TAG_MAX_SIZE,
   equipmentStyles,
-  getEquipmentsInfosForSearchBar
+  getConnectionDirectionLabel,
+  getEquipmentsInfosForSearchBar,
+  getLoadTypeLabel
 };

package/dist/utils/types/index.js

@@ -2,7 +2,7 @@ import { CustomError } from "./CustomError.js";
 import { ProblemDetailError } from "./ProblemDetailError.js";
 import { NetworkTimeoutError } from "./NetworkTimeoutError.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 { ALL_EQUIPMENTS, BASE_EQUIPMENTS, CONNECTION_DIRECTIONS, EquipmentType, ExtendedEquipmentType, HvdcType, LOAD_TYPES, OperatingStatus, SEARCH_EQUIPMENTS, TYPE_TAG_MAX_SIZE, UNDEFINED_CONNECTION_DIRECTION, UNDEFINED_LOAD_TYPE, VL_TAG_MAX_SIZE, equipmentStyles, getConnectionDirectionLabel, getEquipmentsInfosForSearchBar, getLoadTypeLabel } from "./equipmentType.js";
 import { Battery, BusBar, DanglingLine, Generator, Hvdc, LCC, Line, Load, SVC, ShuntCompensator, Substation, ThreeWindingTransfo, TwoWindingTransfo, VSC, VoltageLevel } from "./equipmentTypes.js";
 import { AnnouncementSeverity, ArrayAction } from "./types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./modificationType.js";
@@ -19,6 +19,7 @@ export {
   BASE_EQUIPMENTS,
   Battery,
   BusBar,
+  CONNECTION_DIRECTIONS,
   CalculationType,
   CustomError,
   DanglingLine,
@@ -31,6 +32,7 @@ export {
   Hvdc,
   HvdcType,
   LCC,
+  LOAD_TYPES,
   Line,
   Load,
   LoadModelsRule,
@@ -50,9 +52,13 @@ export {
   TYPE_TAG_MAX_SIZE,
   ThreeWindingTransfo,
   TwoWindingTransfo,
+  UNDEFINED_CONNECTION_DIRECTION,
+  UNDEFINED_LOAD_TYPE,
   VL_TAG_MAX_SIZE,
   VSC,
   VoltageLevel,
   equipmentStyles,
-  getEquipmentsInfosForSearchBar
+  getConnectionDirectionLabel,
+  getEquipmentsInfosForSearchBar,
+  getLoadTypeLabel
 };

package/package.json

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