@sapui5/sap.fe.core 1.97.0 → 1.100.0

package/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;