@openui5/sap.ui.core 1.119.1 → 1.120.1

package/src/sap/ui/core/Lib.js

@@ -12,7 +12,10 @@ sap.ui.define([
 	'sap/base/i18n/ResourceBundle',
 	'sap/base/Log',
 	'sap/base/util/deepExtend',
+	"sap/base/util/isEmptyObject",
+	"sap/base/util/isPlainObject",
 	'sap/base/util/LoaderExtensions',
+	'sap/base/util/fetch',
 	'sap/base/util/mixedFetch',
 	"sap/base/util/ObjectPath",
 	'sap/base/util/Version',
@@ -32,7 +35,10 @@ sap.ui.define([
 	ResourceBundle,
 	Log,
 	deepExtend,
+	isEmptyObject,
+	isPlainObject,
 	LoaderExtensions,
+	fetch,
 	mixedFetch,
 	ObjectPath,
 	Version,
@@ -510,7 +516,7 @@ sap.ui.define([
 			var sFileType = this._getFileType(mOptions.json),
 				sLibPackage = this.name.replace(/\./g, '/'),
 				bEntryModuleExists = !!sap.ui.loader._.getModuleState(sLibPackage + '/library.js'),
-				bHttp2 = Configuration.getDepCache();
+				bHttp2 = Library.isDepCacheEnabled();
 
 			if (sFileType === 'none') {
 				return mOptions.sync ? this : Promise.resolve(this);
@@ -556,6 +562,7 @@ sap.ui.define([
 				// (but the loader avoids double loading).
 				Log.debug("Lazy dependency to '" + this.name + "' encountered, loading library-preload-lazy.js");
 
+				/** @deprecated */
 				if (mOptions.sync) {
 					try {
 						sap.ui.requireSync(sLibPackage + '/library-preload-lazy'); // legacy-relevant: Sync path
@@ -563,10 +570,10 @@ sap.ui.define([
 						Log.error("failed to load '" + sLibPackage + "/library-preload-lazy.js" + "' synchronously (" + (e && e.message || e) + ")");
 					}
 					return this;
-				} else {
-					return sap.ui.loader._.loadJSResourceAsync(
-						sLibPackage + '/library-preload-lazy.js', /* ignoreErrors = */ true);
 				}
+
+				return sap.ui.loader._.loadJSResourceAsync(
+					sLibPackage + '/library-preload-lazy.js', /* ignoreErrors = */ true);
 			}
 
 			// otherwise mark as pending
@@ -628,6 +635,7 @@ sap.ui.define([
 					aPromises = aDependencies.map(function(oDependency) {
 						var oLibrary = Library._get(oDependency.name, true/* bCreate */);
 						return oLibrary._preload({
+							/** @deprecated since 1.120 */
 							sync: mOptions.sync,
 							lazy: oDependency.lazy
 						});
@@ -725,9 +733,13 @@ sap.ui.define([
 
 			var sURL = getModulePath(this.name, "/library-preload.json");
 
-			return mixedFetch(sURL, {
+			/**
+			 * @deprecated As of Version 1.120
+			 */
+			fetch = mixedFetch ? mixedFetch : fetch;
+			return fetch(sURL, {
 				headers: {
-					Accept: mixedFetch.ContentTypes.JSON
+					Accept: fetch.ContentTypes.JSON
 				}
 			}, mOptions.sync).then(function(response) {
 				if (response.ok) {
@@ -1144,7 +1156,7 @@ sap.ui.define([
 	 * @returns {object} A map that contains the initialized libraries. Each library is saved in the map under its name
 	 *  as key.
 	 * @private
-	 * @ui5-restricted sap.ui.core, sap.ui.support
+	 * @ui5-restricted sap.ui.core, sap.ui.support, sap.ui.fl, sap.ui.dt
 	 */
 	Library.all = function() {
 		// return only libraries that are initialized (settings enhanced)
@@ -1173,11 +1185,93 @@ sap.ui.define([
 		return mInitLibraries;
 	};
 
+	/*
+	 * A symbol used to mark a Proxy as such
+	 * Proxys are indistinguishable from the outside, but we need a way
+	 * to prevent duplicate Proxy wrapping for library namespaces.
+	 */
+	const symIsProxy = Symbol("isProxy");
+
+	/**
+	 * Creates a Proxy handler object for the a library namespace.
+	 * Additionally creates a WeakMap for storing sub-namespace segments.
+	 * @param {string} sLibName the library name in dot-notation
+	 * @param {object} oLibNamespace the top-level library namespace object
+	 * @returns {object} an object containing the proxy-handler and the sub-namespace map
+	 */
+	function createProxyForLibraryNamespace(sLibName, oLibNamespace) {
+		// weakmap to track sub-namespaces for a library
+		// key: the sub-namespace objects, value: the accumulated namespace segments as string[]
+		// initial entry (the first 'target') is the library namespace object itself
+		const mSubNamespaces = new WeakMap();
+		mSubNamespaces.set(oLibNamespace, `${sLibName}.`);
+
+		// Proxy facade for library namespace/info-object
+		// will be filled successively by the library after Library.init()
+		const oLibProxyHandler = {
+
+			set(target, prop, value) {
+				// only analyze plain-objects: literals and (Constructor) functions, etc. must not have a proxy
+				// note: we explicitly must exclude Proxies here, since they are recognized as plain and empty
+				if ( isPlainObject(value) && !value[symIsProxy]) {
+					//Check Objects if they only contain static values
+					// assumption: a non-empty plain-object with only static content is an enum
+					const valueIsEmpty = isEmptyObject(value);
+
+					let registerProxy = valueIsEmpty;
+
+					if (!valueIsEmpty) {
+						if (DataType._isEnumCandidate(value)) {
+							// general namespace assignment
+							target[prop] = value;
+
+							// join library sub-paths when registering an enum type
+							// note: namespace already contains a trailing dot '.'
+							const sNamespacePrefix = mSubNamespaces.get(target);
+							DataType.registerEnum(`${sNamespacePrefix}${prop}`, value);
+						} else {
+							const firstChar = prop.charAt(0);
+							if (firstChar === firstChar.toLowerCase() && firstChar !== firstChar.toUpperCase()) {
+								registerProxy = true;
+							} else {
+								// general namespace assignment
+								target[prop] = value;
+							}
+						}
+					}
+
+					if (registerProxy) {
+						target[prop] = new Proxy(value, oLibProxyHandler);
+						// append currently written property to the namespace (mind the '.' at the end for the next level)
+						const sNamespacePrefix = `${mSubNamespaces.get(target)}${prop}.`;
+						// track nested namespace paths segments per proxy object
+						mSubNamespaces.set(value, sNamespacePrefix);
+					}
+				} else {
+					// no plain-object values, e.g. strings, classes
+					target[prop] = value;
+				}
+
+				return true;
+			},
+
+			get(target, prop) {
+				// check if an object is a proxy
+				if (prop === symIsProxy) {
+					return true;
+				}
+				return target[prop];
+			}
+		};
+
+		return oLibProxyHandler;
+	}
+
 	/**
 	 * Provides information about a library.
 	 *
 	 * This method is intended to be called exactly once while the main module of a library (its <code>library.js</code>
-	 * module) is executing, typically at its begin. The single parameter <code>oLibInfo</code> is an info object that
+	 * module) is executing, typically at its begin. The single parameter <code>mSettings</code> is an info object that
 	 * describes the content of the library.
 	 *
 	 * When the <code>mSettings</code> has been processed, a normalized version will be set on the library instance
@@ -1194,9 +1288,11 @@ sap.ui.define([
 	 *
 	 * <li>If the object contains a list of <code>controls</code> or <code>elements</code>, {@link sap.ui.lazyRequire
 	 * lazy stubs} will be created for their constructor as well as for their static <code>extend</code> and
-	 * <code>getMetadata</code> methods.<br> <b>Note:</b> Future versions might abandon the concept of lazy stubs as it
-	 * requires synchronous XMLHttpRequests which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be
-	 * on the safe side, productive applications should always require any modules that they directly depend on.</li>
+	 * <code>getMetadata</code> methods.
+	 *
+	 * <b>Note:</b> Future versions of UI5 will abandon the concept of lazy stubs as it requires synchronous
+	 * XMLHttpRequests which have been deprecated (see {@link http://xhr.spec.whatwg.org}). To be on the safe side,
+	 * productive applications should always require any modules that they directly depend on.</li>
 	 *
 	 * <li>With the <code>noLibraryCSS</code> property, the library can be marked as 'theming-free'.  Otherwise, the
 	 * framework will add a &lt;link&gt; tag to the page's head, pointing to the library's theme-specific stylesheet.
@@ -1206,9 +1302,21 @@ sap.ui.define([
 	 * loaded the resulting stylesheet.</li>
 	 *
 	 * <li>If a list of library <code>dependencies</code> is specified in the info object, those libraries will be
-	 * loaded synchronously.<br> <b>Note:</b> Dependencies between libraries don't have to be modeled as AMD
-	 * dependencies. Only when enums or types from an additional library are used in the coding of the
-	 * <code>library.js</code> module, the library should be additionally listed in the AMD dependencies.</li>
+	 * loaded synchronously if they haven't been loaded yet.
+	 *
+	 * <b>Note:</b> Dependencies between libraries have to be modeled consistently in several places:
+	 * <ul>
+	 * <li>Both eager and lazy dependencies have to be modelled in the <code>.library</code> file.</li>
+	 * <li>By default, UI5 Tooling generates a <code>manifest.json</code> file from the content of the <code>.library</code>
+	 * file. However, if the <code>manifest.json</code> file for the library is not generated but
+	 * maintained manually, it must be kept consistent with the <code>.library</code> file, especially regarding
+	 * its listed library dependencies.</li>
+	 * <li>All eager library dependencies must be declared as AMD dependencies of the <code>library.js</code> module
+	 * by referring to the corresponding <code>"some/lib/namespace/library"</code> module of each library
+	 * dependency.</code></li>
+	 * <li>All eager dependencies must be listed in the <code>dependencies</code> property of the info object.</li>
+	 * <li>All lazy dependencies <b>must not</b> be listed as AMD dependencies or in the <code>dependencies</code>
+	 * property of the info object.</li>
 	 * </ul>
 	 *
 	 * Last but not least, higher layer frameworks might want to include their own metadata for libraries.
@@ -1217,19 +1325,15 @@ sap.ui.define([
 	 * in the <code>extensions</code> object and that the name of that property contains some namespace
 	 * information (e.g. library name that introduces the feature) to avoid conflicts with other extensions.
 	 * The framework won't touch the content of <code>extensions</code> but will make it available
-	 * in the library info objects returned by {@link #.getInitializedLibraries}.
+	 * in the library info objects provided by {@link #.load}.
 	 *
 	 *
 	 * <h3>Relationship to Descriptor for Libraries (manifest.json)</h3>
 	 *
 	 * The information contained in <code>mSettings</code> is partially redundant to the content of the descriptor
-	 * for the same library (its <code>manifest.json</code> file). Future versions of UI5 might ignore the information
-	 * provided in <code>oLibInfo</code> and might evaluate the descriptor file instead. Library developers therefore
-	 * should keep the information in both files in sync.
-	 *
-	 * When the <code>manifest.json</code> is generated from the <code>.library</code> file (which is the default
-	 * for UI5 libraries built with Maven), then the content of the <code>.library</code> and <code>library.js</code>
-	 * files must be kept in sync.
+	 * for the same library (its <code>manifest.json</code> file). Future versions of UI5 will ignore the information
+	 * provided in <code>mSettings</code> and will evaluate the descriptor file instead. Library developers therefore
+	 * must keep the information in both files in sync if the <code>manifest.json</code> file is maintained manually.
 	 *
 	 * @param {object} mSettings Info object for the library
 	 * @param {string} mSettings.name Name of the library; It must match the name by which the library has been loaded
@@ -1248,10 +1352,15 @@ sap.ui.define([
 	 *  When set to true, no library.css will be loaded for this library
 	 * @param {object} [mSettings.extensions] Potential extensions of the library metadata; structure not defined by the
 	 *  UI5 core framework.
-	 * @returns {object} As of version 1.101; returns the library namespace, based on the given library name.
+	 * @returns {object} Returns the library namespace, based on the given library name.
 	 * @public
 	 */
 	Library.init = function(mSettings) {
+		// throw error if a Library is initialized before the core is ready.
+		if (!sap.ui.require("sap/ui/core/Core")) {
+			throw new Error("Library " + mSettings.name + ": Library must not be used before the core is ready!");
+		}
+
 		assert(typeof mSettings === "object" , "mSettings given to 'sap/ui/core/Lib.init' must be an object");
 		assert(typeof mSettings.name === "string" && mSettings.name, "mSettings given to 'sap/ui/core/Lib.init' must have the 'name' property set");
 
@@ -1261,11 +1370,36 @@ sap.ui.define([
 		var oLib = Library._get(mSettings.name, true /* bCreate */);
 		oLib.enhanceSettings(mSettings);
 
-		// ensure namespace
-		var oLibNamespace = ObjectPath.create(mSettings.name),
+		var oLibNamespace = Object.create(null),
 			i;
 
-		// resolve dependencies
+		/**
+		 * Creates the library namespace inside the global object.
+		 * @deprecated since 1.120
+		 */
+		oLibNamespace = ObjectPath.create(mSettings.name);
+
+		// If a library states that it is using apiVersion 2, we expect types to be fully declared.
+		// In this case we don't need to create Proxies for the library namespace.
+		const apiVersion = mSettings.apiVersion ?? 1;
+		if (apiVersion < 2) {
+			const oLibProxyHandler = createProxyForLibraryNamespace(mSettings.name, oLibNamespace);
+
+			// activate proxy for outer library namespace object
+			oLibNamespace = new Proxy(oLibNamespace, oLibProxyHandler);
+
+			/**
+			 * proxy must be written back to the original path (global)
+			 * @deprecated since 1.120
+			 */
+			ObjectPath.set(mSettings.name, oLibNamespace);
+		}
+
+
+		/**
+		 * Synchronously resolve dependencies
+		 * @deprecated since 1.120
+		 */
 		for (i = 0; i < oLib.dependencies.length; i++) {
 			var sDepLib = oLib.dependencies[i];
 			var oDepLib = Library._get(sDepLib, true /* bCreate */);
@@ -1279,14 +1413,22 @@ sap.ui.define([
 		// register interface types
 		DataType.registerInterfaceTypes(oLib.interfaces);
 
-		// Declare a module for each (non-builtin) simple type
-		// Only needed for backward compatibility: some code 'requires' such types although they never have been modules on their own
+		/**
+		 * Declare a module for each (non-builtin) simple type.
+		 * Only needed for backward compatibility: some code 'requires' such types although they never have been modules on their own.
+		 * @deprecated since 1.120
+		 */
 		for (i = 0; i < oLib.types.length; i++) {
 			if ( !/^(any|boolean|float|int|string|object|void)$/.test(oLib.types[i]) ) {
-				sap.ui.loader._.declareModule(oLib.types[i].replace(/\./g, "/") + ".js");
+				// register a wrapper module that logs a deprecation warning
+				const sTypeName = oLib.types[i];
+				sap.ui.predefine(sTypeName.replace(/\./g, "/"), [], function(sTypeName) {
+					Log.error(`Deprecation: Import the type '${sTypeName}' as a module is deprecated. Please require the corresponding 'library.js' containing the type directly. You can then reference the type via the library's module export.`);
+					return ObjectPath.get(sTypeName);
+				}.bind(null, sTypeName));
 
 				// ensure parent namespace of the type
-				var sNamespacePrefix = oLib.types[i].substring(0, oLib.types[i].lastIndexOf("."));
+				var sNamespacePrefix = sTypeName.substring(0, sTypeName.lastIndexOf("."));
 				if (ObjectPath.get(sNamespacePrefix) === undefined) {
 					// parent type namespace does not exists, so we create its
 					ObjectPath.create(sNamespacePrefix);
@@ -1294,11 +1436,16 @@ sap.ui.define([
 			}
 		}
 
-		// create lazy loading stubs for all controls and elements
-		var aElements = oLib.controls.concat(oLib.elements);
-		for (i = 0; i < aElements.length; i++) {
-			sap.ui.lazyRequire(aElements[i], "new extend getMetadata"); // TODO don't create an 'extend' stub for final classes
-		}
+		/**
+		 * create lazy loading stubs for all controls and elements
+		 * @deprecated since 1.120
+		 */
+		(() => {
+			var aElements = oLib.controls.concat(oLib.elements);
+			for (i = 0; i < aElements.length; i++) {
+				sap.ui.lazyRequire(aElements[i], "new extend getMetadata"); // TODO don't create an 'extend' stub for final classes
+			}
+		})();
 
 			// include the library theme, but only if it has not been suppressed in library metadata or by configuration
 		if (!oLib.noLibraryCSS) {
@@ -1399,13 +1546,11 @@ sap.ui.define([
 	 * For example, when an app uses a heavy-weight charting library that shouldn't be loaded during startup, it can
 	 * declare it as "lazy" and load it just before it loads and displays a view that uses the charting library:
 	 * <pre>
-	 *   Lib.load({name: "heavy.charting"})
-	 *     .then(function() {
-	 *       View.create({
-	 *         name: "myapp.views.HeavyChartingView",
-	 *         type: ViewType.XML
-	 *       });
-	 *     });
+	 *   await Library.load({name: "heavy.charting"});
+	 *   await View.create({
+	 *       name: "myapp.views.HeavyChartingView",
+	 *       type: ViewType.XML
+	 *   });
 	 * </pre>
 	 *
 	 * @param {object} mOptions The options object that contains the following properties
@@ -1476,7 +1621,7 @@ sap.ui.define([
 			}
 		});
 
-		var bPreload = Configuration.getPreload() === 'sync' || Configuration.getPreload() === 'async',
+		var bPreload = Library.getPreloadMode() === 'sync' || Library.getPreloadMode() === 'async',
 			bRequire = !mOptions.preloadOnly;
 
 		if (!mOptions.sync) {
@@ -1493,19 +1638,11 @@ sap.ui.define([
 			return oLib;
 		});
 
-		if (!mOptions.sync) {
-			var pPreloaded = bPreload ?
-				Promise.all(aLibs.map(function(oLib) {
-					var mOptions = {};
-					if (mAdditionalConfig[oLib.name] && mAdditionalConfig[oLib.name].hasOwnProperty("json")) {
-						mOptions.json = mAdditionalConfig[oLib.name].json;
-					}
-					return oLib._preload(mOptions);
-				})) :
-				Promise.resolve(aLibs);
-
-			return bRequire ? pPreloaded.then(requireLibrariesAsync) : pPreloaded;
-		} else {
+		/**
+		 * sync loading
+		 * @deprecated since 1.120
+		 */
+		if (mOptions.sync) {
 			if (bPreload) {
 				aLibs.forEach(function(oLib) {
 					var mOptions = {sync: true};
@@ -1536,6 +1673,18 @@ sap.ui.define([
 
 			return aLibs;
 		}
+
+		const pPreloaded = bPreload ?
+			Promise.all(aLibs.map(function(oLib) {
+				const mOptions = {};
+				if (mAdditionalConfig[oLib.name] && mAdditionalConfig[oLib.name].hasOwnProperty("json")) {
+					mOptions.json = mAdditionalConfig[oLib.name].json;
+				}
+				return oLib._preload(mOptions);
+			})) :
+			Promise.resolve(aLibs);
+
+		return bRequire ? pPreloaded.then(requireLibrariesAsync) : pPreloaded;
 	};
 
 	/**
@@ -1720,7 +1869,7 @@ sap.ui.define([
 	 *
 	 * @returns {boolean} Wether VersionedLibCss is enabled or not
 	 * @private
-	 * @ui-restricted sap.ui.core
+	 * @ui5-restricted sap.ui.core
 	 */
 	Library.getVersionedLibCss = function() {
 		return BaseConfig.get({
@@ -1730,5 +1879,52 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Whether dependency cache info files should be loaded instead of preload files.
+	 *
+	 * @private
+	 * @ui5-restricted sap.ui.core
+	 * @returns {boolean} whether dep-cache info files should be loaded
+	 */
+	Library.isDepCacheEnabled = function() {
+		return BaseConfig.get({
+			name: "sapUiXxDepCache",
+			type: BaseConfig.Type.Boolean,
+			external: true
+		});
+	};
+
+	/**
+	 * Currently active preload mode for libraries or falsy value.
+	 *
+	 * @returns {string} preload mode
+	 * @private
+	 * @ui5-restricted sap.ui.core
+	 * @since 1.120.0
+	 */
+	Library.getPreloadMode = function() {
+		// if debug sources are requested, then the preload feature must be deactivated
+		if (Configuration.getDebug() === true) {
+			return "";
+		}
+		// determine preload mode (e.g. resolve default or auto)
+		let sPreloadMode = BaseConfig.get({
+			name: "sapUiPreload",
+			type: BaseConfig.Type.String,
+			defaultValue: "auto",
+			external: true
+		});
+		// when the preload mode is 'auto', it will be set to 'async' or 'sync' for optimized sources
+		// depending on whether the ui5loader is configured async
+		if ( sPreloadMode === "auto" ) {
+			if (window["sap-ui-optimized"]) {
+				sPreloadMode = sap.ui.loader.config().async ? "async" : "sync";
+			} else {
+				sPreloadMode = "";
+			}
+		}
+		return sPreloadMode;
+	};
+
 	return Library;
 });

package/src/sap/ui/core/ListItem.js

@@ -23,7 +23,7 @@ sap.ui.define(['./Item', './library'],
 	 * @extends sap.ui.core.Item
 	 *
 	 * @author SAP SE
-	 * @version 1.119.1
+	 * @version 1.120.1
 	 *
 	 * @public
 	 * @alias sap.ui.core.ListItem

package/src/sap/ui/core/LocalBusyIndicator.js

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.core.Control
 	 *
 	 * @author SAP SE
-	 * @version 1.119.1
+	 * @version 1.120.1
 	 *
 	 * @public
 	 * @since 1.11.0

package/src/sap/ui/core/Locale.js

@@ -20,7 +20,7 @@ sap.ui.define(['sap/base/assert', 'sap/ui/base/Object', "sap/base/i18n/Localizat
 	 *
 	 * @extends sap.ui.base.Object
 	 * @author SAP SE
-	 * @version 1.119.1
+	 * @version 1.120.1
 	 * @public
 	 * @alias sap.ui.core.Locale
 	 */