@gridsuite/commons-ui 0.57.0 → 0.59.0

package/dist/components/TopBar/AboutDialog.d.ts

@@ -1,24 +1,31 @@
-import { default as PropTypes } from 'prop-types';
-export default AboutDialog;
-declare function AboutDialog({ open, onClose, globalVersionPromise, appName, appVersion, appGitTag, appLicense, additionalModulesPromise, }: {
-    open: any;
-    onClose: any;
-    globalVersionPromise: any;
-    appName: any;
-    appVersion: any;
-    appGitTag: any;
-    appLicense: any;
-    additionalModulesPromise: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace AboutDialog {
-    namespace propTypes {
-        let open: PropTypes.Validator<boolean>;
-        let onClose: PropTypes.Requireable<(...args: any[]) => any>;
-        let appName: PropTypes.Validator<string>;
-        let appVersion: PropTypes.Requireable<string>;
-        let appGitTag: PropTypes.Requireable<string>;
-        let appLicense: PropTypes.Requireable<string>;
-        let globalVersionPromise: PropTypes.Requireable<(...args: any[]) => any>;
-        let additionalModulesPromise: PropTypes.Requireable<(...args: any[]) => any>;
-    }
+/**
+ * Copyright (c) 2023, 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/.
+ */
+declare const moduleTypeSort: {
+    app: number;
+    server: number;
+    other: number;
+};
+type ModuleType = keyof typeof moduleTypeSort;
+type GridSuiteModule = {
+    name: string;
+    type: ModuleType;
+    version?: string;
+    gitTag?: string;
+    license?: string;
+};
+export interface AboutDialogProps {
+    open: boolean;
+    onClose: () => void;
+    globalVersionPromise?: () => Promise<string>;
+    appName: string;
+    appVersion?: string;
+    appGitTag?: string;
+    appLicense?: string;
+    additionalModulesPromise?: () => Promise<GridSuiteModule[]>;
 }
+declare const AboutDialog: ({ open, onClose, globalVersionPromise, appName, appVersion, appGitTag, appLicense, additionalModulesPromise, }: AboutDialogProps) => import("react/jsx-runtime").JSX.Element;
+export default AboutDialog;

package/dist/components/TopBar/AboutDialog.js

@@ -4,7 +4,6 @@ import { useTheme, Dialog, useMediaQuery, DialogTitle, Collapse, Alert, Box, Fad
 import { LoadingButton } from "@mui/lab";
 import { Refresh, ExpandMore, Gavel, Apps, WidgetsOutlined, DnsOutlined, QuestionMark } from "@mui/icons-material";
 import { FormattedMessage } from "react-intl";
-import PropTypes from "prop-types";
 import { LogoText } from "./GridLogo.js";
 const styles = {
   general: {
@@ -42,7 +41,7 @@ function getGlobalVersion(fnPromise, type, setData, setLoader) {
       if (setLoader) {
         setLoader(true);
       }
-      resolve();
+      resolve(null);
     }).then(() => fnPromise()).then(
       (value) => {
         console.debug(type, "global version is", value);
@@ -72,7 +71,7 @@ const moduleTypeSort = {
   other: 20
 };
 function compareModules(c1, c2) {
-  return [moduleTypeSort[c1.type] || 100] - [moduleTypeSort[c2.type] || 100] || (c1.name || "").localeCompare(c2.name || "");
+  return (moduleTypeSort[c1.type] || 100) - (moduleTypeSort[c2.type] || 100) || (c1.name || "").localeCompare(c2.name || "");
 }
 const AboutDialog = ({
   open,
@@ -220,7 +219,7 @@ const AboutDialog = ({
                       {
                         component: "span",
                         sx: styles.versionField(
-                          !loadingGlobalVersion && actualGlobalVersion
+                          !loadingGlobalVersion && !!actualGlobalVersion
                         ),
                         children: actualGlobalVersion || "unknown"
                       }
@@ -311,16 +310,6 @@ const AboutDialog = ({
     }
   );
 };
-AboutDialog.propTypes = {
-  open: PropTypes.bool.isRequired,
-  onClose: PropTypes.func,
-  appName: PropTypes.string.isRequired,
-  appVersion: PropTypes.string,
-  appGitTag: PropTypes.string,
-  appLicense: PropTypes.string,
-  globalVersionPromise: PropTypes.func,
-  additionalModulesPromise: PropTypes.func
-};
 const moduleStyles = {
   icons: {
     flexGrow: 0,
@@ -388,7 +377,7 @@ function tooltipTypeLabel(type) {
     return "about-dialog/module-tooltip-other";
   }
 }
-const Module = ({ type, name, version, gitTag, license }) => {
+const Module = ({ type, name, version, gitTag }) => {
   return /* @__PURE__ */ jsx(
     Grid,
     {
@@ -455,13 +444,6 @@ const Module = ({ type, name, version, gitTag, license }) => {
     }
   );
 };
-Module.propTypes = {
-  type: PropTypes.string,
-  name: PropTypes.string,
-  version: PropTypes.string,
-  gitTag: PropTypes.string,
-  license: PropTypes.string
-};
 export {
   AboutDialog as default
 };

package/dist/components/TopBar/GridLogo.d.ts

@@ -1,34 +1,15 @@
-import { default as PropTypes } from 'prop-types';
-export default GridLogo;
-export function LogoText({ appName, appColor, style, onClick }: {
-    appName: any;
-    appColor: any;
-    style: any;
-    onClick: any;
-}): import("react/jsx-runtime").JSX.Element;
-export namespace LogoText {
-    namespace propTypes {
-        let appName: PropTypes.Validator<string>;
-        let appColor: PropTypes.Validator<string>;
-        let style: PropTypes.Requireable<object>;
-        let onClick: PropTypes.Requireable<(...args: any[]) => any>;
-    }
+import { ReactNode } from 'react';
+import { SxProps } from '@mui/material';
+
+export interface GridLogoProps extends Omit<LogoTextProps, 'style'> {
+    appLogo: ReactNode;
 }
-declare function GridLogo({ appLogo, appName, appColor, onClick }: {
-    appLogo: any;
-    appName: any;
-    appColor: any;
-    onClick: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace GridLogo {
-    export namespace propTypes_1 {
-        export let appLogo: PropTypes.Requireable<PropTypes.ReactElementLike>;
-        let appName_1: PropTypes.Validator<string>;
-        export { appName_1 as appName };
-        let appColor_1: PropTypes.Validator<string>;
-        export { appColor_1 as appColor };
-        let onClick_1: PropTypes.Requireable<(...args: any[]) => any>;
-        export { onClick_1 as onClick };
-    }
-    export { propTypes_1 as propTypes };
+declare const GridLogo: ({ appLogo, appName, appColor, onClick, }: Partial<GridLogoProps>) => import("react/jsx-runtime").JSX.Element;
+export default GridLogo;
+export interface LogoTextProps {
+    appName: string;
+    appColor: string;
+    style: SxProps;
+    onClick: () => void;
 }
+export declare const LogoText: ({ appName, appColor, style, onClick, }: Partial<LogoTextProps>) => import("react/jsx-runtime").JSX.Element;

package/dist/components/TopBar/GridLogo.js

@@ -2,7 +2,6 @@ import { jsxs, Fragment, jsx } from "react/jsx-runtime";
 import { Box, Typography } from "@mui/material";
 import { BrokenImage } from "@mui/icons-material";
 import { mergeSx } from "../../utils/styles.js";
-import PropTypes from "prop-types";
 const styles = {
   logo: {
     flexShrink: 0,
@@ -18,7 +17,12 @@ const styles = {
     cursor: "pointer"
   }
 };
-const GridLogo = ({ appLogo, appName, appColor, onClick }) => {
+const GridLogo = ({
+  appLogo,
+  appName,
+  appColor,
+  onClick
+}) => {
   return /* @__PURE__ */ jsxs(Fragment, { children: [
     /* @__PURE__ */ jsx(
       Box,
@@ -39,13 +43,12 @@ const GridLogo = ({ appLogo, appName, appColor, onClick }) => {
     )
   ] });
 };
-GridLogo.propTypes = {
-  appLogo: PropTypes.element,
-  appName: PropTypes.string.isRequired,
-  appColor: PropTypes.string.isRequired,
-  onClick: PropTypes.func
-};
-const LogoText = ({ appName, appColor, style, onClick }) => {
+const LogoText = ({
+  appName,
+  appColor,
+  style,
+  onClick
+}) => {
   return /* @__PURE__ */ jsxs(
     Typography,
     {
@@ -59,12 +62,6 @@ const LogoText = ({ appName, appColor, style, onClick }) => {
     }
   );
 };
-LogoText.propTypes = {
-  appName: PropTypes.string.isRequired,
-  appColor: PropTypes.string.isRequired,
-  style: PropTypes.oneOfType([PropTypes.object, PropTypes.func]),
-  onClick: PropTypes.func
-};
 export {
   LogoText,
   GridLogo as default

package/dist/components/TopBar/TopBar.d.ts

@@ -1,53 +1,54 @@
+import { CommonMetadata } from '../../services';
+import { User } from 'oidc-client';
+import { LogoutProps } from '../Login/Logout';
+import { AboutDialogProps } from './AboutDialog';
+import { GridLogoProps } from './GridLogo';
 import { default as PropTypes } from 'prop-types';
-export const DARK_THEME: "Dark";
-export const LIGHT_THEME: "Light";
-export const LANG_SYSTEM: "sys";
-export const LANG_ENGLISH: "en";
-export const LANG_FRENCH: "fr";
+import { PropsWithChildren } from 'react';
+
+export declare const DARK_THEME = "Dark";
+export declare const LIGHT_THEME = "Light";
+export declare const LANG_SYSTEM = "sys";
+export declare const LANG_ENGLISH = "en";
+export declare const LANG_FRENCH = "fr";
+export type GsLang = typeof LANG_ENGLISH | typeof LANG_FRENCH | typeof LANG_SYSTEM;
+export type GsTheme = typeof LIGHT_THEME | typeof DARK_THEME;
+export type TopBarProps = Omit<GridLogoProps, 'onClick'> & Omit<LogoutProps, 'disabled'> & Omit<AboutDialogProps, 'open' | 'onClose'> & {
+    onParametersClick?: () => void;
+    onLogoClick: GridLogoProps['onClick'];
+    user: User;
+    onAboutClick?: () => void;
+    appsAndUrls: CommonMetadata[];
+    onThemeClick?: (theme: GsTheme) => void;
+    theme?: GsTheme;
+    onEquipmentLabellingClick?: (toggle: boolean) => void;
+    equipmentLabelling?: boolean;
+    onLanguageClick: (value: GsLang) => void;
+    language: GsLang;
+};
+declare const TopBar: {
+    ({ appName, appColor, appLogo, appVersion, appLicense, onParametersClick, onLogoutClick, onLogoClick, user, children, appsAndUrls, onAboutClick, globalVersionPromise, additionalModulesPromise, onThemeClick, theme, onEquipmentLabellingClick, equipmentLabelling, onLanguageClick, language, }: PropsWithChildren<TopBarProps>): import("react/jsx-runtime").JSX.Element;
+    propTypes: {
+        onParametersClick: PropTypes.Requireable<(...args: any[]) => any>;
+        onLogoutClick: PropTypes.Requireable<(...args: any[]) => any>;
+        onLogoClick: PropTypes.Requireable<(...args: any[]) => any>;
+        appName: PropTypes.Requireable<string>;
+        appColor: PropTypes.Requireable<string>;
+        appLogo: PropTypes.Requireable<object>;
+        appVersion: PropTypes.Requireable<string>;
+        appLicense: PropTypes.Requireable<string>;
+        user: PropTypes.Requireable<object>;
+        children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
+        appsAndUrls: PropTypes.Requireable<any[]>;
+        onThemeClick: PropTypes.Requireable<(...args: any[]) => any>;
+        theme: PropTypes.Requireable<string>;
+        onAboutClick: PropTypes.Requireable<(...args: any[]) => any>;
+        globalVersionPromise: PropTypes.Requireable<(...args: any[]) => any>;
+        additionalModulesPromise: PropTypes.Requireable<(...args: any[]) => any>;
+        onEquipmentLabellingClick: PropTypes.Requireable<(...args: any[]) => any>;
+        equipmentLabelling: PropTypes.Requireable<boolean>;
+        onLanguageClick: PropTypes.Validator<(...args: any[]) => any>;
+        language: PropTypes.Validator<string>;
+    };
+};
 export default TopBar;
-declare function TopBar({ appName, appColor, appLogo, appVersion, appLicense, onParametersClick, onLogoutClick, onLogoClick, user, children, appsAndUrls, onAboutClick, globalVersionPromise, additionalModulesPromise, onThemeClick, theme, onEquipmentLabellingClick, equipmentLabelling, onLanguageClick, language, }: {
-    appName: any;
-    appColor: any;
-    appLogo: any;
-    appVersion: any;
-    appLicense: any;
-    onParametersClick: any;
-    onLogoutClick: any;
-    onLogoClick: any;
-    user: any;
-    children: any;
-    appsAndUrls: any;
-    onAboutClick: any;
-    globalVersionPromise: any;
-    additionalModulesPromise: any;
-    onThemeClick: any;
-    theme: any;
-    onEquipmentLabellingClick: any;
-    equipmentLabelling: any;
-    onLanguageClick: any;
-    language: any;
-}): import("react/jsx-runtime").JSX.Element;
-declare namespace TopBar {
-    namespace propTypes {
-        let onParametersClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let onLogoutClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let onLogoClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let appName: PropTypes.Requireable<string>;
-        let appColor: PropTypes.Requireable<string>;
-        let appLogo: PropTypes.Requireable<object>;
-        let appVersion: PropTypes.Requireable<string>;
-        let appLicense: PropTypes.Requireable<string>;
-        let user: PropTypes.Requireable<object>;
-        let children: PropTypes.Requireable<PropTypes.ReactNodeLike>;
-        let appsAndUrls: PropTypes.Requireable<any[]>;
-        let onThemeClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let theme: PropTypes.Requireable<string>;
-        let onAboutClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let globalVersionPromise: PropTypes.Requireable<(...args: any[]) => any>;
-        let additionalModulesPromise: PropTypes.Requireable<(...args: any[]) => any>;
-        let onEquipmentLabellingClick: PropTypes.Requireable<(...args: any[]) => any>;
-        let equipmentLabelling: PropTypes.Requireable<boolean>;
-        let onLanguageClick: PropTypes.Validator<(...args: any[]) => any>;
-        let language: PropTypes.Validator<string>;
-    }
-}