@openui5/sap.ui.integration 1.96.2 → 1.98.0

package/src/sap/ui/integration/util/ContentFactory.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([
 	"./BaseFactory",
-	"./CardActions",
+	"sap/ui/integration/cards/actions/CardActions",
 	"sap/ui/integration/cards/AdaptiveContent",
 	"sap/ui/integration/cards/AnalyticalContent",
 	"sap/ui/integration/cards/AnalyticsCloudContent",
@@ -40,7 +40,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private
@@ -87,14 +87,10 @@ sap.ui.define([
 					oContent.setDataProviderFactory(mConfig.dataProviderFactory);
 					oContent.setIconFormatter(mConfig.iconFormatter);
 					oContent.setActions(oActions);
+					oContent.setConfiguration(mConfig.contentManifest, sType);
 
-					if (sType.toLowerCase() !== "adaptivecard") {
-						oContent.setConfiguration(this.createBindingInfos(mConfig.contentManifest), sType);
-					} else {
-						oContent.setConfiguration(mConfig.contentManifest);
-					}
 					resolve(oContent);
-				}.bind(this))
+				})
 				.catch(function (sError) {
 					reject(sError);
 				});

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

@@ -0,0 +1,296 @@
+/*!
+ * 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/base/Object",
+	"sap/base/util/isPlainObject",
+	"sap/base/util/merge",
+	"sap/ui/model/json/JSONModel"
+], function (
+	BaseObject,
+	isPlainObject,
+	merge,
+	JSONModel
+) {
+	"use strict";
+
+	var rPattern = /\{\{csrfTokens.([^\}]+)/;
+	var TOKEN_DEFAULT_HEADER = "X-CSRF-Token";
+
+	/**
+	 * Constructor for a new <code>CsrfTokenHandler</code>.
+	 *
+	 * @class
+	 * Fetches and provides CSRF tokens for data requests.
+	 * Tokens are shared between cards per user session.
+	 *
+	 * @extends sap.ui.base.Object
+	 *
+	 * @author SAP SE
+	 * @version 1.98.0
+	 *
+	 * @constructor
+	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolve CSRF tokens.
+	 * @param {object} oConfiguration The CSRF configuration from the manifest.
+	 * @private
+	 * @ui5-restricted
+	 * @alias sap.ui.integration.util.CsrfTokenHandler
+	 */
+	var CsrfTokenHandler = BaseObject.extend("sap.ui.integration.util.CsrfTokenHandler", {
+		metadata: {
+			library: "sap.ui.integration"
+		},
+		constructor: function (mSettings) {
+			BaseObject.call(this);
+
+			mSettings = mSettings || {};
+
+			this._oHost = mSettings.host;
+			this._oConfiguration = mSettings.configuration;
+		}
+	});
+
+	/**
+	 * Map of all Promises which resolve to CSRF tokens. Keyed by the unique URL of each CSRF request. Shared by all cards.
+	 *
+	 * @static
+	 * @private
+	 */
+	CsrfTokenHandler._mTokens = new Map();
+
+	/**
+	 * Resolves CSRF placeholders to actual values within a data configuration object.
+	 *
+	 * @public
+	 * @param {object} oDataConfig Data configuration object
+	 * @returns {Promise} A promise which resolves with the data configuration object containing resolved CSRF token values
+	 */
+	CsrfTokenHandler.prototype.resolveToken = function (oDataConfig) {
+		var oCsrfTokenContext,
+			oCsrfTokenConfig;
+
+		// clone the data configuration,
+		// so we won't change the original settings
+		oDataConfig = merge({}, oDataConfig);
+
+		oCsrfTokenContext = this._findCsrfPlaceholder(oDataConfig);
+
+		if (!oCsrfTokenContext) {
+			return Promise.resolve(oDataConfig);
+		}
+
+		oCsrfTokenConfig = this._getCsrfConfig(oCsrfTokenContext.tokenName);
+
+		if (this._oHost) {
+			return this._oHost.getCsrfToken(oCsrfTokenConfig)
+				.then(function (sTokenValue) {
+					if (!sTokenValue) {
+						return this._resolveTokenByUrl(oDataConfig, oCsrfTokenContext);
+					}
+
+					this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
+					return oDataConfig;
+				}.bind(this))
+				.catch(function (sError) {
+					return Promise.reject(sError);
+				});
+		}
+
+		return this._resolveTokenByUrl(oDataConfig, oCsrfTokenContext);
+	};
+
+	CsrfTokenHandler.prototype._resolveTokenByUrl = function (oDataConfig, oCsrfTokenContext) {
+		var sCsrfTokenName = oCsrfTokenContext.tokenName,
+			sCsrfUrl = this._getCsrfConfig(sCsrfTokenName).data.request.url;
+
+		if (CsrfTokenHandler._mTokens.has(sCsrfUrl)) {
+			return CsrfTokenHandler._mTokens.get(sCsrfUrl).then(function (sTokenValue) {
+				this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
+				return oDataConfig;
+			}.bind(this));
+		}
+
+		if (sCsrfTokenName) {
+			return this._requestToken(oDataConfig, oCsrfTokenContext);
+		}
+
+		return Promise.resolve(oDataConfig);
+	};
+
+	/**
+	 * Saves a reference to the DataProviderFactory to create own data requests.
+	 * Those CSRF placeholders may contain destinations placeholders which need to be resolved prior to making the request.
+	 *
+	 * @public
+	 * @param {sap.ui.integration.util.DataProviderFactory} oDataProviderFactory the factory
+	 */
+	CsrfTokenHandler.prototype.setDataProviderFactory = function (oDataProviderFactory) {
+		this._oDataProviderFactory = oDataProviderFactory;
+	};
+
+	/**
+	 * Sets the host which is used to resolve tokens.
+	 * @param {sap.ui.integration.Host} oHost The host.
+	 */
+	CsrfTokenHandler.prototype.setHost = function (oHost) {
+		this._oHost = oHost;
+	};
+
+	/**
+	 * Checks if a response contains an expired CSRF Token.
+	 * @param {object} jqXHR The request.
+	 */
+	CsrfTokenHandler.prototype.isExpiredToken = function (jqXHR) {
+		if (!jqXHR) {
+			return false;
+		}
+
+		var sXCSRFHeader = jqXHR.getResponseHeader(TOKEN_DEFAULT_HEADER);
+		return sXCSRFHeader && sXCSRFHeader.toLowerCase() === "required" && jqXHR.status === 403;
+	};
+
+	/**
+	 * Executes a CSRF token request based on the data configuration object which contains a CSRF placeholder in its headers property.
+	 *
+	 * @private
+	 * @param {object} oDataConfig Data configuration object
+	 * @returns {Promise} Promise which resolves with the CSRF token
+	 */
+	CsrfTokenHandler.prototype._requestToken = function (oDataConfig, oCsrfTokenContext) {
+		var sCsrfTokenName = oCsrfTokenContext.tokenName,
+			oCsrfTokenConfig = this._getCsrfConfig(sCsrfTokenName);
+
+		if (!sCsrfTokenName || !oCsrfTokenConfig) {
+			return Promise.reject("CSRF definition is incorrect");
+		}
+
+		var pTokenValuePromise = new Promise(function (resolve, reject) {
+			var oCsrfTokenDataProvider = this._oDataProviderFactory.create(oCsrfTokenConfig.data);
+			oCsrfTokenDataProvider.getData().then(function (oData) {
+				var sTokenValue,
+					oModel;
+
+				if (oCsrfTokenConfig.data.path) {
+					oModel = new JSONModel(oData);
+					sTokenValue = oModel.getProperty(oCsrfTokenConfig.data.path);
+					oModel.destroy();
+				} else {
+					sTokenValue = oCsrfTokenDataProvider.getLastJQXHR().getResponseHeader(TOKEN_DEFAULT_HEADER);
+				}
+
+				resolve(sTokenValue);
+			}).catch(function () {
+				reject("CSRF token cannot be resolved");
+			});
+		}.bind(this));
+
+		this._registerToken(oCsrfTokenConfig, pTokenValuePromise);
+
+		return pTokenValuePromise.then(function (sTokenValue) {
+			this._replaceCsrfPlaceholder(oCsrfTokenContext, sTokenValue);
+			return oDataConfig;
+		}.bind(this));
+	};
+
+	/**
+	 * Deletes a token based on a data configuration object which contains a CSRF placeholder in its headers property.
+	 *
+	 * @public
+	 * @param {object} oDataConfig Data configuration object
+	 */
+	CsrfTokenHandler.prototype.resetTokenByRequest = function (oDataConfig) {
+		var oCsrfTokenContext = this._findCsrfPlaceholder(oDataConfig);
+		if (!oCsrfTokenContext) {
+			return;
+		}
+
+		this._deleteRegisteredToken(this._getCsrfConfig(oCsrfTokenContext.tokenName));
+	};
+
+	/**
+	 * Returns the CSRF configuration object based on its name from the card configuration.
+	 *
+	 * @private
+	 * @param {string} sCsrfTokenName The name of the CSRF object.
+	 * @returns {object} The CSRF configuration object.
+	 */
+	CsrfTokenHandler.prototype._getCsrfConfig = function (sCsrfTokenName) {
+		return this._oConfiguration[sCsrfTokenName];
+	};
+
+	CsrfTokenHandler.prototype._replaceCsrfPlaceholder = function (oCsrfTokenContext, sTokenValue) {
+		var sPlaceholder = oCsrfTokenContext.object[oCsrfTokenContext.key];
+
+		oCsrfTokenContext.object[oCsrfTokenContext.key] = sPlaceholder.replace("{{csrfTokens." + oCsrfTokenContext.tokenName + "}}", sTokenValue);
+	};
+
+	CsrfTokenHandler.prototype._findCsrfPlaceholder = function (oConfig) {
+		var vValue,
+			sKey,
+			sTokenName;
+
+		for (sKey in oConfig) {
+			vValue = oConfig[sKey];
+
+			if (typeof vValue === "string") {
+				sTokenName = this._getCsrfTokenName(vValue);
+
+				if (sTokenName) {
+					return {
+						object: oConfig,
+						key: sKey,
+						tokenName: sTokenName
+					};
+				}
+			}
+
+			if (isPlainObject(vValue)) {
+				vValue = this._findCsrfPlaceholder(vValue);
+
+				if (vValue) {
+					return vValue;
+				}
+			}
+		}
+
+		return null;
+	};
+
+	/**
+	 * Returns the name from the CSRF placeholder.
+	 * For input of <code>{{csrfTokens.token1}}</code>, it will return <code>"token1"</code>
+	 *
+	 * @private
+	 * @param {string} sString the CSRF placeholder
+	 * @returns {string} The name of the placeholder or empty string
+	 */
+	CsrfTokenHandler.prototype._getCsrfTokenName = function (sString) {
+		var aMatches = sString.match(rPattern);
+		if (!aMatches) {
+			return "";
+		}
+
+		return aMatches[1];
+	};
+
+	CsrfTokenHandler.prototype._registerToken = function (mCSRFTokenConfig, pTokenValuePromise) {
+		CsrfTokenHandler._mTokens.set(mCSRFTokenConfig.data.request.url, pTokenValuePromise);
+
+		if (this._oHost) {
+			this._oHost.csrfTokenFetched(mCSRFTokenConfig, pTokenValuePromise);
+		}
+	};
+
+	CsrfTokenHandler.prototype._deleteRegisteredToken = function (mCSRFTokenConfig) {
+		CsrfTokenHandler._mTokens.delete(mCSRFTokenConfig.data.request.url);
+
+		if (this._oHost) {
+			this._oHost.csrfTokenExpired(mCSRFTokenConfig);
+		}
+	};
+
+	return CsrfTokenHandler;
+});

package/src/sap/ui/integration/util/DataProvider.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/base/ManagedObject"],
@@ -24,7 +24,7 @@ sap.ui.define(["sap/ui/base/ManagedObject"],
 	 * @extends sap.ui.base.ManagedObject
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private
@@ -100,6 +100,15 @@ sap.ui.define(["sap/ui/base/ManagedObject"],
 		this._oDestinations = oDestinations;
 	};
 
+	/**
+	 * Sets the CSRF token handler
+	 *
+	 * @param {sap.ui.integration.util.CsrfTokenHandler} oCsrfTokenHandler The CSRF token handler.
+	 */
+	DataProvider.prototype.setCsrfTokenHandler = function (oCsrfTokenHandler) {
+		this._oCsrfTokenHandler = oCsrfTokenHandler;
+	};
+
 	/**
 	 * Sets a list of <code>sap.ui.integration.util.DataProvider</code> which will be considered dependencies of the current one.
 	 * @param {sap.ui.integration.util.DataProvider[]} aDependencies The list of dependencies.

package/src/sap/ui/integration/util/DataProviderFactory.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([
@@ -11,10 +11,18 @@ sap.ui.define([
 	"sap/ui/integration/util/DataProvider",
 	"sap/ui/integration/util/ExtensionDataProvider",
 	"sap/ui/integration/util/JSONBindingHelper",
-	"sap/ui/integration/util/BindingHelper"
-],
-function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestDataProvider, DataProvider, ExtensionDataProvider, JSONBindingHelper, BindingHelper) {
-"use strict";
+	"sap/ui/integration/util/BindingHelper",
+	"sap/ui/integration/util/CsrfTokenHandler"
+], function (BaseObject,
+			 ServiceDataProvider,
+			 RequestDataProvider,
+			 CacheAndRequestDataProvider,
+			 DataProvider,
+			 ExtensionDataProvider,
+			 JSONBindingHelper,
+			 BindingHelper,
+			 CsrfTokenHandler) {
+	"use strict";
 
 	/**
 	 * @class
@@ -22,7 +30,7 @@ function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestD
 	 * When destroyed, all data providers created by this class are also destroyed.
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit
@@ -30,13 +38,24 @@ function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestD
 	 * @alias sap.ui.integration.util.DataProviderFactory
 	 */
 	var DataProviderFactory = BaseObject.extend("sap.ui.integration.util.DataProviderFactory", {
-		constructor: function (oDestinations, oExtension, oCard, oEditor, oHost) {
+		constructor: function (mSettings) {
 			BaseObject.call(this);
-			this._oDestinations = oDestinations;
-			this._oExtension = oExtension;
-			this._oCard = oCard;
-			this._oEditor = oEditor;
-			this._oHost = oHost;
+
+			mSettings = mSettings || {};
+
+			this._oDestinations = mSettings.destinations;
+			this._oExtension = mSettings.extension;
+			this._oCsrfTokenHandler = mSettings.csrfTokenHandler;
+			this._oCard = mSettings.card;
+			this._oEditor = mSettings.editor;
+			this._oHost = mSettings.host;
+
+			if (mSettings.csrfTokensConfig) {
+				this._oCsrfTokenHandler = new CsrfTokenHandler({
+					host: mSettings.host,
+					configuration: mSettings.csrfTokensConfig
+				});
+			}
 
 			this._aDataProviders = [];
 			this._aFiltersProviders = [];
@@ -61,6 +80,11 @@ function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestD
 			this._aFiltersProviders = null;
 		}
 
+		if (this._oCsrfTokenHandler) {
+			this._oCsrfTokenHandler.destroy();
+			this._oCsrfTokenHandler = null;
+		}
+
 		this._oCard = null;
 		this._oExtension = null;
 		this._bIsDestroyed = true;
@@ -139,6 +163,11 @@ function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestD
 
 		oDataProvider.setDestinations(this._oDestinations);
 
+		if (this._oCsrfTokenHandler) {
+			oDataProvider.setCsrfTokenHandler(this._oCsrfTokenHandler);
+			this._oCsrfTokenHandler.setDataProviderFactory(this);
+		}
+
 		if (oDataProvider.isA("sap.ui.integration.util.IServiceDataProvider")) {
 			oDataProvider.createServiceInstances(oServiceManager);
 		}
@@ -174,5 +203,13 @@ function (BaseObject, ServiceDataProvider, RequestDataProvider, CacheAndRequestD
 		}
 	};
 
+	DataProviderFactory.prototype.setHost = function (oHost) {
+		this._oHost = oHost;
+
+		if (this._oCsrfTokenHandler) {
+			this._oCsrfTokenHandler.setHost(oHost);
+		}
+	};
+
 	return DataProviderFactory;
 });

package/src/sap/ui/integration/util/Destinations.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.
  */
 
@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @param {sap.ui.integration.Host} oHost The Host which will be used for resolving destinations.

package/src/sap/ui/integration/util/ExtensionDataProvider.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/HeaderFactory.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([
 	"./BaseFactory",
-	"./CardActions",
+	"sap/ui/integration/cards/actions/CardActions",
 	"sap/ui/integration/library",
 	"sap/ui/integration/cards/NumericHeader",
 	"sap/ui/integration/cards/Header",
@@ -68,7 +68,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/integration/util/JSONBindingHelper.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([
@@ -27,7 +27,7 @@ sap.ui.define([
 	 * Helper class for working with bindings for json objects.
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit
@@ -70,7 +70,7 @@ sap.ui.define([
 			}
 
 			return vValue;
-		  }.bind(this));
+		}.bind(this));
 
 		sResult = this._escape(sResult);
 

package/src/sap/ui/integration/util/LoadingProvider.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([
@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private

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.2
+	 * @version 1.98.0
 	 *
 	 * @constructor
 	 * @private
@@ -602,4 +602,4 @@ sap.ui.define([
 	};
 
 	return Manifest;
-}, true);
+});