@optimiser/common 1.0.365 → 1.0.367

package/dist/lib/utility.d.ts

@@ -1,298 +1,300 @@
-import { Moment } from "moment";
-import { NextFunction, Response } from "express";
-import { ObjectId, Db } from "mongodb";
-import { ResponseStructure, OPT_ERROR } from "../modals/connection.modal";
-import { Express } from '../modals/log.modal';
-import { AnyObjectInterface, callBackInterface, GetEncryptedURLOptions } from "../modals/utility.modal";
-import { OPT_Request } from "../modals/connection.modal";
-import { Redis } from "ioredis";
-import 'moment-timezone';
-import { integer } from "aws-sdk/clients/cloudfront";
-declare function GetObjectByKeyValueFromList(list: AnyObjectInterface, key: string, val: any): any;
-declare function IsEqualArrays(a: [any] | [], b: [any] | []): boolean;
-declare function IsEqualValue(a: any, b: any): boolean;
-declare function AddDaysToDate(date: any, days: integer): Date;
-declare function CheckUserProfileField(pageData: AnyObjectInterface, profileData: AnyObjectInterface): void;
-declare function GetPageFieldData(pageName: string, db: any, mdb: any, msp_d: any, next: NextFunction, callback: callBackInterface): void;
-declare function GetPageObjectSchema(pageName: string, db: Db, next: NextFunction, callback: callBackInterface): void;
-declare function GetFieldDetail(objectName: string, fieldName: string, db: any, callback: callBackInterface, next: NextFunction): void;
-declare function UpdateRecentViewObject(objectName: string, objectID: ObjectId, userID: ObjectId, db: Db): void;
-declare function UpdateRecentViewFields(objectName: string, fieldID: string, userID: ObjectId, db: Db): void;
-declare function SyncChildObjectData(pageData: AnyObjectInterface, objectID: ObjectId, db: Db): Promise<void>;
-declare function SyncParentObjectData(pageData: AnyObjectInterface, objectID: ObjectId, db: Db): Promise<void>;
-/**
- * Delete field in other collection after delete records
- * @param objectName :  ObjectName of record to which we want to delete
- * @param objectIDs : ObjectId of the created records of above object name collection
- * @param db : database connection || Db
- * @param params :  It includes the object of remaining arguments passing here as an argument
- * @param params.isBuiltOnPromise : optional param need to send with params obj for to confirm function is used with promise or not!!
- * @param params.mongoQueryOpts :optional param sending with params obj for some specific mongodb query operation, to maintain session for transactions
- * @param comMasterDb : optional param sending to get it update and sync with master db.
- */
-declare function DeleteFieldInOtherCollection(objectName: string, objectIDs: ObjectId, db: Db, params?: AnyObjectInterface, comMasterDb?: Db): Promise<void>;
-declare function ReactivateFieldInOtherCollection(objectName: string, objectIDs: ObjectId, db: Db): void;
-declare function SyncFieldInSameCollection(objectName: string, objectIDs: ObjectId[], db: Db, comMasterDb?: Db): Promise<any>;
-declare function SyncFieldInSameCollectionByObjectID(objectName: string, objectID: ObjectId, db: Db): void;
-declare function SyncFieldInSameCollectionByObjectIDWithPromise(objectName: string, objectID: ObjectId, db: Db): Promise<any>;
-declare function SyncFieldInOtherCollection(syncFields: AnyObjectInterface[], db: Db): Promise<any>;
-/** Special Note: Need to create seachValue for it in QPC-6169.
-    I've not done yet, cause it was not calling from anywhere.
-*/
-declare function SyncUserInOtherCollection(options: AnyObjectInterface, db: Db, callback: callBackInterface, next: NextFunction): void;
-declare function GetObjectByString(o: any, s: any): any;
-declare function BuildLookupDataField(fieldSchema: AnyObjectInterface, updateObj: AnyObjectInterface, db: Db): Promise<void>;
-declare function CheckDataBeforeAdd(updateObj: AnyObjectInterface, objectSchema: AnyObjectInterface, db: Db): Promise<void>;
-declare function CheckDataBeforeUpdate(updateObj: AnyObjectInterface, objectData: AnyObjectInterface, objectSchema: AnyObjectInterface, db: Db): Promise<void>;
-declare function BuildGridFieldProjection(project: AnyObjectInterface, field: AnyObjectInterface, group?: AnyObjectInterface): void;
-declare function BuildFieldProjection(project: AnyObjectInterface, field: AnyObjectInterface, group: AnyObjectInterface): void;
-declare function BuildLookupFieldProjection(field: AnyObjectInterface, group: AnyObjectInterface, project: AnyObjectInterface, aggregateArry: AnyObjectInterface[]): void;
-declare function FilterConditions(condition: AnyObjectInterface, match: AnyObjectInterface, fields: AnyObjectInterface): void;
-declare function GirdHeaderFilters(filters: AnyObjectInterface, fields: AnyObjectInterface): {
-    $and: AnyObjectInterface[];
-} | undefined;
-declare function FieldsGridHeaderFilters(filters: AnyObjectInterface, fields: AnyObjectInterface): {
-    $and: AnyObjectInterface[];
-    lookupConditions: {
-        [x: number]: RegExp;
-    }[];
-};
-/** @desc:{
-    objectName: It's a name of Collection.
-    logAction: Add | Modify | Delete
-    objLogProp :{ // Its details of the object
-        ObjectID: Object Id
-        Data : Full Collection Object
-    }
-}*/
-declare function AddLog(req: OPT_Request, objectName: string, logAction: string, objLogProp: AnyObjectInterface, db: Db, next: NextFunction): void;
-declare function CheckFilterFieldsProjection(condition: AnyObjectInterface, fields: AnyObjectInterface, pageData: AnyObjectInterface, project: AnyObjectInterface): void;
-declare function VerifyEmailPassword(options: AnyObjectInterface, callback: callBackInterface): void;
-declare function GetMyTeamUsers(options: AnyObjectInterface, next: NextFunction): void;
-declare function ExtractChildUsersTree(userId: string, childUsersArray: AnyObjectInterface[], usersTraversed: string[], counter: number, db: Db, onFetch: callBackInterface): void;
-declare function GetMaxKeyValueListSchema(ListName: string, db: Db): Promise<any>;
-declare function VerifyAWSEmailConfig(mailData: AnyObjectInterface, callback: callBackInterface): void;
-declare function GenerateId(obj: AnyObjectInterface): void;
-declare function SyncUserDetailsWithMasterDB(userData: AnyObjectInterface, callback: CallableFunction, dbMaster: Db): void;
-declare function SignoutUserFromAllDevices(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): void;
-declare function SignoutUsersWithPromise(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): Promise<unknown>;
-declare function SignoutMultipleUsersFromAllDevices(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): void;
-declare function UserLicenseConsumeCalculate(options: AnyObjectInterface): void;
-declare function sendMailWithUserAccount(mailObj: AnyObjectInterface, files: AnyObjectInterface, userSettings: AnyObjectInterface): Promise<any>;
-declare function GetEmailClientConfigs(options: AnyObjectInterface): void;
-declare function GetCompanyEncryptionKey(options: AnyObjectInterface): void;
-declare function ExecuteDynamicDMLQuery(options: AnyObjectInterface): Promise<string>;
-declare function ExecuteDynamicDQLQuery(options: AnyObjectInterface): Promise<AnyObjectInterface>;
-declare function GetUserProfilePermissions(options: AnyObjectInterface): void;
-declare function MakeUserPasswordInvalid(options: AnyObjectInterface): void;
-declare function ConvertJsonToXLXS(data: AnyObjectInterface, params: AnyObjectInterface | undefined, filePath: string): Promise<void>;
-declare function SendResetPasswordMail(db: Db, userDetails: AnyObjectInterface, type?: string): Promise<unknown>;
-declare function SendMailToSupport(mailData: AnyObjectInterface, callback: callBackInterface): void;
-declare function MailTemplateStructure(content: string, HasDontReplyContent?: boolean): string;
-declare function SendMailToCustomer(mailData: AnyObjectInterface, callback: callBackInterface): void;
-declare function parseMSPCookie(cookie: AnyObjectInterface): any;
-declare function isEmptyObj(object: AnyObjectInterface): boolean;
-declare function ConvertFileByteSize(bytes: number): string;
-declare function GetIPDetailsFromReq(req: Express.Request): Promise<{
-    countryName: string;
-    region: string;
-    city: string;
-    ip: string;
-}>;
-/**
- * @param res
- * @param params
- * @description Helper function to send response
- */
-declare function ReturnJsonResponse(res: Response, params: ResponseStructure): void;
-declare function CheckForWhiteListedDomain(req: Express.Request, whiteListedDomain: Array<string>): boolean;
-declare function SyncListSchemaFieldInOtherCollection(syncFields: AnyObjectInterface, db: Db, msp_d: AnyObjectInterface): Promise<void>;
-declare function UpdateTagCountAfterDelete(objectids: ObjectId[], objectName: string, db: Db, params?: AnyObjectInterface): Promise<void>;
-declare function SyncTagCountAfterUpdate(objectName: string, db: Db): void;
-declare function SyncUserLicenceConsumedCount(msp_d: AnyObjectInterface, db: Db, dbMaster: Db): Promise<void>;
-/**
- * @param db: database object
- * @param event : event module object
- * @param EventsList : array of events like socket event..
- * * @param EventName : name of event like refresh-notification
- * * @param EventData : event data, if needed
- * * @param IsSocketEvent : Type of event, currently handled for socket event only
- * @param UserID : creater of the event, event is not sending to sender
- * @param req : request object
- * @param req : response object
- * @param next : next object
- * @description To Broad Case any event to all company Users like refresh-notification
- */
-declare function BroadCastEventToAllCompanyUsers(params: AnyObjectInterface): void;
-/**
- * @param actionType : add, edit, delete
- * @description check before add update or delete operation
- */
-declare function CheckDataPermission(fieldsObj: AnyObjectInterface, pageData: AnyObjectInterface, profileData: AnyObjectInterface, actionType: string): void;
-/**
- * @param fieldsObj : company ID
- * @description Sync Company Licence In Master Company
- */
-declare function SyncCompanyLicenceInMasterCompanyAfterAdd(fieldsObj: AnyObjectInterface, dbMaster: Db): Promise<void>;
-/**
- * Returns date string - Date for next service with the given options
- *
- * @param object options   date string
- * @return  string - date
- */
-declare function NextServiceDateForDashboard(options: any): string;
-/**
- * Returns - Check Date Exist in Past
- * _common.GetWeekDayInfoInMonth("sunday");
- *
- * @param {object} currentDt moment date object
- * @param {object} dateToCheck moment date object
- * @return boolean
- */
-declare function CheckDateNotInPast(currentDt: Moment, dateToCheck: Moment): boolean;
-/**
- * Returns - date by given date, weekday and occurance like first, second -
- * _common.GetWeekDayByDayAndOccurance(moment().format(), 5, "fourth");
- *
- * @param {string} dt   date moment date string
- * @param {string} weekday   weekday like sunday, monday
- * @param {string} occuranceSeq   occurence like first, second till fourth & last
- * @return string
- */
-declare function GetWeekDayByDayAndOccurance(dt: string, weekday: number, occuranceSeq: string): string;
-/**
- * Returns - get occurence index from list
- * _common.GetInterValFromOccurance("first");
- *
- * @param {string} occurVal first, second till fourth & last
- * @return number
- */
-declare function GetInterValFromOccurance(occurVal: string): number;
-/**
- * Returns object - Get Date information related to occurance, day index etc.
- *
- * @param {string} dt   date string
- * @return  occurance, day, month, date, dayIndex
- */
-declare function GetWeekDayInfoInMonth(dt: string): {
-    occurance: string;
-    day: string;
-    month: string;
-    date: number;
-    dayIndex: number;
-};
-/**
- * Returns - weekindex
- * _common.GetWeekDayInfoInMonth("sunday");
- *
- * @param {string} day sunday to saturday
- * @return number
- */
-declare function GetDayIndex(day: string): number;
-declare function GetUserProfile(msp_d: AnyObjectInterface, db: Db, mdb: Db, next: NextFunction): Promise<{
-    statusCode: number;
-    message: string;
-    data: any;
-} | undefined>;
-declare function CheckPageAuthentication(pageData: AnyObjectInterface, msp_d: AnyObjectInterface, db: Db, mdb: Db, next: NextFunction): Promise<boolean>;
-declare function RemoveFieldsFromFilters(condition: AnyObjectInterface, fields: AnyObjectInterface[], identifier: string): void;
-/**
-     * @param Error Error object
-     * @param ServiceOrigin - Error Occur in Service (Service Name)
-     * @param EmailConfig Email configuration object
-     * @param Module Module
-     * @param db db connection
-     * @description Error handler function: Send Error Email & Save Error in database
-     */
-declare function ErrorHandlerForServices(Error: OPT_ERROR, ServiceOrigin: string, EmailConfig: any, Module?: string, db?: Db): Promise<any>;
-declare function CheckCaptcha(token: string, captcha: string, redisClient: Redis): Promise<unknown>;
-declare function IsStringValue(val: any): boolean;
-declare function ValidateSanitizeUserInput(inputFields: AnyObjectInterface, pageData: AnyObjectInterface): Promise<AnyObjectInterface[] | undefined>;
-declare function ValidateUserInput(options: AnyObjectInterface): Promise<string | undefined>;
-/**
- * TODO: Check conditional field criteria with user inputs
- *
- * @param {object} field Contains shcema
- * @param {object} record contains user inputs
- * @param {string} action shows add or update
- * @return message in string
- */
-declare function CheckConditionalField(field: any, record: any, action: string): string;
-/**
- * TODO: Check expression on date field
- *
- * @param {object} record Contains user inputs
- * @param {string} fieldName name
- * @param {string} range like 'Custom', 'today', yesterday etc.
- * @param {string} startDate in case of custom range
- * @param {string} endDate in case of custom range
- * @return true or false
- */
-declare function CheckExpressionOnDateField(record: any, fieldName: string, range: string, startDate: string, endDate: string): boolean;
-/**
- * TODO: Create lookup of fields of list schema for Vat Setting data
- *
- * @param {object} msp_d Contains user information
- * @param {object} db  Database connection object
- * @param {object} sdata contains vat setting data including list schema
- * @param next middleware for error handling
- * @return N/A
- */
-declare function CreateBanquetingVATSettingsData(msp_d: AnyObjectInterface, db: Db, sdata: AnyObjectInterface, next: NextFunction): Promise<void>;
-/**
- * TODO: To Check if given user has access to Report Folder - THIS FUNCTION IS COPIED FROM report_controller.js
- *
- * @param {object} report Contains Report information
- * @param {object} db  Database connection object
- * @param {object} msp_d Contains User id information
- * @param folderActiveStatus boolean default value true
- * @return N/A
- */
-declare function CheckReportFolderAccess(report: AnyObjectInterface, db: Db, msp_d: AnyObjectInterface, folderActiveStatus?: boolean): Promise<boolean>;
-/**
- * TODO: Return On behalf String in Calendar Invitation mails
- * @param fromUser  From User Name
- * @returns string
- */
-declare function GetMailFromString(fromUser: string): string;
-/**
- * TODO: Return On behalf String in Calendar Invitation mails
- * @param fromUser  From User Name
- * @param fromEmail  From User Email
- * @returns string
- */
-declare function InvitationMailReplyContent(fromUser: string, fromEmail: string): string;
-/**
- * TODO: Check if filter has fiscal in Operator value - Recursion Function
- *
- * @param filter - object || array
- * @return boolean
- */
-declare function HasFiscalOperator(filter: any): boolean;
-/**
- * TODO: Return Encrypted URL
- *
- * @param recordIds - ObjectId[]
- * @param companyId - string
- * @param secretKey - string
- * @return object
- */
-declare function GetEncryptedURL(options: GetEncryptedURLOptions): any[];
-declare function GenerateBase64QRCodeData(data: string, options?: any): Promise<any>;
-/**
- * QPC-7137: getting Drive sharing
- *
- * @param parentFolderID - folder id
- * @param db - object db connecttion
- * @return array of all sharing of child file folders
- */
-declare function GetFileFolderDetailsInFolderForDriveSharing(parentFolderID: any, db: Db): Promise<any>;
-/**
- * TODO: Sync total slots remainig in Event Registration
- *
- * @param1 registration id || ObjectId
- * @param2 database connection || Db
- * @return NA
- */
-declare function SyncTotalSlotRemaining(registrationID: any, db: Db): Promise<void>;
-export { CheckForWhiteListedDomain, ReturnJsonResponse, ConvertFileByteSize, GetObjectByKeyValueFromList, IsEqualArrays, IsEqualValue, CheckUserProfileField, GetPageFieldData, GetPageObjectSchema, GetFieldDetail, UpdateRecentViewObject, UpdateRecentViewFields, SyncChildObjectData, SyncParentObjectData, DeleteFieldInOtherCollection, SyncFieldInSameCollection, SyncFieldInSameCollectionByObjectID, SyncFieldInSameCollectionByObjectIDWithPromise, SyncFieldInOtherCollection, SyncUserInOtherCollection, GetObjectByString, BuildLookupDataField, CheckDataBeforeAdd, CheckDataBeforeUpdate, BuildGridFieldProjection, BuildFieldProjection, BuildLookupFieldProjection, FilterConditions, GirdHeaderFilters, FieldsGridHeaderFilters, AddLog, CheckFilterFieldsProjection, VerifyEmailPassword, GetMyTeamUsers, ExtractChildUsersTree, GetMaxKeyValueListSchema, VerifyAWSEmailConfig, GenerateId, SyncUserDetailsWithMasterDB, SignoutUserFromAllDevices, SignoutUsersWithPromise, SignoutMultipleUsersFromAllDevices, UserLicenseConsumeCalculate, sendMailWithUserAccount, GetEmailClientConfigs, GetCompanyEncryptionKey, ExecuteDynamicDMLQuery, ExecuteDynamicDQLQuery, GetUserProfilePermissions, MakeUserPasswordInvalid, ConvertJsonToXLXS, SendResetPasswordMail, SendMailToSupport, MailTemplateStructure, SendMailToCustomer, parseMSPCookie, GetIPDetailsFromReq, isEmptyObj, SyncListSchemaFieldInOtherCollection, UpdateTagCountAfterDelete, SyncTagCountAfterUpdate, ReactivateFieldInOtherCollection, SyncUserLicenceConsumedCount, BroadCastEventToAllCompanyUsers, CheckDataPermission, SyncCompanyLicenceInMasterCompanyAfterAdd, NextServiceDateForDashboard, CheckDateNotInPast, GetWeekDayByDayAndOccurance, GetInterValFromOccurance, GetWeekDayInfoInMonth, GetDayIndex, RemoveFieldsFromFilters, GetUserProfile, CheckPageAuthentication, ErrorHandlerForServices, CheckCaptcha, IsStringValue, ValidateSanitizeUserInput, ValidateUserInput, CheckConditionalField, CheckExpressionOnDateField, AddDaysToDate, CreateBanquetingVATSettingsData, CheckReportFolderAccess, GetMailFromString, InvitationMailReplyContent, HasFiscalOperator, GetEncryptedURL, GenerateBase64QRCodeData, GetFileFolderDetailsInFolderForDriveSharing, SyncTotalSlotRemaining };
+import { Moment } from "moment";
+import { NextFunction, Response } from "express";
+import { ObjectId, Db } from "mongodb";
+import { ResponseStructure, OPT_ERROR } from "../modals/connection.modal";
+import { Express } from '../modals/log.modal';
+import { AnyObjectInterface, callBackInterface, GetEncryptedURLOptions } from "../modals/utility.modal";
+import { OPT_Request } from "../modals/connection.modal";
+import { Redis } from "ioredis";
+import 'moment-timezone';
+import { integer } from "aws-sdk/clients/cloudfront";
+declare function GetObjectByKeyValueFromList(list: AnyObjectInterface, key: string, val: any): any;
+declare function IsEqualArrays(a: [any] | [], b: [any] | []): boolean;
+declare function IsEqualValue(a: any, b: any): boolean;
+declare function AddDaysToDate(date: any, days: integer): Date;
+declare function CheckUserProfileField(pageData: AnyObjectInterface, profileData: AnyObjectInterface): void;
+declare function GetPageFieldData(pageName: string, db: any, mdb: any, msp_d: any, next: NextFunction, callback: callBackInterface): void;
+declare function GetPageObjectSchema(pageName: string, db: Db, next: NextFunction, callback: callBackInterface): void;
+declare function GetFieldDetail(objectName: string, fieldName: string, db: any, callback: callBackInterface, next: NextFunction): void;
+declare function UpdateRecentViewObject(objectName: string, objectID: ObjectId, userID: ObjectId, db: Db): void;
+declare function UpdateRecentViewFields(objectName: string, fieldID: string, userID: ObjectId, db: Db): void;
+declare function SyncChildObjectData(pageData: AnyObjectInterface, objectID: ObjectId, db: Db): Promise<void>;
+declare function SyncParentObjectData(pageData: AnyObjectInterface, objectID: ObjectId, db: Db): Promise<void>;
+/**
+ * Delete field in other collection after delete records
+ * @param objectName :  ObjectName of record to which we want to delete
+ * @param objectIDs : ObjectId of the created records of above object name collection
+ * @param db : database connection || Db
+ * @param params :  It includes the object of remaining arguments passing here as an argument
+ * @param params.isBuiltOnPromise : optional param need to send with params obj for to confirm function is used with promise or not!!
+ * @param params.mongoQueryOpts :optional param sending with params obj for some specific mongodb query operation, to maintain session for transactions
+ * @param comMasterDb : optional param sending to get it update and sync with master db.
+ */
+declare function DeleteFieldInOtherCollection(objectName: string, objectIDs: ObjectId, db: Db, params?: AnyObjectInterface, comMasterDb?: Db): Promise<void>;
+declare function ReactivateFieldInOtherCollection(objectName: string, objectIDs: ObjectId, db: Db): void;
+declare function SyncFieldInSameCollection(objectName: string, objectIDs: ObjectId[], db: Db, comMasterDb?: Db): Promise<any>;
+declare function SyncFieldInSameCollectionByObjectID(objectName: string, objectID: ObjectId, db: Db): void;
+declare function SyncFieldInSameCollectionByObjectIDWithPromise(objectName: string, objectID: ObjectId, db: Db): Promise<any>;
+declare function SyncFieldInOtherCollection(syncFields: AnyObjectInterface[], db: Db): Promise<any>;
+/** Special Note: Need to create seachValue for it in QPC-6169.
+    I've not done yet, cause it was not calling from anywhere.
+*/
+declare function SyncUserInOtherCollection(options: AnyObjectInterface, db: Db, callback: callBackInterface, next: NextFunction): void;
+declare function GetObjectByString(o: any, s: any): any;
+declare function BuildLookupDataField(fieldSchema: AnyObjectInterface, updateObj: AnyObjectInterface, db: Db): Promise<void>;
+declare function CheckDataBeforeAdd(updateObj: AnyObjectInterface, objectSchema: AnyObjectInterface, db: Db): Promise<void>;
+declare function CheckDataBeforeUpdate(updateObj: AnyObjectInterface, objectData: AnyObjectInterface, objectSchema: AnyObjectInterface, db: Db): Promise<void>;
+declare function BuildGridFieldProjection(project: AnyObjectInterface, field: AnyObjectInterface, group?: AnyObjectInterface): void;
+declare function BuildFieldProjection(project: AnyObjectInterface, field: AnyObjectInterface, group: AnyObjectInterface): void;
+declare function BuildLookupFieldProjection(field: AnyObjectInterface, group: AnyObjectInterface, project: AnyObjectInterface, aggregateArry: AnyObjectInterface[]): void;
+declare function FilterConditions(condition: AnyObjectInterface, match: AnyObjectInterface, fields: AnyObjectInterface): void;
+declare function GirdHeaderFilters(filters: AnyObjectInterface, fields: AnyObjectInterface): {
+    $and: AnyObjectInterface[];
+} | undefined;
+declare function FieldsGridHeaderFilters(filters: AnyObjectInterface, fields: AnyObjectInterface): {
+    $and: AnyObjectInterface[];
+    lookupConditions: {
+        [x: number]: RegExp;
+    }[];
+};
+/** @desc:{
+    objectName: It's a name of Collection.
+    logAction: Add | Modify | Delete
+    objLogProp :{ // Its details of the object
+        ObjectID: Object Id
+        Data : Full Collection Object
+    }
+}*/
+declare function AddLog(req: OPT_Request, objectName: string, logAction: string, objLogProp: AnyObjectInterface, db: Db, next: NextFunction): void;
+declare function CheckFilterFieldsProjection(condition: AnyObjectInterface, fields: AnyObjectInterface, pageData: AnyObjectInterface, project: AnyObjectInterface): void;
+declare function VerifyEmailPassword(options: AnyObjectInterface, callback: callBackInterface): void;
+declare function GetMyTeamUsers(options: AnyObjectInterface, next: NextFunction): void;
+declare function ExtractChildUsersTree(userId: string, childUsersArray: AnyObjectInterface[], usersTraversed: string[], counter: number, db: Db, onFetch: callBackInterface): void;
+declare function GetMaxKeyValueListSchema(ListName: string, db: Db): Promise<any>;
+declare function VerifyAWSEmailConfig(mailData: AnyObjectInterface, callback: callBackInterface): void;
+declare function GenerateId(obj: AnyObjectInterface): void;
+declare function SyncUserDetailsWithMasterDB(userData: AnyObjectInterface, callback: CallableFunction, dbMaster: Db): void;
+declare function SignoutUserFromAllDevices(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): void;
+declare function SignoutUsersWithPromise(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): Promise<unknown>;
+declare function SignoutMultipleUsersFromAllDevices(options: AnyObjectInterface, dbMaster: Db, redisClient: Redis): void;
+declare function UserLicenseConsumeCalculate(options: AnyObjectInterface): void;
+declare function sendMailWithUserAccount(mailObj: AnyObjectInterface, files: AnyObjectInterface, userSettings: AnyObjectInterface): Promise<any>;
+declare function GetEmailClientConfigs(options: AnyObjectInterface): void;
+declare function GetCompanyEncryptionKey(options: AnyObjectInterface): void;
+declare function ExecuteDynamicDMLQuery(options: AnyObjectInterface): Promise<string>;
+declare function ExecuteDynamicDQLQuery(options: AnyObjectInterface): Promise<AnyObjectInterface>;
+declare function GetUserProfilePermissions(options: AnyObjectInterface): void;
+declare function MakeUserPasswordInvalid(options: AnyObjectInterface): void;
+declare function ConvertJsonToXLXS(data: AnyObjectInterface, params: AnyObjectInterface | undefined, filePath: string): Promise<void>;
+declare function SendResetPasswordMail(db: Db, userDetails: AnyObjectInterface, type?: string): Promise<unknown>;
+declare function SendMailToSupport(mailData: AnyObjectInterface, callback: callBackInterface): void;
+declare function MailTemplateStructure(content: string, HasDontReplyContent?: boolean): string;
+declare function SendMailToCustomer(mailData: AnyObjectInterface, callback: callBackInterface): void;
+declare function parseMSPCookie(cookie: AnyObjectInterface): any;
+declare function isEmptyObj(object: AnyObjectInterface): boolean;
+declare function ConvertFileByteSize(bytes: number): string;
+declare function GetIPDetailsFromReq(req: Express.Request): Promise<{
+    countryName: string;
+    region: string;
+    city: string;
+    ip: string;
+}>;
+/**
+ * @param res
+ * @param params
+ * @description Helper function to send response
+ */
+declare function ReturnJsonResponse(res: Response, params: ResponseStructure): void;
+declare function CheckForWhiteListedDomain(req: Express.Request, whiteListedDomain: Array<string>): boolean;
+declare function SyncListSchemaFieldInOtherCollection(syncFields: AnyObjectInterface, db: Db, msp_d: AnyObjectInterface): Promise<void>;
+declare function UpdateTagCountAfterDelete(objectids: ObjectId[], objectName: string, db: Db, params?: AnyObjectInterface): Promise<void>;
+declare function SyncTagCountAfterUpdate(objectName: string, db: Db): void;
+declare function SyncUserLicenceConsumedCount(msp_d: AnyObjectInterface, db: Db, dbMaster: Db): Promise<void>;
+/**
+ * @param db: database object
+ * @param event : event module object
+ * @param EventsList : array of events like socket event..
+ * * @param EventName : name of event like refresh-notification
+ * * @param EventData : event data, if needed
+ * * @param IsSocketEvent : Type of event, currently handled for socket event only
+ * @param UserID : creater of the event, event is not sending to sender
+ * @param req : request object
+ * @param req : response object
+ * @param next : next object
+ * @description To Broad Case any event to all company Users like refresh-notification
+ */
+declare function BroadCastEventToAllCompanyUsers(params: AnyObjectInterface): void;
+/**
+ * @param actionType : add, edit, delete
+ * @description check before add update or delete operation
+ */
+declare function CheckDataPermission(fieldsObj: AnyObjectInterface, pageData: AnyObjectInterface, profileData: AnyObjectInterface, actionType: string): void;
+/**
+ * @param fieldsObj : company ID
+ * @description Sync Company Licence In Master Company
+ */
+declare function SyncCompanyLicenceInMasterCompanyAfterAdd(fieldsObj: AnyObjectInterface, dbMaster: Db): Promise<void>;
+/**
+ * Returns date string - Date for next service with the given options
+ *
+ * @param object options   date string
+ * @return  string - date
+ */
+declare function NextServiceDateForDashboard(options: any): string;
+/**
+ * Returns - Check Date Exist in Past
+ * _common.GetWeekDayInfoInMonth("sunday");
+ *
+ * @param {object} currentDt moment date object
+ * @param {object} dateToCheck moment date object
+ * @return boolean
+ */
+declare function CheckDateNotInPast(currentDt: Moment, dateToCheck: Moment): boolean;
+/**
+ * Returns - date by given date, weekday and occurance like first, second -
+ * _common.GetWeekDayByDayAndOccurance(moment().format(), 5, "fourth");
+ *
+ * @param {string} dt   date moment date string
+ * @param {string} weekday   weekday like sunday, monday
+ * @param {string} occuranceSeq   occurence like first, second till fourth & last
+ * @return string
+ */
+declare function GetWeekDayByDayAndOccurance(dt: string, weekday: number, occuranceSeq: string): string;
+/**
+ * Returns - get occurence index from list
+ * _common.GetInterValFromOccurance("first");
+ *
+ * @param {string} occurVal first, second till fourth & last
+ * @return number
+ */
+declare function GetInterValFromOccurance(occurVal: string): number;
+/**
+ * Returns object - Get Date information related to occurance, day index etc.
+ *
+ * @param {string} dt   date string
+ * @return  occurance, day, month, date, dayIndex
+ */
+declare function GetWeekDayInfoInMonth(dt: string): {
+    occurance: string;
+    day: string;
+    month: string;
+    date: number;
+    dayIndex: number;
+};
+/**
+ * Returns - weekindex
+ * _common.GetWeekDayInfoInMonth("sunday");
+ *
+ * @param {string} day sunday to saturday
+ * @return number
+ */
+declare function GetDayIndex(day: string): number;
+declare function GetUserProfile(msp_d: AnyObjectInterface, db: Db, mdb: Db, next: NextFunction): Promise<{
+    statusCode: number;
+    message: string;
+    data: any;
+} | undefined>;
+declare function CheckPageAuthentication(pageData: AnyObjectInterface, msp_d: AnyObjectInterface, db: Db, mdb: Db, next: NextFunction): Promise<boolean>;
+declare function RemoveFieldsFromFilters(condition: AnyObjectInterface, fields: AnyObjectInterface[], identifier: string): void;
+/**
+     * @param Error Error object
+     * @param ServiceOrigin - Error Occur in Service (Service Name)
+     * @param EmailConfig Email configuration object
+     * @param Module Module
+     * @param db db connection
+     * @description Error handler function: Send Error Email & Save Error in database
+     */
+declare function ErrorHandlerForServices(Error: OPT_ERROR, ServiceOrigin: string, EmailConfig: any, Module?: string, db?: Db): Promise<any>;
+declare function CheckCaptcha(token: string, captcha: string, redisClient: Redis): Promise<unknown>;
+declare function IsStringValue(val: any): boolean;
+declare function ValidateSanitizeUserInput(inputFields: AnyObjectInterface, pageData: AnyObjectInterface): Promise<(AnyObjectInterface | {
+    msg: string;
+})[] | undefined>;
+declare function ValidateUserInput(options: AnyObjectInterface): Promise<string | undefined>;
+/**
+ * TODO: Check conditional field criteria with user inputs
+ *
+ * @param {object} field Contains shcema
+ * @param {object} record contains user inputs
+ * @param {string} action shows add or update
+ * @return message in string
+ */
+declare function CheckConditionalField(field: any, record: any, action: string): string;
+/**
+ * TODO: Check expression on date field
+ *
+ * @param {object} record Contains user inputs
+ * @param {string} fieldName name
+ * @param {string} range like 'Custom', 'today', yesterday etc.
+ * @param {string} startDate in case of custom range
+ * @param {string} endDate in case of custom range
+ * @return true or false
+ */
+declare function CheckExpressionOnDateField(record: any, fieldName: string, range: string, startDate: string, endDate: string): boolean;
+/**
+ * TODO: Create lookup of fields of list schema for Vat Setting data
+ *
+ * @param {object} msp_d Contains user information
+ * @param {object} db  Database connection object
+ * @param {object} sdata contains vat setting data including list schema
+ * @param next middleware for error handling
+ * @return N/A
+ */
+declare function CreateBanquetingVATSettingsData(msp_d: AnyObjectInterface, db: Db, sdata: AnyObjectInterface, next: NextFunction): Promise<void>;
+/**
+ * TODO: To Check if given user has access to Report Folder - THIS FUNCTION IS COPIED FROM report_controller.js
+ *
+ * @param {object} report Contains Report information
+ * @param {object} db  Database connection object
+ * @param {object} msp_d Contains User id information
+ * @param folderActiveStatus boolean default value true
+ * @return N/A
+ */
+declare function CheckReportFolderAccess(report: AnyObjectInterface, db: Db, msp_d: AnyObjectInterface, folderActiveStatus?: boolean): Promise<boolean>;
+/**
+ * TODO: Return On behalf String in Calendar Invitation mails
+ * @param fromUser  From User Name
+ * @returns string
+ */
+declare function GetMailFromString(fromUser: string): string;
+/**
+ * TODO: Return On behalf String in Calendar Invitation mails
+ * @param fromUser  From User Name
+ * @param fromEmail  From User Email
+ * @returns string
+ */
+declare function InvitationMailReplyContent(fromUser: string, fromEmail: string): string;
+/**
+ * TODO: Check if filter has fiscal in Operator value - Recursion Function
+ *
+ * @param filter - object || array
+ * @return boolean
+ */
+declare function HasFiscalOperator(filter: any): boolean;
+/**
+ * TODO: Return Encrypted URL
+ *
+ * @param recordIds - ObjectId[]
+ * @param companyId - string
+ * @param secretKey - string
+ * @return object
+ */
+declare function GetEncryptedURL(options: GetEncryptedURLOptions): any[];
+declare function GenerateBase64QRCodeData(data: string, options?: any): Promise<any>;
+/**
+ * QPC-7137: getting Drive sharing
+ *
+ * @param parentFolderID - folder id
+ * @param db - object db connecttion
+ * @return array of all sharing of child file folders
+ */
+declare function GetFileFolderDetailsInFolderForDriveSharing(parentFolderID: any, db: Db): Promise<any>;
+/**
+ * TODO: Sync total slots remainig in Event Registration
+ *
+ * @param1 registration id || ObjectId
+ * @param2 database connection || Db
+ * @return NA
+ */
+declare function SyncTotalSlotRemaining(registrationID: any, db: Db): Promise<void>;
+export { CheckForWhiteListedDomain, ReturnJsonResponse, ConvertFileByteSize, GetObjectByKeyValueFromList, IsEqualArrays, IsEqualValue, CheckUserProfileField, GetPageFieldData, GetPageObjectSchema, GetFieldDetail, UpdateRecentViewObject, UpdateRecentViewFields, SyncChildObjectData, SyncParentObjectData, DeleteFieldInOtherCollection, SyncFieldInSameCollection, SyncFieldInSameCollectionByObjectID, SyncFieldInSameCollectionByObjectIDWithPromise, SyncFieldInOtherCollection, SyncUserInOtherCollection, GetObjectByString, BuildLookupDataField, CheckDataBeforeAdd, CheckDataBeforeUpdate, BuildGridFieldProjection, BuildFieldProjection, BuildLookupFieldProjection, FilterConditions, GirdHeaderFilters, FieldsGridHeaderFilters, AddLog, CheckFilterFieldsProjection, VerifyEmailPassword, GetMyTeamUsers, ExtractChildUsersTree, GetMaxKeyValueListSchema, VerifyAWSEmailConfig, GenerateId, SyncUserDetailsWithMasterDB, SignoutUserFromAllDevices, SignoutUsersWithPromise, SignoutMultipleUsersFromAllDevices, UserLicenseConsumeCalculate, sendMailWithUserAccount, GetEmailClientConfigs, GetCompanyEncryptionKey, ExecuteDynamicDMLQuery, ExecuteDynamicDQLQuery, GetUserProfilePermissions, MakeUserPasswordInvalid, ConvertJsonToXLXS, SendResetPasswordMail, SendMailToSupport, MailTemplateStructure, SendMailToCustomer, parseMSPCookie, GetIPDetailsFromReq, isEmptyObj, SyncListSchemaFieldInOtherCollection, UpdateTagCountAfterDelete, SyncTagCountAfterUpdate, ReactivateFieldInOtherCollection, SyncUserLicenceConsumedCount, BroadCastEventToAllCompanyUsers, CheckDataPermission, SyncCompanyLicenceInMasterCompanyAfterAdd, NextServiceDateForDashboard, CheckDateNotInPast, GetWeekDayByDayAndOccurance, GetInterValFromOccurance, GetWeekDayInfoInMonth, GetDayIndex, RemoveFieldsFromFilters, GetUserProfile, CheckPageAuthentication, ErrorHandlerForServices, CheckCaptcha, IsStringValue, ValidateSanitizeUserInput, ValidateUserInput, CheckConditionalField, CheckExpressionOnDateField, AddDaysToDate, CreateBanquetingVATSettingsData, CheckReportFolderAccess, GetMailFromString, InvitationMailReplyContent, HasFiscalOperator, GetEncryptedURL, GenerateBase64QRCodeData, GetFileFolderDetailsInFolderForDriveSharing, SyncTotalSlotRemaining };