@sapui5/sap.fe.navigation 1.104.1 → 1.105.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.fe.navigation",
-	"version": "1.104.1",
+	"version": "1.105.0",
 	"description": "SAPUI5 Library sap.fe.navigation",
 	"license": "SEE LICENSE IN LICENSE.txt",
 	"author": "SAP SE (https://www.sap.com)",

package/src/sap/fe/navigation/.library

@@ -6,7 +6,7 @@
     <copyright>SAP UI development toolkit for HTML5 (SAPUI5)
         (c) Copyright 2009-2021 SAP SE. All rights reserved
     </copyright>
-    <version>1.104.1</version>
+    <version>1.105.0</version>
 
     <documentation>UI5 library: sap.fe.navigation</documentation>
 

package/src/sap/fe/navigation/NavigationHandler.js

@@ -84,6 +84,7 @@ sap.ui.define(
 					"navigate",
 					"parseNavigation",
 					"storeInnerAppState",
+					"storeInnerAppStateAsync",
 					"storeInnerAppStateWithImmediateReturn",
 					"processBeforeSmartLinkPopoverOpens",
 					"processBeforeSemanticLinkPopoverOpens",
@@ -435,7 +436,7 @@ sap.ui.define(
 				};
 				var fnStoreAndNavigate = function (oCrossAppNavService) {
 					oNavHandler
-						.storeInnerAppState(oInnerAppData, true)
+						.storeInnerAppStateAsync(oInnerAppData, true)
 						.then(function (sAppStateKey) {
 							if (sAppStateKey) {
 								oNavHandler.replaceHash(sAppStateKey);
@@ -511,7 +512,7 @@ sap.ui.define(
 			 *          <li><code>oAppData.tableVariantId</code></li>
 			 *          <li><code>oAppData.customData</code></li>
 			 *          </ul>
-			 *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppState storeInnerAppState}.
+			 *          which return the inner app data as stored in {@link #.navigate navigate} or {@link #.storeInnerAppStateAsync storeInnerAppStateAsync}.
 			 *          <code>oAppData.oDefaultedSelectionVariant</code> is an empty selection variant and
 			 *          <code>oAppData.bNavSelVarHasDefaultsOnly</code> is <code>false</code> in this case.<br>
 			 *          <b>Note:</b> If the navigation type is {@link sap.fe.navigation.NavType.initial} oAppData is an empty object!<br>
@@ -940,7 +941,7 @@ sap.ui.define(
 			 * @param {object} [mInnerAppData.semanticDates] Object containing semanticDates filter information
 			 * @param {boolean} [bImmediateHashReplace=true] If set to false, the inner app hash will not be replaced until storing is successful; do not
 			 *        set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event
-			 * @param {boolean} [bSkipHashReplace=false] If set to true, the inner app hash will not be replaced in the storeInnerAppState. Also the bImmediateHashReplace
+			 * @param {boolean} [bSkipHashReplace=false] If set to true, the inner app hash will not be replaced in the storeInnerAppStateAsync. Also the bImmediateHashReplace
 			 * 		  will be ignored.
 			 * @returns {object} A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the
 			 *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
@@ -955,7 +956,7 @@ sap.ui.define(
 			 * 		customData : oMyCustomData
 			 * 	};
 			 *
-			 * 	var oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppState(mInnerAppData);
+			 * 	var oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppStateAsync(mInnerAppData);
 			 *
 			 * 	oStoreInnerAppStatePromise.done(function(sAppStateKey){
 			 * 		//your inner app state is saved now, sAppStateKey was added to URL
@@ -968,7 +969,7 @@ sap.ui.define(
 			 * });
 			 * </code>
 			 */
-			storeInnerAppState: function (mInnerAppData, bImmediateHashReplace, bSkipHashReplace) {
+			storeInnerAppStateAsync: function (mInnerAppData, bImmediateHashReplace, bSkipHashReplace) {
 				if (typeof bImmediateHashReplace !== "boolean") {
 					bImmediateHashReplace = true; // default
 				}
@@ -1047,6 +1048,127 @@ sap.ui.define(
 				return oMyDeferred.promise();
 			},
 
+			/**
+			 * Changes the URL according to the current app state and stores the app state for later retrieval.
+			 *
+			 * @param {object} mInnerAppData Object containing the current state of the app
+			 * @param {string} mInnerAppData.selectionVariant Stringified JSON object as returned, for example, from getDataSuiteFormat() of the
+			 *        SmartFilterBar control
+			 * @param {string} [mInnerAppData.tableVariantId] ID of the SmartTable variant
+			 * @param {object} [mInnerAppData.customData] Object that can be used to store additional app-specific data
+			 * @param {object} [mInnerAppData.presentationVariant] Object containing the current ui state of the app
+			 * @param {object} [mInnerAppData.valueTexts] Object containing value descriptions
+			 * @param {object} [mInnerAppData.semanticDates] Object containing semanticDates filter information
+			 * @param {boolean} [bImmediateHashReplace=true] If set to false, the inner app hash will not be replaced until storing is successful; do not
+			 *        set to false if you cannot react to the resolution of the Promise, for example, when calling the beforeLinkPressed event
+			 * @returns {object} A Promise object to monitor when all the actions of the function have been executed; if the execution is successful, the
+			 *          app state key is returned; if an error occurs, an object of type {@link sap.fe.navigation.NavError} is
+			 *          returned
+			 * @public
+			 * @example <code>
+			 * sap.ui.define(["sap/fe/navigation/NavigationHandler"], function (NavigationHandler) {
+			 * 	var oNavigationHandler = new NavigationHandler(oController);
+			 * 	var mInnerAppData = {
+			 * 		selectionVariant : oSmartFilterBar.getDataSuiteFormat(),
+			 * 		tableVariantId : oSmartTable.getCurrentVariantId(),
+			 * 		customData : oMyCustomData
+			 * 	};
+			 *
+			 * 	var oStoreInnerAppStatePromise = oNavigationHandler.storeInnerAppState(mInnerAppData);
+			 *
+			 * 	oStoreInnerAppStatePromise.done(function(sAppStateKey){
+			 * 		//your inner app state is saved now, sAppStateKey was added to URL
+			 * 		//perform actions that must run after save
+			 * 	});
+			 *
+			 * 	oStoreInnerAppStatePromise.fail(function(oError){
+			 * 		//some error handling
+			 * 	});
+			 * });
+			 * </code>
+			 * @deprecated as of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync} instead.
+			 */
+
+			storeInnerAppState: function (mInnerAppData, bImmediateHashReplace) {
+				Log.error(
+					"Deprecated API call of 'sap.fe.navigation.NavigationHandler.storeInnerAppState'. Please use 'storeInnerAppStateAsync' instead",
+					null,
+					"sap.fe.navigation.NavigationHandler"
+				);
+				if (typeof bImmediateHashReplace !== "boolean") {
+					bImmediateHashReplace = true; // default
+				}
+				var oNavHandler = this;
+				var oMyDeferred = jQuery.Deferred();
+
+				var fnReplaceHash = function (sAppStateKey) {
+					var oHashChanger = oNavHandler.oRouter.oHashChanger ? oNavHandler.oRouter.oHashChanger : HashChanger.getInstance();
+					var sAppHashOld = oHashChanger.getHash();
+					/*
+					 * use .getHash() here instead of .getAppHash() to also be able dealing with environments where only SAPUI5 is loaded and the UShell
+					 * is not initialized properly.
+					 */
+					var sAppHashNew = oNavHandler._replaceInnerAppStateKey(sAppHashOld, sAppStateKey);
+					oHashChanger.replaceHash(sAppHashNew);
+				};
+
+				// in case mInnerAppState is empty, do not overwrite the last saved state
+				if (isEmptyObject(mInnerAppData)) {
+					oMyDeferred.resolve("");
+					return oMyDeferred.promise();
+				}
+
+				// check if we already saved the same data
+				var sAppStateKeyCached = this._oLastSavedInnerAppData.sAppStateKey;
+
+				var bInnerAppDataEqual = JSON.stringify(mInnerAppData) === JSON.stringify(this._oLastSavedInnerAppData.oAppData);
+				if (bInnerAppDataEqual && sAppStateKeyCached) {
+					// passed inner app state found in cache
+					this._oLastSavedInnerAppData.iCacheHit++;
+
+					// replace inner app hash with cached appStateKey in url (just in case the app has changed the hash in meantime)
+					fnReplaceHash(sAppStateKeyCached);
+					oMyDeferred.resolve(sAppStateKeyCached);
+					return oMyDeferred.promise();
+				}
+
+				// passed inner app state not found in cache
+				this._oLastSavedInnerAppData.iCacheMiss++;
+
+				var fnOnAfterSave = function (sAppStateKey) {
+					// replace inner app hash with new appStateKey in url
+					if (!bImmediateHashReplace) {
+						fnReplaceHash(sAppStateKey);
+					}
+
+					// remember last saved state
+					oNavHandler._oLastSavedInnerAppData.oAppData = mInnerAppData;
+					oNavHandler._oLastSavedInnerAppData.sAppStateKey = sAppStateKey;
+					oMyDeferred.resolve(sAppStateKey);
+				};
+
+				var fnOnError = function (oError) {
+					oMyDeferred.reject(oError);
+				};
+
+				var sAppStateKey = this._saveAppState(mInnerAppData, fnOnAfterSave, fnOnError);
+				/*
+				 * Note that _sapAppState may return 'undefined' in case that the parsing has failed. In this case, we should not trigger the replacement
+				 * of the App Hash with the generated key, as the container was not written before. Note as well that the error handling has already
+				 * happened before by making the oMyDeferred promise fail (see fnOnError above).
+				 */
+				if (sAppStateKey !== undefined) {
+					// replace inner app hash with new appStateKey in url
+					// note: we do not wait for the save to be completed: this asynchronously behaviour is necessary if
+					// this method is called e.g. in a onLinkPressed event with no possibility to wait for the promise resolution
+					if (bImmediateHashReplace) {
+						fnReplaceHash(sAppStateKey);
+					}
+				}
+
+				return oMyDeferred.promise();
+			},
+
 			/**
 			 * Changes the URL according to the current app state and stores the app state for later retrieval.
 			 *
@@ -1091,11 +1213,11 @@ sap.ui.define(
 			 * });
 			 * </code>
 			 * @public
-			 * @deprecated as of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppState} instead.
+			 * @deprecated as of version 1.104. Use the {@link sap.fe.navigation.NavigationHandler.storeInnerAppStateAsync} instead.
 			 */
 			storeInnerAppStateWithImmediateReturn: function (mInnerAppData, bImmediateHashReplace) {
 				Log.error(
-					"Deprecated API call of 'sap.fe.navigation.NavigationHandler.storeInnerAppStateWithImmediateReturn'. Please use 'storeInnerAppState' instead",
+					"Deprecated API call of 'sap.fe.navigation.NavigationHandler.storeInnerAppStateWithImmediateReturn'. Please use 'storeInnerAppStateAsync' instead",
 					null,
 					"sap.fe.navigation.NavigationHandler"
 				);
@@ -1309,7 +1431,7 @@ sap.ui.define(
 				};
 
 				if (mInnerAppData) {
-					var oStoreInnerAppStatePromise = this.storeInnerAppState(mInnerAppData, true);
+					var oStoreInnerAppStatePromise = this.storeInnerAppStateAsync(mInnerAppData, true);
 
 					// if the inner app state was successfully stored, store also the xapp-state
 					oStoreInnerAppStatePromise.done(function () {
@@ -1630,18 +1752,18 @@ sap.ui.define(
 			},
 			_fnSaveAppStateAsync: function (oAppData, fnOnError) {
 				var oNavHandler = this;
-				return this._getAppNavigationServiceAsync().then(function (oCrossAppNavService) {
-					return oCrossAppNavService
-						.createEmptyAppStateAsync(oNavHandler.oComponent)
-						.then(function (oAppState) {
-							return oNavHandler._fnSaveAppStateWithImmediateReturn(oAppData, oAppState, fnOnError);
-						})
-						.catch(function (oError) {
-							if (fnOnError) {
-								fnOnError(oError);
-							}
-						});
-				});
+				return this._getAppNavigationServiceAsync()
+					.then(function (oCrossAppNavService) {
+						return oCrossAppNavService.createEmptyAppStateAsync(oNavHandler.oComponent);
+					})
+					.then(function (oAppState) {
+						return oNavHandler._fnSaveAppStateWithImmediateReturn(oAppData, oAppState, fnOnError);
+					})
+					.catch(function (oError) {
+						if (fnOnError) {
+							fnOnError(oError);
+						}
+					});
 			},
 			_saveAppStateWithImmediateReturn: function (oAppData, fnOnError) {
 				var oAppState = this._getAppNavigationService().createEmptyAppState(this.oComponent);

package/src/sap/fe/navigation/library.js

@@ -26,7 +26,7 @@ sap.ui.define(
 		var thisLib = sap.ui.getCore().initLibrary({
 			name: "sap.fe.navigation",
 			// eslint-disable-next-line no-template-curly-in-string
-			version: "1.104.1",
+			version: "1.105.0",
 			dependencies: ["sap.ui.core"],
 			types: ["sap.fe.navigation.NavType", "sap.fe.navigation.ParamHandlingMode", "sap.fe.navigation.SuppressionBehavior"],
 			interfaces: [],