@sapui5/sap.fe.core 1.102.0 → 1.103.0

package/src/sap/fe/core/services/SideEffectsServiceFactory.ts

@@ -1,13 +1,23 @@
-import ServiceFactory from "sap/ui/core/service/ServiceFactory";
-import Service from "sap/ui/core/service/Service";
-import { ComplexType, ConverterOutput, EntityType, NavigationProperty, Property } from "@sap-ux/annotation-converter";
-import Context from "sap/ui/model/odata/v4/Context";
-import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
-import { convertTypes, EnvironmentCapabilities } from "sap/fe/core/converters/MetaModelConverter";
-import { CommonAnnotationTypes, QualifiedName } from "@sap-ux/vocabularies-types/dist/generated/Common";
-import { Action, NavigationPropertyPath, PropertyPath } from "@sap-ux/vocabularies-types";
+import type {
+	Action,
+	ComplexType,
+	ConvertedMetadata,
+	EntityType,
+	NavigationProperty,
+	NavigationPropertyPath,
+	Property,
+	PropertyPath
+} from "@sap-ux/vocabularies-types";
+import type { QualifiedName } from "@sap-ux/vocabularies-types/vocabularies/Common";
+import { CommonAnnotationTypes } from "@sap-ux/vocabularies-types/vocabularies/Common";
 import Log from "sap/base/Log";
-import { ServiceContext } from "types/extension_types";
+import type { EnvironmentCapabilities } from "sap/fe/core/converters/MetaModelConverter";
+import { convertTypes } from "sap/fe/core/converters/MetaModelConverter";
+import Service from "sap/ui/core/service/Service";
+import ServiceFactory from "sap/ui/core/service/ServiceFactory";
+import type Context from "sap/ui/model/odata/v4/Context";
+import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import type { ServiceContext } from "types/extension_types";
 
 type SideEffectsSettings = {};
 
@@ -103,14 +113,14 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sEntityType Name of the entity type
-	 * @param {object} oSideEffect SideEffects definition
+	 * @param sEntityType Name of the entity type
+	 * @param oSideEffect SideEffects definition
 	 */
 	public addControlSideEffects(sEntityType: string, oSideEffect: Omit<ControlSideEffectsType, "fullyQualifiedName">): void {
 		if (oSideEffect.sourceControlId) {
 			const oControlSideEffect: ControlSideEffectsType = {
 				...oSideEffect,
-				fullyQualifiedName: sEntityType + "/SideEffectsForControl/" + oSideEffect.sourceControlId
+				fullyQualifiedName: `${sEntityType}/SideEffectsForControl/${oSideEffect.sourceControlId}`
 			};
 			const mEntityControlSideEffects = this._oSideEffectsType.control[sEntityType] || {};
 			mEntityControlSideEffects[oControlSideEffect.sourceControlId] = oControlSideEffect;
@@ -123,13 +133,13 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sTriggerAction Name of the action
-	 * @param {object} oContext Context
-	 * @param {string} sGroupId The group ID to be used for the request
-	 * @returns {Promise} A promise that is resolved without data or with a return value context when the action call succeeded
+	 * @param sTriggerAction Name of the action
+	 * @param oContext Context
+	 * @param sGroupId The group ID to be used for the request
+	 * @returns A promise that is resolved without data or with a return value context when the action call succeeded
 	 */
 	public executeAction(sTriggerAction: string, oContext: Context, sGroupId?: string): Promise<any> {
-		const oTriggerAction: any = oContext.getModel().bindContext(sTriggerAction + "(...)", oContext);
+		const oTriggerAction: any = oContext.getModel().bindContext(`${sTriggerAction}(...)`, oContext);
 		return oTriggerAction.execute(sGroupId || (oContext as any).getBinding().getUpdateGroupId());
 	}
 
@@ -138,9 +148,9 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @returns {object} Converted OData metaModel
+	 * @returns Converted OData metaModel
 	 */
-	public getConvertedMetaModel(): ConverterOutput {
+	public getConvertedMetaModel(): ConvertedMetadata {
 		const oContext = this.getContext();
 		const oComponent = oContext.scopeObject as any;
 		const oMetaModel: ODataMetaModel = oComponent.getModel().getMetaModel();
@@ -152,8 +162,8 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @function
 	 * @name getEntityTypeFromContext
-	 * @param {object} oContext Context
-	 * @returns {string | undefined } Entity Type
+	 * @param oContext Context
+	 * @returns Entity Type
 	 */
 	public getEntityTypeFromContext(oContext: Context): string | undefined {
 		const oMetaModel = oContext.getModel().getMetaModel(),
@@ -167,8 +177,8 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sEntityTypeName Name of the entity type
-	 * @returns {object} SideEffects dictionary
+	 * @param sEntityTypeName Name of the entity type
+	 * @returns SideEffects dictionary
 	 */
 	public getODataEntitySideEffects(sEntityTypeName: string): Record<string, ODataSideEffectsType> {
 		return this._oSideEffectsType.oData.entities[sEntityTypeName] || {};
@@ -179,9 +189,9 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sActionName Name of the action
-	 * @param {object} oContext Context
-	 * @returns {object} SideEffects definition
+	 * @param sActionName Name of the action
+	 * @param oContext Context
+	 * @returns SideEffects definition
 	 */
 	public getODataActionSideEffects(sActionName: string, oContext?: Context): ActionSideEffectsType | undefined {
 		if (oContext) {
@@ -204,7 +214,7 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 		this._oCapabilities = oCapabilities;
 		if (!this._bInitialized) {
 			const oConvertedMetaModel = this.getConvertedMetaModel();
-			oConvertedMetaModel.entityTypes.forEach(entityType => {
+			oConvertedMetaModel.entityTypes.forEach((entityType) => {
 				this._oSideEffectsType.oData.entities[entityType.fullyQualifiedName] = this._retrieveODataEntitySideEffects(entityType);
 				this._oSideEffectsType.oData.actions[entityType.fullyQualifiedName] = this._retrieveODataActionsSideEffects(entityType); // only bound actions are analyzed since unbound ones don't get SideEffects
 			});
@@ -217,10 +227,10 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sControlId Control Id
+	 * @param sControlId Control Id
 	 */
 	public removeControlSideEffects(sControlId: string): void {
-		Object.keys(this._oSideEffectsType.control).forEach(sEntityType => {
+		Object.keys(this._oSideEffectsType.control).forEach((sEntityType) => {
 			if (this._oSideEffectsType.control[sEntityType][sControlId]) {
 				delete this._oSideEffectsType.control[sEntityType][sControlId];
 			}
@@ -232,10 +242,10 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @function
 	 * @name requestSideEffects
-	 * @param {Array} aPathExpressions Targets of SideEffects to be executed
-	 * @param {object} oContext Context where SideEffects need to be executed
-	 * @param {string} sGroupId The group ID to be used for the request
-	 * @returns {Promise} Promise on SideEffects request
+	 * @param aPathExpressions Targets of SideEffects to be executed
+	 * @param oContext Context where SideEffects need to be executed
+	 * @param sGroupId The group ID to be used for the request
+	 * @returns Promise on SideEffects request
 	 */
 	public requestSideEffects(aPathExpressions: SideEffectsTarget[], oContext: Context, sGroupId?: string): Promise<any> {
 		this._logRequest(aPathExpressions, oContext);
@@ -275,23 +285,23 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @function
 	 * @name requestSideEffectsForNavigationProperty
-	 * @param {string} sNavigationProperty Navigation property
-	 * @param {object} oContext Context where SideEffects need to be executed
-	 * @returns {object} SideEffects request on SAPUI5 context
+	 * @param sNavigationProperty Navigation property
+	 * @param oContext Context where SideEffects need to be executed
+	 * @returns SideEffects request on SAPUI5 context
 	 */
 	public requestSideEffectsForNavigationProperty(sNavigationProperty: string, oContext: Context): Promise<any> {
 		const sBaseEntityType = this.getEntityTypeFromContext(oContext);
 		if (sBaseEntityType) {
-			const sNavigationPath = sNavigationProperty + "/";
+			const sNavigationPath = `${sNavigationProperty}/`;
 			const aSideEffects = this.getODataEntitySideEffects(sBaseEntityType);
 			let aTargets: SideEffectsTarget[] = [];
 			Object.keys(aSideEffects)
 				.filter(
 					// Keep relevant SideEffects
-					sAnnotationName => {
+					(sAnnotationName) => {
 						const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
 						return (
-							(oSideEffects.SourceProperties || []).some(oPropertyPath => {
+							(oSideEffects.SourceProperties || []).some((oPropertyPath) => {
 								const sPropertyPath = oPropertyPath.value;
 								return (
 									sPropertyPath.startsWith(sNavigationPath) &&
@@ -299,25 +309,25 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 								);
 							}) ||
 							(oSideEffects.SourceEntities || []).some(
-								oNavigationPropertyPath => oNavigationPropertyPath.value === sNavigationProperty
+								(oNavigationPropertyPath) => oNavigationPropertyPath.value === sNavigationProperty
 							)
 						);
 					}
 				)
-				.forEach(sAnnotationName => {
+				.forEach((sAnnotationName) => {
 					const oSideEffects: ODataSideEffectsType = aSideEffects[sAnnotationName];
 					if (oSideEffects.TriggerAction) {
 						this.executeAction(oSideEffects.TriggerAction as string, oContext);
 					}
 					((oSideEffects.TargetEntities as any[]) || [])
 						.concat((oSideEffects.TargetProperties as any[]) || [])
-						.forEach(mTarget => aTargets.push(mTarget));
+						.forEach((mTarget) => aTargets.push(mTarget));
 				});
 			// Remove duplicate properties
 			aTargets = this._removeDuplicateTargets(aTargets);
 			if (aTargets.length > 0) {
-				return this.requestSideEffects(aTargets, oContext).catch(oError =>
-					Log.error("SideEffects - Error while processing SideEffects for Navigation Property " + sNavigationProperty, oError)
+				return this.requestSideEffects(aTargets, oContext).catch((oError) =>
+					Log.error(`SideEffects - Error while processing SideEffects for Navigation Property ${sNavigationProperty}`, oError)
 				);
 			}
 		}
@@ -329,8 +339,8 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {string} sEntityTypeName Entity type Name
-	 * @returns {object} SideEffects dictionary
+	 * @param sEntityTypeName Entity type Name
+	 * @returns SideEffects dictionary
 	 */
 	public getControlEntitySideEffects(sEntityTypeName: string): Record<string, ControlSideEffectsType> {
 		return this._oSideEffectsType.control[sEntityTypeName] || {};
@@ -342,19 +352,19 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oSideEffect SideEffects definition
-	 * @param {object} mEntityType Entity type
-	 * @returns {object} SideEffects definition with added text properties
+	 * @param oSideEffect SideEffects definition
+	 * @param mEntityType Entity type
+	 * @returns SideEffects definition with added text properties
 	 */
 	private _addRequiredTextProperties(oSideEffect: BaseSideEffectsType, mEntityType: EntityType): BaseSideEffectsType {
 		const aInitialProperties: string[] = oSideEffect.TargetProperties || [],
-			aEntitiesRequested: string[] = (oSideEffect.TargetEntities || []).map(navigation => navigation.$NavigationPropertyPath);
+			aEntitiesRequested: string[] = (oSideEffect.TargetEntities || []).map((navigation) => navigation.$NavigationPropertyPath);
 		let aDerivedProperties: ExtractorPropertyInfo[] = [];
 
-		aInitialProperties.forEach(sPropertyPath => {
+		aInitialProperties.forEach((sPropertyPath) => {
 			const bIsStarProperty = sPropertyPath.endsWith("*"), // Can be '*' or '.../navProp/*'
 				sNavigationPropertyPath: string = sPropertyPath.substring(0, sPropertyPath.lastIndexOf("/")),
-				sRelativePath = sNavigationPropertyPath ? sNavigationPropertyPath + "/" : "",
+				sRelativePath = sNavigationPropertyPath ? `${sNavigationPropertyPath}/` : "",
 				mTarget: any = mEntityType.resolvePath(sNavigationPropertyPath) || mEntityType;
 
 			if (mTarget) {
@@ -368,7 +378,7 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 						// Add all required properties behind the *
 						aEntitiesRequested.push(sNavigationPropertyPath);
 						aDerivedProperties = aDerivedProperties.concat(
-							aTargetEntityProperties.map(mProperty => {
+							aTargetEntityProperties.map((mProperty) => {
 								return {
 									navigationPath: sRelativePath,
 									property: mProperty
@@ -378,20 +388,20 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 					} else {
 						aDerivedProperties.push({
 							property: aTargetEntityProperties.find(
-								mProperty => mProperty.name === sPropertyPath.split("/").pop()
+								(mProperty) => mProperty.name === sPropertyPath.split("/").pop()
 							) as Property,
 							navigationPath: sRelativePath
 						});
 					}
 				} else {
-					Log.info("SideEffects - The entity type associated to property path " + sPropertyPath + " cannot be resolved");
+					Log.info(`SideEffects - The entity type associated to property path ${sPropertyPath} cannot be resolved`);
 				}
 			} else {
-				Log.info("SideEffects - The property path " + sPropertyPath + " cannot be resolved");
+				Log.info(`SideEffects - The property path ${sPropertyPath} cannot be resolved`);
 			}
 		});
 
-		aDerivedProperties.forEach(mPropertyInfo => {
+		aDerivedProperties.forEach((mPropertyInfo) => {
 			if (mPropertyInfo.property) {
 				const sTargetTextPath = (mPropertyInfo.property.annotations?.Common?.Text as any)?.path,
 					sTextPathFromInitialEntity = mPropertyInfo.navigationPath + sTargetTextPath,
@@ -434,10 +444,10 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oSideEffects SideEffects definition
-	 * @param {object} mEntityType Entity type
-	 * @param {string} sBindingParameter Name of the binding parameter
-	 * @returns {object} SideEffects definition
+	 * @param oSideEffects SideEffects definition
+	 * @param mEntityType Entity type
+	 * @param sBindingParameter Name of the binding parameter
+	 * @returns SideEffects definition
 	 */
 	private _convertSideEffects(
 		oSideEffects: BaseSideEffectsType | BaseAnnotationSideEffectsType,
@@ -455,20 +465,20 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oSideEffects SideEffects definition
-	 * @returns {object} Converted SideEffects
+	 * @param oSideEffects SideEffects definition
+	 * @returns Converted SideEffects
 	 */
 	private _convertTargetsFormat(oSideEffects: BaseSideEffectsType | BaseAnnotationSideEffectsType): BaseSideEffectsType {
-		const TargetProperties: string[] = ((oSideEffects.TargetProperties as any[]) || []).reduce(function(aTargetProperties, vTarget) {
+		const TargetProperties: string[] = ((oSideEffects.TargetProperties as any[]) || []).reduce(function (aTargetProperties, vTarget) {
 				const sTarget = (typeof vTarget === "string" && vTarget) || (vTarget.type === "PropertyPath" && vTarget.value);
 				if (sTarget) {
 					aTargetProperties.push(sTarget);
 				} else {
-					Log.error("SideEffects - Error while processing TargetProperties for SideEffects" + oSideEffects.fullyQualifiedName);
+					Log.error(`SideEffects - Error while processing TargetProperties for SideEffects${oSideEffects.fullyQualifiedName}`);
 				}
 				return aTargetProperties;
 			}, []),
-			TargetEntities: SideEffectsTargetEntityType[] = ((oSideEffects.TargetEntities as any[]) || []).map(mTargetEntity => {
+			TargetEntities: SideEffectsTargetEntityType[] = ((oSideEffects.TargetEntities as any[]) || []).map((mTargetEntity) => {
 				/**
 				 *  SideEffects that comes from SAP FE get TargetEntities with $NavigationPropertyPath whereas
 				 *  ones coming from the converted OData model gets a NavigationPropertyPath format
@@ -486,8 +496,8 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oSource Entity type or action
-	 * @returns {object} Array of SideEffects
+	 * @param oSource Entity type or action
+	 * @returns Array of SideEffects
 	 */
 	private _getSideEffectsFromSource(oSource: any): ODataSideEffectsType[] {
 		const aSideEffects: ODataSideEffectsType[] = [];
@@ -497,12 +507,12 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 			if (mEntityType) {
 				const mCommonAnnotation: any = oSource.annotations?.Common || {};
 				const mBindingParameter = ((oSource as Action).parameters || []).find(
-					mParameter => mParameter.type === mEntityType.fullyQualifiedName
+					(mParameter) => mParameter.type === mEntityType.fullyQualifiedName
 				);
 				const sBindingParameter = mBindingParameter ? mBindingParameter.fullyQualifiedName.split("/")[1] : "";
 				Object.keys(mCommonAnnotation)
-					.filter(sAnnotationName => mCommonAnnotation[sAnnotationName].$Type === CommonAnnotationTypes.SideEffectsType)
-					.forEach(sAnnotationName => {
+					.filter((sAnnotationName) => mCommonAnnotation[sAnnotationName].$Type === CommonAnnotationTypes.SideEffectsType)
+					.forEach((sAnnotationName) => {
 						aSideEffects.push(this._convertSideEffects(mCommonAnnotation[sAnnotationName], mEntityType, sBindingParameter));
 					});
 			}
@@ -515,14 +525,14 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Array} aPathExpressions SideEffects targets
-	 * @param {object} oContext Context
+	 * @param aPathExpressions SideEffects targets
+	 * @param oContext Context
 	 */
 	private _logRequest(aPathExpressions: SideEffectsTarget[], oContext: Context) {
-		const sTargetPaths = aPathExpressions.reduce(function(sPaths, mTarget) {
-			return sPaths + "\n\t\t" + ((mTarget as SideEffectsTargetEntityType).$NavigationPropertyPath || mTarget || "");
+		const sTargetPaths = aPathExpressions.reduce(function (sPaths, mTarget) {
+			return `${sPaths}\n\t\t${(mTarget as SideEffectsTargetEntityType).$NavigationPropertyPath || mTarget || ""}`;
 		}, "");
-		Log.debug("SideEffects - Request:\n\tContext path : " + oContext.getPath() + "\n\tProperty paths :" + sTargetPaths);
+		Log.debug(`SideEffects - Request:\n\tContext path : ${oContext.getPath()}\n\tProperty paths :${sTargetPaths}`);
 	}
 
 	/**
@@ -530,20 +540,20 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} oSideEffects SideEffects definition
-	 * @param {string} sBindingParameterName Name of binding parameter
-	 * @returns {object} SideEffects definition
+	 * @param oSideEffects SideEffects definition
+	 * @param sBindingParameterName Name of binding parameter
+	 * @returns SideEffects definition
 	 */
 	private _removeBindingParameter(oSideEffects: BaseSideEffectsType, sBindingParameterName?: string): BaseSideEffectsType {
 		if (sBindingParameterName) {
 			const aTargets = ["TargetProperties", "TargetEntities"];
-			aTargets.forEach(sTarget => {
+			aTargets.forEach((sTarget) => {
 				let mTarget = (oSideEffects as any)[sTarget];
 				if (mTarget) {
 					mTarget = mTarget.map((mProperty: any) => {
 						const bNavigationPropertyPath = mProperty.$NavigationPropertyPath !== undefined; // Need to test with undefined since  mProperty.$NavigationPropertyPath could be "" (empty string)
 						const sValue = (bNavigationPropertyPath ? mProperty.$NavigationPropertyPath : mProperty).replace(
-							new RegExp("^" + sBindingParameterName + "/?"),
+							new RegExp(`^${sBindingParameterName}/?`),
 							""
 						);
 						return bNavigationPropertyPath ? { $NavigationPropertyPath: sValue } : sValue;
@@ -560,13 +570,13 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {Array} aTargets SideEffects targets
-	 * @returns {Array} SideEffects targets without duplicates
+	 * @param aTargets SideEffects targets
+	 * @returns SideEffects targets without duplicates
 	 */
 	private _removeDuplicateTargets(aTargets: SideEffectsTarget[]): SideEffectsTarget[] {
 		return aTargets.filter(
-			(mTarget: any, iIndex, aTargets) =>
-				aTargets.findIndex((mSearchTarget: any) => {
+			(mTarget: any, iIndex, aInTargets) =>
+				aInTargets.findIndex((mSearchTarget: any) => {
 					return (
 						mSearchTarget === mTarget || // PropertyPath
 						(mTarget.$NavigationPropertyPath && mSearchTarget.$NavigationPropertyPath === mTarget.$NavigationPropertyPath) // NavigationPropertyPath
@@ -583,20 +593,20 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} mEntityType Entity type
-	 * @returns {object} Entity type SideEffects dictionary
+	 * @param mEntityType Entity type
+	 * @returns Entity type SideEffects dictionary
 	 */
 	private _retrieveODataActionsSideEffects(mEntityType: EntityType): Record<string, ActionSideEffectsType> {
 		const oSideEffects: Record<string, ActionSideEffectsType> = {};
 		const aActions = mEntityType.actions;
 		if (aActions) {
-			Object.keys(aActions).forEach(sActionName => {
+			Object.keys(aActions).forEach((sActionName) => {
 				const oAction = mEntityType.actions[sActionName];
 				const triggerActions: string[] = [];
 				let pathExpressions: SideEffectsTarget[] = [];
 				let aTargets: SideEffectsTarget[] = [];
 
-				this._getSideEffectsFromSource(oAction).forEach(oSideEffect => {
+				this._getSideEffectsFromSource(oAction).forEach((oSideEffect) => {
 					const sTriggerAction = oSideEffect.TriggerAction;
 					aTargets = aTargets.concat(oSideEffect.TargetEntities || []).concat((oSideEffect.TargetProperties as any[]) || []);
 					if (sTriggerAction && triggerActions.indexOf(sTriggerAction as string) === -1) {
@@ -618,12 +628,12 @@ export class SideEffectsService extends Service<SideEffectsSettings> {
 	 *
 	 * @private
 	 * @ui5-restricted
-	 * @param {object} mEntityType Entity type
-	 * @returns {object} Entity type SideEffects dictionary
+	 * @param mEntityType Entity type
+	 * @returns Entity type SideEffects dictionary
 	 */
 	private _retrieveODataEntitySideEffects(mEntityType: EntityType): Record<string, ODataSideEffectsType> {
 		const oEntitySideEffects: Record<string, ODataSideEffectsType> = {};
-		this._getSideEffectsFromSource(mEntityType).forEach(oSideEffects => {
+		this._getSideEffectsFromSource(mEntityType).forEach((oSideEffects) => {
 			oEntitySideEffects[oSideEffects.fullyQualifiedName] = oSideEffects;
 		});
 		return oEntitySideEffects;