@sapui5/sap.ui.export 1.100.0 → 1.101.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.100.0",
+	"version": "1.101.0",
 	"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-2022 SAP SE. All rights reserved.</copyright>
-	<version>1.100.0</version>
+	<version>1.101.0</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 
@@ -34,7 +34,7 @@
 			</module-infos>
 			<all-in-one>
 				<!-- exclude third party bundles and the worker code -->
-				<exclude name="sap/ui/export/js/**" />
+				<exclude name="sap/ui/export/js/" />
 			</all-in-one>
 		</packaging>
 		<ownership xmlns="http://www.sap.com/ui5/buildext/ownership">

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

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * @constructor The <code>sap.ui.export.ExportBase</code> class allows you to export table data from a UI5 application to a Portable Document Format (*.PDF) file.
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.101.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase

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

@@ -58,6 +58,9 @@ sap.ui.define([
 			includeFilterSettings: false,
 			addDateTime: false,
 			doEnableAccessibility: false,
+			pdfArchive: false,
+			capabilities: oExportCapabilities,
+			fitToPage: false,
 			paperSize: [
 				{key: "DIN_A4", text: oResourceBundle.getText("PAPER_SIZE_A4")},
 				{key: "US_LETTER", text: oResourceBundle.getText("PAPER_SIZE_US_LETTER")}
@@ -97,7 +100,7 @@ sap.ui.define([
 	function processExportSettings(oSettings) {
 		var oFinalSettings = {};
 
-		["fileName", "selectedFileType", "selectedPaperSize", "selectedOrientation", "splitCells", "includeFilterSettings", "addDateTime", "doEnableAccessibility", "fontSize", "signature", "signatureReason"].forEach(function(sProperty) {
+		["fileName", "selectedFileType", "selectedPaperSize", "selectedOrientation", "splitCells", "includeFilterSettings", "addDateTime", "doEnableAccessibility", "fitToPage", "fontSize", "signature", "signatureReason", "pdfArchive"].forEach(function(sProperty) {
 			oFinalSettings[sProperty] = oSettings[sProperty];
 		});
 
@@ -108,7 +111,7 @@ sap.ui.define([
 	 * Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.101.0
 	 *
 	 * @since 1.59
 	 * @name sap.ui.export.ExportUtils
@@ -225,6 +228,7 @@ sap.ui.define([
 								var oSelectedItem = oEvent.getParameter("selectedItem");
 								if (oSelectedItem && oSelectedItem.getKey() === FileType.PDF) {
 									oExportConfigModel.setProperty("/splitCells", true);
+									oExportConfigModel.setProperty("/includeFilterSettings", false);
 								} else {
 									Core.byId('exportSettingsDialog-signatureReason').setVisible(false);
 									Core.byId('exportSettingsDialog-signatureReasonLabel').setVisible(false);
@@ -349,10 +353,11 @@ sap.ui.define([
 		 * subsequent filters.
 		 *
 		 * @param {Object} oLogicalFilter Filter object according to ListBinding#getFilterInfo
-		 * @returns {Array} Array containing all filter settings
+		 * @returns {Array} Array containing evaluated filter settings
 		 * @private
 		 */
 		_parseLogical: function(oLogicalFilter) {
+			var aFilters, sProperty;
 
 			/* Breakout behavior for between filter */
 			if (oLogicalFilter.op == '&&'
@@ -382,7 +387,27 @@ sap.ui.define([
 				});
 			}
 
-			return 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;
+
+				if (aFilters.every(function(item) { return item.key === sProperty; })) {
+					aFilters = [
+						{
+							key: sProperty,
+							value: aFilters.reduce(function(acc, item) {
+								var sSeparator = acc ? '; ' : '';
+
+								return acc + sSeparator + item.value;
+							}, '')
+						}
+					];
+				}
+			}
+
+			return aFilters;
 		},
 
 		/**
@@ -831,7 +856,7 @@ sap.ui.define([
 				});
 
 				/* Validate string based properties (not column type String related) */
-				['inputFormat', 'unit', 'unitProperty', 'template', 'trueValue', 'falseValue'].forEach(function(sProperty) {
+				['inputFormat', 'unit', 'unitProperty', 'template', 'trueValue', 'falseValue', 'timezone', 'timezoneProperty'].forEach(function(sProperty) {
 					Utils._validateString(oColumn, sProperty);
 				});
 
@@ -855,11 +880,27 @@ sap.ui.define([
 				}
 
 				/* Validate utc property */
-				if (oColumn.utc != null && (oColumn.type === EdmType.Date || oColumn.type === EdmType.Time)) {
-					oColumn.utc = true; // Date and Time always use UTC
-				}
 				if (oColumn.type === EdmType.DateTime) {
-					Utils._validateProperty(oColumn, 'utc', 'boolean', true);
+
+					/*
+					 * Apply local time or UTC as fixed timezone
+					 * in case no timezone is defined. This also
+					 * serves as a fallback if timezoneProperty
+					 * is defined but the Line Item has no value
+					 * for the referenced property name.
+					 */
+					if (!oColumn.timezone) {
+						oColumn.timezone = oColumn.utc === false ? new Intl.DateTimeFormat().resolvedOptions().timeZone : 'UTC';
+					}
+
+					/* Remove obviously incorrect timezoneProperty settings */
+					if (oColumn.property === oColumn.timezoneProperty || (typeof oColumn.timezoneProperty === 'string' && oColumn.timezoneProperty.split(',').length > 1)) {
+						Log.warning(CLASS_NAME + ': Property timezoneProperty is invalid.');
+						delete oColumn.timezoneProperty;
+					}
+				} else if (typeof oColumn.utc === 'boolean') {
+					Log.warning(CLASS_NAME + ': Property utc is only supported for type DateTime.');
+					delete oColumn.utc;
 				}
 
 				/* Validate scale property */
@@ -934,7 +975,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.100.0")
+		 * @param {string} [oContext.version] Application version (default: "1.101.0")
 		 * @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
@@ -1028,7 +1069,7 @@ sap.ui.define([
 				value = null;
 			}
 
-			oContext[sProperty] = value == null && defaultValue ? defaultValue : value;
+			oContext[sProperty] = value == null && typeof defaultValue !== 'undefined' ? defaultValue : value;
 		},
 
 		/**

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

@@ -16,7 +16,7 @@ sap.ui.define([
 	 * @constructor 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.100.0
+	 * @version 1.101.0
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument
@@ -30,7 +30,7 @@ sap.ui.define([
 
 
 			/* Only apply supported properties */
-			['paperSize', 'orientation', 'font', 'fontSize', 'doEnableAccessibility', 'signature', 'signatureReason'].forEach(function(sProperty) {
+			['paperSize', 'orientation', 'font', 'fontSize', 'doEnableAccessibility', 'fitToPage', 'signature', 'signatureReason', 'pdfArchive'].forEach(function(sProperty) {
 				if (typeof mSettings[sProperty] !== 'undefined') {
 					this._mSettings[sProperty] = mSettings[sProperty];
 				}
@@ -149,7 +149,14 @@ sap.ui.define([
 				"PaperSize": mSettings.paperSize,
 				"Orientation": mSettings.orientation,
 				"FontSize": Number(mSettings.fontSize),
-				"DoEnableAccessibility": mSettings.doEnableAccessibility
+				"FitToPage": {
+					"IsEnabled": mSettings.fitToPage,
+					"MinimumFontSize": 4
+				}
+			},
+			"PDFStandard": {
+				"DoEnableAccessibility": mSettings.doEnableAccessibility,
+				"UsePDFAConformance": mSettings.pdfArchive
 			},
 			"Signature": {
 				"DoSign": mSettings.signature,
@@ -251,7 +258,7 @@ sap.ui.define([
 			oContext = mSettings.workbook.context = {};
 		}
 
-		if (typeof oContext.title === 'string') {
+		if (typeof oContext.title === 'string' && oContext.title) {
 			return Promise.resolve();
 		}
 
@@ -267,48 +274,51 @@ sap.ui.define([
 	 *
 	 * @param {Object} oDocumentDescription DocumentDescription instance that is being created
 	 * @param {Object} oDataSource DataSource settings of the export configuration
-	 * @param {function} fnSuccess Success handler function
-	 * @param {function} fnError Error handler function
+	 *
+	 * @returns {Promise} A Promise that resolves with the newly created Id of the DocumentDescription
 	 */
-	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource, fnSuccess, fnError) {
+	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource) {
 		var oBinding, oModel, sPath;
 
 		oModel = this._getModel(oDataSource);
 		sPath = '/' + this._getEntitySetName(oDataSource);
 
 		if (!oModel || !oModel.isA(['sap.ui.model.odata.v4.ODataModel', 'sap.ui.model.odata.v2.ODataModel'])) {
-			fnError('Unsupported Model');
+			return Promise.reject('Unsupported Model');
 		}
 
-		if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
-			oBinding = oModel.bindList(sPath);
+		return new Promise(function(fnResolve, fnReject) {
 
-			oBinding.attachCreateCompleted(function(oEvent) {
-				var success = oEvent.getParameter('success');
+			if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
+				oBinding = oModel.bindList(sPath);
 
-				if (success) {
-					fnSuccess(oEvent.getParameter('context').getObject()['Id']);
-				} else {
-					fnError();
-				}
-			});
+				oBinding.attachCreateCompleted(function(oEvent) {
+					var success = oEvent.getParameter('success');
 
-			oBinding.create(oDocumentDescription);
-		} else {
-			var bUseBatch = oModel.bUseBatch;
-
-			oModel.setUseBatch(false);
-			oModel.create(sPath, oDocumentDescription, {
-				success: function(oData) {
-					oModel.setUseBatch(bUseBatch);
-					fnSuccess(oData['Id']);
-				},
-				error: function(oError) {
-					oModel.setUseBatch(bUseBatch);
-					fnError(oError);
-				}
-			});
-		}
+					if (success) {
+						fnResolve(oEvent.getParameter('context').getObject()['Id']);
+					} else {
+						fnReject();
+					}
+				});
+
+				oBinding.create(oDocumentDescription);
+			} else {
+				var bUseBatch = oModel.bUseBatch;
+
+				oModel.setUseBatch(false);
+				oModel.create(sPath, oDocumentDescription, {
+					success: function(oData) {
+						oModel.setUseBatch(bUseBatch);
+						fnResolve(oData['Id']);
+					},
+					error: function(oError) {
+						oModel.setUseBatch(bUseBatch);
+						fnReject(oError);
+					}
+				});
+			}
+		});
 	};
 
 	/**
@@ -320,16 +330,33 @@ sap.ui.define([
 	 */
 	PortableDocument.prototype.createBuildPromise = function(mSettings) {
 		var that = this;
+		var oDocumentDescription;
+		var oBusyDialog;
+		var oResourceBundle = Core.getLibraryResourceBundle('sap.ui.export');
+
+		oBusyDialog = new sap.m.BusyDialog('PDFExportBusyDialog', {
+			title: oResourceBundle.getText("PROGRESS_TITLE"),
+			text: oResourceBundle.getText("PDF_GENERATION_IN_PROGRESS"),
+			showCancelButton: true,
+			close: function(oEvent) {
+				if (oEvent.getParameter("cancelPressed")) {
+					that.cancel();
+					oBusyDialog.destroy();
+					oBusyDialog = null;
+				}
+			}
+		});
 
-		return new Promise(function(fnResolve, fnReject) {
-			var oDocumentDescription;
-
-			oDocumentDescription = that._createDocumentDescription(mSettings);
-			that.postDocumentDescription(oDocumentDescription, mSettings.dataSource, fnResolve, fnReject);
+		oDocumentDescription = that._createDocumentDescription(mSettings);
 
-		}).then(function(sDocumentDescriptionId) {
-			return that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
+		return that.postDocumentDescription(oDocumentDescription, mSettings.dataSource).then(function(sDocumentDescriptionId) {
+			oBusyDialog.open();
+			return oBusyDialog && that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
 				ExportUtils.saveAsFile(response, mSettings.fileName);
+				oBusyDialog && oBusyDialog.destroy();
+			}).catch(function(e) {
+				oBusyDialog && oBusyDialog.destroy();
+				new sap.m.MessageToast.show("Error during PDF export!");
 			});
 		});
 	};

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

@@ -83,7 +83,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.100.0")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.101.0")</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>
@@ -166,7 +166,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.100.0',
+		 *         version: '1.101.0',
 		 *         title: 'Some random title',
 		 *         modifiedBy: 'John Doe',
 		 *         metaSheetName: 'Custom metadata',
@@ -278,7 +278,7 @@ sap.ui.define([
 		 * @constructor 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.100.0
+		 * @version 1.101.0
 		 *
 		 * @since 1.50
 		 * @name sap.ui.export.Spreadsheet

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

@@ -22,7 +22,7 @@ sap.ui.define(['sap/base/Log', 'sap/ui/export/ExportUtils'], function(Log, Expor
 	 *
 	 * @namespace
 	 * @author SAP SE
-	 * @version 1.100.0
+	 * @version 1.101.0
 	 *
 	 * @private
 	 * @since 1.50.0

package/src/sap/ui/export/fragments/SettingsDialog.fragment.xml

@@ -11,7 +11,9 @@
 				</items>
 			</Select>
 
-			<CheckBox id="exportSettingsDialog-includeFilterSettings" selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"/>
+			<CheckBox id="exportSettingsDialog-includeFilterSettings" selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/selectedFileType', formatter: '.isXLSX'}"/>
+			<CheckBox id="exportSettingsDialog-includeFilterSettings-PDF" enabled="{/capabilities/PDF/CoverPage}"  selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_FILTER_SETTINGS}"/>
+			<CheckBox id="exportSettingsDialog-pdfArchive" enabled="{/capabilities/PDF/ArchiveFormat}" selected="{/pdfArchive}" text="{i18n>ARCHIVE_FORMAT}"  visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_ARCHIVE_FORMAT}"/>
 			<CheckBox id="exportSettingsDialog-splitCells" selected="{/splitCells}" text="{i18n>SPLIT_CELLS}" visible="{path:'/selectedFileType', formatter: '.isXLSX'}"/> <!-- Will be hidden in case of PDF because it needs to be true always -->
 			<CheckBox id="exportSettingsDialog-addDateTime" selected="{/addDateTime}" text="{i18n>ADD_DATE_TIME}" visible="false"/>
 
@@ -31,10 +33,11 @@
 			</Select>
 
 			<Label text="{i18n>FONT_SIZE}" labelFor="exportSettingsDialog-fontSize" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
-			<Input id="exportSettingsDialog-fontSize" value="{/fontSize}" liveChange=".onFontSizeChange" class="sapUiTinyMarginBottom" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<Input id="exportSettingsDialog-fontSize" value="{/fontSize}" enabled="{/capabilities/PDF/FontSize}" liveChange=".onFontSizeChange" class="sapUiTinyMarginBottom" visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_FONT_SIZE}"/>
 
-			<CheckBox id="exportSettingsDialog-accessibility" enabled="{/accessibilitySupported}" selected="{/doEnableAccessibility}" text="{i18n>ENABLE_ACCESSIBILITY}" tooltip="{i18n>TOOLTIP_PDF_ACCESSIBILITY}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
-			<CheckBox id="exportSettingsDialog-signature" enabled="{/signatureSupported}" selected="{/signature}" text="{i18n>ENABLE_SIGNATURE}" tooltip="{i18n>TOOLTIP_PDF_SIGNATURE}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<CheckBox id="exportSettingsDialog-accessibility" selected="{/doEnableAccessibility}" text="{i18n>ENABLE_ACCESSIBILITY}" tooltip="{i18n>TOOLTIP_PDF_ACCESSIBILITY}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<CheckBox id="exportSettingsDialog-fitToPage" enabled="{/capabilities/PDF/FitToPage}" selected="{/fitToPage}" text="{i18n>FITTOPAGE}" tooltip="{i18n>TOOLTIP_FITTOPAGE}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<CheckBox id="exportSettingsDialog-signature" enabled="{/capabilities/PDF/Signature}" selected="{/signature}" text="{i18n>ENABLE_SIGNATURE}" tooltip="{i18n>TOOLTIP_PDF_SIGNATURE}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
 
 			<Label id="exportSettingsDialog-signatureReasonLabel" text="{i18n>SIGNATURE_REASON}" labelFor="exportSettingsDialog-signatureReason" visible="{/signature}"/>
 			<Input id="exportSettingsDialog-signatureReason" value="{/signatureReason}" class="sapUiTinyMarginBottom" visible="{/signature}"/>