@sapui5/sap.fe.core 1.102.0 → 1.103.0

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

@@ -1,6 +1,6 @@
 import Log from "sap/base/Log";
 import mergeObjects from "sap/base/util/merge";
-import AppComponent from "sap/fe/core/AppComponent";
+import type AppComponent from "sap/fe/core/AppComponent";
 import draft from "sap/fe/core/controllerextensions/editFlow/draft";
 import {
 	defineUI5Class,
@@ -12,28 +12,27 @@ import {
 } 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 type PageController from "sap/fe/core/PageController";
+import type { NavigationService } from "sap/fe/core/services/NavigationServiceFactory";
 import SelectionVariant from "sap/fe/navigation/SelectionVariant";
-import Dialog from "sap/m/Dialog";
+import type Dialog from "sap/m/Dialog";
 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 type 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 type 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";
+import type ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import type { CoreEx } from "types/extension_types";
 
 /**
  * {@link sap.ui.core.mvc.ControllerExtension Controller extension}
  *
  * @namespace
  * @alias sap.fe.core.controllerextensions.InternalInternalBasedNavigation
- *
  * @private
  * @since 1.84.0
  */
@@ -57,10 +56,10 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * If semantic object mapping is provided, this is also applied to the selection variant after the adaptation by a consumer.
 	 * This takes care of removing any technical parameters and determines if an explace or inplace navigation should take place.
 	 *
-	 * @param {string} sSemanticObject Semantic object for the target app
-	 * @param {string} sAction  Action for the target app
-	 * @param {object} [mNavigationParameters] Optional parameters to be passed to the external navigation
-	 * @param {Array|object} [mNavigationParameters.navigationContexts] Uses one of the following to be passed to the intent:
+	 * @param sSemanticObject Semantic object for the target app
+	 * @param sAction  Action for the target app
+	 * @param [mNavigationParameters] Optional parameters to be passed to the external navigation
+	 * @param [mNavigationParameters.navigationContexts] Uses one of the following to be passed to the intent:
 	 *    a single instance of {@link sap.ui.model.odata.v4.Context}
 	 *    multiple instances of {@link sap.ui.model.odata.v4.Context}
 	 *    an object or an array of objects
@@ -73,11 +72,11 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 *			 },
 	 *			 metaPath: "/SalesOrderManage"
 	 *        }
-	 * @param {string | object} [mNavigationParameters.semanticObjectMapping] String representation of the SemanticObjectMapping or SemanticObjectMapping that applies to this navigation
-	 * @param {object} [mNavigationParameters.defaultRefreshStrategy] Default refresh strategy to be used in case no refresh strategy is specified for the intent in the view.
-	 * @param {object} [mNavigationParameters.refreshStrategies]
-	 * @param {object} [mNavigationParameters.additionalNavigationParameters] Additional navigation parameters configured in the crossAppNavigation outbound parameters.
-	 **/
+	 * @param [mNavigationParameters.semanticObjectMapping] String representation of the SemanticObjectMapping or SemanticObjectMapping that applies to this navigation
+	 * @param [mNavigationParameters.defaultRefreshStrategy] Default refresh strategy to be used in case no refresh strategy is specified for the intent in the view.
+	 * @param [mNavigationParameters.refreshStrategies]
+	 * @param [mNavigationParameters.additionalNavigationParameters] Additional navigation parameters configured in the crossAppNavigation outbound parameters.
+	 */
 	@publicExtension()
 	@finalExtension()
 	navigate(
@@ -233,9 +232,10 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 
 	/**
 	 * Prepare attributes to be passed to external navigation.
-	 * @param {object} oSemanticAttributes Context data after removing all sensitive information.
-	 * @param {object} oContext Actual context from which the semanticAttributes were derived.
-	 * @returns {object} Object of prepared attributes for external navigation and no conflict properties.
+	 *
+	 * @param oSemanticAttributes Context data after removing all sensitive information.
+	 * @param oContext Actual context from which the semanticAttributes were derived.
+	 * @returns Object of prepared attributes for external navigation and no conflict properties.
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -261,7 +261,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				} else {
 					// if a nested object is found
 					const oNewLookUpObject = LookUpObject[sKey];
-					_findDistinctKeysInObject(oNewLookUpObject, sLookUpObjectMetaPath + "/" + sKey);
+					_findDistinctKeysInObject(oNewLookUpObject, `${sLookUpObjectMetaPath}/${sKey}`);
 				}
 			}
 		}
@@ -270,7 +270,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 
 		// 2. Determine distinct key value and add conflicted paths to semantic attributes
 		const sMainEntitySetName = aMetaPathParts[0],
-			sMainEntityTypeName = oMetaModel.getObject("/" + sMainEntitySetName + "/@sapui.name"),
+			sMainEntityTypeName = oMetaModel.getObject(`/${sMainEntitySetName}/@sapui.name`),
 			oPropertiesWithoutConflict: any = {};
 		let sMainEntityValuePath, sCurrentValuePath, sLastValuePath;
 		for (const sDistinctKey in oDistinctKeys) {
@@ -285,9 +285,9 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				// conflict
 				for (let i = 0; i <= aConflictingPaths.length - 1; i++) {
 					const sPath = aConflictingPaths[i];
-					let sPathInContext = sPath.replace(sPath === sMetaPath ? sMetaPath : sMetaPath + "/", "");
-					sPathInContext = (sPathInContext === "" ? sPathInContext : sPathInContext + "/") + sDistinctKey;
-					const sEntityTypeName = oMetaModel.getObject(sPath + "/@sapui.name");
+					let sPathInContext = sPath.replace(sPath === sMetaPath ? sMetaPath : `${sMetaPath}/`, "");
+					sPathInContext = (sPathInContext === "" ? sPathInContext : `${sPathInContext}/`) + sDistinctKey;
+					const sEntityTypeName = oMetaModel.getObject(`${sPath}/@sapui.name`);
 					// rule A
 
 					// rule A
@@ -306,7 +306,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					// add conflicted path to semantic attributes
 					// check if the current path points to main entity and prefix attribute names accordingly
 					oSemanticAttributes[
-						(sMetaPath + "/" + sPathInContext)
+						`${sMetaPath}/${sPathInContext}`
 							.split("/")
 							.filter(function (sValue: string) {
 								return sValue != "";
@@ -323,10 +323,10 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			} else {
 				// no conflict, add distinct key without adding paths
 				const sPath = aConflictingPaths[0]; // because there is only one and hence no conflict
-				let sPathInContext = sPath.replace(sPath === sMetaPath ? sMetaPath : sMetaPath + "/", "");
-				sPathInContext = (sPathInContext === "" ? sPathInContext : sPathInContext + "/") + sDistinctKey;
+				let sPathInContext = sPath.replace(sPath === sMetaPath ? sMetaPath : `${sMetaPath}/`, "");
+				sPathInContext = (sPathInContext === "" ? sPathInContext : `${sPathInContext}/`) + sDistinctKey;
 				oSemanticAttributes[sDistinctKey] = oContext.getProperty(sPathInContext);
-				oPropertiesWithoutConflict[sDistinctKey] = (sMetaPath + "/" + sPathInContext)
+				oPropertiesWithoutConflict[sDistinctKey] = `${sMetaPath}/${sPathInContext}`
 					.split("/")
 					.filter(function (sValue: string) {
 						return sValue != "";
@@ -347,10 +347,11 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	}
 	/**
 	 * Prepare filter conditions to be passed to external navigation.
-	 * @param {object} oFilterBarConditions Filter conditions.
-	 * @param {string} sRootPath Root path of the application.
-	 * @param {Array} aParameters Names of parameters to be considered.
-	 * @returns {object} Object of prepared filter conditions for external navigation and no conflict filters.
+	 *
+	 * @param oFilterBarConditions Filter conditions.
+	 * @param sRootPath Root path of the application.
+	 * @param aParameters Names of parameters to be considered.
+	 * @returns Object of prepared filter conditions for external navigation and no conflict filters.
 	 */
 	@publicExtension()
 	@finalExtension()
@@ -391,15 +392,15 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				for (let i = 0; i <= aConflictingPaths.length - 1; i++) {
 					sPath = aConflictingPaths[i];
 					if (sPath === sRootPath) {
-						sFullContextPath = sRootPath + "/" + sDistinctKey;
+						sFullContextPath = `${sRootPath}/${sDistinctKey}`;
 						sPathInContext = sDistinctKey;
 						sMainEntityValuePath = sDistinctKey;
 						if (aParameters && aParameters.includes(sDistinctKey)) {
-							oFilterBarConditions["$Parameter." + sDistinctKey] = oFilterBarConditions[sDistinctKey];
+							oFilterBarConditions[`$Parameter.${sDistinctKey}`] = oFilterBarConditions[sDistinctKey];
 						}
 					} else {
 						sPathInContext = sPath;
-						sFullContextPath = ((sRootPath + "/" + sPath) as any).replaceAll(/\*/g, "");
+						sFullContextPath = (`${sRootPath}/${sPath}` as any).replaceAll(/\*/g, "");
 						sCurrentValuePath = sPath;
 					}
 					oFilterBarConditions[
@@ -419,7 +420,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 				// no conflict, add distinct key without adding paths
 				sPath = aConflictingPaths[0];
 				sFullContextPath =
-					sPath === sRootPath ? sRootPath + "/" + sDistinctKey : ((sRootPath + "/" + sPath) as any).replaceAll("*", "");
+					sPath === sRootPath ? `${sRootPath}/${sDistinctKey}` : (`${sRootPath}/${sPath}` as any).replaceAll("*", "");
 				oFilterConditionsWithoutConflict[sDistinctKey] = sFullContextPath
 					.split("/")
 					.filter(function (sValue: any) {
@@ -427,7 +428,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 					})
 					.join(".");
 				if (aParameters && aParameters.includes(sDistinctKey)) {
-					oFilterBarConditions["$Parameter." + sDistinctKey] = oFilterBarConditions[sDistinctKey];
+					oFilterBarConditions[`$Parameter.${sDistinctKey}`] = oFilterBarConditions[sDistinctKey];
 				}
 			}
 		}
@@ -441,7 +442,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	/**
 	 * Get Navigation mode.
 	 *
-	 * @returns {string}
+	 * @returns The navigation mode
 	 */
 	@publicExtension()
 	@extensible(OverrideExecution.Instead)
@@ -453,13 +454,13 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * If semantic object mapping is provided, this setting is also applied to the selection variant after adaptation by a consumer.
 	 * This setting also removes any technical parameters and determines if an inplace or explace navigation should take place.
 	 *
-	 * @param {string} sSemanticObject Semantic object for the target app
-	 * @param {string} sAction  Action for the target app
-	 * @param {object} [mNavigationParameters] Optional parameters to be passed to the external navigation
-	 * @param {string} [mNavigationParameters.label]
-	 * @param {Array|object} [mNavigationParameters.navigationContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent.
-	 * @param {Array|object} [mNavigationParameters.applicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent and for which the IBN button is enabled
-	 * @param {Array|object} [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, which cannot be passed to the intent.
+	 * @param sSemanticObject Semantic object for the target app
+	 * @param sAction  Action for the target app
+	 * @param [mNavigationParameters] Optional parameters to be passed to the external navigation
+	 * @param [mNavigationParameters.label]
+	 * @param [mNavigationParameters.navigationContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent.
+	 * @param [mNavigationParameters.applicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, to be passed to the intent and for which the IBN button is enabled
+	 * @param [mNavigationParameters.notApplicableContexts] Single instance or multiple instances of {@link sap.ui.model.odata.v4.Context}, or alternatively an object or array of objects, which cannot be passed to the intent.
 	 *		  if an array of contexts is passed the context is used to determine the meta path and accordingly remove the sensitive data
 	 *		  If an array of objects is passed, the following format is expected:
 	 *		  {
@@ -470,8 +471,8 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 *			 metaPath: "/SalesOrderManage"
 	 *        }
 	 *		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
-	 **/
+	 * @param [mNavigationParameters.semanticObjectMapping] String representation of SemanticObjectMapping or SemanticObjectMapping that applies to this navigation
+	 */
 	@publicExtension()
 	@finalExtension()
 	navigateWithConfirmationDialog(
@@ -519,7 +520,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			const oModel = this._oView.getModel();
 			const oMetaModel = oModel.getMetaModel();
 			const sCanonicalPath = mNavigationParameters.notApplicableContexts[0].getCanonicalPath();
-			const sEntitySet = sCanonicalPath.substr(0, sCanonicalPath.indexOf("(")) + "/";
+			const sEntitySet = `${sCanonicalPath.substr(0, sCanonicalPath.indexOf("("))}/`;
 			Promise.resolve(
 				XMLPreprocessor.process(
 					oDialogFragment,
@@ -558,9 +559,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	/**
 	 * Get targeted Entity set.
 	 *
-	 * @returns {string} Entity set name
-	 *
-	 *
+	 * @returns Entity set name
 	 */
 	@privateExtension()
 	getEntitySet() {
@@ -569,11 +568,11 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	/**
 	 * Removes sensitive data from the semantic attribute with respect to entitySet.
 	 *
-	 * @param {object} oAttributes Context data
-	 * @param {string} sMetaPath Meta path to reach the entityset in the MetaModel
-	 * @returns {Array} Array of semantic Attributes
+	 * @param oAttributes Context data
+	 * @param sMetaPath Meta path to reach the entityset in the MetaModel
+	 * @returns Array of semantic Attributes
 	 * @private
-	 **/
+	 */
 	// TO-DO add unit tests for this function in the controller extension qunit.
 	@publicExtension()
 	@finalExtension()
@@ -585,10 +584,10 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			delete oAttributes["SAP__Messages"];
 			for (let j = 0; j < aProperties.length; j++) {
 				if (oAttributes[aProperties[j]] && typeof oAttributes[aProperties[j]] === "object") {
-					this.removeSensitiveData(oAttributes[aProperties[j]], sMetaPath + "/" + aProperties[j]);
+					this.removeSensitiveData(oAttributes[aProperties[j]], `${sMetaPath}/${aProperties[j]}`);
 				}
 				const sProp = aProperties[j],
-					aPropertyAnnotations = this._oMetaModel.getObject(sMetaPath + "/" + sProp + "@");
+					aPropertyAnnotations = this._oMetaModel.getObject(`${sMetaPath}/${sProp}@`);
 				if (aPropertyAnnotations) {
 					if (
 						aPropertyAnnotations["@com.sap.vocabularies.PersonalData.v1.IsPotentiallySensitive"] ||
@@ -613,10 +612,9 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	/**
 	 * Check if Path based FieldControl Evaluates to inapplicable.
 	 *
-	 * @param {string} sFieldControlPath Field control path
-	 * @param {object} oAttribute SemanticAttributes
-	 * @returns {boolean} `true` if inapplicable
-	 *
+	 * @param sFieldControlPath Field control path
+	 * @param oAttribute SemanticAttributes
+	 * @returns `true` if inapplicable
 	 */
 	_isFieldControlPathInapplicable(sFieldControlPath: string, oAttribute: any) {
 		let bInapplicable = false;
@@ -633,9 +631,9 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	/**
 	 * Method to replace Local Properties with Semantic Object mappings.
 	 *
-	 * @param {object} oSelectionVariant SelectionVariant consisting of filterbar, Table and Page Context
-	 * @param {object | string} vMappings A string representation of semantic object mapping
-	 * @returns {object} - Modified SelectionVariant with LocalProperty replaced with SemanticObjectProperties.
+	 * @param oSelectionVariant SelectionVariant consisting of filterbar, Table and Page Context
+	 * @param vMappings A string representation of semantic object mapping
+	 * @returns - Modified SelectionVariant with LocalProperty replaced with SemanticObjectProperties.
 	 */
 	_applySemanticObjectMappings(oSelectionVariant: SelectionVariant, vMappings: object | string) {
 		const oMappings = typeof vMappings === "string" ? JSON.parse(vMappings) : vMappings;
@@ -658,12 +656,13 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	}
 	/**
 	 * Navigates to an Outbound provided in the manifest.
+	 *
 	 * @function
-	 * @param {string} sOutbound Identifier to location the outbound in the manifest
-	 * @param {object} mNavigationParameters Optional map containing key/value pairs to be passed to the intent
+	 * @param sOutbound Identifier to location the outbound in the manifest
+	 * @param mNavigationParameters Optional map containing key/value pairs to be passed to the intent
 	 * @alias sap.fe.core.controllerextensions.IntentBasedNavigation#navigateOutbound
 	 * @since 1.86.0
-	 **/
+	 */
 	@publicExtension()
 	@finalExtension()
 	navigateOutbound(sOutbound: string, mNavigationParameters: any) {
@@ -708,9 +707,10 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 
 	/**
 	 * Method to apply outbound parameters defined in the manifest.
-	 * @param {object} oSelectionVariant SelectionVariant consisting of a filter bar, a table, and a page context
-	 * @param {object} vOutboundParams Outbound Properties defined in the manifest
-	 * @returns {object} - The modified SelectionVariant with outbound parameters.
+	 *
+	 * @param oSelectionVariant SelectionVariant consisting of a filter bar, a table, and a page context
+	 * @param vOutboundParams Outbound Properties defined in the manifest
+	 * @returns - The modified SelectionVariant with outbound parameters.
 	 */
 	_applyOutboundParams(oSelectionVariant: SelectionVariant, vOutboundParams: any) {
 		const aParameters = Object.keys(vOutboundParams);
@@ -726,9 +726,9 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 	 * Method to get the outbound parameters defined in the manifest.
 	 *
 	 * @function
-	 * @param {object} oOutboundParams Parameters defined in the outbounds. Only "plain" is supported
-	 * @returns {Array} Parameters with the key-Value pair
-	 **/
+	 * @param oOutboundParams Parameters defined in the outbounds. Only "plain" is supported
+	 * @returns Parameters with the key-Value pair
+	 */
 	@publicExtension()
 	@finalExtension()
 	getOutboundParams(oOutboundParams: any) {
@@ -784,7 +784,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			}
 
 			if (sCreatePath) {
-				const sKey = oDisplayOutbound.semanticObject + "-" + oDisplayOutbound.action;
+				const sKey = `${oDisplayOutbound.semanticObject}-${oDisplayOutbound.action}`;
 				oRefreshStrategies.intents[sKey] = {};
 				oRefreshStrategies.intents[sKey][sCreatePath] = "self";
 			}
@@ -804,7 +804,7 @@ class InternalIntentBasedNavigation extends ControllerExtension {
 			//TODO: check why returning a promise is required
 			return Promise.resolve();
 		} else {
-			throw new Error("outbound target " + sOutboundTarget + " not found in cross navigation definition of manifest");
+			throw new Error(`outbound target ${sOutboundTarget} not found in cross navigation definition of manifest`);
 		}
 	}
 }