@sapui5/sap.ui.export 1.110.0 → 1.111.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.110.0",
+	"version": "1.111.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.110.0</version>
+	<version>1.111.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.110.0
+	 * @version 1.111.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase
@@ -36,9 +36,11 @@ sap.ui.define([
 	 */
 	var ExportBase = EventProvider.extend('sap.ui.export.ExportBase', {
 
-		constructor: function(mSettings) {
+		constructor: function(mSettings, mCapabilities) {
 			EventProvider.call(this, mSettings);
 
+			this._mCapabilities = mCapabilities || {};
+
 			/* Default settings */
 			this._mSettings = {
 				fileName: 'Export'
@@ -121,6 +123,8 @@ sap.ui.define([
 		EventProvider.prototype.destroy.apply(this, arguments);
 
 		this.cancel();
+		this._mSettings = null;
+		this._mCapabilities = null;
 		this.bIsDestroyed = true;
 	};
 

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.110.0
+	 * @version 1.111.0
 	 *
 	 * @since 1.102
 	 * @alias sap.ui.export.ExportHandler
@@ -56,9 +56,9 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * @param {sap.ui.base.Event} oEvent
 	 * @param {sap.ui.base.EventProvider} oEvent.getSource
 	 * @param {object} oEvent.getParameters
-	 * @param {object} oEvent.getParameter.exportSettings Contains export-related configuration
-	 * @param {object} oEvent.getParameter.userExportSettings User specific settings from the "Export As" dialog
-	 * @param {sap.ui.export.util.Filter[]} oEvent.getParameter.filterSettings Array of filter settings for the exported data
+	 * @param {object} oEvent.getParameters.exportSettings Contains export-related configuration
+	 * @param {object} oEvent.getParameters.userExportSettings User specific settings from the "Export As" dialog
+	 * @param {sap.ui.export.util.Filter[]} oEvent.getParameters.filterSettings Array of filter settings for the exported data
 	 *
 	 * @since 1.102
 	 * @public
@@ -244,7 +244,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 
 		return Promise.all([
 			ExportUtils.getResourceBundle(),
-			ExportUtils.getExportInstance(mExportSettings)
+			ExportUtils.getExportInstance(mExportSettings, this._mCapabilities)
 		]).then(function(aResolve) {
 			var oResourceBundle = aResolve[0];
 			var oExportInstance = aResolve[1];

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

@@ -133,7 +133,7 @@ sap.ui.define([
 	 * Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 *
 	 * @since 1.59
 	 * @name sap.ui.export.ExportUtils
@@ -236,10 +236,13 @@ sap.ui.define([
 				if (typeof bRemoteDestination === 'object') {
 					fnCallback = oOpener;
 					oOpener = bRemoteDestination;
+					bRemoteDestination = undefined;
 				} else if (typeof bRemoteDestination === 'function') {
 					fnCallback = bRemoteDestination;
+					bRemoteDestination = undefined;
 				} else if (typeof oOpener === 'function') {
 					fnCallback = oOpener;
+					oOpener = null;
 				}
 
 				oResourceBundlePromise.then(function (oResourceBundle) {
@@ -593,7 +596,7 @@ sap.ui.define([
 
 			aFilters = [];
 
-			if (!oBinding || !(oBinding.isA('sap.ui.model.ListBinding') || !oBinding.isA('sap.ui.model.TreeBinding'))) {
+			if (!oBinding || !oBinding.isA(['sap.ui.model.ListBinding', 'sap.ui.model.TreeBinding'])) {
 				Log.error('A ListBinding or TreeBinding is required for parsing the filter settings');
 				return aFilters;
 			}
@@ -985,14 +988,14 @@ sap.ui.define([
 				if (oColumn.type === EdmType.DateTime) {
 
 					/*
-					 * Apply local time or UTC as fixed timezone
-					 * in case no timezone is defined. This also
+					 * Apply user timezone or UTC as fixed timezone
+					 * in case no timezone was provided. 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';
+						oColumn.timezone = oColumn.utc === false ? Core.getConfiguration().getTimezone() : 'UTC';
 					}
 
 					/* Remove obviously incorrect timezoneProperty settings */
@@ -1030,6 +1033,7 @@ sap.ui.define([
 
 			Utils._validateWorkbookContext(mWorkbook.context);
 			Utils._validateString(mWorkbook, 'hierarchyLevel');
+			Utils._validateString(mWorkbook, 'drillState');
 		},
 
 		/**
@@ -1102,7 +1106,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.110.0")
+		 * @param {string} [oContext.version] Application version (default: "1.111.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
@@ -1248,11 +1252,13 @@ sap.ui.define([
 		 * no specific FileType is defined in the export settings.
 		 *
 		 * @param {object} mSettings Export configuration with optional FileType
-		 * @returns {Promise} A Promise that gets resolved with the requested instance
+		 * @param {object} [mCapabilities] Export Capabilities for all supported types
+		 * @returns {Promise<sap.ui.export.ExportBase>} A Promise that gets resolved with the requested instance
 		 */
-		getExportInstance: function(mSettings) {
+		getExportInstance: function(mSettings, mCapabilities) {
 			var sClassName, sFileType;
 
+			mCapabilities = mCapabilities ? mCapabilities : {};
 			sFileType = typeof mSettings.fileType === 'string' ? mSettings.fileType.toUpperCase() : mSettings.fileType;
 
 			switch (sFileType) {
@@ -1265,7 +1271,7 @@ sap.ui.define([
 
 			return new Promise(function(fnResolve) {
 				sap.ui.require([sClassName], function(ExportClass) {
-					fnResolve(new ExportClass(mSettings));
+					fnResolve(new ExportClass(mSettings, mCapabilities[sFileType]));
 				});
 			});
 		},

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.110.0
+	 * @version 1.111.0
 	 *
 	 * @since 1.96
 	 * @alias sap.ui.export.PortableDocument
@@ -26,9 +26,8 @@ sap.ui.define([
 	 */
 	var PortableDocument = ExportBase.extend('sap.ui.export.PortableDocument', {
 
-		constructor: function(mSettings) {
-			ExportBase.call(this, mSettings);
-
+		constructor: function(mSettings, mCapabilities) {
+			ExportBase.call(this, mSettings, mCapabilities);
 
 			/* Only apply supported properties */
 			['paperSize', 'orientation', 'font', 'fontSize', 'doEnableAccessibility', 'fitToPage', 'signature', 'signatureReason', 'pdfArchive'].forEach(function(sProperty) {
@@ -82,21 +81,9 @@ sap.ui.define([
 	 * @returns {object} - Valid data source configuration built upon the ListBinding
 	 */
 	 PortableDocument.prototype.createDataSourceFromBinding = function(oBinding) {
-
-		/**
-		 * Use empty array as default in case of <code>ListBinding</code> is not of type
-		 * ClientListBinding and does not provide a getDownloadUrl function
-		 */
 		var oDataSource = null;
 
-		/**
-		 * If <code>ClientListBinding</code>, we use the binding path to receive the data from the underlying model
-		 */
-		if (oBinding.isA('sap.ui.model.ClientListBinding')) {
-			Log.error('Unable to create dataSource configuration due to not supported Binding: ' + oBinding.getMetadata().getName());
-		}
-
-		if (oBinding.isA('sap.ui.model.ClientTreeBinding')) {
+		if (oBinding.isA(['sap.ui.model.ClientListBinding', 'sap.ui.model.ClientTreeBinding'])) {
 			Log.error('Unable to create dataSource configuration due to not supported Binding: ' + oBinding.getMetadata().getName());
 		}
 
@@ -124,7 +111,7 @@ sap.ui.define([
 				type: 'odata',
 				version: bV4ODataModel ? 4 : 2,
 				dataUrl: oDataUrl.toString(),
-				serviceUrl: sServiceUrl.split('/').slice(0, -5).join('/') + '/default/iwbep/common/0001/', // Requires the serviceUrl to end with a /
+				serviceUrl: this._resolveServiceUrl(sServiceUrl),
 				headers: bV4ODataModel ?  oModel.getHttpHeaders(true) : oModel.getHeaders()
 			};
 		}
@@ -132,6 +119,33 @@ sap.ui.define([
 		return oDataSource;
 	};
 
+	/**
+	 * Resolves the service URL that contains the DocumentDescription
+	 * relative to the current service URL. The returned service URL
+	 * always ends with an forward slash.
+	 *
+	 * @param {string} sCurrentServiceUrl URL of the data service
+	 * @returns {string} Converted service url
+	 */
+	PortableDocument.prototype._resolveServiceUrl = function(sCurrentServiceUrl) {
+		var isRelative, sReference;
+
+		sCurrentServiceUrl += sCurrentServiceUrl.endsWith('/') ? '' : '/';
+		isRelative = /^[\./]/.test(sCurrentServiceUrl);
+		sReference = this._mCapabilities.DocumentDescriptionReference;
+
+		if (typeof sReference !== 'string') {
+			return sCurrentServiceUrl.split('/').slice(0, -5).join('/') + '/default/iwbep/common/0001/';
+		}
+
+		sReference = sReference.endsWith('/') ? sReference : sReference.split('/').slice(0, -1).join('/') + '/';
+		var oUrl = new URL(sCurrentServiceUrl, document.baseURI);
+
+		oUrl = new URL(sReference, oUrl.href);
+
+		return isRelative ? oUrl.pathname : oUrl.href;
+	};
+
 	/**
 	 * Creates the DocumentDescription based on the given export
 	 * settings and assigns a unique Id to it.
@@ -167,6 +181,13 @@ sap.ui.define([
 			"TableColumns": []
 		};
 
+		if (oWorkbook.hierarchyLevel && oWorkbook.drillState && window.location.href.includes('sap-ui-xx-enable-tree-export')) {
+			oDocumentDescription.Hierarchy = {
+				"DistanceFromRootElement": oWorkbook.hierarchyLevel,
+				"DrillStateElement": oWorkbook.drillState
+			};
+		}
+
 		oMetaInfo = oWorkbook.context.metainfo;
 
 		/* Add metaInfo to CoverPage */
@@ -226,9 +247,15 @@ sap.ui.define([
 	 * @returns {string} Name of the EntitySet according to the OData version
 	 */
 	PortableDocument.prototype._getEntitySetName = function(mDataSource) {
-		var version = mDataSource && mDataSource.version || 2; // Use OData V2 by default
+		var sCollectionName, iVersion;
+
+		iVersion = mDataSource && mDataSource.version || 2; // Use OData V2 by default
+
+		if (this._mCapabilities && typeof this._mCapabilities.DocumentDescriptionCollection === 'string') {
+			sCollectionName = this._mCapabilities.DocumentDescriptionCollection;
+		}
 
-		return version == 4 ? 'MyDocumentDescriptions' : 'SAP__MyDocumentDescriptions';
+		return sCollectionName || (iVersion == 4 ? 'MyDocumentDescriptions' : 'SAP__MyDocumentDescriptions');
 	};
 
 	/**
@@ -238,9 +265,9 @@ sap.ui.define([
 	 * @returns {ODataModel} ODataModel, either V2 or V4.
 	 */
 	PortableDocument.prototype._getModel = function(oDataSource) {
-		var version = oDataSource.version || 2;
+		var iVersion = oDataSource.version || 2;
 
-		return version === 4 ? new ODataModel({
+		return iVersion === 4 ? new ODataModel({
 			serviceUrl: oDataSource.serviceUrl,
 			synchronizationMode: 'None'
 		}) : this._oModel;

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

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

@@ -5,14 +5,14 @@
 			<Input id="exportSettingsDialog-fileName" value="{/fileName}" liveChange=".onFileNameChange" class="sapUiTinyMarginBottom"/>
 
 			<Label text="{i18n>SELECT_FORMAT}" labelFor="exportSettingsDialog-fileType"/>
-			<Select id="exportSettingsDialog-fileType" selectedKey="{/fileType}" items="{path: '/fileTypeCollection'}" change=".onFileTypeChange" width="100%" class="sapUiTinyMarginBottom">
+			<Select id="exportSettingsDialog-fileType" selectedKey="{/fileType}" items="{/fileTypeCollection}" change=".onFileTypeChange" width="100%" class="sapUiTinyMarginBottom">
 				<items>
 					<core:Item key="{key}" text="{text}"/>
 				</items>
 			</Select>
 
 			<Label text="{i18n>SELECT_DESTINATION}" labelFor="exportSettingsDialog-destination" visible="{path: '/destinationCollection', formatter: '.hasDestinations'}"/>
-			<Select id="exportSettingsDialog-destination" selectedKey="{/destination}" items="{path: '/destinationCollection'}" visible="{path: '/destinationCollection', formatter: '.hasDestinations'}" enabled="{path: '/fileType', formatter: '.isDestinationEnabled'}" width="100%" class="sapUiTinyMarginBottom">
+			<Select id="exportSettingsDialog-destination" selectedKey="{/destination}" items="{/destinationCollection}" visible="{path: '/destinationCollection', formatter: '.hasDestinations'}" enabled="{path: '/fileType', formatter: '.isDestinationEnabled'}" width="100%" class="sapUiTinyMarginBottom">
 				<items>
 					<core:Item key="{key}" text="{text}"/>
 				</items>
@@ -26,14 +26,14 @@
 
 			<!-- PDF Specific settings -->
 			<Label text="{i18n>PAPER_SIZE}" labelFor="exportSettingsDialog-papersize" visible="{path:'/fileType', formatter: '.isPDF'}"/>
-			<Select id="exportSettingsDialog-papersize" selectedKey="{/paperSize}" items="{path: '/paperSizeCollection'}" width="100%" visible="{path:'/fileType', formatter: '.isPDF'}" class="sapUiTinyMarginBottom">
+			<Select id="exportSettingsDialog-papersize" selectedKey="{/paperSize}" items="{/paperSizeCollection}" width="100%" visible="{path:'/fileType', formatter: '.isPDF'}" class="sapUiTinyMarginBottom">
 				<items>
 					<core:Item key="{key}" text="{text}"/>
 				</items>
 			</Select>
 
 			<Label text="{i18n>ORIENTATION}" labelFor="exportSettingsDialog-orientation" visible="{path:'/fileType', formatter: '.isPDF'}"/>
-			<Select id="exportSettingsDialog-orientation" selectedKey="{/orientation}" items="{path: '/orientationCollection'}" width="100%" visible="{path:'/fileType', formatter: '.isPDF'}" class="sapUiTinyMarginBottom">
+			<Select id="exportSettingsDialog-orientation" selectedKey="{/orientation}" items="{/orientationCollection}" width="100%" visible="{path:'/fileType', formatter: '.isPDF'}" class="sapUiTinyMarginBottom">
 				<items>
 					<core:Item key="{key}" text="{text}"/>
 				</items>

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

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * @namespace
 	 * @alias sap.ui.export
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 * @public
 	 */
 
@@ -33,7 +33,7 @@ sap.ui.define([
 		interfaces: [],
 		controls: [],
 		elements: [],
-		version: "1.110.0"
+		version: "1.111.0"
 	});
 
 

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

@@ -15,16 +15,17 @@ sap.ui.define(['sap/ui/base/Object'], function(BaseObject) {
 	 * @param {boolean} [vRawFilter.exclude] Defines whether it is an exclude filter
 	 * @param {string} [sLabel] Optional label for the filter property
 	 *
-	 * @constructor The <code>sap.ui.export.util.Filter</code> class represents filter settings that are used for the export.
+	 * @class The <code>sap.ui.export.util.Filter</code> class represents filter settings that are used for the export.
 	 * It provides the capability to have a visual representation of the filters in the exported document and offers
 	 * convenience functions like <code>sap.ui.export.util.Filter#setType</code> to improve the result.
 	 *
 	 * @author SAP SE
-	 * @version 1.110.0
+	 * @version 1.111.0
 	 *
 	 * @since 1.110
 	 * @name sap.ui.export.util.Filter
 	 * @extends sap.ui.base.Object
+	 * @constructor
 	 * @public
 	 */
 	var Filter = BaseObject.extend('sap.ui.export.util.Filter', {