@open-ui-kit/core 1.2.1 → 1.3.1

package/index.d.ts

@@ -2,7 +2,7 @@ import * as React$1 from 'react';
 import React__default, { ReactNode, CSSProperties, ReactElement, ComponentProps, JSX as JSX$1, ComponentType } from 'react';
 import { ColorPartial } from '@mui/material/styles/createPalette';
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { BreadcrumbsProps as BreadcrumbsProps$1, TabsProps as TabsProps$1, HeaderProps as HeaderProps$1, LinkProps as LinkProps$1, LinkColorEnum as LinkColorEnum$1, LinkType as LinkType$1, CopyButtonProps as CopyButtonProps$1, TooltipProps as TooltipProps$1, SearchFieldProps as SearchFieldProps$1, EmptyStateProps as EmptyStateProps$1, ILegendProps as ILegendProps$1, IWidgetProps as IWidgetProps$1 } from '@/components';
+import { BreadcrumbsProps as BreadcrumbsProps$1, TabsProps as TabsProps$1, HeaderProps as HeaderProps$1, LinkProps as LinkProps$1, LinkColorEnum as LinkColorEnum$1, LinkType as LinkType$1, CopyButtonProps as CopyButtonProps$1, TooltipProps as TooltipProps$1, SearchFieldProps as SearchFieldProps$1, IndicatorBadgeProps as IndicatorBadgeProps$1, EmptyStateProps as EmptyStateProps$1, ILegendProps as ILegendProps$1, IWidgetProps as IWidgetProps$1 } from '@/components';
 import * as _mui_material from '@mui/material';
 import { BoxProps, TabProps, AccordionProps as AccordionProps$1, AccordionSummaryProps, SxProps, AlertProps, BadgeProps as BadgeProps$1, TypographyProps, BreadcrumbsProps as BreadcrumbsProps$2, StackOwnProps, Theme, IconButtonProps, Popper, TextFieldProps, PopoverProps, DrawerProps, ButtonProps, MenuProps, SvgIconProps, ListItemProps, StackProps, AppBarProps, CSSProperties as CSSProperties$1, DialogTitleProps, MenuItemProps as MenuItemProps$1, InputProps, CircularProgressProps, TabsProps as TabsProps$2, ChipProps, SwitchProps, TooltipProps as TooltipProps$3, PaginationProps as PaginationProps$1 } from '@mui/material';
 export { Avatar, Backdrop, Box, Button, ButtonGroup, Card, CardActionArea, CardActions, CardContent, CardHeader, Checkbox, Container, Dialog, Divider, Drawer, Fab, Grid, Icon, IconButton, List, ListItem, ListItemButton, Menu, MenuProps, Dialog as Modal, DialogActions as ModalActions, DialogContent as ModalContent, DialogContentText as ModalContentText, DialogProps as ModalProps, Paper, Radio, RadioGroup, Select, Skeleton, Slider, SpeedDial, Stack, Stepper, Typography, debounce } from '@mui/material';
@@ -875,6 +875,16 @@ interface HeaderProps {
 
 declare const Header: ({ logo, title, searchProps, actions, userSection, position, elevation, useDivider, customSearchNode, sx, }: HeaderProps) => react_jsx_runtime.JSX.Element;
 
+interface IndicatorBadgeValueProps {
+    color: string;
+    isActive?: boolean;
+}
+
+interface IndicatorBadgeProps extends Pick<IndicatorBadgeValueProps, "color"> {
+    value: 0 | 1 | 2 | 3 | 4;
+}
+declare const IndicatorBadge: ({ color, value, }: IndicatorBadgeProps) => JSX.Element;
+
 interface ILegendProps<T extends string> {
     headers: T[];
     rows: TRow<T>[];
@@ -975,6 +985,42 @@ interface SeverityBarProps {
 }
 declare const SeverityBar$1: ({ severity, sx, }: SeverityBarProps) => JSX.Element;
 
+interface SeverityBadgeProps {
+    /**
+     * Set a type if you want to display the badge in severity colors.
+     */
+    severity?: Severity$1;
+    /**
+     * Set a value if you want to display the badge in score system colors.
+     * `severity` param overrides this behaviour.
+     */
+    value?: number;
+    /**
+     * Customizable colors / thresholds.
+     */
+    scoreSystem?: SeverityBadgeScoreSystemItem[];
+}
+interface SeverityBadgeConfiguration extends IndicatorBadgeProps$1 {
+    label?: string;
+}
+interface SeverityBadgeScoreSystemItem {
+    configuration: SeverityBadgeConfiguration;
+    threshold: number;
+}
+
+declare const SeverityBadge: ({ severity, scoreSystem, value, }: SeverityBadgeProps) => JSX.Element;
+
+interface SeverityBadgeLabelProps extends SeverityBadgeProps {
+    /**
+     * Provide a custom label to override the default ones
+     */
+    label?: string;
+    containerStackProps?: StackProps;
+    labelTypographyProps?: TypographyProps;
+}
+
+declare const SeverityBadgeLabel: ({ label, scoreSystem, severity, containerStackProps, labelTypographyProps, value, }: SeverityBadgeLabelProps) => JSX.Element;
+
 interface SpinnerProps extends CircularProgressProps {
     boxProps?: BoxProps;
 }
@@ -4713,5 +4759,5 @@ interface AugmentedSelectNodeType<T = unknown> extends SelectNodeType<T> {
     leavesCount?: number;
 }
 
-export { Accordion, StyledAccordionSummary as AccordionSummary, ActionsModal, ActivityTimeline, ActivityTimelineStepStatus, AddDomain, AddRepos, AttackPathAnalysis, AttackPathAnalysisWalkThrough, Badge, Banner, BarChart, BarGraph, BasePage, Breadcrumbs, CardDescription, CardSubheader, Celebration, ChartType, ChartTypeComponents, ChartWidget, CiCd, Cloud, CloudSimple, CodeBlock, CopyButton, CreateTableInstance, Dashboard, Data, DatePicker, DateRangePicker, DateTimePicker, DonutChart, DrawerShell, Dropdown, DropdownAutocompleteTree, DropdownAutocompleteTreeListbox, EMPTY_FUNCTION, EmptyData, EmptyState, FavoriteButton, Footer, GaugeChart, GeneralSize, Git, GitSimple, Header, HorizontalBarChart, IconPosition, index_d as Icons, Info, Kubernetes, LabelAndChildrenTooltipContent, Layout, Legend$1 as Legend, LineChart, Link$1 as Link, LinkColorEnum, LinkType, LoadingErrorState, MenuItem, ModalSubtitle, ModalTitle, Negative, NoData, OS_LIGHT_COLORS, OverflowTooltip, Pagination, PathDisplay, Positive, Recon, RemainingTags, SEVERITY_VALUE, ScrollArea, SearchField, SelectNode, SelectNodeListItem, Sent, Severity, SeverityBar$1 as SeverityBar, Shield, SpiderChart, Spinner, StaticDatePicker, StaticDateTimePicker, Success, Tab, Table$1 as Table, Tabs, Tag, TagAvatarSize, TagBackgroundColorVariants, TagStatus, Tags, ThemeProvider, TimePicker, Toast, Toaster, Toggle, Tooltip, TooltipSize, ViewSwitcher, Warning, Widget, augmentTreeData, barShadow, baseSelectTree, boxStyle, capitalize, checkboxStyle, deepCopyTree, ellipsisStyle, flattenSelectTree, flattenSelectTreeWithSearch, flattenSelectTreeWithoutSearch, formatNodeValue, gaugeLabel, gaugeWrapper, getAllSelectedLeaves, getAllSelectedParents, getChildrenOfTopLevelNode, getColorBySeverity, getLeafCounts, getTagStyle, gradientsPalette, isLeaf, mergeNodeChildrenValueToText, normalizeSeverity, selectTagStyle, selectTreeExample, setSelectedMainSkillCategories, singleSelectTree, sortBySeverity, toast, upwardsPush, useDebouncedValue, useDropdownAutocompleteTree };
-export type { AccordionProps, ActionsModalProps, ActivityTimelineProps, ActivityTimelineStep, AtomicTypes, AugmentedSelectNodeType, BadgeProps, BadgeType, BannerProps, BarChartProps, BarGraphItem, BarGraphProps, BarProps, BasePageProps, BreadcrumbsProps, ChartCategory, ChartCategoryItem, ChartDataItem, ChartProps, CodeBlockProps, ConditionalPropsByType, CopyButtonPosition, CopyButtonProps, DatePickerProps, DateTimePickerProps, DonutProps, DrawerShellProps, DropdownAutocompleteTreeProps, DropdownOption, DropdownProps, EmptyStateProps, ExportProps, ExtendedChartProps, ExtendedDataPoint, FavoriteButtonProps, FlattenSelectTreeArgs, FlattenedSelectTreeData, FooterProps, GaugeChartProps, Gradient, GradientsPalette, HeaderAction, HeaderProps, IChartWidgetProps, ILegendProps, IWidgetProps, LayoutProps, LineChartProps, LinkColorStatus, LinkProps, LinkVariants, MenuItemProps, OverflowTooltipProps, PaginationProps, PathDisplayProps, SearchFieldProps, SelectNodeType, SeverityBarProps, SpiderChartProps, SpinnerProps, StatusBanner, TableChartDataItem, TableProps, TableRow, TableTitle, TabsProps, TabsType, TagProps, TagStatusStyle, ThemeProviderProps, TimePickerProps, ToastProps, ToastType, ToasterProps, ToggleProps, TooltipProps, TopToolbarProps, TrendDirection, TrendStatus, ViewSwitcherOption, ViewSwitcherOptionObject, ViewSwitcherOptionProperties, ViewSwitcherSize };
+export { Accordion, StyledAccordionSummary as AccordionSummary, ActionsModal, ActivityTimeline, ActivityTimelineStepStatus, AddDomain, AddRepos, AttackPathAnalysis, AttackPathAnalysisWalkThrough, Badge, Banner, BarChart, BarGraph, BasePage, Breadcrumbs, CardDescription, CardSubheader, Celebration, ChartType, ChartTypeComponents, ChartWidget, CiCd, Cloud, CloudSimple, CodeBlock, CopyButton, CreateTableInstance, Dashboard, Data, DatePicker, DateRangePicker, DateTimePicker, DonutChart, DrawerShell, Dropdown, DropdownAutocompleteTree, DropdownAutocompleteTreeListbox, EMPTY_FUNCTION, EmptyData, EmptyState, FavoriteButton, Footer, GaugeChart, GeneralSize, Git, GitSimple, Header, HorizontalBarChart, IconPosition, index_d as Icons, IndicatorBadge, Info, Kubernetes, LabelAndChildrenTooltipContent, Layout, Legend$1 as Legend, LineChart, Link$1 as Link, LinkColorEnum, LinkType, LoadingErrorState, MenuItem, ModalSubtitle, ModalTitle, Negative, NoData, OS_LIGHT_COLORS, OverflowTooltip, Pagination, PathDisplay, Positive, Recon, RemainingTags, SEVERITY_VALUE, ScrollArea, SearchField, SelectNode, SelectNodeListItem, Sent, Severity, SeverityBadge, SeverityBadgeLabel, SeverityBar$1 as SeverityBar, Shield, SpiderChart, Spinner, StaticDatePicker, StaticDateTimePicker, Success, Tab, Table$1 as Table, Tabs, Tag, TagAvatarSize, TagBackgroundColorVariants, TagStatus, Tags, ThemeProvider, TimePicker, Toast, Toaster, Toggle, Tooltip, TooltipSize, ViewSwitcher, Warning, Widget, augmentTreeData, barShadow, baseSelectTree, boxStyle, capitalize, checkboxStyle, deepCopyTree, ellipsisStyle, flattenSelectTree, flattenSelectTreeWithSearch, flattenSelectTreeWithoutSearch, formatNodeValue, gaugeLabel, gaugeWrapper, getAllSelectedLeaves, getAllSelectedParents, getChildrenOfTopLevelNode, getColorBySeverity, getLeafCounts, getTagStyle, gradientsPalette, isLeaf, mergeNodeChildrenValueToText, normalizeSeverity, selectTagStyle, selectTreeExample, setSelectedMainSkillCategories, singleSelectTree, sortBySeverity, toast, upwardsPush, useDebouncedValue, useDropdownAutocompleteTree };
+export type { AccordionProps, ActionsModalProps, ActivityTimelineProps, ActivityTimelineStep, AtomicTypes, AugmentedSelectNodeType, BadgeProps, BadgeType, BannerProps, BarChartProps, BarGraphItem, BarGraphProps, BarProps, BasePageProps, BreadcrumbsProps, ChartCategory, ChartCategoryItem, ChartDataItem, ChartProps, CodeBlockProps, ConditionalPropsByType, CopyButtonPosition, CopyButtonProps, DatePickerProps, DateTimePickerProps, DonutProps, DrawerShellProps, DropdownAutocompleteTreeProps, DropdownOption, DropdownProps, EmptyStateProps, ExportProps, ExtendedChartProps, ExtendedDataPoint, FavoriteButtonProps, FlattenSelectTreeArgs, FlattenedSelectTreeData, FooterProps, GaugeChartProps, Gradient, GradientsPalette, HeaderAction, HeaderProps, IChartWidgetProps, ILegendProps, IWidgetProps, IndicatorBadgeProps, LayoutProps, LineChartProps, LinkColorStatus, LinkProps, LinkVariants, MenuItemProps, OverflowTooltipProps, PaginationProps, PathDisplayProps, SearchFieldProps, SelectNodeType, SeverityBadgeLabelProps, SeverityBadgeProps, SeverityBadgeScoreSystemItem, SeverityBarProps, SpiderChartProps, SpinnerProps, StatusBanner, TableChartDataItem, TableProps, TableRow, TableTitle, TabsProps, TabsType, TagProps, TagStatusStyle, ThemeProviderProps, TimePickerProps, ToastProps, ToastType, ToasterProps, ToggleProps, TooltipProps, TopToolbarProps, TrendDirection, TrendStatus, ViewSwitcherOption, ViewSwitcherOptionObject, ViewSwitcherOptionProperties, ViewSwitcherSize };