@sapui5/sap.fe.core 1.100.0 → 1.101.0

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

@@ -1,17 +1,27 @@
-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 ResourceBundle from "sap/base/i18n/ResourceBundle";
 import Log from "sap/base/Log";
+import ActivitySync from "sap/fe/core/actions/collaboration/ActivitySync";
+import messageHandling from "sap/fe/core/actions/messageHandling";
 import AppComponent from "sap/fe/core/AppComponent";
+import CommonUtils from "sap/fe/core/CommonUtils";
+import FELibrary from "sap/fe/core/library";
 import { SideEffectsService } from "sap/fe/core/services/SideEffectsServiceFactory";
-import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import Button from "sap/m/Button";
+import Dialog from "sap/m/Dialog";
+import MessageBox from "sap/m/MessageBox";
+import Text from "sap/m/Text";
+import Core from "sap/ui/core/Core";
 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";
+import { CoreEx } from "types/extension_types";
+
+const ProgrammingModel = FELibrary.ProgrammingModel;
+export type SiblingInformation = {
+	targetContext: Context;
+	pathMapping: { oldPath: string; newPath: string }[];
+};
 
 /**
  * Interface for callbacks used in the functions
@@ -78,11 +88,7 @@ const draftOperations = {
  * @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.
  *
@@ -135,11 +141,11 @@ function executeDraftEditAction(oContext: any, bPreserveChanges: boolean) {
 		const oOperation = createOperation(oContext, draftOperations.EDIT, oOptions);
 		oOperation.setParameter("PreserveChanges", bPreserveChanges);
 		const sGroupId = "direct";
-		const localI18nRef = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+		const localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 		const sActionName = localI18nRef.getText("C_COMMON_OBJECT_PAGE_EDIT");
 		const oEditPromise = oOperation
 			.execute(sGroupId, undefined, CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()))
-			.then(function(oDraftDocumentContext: any) {
+			.then(function (oDraftDocumentContext: any) {
 				return oDraftDocumentContext;
 			});
 		oOperation.getModel().submitBatch(sGroupId);
@@ -169,7 +175,7 @@ function executeDraftActivationAction(oContext: any, oAppComponent: AppComponent
 
 	if (!oContext.getProperty("IsActiveEntity")) {
 		const oOperation = createOperation(oContext, draftOperations.ACTIVATION, { $$inheritExpandSelect: true });
-		const localI18nRef = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+		const localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 		const sActionName = localI18nRef.getText("C_OP_OBJECT_PAGE_SAVE");
 		return oOperation
 			.execute(
@@ -177,23 +183,23 @@ function executeDraftActivationAction(oContext: any, oAppComponent: AppComponent
 				bIgnoreEtag,
 				sGroupId ? CommonUtils.fnOnStrictHandlingFailed.bind(draft, sGroupId, sActionName, oContext.getModel()) : undefined
 			) //3rd parameter<------
-			.then(function(oActiveDocumentContext: any) {
+			.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() {
+				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) {
+							oSideEffectsService.requestSideEffects(aTargetPaths, oContext).catch(function (oError: any) {
 								Log.error("Error while requesting side effects", oError);
 							});
 						} else {
-							requestMessages(oContext, oSideEffectsService).catch(function(oError: any) {
+							requestMessages(oContext, oSideEffectsService).catch(function (oError: any) {
 								Log.error("Error while requesting messages", oError);
 							});
 						}
@@ -225,10 +231,10 @@ function executeDraftPreparationAction(oContext: Context, groupId?: string) {
 		const sGroupId = groupId || oOperation.getGroupId();
 		return oOperation
 			.execute(sGroupId)
-			.then(function() {
+			.then(function () {
 				return oOperation;
 			})
-			.catch(function(oError: any) {
+			.catch(function (oError: any) {
 				Log.error("Error while executing the operation", oError);
 			});
 	} else {
@@ -279,7 +285,7 @@ function requestMessages(oContext: any, oSideEffectsService: SideEffectsService)
 function executeDraftDiscardAction(oContext: any): Promise<boolean> {
 	if (!oContext.getProperty("IsActiveEntity")) {
 		const oDiscardOperation = createOperation(oContext, draftOperations.DISCARD);
-		const localI18nRef = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+		const localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core");
 		const sGroupId = "direct";
 		const sActionName = localI18nRef.getText("C_TRANSACTION_HELPER_DRAFT_DISCARD_BUTTON");
 		const oDiscardPromise = oDiscardOperation.execute(
@@ -293,6 +299,84 @@ function executeDraftDiscardAction(oContext: any): Promise<boolean> {
 		throw new Error("The discard action cannot be executed on an active document");
 	}
 }
+
+/**
+ * This methods creates a sibling context for a sub-object page, and calculates a sibling path for
+ * all intermediates paths between the OP and the sub-OP.
+ *
+ * @param {object} rootCurrentContext The context for the root of the draft
+ * @param {object} rightmostCurrentContext The context of the sub-object
+ * @returns {Promise} returns the siblingInformation object
+ */
+async function computeSiblingInformation(
+	rootCurrentContext: Context,
+	rightmostCurrentContext: Context
+): Promise<SiblingInformation | undefined> {
+	if (!rightmostCurrentContext.getPath().startsWith(rootCurrentContext.getPath())) {
+		// Wrong usage !!
+		Log.error("Cannot compute rightmost sibling context");
+		throw new Error("Cannot compute rightmost sibling context");
+	}
+
+	const model = rootCurrentContext.getModel();
+	try {
+		// //////////////////////////////////////////////////////////////////
+		// 1. Find all segments between the root object and the sub-object
+		// Example: for root = /Param(aa)/Entity(bb) and rightMost = /Param(aa)/Entity(bb)/_Nav(cc)/_SubNav(dd)
+		// ---> ["Param(aa)/Entity(bb)", "_Nav(cc)", "_SubNav(dd)"]
+
+		// Find all segments in the rightmost path
+		const additionalPath = rightmostCurrentContext.getPath().replace(rootCurrentContext.getPath(), "");
+		const segments = additionalPath ? additionalPath.substring(1).split("/") : [];
+		// First segment is always the full path of the root object, which can contain '/' in case of a parametrized entity
+		segments.unshift(rootCurrentContext.getPath().substring(1));
+
+		// //////////////////////////////////////////////////////////////////
+		// 2. Request canonical paths of the sibling entity for eah segment
+		// Example: for ["Param(aa)/Entity(bb)", "_Nav(cc)", "_SubNav(dd)"]
+		// --> request canonical paths for "Param(aa)/Entity(bb)/SiblingEntity", "Param(aa)/Entity(bb)/_Nav(cc)/SiblingEntity", "Param(aa)/Entity(bb)/_Nav(cc)/_SubNav(dd)/SiblingEntity"
+		const oldPaths: string[] = [];
+		const newPaths: string[] = [];
+		let currentPath = "";
+		const canonicalPathPromises = segments.map((segment) => {
+			currentPath += `/${segment}`;
+			oldPaths.unshift(currentPath);
+			const siblingContext = model.bindContext(currentPath + "/SiblingEntity").getBoundContext() as Context;
+			return siblingContext.requestCanonicalPath();
+		});
+
+		// //////////////////////////////////////////////////////////////////
+		// 3. Reconstruct the full paths from canonical paths (for path mapping)
+		// Example: for canonical paths "/Param(aa)/Entity(bb-sibling)", "/Entity2(cc-sibling)", "/Entity3(dd-sibling)"
+		// --> ["Param(aa)/Entity(bb-sibling)", "Param(aa)/Entity(bb-sibling)/_Nav(cc-sibling)", "Param(aa)/Entity(bb-sibling)/_Nav(cc-sibling)/_SubNav(dd-sibling)"]
+		const canonicalPaths = (await Promise.all(canonicalPathPromises)) as string[];
+		let siblingPath = "";
+		canonicalPaths.forEach((canonicalPath, index) => {
+			if (index !== 0) {
+				const navigation = segments[index].replace(/\(.*$/, ""); // Keep only navigation name from the segment, i.e. aaa(xxx) --> aaa
+				const keys = canonicalPath.replace(/.*\(/, "("); // Keep only the keys fmro the canonical path, i.e. aaa(xxx) --> (xxx)
+				siblingPath += `/${navigation}${keys}`;
+			} else {
+				siblingPath = canonicalPath; // To manage parametrized entities
+			}
+			newPaths.unshift(siblingPath);
+		});
+
+		return {
+			targetContext: model.bindContext(siblingPath).getBoundContext() as Context, // Create the rightmost sibling context from its path
+			pathMapping: oldPaths.map((oldPath, index) => {
+				return {
+					oldPath,
+					newPath: newPaths[index]
+				};
+			})
+		};
+	} catch (error) {
+		// A canonical path couldn't be resolved (because a sibling doesn't exist)
+		return undefined;
+	}
+}
+
 /**
  * Creates a draft document from an existing document.
  *
@@ -314,7 +398,7 @@ function executeDraftDiscardAction(oContext: any): Promise<boolean> {
  * @private
  * @ui5-restricted
  */
-function createDraftFromActiveDocument(
+async function createDraftFromActiveDocument(
 	oContext: any,
 	oAppComponent: AppComponent,
 	mParameters: {
@@ -326,7 +410,7 @@ function createDraftFromActiveDocument(
 	}
 ) {
 	const mParam = mParameters || {},
-		localI18nRef = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle,
+		localI18nRef = (Core as CoreEx).getLibraryResourceBundle("sap.fe.core"),
 		bRunPreserveChangesFlow =
 			typeof mParam.bPreserveChanges === "undefined" || (typeof mParam.bPreserveChanges === "boolean" && mParam.bPreserveChanges); //default true
 
@@ -344,11 +428,11 @@ function createDraftFromActiveDocument(
 			let oResourceBundle: ResourceBundle;
 
 			return ((mParameters.oView.getModel("sap.fe.i18n") as ResourceModel).getResourceBundle() as Promise<ResourceBundle>)
-				.then(function(_oResourceBundle: any) {
+				.then(function (_oResourceBundle: any) {
 					oResourceBundle = _oResourceBundle;
 					return draftDataContext.requestObject();
 				})
-				.then(function(draftAdminData: any) {
+				.then(function (draftAdminData: any) {
 					if (draftAdminData) {
 						// remove all unbound transition messages as we show a special dialog
 						messageHandling.removeUnboundTransitionMessages();
@@ -371,7 +455,7 @@ function createDraftFromActiveDocument(
 								sInfo,
 								sEntitySet
 							);
-							return showMessageBox(sUnsavedChangesMsg).then(function() {
+							return showMessageBox(sUnsavedChangesMsg).then(function () {
 								return executeDraftEditAction(oContext, false);
 							});
 						}
@@ -382,7 +466,7 @@ function createDraftFromActiveDocument(
 	}
 
 	function showMessageBox(sUnsavedChangesMsg: any) {
-		return new Promise(function(resolve: (value: any) => void, reject: (reason?: any) => void) {
+		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",
@@ -392,19 +476,19 @@ function createDraftFromActiveDocument(
 				beginButton: new Button({
 					text: localI18nRef.getText("C_COMMON_OBJECT_PAGE_EDIT"),
 					type: "Emphasized",
-					press: function() {
+					press: function () {
 						oDialog.close();
 						resolve(true);
 					}
 				}),
 				endButton: new Button({
 					text: localI18nRef.getText("C_COMMON_OBJECT_PAGE_CANCEL"),
-					press: function() {
+					press: function () {
 						oDialog.close();
 						reject("Draft creation aborted for document: " + oContext.getPath());
 					}
 				}),
-				afterClose: function() {
+				afterClose: function () {
 					oDialog.destroy();
 				}
 			});
@@ -417,50 +501,62 @@ function createDraftFromActiveDocument(
 		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);
+	const bExecute = mParam.fnBeforeCreateDraftFromActiveDocument
+		? mParam.fnBeforeCreateDraftFromActiveDocument(oContext, bRunPreserveChangesFlow)
+		: true;
+
+	if (!bExecute) {
+		throw new Error("Draft creation was aborted by extension for document: " + oContext.getPath());
+	}
+	let openingSiblingContext = false;
+	try {
+		let oDraftContext: Context | null = null;
+		try {
+			oDraftContext = await draft.executeDraftEditAction(oContext, bRunPreserveChangesFlow);
+		} catch (oResponse: any) {
+			//Only call back if error 409
+			if (bRunPreserveChangesFlow && oResponse.status === 409) {
+				if (ActivitySync.isCollaborationEnabled(mParameters.oView)) {
+					messageHandling.removeUnboundTransitionMessages();
+					const siblingInfo = await draft.computeSiblingInformation(oContext, oContext);
+					const siblingContext = (mParameters.oView.getController() as any)._routing._createBindingContext(
+						siblingInfo?.targetContext.getPath(),
+						oContext.getModel()
+					);
+					openingSiblingContext = true;
+					return siblingContext;
 				} else {
-					throw new Error(oResponse);
+					oDraftContext = await overwriteOnDemand(
+						mParam.fnWhenDecisionToOverwriteDocumentIsRequired ? mParam.fnWhenDecisionToOverwriteDocumentIsRequired() : true
+					);
 				}
-			});
-		})
-		.then(function(oDraftContext: any) {
-			return Promise.resolve(
-				mParam.fnAfterCreateDraftFromActiveDocument
-					? mParam.fnAfterCreateDraftFromActiveDocument(oContext, oDraftContext)
-					: oDraftContext
-			);
-		})
-		.then(function(oDraftContext: any) {
+			} else {
+				throw new Error(oResponse);
+			}
+		}
+		if (openingSiblingContext) {
+			return oDraftContext;
+		}
+
+		oDraftContext =
+			oDraftContext && mParam.fnAfterCreateDraftFromActiveDocument
+				? mParam.fnAfterCreateDraftFromActiveDocument(oContext, oDraftContext)
+				: oDraftContext;
+
+		if (oDraftContext) {
 			const sEditActionName = getActionName(oDraftContext, draftOperations.EDIT);
 			const oSideEffects = oAppComponent.getSideEffectsService().getODataActionSideEffects(sEditActionName, oDraftContext);
 			if (oSideEffects?.triggerActions?.length) {
-				return oAppComponent
-					.getSideEffectsService()
-					.requestSideEffectsForODataAction(oSideEffects, oDraftContext)
-					.then(() => {
-						return oDraftContext;
-					});
+				await oAppComponent.getSideEffectsService().requestSideEffectsForODataAction(oSideEffects, oDraftContext);
+
+				return oDraftContext;
 			} else {
 				return oDraftContext;
 			}
-		})
-		.catch(function(exc: any) {
-			return Promise.reject(exc);
-		});
+		}
+	} catch (exc: any) {
+		return Promise.reject(exc);
+	}
 }
 /**
  * Creates an active document from a draft document.
@@ -491,7 +587,7 @@ function activateDocument(
 		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) {
+		.then(function (bExecute: any) {
 			if (!bExecute) {
 				return Promise.reject(new Error("Activation of the document was aborted by extension for document: " + oContext.getPath()));
 			}
@@ -509,19 +605,19 @@ function activateDocument(
 			const oActivatePromise = executeDraftActivationAction(oContext, oAppComponent, sBatchGroup);
 
 			return Promise.all([oPreparePromise, oActivatePromise])
-				.then(function(values: [any, any]) {
+				.then(function (values: [any, any]) {
 					return values[1];
 				})
-				.catch(function(exc: any) {
+				.catch(function (exc: any) {
 					return Promise.reject(exc);
 				});
 		})
-		.then(function(oActiveDocumentContext: any) {
+		.then(function (oActiveDocumentContext: any) {
 			return Promise.resolve(
 				mParam.fnAfterActivateDocument ? mParam.fnAfterActivateDocument(oContext, oActiveDocumentContext) : oActiveDocumentContext
 			);
 		})
-		.catch(function(exc: any) {
+		.catch(function (exc: any) {
 			return Promise.reject(exc);
 		});
 }
@@ -548,10 +644,10 @@ function deleteDraft(oContext: any): Promise<boolean> {
 			return oContext
 				.getBinding()
 				.resetChanges()
-				.then(function() {
+				.then(function () {
 					return oContext.delete();
 				})
-				.catch(function(error: any) {
+				.catch(function (error: any) {
 					return Promise.reject(error);
 				});
 		} else {
@@ -562,5 +658,12 @@ function deleteDraft(oContext: any): Promise<boolean> {
 		return executeDraftDiscardAction(oContext);
 	}
 }
+const draft = {
+	createDraftFromActiveDocument: createDraftFromActiveDocument,
+	activateDocument: activateDocument,
+	deleteDraft: deleteDraft,
+	executeDraftEditAction: executeDraftEditAction,
+	computeSiblingInformation: computeSiblingInformation
+};
 
 export default draft;