@sapui5/sap.ui.export 1.106.0 → 1.108.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.106.0",
+	"version": "1.108.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.106.0</version>
+	<version>1.108.0</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 
@@ -42,7 +42,7 @@
 		</ownership>
 
 		<thirdparty xmlns="http://www.sap.com/ui5/buildext/thirdparty" >
-			<lib name="JSZip3" displayName="JSZip 3.7.1" version="3.7.1" homepage="https://github.com/Stuk/jszip" id="73555000106100074228">
+			<lib name="JSZip3" displayName="JSZip 3.7.1" npmName="jszip" version="3.7.1" hash="9548550e812008b802e8ea9c94cb4d34" homepage="https://github.com/Stuk/jszip" id="73555000106100074228">
 				<license url="https://github.com/Stuk/jszip/blob/main/LICENSE.markdown" type="MIT"/>
 				<copyright>2009-2016 Stuart Knightley &lt;stuart [at] stuartk.com&gt;</copyright>
 				<pattern>sap/ui/export/js/libs/JSZip3.js</pattern>

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.106.0
+	 * @version 1.108.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase

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

@@ -7,8 +7,16 @@
  * Export progress dialog
  * @private
  */
-sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Button', 'sap/m/ProgressIndicator', 'sap/m/Text', 'sap/m/Link', 'sap/m/VBox', 'sap/m/MessageBox', 'sap/ui/core/format/NumberFormat'],
-		function(coreLibrary, MLibrary, Dialog, Button, ProgressIndicator, Text, Link, VBox, MessageBox, NumberFormat) {
+sap.ui.define([
+	'sap/ui/core/library',
+	'sap/m/library',
+	'sap/m/Dialog',
+	'sap/m/Button',
+	'sap/m/ProgressIndicator',
+	'sap/m/Text',
+	'sap/m/MessageBox',
+	'sap/ui/core/format/NumberFormat'
+], function(coreLibrary, MLibrary, Dialog, Button, ProgressIndicator, Text, MessageBox, NumberFormat) {
 	'use strict';
 
 	var ValueState = coreLibrary.ValueState;
@@ -76,6 +84,7 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 
 					/* Update status text to reflect the current step (bundle instead of fetching data) */
 					if (iPercentage >= 100) {
+						progressIndicator.setState(ValueState.Success);
 						cancelButton.setEnabled(false);
 						oMessage.setText(sMessage || oResourceBundle.getText("PROGRESS_BUNDLE_MSG"));
 					}
@@ -189,14 +198,14 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 		}
 
 		oResourceBundlePromise.then(function(oResourceBundle) {
-			var errorMessage = sMessage || oResourceBundle.getText('PROGRESS_ERROR_DEFAULT');
+			var sErrorMessage = sMessage || oResourceBundle.getText('PROGRESS_ERROR_DEFAULT');
 
 			// Replace technical error message in case of "out of memory"
 			if (sMessage.toLowerCase().indexOf('invalid string length') > -1) {
-				errorMessage = oResourceBundle.getText('MSG_ERROR_OUT_OF_MEMORY');
+				sErrorMessage = oResourceBundle.getText('MSG_ERROR_OUT_OF_MEMORY');
 			}
 
-			MessageBox.error(oResourceBundle.getText("PROGRESS_ERROR_MSG") + "\n\n" + errorMessage, {
+			MessageBox.error(sErrorMessage, {
 				title : oResourceBundle.getText("PROGRESS_ERROR_TITLE")
 			});
 		});

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

@@ -15,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.106.0
+	 * @version 1.108.0
 	 *
 	 * @since 1.102
 	 * @name sap.ui.export.ExportHandler
@@ -26,10 +26,26 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 */
 	var ExportHandler = EventProvider.extend('sap.ui.export.ExportHandler', {
 		constructor: function(mCapabilities) {
+			var that = this;
 			EventProvider.call(this);
 
 			/* Apply default capabilities if nothing is provided */
 			this._mCapabilities = mCapabilities instanceof Object ? mCapabilities : { XLSX: {} };
+
+			/* Activate Google Sheet support */
+			this._initialized = new Promise(function(fnResolve) {
+				that.isGoogleSheetSupported().then(function(bSupported) {
+					if (bSupported) {
+						that._mCapabilities[FileType.GSHEET] = {};
+
+						/* Set cloud default settings */
+						that._mDialogSettings = {
+							destination: Destination.REMOTE,
+							fileType: FileType.GSHEET
+						};
+					}
+				}).finally(fnResolve);
+			});
 		}
 	});
 
@@ -89,6 +105,10 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 		return this.detachEvent('beforeExport', fnHandler, oListener);
 	};
 
+	ExportHandler.prototype.initialized = function() {
+		return this._initialized;
+	};
+
 	/**
 	 * Cleans up the internal structures and removes all event handlers.
 	 *
@@ -105,46 +125,39 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 			this._oModel.destroy();
 		}
 
+		if (this._oFileShareBinding) {
+			this._oFileShareBinding.destroy();
+		}
+
 		this._mCapabilities = null;
 		this._oDataSource = null;
 		this._mDialogSettings = null;
 		this._oModel = null;
+		this._oFileShareBinding = null;
 		this.bIsDestroyed = true;
 	};
 
 	/**
-	 * Loads the FileShareSupport module and requests
-	 * available destinations. If no FileShareSupport
-	 * module is registered or the module does not
-	 * provide a destination, the Promise resolves
-	 * without any result.
+	 * Requests available FileShares and returns a <code>Promise</code> that
+	 * resolves with their Contexts. If the underlying <code>ODataModel</code>
+	 * could not be instantiated the <code>Promise</code> resolves with an
+	 * empty array.
 	 *
-	 * @returns {Promise} A Promise that gets resolved with the FileShareSupport datasource or undefined if there is none
+	 * @returns {Promise<sap.ui.model.odata.v4.Context[]>} <code>Promise</code> that gets resolved with the requested FileShare <code>Context</code> <code>Array</code>
+	 * @private
 	 */
-	ExportHandler.prototype.fetchDataSource = function() {
-		var that = this;
-		var sFileShareSupportModuleName;
-
-		if (this._oDataSource) {
-			return Promise.resolve(this._oDataSource);
-		}
-
-		sFileShareSupportModuleName = Core.getConfiguration().getFileShareSupport();
+	ExportHandler.prototype.getFileShareContexts = function() {
+		return this.getFileShareModel().then(function(oModel) {
+			if (!oModel) {
+				return Promise.resolve([]);
+			}
 
-		if (!sFileShareSupportModuleName) {
-			return Promise.resolve();
-		}
+			if (!this._oFileShareBinding) {
+				this._oFileShareBinding = oModel.bindList('/FileShares');
+			}
 
-		return new Promise(function(fnResolve) {
-			sap.ui.require([sFileShareSupportModuleName], function(oFileShareSupport) {
-				oFileShareSupport.getDataSource().then(function(oDataSource) {
-					that._oDataSource = oDataSource;
-					fnResolve(oDataSource);
-				}).catch(function () {
-					fnResolve();
-				});
-			});
-		});
+			return this._oFileShareBinding.requestContexts(0);
+		}.bind(this));
 	};
 
 	/**
@@ -153,18 +166,25 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * when the user selected a particular location for
 	 * the file that should be created.
 	 *
-	 * @param {object} oDataSource DataSource object containing the serviceUrl for the CloudFilePicker
 	 * @param {string} [sFileName] Suggested name of the file including file extension
 	 * @returns {Promise} Resolves with the file location selected in the <code>CloudFilePicker</code>
 	 */
-	ExportHandler.prototype.getRemoteFileLocation = function(oDataSource, sFileName) {
+	ExportHandler.prototype.getRemoteFileLocation = function(sFileName) {
+		var that = this;
+
 		return new Promise(function(fnResolve, fnReject) {
-			ExportUtils.getResourceBundle().then(function(oResourceBundle) {
+			Promise.all([
+				ExportUtils.getResourceBundle(),
+				that.getFileShareModel()
+			]).then(function(aResolve) {
+				var oResourceBundle = aResolve[0];
+				var oModel = aResolve[1];
+
 				sap.ui.require(['sap/suite/ui/commons/CloudFilePicker'], function(CloudFilePicker) {
 					var oFilePicker;
 
 					oFilePicker = new CloudFilePicker({
-						serviceUrl: oDataSource.uri,
+						sharedModel: oModel,
 						suggestedFileName: sFileName,
 						enableDuplicateCheck: true,
 						fileNameMandatory: true,
@@ -212,7 +232,8 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * @param {object} mExportSettings mExportSettings ExportSettings that are used for the export
 	 * @param {object} mCustomSettings Additional settings that are passed into the event
 	 * @param {object} mCloudFileInfo FileShareItem representation of the file
-	 * @returns {Promise} A Promise that resolves with the desired export instance
+	 * @returns {Promise} A <code>Promise</code> that resolves with the desired export instance
+	 * @private
 	 */
 	ExportHandler.prototype.getExportInstance = function(mExportSettings, mCustomSettings, mCloudFileInfo) {
 		var that = this;
@@ -241,6 +262,11 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 					oExportDialog = oEvent.getParameter('exportDialog');
 					mCloudFileInfo['FileShareItemContentType'] = oExportInstance.getMimeType();
 
+					/* Enforce file conversion for Google Sheet */
+					if (mExportSettings.fileType === FileType.GSHEET) {
+						mCloudFileInfo['FileShareItemConvertToMimeType'] = 'application/vnd.google-apps.spreadsheet';
+					}
+
 					var uInt8Array = new Uint8Array(aArrayBuffer);
 					var stringArray = new Array(uInt8Array.length);
 					for (var i = 0; i < uInt8Array.length; i++) {
@@ -269,15 +295,15 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 * Uploads the file to the FileShareSupport OData service.
 	 *
 	 * @param {object} mCloudFileInfo FileShareItem representation of the file
-	 * @returns {Promise} A Promise that gets resolved after the generated file has been transferred to the FileShareSupport OData service
+	 * @returns {Promise} A <code>Promise</code> that gets resolved after the generated file has been transferred to the FileShareSupport OData service
+	 * @private
 	 */
 	ExportHandler.prototype.uploadFile = function(mCloudFileInfo) {
-		return this.fetchDataSource().then(function(oDestination) {
-			var oBinding, oContext, oModel, sContentProperty, sTypeProperty, sPath;
+		return this.getFileShareModel().then(function(oModel) {
+			var oBinding, oContext, sContentProperty, sTypeProperty, sPath;
 
-			sContentProperty = "FileShareItemContent";
+			sContentProperty = 'FileShareItemContent';
 			sTypeProperty = 'FileShareItemContentType';
-			oModel = this._getModel(oDestination);
 
 			/* Overwrite existing file */
 			if (mCloudFileInfo['FileShareItem']) {
@@ -291,8 +317,9 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 				 * FileShareItemContent. Adding the <code>null</code>
 				 * prevents an additional PATCH for the link. It is also
 				 * important to set all properties without waiting for
-				 * the Promise to resolve. This allows the binding to
-				 * bundle multiple PATCH requests into a single $batch.
+				 * the <code>Promise</code> to resolve. This allows the
+				 * binding to bundle multiple PATCH requests into a
+				 * single $batch.
 				 */
 				oContext.setProperty('FileShareItemContentLink', '', null);
 				oContext.setProperty(sTypeProperty, mCloudFileInfo[sTypeProperty]);
@@ -323,7 +350,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	 *
 	 * @param {sap.ui.model.odata.v4.ODataListBinding} oBinding ListBinding that is bound to the desired folder
 	 * @param {object} mCloudFileInfo FileShareItem representation of the file
-	 * @returns {Promise} Promise that resolves with a Link to the created file
+	 * @returns {Promise} <code>Promise</code> that resolves with a Link to the created file
 	 */
 	ExportHandler.prototype._createFile = function(oBinding, mCloudFileInfo) {
 		return new Promise(function(fnResolve, fnReject) {
@@ -335,7 +362,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 
 				if (bSuccess) {
 					oBinding.detachCreateCompleted(fnCreateCompleted);
-					fnResolve(oContext.getObject()['FileShareItemContentLink']);
+					fnResolve(oContext.getProperty('FileShareItemContentLink'));
 				} else {
 					oContext.destroy();
 					fnReject();
@@ -348,11 +375,16 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	};
 
 	/**
-	 * Exports the data as defined via parameter.
+	 * Exports the data as defined via parameter. The function
+	 * returns a <code>Promise</code> that will be resolved
+	 * after the export process has been finished. In case of
+	 * an error, its message will be shown in a <code>Dialog</code>
+	 * and the <code>Promise</code> will be rejected.
 	 *
-	 * @param {object} mExportSettings ExportSettings that are used for the export
-	 * @returns {Promise} A Promise that gets resolved after the export process has been finished
+	 * @param {object} mExportSettings Export settings that are used for the export
+	 * @returns {Promise} A <code>Promise</code> that gets resolved after the export process has been finished
 	 *
+	 * @name sap.ui.export.ExportHandler#export
 	 * @since 1.102
 	 * @function
 	 * @public
@@ -370,30 +402,35 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	};
 
 	/**
-	 * Exports the data as defined by the user. This function
-	 * will show up a export settings dialog where the user
-	 * can define certain settings that influence the output
-	 * of the export functionality.
+	 * Exports the data as defined by the user. This function will
+	 * show an export settings dialog where the user can define
+	 * certain settings that influence the output of the export
+	 * functionality.
 	 *
 	 * @param {object} oSettings General export settings containing workbook and dataSource information
-	 * @param {function} [fnResolveColumnLabel] Resolves the label for a particular column that is not directly reflected
-	 * @returns {Promise} A Promise that resolves once the data has been exported
+	 * @param {function} [fnResolveColumnLabel] Resolves the label for a particular column that is not directly contained in the export settings
+	 * @returns {Promise} A <code>Promise</code> that resolves once the data has been exported
 	 *
+	 * @name sap.ui.export.ExportHandler#exportAs
 	 * @since 1.102
 	 * @function
 	 * @public
 	 */
 	ExportHandler.prototype.exportAs = function(oSettings, fnResolveColumnLabel) {
 		var that = this;
-		var mExportSettings = Object.assign({}, oSettings, this._mDialogSettings);
+		var mExportSettings;
 		var mUserSettings = {};
 
 		if (this.bIsDestroyed) {
 			return Promise.reject('ExportHandler must not be used after calling #destroy');
 		}
 
-		return this.fetchDataSource().then(function(oDestination) {
-			return ExportUtils.getExportSettingsViaDialog(mExportSettings, that._mCapabilities, !!oDestination);
+		return this.initialized().then(function() {
+			mExportSettings = Object.assign({}, oSettings, that._mDialogSettings);
+
+			return that.getFileShareContexts();
+		}).then(function(aContexts) {
+			return ExportUtils.getExportSettingsViaDialog(mExportSettings, that._mCapabilities, aContexts.length > 0);
 		}).then(function(mDialogSettings) {
 
 			/* Cache settings dialog settings */
@@ -402,7 +439,7 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 			/* Merge export settings with user settings from the dialog */
 			Object.assign(mExportSettings, mDialogSettings);
 
-			if (mExportSettings.fileType !== FileType.XLSX || mExportSettings.destination !== Destination.REMOTE) {
+			if (mExportSettings.fileType === FileType.PDF || mExportSettings.destination !== Destination.REMOTE) {
 				ExportUtils.validateFileSettings(mExportSettings);
 			}
 
@@ -457,9 +494,15 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 				return Promise.resolve();
 			}
 
-			return that.fetchDataSource().then(function(oDataSource) {
-				return that.getRemoteFileLocation(oDataSource, mExportSettings.fileName);
-			});
+			return that.getRemoteFileLocation(mExportSettings.fileName);
+		}).then(function(mCloudFileInfo) {
+
+			/* Verify that selected FileShare is a Google Workspace */
+			if (mExportSettings.fileType === FileType.GSHEET) {
+				return that.validateFileShare(mCloudFileInfo);
+			}
+
+			return mCloudFileInfo;
 		}).then(function(mCloudFileInfo) {
 			return that.getExportInstance(mExportSettings, mUserSettings, mCloudFileInfo).then(function(oExportInstance) {
 				return oExportInstance.build().finally(function() {
@@ -470,22 +513,88 @@ sap.ui.define(['./library', './ExportUtils', './ExportDialog', 'sap/m/MessageToa
 	};
 
 	/**
-	 * Returns the <code>ODataModel</code> that is required to
-	 * create or update binding contexts.
+	 * Ensures that the referenced FileShare is of vendor Google. This
+	 * temporary function is required as long as the FileShare OData
+	 * service does not provide filter capabilities via $filter.
 	 *
-	 * @param {object} oDataSource DataSource obtained by the FileShareSupport module
-	 * @returns {sap.ui.model.odata.v4.ODataModel} ODataModel for the FileShareSupport service
+	 * @param {object} mCloudFileInfo FileShareItem representation that contains the reference to the FileShare
+	 * @returns {Promise} Returns a <code>Promise</code> that either resolves with the current CloudFileInfo or rejects with an error message
+	 * @private
 	 */
-	ExportHandler.prototype._getModel = function(oDataSource) {
-		if (!this._oModel) {
-			this._oModel = new ODataModel({
-				serviceUrl: oDataSource.uri,
-				synchronizationMode: 'None',
-				autoExpandSelect: true
+	 ExportHandler.prototype.validateFileShare = function(mCloudFileInfo) {
+		return Promise.all([
+			ExportUtils.getResourceBundle(),
+			this.getFileShareContexts()
+		]).then(function(aResolve) {
+			var oResourceBundle = aResolve[0];
+			var aContexts = aResolve[1];
+
+			var oFileShareContext = aContexts.find(function(oContext) {
+				return oContext.getProperty('FileShare') === mCloudFileInfo.FileShare;
 			});
+
+			return this.isGoogleWorkspace(oFileShareContext) ? mCloudFileInfo : Promise.reject(oResourceBundle.getText('DESTINATION_ERROR_NOT_GOOGLE'));
+		}.bind(this));
+	};
+
+	/**
+	 * Returns a <code>Promise</code> that resolves with an <code>ODataModel</code> in case
+	 * the FileShareSupport is available and a DataSource can be obtained.
+	 *
+	 * @returns {Promise<sap.ui.model.odata.v4.ODataModel>} ODataModel for the FileShareSupport service
+	 * @private
+	 */
+	ExportHandler.prototype.getFileShareModel = function() {
+
+		if (this._oModel) {
+			return Promise.resolve(this._oModel);
 		}
 
-		return this._oModel;
+		return ExportUtils.fetchDataSource().then(function(oDataSource) {
+			if (oDataSource) {
+				this._oModel = new ODataModel({
+					serviceUrl: oDataSource.uri,
+					synchronizationMode: 'None',
+					autoExpandSelect: true
+				});
+			}
+
+			return this._oModel;
+		}.bind(this));
+	};
+
+	/**
+	 * Evaluates whether there is any FileShare with vendor Google
+	 *
+	 * @returns {Promise<boolean>} Indicates whether there is a FileShare with vendor Google
+	 * @private
+	 */
+	ExportHandler.prototype.isGoogleSheetSupported = function() {
+		return this.getFileShareContexts().then(function(aContexts) {
+			return aContexts.some(this.isGoogleWorkspace);
+		}.bind(this));
+	};
+
+	/**
+	 * Evaluates whether the given FileShare vendor is Google
+	 *
+	 * @param {sap.ui.model.odata.v4.Context} oContext The OData <code>Context</code> of the FileShare
+	 * @returns {boolean} Indicates whether the FileShare vendor is Google
+	 * @private
+	 */
+	ExportHandler.prototype.isGoogleWorkspace = function(oContext) {
+		var sDescription, sVendorType;
+
+		sVendorType = oContext.getProperty('FileShareVendorType');
+
+		if (new URL(window.location.href).search.indexOf("sap-ui-xx-enableGoogleSheets=true") === -1) {
+			return sVendorType === 'GOOGLE';
+		}
+
+		sDescription = oContext.getProperty('FileShareDescription');
+
+		return sVendorType === 'GOOGLE'
+			|| (typeof sDescription === 'string' && sDescription.indexOf('Google') > -1);
 	};
 
 	return ExportHandler;