@sapui5/sap.ui.export 1.102.2 → 1.104.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.102.2",
+	"version": "1.104.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.102.2</version>
+	<version>1.104.0</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 

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

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @constructor 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.102.2
+	 * @version 1.104.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase

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

@@ -180,6 +180,10 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 	 * @param {string} sMessage Error message that will be shown in the error dialog
 	 */
 	function showErrorMessage(sMessage) {
+		if (!sMessage) {
+			return;
+		}
+
 		oResourceBundlePromise.then(function(oResourceBundle) {
 			var errorMessage = sMessage || oResourceBundle.getText('PROGRESS_ERROR_DEFAULT');
 

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

@@ -6,6 +6,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	'use strict';
 
 	var Destination = library.Destination;
+	var FileType = library.FileType;
 
 	/**
 	 * Any export related functionality is encapsuled in the <code>ExportHandler</code> which also stores user settings throughout the session.
@@ -14,7 +15,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * @constructor The <code>sap.ui.export.ExportHandler</code> class allows you to export table data from a UI5 application.
 	 *
 	 * @author SAP SE
-	 * @version 1.102.2
+	 * @version 1.104.0
 	 *
 	 * @since 1.102
 	 * @name sap.ui.export.ExportHandler
@@ -402,8 +403,8 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 			mUserSettings.splitCells = mDialogSettings.splitCells;
 			mUserSettings.includeFilterSettings = mDialogSettings.includeFilterSettings;
 
-			/* Split columns if configured */
-			if (mDialogSettings.splitCells) {
+			/* Enforce split cells option for fileType PDF without persisting the value in the settings dialog */
+			if (mExportSettings.fileType === FileType.PDF || mDialogSettings.splitCells) {
 				mExportSettings.workbook.columns = ExportUtils.splitColumns(mExportSettings.workbook.columns, fnResolveColumnLabel);
 			}
 
@@ -423,6 +424,28 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 				oContext.metaSheetName = oFilterConfig.name;
 				oContext.metainfo = Array.isArray(oContext.metainfo) ? oContext.metainfo.push(oFilterConfig) : [oFilterConfig];
 			}
+
+			if (mExportSettings.includeFilterSettings) {
+				return ExportUtils.parseTechnicalConfiguration();
+			}
+
+			return Promise.resolve();
+		}).then(function(aUserConfig) {
+			if (aUserConfig) {
+				var oContext = mExportSettings.workbook.context;
+
+				if (!oContext) {
+					oContext = mExportSettings.workbook.context = {};
+				}
+
+				if (Array.isArray(oContext.metainfo)) {
+					aUserConfig.forEach(function(oUserConfig) {
+						oContext.metainfo.unshift(oUserConfig);
+					});
+				} else {
+					oContext.metainfo = aUserConfig;
+				}
+			}
 		}).then(function() {
 			if (mExportSettings.destination === Destination.LOCAL) {
 				return Promise.resolve();

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

@@ -12,8 +12,9 @@ sap.ui.define([
 	'sap/ui/model/json/JSONModel',
 	'sap/ui/model/resource/ResourceModel',
 	'sap/ui/util/openWindow',
-	'sap/ui/VersionInfo'
-], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, JSONModel, ResourceModel, openWindow, VersionInfo) {
+	'sap/ui/VersionInfo',
+	'sap/ui/core/format/DateFormat'
+], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, JSONModel, ResourceModel, openWindow, VersionInfo, DateFormat) {
 	'use strict';
 
 	// eslint-disable-next-line
@@ -21,10 +22,12 @@ sap.ui.define([
 
 	// Shortcuts
 	var ValueState = coreLibrary.ValueState;
+	var CalendarType = coreLibrary.CalendarType;
 	var FileType = library.FileType;
 	var EdmType = library.EdmType;
 	var Destination = library.Destination;
 	var uiVersion = null;
+	var oDefaultFormatSettings = null;
 
 	/* Async call to resource bundle */
 	var oResourceBundle;
@@ -68,12 +71,12 @@ sap.ui.define([
 			capabilities: oExportCapabilities,
 			fitToPage: false,
 			paperSizeCollection: [
-				{key: "DIN_A4", text: oResourceBundle.getText("PAPER_SIZE_A4")},
-				{key: "US_LETTER", text: oResourceBundle.getText("PAPER_SIZE_US_LETTER")}
+				{key: 'DIN_A4', text: oResourceBundle.getText('PAPER_SIZE_A4')},
+				{key: 'US_LETTER', text: oResourceBundle.getText('PAPER_SIZE_US_LETTER')}
 			],
 			orientationCollection: [
-				{key:"LANDSCAPE", text: oResourceBundle.getText("ORIENTATION_LAND")},
-				{key:"PORTRAIT", text: oResourceBundle.getText("ORIENTATION_PORT")}
+				{key:'LANDSCAPE', text: oResourceBundle.getText('ORIENTATION_LAND')},
+				{key:'PORTRAIT', text: oResourceBundle.getText('ORIENTATION_PORT')}
 			],
 			fontSize: 10,
 			signature: false,
@@ -113,7 +116,7 @@ sap.ui.define([
 	function processExportSettings(oSettings) {
 		var oFinalSettings = {};
 
-		["fileName", "fileType", "paperSize", "orientation", "splitCells", "includeFilterSettings", "addDateTime", "doEnableAccessibility", "fitToPage", "fontSize", "signature", "signatureReason", "pdfArchive", 'destination'].forEach(function(sProperty) {
+		['fileName', 'fileType', 'paperSize', 'orientation', 'splitCells', 'includeFilterSettings', 'addDateTime', 'doEnableAccessibility', 'fitToPage', 'fontSize', 'signature', 'signatureReason', 'pdfArchive', 'destination'].forEach(function(sProperty) {
 			oFinalSettings[sProperty] = oSettings[sProperty];
 		});
 
@@ -124,7 +127,7 @@ sap.ui.define([
 	 * Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.102.2
+	 * @version 1.104.0
 	 *
 	 * @since 1.59
 	 * @name sap.ui.export.ExportUtils
@@ -135,7 +138,6 @@ sap.ui.define([
 	var Utils = {
 
 		_INTERCEPTSERVICE: 'sap/ushell/cloudServices/interceptor/InterceptService',
-
 		/**
 		 * Uses the Launchpad Cloud Service to intercept a given URL.
 		 *
@@ -219,14 +221,12 @@ sap.ui.define([
 								return sDestination === Destination.LOCAL ? oResourceBundle.getText('EXPORT_BUTTON') : oResourceBundle.getText('DIALOG_BUTTON_CLOUD_DESTINATION');
 							},
 							onCancel: function() {
+								oExportSettingsDialog._bSuccess = false;
 								oExportSettingsDialog.close();
 							},
 							onExport: function() {
-								if (oExportSettingsDialog) {
-									oExportSettingsDialog._bSuccess = true;
-									oExportSettingsDialog.close();
-									fnResolve(processExportSettings(oExportConfigModel.getData()));
-								}
+								oExportSettingsDialog._bSuccess = true;
+								oExportSettingsDialog.close();
 							},
 
 							/**
@@ -255,7 +255,6 @@ sap.ui.define([
 							onFileTypeChange: function(oEvent) {
 								var oSelectedItem = oEvent.getParameter('selectedItem');
 								if (oSelectedItem && oSelectedItem.getKey() === FileType.PDF) {
-									oExportConfigModel.setProperty('/splitCells', true);
 									oExportConfigModel.setProperty('/includeFilterSettings', false);
 									oExportConfigModel.setProperty('/destination', Destination.LOCAL);
 								} else {
@@ -280,7 +279,9 @@ sap.ui.define([
 								oExportBtn.setEnabled(!bValidate);
 							},
 							onAfterClose: function() {
-								if (!oExportSettingsDialog._bSuccess) {
+								if (oExportSettingsDialog._bSuccess) {
+									fnResolve(processExportSettings(oExportConfigModel.getData()));
+								} else {
 									// Handle Cancel after close when export button was not pressed
 									// because a close could also be triggered via Esc
 									fnReject(null);
@@ -569,6 +570,48 @@ sap.ui.define([
 			});
 		},
 
+		/**
+		 * Promise, which resolves with an array containing username and
+		 * time stamp at which the document was created
+		 *
+		 * @returns {Promise} Resolves when the technical information has been obtained
+		*/
+		parseTechnicalConfiguration: function() {
+			var aUserConfig, oBundle, oUshellContainer;
+
+			aUserConfig = [];
+
+			/* sap/ushell/Container is not available through module loader */
+			oUshellContainer = sap.ushell && sap.ushell.Container;
+
+			return Utils.getResourceBundle().then(function(oResourceBundle) {
+				oBundle = oResourceBundle;
+
+				aUserConfig.push({
+					name: oBundle.getText('TECHNICAL_INFORMATION'),
+					items: [
+						{
+							key: oBundle.getText('CREATED_TIME'),
+							value: DateFormat.getDateTimeWithTimezoneInstance().format(new Date())
+						}
+					]
+				});
+			}).then(function() {
+				return oUshellContainer && typeof oUshellContainer.getServiceAsync === 'function' ?
+					oUshellContainer.getServiceAsync('UserInfo') : undefined;
+			}).then(function (oUserInfo) {
+				/* Add entry if UserInfo contains a proper name */
+				if (oUserInfo && oUserInfo.getFullName()) {
+					aUserConfig[0].items.unshift({
+						key: oBundle.getText('USER_NAME'),
+						value: oUserInfo.getFullName()
+					});
+				}
+
+				return aUserConfig;
+			});
+		},
+
 		/**
 		 * This function saves the provided Blob to the local file system.
 		 * The parameter name is optional and depending on the browser it
@@ -850,7 +893,7 @@ sap.ui.define([
 				/* *** Validation of type specific properties *** */
 
 				/* Validate boolean based properties (not column type Boolean related) */
-				['autoScale', 'delimiter', 'displayUnit', 'utc', 'wrap'].forEach(function(sProperty) {
+				['autoScale', 'delimiter', 'displayTimezone', 'displayUnit', 'utc', 'wrap'].forEach(function(sProperty) {
 					Utils._validateProperty(oColumn, sProperty, 'boolean');
 				});
 
@@ -865,6 +908,12 @@ sap.ui.define([
 					delete oColumn.template;
 				}
 
+				/* Only allow supported calendars */
+				if (typeof oColumn.calendar === 'string' && [CalendarType.Gregorian, CalendarType.Islamic, CalendarType.Japanese].indexOf(oColumn.calendar) < 0) {
+					Log.warning(CLASS_NAME + ': Unsupported calendar "' + oColumn.calendar + '" on column "' + (oColumn.label || oColumn.property) + '". Value will be discarded.');
+					delete oColumn.calendar;
+				}
+
 				/* Validate trueValue & falseValue properties */
 				if (oColumn.type === EdmType.Boolean && (oColumn.trueValue === null || oColumn.falseValue === null)) {
 					Log.warning(CLASS_NAME + ': The properties trueValue and falseValue have to be assigned correctly on column "' + (oColumn.label || oColumn.property) + '". Values will be discarded.');
@@ -958,15 +1007,40 @@ sap.ui.define([
 				oColumn.type = sFixedType;
 			}
 
-			if (oColumn.type === EdmType.Currency && !oColumn.unitProperty) {
-				Log.warning(CLASS_NAME + ': Missing unitProperty for type Currency on column "' + (oColumn.label || oColumn.property) + '". Type is reverted to "String".');
-				oColumn.type = EdmType.String;
-
-			} else if (oColumn.type === EdmType.Enumeration && (!oColumn.valueMap || typeof oColumn.valueMap !== 'object')) {
-				Log.warning(CLASS_NAME + ': Invalid valueMap for type Enumeration on column "' + (oColumn.label || oColumn.property) + '". Type is reverted to "String".');
-				oColumn.type = EdmType.String;
+			switch (oColumn.type) {
+				case EdmType.Date:
+					if (!oColumn.format && !oColumn.calendar) {
+						Utils._validateString(oColumn, 'format', Utils.getFormatSettings().datePattern);
+						Utils._validateString(oColumn, 'calendar', Utils.getFormatSettings().calendar);
+					}
+					break;
+				case EdmType.DateTime:
+					if (!oColumn.format && !oColumn.calendar) {
+						Utils._validateString(oColumn, 'format', Utils.getFormatSettings().dateTimePattern);
+						Utils._validateString(oColumn, 'calendar', Utils.getFormatSettings().calendar);
+					}
+					break;
+				case EdmType.Time:
+					Utils._validateString(oColumn, 'format', Utils.getFormatSettings().timePattern);
+					break;
+				case EdmType.Number:
+					/* Keep default delimiter disabled until scale issue has been resolved */
+					// Utils._validateProperty(oColumn, 'delimiter', 'boolean', Utils.getFormatSettings().delimiter);
+					break;
+				case EdmType.Currency:
+					if (!oColumn.unitProperty) {
+						Log.warning(CLASS_NAME + ': Missing unitProperty for type Currency on column "' + (oColumn.label || oColumn.property) + '". Type is reverted to "String".');
+						oColumn.type = EdmType.String;
+					}
+					break;
+				case EdmType.Enumeration:
+					if (!oColumn.valueMap || typeof oColumn.valueMap !== 'object') {
+						Log.warning(CLASS_NAME + ': Invalid valueMap for type Enumeration on column "' + (oColumn.label || oColumn.property) + '". Type is reverted to "String".');
+						oColumn.type = EdmType.String;
+					}
+					break;
+				default: /* Do nothing */
 			}
-
 		},
 
 		/**
@@ -974,7 +1048,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.102.2")
+		 * @param {string} [oContext.version] Application version (default: "1.104.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
@@ -1068,7 +1142,15 @@ sap.ui.define([
 				value = null;
 			}
 
-			oContext[sProperty] = value == null && typeof defaultValue !== 'undefined' ? defaultValue : value;
+			if (value == null && typeof defaultValue !== 'undefined') {
+				value = defaultValue;
+			}
+
+			if (value == null) {
+				delete oContext[sProperty];
+			} else {
+				oContext[sProperty] = value;
+			}
 		},
 
 		/**
@@ -1215,6 +1297,17 @@ sap.ui.define([
 					}
 				}
 
+				if (oColumn.timezoneProperty && oColumn.displayTimezone !== false) {
+					oUpdatedColumn = Object.assign({}, oColumn);
+					sColumnLabel = typeof fnResolveColumnLabel === 'function' ? fnResolveColumnLabel(oColumn.timezoneProperty) : null;
+					aSplittedColumns = [oUpdatedColumn, {
+						property: oColumn.timezoneProperty,
+						label: sColumnLabel || oColumn.label + ' (1)'
+					}];
+
+					oUpdatedColumn.displayTimezone = false;
+				}
+
 				aResult.push(aSplittedColumns || oColumn);
 			});
 
@@ -1236,6 +1329,56 @@ sap.ui.define([
 				});
 			}
 			return Promise.resolve(oResourceBundle);
+		},
+
+		/**
+		 * Provides Office Open XML compliant default format settings
+		 * based on the UI5 Core Configuration.
+		 *
+		 * @returns {Object} Format settings
+		 * @private
+		 */
+		getFormatSettings: function() {
+			if (!oDefaultFormatSettings) {
+				var oCoreSettings, oSettings;
+
+				oSettings = {};
+				oCoreSettings = Core.getConfiguration().getFormatSettings();
+
+				/* Reset cached format settings if formatSettings changed */
+				Core.attachLocalizationChanged(function() {
+					oDefaultFormatSettings = null;
+				});
+
+				/*
+				 * Load default format settings from UI5 Core Configuration
+				 */
+				oSettings.calendar = Core.getConfiguration().getCalendarType();
+				oSettings.datePattern = oCoreSettings.getDatePattern('medium');
+				oSettings.timePattern = oCoreSettings.getTimePattern('medium');
+				oSettings.delimiter = !!oCoreSettings.getNumberSymbol('group');
+
+				/* Post processing: lower case, pattern specific replacement */
+				if (typeof oSettings.datePattern === 'string') {
+					oSettings.datePattern = oSettings.datePattern.toLowerCase();
+				}
+
+				/*
+				 * 12 hour clock period adjustment
+				 * https://unicode.org/reports/tr35/tr35-dates.html#dfst-period
+				 */
+				if (typeof oSettings.timePattern === 'string') {
+					oSettings.timePattern = oSettings.timePattern.toLowerCase().replace(/ a+/, ' AM/PM');
+				}
+
+				if (oSettings.datePattern && oSettings.timePattern) {
+					oSettings.dateTimePattern = oSettings.datePattern + ' ' + oSettings.timePattern;
+				}
+
+				oDefaultFormatSettings = oSettings;
+			}
+
+			return oDefaultFormatSettings;
 		}
 	};
 

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

@@ -17,7 +17,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.102.2
+	 * @version 1.104.0
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument

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.102.2")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.104.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.102.2',
+		 *         version: '1.104.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.102.2
+		 * @version 1.104.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.102.2
+	 * @version 1.104.0
 	 *
 	 * @private
 	 * @since 1.50.0

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

@@ -21,7 +21,7 @@
 			<CheckBox id="exportSettingsDialog-includeFilterSettings" selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/fileType', formatter: '.isXLSX'}"/>
 			<CheckBox id="exportSettingsDialog-includeFilterSettings-PDF" enabled="{/capabilities/PDF/CoverPage}"  selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/fileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_FILTER_SETTINGS}"/>
 			<CheckBox id="exportSettingsDialog-pdfArchive" enabled="{/capabilities/PDF/ArchiveFormat}" selected="{/pdfArchive}" text="{i18n>ARCHIVE_FORMAT}"  visible="{path:'/fileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_ARCHIVE_FORMAT}"/>
-			<CheckBox id="exportSettingsDialog-splitCells" selected="{/splitCells}" text="{i18n>SPLIT_CELLS}" visible="{path:'/fileType', formatter: '.isXLSX'}"/> <!-- Will be hidden in case of PDF because it needs to be always true -->
+			<CheckBox id="exportSettingsDialog-splitCells" selected="{/splitCells}" text="{i18n>SPLIT_CELLS}" visible="{path:'/fileType', formatter: '.isXLSX'}"/> <!-- Will be hidden in case of PDF because it needs to be always true  and is applied implicitly -->
 			<CheckBox id="exportSettingsDialog-addDateTime" selected="{/addDateTime}" text="{i18n>ADD_DATE_TIME}" visible="false"/>
 
 			<!-- PDF Specific settings -->