@sapui5/sap.ui.export 1.117.2 → 1.119.0

package/package.json

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

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

@@ -16,7 +16,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.117.2
+	 * @version 1.119.0
 	 *
 	 * @since 1.102
 	 * @alias sap.ui.export.ExportHandler

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

@@ -4,19 +4,20 @@
  */
 sap.ui.define([
 	'./library',
+	'./util/Filter',
 	'sap/base/Log',
 	'sap/ui/core/Core',
 	'sap/ui/core/Fragment',
+	'sap/ui/core/format/DateFormat',
 	'sap/ui/core/library',
 	'sap/ui/core/syncStyleClass',
-	'sap/ui/export/util/Filter',
+	'sap/ui/core/LocaleData',
 	'sap/ui/model/json/JSONModel',
 	'sap/ui/model/resource/ResourceModel',
+	'sap/ui/performance/trace/FESRHelper',
 	'sap/ui/util/openWindow',
-	'sap/ui/VersionInfo',
-	'sap/ui/core/format/DateFormat',
-	"sap/ui/performance/trace/FESRHelper"
-], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, Filter, JSONModel, ResourceModel, openWindow, VersionInfo, DateFormat, FESRHelper) {
+	'sap/ui/VersionInfo'
+], function(library, Filter, Log, Core, Fragment, DateFormat, coreLibrary, syncStyleClass, LocaleData, JSONModel, ResourceModel, FESRHelper, openWindow, VersionInfo) {
 	'use strict';
 
 	// eslint-disable-next-line
@@ -134,7 +135,7 @@ sap.ui.define([
 	 * @class Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.117.2
+	 * @version 1.119.0
 	 *
 	 * @since 1.59
 	 * @alias sap.ui.export.ExportUtils
@@ -758,7 +759,7 @@ sap.ui.define([
 			link = document.createElementNS('http://www.w3.org/1999/xhtml', 'a');
 			downloadSupported = 'download' in link;
 
-			/* Try ObjectURL Chrome, Firefox, Opera, Android, Safari (Desktop ab 10.1) */
+			/* Try ObjectURL Chrome, Firefox, Opera, Android, Safari (MacOS 10.1, iOS 13) */
 			if (downloadSupported) {
 				fnSave = function(data, fileName) {
 					link.download = fileName;
@@ -767,7 +768,7 @@ sap.ui.define([
 				};
 			}
 
-			/* In case of iOS Safari, MacOS Safari */
+			/* In case of iOS Safari, MacOS Safari (legacy) */
 			if (typeof fnSave === 'undefined') {
 				fnSave = function(data) {
 					var reader = new FileReader();
@@ -1004,10 +1005,23 @@ sap.ui.define([
 					sWidth = iWidth.toLowerCase();
 					iWidth = parseFloat(sWidth);
 
+					/*
+					* We need to convert the column width (rem/px) into
+					* export specific character amount. This calculation
+					* is based on Office Open SpreadsheetML
+					* (ISO/IEC 29500-1:2016) section 18.3.1.13
+					*
+					* The following fixed values are:
+					* 16: Amount of pixels per rem
+					* 5: Padding and grid pixels
+					* 8: Maxium pixel width per character
+					* 100: Formula specific constant
+					* 0.5: Formula specific constant
+					*/
 					if (sWidth.indexOf('em') > 0) {
-						iWidth = iWidth * 2;
+						iWidth = Math.floor((((iWidth * 16) - 5) / 8 * 100) + 0.5) / 100;
 					} else if (sWidth.indexOf('px') > 0) {
-						iWidth = iWidth / 8;
+						iWidth = Math.floor(((iWidth - 5) / 8 * 100) + 0.5) / 100;
 					}
 				}
 
@@ -1200,7 +1214,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.117.2")
+		 * @param {string} [oContext.version] Application version (default: "1.119.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
@@ -1608,6 +1622,23 @@ sap.ui.define([
 			}
 
 			return oDefaultFormatSettings;
+		},
+
+		/**
+		 * Returns a map of translated timezone texts where each key
+		 * represents a IANA timezone id. The translated name is
+		 * according to the current UI5 Locale.
+		 *
+		 * @returns {object} Map of timezone translations
+		 *
+		 * @static
+		 * @private
+		 */
+		getTimezoneTranslations: function() {
+			const oLocale = Core.getConfiguration().getLocale();
+			const oLocaleData = LocaleData.getInstance(oLocale);
+
+			return oLocaleData.getTimezoneTranslations();
 		}
 	};
 

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

@@ -15,13 +15,14 @@ sap.ui.define([
 ], function(Log, Core, ExportBase, ExportUtils, Library, ODataModel, ExportDialog, BusyDialog) {
 	'use strict';
 
-	var FileType = Library.FileType;
+	const FileType = Library.FileType;
+	const EdmType = Library.EdmType;
 
 	/**
 	 * @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.117.2
+	 * @version 1.119.0
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument
@@ -252,11 +253,25 @@ sap.ui.define([
 
 				return sProperty === sOtherProperty;
 			}) === iIndex;
-		}).forEach(function(oColumn) {
-			oDocumentDescription["TableColumns"].push({
-				"Name": Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property,
-				"Header": oColumn.label
-			});
+		}).forEach((oColumnSettings) => {
+			const oColumn = {
+				"Name": Array.isArray(oColumnSettings.property) ? oColumnSettings.property[0] : oColumnSettings.property,
+				"Header": oColumnSettings.label
+			};
+
+			if (this._mCapabilities.IANATimezoneFormat && oColumnSettings.type === EdmType.DateTime) {
+				oColumn.Format = {
+					DisplayFormat: mSettings.dataSource.version == 2 ? "IANATIMEST" : "IANA-Timestamp"
+				};
+
+				if (oColumnSettings.timezoneProperty) {
+					oColumn.Format.IANATimezoneProperty = oColumnSettings.timezoneProperty;
+				} else if (oColumnSettings.timezone) {
+					oColumn.Format.IANATimezone = oColumnSettings.timezone;
+				}
+			}
+
+			oDocumentDescription.TableColumns.push(oColumn);
 		});
 
 		return oDocumentDescription;

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

@@ -4,16 +4,16 @@
  */
 
 sap.ui.define([
-		'sap/ui/core/Core',
+		'./library',
+		'./ExportBase',
 		'./ExportDialog',
-		'sap/ui/export/ExportBase',
-		'sap/ui/Device',
-		'sap/ui/export/SpreadsheetExport',
+		'./ExportUtils',
+		'./SpreadsheetExport',
 		'sap/base/Log',
-		'sap/ui/export/ExportUtils',
-		'sap/ui/export/library'
+		'sap/ui/core/Core',
+		'sap/ui/Device'
 	],
-	function(Core, ExportDialog, ExportBase, Device, SpreadsheetExport, Log, ExportUtils, Library) {
+	function(Library, ExportBase, ExportDialog, ExportUtils, SpreadsheetExport, Log, Core, Device) {
 		'use strict';
 
 		// eslint-disable-next-line
@@ -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.117.2")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.119.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>
@@ -167,7 +167,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.117.2',
+		 *         version: '1.119.0',
 		 *         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.117.2
+		 * @version 1.119.0
 		 *
 		 * @since 1.50
 		 * @alias sap.ui.export.Spreadsheet
@@ -305,7 +305,7 @@ sap.ui.define([
 					}
 				}.bind(this));
 
-				this.codeListsPromise = this.codeListsPromise instanceof Promise ? this.codeListsPromise : Promise.resolve();
+				this.codeListsPromise = this.codeListsPromise instanceof Promise ? this.codeListsPromise : Promise.resolve([null, null]);
 			}
 		});
 
@@ -333,13 +333,36 @@ sap.ui.define([
 		 * @param {object} mParameters - Export parameters object
 		 * @returns {Promise} Promise object
 		 *
+		 * @async
 		 * @private
 		 */
-		Spreadsheet.prototype.setDefaultExportSettings = function(mParameters) {
-			var sCurrencyCode, mCurrencySettings, mUnitSettings;
+		Spreadsheet.prototype.setDefaultExportSettings = async function(mParameters) {
+			var mCurrencySettings, mUnitSettings, oWorkbookContext, sCurrencyCode;
+
+			const oResourceBundle = await ExportUtils.getResourceBundle();
+
+			/* Attach timezone customizing */
+			mParameters.customizing.timezone = ExportUtils.getTimezoneTranslations();
+
+			/**
+			 * Check if a document title and a sheet name have been defined in the 'context' settings.
+			 * Otherwise use default resource bundle properties
+			 */
+			oWorkbookContext = mParameters.workbook.context;
+
+			if (!(oWorkbookContext instanceof Object)) {
+				oWorkbookContext = mParameters.workbook.context = {};
+			}
+			if (!oWorkbookContext.title) {
+				oWorkbookContext.title = oResourceBundle.getText('XLSX_DEFAULT_TITLE');
+			}
+			if (!oWorkbookContext.sheetName) {
+				oWorkbookContext.sheetName = oResourceBundle.getText('XLSX_DEFAULT_SHEETNAME');
+			}
 
-			/* Initialize currency customizing for custom currencies and currency code list */
+			/* Initialize currency customizing for currencies and units of measure */
 			mCurrencySettings = mParameters.customizing.currency = {};
+			mUnitSettings = mParameters.customizing.unit = {};
 
 			/* Attach custom currency configuration */
 			var oCustomCurrencies = Core.getConfiguration().getFormatSettings().getCustomCurrencies();
@@ -350,45 +373,17 @@ sap.ui.define([
 				}
 			}
 
-			return this.codeListsPromise.then(function(aCodeLists) {
-				var mCurrencyCodes, mUnitsOfMeasure, sUnitCode;
+			/* Attach CodeLists customizing */
+			let sUnitCode;
+			const [mCurrencyCodes, mUnitsOfMeasure] = await this.codeListsPromise;
 
-				if (!Array.isArray(aCodeLists)) {
-					return;
-				}
-
-				mUnitSettings = mParameters.customizing.unit = {};
-				mCurrencyCodes = aCodeLists[0];
-				mUnitsOfMeasure = aCodeLists[1];
-
-				for (sUnitCode in mCurrencyCodes) {
-					addUnit(sUnitCode, mCurrencyCodes[sUnitCode], mCurrencySettings);
-				}
+			for (sUnitCode in mCurrencyCodes) {
+				addUnit(sUnitCode, mCurrencyCodes[sUnitCode], mCurrencySettings);
+			}
 
-				for (sUnitCode in mUnitsOfMeasure) {
-					addUnit(sUnitCode, mUnitsOfMeasure[sUnitCode], mUnitSettings);
-				}
-			}).then(function() {
-
-				/* Async call to resource bundle */
-				return Core.getLibraryResourceBundle('sap.ui.export', true);
-			}).then(function(oResourceBundle) {
-				var oWorkbookContext = mParameters.workbook.context;
-
-				/**
-				 * Check if a document title and a sheet name have been defined in the 'context' settings.
-				 * Otherwise use default resource bundle properties
-				 */
-				if (!(oWorkbookContext instanceof Object)) {
-					oWorkbookContext = mParameters.workbook.context = {};
-				}
-				if (!oWorkbookContext.title) {
-					oWorkbookContext.title = oResourceBundle.getText('XLSX_DEFAULT_TITLE');
-				}
-				if (!oWorkbookContext.sheetName) {
-					oWorkbookContext.sheetName = oResourceBundle.getText('XLSX_DEFAULT_SHEETNAME');
-				}
-			});
+			for (sUnitCode in mUnitsOfMeasure) {
+				addUnit(sUnitCode, mUnitsOfMeasure[sUnitCode], mUnitSettings);
+			}
 		};
 
 		/**

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