@asaleh37/ui-base 1.1.6 → 1.1.8

package/dist/index.d.ts

@@ -1,7 +1,40 @@
+import { Reducer } from '@reduxjs/toolkit';
+import { IconProp } from '@fortawesome/fontawesome-svg-core';
+import { TextFieldProps, SxProps } from '@mui/material';
 export * from '@mui/material';
 export * from 'zod';
 export { toast } from 'react-toastify';
 export { FontAwesomeIcon, FontAwesomeIconProps } from '@fortawesome/react-fontawesome';
+import * as react from 'react';
+import react__default from 'react';
+import { GridColDef, GridRowSelectionModel, DataGridPremiumProps, GridToolbarProps, ToolbarPropsOverrides } from '@mui/x-data-grid-premium';
+import { UseFormReturn } from 'react-hook-form';
+
+interface SystemRoute {
+    path: string;
+    component: React.FC;
+    authority?: string;
+}
+
+type ExtendedTreeItemProps = {
+    icon: IconProp;
+    id: string;
+    label: string;
+    action?: "NAVIGATION";
+    authority?: string;
+    actionPayload?: {
+        path?: string;
+        parameters?: object;
+    };
+    children?: ExtendedTreeItemProps[];
+};
+
+interface StoreMetaData {
+    url: string;
+    data: Array<any>;
+    autoLoad: boolean;
+    authority?: string;
+}
 
 type AppInfo = {
     documentTitle: string | null;
@@ -9,8 +42,439 @@ type AppInfo = {
     appName: string | null;
     appVersion: string | null;
     appLogo: any | null;
+    businessRoutes: Array<SystemRoute>;
+    businessNavigationItems: Array<ExtendedTreeItemProps>;
+    businessReduxReducers: {
+        [key: string]: Reducer<any>;
+    };
+    businessCommonStoresMetaData: {
+        [key: string]: StoreMetaData;
+    };
 };
 
 declare const BaseApp: React.FC<AppInfo>;
 
-export { BaseApp };
+type TransferListProps = {
+    valueField: string;
+    displayField: string;
+    options: Array<any>;
+    selectedOptions: Array<any>;
+    setSelection: any;
+};
+declare const TransferList: react.FC<TransferListProps>;
+
+interface WidgetProps {
+    widgetTitle?: string;
+    widgetType: "Line" | "Bar" | "Pie" | "Card" | "Gauge" | "Progress";
+    data: any;
+    valueField: string;
+    labelField: string;
+}
+interface SingleRecordWidgetProps {
+    widgetTitle?: string;
+    record: object;
+    valueField: string;
+    labelField: string;
+}
+interface DashboardProps {
+    dashboardTitle: string;
+    dashboardWidgets: Array<WidgetProps>;
+}
+declare const TemplateDashboard: React.FC<DashboardProps>;
+
+declare const TemplateBarChart: React.FC<WidgetProps>;
+
+declare const TemplateDataCard: React.FC<SingleRecordWidgetProps>;
+
+declare const TemplateGauge: React.FC<SingleRecordWidgetProps>;
+
+declare const TemplateLineChart: React.FC<WidgetProps>;
+
+declare const TemplateLineProgress: react.FC<SingleRecordWidgetProps>;
+
+declare const TemplatePieChart: React.FC<WidgetProps>;
+
+interface CheckBoxProps {
+    value: any;
+    disabled?: boolean;
+    required?: boolean;
+    label: string;
+    checkedValue?: any;
+    unCheckedValue?: any;
+    onChangeCallBack: Function;
+    sx?: any;
+}
+declare const CheckBox: React.FC<CheckBoxProps>;
+
+interface ComboBoxProps {
+    value: any;
+    onChangeCallBack: Function;
+    label: string;
+    disabled?: boolean;
+    required?: boolean;
+    options: Array<any>;
+    errorMessage?: any;
+    displayField: string;
+    valueField: string;
+    sx?: any;
+}
+declare const ComboBox: React.FC<ComboBoxProps>;
+
+interface DatefieldProps {
+    value: string | null;
+    label: string;
+    disabled?: boolean;
+    required?: boolean;
+    sx?: any;
+    format?: string;
+    errorMessage?: any;
+    onChangeCallBack: Function;
+    [x: string | number | symbol]: unknown;
+}
+declare const Datefield: React.FC<DatefieldProps>;
+
+interface DatetimeFieldProps {
+    value: string | null;
+    label: string;
+    disabled?: boolean;
+    required?: boolean;
+    format?: string;
+    sx?: any;
+    errorMessage?: any;
+    onChangeCallBack: Function;
+    [x: string | number | symbol]: unknown;
+}
+declare const DatetimeField: React.FC<DatetimeFieldProps>;
+
+declare const TemplateTextField: React.FC<Omit<TextFieldProps, "outlined">>;
+
+type ApiActions = {
+    reloadData: (params?: any) => Promise<void>;
+    saveRecord: (record: any) => Promise<any | null>;
+    loadRecordById: (recordId: any) => Promise<any>;
+    deleteRecordById: (recordId: any) => Promise<boolean>;
+};
+
+type MakeOptional<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+type RecordAction = {
+    label?: string;
+    icon: IconProp;
+    isConfirmationRequired?: 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;
+    };
+    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>;
+};
+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>;
+};
+type TemplateGridColumnProps = {
+    hidden?: boolean;
+    searchable?: boolean;
+    options?: Array<object>;
+    displayField?: string;
+    valueField?: string;
+    muiProps?: MakeOptional<GridColDef, "field">;
+};
+type TemplateGridColDef = GridColDef & {
+    hidden?: boolean;
+    searchable?: boolean;
+    options?: Array<object>;
+    displayField?: string;
+    valueField?: string;
+};
+type TemplateGridProps = {
+    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;
+    hideBackButton?: boolean;
+    apiActions: ApiActions;
+    rowSelectionModel?: GridRowSelectionModel;
+    setRowSelectionModel?: any;
+    setSelectedRecord?: any;
+    setSelectedRecordIds?: 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">;
+};
+type ModalFormProps = {
+    recordIdToEdit?: any;
+    formCloseCallBk?: () => void;
+};
+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;
+};
+type RecordFieldProps = {
+    fieldName: string;
+    fieldLabel: string;
+    fieldType: "text" | "number" | "date" | "datetime" | "combobox" | "checkbox";
+    required?: boolean;
+    disabled?: boolean;
+    hidden?: boolean;
+    dateFormat?: string;
+    options?: Array<any>;
+    optionValueField?: string;
+    optionDisplayField?: string;
+    checkedValue?: any;
+    unCheckedValue?: any;
+    gridProps?: TemplateGridColumnProps;
+    formProps?: {
+        fieldSize?: FormElementSize;
+        style?: SxProps;
+        onValueChangeCallBack?: (value: any, formManager: UseFormReturn, formActions?: FormActionProps, selectedRecord?: any) => void;
+    };
+};
+type FormElementGroupProps = {
+    style?: SxProps;
+    icon?: IconProp;
+    label?: string;
+    elements?: Array<FormElementProps>;
+    actions?: Array<RecordAction>;
+    formManager?: UseFormReturn;
+    formValues?: any;
+    formActions?: any;
+    hiddenFields: string[];
+    disabledFields: string[];
+};
+type FormElementFieldProps = {
+    fieldInfo: RecordFieldProps;
+    formManager?: UseFormReturn;
+    formValues?: any;
+    formActions?: any;
+    hiddenFields: string[];
+    disabledFields: string[];
+};
+type FormElementNodeProps = {
+    formManager?: UseFormReturn;
+    formValues: any;
+    formActions?: any;
+};
+type FormElementProps = {
+    type: "group";
+    props: FormElementGroupProps;
+} | {
+    type: "field";
+    mode: "node";
+    node: React.FC<FormElementNodeProps>;
+    props?: RecordFieldProps;
+} | {
+    type: "field";
+    mode: "props";
+    props: RecordFieldProps;
+};
+type FormActionProps = {
+    setFieldValue: (fieldName: string, fieldValue: any) => void;
+    hideField: (fieldName: string) => void;
+    showField: (fieldName: string) => void;
+    disableField: (fieldName: string) => void;
+    enableField: (fieldName: string) => void;
+};
+type TemplateFormProps = {
+    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;
+    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";
+    };
+};
+type TemplateGridTopBarProps = GridToolbarProps & ToolbarPropsOverrides & {
+    templateProps: TemplateGridProps;
+    handleCreateNewRecord?: () => void;
+    clearGridState: () => void;
+};
+
+declare const TemplateForm: react__default.FC<TemplateFormProps>;
+
+declare const TemplateGrid: react__default.FC<TemplateGridProps>;
+
+interface APIRequest {
+    endPointURI: string;
+    parameters?: any;
+    data?: any;
+    showMask?: Boolean;
+    loadingMessage?: string;
+    successCallBkFn?: Function;
+    failureCallBkFn?: Function;
+}
+declare const useAxios: () => {
+    handleGetRequest: (props?: APIRequest) => Promise<any>;
+    handlePostRequest: (props?: APIRequest) => Promise<any>;
+    handleDeleteRequest: (props?: APIRequest) => Promise<any>;
+    HandleDownloadHTTPPostPDF: (props?: APIRequest) => Promise<any>;
+};
+
+interface ConfirmationWindowProps {
+    title: string;
+    body: string;
+    onConfirmationCallBk: () => void;
+}
+declare const useConfirmationWindow: (props: ConfirmationWindowProps) => {
+    ConfirmationWindow: react.FC<{}>;
+    open: boolean;
+    setOpen: react.Dispatch<react.SetStateAction<boolean>>;
+};
+
+declare const useLoadingMask: () => {
+    show: (message?: string) => void;
+    hide: () => void;
+};
+
+declare const useIsMobile: (breakpoint?: number) => boolean;
+
+interface OrganizationProps {
+    organizationCode?: string;
+    organizationName?: string;
+}
+interface UserProfileProps {
+    username?: string;
+    currentOrganizationCode?: string;
+    userOrganizations?: Array<OrganizationProps>;
+    employeeNumber?: string;
+    employeeName?: string;
+    divisionCode?: string;
+    divisionName?: string;
+    departmentCode?: string;
+    departmentName?: string;
+    rankCode?: string;
+    rankName?: string;
+    sectionCode?: string;
+    sectionName?: string;
+    subsectionCode?: string;
+    subsectionName?: string;
+    extNumber?: string;
+    mobileNumber?: string;
+    email?: string;
+}
+interface UserSessionProps {
+    value: {
+        isAuthenticated: boolean | null;
+        userProfile: UserProfileProps | null;
+        authorities: Array<{
+            authority: string;
+        }>;
+    };
+}
+
+declare const useSession: () => {
+    UserSession: UserSessionProps;
+    isUserAuthorized: (authorityCode: string) => boolean;
+};
+
+interface TemplateWindowProp {
+    height?: any;
+    width?: any;
+    minWidth?: any;
+    minHeight?: any;
+    windowIcon?: any;
+    windowTitle?: string;
+    onCloseCallBack?: any;
+}
+interface WindowProps {
+    children?: React.ReactNode;
+}
+declare const useWindow: (props: TemplateWindowProp) => {
+    windowState: boolean;
+    setWindowState: react.Dispatch<react.SetStateAction<boolean>>;
+    Window: react.FC<WindowProps>;
+};
+
+declare function hasDigitsOnly(str: string): boolean;
+declare function isNumber(value: any): boolean;
+declare function isNumeric(value: string): boolean;
+declare function capitalizeFirstLetter(str: string): string;
+
+declare const DATE_FORMAT = "YYYY-MM-DD";
+declare const DATE_TIME_FORMAT = "YYYY-MM-DD HH:mm:ss";
+
+export { BaseApp, CheckBox, ComboBox, DATE_FORMAT, DATE_TIME_FORMAT, Datefield, DatetimeField, TemplateBarChart, TemplateDashboard, TemplateDataCard, TemplateForm, TemplateGauge, TemplateGrid, TemplateLineChart, TemplateLineProgress, TemplatePieChart, TemplateTextField, TransferList, capitalizeFirstLetter, hasDigitsOnly, isNumber, isNumeric, useAxios, useConfirmationWindow, useIsMobile, useLoadingMask, useSession, useWindow };
+export type { DashboardProps, EditDeleteAction, FormActionProps, FormElementFieldProps, FormElementGroupProps, FormElementNodeProps, FormElementProps, FormElementSize, MakeOptional, ModalFormProps, RecordAction, RecordFieldProps, TemplateFormProps, TemplateGridColDef, TemplateGridColumnProps, TemplateGridProps, TemplateGridTopBarProps, TransferListProps };