@openui5/sap.ui.integration 1.96.1 → 1.97.1

package/src/sap/ui/integration/util/Manifest.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.
  */
 
@@ -29,7 +29,7 @@ sap.ui.define([
 		MANIFEST_FILTERS = "/{SECTION}/configuration/filters",
 		MANIFEST_CONFIGURATION = "/{SECTION}",
 		APP_DATA_SOURCES = "/sap.app/dataSources",
-		REGEXP_TRANSLATABLE = /\{\{(?!parameters.)(?!destinations.)([^\}\}]+)\}\}|\{i18n>([^\}]+)\}/g;
+		REGEXP_TRANSLATABLE = /\{\{(?!parameters.)(?!destinations.)(?!csrfTokens.)([^\}\}]+)\}\}|\{i18n>([^\}]+)\}/g;
 
 	/**
 	 * Creates a new Manifest object.
@@ -60,7 +60,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.96.1
+	 * @version 1.97.1
 	 *
 	 * @constructor
 	 * @private

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,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([
@@ -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"];
 
 	/**
 	 * 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.1
+	 * @version 1.97.1
 	 *
 	 * @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.1
+	 * @version 1.97.1
 	 *
 	 * @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.1
+	 * @version 1.97.1
 	 *
 	 * @constructor
 	 * @param {Object} mServiceFactoryReferences A map with service descriptions.

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.1
+	 * @version 1.97.1
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Utils
@@ -132,5 +132,45 @@ 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;
+	};
+
 	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 () {

package/src/sap/ui/integration/widgets/Card.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([
@@ -83,6 +83,7 @@ sap.ui.define([
 		APP_TYPE: "/sap.app/type",
 		PARAMS: "/sap.card/configuration/parameters",
 		DESTINATIONS: "/sap.card/configuration/destinations",
+		CSRF_TOKENS: "/sap.card/configuration/csrfTokens",
 		FILTERS: "/sap.card/configuration/filters"
 	};
 
@@ -158,7 +159,7 @@ sap.ui.define([
 	 * @extends sap.f.CardBase
 	 *
 	 * @author SAP SE
-	 * @version 1.96.1
+	 * @version 1.97.1
 	 * @public
 	 * @constructor
 	 * @see {@link topic:5b46b03f024542ba802d99d67bc1a3f4 Cards}
@@ -409,6 +410,7 @@ sap.ui.define([
 		this.setModel(new JSONModel()); // always create a default model to isolate the card from a propagated default model
 		this.setModel(new JSONModel(), "parameters");
 		this.setModel(new JSONModel(), "filters");
+		// this.setModel(new JSONModel(), "csrfTokens");
 		this.setModel(new ContextModel(), "context");
 		this._oContentFactory = new ContentFactory(this);
 		this._oCardObserver = new CardObserver(this);
@@ -424,7 +426,7 @@ sap.ui.define([
 		 * @experimental since 1.79
 		 * @public
 		 * @author SAP SE
-		 * @version 1.96.1
+		 * @version 1.97.1
 		 * @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
@@ -621,6 +623,10 @@ sap.ui.define([
 			this._oDestinations.setHost(oHostInstance);
 		}
 
+		if (this._oDataProviderFactory) {
+			this._oDataProviderFactory.setHost(oHostInstance);
+		}
+
 		if (oHostInstance && oHostInstance.bUseExperimentalCaching) {
 			this.addStyleClass("sapFCardExperimentalCaching");
 		} else {
@@ -979,6 +985,7 @@ sap.ui.define([
 			this._oTemporaryContent.destroy();
 			this._oTemporaryContent = null;
 		}
+
 		if (this._oDestinations) {
 			this._oDestinations.destroy();
 			this._oDestinations = null;
@@ -1003,6 +1010,7 @@ sap.ui.define([
 
 		this.getModel("filters").setData({});
 		this.getModel("parameters").setData({});
+		// this.getModel("csrfTokens").setData({});
 
 		this._oContextParameters = null;
 
@@ -1264,7 +1272,13 @@ sap.ui.define([
 			card: this
 		});
 
-		this._oDataProviderFactory = new DataProviderFactory(this._oDestinations, oExtension, this);
+		this._oDataProviderFactory = new DataProviderFactory({
+			host: this.getHostInstance(),
+			destinations: this._oDestinations,
+			extension: oExtension,
+			csrfTokensConfig: this._oCardManifest.get(MANIFEST_PATHS.CSRF_TOKENS),
+			card: this
+		});
 
 		this._registerCustomModels();
 

package/src/sap/ui/integration/widgets/CardRenderer.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-card-editor.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-editor.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.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.
  */