@sapui5/sap.fe.core 1.98.0 → 1.101.0

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

@@ -1,20 +1,21 @@
-import { ControllerExtension } from "sap/ui/core/mvc";
-import { Binding, Context } from "sap/ui/model";
-import { CheckBox } from "sap/m";
-import { FileUploader } from "sap/ui/unified";
-import { ControllerExtensionMetadata } from "sap/fe/core/controllerextensions";
-import { UI5Class, Override, Public, Final, Private } from "../helpers/ClassSupport";
-import { AppComponent, CommonUtils } from "sap/fe/core";
-import { Control } from "sap/ui/core";
+import { ConverterOutput, EntityType, PropertyPath } from "@sap-ux/vocabularies-types";
+import Log from "sap/base/Log";
+import AppComponent from "sap/fe/core/AppComponent";
 import {
-	SideEffectsType,
+	ControlSideEffectsEntityDictionary,
 	ControlSideEffectsType,
 	ODataSideEffectsType,
-	ControlSideEffectsEntityDictionary
+	SideEffectsType
 } from "sap/fe/core/services/SideEffectsServiceFactory";
 import { FieldRuntime } from "sap/fe/macros/field";
-import { ConverterOutput, PropertyPath, EntityType } from "@sap-ux/vocabularies-types";
-import { Log } from "sap/base";
+import Event from "sap/ui/base/Event";
+import 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 CommonUtils from "../CommonUtils";
+import { defineUI5Class, finalExtension, methodOverride, privateExtension, publicExtension } from "../helpers/ClassSupport";
 
 type FieldControl = Control & {
 	getFieldHelp(): string;
@@ -30,7 +31,7 @@ type FieldEventPropertyType = {
 type FieldSideEffectPropertyType = {
 	name: string;
 	immediate?: boolean;
-	context: Context<any>;
+	context: Context;
 	sideEffects: SideEffectsType;
 	previouslyFailed?: boolean;
 };
@@ -51,7 +52,7 @@ type FieldGroupQueueMapType = {
 	};
 };
 
-@UI5Class("sap.fe.core.controllerextensions.SideEffects", ControllerExtensionMetadata)
+@defineUI5Class("sap.fe.core.controllerextensions.SideEffects")
 class SideEffectsControllerExtension extends ControllerExtension {
 	private _oView: any;
 	private _oAppComponent!: AppComponent;
@@ -60,7 +61,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	private _oSideEffectsService!: any;
 	private _mFailedSideEffects!: FailedSideEffectDictionary;
 
-	@Override()
+	@methodOverride()
 	public onInit() {
 		this._oView = (this as any).base.getView();
 		this._oAppComponent = CommonUtils.getAppComponent(this._oView);
@@ -76,8 +77,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @function
 	 * @name clearPropertiesStatus
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public clearPropertiesStatus(): void {
 		this._aSourcePropertiesFailure.clear();
 	}
@@ -89,8 +90,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @name getRegisteredFailedRequests
 	 * @returns {object} Registered SideEffects requests that have failed
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public getRegisteredFailedRequests(): FailedSideEffectDictionary {
 		return this._mFailedSideEffects;
 	}
@@ -107,9 +108,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oFieldGroupPreRequisite Promise to be fulfilled before executing deferred SideEffects
 	 * @returns {object}  Promise on SideEffects request(s)
 	 */
-	@Public
-	@Final
-	public handleFieldChange(oEvent: UI5Event, oFieldGroupPreRequisite?: Promise<any>): Promise<any> {
+	@publicExtension()
+	@finalExtension()
+	public handleFieldChange(oEvent: Event, oFieldGroupPreRequisite?: Promise<any>): Promise<any> {
 		const mEventFieldProperties = this._getFieldProperties(oEvent),
 			aImmediateSideEffectsProperties: FieldSideEffectPropertyType[] = this._initializeFieldSideEffects(
 				mEventFieldProperties,
@@ -122,12 +123,12 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			.then(() => {
 				bIsImmediateTriggered = true;
 				return Promise.all(
-					aImmediateSideEffectsProperties.map(mSideEffectsProperty => {
+					aImmediateSideEffectsProperties.map((mSideEffectsProperty) => {
 						return this.requestSideEffects(mSideEffectsProperty.sideEffects, mSideEffectsProperty.context);
 					}) || []
 				);
 			})
-			.catch(oError => {
+			.catch((oError) => {
 				if (bIsImmediateTriggered) {
 					Log.debug("Error while processing Field SideEffects", oError);
 				} else {
@@ -137,8 +138,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					 */
 
 					aImmediateSideEffectsProperties
-						.filter(mImmediateSideEffects => mImmediateSideEffects.previouslyFailed === true)
-						.forEach(mImmediateSideEffects =>
+						.filter((mImmediateSideEffects) => mImmediateSideEffects.previouslyFailed === true)
+						.forEach((mImmediateSideEffects) =>
 							this._addFailedSideEffects(mImmediateSideEffects.sideEffects, mImmediateSideEffects.context)
 						);
 				}
@@ -153,15 +154,15 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oEvent SAPUI5 Event
 	 * @returns {object} Promise on SideEffects request(s)
 	 */
-	@Public
-	@Final
-	public handleFieldGroupChange(oEvent: UI5Event): Promise<any> {
+	@publicExtension()
+	@finalExtension()
+	public handleFieldGroupChange(oEvent: Event): Promise<any> {
 		// eslint-disable-next-line @typescript-eslint/no-this-alias
 		const that = this,
 			aDeferredSideEffects: FieldGroupSideEffectType[] = [],
 			aFieldGroupIds: string[] = oEvent.getParameter("fieldGroupIds");
 
-		const getFieldGroupRequestPromise = function(oDeferredSideEffect: FieldGroupSideEffectType) {
+		const getFieldGroupRequestPromise = function (oDeferredSideEffect: FieldGroupSideEffectType) {
 			let bIsRequestsTriggered = false;
 			const oSideEffectProperty = oDeferredSideEffect.sideEffectProperty;
 			const oContext = oSideEffectProperty.context;
@@ -170,13 +171,13 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			const mEntityType = that._getEntityTypeFromFQN(sEntityType);
 
 			return Promise.all(oDeferredSideEffect.promises)
-				.then(function() {
+				.then(function () {
 					bIsRequestsTriggered = true;
 
 					//Deferred SideEffects are executed only if all sourceProperties have no registered failure.
 					if (
 						mEntityType &&
-						(oSideEffectProperty.sideEffects.SourceProperties as PropertyPath[]).every(sourceProperty => {
+						(oSideEffectProperty.sideEffects.SourceProperties as PropertyPath[]).every((sourceProperty) => {
 							if (sourceProperty.type === "PropertyPath") {
 								const sId = that._generateStatusIndex(mEntityType, sourceProperty.value, oContext);
 								if (sId) {
@@ -190,7 +191,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					}
 					return null;
 				})
-				.catch(oError => {
+				.catch((oError) => {
 					if (bIsRequestsTriggered) {
 						Log.debug("Error while processing FieldGroup SideEffects on context " + sContextPath, oError);
 					}
@@ -200,7 +201,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 				});
 		};
 
-		aFieldGroupIds.forEach(sFieldGroupId => {
+		aFieldGroupIds.forEach((sFieldGroupId) => {
 			/**
 			 * string "$$ImmediateRequest" is added to the SideEffects name during templating to know
 			 * if this SideEffects must be immediately executed requested (on field change) or must
@@ -210,7 +211,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			const sSideEffectName: string = sFieldGroupId.replace("$$ImmediateRequest", "");
 			const mContextDeferredSideEffects = that._mFieldGroupQueue?.[sSideEffectName];
 			if (mContextDeferredSideEffects) {
-				Object.keys(mContextDeferredSideEffects).forEach(sContextPath => {
+				Object.keys(mContextDeferredSideEffects).forEach((sContextPath) => {
 					const oDeferredSideEffect = mContextDeferredSideEffects[sContextPath];
 					if (!oDeferredSideEffect.processStarted) {
 						oDeferredSideEffect.processStarted = true;
@@ -221,7 +222,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		});
 
 		return Promise.all(
-			aDeferredSideEffects.map(oDeferredSideEffect => {
+			aDeferredSideEffects.map((oDeferredSideEffect) => {
 				return getFieldGroupRequestPromise(oDeferredSideEffect);
 			})
 		);
@@ -236,8 +237,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oSideEffects SideEffects to register. Ensure the sourceControlId matches the associated SAPUI5 control ID.
 	 *
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public addControlSideEffects(sEntityType: string, oSideEffects: Omit<ControlSideEffectsType, "fullyQualifiedName">): void {
 		this._oSideEffectsService.addControlSideEffects(sEntityType, oSideEffects);
 	}
@@ -248,8 +249,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @function
 	 * @name removeFailedSideEffects
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public removeFailedSideEffects(): void {
 		this._mFailedSideEffects = {};
 	}
@@ -263,11 +264,11 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oContext Context where SideEffects need to be executed
 	 * @returns {object} SideEffects request on SAPUI5 context
 	 */
-	@Public
-	@Final
-	public requestSideEffects(oSideEffects: SideEffectsType, oContext: Context<any>): Promise<any> {
+	@publicExtension()
+	@finalExtension()
+	public requestSideEffects(oSideEffects: SideEffectsType, oContext: Context): Promise<any> {
 		let fResolver: any, fRejector: any;
-		const oPromise = new Promise(function(resolve, reject) {
+		const oPromise = new Promise(function (resolve, reject) {
 			fResolver = resolve;
 			fRejector = reject;
 		});
@@ -296,8 +297,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @name removeControlSideEffects
 	 * @param {object} oControl SAPUI5 Control
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public removeControlSideEffects(oControl: Control): void {
 		const sControlId = oControl && oControl.isA && oControl.isA("sap.ui.base.ManagedObject") && oControl.getId();
 
@@ -315,13 +316,13 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oSideEffects SideEffects that need to be retriggered
 	 * @param {object} oContext Context where SideEffects have failed
 	 */
-	@Private
-	@Final
-	private _addFailedSideEffects(oSideEffects: SideEffectsType, oContext: Context<any>): void {
+	@privateExtension()
+	@finalExtension()
+	private _addFailedSideEffects(oSideEffects: SideEffectsType, oContext: Context): void {
 		const sContextPath: string = oContext.getPath();
 		this._mFailedSideEffects[sContextPath] = this._mFailedSideEffects[sContextPath] || [];
 		const bIsNotAlreadyListed = this._mFailedSideEffects[sContextPath].every(
-			mFailedSideEffects => oSideEffects.fullyQualifiedName !== mFailedSideEffects.fullyQualifiedName
+			(mFailedSideEffects) => oSideEffects.fullyQualifiedName !== mFailedSideEffects.fullyQualifiedName
 		);
 		if (bIsNotAlreadyListed) {
 			this._mFailedSideEffects[sContextPath].push(oSideEffects);
@@ -344,10 +345,10 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 		let bPromiseSuccess = true;
 		return mEventFieldProperties.promise
-			.then(function() {
+			.then(function () {
 				return bPromiseSuccess;
 			})
-			.catch(function() {
+			.catch(function () {
 				bPromiseSuccess = false;
 				return bPromiseSuccess;
 			})
@@ -370,7 +371,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 */
 	private _generateImmediatePromise(mEventFieldProperties: FieldEventPropertyType): Promise<any> {
 		const oPromise = mEventFieldProperties.promise;
-		return oPromise.then(function() {
+		return oPromise.then(function () {
 			/**
 			 * If the field gets a FieldHelper, we need to wait until all fields changed by this FieldHelper have been set.
 			 * To achieve this, we ensure that all related bindings have been resolved.
@@ -381,10 +382,10 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			const oField = mEventFieldProperties.field;
 			const sFieldHelperId = oField.getFieldHelp && oField.getFieldHelp();
 			if (sFieldHelperId) {
-				const oFilterHelp: any = sap.ui.getCore().byId(sFieldHelperId);
+				const oFilterHelp: any = Core.byId(sFieldHelperId);
 				if (oFilterHelp) {
 					return Promise.all(
-						(oFilterHelp.getOutParameters() as any[]).map(oOutParameter => {
+						(oFilterHelp.getOutParameters() as any[]).map((oOutParameter) => {
 							const oBinding = oOutParameter.getBinding("value");
 							return oBinding ? oBinding.requestValue() : Promise.resolve();
 						})
@@ -405,8 +406,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oContext SAPUI5 Context
 	 * @returns {string | undefined} Index
 	 */
-	private _generateStatusIndex(mEntityType: EntityType, sPropertyPath: string, oContext: Context<any>): string | undefined {
-		const sContextPath = oContext.getPath();
+	private _generateStatusIndex(mEntityType: EntityType, sPropertyPath: string, oContext?: Context | null): string | undefined {
+		const sContextPath = oContext?.getPath();
 		const mProperty = mEntityType.resolvePath(sPropertyPath);
 		if (mProperty) {
 			if (mProperty && mProperty._type === "Property") {
@@ -426,9 +427,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {string} sSideEffectEntityType Target entity type of the SideEffects annotation
 	 * @returns {object} SAPUI5 Context
 	 */
-	@Private
-	@Final
-	private _getContextForSideEffects(oSourceField: FieldControl, sSideEffectEntityType: string): Context<any> | undefined {
+	@privateExtension()
+	@finalExtension()
+	private _getContextForSideEffects(oSourceField: FieldControl, sSideEffectEntityType: string): Context | undefined {
 		const oBindingContext = oSourceField.getBindingContext();
 		let oContextForSideEffects = oBindingContext,
 			sEntityType = this._oSideEffectsService.getEntityTypeFromContext(oBindingContext);
@@ -459,7 +460,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @returns {object} The entity type
 	 */
 	private _getEntityTypeFromFQN(sFullyQualifiedName: string): EntityType | undefined {
-		const mEntityType = (this._oSideEffectsService.getConvertedMetaModel() as ConverterOutput).entityTypes.find(oEntityType => {
+		const mEntityType = (this._oSideEffectsService.getConvertedMetaModel() as ConverterOutput).entityTypes.find((oEntityType) => {
 			return oEntityType.fullyQualifiedName === sFullyQualifiedName;
 		});
 		return mEntityType;
@@ -473,11 +474,11 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oEvent Field change event
 	 * @returns {object} Field promise
 	 */
-	private _getFieldPromise(oEvent: UI5Event): Promise<any> {
+	private _getFieldPromise(oEvent: Event): Promise<any> {
 		const promise = oEvent.getParameter("promise") || Promise.resolve();
 
 		return promise.then(() => {
-			const oPromise = new Promise(function(resolve, reject) {
+			const oPromise = new Promise(function (resolve, reject) {
 				if (!FieldRuntime.getFieldStateOnChange(oEvent).state.validity) {
 					reject();
 				} else {
@@ -496,8 +497,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param {object} oEvent Field change event
 	 * @returns {object} Field properties (event change promise, field, SideEffects related to this field)
 	 */
-	private _getFieldProperties(oEvent: UI5Event): FieldEventPropertyType {
-		const oField: FieldControl = oEvent.getSource();
+	private _getFieldProperties(oEvent: Event): FieldEventPropertyType {
+		const oField: FieldControl = oEvent.getSource() as FieldControl;
 
 		return {
 			promise: this._getFieldPromise(oEvent),
@@ -521,12 +522,12 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		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 ConverterOutput).entitySets.find((oEntitySet) => {
 				return oEntitySet.name === sViewEntitySetSetName;
 			});
 
 		// SideEffects coming from an OData Service
-		aFieldGroupIds.forEach(sFieldGroupId => {
+		aFieldGroupIds.forEach((sFieldGroupId) => {
 			const bIsImmediate: boolean = sFieldGroupId.indexOf("$$ImmediateRequest") !== -1,
 				sName: string = sFieldGroupId.replace("$$ImmediateRequest", ""),
 				aSideEffectParts: string[] = sName.split("#"),
@@ -535,10 +536,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					sSideEffectEntityType +
 					"@com.sap.vocabularies.Common.v1.SideEffects" +
 					(aSideEffectParts.length === 2 ? "#" + aSideEffectParts[1] : ""),
-				oSideEffect: SideEffectsType | undefined = this._oSideEffectsService.getODataEntitySideEffects(sSideEffectEntityType)?.[
-					sSideEffectPath
-				],
-				oContext: Context<any> | undefined = this._getContextForSideEffects(oField, sSideEffectEntityType);
+				oSideEffect: SideEffectsType | undefined =
+					this._oSideEffectsService.getODataEntitySideEffects(sSideEffectEntityType)?.[sSideEffectPath],
+				oContext: Context | undefined = this._getContextForSideEffects(oField, sSideEffectEntityType);
 			if (oSideEffect && oContext) {
 				mSideEffectsMap[sName] = {
 					name: sName,
@@ -552,17 +552,17 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		//SideEffects coming from control(s)
 		if (sViewEntitySetSetName && oViewEntitySet) {
 			const sViewEntityType = oViewEntitySet.entityType.fullyQualifiedName,
-				mFieldPath: any = (oField.getAggregation("customData") as any[]).find(oCustomData => {
+				mFieldPath: any = (oField.getAggregation("customData") as any[]).find((oCustomData) => {
 					return oCustomData.getKey() === "sourcePath";
 				}),
-				oContext: Context<any> | undefined = this._getContextForSideEffects(oField, sViewEntityType);
+				oContext: Context | undefined = this._getContextForSideEffects(oField, sViewEntityType);
 
 			if (mFieldPath && oContext) {
 				const sFieldPath = mFieldPath.getValue().replace("/" + sViewEntitySetSetName + "/", ""),
 					mControlEntityType = this._oSideEffectsService.getControlEntitySideEffects(
 						sViewEntityType
 					) as ControlSideEffectsEntityDictionary;
-				Object.keys(mControlEntityType).forEach(sControlName => {
+				Object.keys(mControlEntityType).forEach((sControlName) => {
 					const oControlSideEffects: SideEffectsType = mControlEntityType[sControlName];
 					if ((oControlSideEffects.SourceProperties as string[]).includes(sFieldPath)) {
 						const sName = sControlName + "::" + sViewEntityType;
@@ -601,7 +601,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 
 		oFieldGroupPreRequisite = oFieldGroupPreRequisite || Promise.resolve();
 
-		Object.keys(mFieldSideEffectsMap).forEach(sSideEffectName => {
+		Object.keys(mFieldSideEffectsMap).forEach((sSideEffectName) => {
 			const oSideEffectProperty: FieldSideEffectPropertyType = mFieldSideEffectsMap[sSideEffectName],
 				sSideEffectContextPath = oSideEffectProperty.context.getPath(),
 				aFailedSideEffects = this._mFailedSideEffects[sSideEffectContextPath];
@@ -610,7 +610,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			if (aFailedSideEffects) {
 				delete this._mFailedSideEffects[sSideEffectContextPath];
 				mFailedSideEffectsName[sSideEffectContextPath] = {};
-				aFailedSideEffects.forEach(mFailedSideEffects => {
+				aFailedSideEffects.forEach((mFailedSideEffects) => {
 					mFailedSideEffectsName[sSideEffectContextPath][mFailedSideEffects.fullyQualifiedName] = true;
 					aImmediateSideEffectsProperties.push({
 						name: sSideEffectName,
@@ -661,7 +661,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			// Retrieves all properties used by the field
 			const oFieldBinding: any = this._getBindingForField(oField);
 			const aFieldPaths = oFieldBinding.isA("sap.ui.model.CompositeBinding")
-				? ((oFieldBinding as any).getBindings() || []).map((oBinding: any) => oBinding.sPath)
+				? (oFieldBinding.getBindings() || []).map((oBinding: any) => oBinding.sPath)
 				: [oFieldBinding.getPath()];
 
 			// Stores status for all properties
@@ -682,9 +682,9 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 */
 	private _getBindingForField(oField: FieldControl): Binding {
 		let sBindingName = "value";
-		if (oField.isA<CheckBox>("sap.m.CheckBox")) {
+		if (oField.isA("sap.m.CheckBox")) {
 			sBindingName = "selected";
-		} else if (oField.isA<FileUploader>("sap.ui.unified.FileUploader")) {
+		} else if (oField.isA("sap.fe.core.controls.FileWrapper")) {
 			sBindingName = "uploadUrl";
 		}
 		return oField.getBinding(sBindingName);