@openui5/sap.ui.integration 1.96.2 → 1.98.0

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

@@ -0,0 +1,99 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/ui/integration/util/BindingHelper",
+	"sap/ui/integration/util/BindingResolver",
+	"sap/ui/integration/util/Utils"
+], function (
+	BindingHelper,
+	BindingResolver,
+	Utils
+) {
+	"use strict";
+
+	/**
+	 * Util class for preprocessing of card manifests.
+	 * @namespace sap.ui.integration.util.ManifestResolver
+	 * @since 1.97
+	 * @experimental 1.97
+	 * @private
+	 * @ui5-restricted Mobile SDK
+	 */
+	var ManifestResolver = {};
+
+	/**
+	 * Resolves a card and returns its resolved manifest.
+	 * @memberof sap.ui.integration.util.ManifestResolver
+	 * @alias sap.ui.integration.util.ManifestResolver.resolveCard
+	 * @param {sap.ui.integration.widgets.Card} oCard The card to resolve.
+	 * @returns {Promise<string>} Promise which resolves with stringified manifest with resolved bindings and translations or rejects with an error message if there is an error.
+	 * @private
+	 * @ui5-restricted Mobile SDK
+	 */
+	ManifestResolver.resolveCard = function (oCard) {
+		oCard.startManifestProcessing();
+
+		return ManifestResolver._awaitReadyEvent(oCard)
+			.then(ManifestResolver._handleCardReady);
+	};
+
+	ManifestResolver._awaitReadyEvent = function (oCard) {
+		return new Promise(function (resolve, reject) {
+			oCard.attachEvent("_ready", function (e) {
+				resolve(oCard);
+			});
+		});
+	};
+
+	ManifestResolver._handleCardReady = function (oCard) {
+		var oManifest = oCard.getManifestEntry("/");
+		var aFilters = [];
+		var aErrors = oCard.getFundamentalErrors();
+
+		if (aErrors.length) {
+			return Promise.reject(aErrors.join(" "));
+		}
+
+		if (oCard.getAggregation("_filterBar")) {
+			aFilters =  oCard.getAggregation("_filterBar")._getFilters().map(function (oFilter) {
+				return ["/sap.card/configuration/filters/" + oFilter.getKey(), oFilter];
+			});
+		}
+
+		// Process card sections in order - nested sections with "data" have to be processed first
+		aFilters.concat([
+			["/sap.card/content", oCard.getCardContent()],
+			["/sap.card/header", oCard.getCardHeader()],
+			["/sap.card", oCard]
+		]).filter(function (aPathAndContext) {
+			return !!oCard.getManifestEntry(aPathAndContext[0]); // only resolve existing sections
+		}).forEach(function (aPathAndContext) {
+			var sManifestPath = aPathAndContext[0];
+			var oContext = aPathAndContext[1];
+			var oSubConfig;
+
+			if (oContext.getStaticConfiguration) {
+				oSubConfig = oContext.getStaticConfiguration();
+			} else {
+				oSubConfig = Utils.getNestedPropertyValue(oManifest, sManifestPath);
+			}
+
+			if (oSubConfig.data) {
+				var sDataPath = oSubConfig.data.path;
+				delete oSubConfig.data;
+				oSubConfig = BindingHelper.createBindingInfos(oSubConfig, oCard.getBindingNamespaces());
+				oSubConfig = BindingResolver.resolveValue(oSubConfig, oContext, sDataPath);
+			}
+
+			Utils.setNestedPropertyValue(oManifest, sManifestPath, oSubConfig);
+		});
+
+		oCard.destroy();
+		return JSON.stringify(oManifest);
+	};
+
+	return ManifestResolver;
+});

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

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

@@ -1,11 +1,11 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
 	"sap/ui/integration/util/DataProvider",
-	"jquery.sap.global",
+	"sap/ui/thirdparty/jquery",
 	"sap/base/Log",
 	"sap/ui/model/odata/v4/ODataUtils"
 ], function (DataProvider, jQuery, Log, ODataUtils) {
@@ -18,7 +18,7 @@ sap.ui.define([
 	var RETRY_STATUS_CODES = [429, 503];
 
 	var aModes = ["no-cors", "same-origin", "cors"];
-	var aMethods = ["GET", "POST"];
+	var aMethods = ["GET", "POST", "HEAD", "PUT", "PATCH", "DELETE", "OPTIONS"];
 
 	/**
 	 * Constructor for a new <code>RequestDataProvider</code>.
@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private
@@ -63,6 +63,10 @@ sap.ui.define([
 		DataProvider.prototype.destroy.apply(this, arguments);
 	};
 
+	RequestDataProvider.prototype.getLastJQXHR = function () {
+		return this._lastJQXHR;
+	};
+
 	/**
 	 * @override
 	 * @private
@@ -70,35 +74,39 @@ sap.ui.define([
 	 * @returns {Promise} A promise resolved when the data is available and rejected in case of an error.
 	 */
 	RequestDataProvider.prototype.getData = function () {
-		var oRequestConfig = this.getSettings().request;
+		var oRequestConfig = this.getSettings().request,
+			pRequestChain = Promise.resolve(oRequestConfig);
 
 		if (this._oDestinations) {
-			return this._oDestinations.process(oRequestConfig)
-				.then(this._fetch.bind(this));
+			pRequestChain = this._oDestinations.process(oRequestConfig);
 		}
 
-		return this._fetch(oRequestConfig);
-	};
+		if (this._oCsrfTokenHandler) {
+			pRequestChain = pRequestChain.then(function (oRequest) {
+				return this._oCsrfTokenHandler.resolveToken(oRequest);
+			}.bind(this));
+		}
 
-	RequestDataProvider.prototype._isValidRequest = function (oRequest) {
+		pRequestChain = pRequestChain.then(this._fetch.bind(this));
 
-		if (!oRequest) {
-			return false;
+		if (this._oCsrfTokenHandler) {
+			pRequestChain = pRequestChain.catch(this._handleExpiredToken.bind(this));
 		}
 
-		if (aModes.indexOf(oRequest.mode) === -1) {
-			return false;
-		}
+		return pRequestChain;
+	};
 
-		if (aMethods.indexOf(oRequest.method) === -1) {
-			return false;
-		}
+	RequestDataProvider.prototype._handleExpiredToken = function (oError) {
+		if (this._oCsrfTokenHandler.isExpiredToken(this.getLastJQXHR())) {
+			// csrf token has expired, reset the token and retry this whole request
+			this._oCsrfTokenHandler.resetTokenByRequest(this.getSettings().request);
 
-		if (typeof oRequest.url !== "string") {
-			return false;
+			return this.getData().catch(function (oError) {
+				throw oError;
+			});
 		}
 
-		return true;
+		throw oError;
 	};
 
 	RequestDataProvider.prototype._fetch = function (oRequestConfig) {
@@ -153,6 +161,10 @@ sap.ui.define([
 			}
 		};
 
+		if (!vData) {
+			delete oRequest.data;
+		}
+
 		if (!this._isValidRequest(oRequest)) {
 			Log.error(sMessage);
 			return Promise.reject(sMessage);
@@ -160,11 +172,10 @@ sap.ui.define([
 
 		return this._request(oRequest)
 			.then(function (vResult) {
-				var vData = vResult[0],
-					jqXHR = vResult[1];
+				var vData = vResult[0];
 
 				if (mBatchRequests) {
-					return this._deserializeBatchResponse(mBatchRequests, vData, jqXHR);
+					return this._deserializeBatchResponse(mBatchRequests, vData);
 				}
 
 				return vData;
@@ -179,28 +190,35 @@ sap.ui.define([
 	 */
 	RequestDataProvider.prototype._request = function (oRequest, bNoRetry) {
 		return new Promise(function (resolve, reject) {
-			jQuery.ajax(oRequest).done(function (vData, sTextStatus, jqXHR) {
-				if (this.bIsDestroyed) {
-					reject("RequestDataProvider is already destroyed before the response is received.");
-					return;
-				}
-
-				resolve([vData, jqXHR]);
-			}).fail(function (jqXHR, sTextStatus, sError) {
-				var aError = [sError, jqXHR];
-
-				if (this.bIsDestroyed) {
-					reject("RequestDataProvider is already destroyed while error in the response occurred.");
-					return;
-				}
-
-				if (bNoRetry) {
-					reject(aError);
-					return;
-				}
-
-				this._retryRequest(aError, oRequest).then(resolve, reject);
-			}.bind(this));
+			jQuery.ajax(oRequest).done(
+				function (vData, sTextStatus, jqXHR) {
+					if (this.bIsDestroyed) {
+						reject("RequestDataProvider is already destroyed before the response is received.");
+						return;
+					}
+
+					this._lastJQXHR = jqXHR;
+
+					resolve([vData, jqXHR]);
+				}.bind(this)
+			).fail(
+				function (jqXHR, sTextStatus, sError) {
+					var aError = [sError, jqXHR];
+
+					if (this.bIsDestroyed) {
+						reject("RequestDataProvider is already destroyed while error in the response occurred.");
+						return;
+					}
+
+					this._lastJQXHR = jqXHR;
+
+					if (bNoRetry) {
+						reject(aError);
+						return;
+					}
+
+					this._retryRequest(aError, oRequest).then(resolve, reject);
+				}.bind(this));
 		}.bind(this));
 	};
 
@@ -286,17 +304,37 @@ sap.ui.define([
 		return false;
 	};
 
+	RequestDataProvider.prototype._isValidRequest = function (oRequest) {
+
+		if (!oRequest) {
+			return false;
+		}
+
+		if (aModes.indexOf(oRequest.mode) === -1) {
+			return false;
+		}
+
+		if (aMethods.indexOf(oRequest.method) === -1) {
+			return false;
+		}
+
+		if (typeof oRequest.url !== "string") {
+			return false;
+		}
+
+		return true;
+	};
+
 	/**
 	 * Deserializes the result of a batch (multipart/mixed) request.
 	 * @private
 	 * @param {map} mBatchRequests The requests which were send in batch. Order in the response must match.
 	 * @param {Object} sResponseBody The response to be deserialized.
-	 * @param {jqXHR} jqXHR The jQuery XHR which goes with the response.
 	 * @returns {Object} The deserialized response. Each object in the result will have a key matching the one in the request.
 	 */
-	RequestDataProvider.prototype._deserializeBatchResponse = function (mBatchRequests, sResponseBody, jqXHR) {
+	RequestDataProvider.prototype._deserializeBatchResponse = function (mBatchRequests, sResponseBody) {
 		return new Promise(function(resolve, reject) {
-			var sContentType = jqXHR.getResponseHeader("Content-Type"),
+			var sContentType = this.getLastJQXHR().getResponseHeader("Content-Type"),
 				aBatchResponses = ODataUtils.deserializeBatchResponse(sContentType, sResponseBody, false),
 				aKeys = Object.keys(mBatchRequests),
 				mResult = {};
@@ -321,7 +359,7 @@ sap.ui.define([
 			});
 
 			resolve(mResult);
-		});
+		}.bind(this));
 	};
 
 	/**

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define(["sap/ui/integration/util/DataProvider"], function (DataProvider) {
@@ -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.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
@@ -37,7 +37,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @param {Object} mServiceFactoryReferences A map with service descriptions.

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

@@ -0,0 +1,50 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/ui/integration/widgets/Card",
+	"sap/ui/integration/util/ManifestResolver"
+], function (Card, ManifestResolver) {
+	"use strict";
+
+	/**
+	 * Constructor for a new <code>SkeletonCard</code>.
+	 * @inherit
+	 * @class
+	 *
+	 * Represents a card which can work without being rendered.
+	 *
+	 * @extends sap.ui.integration.widgets.Card
+	 *
+	 * @author SAP SE
+	 * @version 1.98.0
+	 *
+	 * @constructor
+	 * @private
+	 * @ui5-restricted Mobile SDK
+	 * @since 1.98
+	 * @alias sap.ui.integration.util.SkeletonCard
+	 */
+	var SkeletonCard = Card.extend("sap.ui.integration.util.SkeletonCard");
+
+	/**
+	 * Resolves the card manifest to a static manifest.
+	 * Processes all bindings and translations then returns the result as a static manifest in which bindings and translations are resolved.
+	 *
+	 * @returns {Promise<string>} Promise which resolves with stringified manifest with resolved bindings and translations or rejects with an error message if there is an error.
+	 */
+	SkeletonCard.prototype.resolveManifest = function () {
+		return ManifestResolver.resolveCard(this);
+	};
+
+	/**
+	 * @private
+	 */
+	SkeletonCard.prototype.isSkeleton = function () {
+		return true;
+	};
+
+	return SkeletonCard;
+});

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Utility class helping with JSON strings and formatters.
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Utils
@@ -132,5 +132,77 @@ sap.ui.define([
 		return typeof sString == "string" && ["null", "false", "undefined", ""].indexOf(sString.trim()) > -1;
 	};
 
+	Utils.setNestedPropertyValue = function (oObject, sPath, vValue) {
+		var aPaths = sPath.substring(1).split("/"),
+			sPathSegment;
+
+		for (var i = 0; i < aPaths.length - 1; i++) {
+			sPathSegment = aPaths[i];
+
+			// Prevent access to native properties
+			oObject = oObject.hasOwnProperty(sPathSegment) ? oObject[sPathSegment] : undefined;
+
+			// Only continue with lookup if the value is an object.
+			// Accessing properties of other types is not allowed!
+			if (oObject === null || typeof oObject !== "object") {
+				break;
+			}
+		}
+
+		oObject[aPaths[aPaths.length - 1]] = vValue;
+	};
+
+	Utils.getNestedPropertyValue = function (oObject, sPath) {
+		var aPaths = sPath.substring(1).split("/"),
+			sPathSegment;
+
+		for (var i = 0; i < aPaths.length; i++) {
+			sPathSegment = aPaths[i];
+
+			// Prevent access to native properties
+			oObject = oObject.hasOwnProperty(sPathSegment) ? oObject[sPathSegment] : undefined;
+
+			// Only continue with lookup if the value is an object.
+			// Accessing properties of other types is not allowed!
+			if (oObject === null || typeof oObject !== "object") {
+				break;
+			}
+		}
+
+		return oObject;
+	};
+
+	/**
+	 * @param {object|array} vData Object with 'undefined' values
+	 * @returns {object|array} The same object will all 'undefined' values replaced with 'null'
+	 */
+	Utils.makeUndefinedValuesNull = function (vData) {
+		if (Array.isArray(vData)) {
+			return vData.map(function (vValue) {
+				if (vValue === undefined) {
+					return null;
+				}
+
+				if (typeof vValue === "object") {
+					return Utils.makeUndefinedValuesNull(vValue);
+				}
+
+				return vValue;
+			});
+		}
+
+		for (var sKey in vData) {
+			if (vData.hasOwnProperty(sKey)) {
+				if (vData[sKey] === undefined) {
+					vData[sKey] = null;
+				} else if (typeof vData[sKey] === "object") {
+					vData[sKey] = Utils.makeUndefinedValuesNull(vData[sKey]);
+				}
+			}
+		}
+
+		return vData;
+	};
+
 	return Utils;
 });

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

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define(function () {