@sapui5/sap.fe.templates 1.114.0 → 1.114.2

package/src/sap/fe/templates/ObjectPage/ObjectPageController.controller.ts

@@ -19,9 +19,11 @@ import ViewState from "sap/fe/core/controllerextensions/ViewState";
 import { defineUI5Class, extensible, finalExtension, publicExtension, usingExtension } from "sap/fe/core/helpers/ClassSupport";
 import type { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
+import { recommendationHelper } from "sap/fe/core/helpers/RecommendationHelper";
 import { getResourceModel } from "sap/fe/core/helpers/ResourceModelHelper";
 import FELibrary from "sap/fe/core/library";
 import PageController from "sap/fe/core/PageController";
+import type { ViewData } from "sap/fe/core/services/TemplatedViewServiceFactory";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import DelegateUtil from "sap/fe/macros/DelegateUtil";
 import type TableAPI from "sap/fe/macros/table/TableAPI";
@@ -36,6 +38,7 @@ import InstanceManager from "sap/m/InstanceManager";
 import Link from "sap/m/Link";
 import MessageBox from "sap/m/MessageBox";
 import type Popover from "sap/m/Popover";
+import Control from "sap/ui/core/Control";
 import Core from "sap/ui/core/Core";
 import Message from "sap/ui/core/message/Message";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
@@ -59,6 +62,10 @@ import PaginatorOverride from "./overrides/Paginator";
 import ShareOverrides from "./overrides/Share";
 import ViewStateOverrides from "./overrides/ViewState";
 
+type BindingParams = {
+	redirectedToNonDraft?: string | undefined;
+};
+
 const ProgrammingModel = FELibrary.ProgrammingModel;
 @defineUI5Class("sap.fe.templates.ObjectPage.ObjectPageController")
 class ObjectPageController extends PageController {
@@ -121,6 +128,8 @@ class ObjectPageController extends PageController {
 
 	private messageButton: any;
 
+	private collaborationMessage?: Message;
+
 	@publicExtension()
 	@finalExtension()
 	getExtensionAPI(sId?: string): ExtensionAPI {
@@ -199,8 +208,6 @@ class ObjectPageController extends PageController {
 	_fnShowOPMessage() {
 		const extensionAPI = this.getExtensionAPI();
 		const view = this.getView();
-		const internalContext = view?.getBindingContext("internal");
-		const stripVisible = internalContext?.getProperty("OPMessageStripVisibility");
 		const messages = this.messageButton.oMessagePopover
 			.getItems()
 			.map((item: any) => item.getBindingContext("message").getObject())
@@ -208,7 +215,7 @@ class ObjectPageController extends PageController {
 				return message.getTargets()[0] === view.getBindingContext()?.getPath();
 			});
 
-		if (extensionAPI && !(messages.length === 0 && stripVisible)) {
+		if (extensionAPI) {
 			extensionAPI.showMessages(messages);
 		}
 	}
@@ -227,7 +234,11 @@ class ObjectPageController extends PageController {
 		const changeClassForTables = (event: Event, lastVisibleSubSection: ObjectPageSubSection) => {
 			const blocks = [...lastVisibleSubSection.getBlocks(), ...lastVisibleSubSection.getMoreBlocks()];
 			const tableType = blocks.length === 1 && this.searchTableInBlock(blocks[0] as SubSectionBlock)?.getType();
-			if (tableType && (tableType?.isA("sap.ui.mdc.table.GridTableType") || tableType?.isA("sap.ui.mdc.table.TreeTableType"))) {
+			if (
+				tableType &&
+				((tableType as Control)?.isA("sap.ui.mdc.table.GridTableType") ||
+					(tableType as Control)?.isA("sap.ui.mdc.table.TreeTableType"))
+			) {
 				//In case there is only a single table in a subSection we fit that to the whole page so that the scrollbar comes only on table and not on page
 				lastVisibleSubSection.addStyleClass("sapUxAPObjectPageSubSectionFitContainer");
 				lastVisibleSubSection.detachEvent("modelContextChange", changeClassForTables, this);
@@ -381,7 +392,7 @@ class ObjectPageController extends PageController {
 			const aSections = oObjectPage.getSections();
 			const bUseIconTabBar = oObjectPage.getUseIconTabBar();
 			let iSkip = 2;
-			const bIsInEditMode = oObjectPage.getModel("ui").getProperty("/isEditable");
+			const bIsInEditMode = oObjectPage?.getModel("ui")?.getProperty("/isEditable");
 			const bEditableHeader = (this.getView().getViewData() as any).editableHeaderContent;
 			for (let iSection = 0; iSection < aSections.length; iSection++) {
 				const oSection = aSections[iSection];
@@ -517,7 +528,9 @@ class ObjectPageController extends PageController {
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	_onAfterBinding(inputBindingContext: any, mParameters: any) {
+	_onAfterBinding(inputBindingContext: Context | undefined, mParameters: BindingParams | undefined): void {
+		const view = this.getView();
+		const viewLevel = (view?.getViewData() as ViewData)?.viewLevel;
 		const oObjectPage = this._getObjectPageLayoutControl();
 		const aTables = this._findTables();
 
@@ -625,7 +638,7 @@ class ObjectPageController extends PageController {
 			if (ModelHelper.isCollaborationDraftSupported(oModel.getMetaModel())) {
 				oFinalUIState
 					.then(() => {
-						if (this.getView().getModel("ui").getProperty("/isEditable")) {
+						if (this.getView()?.getModel("ui")?.getProperty("/isEditable")) {
 							connect(this.getView());
 						} else if (isConnected(this.getView())) {
 							disconnect(this.getView()); // Cleanup collaboration connection in case we switch to another element (e.g. in FCL)
@@ -662,6 +675,14 @@ class ObjectPageController extends PageController {
 			//To Compute the Edit Binding of the subObject page using root object page, create a context for draft root and update the edit button in sub OP using the context
 			ActionRuntime.updateEditButtonVisibilityAndEnablement(this.getView());
 		}
+		// we are clearing any previous data from recommendations every time we come to new OP
+		// so that cached recommendations are not shown to user
+		if (viewLevel && viewLevel === 1) {
+			oFinalUIState?.then(() => {
+				recommendationHelper.clearRecommendations(view, inputBindingContext);
+				return;
+			});
+		}
 		this.displayCollaborationMessage(mParameters?.redirectedToNonDraft);
 	}
 
@@ -673,23 +694,20 @@ class ObjectPageController extends PageController {
 	 * @private
 	 */
 	displayCollaborationMessage(entityName: string | undefined) {
-		const internalBindingContext = this.getView()?.getBindingContext("internal");
 		const resourceBundle = Core.getLibraryResourceBundle("sap.fe.core");
+
+		if (this.collaborationMessage) {
+			Core.getMessageManager().removeMessages([this.collaborationMessage]);
+			delete this.collaborationMessage;
+		}
+
 		if (entityName) {
-			const message = new Message({
+			this.collaborationMessage = new Message({
 				message: resourceBundle.getText("REROUTED_NAVIGATION_TO_SAVED_VERSION", [entityName]),
-				type: "Information"
+				type: "Information",
+				target: this.getView()?.getBindingContext()?.getPath()
 			});
-			this.getExtensionAPI().showMessages([message]);
-		} else {
-			const messageToCompare = resourceBundle.getText("REROUTED_NAVIGATION_TO_SAVED_VERSION", ["{0}"]);
-			const lengthUntilVariable = messageToCompare.search("{");
-			if (
-				internalBindingContext?.getProperty("OPMessageStripText")?.substring(0, lengthUntilVariable) ===
-				messageToCompare.substring(0, lengthUntilVariable)
-			) {
-				this.getExtensionAPI().showMessages([]);
-			}
+			sap.ui.getCore().getMessageManager().addMessages([this.collaborationMessage]);
 		}
 	}
 
@@ -699,7 +717,7 @@ class ObjectPageController extends PageController {
 		const setFocus = () => {
 			// Set the focus to the first action button, or to the first editable input if in editable mode
 			const oObjectPage = this._getObjectPageLayoutControl();
-			const isInDisplayMode = !oObjectPage.getModel("ui").getProperty("/isEditable");
+			const isInDisplayMode = !oObjectPage?.getModel("ui")?.getProperty("/isEditable");
 
 			if (isInDisplayMode) {
 				const oFirstClickableElement = this._getFirstClickableElement(oObjectPage);
@@ -713,6 +731,10 @@ class ObjectPageController extends PageController {
 				}
 			}
 		};
+		const ctxt = this.getView().getBindingContext();
+		// setting this model data to be used for recommendations binding
+		(this.getView().getModel("internal") as JSONModel).setProperty("/currentCtxt", ctxt);
+
 		// Apply app state only after the page is ready with the first section selected
 		const oView = this.getView();
 		const oInternalModelContext = oView.getBindingContext("internal") as InternalModelContext;
@@ -753,7 +775,7 @@ class ObjectPageController extends PageController {
 		if (oBindingContext) {
 			const bIsStickyMode = ModelHelper.isStickySessionSupported(oBindingContext.getModel().getMetaModel());
 			if (bIsStickyMode) {
-				bIsStickyEditMode = this.getView().getModel("ui").getProperty("/isEditable");
+				bIsStickyEditMode = this.getView()?.getModel("ui")?.getProperty("/isEditable");
 			}
 		}
 		return bIsStickyEditMode;
@@ -868,11 +890,46 @@ class ObjectPageController extends PageController {
 		});
 	}
 
-	async _validateDocument(): Promise<void | any[] | ODataContextBinding> {
-		const appComponent = this.getAppComponent();
+	/**
+	 * Executes the validation of the document
+	 * One of the following actions is triggered on the draft version of the document:
+	 * - on a transient context:
+	 * - if the context gets data, wait for the creation of the context and execute the global validation
+	 * - if no data is found on this context, only the prepareAction is requested
+	 * - on a regular context, the global validation is requested.
+	 *
+	 * @returns Promise of the global validation or undefined if not executed
+	 */
+	async _validateDocument(): Promise<void | unknown[] | ODataContextBinding> {
 		const control = Core.byId(Core.getCurrentFocusedControlId());
 		const context = control?.getBindingContext() as Context | undefined;
-		if (context && !context.isTransient()) {
+
+		if (!context) {
+			return undefined;
+		}
+		if (context.isTransient()) {
+			if (context.hasPendingChanges()) {
+				await context.created();
+				return this.executeGlobalValidation(context);
+			}
+			return this.executeGlobalValidation(context, true);
+		}
+		return this.executeGlobalValidation(context);
+	}
+
+	/**
+	 * Executes the global validation of the draft
+	 * One of the following actions is triggered on the draft version of the document:
+	 * - the global side effects are executed if these side effects are defined in the context
+	 * - the draft Validation on the DraftRoot context.
+	 *
+	 * @param context The Context
+	 * @param byPassSideEffects Only the draft Validation step is executed
+	 * @returns Promise of the global validation
+	 */
+	async executeGlobalValidation(context: Context, byPassSideEffects = false): Promise<void | unknown[] | ODataContextBinding> {
+		const appComponent = this.getAppComponent();
+		if (!byPassSideEffects) {
 			const sideEffectsService = appComponent.getSideEffectsService();
 			const entityType = sideEffectsService.getEntityTypeFromContext(context);
 			const globalSideEffects = entityType ? sideEffectsService.getGlobalODataEntitySideEffects(entityType) : [];
@@ -881,14 +938,14 @@ class ObjectPageController extends PageController {
 				await this.editFlow.syncTask();
 				return Promise.all(globalSideEffects.map((sideEffects) => this._sideEffects.requestSideEffects(sideEffects, context)));
 			}
-			const draftRootContext = (await CommonUtils.createRootContext(ProgrammingModel.Draft, this.getView(), appComponent)) as Context;
-			//Execute the draftValidation if there is no globalSideEffects (ignore ETags in collaboration draft)
-			if (draftRootContext) {
-				await this.editFlow.syncTask();
-				return draft.executeDraftValidation(draftRootContext, appComponent, isConnected(this.getView()));
-			}
 		}
-		return undefined;
+
+		const draftRootContext = (await CommonUtils.createRootContext(ProgrammingModel.Draft, this.getView(), appComponent)) as Context;
+		//Execute the draftValidation if there is no globalSideEffects (ignore ETags in collaboration draft)
+		if (draftRootContext) {
+			await this.editFlow.syncTask();
+			return draft.executeDraftValidation(draftRootContext, appComponent, isConnected(this.getView()));
+		}
 	}
 
 	async _saveDocument(oContext: any) {
@@ -1089,7 +1146,7 @@ class ObjectPageController extends PageController {
 	}
 
 	/**
-	 * Scroll the tables to the row with the sPath
+	 * Scroll the tables to the row with the sPath.
 	 *
 	 * @function
 	 * @name sap.fe.templates.ObjectPage.ObjectPageController.controller#_scrollTablesToRow
@@ -1312,7 +1369,7 @@ class ObjectPageController extends PageController {
 
 				if (oMixedContext) {
 					for (const sKey in oMixedContext) {
-						if (sKey.indexOf("_") !== 0 && sKey.indexOf("odata.context") === -1) {
+						if (!sKey.startsWith("_") && !sKey.includes("odata.context")) {
 							oParams[sKey] = oMixedContext[sKey];
 						}
 					}
@@ -1378,9 +1435,9 @@ class ObjectPageController extends PageController {
 				if (mConditions.editActionEnabled) {
 					oController._editDocument(oContext);
 				}
-			} else if (iViewLevel === 1 && oObjectPage.getModel("ui").getProperty("/isEditable")) {
+			} else if (iViewLevel === 1 && oObjectPage?.getModel("ui")?.getProperty("/isEditable")) {
 				oController._saveDocument(oContext);
-			} else if (oObjectPage.getModel("ui").getProperty("/isEditable")) {
+			} else if (oObjectPage?.getModel("ui")?.getProperty("/isEditable")) {
 				oController._applyDocument(oContext);
 			}
 		},
@@ -1551,7 +1608,7 @@ class ObjectPageController extends PageController {
 			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
 			const oObjectPage = this._getObjectPageLayoutControl();
 			if (
-				oObjectPage.getModel("ui").getProperty("/isEditable") &&
+				oObjectPage?.getModel("ui")?.getProperty("/isEditable") &&
 				(this.getView().getViewData() as any).sectionLayout === "Tabs" &&
 				oInternalModelContext.getProperty("errorNavigationSectionFlag") === false
 			) {

package/src/sap/fe/templates/ObjectPage/manifest.json

@@ -4,7 +4,7 @@
 		"id": "sap.fe.templates.ObjectPage",
 		"type": "component",
 		"applicationVersion": {
-			"version": "1.114.0"
+			"version": "1.114.2"
 		},
 		"title": "Object Page",
 		"tags": {

package/src/sap/fe/templates/library-dbg.js

@@ -39,7 +39,7 @@ sap.ui.define(["sap/f/library", "sap/fe/core/library", "sap/fe/macros/library",
     controls: [],
     elements: [],
     // eslint-disable-next-line no-template-curly-in-string
-    version: "1.114.0",
+    version: "1.114.2",
     noLibraryCSS: true
   });
   if (!thisLib.ObjectPage) {