@sapui5/sap.ui.export 1.129.0 → 1.130.0

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

@@ -37,15 +37,14 @@ sap.ui.define([
 	const Destination = library.Destination;
 	const MessageMode = coreLibrary.InvisibleMessageMode;
 
-	var uiVersion = null;
-	var oDefaultFormatSettings = null;
+	let uiVersion = null;
+	let oDefaultFormatSettings = null;
 
 	/* Async call to resource bundle */
-	var oResourceBundle;
+	let oResourceBundle;
 
-	var CLASS_NAME = "sap.ui.export.ExportUtils";
-
-	var UNSUPPORTED_SHEETNAME_CHARACTERS_REGEX = /[\\\/\?\*:\[\]]/g;
+	const CLASS_NAME = "sap.ui.export.ExportUtils";
+	const UNSUPPORTED_SHEETNAME_CHARACTERS_REGEX = /[\\\/\?\*:\[\]]/g;
 
 	/*
 	 * Trigger loading of sap-ui-version.json during initialization,
@@ -53,7 +52,7 @@ sap.ui.define([
 	 * when the variable is accessed, it is most likely the case.
 	 */
 	VersionInfo.load().then(function(oVersionInfo) {
-		var aMatch = /^[0-9]+\.[0-9]+/.exec(oVersionInfo.version);
+		const aMatch = /^[0-9]+\.[0-9]+/.exec(oVersionInfo.version);
 
 		uiVersion = aMatch ? aMatch[0] : null;
 	});
@@ -69,9 +68,9 @@ sap.ui.define([
 
 	/* Returns the Export Settings used by the User Settings Dialog */
 	function getDefaultSettings(oCustomConfig, oResourceBundle, oExportCapabilities, bRemoteDestination) {
-		var aSupportedFormats = Object.keys(oExportCapabilities);
+		const aSupportedFormats = Object.keys(oExportCapabilities);
 
-		var oDefaultConfig = {
+		const oDefaultConfig = {
 			fileName: "Standard",
 			fileTypeCollection: [],
 			fileType: "XLSX",
@@ -103,10 +102,8 @@ sap.ui.define([
 		};
 
 		aSupportedFormats.forEach(function(sFormat) {
-			var sFileType, sResourceBundleKey;
-
-			sFileType = sFormat.toUpperCase();
-			sResourceBundleKey = `${sFileType}_FILETYPE`;
+			const sFileType = sFormat.toUpperCase();
+			const sResourceBundleKey = `${sFileType}_FILETYPE`;
 
 			oDefaultConfig.fileTypeCollection.push({
 				key: sFileType,
@@ -121,7 +118,7 @@ sap.ui.define([
 			});
 		}
 
-		var oExportConfig = Object.assign({}, oDefaultConfig, oCustomConfig || {});
+		const oExportConfig = Object.assign({}, oDefaultConfig, oCustomConfig || {});
 
 		/* Select first element if selected key is unavailable */
 		if (!oExportConfig.fileTypeCollection.some(function(oEntry) {
@@ -134,7 +131,7 @@ sap.ui.define([
 	}
 
 	function processExportSettings(oSettings) {
-		var oFinalSettings = {};
+		const oFinalSettings = {};
 
 		["fileName", "fileType", "paperSize", "orientation", "splitCells", "includeFilterSettings", "addDateTime", "doEnableAccessibility", "fitToPage", "fontSize", "signature", "signatureReason", "pdfArchive", "destination", "showPageNumber"].forEach(function(sProperty) {
 			oFinalSettings[sProperty] = oSettings[sProperty];
@@ -147,14 +144,14 @@ sap.ui.define([
 	 * @class Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.129.0
+	 * @version 1.130.0
 	 *
 	 * @since 1.59
 	 * @alias sap.ui.export.ExportUtils
 	 * @private
 	 * @ui5-restricted sap.ui.comp.smarttable.SmartTable
 	 */
-	var Utils = {
+	const Utils = {
 
 		_INTERCEPTSERVICE: "sap/ushell/cloudServices/interceptor/InterceptService",
 		/**
@@ -170,9 +167,10 @@ sap.ui.define([
 		interceptUrl: function(sUrl) {
 			// Check if cloud InterceptService exists (for destination routing) - See JIRA: FIORITECHP1-8941
 			// This is necessary for cloud instances e.g. SAP CP, due to some destination routing that is not known by UI5 model/client!
-			var InterceptService = sap.ui.require(Utils._INTERCEPTSERVICE);
+			const InterceptService = sap.ui.require(Utils._INTERCEPTSERVICE);
 			if (InterceptService) {
-				var oInterceptService = InterceptService.getInstance();
+				const oInterceptService = InterceptService.getInstance();
+
 				if (oInterceptService && oInterceptService.interceptUrl) {
 					sUrl = oInterceptService.interceptUrl(sUrl);
 				}
@@ -194,13 +192,11 @@ sap.ui.define([
 		 * @public
 		 */
 		fetchDataSource: function() {
-			var sFileShareSupportModuleName;
-
 			if (Utils._oDataSource) {
 				return Promise.resolve(Utils._oDataSource);
 			}
 
-			sFileShareSupportModuleName = BaseConfig.get({
+			const sFileShareSupportModuleName = BaseConfig.get({
 				name: "sapUiFileShareSupport",
 				type: BaseConfig.Type.String,
 				defaultValue: undefined
@@ -250,8 +246,12 @@ sap.ui.define([
 		 * @private
 		 */
 		getExportSettingsViaDialog: function(mCustomConfig, oExportCapabilities, bRemoteDestination, oOpener, fnCallback) {
+			function isPDFFileShareExportEnabled() {
+				return document.location.search.includes("sap-ui-xx-pdfFileShareExport=true") && oExportCapabilities?.PDF?.UploadToFileShare;
+			}
+
 			return new Promise(function (fnResolve, fnReject) {
-				var oExportSettingsDialog;
+				let oExportSettingsDialog;
 
 				// Shift optional arguments
 				if (typeof bRemoteDestination === "object") {
@@ -266,12 +266,13 @@ sap.ui.define([
 					oOpener = null;
 				}
 
-				Utils.getResourceBundle().then(function (oResourceBundle) {
-					var oExportConfigModel = new JSONModel();
-					var fnSetSemanticStepName = function (oExportConfigModel, oExportButton) {
-						var sStepName = "OI:EXP:";
-						var sDestination = oExportConfigModel.getProperty("/destination");
-						var sFileType = oExportConfigModel.getProperty("/fileType");
+				Utils.getResourceBundle().then((oResourceBundle) => {
+					const oExportConfigModel = new JSONModel();
+
+					function fnSetSemanticStepName (oExportConfigModel, oExportButton) {
+						const sDestination = oExportConfigModel.getProperty("/destination");
+						const sFileType = oExportConfigModel.getProperty("/fileType");
+						let sStepName = "OI:EXP:";
 
 						sStepName += sDestination === Destination.REMOTE ? "CL:" : "LOC:";
 
@@ -290,7 +291,7 @@ sap.ui.define([
 						}
 
 						FESRHelper.setSemanticStepname(oExportButton, "press", sStepName);
-					};
+					}
 
 					oExportConfigModel.setData(getDefaultSettings(mCustomConfig, oResourceBundle, oExportCapabilities, bRemoteDestination));
 
@@ -305,7 +306,8 @@ sap.ui.define([
 								return sValue === FileType.XLSX || sValue === FileType.GSHEET;
 							},
 							isDestinationEnabled: function(sFileType) {
-								return sFileType === FileType.XLSX;
+								// URL Parameter dependend activation of PDF File Share Export
+								return isPDFFileShareExportEnabled() ? sFileType !== FileType.GSHEET : sFileType === FileType.XLSX;
 							},
 							hasDestinations: function(aDestinationCollection) {
 								return aDestinationCollection.length > 1;
@@ -328,11 +330,12 @@ sap.ui.define([
 							 * @param {sap.ui.base.Event} oEvent LiveChange event of the Input control
 							 */
 							onFileNameChange: function(oEvent) {
-								var oInput = oEvent.getSource();
-								var sFileName = oEvent.getParameter("value");
-								var oRegEx = /[\\/:|?"*<>]/;
-								var oExportBtn = Element.getElementById("exportSettingsDialog-exportButton");
-								var bValidate = oRegEx.test(sFileName);
+								const oInput = oEvent.getSource();
+								const sFileName = oEvent.getParameter("value");
+								const oRegEx = /[\\/:|?"*<>]/;
+								const oExportBtn = Element.getElementById("exportSettingsDialog-exportButton");
+								const bValidate = oRegEx.test(sFileName);
+
 								if (bValidate) {
 									oInput.setValueState(ValueState.Error);
 									oInput.setValueStateText(oResourceBundle.getText("FILENAME_ERROR"));
@@ -346,7 +349,7 @@ sap.ui.define([
 								oExportBtn.setEnabled(!bValidate);
 							},
 							onFileTypeChange: function(oEvent) {
-								var oSelectedItem = oEvent.getParameter("selectedItem");
+								const oSelectedItem = oEvent.getParameter("selectedItem");
 
 								if (!oSelectedItem) {
 									return;
@@ -354,8 +357,12 @@ sap.ui.define([
 
 								switch (oSelectedItem.getKey()) {
 									case FileType.PDF:
+										// URL Parameter dependend activation of PDF File Share Export
+										if (!isPDFFileShareExportEnabled()) {
+											oExportConfigModel.setProperty("/destination", Destination.LOCAL);
+										}
+
 										oExportConfigModel.setProperty("/includeFilterSettings", false);
-										oExportConfigModel.setProperty("/destination", Destination.LOCAL);
 										fnSetSemanticStepName(oExportConfigModel, oExportSettingsDialog.getBeginButton());
 										break;
 									case FileType.GSHEET:
@@ -377,11 +384,12 @@ sap.ui.define([
 							},
 							onFontSizeChange: function(oEvent) {
 								// user input validation for font size
-								var oInput = oEvent.getSource();
-								var sFontValue = oEvent.getParameter("value");
-								var oRegEx = /[^\d]/g;
-								var oExportBtn = Element.getElementById("exportSettingsDialog-exportButton");
-								var bValidate = oRegEx.test(sFontValue);
+								const oInput = oEvent.getSource();
+								const sFontValue = oEvent.getParameter("value");
+								const oRegEx = /[^\d]/g;
+								const oExportBtn = Element.getElementById("exportSettingsDialog-exportButton");
+								const bValidate = oRegEx.test(sFontValue);
+
 								if (bValidate) {
 									oInput.setValueState(ValueState.Error);
 									oInput.setValueStateText(oResourceBundle.getText("NUMBER_ERROR"));
@@ -506,7 +514,7 @@ sap.ui.define([
 		 * @private
 		 */
 		_parseLogical: function(oLogicalFilter) {
-			var aFilters, sProperty;
+			let aFilters;
 
 			try {
 				/*
@@ -557,7 +565,7 @@ sap.ui.define([
 
 				/* Group logical OR filter on the same property */
 				if (oLogicalFilter.op === "||" && aFilters.length) {
-					sProperty = aFilters[0].key;
+					const sProperty = aFilters[0].key;
 
 					if (aFilters.every(function(item) { return item.key === sProperty; })) {
 						aFilters = [
@@ -616,13 +624,11 @@ sap.ui.define([
 		 * @private
 		 */
 		_parseUnary: function(oUnaryFilter) {
-			var result;
-
 			if (!oUnaryFilter.arg) {
 				return [];
 			}
 
-			result = Utils._parseFilter(oUnaryFilter.arg);
+			const result = Utils._parseFilter(oUnaryFilter.arg);
 
 			if (oUnaryFilter.op === "!" && result[0].value) {
 				result[0].value.exclude = true;
@@ -688,16 +694,14 @@ sap.ui.define([
 		 * @private
 		 */
 		getFilters: function(oBinding) {
-			var aFilters, oFilterInfo;
-
-			aFilters = [];
+			const aFilters = [];
 
 			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;
 			}
 
-			oFilterInfo = oBinding.getFilterInfo();
+			const oFilterInfo = oBinding.getFilterInfo();
 			if (oFilterInfo) {
 				Utils._parseFilter(oFilterInfo).forEach(function(oEntry) {
 					aFilters.push(new Filter(oEntry.key, oEntry.value));
@@ -758,17 +762,16 @@ sap.ui.define([
 		 * @public
 		 */
 		saveAsFile: function(oBlob, sFilename) {
-			var link, downloadSupported, fnSave;
+			let fnSave;
 
 			/* Ignore other formats than Blob */
 			if (!(oBlob instanceof Blob)) {
 				return;
 			}
 
-			link = document.createElementNS("http://www.w3.org/1999/xhtml", "a");
-			downloadSupported = "download" in link;
+			const link = document.createElementNS("http://www.w3.org/1999/xhtml", "a");
+			const downloadSupported = "download" in link;
 
-			/* Try ObjectURL Chrome, Firefox, Opera, Android, Safari (MacOS 10.1, iOS 13) */
 			if (downloadSupported) {
 				fnSave = function(data, fileName) {
 					link.download = fileName;
@@ -777,16 +780,14 @@ sap.ui.define([
 				};
 			}
 
-			/* In case of iOS Safari, MacOS Safari (legacy) */
+			/* In case of pre iOS 13 Safari, MacOS Safari (legacy) */
 			if (typeof fnSave === "undefined") {
 				fnSave = function(data) {
-					var reader = new FileReader();
+					const reader = new FileReader();
 
 					reader.onloadend = function() {
-						var opened, url;
-
-						url = reader.result.replace(/^data:[^;]*;/, "data:attachment/file;");
-						opened = openWindow(url, "_blank");
+						const url = reader.result.replace(/^data:[^;]*;/, "data:attachment/file;");
+						const opened = openWindow(url, "_blank");
 
 						if (!opened) {
 							window.location.href = url;
@@ -868,10 +869,9 @@ sap.ui.define([
 		 * @private
 		 */
 		validateFileName: function(sName, sType) {
-			var sExtension;
+			const sExtension = "." + sType.toLowerCase();
 
 			sName = sName || "export";
-			sExtension = "." + sType.toLowerCase();
 
 			if (!sName.endsWith(sExtension) && sType !== FileType.GSHEET) {
 				sName += sExtension;
@@ -898,8 +898,6 @@ sap.ui.define([
 		 * @private
 		 */
 		_validateDataSource: function(mDataSource) {
-			var iSizeLimit;
-
 			if (!mDataSource || typeof mDataSource !== "object") {
 				throw new Error(`${CLASS_NAME}: dataSource has not been specified`);
 			}
@@ -955,10 +953,10 @@ sap.ui.define([
 				}
 			}
 
-			iSizeLimit = mDataSource.sizeLimit;
+			let iSizeLimit = mDataSource.sizeLimit;
 			if (!iSizeLimit || isNaN(iSizeLimit) || iSizeLimit % 1 !== 0) {
-				var iMaxSize = 5000,
-					iMinSize = 200;
+				const iMaxSize = 5000;
+				const iMinSize = 200;
 
 				// Try to load data in 5 steps, but each step should be at least 200 rows
 				iSizeLimit = mDataSource.count ? Math.round(mDataSource.count / (iMinSize * 5)) * iMinSize : iMinSize;
@@ -988,8 +986,6 @@ sap.ui.define([
 
 			/* Eliminate incorrect column definitions */
 			mWorkbook.columns = mWorkbook.columns.filter(function(oColumn, iIndex) {
-				var iWidth;
-
 				if (!(oColumn instanceof Object)) {
 					Log.error(`${CLASS_NAME}: Column ${iIndex} skipped due to invalid configuration`);
 					return false;
@@ -1011,12 +1007,11 @@ sap.ui.define([
 				oColumn.label = oColumn.label || (oColumn.property instanceof Array ? oColumn.property[0] : oColumn.property);
 
 				/* Column width calculation */
-				iWidth = oColumn.width;
+				let iWidth = oColumn.width;
 
 				if (typeof iWidth === "string") {
-					var sWidth;
+					const sWidth = iWidth.toLowerCase();
 
-					sWidth = iWidth.toLowerCase();
 					iWidth = parseFloat(sWidth);
 
 					/*
@@ -1045,18 +1040,15 @@ sap.ui.define([
 
 				oColumn.width = Math.round(iWidth);
 
-				/* Type validation */
 				Utils._validateType(oColumn, iIndex);
-
-				/* TextAlign validation */
 				Utils._validateString(oColumn, "textAlign");
 
 				if (oColumn.textAlign) {
-					var textAlign = String(oColumn.textAlign).toLowerCase();
+					let textAlign = String(oColumn.textAlign).toLowerCase();
 
 					/* Map the values begin & end according to RTL */
 					if (["begin", "end"].indexOf(textAlign) > -1) {
-						var mappedAlignment = ["left", "right"];
+						const mappedAlignment = ["left", "right"];
 
 						textAlign = (Localization.getRTL() ? mappedAlignment.reverse() : mappedAlignment)[["begin", "end"].indexOf(textAlign)];
 					}
@@ -1130,17 +1122,17 @@ sap.ui.define([
 				}
 
 				/* Validate scale property */
-				var scale = oColumn.scale;
-				if (oColumn.type === EdmType.Number && isNaN(scale) && scale !== "variable") {
+				let iScale = oColumn.scale;
+				if (oColumn.type === EdmType.Number && isNaN(iScale) && iScale !== "variable") {
 					Log.warning(`${CLASS_NAME}: scale parameter for numerical column configuration is missing.`);
 				}
-				if (typeof scale === "string") {
-					scale = parseInt(scale);
+				if (typeof iScale === "string") {
+					iScale = parseInt(iScale);
 				}
-				if (isNaN(scale)) {
-					scale = null;
+				if (isNaN(iScale)) {
+					iScale = null;
 				}
-				oColumn.scale = scale;
+				oColumn.scale = iScale;
 
 				/* Validate valueMap property */
 				if (oColumn.valueMap && typeof oColumn.valueMap !== "object") {
@@ -1166,18 +1158,16 @@ sap.ui.define([
 		 * @private
 		 */
 		_validateType: function(oColumn) {
-			var sType, sFixedType;
-
 			if (typeof oColumn.type !== "string") {
 				oColumn.type = EdmType.String;
 				return;
 			}
 
 			if (!EdmType[oColumn.type]) {
-				sFixedType = EdmType.String;
+				let sFixedType = EdmType.String;
 
 				/* Fix type for case insensitive match */
-				for (sType in EdmType) {
+				for (const sType in EdmType) {
 					if (sType.toLowerCase() == oColumn.type.toLowerCase()) {
 						sFixedType = sType;
 					}
@@ -1228,7 +1218,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.129.0")
+		 * @param {string} [oContext.version] Application version (default: "1.130.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
@@ -1282,11 +1272,9 @@ sap.ui.define([
 		 * @private
 		 */
 		_validateString: function(oContext, sProperty, sDefaultValue, iMaxLength, sRemove) {
-			var sValue;
-
 			Utils._validateProperty(oContext, sProperty, "string", sDefaultValue);
 
-			sValue = oContext[sProperty];
+			let sValue = oContext[sProperty];
 
 			if (typeof sValue === "string" && (typeof sRemove === "string" || sRemove instanceof RegExp)) {
 				sValue = sValue.replace(sRemove, "");
@@ -1314,7 +1302,7 @@ sap.ui.define([
 		 * @private
 		 */
 		_validateProperty: function(oContext, sProperty, sType, defaultValue) {
-			var value = oContext[sProperty];
+			let value = oContext[sProperty];
 
 			// eslint-disable-next-line valid-typeof
 			if (value != null && typeof value !== sType) {
@@ -1346,19 +1334,17 @@ sap.ui.define([
 		 * @private
 		 */
 		_validateScaleCustomizing: function(oCustomizing, sProperty) {
-			var sKey, mScaleSettings;
-
 			if (!oCustomizing) {
 				return;
 			}
 
-			mScaleSettings = oCustomizing[sProperty];
+			const mScaleSettings = oCustomizing[sProperty];
 
 			if (!(mScaleSettings instanceof Object) || Array.isArray(mScaleSettings)) {
 				Log.warning(`${CLASS_NAME}: Invalid scale customizing for ${sProperty}.`);
 				oCustomizing[sProperty] = {};
 			} else {
-				for (sKey in mScaleSettings) {
+				for (const sKey in mScaleSettings) {
 					if (!(mScaleSettings[sKey] instanceof Object)) {
 						Log.warning(`${CLASS_NAME}: Key ${sKey} has been removed from customizing`);
 						delete mScaleSettings[sKey];
@@ -1377,17 +1363,18 @@ sap.ui.define([
 		 *
 		 * @param {object} mSettings Export configuration with optional FileType
 		 * @param {object} [mCapabilities] Export capabilities for all supported types
+		 * @param {object} [mCloudFileInfo] Information about the file that is stored in the remote FileShare
 		 * @returns {Promise<sap.ui.export.ExportBase>} A Promise that gets resolved with the requested instance
 		 *
 		 * @static
 		 * @since 1.112
 		 * @public
 		 */
-		getExportInstance: function(mSettings, mCapabilities) {
-			var sClassName, sFileType;
+		getExportInstance: function(mSettings, mCapabilities, mCloudFileInfo) {
+			const sFileType = typeof mSettings.fileType === "string" ? mSettings.fileType.toUpperCase() : mSettings.fileType;
+			let sClassName;
 
 			mCapabilities = mCapabilities ? mCapabilities : {};
-			sFileType = typeof mSettings.fileType === "string" ? mSettings.fileType.toUpperCase() : mSettings.fileType;
 
 			switch (sFileType) {
 				case FileType.PDF:
@@ -1399,7 +1386,7 @@ sap.ui.define([
 
 			return new Promise(function(fnResolve) {
 				sap.ui.require([sClassName], function(ExportClass) {
-					fnResolve(new ExportClass(mSettings, mCapabilities[sFileType]));
+					fnResolve(new ExportClass(mSettings, mCapabilities[sFileType], mCloudFileInfo));
 				});
 			});
 		},
@@ -1415,7 +1402,7 @@ sap.ui.define([
 		 * @private
 		 */
 		getCountFromBinding: function(oBinding) {
-			var iCount;
+			let iCount;
 
 			if (typeof oBinding.getCount === "function") {
 				iCount = oBinding.getCount();
@@ -1500,7 +1487,7 @@ sap.ui.define([
 		 * @private
 		 */
 		splitColumns: function(aColumns, fnResolveColumnLabel) {
-			var aResult = [];
+			const aResult = [];
 
 			/* Assign dummy function to prevent multiple typeof checks */
 			if (typeof fnResolveColumnLabel !== "function") {
@@ -1508,7 +1495,7 @@ sap.ui.define([
 			}
 
 			aColumns.forEach(function(oColumn) {
-				var aSplittedColumns, oUpdatedColumn, oAdditionalColumn, sColumnLabel;
+				let aSplittedColumns, oUpdatedColumn, oAdditionalColumn, sColumnLabel;
 
 				/* Split EdmType.String columns with multiple properties */
 				if (Array.isArray(oColumn.property) && oColumn.property.length > 1) {
@@ -1663,6 +1650,20 @@ sap.ui.define([
 
 			const sMessage = oBundle.getText(`MSG_INFO_EXPORT_${sExportStatus}`, oConfig?.values);
 			oInvisibleMessage.announce(sMessage, oConfig?.assertive ? MessageMode.Assertive : MessageMode.Polite);
+		},
+
+		/**
+		 * Loads the desired class asynchronously
+		 *
+		 * @param {string} sClassName Full qualified class name
+		 * @returns {Promise} Promise that resolves with Class reference
+		 * @static
+		 * @private
+		 */
+		loadClass: function(sClassName) {
+			return new Promise((fnResolve) => {
+				sap.ui.require([sClassName], fnResolve);
+			});
 		}
 	};