@gridsuite/commons-ui 0.99.0 → 0.100.0

package/dist/index.js

@@ -1,4 +1,7 @@
 import { default as default2 } from "./_mocks_/svg.js";
+import { AnnouncementBanner } from "./components/announcement/AnnouncementBanner.js";
+import { AnnouncementNotification } from "./components/announcement/AnnouncementNotification.js";
+import { useGlobalAnnouncement } from "./components/announcement/useGlobalAnnouncement.js";
 import { AuthenticationRouter } from "./components/authentication/AuthenticationRouter.js";
 import { default as default3 } from "./components/authentication/AuthenticationRouterErrorDisplay.js";
 import { Login } from "./components/authentication/Login.js";
@@ -98,9 +101,10 @@ import { ActivableChip } from "./components/inputs/ActivableChip.js";
 import { MultipleSelectionDialog } from "./components/multipleSelectionDialog/MultipleSelectionDialog.js";
 import { OverflowableText } from "./components/overflowableText/OverflowableText.js";
 import { SnackbarProvider } from "./components/snackbarProvider/SnackbarProvider.js";
-import { TopBar } from "./components/topBar/TopBar.js";
-import { GridLogo, LogoText } from "./components/topBar/GridLogo.js";
 import { AboutDialog } from "./components/topBar/AboutDialog.js";
+import { GridLogo, LogoText } from "./components/topBar/GridLogo.js";
+import { DevModeBanner } from "./components/topBar/DevModeBanner.js";
+import { TopBar } from "./components/topBar/TopBar.js";
 import { TreeViewFinder, generateTreeViewFinderClass } from "./components/treeViewFinder/TreeViewFinder.js";
 import { NotificationsProvider } from "./components/notifications/NotificationsProvider.js";
 import { NotificationsContext } from "./components/notifications/contexts/NotificationsContext.js";
@@ -152,6 +156,7 @@ import { createFilter, createParameter, fetchElementsInfos, saveFilter, updatePa
 import { fetchAppsMetadata, fetchDefaultCountry, fetchEnv, fetchFavoriteAndDefaultCountries, fetchStudyMetadata, isStudyMetadata } from "./services/appsMetadata.js";
 import { elementAlreadyExists, fetchDirectoryContent, fetchDirectoryElementPath, fetchRootFolders } from "./services/directory.js";
 import { exportFilter } from "./services/study.js";
+import { fetchCurrentAnnouncement, fetchUserDetails } from "./services/userAdmin.js";
 import { equalsArray } from "./utils/algos.js";
 import { FetchStatus } from "./utils/constants/fetchStatus.js";
 import { FieldConstants } from "./utils/constants/fieldConstants.js";
@@ -162,10 +167,12 @@ import { areArrayElementsUnique, isObjectEmpty, keyGenerator } from "./utils/fun
 import { LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM } from "./utils/langs.js";
 import { getFileIcon } from "./utils/mapper/getFileIcon.js";
 import { equipmentTypesForPredefinedPropertiesMapper } from "./utils/mapper/equipmentTypesForPredefinedPropertiesMapper.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 { ElementType } from "./utils/types/elementType.js";
 import { BASE_EQUIPMENTS, EQUIPMENT_TYPE, EquipmentType, ExtendedEquipmentType, HvdcType, OperatingStatus, SEARCH_EQUIPMENTS, TYPE_TAG_MAX_SIZE, VL_TAG_MAX_SIZE, equipmentStyles, getEquipmentsInfosForSearchBar } from "./utils/types/equipmentType.js";
 import { Battery, BusBar, DanglingLine, Generator, Hvdc, LCC, Line, Load, SVC, ShuntCompensator, Substation, ThreeWindingTransfo, TwoWindingTransfo, VSC, VoltageLevel } from "./utils/types/equipmentTypes.js";
+import { AnnouncementSeverity } from "./utils/types/types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./utils/types/modificationType.js";
 import { FieldType } from "./utils/types/fieldType.js";
 import { ParameterType } from "./utils/types/parameters.type.js";
@@ -225,6 +232,9 @@ export {
   AboutDialog,
   ActivableChip,
   AddButton,
+  AnnouncementBanner,
+  AnnouncementNotification,
+  AnnouncementSeverity,
   AuthenticationRouter,
   default3 as AuthenticationRouterErrorDisplay,
   AutocompleteInput,
@@ -280,6 +290,7 @@ export {
   DataType,
   DescriptionField,
   DescriptionModificationDialog,
+  DevModeBanner,
   DirectoryItemSelector,
   DirectoryItemsInput,
   DistributionType,
@@ -373,6 +384,7 @@ export {
   NO_ITEM_SELECTION_FOR_COPY,
   NotificationsContext,
   NotificationsProvider,
+  NotificationsUrlKeys,
   NumericEditor,
   OHM,
   OPERATOR_OPTIONS,
@@ -391,6 +403,9 @@ export {
   PERCENTAGE,
   PHASE_REGULATION_MODE_OPTIONS,
   PHASE_SHIFTER_REGULATION_ON,
+  PREFIX_CONFIG_NOTIFICATION_WS,
+  PREFIX_DIRECTORY_NOTIFICATION_WS,
+  PREFIX_STUDY_NOTIFICATION_WS,
   PROVIDER,
   ParameterFloat,
   ParameterGroup,
@@ -507,6 +522,7 @@ export {
   exportParamsFr,
   extractDefault,
   fetchAppsMetadata,
+  fetchCurrentAnnouncement,
   fetchDefaultCountry,
   fetchDirectoryContent,
   fetchDirectoryElementPath,
@@ -515,6 +531,7 @@ export {
   fetchFavoriteAndDefaultCountries,
   fetchRootFolders,
   fetchStudyMetadata,
+  fetchUserDetails,
   filterEn,
   filterExpertEn,
   filterExpertFr,
@@ -618,6 +635,7 @@ export {
   useDebounce,
   useElementSearch,
   useFormatLabelWithUnit,
+  useGlobalAnnouncement,
   useIntlRef,
   useListenerManager,
   useLocalizedCountries,

package/dist/services/index.d.ts

@@ -9,3 +9,4 @@ export * from './explore';
 export * from './appsMetadata';
 export * from './directory';
 export * from './study';
+export * from './userAdmin';

package/dist/services/index.js

@@ -3,6 +3,7 @@ import { createFilter, createParameter, fetchElementsInfos, saveFilter, updatePa
 import { fetchAppsMetadata, fetchDefaultCountry, fetchEnv, fetchFavoriteAndDefaultCountries, fetchStudyMetadata, isStudyMetadata } from "./appsMetadata.js";
 import { elementAlreadyExists, fetchDirectoryContent, fetchDirectoryElementPath, fetchRootFolders } from "./directory.js";
 import { exportFilter } from "./study.js";
+import { fetchCurrentAnnouncement, fetchUserDetails } from "./userAdmin.js";
 export {
   backendFetch,
   backendFetchJson,
@@ -13,6 +14,7 @@ export {
   elementAlreadyExists,
   exportFilter,
   fetchAppsMetadata,
+  fetchCurrentAnnouncement,
   fetchDefaultCountry,
   fetchDirectoryContent,
   fetchDirectoryElementPath,
@@ -21,6 +23,7 @@ export {
   fetchFavoriteAndDefaultCountries,
   fetchRootFolders,
   fetchStudyMetadata,
+  fetchUserDetails,
   getRequestParamFromList,
   isStudyMetadata,
   saveFilter,

package/dist/services/userAdmin.d.ts

@@ -1,3 +1,3 @@
-import { UserDetail } from '../utils/types/types';
-declare function fetchUserDetails(user: string): Promise<UserDetail>;
-export default fetchUserDetails;
+import { AnnouncementDto, UserDetail } from '../utils/types/types';
+export declare function fetchUserDetails(user: string): Promise<UserDetail>;
+export declare function fetchCurrentAnnouncement(): Promise<AnnouncementDto | null>;

package/dist/services/userAdmin.js

@@ -7,6 +7,14 @@ function fetchUserDetails(user) {
     headers: { "Content-Type": "application/json" }
   });
 }
+function fetchCurrentAnnouncement() {
+  console.info(`Fetching current announcement ...`);
+  const url = `${PREFIX_USER_ADMIN_QUERIES}/announcements/current`;
+  return backendFetchJson(url, {
+    method: "get"
+  });
+}
 export {
-  fetchUserDetails as default
+  fetchCurrentAnnouncement,
+  fetchUserDetails
 };

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

@@ -0,0 +1,10 @@
+export declare enum NotificationsUrlKeys {
+    CONFIG = "CONFIG",
+    GLOBAL_CONFIG = "GLOBAL_CONFIG",
+    STUDY = "STUDY",
+    DIRECTORY = "DIRECTORY",
+    DIRECTORY_DELETE_STUDY = "DIRECTORY_DELETE_STUDY"
+}
+export declare const PREFIX_CONFIG_NOTIFICATION_WS: string;
+export declare const PREFIX_STUDY_NOTIFICATION_WS: string;
+export declare const PREFIX_DIRECTORY_NOTIFICATION_WS: string;

package/dist/utils/constants/notificationsProvider.js

@@ -0,0 +1,17 @@
+var NotificationsUrlKeys = /* @__PURE__ */ ((NotificationsUrlKeys2) => {
+  NotificationsUrlKeys2["CONFIG"] = "CONFIG";
+  NotificationsUrlKeys2["GLOBAL_CONFIG"] = "GLOBAL_CONFIG";
+  NotificationsUrlKeys2["STUDY"] = "STUDY";
+  NotificationsUrlKeys2["DIRECTORY"] = "DIRECTORY";
+  NotificationsUrlKeys2["DIRECTORY_DELETE_STUDY"] = "DIRECTORY_DELETE_STUDY";
+  return NotificationsUrlKeys2;
+})(NotificationsUrlKeys || {});
+const PREFIX_CONFIG_NOTIFICATION_WS = `${"ws/gateway"}/config-notification`;
+const PREFIX_STUDY_NOTIFICATION_WS = `${"ws/gateway"}/study-notification`;
+const PREFIX_DIRECTORY_NOTIFICATION_WS = `${"ws/gateway"}/directory-notification`;
+export {
+  NotificationsUrlKeys,
+  PREFIX_CONFIG_NOTIFICATION_WS,
+  PREFIX_DIRECTORY_NOTIFICATION_WS,
+  PREFIX_STUDY_NOTIFICATION_WS
+};

package/dist/utils/index.d.ts

@@ -10,6 +10,7 @@ export * from './conversionUtils';
 export * from './functions';
 export * from './langs';
 export * from './mapper';
+export * from './constants/notificationsProvider';
 export * from './styles';
 export * from './types';
 export { default as yupConfig } from './yupConfig';

package/dist/utils/index.js

@@ -8,10 +8,12 @@ import { areArrayElementsUnique, isObjectEmpty, keyGenerator } from "./functions
 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 { ElementType } from "./types/elementType.js";
 import { BASE_EQUIPMENTS, EQUIPMENT_TYPE, 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";
+import { AnnouncementSeverity } from "./types/types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./types/modificationType.js";
 import { FieldType } from "./types/fieldType.js";
 import { ParameterType } from "./types/parameters.type.js";
@@ -22,6 +24,7 @@ import "./yupConfig.js";
 import * as yup from "yup";
 export {
   AMPERE,
+  AnnouncementSeverity,
   BASE_EQUIPMENTS,
   Battery,
   BusBar,
@@ -58,9 +61,13 @@ export {
   MICRO_SIEMENS,
   MODIFICATION_TYPES,
   ModificationType,
+  NotificationsUrlKeys,
   OHM,
   OperatingStatus,
   PERCENTAGE,
+  PREFIX_CONFIG_NOTIFICATION_WS,
+  PREFIX_DIRECTORY_NOTIFICATION_WS,
+  PREFIX_STUDY_NOTIFICATION_WS,
   ParameterType,
   SEARCH_EQUIPMENTS,
   SIEMENS,

package/dist/utils/types/index.js

@@ -1,6 +1,7 @@
 import { ElementType } from "./elementType.js";
 import { BASE_EQUIPMENTS, EQUIPMENT_TYPE, 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";
+import { AnnouncementSeverity } from "./types.js";
 import { MODIFICATION_TYPES, ModificationType } from "./modificationType.js";
 import { FieldType } from "./fieldType.js";
 import { ParameterType } from "./parameters.type.js";
@@ -8,6 +9,7 @@ import { SolverTypeInfos } from "./dynamic-simulation.type.js";
 import { EnergySource } from "./non-evacuated-energy.type.js";
 import { DistributionType, SensitivityType } from "./sensitivity-analysis.type.js";
 export {
+  AnnouncementSeverity,
   BASE_EQUIPMENTS,
   Battery,
   BusBar,

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

@@ -21,5 +21,6 @@ export type StudyMetadata = Metadata & {
     };
     defaultCountry?: string;
     favoriteCountries?: string[];
+    substationPropertiesGlobalFilters?: Map<string, string[]>;
 };
 export {};

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

@@ -44,3 +44,15 @@ export type UserDetail = {
     numberCasesUsed: number;
     maxAllowedBuilds: number;
 };
+export declare enum AnnouncementSeverity {
+    INFO = "INFO",
+    WARN = "WARN"
+}
+export type AnnouncementDto = {
+    id: UUID;
+    startDate: Date;
+    endDate: Date;
+    message: string;
+    severity: AnnouncementSeverity;
+    remainingDuration: number;
+};

package/dist/utils/types/types.js

@@ -1 +1,8 @@
-
+var AnnouncementSeverity = /* @__PURE__ */ ((AnnouncementSeverity2) => {
+  AnnouncementSeverity2["INFO"] = "INFO";
+  AnnouncementSeverity2["WARN"] = "WARN";
+  return AnnouncementSeverity2;
+})(AnnouncementSeverity || {});
+export {
+  AnnouncementSeverity
+};

package/package.json

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

package/dist/components/topBar/MessageBanner.d.ts

@@ -1,6 +0,0 @@
-import { ReactNode } from 'react';
-export interface MessageBannerProps {
-    children: ReactNode;
-}
-declare function MessageBanner({ children }: MessageBannerProps): false | import("react/jsx-runtime").JSX.Element;
-export default MessageBanner;

package/dist/components/topBar/MessageBanner.js

@@ -1,54 +0,0 @@
-import { jsxs, jsx } from "react/jsx-runtime";
-import { useState } from "react";
-import { Box } from "@mui/material";
-import { WarningAmber, Close } from "@mui/icons-material";
-const styles = {
-  banner: (theme) => ({
-    left: 0,
-    width: "100%",
-    backgroundColor: "#f6b26b",
-    color: "black",
-    padding: theme.spacing(1),
-    textAlign: "left",
-    boxShadow: "0px 2px 5px rgba(0, 0, 0, 0.1)",
-    zIndex: 1e3,
-    display: "flex",
-    justifyContent: "flex-start",
-    alignItems: "center"
-  }),
-  icon: (theme) => ({
-    paddingRight: theme.spacing(0.75),
-    color: "red",
-    marginTop: theme.spacing(0.5)
-  }),
-  message: {
-    flexGrow: 1
-  },
-  button: (theme) => ({
-    backgroundColor: "#f6b26b",
-    border: "none",
-    cursor: "pointer",
-    borderRadius: theme.spacing(0.5),
-    marginRight: theme.spacing(0.5),
-    width: theme.spacing(3.5),
-    height: theme.spacing(3.5),
-    "&:hover": {
-      backgroundColor: "#e39648"
-    },
-    "& svg": {
-      width: "100%",
-      height: "100%"
-    }
-  })
-};
-function MessageBanner({ children }) {
-  const [visible, setVisible] = useState(true);
-  return visible && /* @__PURE__ */ jsxs(Box, { sx: styles.banner, children: [
-    /* @__PURE__ */ jsx(Box, { sx: styles.icon, children: /* @__PURE__ */ jsx(WarningAmber, {}) }),
-    /* @__PURE__ */ jsx(Box, { sx: styles.message, children }),
-    /* @__PURE__ */ jsx(Box, { sx: styles.button, onClick: () => setVisible(false), children: /* @__PURE__ */ jsx(Close, {}) })
-  ] });
-}
-export {
-  MessageBanner as default
-};