@openui5/sap.ui.integration 1.123.1 → 1.124.0

package/src/sap/ui/integration/schemas/sap-card.json

@@ -74,6 +74,10 @@
           "description": "Markdown enablement for Adaptive Content",
           "type": "boolean"
         },
+        "helpId": {
+          "description": "[Experimental] The help-id which will be rendered as data-help-id on the base element of the card.",
+          "type": "string"
+        },
         "modelSizeLimit": {
           "description": "[Experimental] Represents the maximum number of entries that are used for list bindings.",
           "oneOf": [
@@ -647,6 +651,9 @@
         "visible": {
           "description": "[Experimental] Visibility of the header",
           "$ref": "#/definitions/visibility"
+        },
+        "chart": {
+          "$ref": "#/definitions/MicroChart"
         }
       }
     },
@@ -863,7 +870,7 @@
           }
         },
         "chart": {
-          "$ref": "#/definitions/Microchart"
+          "$ref": "#/definitions/MicroChart"
         },
         "actionsStrip": {
           "description": "Describes actions strip",
@@ -3711,18 +3718,40 @@
         }
       }
     },
-    "Microchart": {
-      "description": "[Experimental] Describes Microchart attributes",
+    "MicroChart": {
+      "description": "[Experimental] Describes MicroChart attributes",
       "oneOf": [
         {
-          "$ref": "#/definitions/Microchart.Bullet"
+          "$ref": "#/definitions/MicroChart.Generic"
         },
         {
-          "$ref": "#/definitions/Microchart.StackedBar"
+          "$ref": "#/definitions/MicroChart.Bullet"
+        },
+        {
+          "$ref": "#/definitions/MicroChart.StackedBar"
         }
       ]
     },
-    "Microchart.Bullet": {
+    "MicroChart.Generic": {
+      "type": "object",
+      "additionalProperties": true,
+      "required": [
+        "type"
+      ],
+      "properties": {
+        "type": {
+          "description": "Represents the type of the MicroChart",
+          "type": "string",
+          "enum": [
+            "Line",
+            "Column",
+            "HarveyBall",
+            "Radial"
+          ]
+        }
+      }
+    },
+    "MicroChart.Bullet": {
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -3730,7 +3759,7 @@
       ],
       "properties": {
         "type": {
-          "description": "Represents the type of the Microchart",
+          "description": "Represents the type of the MicroChart",
           "type": "string",
           "const": "Bullet"
         },
@@ -3802,7 +3831,7 @@
           "description": "The thresholds indicators of the bar",
           "type": "array",
           "items": {
-            "$ref": "#/definitions/Microchart.Bullet.Threshold"
+            "$ref": "#/definitions/MicroChart.Bullet.Threshold"
           }
         },
         "visible": {
@@ -3811,7 +3840,7 @@
         }
       }
     },
-    "Microchart.Bullet.Threshold": {
+    "MicroChart.Bullet.Threshold": {
       "type": "object",
       "additionalProperties": false,
       "properties": {
@@ -3840,7 +3869,7 @@
         }
       }
     },
-    "Microchart.StackedBar": {
+    "MicroChart.StackedBar": {
       "type": "object",
       "additionalProperties": false,
       "required": [
@@ -3848,7 +3877,7 @@
       ],
       "properties": {
         "type": {
-          "description": "Represents the type of the Microchart",
+          "description": "Represents the type of the MicroChart",
           "type": "string",
           "const": "StackedBar"
         },
@@ -3871,7 +3900,7 @@
           "description": "The bars of the chart",
           "type": "array",
           "items": {
-            "$ref": "#/definitions/Microchart.StackedBar.Bar"
+            "$ref": "#/definitions/MicroChart.StackedBar.Bar"
           }
         },
         "visible": {
@@ -3880,7 +3909,7 @@
         }
       }
     },
-    "Microchart.StackedBar.Bar": {
+    "MicroChart.StackedBar.Bar": {
       "type": "object",
       "additionalProperties": false,
       "properties": {

package/src/sap/ui/integration/themes/base/CardTileVariant.less

@@ -49,6 +49,11 @@
 .sapFCard.sapUiIntCardTileFlat,
 .sapFCard.sapUiIntCardTileFlatWide {
 	.sapFCardHeader {
+
+		.sapFCardHeaderWrapper {
+			padding: 1rem 1rem 0.75rem;
+		}
+
 		.sapFCardHeaderText {
 			justify-content: flex-start;
 		}
@@ -70,6 +75,10 @@
 		}
 
 		&.sapFCardNumericHeader {
+			.sapFCardHeaderContent {
+				padding: 1rem 1rem 0.75rem;
+			}
+
 			.sapFCardHeaderDetailsWrapper {
 				display: none;
 			}

package/src/sap/ui/integration/themes/base/Microchart.less

@@ -23,17 +23,40 @@
 }
 
 .sapUiIntMicrochartChartWrapper {
-	height: 1rem;
+	min-height: 1rem;
+	max-height: 3rem;
 	display: flex;
 	align-items: center;
 	justify-content: space-between;
 
 	.sapUiIntMicrochartChart {
 		flex-grow: 1;
-		height: 0.675rem;
-
 		.sapUiIntMicrochartChartInner {
 			height: 100%;
 		}
 	}
+}
+
+.sapUiIntMicrochartInHeader.sapUiIntMicrochartChartWrapper {
+	flex-grow: 1;
+	margin-top: 0.5rem;
+	max-width: 8.5rem;
+	min-width: 5rem;
+
+	&:has(.sapUiIntMicrochartSizeS) {
+		max-height: 3.5rem;
+		margin-top: 0.25rem;
+		max-width: 8.25rem;
+
+		&:has(.sapMSLIInfo) {
+			max-width: 13rem;
+		}
+	}
+	.sapUiIntMicrochartSizeS {
+		height: 3.5rem;
+	}
+
+	&:only-child {
+		max-width: 100%;
+	}
 }

package/src/sap/ui/integration/util/BaseFactory.js

@@ -22,7 +22,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/BindingHelper.js

@@ -42,7 +42,7 @@ sap.ui.define([
 	 * Helper class for working with bindings.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.BindingHelper

package/src/sap/ui/integration/util/BindingResolver.js

@@ -33,7 +33,7 @@ sap.ui.define([
 		 * Resolves a binding syntax based on a provided model and path.
 		 *
 		 * @author SAP SE
-		 * @version 1.123.1
+		 * @version 1.124.0
 		 *
 		 * @private
 		 * @ui5-restricted sap.ushell

package/src/sap/ui/integration/util/CardObserver.js

@@ -18,7 +18,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/ComboBoxHelper.js

@@ -11,7 +11,7 @@ sap.ui.define([], function () {
 	 * Utility class helping with sap.m.ComboBox control.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.ComboBoxHelper

package/src/sap/ui/integration/util/ContentFactory.js

@@ -42,7 +42,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/CsrfTokenHandler.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @param {object} mSettings Token handler settings

package/src/sap/ui/integration/util/DataProvider.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/DataProviderFactory.js

@@ -40,7 +40,7 @@ sap.ui.define([
 	 * When destroyed, all data providers created by this class are also destroyed.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit

package/src/sap/ui/integration/util/Destinations.js

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolving destinations.

package/src/sap/ui/integration/util/ErrorHandler.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * Utility class for handling errors in the cards.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @ui5-restricted

package/src/sap/ui/integration/util/ExtensionDataProvider.js

@@ -17,7 +17,7 @@ sap.ui.define(["sap/ui/integration/util/DataProvider"], function (DataProvider)
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/Form.js

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * Utility class for handling forms in the cards.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @ui5-restricted

package/src/sap/ui/integration/util/HeaderFactory.js

@@ -50,7 +50,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/JSONBindingHelper.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * Helper class for working with bindings for json objects.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit

package/src/sap/ui/integration/util/LoadingProvider.js

@@ -21,7 +21,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/Manifest.js

@@ -68,7 +68,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/OAuth3LOHelper.js

@@ -0,0 +1,130 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2024 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([], function () {
+	"use strict";
+
+	/**
+	 * Map of consents and the cards that are waiting for them.
+	 * @private
+	 * @constant {Map<string, Set<Card>>}
+	 */
+	const mConsents = new Map();
+
+	/**
+	 * Utility class helping with OAuth 3LO flow handling.
+	 *
+	 * @author SAP SE
+	 * @version 1.124.0
+	 *
+	 * @private
+	 * @alias sap.ui.integration.util.OAuth3LOHelper
+	 */
+	const OAuth3LOHelper = { };
+
+	/**
+	 * Opens a new window with the consent URL.
+	 * @param {string} sConsentUrl The URL to open in the consent window.
+	 * @param {object} oPopupSettings The settings for the popup window.
+	 */
+	OAuth3LOHelper.openConsentWindow = function (sConsentUrl, oPopupSettings) {
+		const iWidth = oPopupSettings?.width || 400;
+		const iHeight = oPopupSettings?.height || 400;
+		const iLeft = (screen.width / 2) - (iWidth / 2);
+		const iTop = (screen.height / 2) - (iHeight / 2);
+
+		const sWindowConfig = `noopener, noreferrer, popup, toolbar=no, location=no, directories=no, status=no, menubar=no, scrollbars=no, resizable=no, copyhistory=no, width=${iWidth}, height=${iHeight}, top=${iTop}, left=${iLeft}`;
+
+		window.open(sConsentUrl, "_blank", sWindowConfig);
+	};
+
+	/**
+	 * Checks if the consent is needed.
+	 * @param {Response} oResponse The response object.
+	 * @returns {boolean} Whether the consent is needed.
+	 */
+	OAuth3LOHelper.needsConsent = function (oResponse) {
+		return oResponse.status === 502 && oResponse.headers.get("sap-3lo-flow");
+	};
+
+	/**
+	 * Checks if there is an error in the OAuth 3LO flow.
+	 * @param {Response} oResponse The response object.
+	 * @returns {boolean} True if there is an error in the OAuth 3LO flow.
+	 */
+	OAuth3LOHelper.hasConsentError = function (oResponse) {
+		if (!OAuth3LOHelper.needsConsent(oResponse)) {
+			return false;
+		}
+
+		const oHeader = OAuth3LOHelper.readHeader(oResponse);
+		return oHeader.status === "error";
+	};
+
+	/**
+	 * Reads the header settings from the response.
+	 * @param {Response} oResponse The response object.
+	 * @returns {object} The header settings.
+	 */
+	OAuth3LOHelper.readHeader = function (oResponse) {
+		let sHeader = oResponse.headers.get("sap-3lo-flow");
+
+		if (!sHeader) {
+			return null;
+		}
+
+		sHeader = atob(sHeader);
+
+		return JSON.parse(sHeader);
+	};
+
+	/**
+	 * Register the card to wait for the consent.
+	 * @param {string} sConsentId The consent ID for which this card will be waiting.
+	 * @param {Card} oCard The card that will be waiting for the consent.
+	 */
+	OAuth3LOHelper.registerCard = function (sConsentId, oCard) {
+		let mCards = mConsents.get(sConsentId);
+
+		if (!mCards) {
+			mCards = new Set();
+			mConsents.set(sConsentId, mCards);
+		}
+
+		mCards.add(oCard);
+	};
+
+	/**
+	 * Unregister the card from the consent.
+	 * @param {string} sConsentId The consent ID for which this card has received consent.
+	 * @param {Card} oCard The card that has received the consent.
+	 */
+	OAuth3LOHelper.unregisterCard = function (sConsentId, oCard) {
+		const mCards = mConsents.get(sConsentId);
+
+		mCards?.delete(oCard);
+	};
+
+	/**
+	 * Called when the consent is given.
+	 * @param {string} sConsentId The consent ID for which this card has received consent.
+	 */
+	OAuth3LOHelper.handleConsent = function (sConsentId) {
+		const mCards = mConsents.get(sConsentId);
+
+		if (!mCards) {
+			return;
+		}
+
+		for (const oCard of mCards) {
+			oCard.refreshData();
+		}
+
+		mConsents.delete(sConsentId);
+	};
+
+	return OAuth3LOHelper;
+});

package/src/sap/ui/integration/util/RequestDataProvider.js

@@ -72,7 +72,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/ServiceDataProvider.js

@@ -17,7 +17,7 @@ sap.ui.define(["sap/ui/integration/util/DataProvider"], function (DataProvider)
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/ServiceManager.js

@@ -37,7 +37,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @param {Object} mServiceFactoryReferences A map with service descriptions.

package/src/sap/ui/integration/util/SkeletonCard.js

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.widgets.Card
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/Utils.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * Utility class helping with JSON strings and formatters.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Utils
@@ -321,5 +321,43 @@ sap.ui.define([
 		return oBindingInfo;
 	};
 
+	/**
+	 * Starts a polling which executes the <code>fnRequest</code> function with a given interval.
+	 * It will stop if the <code>fnRequest</code> returns <code>true</code> or the maximum time is reached.
+	 * @public
+	 * @param {function} fnRequest The function to repeat with each polling. This function can return <code>true</code> if the polling is done and must be stopped.
+	 * @param {int} iInterval The time between each execution of the <code>fnRequest</code> in milliseconds.
+	 * @param {int} iMaximum The maximum time to poll in milliseconds.
+	 * @returns {object} An object with a stop function to stop the polling.
+	 */
+	Utils.polling = function (fnRequest, iInterval = 3000, iMaximum = 600000) {
+		let iTotal = 0;
+		let iTimeoutHandle;
+		let bStopped = false;
+		const fnPoll = async () => {
+			if (iMaximum && iTotal >= iMaximum) {
+				return;
+			}
+
+			const bDone = await fnRequest();
+
+			if (bDone || bStopped) {
+				return;
+			}
+
+			iTotal += iInterval;
+			iTimeoutHandle = setTimeout(fnPoll, iInterval);
+		};
+
+		fnPoll();
+
+		return {
+			stop: () => {
+				clearTimeout(iTimeoutHandle);
+				bStopped = true;
+			}
+		};
+	};
+
 	return Utils;
 });

package/src/sap/ui/integration/util/Validators.js

@@ -11,7 +11,7 @@ sap.ui.define([], function () {
 	 * Utility class helping with input validations.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Validators

package/src/sap/ui/integration/widgets/Card.js

@@ -176,7 +176,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -545,7 +545,7 @@ sap.ui.define([
 		 * @experimental since 1.79
 		 * @public
 		 * @author SAP SE
-		 * @version 1.123.1
+		 * @version 1.124.0
 		 * @borrows sap.ui.integration.widgets.Card#getDomRef as getDomRef
 		 * @borrows sap.ui.integration.widgets.Card#setVisible as setVisible
 		 * @borrows sap.ui.integration.widgets.Card#getParameters as getParameters
@@ -2232,9 +2232,16 @@ sap.ui.define([
 	 * @private
 	 */
 	Card.prototype._handleError = function (mErrorInfo) {
-		var sLogMessage = mErrorInfo.requestErrorParams ? mErrorInfo.requestErrorParams.message : mErrorInfo.title,
-			oContent = this.getCardContent(),
-			mMessageSettings;
+		const oExtensionMessage = this._extensionErrorOverride(mErrorInfo);
+		if (oExtensionMessage) {
+			this.showBlockingMessage(oExtensionMessage);
+			return;
+		}
+
+		const sLogMessage = mErrorInfo.requestErrorParams ? mErrorInfo.requestErrorParams.message : mErrorInfo.title,
+			oContent = this.getCardContent();
+
+		let mMessageSettings;
 
 		Log.error(sLogMessage, mErrorInfo.originalError, "sap.ui.integration.widgets.Card");
 		this.fireEvent("_error", { message: sLogMessage });
@@ -2258,6 +2265,17 @@ sap.ui.define([
 		}
 	};
 
+	Card.prototype._extensionErrorOverride = function (mErrorInfo) {
+		const oExtension = this.getAggregation("_extension");
+
+		if (!oExtension || !oExtension.overrideBlockingMessage) {
+			return null;
+		}
+
+		const oResponse = mErrorInfo?.requestErrorParams?.response;
+		return oExtension.overrideBlockingMessage(oResponse);
+	};
+
 	/**
 	 * @ui5-restricted sap.ui.integration
 	 * @private