@sapui5/sap.fe.core 1.100.0 → 1.102.0

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

@@ -1,25 +1,32 @@
-import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
-import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
-import SelectionVariant from "sap/fe/navigation/SelectionVariant";
-import ModelHelper from "sap/fe/core/helpers/ModelHelper";
-import XMLPreprocessor from "sap/ui/core/util/XMLPreprocessor";
-import XMLTemplateProcessor from "sap/ui/core/XMLTemplateProcessor";
-import Fragment from "sap/ui/core/Fragment";
-import JSONModel from "sap/ui/model/json/JSONModel";
 import Log from "sap/base/Log";
-import CommonUtils from "sap/fe/core/CommonUtils";
-import KeepAliveHelper from "sap/fe/core/helpers/KeepAliveHelper";
 import mergeObjects from "sap/base/util/merge";
-import { Extensible, Final, Override, Private, Public, UI5Class } from "sap/fe/core/helpers/ClassSupport";
-import ControllerExtensionMetadata from "sap/fe/core/controllerextensions/ControllerExtensionMetadata";
 import AppComponent from "sap/fe/core/AppComponent";
-import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
-import View from "sap/ui/core/mvc/View";
+import draft from "sap/fe/core/controllerextensions/editFlow/draft";
+import {
+	defineUI5Class,
+	extensible,
+	finalExtension,
+	methodOverride,
+	privateExtension,
+	publicExtension
+} from "sap/fe/core/helpers/ClassSupport";
+import KeepAliveHelper from "sap/fe/core/helpers/KeepAliveHelper";
+import ModelHelper from "sap/fe/core/helpers/ModelHelper";
 import PageController from "sap/fe/core/PageController";
 import { NavigationService } from "sap/fe/core/services/NavigationServiceFactory";
-import Context from "sap/ui/model/Context";
+import SelectionVariant from "sap/fe/navigation/SelectionVariant";
 import Dialog from "sap/m/Dialog";
-import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import Core from "sap/ui/core/Core";
+import Fragment from "sap/ui/core/Fragment";
+import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
+import View from "sap/ui/core/mvc/View";
+import XMLPreprocessor from "sap/ui/core/util/XMLPreprocessor";
+import XMLTemplateProcessor from "sap/ui/core/XMLTemplateProcessor";
+import Context from "sap/ui/model/Context";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import { CoreEx } from "types/extension_types";
 
 /**
  * {@link sap.ui.core.mvc.ControllerExtension Controller extension}
@@ -30,14 +37,14 @@ import ResourceBundle from "sap/base/i18n/ResourceBundle";
  * @private
  * @since 1.84.0
  */
-@UI5Class("sap.fe.core.controllerextensions.InternalInternalBasedNavigation", ControllerExtensionMetadata)
+@defineUI5Class("sap.fe.core.controllerextensions.InternalInternalBasedNavigation")
 class InternalIntentBasedNavigation extends ControllerExtension {
-	private base!: PageController;
+	protected base!: PageController;
 	private _oAppComponent!: AppComponent;
 	private _oMetaModel!: ODataMetaModel;
 	private _oNavigationService!: NavigationService;
 	private _oView!: View;
-	@Override()
+	@methodOverride()
 	onInit() {
 		this._oAppComponent = this.base.getAppComponent();
 		this._oMetaModel = this._oAppComponent.getModel().getMetaModel() as ODataMetaModel;
@@ -71,8 +78,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @param {object} [mNavigationParameters.refreshStrategies]
 	 * @param {object} [mNavigationParameters.additionalNavigationParameters] Additional navigation parameters configured in the crossAppNavigation outbound parameters.
 	 **/
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	navigate(
 		sSemanticObject: string,
 		sAction: string,
@@ -108,7 +115,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					oSelectionVariant = new SelectionVariant();
 				// 1. get SemanticAttributes for navigation
 				if (aNavigationContexts && aNavigationContexts.length) {
-					aNavigationContexts.map((oNavigationContext: any) => {
+					aNavigationContexts.forEach((oNavigationContext: any) => {
 						// 1.1.a if navigation context is instance of sap.ui.mode.odata.v4.Context
 						// else check if navigation context is of type object
 						if (oNavigationContext.isA && oNavigationContext.isA("sap.ui.model.odata.v4.Context")) {
@@ -183,9 +190,9 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				}
 
 				// 9. Navigate via NavigationHandler
-				const onError = function() {
-					sap.ui.require(["sap/m/MessageBox"], function(MessageBox: any) {
-						const oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+				const onError = function () {
+					sap.ui.require(["sap/m/MessageBox"], function (MessageBox: any) {
+						const oResourceBundle = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 						MessageBox.show(oResourceBundle.getText("C_COMMON_HELPER_NAVIGATION_ERROR_MESSAGE"), {
 							title: oResourceBundle.getText("C_COMMON_NAVIGATION_ERROR_TITLE")
 						});
@@ -211,11 +218,13 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			oMetaModel &&
 			!ModelHelper.isStickySessionSupported(oMetaModel)
 		) {
-			CommonUtils.fnProcessDataLossOrDraftDiscardConfirmation(
+			draft.processDataLossOrDraftDiscardConfirmation(
 				_doNavigate.bind(this),
 				Function.prototype,
 				this.base.getView().getBindingContext(),
-				this.base.getView().getController()
+				this.base.getView().getController(),
+				true,
+				draft.NavigationType.ForwardNavigation
 			);
 		} else {
 			_doNavigate();
@@ -228,8 +237,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @param {object} oContext Actual context from which the semanticAttributes were derived.
 	 * @returns {object} Object of prepared attributes for external navigation and no conflict properties.
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	prepareContextForExternalNavigation(oSemanticAttributes: any, oContext: Context) {
 		// 1. Find all distinct keys in the object SemanticAttributes
 		// Store meta path for each occurence of the key
@@ -299,7 +308,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					oSemanticAttributes[
 						(sMetaPath + "/" + sPathInContext)
 							.split("/")
-							.filter(function(sValue: string) {
+							.filter(function (sValue: string) {
 								return sValue != "";
 							})
 							.join(".")
@@ -319,7 +328,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				oSemanticAttributes[sDistinctKey] = oContext.getProperty(sPathInContext);
 				oPropertiesWithoutConflict[sDistinctKey] = (sMetaPath + "/" + sPathInContext)
 					.split("/")
-					.filter(function(sValue: string) {
+					.filter(function (sValue: string) {
 						return sValue != "";
 					})
 					.join(".");
@@ -343,8 +352,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @param {Array} aParameters Names of parameters to be considered.
 	 * @returns {object} Object of prepared filter conditions for external navigation and no conflict filters.
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	prepareFiltersForExternalNavigation(oFilterBarConditions: any, sRootPath: string, aParameters?: any[]) {
 		let sPath;
 		const oDistinctKeys: any = {};
@@ -396,7 +405,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					oFilterBarConditions[
 						sFullContextPath
 							.split("/")
-							.filter(function(sValue: any) {
+							.filter(function (sValue: any) {
 								return sValue != "";
 							})
 							.join(".")
@@ -413,7 +422,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					sPath === sRootPath ? sRootPath + "/" + sDistinctKey : ((sRootPath + "/" + sPath) as any).replaceAll("*", "");
 				oFilterConditionsWithoutConflict[sDistinctKey] = sFullContextPath
 					.split("/")
-					.filter(function(sValue: any) {
+					.filter(function (sValue: any) {
 						return sValue != "";
 					})
 					.join(".");
@@ -434,8 +443,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 *
 	 * @returns {string}
 	 */
-	@Public
-	@Extensible(OverrideExecution.Instead)
+	@publicExtension()
+	@extensible(OverrideExecution.Instead)
 	getNavigationMode() {
 		return undefined;
 	}
@@ -463,8 +472,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 *		The metaPath is used to remove any sensitive data.
 	 * @param {string | object} [mNavigationParameters.semanticObjectMapping] String representation of SemanticObjectMapping or SemanticObjectMapping that applies to this navigation
 	 **/
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	navigateWithConfirmationDialog(
 		sSemanticObject: string,
 		sAction: string,
@@ -479,7 +488,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 		if (mNavigationParameters?.notApplicableContexts && mNavigationParameters.notApplicableContexts?.length >= 1) {
 			let oApplicableContextDialog: Dialog;
 			const oController = {
-				onClose: function() {
+				onClose: function () {
 					// User cancels action
 					oApplicableContextDialog.close();
 				},
@@ -490,7 +499,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					this.navigate(sSemanticObject, sAction, mNavigationParameters);
 				}
 			};
-			const fnOpenAndFillDialog = function() {
+			const fnOpenAndFillDialog = function () {
 				let oDialogContent;
 				const nNotApplicable = mNavigationParameters.notApplicableContexts.length,
 					aNotApplicableItems = [];
@@ -526,7 +535,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					}
 				)
 			)
-				.then(function(oFragment: any) {
+				.then(function (oFragment: any) {
 					return Fragment.load({ definition: oFragment, controller: oController });
 				})
 				.then((oPopover: any) => {
@@ -534,7 +543,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					this.getView().addDependent(oPopover);
 					fnOpenAndFillDialog();
 				})
-				.catch(function() {
+				.catch(function () {
 					Log.error("Error");
 				});
 		} else {
@@ -553,7 +562,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 *
 	 *
 	 */
-	@Private
+	@privateExtension()
 	getEntitySet() {
 		return (this._oView.getViewData() as any).entitySet;
 	}
@@ -566,8 +575,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @private
 	 **/
 	// TO-DO add unit tests for this function in the controller extension qunit.
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	removeSensitiveData(oAttributes: any, sMetaPath: string) {
 		const aProperties = Object.keys(oAttributes);
 		if (aProperties.length) {
@@ -655,8 +664,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#navigateOutbound
 	 * @since 1.86.0
 	 **/
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	navigateOutbound(sOutbound: string, mNavigationParameters: any) {
 		let aNavParams: any[] | undefined;
 		const oManifestEntry = this.base.getAppComponent().getManifestEntry("sap.app"),
@@ -671,7 +680,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 
 		if (mNavigationParameters) {
 			aNavParams = [];
-			Object.keys(mNavigationParameters).forEach(function(key: string) {
+			Object.keys(mNavigationParameters).forEach(function (key: string) {
 				let oParams: any;
 				if (Array.isArray(mNavigationParameters[key])) {
 					const aValues = mNavigationParameters[key];
@@ -706,7 +715,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	_applyOutboundParams(oSelectionVariant: SelectionVariant, vOutboundParams: any) {
 		const aParameters = Object.keys(vOutboundParams);
 		const aSelectProperties = oSelectionVariant.getSelectOptionsPropertyNames();
-		aParameters.forEach(function(key: string) {
+		aParameters.forEach(function (key: string) {
 			if (!aSelectProperties.includes(key)) {
 				oSelectionVariant.addSelectOption(key, "I", "EQ", vOutboundParams[key]);
 			}
@@ -720,14 +729,14 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @param {object} oOutboundParams Parameters defined in the outbounds. Only "plain" is supported
 	 * @returns {Array} Parameters with the key-Value pair
 	 **/
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getOutboundParams(oOutboundParams: any) {
 		const oParamsMapping: any = {};
 		if (oOutboundParams) {
 			const aParameters = Object.keys(oOutboundParams) || [];
 			if (aParameters.length > 0) {
-				aParameters.forEach(function(key: string) {
+				aParameters.forEach(function (key: string) {
 					const oMapping = oOutboundParams[key];
 					if (oMapping.value && oMapping.value.value && oMapping.value.format === "plain") {
 						if (!oParamsMapping[key]) {
@@ -750,8 +759,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * @returns {Promise} Promise which is resolved once the navigation is triggered
 	 */
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	onChevronPressNavigateOutBound(oController: PageController, sOutboundTarget: string, oContext: any, sCreatePath: string) {
 		const oOutbounds = (oController.getAppComponent() as any).getRoutingService().getOutbounds();
 		const oDisplayOutbound = oOutbounds[sOutboundTarget];