@sapui5/sap.fe.core 1.99.0 → 1.101.1

package/src/sap/fe/core/actions/messageHandling.ts

@@ -1,22 +1,23 @@
-import MessageToast from "sap/m/MessageToast";
-import MessageItem from "sap/m/MessageItem";
-import MessageView from "sap/m/MessageView";
+import Bar from "sap/m/Bar";
 import Button from "sap/m/Button";
 import Dialog from "sap/m/Dialog";
+import FormattedText from "sap/m/FormattedText";
+import MessageBox from "sap/m/MessageBox";
+import MessageItem from "sap/m/MessageItem";
+import MessageToast from "sap/m/MessageToast";
+import MessageView from "sap/m/MessageView";
 import Text from "sap/m/Text";
+import ManagedObject from "sap/ui/base/ManagedObject";
+import Core from "sap/ui/core/Core";
+import DateFormat from "sap/ui/core/format/DateFormat";
+import IconPool from "sap/ui/core/IconPool";
 import CoreLib from "sap/ui/core/library";
+import Message from "sap/ui/core/message/Message";
+import Control from "sap/ui/mdc/Control";
 import Filter from "sap/ui/model/Filter";
 import FilterOperator from "sap/ui/model/FilterOperator";
-import Message from "sap/ui/core/message/Message";
-import IconPool from "sap/ui/core/IconPool";
 import JSONModel from "sap/ui/model/json/JSONModel";
-import DateFormat from "sap/ui/core/format/DateFormat";
-import ResourceBundle from "sap/base/i18n/ResourceBundle";
-import Control from "sap/ui/mdc/Control";
-import ManagedObject from "sap/ui/base/ManagedObject";
-import Bar from "sap/m/Bar";
-import MessageBox from "sap/m/MessageBox";
-import FormattedText from "sap/m/FormattedText";
+import { CoreEx } from "types/extension_types";
 
 const MessageType = CoreLib.MessageType;
 let aMessageList: any[] = [];
@@ -39,6 +40,7 @@ export type messageHandlingType = {
 	removeBoundTransitionMessages: () => void;
 	modifyETagMessagesOnly: (oMessageManager: any, oResourceBundle: any) => boolean;
 	getRetryAfterMessage: (oMessage: any, bMessageDialog?: any) => any;
+	prepareMessageViewForDialog: (oMessageDialogModel: JSONModel, bStrictHandlingFlow: boolean) => any;
 };
 
 function fnFormatTechnicalDetails() {
@@ -89,7 +91,7 @@ function fnFormatTechnicalDetails() {
 	}
 
 	let sHTML = "Object.keys(" + "${technicalDetails}" + ').length > 0 ? "<h2>Technical Details</h2>" : "" ';
-	getPaths().forEach(function(oProperty: { groupName: string; property: string }) {
+	getPaths().forEach(function (oProperty: { groupName: string; property: string }) {
 		sHTML = sHTML + insertGroupName(oProperty) + "" + insertDetail(oProperty) + " + ";
 	});
 	return sHTML;
@@ -134,7 +136,7 @@ function fnModifyETagMessagesOnly(oMessageManager: any, oResourceBundle: any) {
 	const aMessages = oMessageManager.getMessageModel().getObject("/");
 	let bMessagesModified = false;
 	let sEtagMessage = "";
-	aMessages.forEach(function(oMessage: any, i: any) {
+	aMessages.forEach(function (oMessage: any, i: any) {
 		const oTechnicalDetails = oMessage.getTechnicalDetails();
 		if (oTechnicalDetails && oTechnicalDetails.httpStatus === 412) {
 			sEtagMessage = sEtagMessage || oResourceBundle.getText("C_APP_COMPONENT_SAPFE_ETAG_TECHNICAL_ISSUES");
@@ -152,12 +154,16 @@ function dialogCloseHandler() {
 	oDialog.close();
 	oBackButton.setVisible(false);
 	aMessageList = [];
+	const oMessageDialogModel: any = oMessageView.getModel();
+	if (oMessageDialogModel) {
+		oMessageDialogModel.setData({});
+	}
 	removeUnboundTransitionMessages();
 }
-function getRetryAfterMessage(oMessage: any, bMessageDialog: any) {
+function getRetryAfterMessage(oMessage: any, bMessageDialog?: any) {
 	const dNow = new Date();
 	const oTechnicalDetails = oMessage.getTechnicalDetails();
-	const oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+	const oResourceBundle = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 	let sRetryAfterMessage;
 	if (oTechnicalDetails && oTechnicalDetails.httpStatus === 503 && oTechnicalDetails.retryAfter) {
 		const dRetryAfter = oTechnicalDetails.retryAfter;
@@ -196,6 +202,65 @@ function getRetryAfterMessage(oMessage: any, bMessageDialog: any) {
 	}
 	return sRetryAfterMessage;
 }
+
+function prepareMessageViewForDialog(oMessageDialogModel: JSONModel, bStrictHandlingFlow: boolean) {
+	if (!bStrictHandlingFlow) {
+		oMessageTemplate =
+			oMessageTemplate ||
+			new MessageItem(undefined, {
+				counter: { path: "counter" },
+				title: "{message}",
+				subtitle: "{additionalText}",
+				longtextUrl: "{descriptionUrl}",
+				type: { path: "type" },
+				description:
+					"{= ${" +
+					"description} || ${technicalDetails} ? " +
+					'"<html><body>" + ' +
+					fnFormatDescription() +
+					" + " +
+					fnFormatTechnicalDetails() +
+					'"</body></html>"' +
+					' : "" }',
+				markupDescription: true
+			});
+	} else {
+		oMessageTemplate = new MessageItem({
+			title: "{message}",
+			type: "Warning",
+			longtextUrl: "{descriptionUrl}"
+		});
+	}
+	oMessageView =
+		oMessageView ||
+		new MessageView({
+			showDetailsPageHeader: false,
+			itemSelect: function () {
+				oBackButton.setVisible(true);
+			},
+			items: {
+				path: "/",
+				template: oMessageTemplate
+			}
+		});
+	oBackButton =
+		oBackButton ||
+		new Button({
+			icon: IconPool.getIconURI("nav-back"),
+			visible: false,
+			press: function (this: Button) {
+				oMessageView.navigateBack();
+				this.setVisible(false);
+			}
+		});
+	// Update proper ETag Mismatch error
+	oMessageView.setModel(oMessageDialogModel);
+	return {
+		oMessageView,
+		oBackButton
+	};
+}
+
 function showUnboundMessages(
 	this: messageHandlingType,
 	aCustomMessages?: any[],
@@ -204,7 +269,7 @@ function showUnboundMessages(
 	bShowBoundTransition?: boolean
 ) {
 	let aUnboundMessages = this.getMessages();
-	const oMessageManager = (sap.ui.getCore() as any).getMessageManager();
+	const oMessageManager = Core.getMessageManager();
 	let sHighestPriority;
 	let sHighestPriorityText;
 	const aFilters = [
@@ -218,10 +283,10 @@ function showUnboundMessages(
 		aUnboundMessages = aUnboundMessages.concat(getMessages(true, true));
 		// we only want to show bound transition messages not bound state messages hence add a filter for the same
 		aFilters.push(new Filter({ path: "persistent", operator: FilterOperator.EQ, value1: true }));
-		const fnCheckControlIdInDialog = function(aControlIds: any) {
+		const fnCheckControlIdInDialog = function (aControlIds: any) {
 			let index = Infinity,
-				oControl = sap.ui.getCore().byId(aControlIds[0]) as ManagedObject;
-			const errorFieldControl = sap.ui.getCore().byId(aControlIds[0]) as Control;
+				oControl = Core.byId(aControlIds[0]) as ManagedObject;
+			const errorFieldControl = Core.byId(aControlIds[0]) as Control;
 			while (oControl) {
 				const fieldRankinDialog =
 					oControl instanceof Dialog
@@ -252,7 +317,7 @@ function showUnboundMessages(
 		aFilters.push(new Filter({ path: "target", operator: FilterOperator.EQ, value1: "" }));
 	}
 	if (aCustomMessages && aCustomMessages.length) {
-		aCustomMessages.forEach(function(oMessage: any) {
+		aCustomMessages.forEach(function (oMessage: any) {
 			const messageCode = oMessage.code ? oMessage.code : "";
 			oMessageManager.addMessages(
 				new Message({
@@ -266,7 +331,7 @@ function showUnboundMessages(
 			//The target and persistent properties of the message are hardcoded as "" and true because the function deals with only unbound messages.
 		});
 	}
-	const oMessageDialogModel = new JSONModel();
+	const oMessageDialogModel = (oMessageView && (oMessageView.getModel() as JSONModel)) || new JSONModel();
 	if (aUnboundMessages.length === 1 && aUnboundMessages[0].getCode() === "503") {
 		showMessageBox = true;
 	} else {
@@ -279,7 +344,7 @@ function showUnboundMessages(
 			// using the message model again for the message dialog view and then filtering on that binding again is unnecessary.
 			// So we create new json model to use for the message dialog view.
 			const aMessages: any[] = [];
-			aCurrentContexts.forEach(function(oContext: any) {
+			aCurrentContexts.forEach(function (oContext: any) {
 				let oMessage;
 				if (
 					oContext.getObject().technicalDetails &&
@@ -298,75 +363,39 @@ function showUnboundMessages(
 			// if(aMessages.length === 0 && aMessageList.length) {
 			// 	oMessageDialogModel.setData(aMessages);
 			// }
-			oMessageDialogModel.setData(aMessageDataList);
+			let existingMessages: any[] = [];
+			if (Array.isArray(oMessageDialogModel.getData())) {
+				existingMessages = oMessageDialogModel.getData();
+			}
+			oMessageDialogModel.setData(aMessageDataList.concat(existingMessages));
 		}
 	}
 	if (aUnboundMessages.length === 0 && !aCustomMessages && !bHasEtagMessage) {
 		// Don't show the popup if there are no transient messages
 		return Promise.resolve(true);
 	} else if (aUnboundMessages.length === 1 && aUnboundMessages[0].getType() === MessageType.Success && !aCustomMessages) {
-		return new Promise<void>(resolve => {
+		return new Promise<void>((resolve) => {
 			MessageToast.show(aUnboundMessages[0].message);
 			oMessageManager.removeMessages(aUnboundMessages);
 			resolve();
 		});
 	} else if (showMessageDialog) {
 		aResolveFunctions = aResolveFunctions || [];
-		return new Promise(function(resolve: (value: any) => void, reject: (reason?: any) => void) {
+		return new Promise(function (resolve: (value: any) => void, reject: (reason?: any) => void) {
 			aResolveFunctions.push(resolve);
-			(sap.ui.getCore().getLibraryResourceBundle("sap.fe.core", true) as Promise<ResourceBundle>)
-				.then(function(oResourceBundle: any) {
-					oMessageTemplate =
-						oMessageTemplate ||
-						new MessageItem(undefined, {
-							counter: { path: "counter" },
-							title: "{message}",
-							subtitle: "{additionalText}",
-							longtextUrl: "{descriptionUrl}",
-							type: { path: "type" },
-							description:
-								"{= ${" +
-								"description} || ${technicalDetails} ? " +
-								'"<html><body>" + ' +
-								fnFormatDescription() +
-								" + " +
-								fnFormatTechnicalDetails() +
-								'"</body></html>"' +
-								' : "" }',
-							markupDescription: true
-						});
-					oMessageView =
-						oMessageView ||
-						new MessageView({
-							showDetailsPageHeader: false,
-							itemSelect: function() {
-								oBackButton.setVisible(true);
-							},
-							items: {
-								path: "/",
-								template: oMessageTemplate
-							}
-						});
-					oBackButton =
-						oBackButton ||
-						new Button({
-							icon: IconPool.getIconURI("nav-back"),
-							visible: false,
-							press: function(this: Button) {
-								oMessageView.navigateBack();
-								this.setVisible(false);
-							}
-						});
-					// Update proper ETag Mismatch error
+			(Core as CoreEx)
+				.getLibraryResourceBundle("sap.fe.core", true)
+				.then(function (oResourceBundle: any) {
+					const bStrictHandlingFlow = false;
 					const bHasEtagMessage = fnModifyETagMessagesOnly(oMessageManager, oResourceBundle);
-					oMessageView.setModel(oMessageDialogModel);
+					const oMessageObject = prepareMessageViewForDialog(oMessageDialogModel, bStrictHandlingFlow);
 					oDialog =
 						oDialog ||
 						new Dialog({
 							resizable: true,
-							content: oMessageView,
+							content: oMessageObject.oMessageView,
 							endButton: new Button({
-								press: function() {
+								press: function () {
 									dialogCloseHandler();
 									// also remove bound transition messages if we were showing them
 									if (bShowBoundTransition) {
@@ -386,7 +415,7 @@ function showUnboundMessages(
 							contentWidth: "37.5em",
 							contentHeight: "21.5em",
 							verticalScrolling: false,
-							afterClose: function() {
+							afterClose: function () {
 								for (let i = 0; i < aResolveFunctions.length; i++) {
 									aResolveFunctions[i].call();
 								}
@@ -395,10 +424,10 @@ function showUnboundMessages(
 						});
 
 					if (bHasEtagMessage) {
-						sap.ui.require(["sap/m/ButtonType"], function(ButtonType: any) {
+						sap.ui.require(["sap/m/ButtonType"], function (ButtonType: any) {
 							oDialog.setBeginButton(
 								new Button({
-									press: function() {
+									press: function () {
 										dialogCloseHandler();
 										if (oContext.hasPendingChanges()) {
 											oContext.getBinding().resetChanges();
@@ -423,7 +452,7 @@ function showUnboundMessages(
 				.catch(reject);
 		});
 	} else if (showMessageBox) {
-		return new Promise(function(resolve) {
+		return new Promise(function (resolve) {
 			const oMessage = aUnboundMessages[0];
 			if (oMessage.technicalDetails && aMessageList.indexOf(oMessage.technicalDetails.originalMessage.message) === -1) {
 				aMessageList.push(oMessage.technicalDetails.originalMessage.message);
@@ -437,7 +466,7 @@ function showUnboundMessages(
 					htmlText: formattedTextString
 				});
 				MessageBox.error(formattedText, {
-					onClose: function() {
+					onClose: function () {
 						aMessageList = [];
 						if (bShowBoundTransition) {
 							removeBoundTransitionMessages();
@@ -453,7 +482,7 @@ function showUnboundMessages(
 	}
 }
 function getTranslatedTextForMessageDialog(sHighestPriority: any) {
-	const oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+	const oResourceBundle = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 	switch (sHighestPriority) {
 		case "Error":
 			return oResourceBundle.getText("C_COMMON_SAPFE_ERROR_MESSAGES_PAGE_TITLE_ERROR");
@@ -475,10 +504,10 @@ function removeBoundTransitionMessages() {
 }
 function getMessages(bBoundMessages: boolean = false, bTransitionOnly: boolean = false) {
 	let i;
-	const oMessageManager = (sap.ui.getCore() as any).getMessageManager(),
+	const oMessageManager = (Core as CoreEx as any).getMessageManager(),
 		oMessageModel = oMessageManager.getMessageModel(),
 		aMessages = oMessageModel.getObject("/"),
-		oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle,
+		oResourceBundle = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core"),
 		aTransitionMessages = [];
 
 	for (i = 0; i < aMessages.length; i++) {
@@ -507,7 +536,7 @@ function removeTransitionMessages(bBoundMessages: any) {
 	const aMessagesToBeDeleted = getMessages(bBoundMessages, true);
 
 	if (aMessagesToBeDeleted.length > 0) {
-		(sap.ui.getCore() as any).getMessageManager().removeMessages(aMessagesToBeDeleted);
+		Core.getMessageManager().removeMessages(aMessagesToBeDeleted);
 	}
 }
 
@@ -526,7 +555,8 @@ const messageHandling: messageHandlingType = {
 	removeUnboundTransitionMessages: removeUnboundTransitionMessages,
 	removeBoundTransitionMessages: removeBoundTransitionMessages,
 	modifyETagMessagesOnly: fnModifyETagMessagesOnly,
-	getRetryAfterMessage: getRetryAfterMessage
+	getRetryAfterMessage: getRetryAfterMessage,
+	prepareMessageViewForDialog: prepareMessageViewForDialog
 };
 
 export default messageHandling;