@mcurros2/microm 1.1.375-0 → 1.1.377-0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AlertProps, DefaultMantineColor, ProgressProps, MantineNumberSize, Variants, StepperProps, MantineTheme, TextareaProps, TextInputProps, MantineColor, PasswordInputProps, NotificationProps, CheckboxProps, ButtonProps, ActionIconProps, NumberInputProps, ImageProps, MultiSelectProps, SelectItem, BadgeVariant, MantineSize, CardProps, OverlayProps, TransitionProps, AccordionProps, PinInputProps, SwitchProps, Radio, SelectProps, GroupProps, AvatarProps, AnchorProps, AutocompleteItem, AutocompleteProps, DefaultProps, BadgeProps } from "@mantine/core";
+import { AlertProps, DefaultMantineColor, ProgressProps, MantineNumberSize, Variants, StepperProps, MantineTheme, TextareaProps, TextInputProps, MantineColor, PasswordInputProps, NotificationProps, CheckboxProps, ButtonProps, ActionIconProps, NumberInputProps, ImageProps, MultiSelectProps, SelectItem, BadgeVariant, MantineSize, CardProps, OverlayProps, TransitionProps, AccordionProps, PinInputProps, SwitchProps, Radio, SelectProps, GroupProps, AvatarProps, AnchorProps, AutocompleteItem, AutocompleteProps, DefaultProps, BadgeProps, BreadcrumbsProps, MenuProps as _MenuProps1, TitleOrder, CSSObject, SimpleGridProps, StackProps, NavbarProps, TooltipProps } from "@mantine/core";
 import { JSX } from "react/jsx-runtime";
 import React, { JSXElementConstructor, ReactElement, ReactNode, PropsWithChildren, RefAttributes, ForwardRefExoticComponent, ComponentType, MutableRefObject, useState, Dispatch, SetStateAction, KeyboardEvent, RefObject, CSSProperties, ComponentPropsWithoutRef, Context, ReactPortal } from "react";
 import { hasLength, isNotEmpty, matches, UseFormReturnType } from "@mantine/form";
@@ -2678,6 +2678,7 @@ export function useMenuContent(props: UseMenuContentProps): UseMenuContentResult
 export type UseMenuContentReturnType = UseMenuContentResult;
 export function normalizeTextToLowercaseWithoutAccents(value: string): string;
 export function caseInsensitveAccentInsensitiveFilter(query: string, actions: SpotlightAction[]): SpotlightAction[];
+export function getMainMenuId(menuConfig: Record<string, MenuConfigItem>): string;
 export type AvatarImageProcessingOptions = BrowserImageProcessingOptions;
 export interface useAvatarUploaderProps {
     client: MicroMClient;
@@ -4045,6 +4046,323 @@ export interface CustomWindowEventDefinition {
 }
 export type CustomWindowEvent<T extends CustomWindowEventDefinition> = T;
 export function triggerCustomWindowEvent<T extends CustomWindowEventDefinition>(eventName: T["eventName"], payload: T["payload"]): void;
+export type EntityBuilderProps = {
+    entity: Entity<EntityDefinition>;
+    view: string;
+    Card: ComponentType<EntityCardProps<ValuesObject>>;
+};
+export type EntityGridBuilderProps = Omit<EntityBuilderProps, 'Card'>;
+export type EntityLoader = (client: MicroMClient, parentKeys?: ValuesObject) => Promise<Entity<EntityDefinition>>;
+export type EntityBuilder<TEntity, TClient> = new (client: TClient, parentKeys?: ValuesObject) => TEntity;
+export type EntitySource<TResult> = {
+    /** Builds the result synchronously */
+    entityConstructor: (client: MicroMClient, parentKeys?: ValuesObject) => TResult;
+    entityLoader?: never;
+} | {
+    entityConstructor?: never;
+    /** Loads the result asynchronously (e.g. via dynamic import) */
+    entityLoader: (client: MicroMClient, parentKeys?: ValuesObject) => Promise<TResult>;
+};
+export type EntitySourceProps = EntitySource<Entity<EntityDefinition>>;
+export type EntityBuilderSourceProps = EntitySource<EntityBuilderProps>;
+export type EntityGridSourceProps = EntitySource<EntityGridBuilderProps>;
+export function importEntity<TClient, TEntity, TModule>(importModule: () => Promise<TModule>, getEntity: (module: TModule) => EntityBuilder<TEntity, TClient>): (client: TClient, parentKeys?: ValuesObject) => Promise<TEntity>;
+export function getEntity<TClient, TEntity, TModule, TCard>(importModule: () => Promise<TModule>, getEntity: (module: TModule) => EntityBuilder<TEntity, TClient>, getView: (entity: TEntity) => string, importCard: () => Promise<TCard>): (client: TClient, parentKeys?: ValuesObject) => Promise<EntityBuilderProps>;
+export function getEntity<TClient, TEntity, TModule>(importModule: () => Promise<TModule>, getEntity: (module: TModule) => EntityBuilder<TEntity, TClient>, getView: (entity: TEntity) => string): (client: TClient, parentKeys?: ValuesObject) => Promise<EntityGridBuilderProps>;
+export interface UseResolvedEntityBuilderResult<TResult> {
+    result: TResult | null;
+    ready: boolean;
+}
+export function useResolvedEntityBuilder<TResult>(client: MicroMClient, parentKeys: ValuesObject | undefined, source: EntitySource<TResult>): UseResolvedEntityBuilderResult<TResult>;
+export interface UseResolvedEntityConstructorResult {
+    entityConstructor: EntityConstructor | null;
+    loading: boolean;
+    error: unknown | null;
+}
+export function useResolvedEntityConstructor(client: MicroMClient, parentKeys: ValuesObject | undefined, source: EntitySourceProps): UseResolvedEntityConstructorResult;
+export interface MenuHostProps {
+    client: MicroMClient;
+    mainMenuId: string;
+    menuId: string;
+    menu: MenuContentResult;
+    menus: Record<string, MenuContentResult>;
+    emptyNodeMessage?: ReactNode;
+    defaultLoadingComponent?: ReactNode;
+}
+export interface APPMenuConfigProps extends MenuConfigItem {
+    hostPanel?: ComponentType<MenuHostProps>;
+}
+interface MenuCardBreadcrumbsProps extends Omit<BreadcrumbsProps, 'children'> {
+    items: {
+        title: string;
+        path: string;
+    }[];
+    menuID: string;
+    maxItems?: number;
+    titleSize?: TitleOrder;
+    textColor?: DefaultMantineColor | 'dimmed';
+    /** Node shown in place of the collapsed items */
+    collapsedIndicator?: ReactNode;
+    /** Props for the dropdown menu that lists the collapsed items. Replaces the default object entirely when set per instance */
+    collapsedMenuProps?: Partial<Omit<_MenuProps1, 'children'>>;
+}
+export interface MenuCardItemProps extends Omit<CardProps, 'children'> {
+    item: MenuItem;
+    routeBuilder?: (path: string) => string;
+    /** Styles applied to the card on hover */
+    hoverStyles?: CSSObject;
+    /** Heading order for the item title */
+    titleOrder?: TitleOrder;
+    /** Title color in light color scheme */
+    titleColorLight?: DefaultMantineColor;
+    /** Title color in dark color scheme */
+    titleColorDark?: DefaultMantineColor;
+    /** Spacing between the icon and the title */
+    headerSpacing?: MantineNumberSize;
+    /** Spacing between shortcut links */
+    shortcutSpacing?: MantineNumberSize;
+    /** Font size of shortcut links */
+    shortcutSize?: MantineSize;
+    /** Node rendered between shortcut links */
+    shortcutSeparator?: ReactNode;
+    /** Left indent applied to shortcuts when the item has no icon */
+    noIconIndent?: MantineNumberSize;
+}
+export const MenuCardItemDefaultProps: Partial<MenuCardItemProps>;
+export function MenuCardItem(props: MenuCardItemProps): JSX.Element;
+export interface MenuCardGridProps extends Omit<SimpleGridProps, 'children'> {
+    items: MenuItem[];
+    routeBuilder?: (path: string) => string;
+}
+export const MenuCardGridDefaultProps: Partial<MenuCardGridProps>;
+export function MenuCardGrid(props: MenuCardGridProps): JSX.Element;
+export interface MenuCardRootProps extends Omit<StackProps, 'children'> {
+    items: MenuItem[];
+    breadcrumbs: MenuCardBreadcrumbsProps['items'];
+    rootID: string;
+    renderBreadcrumbs?: boolean;
+    routeBuilder?: (path: string) => string;
+}
+export const MenuCardRootDefaultProps: Partial<MenuCardRootProps>;
+export function MenuCardRoot(props: MenuCardRootProps): JSX.Element | null;
+export interface MenuCardPanelProps {
+    menuId: string;
+    menu: MenuContentResult;
+    breadcrumbsPrefix?: MenuCardBreadcrumbsProps["items"];
+    renderBreadcrumbs?: boolean;
+    emptyNodeMessage?: ReactNode;
+    defaultLoadingComponent?: ReactNode;
+}
+export const MenuCardPanelDefaultProps: Partial<MenuCardPanelProps>;
+export function MenuCardPanel(props: MenuCardPanelProps): JSX.Element;
+export interface GestionarPanelProps extends MenuHostProps, Omit<StackProps, 'children'> {
+    header?: ReactNode;
+    homeLabel?: string;
+}
+export const GestionarPanelDefaultProps: Partial<GestionarPanelProps>;
+export function ContextualMenuPanel(props: GestionarPanelProps): JSX.Element;
+/**
+ * Shades and scales used by the navbar style functions. To override only some
+ * values, spread the defaults: `{ ...NavBarVariantStylesDefaults, hoverScale: 1.5 }`.
+ */
+export interface NavBarVariantStyles {
+    /** Color shade (0-9) for the navbar background in light color scheme */
+    backgroundShade: number;
+    /** Focus ring width */
+    focusOutlineWidth: string;
+    /** Color shade (0-9) for the focus ring */
+    focusOutlineShade: number;
+    /** Focus ring offset */
+    focusOutlineOffset: string;
+    /** Scale applied to an item on hover (icons mode) */
+    hoverScale: number;
+    /** Scale applied to the active item */
+    activeScale: number;
+    /** Color shade (0-9) for the active item background */
+    activeBackgroundShade: number;
+    /** Scale applied to the item icon on hover (text mode) */
+    hoverIconScale: number;
+    /** Color shade (0-9) for the icon background on hover (text mode) */
+    hoverIconBackgroundShade: number;
+    /** Color shade (0-9) for the row background on hover/active (text mode) */
+    hoverBackgroundShade: number;
+    /** Color shade (0-9) for the item label and icon color */
+    labelShade: number;
+}
+export const NavBarVariantStylesDefaults: NavBarVariantStyles;
+export function getNavBarButtonsColor(theme: MantineTheme, brandColor?: DefaultMantineColor): DefaultMantineColor;
+export function getNavBarBackgroundColor(theme: MantineTheme, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles): string | undefined;
+export function getNavBarItemActiveStyles(theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles): {
+    transform?: undefined;
+    backgroundColor?: undefined;
+    '&:hover'?: undefined;
+} | {
+    transform: string;
+    backgroundColor: string;
+    '&:hover': {
+        backgroundColor: string;
+    };
+};
+export function getNavBarIconItemStyles(theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles): {
+    transform?: undefined;
+    backgroundColor?: undefined;
+    '&:hover': {
+        transform: string;
+    };
+    '&:focus-visible': {
+        outline: string;
+        outlineOffset: string;
+    };
+    '&:focus:not(:focus-visible)': {
+        outline: string;
+    };
+} | {
+    transform: string;
+    backgroundColor: string;
+    '&:hover': {
+        backgroundColor: string;
+    };
+    '&:focus-visible': {
+        outline: string;
+        outlineOffset: string;
+    };
+    '&:focus:not(:focus-visible)': {
+        outline: string;
+    };
+};
+export function getNavBarTextItemStyles(theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles): {
+    '&:focus-visible': {
+        outline: string;
+        outlineOffset: string;
+    };
+    '&:focus:not(:focus-visible)': {
+        outline: string;
+    };
+    backgroundColor?: string | undefined;
+    '&:hover .menu-card-navbar-item-icon': {
+        transform: string;
+        backgroundColor: string;
+    };
+    '&:hover': {
+        backgroundColor: string;
+    };
+};
+/**
+ * Style functions used by the navbar components. Provide your own implementations
+ * to fully replace the styling logic. To replace only some functions, spread the
+ * defaults: `{ ...NavBarThemeFunctionsDefaults, getNavBarBackgroundColor: mine }`.
+ * The `styles` argument arrives already resolved (a complete NavBarVariantStyles).
+ * Note: the composite functions (getNavBarIconItemStyles / getNavBarTextItemStyles)
+ * are self-contained — overriding getNavBarItemActiveStyles does not change what
+ * the default composites produce.
+ */
+export interface NavBarThemeFunctions {
+    /** Resolves the base color used by the navbar buttons */
+    getNavBarButtonsColor: (theme: MantineTheme, brandColor?: DefaultMantineColor) => DefaultMantineColor;
+    /** Navbar background color; return undefined to keep the color scheme default */
+    getNavBarBackgroundColor: (theme: MantineTheme, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles) => DefaultMantineColor | undefined;
+    /** Styles applied to the active item icon */
+    getNavBarItemActiveStyles: (theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles) => CSSObject;
+    /** Styles for an item in icons mode (focus + hover + active) */
+    getNavBarIconItemStyles: (theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles) => CSSObject;
+    /** Styles for an item row in text mode (hover + active + focus) */
+    getNavBarTextItemStyles: (theme: MantineTheme, active: boolean, brandColor?: DefaultMantineColor, styles?: NavBarVariantStyles) => CSSObject;
+}
+export const NavBarThemeFunctionsDefaults: NavBarThemeFunctions;
+export type NavBarMode = 'icons' | 'text';
+export type MenuMode = NavBarMode | 'collapsed';
+type NavBarItemOverrides = Partial<Pick<MenuCardNavBarItemProps, 'iconSize' | 'tooltipProps' | 'radius' | 'textColor' | 'mb'>>;
+export interface MenuCardNavBarPanelProps extends Omit<NavbarProps, 'children' | 'width'> {
+    isLoggedIn?: boolean;
+    rootItems: MenuItem[];
+    Logo?: ReactNode;
+    logoTooltip?: string;
+    mode: NavBarMode;
+    homeMenuId: string;
+    homeLabel?: string;
+    searchLabel?: string;
+    brandColor?: DefaultMantineColor;
+    /** Navbar width in icons mode */
+    widthIcons?: number;
+    /** Navbar width in text mode */
+    widthText?: number;
+    /** Icon for the home item */
+    homeIcon?: ReactNode;
+    /** Icon for the search item */
+    searchIcon?: ReactNode;
+    /** Shades and scales used to style the navbar and its items. Replaces the default object entirely — spread NavBarVariantStylesDefaults to override selectively */
+    variantStyles?: NavBarVariantStyles;
+    /** Style functions for the navbar and its items. Replaces the default object entirely — spread NavBarThemeFunctionsDefaults to override selectively */
+    themeFunctions?: NavBarThemeFunctions;
+    /** Overrides applied to every navbar item. Replaces the default object entirely when set per instance */
+    itemProps?: NavBarItemOverrides;
+    /** Overrides applied to the search item only, after itemProps. Replaces the default object entirely when set per instance */
+    searchItemProps?: NavBarItemOverrides;
+}
+export const MenuCardNavBarPanelDefaultProps: Partial<MenuCardNavBarPanelProps>;
+export function MenuCardNavBarPanel(props: MenuCardNavBarPanelProps): JSX.Element;
+export interface MenuCardNavBarItemProps {
+    icon: ReactNode;
+    label: string;
+    active: boolean;
+    mode: NavBarMode;
+    href?: string;
+    onClick?: () => void;
+    radius?: MantineNumberSize;
+    mb?: MantineNumberSize;
+    brandColor?: DefaultMantineColor;
+    textColor?: DefaultMantineColor;
+    /** Size of the icon container */
+    iconSize?: MantineNumberSize;
+    /** Props for the tooltip shown in icons mode. Replaces the default object entirely when set per instance */
+    tooltipProps?: Omit<TooltipProps, 'label' | 'children'>;
+    /** Shades and scales used to style the item. Replaces the default object entirely — spread NavBarVariantStylesDefaults to override selectively */
+    variantStyles?: NavBarVariantStyles;
+    /** Style functions for the item. Replaces the default object entirely — spread NavBarThemeFunctionsDefaults to override selectively */
+    themeFunctions?: NavBarThemeFunctions;
+}
+export const MenuCardNavBarItemDefaultProps: Partial<MenuCardNavBarItemProps>;
+export function MenuCardNavBarItem(props: MenuCardNavBarItemProps): JSX.Element;
+export type MenuModalCloseBehavior = {
+    route?: string;
+    onClosed?: () => void;
+    lastLevel?: boolean;
+};
+export function useMenuModalCloseNavigator(closeBehavior?: MenuModalCloseBehavior): () => void;
+export type MenuEntityActionModalProps = EntitySourceProps & {
+    client: MicroMClient;
+    parentKeys?: ValuesObject;
+    actionName: string;
+    selectedKeys?: ValuesObject[];
+    closeBehavior?: MenuModalCloseBehavior;
+    errorComponent?: (error: unknown, close: () => void) => ReactNode;
+    errorTitle?: string;
+    backLabel?: string;
+    actionNotFoundLabel?: string;
+    selectionRequiredLabel?: string;
+};
+export const MenuEntityActionModalDefaultProps: Partial<MenuEntityActionModalProps>;
+export function MenuEntityActionModal(props: MenuEntityActionModalProps): JSX.Element | null;
+type PassthroughProps = Omit<EntityFormModalProps, "entityConstructor" | "openState" | "setOpenState" | "onModalClosed" | "client">;
+export type MenuEntityFormModalProps = PassthroughProps & EntitySourceProps & {
+    client: MicroMClient;
+    parentKeys?: ValuesObject;
+    closeBehavior?: MenuModalCloseBehavior;
+    errorComponent?: (error: unknown, close: () => void) => ReactNode;
+    errorTitle?: string;
+    backLabel?: string;
+};
+export const MenuEntityFormModalDefaultProps: Partial<MenuEntityFormModalProps>;
+export function MenuEntityFormModal(props: MenuEntityFormModalProps): JSX.Element | null;
+export interface MenuRouteHostProps {
+    client: MicroMClient;
+    menuConfig: Record<string, APPMenuConfigProps>;
+    menus: Record<string, MenuContentResult>;
+    emptyNodeMessage?: ReactNode;
+    defaultLoadingComponent?: ReactNode;
+}
+export const MenuRouteHostDefaultProps: Partial<MenuRouteHostProps>;
+export function MenuRouteHost(props: MenuRouteHostProps): JSX.Element | null;
 export interface MicroMError extends Error {
     status: number;
     message: string;