@gridsuite/commons-ui 0.257.0 → 0.258.0

package/dist/features/global-filter/global-filter.style.d.ts

@@ -0,0 +1,162 @@
+import { Theme, SxProps } from '@mui/material';
+import { GlobalFilter } from './types/global-filter.type';
+export declare const GLOBAL_FILTERS_CELL_HEIGHT: number;
+export declare const IMPORT_FILTER_HEIGHT: number;
+export declare const resultsGlobalFilterStyles: {
+    readonly autocomplete: (theme: Theme) => {
+        width: string;
+        '.MuiAutocomplete-inputRoot': {
+            height: string;
+            maxHeight: string;
+        };
+        '.Mui-expanded, .Mui-focused, .Mui-focusVisible': {
+            position: "absolute";
+            width: string;
+            height: string;
+            zIndex: number;
+            background: string;
+        };
+        '.MuiInputLabel-root': {
+            zIndex: number;
+            width: string;
+        };
+        '.MuiInputBase-root': {
+            position: "relative";
+        };
+    };
+    readonly dropdown: {
+        readonly position: "relative";
+        readonly left: "0px";
+        readonly width: `${number}px`;
+    };
+    readonly cellHeader: (theme: Theme) => {
+        color: string;
+        fontSize: string;
+        padding: number;
+        border: "1px solid";
+        borderColor: string;
+    };
+    readonly cellTooltip: (theme: Theme) => {
+        paddingLeft: string;
+    };
+    readonly cell: (theme: Theme) => {
+        borderLeft: string;
+        borderColor: string;
+    };
+    readonly list: (theme: Theme) => {
+        display: "flex";
+        flexDirection: "column";
+        color: string;
+        fontSize: string;
+        width: string;
+        maxHeight: string;
+    };
+    readonly selectedFiltersPanel: () => {
+        overflowY: "auto";
+        padding: number;
+        maxHeight: string;
+    };
+    readonly selectedFiltersSubGroup: (theme: Theme) => {
+        display: "block";
+        paddingTop: number;
+        paddingBottom: number;
+        color: string;
+    };
+    readonly selectedFiltersChips: (theme: Theme) => {
+        display: "flex";
+        flexDirection: "row";
+        flexWrap: "wrap";
+        color: string;
+        fontSize: string;
+    };
+    readonly importFilterButton: (theme: Theme) => {
+        color: string;
+        fontSize: string;
+        borderTop: string;
+        borderColor: string;
+        height: string;
+        justifyContent: "flex-start";
+        paddingLeft: string;
+    };
+    readonly miniButton: (theme: Theme) => {
+        color: string;
+        border: "1px solid";
+        borderColor: string;
+        padding: number;
+        paddingLeft: number;
+        paddingRight: number;
+        position: "absolute";
+        top: number;
+        right: number;
+    };
+    readonly chip: {
+        readonly '&.MuiChip-root': {
+            readonly margin: "1px 2px 1px 2px";
+            readonly padding: "0";
+            readonly color: "white";
+        };
+        readonly '.MuiChip-deleteIcon': {
+            readonly color: "white";
+            readonly opacity: 0.6;
+        };
+        readonly '.MuiChip-deleteIcon:hover': {
+            readonly color: "white";
+            readonly opacity: 1;
+        };
+        readonly '&.Mui-focusVisible': {
+            readonly width: "unset";
+            readonly height: "unset";
+            readonly position: "relative";
+        };
+    };
+    readonly chipCountry: (theme: Theme) => {
+        '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            backgroundColor: `${string}!important`;
+        };
+        '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            backgroundColor: `${string}!important`;
+        };
+    };
+    readonly chipVoltageLevel: (theme: Theme) => {
+        '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            backgroundColor: `${string}!important`;
+        };
+        '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            backgroundColor: `${string}!important`;
+        };
+    };
+    readonly chipGenericFilter: {
+        readonly '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            readonly backgroundColor: "#00bcd4!important";
+        };
+        readonly '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            readonly backgroundColor: "#0097a7!important";
+        };
+    };
+    readonly chipSubstationOrVoltageLevel: {
+        readonly '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            readonly backgroundColor: "#9e9d24!important";
+        };
+        readonly '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            readonly backgroundColor: "#827717!important";
+        };
+    };
+    readonly chipSubstationProperty: (theme: Theme) => {
+        '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            backgroundColor: `${string}!important`;
+        };
+        '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            backgroundColor: `${string}!important`;
+        };
+    };
+    readonly chipNotFound: (theme: Theme) => {
+        '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+            backgroundColor: `${string}!important`;
+        };
+        '&.MuiChip-root:hover, &.MuiChip-root:focus': {
+            backgroundColor: `${string}!important`;
+        };
+        color: string;
+    };
+};
+export declare const getResultsGlobalFiltersChipStyle: (element: GlobalFilter) => SxProps<Theme>;

package/dist/features/global-filter/global-filter.style.js

@@ -0,0 +1,190 @@
+import { lime, cyan } from "@mui/material/colors";
+import { GlobalFilterType } from "./types/global-filter.type.js";
+import "../../utils/conversionUtils.js";
+import "../../utils/types/equipmentType.js";
+import "react/jsx-runtime";
+import "@mui/icons-material";
+import { mergeSx } from "../../utils/styles.js";
+const AUTOCOMPLETE_WIDTH = 520;
+const POPPER_EXTRA_WIDTH = 300;
+const GLOBAL_FILTERS_CELL_HEIGHT = 400;
+const IMPORT_FILTER_HEIGHT = 40;
+const resultsGlobalFilterStyles = {
+  autocomplete: (theme) => ({
+    width: `${AUTOCOMPLETE_WIDTH}px`,
+    ".MuiAutocomplete-inputRoot": {
+      height: "40px",
+      maxHeight: "40px"
+    },
+    ".Mui-expanded, .Mui-focused, .Mui-focusVisible": {
+      position: "absolute",
+      width: "inherit",
+      height: "inherit",
+      zIndex: 20,
+      background: theme.palette.tabBackground
+    },
+    ".MuiInputLabel-root": {
+      zIndex: 30,
+      width: "auto"
+    },
+    ".MuiInputBase-root": {
+      position: "relative"
+    }
+  }),
+  // from the expanded part :
+  dropdown: {
+    position: "relative",
+    left: `0px`,
+    width: `${AUTOCOMPLETE_WIDTH + POPPER_EXTRA_WIDTH}px`
+  },
+  cellHeader: (theme) => ({
+    color: theme.palette.text.secondary,
+    fontSize: "1em",
+    padding: 1,
+    border: "1px solid",
+    borderColor: theme.palette.divider
+  }),
+  cellTooltip: (theme) => ({
+    paddingLeft: theme.spacing(1)
+  }),
+  cell: (theme) => ({
+    borderLeft: "1px solid",
+    borderColor: theme.palette.divider
+  }),
+  list: (theme) => ({
+    display: "flex",
+    flexDirection: "column",
+    color: theme.palette.text.secondary,
+    fontSize: "1em",
+    width: "100%",
+    maxHeight: `${GLOBAL_FILTERS_CELL_HEIGHT}px`
+  }),
+  selectedFiltersPanel: () => ({
+    overflowY: "auto",
+    padding: 0,
+    maxHeight: `${GLOBAL_FILTERS_CELL_HEIGHT}px`
+  }),
+  selectedFiltersSubGroup: (theme) => ({
+    display: "block",
+    paddingTop: 1,
+    paddingBottom: 0,
+    color: theme.palette.text.secondary
+  }),
+  selectedFiltersChips: (theme) => ({
+    display: "flex",
+    flexDirection: "row",
+    flexWrap: "wrap",
+    color: theme.palette.text.secondary,
+    fontSize: "1em"
+  }),
+  importFilterButton: (theme) => ({
+    color: theme.palette.text.secondary,
+    fontSize: "0.8em",
+    borderTop: "1px solid",
+    borderColor: theme.palette.divider,
+    height: `${IMPORT_FILTER_HEIGHT}px`,
+    justifyContent: "flex-start",
+    paddingLeft: "24px"
+  }),
+  miniButton: (theme) => ({
+    color: theme.palette.text.primary,
+    border: "1px solid",
+    borderColor: theme.palette.text.primary,
+    padding: 0,
+    paddingLeft: 0.5,
+    paddingRight: 0.5,
+    position: "absolute",
+    top: 12,
+    right: 8
+  }),
+  chip: {
+    "&.MuiChip-root": {
+      margin: "1px 2px 1px 2px",
+      padding: "0",
+      color: "white"
+    },
+    ".MuiChip-deleteIcon": {
+      color: "white",
+      opacity: 0.6
+    },
+    ".MuiChip-deleteIcon:hover": {
+      color: "white",
+      opacity: 1
+    },
+    "&.Mui-focusVisible": {
+      width: "unset",
+      // prevents the chip from changing size when selected with the keyboard
+      height: "unset",
+      // prevents the chip from changing size when selected with the keyboard
+      position: "relative"
+    }
+  },
+  chipCountry: (theme) => ({
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${theme.palette.info.main}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${theme.palette.info.dark}!important`
+    }
+  }),
+  chipVoltageLevel: (theme) => ({
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${theme.palette.secondary.main}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${theme.palette.secondary.dark}!important`
+    }
+  }),
+  chipGenericFilter: {
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${cyan["500"]}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${cyan["700"]}!important`
+    }
+  },
+  chipSubstationOrVoltageLevel: {
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${lime["800"]}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${lime["900"]}!important`
+    }
+  },
+  chipSubstationProperty: (theme) => ({
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${theme.palette.success.main}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${theme.palette.success.dark}!important`
+    }
+  }),
+  chipNotFound: (theme) => ({
+    '&.MuiChip-root, &.MuiChip-root[aria-selected="true"]': {
+      backgroundColor: `${theme.palette.error.main}!important`
+    },
+    "&.MuiChip-root:hover, &.MuiChip-root:focus": {
+      backgroundColor: `${theme.palette.error.dark}!important`
+    },
+    color: theme.palette.error.contrastText
+  })
+};
+const FILTER_TYPE_STYLE_MAP = {
+  [GlobalFilterType.COUNTRY]: resultsGlobalFilterStyles.chipCountry,
+  [GlobalFilterType.VOLTAGE_LEVEL]: resultsGlobalFilterStyles.chipVoltageLevel,
+  [GlobalFilterType.GENERIC_FILTER]: resultsGlobalFilterStyles.chipGenericFilter,
+  [GlobalFilterType.SUBSTATION_OR_VL]: resultsGlobalFilterStyles.chipSubstationOrVoltageLevel,
+  [GlobalFilterType.SUBSTATION_PROPERTY]: resultsGlobalFilterStyles.chipSubstationProperty
+};
+const getResultsGlobalFiltersChipStyle = (element) => {
+  return mergeSx(
+    resultsGlobalFilterStyles.chip,
+    element.deleted ? resultsGlobalFilterStyles.chipNotFound : FILTER_TYPE_STYLE_MAP[element.filterType]
+  );
+};
+export {
+  GLOBAL_FILTERS_CELL_HEIGHT,
+  IMPORT_FILTER_HEIGHT,
+  getResultsGlobalFiltersChipStyle,
+  resultsGlobalFilterStyles
+};

package/dist/features/global-filter/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2026, 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 * from './ui/global-filter-panel';
+export * from './types';
+export * from './utils';
+export * from './context';

package/dist/features/global-filter/index.js

@@ -0,0 +1,31 @@
+import { GlobalFilterPanel } from "./ui/global-filter-panel.js";
+import { GlobalFilterType, isCriteriaFilter, isCriteriaFilterType } from "./types/global-filter.type.js";
+import { LimitTypes } from "./types/limit-violation.type.js";
+import { buildValidGlobalFilters } from "./utils/build-valid-global-filters.js";
+import { isEditingGlobalFilter, markEditingGlobalFilter, unmarkEditingGlobalFilter } from "./utils/editing-global-filter-sync.js";
+import { MAX_RECENT_GLOBAL_FILTERS, addSelectedGlobalFiltersToTableState, clearSelectedGlobalFiltersFromTableState, markNotFoundGlobalFiltersAsDeletedInState, removeSelectedGlobalFiltersFromTableState } from "./utils/global-filter-state.utils.js";
+import { syncGlobalFilters } from "./utils/global-filter-sync.utils.js";
+import { RECENT_FILTER, addGlobalFilterId, getGlobalFilterId, getOptionLabel } from "./utils/global-filter-utils.js";
+import { GlobalFilterContextProvider } from "./context/global-filter-context-provider.js";
+export {
+  GlobalFilterContextProvider,
+  GlobalFilterPanel,
+  GlobalFilterType,
+  LimitTypes,
+  MAX_RECENT_GLOBAL_FILTERS,
+  RECENT_FILTER,
+  addGlobalFilterId,
+  addSelectedGlobalFiltersToTableState,
+  buildValidGlobalFilters,
+  clearSelectedGlobalFiltersFromTableState,
+  getGlobalFilterId,
+  getOptionLabel,
+  isCriteriaFilter,
+  isCriteriaFilterType,
+  isEditingGlobalFilter,
+  markEditingGlobalFilter,
+  markNotFoundGlobalFiltersAsDeletedInState,
+  removeSelectedGlobalFiltersFromTableState,
+  syncGlobalFilters,
+  unmarkEditingGlobalFilter
+};

package/dist/features/global-filter/types/global-filter.type.d.ts

@@ -0,0 +1,51 @@
+import { UUID } from 'node:crypto';
+import { LimitTypes } from './limit-violation.type';
+import { FilterConfig, SortConfig } from '../../../components';
+/**
+ * Global filters types
+ * the order of those enum values is the default order for global filter displays : do not move them around
+ */
+export declare enum GlobalFilterType {
+    VOLTAGE_LEVEL = "voltageLevel",
+    COUNTRY = "country",
+    SUBSTATION_PROPERTY = "substationProperty",
+    SUBSTATION_OR_VL = "substationOrVoltageLevelFilter",// voltage levels and substation generic filters which uses the filter library
+    GENERIC_FILTER = "genericFilter"
+}
+export declare function isCriteriaFilterType(filterType: string | undefined): boolean;
+export declare function isCriteriaFilter(filter: GlobalFilter): boolean;
+/**
+ * globals filters are the filters applied to computation results
+ * they may contain generic filters
+ */
+export interface GlobalFilters {
+    voltageRanges?: number[][];
+    countryCode?: string[];
+    genericFilter?: string[];
+    substationOrVoltageLevelFilter?: string[];
+    substationProperty?: Object;
+    limitViolationsTypes?: LimitTypes[];
+}
+export interface GlobalFilter {
+    id: string;
+    label: string;
+    filterType: string;
+    filterSubtype?: string;
+    filterTypeFromMetadata?: string;
+    unselectedDate?: number;
+    uuid?: UUID;
+    equipmentType?: string;
+    path?: string;
+    minValue?: number;
+    maxValue?: number;
+    deleted?: boolean;
+}
+export interface RecentGlobalFilter {
+    id: string;
+    unselectedDate: number;
+}
+export interface ResultsQueryParams {
+    sort?: SortConfig[];
+    filters: FilterConfig[] | null;
+    globalFilters?: GlobalFilters;
+}

package/dist/features/global-filter/types/global-filter.type.js

@@ -0,0 +1,19 @@
+var GlobalFilterType = /* @__PURE__ */ ((GlobalFilterType2) => {
+  GlobalFilterType2["VOLTAGE_LEVEL"] = "voltageLevel";
+  GlobalFilterType2["COUNTRY"] = "country";
+  GlobalFilterType2["SUBSTATION_PROPERTY"] = "substationProperty";
+  GlobalFilterType2["SUBSTATION_OR_VL"] = "substationOrVoltageLevelFilter";
+  GlobalFilterType2["GENERIC_FILTER"] = "genericFilter";
+  return GlobalFilterType2;
+})(GlobalFilterType || {});
+function isCriteriaFilterType(filterType) {
+  return filterType !== void 0 && (filterType === "genericFilter" || filterType === "substationOrVoltageLevelFilter");
+}
+function isCriteriaFilter(filter) {
+  return isCriteriaFilterType(filter.filterType);
+}
+export {
+  GlobalFilterType,
+  isCriteriaFilter,
+  isCriteriaFilterType
+};

package/dist/features/global-filter/types/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) 2026, 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 * from './global-filter.type';
+export * from './limit-violation.type';

package/dist/features/global-filter/types/index.js

@@ -0,0 +1,8 @@
+import { GlobalFilterType, isCriteriaFilter, isCriteriaFilterType } from "./global-filter.type.js";
+import { LimitTypes } from "./limit-violation.type.js";
+export {
+  GlobalFilterType,
+  LimitTypes,
+  isCriteriaFilter,
+  isCriteriaFilterType
+};

package/dist/features/global-filter/types/limit-violation.type.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) 2026, 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 enum LimitTypes {
+    HIGH_VOLTAGE = "HIGH_VOLTAGE",
+    LOW_VOLTAGE = "LOW_VOLTAGE",
+    CURRENT = "CURRENT"
+}

package/dist/features/global-filter/types/limit-violation.type.js

@@ -0,0 +1,9 @@
+var LimitTypes = /* @__PURE__ */ ((LimitTypes2) => {
+  LimitTypes2["HIGH_VOLTAGE"] = "HIGH_VOLTAGE";
+  LimitTypes2["LOW_VOLTAGE"] = "LOW_VOLTAGE";
+  LimitTypes2["CURRENT"] = "CURRENT";
+  return LimitTypes2;
+})(LimitTypes || {});
+export {
+  LimitTypes
+};

package/dist/features/global-filter/ui/global-filter-dropdown-panel.d.ts

@@ -0,0 +1,10 @@
+import { PropsWithChildren, RefObject } from 'react';
+import { GlobalFilterProps } from './global-filter-panel';
+type GlobalFilterPaperProps = PropsWithChildren<GlobalFilterProps & {
+    autocompleteRef?: RefObject<HTMLElement | null>;
+    setOpenedDropdown: (open: boolean) => void;
+    filterGroupSelected: string;
+    setFilterGroupSelected: (selectedFilterGroup: string) => void;
+}>;
+declare function GlobalFilterDropdownPanel({ children, autocompleteRef, setOpenedDropdown, filterGroupSelected, setFilterGroupSelected, substationPropertiesGlobalFilters, filterCategories, genericFiltersStrictMode, filterableEquipmentTypes, translateCountryCode, }: Readonly<GlobalFilterPaperProps>): import("react").JSX.Element;
+export default GlobalFilterDropdownPanel;