@sava-info-systems/api-maker-with-extensions 1.0.0-alpha

package/src/assets/schema-types/types.ts

@@ -0,0 +1,1529 @@
+export interface IAMGlobal {
+    req: IAMGlobalRequest;
+    res: IAMGlobalResponse;
+    sys: IAMGlobalSys;
+    logger: IAMGlobalLogger;
+    shared: any;
+}
+
+export interface IAMGlobalLogger {
+    debug(...data: any[]): void;
+    log(...data: any[]): void;
+    info(...data: any[]): void;
+    warn(...data: any[]): void;
+    error(...data: any[]): void;
+}
+
+export interface IAMGlobalRequest {
+    headers: any;
+    params: any;
+    query: any;
+    body: any;
+    eventData: any;
+    auth: ISandboxReqAuthObj;
+}
+
+export interface ISandboxReqAuthObj {
+    authAMUser?: any;
+    authAMDB?: any;
+
+    authGoogle?: any;
+    authAWS?: any;
+    authAzure?: any;
+}
+
+export interface IAuthInfoObjects {
+    authAMDBInfo?: IAuthTokenAMDB; //
+    authAMDBGroups?: any[]; // IGroup[]
+
+    authGoogleInfo?: IAuthTokenGoogle;
+    authGoogleGroups?: any[]; // IGroup[]
+    authAWSInfo?: IAuthTokenAWS;
+    authAWSGroups?: any[]; // IGroup[]
+    authAzureInfo?: IAuthTokenAzureAD;
+    authAzureGroups?: any[]; // IGroup[]
+}
+
+// duplicate with store-types
+export enum EContentType {
+    JSON = 'application/json',
+    XML = 'text/xml',
+    YAML = 'text/yaml',
+    TEXT = 'text/plain',
+    HTML = 'text/html',
+    OCTET_STREAM = 'application/octet-stream',
+}
+
+// duplicate with store-types
+export enum ERequestMethod {
+    GET = 'GET',
+    POST = 'POST',
+    PUT = 'PUT',
+    DELETE = 'DELETE',
+}
+
+export interface IAMGlobalResponse {
+    /** Status code of response. ex: 401, 500 */
+    statusCode?: EStatusCode;
+
+    /** Change content-type header of response. default is 'application/json' */
+    contentType?: EContentType;
+
+    /** It will be sent to user as response of api call. */
+    output?: any;
+
+    /** Shared object for user to use. */
+    shared?: any;
+
+    /** * List of errors. If any error occurs. It will be returned to user. */
+    errors?: IResponseError[];
+
+    /** List of errors. If any error occurs. It will be returned to user. */
+    warnings?: IResponseError[];
+}
+
+export enum EType {
+    string = 'string',
+    number = 'number',
+    boolean = 'boolean',
+    date = 'date',
+    objectId = 'objectId',
+
+    // below are added because of third party request body
+    file = 'file',
+    files = 'files'
+}
+
+export enum EErrorType {
+    required = 'required',
+    min = 'min',
+    max = 'max',
+    minLength = 'minLength',
+    maxLength = 'maxLength',
+    unique = 'unique',
+    uniqueCombination = 'uniqueCombination', // multiple keys unique violated
+    invalidValue = 'invalidValue',
+    schemaKeyNotFound = 'schemaKeyNotFound',
+    schemaNotFound = 'schemaNotFound',
+    emailNotValid = 'emailNotValid',
+}
+
+// Main interfaces
+export interface ISchemaType {
+    [key: string]: IAnySchemaPropertyType;
+}
+
+export type IAnySchemaPropertyType = EType | [EType] | ISchemaProperty | [ISchemaProperty] | ISchemaType | [ISchemaType];
+
+export interface ISchemaProperty { // Add new schema property in ValidateDBSchema too
+    __type?: EType;
+    conversions?: IPropertyConversion;
+    validations?: IPropertyValidation;
+
+    instance?: string; // used as strings in _.get
+    database?: string; // used as strings in _.get
+    collection?: string; // used as strings in _.get
+    table?: string;
+
+    // this column value will be return after nested save.
+    column?: string; // user can define column of target collection here. so no need to define t_key in deep property. Used in getDataForDeep // used as strings in _.get
+    isPrimaryKey?: boolean;
+
+    /** Database will take care of assigning incremental value for this field. */
+    isAutoIncrementByDB?: boolean;
+
+    /** API Maker will take care of assigning incremental value for this field. */
+    isAutoIncrementByAM?: boolean | IIsAutoIncrementByAM;
+    // defaultValue?: any; it can be very dynamic so skipping it right now.
+}
+
+export interface IIsAutoIncrementByAM {
+    start: number;
+    step?: number; // default value will be 1
+}
+
+export interface IPropertyValidation {
+    required?: boolean; // Allowed Types : *
+    min?: number; // Allowed Types : number | date
+    max?: number; // Allowed Types : number | date
+    minLength?: number; // Allowed Types : string
+    maxLength?: number; // Allowed Types : string
+    unique?: boolean;
+    email?: boolean; // Allowed Types : string
+    validatorFun?: Function;
+}
+
+export interface IPropertyConversion {
+    trimStart?: boolean;
+    trimEnd?: boolean;
+    trim?: boolean;
+    toLowerCase?: boolean;
+    toUpperCase?: boolean;
+    conversionFun?: Function;
+
+    /** enable encryption for this property */
+    encryption?: boolean | IEncryptionDescription;
+
+    /** enable description for this property */
+    // decryption?: boolean | IEncryptionDescription;
+
+    /** enable hashing for this property */
+    hashing?: boolean | IPropertyHashing;
+}
+
+export interface IEncryptionDescription {
+    /** by default is DB for encryption and User for decryption. value will be encrypted while sending to DB | User */
+    sendingTo?: ESendingToSchema;
+
+    /** algorithm path within secret object. default: common.encryptionAlgorithm */
+    encryptionAlgorithm?: string;
+
+    /** secret path within secret object. default: common.secret */
+    secret?: string;
+
+    /** nonce path within secret object. default: common.nonce, common.secret */
+    nonce?: string;
+}
+
+export interface IPropertyHashing {
+
+    /** by default is DB for encryption and User for decryption. value will be encrypted while sending to DB | User */
+    sendingTo?: ESendingToSchema;
+
+    /** algorithm path within secret object. default: common.hashingAlgorithm */
+    hashingAlgorithm?: string;
+
+    /** secret path within secret object. default: common.secret */
+    secret?: string;
+}
+
+export enum ESendingToSchema {
+    DB = 'DB',
+    USER = 'USER',
+}
+
+export interface IDownloadResponse {
+    __am__downloadFolderFileName?: string; // ex: hello.txt // override file name for download
+    __am__downloadFilePath?: string; // my.zip | hello.txt // mostly it should be random number // give original file name which we created in uploads folder.
+    __am__downloadFileOrFolderPaths?: string | string[] | { fsSource: string; archiveDestination: string }[];
+    __am__cleanupFileOrFolderPaths?: string | string[]; // once file or zip sent to user, remove these files/folders from uploads directory.
+}
+
+export enum ESpecialParamKeyNames {
+    path = 'path', // it will be used in file upload or download in ftp/s3/azure and engine will try to fetch file name with extension to throw for download with name & extension
+}
+
+// Below interface is used in Secret Management.
+export interface ISecretType {
+    common?: ISecretTypeCommon; // it is general purpose secret key section.
+}
+
+export interface ISecretTypeCommon extends Pick<IAuthTokenInfoCommon, 'authTokenInfo'> {
+    hashingAlgorithm?: 'SHA256'; // change in IPropertyHashing also
+    nonce?: string; // if it is available, it will be used for hashing, if not available secret will be used for hashing
+
+    encryptionAlgorithm?: 'AES' | 'RC4' | 'TRIPLEDES'; // encryptionAlgorithm  // encryptionAlgorithmDBPersist
+    secret?: string; // secret // secretDBPersist
+
+    encryptionAlgorithmFETransfer?: 'AES' | 'RC4' | 'TRIPLEDES'; // encryption algo used to decrypt data sent by FE.
+    secretFETransfer?: string; // secret used to decrypt data sent by FE.
+    feTransferDataValidityInSeconds?: number; // to validate value of createdAt // to (now - createdAt) > this value, means payload is invalid.
+
+    connectionString: {
+        mongodb?: string;
+        mysql?: string;
+        mariadb?: string;
+        sqlServer?: string;
+        postgreSQL?: string;
+        oracle?: string;
+    }
+}
+
+export interface IAuthTokenInfo {
+    authTokenType?: EAuthTokenType;
+    authTokenAM?: IAuthTokenAM | IRefreshTokenAM;
+    authTokenAMDB?: IAuthTokenAMDB | IRefreshTokenAM;
+
+    authTokenAWS?: IAuthTokenAWS;
+    authTokenAzureAD?: IAuthTokenAzureAD;
+    authTokenGoogle?: IAuthTokenGoogle;
+    testObj?: any;
+}
+
+export interface IAuthTokenAM {
+    u: string;
+    p: string;
+}
+
+export interface IRefreshTokenAM {
+    refresh_token: string;
+}
+
+export interface IAuthTokenAMDB extends Partial<IAuthTokenAM> {
+    instance?: string; // it will be instance name
+    database?: string;
+    collection?: string;
+    table?: string;
+    usernameColumn?: string;
+    passwordColumn?: string;
+    /** column name which holds values of, comma separated groups assigned to this db user. * = means all groups of api user. DB user can hit API if he/she has access in any of these groups. */
+    groupsColumn?: string;
+    countOfUsersForTesting?: number; // load these much users in dropdown.
+
+    condition?: any;
+    sortUsersForTesting?: any; // sorting condition for dropdown
+    select?: any;
+
+    __amDBRequestData?: string; // we will stringify request JSON and set in this field.
+}
+
+export interface IAuthTokenAWS extends IAuthTokenGroupsProperties {
+    cognitoUserPoolId: string;
+    region: string;
+    tokenUse: 'access' | 'id'; // Possible Values: access | id
+    tokenExpiration: number; // Up to default expiration of 1 hour (3600000 ms)
+}
+
+export interface IAuthTokenAzureAD extends IAuthTokenGroupsProperties{
+    /** client_id */
+    appId: string;
+    tenant: string;
+
+    audience: string;
+    issuer: string;
+    maxRetries: number;
+}
+
+export interface IAuthTokenGroupsProperties {
+    sourceFieldOfUniqueId?: string;
+    groupsDataSource?: {
+        instance: string;
+        database: string;
+        collection?: string;
+        table?: string;
+        targetFieldForUniqueId: string;
+        groupsColumn: string;
+        select?: any;
+    };
+}
+
+export interface IAuthTokenGoogle extends IAuthTokenGroupsProperties {
+    clientId: string;
+}
+
+export interface IConnectionOptions {
+    title: '', // title of the option
+    text?: '', // description of the connection option
+    sample?: '' // sample connection string of that option
+}
+
+export interface IResponseError {
+    type?: EErrorType;
+    field?: string;
+    message?: string;
+    action?: string; // we can give message in this to solve this error or issue.
+    value?: any;
+    code?: EStatusCode;
+    systemMessage?: string;
+    dataIndex?: number;
+    stack?: any; // it might be present.
+    apiCallSequence?: string[];
+}
+
+export enum EApiPaths {
+    API = '/api',
+    GEN = '/gen',
+    SCHEMA = '/schema',
+    THIRD_PARTY = '/third-party',
+    THIRD_PARTY_STORE = '/third-party-store',
+    CUSTOM_API = '/custom-api',
+    SYSTEM_API = '/system-api',
+    SITES = '/sites',
+
+    // test--hook is hard coded in eval utils so please change that also if changing.
+    TEST_HOOK = '/test--hook', // it is special url for custom api for hook to test hook code.
+    ENCRYPT_DATA = '/encrypt-data',
+    DECRYPT_DATA = '/decrypt-data',
+    HASH_DATA = '/hash-data',
+    GET_TOKEN = '/token',
+    CALL_EXTERNAL_API = '/call-external-api',
+    EXECUTE_PLAIN_QUERY = '/execute-plain-query', // it is special url for executing
+    GET_SECRET_BY_NAME = '/get-secret-by-name', // it is special url for executing
+    GET_REDIS_KEY = '/get-redis-key',
+    SET_REDIS_KEY = '/set-redis-key',
+    REMOVE_REDIS_KEY = '/remove-redis-key',
+    RESET_REDIS_CACHE_DB = '/reset-redis-cache-db',
+    RESET_REDIS_CACHE_CUSTOM_APIS = '/reset-redis-cache-custom-apis',
+    RESET_REDIS_CACHE_SYSTEM_APIS = '/reset-redis-cache-system-apis',
+    RESET_REDIS_CACHE_TP_APIS = '/reset-redis-cache-third-party-apis',
+
+    GET_TABLE_META = '/get-table-meta', // get table meta data for sql databases in some common format.
+    EMIT_EVENT = '/emit-event',
+    EMIT_EVENT_WS = '/emit-event-ws',
+
+    // validations
+    IS_VALID_DATA_FOR_TABLE = '/is-valid-data-for-table',
+    IS_VALID_DATA_FOR_CUSTOM_API = '/is-valid-data-for-custom-api',
+    IS_VALID_DATA_FOR_THIRD_PARTY_API = '/is-valid-data-for-third-party-api',
+}
+
+export interface IQueryFormat {
+    find?: any;
+    find_join?: IFindJoinFormat[];
+    sort?: any;
+    skip?: number;
+    limit?: number;
+    select?: any;
+    deep?: IApiParamsDeepFormat[] | string[] | string; // do not use it, it will return old cached obj because of caching so do not use it.
+    set?: any; // It will be used for bulk update.
+    groupBy?: any; // it is used in mysql query
+    updateData?: any; // it is used in updateMany API
+    getTotalCount?: boolean; // return total count if it's value is true.
+    [key: string]: any;
+}
+
+export interface IApiParamsDeepFormat {
+    s_key: string;
+    // t_apiPath?: string;
+    t_instance?: string;
+    t_db?: string;
+    t_col?: string;
+    t_key?: string;
+    deep?: IApiParamsDeepFormat[] | string[] | string;
+    select?: any;
+
+    // below are additional feature properties newly added to give more flexibility in populate.
+    isMultiple?: boolean;
+    find?: any;
+    sort?: any;
+
+    // skip & limit can not be supported directly in query, because query is in query with all the ids of array.
+    // We process skip & limit while setting multiple data.
+    skip?: number;
+    limit?: number;
+}
+
+export interface IDeepFormat extends IApiParamsDeepFormat {
+    // below is used in deep
+    selectFromNextDeep?: any;
+}
+
+export interface IFindJoinFormat {
+    t_instance?: string;
+    t_db?: string;
+    t_col: string;
+    find: any;
+
+    find_key_target?: string; // after find, put list of ids in this key of find // ex: address.country, address
+    find_id_source?: string; // get ids from this source key instead of find property // ex: address.country
+    sourceTablePrimaryKey?: string; // it will be present when user defines column in source/parent table schema. We will use it instead of child table primary key.
+}
+
+// It is used internally & for users also.
+/**
+ * Create array of this interface in schema.
+ * It will be validated on every update/save
+ */
+export interface IDataValidation {
+    name?: string;
+    paths: string[];
+    type: EDataValidationType;
+    errorMessage?: string | any; // This string will be return to user if it is available.
+}
+
+export enum EDataValidationType {
+    SUPER_KEY = 'SUPER_KEY', // this combination of keys should be unique, Make sure they are required field.
+}
+
+export enum EStatusCode {
+    OK = 200,
+    NO_CONTENT = 204, // do not use this because it will not send our data with null.
+    CREATED = 201,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403, // client is authenticated but doesn't have access plus CORS error
+    RESOURCE_NOT_FOUND = 404, // convert 405(Method not allowed) in this 404.
+    INTERNAL_SERVER_ERROR = 500,
+}
+
+export interface ICallApiFromBackend {
+    url: string;
+    method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
+    timeout?: number;
+    body?: any;
+    queryParams?: any;
+    headers?: any;
+    id?: string;
+    preProcess?: ICallApiFromBackendDataProcess[];
+    postProcess?: ICallApiFromBackendDataProcess[];
+    output?: any;
+}
+
+export interface ICallApiFromBackendDataProcess {
+    from?: string; // '1.resp.id'
+    to?: string; // 'body.orderId'
+}
+
+export interface ICallApiFromBackendProcess {
+    type: EApiCallType,
+    data: ICallApiFromBackendProcess | ICallApiFromBackend[];
+}
+
+export enum EApiCallType {
+    parallel = 'parallel',
+    sequential = 'sequential',
+}
+
+export interface IArrayOperationBody {
+    find: any;
+    select?: any;
+    operations: IArrayOperation[];
+}
+
+export interface IArrayOperation {
+    operation?: EArrayOperation;
+    path?: string;
+    dataToPush?: any[]; // $push, used for push operation. Array/Object of data to pushe in array.
+    queryToRemove?: any; // $pull, query to remove docs from array.
+    dataToPull?: any[]; // $pullAll, array of items which will be removed from array.
+    direction?: -1 | 1; // $pop, -1 remove first, 1 remove last.
+    position?: number; // $push, used in push. If dataToPush is array we can use it with $each operator.
+    slice?: number; // $push, must use with $each, used in push. positive = remove that much elements from front of array. negative = remove items from end of array
+    sort?: number; // $push, must use with $each, used in push.
+    dataToSet?: any; // object to be passed in $set operator
+    arrayFilters?: any[]; // array of objects, to be used to filter array items and set values of $set operator.
+    upsert?: boolean; // if value not found in $set operation it will insert new value there.
+}
+
+export interface IGetTokenResponse {
+    token: string;
+    refresh_token: string;
+    expires_in: number; // in seconds
+}
+
+export interface IAuthTokenInfoCommon {
+    apiAccessType?: EAPIAccessType; // api level setting
+    authTokenInfo?: IAuthTokenInfo[] | string; // string will point to secret path.
+}
+
+export interface IInstanceApiSettingsTypes extends IAuthTokenInfoCommon {
+    enableCaching?: boolean; // collection level setting
+    acceptOnlyEncryptedData?: boolean; // database & collection & api level setting
+}
+
+export type IInstanceApiSettingsTypesForAPI = Omit<IInstanceApiSettingsTypes, 'enableCaching'>;
+
+export interface ITPApiSettingsTypes extends IAuthTokenInfoCommon {
+    enableCaching?: boolean; // collection level setting
+    resetCacheOnModificationOf?: string[]; // ins.db.col | api_bundle.version
+    acceptOnlyEncryptedData?: boolean; // database & collection & api level setting
+}
+
+export type ITPApiSettingsTypesAPILevel = Omit<ITPApiSettingsTypes, 'enableCaching' | 'resetCacheOnModificationOf'>;
+
+export interface ICustomApiSettingsTypes extends IAuthTokenInfoCommon {
+    name: string;
+    // label: string;
+    path: string;
+    requestMethod: ERequestMethod;
+    enableCaching?: boolean; // collection level setting
+    resetCacheOnModificationOf?: string[]; // ins.db.col | api_bundle.version
+    acceptOnlyEncryptedData?: boolean; // database & collection & api level setting
+
+    reqBodySchema?: ISchemaType;
+    reqQueryParametersSchema?: ISchemaType;
+
+    /**
+     * 👉 If true, code will execute on original Node.js process and not in sandbox.<br/>
+     * 👉 It makes code execution fast, Do not use it if you don't know what you are doing.<br/>
+     * 👉 Bad code can make entire server freeze and give weird behaviour.<br/>
+     * 👉 So, it can not use sandbox packages.<br/>
+     * 👉 It can use Node.js inbuilt packages.<br/>
+     * 👉 It can use packages from package.json of api_maker_be.<br/>
+     * 👉 You can use all features of global variable 'g'.<br/>
+     */
+    runOnNativeProcess?: boolean;
+
+    // calculated property
+    errorList: string[]; // list of all errors thrown by this API.
+    pathAndRequestMethod?: string;
+}
+
+export interface ISystemApiSettingsTypes extends IAuthTokenInfoCommon {
+    enableCaching?: boolean; // collection level setting
+    acceptOnlyEncryptedData?: boolean; // database & collection & api level setting
+}
+
+export enum EAuthTokenType {
+    AM = 'AM', // API Maker user token
+    AM_DB = 'AM_DB', // User database entry
+    GOOGLE = 'GOOGLE',
+    AWS = 'AWS',
+    AZURE = 'AZURE',
+    // GITHUB = 'GITHUB',
+    // FACEBOOK = 'FACEBOOK',
+    // TWITTER = 'TWITTER',
+}
+
+export enum EArrayOperation {
+    push = 'push',
+    addToSet = 'addToSet',
+    pull = 'pull',
+    pullAll = 'pullAll',
+    pop = 'pop',
+    set = 'set',
+}
+
+export enum EAPIAccessType {
+    IS_PUBLIC = 'IS_PUBLIC',
+    TOKEN_ACCESS = 'TOKEN_ACCESS',
+}
+
+export interface IAMGlobalSys {
+    db: ICommonApisSchema;
+    system: IAMGlobalSysSystem;
+    cache: IAMGlobalSysCache;
+}
+
+export interface ICommonApisSchema {
+    gen: ICommonApisGen;
+    /**
+     * => Returns [an array of objects].
+     */
+    getAll<T>(query: IApiParamsGetAll): Promise<T[] | null>;
+    getAll<T>(query: IApiParamsGetAll, getFullResponse: boolean): Promise<IAPIResponse<T[] | null>>;
+
+    getAllByStream<T>(query: IApiParamsGetAll, callback: (data: T) => void): Promise<void>;
+    /**
+     * => Returns [a single object].
+     */
+    getById<T>(query: IApiParamsGetById): Promise<T>;
+    getById<T>(query: IApiParamsGetById, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a object] or [an array of objects].
+     */
+    saveSingleOrMultiple<T>(query: IApiParamsSave): Promise<T | T[]>;
+    saveSingleOrMultiple<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+    /**
+     * => Returns [a object] or [an array of objects].
+     */
+    masterSave<T>(query: IApiParamsSave): Promise<T | T[]>;
+    masterSave<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+
+    arrayOperations<T>(query: IArrayOperationBody & IAMGlobalBaseParams): Promise<T>;
+    arrayOperations<T>(query: IArrayOperationBody & IAMGlobalBaseParams, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a single object].
+     */
+    updateById<T>(query: IApiParamsUpdate): Promise<T>;
+    updateById<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [updatedRowsCount].
+     */
+    updateMany(query: IApiParamsUpdateMany): Promise<IUpdateManyAPIResponse>;
+    updateMany(query: IApiParamsUpdateMany, getFullResponse: boolean): Promise<IAPIResponse<IUpdateManyAPIResponse>>;
+    /**
+     * => Returns [a single object].
+     */
+    replaceById<T>(query: IApiParamsUpdate): Promise<T>;
+    replaceById<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a single object].
+     */
+    removeById<T>(query: IApiParamsRemove): Promise<T>;
+    removeById<T>(query: IApiParamsRemove, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    removeByQuery<T>(query: Pick<IApiParamsQuery, 'instance' | 'database' | 'collection' | 'find' | 'headers'>): Promise<T>;
+    removeByQuery<T>(query: Pick<IApiParamsQuery, 'instance' | 'database' | 'collection' | 'find' | 'headers'>, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [an array of objects].
+     */
+    query<T>(query: IApiParamsQuery): Promise<T[]>;
+    query<T>(query: IApiParamsQuery, getFullResponse: boolean): Promise<IAPIResponse<T[]>>;
+
+    queryByStream<T>(query: IApiParamsQueryStream, callback: (data: T) => void): Promise<void>;
+
+    aggregate(query: IApiParamsAggregate): Promise<any>;
+    aggregate(query: IApiParamsAggregate, getFullResponse: boolean): Promise<IAPIResponse<any>>;
+
+    count(query: IApiParamsCount): Promise<number>;
+    count(query: IApiParamsCount, getFullResponse: boolean): IAPIResponse<number>;
+
+    distinct(query: Omit<IApiParamsDistinct, 'find'>): Promise<any[]>;
+    distinct(query: Omit<IApiParamsDistinct, 'find'>, getFullResponse: boolean): Promise<IAPIResponse<any[]>>;
+
+    distinctQuery(query: IApiParamsDistinct): Promise<any[]>;
+    distinctQuery(query: IApiParamsDistinct, getFullResponse: boolean): Promise<IAPIResponse<any[]>>;
+}
+
+export interface ICommonApisGen {
+    /**
+     * => Returns [an array of objects].
+     */
+    getAllGen<T>(query: IApiParamsGetAll): Promise<T[] | null>;
+    getAllGen<T>(query: IApiParamsGetAll, getFullResponse: boolean): Promise<IAPIResponse<T[] | null>>;
+
+    getAllByStreamGen<T>(query: IApiParamsGetAll, callback: (data: T) => void): Promise<void>;
+    /**
+     * => Returns [a single object].
+     */
+    getByIdGen<T>(query: IApiParamsGetById): Promise<T>;
+    getByIdGen<T>(query: IApiParamsGetById, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a object] or [an array of objects].
+     */
+    saveSingleOrMultipleGen<T>(query: IApiParamsSave): Promise<T | T[]>;
+    saveSingleOrMultipleGen<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+    /**
+     * => Returns [a object] or [an array of objects].
+     */
+    masterSaveGen<T>(query: IApiParamsSave): Promise<T | T[]>;
+    masterSaveGen<T>(query: IApiParamsSave, getFullResponse: boolean): Promise<IAPIResponse<T | T[]>>;
+
+    arrayOperationsGen<T>(query: IArrayOperationBody & IAMGlobalBaseParams): Promise<T>;
+    arrayOperationsGen<T>(query: IArrayOperationBody & IAMGlobalBaseParams, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a single object].
+     */
+    updateByIdGen<T>(query: IApiParamsUpdate): Promise<T>;
+    updateByIdGen<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [updatedRowsCount].
+     */
+    updateManyGen(query: IApiParamsUpdateMany): Promise<IUpdateManyAPIResponse>;
+    updateManyGen(query: IApiParamsUpdateMany, getFullResponse: boolean): Promise<IAPIResponse<IUpdateManyAPIResponse>>;
+    /**
+     * => Returns [a single object].
+     */
+    replaceByIdGen<T>(query: IApiParamsUpdate): Promise<T>;
+    replaceByIdGen<T>(query: IApiParamsUpdate, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [a single object].
+     */
+    removeByIdGen<T>(query: IApiParamsRemove): Promise<T>;
+    removeByIdGen<T>(query: IApiParamsRemove, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    removeByQueryGen<T>(query: Pick<IApiParamsQuery, 'instance' | 'database' | 'collection' | 'find'>): Promise<T>;
+    removeByQueryGen<T>(query: Pick<IApiParamsQuery, 'instance' | 'database' | 'collection' | 'find'>, getFullResponse: boolean): Promise<IAPIResponse<T>>;
+    /**
+     * => Returns [an array of objects].
+     */
+    queryGen<T>(query: IApiParamsQuery): Promise<T[]>;
+    queryGen<T>(query: IApiParamsQuery, getFullResponse: boolean): Promise<IAPIResponse<T[]>>;
+
+    queryByStreamGen<T>(query: IApiParamsQueryStream, callback: (data: T) => void): Promise<void>;
+
+    aggregateGen(query: IApiParamsAggregate): Promise<any>;
+    aggregateGen(query: IApiParamsAggregate, getFullResponse: boolean): Promise<IAPIResponse<any>>;
+
+    countGen(query: IApiParamsCount): Promise<number>;
+    countGen(query: IApiParamsCount, getFullResponse: boolean): IAPIResponse<number>;
+
+    distinctGen(query: Omit<IApiParamsDistinct, 'find'>): Promise<any[]>;
+    distinctGen(query: Omit<IApiParamsDistinct, 'find'>, getFullResponse: boolean): Promise<IAPIResponse<any[]>>;
+
+    distinctQueryGen(query: IApiParamsDistinct): Promise<any[]>;
+    distinctQueryGen(query: IApiParamsDistinct, getFullResponse: boolean): Promise<IAPIResponse<any[]>>;
+}
+
+export interface IAMGlobalSysSystem {
+    encrypt(body: any): Promise<string>;
+    encrypt(body: any, getFullResponse: boolean): Promise<string>;
+    encrypt(body: any, algorithm: EEncryptionAlgorithm, pass: string): Promise<string>;
+    encrypt(body: any, algorithm: EEncryptionAlgorithm, pass: string, getFullResponse: boolean): Promise<string>;
+
+    decrypt(body: string): Promise<any>;
+    decrypt(body: string, getFullResponse: boolean): Promise<string>;
+    decrypt(body: string, algorithm: EEncryptionAlgorithm, pass: string): Promise<any>;
+    decrypt(body: string, algorithm: EEncryptionAlgorithm, pass: string, getFullResponse: boolean): Promise<string>;
+
+    hash(body: any): any;
+    getSecret(name: string | string[], fromSecretName: string, getFullResponse: boolean): any;
+    getSecret(name: string | string[], fromSecretName: string): any;
+    getSecret(name: string | string[], getFullResponse: boolean): any;
+    getSecret(name: string | string[]): any;
+    getSecret(): any; // we can call it without any param also, in store and in tp it will return object of that part.
+    callExternalApi<T>(data: ICallApiFromBackend | ICallApiFromBackend[] | ICallApiFromBackendProcess | ICallApiFromBackendProcess[] | (ICallApiFromBackend | ICallApiFromBackendProcess)[]): Promise<ICallExternalApiResp<T>>;
+    callExternalApi(data: ICallApiFromBackend | ICallApiFromBackend[] | ICallApiFromBackendProcess | ICallApiFromBackendProcess[] | (ICallApiFromBackend | ICallApiFromBackendProcess)[]): Promise<ICallExternalApiResp<any>>;
+    getToken(data: IAuthTokenInfo | IAuthTokenInfo[]): any;
+    executeQuery(query: IExecuteQuery): any;
+    /**
+     * It should be used SQL based databases only.
+     * In MongoDB You can just modify schema. but we can use for mongo also.
+     */
+    getTableMeta(data: Omit<IAMGlobalBaseParams, 'headers'>): any;
+    emitEvent<D>(eventName: string, eventData?: D, executeListeners?: string[]): Promise<IEmitEvent<D>>;
+    emitEventWS<D>(eventName: string, eventData?: D): Promise<void>;
+
+    // data validation
+    isValidDataForTable(data: IIsValidDataForTable): Promise<IResponseError[]>;
+    isValidDataForTable(data: IIsValidDataForTable[]): Promise<IResponseError[][]>;
+    isValidDataForTable(data: IIsValidDataForTable, getFullResponse: boolean): Promise<IResponseError[]>;
+    isValidDataForTable(data: IIsValidDataForTable[], getFullResponse: boolean): Promise<IResponseError[][]>;
+
+    isValidDataForCustomAPI(data: IIsValidDataForCustomAPI): Promise<IResponseError[]>;
+    isValidDataForCustomAPI(data: IIsValidDataForCustomAPI[]): Promise<IResponseError[][]>;
+    isValidDataForCustomAPI(data: IIsValidDataForCustomAPI, getFullResponse: boolean): Promise<IResponseError[]>;
+    isValidDataForCustomAPI(data: IIsValidDataForCustomAPI[], getFullResponse: boolean): Promise<IResponseError[][]>;
+
+    isValidDataForThirdPartyAPI(data: IIsValidDataForThirdPartyAPI): Promise<IResponseError[]>;
+    isValidDataForThirdPartyAPI(data: IIsValidDataForThirdPartyAPI[]): Promise<IResponseError[][]>;
+    isValidDataForThirdPartyAPI(data: IIsValidDataForThirdPartyAPI, getFullResponse: boolean): Promise<IResponseError[]>;
+    isValidDataForThirdPartyAPI(data: IIsValidDataForThirdPartyAPI[], getFullResponse: boolean): Promise<IResponseError[][]>;
+}
+
+export interface ICallExternalApiResp<T> {
+    statusCode: number;
+    headers: any;
+    body: T;
+}
+
+export interface IAMGlobalSysCache {
+    getKey(name: string | string[]): any;
+    setKey(name: string | ISetRedisInternalRequestObj[], value?: string, ttlSeconds?: number): any;
+    removeKey(name: string | string[]): any;
+    resetCacheDB(params: IResetRedisCacheDB): any;
+    resetCacheCustomApis(name: string): any;
+    resetCacheSystemApis(name: string): any;
+    resetCacheThirdPartyApis(params: IResetRedisCacheTP): any;
+}
+
+export enum EEncryptionAlgorithm {
+    AES = 'AES',
+    RC4 = 'RC4',
+    TRIPLEDES = 'TRIPLEDES',
+}
+
+export enum EHashingAlgorithms {
+    SHA256 = 'SHA256',
+}
+
+export interface IThirdPartyAPIIdentity {
+    apiBundleName: string; // npmPackageName // apiBundleName
+    // developedByUsername: string;
+    apiVersionName: string;
+    name: string;
+}
+
+export interface ICollectionIdentity {
+    instance: string;
+    database?: string;
+    collection?: string;
+    table?: string;
+    /**
+     * If true, it will not throw cycle error.<br/>
+     * true = Default in custom APIs, schedulers, third party APIs, migration scripts, test cases, because they can not call themselves.<br/>
+     * false = Default in Events & pre hooks & post hooks.<br/>
+     * If utility class is called from default true category like custom API, it is true, otherwise false.<br/>
+     */
+    noCycle?: boolean;
+
+    /**
+     * If true, it will skip pre hook & post hook running.
+     */
+    skipHookRunning?: boolean;
+}
+
+export interface IAMGlobalBaseParams extends ICollectionIdentity {
+    headers?: any;
+}
+
+export interface IApiParamsGetAll extends IAMGlobalBaseParams {
+    queryParams?: IGetAllQueryParams;
+}
+
+export interface IGetAllQueryParams {
+    find?: any;
+    skip?: number;
+    limit?: number;
+    sort?: any;
+    select?: any;
+    deep?: IApiParamsDeepFormat[] | string[] | string;
+    getTotalCount?: boolean;
+    [key: string]: any;
+}
+
+export interface IApiParamsGetById extends IAMGlobalBaseParams {
+    id: any;
+    primaryKey?: string;
+    select?: any;
+}
+
+export interface IApiParamsSave extends IAMGlobalBaseParams {
+    saveData?: any; // used to save data in db.
+}
+
+export interface IApiParamsQueryStream extends IAMGlobalBaseParams {
+    find?: any;
+    sort?: any;
+    skip?: number;
+    limit?: number;
+    select?: any;
+    deep?: IApiParamsDeepFormat[] | string[] | string; // do not use it, it will return old cached obj because of caching so do not use it.
+    groupBy?: any; // it is used in mysql query
+    updateData?: any;
+}
+
+export interface IApiParamsQuery extends IApiParamsQueryStream {
+    getTotalCount?: boolean;
+}
+
+export interface IApiParamsCount extends IAMGlobalBaseParams {
+    find?: any;
+}
+
+export interface IApiParamsUpdate extends IAMGlobalBaseParams {
+    id?: any;
+    updateData?: any; // It will be used for bulk update.
+    primaryKey?: string;
+    upsert?: boolean; // insert if item not available.
+    returnDocument?: string; // return old doc if 'before', 'before' | 'after'
+    select?: any; // to select which rows will return in response.
+}
+
+export interface IApiParamsUpdateMany extends IAMGlobalBaseParams {
+    find: any;
+    updateData: any;
+}
+
+export interface IApiParamsAggregate extends IAMGlobalBaseParams {
+    aggregateQuery?: any; // It will be used for aggregate body
+}
+
+export interface IApiParamsRemove extends IAMGlobalBaseParams {
+    id?: any;
+    primaryKey?: string;
+    select?: any;
+}
+
+export interface IApiParamsDistinct extends IAMGlobalBaseParams {
+    distinctField: string;
+    order?: 'asc' | 'desc' | any; // asc/desc/dsc , true/false, yes/no, 1/0
+    find?: any; // not supported by mongoDB, and supported in SQL dbs.
+}
+
+export interface IExecuteQuery {
+    instance: string;
+    database?: string; // required for postgresql, mongodb only
+    collection?: string; // required for mongodb only
+    query: string | {
+        find: any;
+        sort?: any;
+        skip?: number;
+        limit?: number;
+        select?: any;
+    };
+    headers?: any;
+}
+
+export interface IEncryptDecryptDataRequest {
+    data: string;
+    algorithm?: EEncryptionAlgorithm;
+    pass?: string;
+}
+
+export interface IDecryptDataFETransfer {
+    dataEncFE: string;
+}
+
+export interface IDecryptDataFETransferPayload {
+    data: any;
+    createdAt: Date;
+}
+
+// it can be value or TTL
+export interface ISetRedisInternalRequestObj {
+    key: string;
+    value?: string;
+    ttl?: number; // in seconds
+}
+
+export interface IResetRedisCacheDB extends ICollectionIdentity {
+}
+
+export interface IResetRedisCacheTP {
+    apiBundleName: string;
+    apiVersionName?: string;
+}
+
+export interface IGetSecretInternalRequestBody {
+    keys: string | string[];
+    fromSecretName?: string;
+    parentParams?: IAMGlobalBaseParams; // it will be present
+}
+
+export interface IEmitEvent<D> {
+    name: string;
+    eventData?: D;
+    executeListeners?: string[];
+    outputArr?: [{ listenerName: string; output: any; }];
+    executedEvents?: IExecutedEvents;
+}
+
+export interface IEmitEventWS<D> {
+    name: string;
+    eventData?: D;
+}
+
+export interface IUpdateManyAPIResponse {
+    /** When actual update operation happens, it has value greater than 0 */
+    updatedRowsCount: number;
+}
+
+export interface IAPIResponse<T> {
+    data?: T;
+    totalCount?: number;
+    encryptedData?: string;
+    errors?: IResponseError[];
+    logs?: any[];
+    meta?: IAPIResponseMeta;
+    stackTraceErrors?: any[];
+    statusCode: EStatusCode;
+    success: boolean;
+    warnings?: IResponseError[];
+}
+
+// WebSocket connection response format.
+export interface IWSResponse {
+    type: EWSObjectType;
+    response?: IWSRegisterResponse | IWSConnectedResponse | IWSUnregisterResponse | IWSNotificationResponse;
+    errors?: IResponseError[];
+}
+
+export interface IWSRegisterResponse {
+    validOnEvents: IWSRegisterOnEvent[];
+    invalidOnEvents: IWSRegisterOnEvent[];
+}
+
+export interface IWSConnectedResponse {
+    connected?: boolean;
+}
+
+export type IWSUnregisterResponse = IWSObject;
+
+export interface IWSNotificationResponse {
+    eventId: string;
+    eventData: any;
+}
+
+export interface IAPIResponseMeta {
+    executionTime?: string;
+    executionPlan?: any[]; // IMongodbExplainPlan[];
+    apiAccessGroups?: IAPIAccessGroupMeta[];
+    runBy?: ICodeRunByResponse[];
+}
+
+export interface ICodeRunByResponse {
+    apiCategory: any; // EAPICategory enum value.
+    serverId: string;
+    processId: string;
+    workerId: string;
+    port: number;
+    publishToRedis?: boolean; // true = if request received by redis.
+}
+
+export interface IAPIAccessGroupMeta {
+    groupId?: string;
+    groupName?: string;
+    hasAccess?: boolean;
+}
+
+export interface IDeleteAPIResponse {
+    deletedRows: any[];
+    deletedRowsCount: number;
+    ids: any[];
+}
+
+export interface IExecutedEvents {
+    eventNameArr: string[];
+    eventNameMap: any;
+}
+
+export interface IIsValidDataForTable extends ICollectionIdentity {
+    data: any;
+    sendingTo?: 'SAVE' | 'UPDATE';
+}
+
+export type IIsValidDataForTable_KA = (keyof IIsValidDataForTable)[];
+
+export enum ECustomAPIDataValidationType {
+    BODY = 'BODY',
+    QUERY_PARAMS = 'QUERY_PARAMS',
+}
+
+export interface IIsValidDataForCustomAPI {
+    name: string;
+    data: any;
+    type: ECustomAPIDataValidationType;
+}
+
+export interface IIsValidDataForThirdPartyAPI extends IThirdPartyAPIIdentity {
+    data: any;
+    type: ECustomAPIDataValidationType;
+    isArray?: boolean;
+}
+
+export enum EWSEventType {
+    INSTANCES = 'INSTANCES',
+    THIRD_PARTY_APIS = 'THIRD_PARTY_APIS',
+    CUSTOM_APIS = 'CUSTOM_APIS',
+    SYSTEM_APIS = 'SYSTEM_APIS',
+    CUSTOM_WS_EVENTS = 'CUSTOM_WS_EVENTS',
+}
+
+export enum EWSObjectType {
+    REGISTER = 'REGISTER',
+    UNREGISTER = 'UNREGISTER',
+    CONNECTED = 'CONNECTED',
+    UNKNOWN = 'UNKNOWN',
+    TOKEN_VALIDATION = 'TOKEN_VALIDATION',
+    NOTIFICATION = 'NOTIFICATION',
+}
+
+export interface IWSObject {
+    guid: string;
+    objType: EWSObjectType;
+    onEvents: IWSRegisterOnEvent[];
+    validatedTokens: {
+        apiUser?: any; // IApiUser
+        amUser?: any; // IUser
+    }
+}
+
+export type IWSObject_P = Partial<IWSObject>;
+
+export interface IWSRegisterOnEvent {
+    eventId?: string; // it will be generated by BE and it is useful to unregister that specific event.
+    wsEventId?: string; // used in log saving. _id of IWebSocketEvents
+    eventType: EWSEventType;
+
+    // instance apis
+    instance?: string;
+    database?: string;
+    collection?: string;
+    table?: string;
+
+    // third party apis
+    apiBundleName?: string;
+    apiVersion?: string;
+
+    apiName: string;
+
+    condition?: IWSCondition; // receive event when this condition match.
+    select?: any; // select fields from objects after condition matched.
+    getEventData?: boolean; // if true we will send eventData based on select, otherwise we will not send eventData field in WS notifications
+
+    // calculated field. // user will not provide it.
+    eventData?: any;
+    apiPath: string; // user will not send it. We will set it from api user token. and user hit that get token system api to get token of specific admin.
+}
+
+export type IWSRegisterOnEvent_P = Partial<IWSRegisterOnEvent>;
+
+export interface IWSCondition {
+    conditionType: EWSConditionType;
+    criteria: any;
+}
+
+export enum EWSConditionType {
+    RESPONSE = 'RESPONSE',
+}
+
+export interface ITestCaseSuccess {
+    name?: string;
+    testCasePass: true;
+    smallTestCases?: ITestCaseResult[];
+}
+
+export interface ITestCaseFail {
+    name?: string;
+    testCasePass: false;
+    message?: string;
+    actual?: any; // variable value.
+    expected?: any; // variable value should be this expected value.
+    smallTestCases?: ITestCaseResult[];
+    stack?: any;
+    errors?: any;
+}
+
+export type ITestCaseResult = ITestCaseSuccess | ITestCaseFail; // _id is test case _id.
+
+export interface ITestCaseSandboxCode {
+    name: string;
+    code: Function;
+
+    // calculated fields while running
+    smallTestCasePass?: boolean;
+    error?: any; // it can be array of errors or single error. When coming from system API calls, it can be array.
+}
+
+export type ITestCaseSandboxCode_P = Partial<ITestCaseSandboxCode>;
+
+// ==== DB Master configurations Start ====
+
+export enum EDBMasterTheme {
+    BOOTSTRAP4_LIGHT_BLUE = 'bootstrap4-light-blue',
+    BOOTSTRAP4_LIGHT_PURPLE = 'bootstrap4-light-purple',
+    BOOTSTRAP4_DARK_BLUE = 'bootstrap4-dark-blue',
+    BOOTSTRAP4_DARK_PURPLE = 'bootstrap4-dark-purple',
+    MD_LIGHT_INDIGO = 'md-light-indigo',
+    MD_LIGHT_DEEPPURPLE = 'md-light-deeppurple',
+    MD_DARK_INDIGO = 'md-dark-indigo',
+    MD_DARK_DEEPPURPLE = 'md-dark-deeppurple',
+    MDC_LIGHT_INDIGO = 'mdc-light-indigo',
+    MDC_LIGHT_DEEPPURPLE = 'mdc-light-deeppurple',
+    MDC_DARK_INDIGO = 'mdc-dark-indigo',
+    MDC_DARK_DEEPPURPLE = 'mdc-dark-deeppurple',
+    FLUENT_LIGHT = 'fluent-light',
+    LARA_LIGHT_BLUE = 'lara-light-blue',
+    LARA_LIGHT_INDIGO = 'lara-light-indigo',
+    LARA_LIGHT_PURPLE = 'lara-light-purple',
+    LARA_LIGHT_TEAL = 'lara-light-teal',
+    LARA_DARK_BLUE = 'lara-dark-blue',
+    LARA_DARK_INDIGO = 'lara-dark-indigo',
+    LARA_DARK_PURPLE = 'lara-dark-purple',
+    LARA_DARK_TEAL = 'lara-dark-teal',
+    SOHO_LIGHT = 'soho-light',
+    SOHO_DARK = 'soho-dark',
+    VIVA_LIGHT = 'viva-light',
+    VIVA_DARK = 'viva-dark',
+    MIRA = 'mira',
+    NANO = 'nano',
+    SAGA_BLUE = 'saga-blue',
+    SAGA_GREEN = 'saga-green',
+    SAGA_ORANGE = 'saga-orange',
+    SAGA_PURPLE = 'saga-purple',
+    VELA_BLUE = 'vela-blue',
+    VELA_GREEN = 'vela-green',
+    VELA_ORANGE = 'vela-orange',
+    VELA_PURPLE = 'vela-purple',
+    ARYA_BLUE = 'arya-blue',
+    ARYA_GREEN = 'arya-green',
+    ARYA_ORANGE = 'arya-orange',
+    ARYA_PURPLE = 'arya-purple',
+    NOVA = 'nova',
+    NOVA_ALT = 'nova-alt',
+    NOVA_ACCENT = 'nova-accent',
+    LUNA_AMBER = 'luna-amber',
+    LUNA_BLUE = 'luna-blue',
+    LUNA_GREEN = 'luna-green',
+    LUNA_PINK = 'luna-pink',
+    RHEA = 'rhea',
+}
+
+export enum EDBMasterGridExport {
+    CSV = 'CSV',
+    CSV_SELECTED = 'CSV Selected',
+    // PDF = 'PDF',
+}
+
+export interface IDBMasterConfig {
+    theme?: EDBMasterTheme;
+
+    /** Default : false */
+    showThemeSelector?: boolean;
+
+    /**
+     * Default : browser timezone.
+     * Dates will be converted into this timezone before display in grid and sending to database query.
+     */
+    dateTimeZone?: string;
+
+    /**
+     * Default : 'dd-MM-yyyy hh:mm:ss a'
+     * System is using date-fns formats to format date object in grid cells.
+     * This format will be converted automatically for primeNG calendar control.
+     * It will not work when unsupported format options of primeNg calendar control are used.
+     *
+     * PrimeNG calendar does not support time format but it will be automatically appended.
+     * This format will be applicable to all Calendar control in UI.
+     */
+    dateTimeFormat?: string;
+
+    operations?: {
+        delete?: boolean;
+        edit?: boolean;
+        add?: boolean;
+
+        hideDeleteConfirmation?: boolean;
+        hideDeleteAllConfirmation?: boolean;
+        hideEditConfirmation?: boolean;
+        hideAddConfirmation?: boolean;
+    };
+    externalLibs?: {
+        css?: string[],
+        js?: string[],
+    },
+    cssCode?: {
+        runOn: 'header',
+        code: string,
+    }[],
+    jsCode?: {
+        appendTo: 'oncePageLoad' | 'gridRender' | 'modifyGridRequest',
+        /**
+         * // gridEvent, gridData are available to use.
+         *
+         * // Return promise for long awaiting tasks.
+         * new Promise(async (resolve, reject) => {
+         *     await new Promise(r => setTimeout(r, 3000));
+         *     gridData[0].name = 'Sample data';
+         *     resolve();
+         * });
+         *
+         * // Directly modify data of grid
+         * gridData[0].name = 'Sample data';
+         *
+         * // Return function
+         * (function setData() { gridData[0].name = 'Sample data'; } );
+         *
+         */
+        code: string,
+    }[],
+    grid?: {
+        header?: string;
+
+        /** Default : false */
+        showColumnSelector?: boolean;
+
+        /** Default : 50rem */
+        minWidth?: string;
+
+        /**
+         * If empty, it will generate grid for all fields of schema in schema order.
+         * It will not generate _id for Mongo DB.
+         */
+        fields?: IDBMasterConfigGridField[],
+
+        /**
+         * Ex1 : { name: 1 }
+         * Ex2 : { password : -1 }
+         * It supports syntax of select object in API Maker's query API.
+         * By default, all fields of database table will be selected.
+         */
+        selectFieldsForQuery?: {
+            [field: string]: 1 | -1
+        };
+
+        /**
+         * Default : 'single'. Default sorting is executed on a single column, in order to enable multiple field sorting,
+         * set sortMode property to "multiple" and use metakey(ctrl | cmd) when clicking on another column.
+         */
+        sortMode?: 'single' | 'multiple';
+
+        /**
+         * Ex : [{ field: 'name', order: 1 }]
+         * Useful to have columns sorted by default.
+         * To make it work, field should have enableSorting true.
+         */
+        multiSortMeta?: { field: string; order: -1 | 1 }[];
+
+        pagination?: {
+            /** Default : false */
+            showPagination?: boolean;
+
+            /** Default : false */
+            serverSidePagination?: boolean;
+
+            /** Default : 10 */
+            rowsPerPage?: number;
+
+            /** Default : [10, 20, 50, 100, 500, 1000] */
+            rowsPerPageOptions?: number[];
+        }
+
+        selection?: {
+            mode: 'single' | 'multiple';
+
+            /** name of primary key field. Default : it will be automatically pickup from schema. */
+            dataKey?: string;
+
+            /** Default : true, If true we need Ctrl | Cmd to select row. */
+            metaKeySelection?: boolean;
+
+            /** Default : false, Works only with mode=multiple. If true it will show checkbox column for selection. */
+            checkboxSelection?: boolean;
+        }
+
+        filter?: {
+            /** Default : false, if true you can filter in all fields */
+            showGlobalSearch?: boolean;
+
+            // country.name is supported by primeNG table.
+            /**
+             * Ex: ['name', 'first_name', 'country.name']
+             * It will work only for string & number fields.
+             * For string, it will check for contains and for number type, will be exact match query.
+             */
+            globalSearchFields?: string[];
+
+            /** Default : false, if true it will show filter for each column */
+            rowFilter?: boolean;
+        }
+    };
+    form?: {
+        /** Ex : 90vw */
+        width?: string;
+
+        /** If it is empty, and operation.add is true, then it will generate form based on schema with all fields. */
+        fields?: IDBMasterConfigFormField[][];
+    };
+
+    export?: {
+        csv?: boolean;
+        // pdf?: boolean;
+    }
+}
+
+export interface IDBMasterConfigGridFilterOfField {
+    matchMode: EDBMasterMatchMode;
+    value: string;
+}
+
+export enum EDBMasterMatchMode {
+    contains = 'contains',
+    notContains = 'notContains',
+    startsWith = 'startsWith',
+    endsWith = 'endsWith',
+    equals = 'equals',
+    notEquals = 'notEquals',
+
+    lt = 'lt',
+    lte = 'lte',
+    gt = 'gt',
+    gte = 'gte',
+
+    dateIs = 'dateIs',
+    dateIsNot = 'dateIsNot',
+    dateBefore = 'dateBefore',
+    dateAfter = 'dateAfter',
+}
+
+export interface IDBMasterConfigGridField {
+    header: string;
+    /** Database field name or path for nested objects. */
+    path?: string; // nested fields like 'country.name' is supported by primeNG grid
+
+    /** Default false, it will format dates in 'dd-MM-yyyy hh:mm:ss a' automatically if 'dateTimeFormat' is not provided. */
+    autoFormatDate?: boolean;
+
+    /** Default : browser timezone. Dates will be converted into this timezone before sending to database query. */
+    dateTimeZone?: string;
+
+    /** Default : 'dd-MM-yyyy hh:mm:ss a' . System is using date-fns formats to format date object. */
+    dateTimeFormat?: string;
+
+    /** Default : false, if true sorting will be enabled for this field. */
+    enableSorting?: boolean;
+}
+
+/** For internal use only. */
+export interface IDBMasterConfigGridFieldExport extends IDBMasterConfigGridField {
+    type: EType;
+
+    /** PrimeNG needs it for export purpose from grid. It should be present in [columns] */
+    field?: string;
+
+    /** Calculated property based on schema. Used to give type to <p-columnFilter>. */
+    filterType?: EDBMasterConfigFilterType;
+}
+
+export enum EDBMasterConfigFilterType {
+    text = 'text',
+    numeric = 'numeric',
+    boolean = 'boolean',
+    date = 'date',
+}
+
+export interface IDBMasterConfigFormField {
+    label: string;
+    path: string;
+    control: EDBMasterFormControl;
+
+    textAreaSettings?: {
+        rows?: number;
+        autoResize?: boolean;
+    }
+
+    datePickerSettings?: {
+        showSeconds?: boolean;
+        showTime?: boolean;
+        /** Default : 24 */
+        hourFormat?: '12' | '24';
+        dateTimeFormat?: string;
+
+        /**
+         * Default : date
+         * Update dateTimeFormat for 'month'(MM-yyyy) & 'year'(yyyy) values.
+         */
+        view?: 'date' | 'month' | 'year';
+    };
+
+    colorPickerSettings?: {
+        format?: 'hex' | 'rgb' | 'hsb';
+    };
+
+    dropdownSettings?: {
+        showClear?: boolean;
+        dataSource: 'static_data' | 'db_data'; // custom_code = We can call any API in that.
+
+        /** it will use used when dataSource is 'static_data'. */
+        staticData?: any[]; // { label: string; value: any; }[] works default.
+
+        dbData?: Partial<Pick<ICollectionIdentity, 'instance' | 'database' | 'collection' | 'table'>
+            & Pick<IQueryFormat, 'find' | 'select' | 'limit'>>;
+
+        /** Default : label */
+        optionLabel?: string;
+
+        /** Default : value */
+        optionValue?: string;
+
+        filter?: boolean;
+
+        /** one field or multiple comma separated fields are supported without any space in between. */
+        filterBy?: string;
+
+        filterMatchMode: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte';
+
+        /** Default : false, if true it will get latest data when form opens for add/edit operation. */
+        alwaysGetLatestDataOnFormOpen?: boolean;
+
+        /** Default : true, If false it will not be able to handle huge amount of data. */
+        virtualScroll?: boolean;
+
+        jsCode?: {
+            appendTo: 'onceDropdownDataLoaded',
+            /**
+             * // dropdownData is available to use.
+             *
+             * // Return promise for long awaiting tasks.
+             * new Promise(async (resolve, reject) => {
+             *     await new Promise(r => setTimeout(r, 3000));
+             *     dropdownData[0].name = 'Sample data';
+             *     resolve();
+             * });
+             *
+             * // Directly modify data of grid
+             * dropdownData[0].name = 'Sample data';
+             *
+             * // Return function
+             * (function setData() { dropdownData[0].name = 'Sample data'; } );
+             *
+             */
+            code: string,
+        }[],
+    };
+
+    autocompleteSettings?: {
+        dropdown?: boolean;
+    }
+}
+
+export enum EDBMasterFormControl {
+    input = 'input',
+    date_picker = 'date_picker',
+    textarea = 'textarea',
+    checkbox = 'checkbox',
+    color_picker = 'color_picker',
+    dropdown = 'dropdown',
+}
+
+// ==== DB Master configurations End ====