@openui5/sap.ui.core 1.122.0 → 1.123.0

package/src/sap/ui/test/generic/TestBase.js

@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 * @abstract
 	 * @author SAP SE
-	 * @version 1.122.0
+	 * @version 1.123.0
 	 * @since 1.100
 	 */
 	return BaseObject.extend("sap.ui.test.generic.TestBase", {

package/src/sap/ui/util/Storage.js

@@ -277,7 +277,7 @@ sap.ui.define(["sap/base/assert"], function (assert) {
 	 *
 	 * @enum {string}
 	 * @public
-	 * @version 1.122.0
+	 * @version 1.123.0
 	 */
 	Storage.Type = {
 		/**

package/src/sap/ui/util/_enforceNoReturnValue.js

@@ -12,7 +12,9 @@ sap.ui.define([
 	function _enforceNoReturnValue(vResult, mLogInfo) {
 		if (vResult !== undefined) {
 			const sFunctionName = mLogInfo.name ? `'${mLogInfo.name}' ` : '';
-			// @deprecated
+			/**
+			 * @deprecated
+			 */
 			if (typeof vResult.then === "function") {
 				vResult.catch((err) => {
 					Log.error(`The registered Event Listener ${sFunctionName}of '${mLogInfo.component}' failed.`, err);

package/src/ui5loader-autoconfig.js

@@ -761,7 +761,7 @@
 	/** autoconfig */
 	var sBaseUrl, bNojQuery,
 		aScripts, rBootScripts, i,
-		sBootstrapUrl, bExposeAsAMDLoader = false;
+		sBootstrapUrl;
 
 	function findBaseUrl(oScript, rUrlPattern) {
 		var sUrl = oScript && oScript.getAttribute("src"),
@@ -972,19 +972,25 @@
 		freeze: true
 	});
 
-	// xx-future implicitly sets the loader to async
-	const bAsync = BaseConfig.get({
-		name: "sapUiAsync",
-		type: BaseConfig.Type.Boolean,
-		external: true,
-		freeze: true
-	}) || bFuture;
+	/**
+	 * Evaluate legacy configuration.
+	 * @deprecated As of version 1.120
+	 */
+	(() => {
+		// xx-future implicitly sets the loader to async
+		const bAsync = BaseConfig.get({
+			name: "sapUiAsync",
+			type: BaseConfig.Type.Boolean,
+			external: true,
+			freeze: true
+		}) || bFuture;
 
-	if (bAsync) {
-		ui5loader.config({
-			async: true
-		});
-	}
+		if (bAsync) {
+			ui5loader.config({
+				async: true
+			});
+		}
+	})();
 
 	// Note: loader converts any NaN value to a default value
 	ui5loader._.maxTaskDuration = BaseConfig.get({
@@ -996,7 +1002,7 @@
 	});
 
 	// support legacy switch 'noLoaderConflict', but 'amdLoader' has higher precedence
-	bExposeAsAMDLoader = BaseConfig.get({
+	const bExposeAsAMDLoader = BaseConfig.get({
 		name: "sapUiAmd",
 		type: BaseConfig.Type.Boolean,
 		defaultValue: !BaseConfig.get({
@@ -1010,7 +1016,7 @@
 		freeze: true
 	});
 
-	//calculate syncCallBehavior
+	// calculate syncCallBehavior
 	let syncCallBehavior = 0; // ignore
 	let sNoSync = BaseConfig.get({ // call must be made to ensure freezing
 		name: "sapUiXxNoSync",
@@ -1029,7 +1035,7 @@
 	}
 
 	/**
-	 * @deprecated As of Version 1.120
+	 * @deprecated As of version 1.120
 	 */
 	(() => {
 		const GlobalConfigurationProvider = sap.ui.require("sap/base/config/GlobalConfigurationProvider");

package/src/ui5loader.js

@@ -122,6 +122,7 @@
 	 *
 	 * To be used by code coverage, only supported in sync mode.
 	 * @private
+	 * @ui5-transform-hint replace-local undefined
 	 */
 	let translate;
 
@@ -146,6 +147,7 @@
 	 * When activated, require will load asynchronously, else synchronously.
 	 * @type {boolean}
 	 * @private
+	 * @ui5-transform-hint replace-local true
 	 */
 	let bGlobalAsyncMode = false;
 
@@ -1526,6 +1528,7 @@
 	 * @throws {Error} When loading failed in sync mode
 	 *
 	 * @private
+	 * @ui5-transform-hint replace-param bAsync true
 	 */
 	function requireModule(oRequestingModule, sModuleName, bAsync, bSkipShimDeps, bSkipBundle) {
 
@@ -1720,7 +1723,11 @@
 		}
 	}
 
-	// sModuleName must be a normalized resource name of type .js
+	/**
+	 * Note: `sModuleName` must be a normalized resource name of type .js
+	 * @private
+	 * @ui5-transform-hint replace-param bAsync true
+	 */
 	function execModule(sModuleName, bAsync) {
 
 		const oModule = mModules[sModuleName];
@@ -1826,6 +1833,10 @@
 		}
 	}
 
+	/**
+	 * @private
+	 * @ui5-transform-hint replace-param bAsync true
+	 */
 	function requireAll(oRequestingModule, aDependencies, fnCallback, fnErrCallback, bAsync) {
 
 		const aModules = [];
@@ -1893,6 +1904,11 @@
 		}
 	}
 
+	/**
+	 * @private
+	 * @ui5-transform-hint replace-param bAsync true
+	 * @ui5-transform-hint replace-param bExport false
+	 */
 	function executeModuleDefinition(sResourceName, aDependencies, vFactory, bExport, bAsync) {
 		const bLoggable = log.isLoggable();
 		sResourceName = normalize(sResourceName);
@@ -2012,6 +2028,10 @@
 
 	}
 
+	/**
+	 * @private
+	 * @ui5-transform-hint replace-param bExport false
+	 */
 	function ui5Define(sModuleName, aDependencies, vFactory, bExport) {
 		let sResourceName;
 
@@ -2202,6 +2222,10 @@
 		return unwrapExport(requireModule(null, sModuleName, /* bAsync = */ false));
 	}
 
+	/**
+	 * @private
+	 * @ui5-transform-hint replace-param bExport false
+	 */
 	function predefine(sModuleName, aDependencies, vFactory, bExport) {
 		if ( typeof sModuleName !== 'string' ) {
 			throw new Error("predefine requires a module name");
@@ -2565,9 +2589,17 @@
 		set measure(v) {
 			measure = v;
 		},
+		/**
+		 * @deprecated As of version 1.120, sync loading is deprecated without replacement due to the deprecation
+		 *   of sync XMLHttpRequests in the web standard.
+		 */
 		get translate() {
 			return translate;
 		},
+		/**
+		 * @deprecated As of version 1.120, sync loading is deprecated without replacement due to the deprecation
+		 *   of sync XMLHttpRequests in the web standard.
+		 */
 		set translate(v) {
 			translate = v;
 		},
@@ -2588,6 +2620,9 @@
 		amdDefine,
 		amdRequire,
 		config: ui5Config,
+		/**
+		 * @deprecated As of version 1.120, all usages of this private API have been deprecated
+		 */
 		declareModule(sResourceName, sDeprecationMessage) {
 			/* void */ declareModule(normalize(sResourceName), sDeprecationMessage);
 		},
@@ -3282,6 +3317,8 @@
 	 * @ui5-restricted sap.ui.core
 	 * @function
 	 * @ui5-global-only
+	 * @deprecated As of version 1.120, sync loading is deprecated without replacement due to the deprecation
+	 *   of sync XMLHttpRequests in the web standard.
 	 */
 	sap.ui.requireSync = requireSync;
 

package/test/sap/ui/core/demokit/docuindex.json

@@ -186,9 +186,20 @@
 				"category": "Display",
 				"since": "1.30",
 				"samples": [
-					"sap.ui.core.sample.MessageManager.BasicMessages",
-					"sap.ui.core.sample.MessageManager.BasicODataMessages",
-					"sap.ui.core.sample.MessageManager.ODataBackendMessagesComp"
+					"sap.ui.core.sample.Messaging.BasicMessages",
+					"sap.ui.core.sample.Messaging.BasicODataMessages",
+					"sap.ui.core.sample.Messaging.ODataBackendMessagesComp"
+				]
+			},
+			{
+				"id": "sap.ui.core.Messaging",
+				"name": "Messaging",
+				"category": "Display",
+				"since": "1.118",
+				"samples": [
+					"sap.ui.core.sample.Messaging.BasicMessages",
+					"sap.ui.core.sample.Messaging.BasicODataMessages",
+					"sap.ui.core.sample.Messaging.ODataBackendMessagesComp"
 				]
 			},
 			{
@@ -788,17 +799,17 @@
 				"description": "The descendant matcher checks if a control has a given descendant."
 			},
 			{
-				"id": "sap.ui.core.sample.MessageManager.BasicMessages",
+				"id": "sap.ui.core.sample.Messaging.BasicMessages",
 				"name": "Basic Messages",
 				"description": "Shows how to create messages on the frontend and display them afterwards. This can be used for form validation on the frontend."
 			},
 			{
-				"id": "sap.ui.core.sample.MessageManager.BasicODataMessages",
+				"id": "sap.ui.core.sample.Messaging.BasicODataMessages",
 				"name": "Basic OData Messages",
 				"description": "Uses the OData V2 mock server to simulate an OData response containing different types of server side messages (error, warning, info, success)."
 			},
 			{
-				"id": "sap.ui.core.sample.MessageManager.ODataBackendMessagesComp",
+				"id": "sap.ui.core.sample.Messaging.ODataBackendMessagesComp",
 				"name": "OData Messages Component",
 				"description": "Shows how to handle OData responses containing server side messages in component based apps. Also illustrates how the sap-message header works."
 			},

package/test/sap/ui/core/demokit/sample/{MessageManager → Messaging}/BasicMessages/Component.js

@@ -3,7 +3,7 @@ sap.ui.define([
 ], function (UIComponent) {
 	"use strict";
 
-	return UIComponent.extend("sap.ui.core.sample.MessageManager.BasicMessages.Component", {
+	return UIComponent.extend("sap.ui.core.sample.Messaging.BasicMessages.Component", {
 		metadata: {
 			manifest: "json"
 		}

package/test/sap/ui/core/demokit/sample/{MessageManager → Messaging}/BasicMessages/Controller.controller.js

@@ -1,26 +1,21 @@
 sap.ui.define([
-	"sap/ui/core/mvc/Controller",
-	"sap/ui/model/json/JSONModel",
-	"sap/ui/model/BindingMode",
+	"sap/ui/core/library",
 	"sap/ui/core/Messaging",
 	"sap/ui/core/message/Message",
-	"sap/ui/core/library",
-	"sap/ui/core/Fragment"
-], function(Controller, JSONModel, BindingMode, Messaging, Message, library, Fragment) {
+	"sap/ui/core/message/MessageType",
+	"sap/ui/core/mvc/Controller",
+	"sap/ui/model/BindingMode",
+	"sap/ui/model/json/JSONModel"
+], function(coreLibrary, Messaging, Message, MessageType, Controller, BindingMode, JSONModel) {
 	"use strict";
 
 	// shortcut for sap.ui.core.ValueState
-	var ValueState = library.ValueState;
+	const { ValueState } = coreLibrary;
 
-	// shortcut for sap.ui.core.MessageType
-	var MessageType = library.MessageType;
+	return Controller.extend("sap.ui.core.sample.Messaging.BasicMessages.Controller", {
 
-	return Controller.extend("sap.ui.core.sample.MessageManager.BasicMessages.Controller", {
-
-		onInit : function () {
-			var oModel, oView;
-
-			oView = this.getView();
+		onInit() {
+			const oView = this.getView();
 
 			// set message model
 			oView.setModel(Messaging.getMessageModel(), "message");
@@ -29,7 +24,7 @@ sap.ui.define([
 			Messaging.registerObject(oView, true);
 
 			// create a default model with somde demo data
-			oModel = new JSONModel({
+			const oModel = new JSONModel({
 				MandatoryInputValue: "",
 				DateValue: null,
 				IntegerValue: undefined,
@@ -37,18 +32,16 @@ sap.ui.define([
 			});
 			oModel.setDefaultBindingMode(BindingMode.TwoWay);
 			oView.setModel(oModel);
-
 		},
 
-		onMessagePopoverPress : function (oEvent) {
-			var oSourceControl = oEvent.getSource();
-			this._getMessagePopover().then(function(oMessagePopover){
-				oMessagePopover.openBy(oSourceControl);
-			});
+		async onMessagePopoverPress(oEvent) {
+			const oSourceControl = oEvent.getSource();
+			const oMessagePopover = await this._getMessagePopover();
+			oMessagePopover.openBy(oSourceControl);
 		},
 
-		onSuccessPress : function(){
-			var oMessage = new Message({
+		onSuccessPress() {
+			const oMessage = new Message({
 				message: "My generated success message",
 				type: MessageType.Success,
 				target: "/Dummy",
@@ -57,8 +50,8 @@ sap.ui.define([
 			Messaging.addMessages(oMessage);
 		},
 
-		onErrorPress : function(){
-			var oMessage = new Message({
+		onErrorPress() {
+			const oMessage = new Message({
 				message: "My generated error message",
 				type: MessageType.Error,
 				target: "/Dummy",
@@ -67,8 +60,8 @@ sap.ui.define([
 			Messaging.addMessages(oMessage);
 		},
 
-		onWarningPress : function(){
-			var oMessage = new Message({
+		onWarningPress() {
+			const oMessage = new Message({
 				message: "My generated warning message",
 				type: MessageType.Warning,
 				target: "/Dummy",
@@ -77,8 +70,8 @@ sap.ui.define([
 			Messaging.addMessages(oMessage);
 		},
 
-		onInfoPress : function(){
-			var oMessage = new Message({
+		onInfoPress() {
+			const oMessage = new Message({
 				message: "My generated info message",
 				type: MessageType.Information,
 				target: "/Dummy",
@@ -87,33 +80,23 @@ sap.ui.define([
 			Messaging.addMessages(oMessage);
 		},
 
-		onValueStatePress : function(){
-			var oInput = this.getView().byId("valuesStateOnly");
+		onValueStatePress() {
+			const oInput = this.getView().byId("valuesStateOnly");
 			oInput.setValueState(ValueState.Error);
 			oInput.setValueStateText("My ValueState text for Error");
 		},
 
-		onClearPress : function(){
+		onClearPress() {
 			// does not remove the manually set ValueStateText we set in onValueStatePress():
 			Messaging.removeAllMessages();
 		},
 
 		//################ Private APIs ###################
 
-		_getMessagePopover: function () {
-			var oView = this.getView();
-
-			// create popover lazily (singleton)
-			if (!this._pMessagePopover) {
-				this._pMessagePopover = Fragment.load({
-					id: oView.getId(),
-					name: "sap.ui.core.sample.MessageManager.BasicMessages.MessagePopover"
-				}).then(function (oMessagePopover) {
-					oView.addDependent(oMessagePopover);
-					return oMessagePopover;
-				});
-			}
-			return this._pMessagePopover;
+		_getMessagePopover() {
+			return this.loadFragment({
+				name: "sap.ui.core.sample.Messaging.BasicMessages.MessagePopover"
+			});
 		}
 	});
 

package/test/sap/ui/core/demokit/sample/Messaging/BasicMessages/MessagePopover.fragment.xml

@@ -0,0 +1,13 @@
+<core:FragmentDefinition
+	xmlns="sap.m"
+	xmlns:core="sap.ui.core">
+	<MessagePopover
+		items="{message>/}"
+		initiallyExpanded="true">
+		<MessageItem
+			type="{message>type}"
+			title="{message>message}"
+			subtitle="{message>additionalText}"
+			description="{message>description}"/>
+	</MessagePopover>
+</core:FragmentDefinition>

package/test/sap/ui/core/demokit/sample/Messaging/BasicMessages/View.view.xml

@@ -0,0 +1,135 @@
+<mvc:View
+	controllerName="sap.ui.core.sample.Messaging.BasicMessages.Controller"
+	xmlns="sap.m"
+	xmlns:mvc="sap.ui.core.mvc"
+	xmlns:form="sap.ui.layout.form"
+	height="100%"
+	displayBlock="true">
+
+	<Page
+		id="page"
+		showHeader="false"
+		class="sapUiContentPadding">
+		<content>
+			<form:Form
+				id="form"
+				editable="true"
+				title="UI Messages">
+				<form:layout>
+					<form:ResponsiveGridLayout />
+				</form:layout>
+				<form:formContainers>
+					<form:FormContainer
+						id="formContainer"
+						title="Fields">
+
+						<form:FormElement>
+							<form:label>
+								<Label
+									text="String\{3,10\}"
+									required="true"/>
+							</form:label>
+							<form:fields>
+								<Input
+									id="mandatoryInput"
+									value="{
+										path: '/MandatoryInputValue',
+										type: 'sap.ui.model.type.String',
+										constraints: {
+											minLength: 3,
+											maxLength: 10
+										}
+									}"/>
+							</form:fields>
+						</form:FormElement>
+
+						<form:FormElement>
+							<form:label>
+								<Label text="DatePicker"/>
+							</form:label>
+							<form:fields>
+								<DatePicker
+									id="date"
+									value="{
+										path:'/DateValue',
+										type:'sap.ui.model.type.Date',
+										formatOptions: {
+											style: 'short',
+											strictParsing: true
+										},
+										constraints: { }
+									}" />
+							</form:fields>
+						</form:FormElement>
+
+						<form:FormElement>
+							<form:label>
+								<Label text="Integer 0-100"/>
+							</form:label>
+							<form:fields>
+								<Input
+									id="int"
+									value="{
+										path: '/IntegerValue',
+										type:'sap.ui.model.type.Integer',
+										constraints: {
+											minimum: 0,
+											maximum: 100
+										}
+									}"/>
+							</form:fields>
+						</form:FormElement>
+
+						<form:FormElement>
+							<form:label>
+								<Label text="Message Buttons"/>
+							</form:label>
+							<form:fields>
+								<Input
+									id="dummy"
+									value="{/Dummy}"/>
+							</form:fields>
+						</form:FormElement>
+
+						<form:FormElement>
+							<form:label>
+								<Label text="ValueState Only"/>
+							</form:label>
+							<form:fields>
+								<Input
+									id="valuesStateOnly"
+									value="{/ValueStateOnly}"/>
+							</form:fields>
+						</form:FormElement>
+
+					</form:FormContainer>
+				</form:formContainers>
+			</form:Form>
+		</content>
+
+		<footer>
+			<Toolbar
+				id="otbFooter">
+
+				<Button
+					icon="sap-icon://alert"
+					text="{= ${message>/}.length }"
+					visible="{= ${message>/}.length > 0 }"
+					type="Emphasized"
+					press="onMessagePopoverPress" />
+
+				<ToolbarSpacer/>
+
+				<Button type="Accept" text="Success" press="onSuccessPress"/>
+				<Button type="Reject" text="Error" press="onErrorPress"/>
+				<Button text="Warning" press="onWarningPress"/>
+				<Button text="Info" press="onInfoPress"/>
+				<Button text="ValueState" press="onValueStatePress"/>
+				<Button text="Clear" press="onClearPress"/>
+
+			</Toolbar>
+		</footer>
+
+	</Page>
+
+</mvc:View>

package/test/sap/ui/core/demokit/sample/{MessageManager → Messaging}/BasicMessages/manifest.json

@@ -1,6 +1,6 @@
 {
 	"sap.app": {
-		"id": "sap.ui.core.sample.MessageManager.BasicMessages",
+		"id": "sap.ui.core.sample.Messaging.BasicMessages",
 		"applicationVersion": {
 			"version": "1.0.0"
 		}
@@ -8,7 +8,7 @@
 	"sap.ui5": {
 		"rootView": {
 			"async": true,
-			"viewName": "sap.ui.core.sample.MessageManager.BasicMessages.View"
+			"viewName": "sap.ui.core.sample.Messaging.BasicMessages.View"
 		},
 		"dependencies": {
 			"libs": {

package/test/sap/ui/core/demokit/sample/{MessageManager → Messaging}/BasicODataMessages/Component.js

@@ -3,7 +3,7 @@ sap.ui.define([
 ], function (UIComponent) {
 	"use strict";
 
-	return UIComponent.extend("sap.ui.core.sample.MessageManager.BasicODataMessages.Component", {
+	return UIComponent.extend("sap.ui.core.sample.Messaging.BasicODataMessages.Component", {
 		metadata: {
 			manifest: "json"
 		}

package/test/sap/ui/core/demokit/sample/Messaging/BasicODataMessages/Controller.controller.js

@@ -0,0 +1,58 @@
+sap.ui.define([
+	"./localService/mockserver",
+	"sap/ui/core/Messaging",
+	"sap/ui/core/mvc/Controller",
+	"sap/ui/model/odata/v2/ODataModel"
+], function(mockserver, Messaging, Controller, ODataModel) {
+	"use strict";
+
+	return Controller.extend("sap.ui.core.sample.Messaging.BasicODataMessages.Controller", {
+
+		onInit() {
+			// set message model
+			this.getView().setModel(Messaging.getMessageModel(), "message");
+
+			// activate automatic message generation for complete view
+			Messaging.registerObject(this.getView(), true);
+
+			const sODataServiceUrl = "/here/goes/your/odata/service/url/";
+
+			// init our mock server
+			mockserver.init(sODataServiceUrl);
+
+			// Northwind service
+			this.getView().setModel(
+				new ODataModel(sODataServiceUrl, {
+					defaultBindingMode : "TwoWay"
+				})
+			);
+
+			this.getView().bindElement("/Employees(1)");
+		},
+
+		async onMessagePopoverPress(oEvent) {
+			const oSourceControl = oEvent.getSource();
+			const oMessagePopover = await this._getMessagePopover();
+			oMessagePopover.openBy(oSourceControl);
+		},
+
+		onDelete() {
+			const sPath = this.getView().getBindingContext().getPath();
+			this.getView().getModel().remove(sPath);
+		},
+
+		onClearPress() {
+			Messaging.removeAllMessages();
+		},
+
+		//################ Private APIs ###################
+
+		_getMessagePopover() {
+			return this.loadFragment({
+				name: "sap.ui.core.sample.Messaging.BasicODataMessages.MessagePopover"
+			});
+		}
+
+	});
+
+});

package/test/sap/ui/core/demokit/sample/Messaging/BasicODataMessages/MessagePopover.fragment.xml

@@ -0,0 +1,13 @@
+<core:FragmentDefinition
+	xmlns="sap.m"
+	xmlns:core="sap.ui.core">
+	<MessagePopover
+		items="{message>/}"
+		initiallyExpanded="true">
+		<MessageItem
+			type="{message>type}"
+			title="{message>message}"
+			subtitle="{message>additionalText}"
+			description="{message>description}"/>
+	</MessagePopover>
+</core:FragmentDefinition>