react-crud-mui 0.2.47 → 0.2.49

package/dist/components/detail-page/components/DetailPageCommands.d.ts

@@ -4,10 +4,11 @@ import { UseFormReturn } from '../../form/hooks/useForm';
 import { CloseReason } from '../../page/Page';
 import { DetailPageCommandsFlag } from '../hooks/useDetailPageStates';
 import { NeedDataReason } from '../pages/DetailPageContent';
-import { SaveMode } from '../pages/DetailPageData';
+import { NavigationDirection, SaveMode } from '../pages/DetailPageData';
 import { StepPane } from './DetailPageStepsHeader';
 export type DetailPageStandartCommandsOptions = {
     saveCommandMode?: SaveMode;
+    reason: NeedDataReason;
 };
 export type DetailPageStepCommandsOptions = {
     nextButtonTitle?: React.ReactNode;
@@ -32,6 +33,7 @@ export type DetailPageStandartCommandsEvents = {
     onDelete?: () => void;
     onClose?: (reason?: CloseReason) => void;
     onSaveClose?: () => void;
+    onNavigate?: (direction: NavigationDirection) => void;
 };
 export type DetailPageStepCommandsEvents = {
     onNextClick?: () => void;

package/dist/components/detail-page/components/DetailPageDefaultLayout.d.ts

@@ -1,14 +1,16 @@
 import { ReactNode } from 'react';
+import { FieldValues } from 'react-hook-form';
 import { NeedDataReason } from '../pages/DetailPageContent';
-export type DetailPageLayoutOptions = {
+export type DetailPageLayoutOptions<TModel extends FieldValues = FieldValues> = {
     loading?: boolean;
     reason: NeedDataReason;
+    data?: TModel;
 };
-export type DetailPageLayoutProps = {
+export type DetailPageLayoutProps<TModel extends FieldValues = FieldValues> = {
     content?: ReactNode;
     stepsContent?: ReactNode;
     autoSaveContent?: ReactNode;
-    options: DetailPageLayoutOptions;
+    options: DetailPageLayoutOptions<TModel>;
 };
 type DetailPageDefaultLayoutProps = DetailPageLayoutProps;
 declare function DetailPageDefaultLayout({ content, stepsContent, autoSaveContent, }: DetailPageDefaultLayoutProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/detail-page/components/DetailPageProvider.d.ts

@@ -6,5 +6,5 @@ export type DetailPageContextType<TModel extends FieldValues = FieldValues> = Pi
     setActiveSegmentIndex: (index: number) => void;
 };
 export declare const DetailPageContext: React.Context<DetailPageContextType<FieldValues> | null>;
-declare function DetailPageProvider({ children, data, reason, loading, enableCopy, enableCreate, enableClose, enableDiscardChanges, enableDelete, onSave, enableSave, disabled, activeSegmentIndex, setActiveSegmentIndex, }: PropsWithChildren & DetailPageContextType): import("react/jsx-runtime").JSX.Element;
+declare function DetailPageProvider<TModel extends FieldValues = FieldValues>({ children, data, reason, loading, enableCopy, enableCreate, enableClose, enableDiscardChanges, enableDelete, onSave, enableSave, disabled, activeSegmentIndex, setActiveSegmentIndex, }: PropsWithChildren & DetailPageContextType<TModel>): import("react/jsx-runtime").JSX.Element;
 export default DetailPageProvider;

package/dist/components/detail-page/hooks/useDetailPageModal.d.ts

@@ -1,5 +1,6 @@
 import { FieldValues } from 'react-hook-form';
 import { NeedDataReason } from '../pages/DetailPageContent';
+import { NavigatePayload } from '../pages/DetailPageData';
 import { DetailPageModalProps } from '../pages/DetailPageModal';
 export type SelectedModelOptions<TModel extends FieldValues> = Pick<DetailPageModalProps<TModel>, 'reason' | 'data' | 'disabled' | 'onAfterSave' | 'onAfterDelete'>;
 type HelperModelFields = {
@@ -17,6 +18,7 @@ export interface UseDetailPageModalProps {
 declare function useDetailPageModal<TModel extends FieldValues>({ models, uniqueIdParamName, }?: UseDetailPageModalProps): readonly [({ data, disabled, reason, onAfterDelete, onAfterSave }?: SelectedModelOptions<TModel>) => void, {
     readonly onReasonChange: (reason: NeedDataReason) => void;
     readonly onClose: () => void;
+    readonly onNavigate: ({ direction }: Pick<NavigatePayload<TModel>, "direction">) => void;
     readonly modalProps?: Omit<import('../../..').ModalProps, "children" | "open">;
     readonly open?: boolean;
     readonly promptOptions?: import('./useFormPrompt').UseFormPromptProps;
@@ -418,6 +420,7 @@ declare function useDetailPageModal<TModel extends FieldValues>({ models, unique
     readonly component?: React.ElementType;
     readonly disabled?: boolean;
     readonly loading?: boolean;
+    readonly readOnly?: boolean;
     readonly size?: import('../../page/components/PageProvider').PaddingSize;
     readonly icon?: import('react').ReactNode;
     readonly rightContent?: import('react').ReactNode;
@@ -464,15 +467,15 @@ declare function useDetailPageModal<TModel extends FieldValues>({ models, unique
     readonly onCreate?: () => void;
     readonly onSave?: import('../pages/DetailPageData').DataEvent<TModel, import('../pages/DetailPageData').SavePayload<TModel>> | undefined;
     readonly onDiscardChanges?: () => void;
-    readonly onContentLayout?: (props: import('../components/DetailPageDefaultLayout').DetailPageLayoutProps) => React.ReactNode;
-    readonly onWrapperLayout?: (props: import('../pages/DetailPageContent').DetailPageWrapperLayoutProps) => React.ReactNode;
+    readonly onContentLayout?: ((props: import('../components/DetailPageDefaultLayout').DetailPageLayoutProps<TModel>) => React.ReactNode) | undefined;
+    readonly onWrapperLayout?: ((props: import('../pages/DetailPageContent').DetailPageWrapperLayoutProps<TModel>) => React.ReactNode) | undefined;
     readonly defaultSaveMode?: import('../pages/DetailPageData').SaveMode;
     readonly steps?: import('../components/DetailPageStepsHeader').StepPane<TModel>[] | undefined;
     readonly customSteps?: React.ComponentType<import('../components/DetailPageStepsHeader').DetailPageStepsHeaderProps>;
     readonly stepsProps?: Partial<import('../components/DetailPageStepsHeader').DetailPageStepsHeaderProps>;
-    readonly showSuccessMessages?: boolean;
-    readonly onAfterSave?: ((result: void | Awaited<TModel> | undefined, variables: import('../pages/DetailPageData').SavePayload<TModel>, form: import('../../form/hooks/useForm').UseFormReturn<TModel>) => void) | undefined;
     readonly onAfterDelete?: ((variables: import('../pages/DetailPageData').DeletePayload<TModel>, form: import('../../form/hooks/useForm').UseFormReturn<TModel>) => void) | undefined;
+    readonly onAfterSave?: ((result: void | Awaited<TModel> | undefined, variables: import('../pages/DetailPageData').SavePayload<TModel>, form: import('../../form/hooks/useForm').UseFormReturn<TModel>) => void) | undefined;
+    readonly showSuccessMessages?: boolean;
     readonly uid?: string;
     readonly index?: number;
 }];

package/dist/components/detail-page/pages/DetailPageContent.d.ts

@@ -6,16 +6,17 @@ import { PageProps } from '../../page/Page';
 import { ServerError } from '../../utils';
 import { AutoSaveOptions } from '../components/AutoSave';
 import { CommandsProps, CommandsPropsFn, DetailPageCommandsProps } from '../components/DetailPageCommands';
-import { DetailPageLayoutProps } from '../components/DetailPageDefaultLayout';
+import { DetailPageLayoutOptions, DetailPageLayoutProps } from '../components/DetailPageDefaultLayout';
 import { DetailPageHeaderProps } from '../components/DetailPageHeader';
 import { DetailPageStepsHeaderProps, StepPane } from '../components/DetailPageStepsHeader';
-import { SaveMode } from './DetailPageData';
+import { NavigationDirection, SaveMode } from './DetailPageData';
 export type NeedDataReason = 'create' | 'fetch' | 'copy' | 'view';
-export type DetailPageWrapperLayoutProps = {
+export type DetailPageWrapperLayoutProps<TModel extends FieldValues = FieldValues> = {
     content: ReactNode;
     pageContent: ReactNode;
     commandsContent: ReactNode;
     alertsContent: ReactNode;
+    options: DetailPageLayoutOptions<TModel>;
 };
 export interface DetailPageContentProps<TModel extends FieldValues> extends Omit<PageProps, 'commandsContent' | 'alertsContent' | 'autoSave' | 'onHeader' | 'tabExtraContent'> {
     commandsProps?: CommandsProps | CommandsPropsFn;
@@ -84,6 +85,10 @@ export interface DetailPageContentProps<TModel extends FieldValues> extends Omit
      * Delete event
      */
     onDelete: () => void;
+    /**
+     * Navigation callback when one of which navigate buttons is pressed
+     */
+    onNavigate: (direction: NavigationDirection) => void;
     /**
      * Custom header function
      */
@@ -120,11 +125,15 @@ export interface DetailPageContentProps<TModel extends FieldValues> extends Omit
      * Having called "onSave" once changing form values
      */
     autoSave?: boolean | AutoSaveOptions;
+    /**
+     * Readonly mode, when true all commands are disabled except commands unlike disabled
+     */
+    readOnly?: boolean;
     /**
      *  Custom content layout
      */
-    onContentLayout?: (props: DetailPageLayoutProps) => React.ReactNode;
-    onWrapperLayout?: (props: DetailPageWrapperLayoutProps) => React.ReactNode;
+    onContentLayout?: (props: DetailPageLayoutProps<TModel>) => React.ReactNode;
+    onWrapperLayout?: (props: DetailPageWrapperLayoutProps<TModel>) => React.ReactNode;
     /**
      *Default save mode (save,saveclose,savecreate) default is 'save'
      */
@@ -143,5 +152,5 @@ export interface DetailPageContentProps<TModel extends FieldValues> extends Omit
     stepsProps?: Partial<DetailPageStepsHeaderProps>;
     tabExtraContent?: ReactNode | ((data?: TModel) => ReactNode);
 }
-declare function DetailPageContent<TModel extends FieldValues>({ activeSegmentIndex, alerts, autoSave, children, commandsPosition, commandsProps, customSteps: CustomSteps, data, defaultSaveMode, disabled, disableShortCuts, enableClose, enableCopy, enableCreate, enableDelete, enableDiscardChanges, enableSave, error, form, hotkeyScopes, loading, onClose, onCommands, onContentLayout, onCopy, onCreate, onDelete, onDiscardChanges, onSegmentChanged, onExtraCommands, onHeader, onSave, onSaveClose, onSaveCreate, onWrapperLayout, reason, showHeader, steps, stepsProps, tabExtraContent, ...pageProps }: DetailPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
+declare function DetailPageContent<TModel extends FieldValues>({ activeSegmentIndex, alerts, autoSave, children, commandsPosition, commandsProps, customSteps: CustomSteps, data, defaultSaveMode, disabled, disableShortCuts, enableClose, enableCopy, enableCreate, enableDelete, enableDiscardChanges, enableSave, error, form, hotkeyScopes, loading, onClose, onCommands, onContentLayout, onCopy, onCreate, onDelete, onDiscardChanges, onSegmentChanged, onExtraCommands, onHeader, onNavigate, onSave, onSaveClose, onSaveCreate, onWrapperLayout, readOnly, reason, showHeader, steps, stepsProps, tabExtraContent, ...pageProps }: DetailPageContentProps<TModel>): import("react/jsx-runtime").JSX.Element;
 export default DetailPageContent;

package/dist/components/detail-page/pages/DetailPageData.d.ts

@@ -18,12 +18,22 @@ export interface DeletePayload<TModel extends FieldValues = FieldValues> extends
     model: TModel;
     data?: TModel;
 }
-export interface DetailPageDataProps<TModel extends FieldValues> extends Omit<DetailPageContentProps<TModel>, 'onSave' | 'onDelete' | 'onDiscardChanges' | 'onCopy' | 'onSaveCreate' | 'onSaveClose'> {
+export interface NavigatePayload<TModel extends FieldValues = FieldValues> extends BasePayload {
+    direction: NavigationDirection;
+    model: TModel;
+}
+export type NavigationDirection = 'next' | 'prev';
+export interface DetailPageDataProps<TModel extends FieldValues> extends Omit<DetailPageContentProps<TModel>, 'onSave' | 'onDelete' | 'onDiscardChanges' | 'onCopy' | 'onSaveCreate' | 'onSaveClose' | 'onNavigate'> {
     /**
      * Save event
      * @returns if returns data,either in promise or object will bind to form data
      */
     onSave?: DataEvent<TModel, SavePayload<TModel>>;
+    /**
+     * Navigation buttons event when navigation is active
+     * @returns if returns data,either in promise or object will bind to form data
+     */
+    onNavigate?: DataEvent<TModel, NavigatePayload<TModel>>;
     /**
      * Delete event
      * @returns if returns data,either in promise or object will bind to form data
@@ -53,5 +63,5 @@ export interface DetailPageDataProps<TModel extends FieldValues> extends Omit<De
 /**
  * Page component that all data manupulation is handled
  */
-declare function DetailPageData<TModel extends FieldValues>({ alerts, autoSave, data, error, form, loading, onAfterDelete, onAfterSave, onClose, onDelete, onDiscardChanges, onReasonChange, onSave, reason, showSuccessMessages, ...dpProps }: DetailPageDataProps<TModel>): import("react/jsx-runtime").JSX.Element;
+declare function DetailPageData<TModel extends FieldValues>({ alerts, autoSave, data, error, form, loading, onAfterDelete, onAfterSave, onClose, onDelete, onDiscardChanges, onReasonChange, onNavigate, onSave, reason, showSuccessMessages, ...dpProps }: DetailPageDataProps<TModel>): import("react/jsx-runtime").JSX.Element;
 export default DetailPageData;

package/dist/components/list-page/components/ListPageProvider.d.ts

@@ -0,0 +1,22 @@
+import { default as React, PropsWithChildren } from 'react';
+import { FieldValues } from 'react-hook-form';
+import { NeedDataReason } from '../../detail-page/pages/DetailPageContent';
+import { ListPageProps } from '../pages/ListPage';
+export type ListPageContextType<TModel extends FieldValues = FieldValues> = {
+    data?: TModel[];
+    /**
+     * Clear all form controls in filter
+     */
+    clear: () => void;
+    /**
+     * Trigger search with defined filter criterias
+     */
+    search: () => void;
+    /**
+     * Used for built in detailpage opener
+     */
+    triggerAction: (reason: NeedDataReason, data?: TModel) => void;
+} & Pick<ListPageProps<TModel>, 'loading' | 'enableClear' | 'enableCreateItem' | 'enableExport' | 'enableSearch'>;
+export declare const ListPageContext: React.Context<ListPageContextType<any> | null>;
+declare function ListPageProvider<TModel extends FieldValues = FieldValues>({ children, data, loading, enableClear, enableCreateItem, enableExport, enableSearch, search: onSearch, clear: onClear, triggerAction, }: PropsWithChildren & ListPageContextType<TModel>): import("react/jsx-runtime").JSX.Element;
+export default ListPageProvider;

package/dist/components/list-page/hooks/useListPage.d.ts

@@ -1,22 +1,4 @@
-import { default as React } from 'react';
 import { FieldValues } from 'react-hook-form';
-import { NeedDataReason } from '../../detail-page/pages/DetailPageContent';
-import { ListPageProps } from '../pages/ListPage';
-export type ListPageContextType<TModel extends FieldValues> = {
-    data?: TModel[];
-    /**
-     * Clear all form controls in filter
-     */
-    clear: () => void;
-    /**
-     * Trigger search with defined filter criterias
-     */
-    search: () => void;
-    /**
-     * Used for built in detailpage opener
-     */
-    triggerAction: (reason: NeedDataReason, data?: TModel) => void;
-} & Pick<ListPageProps<TModel>, 'loading' | 'enableClear' | 'enableCreateItem' | 'enableExport' | 'enableSearch'>;
-export declare const ListPageContext: React.Context<ListPageContextType<any> | null>;
+import { ListPageContextType } from '../components/ListPageProvider';
 declare const useListPage: <TModel extends FieldValues>() => ListPageContextType<TModel>;
 export default useListPage;