@sapui5/sap.fe.core 1.141.2 → 1.143.0

package/src/sap/fe/core/controllerextensions/CollaborativeDraft.ts

@@ -1,5 +1,11 @@
+import type { AnnotationTerm, PropertyAnnotationValue } from "@sap-ux/vocabularies-types";
+import type { Boolean as EdmBoolean } from "@sap-ux/vocabularies-types/Edm";
 import Log from "sap/base/Log";
+import type { BindingToolkitExpression } from "sap/fe/base/BindingToolkit";
+import { compileExpression, getExpressionFromAnnotation, isPathInModelExpression } from "sap/fe/base/BindingToolkit";
 import { defineUI5Class } from "sap/fe/base/ClassSupport";
+import { getInvolvedDataModelObjects } from "sap/fe/core/converters/MetaModelConverter";
+import { bindingContextPathVisitor } from "sap/fe/core/helpers/BindingHelper";
 import type Field from "sap/fe/macros/Field";
 import type FieldWrapper from "sap/fe/macros/controls/FieldWrapper";
 import type Tokenizer from "sap/m/Tokenizer";
@@ -10,30 +16,21 @@ import Element from "sap/ui/core/Element";
 import type MultiValueField from "sap/ui/mdc/MultiValueField";
 import type JSONModel from "sap/ui/model/json/JSONModel";
 import type Context from "sap/ui/model/odata/v4/Context";
+import type ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
 import type { FEView } from "../BaseController";
 import CommonUtils from "../CommonUtils";
-import type PageController from "../PageController";
 import type { CollaborativeDraftService } from "../services/collaborativeDraftServiceFactory";
 import { FieldEditMode } from "../templating/UIFormatters";
 import BaseControllerExtension from "./BaseControllerExtension";
-import { Activity, CollaborationFieldGroupPrefix, CollaborationUtils, addSelf, shareObject } from "./collaboration/CollaborationCommon";
-
-type DraftAdminUser = {
-	DraftEntityType: string;
-	DraftUUID: string;
-	UserID: string;
-};
+import { Activity, CollaborationFieldGroupPrefix, addSelf, shareObject } from "./collaboration/CollaborationCommon";
 
 /**
  * A controller extension to handle collaborative draft scenarios.
- * @ui5-experimental-since 1.141.0
  * @since 1.141.0
  * @public
  */
 @defineUI5Class("sap.fe.core.controllerextensions.CollaborativeDraft")
 export default class CollaborativeDraft extends BaseControllerExtension {
-	private base!: PageController;
-
 	private lastFocusId: string | undefined;
 
 	private lastFocusFieldGroups: string | undefined;
@@ -251,9 +248,9 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 		return internalModel?.getProperty("/collaborativeDraftRootPath");
 	}
 
-	private getDraftUserListPromise(): Promise<DraftAdminUser[]> | undefined {
+	private getDraftShareActionOperationAvailablePromise(): Promise<boolean> | undefined {
 		const internalModel = this.getView().getModel("internal");
-		return internalModel?.getProperty("/collaborativeDraftUserListPromise");
+		return internalModel?.getProperty("/collaborativeDraftShareActionOperationAvailablePromise");
 	}
 
 	private isInitialShare(): boolean {
@@ -273,30 +270,10 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 	 * @param draftRootContext The context for the draft root
 	 * @param groupId The groupId to request the list of users invited in the draft
 	 */
-	private setDraftRoot(draftRootContext: Context, groupId: string): void {
+	public setDraftRoot(draftRootContext: Context, groupId: string): void {
 		const internalModel = this.getView().getModel("internal") as JSONModel;
-		let userListPromise: Promise<DraftAdminUser[]>;
-		if (draftRootContext.getObject("DraftAdministrativeData/DraftAdministrativeUser") === undefined) {
-			userListPromise = new Promise((resolve) => {
-				const draftAdminUsers = draftRootContext
-					.getModel()
-					.bindList("DraftAdministrativeData/DraftAdministrativeUser", draftRootContext);
-				draftAdminUsers
-					.requestContexts()
-					.then((e: Context[]) => {
-						return resolve(e.map((c: Context) => c.getObject()));
-					})
-					.catch((e: Error) => {
-						Log.error("Error while loading the DraftAdministrativeUser " + e);
-					});
-			});
-		} else {
-			userListPromise = draftRootContext
-				.requestSideEffects(["DraftAdministrativeData/DraftAdministrativeUser"], groupId)
-				.then(async () => draftRootContext.requestObject("DraftAdministrativeData/DraftAdministrativeUser"));
-		}
-
-		internalModel?.setProperty("/collaborativeDraftUserListPromise", userListPromise);
+		const shareActionOperationAvailablePromise: Promise<boolean | undefined> = this.getShareActionOperationAvailable(draftRootContext);
+		internalModel?.setProperty("/collaborativeDraftShareActionOperationAvailablePromise", shareActionOperationAvailablePromise);
 		internalModel?.setProperty("/collaborativeDraftRootPath", draftRootContext.getPath());
 	}
 
@@ -306,7 +283,7 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 	 */
 	private cleanDraftRoot(): void {
 		const internalModel = this.getView().getModel("internal") as JSONModel;
-		internalModel?.setProperty("/collaborativeDraftUserListPromise", undefined);
+		internalModel?.setProperty("/collaborativeDraftShareActionOperationAvailablePromise", undefined);
 		internalModel?.setProperty("/collaborativeDraftRootPath", undefined);
 	}
 
@@ -322,7 +299,7 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 			const uiModel = this.getView().getModel("ui") as JSONModel;
 			if (isActiveEntity) {
 				// We're not in a draft -> disconnect if we were connected before
-				uiModel.setProperty("/hasCollaborationAuthorization", undefined);
+				uiModel.setProperty("/showCollaborationStrip", undefined);
 				this.disconnect();
 				return false;
 			}
@@ -346,16 +323,14 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 				);
 			}
 
-			const usersInvited = await this.getDraftUserListPromise();
 			if (uiModel.getProperty("/hasCollaborationAuthorization") !== undefined) {
 				return uiModel.getProperty("/hasCollaborationAuthorization"); // Already checked, all good
 			}
-			const me = CollaborationUtils.getMe(this.base.getAppComponent());
-			const hasMe = usersInvited?.some((singleUser) => singleUser.UserID === me.id) ?? false;
-			uiModel.setProperty("/hasCollaborationAuthorization", hasMe);
-			uiModel.setProperty("/showCollaborationStrip", !hasMe);
+			const isShareActionOperationAvailable = await this.getDraftShareActionOperationAvailablePromise();
+			uiModel.setProperty("/hasCollaborationAuthorization", isShareActionOperationAvailable);
+			uiModel.setProperty("/showCollaborationStrip", !isShareActionOperationAvailable);
 
-			if (hasMe) {
+			if (isShareActionOperationAvailable) {
 				this.connect(draftRootContext).catch((error) => {
 					Log.error("Error when connecting to the collaboration draft " + error);
 				});
@@ -363,13 +338,66 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 				// Disconnect the websocket but keep the properties in the internal model (so don't call this.disconnect)
 				this.getCollaborativeDraftService().disconnect(this.getView() as FEView);
 			}
-			return hasMe;
+			return !!isShareActionOperationAvailable;
 		} catch (err) {
 			Log.error("Error while activating the collaborative draft " + err);
 			return false;
 		}
 	}
 
+	getShareActionOperationAvailableBindingExpression(
+		draftRootContext: Context,
+		getODataCacheValue?: boolean
+	): BindingToolkitExpression<boolean> | boolean | undefined {
+		const metaModel = draftRootContext.getModel()?.getMetaModel();
+		const entitySet = metaModel?.getMetaPath(draftRootContext.getPath());
+		const metaContext = metaModel?.getMetaContext(draftRootContext.getPath());
+		const objectPath = metaContext && getInvolvedDataModelObjects(metaContext);
+		const shareActionName = metaModel?.getObject(`${entitySet}@com.sap.vocabularies.Common.v1.DraftRoot/ShareAction`);
+		const action = objectPath?.convertedTypes.actions.find((action) => {
+			return action.fullyQualifiedName.startsWith(shareActionName);
+		});
+		const bindingParameterFullName = action?.isBound ? action.parameters[0]?.fullyQualifiedName : undefined;
+		const bindingExpression = getExpressionFromAnnotation(
+			action?.annotations?.Core?.OperationAvailable as unknown as AnnotationTerm<PropertyAnnotationValue<EdmBoolean>>,
+			[],
+			undefined,
+			(path: string) => bindingContextPathVisitor(path, objectPath?.convertedTypes, bindingParameterFullName)
+		);
+
+		if (getODataCacheValue) {
+			if (isPathInModelExpression(bindingExpression)) {
+				const currentContextWithCache = draftRootContext.getObject();
+				if (currentContextWithCache) {
+					if (Object.keys(currentContextWithCache).includes(bindingExpression.path)) {
+						return currentContextWithCache[bindingExpression.path];
+					}
+				}
+				return undefined;
+			}
+		} else {
+			return bindingExpression;
+		}
+	}
+
+	async getShareActionOperationAvailable(draftRootContext: Context): Promise<boolean | undefined> {
+		const model = draftRootContext.getModel();
+		const contextPath = draftRootContext.getPath();
+		const bindingExpression = this.getShareActionOperationAvailableBindingExpression(draftRootContext);
+		const shareActionOperationAvailableExpression = compileExpression(bindingExpression);
+		if (shareActionOperationAvailableExpression === "undefined") {
+			return true;
+		}
+		if (isPathInModelExpression(bindingExpression)) {
+			return model
+				.bindContext(`${contextPath}`, undefined, { $$groupId: draftRootContext.getGroupId(), $select: [bindingExpression.path] })
+				.getBoundContext()
+				.requestProperty(bindingExpression.path);
+		} else {
+			return undefined;
+		}
+	}
+
 	/**
 	 * Adds the current user in the draft root context.
 	 * @param pageContext The page context (not necessarily a draft root)
@@ -398,12 +426,17 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 				return; // share was already called before, we don't need to call the Share action again
 			}
 
-			const sharePromise = this.isInitialShare()
-				? shareObject(draftRootContext, undefined, draftRootContext.getGroupId())
-				: addSelf(draftRootContext);
+			const performShare = async (): Promise<Context | void> =>
+				this.isInitialShare() ? shareObject(draftRootContext, undefined, draftRootContext.getGroupId()) : addSelf(draftRootContext);
+
 			this.setInitialShare(false); // Reset the initial share flag, so that we don't call the initial Share action again
 			this.setDraftRoot(draftRootContext, draftRootContext.getGroupId());
-			await sharePromise;
+
+			const cachedAvailability = this.getShareActionOperationAvailableBindingExpression(draftRootContext, true);
+			// Perform share unless availability is explicitly false
+			if (cachedAvailability === undefined || cachedAvailability === true) {
+				await performShare();
+			}
 		} catch (err) {
 			Log.error("Error while adding current user in the collaborative draft " + err);
 		}
@@ -415,7 +448,6 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 	 * @param propertyName The name of the property
 	 * @param isLocked True if the property is locked, false if it is unlocked
 	 * @public
-	 * @ui5-experimental-since 1.141.0
 	 * @since 1.141.0
 	 */
 	sendLockChange(context: Context, propertyName: string, isLocked: boolean): void {
@@ -425,11 +457,10 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 	/**
 	 * Sends a notification to other users that property values have been changed by the current user.
 	 *
-	 * This notification must be sent after the changes have been sent successfully to the back-end.
+	 * This notification must be sent after the changes have been sent successfully to the back end.
 	 * @param context The context for the properties
 	 * @param propertyNames The property name or the array of property names
 	 * @public
-	 * @ui5-experimental-since 1.141.0
 	 * @since 1.141.0
 	 */
 	sendPropertyValuesChange(context: Context, propertyNames: string | string[]): void {
@@ -442,23 +473,25 @@ export default class CollaborativeDraft extends BaseControllerExtension {
 	/**
 	 * Sends a notification to other users that new contexts have been created by the current user.
 	 *
-	 * This notification must be sent after the new contexts have been created successfully in the back-end.
-	 * @param contexts The array of newly created contexts
+	 * This notification must be sent after the new contexts have been created successfully in the back end.
+	 * @param contextsOrBinding The array of newly created contexts, or the binding where the contexts were created
 	 * @public
-	 * @ui5-experimental-since 1.141.0
 	 * @since 1.141.0
 	 */
-	sendContextsCreated(contexts: Context[]): void {
-		this.send({ action: Activity.Create, content: contexts.map((context) => context.getPath()) });
+	sendContextsCreated(contextsOrBinding: Context[] | ODataListBinding): void {
+		if (Array.isArray(contextsOrBinding)) {
+			this.send({ action: Activity.Create, content: contextsOrBinding.map((context) => context.getPath()) });
+		} else {
+			this.send({ action: Activity.Create, content: contextsOrBinding.getResolvedPath() ?? contextsOrBinding.getPath() });
+		}
 	}
 
 	/**
 	 * Sends a notification to other users that contexts have been deleted by the current user.
 	 *
-	 * This notification must be sent after the contexts have been deleted successfully in the back-end.
+	 * This notification must be sent after the contexts have been deleted successfully in the back end.
 	 * @param contexts The array of deleted contexts
 	 * @public
-	 * @ui5-experimental-since 1.141.0
 	 * @since 1.141.0
 	 */
 	sendContextsDeleted(contexts: Context[]): void {