@openui5/sap.ui.integration 1.111.2 → 1.112.2

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

@@ -0,0 +1,440 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 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",
+	"sap/ui/core/library",
+	"sap/base/Log",
+	"sap/base/util/deepExtend",
+	"./Validators",
+	"./BindingResolver"
+], function (ManagedObject, coreLibrary, Log, deepExtend, Validators, BindingResolver) {
+	"use strict";
+
+	var ValueState = coreLibrary.ValueState;
+
+	/**
+	 * Utility class for handling forms in the cards.
+	 *
+	 * @author SAP SE
+	 * @version 1.112.2
+	 *
+	 * @private
+	 * @ui5-restricted
+	 * @alias sap.ui.integration.util.Form
+	 */
+	var Form = ManagedObject.extend("sap.ui.integration.util.Form", {
+		constructor: function (oCard) {
+			ManagedObject.apply(this);
+
+			this._oCard = oCard;
+		},
+
+		metadata: {
+			library: "sap.ui.integration"
+		}
+	});
+
+	Form.prototype.init = function () {
+		this._mControls = new Map();
+	};
+
+	Form.prototype.exit = function () {
+		this._mControls.clear();
+		delete this._mControls;
+		delete this._oCard;
+	};
+
+	/**
+	 * Adds the ObjectGroupItem to the form.
+	 * Changes based on the provided event fired by the ObjectGroupItem will be reflected in the model "form".
+	 * @param {string} sEventType event type
+	 * @param {sap.ui.core.Control} oControl control instance
+	 * @param {object} oItem ObjectGroupItem definition from the manifest
+	 * @param {string} sPath path to this ObjectGroupItem in the manifest
+	 * @public
+	 */
+	Form.prototype.addControl = function (sEventType, oControl, oItem, sPath) {
+		if (!this._isValidControlId(oItem.id)) {
+			return;
+		}
+
+		this._syncToFormModelOn(sEventType, oControl, oItem, sPath);
+	};
+
+	/**
+	 * Performs the defined validations on the form controls.
+	 * @param {boolean} bShowValueState Whether to show the value state on the form controls
+	 * @param {boolean} bSkipFiringStateChangedEvent Whether to skip firing stateChanged event
+	 */
+	Form.prototype.validate = function (bShowValueState, bSkipFiringStateChangedEvent) {
+		var bStateChanged = false;
+
+		this._mControls.forEach(function (oControl) {
+			if (this._validateControl(oControl, bShowValueState)) {
+				bStateChanged = true;
+			}
+		}.bind(this));
+
+		if (bStateChanged && !bSkipFiringStateChangedEvent) {
+			this._oCard._fireStateChanged();
+		}
+	};
+
+	/**
+	 * Resolves an ObjectGroupItem with the values from the form control it corresponds to
+	 * @param {object} oItem ObjectGroupItem definition
+	 * @returns {object} object containing the form control data
+	 * @public
+	 */
+	Form.prototype.resolveControl = function (oItem) {
+		var oResolved = {},
+			vValue,
+			aValidations = this.getModel("messages").getProperty("/records"),
+			oValueState = aValidations.find(function (oValidation) {
+				return oValidation.bindingPath === "/" + oItem.id;
+			}),
+			oControl = this._mControls.get(oItem.id);
+
+		if (oValueState && (oControl && oControl._bShowValueState)) { // should we return the very first validation, even when the control hasn't been touched yet? this is when the form control is not dirty
+			oResolved.valueState = { message: oValueState.message, type: oValueState.type };
+		}
+
+		if (oItem.type === "ComboBox") {
+			vValue = this.getModel("form").getProperty("/" + oItem.id);
+			oResolved.selectedKey = vValue.key;
+			vValue = vValue.value;
+		} else {
+			vValue = this.getModel("form").getProperty("/" + oItem.id);
+		}
+
+		oResolved.value = vValue;
+
+		return oResolved;
+	};
+
+	/**
+	 * Assigns a value to a form control.
+	 * @param {object} oFormControlData Object with key and respective value property to set.
+	 * The name of the value property is named based on the type of the ObjectGroupItem as defined in the manifest.
+	 * @public
+	 */
+	Form.prototype.setControlValue = function (oFormControlData) {
+		if (!this._isControlDataValid(oFormControlData)) {
+			return;
+		}
+
+		var sId = oFormControlData.id,
+			oControl = this._mControls.get(sId);
+
+		if (oControl.isA("sap.m.ComboBox")) {
+			this._setComboBoxValue(oControl, oFormControlData);
+		}
+
+		if ("value" in oFormControlData && oControl.isA(["sap.m.TextArea", "sap.m.Input"])) {
+			oControl.setValue(oFormControlData.value);
+		}
+
+		this._validateAndUpdate(oControl);
+	};
+
+	Form.prototype._setComboBoxValue = function (oComboBox, oControlData) {
+		var oSelectedItem;
+
+		if ("key" in oControlData) {
+			oComboBox.setSelectedKey(oControlData.key);
+		}
+
+		if ("value" in oControlData && !("key" in oControlData)) {
+			oSelectedItem = oComboBox.getItems().find(function (oItem) {
+				return oItem.getText() === oControlData.value;
+			});
+
+			if (oSelectedItem) {
+				oComboBox.setSelectedItem(oSelectedItem);
+			} else {
+				oComboBox.setSelectedKey(""); // now entering unknown value, reset selectedKey to keep it in sync
+				oComboBox.setValue(oControlData.value);
+			}
+		}
+	};
+
+	Form.prototype._isValidControlId = function (sId) {
+		if (!sId) {
+			Log.error("Each input control must have an ID.", "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		if (this._mControls.has(sId)) {
+			Log.error("Duplicate form control ID - '" + sId + "'" , "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		return true;
+	};
+
+	Form.prototype._syncToFormModelOn = function (sEventType, oControl, oItem, sPath) {
+		this._prepareValidationForControl(oControl, oItem, sPath);
+
+		oControl.attachEvent(sEventType, this._validateAndUpdate, this);
+		oControl.addEventDelegate({ onAfterRendering: this._updateModel }, this);
+
+		this._mControls.set(oItem.id, oControl);
+	};
+
+	Form.prototype._updateModel = function (oControlOrEvent) {
+		var oControl = oControlOrEvent.srcControl ? oControlOrEvent.srcControl : oControlOrEvent;
+
+		this.getModel("form").setProperty("/" + oControl._oItem.id, _getValue(oControl));
+	};
+
+	Form.prototype._validateAndUpdate = function (oControlOrEvent) {
+		var oControl = oControlOrEvent.getSource ? oControlOrEvent.getSource() : oControlOrEvent;
+
+		this._validateControl(oControl, true);
+		this._updateModel(oControl);
+
+		this._oCard._fireStateChanged();
+	};
+
+	Form.prototype._isControlDataValid = function (oData) {
+		if (!oData) {
+			return false;
+		}
+
+		var sId = oData.id;
+		if (!sId) {
+			Log.error("Form control data is missing property 'id'." , "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		var oControl = this._mControls.get(sId);
+		if (!oControl) {
+			Log.error("Form control with ID - '" + sId + "' does not exist." , "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		if (oControl.isA(["sap.m.TextArea", "sap.m.Input"]) && !("value" in oData)) {
+			Log.error("Form data for control ID - '" + sId + "' is missing property 'value'." , "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		if (oControl.isA("sap.m.ComboBox")) {
+			if ("value" in oData || "key" in oData) {
+				return true;
+			}
+
+			Log.error("Form data for control ID - '" + sId + "' requires properties 'key' or 'value'." , "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		return true;
+	};
+
+	Form.prototype._prepareValidationForControl = function (oControl, oItem, sPath) {
+		var oClonedItem = deepExtend({}, oItem);
+
+		// this is needed in order to skip binding for "pattern"
+		if (oClonedItem.validations) {
+			oClonedItem.validations.forEach(function (oValidation, iIndex) {
+				if (oValidation.pattern) {
+					oValidation.pattern = this._oCard.getManifestEntry(sPath + "/validations/" + iIndex)["pattern"];
+				}
+			}.bind(this));
+		}
+
+		oControl._oItem = oClonedItem;
+	};
+
+	/**
+	 * Validates control based on the defined validations from the manifest.
+	 * The control will receive a validation error message for the first defined validation that fails.
+	 *
+	 * @param {sap.ui.core.Control} oControl control instance to validate
+	 * @param {boolean} bShowValueState whether to display the new value state on the control
+	 * @returns {boolean} true if the control is invalid
+	 */
+	Form.prototype._validateControl = function (oControl, bShowValueState) {
+		var oExtension = this._oCard.getAggregation("_extension"),
+			oItem = oControl._oItem,
+			oBindingContext = oControl.getBindingContext(),
+			sBindingPath = oBindingContext ? oBindingContext.getPath() : "",
+			bHasErrorSet = false,
+			aResolvedValidations;
+
+		this._removeMessageFromControl(oControl);
+
+		if (!oItem || !oItem.validations) {
+			return bHasErrorSet;
+		}
+
+		aResolvedValidations = BindingResolver.resolveValue(oItem.validations, oControl, sBindingPath);
+
+		bHasErrorSet = !aResolvedValidations.every(function (mValidationConfig) {
+			return this._checkValidationItem(mValidationConfig, oControl, oItem, bShowValueState, oExtension);
+		}.bind(this));
+
+		this._updateMessageModel();
+
+		return bHasErrorSet;
+	};
+
+	Form.prototype._checkValidationItem = function (mValidationConfig, oControl, oItem, bShowValueState, oExtension) {
+		var oValidator = Validators[this._getFormControlType(oItem)],
+			oValidationValue,
+			bValid,
+			sValidationFunctionName,
+			fnValidationFunc,
+			oRB = this.getModel("i18n").getResourceBundle(),
+			bValidationPassed = true;
+
+		for (var sKey in mValidationConfig) {
+			oValidationValue = mValidationConfig[sKey];
+
+			if (sKey === "validate") {
+				sValidationFunctionName = this._getExtensionFunctionName(oValidationValue, oExtension);
+
+				if (sValidationFunctionName) {
+					fnValidationFunc = oExtension[sValidationFunctionName];
+				}
+			} else {
+				fnValidationFunc = oValidator[sKey];
+			}
+
+			if (typeof fnValidationFunc !== "function") {
+				continue;
+			}
+
+			bValid = fnValidationFunc(_getValue(oControl), oValidationValue);
+			if (!bValid) {
+				this._addMessageToControl(oControl, bShowValueState, {
+					type: mValidationConfig.type || ValueState.Error,
+					message: mValidationConfig.message || oRB.getText(oValidator[sKey + "Txt"], oValidationValue),
+					bindingPath: "/" + oItem.id
+				});
+
+				bValidationPassed = false;
+				break;
+			}
+		}
+
+		return bValidationPassed;
+	};
+
+	Form.prototype._addMessageToControl = function (oControl, bShowValueState, oMessage) {
+		var oMessagesModel = this.getModel("messages"),
+			oModelData = oMessagesModel.getData();
+
+		oModelData.records.push(oMessage);
+
+		oMessagesModel.setData(oModelData);
+
+		if (bShowValueState || oControl._bShowValueState) {
+			oControl._bShowValueState = true; // control has been touched once. mark it "dirty"
+			oControl.setValueState(oMessage.type);
+			oControl.setValueStateText(oMessage.message);
+		}
+
+		this._updateMessageModel();
+	};
+
+	Form.prototype._removeMessageFromControl = function (oControl) {
+		var oMessagesModel = this.getModel("messages"),
+			sBindingPath = "/" + oControl._oItem.id,
+			oMessagesModelData = oMessagesModel.getData(),
+			bHasChange = false;
+
+		oControl.setValueState(ValueState.None);
+
+		for (var i = 0; i < oMessagesModelData.records.length; i++) {
+			if (oMessagesModelData.records[i].bindingPath === sBindingPath) {
+				oMessagesModelData.records.splice(i, 1);
+				bHasChange = true;
+				break;
+			}
+		}
+
+		if (bHasChange) {
+			oMessagesModel.setData(oMessagesModelData);
+		}
+
+		this._updateMessageModel();
+	};
+
+	Form.prototype._updateMessageModel = function () {
+		var oMessagesModel = this.getModel("messages"),
+			aRecords = oMessagesModel.getProperty("/records");
+
+		oMessagesModel.setProperty("/hasErrors", aRecords.some(function (oRecord) {
+			return oRecord.type === ValueState.Error;
+		}));
+
+		oMessagesModel.setProperty("/hasWarnings", aRecords.some(function (oRecord) {
+			return oRecord.type === ValueState.Warning;
+		}));
+	};
+
+	Form.prototype.getRequiredValidationValue = function (oItem) {
+		var aValidations = oItem.validations || [],
+			oValidation,
+			i,
+			sKey;
+
+		for (i = 0; i < aValidations.length; i++) {
+			oValidation = aValidations[i];
+
+			for (sKey in oValidation) {
+				if (sKey === "required") {
+					return oValidation[sKey];
+				}
+			}
+		}
+
+		return false;
+	};
+
+	Form.prototype._getExtensionFunctionName = function (sValue, oExtension) {
+		if (!sValue.startsWith("extension.")) {
+			Log.error("Validation function should start with 'extension'.");
+			return false;
+		}
+
+		if (!oExtension) {
+			Log.error("Extension is not defined.");
+			return false;
+		}
+
+		var sValidationFunctionName = sValue.replace("extension.", "");
+
+		if (!oExtension[sValidationFunctionName]) {
+			Log.error("No such function.", sValidationFunctionName, "sap.ui.integration.widgets.Card");
+			return false;
+		}
+
+		return sValidationFunctionName;
+	};
+
+	Form.prototype._getFormControlType = function (oItem) {
+		switch (oItem.type) {
+			case "ComboBox":
+				return "keyValuePair";
+			default:
+				return "string";
+		}
+	};
+
+	function _getValue(oControl) {
+		if (oControl.isA("sap.m.ComboBox")) {
+			return {
+				key: oControl.getSelectedKey(),
+				value: oControl.getValue()
+			};
+		} else {
+			return oControl.getValue();
+		}
+	}
+
+	return Form;
+});

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

@@ -44,7 +44,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.BaseFactory
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @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.111.2
+	 * @version 1.112.2
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.integration, shell-toolkit

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

@@ -45,7 +45,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Element
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @constructor
 	 * @private

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

@@ -64,7 +64,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @constructor
 	 * @private

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

@@ -9,14 +9,16 @@ sap.ui.define([
 	"sap/ui/integration/util/BindingResolver",
 	"sap/ui/integration/util/Utils",
 	"sap/m/IllustratedMessageType",
-	"sap/m/IllustratedMessageSize"
+	"sap/m/IllustratedMessageSize",
+	"sap/base/Log"
 ], function (
 	Core,
 	BindingHelper,
 	BindingResolver,
 	Utils,
 	IllustratedMessageType,
-	IllustratedMessageSize
+	IllustratedMessageSize,
+	Log
 ) {
 	"use strict";
 
@@ -89,6 +91,9 @@ sap.ui.define([
 		}
 
 		try {
+			// Prepare binding infos only once for all sections
+			oManifest = BindingHelper.createBindingInfos(oManifest, oCard.getBindingNamespaces());
+
 			if (oCard.getAggregation("_filterBar")) {
 				aFilters =  oCard.getAggregation("_filterBar")._getFilters().map(function (oFilter) {
 					return ["/sap.card/configuration/filters/" + oFilter.getKey(), oFilter];
@@ -124,8 +129,8 @@ sap.ui.define([
 					delete oSubConfig.data;
 				}
 
-				oSubConfig = BindingHelper.createBindingInfos(oSubConfig, oCard.getBindingNamespaces());
-				oSubConfig = BindingResolver.resolveValue(oSubConfig, oContext, sDataPath);
+				// Resolve only binding infos which are left unresolved, we must not resolve sections twice.
+				oSubConfig = BindingResolver.resolveValue(oSubConfig, oContext, sDataPath, true);
 				Utils.setNestedPropertyValue(oManifest, sManifestPath, oSubConfig);
 			});
 
@@ -146,6 +151,8 @@ sap.ui.define([
 		var oManifest = oCard.getManifestEntry("/"),
 			oResourceBundle = Core.getLibraryResourceBundle("sap.ui.integration");
 
+		Log.error(oError, "sap.ui.integration.util.ManifestResolver");
+
 		if (oManifest === null) {
 			oManifest = {};
 		}

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

@@ -5,58 +5,89 @@
  */
 
 sap.ui.define([
-	"sap/ui/performance/Measurement"
-], function (CoreMeasurement) {
+	"sap/ui/core/Configuration"
+], function (Configuration) {
 	"use strict";
 
-	var bNowAPIExists = performance && performance.now;
 	var bMarkAPIExists = performance && performance.mark;
+	var bMeasureAPIExists = performance && performance.measure;
 
-	function measurementStartTime() {
-		if (bNowAPIExists) {
-			return " Start since page load: " + performance.now();
-		}
-
-		return "";
-	}
-
-	var mMeasurements = new Map();
-
+	/**
+	 * Contains static methods for work with performance markers.
+	 * @private
+	 * @ui5-restricted sap.ui.integration
+	 * @class
+	 */
 	var Measurement = {
+		/**
+		 * Adds a start marker with performance.mark().
+		 * @param {string} sId The id of the marker. Suffix "-start" will be added at the end.
+		 * @param {string} sDetail Details for the marker.
+		 * @returns {PerformanceMark} The start marker.
+		 */
 		start: function (sId, sDetail) {
-			if (!CoreMeasurement.getActive()) {
-				return;
+			if (!this.getActive()) {
+				return null;
 			}
 
-			mMeasurements.set(sId, {
+			return performance.mark(sId + "-start", {
 				detail: sDetail
 			});
-
-			if (bMarkAPIExists){
-				performance.mark(sId + "-start");
-			}
-
-			CoreMeasurement.start(sId, sDetail + measurementStartTime());
 		},
+		/**
+		 * Adds an end marker with performance.mark().
+		 * Also adds a measurement between the end and the start marker with performance.measure().
+		 * @param {string} sId The base id of the marker. Suffix "-end" will be added at the end.
+		 * @returns {PerformanceMark} The end marker.
+		 */
 		end: function (sId) {
-			if (!CoreMeasurement.getActive()) {
-				return;
+			if (!this.getActive()) {
+				return null;
 			}
 
-			var oMeasurement = mMeasurements.get(sId);
+			var oStartMark = performance.getEntriesByName(sId + "-start")[0],
+				oEndMark,
+				sDetail = "";
 
-			if (bMarkAPIExists) {
-				performance.mark(sId + "-end", {
-					start: sId,
-					detail: oMeasurement.detail
-				});
+			if (oStartMark) {
+				sDetail = oStartMark.detail;
 			}
 
-			CoreMeasurement.end(sId);
-			oMeasurement.ended = true;
+			oEndMark = performance.mark(sId + "-end", {
+				start: sId,
+				detail: sDetail
+			});
+
+			performance.measure(sId, {
+				start: sId + "-start",
+				end: sId + "-end",
+				detail: sDetail
+			});
+
+			return oEndMark;
 		},
+		/**
+		 * Checks if an end marker was already added.
+		 * @param {string} sId The base id of the marker.
+		 * @returns {boolean} True if the end marker is there. False otherwise.
+		 */
 		hasEnded: function (sId) {
-			return CoreMeasurement.getActive() && mMeasurements.get(sId).ended;
+			if (!this.getActive()) {
+				return false;
+			}
+
+			var oEndMark = performance.getEntriesByName(sId + "-end")[0];
+
+			return !!oEndMark;
+		},
+		/**
+		 * Should the performance measurement be activated.
+		 * @returns {boolean} True if it should be active. False otherwise.
+		 */
+		getActive: function () {
+			var bActive = Configuration.getMeasureCards(); // @todo
+
+			return bActive && bMarkAPIExists && bMeasureAPIExists;
 		}
 	};
 

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

@@ -33,7 +33,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.util.DataProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @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.111.2
+	 * @version 1.112.2
 	 *
 	 * @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.111.2
+	 * @version 1.112.2
 	 *
 	 * @constructor
 	 * @param {Object} mServiceFactoryReferences A map with service descriptions.

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

@@ -19,7 +19,7 @@ sap.ui.define([
 	 * @extends sap.ui.integration.widgets.Card
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @constructor
 	 * @private

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

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * Utility class helping with JSON strings and formatters.
 	 *
 	 * @author SAP SE
-	 * @version 1.111.2
+	 * @version 1.112.2
 	 *
 	 * @private
 	 * @alias sap.ui.integration.util.Utils