@gridsuite/commons-ui 0.46.0 → 0.47.0

package/dist/hooks/useDebounce.js

@@ -0,0 +1,17 @@
+import { useMemo, useEffect } from "react";
+import { debounce } from "@mui/material";
+const useDebounce = (func, delay = 700) => {
+  const debouncedChangeHandler = useMemo(
+    () => debounce(func, delay),
+    [func, delay]
+  );
+  useEffect(() => {
+    return () => {
+      debouncedChangeHandler.clear();
+    };
+  }, [debouncedChangeHandler]);
+  return debouncedChangeHandler;
+};
+export {
+  useDebounce
+};

package/{es/components/ElementSearchDialog/index.js → dist/hooks/useIntlRef.d.ts}

@@ -4,5 +4,5 @@
  * 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 { default } from './element-search-dialog';
-export { TagRenderer } from './tag-renderer';
+/// <reference types="react" />
+export declare function useIntlRef(): import("react").MutableRefObject<import("react-intl").IntlShape>;

package/dist/hooks/useIntlRef.js

@@ -0,0 +1,13 @@
+import { useRef, useEffect } from "react";
+import { useIntl } from "react-intl";
+function useIntlRef() {
+  const intl = useIntl();
+  const intlRef = useRef(intl);
+  useEffect(() => {
+    intlRef.current = intl;
+  }, [intl]);
+  return intlRef;
+}
+export {
+  useIntlRef
+};

package/dist/hooks/useSnackMessage.js

@@ -0,0 +1,81 @@
+import { useCallback } from "react";
+import { useSnackbar } from "notistack";
+import { useIntlRef } from "./useIntlRef.js";
+function useSnackMessage() {
+  const intlRef = useIntlRef();
+  const { enqueueSnackbar } = useSnackbar();
+  const snackError = useCallback(
+    (snackInputs) => makeSnackbar(snackInputs, intlRef, enqueueSnackbar, "error", true),
+    [enqueueSnackbar, intlRef]
+  );
+  const snackWarning = useCallback(
+    (snackInputs) => makeSnackbar(
+      snackInputs,
+      intlRef,
+      enqueueSnackbar,
+      "warning",
+      true
+    ),
+    [enqueueSnackbar, intlRef]
+  );
+  const snackInfo = useCallback(
+    (snackInputs) => makeSnackbar(snackInputs, intlRef, enqueueSnackbar, "info", false),
+    [enqueueSnackbar, intlRef]
+  );
+  return { snackError, snackInfo, snackWarning };
+}
+function makeSnackbar(snackInputs, intlRef, enqueueSnackbar, level, persistent) {
+  const message = checkAndTranslateIfNecessary(
+    snackInputs.messageTxt,
+    snackInputs.messageId,
+    snackInputs.messageValues,
+    intlRef
+  );
+  const header = checkAndTranslateIfNecessary(
+    snackInputs.headerTxt,
+    snackInputs.headerId,
+    snackInputs.headerValues,
+    intlRef
+  );
+  displayMessageWithSnackbar(
+    message,
+    header,
+    enqueueSnackbar,
+    level,
+    persistent
+  );
+}
+function checkAndTranslateIfNecessary(txt, id, values, intlRef) {
+  checkInputs(txt, id, values);
+  return txt ?? (id ? intlRef.current.formatMessage(
+    {
+      id
+    },
+    values
+  ) : null);
+}
+function checkInputs(txt, id, values) {
+  if (txt && (id || values)) {
+    console.warn("Snack inputs should be [*Txt] OR [*Id, *Values]");
+  }
+}
+function displayMessageWithSnackbar(message, header, enqueueSnackbar, level, persistent) {
+  let fullMessage = "";
+  if (header) {
+    fullMessage += header;
+  }
+  if (message) {
+    if (header) {
+      fullMessage += "\n\n";
+    }
+    fullMessage += message;
+  }
+  enqueueSnackbar(fullMessage, {
+    variant: level,
+    persist: persistent,
+    style: { whiteSpace: "pre-line" }
+  });
+}
+export {
+  useSnackMessage
+};

package/dist/index.d.ts

@@ -0,0 +1,225 @@
+import type { FunctionComponent, ReactElement } from 'react';
+import type { AutocompleteProps } from '@mui/material/Autocomplete/Autocomplete';
+import type {
+    ButtonProps,
+    SwitchProps,
+    CheckboxProps,
+    RadioGroupProps,
+    SxProps,
+    TextFieldProps,
+} from '@mui/material';
+
+/**
+ * Section to export generated type declarations of .ts or .tsx files
+ */
+
+export { useIntlRef } from './hooks/useIntlRef';
+
+/**
+ * Section to export manual type declarations of .js and .jsx files
+ */
+
+export const TopBar: FunctionComponent;
+
+export function logout(
+    dispatch: any,
+    userManagerInstance: any
+): Promise<any | undefined>;
+
+export const DARK_THEME: string, LIGHT_THEME: string;
+
+interface SnackInputs {
+    messageTxt?: string;
+    messageId?: string;
+    messageValues?: Record<string, string>;
+    headerTxt?: string;
+    headerId?: string;
+    headerValues?: Record<string, string>;
+}
+
+interface UseSnackMessageReturn {
+    snackError: (snackInputs: SnackInputs) => void;
+    snackWarning: (snackInputs: SnackInputs) => void;
+    snackInfo: (snackInputs: SnackInputs) => void;
+}
+
+export function useSnackMessage(): UseSnackMessageReturn;
+
+type Input = string | number;
+type Option = string | { id: string; label: string };
+
+interface AutocompleteInputProps
+    extends Omit<
+        AutocompleteProps<
+            Option,
+            boolean | undefined,
+            boolean | undefined,
+            boolean | undefined
+        >,
+        // we already defined them in our custom Autocomplete
+        'value' | 'onChange' | 'renderInput'
+    > {
+    name: string;
+    options: Option[];
+    label?: string;
+    outputTransform?: (value: Option) => Option;
+    inputTransform?: (value: Option) => Option;
+    readOnly?: boolean;
+    previousValue?: string;
+    allowNewValue?: boolean;
+    onChangeCallback?: () => void;
+    formProps?: Omit<
+        TextFieldProps,
+        'value' | 'onChange' | 'inputRef' | 'inputProps' | 'InputProps'
+    >;
+}
+
+export const AutocompleteInput: FunctionComponent<AutocompleteInputProps>;
+
+interface ErrorInputProps {
+    name: string;
+    InputField?: FunctionComponent;
+}
+
+export const ErrorInput: FunctionComponent<ErrorInputProps>;
+
+export const SelectInput: FunctionComponent<
+    Omit<
+        AutocompleteInputProps,
+        'outputTransform' | 'inputTransform' | 'readOnly' | 'getOptionLabel' // already defined in SelectInput
+    >
+>;
+
+export const MidFormError: FunctionComponent;
+
+export const FieldErrorAlert: FunctionComponent;
+
+type TextFieldWithAdornmentProps = TextFieldProps & {
+    // variant already included in TextFieldProps
+    value: Input; // we override the default type of TextFieldProps which is unknown
+    adornmentPosition: string;
+    adornmentText: string;
+    handleClearValue?: () => void;
+};
+
+interface TextInputProps {
+    name: string;
+    label?: string;
+    labelValues?: any; // it's for values from https://formatjs.io/docs/react-intl/components/#formattedmessage
+    id?: string;
+    adornment?: {
+        position: string;
+        text: string;
+    };
+    customAdornment?: ReactElement | null;
+    outputTransform?: (value: string) => Input;
+    inputTransform?: (value: Input) => string;
+    acceptValue?: (value: string) => boolean;
+    previousValue?: Input;
+    clearable?: boolean;
+    formProps?: Omit<
+        TextFieldWithAdornmentProps | TextFieldProps,
+        'value' | 'onChange' | 'inputRef' | 'inputProps' | 'InputProps'
+    >;
+}
+
+export const TextInput: FunctionComponent<TextInputProps>;
+
+export const FloatInput: FunctionComponent<
+    Omit<
+        TextInputProps,
+        'outputTransform' | 'inputTransform' | 'acceptValue' // already defined in FloatInput
+    >
+>;
+
+export const IntegerInput: FunctionComponent<
+    Omit<
+        TextInputProps,
+        'outputTransform' | 'inputTransform' | 'acceptValue' // already defined in IntegerInput
+    >
+>;
+
+interface RadioInputProps {
+    name: string;
+    label?: string;
+    id?: string;
+    options: Array<{
+        id: string;
+        label: string;
+    }>;
+    formProps?: Omit<RadioGroupProps, 'value' | 'onChange'>;
+}
+
+export const RadioInput: FunctionComponent<RadioInputProps>;
+
+interface SwitchInputProps {
+    name: string;
+    label?: string;
+    formProps?: Omit<SwitchProps, 'disabled'>;
+}
+
+export const SwitchInput: FunctionComponent<SwitchInputProps>;
+
+interface CheckboxInputProps {
+    name: string;
+    label?: string;
+    formProps?: Omit<CheckboxProps, 'disabled'>;
+}
+
+export const CheckboxInput: FunctionComponent<CheckboxInputProps>;
+
+export const SubmitButton: FunctionComponent<ButtonProps>;
+
+type CancelButtonProps = ButtonProps & {
+    color?: string;
+};
+
+export const CancelButton: FunctionComponent<CancelButtonProps>;
+
+export const FieldLabel: FunctionComponent<{
+    label: string;
+    optional?: boolean;
+    values?: any; // it's for values from https://formatjs.io/docs/react-intl/components/#formattedmessage
+}>;
+
+interface Parameters {
+    name: string;
+    description: string;
+    type: string;
+    defaultValue: any;
+    possibleValues?: string[] | null;
+}
+
+interface FlatParametersProps extends Pick<TextFieldProps, 'variant'> {
+    paramsAsArray: Parameters[];
+    initValues: Record<string, any>;
+    onChange: (paramName: string, value: any, isEdit: boolean) => void;
+    showSeparator?: boolean;
+    selectionWithDialog?: (parameters: Parameters) => boolean;
+}
+
+export const FlatParameters: FunctionComponent<FlatParametersProps>;
+
+export function useDebounce(
+    debouncedFunction: (...args: any[]) => void,
+    debounceDelay: number
+): (...args: any[]) => void;
+
+interface OverflowableTextProps {
+    sx?: SxProps;
+    text?: string | ReactElement;
+}
+
+export const OverflowableText: FunctionComponent<OverflowableTextProps>;
+
+export enum elementType {
+    DIRECTORY = 'DIRECTORY',
+    STUDY = 'STUDY',
+    FILTER = 'FILTER',
+    MODIFICATION = 'MODIFICATION',
+    CONTINGENCY_LIST = 'CONTINGENCY_LIST',
+    VOLTAGE_INIT_PARAMETERS = 'VOLTAGE_INIT_PARAMETERS',
+    SECURITY_ANALYSIS_PARAMETERS = 'SECURITY_ANALYSIS_PARAMETERS',
+    LOADFLOW_PARAMETERS = 'LOADFLOW_PARAMETERS',
+    SENSITIVITY_PARAMETERS = 'SENSITIVITY_PARAMETERS',
+}

package/dist/index.js

@@ -0,0 +1,154 @@
+import { default as default2 } from "./components/TreeViewFinder/TreeViewFinder.js";
+import { DARK_THEME, LANG_ENGLISH, LANG_FRENCH, LANG_SYSTEM, LIGHT_THEME, default as default3 } from "./components/TopBar/TopBar.js";
+import "./components/TopBar/GridLogo.js";
+import { default as default4 } from "./components/TopBar/AboutDialog.js";
+import { default as default5 } from "./components/SnackbarProvider/SnackbarProvider.js";
+import { default as default6 } from "./components/AuthenticationRouter/AuthenticationRouter.js";
+import { DEFAULT_CELL_PADDING, DEFAULT_HEADER_HEIGHT, DEFAULT_ROW_HEIGHT, default as default7 } from "./components/MuiVirtualizedTable/MuiVirtualizedTable.js";
+import { CHANGE_WAYS, KeyedColumnsRowIndexer } from "./components/MuiVirtualizedTable/KeyedColumnsRowIndexer.js";
+import { default as default8 } from "./components/ReportViewer/report-viewer.js";
+import { default as default9 } from "./components/ReportViewerDialog/report-viewer-dialog.js";
+import { OverflowableText } from "./components/OverflowableText/overflowable-text.js";
+import { default as default10 } from "./components/ElementSearchDialog/element-search-dialog.js";
+import { TagRenderer } from "./components/ElementSearchDialog/tag-renderer.js";
+import { FlatParameters } from "./components/FlatParameters/FlatParameters.js";
+import { default as default11 } from "./components/MultipleSelectionDialog/MultipleSelectionDialog.js";
+import { EQUIPMENT_TYPE, equipmentStyles, getEquipmentsInfosForSearchBar } from "./utils/EquipmentType.js";
+import { dispatchUser, getPreLoginPath, initializeAuthenticationDev, initializeAuthenticationProd, logout } from "./utils/AuthService.js";
+import { elementType, getFileIcon } from "./utils/ElementType.js";
+import { LOGOUT_ERROR, RESET_AUTHENTICATION_ROUTER_ERROR, SHOW_AUTH_INFO_LOGIN, SIGNIN_CALLBACK_ERROR, UNAUTHORIZED_USER_INFO, USER, USER_VALIDATION_ERROR, setLoggedUser, setSignInCallbackError } from "./utils/actions.js";
+import { default as default12 } from "./components/translations/report-viewer-en.js";
+import { default as default13 } from "./components/translations/report-viewer-fr.js";
+import { default as default14 } from "./components/translations/login-en.js";
+import { default as default15 } from "./components/translations/login-fr.js";
+import { default as default16 } from "./components/translations/top-bar-en.js";
+import { default as default17 } from "./components/translations/top-bar-fr.js";
+import { default as default18 } from "./components/translations/table-en.js";
+import { default as default19 } from "./components/translations/table-fr.js";
+import { default as default20 } from "./components/translations/treeview-finder-en.js";
+import { default as default21 } from "./components/translations/treeview-finder-fr.js";
+import { default as default22 } from "./components/translations/element-search-en.js";
+import { default as default23 } from "./components/translations/element-search-fr.js";
+import { default as default24 } from "./components/translations/equipment-search-en.js";
+import { default as default25 } from "./components/translations/equipment-search-fr.js";
+import { default as default26 } from "./components/translations/card-error-boundary-en.js";
+import { default as default27 } from "./components/translations/card-error-boundary-fr.js";
+import { default as default28 } from "./components/translations/flat-parameters-en.js";
+import { default as default29 } from "./components/translations/flat-parameters-fr.js";
+import { default as default30 } from "./components/translations/multiple-selection-dialog-en.js";
+import { default as default31 } from "./components/translations/multiple-selection-dialog-fr.js";
+import { default as default32 } from "./components/translations/common-button-en.js";
+import { default as default33 } from "./components/translations/common-button-fr.js";
+import { EquipmentItem } from "./components/ElementSearchDialog/equipment-item.js";
+import { default as default34 } from "./components/CardErrorBoundary/card-error-boundary.js";
+import { useIntlRef } from "./hooks/useIntlRef.js";
+import { useSnackMessage } from "./hooks/useSnackMessage.js";
+import { useDebounce } from "./hooks/useDebounce.js";
+import { default as default35 } from "./components/react-hook-form/autocomplete-input.js";
+import { default as default36 } from "./components/react-hook-form/text-input.js";
+import { default as default37 } from "./components/react-hook-form/radio-input.js";
+import { default as default38 } from "./components/react-hook-form/slider-input.js";
+import { default as default39 } from "./components/react-hook-form/numbers/float-input.js";
+import { default as default40 } from "./components/react-hook-form/numbers/integer-input.js";
+import { default as default41 } from "./components/react-hook-form/select-input.js";
+import { default as default42 } from "./components/react-hook-form/booleans/checkbox-input.js";
+import { default as default43 } from "./components/react-hook-form/booleans/switch-input.js";
+import { default as default44 } from "./components/react-hook-form/error-management/error-input.js";
+import { default as default45 } from "./components/react-hook-form/error-management/field-error-alert.js";
+import { default as default46 } from "./components/react-hook-form/error-management/mid-form-error.js";
+import { default as default47 } from "./components/react-hook-form/utils/text-field-with-adornment.js";
+import { default as default48 } from "./components/react-hook-form/utils/field-label.js";
+import { default as default49 } from "./components/react-hook-form/utils/submit-button.js";
+import { default as default50 } from "./components/react-hook-form/utils/cancel-button.js";
+import { genHelperError, genHelperPreviousValue, identity, isFieldRequired } from "./components/react-hook-form/utils/functions.js";
+export {
+  default4 as AboutDialog,
+  default6 as AuthenticationRouter,
+  default35 as AutocompleteInput,
+  CHANGE_WAYS,
+  default50 as CancelButton,
+  default34 as CardErrorBoundary,
+  default42 as CheckboxInput,
+  DARK_THEME,
+  DEFAULT_CELL_PADDING,
+  DEFAULT_HEADER_HEIGHT,
+  DEFAULT_ROW_HEIGHT,
+  EQUIPMENT_TYPE,
+  default10 as ElementSearchDialog,
+  EquipmentItem,
+  default44 as ErrorInput,
+  default45 as FieldErrorAlert,
+  default48 as FieldLabel,
+  FlatParameters,
+  default39 as FloatInput,
+  default40 as IntegerInput,
+  KeyedColumnsRowIndexer,
+  LANG_ENGLISH,
+  LANG_FRENCH,
+  LANG_SYSTEM,
+  LIGHT_THEME,
+  LOGOUT_ERROR,
+  default46 as MidFormError,
+  default7 as MuiVirtualizedTable,
+  default11 as MultipleSelectionDialog,
+  OverflowableText,
+  RESET_AUTHENTICATION_ROUTER_ERROR,
+  default37 as RadioInput,
+  default8 as ReportViewer,
+  default9 as ReportViewerDialog,
+  SHOW_AUTH_INFO_LOGIN,
+  SIGNIN_CALLBACK_ERROR,
+  default41 as SelectInput,
+  default38 as SliderInput,
+  default5 as SnackbarProvider,
+  default49 as SubmitButton,
+  default43 as SwitchInput,
+  TagRenderer,
+  default47 as TextFieldWithAdornment,
+  default36 as TextInput,
+  default3 as TopBar,
+  default2 as TreeViewFinder,
+  UNAUTHORIZED_USER_INFO,
+  USER,
+  USER_VALIDATION_ERROR,
+  default26 as card_error_boundary_en,
+  default27 as card_error_boundary_fr,
+  default32 as common_button_en,
+  default33 as common_button_fr,
+  dispatchUser,
+  elementType,
+  default22 as element_search_en,
+  default23 as element_search_fr,
+  equipmentStyles,
+  default24 as equipment_search_en,
+  default25 as equipment_search_fr,
+  default28 as flat_parameters_en,
+  default29 as flat_parameters_fr,
+  genHelperError,
+  genHelperPreviousValue,
+  getEquipmentsInfosForSearchBar,
+  getFileIcon,
+  getPreLoginPath,
+  identity,
+  initializeAuthenticationDev,
+  initializeAuthenticationProd,
+  isFieldRequired,
+  default14 as login_en,
+  default15 as login_fr,
+  logout,
+  default30 as multiple_selection_dialog_en,
+  default31 as multiple_selection_dialog_fr,
+  default12 as report_viewer_en,
+  default13 as report_viewer_fr,
+  setLoggedUser,
+  setSignInCallbackError,
+  default18 as table_en,
+  default19 as table_fr,
+  default16 as top_bar_en,
+  default17 as top_bar_fr,
+  default20 as treeview_finder_en,
+  default21 as treeview_finder_fr,
+  useDebounce,
+  useIntlRef,
+  useSnackMessage
+};