identity-admin 1.28.6 → 1.28.8

package/lib/types/IResourceFile.d.ts

@@ -1,710 +1,719 @@
-import { ValidationChain } from 'express-validator';
-import { Document, Model } from 'mongoose';
-import { IRequest } from '../middlewares/isAuth';
-import { IRepository, PageInfo, PaginateParams } from '../repositories/Repository';
-import SaveResult from '../repositories/SaveResult';
-import { ActionNames, ActionTypes, FieldTypes, FileTypes, HandlerStrategy, ImageOptimizingCategories, NeighborTypes, Virtuals } from './helpers';
-import * as Yup from 'yup';
-declare type orderTypes = 'asc' | 'desc';
-declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
-declare type Severity = 'success' | 'info' | 'warning' | 'error';
-declare type ButtonColors = 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
-declare type ButtonVariants = 'text' | 'outlined' | 'contained';
-declare type ButtonSizes = 'small' | 'medium' | 'large';
-declare type PopulateFunction = (populatedString: any) => Promise<any>;
-interface Parent {
-    /**
-     * Name of the parent
-     */
-    name: string;
-    /**
-     * Icon of the parent. You can get the icons from
-     * {@link https://mui.com/material-ui/material-icons/}
-     */
-    icon: string;
-}
-interface IPopulate {
-    /**
-     * This function is called for all the endpoints to have an access over the populated string
-     */
-    all?: PopulateFunction;
-    /**
-     * This function is called for the list endpoint to have an access over the populated string
-     */
-    list?: PopulateFunction;
-    /**
-     * This function is called for the get one endpoint either in show or form an access over the populated string
-     */
-    show?: PopulateFunction;
-}
-interface Action {
-    /**
-     * Specify if this action is accessible or not.
-     * @default True for show, edit, delete, and new.
-     * @default false for bulk delete.
-     *  You can ovveride any of these values here.
-     */
-    isAccessible?: boolean;
-    /**
-     * Specify if the page requires to be reloaded after executing the action
-     * @default Fale for show, edit, delete, and new.
-     */
-    reloadAfterAction?: boolean;
-    /**
-     * The property that manages which admin role can use this action.
-     * This function's result alters the isAccessible value. So no need to use both properties.
-     * If both are used then isAccessible has the higher priority.
-     * @default 'Same as isAccessible'
-     */
-    isAllowed?: (currentUser: Document) => boolean;
-    /**
-     * The property that manages which action will be extracted from action menu in list.
-     * @default true for edit and show false for others
-     */
-    isMainAction?: boolean;
-    /**
-     * Specify if this action is visible or not per record.
-     * @default 'Same as isAccessible'
-     */
-    isVisible?: (data: ActionData) => Promise<boolean>;
-}
-interface ICrudOperations {
-    index?: {
-        /**
-         * Before handler that gives you the access to the filter object.
-         * You can add to the filter object any key and value that will be used in the filter query before getting the records for list.
-         * @returns the filter object
-         */
-        before?: (req: IRequest, filter: {
-            [key: string]: any;
-        }, currentUser: Document) => Promise<{
-            [key: string]: any;
-        }>;
-        /**
-         * After handler that gives you the access to the array of documents.
-         * @returns the array of documents
-         */
-        after?: (req: IRequest, documents: Document[], currentUser: Document) => Promise<Document[]>;
-        /**
-         * index handler that gives you the access to the run custom index method with custom query.
-         * @returns result list of records
-         */
-        index?: (req: IRequest, filter: {
-            [key: string]: any;
-        }, sortQuery: {
-            [key: string]: any;
-        }, paginateParams: PaginateParams | undefined, populate: any, currentUser: Document) => Promise<{
-            records: Document[];
-            pageInfo?: PageInfo;
-        }>;
-    };
-    create?: {
-        /**
-         * Before handler that is called before creating a new record.
-         * This function gives you the access to the record params before saving it, you can perform any update to the params before saving it.
-         * @returns the params
-         */
-        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
-        /**
-         * After handler that gives you the access to the saved document.
-         * @returns the saved document
-         */
-        after?: (req: IRequest, document: Document, currentUser: Document, params: any) => Promise<Document>;
-        /**
-         * Validators consist of an array of Express ValidationChain, each comprising validation functions that are executed before triggering the save query.
-         */
-        validators?: ValidationChain[];
-    };
-    update?: {
-        /**
-         * Before handler that is called before updating a record.
-         * This function gives you the access to the record params before saving it, you can perform any update to the params before saving it.
-         * @returns the params
-         */
-        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
-        /**
-         * After handler that gives you the access to the updated document.
-         * @returns the updated document
-         */
-        after?: (req: IRequest, document: Document, params: any, currentUser: Document) => Promise<Document>;
-        /**
-         * update handler that gives you the access to the run custom update method with custom query.
-         * @returns saved result with updated document
-         */
-        update?: (req: IRequest, record: Document, recordParams: any, currentUser: Document) => Promise<SaveResult<any>>;
-        /**
-         * Validators consist of an array of Express ValidationChain, each comprising validation functions that are executed before triggering the update query.
-         */
-        validators?: ValidationChain[];
-    };
-    show?: {
-        /**
-         * Before handler that gives you the access to the filter object.
-         * You can add to the filter object any key and value that will be used in the filter query before getting the records for list.
-         * @returns the filter object
-         */
-        before?: (req: IRequest, filter: {
-            [key: string]: any;
-        }, currentUser: Document) => Promise<{
-            [key: string]: any;
-        }>;
-        after?: (req: IRequest, record: Document) => Promise<{
-            record: Document;
-            [key: string]: any;
-        }>;
-        /**
-         * A function that is called before getting the next or the previous record. It gives you the access to the filter object.
-         * @returns The filter object
-         */
-        nextPreviousButtonHandler?: (req: IRequest, filter: {
-            [key: string]: any;
-        }, currentUser: Document, direction: NeighborTypes) => Promise<{
-            [key: string]: any;
-        }>;
-    };
-}
-export interface ActionData {
-    /**
-     * Record document
-     */
-    record: any;
-    /**
-     * Current user data
-     */
-    currentUser: Document;
-    /**
-     * Resource data to which this record belongs
-     */
-    resource: {
-        /**
-         * Model name of this table.
-         */
-        name: string;
-        /**
-         * Path of the resource to which you can redirect.
-         */
-        path: string;
-        /**
-         * Repository of this resource.
-         */
-        repository: IRepository<Document>;
-    };
-}
-interface IFilters {
-    /**
-     * Scope filter props.
-     * Can be either auto or manual. It cannot be both.
-     * This filter is not accessible by default
-     */
-    scopes?: {
-        /**
-         * Specify if this filter is accessible or not
-         * @default false
-         */
-        isAccessible: boolean;
-        /**
-         * Show All tab
-         * @default true
-         */
-        showAll?: boolean;
-        /**
-         * Automatic scope that filters by the specified key with one of the given options
-         * This filter works automatically by mentioning the key as saved in the database along with the values that this key can has.
-         * It doesn't need a handler
-         */
-        auto?: IAutoScope;
-        /**
-         * Manual scope by using a handler.
-         * In this case you can put the options you like with specifying in the handler what to do with each option.
-         */
-        manual?: IManualScope;
-    };
-    /**
-     * Search bar filter props
-     */
-    searchBar?: {
-        /**
-         * Specify if this filter is accessible or not
-         * @default true
-         */
-        isAccessible: boolean;
-    };
-}
-interface IAutoScope {
-    /**
-     * Key of property as specified in the database
-     */
-    key: string;
-    /**
-     * Array of values that this key can have
-     */
-    options: string[];
-}
-interface IManualScope {
-    /**
-     * Array of values that will be appeared in the scope
-     */
-    options: string[];
-    /**
-     * A handler that will be called when scope filter is used.
-     * This handler should perform a switch case on the specified options values, each case set the filter on its way.
-     */
-    handler: (filter: {
-        [key: string]: any;
-    }, scope: string, currentUser: Document) => Promise<{
-        [key: string]: any;
-    }>;
-}
-export interface IFieldValue {
-    /**
-     * If the field is required in the schema and you don't want it to be required in the form, you can override this here.
-     * @default 'same as schema'
-     */
-    required?: boolean;
-    /**
-     * Specify either this field can be edited or not.
-     * @default true
-     */
-    isEditable?: boolean;
-    /**
-     * Specify the type of the field. Can be used for specifying localized string, image,... etc.
-     * @default 'Same as schema''
-     */
-    type?: FieldTypes;
-    /**
-     * Specify the enum values if the field type is an enum.
-     * You can give custom labels with custom background color of the chib as color and label color as labelColor
-     * @default 'Same as schema''
-     */
-    enumValues?: string[] | {
-        [key: string]: {
-            label: string;
-            color: string;
-            labelColor: string;
-        };
-    };
-    /**
-     * Specify the allowed country codes.
-     * @required if the type is phone number
-     * ex: ["sa", "eg", ...]
-     */
-    countryCodes?: string[];
-    /**
-     * Specify the default country code.
-     * ex: ["sa", "eg", ...]
-     * @default 'First country of provided country codes or sa if no country codes provided'
-     */
-    defaultCountryCode?: string;
-    /**
-     * Specify the array type if the field is of type array.
-     * @default 'Same as schema''
-     */
-    arrayType?: FieldTypes;
-    /**
-     * Specify if the array is draggable. Only used when the field type is an array.
-     * @default 'true''
-     */
-    isDraggable?: boolean;
-    /**
-     * Can be used only if this field is a reference to the Image collection
-     */
-    mediaUploader?: boolean;
-    /**
-     * Used only if this field is of type image. It specifies what is the optimizing level of an image before upload
-     * @default NORMAL
-     */
-    imageOptimizingCategory?: ImageOptimizingCategories;
-    /**
-     * Specify the type of the file to be uploaded. Only required if the media uploader is true.
-     * @default image
-     */
-    fileType?: FileTypes;
-    /**
-     * Specify if the date is shown with time or not. Only used if the field type is Date
-     * @default false
-     */
-    withTime?: boolean;
-    /**
-     * Specify the api route that to be called for getting the referenced values
-     * @default undefined
-     */
-    apiRoute?: string;
-    /**
-     * Path of the value inside the model schema
-     * @default undefined
-     */
-    valuePath?: string;
-    /**
-     * Specify if this property is clickable or not in the list view.
-     * @default undefined
-     */
-    isClickable?: boolean;
-    /**
-     * Specify the keys that will be shown in the nested schema. Only used when the type is nested schema
-     * @default undefined
-     */
-    keys?: string[];
-    /**
-     * Specify the nested schema. Only used if the type is nested schema.
-     * @default undefined
-     */
-    schema?: IModel | {
-        [key: string]: IFieldValue;
-    };
-    /**
-     * Specify if this field is filtered by multiple values not only one value. Only used if this value is one of the quick filters.
-     * @default undefined
-     */
-    multipleInFilter?: boolean;
-    /**
-     * Used if you want to override the validation of the original field. For example if you want to add your customized condition for password validations.
-     * @default 'Same as schema'
-     */
-    yupValidationSchema?: Yup.Schema;
-    /**
-     * Used to add the create new icon on the reference field. Only used when the type of the field is reference
-     * @default false
-     */
-    enableCreateNewButtonOnReference?: boolean;
-    /**
-     * Used only with text field types like Text field or Localized string
-     * @default false
-     */
-    textArea?: boolean;
-    /**
-     * Used to add the relatedFields option in the field. Only used when the type of the field is reference
-     * @default undefined
-     */
-    relatedFields?: string[];
-    /**
-      * Only used if the field type is REFERENCE. Used to filter the list of referenced items.
-       */
-    filter?: {
-        formList?: Record<string, any>;
-        filterList?: Record<string, any>;
-    };
-    /**
-     * Path to access the resource.
-     */
-    path?: string;
-    /**
-     * Determines the minimum width for column in list
-     */
-    minWidth?: number;
-}
-export interface IVirtualValue {
-    /**
-     * For now we have some virtual fields that can be added
-     * 1) Password: If you want to add password field in the creation form for example
-     * 2) ref: If it is a one to many realtion. For example, if you want to get all subCatogeries that belong to a category when you show the category record
-     * 3) array: If this field is an array
-     */
-    type: VirtualFieldTypes;
-    /**
-     * Specify the key that should be filtered by in case of 1 to many realtionship
-     */
-    filterBy?: string;
-    /**
-     * Array type exists only if the type is array
-     */
-    arrayType?: string;
-    /**
-     * Defines where this virtaul field need to be appeared
-     */
-    showIn: Virtuals;
-    required: boolean;
-    /**
-     * Define Virtual field's resource in case of ref type or array of ref type
-     */
-    resource?: Model<any, any>;
-    /**
-     * Define Filter query creator required in case of showIn Filter
-     */
-    handler?: (filterQuery: {
-        [key: string]: any;
-    }, value: any | any[]) => Promise<{
-        [key: string]: any;
-    }>;
-}
-export interface IModel {
-    /**
-     * virtual data props
-     */
-    virtuals?: {
-        [key: string]: IVirtualValue;
-    };
-}
-interface ActionOptions {
-    show?: Action;
-    new?: Action;
-    edit?: Action;
-    delete?: Action;
-    bulkDelete?: Action;
-    /**
-     * Any extra action to be added.
-     */
-    extras?: ExtraAction[];
-}
-export interface ExtraAction {
-    /**
-     * Key of this action.
-     * Should be unique in the same resource file
-     */
-    key: string;
-    /**
-     * Name of this action
-     */
-    name: string;
-    /**
-     * Icon of this action.
-     * {@link https://mui.com/material-ui/material-icons/}
-     */
-    icon: string;
-    /**
-     * Color of the action button
-     * In case of bulk actions it is one of the button colors. @default inherit
-     * In case of record actions it is any color like red, green, ... @default black
-     */
-    color?: string | ButtonColors;
-    /**
-     * Size of the action button. Only used in case of bulk actions
-     * @default small
-     */
-    size?: ButtonSizes;
-    /**
-     * Variant of the action button. Only used in case of bulk actions
-     * @default contained
-     */
-    variant?: ButtonVariants;
-    /**
-     * Action type if it is record action or resource action.
-     */
-    actionType: ActionTypes;
-    /**
-     * Guard message title that appears before executing the action to confirm execution.
-     * @default 'No guard message'
-     */
-    guardTitle?: string;
-    /**
-     * Guard message body that appears before executing the action to confirm execution.
-     * @default 'No guard message'
-     */
-    guard?: string;
-    /**
-     * Alert message appear after executing this action.
-     * @default 'Action was executed successfully'
-     */
-    message?: string;
-    /**
-     * Specify if you need the alert message to appear after executing this action
-     * @default 'true'
-     */
-    showAlertMessage?: boolean;
-    /**
-     * The severity of the alert. This defines the color and icon used.
-     * @default 'success'
-     */
-    severity?: Severity;
-    /**
-     * Specify if you need the dialog to be in full screen or not. Used only in case of custom component strategy
-     * @default 'false'
-     */
-    fullScreen?: boolean;
-    /**
-     * @returns boolean value.
-     * This value Specifies to which records should this action appears.
-     * @default 'Action is shown to all records'
-     */
-    isVisible?: (data: ActionData) => Promise<boolean>;
-    /**
-     * Handler function that is executed after clicking the action.
-     */
-    handler: (req: IRequest, res: any, data: ActionData) => Promise<IActionHandlerResponse>;
-    /**
-     * Icon of this action.
-     * {@link https://mui.com/material-ui/material-icons/}
-     */
-    handlerStrategy?: HandlerStrategy;
-    /**
-     * The property that manages which action will be extracted from action menu in list.
-     * @default true for edit and show false for others
-     */
-    isMainAction?: boolean;
-}
-export interface IActionHandlerResponse {
-    /**
-     * The action taken after executing the action.
-     * For example, if you would like to go to list after executing the action, just set this value by list
-     */
-    action: ActionNames;
-    /**
-     * Path of the resource that is intended to redirect.
-     * Is set to resource.path if you would like to be in the same table
-     */
-    path: string;
-    /**
-     * Id of the record that is used in actions that needs record id like show or edit
-     */
-    recordId?: string;
-    /**
-     * Path of the uploaded file in case of file download handling strategy
-     */
-    filePath?: string;
-}
-export interface IResourceFile {
-    properties: {
-        /**
-         * The model
-         */
-        resource: Model<any, any>;
-        /**
-         * Model name as saved in the data base.
-         */
-        modelName: string;
-        /**
-         * Name of this model appeared on the nav bar.
-         * @default 'Model name'
-         */
-        name?: string;
-        /**
-         * Property of this table that is shown as the link for the record.
-         * Used to be searched by in the search bar.
-         * If not mentioned explicitly, a search is done on the schema to check for property title, name, or email.
-         * If these properties are not found, _id is taken.
-         */
-        title?: string;
-        /**
-         * The property to be sorted by the documents.
-         * @default 'The schema title'
-         */
-        defaultOrderBy?: string;
-        /**
-         * The property that controls the permission of this model according to the current user role.
-         * Specify either this user is allowed to see this model or not.
-         * @default true
-         */
-        isAllowed?: (currentUser: Document) => Promise<boolean>;
-        /**
-         * The property that controls the visibility of this resource in the nav bar
-         * @default true
-         */
-        isVisible?: (currentUser: Document) => Promise<boolean>;
-        /**
-         * The property that controls the ability of logging changes of this resource.
-         * @default false
-         */
-        enableLog?: (currentUser: Document) => Promise<boolean>;
-        /**
-         * The default order
-         * @default asc
-         */
-        defaultOrder?: orderTypes;
-        /**
-         * Number of rows per page
-         * @default 10
-         */
-        defaultrowsPerPage?: number;
-        /**
-         * The parent that this model is belong to in the nav bar.
-         * @default 'Set up parent'
-         */
-        parent?: Parent;
-        /**
-         * Array of fields that are completely hidden from all pages
-         */
-        hiddenProperties?: string[];
-        /**
-         * Action options for overriding existing actions accessibility or adding custom actions
-         */
-        actions?: ActionOptions;
-        /**
-         * Filters options
-         */
-        filters?: IFilters;
-        /**
-         * Using before or after handlers of any crud operation
-         */
-        crudOperations?: ICrudOperations;
-        /**
-         * Translation object of the fields' names.
-         */
-        keysTranslations?: {
-            [key: string]: any;
-        };
-        /**
-         * Translation object of the actions' names.
-         */
-        actionsTranslations?: {
-            [key: string]: any;
-        };
-        /**
-         * Override some props of a field's schema structure
-         * Add a new virtual property
-         */
-        model?: {
-            [key: string]: IFieldValue;
-        } | IModel;
-        /**
-         * Override the populated object
-         */
-        populate?: IPopulate;
-        /**
-         * Disable the display of next and previous buttons in the show page
-         * @default false
-         */
-        disableNextPreviousButtonsInShowPage?: boolean;
-        /**
-         * Disable the display of next and previous buttons in the edit page
-         * @default false
-         */
-        disableNextPreviousButtonsInEditPage?: boolean;
-        /**
-         * The option to display the edit page instead of the show page
-         * @default false
-         */
-        displayEditPageInShowPage?: boolean;
-        /**
-         * Specify the path of image to be shown beside the name in the reference options
-         * @default undefined
-         */
-        imageOnReferencePath?: string;
-        /**
-         * The option to disable displaying the image beside the name in the reference options
-         * @default false
-         */
-        disableImageOnReference?: boolean;
-        /**
-         * An object for any extra data need to be sent with the resource file
-         * @default undefined
-         */
-        extras?: {
-            [key: string]: any;
-        };
-    };
-    /**
-     * Array of properties that should be appeared in the list action.
-     * @default 'The whole fields'
-     */
-    listProperties?: string[];
-    /**
-     * Arrays of properties that should be appeared in the show action.
-     * @default 'The whole fields'
-     */
-    showProperties?: string[];
-    /**
-     * Array of properties that should be appeared in the create/edit form.
-     * @default 'The whole fields'
-     */
-    formProperties?: string[];
-    /**
-     * Array of properties that should be appeared in the filter.
-     * @default 'The whole fields'
-     */
-    filterProperties?: string[];
-    /**
-     * Array of properties that should be appeared in the quick filters.
-     * @default 'Empty array'
-     */
-    quickFilterProperties?: string[];
-}
-export {};
+import { ValidationChain } from 'express-validator';
+import { Document, Model } from 'mongoose';
+import { IRequest } from '../middlewares/isAuth';
+import { IRepository, PageInfo, PaginateParams } from '../repositories/Repository';
+import SaveResult from '../repositories/SaveResult';
+import { ActionNames, ActionTypes, FieldTypes, FileTypes, HandlerStrategy, ImageOptimizingCategories, NeighborTypes, Virtuals } from './helpers';
+import * as Yup from 'yup';
+declare type orderTypes = 'asc' | 'desc';
+declare type VirtualFieldTypes = 'password' | 'ref' | 'Array';
+declare type Severity = 'success' | 'info' | 'warning' | 'error';
+declare type ButtonColors = 'inherit' | 'primary' | 'secondary' | 'success' | 'error' | 'info' | 'warning';
+declare type ButtonVariants = 'text' | 'outlined' | 'contained';
+declare type ButtonSizes = 'small' | 'medium' | 'large';
+declare type PopulateFunction = (populatedString: any) => Promise<any>;
+interface Parent {
+    /**
+     * Name of the parent
+     */
+    name: string;
+    /**
+     * Icon of the parent. You can get the icons from
+     * {@link https://mui.com/material-ui/material-icons/}
+     */
+    icon: string;
+}
+interface IPopulate {
+    /**
+     * This function is called for all the endpoints to have an access over the populated string
+     */
+    all?: PopulateFunction;
+    /**
+     * This function is called for the list endpoint to have an access over the populated string
+     */
+    list?: PopulateFunction;
+    /**
+     * This function is called for the get one endpoint either in show or form an access over the populated string
+     */
+    show?: PopulateFunction;
+}
+interface Action {
+    /**
+     * Specify if this action is accessible or not.
+     * @default True for show, edit, delete, and new.
+     * @default false for bulk delete.
+     *  You can ovveride any of these values here.
+     */
+    isAccessible?: boolean;
+    /**
+     * Specify if the page requires to be reloaded after executing the action
+     * @default Fale for show, edit, delete, and new.
+     */
+    reloadAfterAction?: boolean;
+    /**
+     * The property that manages which admin role can use this action.
+     * This function's result alters the isAccessible value. So no need to use both properties.
+     * If both are used then isAccessible has the higher priority.
+     * @default 'Same as isAccessible'
+     */
+    isAllowed?: (currentUser: Document) => boolean;
+    /**
+     * The property that manages which action will be extracted from action menu in list.
+     * @default true for edit and show false for others
+     */
+    isMainAction?: boolean;
+    /**
+     * Specify if this action is visible or not per record.
+     * @default 'Same as isAccessible'
+     */
+    isVisible?: (data: ActionData) => Promise<boolean>;
+}
+interface ICrudOperations {
+    index?: {
+        /**
+         * Before handler that gives you the access to the filter object.
+         * You can add to the filter object any key and value that will be used in the filter query before getting the records for list.
+         * @returns the filter object
+         */
+        before?: (req: IRequest, filter: {
+            [key: string]: any;
+        }, currentUser: Document) => Promise<{
+            [key: string]: any;
+        }>;
+        /**
+         * After handler that gives you the access to the array of documents.
+         * @returns the array of documents
+         */
+        after?: (req: IRequest, documents: Document[], currentUser: Document) => Promise<Document[]>;
+        /**
+         * index handler that gives you the access to the run custom index method with custom query.
+         * @returns result list of records
+         */
+        index?: (req: IRequest, filter: {
+            [key: string]: any;
+        }, sortQuery: {
+            [key: string]: any;
+        }, paginateParams: PaginateParams | undefined, populate: any, currentUser: Document) => Promise<{
+            records: Document[];
+            pageInfo?: PageInfo;
+        }>;
+    };
+    create?: {
+        /**
+         * Before handler that is called before creating a new record.
+         * This function gives you the access to the record params before saving it, you can perform any update to the params before saving it.
+         * @returns the params
+         */
+        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
+        /**
+         * After handler that gives you the access to the saved document.
+         * @returns the saved document
+         */
+        after?: (req: IRequest, document: Document, currentUser: Document, params: any) => Promise<Document>;
+        /**
+         * Validators consist of an array of Express ValidationChain, each comprising validation functions that are executed before triggering the save query.
+         */
+        validators?: ValidationChain[];
+    };
+    update?: {
+        /**
+         * Before handler that is called before updating a record.
+         * This function gives you the access to the record params before saving it, you can perform any update to the params before saving it.
+         * @returns the params
+         */
+        before?: (req: IRequest, params: any, currentUser: Document) => Promise<any>;
+        /**
+         * After handler that gives you the access to the updated document.
+         * @returns the updated document
+         */
+        after?: (req: IRequest, document: Document, params: any, currentUser: Document) => Promise<Document>;
+        /**
+         * update handler that gives you the access to the run custom update method with custom query.
+         * @returns saved result with updated document
+         */
+        update?: (req: IRequest, record: Document, recordParams: any, currentUser: Document) => Promise<SaveResult<any>>;
+        /**
+         * Validators consist of an array of Express ValidationChain, each comprising validation functions that are executed before triggering the update query.
+         */
+        validators?: ValidationChain[];
+    };
+    show?: {
+        /**
+         * Before handler that gives you the access to the filter object.
+         * You can add to the filter object any key and value that will be used in the filter query before getting the records for list.
+         * @returns the filter object
+         */
+        before?: (req: IRequest, filter: {
+            [key: string]: any;
+        }, currentUser: Document) => Promise<{
+            [key: string]: any;
+        }>;
+        after?: (req: IRequest, record: Document) => Promise<{
+            record: Document;
+            [key: string]: any;
+        }>;
+        /**
+         * A function that is called before getting the next or the previous record. It gives you the access to the filter object.
+         * @returns The filter object
+         */
+        nextPreviousButtonHandler?: (req: IRequest, filter: {
+            [key: string]: any;
+        }, currentUser: Document, direction: NeighborTypes) => Promise<{
+            [key: string]: any;
+        }>;
+    };
+}
+export interface ActionData {
+    /**
+     * Record document
+     */
+    record: any;
+    /**
+     * Current user data
+     */
+    currentUser: Document;
+    /**
+     * Resource data to which this record belongs
+     */
+    resource: {
+        /**
+         * Model name of this table.
+         */
+        name: string;
+        /**
+         * Path of the resource to which you can redirect.
+         */
+        path: string;
+        /**
+         * Repository of this resource.
+         */
+        repository: IRepository<Document>;
+    };
+}
+interface IFilters {
+    /**
+     * Scope filter props.
+     * Can be either auto or manual. It cannot be both.
+     * This filter is not accessible by default
+     */
+    scopes?: {
+        /**
+         * Specify if this filter is accessible or not
+         * @default false
+         */
+        isAccessible: boolean;
+        /**
+         * Show All tab
+         * @default true
+         */
+        showAll?: boolean;
+        /**
+         * Automatic scope that filters by the specified key with one of the given options
+         * This filter works automatically by mentioning the key as saved in the database along with the values that this key can has.
+         * It doesn't need a handler
+         */
+        auto?: IAutoScope;
+        /**
+         * Manual scope by using a handler.
+         * In this case you can put the options you like with specifying in the handler what to do with each option.
+         */
+        manual?: IManualScope;
+    };
+    /**
+     * Search bar filter props
+     */
+    searchBar?: {
+        /**
+         * Specify if this filter is accessible or not
+         * @default true
+         */
+        isAccessible: boolean;
+    };
+}
+interface IAutoScope {
+    /**
+     * Key of property as specified in the database
+     */
+    key: string;
+    /**
+     * Array of values that this key can have
+     */
+    options: string[];
+}
+interface IManualScope {
+    /**
+     * Array of values that will be appeared in the scope
+     */
+    options: string[];
+    /**
+     * A handler that will be called when scope filter is used.
+     * This handler should perform a switch case on the specified options values, each case set the filter on its way.
+     */
+    handler: (filter: {
+        [key: string]: any;
+    }, scope: string, currentUser: Document) => Promise<{
+        [key: string]: any;
+    }>;
+}
+export interface IFieldValue {
+    /**
+     * If the field is required in the schema and you don't want it to be required in the form, you can override this here.
+     * @default 'same as schema'
+     */
+    required?: boolean;
+    /**
+     * Specify either this field can be edited or not.
+     * @default true
+     */
+    isEditable?: boolean;
+    /**
+     * Specify the type of the field. Can be used for specifying localized string, image,... etc.
+     * @default 'Same as schema''
+     */
+    type?: FieldTypes;
+    /**
+     * Specify the enum values if the field type is an enum.
+     * You can give custom labels with custom background color of the chib as color and label color as labelColor
+     * @default 'Same as schema''
+     */
+    enumValues?: string[] | {
+        [key: string]: {
+            label: string;
+            color: string;
+            labelColor: string;
+        };
+    };
+    /**
+     * Specify the allowed country codes.
+     * @required if the type is phone number
+     * ex: ["sa", "eg", ...]
+     */
+    countryCodes?: string[];
+    /**
+     * Specify the default country code.
+     * ex: ["sa", "eg", ...]
+     * @default 'First country of provided country codes or sa if no country codes provided'
+     */
+    defaultCountryCode?: string;
+    /**
+     * Specify the array type if the field is of type array.
+     * @default 'Same as schema''
+     */
+    arrayType?: FieldTypes;
+    /**
+     * Specify if the array is draggable. Only used when the field type is an array.
+     * @default 'true''
+     */
+    isDraggable?: boolean;
+    /**
+     * Can be used only if this field is a reference to the Image collection
+     */
+    mediaUploader?: boolean;
+    /**
+     * Used only if this field is of type image. It specifies what is the optimizing level of an image before upload
+     * @default NORMAL
+     */
+    imageOptimizingCategory?: ImageOptimizingCategories;
+    /**
+     * Specify the type of the file to be uploaded. Only required if the media uploader is true.
+     * @default image
+     */
+    fileType?: FileTypes;
+    /**
+     * Specify if the date is shown with time or not. Only used if the field type is Date
+     * @default false
+     */
+    withTime?: boolean;
+    /**
+     * Specify the api route that to be called for getting the referenced values
+     * @default undefined
+     */
+    apiRoute?: string;
+    /**
+     * Path of the value inside the model schema
+     * @default undefined
+     */
+    valuePath?: string;
+    /**
+     * Specify if this property is clickable or not in the list view.
+     * @default undefined
+     */
+    isClickable?: boolean;
+    /**
+     * Specify the keys that will be shown in the nested schema. Only used when the type is nested schema
+     * @default undefined
+     */
+    keys?: string[];
+    /**
+     * Specify the nested schema. Only used if the type is nested schema.
+     * @default undefined
+     */
+    schema?: IModel | {
+        [key: string]: IFieldValue;
+    };
+    /**
+     * Specify if this field is filtered by multiple values not only one value. Only used if this value is one of the quick filters.
+     * @default undefined
+     */
+    multipleInFilter?: boolean;
+    /**
+     * Used if you want to override the validation of the original field. For example if you want to add your customized condition for password validations.
+     * @default 'Same as schema'
+     */
+    yupValidationSchema?: Yup.Schema;
+    /**
+     * Used to add the create new icon on the reference field. Only used when the type of the field is reference
+     * @default false
+     */
+    enableCreateNewButtonOnReference?: boolean;
+    /**
+     * Used only with text field types like Text field or Localized string
+     * @default false
+     */
+    textArea?: boolean;
+    /**
+     * Used to add the relatedFields option in the field. Only used when the type of the field is reference
+     * @default undefined
+     */
+    relatedFields?: string[];
+    /**
+      * Only used if the field type is REFERENCE. Used to filter the list of referenced items.
+       */
+    filter?: {
+        formList?: Record<string, any>;
+        filterList?: Record<string, any>;
+    };
+    /**
+     * Path to access the resource.
+     */
+    path?: string;
+    /**
+     * Determines the minimum width for column in list
+     */
+    minWidth?: number;
+}
+export interface IVirtualValue {
+    /**
+     * For now we have some virtual fields that can be added
+     * 1) Password: If you want to add password field in the creation form for example
+     * 2) ref: If it is a one to many realtion. For example, if you want to get all subCatogeries that belong to a category when you show the category record
+     * 3) array: If this field is an array
+     */
+    type: VirtualFieldTypes;
+    /**
+     * Specify the key that should be filtered by in case of 1 to many realtionship
+     */
+    filterBy?: string;
+    /**
+     * Array type exists only if the type is array
+     */
+    arrayType?: string;
+    /**
+     * Defines where this virtaul field need to be appeared
+     */
+    showIn: Virtuals;
+    required: boolean;
+    /**
+     * Define Virtual field's resource in case of ref type or array of ref type
+     */
+    resource?: Model<any, any>;
+    /**
+     * Define Filter query creator required in case of showIn Filter
+     */
+    handler?: (filterQuery: {
+        [key: string]: any;
+    }, value: any | any[]) => Promise<{
+        [key: string]: any;
+    }>;
+}
+export interface IModel {
+    /**
+     * virtual data props
+     */
+    virtuals?: {
+        [key: string]: IVirtualValue;
+    };
+}
+interface ActionOptions {
+    show?: Action;
+    new?: Action;
+    edit?: Action;
+    delete?: Action;
+    bulkDelete?: Action;
+    /**
+     * Any extra action to be added.
+     */
+    extras?: ExtraAction[];
+}
+export interface ExtraAction {
+    /**
+     * Key of this action.
+     * Should be unique in the same resource file
+     */
+    key: string;
+    /**
+     * Name of this action
+     */
+    name: string;
+    /**
+     * Icon of this action.
+     * {@link https://mui.com/material-ui/material-icons/}
+     */
+    icon: string;
+    /**
+     * Color of the action button
+     * In case of bulk actions it is one of the button colors. @default inherit
+     * In case of record actions it is any color like red, green, ... @default black
+     */
+    color?: string | ButtonColors;
+    /**
+     * Size of the action button. Only used in case of bulk actions
+     * @default small
+     */
+    size?: ButtonSizes;
+    /**
+     * Variant of the action button. Only used in case of bulk actions
+     * @default contained
+     */
+    variant?: ButtonVariants;
+    /**
+     * Action type if it is record action or resource action.
+     */
+    actionType: ActionTypes;
+    /**
+     * Guard message title that appears before executing the action to confirm execution.
+     * @default 'No guard message'
+     */
+    guardTitle?: string;
+    /**
+     * Guard message body that appears before executing the action to confirm execution.
+     * @default 'No guard message'
+     */
+    guard?: string;
+    /**
+     * Alert message appear after executing this action.
+     * @default 'Action was executed successfully'
+     */
+    message?: string;
+    /**
+     * Specify if you need the alert message to appear after executing this action
+     * @default 'true'
+     */
+    showAlertMessage?: boolean;
+    /**
+     * The severity of the alert. This defines the color and icon used.
+     * @default 'success'
+     */
+    severity?: Severity;
+    /**
+     * Specify if you need the dialog to be in full screen or not. Used only in case of custom component strategy
+     * @default 'false'
+     */
+    fullScreen?: boolean;
+    /**
+     * @returns boolean value.
+     * This value Specifies to which records should this action appears.
+     * @default 'Action is shown to all records'
+     */
+    isVisible?: (data: ActionData) => Promise<boolean>;
+    /**
+     * Handler function that is executed after clicking the action.
+     */
+    handler: (req: IRequest, res: any, data: ActionData) => Promise<IActionHandlerResponse>;
+    /**
+     * Icon of this action.
+     * {@link https://mui.com/material-ui/material-icons/}
+     */
+    handlerStrategy?: HandlerStrategy;
+    /**
+     * The property that manages which action will be extracted from action menu in list.
+     * @default true for edit and show false for others
+     */
+    isMainAction?: boolean;
+}
+export interface IActionHandlerResponse {
+    /**
+     * The action taken after executing the action.
+     * For example, if you would like to go to list after executing the action, just set this value by list
+     */
+    action: ActionNames;
+    /**
+     * Path of the resource that is intended to redirect.
+     * Is set to resource.path if you would like to be in the same table
+     */
+    path: string;
+    /**
+     * Id of the record that is used in actions that needs record id like show or edit
+     */
+    recordId?: string;
+    /**
+     * Path of the uploaded file in case of file download handling strategy
+     */
+    filePath?: string;
+}
+export interface IResourceFile {
+    properties: {
+        /**
+         * The model
+         */
+        resource: Model<any, any>;
+        /**
+         * Model name as saved in the data base.
+         */
+        modelName: string;
+        /**
+         * Name of this model appeared on the nav bar.
+         * @default 'Model name'
+         */
+        name?: string;
+        /**
+         * Property of this table that is shown as the link for the record.
+         * Used to be searched by in the search bar.
+         * If not mentioned explicitly, a search is done on the schema to check for property title, name, or email.
+         * If these properties are not found, _id is taken.
+         */
+        title?: string;
+        /**
+         * The property to be sorted by the documents.
+         * @default 'The schema title'
+         */
+        defaultOrderBy?: string;
+        /**
+         * The property that controls the permission of this model according to the current user role.
+         * Specify either this user is allowed to see this model or not.
+         * @default true
+         */
+        isAllowed?: (currentUser: Document) => Promise<boolean>;
+        /**
+         * The property that controls the visibility of this resource in the nav bar
+         * @default true
+         */
+        isVisible?: (currentUser: Document) => Promise<boolean>;
+        /**
+         * The property that controls the ability of logging changes of this resource.
+         * @default false
+         */
+        enableLog?: (currentUser: Document) => Promise<boolean>;
+        /**
+         * The default order
+         * @default asc
+         */
+        defaultOrder?: orderTypes;
+        /**
+         * Number of rows per page
+         * @default 10
+         */
+        defaultrowsPerPage?: number;
+        /**
+         * The parent that this model is belong to in the nav bar.
+         * @default 'Set up parent'
+         */
+        parent?: Parent;
+        /**
+         * Array of fields that are completely hidden from all pages
+         */
+        hiddenProperties?: string[];
+        /**
+         * Action options for overriding existing actions accessibility or adding custom actions
+         */
+        actions?: ActionOptions;
+        /**
+         * Filters options
+         */
+        filters?: IFilters;
+        /**
+         * Using before or after handlers of any crud operation
+         */
+        crudOperations?: ICrudOperations;
+        /**
+         * Translation object of the fields' names.
+         */
+        keysTranslations?: {
+            [key: string]: any;
+        };
+        /**
+         * Translation object of the actions' names.
+         */
+        actionsTranslations?: {
+            [key: string]: any;
+        };
+        /**
+         * Override some props of a field's schema structure
+         * Add a new virtual property
+         */
+        model?: {
+            [key: string]: IFieldValue;
+        } | IModel;
+        /**
+         * Override the populated object
+         */
+        populate?: IPopulate;
+        /**
+         * Disable the display of next and previous buttons in the show page
+         * @default false
+         */
+        disableNextPreviousButtonsInShowPage?: boolean;
+        /**
+         * Disable the display of next and previous buttons in the edit page
+         * @default false
+         */
+        disableNextPreviousButtonsInEditPage?: boolean;
+        /**
+         * The option to display the edit page instead of the show page
+         * @default false
+         */
+        displayEditPageInShowPage?: boolean;
+        /**
+         * Specify the path of image to be shown beside the name in the reference options
+         * @default undefined
+         */
+        imageOnReferencePath?: string;
+        /**
+         * The option to disable displaying the image beside the name in the reference options
+         * @default false
+         */
+        disableImageOnReference?: boolean;
+        /**
+         * An object for any extra data need to be sent with the resource file
+         * @default undefined
+         */
+        extras?: {
+            [key: string]: any;
+        };
+        /**
+         * Used for sending draft mails in mail log
+         * @default undefined
+         */
+        sendDraftMail?: (data: {
+            to: string;
+            subject: string;
+            html: string;
+        }) => Promise<void>;
+    };
+    /**
+     * Array of properties that should be appeared in the list action.
+     * @default 'The whole fields'
+     */
+    listProperties?: string[];
+    /**
+     * Arrays of properties that should be appeared in the show action.
+     * @default 'The whole fields'
+     */
+    showProperties?: string[];
+    /**
+     * Array of properties that should be appeared in the create/edit form.
+     * @default 'The whole fields'
+     */
+    formProperties?: string[];
+    /**
+     * Array of properties that should be appeared in the filter.
+     * @default 'The whole fields'
+     */
+    filterProperties?: string[];
+    /**
+     * Array of properties that should be appeared in the quick filters.
+     * @default 'Empty array'
+     */
+    quickFilterProperties?: string[];
+}
+export {};