@openui5/sap.ui.core 1.124.1 → 1.125.0

package/src/sap/ui/model/odata/v4/lib/_Cache.js

@@ -1129,6 +1129,32 @@ sap.ui.define([
 	 * @public
 	 */
 
+	/**
+	 * Returns an array containing all current elements of a collection or single cache for the
+	 * given relative path; the array is annotated with the collection's $count. If there are
+	 * pending requests, the corresponding promises will be ignored and set to
+	 * <code>undefined</code>.
+	 *
+	 * @param {string} [sPath]
+	 *   Relative path to drill-down into, may be empty (only for collection cache)
+	 * @returns {object[]} The cache elements
+	 *
+	 * @public
+	 */
+	_Cache.prototype.getAllElements = function (sPath) {
+		var aAllElements;
+
+		if (sPath) {
+			return this.getValue(sPath);
+		}
+		aAllElements = this.aElements.map(function (oElement) {
+			return oElement instanceof SyncPromise ? undefined : oElement;
+		});
+		aAllElements.$count = this.aElements.$count;
+
+		return aAllElements;
+	};
+
 	/**
 	 * Returns the collection at the given path and removes it from the cache if it is marked as
 	 * transferable.
@@ -1160,32 +1186,6 @@ sap.ui.define([
 		return vValue;
 	};
 
-	/**
-	 * Returns an array containing all current elements of a collection or single cache for the
-	 * given relative path; the array is annotated with the collection's $count. If there are
-	 * pending requests, the corresponding promises will be ignored and set to
-	 * <code>undefined</code>.
-	 *
-	 * @param {string} [sPath]
-	 *   Relative path to drill-down into, may be empty (only for collection cache)
-	 * @returns {object[]} The cache elements
-	 *
-	 * @public
-	 */
-	_Cache.prototype.getAllElements = function (sPath) {
-		var aAllElements;
-
-		if (sPath) {
-			return this.getValue(sPath);
-		}
-		aAllElements = this.aElements.map(function (oElement) {
-			return oElement instanceof SyncPromise ? undefined : oElement;
-		});
-		aAllElements.$count = this.aElements.$count;
-
-		return aAllElements;
-	};
-
 	/**
 	 * Returns all created elements for the given path.
 	 *
@@ -1281,6 +1281,17 @@ sap.ui.define([
 		return this.mQueryOptions;
 	};
 
+	/**
+	 * Gets the cache's resource path.
+	 *
+	 * @returns {string} The resource path
+	 *
+	 * @public
+	 */
+	_Cache.prototype.getResourcePath = function () {
+		return this.sResourcePath;
+	};
+
 	/**
 	 * Returns the existing map from meta path to type.
 	 *
@@ -1309,17 +1320,6 @@ sap.ui.define([
 		throw new Error("Unsupported operation");
 	};
 
-	/**
-	 * Gets the cache's resource path.
-	 *
-	 * @returns {string} The resource path
-	 *
-	 * @public
-	 */
-	_Cache.prototype.getResourcePath = function () {
-		return this.sResourcePath;
-	};
-
 	/**
 	 * Tells whether there are any registered change listeners.
 	 *
@@ -1929,11 +1929,7 @@ sap.ui.define([
 			this.iLimit += 1; // this doesn't change Infinity
 		}
 		_Helper.addToCount(this.mChangeListeners, sPath, aElements, 1);
-		if (iIndex >= aElements.length) { // Note: #splice ignores iIndex then!
-			aElements[iIndex] = oElement;
-		} else {
-			aElements.splice(iIndex, 0, oElement);
-		}
+		_Helper.insert(aElements, iIndex, oElement);
 		aElements.$byPredicate[_Helper.getPrivateAnnotation(oElement, "predicate")] = oElement;
 	};
 

package/src/sap/ui/model/odata/v4/lib/_Helper.js

@@ -163,8 +163,9 @@ sap.ui.define([
 		 * @param {object} oOperationMetadata
 		 *   The operation metadata to determine whether a given message target is a parameter
 		 *   of the operation
-		 * @param {string} sParameterContextPath
-		 *   The parameter context path
+		 * @param {string} [sParameterContextPath]
+		 *   The parameter context path, needed for adjusting a message target in case it is an
+		 *   operation parameter, except the binding parameter
 		 * @param {string} [sContextPath]
 		 *   The context path for a bound operation
 		 *
@@ -172,7 +173,9 @@ sap.ui.define([
 		 */
 		adjustTargets : function (oMessage, oOperationMetadata, sParameterContextPath,
 				sContextPath) {
-			var sAdditionalTargetsKey = _Helper.getAnnotationKey(oMessage, ".additionalTargets"),
+			var sAdditionalTargetsKey = "additionalTargets" in oMessage
+					? "additionalTargets"
+					: _Helper.getAnnotationKey(oMessage, ".additionalTargets"),
 				aTargets;
 
 			aTargets = [oMessage.target].concat(oMessage[sAdditionalTargetsKey])
@@ -528,6 +531,21 @@ sap.ui.define([
 			}
 		},
 
+		/**
+		 * Sets "@$ui5.context.isSelected" in <code>oTarget</code> to true if it is true in
+		 * <code>oSource</code>.
+		 *
+		 * @param {object} oSource - The source object
+		 * @param {object} oTarget - The target object
+		 *
+		 * @public
+		 */
+		copySelected : function (oSource, oTarget) {
+			if (oSource["@$ui5.context.isSelected"] === true) {
+				oTarget["@$ui5.context.isSelected"] = true;
+			}
+		},
+
 		/**
 		 * Returns an <code>Error</code> instance from a jQuery XHR wrapper.
 		 *
@@ -959,6 +977,32 @@ sap.ui.define([
 			return _Helper.encode(sKey, true) + "=" + _Helper.encode(sValue, false);
 		},
 
+		/**
+		 * Extracts the mergeable query options "$expand" and "$select" from the given ones, returns
+		 * them as a new map while replacing their value with "~" in the old map.
+		 *
+		 * @param {object} mQueryOptions
+		 *   The original query options, will be modified
+		 * @returns {object}
+		 *   The extracted query options
+		 *
+		 * @public
+		 */
+		extractMergeableQueryOptions : function (mQueryOptions) {
+			var mExtractedQueryOptions = {};
+
+			if ("$expand" in mQueryOptions) {
+				mExtractedQueryOptions.$expand = mQueryOptions.$expand;
+				mQueryOptions.$expand = "~";
+			}
+			if ("$select" in mQueryOptions) {
+				mExtractedQueryOptions.$select = mQueryOptions.$select;
+				mQueryOptions.$select = "~";
+			}
+
+			return mExtractedQueryOptions;
+		},
+
 		/**
 		 * Extracts all (top and detail) messages from the given error instance.
 		 *
@@ -1045,32 +1089,6 @@ sap.ui.define([
 			return aMessages;
 		},
 
-		/**
-		 * Extracts the mergeable query options "$expand" and "$select" from the given ones, returns
-		 * them as a new map while replacing their value with "~" in the old map.
-		 *
-		 * @param {object} mQueryOptions
-		 *   The original query options, will be modified
-		 * @returns {object}
-		 *   The extracted query options
-		 *
-		 * @public
-		 */
-		extractMergeableQueryOptions : function (mQueryOptions) {
-			var mExtractedQueryOptions = {};
-
-			if ("$expand" in mQueryOptions) {
-				mExtractedQueryOptions.$expand = mQueryOptions.$expand;
-				mQueryOptions.$expand = "~";
-			}
-			if ("$select" in mQueryOptions) {
-				mExtractedQueryOptions.$select = mQueryOptions.$select;
-				mQueryOptions.$select = "~";
-			}
-
-			return mExtractedQueryOptions;
-		},
-
 		/**
 		 * Fetches the property that is reached by the meta path and (if necessary) its type.
 		 *
@@ -1264,8 +1282,9 @@ sap.ui.define([
 		 * @param {object} oOperationMetadata
 		 *   The operation metadata to determine whether a given message target is a parameter
 		 *   of the operation
-		 * @param {string} sParameterContextPath
-		 *   The parameter context path
+		 * @param {string} [sParameterContextPath]
+		 *   The parameter context path, needed for adjusting a message target in case it is an
+		 *   operation parameter, except the binding parameter
 		 * @param {string} [sContextPath]
 		 *   The context path for a bound operation
 		 * @returns {string|undefined} The adjusted target, or <code>undefined</code> if the target
@@ -1274,7 +1293,7 @@ sap.ui.define([
 		 * @private
 		 */
 		getAdjustedTarget : function (sTarget, oOperationMetadata, sParameterContextPath,
-					sContextPath) {
+				sContextPath) {
 			var bIsParameterName,
 				sParameterName,
 				aSegments;
@@ -1290,6 +1309,9 @@ sap.ui.define([
 				sTarget = _Helper.buildPath(sContextPath, aSegments.join("/"));
 				return sTarget;
 			}
+			if (!sParameterContextPath) {
+				return sTarget;
+			}
 			bIsParameterName = oOperationMetadata.$Parameter.some(function (oParameter) {
 				return sParameterName === oParameter.$Name;
 			});
@@ -1570,6 +1592,27 @@ sap.ui.define([
 				});
 		},
 
+		/**
+		 * Returns the index of the key predicate in the last segment of the given path.
+		 *
+		 * @param {string} sPath - The path
+		 * @returns {number} The index of the key predicate
+		 * @throws {Error} If no path is given or the last segment contains no key predicate
+		 *
+		 * @public
+		 */
+		getPredicateIndex : function (sPath) {
+			var iPredicateIndex = sPath
+				? sPath.indexOf("(", sPath.lastIndexOf("/"))
+				: -1;
+
+			if (iPredicateIndex < 0 || !sPath.endsWith(")")) {
+				throw new Error("Not a list context path to an entity: " + sPath);
+			}
+
+			return iPredicateIndex;
+		},
+
 		/**
 		 * Returns the list of predicates corresponding to the given list of contexts, or
 		 * <code>null</code if at least one predicate is missing.
@@ -1595,27 +1638,6 @@ sap.ui.define([
 			return bMissingPredicate ? null : aPredicates;
 		},
 
-		/**
-		 * Returns the index of the key predicate in the last segment of the given path.
-		 *
-		 * @param {string} sPath - The path
-		 * @returns {number} The index of the key predicate
-		 * @throws {Error} If no path is given or the last segment contains no key predicate
-		 *
-		 * @public
-		 */
-		getPredicateIndex : function (sPath) {
-			var iPredicateIndex = sPath
-				? sPath.indexOf("(", sPath.lastIndexOf("/"))
-				: -1;
-
-			if (iPredicateIndex < 0 || !sPath.endsWith(")")) {
-				throw new Error("Not a list context path to an entity: " + sPath);
-			}
-
-			return iPredicateIndex;
-		},
-
 		/**
 		 * Returns the value of the private client-side instance annotation with the given
 		 * unqualified name at the given object.
@@ -1832,6 +1854,24 @@ sap.ui.define([
 			});
 		},
 
+		/**
+		 * Inserts the given element into the given array at the given index, even it is beyond the
+		 * array's current length.
+		 *
+		 * @param {any[]} aElements - Some array
+		 * @param {number} iIndex - Some index
+		 * @param {any} vElement - Some element
+		 *
+		 * @public
+		 */
+		insert : function (aElements, iIndex, vElement) {
+			if (iIndex >= aElements.length) { // Note: #splice ignores iIndex then!
+				aElements[iIndex] = vElement;
+			} else {
+				aElements.splice(iIndex, 0, vElement);
+			}
+		},
+
 		/**
 		 * Returns a copy of given query options where "$expand" and "$select" are replaced by the
 		 * intersection with the given (navigation) property paths.
@@ -3042,21 +3082,6 @@ sap.ui.define([
 			}
 		},
 
-		/**
-		 * Sets "@$ui5.context.isSelected" in <code>oTarget</code> to true if it is true in
-		 * <code>oSource</code>.
-		 *
-		 * @param {object} oSource - The source object
-		 * @param {object} oTarget - The target object
-		 *
-		 * @public
-		 */
-		copySelected : function (oSource, oTarget) {
-			if (oSource["@$ui5.context.isSelected"] === true) {
-				oTarget["@$ui5.context.isSelected"] = true;
-			}
-		},
-
 		/**
 		 * Creates the query options for a child binding with the meta path given by its base
 		 * meta path and relative meta path. Adds the key properties to $select of all expanded

package/src/sap/ui/model/odata/v4/lib/_Requestor.js

@@ -1061,32 +1061,6 @@ sap.ui.define([
 		return this.lockGroup("$auto", oGroupLock.getOwner());
 	};
 
-	/**
-	 * Tells whether there are only PATCH requests with the "Prefer" header set to "return=minimal"
-	 * (results from using $$patchWithoutSideEffects=true) enqueued in the batch queue with the
-	 * given group ID.
-	 *
-	 * @param {string} sGroupId
-	 *   The group ID
-	 * @returns {boolean}
-	 *   Returns <code>true</code> if only PATCHes are enqueued in the batch queue with the given
-	 *   group ID
-	 *
-	 * @private
-	 */
-	_Requestor.prototype.hasOnlyPatchesWithoutSideEffects = function (sGroupId) {
-		return this.getGroupSubmitMode(sGroupId) === "Auto"
-			&& !!this.mBatchQueue[sGroupId]
-			&& this.mBatchQueue[sGroupId].every(function (vChangeSetOrRequest) {
-				// PATCH requests must be in a change set which is modeled as an array
-				return Array.isArray(vChangeSetOrRequest)
-					&& vChangeSetOrRequest.every(function (oRequest) {
-					return oRequest.method === "PATCH"
-						&& oRequest.headers.Prefer === "return=minimal";
-				});
-			});
-	};
-
 	/**
 	 * Tells whether there are changes (that is, updates via PATCH or bound actions via POST) for
 	 * the given group ID and given entity.
@@ -1113,6 +1087,32 @@ sap.ui.define([
 		return false;
 	};
 
+	/**
+	 * Tells whether there are only PATCH requests with the "Prefer" header set to "return=minimal"
+	 * (results from using $$patchWithoutSideEffects=true) enqueued in the batch queue with the
+	 * given group ID.
+	 *
+	 * @param {string} sGroupId
+	 *   The group ID
+	 * @returns {boolean}
+	 *   Returns <code>true</code> if only PATCHes are enqueued in the batch queue with the given
+	 *   group ID
+	 *
+	 * @private
+	 */
+	_Requestor.prototype.hasOnlyPatchesWithoutSideEffects = function (sGroupId) {
+		return this.getGroupSubmitMode(sGroupId) === "Auto"
+			&& !!this.mBatchQueue[sGroupId]
+			&& this.mBatchQueue[sGroupId].every(function (vChangeSetOrRequest) {
+				// PATCH requests must be in a change set which is modeled as an array
+				return Array.isArray(vChangeSetOrRequest)
+					&& vChangeSetOrRequest.every(function (oRequest) {
+					return oRequest.method === "PATCH"
+						&& oRequest.headers.Prefer === "return=minimal";
+				});
+			});
+	};
+
 	/**
 	 * Returns <code>true</code> if there are pending changes for the given group ID.
 	 *
@@ -1190,6 +1190,46 @@ sap.ui.define([
 		return true;
 	};
 
+	/**
+	 * Creates a group lock for the given group.
+	 *
+	 * A group lock is a hint that a request is expected which may be added asynchronously.
+	 * If the expected request must be part of the next batch request for that group,
+	 * <code>bLocked</code> needs to be set to <code>true</code>. {@link #submitBatch} waits until
+	 * all group locks for that group are unlocked again. A group lock is automatically unlocked if
+	 * {@link #request} is called with that group lock. If the caller of {@link #lockGroup}
+	 * recognizes that no request needs to be added, the caller must unlock the group lock. In case
+	 * of an error the caller of {@link #lockGroup} must call
+	 * {@link sap.ui.model.odata.v4.lib._GroupLock#unlock} with <code>bForce = true</code>.
+	 *
+	 * @param {string} sGroupId
+	 *   The group ID
+	 * @param {object} oOwner
+	 *   The lock's owner for debugging
+	 * @param {boolean} [bLocked]
+	 *   Whether the created lock is locked
+	 * @param {boolean} [bModifying]
+	 *   Whether the reason for the group lock is a modifying request
+	 * @param {function} [fnCancel]
+	 *   Function that is called when the group lock is canceled
+	 * @returns {sap.ui.model.odata.v4.lib._GroupLock}
+	 *   The group lock
+	 * @throws {Error}
+	 *   If <code>bModifying</code> is set but <code>bLocked</code> is unset.
+	 *
+	 * @public
+	 */
+	_Requestor.prototype.lockGroup = function (sGroupId, oOwner, bLocked, bModifying, fnCancel) {
+		var oGroupLock;
+
+		oGroupLock = new _GroupLock(sGroupId, oOwner, bLocked, bModifying, this.getSerialNumber(),
+			fnCancel);
+		if (bLocked) {
+			this.aLockedGroupLocks.push(oGroupLock);
+		}
+		return oGroupLock;
+	};
+
 	/**
 	 * Merges all GET requests that are marked as mergeable (via parameter mQueryOptions of
 	 * {@link #request}) and have the same owner, resource path, and query options besides $expand
@@ -1381,58 +1421,6 @@ sap.ui.define([
 			});
 	};
 
-	/**
-	 * Returns a sync promise that is resolved when the requestor is ready to be used. The V4
-	 * requestor is ready immediately. Subclasses may behave differently.
-	 *
-	 * @returns {sap.ui.base.SyncPromise} A sync promise that is resolved immediately with no result
-	 *
-	 * @public
-	 */
-	_Requestor.prototype.ready = function () {
-		return SyncPromise.resolve();
-	};
-
-	/**
-	 * Creates a group lock for the given group.
-	 *
-	 * A group lock is a hint that a request is expected which may be added asynchronously.
-	 * If the expected request must be part of the next batch request for that group,
-	 * <code>bLocked</code> needs to be set to <code>true</code>. {@link #submitBatch} waits until
-	 * all group locks for that group are unlocked again. A group lock is automatically unlocked if
-	 * {@link #request} is called with that group lock. If the caller of {@link #lockGroup}
-	 * recognizes that no request needs to be added, the caller must unlock the group lock. In case
-	 * of an error the caller of {@link #lockGroup} must call
-	 * {@link sap.ui.model.odata.v4.lib._GroupLock#unlock} with <code>bForce = true</code>.
-	 *
-	 * @param {string} sGroupId
-	 *   The group ID
-	 * @param {object} oOwner
-	 *   The lock's owner for debugging
-	 * @param {boolean} [bLocked]
-	 *   Whether the created lock is locked
-	 * @param {boolean} [bModifying]
-	 *   Whether the reason for the group lock is a modifying request
-	 * @param {function} [fnCancel]
-	 *   Function that is called when the group lock is canceled
-	 * @returns {sap.ui.model.odata.v4.lib._GroupLock}
-	 *   The group lock
-	 * @throws {Error}
-	 *   If <code>bModifying</code> is set but <code>bLocked</code> is unset.
-	 *
-	 * @public
-	 */
-	_Requestor.prototype.lockGroup = function (sGroupId, oOwner, bLocked, bModifying, fnCancel) {
-		var oGroupLock;
-
-		oGroupLock = new _GroupLock(sGroupId, oOwner, bLocked, bModifying, this.getSerialNumber(),
-			fnCancel);
-		if (bLocked) {
-			this.aLockedGroupLocks.push(oGroupLock);
-		}
-		return oGroupLock;
-	};
-
 	/**
 	 * This function has two tasks:
 	 * <ul>
@@ -1554,6 +1542,18 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Returns a sync promise that is resolved when the requestor is ready to be used. The V4
+	 * requestor is ready immediately. Subclasses may behave differently.
+	 *
+	 * @returns {sap.ui.base.SyncPromise} A sync promise that is resolved immediately with no result
+	 *
+	 * @public
+	 */
+	_Requestor.prototype.ready = function () {
+		return SyncPromise.resolve();
+	};
+
 	/**
 	 * Returns a promise that will be resolved once the CSRF token has been refreshed, or rejected
 	 * if that fails. Makes sure that only one HEAD request is underway at any given time and

package/src/sap/ui/model/odata/v4/lib/_TreeState.js

@@ -14,7 +14,7 @@ sap.ui.define([
 	// _TreeState
 	//*********************************************************************************************
 	/**
-	 * A class holding the tree state for recursive hierarchies. It keeps track which nodes have
+	 * A class holding the tree state for a recursive hierarchy. It keeps track which nodes have
 	 * been manually expanded resp. collapsed and is able to build the "ExpandLevels" parameter for
 	 * the "TopLevels" request (see {@link #getExpandLevels}).
 	 *

package/src/sap/ui/model/odata/v4/lib/_V2MetadataConverter.js

@@ -770,6 +770,26 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Post-processing of all bound operations: key properties are removed from parameters.
+	 */
+	_V2MetadataConverter.prototype.processBoundOperations = function () {
+		var that = this;
+
+		this.aBoundOperations.forEach(function (oOperation) {
+			var oEntityType = that.result[oOperation.$Parameter[0].$Type];
+
+			oEntityType.$Key.forEach(function (sKeyName) {
+				oOperation.$Parameter.some(function (oParameter, i) {
+					if (oParameter.$Name === sKeyName) {
+						oOperation.$Parameter.splice(i, 1);
+						return true;
+					}
+				});
+			});
+		});
+	};
+
 	/**
 	 * Processes a ComplexType element.
 	 *
@@ -1302,26 +1322,6 @@ sap.ui.define([
 		}
 	};
 
-	/**
-	 * Post-processing of all bound operations: key properties are removed from parameters.
-	 */
-	_V2MetadataConverter.prototype.processBoundOperations = function () {
-		var that = this;
-
-		this.aBoundOperations.forEach(function (oOperation) {
-			var oEntityType = that.result[oOperation.$Parameter[0].$Type];
-
-			oEntityType.$Key.forEach(function (sKeyName) {
-				oOperation.$Parameter.some(function (oParameter, i) {
-					if (oParameter.$Name === sKeyName) {
-						oOperation.$Parameter.splice(i, 1);
-						return true;
-					}
-				});
-			});
-		});
-	};
-
 	/**
 	 * For each property with a "sap:unit" annotation a corresponding V4 annotation is created.
 	 * The annotation is "Org.OData.Measures.V1.Unit" if the unit has