@sapui5/sap.ui.export 1.96.2 → 1.98.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.96.2",
+	"version": "1.98.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

@@ -4,8 +4,8 @@
 	<name>sap.ui.export</name>
 	<vendor>SAP SE</vendor>
 	<copyright>SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.</copyright>
-	<version>1.96.2</version>
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.</copyright>
+	<version>1.98.0</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 
 sap.ui.define([
@@ -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.96.2
+	 * @version 1.98.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 
 /**

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define([
 	'sap/ui/core/library',
@@ -25,7 +25,8 @@ sap.ui.define([
 ], function(coreLibrary, mLibrary, library, Core, Log, uid, Item, syncStyleClass, JSONModel, Button, CheckBox, Dialog, Input, Label, Select, Text, VBox, VersionInfo, openWindow) {
 	'use strict';
 
-	/*global Blob, MouseEvent, FileReader, URL */
+	// eslint-disable-next-line
+	/* global Blob, MouseEvent, FileReader, URL */
 
 	// Shortcuts
 	var ButtonType = mLibrary.ButtonType;
@@ -93,7 +94,7 @@ sap.ui.define([
 	 * Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.96.2
+	 * @version 1.98.0
 	 *
 	 * @since 1.59
 	 * @name sap.ui.export.ExportUtils
@@ -130,6 +131,17 @@ sap.ui.define([
 			return sUrl;
 		},
 
+		/**
+		 * Ensures that the URL is absolute, so that it can
+		 * be used within a Web Worker.
+		 *
+		 * @param {string} url Relative URL that needs to be processed for Web Worker usage
+		 * @returns {string|any} Returns the absolute URL or the original value in case there is no URL provided
+		 */
+		normalizeUrl: function(url) {
+			return url ? new URL(url, document.baseURI).toString() : url;
+		},
+
 		/**
 		 * Creates the Export settings dialog that can be used for configuring the spreadsheet before exporting.
 		 *
@@ -198,6 +210,8 @@ sap.ui.define([
 										labelFor: sDialogId + '-fileType',
 										visible: !!bDevMode
 									}),
+									// sap.m.Select control disabled as there is only 1 option for now
+									// control must be enabled when more file types are supported
 									new Select({
 										id: sDialogId + '-fileType',
 										width: '100%',
@@ -276,7 +290,7 @@ sap.ui.define([
 		 * Combines the filter operator with the value and
 		 * creates a textual representation.
 		 *
-		 * @param oFilter {Object} A single filter object according to ListBinding#getFilterInfo
+		 * @param {Object} oFilter A single filter object according to ListBinding#getFilterInfo
 		 * @returns {string} Textual representation of the filter operation and value
 		 * @private
 		 */
@@ -306,7 +320,7 @@ sap.ui.define([
 		/**
 		 * Parse filter tree recursively.
 		 *
-		 * @param oFilter {Object} Filter configuration according to ListBinding#getFilterInfo
+		 * @param {Object} oFilter Filter configuration according to ListBinding#getFilterInfo
 		 * @returns {Array} Array of filter entries
 		 * @private
 		 */
@@ -329,7 +343,7 @@ sap.ui.define([
 		 * Parses a logical filter and concatenates all
 		 * subsequent filters.
 		 *
-		 * @param oLogicalFilter {Object} Filter object according to ListBinding#getFilterInfo
+		 * @param {Object} oLogicalFilter Filter object according to ListBinding#getFilterInfo
 		 * @returns {Array} Array containing all filter settings
 		 * @private
 		 */
@@ -370,7 +384,7 @@ sap.ui.define([
 		 * Parses a binary filter and returns an Array that
 		 * contains this explicit filter item.
 		 *
-		 * @param oBinaryFilter {Object} Filter object according to ListBinding#getFilterInfo
+		 * @param {Object} oBinaryFilter Filter object according to ListBinding#getFilterInfo
 		 * @returns {Array} Array containing this explicit filter setting
 		 * @private
 		 */
@@ -390,7 +404,7 @@ sap.ui.define([
 		 * Parses an unary filter and returns a modified
 		 * subsequent filter.
 		 *
-		 * @param oUnaryFilter {Object} Filter object according to ListBinding#getFilterInfo
+		 * @param {Object} oUnaryFilter Filter object according to ListBinding#getFilterInfo
 		 * @returns {Array} Array containing the modified subsequent filter
 		 * @private
 		 */
@@ -411,7 +425,7 @@ sap.ui.define([
 		 * Parses an call filter and returns an Array containing
 		 * this particular filter configuration.
 		 *
-		 * @param oCallFilter {Object} Filter object according to ListBinding#getFilterInfo
+		 * @param {Object} oCallFilter Filter object according to ListBinding#getFilterInfo
 		 * @returns {Array} Array containing this explicit filter setting
 		 * @private
 		 */
@@ -432,11 +446,8 @@ sap.ui.define([
 		 * configuration in a format that can be attached to
 		 * a sap.ui.export.Spreadsheet instance.
 		 *
-		 * @param oBinding {sap.ui.model.ListBinding | sap.ui.model.TreeBinding}
-		 * ListBinding or TreeBinding instance
-		 *
-		 * @param fnCallback {function}
-		 * Callback function that is used to resolve the columns names according to their property.
+		 * @param {sap.ui.model.ListBinding | sap.ui.model.TreeBinding} oBinding ListBinding or TreeBinding instance
+		 * @param {function} fnCallback Callback function that is used to resolve the columns names according to their property
 		 *
 		 * @returns {Promise}
 		 * Promise, which resolves with an object containing a name
@@ -643,7 +654,7 @@ sap.ui.define([
 				throw new Error(CLASS_NAME + ': dataSource has not been specified');
 			}
 
-			mDataSource.type = mDataSource.type || 'odata';
+			mDataSource.type = typeof mDataSource.type === 'string' && mDataSource.type.toLowerCase() || 'odata';
 
 			if (mDataSource.type === 'array' && !Array.isArray(mDataSource.data)) {
 				Log.warning(CLASS_NAME + ': Defined type does not match the provided data');
@@ -653,8 +664,19 @@ sap.ui.define([
 				mDataSource.count = mDataSource.data.length;
 			}
 
-			if (mDataSource.type === 'odata' && (typeof mDataSource.dataUrl !== 'string' || mDataSource.dataUrl.length === 0)) {
-				throw new Error(CLASS_NAME + ': Unable to export data. No dataUrl provided.');
+			if (mDataSource.type === 'odata') {
+				if (typeof mDataSource.dataUrl !== 'string' || mDataSource.dataUrl.length === 0) {
+					throw new Error(CLASS_NAME + ': Unable to export data. No dataUrl provided.');
+				}
+
+				// Ensure absolute URLs for dataUrl and serviceUrl
+				if (mDataSource.dataUrl) {
+					mDataSource.dataUrl = Utils.normalizeUrl(mDataSource.dataUrl);
+				}
+
+				if (mDataSource.serviceUrl) {
+					mDataSource.serviceUrl = Utils.normalizeUrl(mDataSource.serviceUrl);
+				}
 			}
 
 			if (typeof mDataSource.count !== 'number' || mDataSource.count < 0 || isNaN(mDataSource.count) || mDataSource.count % 1 !== 0) {
@@ -889,7 +911,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.96.2")
+		 * @param {string} [oContext.version] Application version (default: "1.98.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
@@ -993,7 +1015,7 @@ sap.ui.define([
 		 * @param {Object} oCustomizing General export customizing
 		 * @param {Object} oCustomizing.currency Currency specific customizing
 		 * @param {Object} oCustomizing.unit Unit of measure specific customizing
-		 * @param {string} sProperty Name of the property
+		 * @param {string} sProperty Key property of the specific customizing setting
 		 * @private
 		 */
 		_validateScaleCustomizing: function(oCustomizing, sProperty) {

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 
 sap.ui.define([
@@ -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.96.2
+	 * @version 1.98.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.PortableDocument
@@ -96,19 +96,26 @@ sap.ui.define([
 		 */
 		if (typeof oBinding.getDownloadUrl === 'function') {
 			var oModel = oBinding.getModel(),
-				sDataUrl = ExportUtils.interceptUrl(oBinding.getDownloadUrl('json')),
+				sDataUrl = ExportUtils.interceptUrl(oBinding.getDownloadUrl('pdf')),
 				sServiceUrl = ExportUtils.interceptUrl(oModel.sServiceUrl),
 				bV4ODataModel = oModel.isA('sap.ui.model.odata.v4.ODataModel');
 
 			var oDataUrl = new URL(sDataUrl, document.baseURI);
 			oDataUrl.hash = '';
-			oDataUrl.search = '';
+
+			// Reference the Model for later use
+			this._oModel = oModel;
+
+			/* Remove $format system query option because it would overwrite the "Accept" header */
+			oDataUrl.search = oDataUrl.search.split('&').filter(function(val) {
+				return val.indexOf('$format') == -1;
+			}).join('&');
 
 			oDataSource = {
 				type: 'odata',
 				version: bV4ODataModel ? 4 : 2,
 				dataUrl: oDataUrl.toString(),
-				serviceUrl: sServiceUrl.split('/').slice(0, -4).join("/") + "/iwbep/common/0001/", // Requires the serviceUrl to end with a /
+				serviceUrl: sServiceUrl.split('/').slice(0, -5).join('/') + '/default/iwbep/common/0001/', // Requires the serviceUrl to end with a /
 				headers: bV4ODataModel ?  oModel.getHttpHeaders(true) : oModel.getHeaders()
 			};
 		}
@@ -134,6 +141,10 @@ sap.ui.define([
 				"Orientation": "LANDSCAPE",
 				"FontSize": 12
 			},
+			"Signature": {
+				"DoSign": true,
+				"Reason": ""
+			},
 			"CoverPage": [],
 			"TableColumns": []
 		};
@@ -161,7 +172,7 @@ sap.ui.define([
 		/* Add columns */
 		oWorkbook.columns.forEach(function(oColumn){
 			oDocumentDescription["TableColumns"].push({
-				"Name": oColumn.property,
+				"Name": Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property,
 				"Header": oColumn.label
 			});
 		});
@@ -169,6 +180,33 @@ sap.ui.define([
 		return oDocumentDescription;
 	};
 
+	/**
+	 * Returns the name of the EntitySet that is being used with the given OData version.
+	 *
+	 * @param {Object} mDataSource DataSource object containing information about OData version
+	 * @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
+
+		return version == 4 ? 'MyDocumentDescriptions' : 'SAP__MyDocumentDescriptions';
+	};
+
+	/**
+	 * Returns the specific ODataModel that is being used for binding to the DocumentDescription EntitySet
+	 *
+	 * @param {Object} oDataSource DataSource settings of the export configuration
+	 * @returns {ODataModel} ODataModel, either V2 or V4.
+	 */
+	PortableDocument.prototype._getModel = function(oDataSource) {
+		var version = oDataSource.version || 2;
+
+		return version === 4 ? new ODataModel({
+			serviceUrl: oDataSource.serviceUrl,
+			synchronizationMode: 'None'
+		}) : this._oModel;
+	};
+
 	/**
 	 * Applies default settings to the export configuration.
 	 *
@@ -191,31 +229,72 @@ sap.ui.define([
 		});
 	};
 
-	PortableDocument.prototype.createBuildPromise = function(mSettings) {
-		var that = this;
-		return new Promise(function(fnResolve, fnReject) {
-			var oBinding, oDocumentDescription, oModel;
+	/**
+	 * Sends a POST request to the GW service which creates the
+	 * DocumentDescription. The corresponding Id is assigned by
+	 * the backend and passed to the event handler functions.
+	 *
+	 * @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
+	 */
+	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource, fnSuccess, fnError) {
+		var oBinding, oModel, sPath;
 
-			oDocumentDescription = that._createDocumentDescription(mSettings.workbook);
+		oModel = this._getModel(oDataSource);
+		sPath = '/' + this._getEntitySetName(oDataSource);
 
-			/* Create COMMON service model and bind to MyDocumentDescription entity */
-			oModel = new ODataModel({
-				serviceUrl: mSettings.dataSource.serviceUrl,
-				synchronizationMode: 'None'
-			});
+		if (!oModel || !oModel.isA(['sap.ui.model.odata.v4.ODataModel', 'sap.ui.model.odata.v2.ODataModel'])) {
+			fnError('Unsupported Model');
+		}
+
+		if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
+			oBinding = oModel.bindList(sPath);
 
-			oBinding = oModel.bindList('/MyDocumentDescriptions');
 			oBinding.attachCreateCompleted(function(oEvent) {
 				var success = oEvent.getParameter('success');
 
 				if (success) {
-					fnResolve(oEvent.getParameter('context').getObject()['Id']);
+					fnSuccess(oEvent.getParameter('context').getObject()['Id']);
 				} else {
-					fnReject();
+					fnError();
 				}
 			});
 
 			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);
+				}
+			});
+		}
+	};
+
+	/**
+	 * Triggers the export process and returns a Promise the
+	 * gets resolved as soon as the export is finished.
+	 *
+	 * @param {Object} mSettings Export settings
+	 * @returns {Promise} Promise that is being resolved as soon as the PDF export is finished
+	 */
+	PortableDocument.prototype.createBuildPromise = function(mSettings) {
+		var that = this;
+
+		return new Promise(function(fnResolve, fnReject) {
+			var oDocumentDescription;
+
+			oDocumentDescription = that._createDocumentDescription(mSettings.workbook);
+			that.postDocumentDescription(oDocumentDescription, mSettings.dataSource, fnResolve, fnReject);
 
 		}).then(function(sDocumentDescriptionId) {
 			return that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
@@ -280,5 +359,19 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Cleans up the internal structures and removes all event handlers.
+	 *
+	 * The object must not be used anymore after destroy was called.
+	 *
+	 * @see sap.ui.export.ExportBase#destroy
+	 * @public
+	 */
+	PortableDocument.prototype.destroy = function() {
+		ExportBase.prototype.destroy.apply(this, arguments);
+
+		this._oModel = null;
+	};
+
 	return PortableDocument;
 });

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

@@ -1,6 +1,6 @@
 /*!
  * SAPUI5
- * (c) Copyright 2009-2021 SAP SE. All rights reserved.
+ * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 
 sap.ui.define([
@@ -15,6 +15,7 @@ sap.ui.define([
 	function(Core, ExportDialog, ExportBase, Device, SpreadsheetExport, Log, ExportUtils) {
 		'use strict';
 
+		// eslint-disable-next-line
 		/* global Blob */
 
 		var CLASS_NAME = 'sap.ui.export.Spreadsheet';
@@ -82,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.96.2")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.98.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>
@@ -165,7 +166,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.96.2',
+		 *         version: '1.98.0',
 		 *         title: 'Some random title',
 		 *         modifiedBy: 'John Doe',
 		 *         metaSheetName: 'Custom metadata',
@@ -277,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.96.2
+		 * @version 1.98.0
 		 *
 		 * @since 1.50
 		 * @name sap.ui.export.Spreadsheet