@sapui5/sap.fe.core 1.127.2 → 1.129.0

package/src/sap/fe/core/controllerextensions/editFlow/TransactionHelper.ts

@@ -41,8 +41,8 @@ import type Event from "sap/ui/base/Event";
 import type Control from "sap/ui/core/Control";
 import Library from "sap/ui/core/Lib";
 import Messaging from "sap/ui/core/Messaging";
-import coreLibrary from "sap/ui/core/library";
 import type Message from "sap/ui/core/message/Message";
+import MessageType from "sap/ui/core/message/MessageType";
 import type View from "sap/ui/core/mvc/View";
 import type MultiValueFieldItem from "sap/ui/mdc/field/MultiValueFieldItem";
 import type Binding from "sap/ui/model/Binding";
@@ -76,10 +76,12 @@ export type CreateParameters = {
 	parentControl: View;
 	inactive?: boolean;
 	beforeCreateCallBack?: Function;
+	afterCreateCallBack?: (context: ODataV4Context) => Promise<void>;
 	skipParameterDialog?: boolean;
 	creationMode?: string;
 	createAtEnd?: boolean;
 	parentContext?: ODataV4Context;
+	creationDialogFields?: string[];
 };
 
 export type CancelParameters = { cancelButton: Button; skipDiscardPopover: boolean; beforeCancelCallBack?: Function };
@@ -118,7 +120,6 @@ class TransactionHelper {
 
 	/**
 	 * Validates a document.
-	 *
 	 * @param oContext Context of the document to be validated
 	 * @param [mParameters] Can contain the following attributes:
 	 * @param [mParameters.data] A map of data that should be validated
@@ -148,7 +149,6 @@ class TransactionHelper {
 
 	/**
 	 * Retrieves defatul values from the DefaultValue function.
-	 *
 	 * @param listBinding The list binding to be used for creation
 	 * @returns A promise with an object containing the default values (or undefined if there's no default value function)
 	 */
@@ -186,7 +186,6 @@ class TransactionHelper {
 
 	/**
 	 * Checks if a list binding corresponds to a hierarchy.
-	 *
 	 * @param listBinding
 	 * @returns True if the list binding is hierarchical.
 	 */
@@ -194,9 +193,18 @@ class TransactionHelper {
 		return (listBinding.getAggregation() as { hierarchyQualifier?: string } | undefined)?.hierarchyQualifier ? true : false;
 	}
 
+	/**
+	 * Checks if the given list binding is analytical.
+	 * @param listBinding The list binding to check
+	 * @returns TRUE if the list binding is analytical, `false` otherwise.
+	 */
+	isListBindingAnalytical(listBinding: ODataListBinding): boolean {
+		const aggregation = listBinding.getAggregation() as { hierarchyQualifier?: string } | undefined;
+		return aggregation !== undefined && !aggregation.hierarchyQualifier;
+	}
+
 	/**
 	 * Creates a new context in a list binding. Handles both flat and hierarchical cases.
-	 *
 	 * @param listBinding
 	 * @param initialData Initial data to create the context.
 	 * @param options Creation options.
@@ -249,6 +257,18 @@ class TransactionHelper {
 			}
 
 			return listBindingForCreation.create(dataForCreation, true);
+		} else if (this.isListBindingAnalytical(listBinding)) {
+			if (listBinding.isRelative()) {
+				throw new Error("Creating a new document in a analytical table is supported only in a ListReport");
+			} else {
+				// We use a temporary flat listBinding for the creation, to avoid adding the new context in the table (we don't want to display it until it's saved)
+				const model = listBinding.getModel();
+				const listBindingForCreation = model.bindList(listBinding.getPath(), undefined, undefined, undefined, {
+					$$groupId: listBinding.getGroupId(),
+					$$updateGroupId: listBinding.getUpdateGroupId()
+				});
+				return listBindingForCreation.create(dataForCreation, true);
+			}
 		} else {
 			return listBinding.create(dataForCreation, true, options.createAtEnd, options.createInactive);
 		}
@@ -267,7 +287,6 @@ class TransactionHelper {
 
 	/**
 	 * Creates a new document.
-	 *
 	 * @param mainListBinding OData V4 ListBinding object
 	 * @param [inParameters] Optional, can contain the following attributes:
 	 * @param [inParameters.data] A map of data that should be sent within the POST
@@ -306,7 +325,7 @@ class TransactionHelper {
 		const resourceBundleCore = Library.getResourceBundleFor("sap.fe.core")!;
 		const messageHandlingKey = messageHandler.registerToHoldMessages();
 		try {
-			newDocumentContext = await this.performActionOrCreation(
+			newDocumentContext = await this.performCreation(
 				mainListBinding,
 				parameters,
 				appComponent,
@@ -342,7 +361,6 @@ class TransactionHelper {
 
 	/**
 	 * Creates a new document.
-	 *
 	 * @param mainListBinding OData V4 ListBinding object.
 	 * @param parameters Contains the following attributes
 	 * @param parameters.data A map of data that should be sent within the POST
@@ -385,8 +403,7 @@ class TransactionHelper {
 	}
 
 	/**
-	 * Creates a new document either via new Action or createDocumentContext.
-	 *
+	 * Creates a new document either via new Action or standard POST create.
 	 * @param mainListBinding OData V4 ListBinding object
 	 * @param parameters Contains the following attributes
 	 * @param parameters.data A map of data that should be sent within the POST
@@ -406,7 +423,7 @@ class TransactionHelper {
 	 * @param fromCopyPaste True if the creation has been triggered by a paste action
 	 * @returns Promise resolves with new binding context
 	 */
-	private async performActionOrCreation(
+	private async performCreation(
 		mainListBinding: ODataListBinding,
 		parameters: CreateParameters,
 		appComponent: AppComponent,
@@ -414,75 +431,127 @@ class TransactionHelper {
 		resourceBundleCore: ResourceBundle,
 		fromCopyPaste: boolean
 	): Promise<ODataV4Context | undefined> {
-		// eslint-disable-next-line @typescript-eslint/no-this-alias
-		const model = mainListBinding.getModel(),
-			metaModel = model.getMetaModel(),
-			metaPath = metaModel.getMetaPath(mainListBinding.getHeaderContext()!.getPath()),
-			messagesPath = ModelHelper.getMessagesPath(metaModel, metaPath),
-			createHash = appComponent.getRouterProxy().getHash(),
-			componentData = appComponent.getComponentData(),
-			startupParameters = (componentData && componentData.startupParameters) || {},
-			newAction = !mainListBinding.isRelative() ? this._getNewAction(startupParameters, createHash, metaModel, metaPath) : undefined;
+		const metaModel = mainListBinding.getModel().getMetaModel();
+		const metaPath = metaModel.getMetaPath(mainListBinding.getHeaderContext()!.getPath());
+		const createHash = appComponent.getRouterProxy().getHash();
+		const componentData = appComponent.getComponentData();
+		const startupParameters = componentData?.startupParameters ?? {};
+		const newAction = !mainListBinding.isRelative()
+			? this._getNewAction(startupParameters, createHash, metaModel, metaPath)
+			: undefined;
+
+		if (newAction) {
+			return this.performCreationWithAction(newAction, mainListBinding, parameters, appComponent, messageHandler, resourceBundleCore);
+		} else {
+			return this.performCreationWithPOST(mainListBinding, parameters, appComponent, messageHandler, fromCopyPaste);
+		}
+	}
+
+	/**
+	 * Creates a document with an action.
+	 * @param actionName
+	 * @param mainListBinding
+	 * @param parameters
+	 * @param appComponent
+	 * @param messageHandler
+	 * @param resourceBundleCore
+	 * @returns The created context.
+	 */
+	private async performCreationWithAction(
+		actionName: string,
+		mainListBinding: ODataListBinding,
+		parameters: CreateParameters,
+		appComponent: AppComponent,
+		messageHandler: MessageHandler,
+		resourceBundleCore: ResourceBundle
+	): Promise<ODataV4Context | undefined> {
+		const metaModel = mainListBinding.getModel().getMetaModel();
+		const metaPath = metaModel.getMetaPath(mainListBinding.getHeaderContext()!.getPath());
+		const messagesPath = ModelHelper.getMessagesPath(metaModel, metaPath);
 		const bindingParameters: BindContextParameters = { $$patchWithoutSideEffects: true };
 
 		if (messagesPath) {
 			bindingParameters["$select"] = messagesPath;
 		}
-		let result: unknown;
-		if (newAction) {
-			result = await this.callAction(
-				newAction,
-				{
-					contexts: mainListBinding.getHeaderContext(),
-					showActionParameterDialog: true,
-					label: this._getSpecificCreateActionDialogLabel(metaModel, metaPath, newAction, resourceBundleCore),
-					bindingParameters: bindingParameters,
-					parentControl: parameters.parentControl,
-					bIsCreateAction: true,
-					skipParameterDialog: parameters.skipParameterDialog
-				},
-				null,
-				appComponent,
-				messageHandler
-			);
-			return result as ODataV4Context | undefined;
-		} else {
-			try {
-				let newDocumentContext: ODataV4Context | undefined;
-				const initialData = parameters.data;
-				if (!fromCopyPaste) {
-					const defaultValueFunctionData = await this.getDataFromDefaultValueFunction(mainListBinding);
-					parameters.data = Object.assign({}, defaultValueFunctionData, parameters.data);
-				}
-				if (parameters.data) {
-					delete parameters.data["@odata.context"];
-				}
+		const result = await this.callAction(
+			actionName,
+			{
+				contexts: mainListBinding.getHeaderContext(),
+				showActionParameterDialog: true,
+				label: this._getSpecificCreateActionDialogLabel(metaModel, metaPath, actionName, resourceBundleCore),
+				bindingParameters: bindingParameters,
+				parentControl: parameters.parentControl,
+				bIsCreateAction: true,
+				skipParameterDialog: parameters.skipParameterDialog
+			},
+			null,
+			appComponent,
+			messageHandler
+		);
+		return result as ODataV4Context | undefined;
+	}
 
-				const isNewPageCreation =
-					parameters.creationMode !== CreationMode.CreationRow && parameters.creationMode !== CreationMode.Inline;
-				const nonComputedVisibleKeyFields = isNewPageCreation
-					? this.getCreationParameters(mainListBinding, initialData, appComponent)
-					: [];
-				if (nonComputedVisibleKeyFields.length > 0) {
-					newDocumentContext = await this.createWithDialog(
-						mainListBinding,
-						nonComputedVisibleKeyFields,
-						parameters,
-						appComponent,
-						messageHandler
-					);
-				} else {
-					newDocumentContext = await this.createDocumentContext(mainListBinding, parameters);
-					if (!parameters.inactive) {
-						await this.waitForCreateCompletion(newDocumentContext, parameters.keepTransientContextOnFailed === true);
+	/**
+	 * Creates a docuemnt with a standard POST request.
+	 * @param mainListBinding
+	 * @param parameters
+	 * @param appComponent
+	 * @param messageHandler
+	 * @param fromCopyPaste
+	 * @returns The created context.
+	 */
+	private async performCreationWithPOST(
+		mainListBinding: ODataListBinding,
+		parameters: CreateParameters,
+		appComponent: AppComponent,
+		messageHandler: MessageHandler,
+		fromCopyPaste: boolean
+	): Promise<ODataV4Context | undefined> {
+		try {
+			let newDocumentContext: ODataV4Context | undefined;
+			const initialData = parameters.data;
+			if (!fromCopyPaste) {
+				const defaultValueFunctionData = await this.getDataFromDefaultValueFunction(mainListBinding);
+				parameters.data = Object.assign({}, defaultValueFunctionData, parameters.data);
+			}
+			if (parameters.data) {
+				delete parameters.data["@odata.context"];
+			}
+
+			const canHaveDialog = parameters.creationMode !== CreationMode.CreationRow && parameters.creationMode !== CreationMode.Inline;
+			const creationDialogFields = canHaveDialog ? this.getCreationParameters(mainListBinding, initialData, appComponent) : [];
+			if (parameters.creationMode === CreationMode.CreationDialog) {
+				parameters.creationDialogFields?.forEach((fieldName) => {
+					if (!creationDialogFields.includes(fieldName)) {
+						creationDialogFields.push(fieldName);
 					}
+				});
+
+				if (creationDialogFields.length === 0) {
+					// In CreationDialog mode, the dialog is mandatory
+					throw new Error("No fields available for the creation dialog");
 				}
-				return newDocumentContext;
-			} catch (error: unknown) {
-				const msg = typeof error === "string" ? error : (error as Error).message ?? error;
-				Log.error("Error while creating the new document", msg);
-				throw msg;
 			}
+
+			if (creationDialogFields.length > 0) {
+				newDocumentContext = await this.createWithDialog(
+					mainListBinding,
+					creationDialogFields,
+					parameters,
+					appComponent,
+					messageHandler
+				);
+			} else {
+				newDocumentContext = await this.createDocumentContext(mainListBinding, parameters);
+				if (!parameters.inactive) {
+					await this.waitForCreateCompletion(newDocumentContext, parameters.keepTransientContextOnFailed === true);
+				}
+			}
+			return newDocumentContext;
+		} catch (error: unknown) {
+			const msg = (error as Error).message ?? error;
+			Log.error("Error while creating the new document", msg);
+			throw msg;
 		}
 	}
 
@@ -494,7 +563,6 @@ class TransactionHelper {
 
 	/**
 	 * Delete one or multiple document(s).
-	 *
 	 * @param contexts Contexts Either one context or an array with contexts to be deleted
 	 * @param mParameters Optional, can contain the following attributes:
 	 * @param mParameters.title Title of the object to be deleted
@@ -677,7 +745,6 @@ class TransactionHelper {
 
 	/**
 	 * Create the confirmation dialog fo the deletion.
-	 *
 	 * @param items An array of controls used for the dialog content
 	 * @param parameters Contains the following attributes:
 	 * @param parameters.parentControl Parent control of the delete button if any
@@ -736,7 +803,6 @@ class TransactionHelper {
 
 	/**
 	 * Edits a document.
-	 *
 	 * @param oContext Context of the active document
 	 * @param oView Current view
 	 * @param appComponent The appComponent
@@ -791,7 +857,6 @@ class TransactionHelper {
 
 	/**
 	 * Cancel 'edit' mode of a document.
-	 *
 	 * @param oContext Context of the document to be canceled or deleted
 	 * @param [mInParameters] Optional, can contain the following attributes:
 	 * @param mInParameters.cancelButton Cancel Button of the discard popover (mandatory for now)
@@ -892,7 +957,6 @@ class TransactionHelper {
 
 	/**
 	 * Saves the document.
-	 *
 	 * @param context Context of the document to be saved
 	 * @param appComponent The appComponent
 	 * @param resourceModel The model to load text resources
@@ -900,6 +964,7 @@ class TransactionHelper {
 	 * @param bindingsForSideEffects The listBindings to be used for executing side effects on error
 	 * @param messageHandler The message handler extension
 	 * @param isNewObject True if we're trying to cancel a newly created object
+	 * @param skipConfirmationMsg
 	 * @returns Promise resolves with ???
 	 * @final
 	 */
@@ -910,7 +975,8 @@ class TransactionHelper {
 		executeSideEffectsOnError: boolean,
 		bindingsForSideEffects: ODataListBinding[],
 		messageHandler: MessageHandler,
-		isNewObject: boolean
+		isNewObject: boolean,
+		skipConfirmationMsg = false
 	): Promise<ODataV4Context> {
 		const sProgrammingModel = this.getProgrammingModel(context);
 		if (sProgrammingModel !== ProgrammingModel.Sticky && sProgrammingModel !== ProgrammingModel.Draft) {
@@ -919,19 +985,17 @@ class TransactionHelper {
 
 		try {
 			this.busyLock(appComponent);
+			const metaModel = context.getModel().getMetaModel();
+			const metaContext = metaModel.getMetaContext(context.getPath());
+			const entitySet = MetaModelConverter.getInvolvedDataModelObjects(metaContext).targetObject as EntitySet | NavigationProperty;
 			const oActiveDocument =
 				sProgrammingModel === ProgrammingModel.Draft
 					? await draft.activateDocument(context, appComponent, {}, messageHandler)
 					: await sticky.activateDocument(context, appComponent, messageHandler);
 
 			const messagesReceived = messageHandling.getMessages().concat(messageHandling.getMessages(true, true)); // get unbound and bound messages present in the model
-			if (!(messagesReceived.length === 1 && messagesReceived[0].getType() === coreLibrary.MessageType.Success)) {
+			if (!skipConfirmationMsg && !(messagesReceived.length === 1 && messagesReceived[0].getType() === MessageType.Success)) {
 				// show our object creation toast only if it is not coming from backend
-				const metaModel = context.getModel().getMetaModel();
-				const metaContext = metaModel.getMetaContext(context.getPath());
-				const entitySet = MetaModelConverter.getInvolvedDataModelObjects(metaContext).targetObject as
-					| EntitySet
-					| NavigationProperty;
 				MessageToast.show(
 					isNewObject
 						? resourceModel.getText("C_TRANSACTION_HELPER_OBJECT_CREATED", undefined, entitySet.name)
@@ -958,7 +1022,6 @@ class TransactionHelper {
 
 	/**
 	 * Calls a bound or unbound action.
-	 *
 	 * @param sActionName The name of the action to be called
 	 * @param [mParameters] Contains the following attributes:
 	 * @param [mParameters.parameterValues] A map of action parameter names and provided values
@@ -1118,7 +1181,6 @@ class TransactionHelper {
 
 	/**
 	 * Handles messages for action call.
-	 *
 	 * @param messageHandler The message handler extension
 	 * @param mParameters Parameters to be considered for the action.
 	 * @param mParameters.label
@@ -1126,6 +1188,7 @@ class TransactionHelper {
 	 * @param mParameters.controlId
 	 * @param mParameters.parentControl
 	 * @param sActionName The name of the action to be called
+	 * @param messageHandlingKey
 	 * @returns Promise after message dialog is opened if required.
 	 * @final
 	 */
@@ -1151,7 +1214,6 @@ class TransactionHelper {
 
 	/**
 	 * Handles validation errors for the 'Discard' action.
-	 *
 	 * @final
 	 */
 	handleValidationError(): void {
@@ -1163,7 +1225,6 @@ class TransactionHelper {
 
 	/**
 	 * Creates a new Popover. Factory method to make unit tests easier.
-	 *
 	 * @param settings Initial parameters for the popover
 	 * @returns A new Popover
 	 */
@@ -1173,7 +1234,6 @@ class TransactionHelper {
 
 	/**
 	 * Shows a popover to confirm discard if needed.
-	 *
 	 * @param cancelButton The control which will open the popover
 	 * @param isModified True if the object has been modified and a confirmation popover must be shown
 	 * @param resourceModel The model to load text resources
@@ -1235,6 +1295,7 @@ class TransactionHelper {
 			data?: Record<string, unknown>;
 			bIsCreateDialog?: boolean;
 			beforeCreateCallBack?: Function;
+			afterCreateCallBack?: (newDocumentContext: ODataV4Context) => Promise<void>;
 			createAtEnd?: boolean;
 			inactive?: boolean;
 			parentContext?: ODataV4Context;
@@ -1331,6 +1392,15 @@ class TransactionHelper {
 
 				const creationSuccess = await this.waitForCreateCompletion(newContext, parameters.keepTransientContextOnFailed === true);
 				if (creationSuccess) {
+					try {
+						await parameters.afterCreateCallBack?.(newContext);
+					} catch (error) {
+						messageHandler.showMessages();
+						newContext.delete();
+						Log.error("Error while creating/saving the new document", error as string);
+						throw FELibrary.Constants.CreationFailed;
+					}
+
 					transientListBinding.destroy();
 					createDialog.closeDialog();
 					resultPromiseKeeper.resolve(newContext);
@@ -1356,7 +1426,6 @@ class TransactionHelper {
 
 	/**
 	 * Waits for the creation of a context to be finished.
-	 *
 	 * @param newContext The context being created
 	 * @param keepTransientContextOnFailed
 	 * @returns True if the creation was successful
@@ -1396,7 +1465,6 @@ class TransactionHelper {
 
 	/**
 	 * Retrieves the name of the NewAction to be executed.
-	 *
 	 * @param oStartupParameters Startup parameters of the application
 	 * @param [oStartupParameters.preferredMode]
 	 * @param sCreateHash Hash to be checked for action type
@@ -1446,7 +1514,6 @@ class TransactionHelper {
 	 * 1. label of line-item annotation.
 	 * 2. label annotated in the action.
 	 * 3. "Create" as a constant from i18n.
-	 *
 	 * @param oMetaModel The MetaModel used to check for the NewAction parameter
 	 * @param sMetaPath The MetaPath
 	 * @param sNewAction Contains the name of the action to be executed