@sap/open.fe 1.99.0 → 1.100.0

package/packages/sap.fe.core/src/sap/fe/core/actions/collaboration/ActivitySync.ts

@@ -0,0 +1,355 @@
+import Event from "sap/ui/base/Event";
+import Control from "sap/ui/core/Control";
+import SapPcpWebSocket from "sap/ui/core/ws/SapPcpWebSocket";
+import MessageBox from "sap/m/MessageBox";
+import { Activity, CollaborationUtils, Message, User, UserActivity } from "sap/fe/core/actions/collaboration/CollaborationCommon";
+import View from "sap/ui/core/mvc/View";
+import UriParameters from "sap/base/util/UriParameters";
+import ODataMetaModel from "sap/ui/model/odata/v4/ODataMetaModel";
+import Log from "sap/base/Log";
+import Context from "sap/ui/model/odata/v4/Context";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+
+const CONNECTED = "/collaboration/connected";
+const CONNECTION = "/collaboration/connection";
+const MYACTIVITY = "/collaboration/myActivity";
+const ACTIVEUSERS = "/collaboration/activeUsers";
+const ACTIVITIES = "/collaboration/activities";
+
+export const isConnected = function(control: Control): boolean {
+	return !!control.getModel("internal").getProperty(CONNECTED);
+};
+
+export const send = function(control: Control, action: Activity, content: string | string[] | Context | Context[] | undefined) {
+	if (isConnected(control)) {
+		const contentArray = Array.isArray(content) ? content : [content];
+		let clientContent: string = "";
+		contentArray.forEach(function(c) {
+			if (c) {
+				clientContent += clientContent ? "|" : "";
+				clientContent += typeof c === "string" ? c : c.getPath();
+			}
+		});
+
+		const internalModel = control.getModel("internal") as any;
+		const webSocket = internalModel.getProperty(CONNECTION) as SapPcpWebSocket;
+
+		if (action === Activity.LiveChange) {
+			// To avoid unnecessary traffic we keep track of live changes and send it only once
+			const myActivity = internalModel.getProperty(MYACTIVITY);
+			if (myActivity === clientContent) {
+				return;
+			} else {
+				internalModel.setProperty(MYACTIVITY, clientContent);
+			}
+		} else {
+			// user finished the activity
+			internalModel.setProperty(MYACTIVITY, null);
+		}
+
+		webSocket.send("", {
+			clientAction: action,
+			clientContent: clientContent
+		});
+
+		if (action === Activity.Activate || action === Activity.Discard) {
+			disconnect(control);
+		}
+	}
+};
+
+export const connect = async function(view: View) {
+	const internalModel: any = view.getModel("internal");
+	const me = CollaborationUtils.getMe(view);
+	if (internalModel.getProperty(CONNECTION)) {
+		// connection already established
+		return;
+	}
+
+	// Retrieving ME from shell service
+	if (!me) {
+		// no me = no shell = not sure what to do
+		return;
+	}
+
+	const activeUsers: any[] = [me];
+	internalModel.setProperty("/collaboration", { activeUsers: activeUsers, activities: {} });
+	const bindingContext = view.getBindingContext() as Context;
+	const webSocketBaseURL = bindingContext
+		.getModel()
+		.getMetaModel()
+		.getObject("/@com.sap.vocabularies.Common.v1.WebSocketBaseURL");
+
+	if (!webSocketBaseURL) {
+		return;
+	}
+
+	const sDraftUUID = await bindingContext.requestProperty("DraftAdministrativeData/DraftUUID");
+	if (!sDraftUUID) {
+		return;
+	}
+
+	const webSocket = establishWebSocketConnection(webSocketBaseURL, sDraftUUID, view);
+
+	webSocket.attachMessage(function(event: Event) {
+		const message: Message = event.getParameter("pcpFields");
+		messageReceive(message, view, webSocket);
+	});
+};
+
+export const disconnect = function(control: Control) {
+	const internalModel = control.getModel("internal") as any;
+	const webSocket = internalModel.getProperty(CONNECTION) as SapPcpWebSocket;
+	webSocket.close();
+	internalModel.setProperty(CONNECTION, null);
+};
+
+function establishWebSocketConnection(socketBaseURL: string, draftUUID: string, view: View) {
+	const internalModel: any = view.getModel("internal");
+	const hostLocation = window.location;
+	let socketURI;
+
+	// Support useBackendUrl for local testing
+	const useBackendUrl = UriParameters.fromQuery(window.location.search).get("useBackendUrl");
+	if (useBackendUrl) {
+		socketURI = useBackendUrl.replace("https", "wss");
+	} else {
+		socketURI = hostLocation.protocol === "https:" ? "wss:" : "ws:";
+		socketURI += "//" + hostLocation.host;
+	}
+
+	socketURI += (socketBaseURL.startsWith("/") ? "" : "/") + socketBaseURL + "?draft=" + draftUUID;
+
+	const webSocket = new SapPcpWebSocket(socketURI, ["v10.pcp.sap.com"]); // TODO: use enum
+	internalModel.setProperty(CONNECTION, webSocket);
+
+	webSocket.attachOpen(function() {
+		internalModel.setProperty(CONNECTED, true);
+	});
+
+	webSocket.attachError(function() {
+		Log.error("The connection to the websocket channel " + socketBaseURL + " could not be established");
+		internalModel.setProperty(CONNECTED, false);
+	});
+
+	webSocket.attachClose(function() {
+		internalModel.setProperty(CONNECTED, false);
+	});
+
+	return webSocket;
+}
+
+function messageReceive(message: Message, view: View, webSocket: any) {
+	const internalModel: any = view.getModel("internal");
+	let activeUsers: User[] = internalModel.getProperty(ACTIVEUSERS);
+	let activities: UserActivity[];
+	let activityKey: string;
+	const metaPath: string = message.clientContent && (view.getModel().getMetaModel() as ODataMetaModel).getMetaPath(message.clientContent);
+	message.userAction = message.userAction || message.clientAction;
+
+	const sender: User = {
+		id: message.userID,
+		name: message.userDescription,
+		initials: CollaborationUtils.formatInitials(message.userDescription),
+		color: CollaborationUtils.getUserColor(message.userID, activeUsers, [])
+	};
+
+	switch (message.userAction) {
+		case Activity.Join:
+		case Activity.JoinEcho:
+			if (activeUsers.findIndex(user => user.id === sender.id) === -1) {
+				activeUsers.push(sender);
+				internalModel.setProperty(ACTIVEUSERS, activeUsers);
+			}
+
+			if (message.userAction === Activity.Join) {
+				// we echo our existence to the newly entered user and also send the current activity if there is any
+				webSocket.send("", {
+					clientAction: Activity.JoinEcho,
+					clientContent: internalModel.getProperty(MYACTIVITY)
+				});
+				// TODO: echo current activity
+			}
+
+			if (message.userAction === Activity.JoinEcho) {
+				if (message.clientContent) {
+					// another user was already typing therefore I want to see his activity immediately. Calling me again as a live change
+					message.userAction = Activity.LiveChange;
+					messageReceive(message, view, webSocket);
+				}
+			}
+
+			break;
+		case Activity.Leave:
+			// Removing the active user. Not removing "me" if I had the screen open in another session
+			activeUsers = activeUsers.filter(user => user.id !== sender.id || user.me);
+			internalModel.setProperty(ACTIVEUSERS, activeUsers);
+			const allActivities = internalModel.getProperty(ACTIVITIES) || {};
+			const removeUserActivities = function(bag: any) {
+				if (Array.isArray(bag)) {
+					return bag.filter(activity => activity.id !== sender.id);
+				} else {
+					for (const p in bag) {
+						bag[p] = removeUserActivities(bag[p]);
+					}
+					return bag;
+				}
+			};
+			removeUserActivities(allActivities);
+			internalModel.setProperty(ACTIVITIES, allActivities);
+			break;
+
+		case Activity.Change:
+			let currentActivities: any[] = internalModel.getProperty(ACTIVITIES + metaPath) || [];
+			activityKey = getActivityKey(message.clientContent);
+			currentActivities = currentActivities.filter(activity => activity.key !== activityKey);
+			internalModel.setProperty(ACTIVITIES + metaPath, currentActivities);
+
+			update(view, message, metaPath, Activity.Change);
+			break;
+		case Activity.Create:
+			// For create we actually just need to refresh the table
+			update(view, message, metaPath, Activity.Create);
+			break;
+		case Activity.Delete:
+			// For now also refresh the page but in case of deletion we need to inform the user
+			update(view, message, metaPath, Activity.Delete);
+			break;
+		case Activity.Activate:
+			disconnect(view);
+			MessageBox.information(getText("C_COLLABORATIONDRAFT_ACTIVATE", sender.name));
+			navigate(message.clientContent, view);
+			break;
+		case Activity.Discard:
+			disconnect(view);
+			MessageBox.information(getText("C_COLLABORATIONDRAFT_DISCARD", sender.name));
+			navigate(message.clientContent, view);
+			break;
+		/*
+		// TODO: Action to be implemented
+		case Activity.Action:
+			// Just for test reasons show a toast - to be checked with UX
+			MessageToast.show("User " + sender.name + " has executed action " + metaPath.split("|")[0]);
+			//update(view, message, metaPath, Activity.Delete);
+			break;
+		 */
+		case Activity.LiveChange:
+			const activity: UserActivity = sender;
+			activity.key = getActivityKey(message.clientContent);
+
+			// stupid JSON model...
+			let initJSONModel: string = "";
+			const parts = metaPath.split("/");
+			for (let i = 1; i < parts.length - 1; i++) {
+				initJSONModel += "/" + parts[i];
+				if (!internalModel.getProperty(ACTIVITIES + initJSONModel)) {
+					internalModel.setProperty(ACTIVITIES + initJSONModel, {});
+				}
+			}
+
+			activities = internalModel.getProperty(ACTIVITIES + metaPath);
+			activities = activities ? activities.slice() : [];
+			activities.push(activity);
+			internalModel.setProperty(ACTIVITIES + metaPath, activities);
+			break;
+		case Activity.Undo:
+			// The user did a change but reverted it, therefore unblock the control
+			activities = internalModel.getProperty(ACTIVITIES + metaPath);
+			activityKey = getActivityKey(message.clientContent);
+			internalModel.setProperty(
+				ACTIVITIES + metaPath,
+				activities.filter(a => a.key !== activityKey)
+			);
+			break;
+	}
+}
+
+function update(view: View, message: Message, metaPath: string, action: Activity) {
+	const appComponent = CollaborationUtils.getAppComponent(view);
+	const metaModel = view.getModel().getMetaModel() as ODataMetaModel;
+	const currentPage = getCurrentPage(view);
+	const sideEffectsService = (appComponent as any).getSideEffectsService(); // TODO: add to appcomponent
+	const currentContext = currentPage.getBindingContext();
+	const currentPath = currentContext.getPath();
+	const currentMetaPath = metaModel.getMetaPath(currentPath);
+	let changedDocument = message.clientContent;
+
+	if (action === Activity.Delete) {
+		// check if user currently displays one deleted object
+		const deletedObjects = message.clientContent.split("|");
+		if (deletedObjects.findIndex(deletedObject => currentPath.startsWith(deletedObject)) > -1) {
+			// any other user deleted the object I'm currently looking at. Inform the user we will navigate to root now
+			MessageBox.information(getText("C_COLLABORATIONDRAFT_DELETE", message.userDescription), {
+				onClose: function() {
+					// TODO: Navigate to root? To be implemented
+					history.back();
+				}
+			});
+		}
+		// TODO: For now just take the first object to get the meta path and do a full refresh of the table
+		changedDocument = deletedObjects[0];
+	}
+
+	if (changedDocument.startsWith(currentPath)) {
+		// Execute SideEffects (TODO for Meet there should be one central method)
+		const activityPath = metaPath.replace(currentMetaPath, "").slice(1);
+		if (activityPath) {
+			// Request also the property itself
+			const sideEffects: any[] = [
+				{
+					$PropertyPath: activityPath
+				}
+			];
+			const entityType = sideEffectsService.getEntityTypeFromContext(currentContext);
+			const entityTypeSideEffects = sideEffectsService.getODataEntitySideEffects(entityType);
+			// Poor man solution without checking source targets, just for POC, this is throw-way coding only
+			const object: any = Object; // just to overcome TS issues, will be anyway replaced
+			const relevantSideEffects = object.fromEntries(
+				object
+					.entries(entityTypeSideEffects)
+					.filter((x: any[]) => x[1].SourceProperties?.findIndex((source: any) => source.value === activityPath) > -1)
+			);
+			for (const p in relevantSideEffects) {
+				relevantSideEffects[p].TargetProperties.forEach(function(targetProperty: any) {
+					sideEffects.push({
+						$PropertyPath: targetProperty
+					});
+				});
+			}
+			sideEffectsService.requestSideEffects(sideEffects, currentContext, "$auto");
+		}
+	}
+
+	// Simulate any change so the edit flow shows the draft indicator and sets the page to dirty
+	currentPage.getController().editFlow.updateDocument(currentContext, Promise.resolve());
+}
+
+function navigate(path: string, view: View) {
+	// TODO: routing.navigate doesn't consider semantic bookmarking
+	const currentPage = getCurrentPage(view);
+	const targetContext = view
+		.getModel()
+		.bindContext(path)
+		.getBoundContext();
+	currentPage.getController().routing.navigate(targetContext);
+}
+
+function getCurrentPage(view: View) {
+	const appComponent = CollaborationUtils.getAppComponent(view);
+	// TODO: isn't there an easier way to get the current page?
+	// TODO: What about FCL?
+	return (appComponent.getRootControl() as any)
+		.getContent()[0]
+		.getCurrentPage()
+		.getComponentInstance()
+		.getRootControl();
+}
+
+function getActivityKey(x: string): string {
+	return x.substring(x.lastIndexOf("(") + 1, x.lastIndexOf(")"));
+}
+
+function getText(textId: string, ...args: string[]): string {
+	const oResourceModel = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
+	return oResourceModel.getText(textId, args);
+}

package/packages/sap.fe.core/src/sap/fe/core/actions/collaboration/CollaborationCommon-dbg.js

@@ -0,0 +1,136 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
+ */
+sap.ui.define(["sap/ui/core/Component"], function (Component) {
+  "use strict";
+
+  var _exports = {};
+
+  var Role;
+
+  (function (Role) {
+    Role["Owner"] = "O";
+    Role["Edit"] = "E";
+  })(Role || (Role = {}));
+
+  _exports.Role = Role;
+  var Activity;
+
+  (function (Activity) {
+    Activity["Join"] = "JOIN";
+    Activity["JoinEcho"] = "JOINECHO";
+    Activity["Leave"] = "LEAVE";
+    Activity["Change"] = "CHANGE";
+    Activity["Create"] = "CREATE";
+    Activity["Delete"] = "DELETE";
+    Activity["Action"] = "ACTION";
+    Activity["LiveChange"] = "LIVECHANGE";
+    Activity["Activate"] = "ACTIVATE";
+    Activity["Discard"] = "DISCARD";
+    Activity["Undo"] = "UNDO";
+  })(Activity || (Activity = {}));
+
+  _exports.Activity = Activity;
+
+  function formatInitials(fullName) {
+    // remove titles - those are the ones from S/4 to be checked if there are others
+    var academicTitles = ["Dr.", "Prof.", "Prof. Dr.", "B.A.", "MBA", "Ph.D."];
+    academicTitles.forEach(function (academicTitle) {
+      fullName = fullName.replace(academicTitle, "");
+    });
+    var initials;
+    var parts = fullName.trimStart().split(" ");
+
+    if (parts.length > 1) {
+      var _parts$shift, _parts$pop;
+
+      initials = ((parts === null || parts === void 0 ? void 0 : (_parts$shift = parts.shift()) === null || _parts$shift === void 0 ? void 0 : _parts$shift.charAt(0)) || "") + ((_parts$pop = parts.pop()) === null || _parts$pop === void 0 ? void 0 : _parts$pop.charAt(0));
+    } else {
+      initials = fullName.substring(0, 2);
+    }
+
+    return initials.toUpperCase();
+  }
+
+  function getUserColor(UserID, activeUsers, invitedUsers) {
+    // search if user is known
+    var user = activeUsers.find(function (u) {
+      return u.id === UserID;
+    });
+
+    if (user) {
+      return user.color;
+    } else {
+      var _loop = function (i) {
+        if (activeUsers.findIndex(function (u) {
+          return u.color === i;
+        }) === -1 && invitedUsers.findIndex(function (u) {
+          return u.color === i;
+        }) === -1) {
+          return {
+            v: i
+          };
+        }
+      };
+
+      // search for next free color
+      for (var i = 1; i <= 10; i++) {
+        var _ret = _loop(i);
+
+        if (typeof _ret === "object") return _ret.v;
+      } // this seems to be a popular object :) for now just return 10 for all.
+      // for invited we should start from 1 again so the colors are different
+
+
+      return 10;
+    }
+  } // copied from CommonUtils. Due to a cycle dependency I can't use CommonUtils here.
+  // That's to be fixed. the discard popover thingy shouldn't be in the common utils at all
+
+
+  function getAppComponent(oControl) {
+    if (oControl.isA("sap.fe.core.AppComponent")) {
+      return oControl;
+    }
+
+    var oOwner = Component.getOwnerComponentFor(oControl);
+
+    if (!oOwner) {
+      return oControl;
+    } else {
+      return getAppComponent(oOwner);
+    }
+  }
+
+  function getMe(view) {
+    var shellServiceHelper = getAppComponent(view).getShellServices();
+
+    if (!shellServiceHelper || !shellServiceHelper.hasUShell()) {
+      throw "No Shell... No User";
+    }
+
+    var me = {
+      initials: shellServiceHelper.getUser().getInitials(),
+      id: shellServiceHelper.getUser().getId(),
+      name: shellServiceHelper.getUser().getFullName(),
+      color: 6,
+      //  same color as FLP...
+      role: Role.Owner,
+      me: true
+    };
+    me.name += " (You)"; // TODO resource bundle
+
+    return me;
+  }
+
+  var CollaborationUtils = {
+    formatInitials: formatInitials,
+    getUserColor: getUserColor,
+    getMe: getMe,
+    getAppComponent: getAppComponent
+  };
+  _exports.CollaborationUtils = CollaborationUtils;
+  return _exports;
+}, false);
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,{"version":3,"sources":["CollaborationCommon.ts"],"names":["Role","Activity","formatInitials","fullName","academicTitles","forEach","academicTitle","replace","initials","parts","trimStart","split","length","shift","charAt","pop","substring","toUpperCase","getUserColor","UserID","activeUsers","invitedUsers","user","find","u","id","color","i","findIndex","getAppComponent","oControl","isA","oOwner","Component","getOwnerComponentFor","getMe","view","shellServiceHelper","getShellServices","hasUShell","me","getUser","getInitials","getId","name","getFullName","role","Owner","CollaborationUtils"],"mappings":";AAAA;AACA;AACA;;;;;;MAgBYA,I;;aAAAA,I;AAAAA,IAAAA,I;AAAAA,IAAAA,I;KAAAA,I,KAAAA,I;;;MAKAC,Q;;aAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;AAAAA,IAAAA,Q;KAAAA,Q,KAAAA,Q;;;;AAsBZ,WAASC,cAAT,CAAwBC,QAAxB,EAAkD;AACjD;AACA,QAAMC,cAAc,GAAG,CAAC,KAAD,EAAQ,OAAR,EAAiB,WAAjB,EAA8B,MAA9B,EAAsC,KAAtC,EAA6C,OAA7C,CAAvB;AACAA,IAAAA,cAAc,CAACC,OAAf,CAAuB,UAASC,aAAT,EAAwB;AAC9CH,MAAAA,QAAQ,GAAGA,QAAQ,CAACI,OAAT,CAAiBD,aAAjB,EAAgC,EAAhC,CAAX;AACA,KAFD;AAIA,QAAIE,QAAJ;AACA,QAAMC,KAAK,GAAGN,QAAQ,CAACO,SAAT,GAAqBC,KAArB,CAA2B,GAA3B,CAAd;;AAEA,QAAIF,KAAK,CAACG,MAAN,GAAe,CAAnB,EAAsB;AAAA;;AACrBJ,MAAAA,QAAQ,GAAG,CAAC,CAAAC,KAAK,SAAL,IAAAA,KAAK,WAAL,4BAAAA,KAAK,CAAEI,KAAP,gEAAgBC,MAAhB,CAAuB,CAAvB,MAA6B,EAA9B,mBAAoCL,KAAK,CAACM,GAAN,EAApC,+CAAoC,WAAaD,MAAb,CAAoB,CAApB,CAApC,CAAX;AACA,KAFD,MAEO;AACNN,MAAAA,QAAQ,GAAGL,QAAQ,CAACa,SAAT,CAAmB,CAAnB,EAAsB,CAAtB,CAAX;AACA;;AAED,WAAOR,QAAQ,CAACS,WAAT,EAAP;AACA;;AAED,WAASC,YAAT,CAAsBC,MAAtB,EAAsCC,WAAtC,EAA2DC,YAA3D,EAAiF;AAChF;AACA,QAAMC,IAAI,GAAGF,WAAW,CAACG,IAAZ,CAAiB,UAAAC,CAAC;AAAA,aAAIA,CAAC,CAACC,EAAF,KAASN,MAAb;AAAA,KAAlB,CAAb;;AACA,QAAIG,IAAJ,EAAU;AACT,aAAOA,IAAI,CAACI,KAAZ;AACA,KAFD,MAEO;AAAA,4BAEGC,CAFH;AAGL,YAAIP,WAAW,CAACQ,SAAZ,CAAsB,UAAAJ,CAAC;AAAA,iBAAIA,CAAC,CAACE,KAAF,KAAYC,CAAhB;AAAA,SAAvB,MAA8C,CAAC,CAA/C,IAAoDN,YAAY,CAACO,SAAb,CAAuB,UAAAJ,CAAC;AAAA,iBAAIA,CAAC,CAACE,KAAF,KAAYC,CAAhB;AAAA,SAAxB,MAA+C,CAAC,CAAxG,EAA2G;AAC1G;AAAA,eAAOA;AAAP;AACA;AALI;;AACN;AACA,WAAK,IAAIA,CAAC,GAAG,CAAb,EAAgBA,CAAC,IAAI,EAArB,EAAyBA,CAAC,EAA1B,EAA8B;AAAA,yBAArBA,CAAqB;;AAAA;AAI7B,OANK,CAON;AACA;;;AACA,aAAO,EAAP;AACA;AACD,G,CAED;AACA;;;AACA,WAASE,eAAT,CAAyBC,QAAzB,EAAsD;AACrD,QAAIA,QAAQ,CAACC,GAAT,CAAa,0BAAb,CAAJ,EAA8C;AAC7C,aAAOD,QAAP;AACA;;AACD,QAAME,MAAM,GAAGC,SAAS,CAACC,oBAAV,CAA+BJ,QAA/B,CAAf;;AACA,QAAI,CAACE,MAAL,EAAa;AACZ,aAAOF,QAAP;AACA,KAFD,MAEO;AACN,aAAOD,eAAe,CAACG,MAAD,CAAtB;AACA;AACD;;AAED,WAASG,KAAT,CAAeC,IAAf,EAAiC;AAChC,QAAMC,kBAAkB,GAAGR,eAAe,CAACO,IAAD,CAAf,CAAsBE,gBAAtB,EAA3B;;AACA,QAAI,CAACD,kBAAD,IAAuB,CAACA,kBAAkB,CAACE,SAAnB,EAA5B,EAA4D;AAC3D,YAAM,qBAAN;AACA;;AACD,QAAMC,EAAQ,GAAG;AAChBhC,MAAAA,QAAQ,EAAE6B,kBAAkB,CAACI,OAAnB,GAA6BC,WAA7B,EADM;AAEhBjB,MAAAA,EAAE,EAAEY,kBAAkB,CAACI,OAAnB,GAA6BE,KAA7B,EAFY;AAGhBC,MAAAA,IAAI,EAAEP,kBAAkB,CAACI,OAAnB,GAA6BI,WAA7B,EAHU;AAIhBnB,MAAAA,KAAK,EAAE,CAJS;AAIN;AACVoB,MAAAA,IAAI,EAAE9C,IAAI,CAAC+C,KALK;AAMhBP,MAAAA,EAAE,EAAE;AANY,KAAjB;AAQAA,IAAAA,EAAE,CAACI,IAAH,IAAW,QAAX,CAbgC,CAaX;;AACrB,WAAOJ,EAAP;AACA;;AAEM,MAAMQ,kBAAkB,GAAG;AACjC9C,IAAAA,cAAc,EAAEA,cADiB;AAEjCgB,IAAAA,YAAY,EAAEA,YAFmB;AAGjCiB,IAAAA,KAAK,EAAEA,KAH0B;AAIjCN,IAAAA,eAAe,EAAEA;AAJgB,GAA3B","sourceRoot":".","sourcesContent":["import View from \"sap/ui/core/mvc/View\";\nimport Component from \"sap/ui/core/Component\";\nimport AppComponent from \"sap/fe/core/AppComponent\";\n\nexport type User = {\n\tid: string;\n\tinitials?: string;\n\tname: string;\n\trole?: Role;\n\tcolor?: number;\n\ttransient?: boolean;\n\tme?: boolean;\n};\n\nexport type UserActivity = User & {\n\tkey?: string;\n};\n\nexport enum Role {\n\tOwner = \"O\",\n\tEdit = \"E\"\n}\n\nexport enum Activity {\n\tJoin = \"JOIN\",\n\tJoinEcho = \"JOINECHO\",\n\tLeave = \"LEAVE\",\n\tChange = \"CHANGE\",\n\tCreate = \"CREATE\",\n\tDelete = \"DELETE\",\n\tAction = \"ACTION\",\n\tLiveChange = \"LIVECHANGE\",\n\tActivate = \"ACTIVATE\",\n\tDiscard = \"DISCARD\",\n\tUndo = \"UNDO\"\n}\n\nexport type Message = {\n\tuserDescription: string;\n\tuserID: string;\n\tuserAction: string;\n\tclientAction: string;\n\tclientContent: string;\n};\n\nfunction formatInitials(fullName: string): string {\n\t// remove titles - those are the ones from S/4 to be checked if there are others\n\tconst academicTitles = [\"Dr.\", \"Prof.\", \"Prof. Dr.\", \"B.A.\", \"MBA\", \"Ph.D.\"];\n\tacademicTitles.forEach(function(academicTitle) {\n\t\tfullName = fullName.replace(academicTitle, \"\");\n\t});\n\n\tlet initials: string;\n\tconst parts = fullName.trimStart().split(\" \");\n\n\tif (parts.length > 1) {\n\t\tinitials = (parts?.shift()?.charAt(0) || \"\") + parts.pop()?.charAt(0);\n\t} else {\n\t\tinitials = fullName.substring(0, 2);\n\t}\n\n\treturn initials.toUpperCase();\n}\n\nfunction getUserColor(UserID: string, activeUsers: User[], invitedUsers: User[]) {\n\t// search if user is known\n\tconst user = activeUsers.find(u => u.id === UserID);\n\tif (user) {\n\t\treturn user.color;\n\t} else {\n\t\t// search for next free color\n\t\tfor (let i = 1; i <= 10; i++) {\n\t\t\tif (activeUsers.findIndex(u => u.color === i) === -1 && invitedUsers.findIndex(u => u.color === i) === -1) {\n\t\t\t\treturn i;\n\t\t\t}\n\t\t}\n\t\t// this seems to be a popular object :) for now just return 10 for all.\n\t\t// for invited we should start from 1 again so the colors are different\n\t\treturn 10;\n\t}\n}\n\n// copied from CommonUtils. Due to a cycle dependency I can't use CommonUtils here.\n// That's to be fixed. the discard popover thingy shouldn't be in the common utils at all\nfunction getAppComponent(oControl: any): AppComponent {\n\tif (oControl.isA(\"sap.fe.core.AppComponent\")) {\n\t\treturn oControl;\n\t}\n\tconst oOwner = Component.getOwnerComponentFor(oControl);\n\tif (!oOwner) {\n\t\treturn oControl;\n\t} else {\n\t\treturn getAppComponent(oOwner);\n\t}\n}\n\nfunction getMe(view: View): User {\n\tconst shellServiceHelper = getAppComponent(view).getShellServices();\n\tif (!shellServiceHelper || !shellServiceHelper.hasUShell()) {\n\t\tthrow \"No Shell... No User\";\n\t}\n\tconst me: User = {\n\t\tinitials: shellServiceHelper.getUser().getInitials(),\n\t\tid: shellServiceHelper.getUser().getId(),\n\t\tname: shellServiceHelper.getUser().getFullName(),\n\t\tcolor: 6, //  same color as FLP...\n\t\trole: Role.Owner,\n\t\tme: true\n\t};\n\tme.name += \" (You)\"; // TODO resource bundle\n\treturn me;\n}\n\nexport const CollaborationUtils = {\n\tformatInitials: formatInitials,\n\tgetUserColor: getUserColor,\n\tgetMe: getMe,\n\tgetAppComponent: getAppComponent\n};\n"]}

package/packages/sap.fe.core/src/sap/fe/core/actions/collaboration/CollaborationCommon.js

@@ -0,0 +1,5 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+ *      (c) Copyright 2009-2021 SAP SE. All rights reserved
+ */
+sap.ui.define(["sap/ui/core/Component"],function(C){"use strict";var _={};var R;(function(R){R["Owner"]="O";R["Edit"]="E";})(R||(R={}));_.Role=R;var A;(function(A){A["Join"]="JOIN";A["JoinEcho"]="JOINECHO";A["Leave"]="LEAVE";A["Change"]="CHANGE";A["Create"]="CREATE";A["Delete"]="DELETE";A["Action"]="ACTION";A["LiveChange"]="LIVECHANGE";A["Activate"]="ACTIVATE";A["Discard"]="DISCARD";A["Undo"]="UNDO";})(A||(A={}));_.Activity=A;function f(d){var e=["Dr.","Prof.","Prof. Dr.","B.A.","MBA","Ph.D."];e.forEach(function(k){d=d.replace(k,"");});var i;var p=d.trimStart().split(" ");if(p.length>1){var h,j;i=((p===null||p===void 0?void 0:(h=p.shift())===null||h===void 0?void 0:h.charAt(0))||"")+((j=p.pop())===null||j===void 0?void 0:j.charAt(0));}else{i=d.substring(0,2);}return i.toUpperCase();}function g(U,d,e){var h=d.find(function(u){return u.id===U;});if(h){return h.color;}else{var j=function(i){if(d.findIndex(function(u){return u.color===i;})===-1&&e.findIndex(function(u){return u.color===i;})===-1){return{v:i};}};for(var i=1;i<=10;i++){var k=j(i);if(typeof k==="object")return k.v;}return 10;}}function a(o){if(o.isA("sap.fe.core.AppComponent")){return o;}var O=C.getOwnerComponentFor(o);if(!O){return o;}else{return a(O);}}function b(v){var s=a(v).getShellServices();if(!s||!s.hasUShell()){throw"No Shell... No User";}var m={initials:s.getUser().getInitials(),id:s.getUser().getId(),name:s.getUser().getFullName(),color:6,role:R.Owner,me:true};m.name+=" (You)";return m;}var c={formatInitials:f,getUserColor:g,getMe:b,getAppComponent:a};_.CollaborationUtils=c;return _;},false);

package/packages/sap.fe.core/src/sap/fe/core/actions/collaboration/CollaborationCommon.ts

@@ -0,0 +1,119 @@
+import View from "sap/ui/core/mvc/View";
+import Component from "sap/ui/core/Component";
+import AppComponent from "sap/fe/core/AppComponent";
+
+export type User = {
+	id: string;
+	initials?: string;
+	name: string;
+	role?: Role;
+	color?: number;
+	transient?: boolean;
+	me?: boolean;
+};
+
+export type UserActivity = User & {
+	key?: string;
+};
+
+export enum Role {
+	Owner = "O",
+	Edit = "E"
+}
+
+export enum Activity {
+	Join = "JOIN",
+	JoinEcho = "JOINECHO",
+	Leave = "LEAVE",
+	Change = "CHANGE",
+	Create = "CREATE",
+	Delete = "DELETE",
+	Action = "ACTION",
+	LiveChange = "LIVECHANGE",
+	Activate = "ACTIVATE",
+	Discard = "DISCARD",
+	Undo = "UNDO"
+}
+
+export type Message = {
+	userDescription: string;
+	userID: string;
+	userAction: string;
+	clientAction: string;
+	clientContent: string;
+};
+
+function formatInitials(fullName: string): string {
+	// remove titles - those are the ones from S/4 to be checked if there are others
+	const academicTitles = ["Dr.", "Prof.", "Prof. Dr.", "B.A.", "MBA", "Ph.D."];
+	academicTitles.forEach(function(academicTitle) {
+		fullName = fullName.replace(academicTitle, "");
+	});
+
+	let initials: string;
+	const parts = fullName.trimStart().split(" ");
+
+	if (parts.length > 1) {
+		initials = (parts?.shift()?.charAt(0) || "") + parts.pop()?.charAt(0);
+	} else {
+		initials = fullName.substring(0, 2);
+	}
+
+	return initials.toUpperCase();
+}
+
+function getUserColor(UserID: string, activeUsers: User[], invitedUsers: User[]) {
+	// search if user is known
+	const user = activeUsers.find(u => u.id === UserID);
+	if (user) {
+		return user.color;
+	} else {
+		// search for next free color
+		for (let i = 1; i <= 10; i++) {
+			if (activeUsers.findIndex(u => u.color === i) === -1 && invitedUsers.findIndex(u => u.color === i) === -1) {
+				return i;
+			}
+		}
+		// this seems to be a popular object :) for now just return 10 for all.
+		// for invited we should start from 1 again so the colors are different
+		return 10;
+	}
+}
+
+// copied from CommonUtils. Due to a cycle dependency I can't use CommonUtils here.
+// That's to be fixed. the discard popover thingy shouldn't be in the common utils at all
+function getAppComponent(oControl: any): AppComponent {
+	if (oControl.isA("sap.fe.core.AppComponent")) {
+		return oControl;
+	}
+	const oOwner = Component.getOwnerComponentFor(oControl);
+	if (!oOwner) {
+		return oControl;
+	} else {
+		return getAppComponent(oOwner);
+	}
+}
+
+function getMe(view: View): User {
+	const shellServiceHelper = getAppComponent(view).getShellServices();
+	if (!shellServiceHelper || !shellServiceHelper.hasUShell()) {
+		throw "No Shell... No User";
+	}
+	const me: User = {
+		initials: shellServiceHelper.getUser().getInitials(),
+		id: shellServiceHelper.getUser().getId(),
+		name: shellServiceHelper.getUser().getFullName(),
+		color: 6, //  same color as FLP...
+		role: Role.Owner,
+		me: true
+	};
+	me.name += " (You)"; // TODO resource bundle
+	return me;
+}
+
+export const CollaborationUtils = {
+	formatInitials: formatInitials,
+	getUserColor: getUserColor,
+	getMe: getMe,
+	getAppComponent: getAppComponent
+};