@sap/open.fe 1.98.0 → 1.99.0

package/packages/sap.fe.core/src/sap/fe/core/actions/draft.js

@@ -1,6 +1,5 @@
 /*!
  * SAP UI development toolkit for HTML5 (SAPUI5)
-        (c) Copyright 2009-2021 SAP SE. All rights reserved
-    
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
  */
-sap.ui.define(["sap/m/Dialog","sap/m/Button","sap/m/Text","sap/m/MessageBox","sap/fe/core/actions/messageHandling","sap/fe/core/CommonUtils","sap/base/Log"],function(D,B,T,M,m,C,L){"use strict";var d={EDIT:"EditAction",ACTIVATION:"ActivationAction",DISCARD:"DiscardAction",PREPARE:"PreparationAction"};var a={createDraftFromActiveDocument:k,activateDocument:l,deleteDraft:n};function g(p,O){var q=p.getModel(),s=q.getMetaModel(),E=s.getMetaPath(p.getPath());return s.getObject(E+"@com.sap.vocabularies.Common.v1.DraftRoot/"+O);}function c(p,O,q){var s=g(p,O);return p.getModel().bindContext(s+"(...)",p,q);}function h(p){return!!g(p,d.PREPARE);}function e(p,P){if(p.getProperty("IsActiveEntity")){var O={$$inheritExpandSelect:true};var q=c(p,d.EDIT,O);q.setParameter("PreserveChanges",P);var G="direct";var E=q.execute(G,undefined,o.bind(a,p,G)).then(function(s){return s;});q.getModel().submitBatch(G);return E;}else{throw new Error("You cannot edit this draft document");}}function o(p,G,q){if(q.length===1){var s=q[0].message,t=new Promise(function(u){sap.ui.require(["sap/m/MessageBox"],function(M){M.warning(s,{title:"Warning",actions:[M.Action.OK,M.Action.CANCEL],onClose:function(A){if(A===M.Action.OK){u(true);p.getModel().submitBatch(G);}else{u(false);}}});});});return t;}}function b(p,A,G){var H=h(p);var I=H;if(!p.getProperty("IsActiveEntity")){var O=c(p,d.ACTIVATION,{$$inheritExpandSelect:true});return O.execute(G,I,o.bind(a,p,G)).then(function(q){return q;}).catch(function(){if(H){var s=g(p,d.PREPARE),S=A.getSideEffectsService(),q=S.getODataActionSideEffects(s,p),t=q&&q.pathExpressions;if(t&&t.length>0){S.requestSideEffects(t,p).catch(function(E){L.error("Error while requesting side effects",E);});}else{r(p,S).catch(function(E){L.error("Error while requesting messages",E);});}}return Promise.reject();});}else{throw new Error("The activation action cannot be executed on an active document");}}function f(p,A,P){var q=P||{};if(!p.getProperty("IsActiveEntity")){var O=c(p,d.PREPARE);O.setParameter("SideEffectsQualifier","");var G=q.groupId||O.getGroupId();var s=O.execute(G).then(function(){if(q.bPrepareForEdit){var t=g(p,d.PREPARE),S=A.getSideEffectsService(),u=S.getODataActionSideEffects(t,p),v=u&&u.pathExpressions;if(v&&v.length>0){S.requestSideEffects(v,p,G).catch(function(E){L.error("Error while requesting side effects",E);});}else{r(p,S);}}return O;}).catch(function(E){L.error("Error while executing the operation",E);});return s;}else{throw new Error("The preparation action cannot be executed on an active document");}}function i(p){var q=p.getModel(),s=q.getMetaModel(),E=s.getMetaPath(p.getPath());return s.getObject(E+"/@com.sap.vocabularies.Common.v1.Messages/$Path");}function r(p,s){var q=i(p);if(q){return s.requestSideEffects([{$PropertyPath:q}],p);}}function j(p){if(!p.getProperty("IsActiveEntity")){var q=c(p,d.DISCARD);var s=q.execute("direct");p.getModel().submitBatch("direct");return s;}else{throw new Error("The discard action cannot be executed on an active document");}}function k(p,A,P){var q=P||{},s=sap.ui.getCore().getLibraryResourceBundle("sap.fe.core"),R=typeof q.bPreserveChanges==="undefined"||(typeof q.bPreserveChanges==="boolean"&&q.bPreserveChanges);function t(O){if(O){var v=p.getModel(),w,x=v.bindContext(p.getPath()+"/DraftAdministrativeData").getBoundContext();return P.oView.getModel("sap.fe.i18n").getResourceBundle().then(function(_){w=_;return x.requestObject();}).then(function(y){if(y){m.removeUnboundTransitionMessages();var I=y.InProcessByUserDescription||y.InProcessByUser;var E=P.oView.getViewData().entitySet;if(I){var z=C.getTranslatedText("C_DRAFT_OBJECT_PAGE_DRAFT_LOCKED_BY_USER",w,I,E);M.error(z);throw new Error(z);}else{I=y.CreatedByUserDescription||y.CreatedByUser;var U=C.getTranslatedText("C_DRAFT_OBJECT_PAGE_DRAFT_UNSAVED_CHANGES",w,I,E);return u(U).then(function(){return e(p,false);});}}});}return Promise.reject(new Error("Draft creation aborted for document: "+p.getPath()));}function u(U){return new Promise(function(v,w){var x=new D({title:s.getText("C_DRAFT_OBJECT_PAGE_WARNING"),state:"Warning",content:new T({text:U}),beginButton:new B({text:s.getText("C_COMMON_OBJECT_PAGE_EDIT"),type:"Emphasized",press:function(){x.close();v(true);}}),endButton:new B({text:s.getText("C_COMMON_OBJECT_PAGE_CANCEL"),press:function(){x.close();w("Draft creation aborted for document: "+p.getPath());}}),afterClose:function(){x.destroy();}});x.addStyleClass("sapUiContentPadding");x.open();});}if(!p){return Promise.reject(new Error("Binding context to active document is required"));}return Promise.resolve(q.fnBeforeCreateDraftFromActiveDocument?q.fnBeforeCreateDraftFromActiveDocument(p,R):true).then(function(E){if(!E){throw new Error("Draft creation was aborted by extension for document: "+p.getPath());}return e(p,R).catch(function(v){if(R&&v.status===409){return Promise.resolve(q.fnWhenDecisionToOverwriteDocumentIsRequired?q.fnWhenDecisionToOverwriteDocumentIsRequired():true).then(t);}else{throw new Error(v);}});}).then(function(v){return Promise.resolve(q.fnAfterCreateDraftFromActiveDocument?q.fnAfterCreateDraftFromActiveDocument(p,v):v);}).then(function(v){if(q.bPrepareOnEdit&&h(v)){return f(v,A,{bPrepareForEdit:true}).then(function(){return v;});}return v;}).catch(function(v){return Promise.reject(v);});}function l(p,A,P){var q=P||{};if(!p){return Promise.reject(new Error("Binding context to draft document is required"));}return Promise.resolve(q.fnBeforeActivateDocument?q.fnBeforeActivateDocument(p):true).then(function(E){if(!E){return Promise.reject(new Error("Activation of the document was aborted by extension for document: "+p.getPath()));}if(!h(p)){return b(p,A);}var s="draft";var t=f(p,A,{groupId:s,bPrepareForEdit:false});p.getModel().submitBatch(s);var u=b(p,A,s);return Promise.all([t,u]).then(function(v){return v[1];}).catch(function(v){return Promise.reject(v);});}).then(function(s){return Promise.resolve(q.fnAfterActivateDocument?q.fnAfterActivateDocument(p,s):s);}).catch(function(s){return Promise.reject(s);});}function n(p){var s=g(p,d.DISCARD),I=p.getObject().IsActiveEntity;if(I||(!I&&!s)){if(p.hasPendingChanges()){p.getBinding().resetChanges().then(function(){return p.delete();}).catch(function(q){return Promise.reject(q);});}else{return p.delete();}}else{return j(p);}}return a;});
+sap.ui.define(["sap/m/Dialog","sap/m/Button","sap/m/Text","sap/m/MessageBox","sap/fe/core/actions/messageHandling","sap/fe/core/CommonUtils","sap/base/Log"],function(D,B,T,M,m,C,L){"use strict";var d={EDIT:"EditAction",ACTIVATION:"ActivationAction",DISCARD:"DiscardAction",PREPARE:"PreparationAction"};var a={createDraftFromActiveDocument:k,activateDocument:l,deleteDraft:n};function g(o,O){var p=o.getModel(),q=p.getMetaModel(),E=q.getMetaPath(o.getPath());return q.getObject(E+"@com.sap.vocabularies.Common.v1.DraftRoot/"+O);}function c(o,O,p){var s=g(o,O);return o.getModel().bindContext(s+"(...)",o,p);}function h(o){return!!g(o,d.PREPARE);}function e(o,p){if(o.getProperty("IsActiveEntity")){var O={$$inheritExpandSelect:true};var q=c(o,d.EDIT,O);q.setParameter("PreserveChanges",p);var G="direct";var E=q.execute(G).then(function(s){return s;});q.getModel().submitBatch(G);return E;}else{throw new Error("You cannot edit this draft document");}}function b(o,A,G){var H=h(o);var I=H;if(!o.getProperty("IsActiveEntity")){var O=c(o,d.ACTIVATION,{$$inheritExpandSelect:true});return O.execute(G,I).then(function(p){return p;}).catch(function(){if(H){var s=g(o,d.PREPARE),S=A.getSideEffectsService(),p=S.getODataActionSideEffects(s,o),t=p&&p.pathExpressions;if(t&&t.length>0){S.requestSideEffects(t,o).catch(function(E){L.error("Error while requesting side effects",E);});}else{r(o,S).catch(function(E){L.error("Error while requesting messages",E);});}}return Promise.reject();});}else{throw new Error("The activation action cannot be executed on an active document");}}function f(o,A,p){var P=p||{};if(!o.getProperty("IsActiveEntity")){var O=c(o,d.PREPARE);O.setParameter("SideEffectsQualifier","");var G=P.groupId||O.getGroupId();var q=O.execute(G).then(function(){if(P.bPrepareForEdit){var s=g(o,d.PREPARE),S=A.getSideEffectsService(),t=S.getODataActionSideEffects(s,o),u=t&&t.pathExpressions;if(u&&u.length>0){S.requestSideEffects(u,o,G).catch(function(E){L.error("Error while requesting side effects",E);});}else{r(o,S);}}return O;}).catch(function(E){L.error("Error while executing the operation",E);});return q;}else{throw new Error("The preparation action cannot be executed on an active document");}}function i(o){var p=o.getModel(),q=p.getMetaModel(),E=q.getMetaPath(o.getPath());return q.getObject(E+"/@com.sap.vocabularies.Common.v1.Messages/$Path");}function r(o,s){var p=i(o);if(p){return s.requestSideEffects([{$PropertyPath:p}],o);}return Promise.resolve();}function j(o){if(!o.getProperty("IsActiveEntity")){var p=c(o,d.DISCARD);var q=p.execute("direct");o.getModel().submitBatch("direct");return q;}else{throw new Error("The discard action cannot be executed on an active document");}}function k(o,A,p){var P=p||{},q=sap.ui.getCore().getLibraryResourceBundle("sap.fe.core"),R=typeof P.bPreserveChanges==="undefined"||typeof P.bPreserveChanges==="boolean"&&P.bPreserveChanges;function s(O){if(O){var u=o.getModel();var v=u.bindContext(o.getPath()+"/DraftAdministrativeData").getBoundContext();var w;return p.oView.getModel("sap.fe.i18n").getResourceBundle().then(function(_){w=_;return v.requestObject();}).then(function(x){if(x){m.removeUnboundTransitionMessages();var I=x.InProcessByUserDescription||x.InProcessByUser;var E=p.oView.getViewData().entitySet;if(I){var y=C.getTranslatedText("C_DRAFT_OBJECT_PAGE_DRAFT_LOCKED_BY_USER",w,I,E);M.error(y);throw new Error(y);}else{I=x.CreatedByUserDescription||x.CreatedByUser;var U=C.getTranslatedText("C_DRAFT_OBJECT_PAGE_DRAFT_UNSAVED_CHANGES",w,I,E);return t(U).then(function(){return e(o,false);});}}});}return Promise.reject(new Error("Draft creation aborted for document: "+o.getPath()));}function t(u){return new Promise(function(v,w){var x=new D({title:q.getText("C_DRAFT_OBJECT_PAGE_WARNING"),state:"Warning",content:new T({text:u}),beginButton:new B({text:q.getText("C_COMMON_OBJECT_PAGE_EDIT"),type:"Emphasized",press:function(){x.close();v(true);}}),endButton:new B({text:q.getText("C_COMMON_OBJECT_PAGE_CANCEL"),press:function(){x.close();w("Draft creation aborted for document: "+o.getPath());}}),afterClose:function(){x.destroy();}});x.addStyleClass("sapUiContentPadding");x.open();});}if(!o){return Promise.reject(new Error("Binding context to active document is required"));}return Promise.resolve(P.fnBeforeCreateDraftFromActiveDocument?P.fnBeforeCreateDraftFromActiveDocument(o,R):true).then(function(E){if(!E){throw new Error("Draft creation was aborted by extension for document: "+o.getPath());}return e(o,R).catch(function(u){if(R&&u.status===409){return Promise.resolve(P.fnWhenDecisionToOverwriteDocumentIsRequired?P.fnWhenDecisionToOverwriteDocumentIsRequired():true).then(s);}else{throw new Error(u);}});}).then(function(u){return Promise.resolve(P.fnAfterCreateDraftFromActiveDocument?P.fnAfterCreateDraftFromActiveDocument(o,u):u);}).then(function(u){if(P.bPrepareOnEdit&&h(u)){return f(u,A,{bPrepareForEdit:true}).then(function(){return u;});}return u;}).catch(function(u){return Promise.reject(u);});}function l(o,A,p){var P=p||{};if(!o){return Promise.reject(new Error("Binding context to draft document is required"));}return Promise.resolve(P.fnBeforeActivateDocument?P.fnBeforeActivateDocument(o):true).then(function(E){if(!E){return Promise.reject(new Error("Activation of the document was aborted by extension for document: "+o.getPath()));}if(!h(o)){return b(o,A);}var s="draft";var q=f(o,A,{groupId:s,bPrepareForEdit:false});o.getModel().submitBatch(s);var t=b(o,A,s);return Promise.all([q,t]).then(function(v){return v[1];}).catch(function(u){return Promise.reject(u);});}).then(function(q){return Promise.resolve(P.fnAfterActivateDocument?P.fnAfterActivateDocument(o,q):q);}).catch(function(q){return Promise.reject(q);});}function n(o){var s=g(o,d.DISCARD),I=o.getObject().IsActiveEntity;if(I||!I&&!s){if(o.hasPendingChanges()){return o.getBinding().resetChanges().then(function(){return o.delete();}).catch(function(p){return Promise.reject(p);});}else{return o.delete();}}else{return j(o);}}return a;},false);

package/packages/sap.fe.core/src/sap/fe/core/actions/draft.ts

@@ -0,0 +1,593 @@
+import Dialog from "sap/m/Dialog";
+import Button from "sap/m/Button";
+import Text from "sap/m/Text";
+import MessageBox from "sap/m/MessageBox";
+import messageHandling from "sap/fe/core/actions/messageHandling";
+import CommonUtils from "sap/fe/core/CommonUtils";
+import Log from "sap/base/Log";
+import { AppComponent } from "sap/fe/core";
+import { SideEffectsService } from "sap/fe/core/services/SideEffectsServiceFactory";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import View from "sap/ui/core/mvc/View";
+import Context from "sap/ui/model/odata/v4/Context";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import ResourceModel from "sap/ui/model/resource/ResourceModel";
+
+/**
+ * Interface for callbacks used in the functions
+ *
+ *
+ * @author SAP SE
+ * @since 1.54.0
+ * @interface
+ * @name sap.fe.core.actions.draft.ICallback
+ * @private
+ */
+
+/**
+ * Callback to approve or reject the creation of a draft
+ * @name sap.fe.core.actions.draft.ICallback.beforeCreateDraftFromActiveDocument
+ * @function
+ * @static
+ * @abstract
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the active document for the new draft
+ * @returns {(boolean|Promise)} Approval of draft creation [true|false] or Promise that resolves with the boolean value
+ *
+ * @private
+ */
+
+/**
+ * Callback after a draft was successully created
+ * @name sap.fe.core.actions.draft.ICallback.afterCreateDraftFromActiveDocument
+ * @function
+ * @static
+ * @abstract
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the new draft
+ * @param {sap.ui.model.odata.v4.Context} oActiveDocumentContext Context of the active document for the new draft
+ * @returns {sap.ui.model.odata.v4.Context} oActiveDocumentContext
+ *
+ * @private
+ */
+
+/**
+ * Callback to approve or reject overwriting an unsaved draft of another user
+ * @name sap.fe.core.actions.draft.ICallback.whenDecisionToOverwriteDocumentIsRequired
+ * @function
+ * @public
+ * @static
+ * @abstract
+ *
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the active document for the new draft
+ * @returns {(boolean|Promise)} Approval to overwrite unsaved draft [true|false] or Promise that resolves with the boolean value
+ *
+ * @ui5-restricted
+ */
+/* Constants for draft operations */
+const draftOperations = {
+	EDIT: "EditAction",
+	ACTIVATION: "ActivationAction",
+	DISCARD: "DiscardAction",
+	PREPARE: "PreparationAction"
+};
+/**
+ * Static functions for the draft programming model
+ *
+ * @namespace
+ * @alias sap.fe.core.actions.draft
+ * @private
+ * @experimental This module is only for experimental use! <br/><b>This is only a POC and maybe deleted</b>
+ * @since 1.54.0
+ */
+const draft = {
+	createDraftFromActiveDocument: createDraftFromActiveDocument,
+	activateDocument: activateDocument,
+	deleteDraft: deleteDraft
+};
+/**
+ * Determines action name for a draft operation.
+ *
+ * @param {sap.ui.model.odata.v4.Context} oContext The context that should be bound to the operation
+ * @param {string} sOperation The operation name
+ * @returns {string} The name of the draft operation
+ */
+function getActionName(oContext: any, sOperation: string) {
+	const oModel = oContext.getModel(),
+		oMetaModel = oModel.getMetaModel(),
+		sEntitySetPath = oMetaModel.getMetaPath(oContext.getPath());
+
+	return oMetaModel.getObject(sEntitySetPath + "@com.sap.vocabularies.Common.v1.DraftRoot/" + sOperation);
+}
+/**
+ * Creates an operation context binding for the given context and operation.
+ *
+ * @param {sap.ui.model.odata.v4.Context} oContext The context that should be bound to the operation
+ * @param {string} sOperation The operation (action or function import)
+ * @param oOptions Options to create the operation context
+ * @returns {sap.ui.model.odata.v4.ODataContextBinding} The context binding of the bound operation
+ */
+function createOperation(oContext: any, sOperation: string, oOptions?: any) {
+	const sOperationName = getActionName(oContext, sOperation);
+
+	return oContext.getModel().bindContext(sOperationName + "(...)", oContext, oOptions);
+}
+/**
+ * Check if optional draft prepare action exists.
+ *
+ * @param {sap.ui.model.odata.v4.Context} oContext The context that should be bound to the operation
+ * @returns {boolean} True if a a prepare action exists
+ */
+function hasPrepareAction(oContext: any) {
+	return !!getActionName(oContext, draftOperations.PREPARE);
+}
+/**
+ * Creates a new draft from an active document.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the action should be performed
+ * @param {boolean} bPreserveChanges If true - existing changes from another user that are not locked are preserved and an error message (http status 409) is send from the backend, otherwise false - existing changes from another user that are not locked are overwritten</li>
+ * @returns {Promise.<sap.ui.model.odata.v4.Context>} Resolve function returns the context of the operation
+ * @private
+ * @ui5-restricted
+ */
+function executeDraftEditAction(oContext: any, bPreserveChanges: boolean) {
+	if (oContext.getProperty("IsActiveEntity")) {
+		const oOptions = { $$inheritExpandSelect: true };
+		const oOperation = createOperation(oContext, draftOperations.EDIT, oOptions);
+		oOperation.setParameter("PreserveChanges", bPreserveChanges);
+		const sGroupId = "direct";
+		const oEditPromise = oOperation.execute(sGroupId).then(function(oDraftDocumentContext: any) {
+			return oDraftDocumentContext;
+		});
+		oOperation.getModel().submitBatch(sGroupId);
+		return oEditPromise;
+	} else {
+		throw new Error("You cannot edit this draft document");
+	}
+}
+/*function fnOnStrictHandlingFailed(oContext: any, sGroupId: any, aMessages: any) { //Will uncomment this function in the commit : 5513510
+	if (aMessages.length === 1) {
+		const sMessage = aMessages[0].message,
+			dialogPromise = new Promise(function(resolve: (value: any) => void) {
+				sap.ui.require(["sap/m/MessageBox"], function(MessageBox: any) {
+					MessageBox.warning(sMessage, {
+						title: "Warning",
+						actions: [MessageBox.Action.OK, MessageBox.Action.CANCEL],
+						onClose: function(sAction: any) {
+							if (sAction === MessageBox.Action.OK) {
+								resolve(true);
+								oContext.getModel().submitBatch(sGroupId);
+							} else {
+								resolve(false);
+							}
+						}
+					});
+				});
+			});
+		return dialogPromise;
+	}
+}*/
+/**
+ * Activates a draft document. The draft will replace the sibling entity and will be deleted by the back end.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the action should be performed
+ * @param {object} oAppComponent The AppComponent
+ * @param {string} [sGroupId] The optional batch group in which the operation is to be executed
+ * @returns {Promise.<sap.ui.model.odata.v4.Context>} Resolve function returns the context of the operation
+ * @private
+ * @ui5-restricted
+ */
+function executeDraftActivationAction(oContext: any, oAppComponent: AppComponent, sGroupId?: string) {
+	const bHasPrepareAction = hasPrepareAction(oContext);
+
+	// According to the draft spec if the service contains a prepare action and we trigger both prepare and
+	// activate in one $batch the activate action is called with iF-Match=*
+	const bIgnoreEtag = bHasPrepareAction;
+
+	if (!oContext.getProperty("IsActiveEntity")) {
+		const oOperation = createOperation(oContext, draftOperations.ACTIVATION, { $$inheritExpandSelect: true });
+		return oOperation
+			.execute(sGroupId, bIgnoreEtag)
+			.then(function(oActiveDocumentContext: any) {
+				return oActiveDocumentContext;
+			})
+			.catch(
+				//if ACTIVATE action fails then we request either the sideEffects against PREPARE action (if annotated) or the messages as fallback:
+				function() {
+					if (bHasPrepareAction) {
+						const sActionName = getActionName(oContext, draftOperations.PREPARE),
+							oSideEffectsService = oAppComponent.getSideEffectsService(),
+							oBindingParameters = oSideEffectsService.getODataActionSideEffects(sActionName, oContext),
+							aTargetPaths = oBindingParameters && oBindingParameters.pathExpressions;
+						if (aTargetPaths && aTargetPaths.length > 0) {
+							oSideEffectsService.requestSideEffects(aTargetPaths, oContext).catch(function(oError: any) {
+								Log.error("Error while requesting side effects", oError);
+							});
+						} else {
+							requestMessages(oContext, oSideEffectsService).catch(function(oError: any) {
+								Log.error("Error while requesting messages", oError);
+							});
+						}
+					}
+					return Promise.reject();
+				}
+			);
+	} else {
+		throw new Error("The activation action cannot be executed on an active document");
+	}
+}
+/**
+ * Execute a preparation action.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the action should be performed
+ * @param {object} oAppComponent The AppComponent
+ * @param {object} mParameters The parameters
+ * @param {boolean} [mParameters.groupId] The optional batch group where we want to execute the operation in
+ * @param {boolean} [mParameters.bPrepareForEdit] Shall the messages be requested if supported by service
+ * @returns {Promise.<sap.ui.model.odata.v4.Context>} Resolve function returns the context of the operation
+ * @private
+ * @ui5-restricted
+ */
+function executeDraftPreparationAction(
+	oContext: any,
+	oAppComponent: AppComponent,
+	mParameters: { groupId?: string; bPrepareForEdit?: boolean }
+) {
+	const mParams = mParameters || {};
+	if (!oContext.getProperty("IsActiveEntity")) {
+		const oOperation = createOperation(oContext, draftOperations.PREPARE);
+
+		// TODO: side effects qualifier shall be even deprecated to be checked
+		oOperation.setParameter("SideEffectsQualifier", "");
+
+		const sGroupId = mParams.groupId || oOperation.getGroupId();
+		const oPreparationPromise = oOperation
+			.execute(sGroupId)
+			.then(function() {
+				if (mParams.bPrepareForEdit) {
+					// if PREPARE action is triggered after Edit then either the sideEffects (if annotated against PREPARE) are executed or the messages are requested as fallback if no sideEffects:
+					const sActionName = getActionName(oContext, draftOperations.PREPARE),
+						oSideEffectsService = oAppComponent.getSideEffectsService(),
+						oBindingParameters = oSideEffectsService.getODataActionSideEffects(sActionName, oContext),
+						aTargetPaths = oBindingParameters && oBindingParameters.pathExpressions;
+					if (aTargetPaths && aTargetPaths.length > 0) {
+						oSideEffectsService.requestSideEffects(aTargetPaths, oContext, sGroupId).catch(function(oError: any) {
+							Log.error("Error while requesting side effects", oError);
+						});
+					} else {
+						requestMessages(oContext, oSideEffectsService);
+					}
+				}
+				return oOperation;
+			})
+			.catch(function(oError: any) {
+				Log.error("Error while executing the operation", oError);
+			});
+
+		return oPreparationPromise;
+	} else {
+		throw new Error("The preparation action cannot be executed on an active document");
+	}
+}
+/**
+ * Determines the message path for a context.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the path shall be determined
+ * @returns {string} Message path, empty if not annotated
+ * @private
+ * @ui5-restricted
+ */
+function getMessagesPath(oContext: Context): string {
+	const oModel = oContext.getModel(),
+		oMetaModel = oModel.getMetaModel() as ODataMetaModel,
+		sEntitySetPath = oMetaModel.getMetaPath(oContext.getPath());
+	return oMetaModel.getObject(sEntitySetPath + "/@com.sap.vocabularies.Common.v1.Messages/$Path");
+}
+/**
+ * Requests the messages if annotated for a given context.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the messages shall be requested
+ * @param {object} oSideEffectsService Service for the SideEffects on SAP Fiori elements
+ * @returns {Promise} Promise which is resolved once messages were requested
+ * @private
+ * @ui5-restricted
+ */
+function requestMessages(oContext: any, oSideEffectsService: SideEffectsService) {
+	const sMessagesPath = getMessagesPath(oContext);
+	if (sMessagesPath) {
+		return oSideEffectsService.requestSideEffects([{ $PropertyPath: sMessagesPath }] as any, oContext);
+	}
+	return Promise.resolve();
+}
+/**
+ * Executes discard of a draft function using HTTP Post.
+ *
+ * @function
+ * @param {sap.ui.model.odata.v4.Context} oContext Context for which the action should be performed
+ * @returns {Promise.<sap.ui.model.odata.v4.Context>} Resolve function returns the context of the operation
+ * @private
+ * @ui5-restricted
+ */
+function executeDraftDiscardAction(oContext: any): Promise<boolean> {
+	if (!oContext.getProperty("IsActiveEntity")) {
+		const oDiscardOperation = createOperation(oContext, draftOperations.DISCARD);
+		const oDiscardPromise = oDiscardOperation.execute("direct");
+		oContext.getModel().submitBatch("direct");
+		return oDiscardPromise;
+	} else {
+		throw new Error("The discard action cannot be executed on an active document");
+	}
+}
+/**
+ * Creates a draft document from an existing document.
+ *
+ * The function supports several hooks as there is a certain coreography defined.
+ *
+ * @function
+ * @name sap.fe.core.actions.draft#createDraftFromActiveDocument
+ * @memberof sap.fe.core.actions.draft
+ * @static
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the active document for the new draft
+ * @param {object} oAppComponent The AppComponent
+ * @param {object} mParameters The parameters
+ * @param {boolean} [mParameters.oView] The view
+ * @param {boolean} [mParameters.bPreserveChanges] Preserve changes of an existing draft of another user
+ * @param {boolean} [mParameters.bPrepareOnEdit] Also call prepare when calling draft creation
+ * @param {sap.fe.core.actions.draft.ICallback.beforeCreateDraftFromActiveDocument} [mParameters.fnBeforeCreateDraftFromActiveDocument] Callback that allows veto before create request is executed
+ * @param {sap.fe.core.actions.draft.ICallback.afterCreateDraftFromActiveDocument} [mParameters.fnAfterCreateDraftFromActiveDocument] Callback for postprocessiong after draft document was created
+ * @param {sap.fe.core.actions.draft.ICallback.whenDecisionToOverwriteDocumentIsRequired} [mParameters.fnWhenDecisionToOverwriteDocumentIsRequired] Callback for deciding on overwriting an unsaved change by another user
+ * @returns {Promise} Promise resolves with the {@link sap.ui.model.odata.v4.Context context} of the new draft document
+ * @private
+ * @ui5-restricted
+ */
+function createDraftFromActiveDocument(
+	oContext: any,
+	oAppComponent: object,
+	mParameters: {
+		oView: View;
+		bPreserveChanges?: boolean | undefined;
+		bPrepareOnEdit?: boolean | undefined;
+		fnBeforeCreateDraftFromActiveDocument?: any;
+		fnAfterCreateDraftFromActiveDocument?: any;
+		fnWhenDecisionToOverwriteDocumentIsRequired?: any;
+	}
+) {
+	const mParam = mParameters || {},
+		localI18nRef = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle,
+		bRunPreserveChangesFlow =
+			typeof mParam.bPreserveChanges === "undefined" || (typeof mParam.bPreserveChanges === "boolean" && mParam.bPreserveChanges); //default true
+
+	/**
+	 * Overwrite or reject based on fnWhenDecisionToOverwriteDocumentIsRequired.
+	 *
+	 * @param {*} bOverwrite Overwrite the change or not
+	 * @returns {Promise} Resolves with result of {@link sap.fe.core.actions#executeDraftEditAction}
+	 */
+	function overwriteOnDemand(bOverwrite: any) {
+		if (bOverwrite) {
+			//Overwrite existing changes
+			const oModel = oContext.getModel();
+			const draftDataContext = oModel.bindContext(oContext.getPath() + "/DraftAdministrativeData").getBoundContext();
+			let oResourceBundle: ResourceBundle;
+
+			return ((mParameters.oView.getModel("sap.fe.i18n") as ResourceModel).getResourceBundle() as Promise<ResourceBundle>)
+				.then(function(_oResourceBundle: any) {
+					oResourceBundle = _oResourceBundle;
+					return draftDataContext.requestObject();
+				})
+				.then(function(draftAdminData: any) {
+					if (draftAdminData) {
+						// remove all unbound transition messages as we show a special dialog
+						messageHandling.removeUnboundTransitionMessages();
+						let sInfo = draftAdminData.InProcessByUserDescription || draftAdminData.InProcessByUser;
+						const sEntitySet = (mParameters.oView.getViewData() as any).entitySet;
+						if (sInfo) {
+							const sLockedByUserMsg = CommonUtils.getTranslatedText(
+								"C_DRAFT_OBJECT_PAGE_DRAFT_LOCKED_BY_USER",
+								oResourceBundle,
+								sInfo,
+								sEntitySet
+							);
+							MessageBox.error(sLockedByUserMsg);
+							throw new Error(sLockedByUserMsg);
+						} else {
+							sInfo = draftAdminData.CreatedByUserDescription || draftAdminData.CreatedByUser;
+							const sUnsavedChangesMsg = CommonUtils.getTranslatedText(
+								"C_DRAFT_OBJECT_PAGE_DRAFT_UNSAVED_CHANGES",
+								oResourceBundle,
+								sInfo,
+								sEntitySet
+							);
+							return showMessageBox(sUnsavedChangesMsg).then(function() {
+								return executeDraftEditAction(oContext, false);
+							});
+						}
+					}
+				});
+		}
+		return Promise.reject(new Error("Draft creation aborted for document: " + oContext.getPath()));
+	}
+
+	function showMessageBox(sUnsavedChangesMsg: any) {
+		return new Promise(function(resolve: (value: any) => void, reject: (reason?: any) => void) {
+			const oDialog = new Dialog({
+				title: localI18nRef.getText("C_DRAFT_OBJECT_PAGE_WARNING"),
+				state: "Warning",
+				content: new Text({
+					text: sUnsavedChangesMsg
+				}),
+				beginButton: new Button({
+					text: localI18nRef.getText("C_COMMON_OBJECT_PAGE_EDIT"),
+					type: "Emphasized",
+					press: function() {
+						oDialog.close();
+						resolve(true);
+					}
+				}),
+				endButton: new Button({
+					text: localI18nRef.getText("C_COMMON_OBJECT_PAGE_CANCEL"),
+					press: function() {
+						oDialog.close();
+						reject("Draft creation aborted for document: " + oContext.getPath());
+					}
+				}),
+				afterClose: function() {
+					oDialog.destroy();
+				}
+			});
+			oDialog.addStyleClass("sapUiContentPadding");
+			oDialog.open();
+		});
+	}
+
+	if (!oContext) {
+		return Promise.reject(new Error("Binding context to active document is required"));
+	}
+
+	return Promise.resolve(
+		mParam.fnBeforeCreateDraftFromActiveDocument
+			? mParam.fnBeforeCreateDraftFromActiveDocument(oContext, bRunPreserveChangesFlow)
+			: true
+	)
+		.then(function(bExecute: any) {
+			if (!bExecute) {
+				throw new Error("Draft creation was aborted by extension for document: " + oContext.getPath());
+			}
+			return executeDraftEditAction(oContext, bRunPreserveChangesFlow).catch(function(oResponse: any) {
+				//Only call back if error 409
+				if (bRunPreserveChangesFlow && oResponse.status === 409) {
+					return Promise.resolve(
+						mParam.fnWhenDecisionToOverwriteDocumentIsRequired ? mParam.fnWhenDecisionToOverwriteDocumentIsRequired() : true
+					).then(overwriteOnDemand);
+				} else {
+					throw new Error(oResponse);
+				}
+			});
+		})
+		.then(function(oDraftContext: any) {
+			return Promise.resolve(
+				mParam.fnAfterCreateDraftFromActiveDocument
+					? mParam.fnAfterCreateDraftFromActiveDocument(oContext, oDraftContext)
+					: oDraftContext
+			);
+		})
+		.then(function(oDraftContext: any) {
+			if (mParam.bPrepareOnEdit && hasPrepareAction(oDraftContext)) {
+				return executeDraftPreparationAction(oDraftContext, oAppComponent, { bPrepareForEdit: true }).then(function() {
+					return oDraftContext;
+				});
+			}
+			return oDraftContext;
+		})
+		.catch(function(exc: any) {
+			return Promise.reject(exc);
+		});
+}
+/**
+ * Creates an active document from a draft document.
+ *
+ * The function supports several hooks as there is a certain choreography defined.
+ *
+ * @function
+ * @name sap.fe.core.actions.draft#activateDocument
+ * @memberof sap.fe.core.actions.draft
+ * @static
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the active document for the new draft
+ * @param {object} oAppComponent The AppComponent
+ * @param {object} mParameters The parameters
+ * @param {sap.fe.core.actions.draft.ICallback.fnBeforeActivateDocument} [mParameters.fnBeforeActivateDocument] Callback that allows veto before create request is executed
+ * @param {sap.fe.core.actions.draft.ICallback.fnAfterActivateDocument} [mParameters.fnAfterActivateDocument] Callback for postprocessiong after document was activated.
+ * @returns {Promise} Promise resolves with the {@link sap.ui.model.odata.v4.Context context} of the new draft document
+ * @private
+ * @ui5-restricted
+ */
+function activateDocument(
+	oContext: any,
+	oAppComponent: object,
+	mParameters: { fnBeforeActivateDocument?: any; fnAfterActivateDocument?: any }
+) {
+	const mParam = mParameters || {};
+
+	if (!oContext) {
+		return Promise.reject(new Error("Binding context to draft document is required"));
+	}
+	return Promise.resolve(mParam.fnBeforeActivateDocument ? mParam.fnBeforeActivateDocument(oContext) : true)
+		.then(function(bExecute: any) {
+			if (!bExecute) {
+				return Promise.reject(new Error("Activation of the document was aborted by extension for document: " + oContext.getPath()));
+			}
+
+			if (!hasPrepareAction(oContext)) {
+				return executeDraftActivationAction(oContext, oAppComponent);
+			}
+
+			/* activation requires preparation */
+			const sBatchGroup = "draft";
+			// we use the same batchGroup to force prepare and activate in a same batch but with different changeset
+			const oPreparePromise = executeDraftPreparationAction(oContext, oAppComponent, {
+				groupId: sBatchGroup,
+				bPrepareForEdit: false
+			});
+			oContext.getModel().submitBatch(sBatchGroup);
+
+			const oActivatePromise = executeDraftActivationAction(oContext, oAppComponent, sBatchGroup);
+
+			return Promise.all([oPreparePromise, oActivatePromise])
+				.then(function(values: [any, any]) {
+					return values[1];
+				})
+				.catch(function(exc: any) {
+					return Promise.reject(exc);
+				});
+		})
+		.then(function(oActiveDocumentContext: any) {
+			return Promise.resolve(
+				mParam.fnAfterActivateDocument ? mParam.fnAfterActivateDocument(oContext, oActiveDocumentContext) : oActiveDocumentContext
+			);
+		})
+		.catch(function(exc: any) {
+			return Promise.reject(exc);
+		});
+}
+/**
+ * HTTP POST call when DraftAction is present for Draft Delete; HTTP DELETE for Draft(when no DraftAction)
+ * and Active Instance uses DELETE always.
+ *
+ * @function
+ * @name sap.fe.core.actions.draft#deleteDraft
+ * @memberof sap.fe.core.actions.draft
+ * @static
+ * @param {sap.ui.model.odata.v4.Context} oContext Context of the document to be discarded
+ * @private
+ * @returns {Promise}
+ * @ui5-restricted
+ */
+function deleteDraft(oContext: any): Promise<boolean> {
+	const sDiscardAction = getActionName(oContext, draftOperations.DISCARD),
+		bIsActiveEntity = oContext.getObject().IsActiveEntity;
+
+	if (bIsActiveEntity || (!bIsActiveEntity && !sDiscardAction)) {
+		//Use Delete in case of active entity and no discard action available for draft
+		if (oContext.hasPendingChanges()) {
+			return oContext
+				.getBinding()
+				.resetChanges()
+				.then(function() {
+					return oContext.delete();
+				})
+				.catch(function(error: any) {
+					return Promise.reject(error);
+				});
+		} else {
+			return oContext.delete();
+		}
+	} else {
+		//Use Discard Post Action if it is a draft entity and discard action exists
+		return executeDraftDiscardAction(oContext);
+	}
+}
+
+export default draft;