@openui5/sap.ui.integration 1.146.0 → 1.147.0

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.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit
@@ -237,14 +237,14 @@ sap.ui.define([
 		const oEditor = this._oEditor;
 
 		if (oCard) {
-			oSettings.baseRuntimeUrl = oCard.getRuntimeUrl();
+			oSettings.baseRuntimeUrl = oCard.resolveUrl();
 			oSettings.card = oCard;
 
 			if (!bConfigurationResolved) {
 				oSettings.configurationJson = JSONBindingHelper.createJsonWithBindingInfos(oDataConfiguration, oCard.getBindingNamespaces());
 			}
 		} else if (oEditor) {
-			oSettings.baseRuntimeUrl = oEditor.getRuntimeUrl("/"); // @todo should behave the same as card.getRuntimeUrl
+			oSettings.baseRuntimeUrl = oEditor.resolveUrl("/"); // @todo should behave the same as card.resolveUrl
 			oSettings.configurationJson = JSONBindingHelper.createJsonWithBindingInfos(oDataConfiguration, oEditor.getBindingNamespaces());
 		} else {
 			oSettings.configurationJson = JSONBindingHelper.createJsonWithBindingInfos(oDataConfiguration, {});

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

@@ -38,7 +38,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.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

@@ -52,7 +52,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 *
 	 * @constructor
 	 * @param {sap.ui.integration.widgets.Card} oCard The card.

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

@@ -38,7 +38,7 @@ sap.ui.define([
 	 * Utility class for handling errors in the cards.
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.0
 	 *
 	 * @constructor
 	 * @private

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

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

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

@@ -52,7 +52,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -93,6 +93,10 @@ sap.ui.define([
 			// Prepare binding infos only once for all sections
 			oManifest = BindingHelper.createBindingInfos(oManifest, oCard.getBindingNamespaces());
 
+			// Include merged customSettings in resolved manifest
+			const oCustomSettings = oCard.getCombinedCustomSettings();
+			oManifest["sap.card"].customSettings = oCustomSettings;
+
 			if (oCard.getAggregation("_filterBar")) {
 				aFilters =  oCard.getAggregation("_filterBar")._getFilters().map(function (oFilter) {
 					return ["/sap.card/configuration/filters/" + oFilter.getKey(), oFilter];

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.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.OAuth3LOHelper

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

@@ -19,7 +19,7 @@ sap.ui.define([
 	 * Utility class for creating objects.
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.ObjectFactory

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

@@ -10,7 +10,7 @@ sap.ui.define([], function () {
 	 * Utility class for handling RadioButton and RadioButtonGroup operations in forms.
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.RadioButtonHelper

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

@@ -74,7 +74,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.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.146.0
+	 * @version 1.147.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Utility class helping with sap.ui.model.Sorter control.
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.SorterHelper

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

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * Utility class helping with JSON strings and formatters.
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.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.146.0
+	 * @version 1.147.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Validators

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

@@ -99,6 +99,7 @@ sap.ui.define([
 		DESTINATIONS: "/sap.card/configuration/destinations",
 		CSRF_TOKENS: "/sap.card/configuration/csrfTokens",
 		FILTERS: "/sap.card/configuration/filters",
+		CUSTOM_SETTINGS: "/sap.card/customSettings",
 		NO_DATA_MESSAGES: "/sap.card/configuration/messages/noData",
 		MODEL_SIZE_LIMIT: "/sap.card/configuration/modelSizeLimit",
 		CHILD_CARDS: "/sap.card/configuration/childCards"
@@ -191,7 +192,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.146.0
+	 * @version 1.147.0
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -232,6 +233,21 @@ sap.ui.define([
 					defaultValue: null
 				},
 
+				/**
+				 * Defines custom settings passed from the Mobile SDK or a hosting application.
+				 * These are global defaults that can be overridden by individual cards via their manifest.
+				 * The value is an object containing custom settings as key-value pairs.
+				 *
+				 * <b>Note:</b> For Mobile SDK usage, set this property before calling <code>startManifestProcessing</code>.
+				 *
+				 * @ui5-experimental-since 1.146
+				 */
+				customSettings: {
+					type: "object",
+					defaultValue: {},
+					visibility: "hidden"
+				},
+
 				/**
 				 * Defines the state of the <code>Card</code>. When set to <code>Inactive</code>, the <code>Card</code> doesn't make requests.
 				 * @ui5-experimental-since 1.65
@@ -243,10 +259,14 @@ sap.ui.define([
 				},
 
 				/**
-				 * Defines the base URL of the card manifest. It should be used when manifest property is an object instead of a URL.
-				 * If both manifest URL and base URL are defined - the base URL will be used for loading dependencies.
-				 * If both manifest URL and base URL are not defined - relative resources might not be loaded correctly.
-				 * @ui5-experimental-since 1.70
+				 * Defines the base URL of the card manifest. It must be provided when the manifest is an object and not a URL.
+				 * The base URL is used to load relatively referenced resources.
+				 *
+				 *	If the base URL is not defined and the manifest URL is defined, the manifest URL is used as the base URL.
+				 *	<ul>
+				 *	<li>If both the manifest URL and the base URL are defined, the base URL is used.</li>
+				 *	<li>If neither the manifest URL nor the base URL is defined, relative resources will not load correctly.</li>
+				 *	</ul>
 				 */
 				baseUrl: {
 					type: "sap.ui.core.URI",
@@ -622,6 +642,7 @@ sap.ui.define([
 		this._aSevereErrors = [];
 		this._sPerformanceId = "UI5 Integration Cards " + this.getId() + " ";
 		this._aActiveLoadingProviders = [];
+		this._oCustomSettings = this.getProperty("customSettings");
 		this._fnOnDataReady = function () {
 			this._bDataReady = true;
 		}.bind(this);
@@ -639,7 +660,7 @@ sap.ui.define([
 		 * @name sap.ui.integration.widgets.CardFacade
 		 * @public
 		 * @author SAP SE
-		 * @version 1.146.0
+		 * @version 1.147.0
 		 * @borrows sap.ui.integration.widgets.Card#getId as getId
 		 * @borrows sap.ui.integration.widgets.Card#getCombinedParameters as getCombinedParameters
 		 * @borrows sap.ui.integration.widgets.Card#getManifestEntry as getManifestEntry
@@ -649,8 +670,7 @@ sap.ui.define([
 		 * @borrows sap.ui.integration.widgets.Card#refreshData as refreshData
 		 * @borrows sap.ui.integration.widgets.Card#showMessage as showMessage
 		 * @borrows sap.ui.integration.widgets.Card#hideMessage as hideMessage
-		 * @borrows sap.ui.integration.widgets.Card#getBaseUrl as getBaseUrl
-		 * @borrows sap.ui.integration.widgets.Card#getRuntimeUrl as getRuntimeUrl
+		 * @borrows sap.ui.integration.widgets.Card#resolveUrl as resolveUrl
 		 * @borrows sap.ui.integration.widgets.Card#getTranslatedText as getTranslatedText
 		 * @borrows sap.ui.integration.widgets.Card#triggerAction as triggerAction
 		 * @borrows sap.ui.integration.widgets.Card#addActionDefinition as addActionDefinition
@@ -682,7 +702,8 @@ sap.ui.define([
 			"refreshData",
 			"showMessage",
 			"getBaseUrl",
-			"getRuntimeUrl",
+			"resolveUrl",
+			"getRuntimeUrl", // @deprecated since 1.147.0
 			"getTranslatedText",
 			"getModel",
 			"triggerAction",
@@ -702,6 +723,13 @@ sap.ui.define([
 			"hideBlockingMessage",
 			"getBlockingMessage"
 		]);
+
+		// Temporary compatibility for deprecated getBaseUrl method
+		const fnOriginalGetBaseUrl = this._oLimitedInterface.getBaseUrl;
+		this._oLimitedInterface.getBaseUrl = function() {
+			Log.warning("Method 'getBaseUrl' must not be used through the card interface. It will be removed soon. Use 'resolveUrl' instead.");
+			return fnOriginalGetBaseUrl.apply(this, arguments);
+		};
 	};
 
 	/**
@@ -751,6 +779,10 @@ sap.ui.define([
 			parameters: {
 				init: () => this.setModel(new JSONModel(ParameterMap.getParamsForModel()), "parameters")
 			},
+			customSettings: {
+				init: () => this.setModel(new JSONModel({}), "customSettings"),
+				reset: () => this.getModel("customSettings").setData({})
+			},
 			filters: {
 				init: () => this.setModel(new JSONModel(), "filters"),
 				reset: () => this.getModel("filters").setData({})
@@ -876,6 +908,12 @@ sap.ui.define([
 		if (this._getActualDataMode() !== CardDataMode.Active) {
 			return;
 		}
+
+		if (this._oCustomSettings !== this.getProperty("customSettings")) {
+			this._bApplyCustomSettings = true;
+			this._oCustomSettings = this.getProperty("customSettings");
+		}
+
 		this.startManifestProcessing();
 	};
 
@@ -922,7 +960,7 @@ sap.ui.define([
 			);
 		}
 
-		if (this._bApplyManifest || this._bApplyParameters) {
+		if (this._bApplyManifest || this._bApplyParameters || this._bApplyCustomSettings) {
 			this._clearReadyState();
 			this._initReadyState();
 		}
@@ -933,7 +971,7 @@ sap.ui.define([
 			this.createManifest(vManifest, this.getBaseUrl());
 		}
 
-		if (!this._bApplyManifest && this._bApplyParameters) {
+		if (!this._bApplyManifest && (this._bApplyParameters || this._bApplyCustomSettings)) {
 			this._oCardManifest.processParameters(this._getContextAndRuntimeParams());
 
 			this.processDestinations(this._oCardManifest.getJson()).then((oResult) => {
@@ -945,6 +983,7 @@ sap.ui.define([
 
 		this._bApplyManifest = false;
 		this._bApplyParameters = false;
+		this._bApplyCustomSettings = false;
 		this._refreshActionsMenu();
 	};
 
@@ -1611,6 +1650,36 @@ sap.ui.define([
 		return oResultParams;
 	};
 
+	/**
+	 * Gets the merged custom settings from the manifest combined with the settings from <code>customSettings</code> property.
+	 * Card manifest values take precedence for individual properties (shallow merge).
+	 *
+	 * <b>Notes</b>
+	 *
+	 * - Use this method when the manifest is ready. Check <code>manifestReady</code> event.
+	 *
+	 * - This method is intended for use by Mobile SDK.
+	 *
+	 * @private
+	 * @ui5-restricted Mobile SDK
+	 * @returns {object} Object containing the merged custom settings. Returns <code>null</code> if the manifest is not ready.
+	 * @ui5-experimental-since 1.146
+	 */
+	Card.prototype.getCombinedCustomSettings = function () {
+		if (!this._isManifestReady) {
+			Log.error("The manifest is not ready. Consider using the 'manifestReady' event.", "sap.ui.integration.widgets.Card");
+			return null;
+		}
+
+		const oModel = this.getModel("customSettings");
+		if (oModel) {
+			const oData = oModel.getData();
+			return jQuery.extend(true, {}, oData);
+		}
+
+		return {};
+	};
+
 	/**
 	 * Returns a value from the Manifest based on the specified path.
 	 *
@@ -1850,37 +1919,42 @@ sap.ui.define([
 	};
 
 	/**
-	 * Resolves the given URL relatively to the manifest base path.
+	 * Resolves the given URL relative to the manifest base path.
 	 * Absolute paths are not changed.
 	 *
 	 * @example
-	 * oCard.getRuntimeUrl("images/Avatar.png") === "{cardBaseUrl}/images/Avatar.png"
-	 * oCard.getRuntimeUrl("/images/Avatar.png") === "/images/Avatar.png" (remains relative to host root)
-	 * oCard.getRuntimeUrl("http://www.someurl.com/Avatar.png") === "http://www.someurl.com/Avatar.png"
-	 * oCard.getRuntimeUrl("https://www.someurl.com/Avatar.png") === "https://www.someurl.com/Avatar.png"
+	 * oCard.resolveUrl("images/Avatar.png") === "{cardBaseUrl}/images/Avatar.png"
+	 * oCard.resolveUrl("/images/Avatar.png") === "/images/Avatar.png" (remains relative to host root)
+	 * oCard.resolveUrl("http://www.someurl.com/Avatar.png") === "http://www.someurl.com/Avatar.png"
+	 * oCard.resolveUrl("https://www.someurl.com/Avatar.png") === "https://www.someurl.com/Avatar.png"
 	 *
 	 * @ui5-restricted
 	 * @param {string} sUrl The URL to resolve.
 	 * @returns {string} The resolved URL.
 	 */
-	Card.prototype.getRuntimeUrl = function (sUrl) {
+	Card.prototype.resolveUrl = function (sUrl) {
 		if (!sUrl) {
 			sUrl = "";
 		}
 
-		const sAppId = this._oCardManifest ? this._oCardManifest.get("/sap.app/id") : null;
-		if (sAppId === null) {
+		if (!this._oCardManifest) {
 			Log.error("The manifest is not ready so the URL can not be resolved. Consider using the 'manifestReady' event.", "sap.ui.integration.widgets.Card");
 			return null;
 		}
 
-		if (!sAppId ||
-			sUrl.startsWith("http://") ||
+		const sAppId = this._oCardManifest.get("/sap.app/id");
+
+		if (sUrl.startsWith("http://") ||
 			sUrl.startsWith("https://") ||
 			sUrl.startsWith("//")) {
 			return sUrl;
 		}
 
+		if (!sAppId) {
+			Log.error("The manifest property 'sap.app/id' is missing or empty. The URL '" + sUrl + "' cannot be resolved.", "sap.ui.integration.widgets.Card");
+			return sUrl;
+		}
+
 		if (sUrl.startsWith("/")) {
 			// urls which are absolute to the server root are not changed
 			return sUrl;
@@ -1894,6 +1968,26 @@ sap.ui.define([
 		return sap.ui.require.toUrl(sAppName) + "/" + sSanitizedUrl;
 	};
 
+	/**
+	 * Resolves the given URL relative to the manifest base path.
+	 * Absolute paths are not changed.
+	 *
+	 * @example
+	 * oCard.getRuntimeUrl("images/Avatar.png") === "{cardBaseUrl}/images/Avatar.png"
+	 * oCard.getRuntimeUrl("/images/Avatar.png") === "/images/Avatar.png" (remains relative to host root)
+	 * oCard.getRuntimeUrl("http://www.someurl.com/Avatar.png") === "http://www.someurl.com/Avatar.png"
+	 * oCard.getRuntimeUrl("https://www.someurl.com/Avatar.png") === "https://www.someurl.com/Avatar.png"
+	 *
+	 * @deprecated As of version 1.146, replaced by {@link sap.ui.integration.widgets.Card#resolveUrl}
+	 * @ui5-restricted
+	 * @param {string} sUrl The URL to resolve.
+	 * @returns {string} The resolved URL.
+	 */
+	Card.prototype.getRuntimeUrl = function (sUrl) {
+		Log.warning("'getRuntimeUrl' is deprecated. Use 'resolveUrl' instead.", "sap.ui.integration.widgets.Card");
+		return this.resolveUrl(sUrl);
+	};
+
 	/**
 	 * Returns the matching value from the query.
 	 *
@@ -1975,6 +2069,7 @@ sap.ui.define([
 	 */
 	Card.prototype._applyManifestSettings = function () {
 		this._setParametersModelData();
+		this._setCustomSettingsModelData();
 
 		this._checkMockPreviewMode();
 
@@ -2017,6 +2112,24 @@ sap.ui.define([
 		this.getModel("parameters").setData(merge(oPredefinedParameters, oCustomParameters));
 	};
 
+	/**
+	 * Sets the data for the customSettings model.
+	 * Merges <code>customSettings</code> property with card manifest overrides.
+	 * Card manifest values take precedence for individual properties.
+	 *
+	 * The merge is shallow - card manifest can override individual properties
+	 * while preserving non-overridden properties from <code>customSettings</code> property.
+	 *
+	 * @private
+	 */
+	Card.prototype._setCustomSettingsModelData = function () {
+		const oCustomSettings = this.getProperty("customSettings");
+		const oManifestOverrides = this._oCardManifest.get(MANIFEST_PATHS.CUSTOM_SETTINGS) || {};
+		const oMergedSettings = Object.assign({}, oCustomSettings, oManifestOverrides);
+
+		this.getModel("customSettings").setData(oMergedSettings);
+	};
+
 	Card.prototype._applyDataManifestSettings = function () {
 		var oDataSettings = this._oCardManifest.get(MANIFEST_PATHS.DATA),
 			oModel;
@@ -2321,7 +2434,7 @@ sap.ui.define([
 					sAncestorUrl = new URL(oAncestor.getManifest(), window.location).href;
 				}
 
-				if (new URL(this.getRuntimeUrl(manifest), window.location).href === sAncestorUrl) {
+				if (new URL(this.resolveUrl(manifest), window.location).href === sAncestorUrl) {
 					sMatchingChildManifestUrl = manifest;
 					break;
 				}
@@ -3505,13 +3618,13 @@ sap.ui.define([
 		}
 
 		if (typeof vManifest === "string") {
-			oChildCard.setManifest(this.getRuntimeUrl(vManifest));
+			oChildCard.setManifest(this.resolveUrl(vManifest));
 			if (sBaseUrl) {
 				oChildCard.setBaseUrl(sBaseUrl);
 			}
 		} else {
 			oChildCard.setManifest(vManifest);
-			oChildCard.setBaseUrl(sBaseUrl || this.getRuntimeUrl());
+			oChildCard.setBaseUrl(sBaseUrl || this.resolveUrl());
 		}
 
 		return oChildCard;