@sapui5/sap.fe.core 1.102.3 → 1.105.0

package/src/sap/fe/core/controllerextensions/SideEffects.ts

@@ -1,19 +1,19 @@
-import { ConverterOutput, EntityType, PropertyPath } from "@sap-ux/vocabularies-types";
+import type { ConvertedMetadata, EntityType, PropertyPath } from "@sap-ux/vocabularies-types";
 import Log from "sap/base/Log";
-import AppComponent from "sap/fe/core/AppComponent";
-import {
+import type AppComponent from "sap/fe/core/AppComponent";
+import type {
 	ControlSideEffectsEntityDictionary,
 	ControlSideEffectsType,
 	ODataSideEffectsType,
 	SideEffectsType
 } from "sap/fe/core/services/SideEffectsServiceFactory";
 import FieldRuntime from "sap/fe/macros/field/FieldRuntime";
-import Event from "sap/ui/base/Event";
-import Control from "sap/ui/core/Control";
+import type Event from "sap/ui/base/Event";
+import type Control from "sap/ui/core/Control";
 import Core from "sap/ui/core/Core";
 import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
-import Binding from "sap/ui/model/Binding";
-import Context from "sap/ui/model/Context";
+import type Binding from "sap/ui/model/Binding";
+import type Context from "sap/ui/model/Context";
 import CommonUtils from "../CommonUtils";
 import { defineUI5Class, finalExtension, methodOverride, privateExtension, publicExtension } from "../helpers/ClassSupport";
 
@@ -88,7 +88,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name getRegisteredFailedRequests
-	 * @returns {object} Registered SideEffects requests that have failed
+	 * @returns Registered SideEffects requests that have failed
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -104,9 +104,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name handleFieldChange
-	 * @param {object} oEvent SAPUI5 event that comes from a field change
-	 * @param {object} oFieldGroupPreRequisite Promise to be fulfilled before executing deferred SideEffects
-	 * @returns {object}  Promise on SideEffects request(s)
+	 * @param oEvent SAPUI5 event that comes from a field change
+	 * @param oFieldGroupPreRequisite Promise to be fulfilled before executing deferred SideEffects
+	 * @returns  Promise on SideEffects request(s)
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -151,8 +151,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name handleFieldGroupChange
-	 * @param {object} oEvent SAPUI5 Event
-	 * @returns {object} Promise on SideEffects request(s)
+	 * @param oEvent SAPUI5 Event
+	 * @returns Promise on SideEffects request(s)
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -193,7 +193,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 				})
 				.catch((oError) => {
 					if (bIsRequestsTriggered) {
-						Log.debug("Error while processing FieldGroup SideEffects on context " + sContextPath, oError);
+						Log.debug(`Error while processing FieldGroup SideEffects on context ${sContextPath}`, oError);
 					}
 				})
 				.finally(() => {
@@ -233,9 +233,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name addControlSideEffects
-	 * @param {string} sEntityType Name of the entity where the SideEffects control will be registered
-	 * @param {object} oSideEffects SideEffects to register. Ensure the sourceControlId matches the associated SAPUI5 control ID.
-	 *
+	 * @param sEntityType Name of the entity where the SideEffects control will be registered
+	 * @param oSideEffects SideEffects to register. Ensure the sourceControlId matches the associated SAPUI5 control ID.
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -260,9 +259,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name requestSideEffects
-	 * @param {object} oSideEffects SideEffects to be executed
-	 * @param {object} oContext Context where SideEffects need to be executed
-	 * @returns {object} SideEffects request on SAPUI5 context
+	 * @param oSideEffects SideEffects to be executed
+	 * @param oContext Context where SideEffects need to be executed
+	 * @returns SideEffects request on SAPUI5 context
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -295,7 +294,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name removeControlSideEffects
-	 * @param {object} oControl SAPUI5 Control
+	 * @param oControl SAPUI5 Control
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -313,8 +312,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _addFailedSideEffects
-	 * @param {object} oSideEffects SideEffects that need to be retriggered
-	 * @param {object} oContext Context where SideEffects have failed
+	 * @param oSideEffects SideEffects that need to be retriggered
+	 * @param oContext Context where SideEffects have failed
 	 */
 	@privateExtension()
 	@finalExtension()
@@ -336,8 +335,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _generateFieldGroupPromise
-	 * @param {object} mEventFieldProperties Field properties
-	 * @returns {object} Promise to be used for the validation of the field
+	 * @param mEventFieldProperties Field properties
+	 * @returns Promise to be used for the validation of the field
 	 */
 	private _generateFieldGroupPromise(mEventFieldProperties: FieldEventPropertyType): Promise<any> {
 		// eslint-disable-next-line @typescript-eslint/no-this-alias
@@ -366,8 +365,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _generateImmediatePromise
-	 * @param {object} mEventFieldProperties Field properties
-	 * @returns {object} Promise to be used for the validation of the field
+	 * @param mEventFieldProperties Field properties
+	 * @returns Promise to be used for the validation of the field
 	 */
 	private _generateImmediatePromise(mEventFieldProperties: FieldEventPropertyType): Promise<any> {
 		const oPromise = mEventFieldProperties.promise;
@@ -401,10 +400,10 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _generateStatusIndex
-	 * @param {object} mEntityType The entity type
-	 * @param {string} sPropertyPath The property path
-	 * @param {object} oContext SAPUI5 Context
-	 * @returns {string | undefined} Index
+	 * @param mEntityType The entity type
+	 * @param sPropertyPath The property path
+	 * @param oContext SAPUI5 Context
+	 * @returns Index
 	 */
 	private _generateStatusIndex(mEntityType: EntityType, sPropertyPath: string, oContext?: Context | null): string | undefined {
 		const sContextPath = oContext?.getPath();
@@ -423,9 +422,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _getContextForSideEffects
-	 * @param {object} oSourceField Field
-	 * @param {string} sSideEffectEntityType Target entity type of the SideEffects annotation
-	 * @returns {object} SAPUI5 Context
+	 * @param oSourceField Field
+	 * @param sSideEffectEntityType Target entity type of the SideEffects annotation
+	 * @returns SAPUI5 Context
 	 */
 	@privateExtension()
 	@finalExtension()
@@ -456,14 +455,13 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	/**
 	 * Retrieves the EntityType based on its fully-qualified name.
 	 *
-	 * @param {string} sFullyQualifiedName The fully-qualified name
-	 * @returns {object} The entity type
+	 * @param sFullyQualifiedName The fully-qualified name
+	 * @returns The entity type
 	 */
 	private _getEntityTypeFromFQN(sFullyQualifiedName: string): EntityType | undefined {
-		const mEntityType = (this._oSideEffectsService.getConvertedMetaModel() as ConverterOutput).entityTypes.find((oEntityType) => {
+		return (this._oSideEffectsService.getConvertedMetaModel() as ConvertedMetadata).entityTypes.find((oEntityType) => {
 			return oEntityType.fullyQualifiedName === sFullyQualifiedName;
 		});
-		return mEntityType;
 	}
 
 	/**
@@ -471,21 +469,20 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _getFieldPromise
-	 * @param {object} oEvent Field change event
-	 * @returns {object} Field promise
+	 * @param oEvent Field change event
+	 * @returns Field promise
 	 */
 	private _getFieldPromise(oEvent: Event): Promise<any> {
 		const promise = oEvent.getParameter("promise") || Promise.resolve();
 
 		return promise.then(() => {
-			const oPromise = new Promise(function (resolve, reject) {
+			return new Promise(function (resolve, reject) {
 				if (!FieldRuntime.getFieldStateOnChange(oEvent).state.validity) {
 					reject();
 				} else {
 					resolve(true);
 				}
 			});
-			return oPromise;
 		});
 	}
 
@@ -494,8 +491,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _getFieldProperties
-	 * @param {object} oEvent Field change event
-	 * @returns {object} Field properties (event change promise, field, SideEffects related to this field)
+	 * @param oEvent Field change event
+	 * @returns Field properties (event change promise, field, SideEffects related to this field)
 	 */
 	private _getFieldProperties(oEvent: Event): FieldEventPropertyType {
 		const oField: FieldControl = oEvent.getSource() as FieldControl;
@@ -515,14 +512,14 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _getFieldSideEffectsMap
-	 * @param {object} oField Field
-	 * @returns {object} SideEffects map
+	 * @param oField Field
+	 * @returns SideEffects map
 	 */
 	private _getFieldSideEffectsMap(oField: FieldControl): FieldSideEffectDictionary {
 		const mSideEffectsMap: FieldSideEffectDictionary = {},
 			aFieldGroupIds: string[] = oField.getFieldGroupIds(),
 			sViewEntitySetSetName = this._oView.getViewData().entitySet,
-			oViewEntitySet = (this._oSideEffectsService.getConvertedMetaModel() as ConverterOutput).entitySets.find((oEntitySet) => {
+			oViewEntitySet = (this._oSideEffectsService.getConvertedMetaModel() as ConvertedMetadata).entitySets.find((oEntitySet) => {
 				return oEntitySet.name === sViewEntitySetSetName;
 			});
 
@@ -532,10 +529,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 				sName: string = sFieldGroupId.replace("$$ImmediateRequest", ""),
 				aSideEffectParts: string[] = sName.split("#"),
 				sSideEffectEntityType: string = aSideEffectParts[0],
-				sSideEffectPath: string =
-					sSideEffectEntityType +
-					"@com.sap.vocabularies.Common.v1.SideEffects" +
-					(aSideEffectParts.length === 2 ? "#" + aSideEffectParts[1] : ""),
+				sSideEffectPath: string = `${sSideEffectEntityType}@com.sap.vocabularies.Common.v1.SideEffects${
+					aSideEffectParts.length === 2 ? `#${aSideEffectParts[1]}` : ""
+				}`,
 				oSideEffect: SideEffectsType | undefined =
 					this._oSideEffectsService.getODataEntitySideEffects(sSideEffectEntityType)?.[sSideEffectPath],
 				oContext: Context | undefined = this._getContextForSideEffects(oField, sSideEffectEntityType);
@@ -558,14 +554,14 @@ class SideEffectsControllerExtension extends ControllerExtension {
 				oContext: Context | undefined = this._getContextForSideEffects(oField, sViewEntityType);
 
 			if (mFieldPath && oContext) {
-				const sFieldPath = mFieldPath.getValue().replace("/" + sViewEntitySetSetName + "/", ""),
+				const sFieldPath = mFieldPath.getValue().replace(`/${sViewEntitySetSetName}/`, ""),
 					mControlEntityType = this._oSideEffectsService.getControlEntitySideEffects(
 						sViewEntityType
 					) as ControlSideEffectsEntityDictionary;
 				Object.keys(mControlEntityType).forEach((sControlName) => {
 					const oControlSideEffects: SideEffectsType = mControlEntityType[sControlName];
-					if ((oControlSideEffects.SourceProperties as string[]).includes(sFieldPath)) {
-						const sName = sControlName + "::" + sViewEntityType;
+					if (oControlSideEffects.SourceProperties.includes(sFieldPath)) {
+						const sName = `${sControlName}::${sViewEntityType}`;
 						mSideEffectsMap[sName] = {
 							name: sName,
 							immediate: true,
@@ -586,9 +582,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 *
 	 * @function
 	 * @name _initializeFieldSideEffects
-	 * @param {object} mEventFieldProperties Field event properties
-	 * @param {object} oFieldGroupPreRequisite Promise to be fulfilled before executing deferred SideEffects
-	 * @returns {Array}  Array of immediate SideEffects
+	 * @param mEventFieldProperties Field event properties
+	 * @param oFieldGroupPreRequisite Promise to be fulfilled before executing deferred SideEffects
+	 * @returns  Array of immediate SideEffects
 	 */
 	private _initializeFieldSideEffects(
 		mEventFieldProperties: FieldEventPropertyType,
@@ -650,8 +646,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	/**
 	 * Saves the validation status of properties related to a field control.
 	 *
-	 * @param {object} oField Field
-	 * @param {boolean} bSuccess Status of the field validation
+	 * @param oField Field
+	 * @param bSuccess Status of the field validation
 	 */
 	private _saveFieldPropertiesStatus(oField: FieldControl, bSuccess: boolean): void {
 		const oBindingContext = oField.getBindingContext();
@@ -678,7 +674,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * Retrieves the property binding to the value of the field.
 	 *
 	 * @param oField Field
-	 * @returns {Binding}  Binding to the value
+	 * @returns  Binding to the value
 	 */
 	private _getBindingForField(oField: FieldControl): Binding {
 		let sBindingName = "value";