@sapui5/sap.ui.export 1.113.0 → 1.114.2

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.113.0",
+	"version": "1.114.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-2023 SAP SE. All rights reserved.</copyright>
-	<version>1.113.0</version>
+	<version>1.114.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.113.0
+	 * @version 1.114.2
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.ExportBase

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

@@ -9,14 +9,15 @@
  */
 sap.ui.define([
 	'sap/ui/core/library',
+	'sap/ui/core/format/NumberFormat',
+	'sap/ui/export/ExportUtils',
 	'sap/m/library',
 	'sap/m/Dialog',
 	'sap/m/Button',
 	'sap/m/ProgressIndicator',
 	'sap/m/Text',
-	'sap/m/MessageBox',
-	'sap/ui/core/format/NumberFormat'
-], function(coreLibrary, MLibrary, Dialog, Button, ProgressIndicator, Text, MessageBox, NumberFormat) {
+	'sap/m/MessageBox'
+], function(coreLibrary, NumberFormat, ExportUtils, MLibrary, Dialog, Button, ProgressIndicator, Text, MessageBox) {
 	'use strict';
 
 	var ValueState = coreLibrary.ValueState;
@@ -24,9 +25,6 @@ sap.ui.define([
 	var DialogType = MLibrary.DialogType;
 	var ButtonType = MLibrary.ButtonType;
 
-	/* Async call to resource bundle */
-	var oResourceBundlePromise = sap.ui.getCore().getLibraryResourceBundle("sap.ui.export", true);
-
 	/**
 	 * The method returns a new Promise that results in a new
 	 * progress dialog.
@@ -37,7 +35,7 @@ sap.ui.define([
 		return new Promise(function(fnResolve, fnReject) {
 			var dialog;
 
-			oResourceBundlePromise.then(function(oResourceBundle) {
+			ExportUtils.getResourceBundle().then(function(oResourceBundle) {
 				var cancelButton = new Button({
 					text : oResourceBundle.getText("CANCEL_BUTTON"),
 					press : function() {
@@ -117,49 +115,60 @@ sap.ui.define([
 	 * Shows a warning dialog that can show several warning messages, either alone or combined.
 	 *
 	 * @param {Object} mParams Configuration of the warning dialog
-	 * @param {number} mParams.rows Amount of rows that will be exported
-	 * @param {number} mParams.columns Amount of columns that will be exported
-	 * @param {boolean} mParams.sizeLimit Indicates whether the size limit warning needs to be shown
-	 * @param {boolean} mParams.cutOff Indicates whether the cut off message needs to be shown
+	 * @param {number} mParams.rows Number of rows that will be exported
+	 * @param {number} mParams.columns Number of columns that will be exported
+	 * @param {boolean} mParams.cellLimit Number of cells that are suported
+	 * @param {boolean} mParams.rowLimit Number of rows that are supported
 	 * @param {String} mParams.fileType File type of the exported document
 	 * @returns {Promise} Promise that gets resolved when the user wants to export, regardless of the warning
 	 */
 	function showWarningDialog(mParams) {
 		return new Promise(function(fnResolve, fnReject) {
 
-			oResourceBundlePromise.then(function(oResourceBundle) {
-				var bContinue, oWarningDialog, oWarningText, sWarningText, oNumberFormat, sRowsFormatted, sCellsFormatted, sCutOffFormatted, sFileTypeText;
+			ExportUtils.getResourceBundle().then(function(oResourceBundle) {
+				var aText, bContinue, oWarningDialog, oWarningText, oNumberFormat, sRowCount, sCellCount, sCellLimit, sLimit, sFileType;
 
-				oNumberFormat = NumberFormat.getIntegerInstance({groupingEnabled: true});
+				aText = [];
 				bContinue = false;
-				sWarningText = '';
+				oNumberFormat = NumberFormat.getIntegerInstance({groupingEnabled: true});
+				sFileType = oResourceBundle.getText(mParams.fileType + "_FILETYPE");
+				sLimit = oNumberFormat.format(mParams.rowLimit);
 
-				if (!mParams.rows) {
-					sWarningText = oResourceBundle.getText("NO_COUNT_WARNING_MSG");
-				} else {
-					sRowsFormatted = oNumberFormat.format(mParams.rows);
+				if (mParams.rows) {
+					sRowCount = oNumberFormat.format(mParams.rows);
 
-					if (mParams.sizeLimit) {
-						sCellsFormatted = oNumberFormat.format(mParams.rows * mParams.columns);
-						sWarningText = oResourceBundle.getText("SIZE_WARNING_MSG", [sRowsFormatted, mParams.columns, sCellsFormatted]);
+					if (mParams.columns) {
+						sCellCount = oNumberFormat.format(mParams.rows * mParams.columns);
+						aText.push(oResourceBundle.getText("MSG_WARNING_CELL_COUNT", [sRowCount, mParams.columns, sCellCount]));
+					} else {
+						aText.push(oResourceBundle.getText("MSG_WARNING_ROW_COUNT", [sRowCount]));
 					}
 
-					if (mParams.rows > mParams.cutOff) {
-						sCutOffFormatted = oNumberFormat.format(mParams.cutOff);
-						sWarningText += sWarningText === '' ? '' : '\n\n'; // Add line breaks if there is already a message
-						sFileTypeText = oResourceBundle.getText(mParams.fileType + "_FILETYPE");
-						sWarningText += oResourceBundle.getText("MSG_WARNING_CUT_OFF", [sRowsFormatted, sCutOffFormatted, sFileTypeText]);
+					if (mParams.rows > mParams.rowLimit) {
+						aText.push(oResourceBundle.getText("MSG_WARNING_ROW_LIMIT", [sLimit, sFileType]));
 					}
+
+					if (mParams.rows * mParams.columns > mParams.cellLimit) {
+						sCellLimit = oNumberFormat.format(mParams.cellLimit);
+						aText.push(oResourceBundle.getText("MSG_WARNING_CELL_LIMIT", [sCellLimit]));
+					}
+				} else {
+					aText.push(oResourceBundle.getText("MSG_WARNING_COUNT_UNKNOWN"));
+					aText.push(oResourceBundle.getText("MSG_WARNING_ROW_LIMIT", [sLimit, sFileType]));
+					aText.push(oResourceBundle.getText("MSG_WARNING_ADVICE"));
 				}
 
+				aText.push(oResourceBundle.getText("MSG_WARNING_EXPORT_ANYWAY"));
+
 				oWarningText = new Text({
-					text: sWarningText
+					text: aText.join('\n\n')
 				});
 				oWarningDialog = new Dialog({
 					title: oResourceBundle.getText('WARNING_TITLE'),
 					type: DialogType.Message,
 					state: ValueState.Warning,
 					content: oWarningText,
+					contentWidth: '550px', // UX recommendation
 					ariaLabelledBy: oWarningText,
 					endButton: new Button({
 						type: ButtonType.Transparent,
@@ -201,7 +210,7 @@ sap.ui.define([
 			sMessage = sMessage.message;
 		}
 
-		oResourceBundlePromise.then(function(oResourceBundle) {
+		ExportUtils.getResourceBundle().then(function(oResourceBundle) {
 			var sErrorMessage = sMessage || oResourceBundle.getText('PROGRESS_ERROR_DEFAULT');
 
 			// Replace technical error message in case of "out of memory"

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

@@ -15,7 +15,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * @class The <code>sap.ui.export.ExportHandler</code> class allows you to export table data from a UI5 application.
 	 *
 	 * @author SAP SE
-	 * @version 1.113.0
+	 * @version 1.114.2
 	 *
 	 * @since 1.102
 	 * @alias sap.ui.export.ExportHandler

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

@@ -14,8 +14,9 @@ sap.ui.define([
 	'sap/ui/model/resource/ResourceModel',
 	'sap/ui/util/openWindow',
 	'sap/ui/VersionInfo',
-	'sap/ui/core/format/DateFormat'
-], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, Filter, JSONModel, ResourceModel, openWindow, VersionInfo, DateFormat) {
+	'sap/ui/core/format/DateFormat',
+	"sap/ui/performance/trace/FESRHelper"
+], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, Filter, JSONModel, ResourceModel, openWindow, VersionInfo, DateFormat, FESRHelper) {
 	'use strict';
 
 	// eslint-disable-next-line
@@ -32,7 +33,6 @@ sap.ui.define([
 
 	/* Async call to resource bundle */
 	var oResourceBundle;
-	var oResourceBundlePromise = Core.getLibraryResourceBundle('sap.ui.export', true);
 
 	var CLASS_NAME = 'sap.ui.export.ExportUtils';
 
@@ -134,7 +134,7 @@ sap.ui.define([
 	 * @class Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.113.0
+	 * @version 1.114.2
 	 *
 	 * @since 1.59
 	 * @alias sap.ui.export.ExportUtils
@@ -249,7 +249,7 @@ sap.ui.define([
 					oOpener = null;
 				}
 
-				oResourceBundlePromise.then(function (oResourceBundle) {
+				Utils.getResourceBundle().then(function (oResourceBundle) {
 					var oExportConfigModel = new JSONModel();
 
 					oExportConfigModel.setData(getDefaultSettings(mCustomConfig, oResourceBundle, oExportCapabilities, bRemoteDestination));
@@ -368,6 +368,10 @@ sap.ui.define([
 						if (oOpener) {
 							syncStyleClass('sapUiSizeCompact', oOpener, oExportSettingsDialog);
 						}
+
+						FESRHelper.setSemanticStepname(oExportSettingsDialog.getBeginButton(), "press", "oi:exp:export");
+						FESRHelper.setSemanticStepname(oExportSettingsDialog.getEndButton(), "press", "oi:exp:cancel");
+
 						oExportSettingsDialog.open();
 
 						if (fnCallback) {
@@ -454,56 +458,76 @@ sap.ui.define([
 		_parseLogical: function(oLogicalFilter) {
 			var aFilters, sProperty;
 
-			/* Breakout behavior for between filter */
-			if (oLogicalFilter.op == '&&'
-				&& oLogicalFilter.left.type === 'Binary'
-				&& oLogicalFilter.right.type === 'Binary'
-				&& oLogicalFilter.left.op === '>='
-				&& oLogicalFilter.right.op === '<='
-				&& oLogicalFilter.left.left.path === oLogicalFilter.right.left.path) {
-
-				return Utils._parseCall({
-					args: [
-						{
-							path: oLogicalFilter.left.left.path,
-							type: 'Reference'
-						},
-						{
-							type: 'Literal',
-							value: oLogicalFilter.left.right.value
-						},
-						{
-							type: 'Literal',
-							value: oLogicalFilter.right.right.value
-						}
-					],
-					name: 'between',
-					type: 'Call'
-				});
-			}
+			try {
+				/*
+				 * BCP 002075129400002076772023
+				 * When too many filters are applied, the
+				 * filter evaluation might fail due to an
+				 * "Maximum call stack size exceeded" error.
+				 * This will be prevented by try-catch and
+				 * still allows to keep existing results.
+				 * Once the error occurs, additional filters
+				 * will be ignored. This only happens for
+				 * Logical filters with OR operator because
+				 * they can lead to an unbalanced filter tree.
+				 * For the unlikely scenario that the failing
+				 * filter is a between filter, this scenario
+				 * is also contained in try-catch.
+				 */
+
+				/* Breakout behavior for between filter */
+				if (oLogicalFilter.op == '&&'
+					&& oLogicalFilter.left.type === 'Binary'
+					&& oLogicalFilter.right.type === 'Binary'
+					&& oLogicalFilter.left.op === '>='
+					&& oLogicalFilter.right.op === '<='
+					&& oLogicalFilter.left.left.path === oLogicalFilter.right.left.path) {
+
+					return Utils._parseCall({
+						args: [
+							{
+								path: oLogicalFilter.left.left.path,
+								type: 'Reference'
+							},
+							{
+								type: 'Literal',
+								value: oLogicalFilter.left.right.value
+							},
+							{
+								type: 'Literal',
+								value: oLogicalFilter.right.right.value
+							}
+						],
+						name: 'between',
+						type: 'Call'
+					});
+				}
 
-			aFilters = Utils._parseFilter(oLogicalFilter.left).concat(Utils._parseFilter(oLogicalFilter.right));
+				aFilters = Utils._parseFilter(oLogicalFilter.left).concat(Utils._parseFilter(oLogicalFilter.right));
 
-			/* Group logical OR filter on the same property */
-			if (oLogicalFilter.op === '||' && aFilters.length) {
-				sProperty = aFilters[0].key;
+				/* Group logical OR filter on the same property */
+				if (oLogicalFilter.op === '||' && aFilters.length) {
+					sProperty = aFilters[0].key;
 
-				if (aFilters.every(function(item) { return item.key === sProperty; })) {
-					aFilters = [
-						{
-							key: sProperty,
-							value: aFilters.reduce(function(acc, item) {
-								if (Array.isArray(item.value)) {
-									return acc.concat(item.value);
-								}
+					if (aFilters.every(function(item) { return item.key === sProperty; })) {
+						aFilters = [
+							{
+								key: sProperty,
+								value: aFilters.reduce(function(acc, item) {
+									if (Array.isArray(item.value)) {
+										return acc.concat(item.value);
+									}
 
-								acc.push(item.value);
+									acc.push(item.value);
 
-								return acc;
-							}, [])
-						}
-					];
+									return acc;
+								}, [])
+							}
+						];
+					}
 				}
+			} catch (oError) {
+				aFilters = [];
 			}
 
 			return aFilters;
@@ -593,7 +617,7 @@ sap.ui.define([
 		parseFilterConfiguration: function() {
 			Log.error('Function is deprecated and must not be used anymore');
 
-			return oResourceBundlePromise.then(function(oResourceBundle) {
+			return Utils.getResourceBundle().then(function(oResourceBundle) {
 				return {
 					name: oResourceBundle.getText('FILTER_HEADER'),
 					items: []
@@ -1143,7 +1167,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.113.0")
+		 * @param {string} [oContext.version] Application version (default: "1.114.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

@@ -15,11 +15,13 @@ sap.ui.define([
 ], function(Log, Core, ExportBase, ExportUtils, Library, ODataModel, ExportDialog, BusyDialog) {
 	'use strict';
 
+	var FileType = Library.FileType;
+
 	/**
 	 * @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.113.0
+	 * @version 1.114.2
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument
@@ -116,7 +118,8 @@ sap.ui.define([
 				version: bV4ODataModel ? 4 : 2,
 				dataUrl: oDataUrl.toString(),
 				serviceUrl: this._resolveServiceUrl(sServiceUrl),
-				headers: bV4ODataModel ?  oModel.getHttpHeaders(true) : oModel.getHeaders()
+				headers: bV4ODataModel ?  oModel.getHttpHeaders(true) : oModel.getHeaders(),
+				count: ExportUtils.getCountFromBinding(oBinding)
 			};
 		}
 
@@ -236,10 +239,14 @@ sap.ui.define([
 			}
 		}
 
-		/* Eliminate duplicates before adding columns */
+		/* Eliminate duplicate or unknown columns before adding them to the DocumentDescription */
 		oWorkbook.columns.filter(function(oColumn, iIndex, aArray) {
 			var sProperty = Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property;
 
+			if (!sProperty) {
+				return false;
+			}
+
 			return aArray.findIndex(function(oOtherColumn) {
 				var sOtherProperty = Array.isArray(oOtherColumn.property) ? oOtherColumn.property[0] : oOtherColumn.property;
 
@@ -292,6 +299,61 @@ sap.ui.define([
 		}) : this._oModel;
 	};
 
+	/**
+	 * Shows a warning dialog that the exported file might get cut off.
+	 * If the count is less than the ResultSizeMaximum of the PDF capabilities,
+	 * no dialog will be shown and the export will proceed automatically.
+	 *
+	 * @param {object} mSettings Export configuration object
+	 * @returns {Promise} Promise that gets resolved if the requirements
+	 * for the warning are not met or if the user decides to proceed.
+	 * When the user cancels the export, the Promise will reject.
+	 *
+	 * @private
+	 */
+	PortableDocument.prototype._showWarning = function(mSettings) {
+		var mParams, oWarningPromise;
+
+		mParams = {
+			rows: mSettings.dataSource.count,
+			rowLimit: this._mCapabilities.ResultSizeMaximum,
+			fileType: FileType.PDF
+		};
+
+		oWarningPromise = Promise.resolve();
+
+		if (isNaN(mParams.rows) || (mParams.rows > mParams.rowLimit)) {
+			oWarningPromise = ExportDialog.showWarningDialog(mParams);
+		}
+
+		return oWarningPromise;
+	};
+
+	/**
+	 * 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
+	 * the annotation or its value is not a number, it will be ignored.
+	 *
+	 * @param {string} sUrl Data URL that is used to request the PDF document
+	 * @returns {string} The modified data URL that contains $top. The value of $top is
+	 * based on the ResultSizeMaximum of the com.sap.vocabularies.PDF.v1.Features
+	 * annotation.
+	 */
+	PortableDocument.prototype._applyResultSize = function(sUrl) {
+		var iLimit, mDataUrl;
+
+		iLimit = parseInt(this._mCapabilities.ResultSizeMaximum);
+
+		if (!isNaN(iLimit) && iLimit > 0) {
+
+			mDataUrl = new URL(sUrl);
+			mDataUrl.search += '&$top=' + iLimit;
+			sUrl = mDataUrl.toString();
+		}
+
+		return sUrl;
+	};
+
 	/**
 	 * Applies default settings to the export configuration.
 	 *
@@ -404,20 +466,7 @@ sap.ui.define([
 		oDocumentDescription = that._createDocumentDescription(mSettings);
 		oBusyDialog.open();
 
-		//mParams for WarningDialog handling
-		var mParams = {
-			rows: mSettings.dataSource.count,
-			cutOff: this._mCapabilities.ResultSizeDefault,
-			fileType: Library.FileType.PDF
-		};
-
-		var oWarningPromise = Promise.resolve();
-
-		if (mParams.rows > mParams.cutOff) {
-			oWarningPromise = ExportDialog.showWarningDialog(mParams);
-		}
-
-		return oWarningPromise.then(function() {
+		return this._showWarning(mSettings).then(function() {
 			return that.postDocumentDescription(oDocumentDescription, mSettings.dataSource);
 		}).then(function(sDocumentDescriptionId) {
 			return oBusyDialog && that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId);
@@ -451,6 +500,8 @@ sap.ui.define([
 	 * @private
 	 */
 	PortableDocument.prototype.sendRequest = function(sUrl, sDocumentDescriptionId) {
+		sUrl = this._applyResultSize(sUrl);
+
 		return new Promise(function(fnResolve, fnReject) {
 			var oXHR = this.request = new XMLHttpRequest();
 

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

@@ -84,7 +84,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.113.0")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.114.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>
@@ -167,7 +167,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.113.0',
+		 *         version: '1.114.2',
 		 *         title: 'Some random title',
 		 *         modifiedBy: 'John Doe',
 		 *         metaSheetName: 'Custom metadata',
@@ -279,7 +279,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.113.0
+		 * @version 1.114.2
 		 *
 		 * @since 1.50
 		 * @alias sap.ui.export.Spreadsheet
@@ -752,17 +752,15 @@ sap.ui.define([
 					var oDialogSettings = {
 						rows: nRows,
 						columns: nColumns,
-						sizeLimit: nRows * nColumns > nSizeLimit,
-						cutOff: MAX_ROWS,
+						cellLimit: nSizeLimit,
+						rowLimit: MAX_ROWS,
 						fileType: Library.FileType.XLSX
 					};
 
 					// Show warning and execute
 					ExportDialog.showWarningDialog(oDialogSettings)
 						.then(startExport)
-						.catch(function() {
-							fnReject('Export cancelled by the user.');
-						});
+						.catch(fnReject);
 				} else {
 					startExport();
 				}

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.113.0
+	 * @version 1.114.2
 	 *
 	 * @alias sap.ui.export.SpreadsheetExport
 	 * @private