@asaleh37/ui-base 26.2.131 → 27.5.26

package/src/components/templates/DataEntryTemplates/DataEntryTypes.ts

@@ -1,361 +1,361 @@
-import { attachment } from "./../attachment/AttachmentCard";
-import { IconProp } from "@fortawesome/fontawesome-svg-core";
-import {
-  DataGridPremiumProps,
-  GridColDef,
-  GridRowSelectionModel,
-  GridToolbarProps,
-  ToolbarPropsOverrides,
-} from "@mui/x-data-grid-premium";
-import { UseFormReturn } from "react-hook-form";
-import { SxProps, TextFieldProps } from "@mui/material";
-import { ApiActions } from "../../../hooks/useApiActions";
-import { z } from "zod";
-export type MakeOptional<T, K extends keyof T> = Omit<T, K> &
-  Partial<Pick<T, K>>;
-
-// Generic Types for Data Entry
-export type RecordAction = {
-  label?: string;
-  icon: IconProp;
-  isConfirmationRequired?: boolean;
-  isIdRequired?: Boolean;
-  confirmationMessage?: string;
-  authority?: string;
-  getActionIconStyleForRecord?: (record: any) => object;
-  isActionVisibleForRecord?: (record: any) => boolean;
-  isActionDisabledForRecord?: (record: any) => boolean;
-  actionFn: (
-    data: any | Array<any>,
-    recordIdsToProcessActionOn?: Array<any>
-  ) => Promise<void>;
-  preActionValidation?: (record: any) => boolean | Promise<boolean>;
-  postActionCallBack?: (record: any) => any | void;
-  gridActionProps?: {
-    showInMenu?: boolean;
-    multiRecord?: boolean;
-    reloadGridAfterAction?: boolean;
-  };
-  formActionProps?: {
-    enabled?: boolean;
-    actionButtonVariant?: "text" | "outlined" | "contained";
-    actionButtonColor?:
-      | "inherit"
-      | "primary"
-      | "secondary"
-      | "success"
-      | "error"
-      | "info"
-      | "warning";
-  };
-  record?: any;
-  reloadData?: (parameters?: any) => Promise<void>;
-  recordsToProcessActionOn?: Array<any>;
-  recordIdsToProcessActionOn?: Array<any>;
-};
-
-export type EditDeleteAction = {
-  isEnabled: boolean;
-  authority?: string;
-  isActionVisibleForRecord?: (record: any) => boolean;
-  isActionDisabledForRecord?: (record: any) => boolean;
-  preActionValidation?: (record: any) => boolean | Promise<boolean>;
-  postActionCallBack?: (record: any) => any | void;
-  gridActionProps?: {
-    showInMenu?: boolean;
-  };
-  formActionProps?: {
-    actionButtonVariant?: "text" | "outlined" | "contained";
-    actionButtonColor?:
-      | "inherit"
-      | "primary"
-      | "secondary"
-      | "success"
-      | "error"
-      | "info"
-      | "warning";
-  };
-  record?: any;
-  reloadData?: (parameters?: any) => Promise<void>;
-};
-
-// Template Grid Types
-
-export type TemplateGridColumnProps = {
-  hidden?: boolean;
-  searchable?: boolean;
-  options?: Array<object>;
-  displayField?: string;
-  valueField?: string;
-  muiProps?: MakeOptional<GridColDef, "field">;
-};
-
-export type TemplateGridColDef = GridColDef & {
-  lookupType?: string;
-  hidden?: boolean;
-  searchable?: boolean;
-  options?: Array<object>;
-  displayField?: string;
-  valueField?: string;
-  commonStoreKey?: string;
-  dataQueryId?: number;
-  storeUrl?: string;
-  storeLoadParam?: any;
-  comboboxGroupField?: string;
-};
-
-export type TemplateGridAttachmentProps = {
-  attachmentCode: string;
-  enableAttachFn?: (record: any) => boolean;
-};
-
-export type TemplateGridProps = {
-  workFlowDocumentCode?: string;
-  attachment?: TemplateGridAttachmentProps;
-  formElements: Array<FormElementProps>;
-  gridStateKey?: string;
-  data: Array<any>;
-  setData: any;
-  keyColumnName?: any;
-  autoLoad?: boolean;
-  gridTitle: string;
-  girdIcon: IconProp;
-  editAction?: EditDeleteAction;
-  deleteAction?: EditDeleteAction;
-  rowActions?: Array<RecordAction>;
-  gridLoadParameters?: Array<FormElementProps>;
-  gridLoadParametersValues?: { [key: string]: any };
-  setGridLoadParametersValues?: any;
-  tBar?: any;
-  disableDefaultAction?: boolean;
-  enableQuickSearch?: boolean;
-  enableExport?: boolean;
-  enableDensitySelector?: boolean;
-  hideInfoBar?: boolean;
-  hideCreateBtn?: boolean;
-  hideBackButton?: boolean;
-  apiActions: ApiActions;
-  rowSelectionModel?: GridRowSelectionModel;
-  setRowSelectionModel?: any;
-  setSelectedRecord?: any;
-  setSelectedRecordIds?: any;
-  formProps?: {
-    formValuesChangeCallBk?: FormValueChangeCallBk;
-  };
-  validationSchema?: z.ZodObject<
-    any,
-    "strip",
-    z.ZodTypeAny,
-    {
-      [x: string]: any;
-    },
-    {
-      [x: string]: any;
-    }
-  >;
-  editMode:
-    | { editMode: "none" }
-    | {
-        editMode: "row";
-        reloadAfterSave?: boolean;
-      }
-    | {
-        editMode: "modal";
-        specs?: {
-          modalTitle?: string;
-          modalIcon?: IconProp;
-          modalHeight?: any;
-          modalWidth?: any;
-          modalMinHeight?: any;
-          modalMinWidth?: any;
-          formComponent?: React.FC<ModalFormProps>;
-        };
-      }
-    | {
-        editMode: "form";
-        specs: {
-          formRoute: string;
-        };
-      };
-
-  muiProps?: MakeOptional<DataGridPremiumProps, "rows" | "columns">;
-};
-
-// Form Types
-export type ModalFormProps = {
-  recordIdToEdit?: any;
-  formCloseCallBk?: () => void;
-};
-
-export type FormElementSize = {
-  lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
-  md?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
-  sm?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
-};
-
-export type RecordFieldProps = {
-  fieldName: string;
-  fieldLabel: string;
-  fieldType:
-    | "text"
-    | "number"
-    | "date"
-    | "datetime"
-    | "combobox"
-    | "checkbox"
-    | "html"
-    | "lookup"
-    | "custom";
-  lookupType?: string;
-  comboboxValueDataType?: "number" | "string";
-  comboboxGroupField?: string;
-  commonStoreKey?: string;
-  dataQueryId?: number;
-  storeUrl?: string;
-  storeLoadParam?: any;
-  required?: boolean;
-  disabled?: boolean;
-  hidden?: boolean;
-  dateFormat?: string;
-  defaultValue?: any;
-  options?: Array<any>;
-  optionValueField?: string;
-  optionDisplayField?: string;
-  checkedValue?: any;
-  unCheckedValue?: any;
-  muiTextFieldProps?: TextFieldProps;
-  gridProps?: TemplateGridColumnProps;
-  formProps?: {
-    fieldSize?: FormElementSize;
-    fieldLabelFn?: (record: any) => string;
-    fieldHeight?: number;
-    style?: SxProps;
-  };
-};
-
-export type FormElementGroupProps = {
-  style?: SxProps;
-  icon?: IconProp;
-  label?: string;
-  elements?: Array<FormElementProps>;
-  actions?: Array<RecordAction>;
-  formManager?: UseFormReturn;
-  formValues?: any;
-  formActions?: any;
-  hiddenFields?: string[];
-  disabledFields?: string[];
-  formValuesChangeCallBk?: FormValueChangeCallBk;
-};
-
-export type FormValueChangeCallBk = (
-  formValues: any,
-  formActions: FormActionProps,
-  formManager: UseFormReturn,
-  fieldName?: string,
-  newValue?: any,
-  selectedRecord?: any
-) => void;
-
-export type FormElementFieldProps = {
-  fieldInfo: RecordFieldProps;
-  formManager?: UseFormReturn;
-  formValues?: any;
-  formActions?: any;
-  hiddenFields?: string[];
-  disabledFields?: string[];
-  formValuesChangeCallBk?: FormValueChangeCallBk;
-};
-
-export type FormElementNodeProps = {
-  formManager?: UseFormReturn;
-  formValues: any;
-  formActions?: any;
-};
-
-export type FormElementProps =
-  | {
-      type: "group";
-      props: FormElementGroupProps;
-    }
-  | {
-      type: "field";
-      mode: "node";
-      node: React.FC<FormElementNodeProps>;
-      props?: RecordFieldProps;
-    }
-  | {
-      type: "field";
-      mode: "props";
-      props: RecordFieldProps;
-    };
-
-export type FormActionProps = {
-  setFieldValue: (fieldName: string, fieldValue: any) => void;
-  hideField: (fieldName: string) => void;
-  showField: (fieldName: string) => void;
-  disableField: (fieldName: string) => void;
-  enableField: (fieldName: string) => void;
-};
-
-export type TemplateFormProps = {
-  workFlowDocumentCode?: string;
-  attachment?: TemplateGridAttachmentProps;
-  keyColumnName?: any;
-  elements: Array<FormElementProps>;
-  findByIdParamName?: string;
-  recordIdToEdit?: any;
-  formRouteRecordIdParamName?: string;
-  actions?: Array<RecordAction>;
-  editAuthorityKey?: string;
-  apiActions: ApiActions;
-  preSaveValidation?: (record: any) => boolean | Promise<boolean>;
-  formSavedSuccessfullyCallBk?: (response: any) => void;
-  formValuesChangeCallBk?: FormValueChangeCallBk;
-  formCloseCallBk?: () => void;
-  saveButtonSpecs?: {
-    label?: string;
-    icon?: IconProp;
-    hidden?: boolean;
-    actionButtonVariant?: "text" | "outlined" | "contained";
-    actionButtonColor?:
-      | "inherit"
-      | "primary"
-      | "secondary"
-      | "success"
-      | "error"
-      | "info"
-      | "warning";
-  };
-  cancelButtonSpecs?: {
-    label?: string;
-    icon?: IconProp;
-    hidden?: boolean;
-    actionButtonVariant?: "text" | "outlined" | "contained";
-    actionButtonColor?:
-      | "inherit"
-      | "primary"
-      | "secondary"
-      | "success"
-      | "error"
-      | "info"
-      | "warning";
-  };
-  validationSchema?: z.ZodObject<
-    any,
-    "strip",
-    z.ZodTypeAny,
-    {
-      [x: string]: any;
-    },
-    {
-      [x: string]: any;
-    }
-  >;
-};
-
-export type TemplateGridTopBarProps = GridToolbarProps &
-  ToolbarPropsOverrides & {
-    templateProps: TemplateGridProps;
-    handleCreateNewRecord?: () => void;
-    clearGridState: () => void;
-  };
+import { attachment } from "./../attachment/AttachmentCard";
+import { IconProp } from "@fortawesome/fontawesome-svg-core";
+import {
+  DataGridPremiumProps,
+  GridColDef,
+  GridRowSelectionModel,
+  GridToolbarProps,
+  ToolbarPropsOverrides,
+} from "@mui/x-data-grid-premium";
+import { UseFormReturn } from "react-hook-form";
+import { SxProps, TextFieldProps } from "@mui/material";
+import { ApiActions } from "../../../hooks/useApiActions";
+import { z } from "zod";
+export type MakeOptional<T, K extends keyof T> = Omit<T, K> &
+  Partial<Pick<T, K>>;
+
+// Generic Types for Data Entry
+export type RecordAction = {
+  label?: string;
+  icon: IconProp;
+  isConfirmationRequired?: boolean;
+  isIdRequired?: Boolean;
+  confirmationMessage?: string;
+  authority?: string;
+  getActionIconStyleForRecord?: (record: any) => object;
+  isActionVisibleForRecord?: (record: any) => boolean;
+  isActionDisabledForRecord?: (record: any) => boolean;
+  actionFn: (
+    data: any | Array<any>,
+    recordIdsToProcessActionOn?: Array<any>
+  ) => Promise<void>;
+  preActionValidation?: (record: any) => boolean | Promise<boolean>;
+  postActionCallBack?: (record: any) => any | void;
+  gridActionProps?: {
+    showInMenu?: boolean;
+    multiRecord?: boolean;
+    reloadGridAfterAction?: boolean;
+  };
+  formActionProps?: {
+    enabled?: boolean;
+    actionButtonVariant?: "text" | "outlined" | "contained";
+    actionButtonColor?:
+      | "inherit"
+      | "primary"
+      | "secondary"
+      | "success"
+      | "error"
+      | "info"
+      | "warning";
+  };
+  record?: any;
+  reloadData?: (parameters?: any) => Promise<void>;
+  recordsToProcessActionOn?: Array<any>;
+  recordIdsToProcessActionOn?: Array<any>;
+};
+
+export type EditDeleteAction = {
+  isEnabled: boolean;
+  authority?: string;
+  isActionVisibleForRecord?: (record: any) => boolean;
+  isActionDisabledForRecord?: (record: any) => boolean;
+  preActionValidation?: (record: any) => boolean | Promise<boolean>;
+  postActionCallBack?: (record: any) => any | void;
+  gridActionProps?: {
+    showInMenu?: boolean;
+  };
+  formActionProps?: {
+    actionButtonVariant?: "text" | "outlined" | "contained";
+    actionButtonColor?:
+      | "inherit"
+      | "primary"
+      | "secondary"
+      | "success"
+      | "error"
+      | "info"
+      | "warning";
+  };
+  record?: any;
+  reloadData?: (parameters?: any) => Promise<void>;
+};
+
+// Template Grid Types
+
+export type TemplateGridColumnProps = {
+  hidden?: boolean;
+  searchable?: boolean;
+  options?: Array<object>;
+  displayField?: string;
+  valueField?: string;
+  muiProps?: MakeOptional<GridColDef, "field">;
+};
+
+export type TemplateGridColDef = GridColDef & {
+  lookupType?: string;
+  hidden?: boolean;
+  searchable?: boolean;
+  options?: Array<object>;
+  displayField?: string;
+  valueField?: string;
+  commonStoreKey?: string;
+  dataQueryId?: number;
+  storeUrl?: string;
+  storeLoadParam?: any;
+  comboboxGroupField?: string;
+};
+
+export type TemplateGridAttachmentProps = {
+  attachmentCode: string;
+  enableAttachFn?: (record: any) => boolean;
+};
+
+export type TemplateGridProps = {
+  workFlowDocumentCode?: string;
+  attachment?: TemplateGridAttachmentProps;
+  formElements: Array<FormElementProps>;
+  gridStateKey?: string;
+  data: Array<any>;
+  setData: any;
+  keyColumnName?: any;
+  autoLoad?: boolean;
+  gridTitle: string;
+  girdIcon: IconProp;
+  editAction?: EditDeleteAction;
+  deleteAction?: EditDeleteAction;
+  rowActions?: Array<RecordAction>;
+  gridLoadParameters?: Array<FormElementProps>;
+  gridLoadParametersValues?: { [key: string]: any };
+  setGridLoadParametersValues?: any;
+  tBar?: any;
+  disableDefaultAction?: boolean;
+  enableQuickSearch?: boolean;
+  enableExport?: boolean;
+  enableDensitySelector?: boolean;
+  hideInfoBar?: boolean;
+  hideCreateBtn?: boolean;
+  hideBackButton?: boolean;
+  apiActions: ApiActions;
+  rowSelectionModel?: GridRowSelectionModel;
+  setRowSelectionModel?: any;
+  setSelectedRecord?: any;
+  setSelectedRecordIds?: any;
+  formProps?: {
+    formValuesChangeCallBk?: FormValueChangeCallBk;
+  };
+  validationSchema?: z.ZodObject<
+    any,
+    "strip",
+    z.ZodTypeAny,
+    {
+      [x: string]: any;
+    },
+    {
+      [x: string]: any;
+    }
+  >;
+  editMode:
+    | { editMode: "none" }
+    | {
+        editMode: "row";
+        reloadAfterSave?: boolean;
+      }
+    | {
+        editMode: "modal";
+        specs?: {
+          modalTitle?: string;
+          modalIcon?: IconProp;
+          modalHeight?: any;
+          modalWidth?: any;
+          modalMinHeight?: any;
+          modalMinWidth?: any;
+          formComponent?: React.FC<ModalFormProps>;
+        };
+      }
+    | {
+        editMode: "form";
+        specs: {
+          formRoute: string;
+        };
+      };
+
+  muiProps?: MakeOptional<DataGridPremiumProps, "rows" | "columns">;
+};
+
+// Form Types
+export type ModalFormProps = {
+  recordIdToEdit?: any;
+  formCloseCallBk?: () => void;
+};
+
+export type FormElementSize = {
+  lg?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+  md?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+  sm?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+};
+
+export type RecordFieldProps = {
+  fieldName: string;
+  fieldLabel: string;
+  fieldType:
+    | "text"
+    | "number"
+    | "date"
+    | "datetime"
+    | "combobox"
+    | "checkbox"
+    | "html"
+    | "lookup"
+    | "custom";
+  lookupType?: string;
+  comboboxValueDataType?: "number" | "string";
+  comboboxGroupField?: string;
+  commonStoreKey?: string;
+  dataQueryId?: number;
+  storeUrl?: string;
+  storeLoadParam?: any;
+  required?: boolean;
+  disabled?: boolean;
+  hidden?: boolean;
+  dateFormat?: string;
+  defaultValue?: any;
+  options?: Array<any>;
+  optionValueField?: string;
+  optionDisplayField?: string;
+  checkedValue?: any;
+  unCheckedValue?: any;
+  muiTextFieldProps?: TextFieldProps;
+  gridProps?: TemplateGridColumnProps;
+  formProps?: {
+    fieldSize?: FormElementSize;
+    fieldLabelFn?: (record: any) => string;
+    fieldHeight?: number;
+    style?: SxProps;
+  };
+};
+
+export type FormElementGroupProps = {
+  style?: SxProps;
+  icon?: IconProp;
+  label?: string;
+  elements?: Array<FormElementProps>;
+  actions?: Array<RecordAction>;
+  formManager?: UseFormReturn;
+  formValues?: any;
+  formActions?: any;
+  hiddenFields?: string[];
+  disabledFields?: string[];
+  formValuesChangeCallBk?: FormValueChangeCallBk;
+};
+
+export type FormValueChangeCallBk = (
+  formValues: any,
+  formActions: FormActionProps,
+  formManager: UseFormReturn,
+  fieldName?: string,
+  newValue?: any,
+  selectedRecord?: any
+) => void;
+
+export type FormElementFieldProps = {
+  fieldInfo: RecordFieldProps;
+  formManager?: UseFormReturn;
+  formValues?: any;
+  formActions?: any;
+  hiddenFields?: string[];
+  disabledFields?: string[];
+  formValuesChangeCallBk?: FormValueChangeCallBk;
+};
+
+export type FormElementNodeProps = {
+  formManager?: UseFormReturn;
+  formValues: any;
+  formActions?: any;
+};
+
+export type FormElementProps =
+  | {
+      type: "group";
+      props: FormElementGroupProps;
+    }
+  | {
+      type: "field";
+      mode: "node";
+      node: React.FC<FormElementNodeProps>;
+      props?: RecordFieldProps;
+    }
+  | {
+      type: "field";
+      mode: "props";
+      props: RecordFieldProps;
+    };
+
+export type FormActionProps = {
+  setFieldValue: (fieldName: string, fieldValue: any) => void;
+  hideField: (fieldName: string) => void;
+  showField: (fieldName: string) => void;
+  disableField: (fieldName: string) => void;
+  enableField: (fieldName: string) => void;
+};
+
+export type TemplateFormProps = {
+  workFlowDocumentCode?: string;
+  attachment?: TemplateGridAttachmentProps;
+  keyColumnName?: any;
+  elements: Array<FormElementProps>;
+  findByIdParamName?: string;
+  recordIdToEdit?: any;
+  formRouteRecordIdParamName?: string;
+  actions?: Array<RecordAction>;
+  editAuthorityKey?: string;
+  apiActions: ApiActions;
+  preSaveValidation?: (record: any) => boolean | Promise<boolean>;
+  formSavedSuccessfullyCallBk?: (response: any) => void;
+  formValuesChangeCallBk?: FormValueChangeCallBk;
+  formCloseCallBk?: () => void;
+  saveButtonSpecs?: {
+    label?: string;
+    icon?: IconProp;
+    hidden?: boolean;
+    actionButtonVariant?: "text" | "outlined" | "contained";
+    actionButtonColor?:
+      | "inherit"
+      | "primary"
+      | "secondary"
+      | "success"
+      | "error"
+      | "info"
+      | "warning";
+  };
+  cancelButtonSpecs?: {
+    label?: string;
+    icon?: IconProp;
+    hidden?: boolean;
+    actionButtonVariant?: "text" | "outlined" | "contained";
+    actionButtonColor?:
+      | "inherit"
+      | "primary"
+      | "secondary"
+      | "success"
+      | "error"
+      | "info"
+      | "warning";
+  };
+  validationSchema?: z.ZodObject<
+    any,
+    "strip",
+    z.ZodTypeAny,
+    {
+      [x: string]: any;
+    },
+    {
+      [x: string]: any;
+    }
+  >;
+};
+
+export type TemplateGridTopBarProps = GridToolbarProps &
+  ToolbarPropsOverrides & {
+    templateProps: TemplateGridProps;
+    handleCreateNewRecord?: () => void;
+    clearGridState: () => void;
+  };