@sapui5/sap.ui.export 1.124.0 → 1.124.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.124.0",
+	"version": "1.124.2",
 	"description": "SAPUI5 Library sap.ui.export",
 	"homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
 	"author": "SAP SE (https://www.sap.com)",

package/src/sap/ui/export/.library

@@ -5,7 +5,7 @@
 	<vendor>SAP SE</vendor>
 	<copyright>SAPUI5
  * (c) Copyright 2009-2024 SAP SE. All rights reserved.</copyright>
-	<version>1.124.0</version>
+	<version>1.124.2</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 

package/src/sap/ui/export/ExportBase.js

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @class The <code>sap.ui.export.ExportBase</code> class allows you to export table data from a UI5 application to certain formats. This class is an abstract class that requires specific implementations for each file format.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.ExportBase
@@ -197,8 +197,9 @@ sap.ui.define([
 	 * @returns {Promise} Promise that gets resolved once the data has been exported
 	 *
 	 * @public
+	 * @async
 	 */
-	 ExportBase.prototype.build = function() {
+	 ExportBase.prototype.build = async function() {
 		var mParameters = this._mSettings;
 
 		if (this.bIsDestroyed) {
@@ -208,17 +209,15 @@ sap.ui.define([
 			return Promise.reject(sMessage);
 		}
 
-		return this.setDefaultExportSettings(mParameters).then(function() {
-			const bExecuteDefaultAction = this.fireEvent('beforeExport', {exportSettings: mParameters}, true, false);
+		await this.setDefaultExportSettings(mParameters);
+		const bExecuteDefaultAction = this.fireEvent('beforeExport', {exportSettings: mParameters}, true, false);
 
-			if (!bExecuteDefaultAction) {
-				return Promise.resolve();
-			}
-
-			ExportUtils.validateSettings(mParameters);
+		if (!bExecuteDefaultAction) {
+			return Promise.resolve();
+		}
 
-			return this.createBuildPromise(mParameters);
-		}.bind(this));
+		ExportUtils.validateSettings(mParameters);
+		return this.createBuildPromise(mParameters);
 	};
 
     return ExportBase;

package/src/sap/ui/export/ExportHandler.js

@@ -18,7 +18,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', './util/PDFCapabi
 	 * @class The <code>sap.ui.export.ExportHandler</code> class allows you to export table data from an SAPUI5 application.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @since 1.102
 	 * @alias sap.ui.export.ExportHandler

package/src/sap/ui/export/ExportUtils.js

@@ -147,7 +147,7 @@ sap.ui.define([
 	 * @class Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @since 1.59
 	 * @alias sap.ui.export.ExportUtils
@@ -1228,7 +1228,7 @@ sap.ui.define([
 		 *
 		 * @param {object} oContext Context object
 		 * @param {string} [oContext.application] Name of the application (default: "SAP UI5")
-		 * @param {string} [oContext.version] Application version (default: "1.124.0")
+		 * @param {string} [oContext.version] Application version (default: "1.124.2")
 		 * @param {string} [oContext.title] Title that will be written to the file (NOT the filename)
 		 * @param {string} [oContext.modifiedBy] Optional user context that will be written to the file
 		 * @param {string} [oContext.sheetName] Name of the data sheet - Maximum length of 31 characters

package/src/sap/ui/export/PortableDocument.js

@@ -4,16 +4,16 @@
  */
 
 sap.ui.define([
+	'./ExportDialog',
+	'./ExportBase',
+	'./ExportUtils',
+	'./library',
+	'./util/PDFCapabilities',
 	'sap/base/Log',
 	'sap/ui/base/Object',
-	'sap/ui/export/ExportBase',
-	'sap/ui/export/ExportUtils',
-	'sap/ui/export/library',
-	'sap/ui/export/util/PDFCapabilities',
 	'sap/ui/model/odata/v4/ODataModel',
-	'./ExportDialog',
 	'sap/m/BusyDialog'
-], function(Log, BaseObject, ExportBase, ExportUtils, Library, PDFCapabilities, ODataModel, ExportDialog, BusyDialog) {
+], function(ExportDialog, ExportBase, ExportUtils, Library, PDFCapabilities, Log, BaseObject, ODataModel, BusyDialog) {
 	'use strict';
 
 	const FileType = Library.FileType;
@@ -24,7 +24,7 @@ sap.ui.define([
 	 * @class The <code>sap.ui.export.PortableDocument</code> class allows you to export table data from a UI5 application to a Portable Document Format (*.PDF) file.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument
@@ -203,11 +203,15 @@ sap.ui.define([
 			if (oMetaInfo instanceof Array) {
 				oMetaInfo.forEach(function(oGroup) {
 					if (iODataVersion === 2) {
+						const truncateString = (sValue) => {
+							return sValue.length > 256 ? sValue.substring(0, 253) + '...' : sValue;
+						};
+
 						oGroup.items.forEach(function(oItem) {
 							const oCoverPageGroup = {
 								"Title": oGroup.name,
 								"Name": oItem.key,
-								"Value": oItem.value
+								"Value": truncateString(oItem.value)
 							};
 							oDocumentDescription["CoverPage"].push(oCoverPageGroup);
 						});
@@ -374,6 +378,33 @@ sap.ui.define([
 		return oWarningPromise;
 	};
 
+	/**
+	 * Evaluates the error message from the given error parameter and shows it in a dialog.
+	 *
+	 * @param {string|object|Blob} vError Error object that is provided
+	 * @returns {Promise} Shows the error message in a dialog and resolves automatically
+	 */
+	PortableDocument.showErrorMessage = async (vError) => {
+		const oResourceBundle = await ExportUtils.getResourceBundle();
+
+		/* Handle ignore Promise rejection due to cancellation by the user */
+		if (!vError) {
+			return;
+		}
+
+		if (typeof vError.text === 'function') {
+			vError.text()
+			.then(function(sError) {
+				ExportDialog.showErrorMessage(sError);
+			})
+			.catch(function() {
+				ExportDialog.showErrorMessage(oResourceBundle.getText('PDF_GENERIC_ERROR'));
+			});
+		} else if (vError.message) {
+			ExportDialog.showErrorMessage(vError.message);
+		}
+	};
+
 	/**
 	 * Adds the ResultSizeMaximum from the com.sap.vocabularies.PDF.v1.Features
 	 * annotation as $top to the data URL. If this property is not available on
@@ -489,16 +520,16 @@ sap.ui.define([
 	 * @private
 	 */
 	PortableDocument.prototype.createBuildPromise = async function(mSettings) {
-		const that = this;
 		const oResourceBundle = await ExportUtils.getResourceBundle();
+		const oDocumentDescription = this._createDocumentDescription(mSettings);
 
 		let oBusyDialog = new BusyDialog('PDFExportBusyDialog', {
 			title: oResourceBundle.getText('PROGRESS_TITLE'),
 			text: oResourceBundle.getText('PDF_GENERATION_IN_PROGRESS'),
 			showCancelButton: true,
-			close: function(oEvent) {
+			close: (oEvent) => {
 				if (oEvent.getParameter('cancelPressed')) {
-					that.cancel();
+					this.cancel();
 				}
 
 				oBusyDialog.destroy();
@@ -506,32 +537,20 @@ sap.ui.define([
 			}
 		});
 
-		const oDocumentDescription = that._createDocumentDescription(mSettings);
 		oBusyDialog.open();
 
-		return this._showWarning(mSettings).then(function() {
-			return that.postDocumentDescription(oDocumentDescription, mSettings.dataSource);
-		}).then(function(sDocumentDescriptionId) {
-			return oBusyDialog && that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId);
-		}).then(function(response) {
+		try {
+			await this._showWarning(mSettings);
+			const sDocumentDescriptionId = await this.postDocumentDescription(oDocumentDescription, mSettings.dataSource);
+			const response = await this.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId);
+
 			ExportUtils.saveAsFile(response, mSettings.fileName);
 			ExportUtils.announceExportStatus(Status.FINISHED);
-		}).catch(function(oError) {
-			/* Handle ignore Promise rejection due to cancellation by the user */
-			if (!oError) {
-				return;
-			}
+		} catch (oError) {
+			PortableDocument.showErrorMessage(oError);
+		}
 
-			oError.text()
-				.then(function(sError) {
-					ExportDialog.showErrorMessage(sError);
-				})
-				.catch(function() {
-					ExportDialog.showErrorMessage(oResourceBundle.getText('PDF_GENERIC_ERROR'));
-				});
-		}).finally(function() {
-			oBusyDialog?.close();
-		});
+		oBusyDialog?.destroy();
 	};
 
 	/**

package/src/sap/ui/export/Spreadsheet.js

@@ -85,7 +85,7 @@ sap.ui.define([
 		 *      <li><code>workbook.context</code> - Context object that will be applied to the generated file. It may contain the following fields:</li>
 		 *      <ul>
 		 *          <li><code>application</code> (string) - The application that creates the XLSX document (default: "SAP UI5")</li>
-		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.124.0")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.124.2")</li>
 		 *          <li><code>title</code> (string) - Title of the XLSX document (NOT the filename)</li>
 		 *          <li><code>modifiedBy</code> (string) - User context for the XLSX document</li>
 		 *          <li><code>sheetName</code> (string) - The label of the data sheet</li>
@@ -169,7 +169,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.124.0',
+		 *         version: '1.124.2',
 		 *         title: 'Some random title',
 		 *         modifiedBy: 'John Doe',
 		 *         metaSheetName: 'Custom metadata',
@@ -281,7 +281,7 @@ sap.ui.define([
 		 * @class The <code>sap.ui.export.Spreadsheet</code> class allows you to export table data from a UI5 application to a spreadsheet file.
 		 *
 		 * @author SAP SE
-		 * @version 1.124.0
+		 * @version 1.124.2
 		 *
 		 * @since 1.50
 		 * @alias sap.ui.export.Spreadsheet

package/src/sap/ui/export/SpreadsheetExport.js

@@ -21,7 +21,7 @@ sap.ui.define(['sap/base/Log', 'sap/ui/export/ExportUtils'], function(Log, Expor
 	 * Utility class to perform spreadsheet export.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @alias sap.ui.export.SpreadsheetExport
 	 * @private

package/src/sap/ui/export/library.js

@@ -15,7 +15,7 @@ sap.ui.define(["sap/ui/core/Lib"], function(Library) {
 	 * @namespace
 	 * @alias sap.ui.export
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 * @public
 	 */
 
@@ -33,7 +33,7 @@ sap.ui.define(["sap/ui/core/Lib"], function(Library) {
 		interfaces: [],
 		controls: [],
 		elements: [],
-		version: "1.124.0"
+		version: "1.124.2"
 	});
 
 	/**

package/src/sap/ui/export/provider/DataProviderBase.js

@@ -24,7 +24,7 @@
 	 * @param {object} mSettings Data service related part of the export configuration
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @constructor
 	 * @class DataProviderBase

package/src/sap/ui/export/util/Filter.js

@@ -20,7 +20,7 @@ sap.ui.define(['sap/ui/base/Object'], function(BaseObject) {
 	 * convenience functions like <code>sap.ui.export.util.Filter#setType</code> to improve the result.
 	 *
 	 * @author SAP SE
-	 * @version 1.124.0
+	 * @version 1.124.2
 	 *
 	 * @since 1.110
 	 * @alias sap.ui.export.util.Filter