@telicent-oss/ds 4.4.2 → 5.0.0

package/dist/ds.d.ts

@@ -24,8 +24,8 @@ import { AvatarProps } from '@mui/material';
 import { AxiosInstance } from 'axios';
 import { BackdropClasses } from '@mui/material';
 import { BackdropProps } from '@mui/material';
-import { BadgeClasses } from '@mui/material';
-import { BadgeProps } from '@mui/material';
+import { BadgeOwnProps } from '@mui/material';
+import { BadgeProps as BadgeProps_2 } from '@mui/material/Badge';
 import { BaseSelectProps } from '@mui/material';
 import { BottomNavigationActionClasses } from '@mui/material';
 import { BottomNavigationActionProps } from '@mui/material';
@@ -56,6 +56,7 @@ import { CardOwnProps } from '@mui/material';
 import { CardProps as CardProps_2 } from '@mui/material/Card';
 import { CheckboxClasses } from '@mui/material';
 import { CheckboxProps } from '@mui/material';
+import { ChevronLeft as ChevronLeftIcon } from '@telicent-oss/mui-icons-material';
 import { ChevronRight as ChevronRightIcon } from '@telicent-oss/mui-icons-material';
 import { ChipClasses } from '@mui/material';
 import { ChipProps as ChipProps_2 } from '@mui/material';
@@ -94,7 +95,6 @@ import { DividerClasses } from '@mui/material';
 import { dividerClasses } from '@mui/material/Divider';
 import { DividerProps } from '@mui/material';
 import { DividerProps as DividerProps_3 } from '@mui/material/Divider';
-import { DrawerClasses } from '@mui/material';
 import { DrawerProps as DrawerProps_2 } from '@mui/material';
 import { DrawerProps as DrawerProps_3 } from '@mui/material/Drawer';
 import { ElementType } from 'react';
@@ -166,7 +166,7 @@ import { ListItemAvatarClasses } from '@mui/material';
 import { ListItemAvatarProps } from '@mui/material';
 import { ListItemButtonClasses } from '@mui/material';
 import { ListItemButtonProps } from '@mui/material';
-import { ListItemButtonProps as ListItemButtonProps_2 } from '@mui/material/ListItemButton';
+import { ListItemButtonTypeMap } from '@mui/material/ListItemButton';
 import { ListItemClasses } from '@mui/material';
 import { ListItemIconClasses } from '@mui/material';
 import { ListItemIconProps } from '@mui/material';
@@ -421,22 +421,18 @@ export declare const AppSwitchLibrarySchema: default_2.ZodObject<{
     id: default_2.ZodString;
     name: default_2.ZodString;
     url: default_2.ZodString;
-    /** @deprecated Use `iconDark` and `iconLight` for theme-aware icons. */
-    icon: default_2.ZodOptional<default_2.ZodString>;
     iconDark: default_2.ZodOptional<default_2.ZodString>;
     iconLight: default_2.ZodOptional<default_2.ZodString>;
 }, "strip", default_2.ZodTypeAny, {
     id: string;
     url: string;
     name: string;
-    icon?: string | undefined;
     iconDark?: string | undefined;
     iconLight?: string | undefined;
 }, {
     id: string;
     url: string;
     name: string;
-    icon?: string | undefined;
     iconDark?: string | undefined;
     iconLight?: string | undefined;
 }>;
@@ -544,6 +540,10 @@ declare type AutocompleteOption = {
     isRecentSearch: boolean;
 };
 
+export declare const Badge: default_3.FC<BadgeProps>;
+
+export declare type BadgeProps = BadgeProps_2;
+
 export declare const base64Codec: Codec;
 
 export declare type BaseProps = Omit<TypographyProps_2, "variant" | "paragraph">;
@@ -590,10 +590,6 @@ export declare interface BasicMapProperties {
     center: number[];
     layers?: LayerConfig[];
     controls?: Partial<MapControlsConfig>;
-    /**
-     * @deprecated Use `layers` instead. This prop will be removed in a future release.
-     */
-    mapStyleOptions?: LegacyMapConfig;
     markers: MarkerFeature[];
     polygons: PolygonFeature[];
     onFeatureClick?: OnFeatureClick;
@@ -700,6 +696,8 @@ declare type CardProps = Omit<CardProps_2, "classes" | "raised"> & Partial<{
 
 export declare const Checkbox: default_3.FC<CustomCheckboxProps>;
 
+export { ChevronLeftIcon }
+
 export { ChevronRightIcon }
 
 export declare const Chip: default_3.FC<ChipProps>;
@@ -903,8 +901,13 @@ export declare interface DraggableFloatingPanelProps extends HTMLAttributes<HTML
 
 export declare const DragHandleIcon: default_3.FC<SvgIconProps>;
 
-export declare const Drawer: default_3.ForwardRefExoticComponent<DrawerProps & default_3.RefAttributes<DrawerController>>;
+/**
+ * A controlled side sheet: MUI's Drawer under the DS theme. The caller owns
+ * `open` and `onClose`, and Escape and a backdrop click both call `onClose`.
+ */
+export declare const Drawer: default_3.FC<DrawerProps>;
 
+/** @deprecated Part of the deprecated `InsetDrawer` (ADR-0005). */
 export declare interface DrawerController {
     openDrawer(): void;
     closeDrawer(): void;
@@ -921,12 +924,13 @@ declare interface DrawerPresentationalProps extends Omit<DrawerProps_3, "PaperPr
     id?: string;
 }
 
-export declare interface DrawerProps extends Omit<DrawerPresentationalProps, "open" | "onClose" | "ref"> {
-    /** (default: true) */
-    initialOpen?: boolean;
-    onVisibilityChange?: (open: boolean) => void;
-    PaperSx?: SxProps<Theme>;
-}
+export declare type DrawerProps = DrawerProps_3 & {
+    /**
+     * Width of a left or right panel, in px when a number. The theme caps it
+     * at the viewport, so a fixed width never runs off a narrow screen.
+     */
+    width?: number | string;
+};
 
 export declare const DropdownButton: default_3.FC<DropdownButtonProps>;
 
@@ -957,6 +961,37 @@ export declare type ENCODE_SEARCH_PARAMS_MODES_Type = z.infer<typeof ENCODE_SEAR
  */
 export declare const ensureFaIconPath: (faIcon: string) => Promise<string | undefined>;
 
+export declare const EntityList: <T>({ items, columns, getItemKey, getItemHref, getItemLabel, onItemClick, ariaLabelledBy, ariaLabel, initialSort, isLoading, defaultPageSize, pageSizeOptions, renderEmpty, }: EntityListProps<T>) => JSX.Element;
+
+declare type EntityListBaseProps<T> = {
+    items: T[];
+    columns: EntityListColumn<T>[];
+    getItemKey: (item: T) => string | number;
+    getItemHref?: (item: T) => string;
+    getItemLabel?: (item: T) => string;
+    onItemClick?: (item: T, href: string) => void;
+    initialSort?: {
+        key: string;
+        direction: SortDirection;
+    };
+    isLoading?: boolean;
+    defaultPageSize?: number;
+    pageSizeOptions?: number[];
+    renderEmpty?: () => ReactNode;
+};
+
+export declare type EntityListColumn<T> = {
+    key: string;
+    header: string;
+    render: (item: T) => ReactNode;
+    getSortValue?: (item: T) => SortValue;
+    flex?: number;
+    width?: number | string;
+    align?: "left" | "right";
+};
+
+export declare type EntityListProps<T> = EntityListBaseProps<T> & LabellingProps;
+
 export declare const ErrorFallback: default_3.FC<ErrorFallbackProps>;
 
 export declare type ErrorFallbackProps = Omit<ErrorFallbackWrapperProps, "children"> & ErrorFallbackTextProps;
@@ -1289,6 +1324,19 @@ declare const generateComponentOverrides: (uiTheme: UITheme) => {
             };
         };
     };
+    MuiDrawer: {
+        styleOverrides: {
+            paper: ({ ownerState }: DrawerProps_2 & Record<string, unknown> & {
+                ownerState: DrawerProps_2 & Record<string, unknown>;
+            } & {
+                theme: Omit<Theme, "components">;
+            }) => {
+                maxWidth: string;
+            } | {
+                maxWidth?: undefined;
+            };
+        };
+    };
     MuiCard: {
         variants: {
             props: {
@@ -1398,6 +1446,30 @@ declare const generateComponentOverrides: (uiTheme: UITheme) => {
             };
         };
     };
+    MuiBadge: {
+        styleOverrides: {
+            badge: ({ theme }: BadgeOwnProps & CommonProps & Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "components" | "className" | "style" | "classes" | "children" | "sx" | "variant" | "slots" | "slotProps" | "color" | "invisible" | "anchorOrigin" | "badgeContent" | "componentsProps" | "max" | "overlap" | "showZero"> & {
+                component?: ElementType;
+            } & Record<string, unknown> & {
+                ownerState: BadgeOwnProps & CommonProps & Omit<DetailedHTMLProps<HTMLAttributes<HTMLSpanElement>, HTMLSpanElement>, "components" | "className" | "style" | "classes" | "children" | "sx" | "variant" | "slots" | "slotProps" | "color" | "invisible" | "anchorOrigin" | "badgeContent" | "componentsProps" | "max" | "overlap" | "showZero"> & {
+                    component?: ElementType;
+                } & Record<string, unknown>;
+            } & {
+                theme: Omit<Theme, "components">;
+            }) => {
+                pointerEvents: "none";
+                "&.MuiBadge-standard": {
+                    minWidth: number;
+                    height: number;
+                    padding: string;
+                    borderRadius: number;
+                    fontSize: number;
+                    fontWeight: number;
+                    border: string;
+                };
+            };
+        };
+    };
     MuiAccordion: {
         defaultProps: {
             elevation: number;
@@ -1472,18 +1544,6 @@ declare const generateComponentOverrides: (uiTheme: UITheme) => {
             }>;
         }[] | undefined;
     } | undefined;
-    MuiBadge?: {
-        defaultProps?: ComponentsProps["MuiBadge"];
-        styleOverrides?: Partial<OverridesStyleRules<keyof BadgeClasses, "MuiBadge", Omit<Theme, "components">>> | undefined;
-        variants?: {
-            props: Partial<BadgeProps> | ((props: Partial<BadgeProps> & {
-                ownerState: Partial<BadgeProps>;
-            }) => boolean);
-            style: Interpolation<    {
-            theme: Omit<Theme, "components">;
-            }>;
-        }[] | undefined;
-    } | undefined;
     MuiBottomNavigation?: {
         defaultProps?: ComponentsProps["MuiBottomNavigation"];
         styleOverrides?: Partial<OverridesStyleRules<"root", "MuiBottomNavigation", Omit<Theme, "components">>> | undefined;
@@ -1712,18 +1772,6 @@ declare const generateComponentOverrides: (uiTheme: UITheme) => {
             }>;
         }[] | undefined;
     } | undefined;
-    MuiDrawer?: {
-        defaultProps?: ComponentsProps["MuiDrawer"];
-        styleOverrides?: Partial<OverridesStyleRules<keyof DrawerClasses, "MuiDrawer", Omit<Theme, "components">>> | undefined;
-        variants?: {
-            props: Partial<DrawerProps_2> | ((props: Partial<DrawerProps_2> & {
-                ownerState: Partial<DrawerProps_2>;
-            }) => boolean);
-            style: Interpolation<    {
-            theme: Omit<Theme, "components">;
-            }>;
-        }[] | undefined;
-    } | undefined;
     MuiAccordionActions?: {
         defaultProps?: ComponentsProps["MuiAccordionActions"];
         styleOverrides?: Partial<OverridesStyleRules<keyof AccordionActionsClasses, "MuiAccordionActions", Omit<Theme, "components">>> | undefined;
@@ -2703,6 +2751,21 @@ declare type InputText = TextFieldProps & {
     fullWidth?: boolean;
 };
 
+/**
+ * @deprecated The map inset's ref-driven panel. Use the controlled `Drawer`
+ * from `@telicent-oss/ds`, which takes `open` and `onClose` (ADR-0005).
+ * Kept for existing consumers; removed in a later major.
+ */
+export declare const InsetDrawer: default_3.ForwardRefExoticComponent<InsetDrawerProps & default_3.RefAttributes<DrawerController>>;
+
+/** @deprecated Use the controlled `Drawer` from `@telicent-oss/ds` (ADR-0005). */
+export declare interface InsetDrawerProps extends Omit<DrawerPresentationalProps, "open" | "onClose" | "ref"> {
+    /** (default: true) */
+    initialOpen?: boolean;
+    onVisibilityChange?: (open: boolean) => void;
+    PaperSx?: SxProps<Theme>;
+}
+
 export declare const InsetInMap: default_3.FC<RootPropsType & {
     content: default_3.ReactNode;
     children?: default_3.ReactNode;
@@ -2736,6 +2799,14 @@ export declare type LabeledSwitchProps = {
     ref?: Ref<HTMLButtonElement>;
 };
 
+declare type LabellingProps = {
+    ariaLabel: string;
+    ariaLabelledBy?: string;
+} | {
+    ariaLabel?: string;
+    ariaLabelledBy: string;
+};
+
 export declare type LayerConfig = BaseRasterLayerConfig | BaseVectorTileLayerConfig | OverlayVectorLayerConfig;
 
 export declare type LayerMeta = {
@@ -2757,24 +2828,6 @@ export declare interface LayerWithOptionalSource extends default_6 {
     getSource?: () => SourceWithEvents | null;
 }
 
-export declare type LegacyMapConfig = {
-    vectorStyles?: LegacyVectorStyle;
-    tileSets?: LegacyTileSet[];
-};
-
-export declare type LegacyTileSet = {
-    label: string;
-    uri: string;
-    image: string;
-    attribution?: string;
-};
-
-export declare type LegacyVectorStyle = {
-    label: string;
-    uri: string;
-    image: string;
-};
-
 export declare const LinearProgress: default_3.FC<LinearProgressProps_2>;
 
 export declare const Link: default_3.ForwardRefExoticComponent<Omit<LinkButtonProps, "ref"> & default_3.RefAttributes<HTMLButtonElement>>;
@@ -2787,7 +2840,7 @@ export { ListIcon }
 
 export declare const ListItem: default_3.FC<ListItemProps_2>;
 
-export declare const ListItemButton: default_3.FC<ListItemButtonProps_2>;
+export declare const ListItemButton: ExtendButtonBase<ListItemButtonTypeMap<    {}, "div">>;
 
 export declare const ListItemIcon: default_3.FC<ListItemIconProps_2>;
 
@@ -3708,6 +3761,10 @@ export declare type SnackbarProviderProps = SnackbarProviderProps_2;
 
 export declare type SnackbarType = "success" | "error" | "warning" | "info";
 
+export declare type SortDirection = "asc" | "desc";
+
+export declare type SortValue = string | number | Date | null | undefined;
+
 export declare interface SourceWithEvents {
     on(type: string, listener: (e: unknown) => void): void;
 }
@@ -3872,11 +3929,11 @@ declare type TeliTypeIconSizeProp = "xs" | "sm" | "base" | "lg";
 declare const Text_2: default_3.FC<TextProps>;
 export { Text_2 as Text }
 
-export declare const TextField: default_3.ForwardRefExoticComponent<(Omit<OutlinedTextFieldProps & {
+export declare const TextField: default_3.ForwardRefExoticComponent<(Omit<StandardTextFieldProps & {
     errorText?: default_3.ReactNode;
-}, "ref"> | Omit<FilledTextFieldProps & {
+}, "ref"> | Omit<OutlinedTextFieldProps & {
     errorText?: default_3.ReactNode;
-}, "ref"> | Omit<StandardTextFieldProps & {
+}, "ref"> | Omit<FilledTextFieldProps & {
     errorText?: default_3.ReactNode;
 }, "ref">) & default_3.RefAttributes<HTMLInputElement>>;
 
@@ -4154,13 +4211,8 @@ declare type UIThemeProviderProps = default_3.PropsWithChildren & {
     dark?: boolean;
 };
 
-/**
- * Curated set of DS themes. `"DataNavy"` is deprecated (kept for backwards
- * compatibility with apps that still pass it to `UIThemeProvider`) and is
- * hidden from the Storybook theme selector — prefer any of the others for
- * new work.
- */
-export declare const UIThemeSchema: default_2.ZodEnum<["DataNavy", "DocumentPink", "GraphOrange", "AdminBlue", "GeoGreen", "Blank"]>;
+/** Curated set of DS themes. */
+export declare const UIThemeSchema: default_2.ZodEnum<["DocumentPink", "GraphOrange", "AdminBlue", "GeoGreen", "Blank"]>;
 
 export declare const uriComponentCodec: Codec;
 
@@ -4177,6 +4229,7 @@ export declare const useDebounce: (value: any, delay?: number) => any;
  * @param onVisibilityChange
  * @returns
  */
+/** @deprecated Part of the deprecated `InsetDrawer` (ADR-0005). */
 export declare function useDrawer(args: {
     ref: ForwardedRef<DrawerController>;
     initialOpen: boolean;