@openui5/sap.ui.core 1.94.0 → 1.97.0

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

@@ -19,6 +19,19 @@ sap.ui.define([
 	 *   An absolute path without trailing slash, for example "/Products(1)/ToSupplier"
 	 * @param {string} [sDeepPath=sPath]
 	 *   The absolute deep path including all intermediate paths of the binding hierarchy
+	 * @param {sap.ui.base.SyncPromise} [oCreatePromise]
+	 *   A sync promise that is given when this context has been created by
+	 *   {@link sap.ui.model.odata.v2.ODataModel#createEntry} or
+	 *   {@link sap.ui.model.odata.v2.ODataListBinding#create}.
+	 *
+	 *   When the entity represented by this context has been successfully persisted in the back
+	 *   end, the given promise resolves.
+	 *
+	 *   When the entity is deleted before it has been persisted in the back end via
+	 *   {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the
+	 *   <code>bDeleteCreatedEntities</code> parameter set to <code>true</code>, the given promise
+	 *   rejects with an object <code>oError</code> containing the error information, where
+	 *   <code>oError.aborted === true</code>.
 	 * @alias sap.ui.model.odata.v2.Context
 	 * @author SAP SE
 	 * @class Implementation of an OData V2 model's context.
@@ -31,6 +44,8 @@ sap.ui.define([
 	 *   <ul>
 	 *     <li>an OData binding</li>
 	 *     <li>a view element</li>
+	 *     <li>{@link sap.ui.model.odata.v2.ODataListBinding#create}</li>
+	 *     <li>{@link sap.ui.model.odata.v2.ODataModel#callFunction}</li>
 	 *     <li>{@link sap.ui.model.odata.v2.ODataModel#createBindingContext}</li>
 	 *     <li>{@link sap.ui.model.odata.v2.ODataModel#createEntry}</li>
 	 *   </ul>
@@ -39,17 +54,15 @@ sap.ui.define([
 	 * @hideconstructor
 	 * @public
 	 * @since 1.93.0
-	 * @version 1.94.0
+	 * @version 1.97.0
 	 */
 	var Context = BaseContext.extend("sap.ui.model.odata.v2.Context", {
-			constructor : function (oModel, sPath, sDeepPath) {
+			constructor : function (oModel, sPath, sDeepPath, oCreatePromise) {
 				BaseContext.call(this, oModel, sPath);
-				// whether this context references a newly created transient entity; supported
-				// values are:
-				// - undefined: entity has not been created on client side,
-				// - true: created on the client but not yet persisted in the back end,
-				// - false: created on the client and persisted in the back end
-				this.bCreated = undefined;
+				// Promise returned by #created for a context of a newly created entity which
+				// resolves when the entity is persisted or rejects if the creation is aborted; set
+				// it lazily to avoid "Uncaught (in promise)" errors
+				this.oCreatePromise = undefined;
 				// the absolute path including all intermediate paths of the binding hierarchy;
 				// used to compute the full target of messages
 				this.sDeepPath = sDeepPath || sPath;
@@ -58,12 +71,61 @@ sap.ui.define([
 				// whether this context's path may be used to create the request URL for dependent
 				// bindings even if no data has been loaded for the context's entity
 				this.bPreliminary = false;
+				// SyncPromise for a context created via
+				// sap.ui.model.odata.v2.ODataModel#createEntry; used internally to detect
+				// synchronously whether the promise is already fulfilled
+				this.oSyncCreatePromise = oCreatePromise;
 				// whether the context is updated, e.g. path changed from a preliminary path to the
 				// canonical one
 				this.bUpdated = false;
 			}
 		});
 
+	/**
+	 * Returns a promise on the creation state of this context if it has been created via
+	 * {@link sap.ui.model.odata.v2.ODataModel#createEntry} or
+	 * {@link sap.ui.model.odata.v2.ODataListBinding#create}; otherwise returns
+	 * <code>undefined</code>.
+	 *
+	 * As long as the promise is not yet resolved or rejected, the entity represented by this
+	 * context is transient.
+	 *
+	 * Once the promise is resolved, the entity for this context is stored in the back end and
+	 * {@link #getPath} returns a path including the key predicate of the new entity.
+	 *
+	 * If the context has been created via {@link sap.ui.model.odata.v2.ODataListBinding#create} and
+	 * the entity for this context has been stored in the back end, {@link #created} returns
+	 * <code>undefined</code> after the data has been re-read from the back end and inserted at the
+	 * right position based on the list binding's filters and sorters.
+	 * If the context has been created via {@link sap.ui.model.odata.v2.ODataModel#createEntry} and
+	 * the entity for this context has been stored in the back end, {@link #created} returns
+	 * <code>undefined</code>.
+	 *
+	 * @returns {Promise}
+	 *   A promise for a context which has been created via
+	 *   {@link sap.ui.model.odata.v2.ODataModel#createEntry} or
+	 *   {@link sap.ui.model.odata.v2.ODataListBinding#create}, otherwise <code>undefined</code>.
+	 *
+	 *   When the entity represented by this context has been persisted in the back end, the promise
+	 *   resolves without data.
+	 *
+	 *   When the entity is deleted before it has been persisted in the back end via
+	 *   {@link sap.ui.model.odata.v2.ODataModel#resetChanges} with the
+	 *   <code>bDeleteCreatedEntities</code> parameter set to <code>true</code>, the promise rejects
+	 *   with an object <code>oError</code> containing the error information, where
+	 *   <code>oError.aborted === true</code>.
+	 *
+	 * @public
+	 * @since 1.96.0
+	 */
+	Context.prototype.created = function () {
+		if (this.oSyncCreatePromise && !this.oCreatePromise) {
+			// ensure to return a promise that is resolved w/o data
+			this.oCreatePromise = Promise.resolve(this.oSyncCreatePromise).then(function () {});
+		}
+
+		return this.oCreatePromise;
+	};
 
 	/**
 	 * Gets the absolute deep path including all intermediate paths of the binding hierarchy. This
@@ -85,7 +147,7 @@ sap.ui.define([
 	 * @see sap.ui.model.odata.v2.Context#isUpdated
 	 * @see sap.ui.model.odata.v2.Context#isRefreshForced
 	 */
-	Context.prototype.hasChanged = function() {
+	Context.prototype.hasChanged = function () {
 		return this.bUpdated || this.bForceRefresh;
 	};
 
@@ -114,21 +176,30 @@ sap.ui.define([
 	};
 
 	/**
-	 * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}, the method
-	 * returns <code>true</code> if the context is transient or <code>false</code> if the context is
-	 * not transient. A transient context represents an entity created on the client which has not
-	 * been persisted in the back end.
+	 * For a context created using {@link sap.ui.model.odata.v2.ODataModel#createEntry} or
+	 * {@link sap.ui.model.odata.v2.ODataListBinding#create}, the method returns <code>true</code>
+	 * if the context is transient or <code>false</code> if the context is not transient. A
+	 * transient context represents an entity created on the client which has not been persisted in
+	 * the back end.
 	 *
 	 * @returns {boolean}
-	 *   Whether this context is transient if it has been created using
-	 *   {@link sap.ui.model.odata.v2.ODataModel#createEntry}; returns <code>undefined</code> if the
-	 *   context has not been created using {@link sap.ui.model.odata.v2.ODataModel#createEntry}
+	 *   <ul>
+	 *   <li><code>true</code>: if the context has been created via
+	 *     {@link sap.ui.model.odata.v2.ODataModel#createEntry} or
+	 *     {@link sap.ui.model.odata.v2.ODataListBinding#create} and is not yet persisted in the
+	 *     back end,</li>
+	 *   <li><code>false</code>: if the context has been created via
+	 *     {@link sap.ui.model.odata.v2.ODataListBinding#create}, data has been successfully
+	 *     persisted in the back end and the data is still displayed in the area of the inline
+	 *     creation rows, and</li>
+	 *   <li><code>undefined</code>: otherwise</li>
+	 *   </ul>
 	 *
 	 * @public
 	 * @since 1.94.0
 	 */
 	Context.prototype.isTransient = function () {
-		return this.bCreated;
+		return this.oSyncCreatePromise && this.oSyncCreatePromise.isPending();
 	};
 
 	/**
@@ -142,6 +213,16 @@ sap.ui.define([
 		return this.bUpdated;
 	};
 
+	/**
+	 * Resets the created promise to indicate that the entity has been re-read from the back end.
+	 *
+	 * @private
+	 */
+	Context.prototype.resetCreatedPromise = function () {
+		this.oCreatePromise = undefined;
+		this.oSyncCreatePromise = undefined;
+	};
+
 	/**
 	 * Sets the absolute deep path; see {@link #getDeepPath} for details.
 	 *

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 // Provides class sap.ui.model.odata.v2.ODataAnnotations
 sap.ui.define([
 	"sap/base/assert",
@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @class Annotation loader for OData V2 services
 	 *
 	 * @author SAP SE
-	 * @version 1.94.0
+	 * @version 1.97.0
 	 *
 	 * @public
 	 * @since 1.37.0

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

@@ -3,7 +3,7 @@
  * (c) Copyright 2009-2021 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
-
+/*eslint-disable max-len */
 //Provides an abstraction for list bindings
 sap.ui.define([
 	"sap/base/util/deepExtend",