@gridsuite/commons-ui 0.145.0 → 0.146.0

package/dist/index.js

@@ -133,6 +133,7 @@ import { LeftPanelCloseIcon } from "./components/icons/LeftPanelCloseIcon.js";
 import { DeviceHubIcon } from "./components/icons/DeviceHubIcon.js";
 import { TuneIcon } from "./components/icons/TuneIcon.js";
 import { PhotoLibraryIcon } from "./components/icons/PhotoLibraryIcon.js";
+import { EditNoteIcon } from "./components/icons/EditNoteIcon.js";
 import { ComputingType, formatComputingTypeLabel, isValidComputingType } from "./components/parameters/common/computing-type.js";
 import { COMMON_PARAMETERS, PARAM_SA_FLOW_PROPORTIONAL_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_HIGH_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_LOW_VOLTAGE_ABSOLUTE_THRESHOLD, PARAM_SA_LOW_VOLTAGE_PROPORTIONAL_THRESHOLD, PARAM_SA_PROVIDER, PROVIDER, ReactivePowerAdornment, SPECIFIC_PARAMETERS, VERSION_PARAMETER, VOLTAGE_LEVEL, VoltageAdornment } from "./components/parameters/common/constant.js";
 import { LineSeparator } from "./components/parameters/common/line-separator.js";
@@ -222,7 +223,7 @@ import { equipmentTypesForPredefinedPropertiesMapper } from "./utils/mapper/equi
 import { copyToClipboard } from "./utils/navigator-clipboard.js";
 import { NotificationsUrlKeys, PREFIX_CONFIG_NOTIFICATION_WS, PREFIX_DIRECTORY_NOTIFICATION_WS, PREFIX_STUDY_NOTIFICATION_WS } from "./utils/constants/notificationsProvider.js";
 import { DARK_THEME, LIGHT_THEME, makeComposeClasses, mergeSx, toNestedGlobalSelectors } from "./utils/styles.js";
-import { CustomError, formatMessageValues } from "./utils/types/CustomError.js";
+import { ProblemDetailError, formatMessageValues } from "./utils/types/ProblemDetailError.js";
 import { NetworkTimeoutError } from "./utils/types/NetworkTimeoutError.js";
 import { ElementType } from "./utils/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 "./utils/types/equipmentType.js";
@@ -351,7 +352,6 @@ export {
   CsvUploader,
   CustomAGGrid,
   CustomAgGridTable,
-  CustomError,
   CustomFormContext,
   CustomFormProvider,
   CustomMenuItem,
@@ -396,6 +396,7 @@ export {
   EXPERT_FILTER_EQUIPMENTS,
   EXPERT_FILTER_FIELDS,
   EXPERT_FILTER_QUERY,
+  EditNoteIcon,
   ElementSaveDialog,
   ElementSearchDialog,
   ElementSearchInput,
@@ -576,6 +577,7 @@ export {
   PhotoLibraryIcon,
   PopupConfirmationDialog,
   PredefinedParameters,
+  ProblemDetailError,
   PropertyValueEditor,
   ProviderParam,
   RATIO_REGULATION_MODE_OPTIONS,

package/dist/services/utils.d.ts

@@ -1,10 +1,15 @@
-import { CustomError } from '../utils/types/CustomError';
+/**
+ * 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/.
+ */
 /** Optional convenience: allow per-call timeout override without crafting a signal manually. */
 type FetchInitWithTimeout = RequestInit & {
     /** If provided and no signal is set, use this as the timeout override (ms). */
     timeoutMs?: number;
 };
-export declare const convertToCustomError: (response: string) => CustomError;
+export declare const convertToCustomError: (textError: string) => Error;
 export declare const backendFetch: (url: string, init?: FetchInitWithTimeout, token?: string) => Promise<Response>;
 export declare const backendFetchJson: (url: string, init?: FetchInitWithTimeout, token?: string) => Promise<any>;
 export declare function backendFetchText(url: string, init?: FetchInitWithTimeout, token?: string): Promise<string>;

package/dist/services/utils.js

@@ -1,5 +1,5 @@
 import { getUserToken } from "../redux/commonStore.js";
-import { CustomError } from "../utils/types/CustomError.js";
+import { ProblemDetailError } from "../utils/types/ProblemDetailError.js";
 import { NetworkTimeoutError } from "../utils/types/NetworkTimeoutError.js";
 const DEFAULT_TIMEOUT_MS = 5e4;
 const parseError = (text) => {
@@ -27,20 +27,25 @@ const prepareRequest = (init, token) => {
   initWithSignal.headers.append("Authorization", `Bearer ${tokenCopy}`);
   return initWithSignal;
 };
-const convertToCustomError = (response) => {
-  const errorJson = parseError(response);
-  if (errorJson?.businessErrorCode) {
-    return new CustomError(
-      `Server error: ${errorJson.detail}`,
+const convertToCustomError = (textError) => {
+  const errorJson = parseError(textError);
+  if (errorJson?.server && errorJson?.timestamp && errorJson?.traceId && errorJson?.detail) {
+    let date = /* @__PURE__ */ new Date();
+    try {
+      date = new Date(errorJson.timestamp);
+    } catch {
+    }
+    return new ProblemDetailError(
+      errorJson.detail,
+      errorJson.server,
+      date,
+      errorJson.traceId,
       errorJson.status,
       errorJson.businessErrorCode,
       errorJson.businessErrorValues
     );
   }
-  if (errorJson?.detail) {
-    return new CustomError(`Server error: ${errorJson.detail}`, errorJson.status);
-  }
-  return new CustomError(errorJson);
+  return new Error(textError);
 };
 const handleError = (response) => {
   return response.text().then((text) => {

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

@@ -6,4 +6,5 @@
  */
 export declare const errorsEn: {
     'errors.network.timeout': string;
+    'errors.technicalError': string;
 };

package/dist/translations/en/errorsEn.js

@@ -1,5 +1,6 @@
 const errorsEn = {
-  "errors.network.timeout": "The request timed out. Please try again."
+  "errors.network.timeout": "The request timed out. Please try again.",
+  "errors.technicalError": "Server error: {message}\n (server: {serverName}, timestamp: {timestamp}, trace ID: {traceId})"
 };
 export {
   errorsEn

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

@@ -6,4 +6,5 @@
  */
 export declare const errorsFr: {
     'errors.network.timeout': string;
+    'errors.technicalError': string;
 };

package/dist/translations/fr/errorsFr.js

@@ -1,5 +1,6 @@
 const errorsFr = {
-  "errors.network.timeout": "La requête a expiré. Veuillez réessayer."
+  "errors.network.timeout": "La requête a expiré. Veuillez réessayer.",
+  "errors.technicalError": "Erreur serveur: {message}\n (serveur: {serverName}, horodatage: {timestamp}, trace ID: {traceId})"
 };
 export {
   errorsFr

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

@@ -1,6 +1,6 @@
 export declare const PARAM_THEME = "theme";
 export declare const PARAM_LANGUAGE = "language";
-export declare const PARAM_DEVELOPER_MODE = "enableDeveloperMode";
+export declare const PARAM_DEVELOPER_MODE = "isDeveloperMode";
 export declare const LAST_SELECTED_DIRECTORY = "lastSelectedDirectory";
 export declare const COMMON_CONFIG_PARAMS_NAMES: Set<string>;
 export declare const COMMON_APP_NAME = "common";

package/dist/utils/constants/configConstants.js

@@ -1,6 +1,6 @@
 const PARAM_THEME = "theme";
 const PARAM_LANGUAGE = "language";
-const PARAM_DEVELOPER_MODE = "enableDeveloperMode";
+const PARAM_DEVELOPER_MODE = "isDeveloperMode";
 const LAST_SELECTED_DIRECTORY = "lastSelectedDirectory";
 const COMMON_CONFIG_PARAMS_NAMES = /* @__PURE__ */ new Set([
   PARAM_THEME,

package/dist/utils/error.js

@@ -1,4 +1,4 @@
-import { CustomError, formatMessageValues } from "./types/CustomError.js";
+import { ProblemDetailError, formatMessageValues } from "./types/ProblemDetailError.js";
 import { NetworkTimeoutError } from "./types/NetworkTimeoutError.js";
 function catchErrorHandler(error, callback) {
   if (error instanceof Object && "message" in error && typeof error.message === "string") {
@@ -15,12 +15,26 @@ function snackWithFallback(snackError, error, headerInputs) {
     });
     return;
   }
-  if (error instanceof CustomError && error.businessErrorCode) {
-    snackError({
-      messageId: error.businessErrorCode,
-      messageValues: error.businessErrorValues ? formatMessageValues(error.businessErrorValues) : void 0,
-      ...headerInputs
-    });
+  if (error instanceof ProblemDetailError) {
+    if (error.businessErrorCode) {
+      snackError({
+        messageId: error.businessErrorCode,
+        messageValues: error.businessErrorValues ? formatMessageValues(error.businessErrorValues) : void 0,
+        ...headerInputs
+      });
+    } else {
+      snackError({
+        messageId: "errors.technicalError",
+        messageValues: {
+          message: error.message,
+          serverName: error.serverName,
+          timestamp: error.timestamp.toLocaleString(),
+          // It would require refactoring to adapt with GS language so we keep it like that for now
+          traceId: error.traceId
+        },
+        ...headerInputs
+      });
+    }
   } else {
     catchErrorHandler(error, (message) => {
       snackError({

package/dist/utils/index.js

@@ -14,7 +14,7 @@ import { equipmentTypesForPredefinedPropertiesMapper } from "./mapper/equipmentT
 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 { ProblemDetailError, formatMessageValues } 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";
@@ -39,7 +39,6 @@ export {
   BusBar,
   COMMON_APP_NAME,
   COMMON_CONFIG_PARAMS_NAMES,
-  CustomError,
   DARK_THEME,
   DEGREE,
   DanglingLine,
@@ -88,6 +87,7 @@ export {
   PREFIX_DIRECTORY_NOTIFICATION_WS,
   PREFIX_STUDY_NOTIFICATION_WS,
   ParameterType,
+  ProblemDetailError,
   SEARCH_EQUIPMENTS,
   SIEMENS,
   SVC,

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

@@ -4,10 +4,13 @@
  * 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 class CustomError extends Error {
+export declare class ProblemDetailError extends Error {
+    serverName: string;
+    timestamp: Date;
+    traceId: string;
     status?: number;
     businessErrorCode?: string;
     businessErrorValues?: Record<string, unknown>;
-    constructor(message: string, status?: number, businessErrorCode?: string, businessErrorValues?: Record<string, unknown>);
+    constructor(message: string, serverName: string, timestamp: Date, traceId: 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 → ProblemDetailError.js}

@@ -1,6 +1,9 @@
-class CustomError extends Error {
-  constructor(message, status, businessErrorCode, businessErrorValues) {
+class ProblemDetailError extends Error {
+  constructor(message, serverName, timestamp, traceId, status, businessErrorCode, businessErrorValues) {
     super(message);
+    this.serverName = serverName;
+    this.timestamp = timestamp;
+    this.traceId = traceId;
     this.status = status;
     this.businessErrorCode = businessErrorCode;
     this.businessErrorValues = businessErrorValues;
@@ -15,6 +18,6 @@ function formatMessageValues(properties) {
   );
 }
 export {
-  CustomError,
+  ProblemDetailError,
   formatMessageValues
 };

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

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

package/dist/utils/types/index.js

@@ -1,4 +1,4 @@
-import { CustomError, formatMessageValues } from "./CustomError.js";
+import { ProblemDetailError, formatMessageValues } 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";
@@ -16,7 +16,6 @@ export {
   BASE_EQUIPMENTS,
   Battery,
   BusBar,
-  CustomError,
   DanglingLine,
   DistributionType,
   ElementType,
@@ -34,6 +33,7 @@ export {
   NetworkTimeoutError,
   OperatingStatus,
   ParameterType,
+  ProblemDetailError,
   SEARCH_EQUIPMENTS,
   SVC,
   SensitivityType,

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

@@ -17,7 +17,7 @@ export type StudyMetadata = Metadata & {
         [networkElementType: string]: PredefinedProperties;
     };
     defaultParametersValues?: {
-        enableDeveloperMode?: boolean;
+        isDeveloperMode?: boolean;
     };
     defaultCountry?: string;
     favoriteCountries?: string[];

package/package.json

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