@openui5/sap.ui.integration 1.124.2 → 1.126.0

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

@@ -0,0 +1,103 @@
+/*!
+ * 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([
+	"sap/base/i18n/Localization",
+	"sap/ui/core/Locale",
+	"sap/ui/core/Theming",
+	"sap/ui/dom/includeScript"
+], function (
+	Localization,
+	Locale,
+	Theming,
+	includeScript
+) {
+	"use strict";
+
+	/**
+	 * Utility class helping with analytics cloud widget.
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 *
+	 * @private
+	 * @alias sap.ui.integration.util.AnalyticsCloudHelper
+	 */
+	const AnalyticsCloudHelper = { };
+
+	/**
+	 * The source for the analytics cloud widget.
+	 * @const
+	 */
+	AnalyticsCloudHelper.WIDGET_SCRIPT_SRC = "https://assets.sapanalytics.cloud/production/api/widget/sac-widget-embed.js";
+
+	/**
+	 * Loads the widget code and calls initial setup.
+	 * This method will do the loading and the setup only once.
+	 * @param {sap.ui.integration.Host} oHost A host instance which can override the src of the script. Note that only the host of the first card will be taken into account.
+	 * @returns {Promise} A promise which full fills when script is loaded.
+	 */
+	AnalyticsCloudHelper.loadWidget = function (oHost) {
+		if (sap?.sac?.api?.widget) {
+			// Already loaded on the page
+			return Promise.resolve();
+		}
+
+		if (AnalyticsCloudHelper._pInitialize) {
+			return AnalyticsCloudHelper._pInitialize;
+		}
+
+		let sScriptSrc = AnalyticsCloudHelper.WIDGET_SCRIPT_SRC;
+		if (oHost && oHost.getAnalyticsCloudWidgetSrc) {
+			sScriptSrc = oHost.getAnalyticsCloudWidgetSrc() || sScriptSrc;
+		}
+
+		const pInitialize = AnalyticsCloudHelper._includeScript(sScriptSrc)
+			.then(
+				() => {
+					if (!sap?.sac?.api?.widget) {
+						return Promise.reject("Object sap.sac.api.widget is undefined after the script was loaded.");
+					}
+					sap.sac.api.widget.setup(AnalyticsCloudHelper._getSettings());
+					return Promise.resolve();
+				},
+				() => {
+					return Promise.reject(`There was a problem loading the widget from '${sScriptSrc}'`);
+				}
+			);
+
+		AnalyticsCloudHelper._pInitialize = pInitialize;
+
+		return pInitialize;
+	};
+
+	/**
+	 * Gets initial settings for the widget.
+	 * @private
+	 * @returns {object} A map with the widget settings for initial setup.
+	 */
+	AnalyticsCloudHelper._getSettings = function () {
+		const oLocale = new Locale(Localization.getLanguageTag());
+		const oSettings = {
+			language: oLocale.toString(),
+			dataAccessLanguage: oLocale.toString(),
+			theme: Theming.getTheme()
+		};
+
+		return oSettings;
+	};
+
+	/**
+	 * Wrapper for sap.ui.dom.includeScript.
+	 * @param {string} sScriptSrc The widget script src.
+	 * @returns {Promise} A promise which resolves when script is loaded.
+	 */
+	AnalyticsCloudHelper._includeScript = function (sScriptSrc) {
+		return includeScript({ url: sScriptSrc });
+	};
+
+	return AnalyticsCloudHelper;
+});

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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+		 * @version 1.126.0
 		 *
 		 * @private
 		 * @ui5-restricted sap.ushell

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

@@ -22,10 +22,23 @@ sap.ui.define([
 			Object.keys(oChange).forEach(function (s) {
 				if (s.charAt(0) === "/") {
 					var value = oChange[s];
-					oModel.setProperty(s, value);
+					CardMerger.updateManifestProperty(oModel, s, value);
 				}
 			});
 		},
+		updateManifestProperty: function (oModel, path, value) {
+			var bSuccess = oModel.setProperty(path, value);
+			if (!bSuccess) {
+				// path not exists in model data
+				var iLastSlash = path.lastIndexOf("/");
+				// In case there is only one slash at the beginning, sParentPath must contain this slash
+				var sParentPath = path.substring(0, iLastSlash || 1);
+				var sProperty = path.substring(iLastSlash + 1);
+				var oValue = {};
+				oValue[sProperty] = value;
+				CardMerger.updateManifestProperty(oModel, sParentPath, oValue);
+			}
+		},
 		mergeTextsChanges: function (oModel, oTexts, oDesigntime) {
 			var sLanguage =  Utils._language;
 			if (oTexts && oTexts.hasOwnProperty(sLanguage)) {
@@ -56,6 +69,8 @@ sap.ui.define([
 			}
 			if (Array.isArray(aChanges) && aChanges.length > 0) {
 				var oModel, oTexts, oDesigntime;
+				//map translations of unmatch languages
+				Utils.mapLanguagesInManifestChanges(aChanges);
 				aChanges.forEach(function (oChange) {
 					if (oChange.content) {
 						//merge old changes

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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.ComboBoxHelper

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

@@ -5,6 +5,7 @@
  */
 sap.ui.define([
 	"./BaseFactory",
+	"sap/base/Log",
 	"sap/m/IllustratedMessageType",
 	"sap/ui/integration/cards/actions/CardActions",
 	"sap/ui/integration/cards/AdaptiveContent",
@@ -19,6 +20,7 @@ sap.ui.define([
 	"sap/ui/integration/cards/WebPageContent"
 ], function (
 	BaseFactory,
+	Log,
 	IllustratedMessageType,
 	CardActions,
 	AdaptiveContent,
@@ -42,7 +44,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.124.2
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @private
@@ -90,6 +92,7 @@ sap.ui.define([
 				return true;
 			}).catch(function (sError) {
 				if (sError) {
+					Log.error(sError, "sap.ui.integration.util.ContentFactory");
 					oCard._handleError({
 						type: IllustratedMessageType.ErrorScreen,
 						title: oCard.getTranslatedText("CARD_DATA_LOAD_DEPENDENCIES_ERROR"),

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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolving destinations.

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

@@ -0,0 +1,132 @@
+/*!
+ * 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([
+	"sap/ui/integration/library",
+	"sap/ui/base/Object",
+	"sap/ui/model/json/JSONModel"
+], function (
+	library,
+	BaseObject,
+	JSONModel
+) {
+	"use strict";
+
+	const iStandardTile = 16 * 11;
+
+	const mWidthRanges = {
+		tiny: [20, 1 * iStandardTile],
+		narrow: [1 * iStandardTile, 2 * iStandardTile],
+		regular: [2 * iStandardTile, 4 * iStandardTile],
+		wide: [4 * iStandardTile, 6 * iStandardTile],
+		extraWide: [6 * iStandardTile, 10000]
+	};
+
+	const CardDisplayVariant = library.CardDisplayVariant;
+
+	/**
+	 * Constructor for a new <code>DisplayVariants</code>.
+	 *
+	 * @class
+	 * Processes and resolves destinations configuration.
+	 *
+	 * @extends sap.ui.base.Object
+	 *
+	 * @author SAP SE
+	 * @version 1.126.0
+	 *
+	 * @constructor
+	 * @param {sap.ui.integration.widgets.Card} oCard The card.
+	 * @private
+	 * @alias sap.ui.integration.util.DisplayVariants
+	 */
+	const DisplayVariants = BaseObject.extend("sap.ui.integration.util.DisplayVariants", {
+		metadata: {
+			library: "sap.ui.integration"
+		},
+		constructor: function (oCard) {
+			BaseObject.call(this);
+			this._oCard = oCard;
+
+			oCard.addEventDelegate({
+				onAfterRendering: this._observeWidth
+			}, this);
+		}
+	});
+
+	DisplayVariants.prototype.destroy = function () {
+		BaseObject.prototype.destroy.apply(this, arguments);
+
+		this._oWidthObserver = null;
+	};
+
+	DisplayVariants.prototype.updateSizeModel = function (iWidth) {
+		const oCard = this._oCard;
+		if (!oCard.getDomRef()) {
+			return;
+		}
+		const oSizeModel = oCard.getModel("size");
+		const sDisplayVariant = oCard.getDisplayVariant();
+		iWidth = iWidth || oCard.getDomRef().offsetWidth;
+		const mSize = {
+			tiny: true,
+			narrow: DisplayVariants.determineSize("narrow", iWidth),
+			regular: DisplayVariants.determineSize("regular", iWidth),
+			wide: DisplayVariants.determineSize("wide", iWidth),
+			extraWide: DisplayVariants.determineSize("extraWide", iWidth),
+			compactHeader: sDisplayVariant === CardDisplayVariant.CompactHeader,
+			smallHeader: sDisplayVariant === CardDisplayVariant.SmallHeader,
+			standardHeader: sDisplayVariant === CardDisplayVariant.StandardHeader,
+			small: sDisplayVariant === CardDisplayVariant.Small,
+			standard: sDisplayVariant === CardDisplayVariant.Standard,
+			large: sDisplayVariant === CardDisplayVariant.Large,
+			variant: sDisplayVariant
+		};
+		oSizeModel.setData(mSize);
+	};
+
+	DisplayVariants.prototype.getInitialSizeModel = function () {
+		return new JSONModel({
+			tiny: true,
+			narrow: true,
+			regular: true,
+			wide: false,
+			extraWide: false,
+			compactHeader: false,
+			smallHeader: false,
+			standardHeader: false,
+			small: false,
+			standard: true,
+			large: false,
+			variant: CardDisplayVariant.Standard
+		});
+	};
+
+	DisplayVariants.prototype._observeWidth = function () {
+		const oCardDomRef = this._oCard.getDomRef();
+		if (!oCardDomRef) {
+			return;
+		}
+		if (this._oWidthObserver) {
+			this._oWidthObserver.unobserve(oCardDomRef);
+		}
+		this._oWidthObserver = new ResizeObserver((aEntries) => {
+			const oEntry = aEntries[0];
+			const iWidth = oEntry.contentRect.width;
+			this.updateSizeModel(iWidth);
+		});
+		this._oWidthObserver.observe(oCardDomRef);
+	};
+
+	DisplayVariants.determineSize = function(sSize, iWidth) {
+		if (iWidth >= mWidthRanges[sSize][0]) {
+			return true;
+		}
+		return false;
+	};
+
+	return DisplayVariants;
+});

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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @private
@@ -76,6 +76,10 @@ sap.ui.define([
 			oToolbar = this._createCloseButton(mConfiguration);
 		}
 
+		if (oCard.isCompactHeader()) {
+			mConfiguration.type = "";
+		}
+
 		switch (mConfiguration.type) {
 			case "Numeric":
 				oHeader = new NumericHeader(sId, mConfiguration, oToolbar, oCard._oIconFormatter);
@@ -102,7 +106,9 @@ sap.ui.define([
 		oHeader._setDataConfiguration(mConfiguration.data);
 
 		if (oCard.isTileDisplayVariant()) {
-			this._setTileDefaults(oHeader, mConfiguration);
+			this._setTileDisplayDefaults(oHeader, mConfiguration);
+		} else if (oCard.isHeaderDisplayVariant()) {
+			this._setHeaderDisplayDefaults(oHeader, mConfiguration);
 		}
 
 		var oActions = new CardActions({
@@ -146,7 +152,7 @@ sap.ui.define([
 		return oButton;
 	};
 
-	HeaderFactory.prototype._setTileDefaults = function (oHeader, mConfiguration) {
+	HeaderFactory.prototype._setTileDisplayDefaults = function (oHeader, mConfiguration) {
 		oHeader.setProperty("useTileLayout", true);
 		oHeader.setProperty("useTooltips", true);
 
@@ -188,5 +194,42 @@ sap.ui.define([
 		}
 	};
 
+	HeaderFactory.prototype._setHeaderDisplayDefaults = function (oHeader, mConfiguration) {
+		const oCard = this._oCard;
+		oHeader.setProperty("useTooltips", true);
+
+		if (oCard.isCompactHeader()) {
+			oHeader.setProperty("useTooltips", true);
+			oHeader.setIconSize("XS");
+			oHeader.setTitleMaxLines(1);
+			oHeader.setSubtitleMaxLines(1);
+			oHeader.setStatusVisible(false);
+			return;
+		}
+
+		const bIsSmall = oCard.isSmallHeader();
+
+		if (!mConfiguration.titleMaxLines) {
+			oHeader.setTitleMaxLines(bIsSmall ? 1 : 2);
+		}
+
+		if (bIsSmall) {
+			if (oHeader.isA("sap.f.cards.NumericHeader")) {
+				oHeader.setIconSize("XS");
+				oHeader.setNumberSize("S");
+			}
+
+			if (!mConfiguration.subtitleMaxLines) {
+				oHeader.setSubtitleMaxLines(1);
+			}
+		}
+
+		if (oHeader.isA("sap.f.cards.NumericHeader")) {
+			oHeader.getSideIndicators().forEach((oSideIndicator) => {
+				oSideIndicator.setProperty("useTooltips", true);
+			});
+		}
+	};
+
 	return HeaderFactory;
 });

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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -18,7 +18,7 @@ sap.ui.define([], function () {
 	 * Utility class helping with OAuth 3LO flow handling.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.2
+	 * @version 1.126.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.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.124.2
+	 * @version 1.126.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -11,7 +11,8 @@ sap.ui.define([
 	'sap/base/util/isPlainObject',
 	"sap/base/Log",
 	"sap/ui/core/date/UI5Date",
-	"sap/base/i18n/Localization"
+	"sap/base/i18n/Localization",
+	"sap/base/util/deepClone"
 ], function (
 	getCompatibilityVersion,
 	Locale,
@@ -19,7 +20,8 @@ sap.ui.define([
 	isPlainObject,
 	Log,
 	UI5Date,
-	Localization
+	Localization,
+	deepClone
 ) {
 	"use strict";
 
@@ -27,7 +29,7 @@ sap.ui.define([
 	 * Utility class helping with JSON strings and formatters.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.2
+	 * @version 1.126.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Utils
@@ -64,6 +66,23 @@ sap.ui.define([
 		return Utils.languageMapping[language] || language;
 	};
 
+	Utils.mapLanguagesInManifestChanges = function(oManifestChanges) {
+		if (typeof oManifestChanges === "object") {
+			oManifestChanges.forEach(function (oChange) {
+				if (oChange.texts) {
+					for (var [sLanguage, sMappingLanguage] of Object.entries(Utils.languageMapping)) {
+						if (oChange.texts[sLanguage]) {
+							var oTranslations = deepClone(oChange.texts[sLanguage], 500);
+							delete oChange.texts[sLanguage];
+							oTranslations = Object.assign(oTranslations, oChange.texts[sMappingLanguage]);
+							oChange.texts[sMappingLanguage] = oTranslations;
+						}
+					}
+				}
+			});
+		}
+	};
+
 	Utils._language = Utils.getLocalizationLanguage();
 
 	/**

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.124.2
+	 * @version 1.126.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Validators