@gridsuite/commons-ui 0.55.0 → 0.56.0

package/dist/components/react-query-builder-inputs/use-valid.d.ts

@@ -0,0 +1,7 @@
+import { ValueEditorProps } from 'react-querybuilder';
+
+/**
+ * Hook that return if a field of RQB is valid or not
+ */
+declare const useValid: ({ validation }: ValueEditorProps) => boolean;
+export default useValid;

package/dist/components/react-query-builder-inputs/use-valid.js

@@ -0,0 +1,13 @@
+const useValid = ({ validation }) => {
+  if (validation === void 0 || validation === null) {
+    return true;
+  }
+  if (typeof validation === "boolean") {
+    return validation;
+  }
+  const convertedValidation = validation;
+  return convertedValidation.valid;
+};
+export {
+  useValid as default
+};

package/dist/components/react-query-builder-inputs/value-editor.d.ts

@@ -0,0 +1,5 @@
+import { FunctionComponent } from 'react';
+import { ValueEditorProps } from 'react-querybuilder';
+
+declare const ValueEditor: FunctionComponent<ValueEditorProps>;
+export default ValueEditor;

package/dist/components/react-query-builder-inputs/value-editor.js

@@ -0,0 +1,18 @@
+import "react/jsx-runtime";
+import "react";
+import "@react-querybuilder/material";
+import "./country-value-editor.js";
+import "./translated-value-editor.js";
+import "./text-value-editor.js";
+import "@mui/material/Box";
+import "react-hook-form";
+import "../filter/constants/field-constants.js";
+import "../filter/expert/expert-filter.type.js";
+import "../filter/constants/equipment-types.js";
+import { V } from "../../chunks/criteria-based-filter-edition-dialog.DxqH-mLe.js";
+import "../../utils/ElementType.js";
+import "./property-value-editor.js";
+import "../filter/constants/filter-constants.js";
+export {
+  V as default
+};

package/dist/components/react-query-builder-inputs/value-selector.d.ts

@@ -0,0 +1,4 @@
+import { ValueSelectorProps } from 'react-querybuilder';
+
+declare const ValueSelector: (props: ValueSelectorProps) => import("react/jsx-runtime").JSX.Element;
+export default ValueSelector;

package/dist/components/react-query-builder-inputs/value-selector.js

@@ -0,0 +1,14 @@
+import { jsx } from "react/jsx-runtime";
+import { MaterialValueSelector } from "@react-querybuilder/material";
+const ValueSelector = (props) => {
+  return /* @__PURE__ */ jsx(
+    MaterialValueSelector,
+    {
+      ...props,
+      title: void 0
+    }
+  );
+};
+export {
+  ValueSelector as default
+};

package/dist/hooks/localized-countries-hook.d.ts

@@ -0,0 +1,6 @@
+export function getSystemLanguage(): string;
+export function getComputedLanguage(language: any): any;
+export function useLocalizedCountries(language: any): {
+    translate: (countryCode: any) => any;
+    countryCodes: string[];
+};

package/dist/hooks/localized-countries-hook.js

@@ -0,0 +1,45 @@
+import { useState, useEffect, useMemo, useCallback } from "react";
+import localizedCountries from "localized-countries";
+import countriesFr from "localized-countries/data/fr";
+import countriesEn from "localized-countries/data/en";
+import { LANG_ENGLISH, LANG_SYSTEM, LANG_FRENCH } from "../components/TopBar/TopBar.js";
+const supportedLanguages = [LANG_FRENCH, LANG_ENGLISH];
+const getSystemLanguage = () => {
+  const systemLanguage = navigator.language.split(/[-_]/)[0];
+  return supportedLanguages.includes(systemLanguage) ? systemLanguage : LANG_ENGLISH;
+};
+const getComputedLanguage = (language) => {
+  return language === LANG_SYSTEM ? getSystemLanguage() : language;
+};
+const useLocalizedCountries = (language) => {
+  const [localizedCountriesModule, setLocalizedCountriesModule] = useState();
+  useEffect(() => {
+    const lang = getComputedLanguage(language).substring(0, 2);
+    let localizedCountriesResult;
+    if (lang === "fr") {
+      localizedCountriesResult = localizedCountries(countriesFr);
+    } else if (lang === "en") {
+      localizedCountriesResult = localizedCountries(countriesEn);
+    } else {
+      console.warn(
+        'Unsupported language "' + lang + '" for countries translation, we use english as default'
+      );
+      localizedCountriesResult = localizedCountries(countriesEn);
+    }
+    setLocalizedCountriesModule(localizedCountriesResult);
+  }, [language]);
+  const countryCodes = useMemo(
+    () => localizedCountriesModule ? Object.keys(localizedCountriesModule.object()) : [],
+    [localizedCountriesModule]
+  );
+  const translate = useCallback(
+    (countryCode) => localizedCountriesModule ? localizedCountriesModule.get(countryCode) : "",
+    [localizedCountriesModule]
+  );
+  return { translate, countryCodes };
+};
+export {
+  getComputedLanguage,
+  getSystemLanguage,
+  useLocalizedCountries
+};

package/dist/hooks/predefined-properties-hook.d.ts

@@ -0,0 +1,18 @@
+import { EquipmentType, PredefinedProperties } from '../utils/types.ts';
+import { Dispatch, SetStateAction } from 'react';
+
+interface Metadata {
+    name: string;
+    url: string;
+    appColor: string;
+    hiddenInAppsMenu: boolean;
+    resources: unknown;
+}
+export interface StudyMetadata extends Metadata {
+    name: 'Study';
+    predefinedEquipmentProperties: {
+        [networkElementType: string]: PredefinedProperties;
+    };
+}
+export declare const usePredefinedProperties: (initialType: EquipmentType | null) => [PredefinedProperties, Dispatch<SetStateAction<EquipmentType | null>>];
+export {};

package/dist/hooks/predefined-properties-hook.js

@@ -0,0 +1,43 @@
+import { useState, useContext, useEffect } from "react";
+import { mapEquipmentTypeForPredefinedProperties } from "../utils/equipment-types-for-predefined-properties-mapper.js";
+import { useSnackMessage } from "./useSnackMessage.js";
+import { FilterContext } from "../components/filter/filter-context.js";
+const isStudyMetadata = (metadata) => {
+  return metadata.name === "Study";
+};
+const fetchPredefinedProperties = async (equipmentType, fetchAppsAndUrls) => {
+  var _a;
+  const networkEquipmentType = mapEquipmentTypeForPredefinedProperties(equipmentType);
+  if (networkEquipmentType === void 0) {
+    return Promise.resolve(void 0);
+  }
+  const res = await fetchAppsAndUrls();
+  const studyMetadata = res.filter(isStudyMetadata);
+  if (!studyMetadata) {
+    return Promise.reject("Study entry could not be found in metadata");
+  }
+  return (_a = studyMetadata[0].predefinedEquipmentProperties) == null ? void 0 : _a[networkEquipmentType];
+};
+const usePredefinedProperties = (initialType) => {
+  const [type, setType] = useState(initialType);
+  const [equipmentPredefinedProps, setEquipmentPredefinedProps] = useState({});
+  const { snackError } = useSnackMessage();
+  const { fetchAppsAndUrls } = useContext(FilterContext);
+  useEffect(() => {
+    if (fetchAppsAndUrls && type !== null) {
+      fetchPredefinedProperties(type, fetchAppsAndUrls).then((p) => {
+        if (p !== void 0) {
+          setEquipmentPredefinedProps(p);
+        }
+      }).catch((error) => {
+        snackError({
+          messageTxt: error.message ?? error
+        });
+      });
+    }
+  }, [type, setEquipmentPredefinedProps, snackError, fetchAppsAndUrls]);
+  return [equipmentPredefinedProps, setType];
+};
+export {
+  usePredefinedProperties
+};

package/dist/hooks/useDebounce.d.ts

@@ -1 +1,7 @@
-export function useDebounce(func: any, delay?: number): 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/.
+ */
+export declare const useDebounce: (func: (...args: any[]) => any, delay?: number) => ((...args: any[]) => any) & import('@mui/utils/debounce').Cancelable;

package/dist/hooks/useSnackMessage.d.ts

@@ -1,5 +1,23 @@
-export function useSnackMessage(): {
-    snackError: (snackInputs: any) => void;
-    snackInfo: (snackInputs: any) => void;
-    snackWarning: (snackInputs: any) => void;
-};
+/**
+ * Copyright (c) 2021, 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/.
+ */
+interface SnackInputs {
+    messageTxt?: string;
+    messageId?: string;
+    messageValues?: {
+        [key: string]: string;
+    };
+    headerTxt?: string;
+    headerId?: string;
+    headerValues?: Record<string, string>;
+}
+export interface UseSnackMessageReturn {
+    snackError: (snackInputs: SnackInputs) => void;
+    snackWarning: (snackInputs: SnackInputs) => void;
+    snackInfo: (snackInputs: SnackInputs) => void;
+}
+export declare function useSnackMessage(): UseSnackMessageReturn;
+export {};

package/dist/hooks/useSnackMessage.js

@@ -26,26 +26,28 @@ function useSnackMessage() {
 }
 function makeSnackbar(snackInputs, intlRef, enqueueSnackbar, level, persistent) {
   const message = checkAndTranslateIfNecessary(
+    intlRef,
     snackInputs.messageTxt,
     snackInputs.messageId,
-    snackInputs.messageValues,
-    intlRef
+    snackInputs.messageValues
   );
   const header = checkAndTranslateIfNecessary(
+    intlRef,
     snackInputs.headerTxt,
     snackInputs.headerId,
-    snackInputs.headerValues,
-    intlRef
-  );
-  displayMessageWithSnackbar(
-    message,
-    header,
-    enqueueSnackbar,
-    level,
-    persistent
+    snackInputs.headerValues
   );
+  if (message !== null && header !== null) {
+    displayMessageWithSnackbar(
+      message,
+      header,
+      enqueueSnackbar,
+      level,
+      persistent
+    );
+  }
 }
-function checkAndTranslateIfNecessary(txt, id, values, intlRef) {
+function checkAndTranslateIfNecessary(intlRef, txt, id, values) {
   checkInputs(txt, id, values);
   return txt ?? (id ? intlRef.current.formatMessage(
     {

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import { ButtonProps, CheckboxProps, RadioGroupProps, SwitchProps, SxProps, TextFieldProps } from '@mui/material';
-import { AutocompleteProps } from '@mui/material/Autocomplete/Autocomplete';
+import { CheckboxProps, SwitchProps, SxProps, TextFieldProps } from '@mui/material';
 import { FunctionComponent, ReactElement } from 'react';
 
 
@@ -41,8 +40,6 @@ export {
     getPreLoginPath,
 } from './utils/AuthService';
 
-export { getFileIcon } from './utils/ElementIcon';
-
 export {
     DEFAULT_CELL_PADDING,
     DEFAULT_HEADER_HEIGHT,
@@ -67,6 +64,10 @@ export {
     RESET_AUTHENTICATION_ROUTER_ERROR,
     SHOW_AUTH_INFO_LOGIN,
 } from './utils/actions';
+export {
+    getCriteriaBasedFormData,
+    getCriteriaBasedSchema,
+} from './components/filter/utils/criteria-based-utils';
 export { default as report_viewer_en } from './components/translations/report-viewer-en';
 export { default as report_viewer_fr } from './components/translations/report-viewer-fr';
 export { default as login_en } from './components/translations/login-en';
@@ -95,27 +96,105 @@ export { default as directory_items_input_fr } from './components/translations/d
 export { TagRenderer } from './components/ElementSearchDialog';
 export { EquipmentItem } from './components/ElementSearchDialog/equipment-item';
 export { useIntlRef } from './hooks/useIntlRef';
+export { default as SelectClearable } from './components/inputs/select-clearable';
 export { useCustomFormContext } from './components/react-hook-form/provider/use-custom-form-context';
 export { default as CustomFormProvider } from './components/react-hook-form/provider/custom-form-provider';
 export { default as SliderInput } from './components/react-hook-form/slider-input';
 export { default as TextFieldWithAdornment } from './components/react-hook-form/utils/text-field-with-adornment';
+export { default as SelectInput } from './components/react-hook-form/select-inputs/select-input';
+export { default as ErrorInput } from './components/react-hook-form/error-management/error-input';
+export { default as AutocompleteInput } from './components/react-hook-form/autocomplete-input';
+export { default as TextInput } from './components/react-hook-form/text-input';
+export { default as FloatInput } from './components/react-hook-form/numbers/float-input';
+export { default as RadioInput } from './components/react-hook-form/radio-input';
+export { default as SubmitButton } from './components/react-hook-form/utils/submit-button';
+export { default as CancelButton } from './components/react-hook-form/utils/cancel-button';
+export { default as FieldLabel } from './components/react-hook-form/utils/field-label';
+export { default as FieldErrorAlert } from './components/react-hook-form/error-management/field-error-alert';
+export { default as FilterCreationDialog } from './components/filter/filter-creation-dialog';
+export { default as ExpertFilterEditionDialog } from './components/filter/expert/expert-filter-edition-dialog';
+export { default as ExplicitNamingFilterEditionDialog } from './components/filter/explicit-naming/explicit-naming-filter-edition-dialog';
+export { default as CriteriaBasedFilterEditionDialog } from './components/filter/criteria-based/criteria-based-filter-edition-dialog';
+export { default as ExpandingTextField } from './components/react-hook-form/expanding-text-field';
+export { default as CustomMuiDialog } from './components/dialogs/custom-mui-dialog';
 export {
     genHelperPreviousValue,
     genHelperError,
     identity,
     isFieldRequired,
+    gridItem,
+    isFloatNumber,
+    toFloatOrNullValue,
 } from './components/react-hook-form/utils/functions';
 export { default as DirectoryItemsInput } from './components/react-hook-form/directory-items-input';
 export { default as DirectoryItemSelector } from './components/DirectoryItemSelector/directory-item-selector';
 export { RawReadOnlyInput } from './components/react-hook-form/raw-read-only-input';
 export { UserManagerMock } from './utils/UserManagerMock';
+export {
+    keyGenerator,
+    areArrayElementsUnique,
+    mergeSx,
+    isObjectEmpty,
+} from './utils/functions';
 
+export { ElementType, getFileIcon } from './utils/ElementType';
+export {
+    saveExplicitNamingFilter,
+    saveCriteriaBasedFilter,
+    saveExpertFilter,
+} from './components/filter/utils/filters-utils';
 export {
-    ExpandingTextFieldProps,
-    ExpandingTextField,
-} from './components/react-hook-form/expanding-text-field';
+    RangeInput,
+    DEFAULT_RANGE_VALUE,
+    getRangeInputDataForm,
+    getRangeInputSchema,
+} from './components/react-hook-form/range-input';
+export { InputWithPopupConfirmation } from './components/react-hook-form/select-inputs/input-with-popup-confirmation';
+export { MuiSelectInput } from './components/react-hook-form/select-inputs/mui-select-input';
+export {
+    CountriesInput,
+    getSystemLanguage,
+    getComputedLanguage,
+} from './components/react-hook-form/select-inputs/countries-input';
+export { MultipleAutocompleteInput } from './components/react-hook-form/autocomplete-inputs/multiple-autocomplete-input';
+export { CsvUploader } from './components/react-hook-form/ag-grid-table-rhf/csv-uploader/csv-uploader';
+export { UniqueNameInput } from './components/react-hook-form/unique-name-input';
 
-export { ElementType } from './utils/ElementType';
+export {
+    Line,
+    Generator,
+    Load,
+    Battery,
+    SVC,
+    DanglingLine,
+    LCC,
+    VSC,
+    Hvdc,
+    BusBar,
+    TwoWindingTransfo,
+    ThreeWindingTransfo,
+    ShuntCompensator,
+    VoltageLevel,
+    Substation,
+    noSelectionForCopy,
+} from './components/filter/constants/equipment-types';
+
+export { FieldConstants } from './components/filter/constants/field-constants';
+
+export {
+    GRIDSUITE_DEFAULT_PRECISION,
+    roundToPrecision,
+    roundToDefaultPrecision,
+    isBlankOrEmpty,
+    unitToMicroUnit,
+    microUnitToUnit,
+} from './utils/conversion-utils';
+
+export { useSnackMessage } from './hooks/useSnackMessage';
+export { useDebounce } from './hooks/useDebounce';
+export { ROW_DRAGGING_SELECTION_COLUMN_DEF } from './components/react-hook-form/ag-grid-table-rhf/custom-ag-grid-table';
+export { FILTER_EQUIPMENTS } from './components/filter/utils/criteria-based-utils';
+export { CONTINGENCY_LIST_EQUIPMENTS } from './components/filter/utils/criteria-based-utils';
 
 /**
  * Section to export manual type declarations of .js and .jsx files
@@ -130,110 +209,8 @@ export function logout(
     userManagerInstance: any
 ): Promise<any | undefined>;
 
-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;
-};
-
-export 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,
@@ -241,19 +218,6 @@ export const IntegerInput: FunctionComponent<
     >
 >;
 
-interface RadioInputProps {
-    name: string;
-    label?: string;
-    id?: string;
-    options: Array<{
-        id: string;
-        label: string;
-    }>;
-    formProps?: Omit<RadioGroupProps, 'value'>;
-}
-
-export const RadioInput: FunctionComponent<RadioInputProps>;
-
 interface SwitchInputProps {
     name: string;
     label?: string;
@@ -270,20 +234,6 @@ interface CheckboxInputProps {
 
 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;
@@ -302,11 +252,6 @@ interface FlatParametersProps extends Pick<TextFieldProps, 'variant'> {
 
 export const FlatParameters: FunctionComponent<FlatParametersProps>;
 
-export function useDebounce(
-    debouncedFunction: (...args: any[]) => void,
-    debounceDelay: number
-): (...args: any[]) => void;
-
 interface OverflowableTextProps {
     sx?: SxProps;
     text?: string | ReactElement;