@sap/open.fe 1.98.0 → 1.99.0

package/packages/sap.fe.core/src/sap/fe/core/helpers/PasteHelper.js

@@ -1,6 +1,5 @@
 /*!
  * SAP UI development toolkit for HTML5 (SAPUI5)
-        (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
  */
-sap.ui.define(["sap/ui/core/util/PasteHelper","sap/m/MessageBox"],function(C,M){"use strict";var _=function(P,r,m,o){var b=m.getProperty(P),f={parseKeepsEmptyString:true},t=o.getUI5Type(r+"/"+P,f),i=!b||m.getProperty(P+"@Org.OData.Core.V1.Computed");return{property:P,ignore:i,type:t};};var a=function(t){var m=t.getRowBinding().getModel(),o=m.getMetaModel(),r=m.resolve(t.getRowBinding().getPath(),t.getRowBinding().getContext()),b=o.getMetaContext(r);return t.getControlDelegate().fetchProperties(t).then(function(P){var c=[];t.getColumns().forEach(function(d){var i=P.find(function(e){return e.name===d.getDataProperty();});if(i.propertyInfos){i.propertyInfos.forEach(function(e){var D=P.find(function(f){return f.name===e;});if((D&&D.path.indexOf("@com.sap.vocabularies.UI.v1.DataPoint")>-1)||e.indexOf("/")>-1){c.push({property:D.path,ignore:true});}else{c.push(_(D.path,r,b,o));}});}else if(i.path){c.push(_(i.path,r,b,o));}else{c.push({property:"unused",type:null,ignore:true});}});return c;});};var p={parseDataForTablePaste:function(r,t){return a(t).then(function(P){var i=r.length?r[0].length:0;var f=-1;for(var I=0;I<P.length&&f<0;I++){if(!P[I].ignore){f=I;}}if(f<0||f>i-1){return Promise.resolve([]);}else{return C.parse(r,P).then(function(o){if(o.errors){var e=o.errors.map(function(b){return b.message;});var R=sap.ui.getCore().getLibraryResourceBundle("sap.fe.core"),s,E=R.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_MESSAGE"),n=R.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_NOTE");if(e.length>1){s=R.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_PLURAL",[e.length]);}else{s=R.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_SINGULAR");}e.unshift("");e.unshift(n);e.unshift(E);M.error(s,{icon:M.Icon.ERROR,title:R.getText("C_COMMON_SAPFE_ERROR_MESSAGES_PAGE_TITLE_ERROR"),details:e.join("<br>")});return[];}else{return o.parsedData?o.parsedData:[];}});}});}};return p;});
+sap.ui.define(["sap/ui/core/util/PasteHelper","sap/m/MessageBox","sap/base/Log"],function(C,M,L){"use strict";function _(o,k,v){if(k in o){Object.defineProperty(o,k,{value:v,enumerable:true,configurable:true,writable:true});}else{o[k]=v;}return o;}function a(i){return e(i)||d(i)||c(i)||b();}function b(){throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");}function c(o,m){if(!o)return;if(typeof o==="string")return f(o,m);var n=Object.prototype.toString.call(o).slice(8,-1);if(n==="Object"&&o.constructor)n=o.constructor.name;if(n==="Map"||n==="Set")return Array.from(o);if(n==="Arguments"||/^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n))return f(o,m);}function d(i){if(typeof Symbol!=="undefined"&&i[Symbol.iterator]!=null||i["@@iterator"]!=null)return Array.from(i);}function e(i){if(Array.isArray(i))return f(i);}function f(j,l){if(l==null||l>j.length)l=j.length;for(var i=0,k=new Array(l);i<l;i++){k[i]=j[i];}return k;}var g=function(p,r,m,i){var j=m.getProperty(p),k={parseKeepsEmptyString:true},t=i.getUI5Type("".concat(r,"/").concat(p),k),l=!j||m.getProperty(p+"@Org.OData.Core.V1.Computed");return{property:p,ignore:l,type:t};};var h=function(i){var m=a(i);var r=sap.ui.getCore().getLibraryResourceBundle("sap.fe.core"),j=r.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_MESSAGE"),n=r.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_NOTE");var p;if(m.length>1){p=r.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_PLURAL",[m.length]);}else{p=r.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_SINGULAR");}m.unshift("");m.unshift(n);m.unshift(j);M.error(p,{title:r.getText("C_COMMON_SAPFE_ERROR_MESSAGES_PAGE_TITLE_ERROR"),details:m.join("<br>")});};var P={displayErrorMessages:h,formatCustomMessage:function(v,r){var i="";var n=v.length;var j=sap.ui.getCore().getLibraryResourceBundle("sap.fe.core"),k=j.getText("T_MESSAGE_GROUP_DESCRIPTION_TABLE_ROW");if(n>0){i+="".concat(k," ").concat(r,": ");v.forEach(function(m,l){if(m.messageText){i+=m.messageText+(l+1!==n?" ":"");}});}return i;},getColumnInfo:function(t){var i=this;var m=t.getRowBinding().getModel(),j=m.getMetaModel(),r=m.resolve(t.getRowBinding().getPath(),t.getRowBinding().getContext()),k=j.getMetaContext(r);return t.getControlDelegate().fetchProperties(t).then(function(p){var l=Object.assign.apply(Object,[{}].concat(a(p.map(function(o){return _({},o.name,o);}))));var n=[];t.getColumns().forEach(function(o){var q=l[o.getDataProperty()];if(q.propertyInfos){q.propertyInfos.forEach(function(s){var u=l[s];if(u&&u.path.indexOf("@com.sap.vocabularies.UI.v1.DataPoint")>-1||s.indexOf("/")>-1){n.push({property:u.path,ignore:true});}else{n.push(i.getInfoForEntityProperty(u.path,r,k,j));}});}else if(q.path){n.push(i.getInfoForEntityProperty(q.path,r,k,j));}else{n.push({property:"unused",type:null,ignore:true});}});return n;});},getInfoForEntityProperty:g,parsePastedData:function(r,t){var i=this;return this.getColumnInfo(t).then(function(p){var j=r.length?r[0].length:0;var k=-1;for(var I=0;I<p.length&&k<0;I++){if(!p[I].ignore){k=I;}}return k<0||k>j-1?Promise.resolve({}):C.parse(r,p);}).then(function(p){if(p.errors){var j=p.errors.map(function(E){return E.message;});i.displayErrorMessages(j);return[];}else{return p.parsedData?p.parsedData:[];}});},pasteData:function(r,t,i){var j=this;var I=i._editFlow;var k=t.getParent().getTableDefinition();var D=[];return this.parsePastedData(r,t).then(function(p){D=p||[];return Promise.all(D.map(function(m){var l;return I.getTransactionHelper().validateDocument(t.getBindingContext(),{data:m,customValidationFunction:k===null||k===void 0?void 0:(l=k.control)===null||l===void 0?void 0:l.customValidationFunction},i.getView());}));}).then(function(v){var E=v.reduce(function(m,l,n){if(l.length>0){m.push({messages:l,row:n+1});}return m;},[]);if(E.length>0){var R=E.map(function(m){return j.formatCustomMessage(m.messages,m.row);});j.displayErrorMessages(R);return[];}return D;}).then(function(v){var l;return v.length>0?I.createMultipleDocuments(t.getRowBinding(),v,k===null||k===void 0?void 0:(l=k.control)===null||l===void 0?void 0:l.createAtEnd,true,i.editFlow.onBeforeCreate):undefined;}).catch(function(E){L.error("Error while pasting data",E);});}};return P;},false);

package/packages/sap.fe.core/src/sap/fe/core/helpers/PasteHelper.ts

@@ -0,0 +1,196 @@
+import * as CorePasteHelper from "sap/ui/core/util/PasteHelper";
+import MessageBox from "sap/m/MessageBox";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import Log from "sap/base/Log";
+import PageController from "sap/fe/core/PageController";
+
+export type customValidationMessage = {
+	messageText?: string;
+	messageTarget?: string;
+};
+
+const getInfoForEntityProperty = function(propertyPath: any, rowBindingPath: any, metaContext: any, metaModel: any): any {
+	const property = metaContext.getProperty(propertyPath),
+		formatOptions = { parseKeepsEmptyString: true },
+		type = metaModel.getUI5Type(`${rowBindingPath}/${propertyPath}`, formatOptions),
+		isIgnored = !property || metaContext.getProperty(propertyPath + "@Org.OData.Core.V1.Computed");
+	return {
+		property: propertyPath,
+		ignore: isIgnored,
+		type: type
+	};
+};
+
+const displayErrorMessages = function(errorMessages: string[]): void {
+	const messageDetails = [...errorMessages];
+	const resourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle,
+		errorCorrectionMessage = resourceBundle.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_MESSAGE"),
+		noteMessage = resourceBundle.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_CORRECTION_NOTE");
+	let pasteErrorMessage;
+
+	if (messageDetails.length > 1) {
+		pasteErrorMessage = resourceBundle.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_PLURAL", [messageDetails.length]);
+	} else {
+		pasteErrorMessage = resourceBundle.getText("C_PASTE_HELPER_SAPFE_PASTE_ERROR_MESSAGE_SINGULAR");
+	}
+	messageDetails.unshift(""); // To show space between the short text and the list of errors
+	messageDetails.unshift(noteMessage);
+	messageDetails.unshift(errorCorrectionMessage);
+	MessageBox.error(pasteErrorMessage, {
+		title: resourceBundle.getText("C_COMMON_SAPFE_ERROR_MESSAGES_PAGE_TITLE_ERROR"),
+		details: messageDetails.join("<br>")
+	});
+};
+
+const PasteHelper = {
+	displayErrorMessages: displayErrorMessages,
+	formatCustomMessage: function(validationMessages: customValidationMessage[], iRowNumber: number): string {
+		let errorMessage = "";
+		const numberMessages = validationMessages.length;
+		const resourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle,
+			i18nRow = resourceBundle.getText("T_MESSAGE_GROUP_DESCRIPTION_TABLE_ROW");
+		if (numberMessages > 0) {
+			errorMessage += `${i18nRow} ${iRowNumber}: `;
+			validationMessages.forEach((message, indexMessage) => {
+				if (message.messageText) {
+					errorMessage += message.messageText + (indexMessage + 1 !== numberMessages ? " " : "");
+				}
+			});
+		}
+		return errorMessage;
+	},
+	getColumnInfo: function(table: any): Promise<any[]> {
+		const model = table.getRowBinding().getModel(),
+			metaModel = model.getMetaModel(),
+			rowBindingPath = model.resolve(table.getRowBinding().getPath(), table.getRowBinding().getContext()),
+			metaContext = metaModel.getMetaContext(rowBindingPath);
+		return table
+			.getControlDelegate()
+			.fetchProperties(table)
+			.then((propertyInfo: any) => {
+				const PropertyInfoDict = Object.assign({}, ...propertyInfo.map((property: any) => ({ [property.name]: property })));
+				const columnInfos: any[] = [];
+				table.getColumns().forEach((column: any) => {
+					const infoProperty = PropertyInfoDict[column.getDataProperty()];
+					// Check if it's a complex property (property associated to multiple simple properties)
+					if (infoProperty.propertyInfos) {
+						// Get data from simple property
+						infoProperty.propertyInfos.forEach((property: any) => {
+							const dataProperty = PropertyInfoDict[property];
+
+							// Check if there is a simple property associated to a Rating or Progress ComplexProperty --> ignore
+							// Or check a navigation property within the current Complex property --> ignore
+							// A fake property was created into the propertyInfos to include the Target Value
+							// from the DataPoint (path includes the @com.sap.vocabularies.UI.v1.DataPoint annotation)
+							if (
+								(dataProperty && dataProperty.path.indexOf("@com.sap.vocabularies.UI.v1.DataPoint") > -1) ||
+								property.indexOf("/") > -1
+							) {
+								columnInfos.push({
+									property: dataProperty.path,
+									ignore: true
+								});
+							} else {
+								columnInfos.push(this.getInfoForEntityProperty(dataProperty.path, rowBindingPath, metaContext, metaModel));
+							}
+						});
+					} else if (infoProperty.path) {
+						columnInfos.push(this.getInfoForEntityProperty(infoProperty.path, rowBindingPath, metaContext, metaModel));
+					} else {
+						// Empty column --> ignore
+						columnInfos.push({
+							property: "unused",
+							type: null,
+							ignore: true
+						});
+					}
+				});
+				return columnInfos;
+			});
+	},
+	getInfoForEntityProperty: getInfoForEntityProperty,
+	/**
+	 *
+	 * @param rawData
+	 * @param table
+	 * @returns {Promise<any>}
+	 */
+	parsePastedData: function(rawData: any, table: any): Promise<any[]> {
+		return this.getColumnInfo(table)
+			.then(function(pasteInfos: any[]) {
+				// Check if we have data for at least the first editable column
+				const pastedColumnCount = rawData.length ? rawData[0].length : 0;
+				let firstEditableColumnIndex = -1;
+				for (let I = 0; I < pasteInfos.length && firstEditableColumnIndex < 0; I++) {
+					if (!pasteInfos[I].ignore) {
+						firstEditableColumnIndex = I;
+					}
+				}
+				return firstEditableColumnIndex < 0 || firstEditableColumnIndex > pastedColumnCount - 1
+					? Promise.resolve({}) // We don't have data for an editable column --> return empty parsed data
+					: (CorePasteHelper as any).parse(rawData, pasteInfos);
+			})
+			.then((parseResult: any) => {
+				if (parseResult.errors) {
+					const errorMessages = parseResult.errors.map(function(oElement: any) {
+						return oElement.message;
+					});
+					this.displayErrorMessages(errorMessages);
+					return []; // Errors --> return nothing
+				} else {
+					return parseResult.parsedData ? parseResult.parsedData : [];
+				}
+			});
+	},
+	pasteData: function(rawData: any, table: any, controller: PageController): Promise<any> {
+		const oInternalEditFlow = (controller as any)._editFlow;
+		const tableDefinition = table.getParent().getTableDefinition();
+		let aData: any[] = [];
+		return this.parsePastedData(rawData, table)
+			.then(aParsedData => {
+				aData = aParsedData || [];
+				return Promise.all(
+					aData.map(mData =>
+						oInternalEditFlow.getTransactionHelper().validateDocument(
+							table.getBindingContext(),
+							{
+								data: mData,
+								customValidationFunction: tableDefinition?.control?.customValidationFunction
+							},
+							controller.getView()
+						)
+					)
+				);
+			})
+			.then(aValidationMessages => {
+				const aErrorMessages = aValidationMessages.reduce(function(aMessages, aCustomMessages, index) {
+					if (aCustomMessages.length > 0) {
+						aMessages.push({ messages: aCustomMessages, row: index + 1 });
+					}
+					return aMessages;
+				}, []);
+				if (aErrorMessages.length > 0) {
+					const aRowMessages = aErrorMessages.map((mError: any) => this.formatCustomMessage(mError.messages, mError.row));
+					this.displayErrorMessages(aRowMessages);
+					return [];
+				}
+				return aData;
+			})
+			.then(aValidatedData => {
+				return aValidatedData.length > 0
+					? oInternalEditFlow.createMultipleDocuments(
+							table.getRowBinding(),
+							aValidatedData,
+							tableDefinition?.control?.createAtEnd,
+							true,
+							(controller as any).editFlow.onBeforeCreate
+					  )
+					: undefined;
+			})
+			.catch(oError => {
+				Log.error("Error while pasting data", oError);
+			});
+	}
+};
+
+export default PasteHelper;