@sapui5/sap.suite.ui.generic.template 1.129.0 → 1.130.1

package/src/sap/suite/ui/generic/template/lib/CommonUtils.js

@@ -854,7 +854,8 @@ sap.ui.define(["sap/ui/base/Object",
 					// oResponse is never going to have the value for oDatafield.name in the encoded format, hence the transformation into encodedURI.
 					// It may happen that the oResponse[oDatafield.name] contains some special characters (for ex: space) but in a decoded manner.
 					// but the route for Context Navigation requires the route string in the encoded way.
-					var sEncodedFieldValueFromODataResponse = encodeURIComponent(oResponse[oDatafield.name]);
+					var sFieldValueFromODataResponse = oResponse[oDatafield.name];
+					var sEncodedFieldValueFromODataResponse = encodeURIComponent(sFieldValueFromODataResponse);
 					switch (oDatafield.type) {
 						case "Edm.Guid":
 							if (oResponse.DraftAdministrativeData && oResponse.DraftAdministrativeData.DraftIsCreatedByMe) {
@@ -881,6 +882,10 @@ sap.ui.define(["sap/ui/base/Object",
 							var sFormattedvalue = ODataUtils.formatValue(sEncodedFieldValueFromODataResponse, oDatafield.type);
 							sRoute += sKeySeparator + oDatafield.name + "=" + sFormattedvalue;
 							break;
+						case "Edm.DateTime":
+							var sFormattedvalue = ODataUtils.formatValue(sFieldValueFromODataResponse, oDatafield.type);
+							sRoute += sKeySeparator + oDatafield.name + "=" + encodeURIComponent(sFormattedvalue);
+							break;
 						default:
 							if (typeof sEncodedFieldValueFromODataResponse === "string") {
 								sRoute += sKeySeparator + oDatafield.name + "=" + "'" + sEncodedFieldValueFromODataResponse + "'";

package/src/sap/suite/ui/generic/template/lib/MessageButtonHelper.js

@@ -1,16 +1,14 @@
 sap.ui.define([
 	"sap/ui/base/Object",
-	"sap/m/MessagePopover",
-	"sap/m/MessagePopoverItem",
 	"sap/ui/model/Filter",
 	"sap/ui/model/FilterOperator",
 	"sap/ui/model/json/JSONModel",
 	"sap/suite/ui/generic/template/lib/MessageUtils",
 	"sap/suite/ui/generic/template/genericUtilities/testableHelper",
-	"sap/ui/core/Element",
 	"sap/base/util/extend",
-	"sap/suite/ui/generic/template/genericUtilities/oDataModelHelper"
-], function (BaseObject, MessagePopover, MessagePopoverItem, Filter, FilterOperator, JSONModel, MessageUtils, testableHelper, Element, extend, oDataModelHelper) {
+	"sap/suite/ui/generic/template/genericUtilities/oDataModelHelper",
+	"sap/suite/ui/generic/template/lib/ai/ErrorExplanationHelper"
+], function (BaseObject, Filter, FilterOperator, JSONModel, MessageUtils, testableHelper, extend, oDataModelHelper, ErrorExplanationHelper) {
 	"use strict";
 
 	Filter = testableHelper.observableConstructor(Filter, true);
@@ -51,8 +49,10 @@ sap.ui.define([
 		var oUiModel = oComponent.getModel("ui");
 		var oHelperModel = new JSONModel({
 			isPopoverOpen: false,
-			messageToGroupName: Object.create(null)
+			messageToGroupName: Object.create(null),
+			isAIErrorExplanationEnabled : false
 		});
+		//getLink();
 		var oMessageButton = oController.byId("showMessages");
 		var bIsDraftEnabled = oTemplateUtils.oComponentUtils.isDraftEnabled();
 		
@@ -76,7 +76,7 @@ sap.ui.define([
 			(fnUpdateSorting || Function.prototype)();
 			return bRet;
 		}
-		
+
 		function getSubtitle(sMsgId, aControlIds, sAdditionalText, bIsPopoverOpen){		
 			var sRet = (bIsPopoverOpen && sMsgId && aControlIds && oCurrentMessageSupportFunctions) ? oCurrentMessageSupportFunctions.getSubtitle(sMsgId, sAdditionalText) : sAdditionalText;		
 			return sRet;
@@ -97,6 +97,9 @@ sap.ui.define([
 				oHelperModel.setProperty("/isPopoverOpen", true);
 			},
 			isPositionable: isPositionable,
+			generateErrorExplanation: function(oEvent) {
+				ErrorExplanationHelper.generateErrorExplanation(oEvent, oController, oTemplateUtils);
+			},
 			getSubtitle: getSubtitle,
 			titlePressed: function (oEvent) { // the user wants to navigate from the message to the corresponding control
 				MessageUtils.navigateFromMessageTitleEvent(oTemplateUtils, oEvent, oComponent, bIsDraftEnabled, sCurrentBindingPath);
@@ -108,6 +111,7 @@ sap.ui.define([
 			oItemBinding = oMessagePopover.getBinding("items");
 			oItemBinding.filter(oCurrentFilter);
 
+			oHelperModel.setProperty("/isAIErrorExplanationEnabled", ErrorExplanationHelper.isErrorExplanationEnabled(oTemplateUtils));
 			var oTemplatePrivate = oTemplateUtils.oComponentUtils.getTemplatePrivateModel();
 			oTemplatePrivate.setProperty("/generic/messageButtonInfo", {
 				count: 0,

package/src/sap/suite/ui/generic/template/lib/RetryAfterHandler.js

@@ -0,0 +1,249 @@
+sap.ui.define(["sap/ui/base/Object", 
+	"sap/base/util/extend",
+    "sap/base/i18n/Formatting",
+    "sap/m/Button",
+    "sap/m/Dialog",
+    "sap/m/ProgressIndicator",
+    "sap/m/Text",
+    "sap/m/library",
+    "sap/ui/core/format/DateFormat",
+    "sap/ui/core/library"
+], function (BaseObject, extend, Formatting, Button, Dialog, ProgressIndicator, Text, mobileLibrary, DateFormat, coreLibrary) {
+	"use strict";
+
+    /**
+     * This class handles the 503 error (service unavailable) response which includes "retry-after" header. 
+     * 
+     * Whenever the server throws 503 error, it adds "retry-after" (minimum number of seconds need to be waited before the next server call)
+     * to the response header. The model intercepts the error and invokes the error handler registered on "setRetryAfterHandler" method.
+     * Model takes care of converting the "retry-after" value to the Date value.
+     * 
+     * Here the code flow starts with "fnRegisterRetryAfterHandler". It sets the retry after handler to the model. 
+     * Whenever 503 error is thrown, the "fnRetryAfterHandler" method is invoked.
+     * The method should always return a promise. The model waits for the promise to be resolved.
+     * - If the promise is resolved, the model retries the batch call.
+     * - If the promise is rejected, it aborts the batch call.
+     * 
+     * Cases handled here.
+     * 1. When the retry after time is <= 600 seconds
+     *      Opens up dialog with progress indicator. Once the retry after time is reached, the dialog is automatically closed and the action is retried.
+     * 2. When the retry after time is same day as today, navigate to message page 
+     *      (Message shown: We expect it to be available again at 7:00 AM)
+     * 3. When the retry after time is some other day in the same year, navigate to message page 
+     *      (Message shown: We expect it to be available again on October 1 at 7:00 AM)
+     * 4. When the retry after time is in different year (Possibly Jan 01 of next year), navigate to message page 
+     *      (Message shown: We expect it to be available again on January 1, 2022 at 12:00 PM)
+     */
+
+	function getMethods(oTemplateContract, oAppComponent) {
+        // Shortcut for sap.m.ButtonType
+        var ButtonType = mobileLibrary.ButtonType;
+        // Shortcut for sap.m.DialogType
+	    var DialogType = mobileLibrary.DialogType;
+        // Shortcut for sap.m.IllustratedMessageType
+        var IllustratedMessageType = mobileLibrary.IllustratedMessageType;
+	    // Shortcut for sap.ui.core.ValueState
+	    var ValueState = coreLibrary.ValueState;
+        //  Shortcut for getting i18n text
+        var getText = oTemplateContract.getText;
+        
+        // Get user's time pattern. If no pattern available on user's settings, use "HH:mm a"
+        var sTimePattern = Formatting.getTimePattern("short") || "HH:mm a";
+
+        function fnRetryAfterHandler (oError) {
+            var sErrorMessage = oError.message;
+            var sAdditionalMessage;
+            if (sErrorMessage) {
+                //Add prefix to the error message
+                sAdditionalMessage = getText("ST_GENERIC_503_SOURCE_MESSAGE") + " " + sErrorMessage;
+            }
+
+            var oRetryAfterDate = oError.retryAfter;
+            var oNow = new Date();
+            var iDifferenceInMilliSeconds = oRetryAfterDate.getTime() - oNow.getTime();
+            var iDifferenceInSeconds = Math.ceil(iDifferenceInMilliSeconds / 1000);
+
+            return new Promise((fnResolve, fnReject) => {
+                var sMessagePageText = null,
+                    sMessagePageDescription = null;
+                if (iDifferenceInSeconds <= 600) {
+                    fnOpenAutoRetryDialog(oRetryAfterDate.getTime(), iDifferenceInSeconds, fnResolve, fnReject);
+                } else {
+                    sMessagePageText = getText("ST_GENERIC_503_SERVICE_UNAVAILABLE");
+                    sMessagePageDescription = fnGetErrorMessageWithTime(oNow, oRetryAfterDate);
+                    fnNavigateToMessagePage(sMessagePageText, sMessagePageDescription, sAdditionalMessage);
+                    fnReject();
+                }
+            });
+        }
+
+        /**
+         * Opens the auto retry dialog. Dialog contains
+         *   - a text containing the number of seconds remaining to retry the action
+         *   - a progress indicator which shows the progress to reach the retry after time
+         *   - a "Cancel" button
+         * 
+         * If the user doesn't do anything, this function will wait until the retry after time and resolves the promise to retry
+         * and closes the dialog.
+         * 
+         * If the user presses "Cancel" button, it opens a new confirmation dialog which does the following:
+         *   - if user presses "Retry" button, it closes the confirmation dialog and opens the auto retry dialog.
+         *   - if user presses "Cancel" button, it rejects the promise for retry (Retry operation will be aborted)
+         * 
+         * @param {number} iRetryAfterTimeInMillis Retry after time in milliseconds
+         * @param {number} iSecondsToRetryAfter Number of seconds to reach the retry-after time from now
+         * @param {function} fnResolve Resolve function for retry promise 
+         * @param {function} fnReject Reject function for retry promise
+         */
+        function fnOpenAutoRetryDialog (iRetryAfterTimeInMillis, iSecondsToRetryAfter, fnResolve, fnReject) {
+            var oAutoRetryDialog = null;
+            var oConfirmRetryDialog = null;
+            var oAutoRetryProgressIndicator = null;
+            var oAutoRetryText = null;
+
+            function getAutoRetryText (iSeconds) {
+                return getText("ST_GENERIC_503_SERVICE_UNAVAILABLE") + " " + getText("ST_GENERIC_503_AUTO_RETRY_MSG", [iSeconds]);
+            }
+
+            function updateAutoRetryStatus (iLapsedSeconds) {
+                var iSecondsUntilRetryAfter = iSecondsToRetryAfter - iLapsedSeconds;
+                oAutoRetryProgressIndicator.setPercentValue(iLapsedSeconds / iSecondsToRetryAfter * 100);
+                oAutoRetryText.setText( getAutoRetryText(iSecondsUntilRetryAfter) );
+
+                // Updating the progress indicator state every second
+                if (iRetryAfterTimeInMillis > new Date().getTime()) {
+                    setTimeout(() => {
+                        updateAutoRetryStatus(iLapsedSeconds + 1);
+                    }, 1000);
+                }
+            }
+
+            oAutoRetryText = new Text({
+                text: getAutoRetryText(iSecondsToRetryAfter)
+            });
+
+            oAutoRetryProgressIndicator = new ProgressIndicator({
+                percentValue : 0,
+                state : ValueState.None
+            });
+
+            oAutoRetryDialog = new Dialog({
+                type : DialogType.Message,
+				state : ValueState.Warning,
+                title: getText("ST_MESSAGES_DIALOG_TITLE_WARNING"),
+                content: [oAutoRetryText, oAutoRetryProgressIndicator],
+                buttons: [
+                    new Button({
+                        type: ButtonType.Emphasized,
+                        text: getText("CANCEL"),
+                        press: function () {
+                            // Close the current dialog and open the confirmation dialog
+                            oAutoRetryDialog.close();
+                            oConfirmRetryDialog.open();
+                        }
+                    })
+                ]
+            });
+
+            oConfirmRetryDialog = new Dialog({
+                type : DialogType.Message,
+				state : ValueState.Warning,
+                title: getText("ST_MESSAGES_DIALOG_TITLE_WARNING"),
+                content: [
+                    new Text({ text: getText("ST_GENERIC_503_CANCEL_RETRY") })
+                ],
+                buttons: [
+                    new Button({
+                        type: ButtonType.Emphasized,
+                        text: getText("RETRY"),
+                        press: function () {
+                            // As the user wants to retry, close the current dialog and reopen the auto retry dialog which contains progress indicator
+                            oConfirmRetryDialog.close();
+                            oAutoRetryDialog.open();
+                        }
+                    }),
+                    new Button({
+                        text: getText("CANCEL"),
+                        press: function () {
+                            // Abort retry and close the confirmation dialog
+                            fnReject(new Error("Request(s) canceled by user"));
+                            oConfirmRetryDialog.close();
+                        }
+                    })
+                ]
+            });
+
+            //Start the progress indicator and open the auto-retry dialog
+            updateAutoRetryStatus(0);
+            oAutoRetryDialog.open();
+            // Once the retry time is reached, resolve the promise which will trigger retry
+            // and close the dialog.
+            setTimeout(function () {
+                fnResolve();
+                oAutoRetryDialog.close();
+            }, iSecondsToRetryAfter * 1000);
+        }
+
+        function fnNavigateToMessagePage (sText, sDescription, sAdditionalMessage) {
+            var aAdditionalContent = [];
+            if (sAdditionalMessage) {
+                aAdditionalContent.push(new Text({text: sAdditionalMessage}));
+            }
+            oTemplateContract.oNavigationControllerProxy.navigateToMessagePage({
+                title: getText("ST_GENERIC_ERROR_TITLE"),
+                text: sText,
+                messageType: IllustratedMessageType.UnableToLoad,
+                description: sDescription,
+                additionalContent: aAdditionalContent
+            });
+        }
+
+        function fnGetErrorMessageWithTime (oNow, oRetryAfterDate) {
+            var sResultMessage = null;
+            // Date format varies from case to case
+            var oDateFormat = null;
+            var sFormattedDate = null;
+            //Time format remains same
+            var oTimeFormat = DateFormat.getTimeInstance({
+                pattern: sTimePattern
+            });
+            var sFormattedTime = oTimeFormat.format(oRetryAfterDate);
+
+            if (oNow.getYear() !== oRetryAfterDate.getYear()) {
+                // Different year
+                oDateFormat = DateFormat.getDateInstance({
+                    pattern: "MMMM dd, yyyy"
+                });
+                sFormattedDate = oDateFormat.format(oRetryAfterDate);
+                sResultMessage = getText("ST_GENERIC_503_RETRY_MSG_OTHER_DAY", [sFormattedDate, sFormattedTime]);
+            } else if (oNow.getMonth() !== oRetryAfterDate.getMonth() || oNow.getDate() !== oRetryAfterDate.getDate()) {
+                // Different day
+                oDateFormat = DateFormat.getDateInstance({
+                    pattern: "MMMM dd"
+                });
+                sFormattedDate = oDateFormat.format(oRetryAfterDate);
+                sResultMessage = getText("ST_GENERIC_503_RETRY_MSG_OTHER_DAY", [sFormattedDate, sFormattedTime]);
+            } else {
+                // Same day (only time is required)
+                sResultMessage = getText("ST_GENERIC_503_RETRY_MSG_SAME_DAY", [sFormattedTime]);
+            }
+            return sResultMessage;
+        }
+
+        function fnRegisterRetryAfterHandler() {
+            // Registering the retry after handler to model
+            var oModel = oAppComponent.getModel();
+            oModel.setRetryAfterHandler(fnRetryAfterHandler);
+        }
+        
+        return {
+            registerRetryAfterHandler: fnRegisterRetryAfterHandler
+        };
+	}
+
+	return BaseObject.extend("sap.suite.ui.generic.template.lib.RetryAfterHandler", {
+		constructor: function (oTemplateContract, oAppComponent) {
+			extend(this, getMethods(oTemplateContract, oAppComponent));
+		}
+	});
+});

package/src/sap/suite/ui/generic/template/lib/ShareUtils.js

@@ -175,7 +175,7 @@ sap.ui.define(["sap/base/util/ObjectPath", "sap/ushell/ui/footerbar/AddBookmarkB
 	ShareUtils.CollaborationButtonPress = function (fnCallBackHandler, oShareModel) {
 		var sCurrentURLPromise = getCurrentUrl();
 		sCurrentURLPromise.then(function (sCurrentURL) {
-			var sAppTitle = oShareModel && oShareModel.getProperty("/title");
+			var sAppTitle = oShareModel && oShareModel.getProperty("/shellTitle");
 			fnCallBackHandler(sAppTitle, sCurrentURL);
 		});
 	};

package/src/sap/suite/ui/generic/template/lib/SideEffectUtil.js

@@ -1,7 +1,8 @@
 sap.ui.define(["sap/suite/ui/generic/template/js/AnnotationHelper",
 "sap/suite/ui/generic/template/genericUtilities/metadataAnalyser",
-"sap/base/util/deepExtend"
-], function(AnnotationHelper, metadataAnalyser, deepExtend) {
+"sap/base/util/deepExtend",
+"sap/ui/comp/util/SharedUtil"
+], function(AnnotationHelper, metadataAnalyser, deepExtend, SharedUtil) {
 	"use strict";
 	var SideEffectSourcePropertyType = {
 		SINGLE_SOURCE_ONLY : "OnlySingleSource",
@@ -133,8 +134,68 @@ sap.ui.define(["sap/suite/ui/generic/template/js/AnnotationHelper",
 		});
 	}
 
+	/**
+	 * Returns the EntitySet name, EntityType name, PropertyName for a given link field
+	 * @param {sap.ui.model.odata.ODataMetaModel.EntitySet} oEntitySet
+	 * @param {object} oTarget
+	 */
+	function fnGetPropsForLinkFields (oEntitySet, oTarget) {
+		var sLinkProperty = oTarget && oTarget.Value && oTarget.Value.Path;
+		if (!sLinkProperty) {
+			return null;
+		}
+		var oCustomData = {
+			"sEntitySetName": oEntitySet.name,
+			"sEntityTypeName":  oEntitySet.entityType,
+			"sLinkProperty": sLinkProperty
+		};
+		return JSON.stringify(oCustomData);
+	}
+
+	/**
+	 * Calculate and assign fieldGroup Id(s) for the link field
+	 * The following logic is executed in the onAfterRendering event of the control because
+	 * 1. We need the binding context to be available for the control
+	 * 2. Avoid unnecessary strain on the rendering of the application during templating
+	 * @param {sap.suite.ui.generic.template.genericUtilities.Link} oLink
+	 */
+	function fnAssignFieldGroupIdsToLinkField (oLink) {
+		var aCustomData = oLink.getCustomData();
+		var oMetaModel = oLink.getModel().getMetaModel();
+		var oCustomData = aCustomData.find((oCustomData) => oCustomData.getKey() === "SideEffects" && oCustomData.getValue());
+		if (oLink.getBindingContext() && oCustomData){
+			var oCustomDataValue = oCustomData.getValue();
+			var sEntitySetName = oCustomDataValue.sEntitySetName;
+			var sEntityTypeName = oCustomDataValue.sEntityTypeName;
+			var sLinkProperty = oCustomDataValue.sLinkProperty;
+			var sSideEffectType = metadataAnalyser.getFieldSourcePropertiesType(sLinkProperty, oMetaModel, sEntityTypeName);
+			
+			if (sSideEffectType === "NoSideEffect"){
+				return;
+			}
+
+			var oEntityType = oMetaModel.getODataEntityType(sEntityTypeName);
+			var oEntitySet = oMetaModel.getODataEntitySet(sEntitySetName);
+			var oProperty = metadataAnalyser.getPropertyMetadata(oMetaModel, sEntityTypeName, sLinkProperty);
+			var oMetaData = {
+				entitySet: oEntitySet,
+				entityType: oEntityType,
+				path: sLinkProperty,
+				property: {
+					property: oProperty
+				}
+			};
+
+			//The method SharedUtil.applyFieldGroupIDs takes in the control and its metadata, reads the Side Effect annotations configured for it 
+			//and assigns the fieldGroupID accordingly.
+			SharedUtil.applyFieldGroupIDs(oLink, oMetaData);
+		}
+	}
+
 	return {
 		handleSideEffectForField : fnHandleSideEffectForField,
-		assignFieldGroupIds: fnAssignFieldGroupIds
+		assignFieldGroupIds: fnAssignFieldGroupIds,
+		getPropsForLinkFields: fnGetPropsForLinkFields,
+		assignFieldGroupIdsToLinkField: fnAssignFieldGroupIdsToLinkField
 	};
 });

package/src/sap/suite/ui/generic/template/lib/StableIdDefinition.js

@@ -212,6 +212,9 @@ sap.ui.define(["sap/suite/ui/generic/template/genericUtilities/FeError"],functio
 				},
 				VariantSelect: {
 					value: "template::VariantSelect"
+				},
+				InvisibleText: {
+					value: "template::ContentSwitch"
 				}
 			},
 			ALPTable: {
@@ -507,6 +510,10 @@ sap.ui.define(["sap/suite/ui/generic/template/genericUtilities/FeError"],functio
 				},
 				VariantSelectionItem: {
 					parameters: ["sFacet", "sQuickVariantKey"]
+				},
+				InvisibleText: {
+					parameters: ["sFacet"],
+					value: function(oParams){return "template:::ObjectPageTable:::ContentSwitch:::sFacet::" + oParams.sFacet;}
 				}
 			},
 			SmartControl: {