@mcurros2/microm 1.1.429-0 → 1.1.431-0

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { AlertProps, DefaultMantineColor, ProgressProps, MantineNumberSize, ButtonProps, SelectItem, BadgeVariant, MantineSize, Variants, StepperProps, CardProps, MantineTheme, ImageProps, MantineColor, TextareaProps, TextInputProps, PasswordInputProps, NotificationProps, CheckboxProps, ActionIconProps, NumberInputProps, MultiSelectProps, SimpleGridProps, OverlayProps, TransitionProps, AccordionProps, PinInputProps, SwitchProps, Radio, SelectProps, GroupProps, AvatarProps, AnchorProps, AutocompleteItem, AutocompleteProps, DefaultProps, BadgeProps, BreadcrumbsProps, MenuProps as _MenuProps1, TitleOrder, CSSObject, StackProps, NavbarProps, TooltipProps } from "@mantine/core";
+import { AlertProps, DefaultMantineColor, ProgressProps, MantineNumberSize, ButtonProps, Variants, StepperProps, SelectItem, BadgeVariant, MantineSize, CardProps, MantineTheme, ImageProps, MantineColor, TextareaProps, TextInputProps, PasswordInputProps, NotificationProps, CheckboxProps, ActionIconProps, NumberInputProps, MultiSelectProps, SimpleGridProps, OverlayProps, TransitionProps, AccordionProps, PinInputProps, SwitchProps, Radio, SelectProps, GroupProps, AvatarProps, AnchorProps, AutocompleteItem, AutocompleteProps, DefaultProps, BadgeProps, BreadcrumbsProps, MenuProps as _MenuProps1, TitleOrder, CSSObject, StackProps, NavbarProps, TooltipProps } from "@mantine/core";
 import { JSX } from "react/jsx-runtime";
 import React, { JSXElementConstructor, ReactElement, ReactNode, PropsWithChildren, RefAttributes, ForwardRefExoticComponent, Dispatch, RefObject, SetStateAction, ComponentType, CSSProperties, MutableRefObject, useState, KeyboardEvent, ComponentPropsWithoutRef, Context, ReactPortal } from "react";
 import { hasLength, isNotEmpty, matches, UseFormReturnType } from "@mantine/form";
@@ -6,7 +6,7 @@ import { ModalSettings } from "@mantine/modals/lib/context";
 import { IconProps, Icon } from "@tabler/icons-react";
 import { LooseKeys } from "@mantine/form/lib/types";
 import { AccordionVariant } from "@mantine/core/lib/Accordion/Accordion.types";
-import { UseEntityFormReturnType as _UseEntityFormReturnType1, EntityClientAction as _EntityClientAction1, DataResult as _DataResult1, OperationStatus as _OperationStatus1, DataMapInfoWindowRenderer as _DataMapInfoWindowRenderer1, DataMapSelectRecordsRenderer as _DataMapSelectRecordsRenderer1, DataMapMarkerRenderer as _DataMapMarkerRenderer1, DataMapGroupMarkerRenderer as _DataMapGroupMarkerRenderer1, EntityDefinition as _EntityDefinition1, Entity as _Entity1, ValuesObject as _ValuesObject1, DataViewSearchCallback as _DataViewSearchCallback1, DBStatusResult as _DBStatusResult1, GridColumnsOverrides as _GridColumnsOverrides1, DataGridSelectionChangedCallback as _DataGridSelectionChangedCallback1, EntityUIAddClick as _EntityUIAddClick1, EntityUIActionClosedCallback as _EntityUIActionClosedCallback1, DataGridLabels as _DataGridLabels1, GridRecord as _GridRecord1, GridSelectionChangedCallback as _GridSelectionChangedCallback1, GridDoubleClickCallback as _GridDoubleClickCallback1, GridColumn as _GridColumn1 } from "src";
+import { UseEntityFormReturnType as _UseEntityFormReturnType1, EntityClientAction as _EntityClientAction1, DataResult as _DataResult1, OperationStatus as _OperationStatus1, DataMapInfoWindowRenderer as _DataMapInfoWindowRenderer1, DataMapSelectRecordsRenderer as _DataMapSelectRecordsRenderer1, DataMapMarkerRenderer as _DataMapMarkerRenderer1, DataMapGroupMarkerRenderer as _DataMapGroupMarkerRenderer1, EntityDefinition as _EntityDefinition1, Entity as _Entity1, ValuesObject as _ValuesObject1, DBStatusResult as _DBStatusResult1, GridColumnsOverrides as _GridColumnsOverrides1, DataGridSelectionChangedCallback as _DataGridSelectionChangedCallback1, DataViewSearchCallback as _DataViewSearchCallback1, EntityUIAddClick as _EntityUIAddClick1, EntityUIActionClosedCallback as _EntityUIActionClosedCallback1, DataGridLabels as _DataGridLabels1, GridRecord as _GridRecord1, GridSelectionChangedCallback as _GridSelectionChangedCallback1, GridDoubleClickCallback as _GridDoubleClickCallback1, GridColumn as _GridColumn1 } from "src";
 import { DropzoneProps } from "@mantine/dropzone";
 import { PrismProps } from "@mantine/prism";
 import { DateInputProps, TimeInputProps, CalendarProps } from "@mantine/dates";
@@ -393,14 +393,16 @@ export interface ConfirmLeaveStaySaveProps {
 }
 export const ConfirmLeaveStaySaveDefaultProps: Partial<ConfirmLeaveStaySaveProps>;
 export function ConfirmLeaveStaySave(props: ConfirmLeaveStaySaveProps): JSX.Element;
-export type NavigationProtectionMode = 'save' | 'confirm';
+/** `allways` skips dirty/value checks only in edit mode; add uses those checks and view is unprotected. */
+export type NavigationProtectionMode = 'save' | 'confirm' | 'allways';
 export type ConfirmNavigationType = 'local' | 'remote';
 export interface UseConfirmNavigationOptions {
     mode?: NavigationProtectionMode;
     hasUnsavedChanges: () => boolean;
     onSave: (navigationType: ConfirmNavigationType) => Promise<boolean>;
+    onLeave?: (navigationType: ConfirmNavigationType) => Promise<boolean>;
 }
-export function useConfirmNavigation({ mode, hasUnsavedChanges, onSave }: UseConfirmNavigationOptions): void;
+export function useConfirmNavigation({ mode, hasUnsavedChanges, onSave, onLeave }: UseConfirmNavigationOptions): void;
 export function getMantineInitialDirty(columns: ColumnsObject, exclude_system_columns: boolean): Record<string, boolean>;
 export function getMantineValuesObject(formValues: ValuesObject, columns: ColumnsObject, exclude_system_columns: boolean): ValuesObject;
 export function getMantineInitialValuesObject(columns: ColumnsObject, columnNames?: string[]): ValuesObject;
@@ -465,9 +467,8 @@ export interface UseEntityFormReturnType {
     form: UseFormReturnType<ValuesObject>;
     status: OperationStatus<DBStatusResult | ValuesObject>;
     formMode: FormMode;
-    handleCancel: () => Promise<void> | void;
-    handleSubmit: (event?: React.FormEvent<HTMLFormElement>) => Promise<void>;
-    handleExecuteMappedAction: (buttonName: 'OK' | 'Cancel', actionName: string, requireValidation: boolean, element?: HTMLElement) => Promise<void>;
+    handleCancel: (silent?: boolean, element?: HTMLElement) => Promise<boolean>;
+    handleSubmit: (event?: React.FormEvent<HTMLFormElement>, silent?: boolean, element?: HTMLElement, requestOptions?: MicroMRequestOptions) => Promise<boolean>;
     performGetData: () => Promise<boolean>;
     saveAndGet: (get_data_if_saved: boolean, override_values?: ValuesObject, requestOptions?: MicroMRequestOptions) => Promise<OperationStatus<DBStatusResult>>;
     configureField: (column: EntityColumn<Value>, validation?: ValidationRule) => void;
@@ -481,96 +482,11 @@ export interface UseEntityFormReturnType {
     clearAllAsyncErrors: () => void;
     isFormValid: () => boolean;
     isFormFieldValid: (column_name: string) => boolean;
+    activeFormActions: EntityFormActions;
     silentSave: (requestOptions?: MicroMRequestOptions) => Promise<SilentSaveResult>;
 }
 export const UseEntityFormDefaultProps: Partial<UseEntityFormOptions>;
 export function useEntityForm(props: UseEntityFormOptions): UseEntityFormReturnType;
-export interface UseDataGridToolbarFiltersProps {
-    filterValues: ValuesObject | undefined;
-    setFilterValues: Dispatch<SetStateAction<ValuesObject | undefined>>;
-    filtersDescription: ValuesObject | undefined;
-    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
-    client?: MicroMClient;
-    parentKeys?: ValuesObject;
-    FiltersEntity?: EntityConstructor;
-    searchData: SelectItem[];
-    setSearchData: Dispatch<SetStateAction<SelectItem[]>>;
-    setSearchText: Dispatch<SetStateAction<string[] | undefined>>;
-    onRefreshClick: (searchText: string[] | undefined) => void;
-    onSearchTextChange?: (text: string[] | undefined) => void;
-    filtersFormSize: MantineNumberSize;
-    visibleFilters?: string[];
-    initialColumnFilters?: ColumnsObject;
-    filterInputRef: RefObject<HTMLInputElement>;
-}
-export function useDataGridToolbarFilters(props: UseDataGridToolbarFiltersProps): {
-    handleFilterButtonClick: (e: React.MouseEvent) => Promise<void>;
-    handleSearchFilterInputEnter: (e: React.KeyboardEvent) => void;
-    handleClearFiltersClick: (e: React.MouseEvent) => void;
-    createSearchPhrase: (filter: string) => {
-        value: string;
-        label: string;
-    };
-    queryText: string;
-    filtersDescription: ValuesObject | undefined;
-    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
-    setQueryText: Dispatch<SetStateAction<string>>;
-    handleSearchFilterInputOnChange: (searchFilter: string[]) => void;
-    updateFilterValuesAndDescription: (columns: ColumnsObject) => void;
-};
-export type DataGridToolbarSizes = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
-export interface DataGridToolbarOptions {
-    size?: DataGridToolbarSizes;
-    client?: MicroMClient;
-    searchPlaceholder?: string;
-    hideCheckboxToggle?: boolean;
-    onCheckboxToggle?: () => void;
-    onSearchTextChange?: (text: string[] | undefined) => void;
-    onRefreshClick: (searchText: string[] | undefined) => void;
-    onExportClick: () => void;
-    autoFocus?: boolean;
-    toolbarIconVariant?: ActionIconVariant;
-    enableExport?: boolean;
-    refreshTooltip?: string;
-    exportTooltip?: string;
-    selectRowsTooltip?: string;
-    searchText: string[] | undefined;
-    setSearchText: Dispatch<SetStateAction<string[] | undefined>>;
-    searchData: SelectItem[];
-    setSearchData: Dispatch<SetStateAction<SelectItem[]>>;
-    maxSearchTerms?: number;
-    FiltersEntity?: EntityConstructor;
-    filterTooltip?: string;
-    parentKeys?: ValuesObject;
-    filterValues: ValuesObject | undefined;
-    setFilterValues: Dispatch<SetStateAction<ValuesObject | undefined>>;
-    filtersDescription: ValuesObject | undefined;
-    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
-    clearFiltersTooltip?: string;
-    filtersFormSize: MantineNumberSize;
-    enableImport?: boolean;
-    importTooltip?: string;
-    onImportClick?: () => void;
-    filtersBadgeSize?: MantineSize;
-    filtersBadgeVariant?: BadgeVariant;
-    showAppliedFilters?: boolean;
-    showRefreshButton?: boolean;
-    showSelectRowsButton?: boolean;
-    showFiltersButton?: boolean;
-    showSearchInput?: boolean;
-    visibleFilters?: string[];
-    initialColumnFilters?: ColumnsObject;
-    filtersTitle?: string;
-    editFiltersLabel?: string;
-    clearFiltersLabel?: string;
-    filtersAccordionVariant?: AccordionVariant;
-    showColumnsConfig?: boolean;
-    configMenuOpened?: boolean;
-    setConfigMenuOpened?: Dispatch<SetStateAction<boolean>>;
-    configMenuDropdown?: ReactNode;
-}
-export const DataGridToolbarDefaultProps: Partial<DataGridToolbarOptions>;
-export function DataGridToolbar(props: DataGridToolbarOptions): JSX.Element;
 export interface EntityFormProps extends PropsWithChildren {
     showOK?: boolean;
     showCancel?: boolean;
@@ -580,8 +496,6 @@ export interface EntityFormProps extends PropsWithChildren {
     OKText?: ReactNode;
     CancelText?: ReactNode;
     CloseText?: ReactNode;
-    OKActionName?: string;
-    CancelActionName?: string;
     formAPI: UseEntityFormReturnType;
     invalidFieldsLabel?: string;
     showHelpButton?: boolean;
@@ -840,6 +754,92 @@ export const DefaultGridProps: Partial<GridOptions>;
 export const DefaultGridColumnProps: Partial<GridColumn>;
 export const Grid: ForwardRefExoticComponent<GridOptions & RefAttributes<GridImperative>>;
 export function GridGlobalStyles(): JSX.Element;
+export interface UseDataGridToolbarFiltersProps {
+    filterValues: ValuesObject | undefined;
+    setFilterValues: Dispatch<SetStateAction<ValuesObject | undefined>>;
+    filtersDescription: ValuesObject | undefined;
+    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
+    client?: MicroMClient;
+    parentKeys?: ValuesObject;
+    FiltersEntity?: EntityConstructor;
+    searchData: SelectItem[];
+    setSearchData: Dispatch<SetStateAction<SelectItem[]>>;
+    setSearchText: Dispatch<SetStateAction<string[] | undefined>>;
+    onRefreshClick: (searchText: string[] | undefined) => void;
+    onSearchTextChange?: (text: string[] | undefined) => void;
+    filtersFormSize: MantineNumberSize;
+    visibleFilters?: string[];
+    initialColumnFilters?: ColumnsObject;
+    filterInputRef: RefObject<HTMLInputElement>;
+}
+export function useDataGridToolbarFilters(props: UseDataGridToolbarFiltersProps): {
+    handleFilterButtonClick: (e: React.MouseEvent) => Promise<void>;
+    handleSearchFilterInputEnter: (e: React.KeyboardEvent) => void;
+    handleClearFiltersClick: (e: React.MouseEvent) => void;
+    createSearchPhrase: (filter: string) => {
+        value: string;
+        label: string;
+    };
+    queryText: string;
+    filtersDescription: ValuesObject | undefined;
+    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
+    setQueryText: Dispatch<SetStateAction<string>>;
+    handleSearchFilterInputOnChange: (searchFilter: string[]) => void;
+    updateFilterValuesAndDescription: (columns: ColumnsObject) => void;
+};
+export type DataGridToolbarSizes = 'xs' | 'sm' | 'md' | 'lg' | 'xl';
+export interface DataGridToolbarOptions {
+    size?: DataGridToolbarSizes;
+    client?: MicroMClient;
+    searchPlaceholder?: string;
+    hideCheckboxToggle?: boolean;
+    onCheckboxToggle?: () => void;
+    onSearchTextChange?: (text: string[] | undefined) => void;
+    onRefreshClick: (searchText: string[] | undefined) => void;
+    onExportClick: () => void;
+    autoFocus?: boolean;
+    toolbarIconVariant?: ActionIconVariant;
+    enableExport?: boolean;
+    refreshTooltip?: string;
+    exportTooltip?: string;
+    selectRowsTooltip?: string;
+    searchText: string[] | undefined;
+    setSearchText: Dispatch<SetStateAction<string[] | undefined>>;
+    searchData: SelectItem[];
+    setSearchData: Dispatch<SetStateAction<SelectItem[]>>;
+    maxSearchTerms?: number;
+    FiltersEntity?: EntityConstructor;
+    filterTooltip?: string;
+    parentKeys?: ValuesObject;
+    filterValues: ValuesObject | undefined;
+    setFilterValues: Dispatch<SetStateAction<ValuesObject | undefined>>;
+    filtersDescription: ValuesObject | undefined;
+    setFiltersDescription: Dispatch<SetStateAction<ValuesObject | undefined>>;
+    clearFiltersTooltip?: string;
+    filtersFormSize: MantineNumberSize;
+    enableImport?: boolean;
+    importTooltip?: string;
+    onImportClick?: () => void;
+    filtersBadgeSize?: MantineSize;
+    filtersBadgeVariant?: BadgeVariant;
+    showAppliedFilters?: boolean;
+    showRefreshButton?: boolean;
+    showSelectRowsButton?: boolean;
+    showFiltersButton?: boolean;
+    showSearchInput?: boolean;
+    visibleFilters?: string[];
+    initialColumnFilters?: ColumnsObject;
+    filtersTitle?: string;
+    editFiltersLabel?: string;
+    clearFiltersLabel?: string;
+    filtersAccordionVariant?: AccordionVariant;
+    showColumnsConfig?: boolean;
+    configMenuOpened?: boolean;
+    setConfigMenuOpened?: Dispatch<SetStateAction<boolean>>;
+    configMenuDropdown?: ReactNode;
+}
+export const DataGridToolbarDefaultProps: Partial<DataGridToolbarOptions>;
+export function DataGridToolbar(props: DataGridToolbarOptions): JSX.Element;
 export interface DataGridStateProps {
     setRefresh: React.Dispatch<React.SetStateAction<boolean>>;
     setSearchText: React.Dispatch<React.SetStateAction<string[] | undefined>>;
@@ -1171,6 +1171,17 @@ export interface EntityClientAction {
     showActionInViewMode?: boolean;
     onClick: (props: EntityClientActionOnClickProps) => Promise<boolean>;
 }
+export interface EntityFormClientActionOnClickProps extends EntityClientActionOnClickProps {
+    silent: boolean;
+}
+export interface EntityFormClientAction extends Omit<EntityClientAction, 'onClick'> {
+    onClick: (props: EntityFormClientActionOnClickProps) => Promise<boolean>;
+}
+export interface EntityFormActions {
+    OK?: EntityFormClientAction;
+    Cancel?: EntityFormClientAction;
+}
+export type EntityFormActionOverrides = Partial<Record<FormMode | 'Allways', EntityFormActions>>;
 export interface EntityProc {
     name: string;
     parms?: Record<string, Value>;
@@ -1204,6 +1215,7 @@ export class EntityDefinition {
     lookups: Record<string, EntityLookup>;
     serverActions: Record<string, EntityServerAction>;
     clientActions: Record<string, EntityClientAction>;
+    formActionOverrides: EntityFormActionOverrides;
     /**
      * Ordered allowlist of columns available for data imports.
      * A null value uses the import flow's inferred destinations; an empty array exposes no destinations.
@@ -3709,12 +3721,6 @@ export function useMultiDataMapGrid({ dataMapView, viewState, selectionMode, map
         entity: _Entity1<_EntityDefinition1>;
         formMode: "view" | "add" | "edit" | undefined;
         parentKeys: _ValuesObject1;
-        onSearchTextChange: _DataViewSearchCallback1;
-        visibleFilters: string[];
-        maxSearchTerms: number;
-        enableImport: boolean;
-        showSelectRowsButton: boolean;
-        limit: "0" | "50" | "100" | "500" | "1000" | "10000" | undefined;
         onModalClosed: (cancelled?: boolean) => void;
         onModalSaved: (new_status: _OperationStatus1<_DBStatusResult1 | null>) => void;
         modalFormSize: string | number | undefined;
@@ -3726,6 +3732,12 @@ export function useMultiDataMapGrid({ dataMapView, viewState, selectionMode, map
         columnBorders: boolean;
         rowBorders: boolean;
         autoSelectFirstRow: boolean;
+        onSearchTextChange: _DataViewSearchCallback1;
+        visibleFilters: string[];
+        maxSearchTerms: number;
+        enableImport: boolean;
+        showSelectRowsButton: boolean;
+        limit: "0" | "50" | "100" | "500" | "1000" | "10000" | undefined;
         viewName: string;
         refreshOnInit: boolean;
         onDataRefresh: (result: _OperationStatus1<_DataResult1[]>) => void;