@sapui5/sap.fe.core 1.111.0 → 1.112.0

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

@@ -1,5 +1,4 @@
 import Log from "sap/base/Log";
-import SideEffectsHelper from "sap/fe/core/helpers/SideEffectsHelper";
 import type {
 	ControlSideEffectsType,
 	ODataSideEffectsType,
@@ -11,9 +10,8 @@ import type Event from "sap/ui/base/Event";
 import type Control from "sap/ui/core/Control";
 import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 import type View from "sap/ui/core/mvc/View";
-import Context from "sap/ui/model/Context";
+import Context from "sap/ui/model/odata/v4/Context";
 import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
-import { V4Context } from "types/extension_types";
 import CommonUtils from "../CommonUtils";
 import { BaseManifestSettings } from "../converters/ManifestSettings";
 import { defineUI5Class, finalExtension, methodOverride, privateExtension, publicExtension } from "../helpers/ClassSupport";
@@ -28,7 +26,7 @@ type BaseSideEffectPropertyType = {
 export type MassEditFieldSideEffectPropertyType = BaseSideEffectPropertyType;
 
 export type FieldSideEffectPropertyType = BaseSideEffectPropertyType & {
-	context: V4Context;
+	context: Context;
 };
 
 export type FieldSideEffectDictionary = Record<string, FieldSideEffectPropertyType>;
@@ -42,13 +40,19 @@ export type FieldGroupSideEffectType = {
 	sideEffectProperty: FieldSideEffectPropertyType;
 };
 
+const IMMEDIATE_REQUEST = "$$ImmediateRequest";
 @defineUI5Class("sap.fe.core.controllerextensions.SideEffects")
 class SideEffectsControllerExtension extends ControllerExtension {
 	protected base!: PageController;
+
 	private _view!: View;
+
 	private _registeredFieldGroupMap!: Record<string, FieldGroupSideEffectType>;
+
 	private _fieldGroupInvalidity!: Record<string, Record<string, boolean>>;
+
 	private _sideEffectsService!: SideEffectsService;
+
 	private _registeredFailedSideEffects!: FailedSideEffectDictionary;
 
 	@methodOverride()
@@ -148,19 +152,22 @@ class SideEffectsControllerExtension extends ControllerExtension {
 			});
 
 		// SideEffects coming from an OData Service
-		sideEffectsMap = this.getSideEffectsMapForFieldGroups(fieldGroupIds, field) as FieldSideEffectDictionary;
+		sideEffectsMap = this.getSideEffectsMapForFieldGroups(
+			fieldGroupIds,
+			field.getBindingContext() as Context | null | undefined
+		) as FieldSideEffectDictionary;
 
 		// SideEffects coming from control(s)
 		if (viewEntitySetSetName && viewEntitySet) {
 			const viewEntityType = viewEntitySet.entityType.fullyQualifiedName,
 				fieldPath = this.getTargetProperty(field),
-				context = this.getContextForSideEffects(field.getBindingContext(), viewEntityType) as V4Context | undefined;
+				context = this.getContextForSideEffects(field.getBindingContext(), viewEntityType);
 
 			if (fieldPath && context) {
 				const controlSideEffectsEntityType = this._sideEffectsService.getControlEntitySideEffects(viewEntityType);
 				Object.keys(controlSideEffectsEntityType).forEach((sideEffectsName) => {
 					const oControlSideEffects = controlSideEffectsEntityType[sideEffectsName];
-					if (oControlSideEffects.SourceProperties.includes(fieldPath)) {
+					if (oControlSideEffects.sourceProperties.includes(fieldPath)) {
 						const name = `${sideEffectsName}::${viewEntityType}`;
 						sideEffectsMap[name] = {
 							name: name,
@@ -181,7 +188,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @function
 	 * @name getSideEffectsMapForFieldGroups
 	 * @param fieldGroupIds Field group ids
-	 * @param field Field control
+	 * @param fieldContext Field binding context
 	 * @returns SideEffects map
 	 */
 
@@ -189,21 +196,19 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	@finalExtension()
 	getSideEffectsMapForFieldGroups(
 		fieldGroupIds: string[],
-		field?: Control
+		fieldContext?: Context | null
 	): MassEditFieldSideEffectDictionary | FieldSideEffectDictionary {
 		const mSideEffectsMap: MassEditFieldSideEffectDictionary | FieldSideEffectDictionary = {};
 		fieldGroupIds.forEach((fieldGroupId) => {
 			const { name, immediate, sideEffects, sideEffectEntityType } = this._getSideEffectsPropertyForFieldGroup(fieldGroupId);
-			const oContext = field
-				? (this.getContextForSideEffects(field.getBindingContext(), sideEffectEntityType) as V4Context)
-				: undefined;
-			if (sideEffects && (!field || (field && oContext))) {
+			const oContext = fieldContext ? (this.getContextForSideEffects(fieldContext, sideEffectEntityType) as Context) : undefined;
+			if (sideEffects && (!fieldContext || (fieldContext && oContext))) {
 				mSideEffectsMap[name] = {
 					name,
 					immediate,
 					sideEffects
 				};
-				if (field) {
+				if (fieldContext) {
 					(mSideEffectsMap[name] as FieldSideEffectPropertyType).context = oContext!;
 				}
 			}
@@ -234,7 +239,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 */
 	@publicExtension()
 	@finalExtension()
-	isFieldGroupValid(fieldGroupId: string, context: V4Context): boolean {
+	isFieldGroupValid(fieldGroupId: string, context: Context): boolean {
 		const id = this._getFieldGroupIndex(fieldGroupId, context);
 		return Object.keys(this._fieldGroupInvalidity[id] ?? {}).length === 0;
 	}
@@ -328,20 +333,15 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 */
 	@publicExtension()
 	@finalExtension()
-	async requestSideEffects(
-		sideEffects: SideEffectsType,
-		context: V4Context,
-		groupId?: string,
-		fnGetTargets?: Function
-	): Promise<unknown> {
+	async requestSideEffects(sideEffects: SideEffectsType, context: Context, groupId?: string, fnGetTargets?: Function): Promise<unknown> {
 		let targets: SideEffectsTarget[], triggerAction;
 		if (fnGetTargets) {
 			const targetsAndActionData = await fnGetTargets(sideEffects);
 			targets = targetsAndActionData["aTargets"];
 			triggerAction = targetsAndActionData["TriggerAction"];
 		} else {
-			targets = [...(sideEffects.TargetEntities ?? []), ...(sideEffects.TargetProperties ?? [])];
-			triggerAction = (sideEffects as ODataSideEffectsType).TriggerAction;
+			targets = [...(sideEffects.targetEntities ?? []), ...(sideEffects.targetProperties ?? [])];
+			triggerAction = (sideEffects as ODataSideEffectsType).triggerAction;
 		}
 		if (triggerAction) {
 			this._sideEffectsService.executeAction(triggerAction, context, groupId);
@@ -487,7 +487,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 	 * @param context SAPUI5 Context
 	 * @returns Index
 	 */
-	private _getFieldGroupIndex(fieldGroupId: string, context: V4Context): string {
+	private _getFieldGroupIndex(fieldGroupId: string, context: Context): string {
 		return `${fieldGroupId}_${context.getPath()}`;
 	}
 
@@ -511,8 +511,8 @@ class SideEffectsControllerExtension extends ControllerExtension {
 		 * be deferred (on field group focus out)
 		 *
 		 */
-		const immediate = fieldGroupId.indexOf(SideEffectsHelper.IMMEDIATE_REQUEST) !== -1,
-			name = fieldGroupId.replace(SideEffectsHelper.IMMEDIATE_REQUEST, ""),
+		const immediate = fieldGroupId.indexOf(IMMEDIATE_REQUEST) !== -1,
+			name = fieldGroupId.replace(IMMEDIATE_REQUEST, ""),
 			sideEffectParts = name.split("#"),
 			sideEffectEntityType = sideEffectParts[0],
 			sideEffectPath = `${sideEffectEntityType}@com.sap.vocabularies.Common.v1.SideEffects${
@@ -554,7 +554,7 @@ class SideEffectsControllerExtension extends ControllerExtension {
 					const failedSideEffects = this._registeredFailedSideEffects[contextPath] ?? [];
 					this.unregisterFailedSideEffectsForAContext(contextPath);
 					for (const failedSideEffect of failedSideEffects) {
-						failedSideEffectsPromises.push(this.requestSideEffects(failedSideEffect, context as V4Context));
+						failedSideEffectsPromises.push(this.requestSideEffects(failedSideEffect, context as Context));
 					}
 				}
 			}