@openui5/sap.ui.core 1.123.1 → 1.124.0

package/src/sap/ui/model/odata/type/Stream.js

@@ -60,7 +60,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 * @public
 	 * @since 1.51.0
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 */
 	var Stream = ODataType.extend("sap.ui.model.odata.type.Stream", {
 			constructor : function (oFormatOptions, oConstraints) {

package/src/sap/ui/model/odata/type/String.js

@@ -85,7 +85,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @alias sap.ui.model.odata.type.String
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/Time.js

@@ -138,7 +138,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @alias sap.ui.model.odata.type.Time
 	 * @param {object} [oFormatOptions]

package/src/sap/ui/model/odata/type/TimeOfDay.js

@@ -93,7 +93,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.odata.type.ODataType
 	 * @public
 	 * @since 1.37.0
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 */
 	var TimeOfDay = ODataType.extend("sap.ui.model.odata.type.TimeOfDay", {
 			constructor : function (oFormatOptions, oConstraints) {

package/src/sap/ui/model/odata/type/Unit.js

@@ -66,7 +66,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.type.Unit
 	 * @public
 	 * @since 1.63.0
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 */
 	var Unit = BaseUnit.extend("sap.ui.model.odata.type.Unit", {
 		constructor : function (oFormatOptions, oConstraints, aDynamicFormatOptionNames) {
@@ -80,6 +80,29 @@ sap.ui.define([
 	 * Formats the given values of the parts of the <code>Unit</code> composite type to the given
 	 * target type.
 	 *
+	 * If CLDR or custom units are used and the <code>preserveDecimals</code> format option is set to
+	 * <code>false</code>, the maximal number of decimal places for the numeric part of the
+	 * {@link sap.ui.model.odata.type.Unit} type depends on:
+	 *   <ul>
+	 *     <li>The <code>DecimalPlaces</code> property of the current unit code.
+	 *     <li>The <code>maxFractionDigits</code> format option of the {@link sap.ui.model.odata.type.Unit} type.
+	 *     <li>The <code>scale</code> constraint of the {@link sap.ui.model.odata.type.Decimal} type for the
+	 *       quantity part.
+	 *   </ul>
+	 *   The maximal number of decimal places is determined as follows:
+	 *   <ul>
+	 *     <li>If <code>maxFractionDigits</code> is provided and is less than the current unit code's
+	 *       <code>DecimalPlaces</code>, the <code>maxFractionDigits</code> is used to determine the
+	 *       number of decimal places. Conversely, if <code>DecimalPlaces</code> is less than
+	 *       <code>maxFractionDigits</code>, <code>DecimalPlaces</code> wins.
+	 *     <li>If <code>maxFractionDigits</code> is not provided, the <code>DecimalPlaces</code> of the current unit
+	 *       code is applied, unless it is greater than the <code>scale</code> of the
+	 *       {@link sap.ui.model.odata.type.Decimal} type for the numeric part, in which case <code>scale</code> wins.
+	 *     <li>A <code>scale='variable'</code> is treated as being always greater than the <code>DecimalPlaces</code>
+	 *       of the current unit code. In this case, the <code>DecimalPlaces</code> of the current unit code is
+	 *       applied.
+	 *   </ul>
+	 *
 	 * @param {any[]} aValues
 	 *   Array of part values to be formatted; contains in the following order: measure, unit,
 	 *   unit customizing. The first call to this method where all parts are set determines the unit

package/src/sap/ui/model/odata/v2/Context.js

@@ -64,7 +64,7 @@ sap.ui.define([
 	 * @hideconstructor
 	 * @public
 	 * @since 1.93.0
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 */
 	var Context = BaseContext.extend("sap.ui.model.odata.v2.Context", {
 			constructor : function (oModel, sPath, sDeepPath, oCreatePromise, bInactive,

package/src/sap/ui/model/odata/v2/ODataAnnotations.js

@@ -36,7 +36,7 @@ sap.ui.define([
 	 * @class Annotation loader for OData V2 services
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @public
 	 * @since 1.37.0

package/src/sap/ui/model/odata/v2/ODataModel.js

@@ -33,10 +33,10 @@ sap.ui.define([
 	"sap/base/util/merge",
 	"sap/base/util/uid",
 	"sap/ui/base/SyncPromise",
-	"sap/ui/core/library",
 	"sap/ui/core/Messaging",
 	"sap/ui/core/message/Message",
 	"sap/ui/core/message/MessageParser",
+	"sap/ui/core/message/MessageType",
 	"sap/ui/core/Supportability",
 	"sap/ui/model/_Helper",
 	"sap/ui/model/BindingMode",
@@ -57,7 +57,7 @@ sap.ui.define([
 	"sap/ui/util/isCrossOriginURL"
 ], function(_CreatedContextsCache, Context, ODataAnnotations, ODataContextBinding, ODataListBinding, ODataTreeBinding,
 		assert, Log, Localization, encodeURL, deepEqual, deepExtend, each, extend, isEmptyObject, isPlainObject, merge,
-		uid, SyncPromise, coreLibrary, Messaging, Message, MessageParser, Supportability,  _Helper, BindingMode,
+		uid, SyncPromise, Messaging, Message, MessageParser, MessageType, Supportability, _Helper, BindingMode,
 		BaseContext, FilterProcessor, Model, CountMode, MessageScope, ODataMetadata, ODataMetaModel, ODataMessageParser,
 		ODataPropertyBinding, ODataUtils, OperationMode, UpdateMethod, OData, URI, isCrossOriginURL
 ) {
@@ -66,7 +66,6 @@ sap.ui.define([
 
 	var sClassName = "sap.ui.model.odata.v2.ODataModel",
 		aDeepCreateParametersAllowlist = ["context", "properties"],
-		MessageType = coreLibrary.MessageType,
 		mMessageType2Severity = {},
 		aRequestSideEffectsParametersAllowList = ["groupId", "urlParameters"];
 
@@ -214,7 +213,7 @@ sap.ui.define([
 	 * This model is not prepared to be inherited from.
 	 *
 	 * @author SAP SE
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 *
 	 * @public
 	 * @alias sap.ui.model.odata.v2.ODataModel
@@ -2185,14 +2184,12 @@ sap.ui.define([
 	 *     OperationMode.Client}, and</li>
 	 *   <li>the {@link sap.ui.table.TreeTable} is used.</li>
 	 *   </ul>
-	 *   The feature is only available when using the <code>ODataTreeBindingAdapter</code>, which is
-	 *   automatically applied when using the <code>sap.ui.table.TreeTable</code>. The tree state
-	 *   handle will contain all necessary information to expand the tree to the given state.
+	 *   The feature is only available when using the {@link sap.ui.table.TreeTable}. The tree
+	 *   state handle will contain all necessary information to expand the tree to the given state.
 	 *
 	 *   This feature is not supported if
 	 *   {@link sap.ui.model.odata.OperationMode.Server OperationMode.Server} or
-	 *   {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is used. See also
-	 *   {@link sap.ui.model.odata.ODataTreeBindingAdapter#getCurrentTreeState}
+	 *   {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is used.
 	 *  @param {sap.ui.model.odata.CountMode} [mParameters.countMode]
 	 *    Defines the count mode of this binding; if not specified, the default count mode of the
 	 *    binding's model is applied. The resulting count mode must not be

package/src/sap/ui/model/odata/v2/ODataTreeBinding.js

@@ -103,7 +103,7 @@ sap.ui.define([
 	 * @extends sap.ui.model.TreeBinding
 	 * @hideconstructor
 	 * @public
-	 * @version 1.123.1
+	 * @version 1.124.0
 	 */
 	var ODataTreeBinding = TreeBinding.extend("sap.ui.model.odata.v2.ODataTreeBinding", /** @lends sap.ui.model.odata.v2.ODataTreeBinding.prototype */ {
 

package/src/sap/ui/model/odata/v4/Context.js

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.123.1
+		 * @version 1.124.0
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -882,7 +882,7 @@ sap.ui.define([
 		if (this.iIndex === undefined) {
 			return undefined;
 		}
-		if (this.oBinding.isFirstCreateAtEnd()) {
+		if (this.oBinding?.isFirstCreateAtEnd()) {
 			if (this.iIndex < 0) { // this does not include undefined for a kept-alive context
 				return this.oBinding.bLengthFinal
 					? this.oBinding.iMaxLength - this.iIndex - 1
@@ -910,7 +910,7 @@ sap.ui.define([
 	 * @private
 	 */
 	Context.prototype.getModelIndex = function () {
-		if (this.iIndex !== undefined && this.oBinding.iCreatedContexts) {
+		if (this.iIndex !== undefined && this.oBinding?.iCreatedContexts) {
 			return this.iIndex + this.oBinding.iCreatedContexts;
 		}
 		return this.iIndex;
@@ -1263,6 +1263,7 @@ sap.ui.define([
 	 *
 	 * @public
 	 * @see #isInactive
+	 * @see #move
 	 * @since 1.43.0
 	 */
 	Context.prototype.isTransient = function () {
@@ -1270,47 +1271,81 @@ sap.ui.define([
 	};
 
 	/**
-	 * Moves this node to the given parent (in case of a recursive hierarchy, see
-	 * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}, where
-	 * <code>oAggregation.expandTo</code> must be either one or at least
-	 * <code>Number.MAX_SAFE_INTEGER</code>). No other
+	 * In a {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation recursive hierarchy}, this
+	 * method moves a node to the given new parent, just before the given next sibling. No other
 	 * {@link sap.ui.model.odata.v4.ODataListBinding#create creation}, {@link #delete deletion}, or
-	 * move must be pending, and no other modification (including collapse of some ancestor node)
-	 * must happen while this move is pending! Omitting a new parent turns this node into a root
-	 * node (since 1.121.0).
-	 *
-	 * This context's {@link #getIndex index} may change and, in case of
-	 * <code>oAggregation.expandTo : 1</code>, it becomes "created persisted", with
-	 * {@link #isTransient} returning <code>false</code> etc. In case of
-	 * <code>oAggregation.expandTo >= Number.MAX_SAFE_INTEGER</code>, a created node becomes simply
-	 * "persisted", with {@link #isTransient} returning <code>undefined</code> etc.
-	 *
-	 * @param {object} [oParameters] - A parameter object
-	 * @param {sap.ui.model.odata.v4.Context} [oParameters.parent=null] - The new parent's context
+	 * move must be pending, and no other modification (including the collapse of an ancestor node)
+	 * must happen while this move is pending!
+	 *
+	 * The move potentially changes the {@link #getIndex index} of this context, of all of its
+	 * descendants, and of all other nodes affected by the move. Any index change can, however, only
+	 * be observed reliably for this context itself.
+	 *
+	 * The move changes the
+	 * {@link topic:c9723f8265f644af91c0ed941e114d46/section_CST context states} of the nodes as
+	 * follows:
+	 * <ul>
+	 *   <li> If the moved node is in the "created" state, it becomes simply "persisted", with
+	 *     {@link #isTransient} returning <code>undefined</code>. In this case, any descendants of
+	 *     this node are themselves in the "created" state and also become "persisted"; otherwise,
+	 *     their states remain unaffected by the move.
+	 *   <li> If the moved node's new parent node is in the "created" state, the parent's
+	 *     lowest-level {@link getParent ancestor} is determined that is also in the "created" state
+	 *     (if no ancestor nodes are in "created" state, this will be the new parent itself). Any
+	 *     descendants of that node are then themselves in the "created" state and also become
+	 *     "persisted"; otherwise, their states remain unaffected by the move.
+	 * </ul>
+	 *
+	 * Note that a node in the "created" state is not shown in its usual position as defined by the
+	 * service and the current sort order, but out of place as the first child of its parent. It is
+	 * even shown if it doesn't match current search or filter criteria! Once it becomes simply
+	 * "persisted" due to the move (as described above), this special handling ends. The node is
+	 * then shown in place again, or it might even not be shown anymore due to the search or filter
+	 * criteria. If the latter happens to this context, its {@link #getIndex index} becomes
+	 * <code>undefined</code>.
+	 *
+	 * @param {object} oParameters - A parameter object
+	 * @param {sap.ui.model.odata.v4.Context|null} [oParameters.nextSibling]
+	 *   The next sibling's context, or <code>null</code> to turn this node into the last sibling
+	 *   (since 1.124.0). Omitting the sibling moves this node to a position determined by the
+	 *   server.
+	 * @param {sap.ui.model.odata.v4.Context|null} oParameters.parent
+	 *   The new parent's context, or (since 1.121.0) <code>null</code> to turn this node into a
+	 *   root node
 	 * @returns {Promise<void>}
 	 *   A promise which is resolved without a defined result when the move is finished, or
 	 *   rejected in case of an error
 	 * @throws {Error} If
 	 *   <ul>
-	 *     <li> the parent is (a descendant of) this node,
-	 *     <li> <code>oAggregation.expandTo</code> is unsupported,
-	 *     <li> this node is {@link #isDeleted deleted},
-	 *     <li> this node is {@link #isTransient transient},
-	 *     <li> this node is not in the collection (has no {@link #getIndex index}).
+	 *     <li> there is no recursive hierarchy,
+	 *     <li> the new parent is (a descendant of) this node,
+	 *     <li> this node or the new parent is
+	 *       <ul>
+	 *         <li> {@link #isDeleted deleted},
+	 *         <li> {@link #isTransient transient},
+	 *         <li> not in the collection (has no {@link #getIndex index}).
+	 *     </ul>
 	 *   </ul>
 	 *
 	 * @experimental As of version 1.119.0
 	 * @public
 	 */
-	Context.prototype.move = function ({parent : oParent = null} = {}) {
+	Context.prototype.move = function ({nextSibling : oNextSibling, parent : oParent} = {}) {
+		if (oNextSibling === undefined && oParent === undefined) {
+			return Promise.resolve(); // "no move happens"
+		}
 		if (this.isDeleted() || this.isTransient() || this.iIndex === undefined) {
 			throw new Error("Cannot move " + this);
 		}
+		if (oParent
+			&& (oParent.isDeleted() || oParent.isTransient() || oParent.iIndex === undefined)) {
+			throw new Error("Cannot move to " + oParent);
+		}
 		if (this.isAncestorOf(oParent)) {
 			throw new Error("Unsupported parent context: " + oParent);
 		}
 
-		return Promise.resolve(this.oBinding.move(this, oParent));
+		return Promise.resolve(this.oBinding.move(this, oParent, oNextSibling));
 	};
 
 	/**
@@ -1976,23 +2011,6 @@ sap.ui.define([
 		this.bSelected = false;
 	};
 
-	/**
-	 * Sets this context's state from "persisted" to "created persisted".
-	 *
-	 * Note: this is a private and internal API. Do not call this!
-	 *
-	 * @throws {Error} If this context is already "created"
-	 *
-	 * @private
-	 */
-	Context.prototype.setCreatedPersisted = function () {
-		if (this.oCreatedPromise) {
-			throw new Error("Already 'created', currently transient: " + this.isTransient());
-		}
-		this.oCreatedPromise = Promise.resolve();
-		this.oSyncCreatePromise = SyncPromise.resolve();
-	};
-
 	/**
 	 * Sets the inactive flag to <code>true</code>
 	 *
@@ -2179,6 +2197,7 @@ sap.ui.define([
 	 * @see sap.ui.model.odata.v4.ODataListBinding#event:patchCompleted
 	 * @since 1.67.0
 	 */
+	// @override sap.ui.model.Context#setProperty
 	Context.prototype.setProperty = function (sPath, vValue, sGroupId, bRetry) {
 		var oGroupLock = null,
 			oModel = this.oModel,
@@ -2210,8 +2229,12 @@ sap.ui.define([
 	 * the preconditions of {@link #setKeepAlive} hold, a best effort is made to implicitly keep a
 	 * selected context alive in order to preserve the selection state. Once the selection is no
 	 * longer needed, for example because you perform an operation on this context which logically
-	 * removes it from its list, you need to reset the selection. If this context is a header
-	 * context of a list binding, the new selection state is propagated to all row contexts.
+	 * removes it from its list, you need to reset the selection.
+	 *
+	 * If this context is a header context of a list binding, the new selection state is propagated
+	 * to all row contexts. This method can be called repeatedly with the same value to again select
+	 * all row contexts. For example, if a row context was deselected explicitly, it is selected
+	 * again by selecting the header context (even if the header context is already selected).
 	 *
 	 * <b>Note:</b> It is unsafe to keep a reference to a context instance which is not
 	 * {@link #isKeepAlive kept alive}.
@@ -2232,12 +2255,14 @@ sap.ui.define([
 		if (bSelected && this.isDeleted()) {
 			throw new Error("Must not select a deleted entity: " + this);
 		}
+		if (this.oBinding.getHeaderContext() === this) {
+			this.oBinding._getAllExistingContexts().forEach(function (oContext) {
+				oContext.setSelected(bSelected);
+			});
+		}
 		if (bSelected !== this.bSelected) {
 			if (this.mChangeListeners) { // header context: "select all"
 				_Helper.fireChange(this.mChangeListeners, "", bSelected);
-				this.oBinding._getAllExistingContexts().forEach(function (oContext) {
-					oContext.setSelected(bSelected);
-				});
 			}
 			this.withCache((oCache, sPath) => {
 				if (this.oBinding) {

package/src/sap/ui/model/odata/v4/ODataBinding.js

@@ -152,13 +152,14 @@ sap.ui.define([
 	 *     {@link sap.ui.model.odata.v4.ODataListBinding#updateAnalyticalInfo} (but without
 	 *     validation here)
 	 *   <li> '$$canonicalPath' with value <code>true</code>
+	 *   <li> '$$clearSelectionOnFilter' with value <code>true</code>
 	 *   <li> '$$groupId' with allowed values as specified in {@link #checkGroupId}
-	 *   <li> '$$updateGroupId' with allowed values as specified in {@link #checkGroupId}
 	 *   <li> '$$inheritExpandSelect' with allowed values <code>false</code> and <code>true</code>
-	 *   <li> "$$noPatch" with value <code>true</code>
+	 *   <li> '$$noPatch' with value <code>true</code>
 	 *   <li> '$$operationMode' with value {@link sap.ui.model.odata.OperationMode.Server}
 	 *   <li> '$$ownRequest' with value <code>true</code>
 	 *   <li> '$$patchWithoutSideEffects' with value <code>true</code>
+	 *   <li> '$$updateGroupId' with allowed values as specified in {@link #checkGroupId}
 	 * </ul>
 	 *
 	 * @param {object} mParameters
@@ -233,6 +234,7 @@ sap.ui.define([
 						});
 					// falls through
 				case "$$canonicalPath":
+				case "$$clearSelectionOnFilter":
 				case "$$noPatch":
 				case "$$ownRequest":
 				case "$$patchWithoutSideEffects":

package/src/sap/ui/model/odata/v4/ODataContextBinding.js

@@ -74,7 +74,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.123.1
+		 * @version 1.124.0
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding