@openui5/sap.ui.core 1.134.0 → 1.135.0

package/src/sap/ui/core/_CommandPool.js

@@ -0,0 +1,80 @@
+/*
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/core/Lib"
+], function(Library) {
+	"use strict";
+
+	// Standarized SAP commands with their respective shortcuts and descriptions.
+	const mSapCommands = {
+		"sap:share": {
+			shortcut: "Ctrl+Shift+S",
+			description: "{{SAP_SHARE}}"
+		},
+		"sap:create": {
+			shortcut: "Ctrl+Enter",
+			description: "{{SAP_CREATE}}"
+		},
+		"sap:edit": {
+			shortcut: "Ctrl+E",
+			description: "{{SAP_EDIT}}"
+		},
+		"sap:save": {
+			shortcut: "Ctrl+S",
+			description: "{{SAP_SAVE}}"
+		},
+		"sap:delete": {
+			shortcut: "Ctrl+D",
+			description: "{{SAP_DELETE}}"
+		}
+	};
+
+	const _rManifestTemplate = /\{\{([^\}\}]+)\}\}/g;
+
+	/**
+	 * Module for resolving command references in the manifest.
+	 *
+	 * The resolve function processes command references and resolves them with their predefined shortcuts
+	 * if available in the SAP standard commands.
+	 *
+	 * @private
+	 */
+	return {
+		/**
+		 * Resolves command references in the given manifest object.
+		 *
+		 * @param  {sap.ui.core.Manifest} oManifest The manifest object containing command configurations.
+		 * @throws {TypeError} Throws and error if an invalid command reference is encountered.
+		 */
+		resolve(oManifest) {
+			const mCommands = oManifest.getEntry("/sap.ui5/commands") || {};
+
+			Object.keys(mCommands).forEach((sCommand) => {
+				const oObject = mCommands[sCommand];
+
+				if (oObject.ref) {
+					if (oObject.shortcut) {
+						throw new TypeError(`If a command reference 'ref' is specified in the 'sap.ui5/commands' section of the manifest, the 'shortcut' property must be omitted.`);
+					}
+
+					const sValue = oObject.ref;
+					const oSapCommand = mSapCommands[sValue];
+					if (!oSapCommand) {
+						throw new TypeError(`The given reference '${sValue}' in the 'sap.ui5/commands' section of the manifest is not valid.`);
+					}
+					oObject.ref = undefined; // resolve with shortcut
+					oObject.shortcut = oSapCommand.shortcut;
+
+					if (!oObject.description) { // Description from manifest always wins
+						const oResourceBundle = Library.getResourceBundleFor("sap.ui.core");
+						oObject.description = oSapCommand.description.replace(_rManifestTemplate, (sMatch, sI18nKey) => oResourceBundle.getText(sI18nKey));
+					}
+				}
+			});
+		}
+	};
+});

package/src/sap/ui/core/boot/KeyboardInteractionEndpoint.js

@@ -0,0 +1,124 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+sap.ui.define([
+	"sap/base/Log"
+], function(Log) {
+	"use strict";
+
+	let pShortcutInfo;
+
+	function loadKeyboardInteractionInfo() {
+		pShortcutInfo ??= new Promise((resolve, reject) => {
+			sap.ui.require(["sap/ui/core/interaction/KeyboardInteractionDisplay"], resolve, reject);
+		});
+
+		return pShortcutInfo;
+	}
+
+	const mRegistry = new Map(); // Store {id -> { origin, port }}
+
+	const mActions = {
+		/**
+		 * Handles the request for a message port and either returns an existing port or creates a new one.
+		 *
+		 * @param  {MessageEvent} oEvent The message event triggered when a message is received.
+		 */
+		"sap.ui.interaction.RequestMessagePort": (oEvent) => {
+			const oData = oEvent.data;
+			const sId = oData?.id;
+
+			if (!sId) {
+				return;
+			}
+
+			const oKnownRequestor = mRegistry.get(sId);
+			if (oKnownRequestor) {
+				oEvent.source.postMessage({ service: "sap.ui.interaction.MessagePortReady"}, oEvent.origin, [oKnownRequestor.port]);
+			} else {
+				const oChannel = new MessageChannel();
+
+				// register id with origin and port
+				mRegistry.set(sId, {
+					origin: oEvent.origin,
+					port: oChannel.port2
+				});
+
+				// Listen for messages on port1
+				oChannel.port1.onmessage = (oEvent) => {
+					const oData = oEvent.data;
+					const sService = oData?.service;
+					const fnAction = mActions[sService];
+
+					if (fnAction) {
+						fnAction(oEvent, oChannel.port1);
+					}
+				};
+
+				// Send port2 to requestor
+				oEvent.source.postMessage({ service: "sap.ui.interaction.MessagePortReady"}, oEvent.origin, [oChannel.port2]);
+			}
+
+		},
+
+		/**
+		 * Starts the display of keyboard interaction information
+		 *
+		 * @param  {MessageEvent} _ Unused event parameter
+		 * @param  {MessagePort} oPort The message port to communicate with.
+		 */
+		"sap.ui.interaction.StartDisplay": async (_, oPort) => {
+			const KeyboardInteractionInfo = await loadKeyboardInteractionInfo();
+			await KeyboardInteractionInfo.activate(oPort);
+		},
+		/**
+		 * Stops the display of keyboard interaction information.
+		 *
+		 * @param  {MessageEvent} _ Unused event parameter.
+		 */
+		"sap.ui.interaction.StopDisplay": async (_) => {
+			const KeyboardInteractionInfo = await loadKeyboardInteractionInfo();
+			KeyboardInteractionInfo.deactivate();
+		}
+	};
+
+	/**
+	 * Listens for incoming post messages and starts the display of keyboard interaction information
+	 * based on the service name received in the message.
+	 *
+	 * @param {MessageEvent} oEvent the message event triggered when a message is received.
+	 */
+	window.addEventListener("message", (oEvent) => {
+		const sService = oEvent?.data?.service;
+		const fnAction = mActions[sService];
+
+		// only process messages with a known name
+		if (fnAction) {
+			const sBootstrapOrigin = new URL(sap.ui.require.toUrl(""), document.baseURI)?.origin;
+
+			// TODO: This implementation currently only supports the FE scenario, see FIORITECHP1-24625
+			if (oEvent.origin !== document.location.origin &&
+				oEvent.origin !== sBootstrapOrigin) {
+
+				Log.error(`Received message from an unauthorized origin: ${oEvent.origin}.`);
+				return;
+			}
+
+			fnAction?.(oEvent);
+		}
+	});
+
+	/**
+	 * Initializes the module that sets up the listener for incoming postmessage events.
+	 * This listener handles the activation and display of keyboard interaction information.
+	 *
+	 * @private
+	 */
+	return {
+		run: function() {
+			return Promise.resolve();
+		}
+	};
+});

package/src/sap/ui/core/date/UI5Date.js

@@ -66,7 +66,7 @@ sap.ui.define([
 	 * @hideconstructor
 	 * @public
 	 * @since 1.111.0
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 */
 	function UI5Date(vDateParts, sTimezoneID) {
 		var oDateInstance = UI5Date._createDateInstance(vDateParts);

package/src/sap/ui/core/delegate/ItemNavigation.js

@@ -82,7 +82,7 @@ sap.ui.define([
 	 * @param {Element[]} aItemDomRefs Array of DOM references representing the items for the navigation
 	 * @param {boolean} [bNotInTabChain=false] Whether the selected element should be in the tab chain or not
 	 *
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @alias sap.ui.core.delegate.ItemNavigation
 	 * @public
 	 */

package/src/sap/ui/core/delegate/ScrollEnablement.js

@@ -61,7 +61,7 @@ sap.ui.define([
 		 *
 		 * @protected
 		 * @alias sap.ui.core.delegate.ScrollEnablement
-		 * @version 1.134.0
+		 * @version 1.135.0
 		 * @author SAP SE
 		 */
 		var ScrollEnablement = BaseObject.extend("sap.ui.core.delegate.ScrollEnablement", /** @lends sap.ui.core.delegate.ScrollEnablement.prototype */ {

package/src/sap/ui/core/dnd/DragDropBase.js

@@ -37,7 +37,7 @@ sap.ui.define([
 	 *
 	 * @extends sap.ui.core.Element
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 *
 	 * @public
 	 * @since 1.52

package/src/sap/ui/core/dnd/DragDropInfo.js

@@ -22,7 +22,7 @@ sap.ui.define(["sap/ui/core/Element", "./DragInfo", "./DropInfo", "sap/base/Log"
 	 * @extends sap.ui.core.dnd.DropInfo
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 *
 	 * @public
 	 * @since 1.52

package/src/sap/ui/core/dnd/DragInfo.js

@@ -22,7 +22,7 @@ sap.ui.define(["./DragDropBase"],
 	 * @extends sap.ui.core.dnd.DragDropBase
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 *
 	 * @public
 	 * @since 1.56

package/src/sap/ui/core/dnd/DropInfo.js

@@ -21,7 +21,7 @@ sap.ui.define(["./DragDropBase"],
 	 * @extends sap.ui.core.dnd.DragDropBase
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 *
 	 * @public
 	 * @since 1.56

package/src/sap/ui/core/fieldhelp/FieldHelp.js

@@ -22,6 +22,27 @@ sap.ui.define([
 	let oFieldHelp;
 	const sURNPrefix = "urn:sap-com:documentation:key?=";
 
+	/**
+	 * Returns whether the two given sets are identical.
+	 *
+	 * @param {Set<any>} oSet0 The first set
+	 * @param {Set<any>} oSet1 The second set
+	 * @returns {boolean} Whether the given sets are identical
+	 */
+	function isSetIdentical(oSet0, oSet1) {
+		if (oSet0.size !== oSet1.size) {
+			return false;
+		}
+
+		for (const oItem of oSet0) {
+			if (!oSet1.has(oItem)) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
 	/**
 	 * Replacement for <code>ManagedObject.prototype.updateFieldHelp</code> to update the field help information
 	 * for the given control property name of <code>this</code> control instance, if the corresponding binding has been
@@ -92,20 +113,20 @@ sap.ui.define([
 		#fnUpdateHotspotsCallback = null;
 
 		/**
-		 * Maps a control ID to an object mapping a control property to a back-end help key URNs.
+		 * Maps a control ID to an object mapping a control property to an array of back-end help key URNs.
 		 *
 		 * @default {}
 		 * @type {Object<string, Object<string, string[]>>}
 		 */
-		#mDocuRefControlToFieldHelp = {};
+		mDocuRefControlToFieldHelp = {};
 
 		/**
-		 * A Promise that resolves when all hotspot updates are done.
+		 * A boolean that is <code>true</code> as long as the hotspots are updated.
 		 *
-		 * @default null
-		 * @type {Promise}
+		 * @default false
+		 * @type {boolean}
 		 */
-		#oUpdateHotspotsPromise = null;
+		#bUpdateHotspotsPending = false;
 
 		/**
 		 * @typedef {Map<string,Map<string,string>>} sap.ui.core.fieldhelp.Text2IdByType
@@ -464,10 +485,10 @@ sap.ui.define([
 		 */
 		_getFieldHelpDisplayMapping() {
 			const mControlIDToDisplayControlID = {};
-			for (const sControlID in this.#mDocuRefControlToFieldHelp) {
+			for (const sControlID in this.mDocuRefControlToFieldHelp) {
 				const oControl = Element.getElementById(sControlID);
 				if (!oControl) { // control has been destroyed, cleanup internal data structure
-					delete this.#mDocuRefControlToFieldHelp[sControlID];
+					delete this.mDocuRefControlToFieldHelp[sControlID];
 					continue;
 				}
 
@@ -485,29 +506,63 @@ sap.ui.define([
 			return mControlIDToDisplayControlID;
 		}
 
+		/**
+		 * Returns the map of control ID to the corresponding set of documentation reference URNs.
+		 *
+		 * The method considers the following precedence for <em>explicit</em> field help set using
+		 * <code>FieldHelpUtil.setDocumentationRef</code> or <code>FieldHelpCustomData</code> and <em>implicit</em>
+		 * field help derived from OData bindings.
+		 * 1. Explicit field help on the control itself
+		 * 2. Explicit field help defined for controls pointing to the control as field help display control
+		 * 3. Union of implicit field helps defined on the control itself and controls pointing to the control as field
+		 *   help display control
+		 *
+		 * @returns {Map<string, Set<string>>}
+		 *   The map of control ID to the corresponding set of documentation reference URNs
+		 */
+		_getDisplayControlIDToURNs() {
+			const mControlIDToDisplayControlID = this._getFieldHelpDisplayMapping();
+			const mExplicitDisplay = new Map();
+			const mExplicitSelf = new Map();
+			const mImplicit = new Map();
+
+			for (const sControlID in this.mDocuRefControlToFieldHelp) {
+				const sDisplayControlID = mControlIDToDisplayControlID[sControlID] || sControlID;
+				const aDocuRefsForControl = this.mDocuRefControlToFieldHelp[sControlID][undefined];
+				if (aDocuRefsForControl) { // explicit field help
+					const oURNSet = new Set(aDocuRefsForControl);
+					if (mControlIDToDisplayControlID[sControlID]) { // on display control
+						const oExistingURNSet = mExplicitDisplay.get(sDisplayControlID);
+						if (oExistingURNSet && !isSetIdentical(oURNSet, oExistingURNSet)) {
+							Log.error("Cannot display field help for control '" + sControlID
+									+ "': different field help already set on hotspot '" + sDisplayControlID + "'",
+								undefined, sClassName);
+							continue;
+						}
+						mExplicitDisplay.set(sDisplayControlID, oURNSet);
+					} else { // on control itself
+						mExplicitSelf.set(sDisplayControlID, oURNSet);
+					}
+				} else {
+					const aDocuRefs = Object.values(this.mDocuRefControlToFieldHelp[sControlID]).flat();
+					// add to a Set to filter duplicates
+					const oURNSet = mImplicit.get(sDisplayControlID) ?? new Set();
+					aDocuRefs.forEach(oURNSet.add.bind(oURNSet));
+					mImplicit.set(sDisplayControlID, oURNSet);
+				}
+			}
+
+			return new Map([...mImplicit, ...mExplicitDisplay, ...mExplicitSelf]);
+		}
+
 		/**
 		 * Gets an array of field help hotspots as required by the SAP Companion.
 		 *
 		 * @returns {module:sap/ui/core/fieldhelp/FieldHelpInfo[]} The array of field help hotspots
 		 */
 		_getFieldHelpHotspots() {
-			const mControlIDToDisplayControlID = this._getFieldHelpDisplayMapping();
-			const mDisplayControlIDToURNs = new Map();
 			const aFieldHelpHotspots = [];
-			Object.keys(this.#mDocuRefControlToFieldHelp).forEach((sControlID) => {
-				const sDisplayControlID = mControlIDToDisplayControlID[sControlID] || sControlID;
-				const oURNSet = mDisplayControlIDToURNs.get(sDisplayControlID)
-					?? mDisplayControlIDToURNs.set(sDisplayControlID, new Set()).get(sDisplayControlID);
-				const aDocuRefsForControl = this.#mDocuRefControlToFieldHelp[sControlID][undefined];
-				const aDocuRefs = aDocuRefsForControl
-					? [aDocuRefsForControl]
-					: Object.values(this.#mDocuRefControlToFieldHelp[sControlID]);
-				aDocuRefs.forEach((aURNs) => {
-					aURNs.forEach(oURNSet.add.bind(oURNSet)); // add to the Set to filter duplicates
-				});
-			});
-
-			for (const [sDisplayControlID, oURNSet] of mDisplayControlIDToURNs) {
+			for (const [sDisplayControlID, oURNSet] of this._getDisplayControlIDToURNs()) {
 				const oControl = Element.getElementById(sDisplayControlID);
 				const sLabel = LabelEnablement._getLabelTexts(oControl)[0];
 				if (!sLabel) {
@@ -548,16 +603,16 @@ sap.ui.define([
 		 */
 		_setFieldHelpDocumentationRefs(oElement, sControlProperty, aDocumentationRefs) {
 			const sControlID = oElement.getId();
-			this.#mDocuRefControlToFieldHelp[sControlID] ||= {};
+			this.mDocuRefControlToFieldHelp[sControlID] ||= {};
 			if (aDocumentationRefs.length > 0) {
-				this.#mDocuRefControlToFieldHelp[sControlID][sControlProperty] = aDocumentationRefs;
+				this.mDocuRefControlToFieldHelp[sControlID][sControlProperty] = aDocumentationRefs;
 			} else {
-				delete this.#mDocuRefControlToFieldHelp[sControlID][sControlProperty];
-				if (Object.keys(this.#mDocuRefControlToFieldHelp[sControlID]).length === 0) {
-					delete this.#mDocuRefControlToFieldHelp[sControlID];
+				delete this.mDocuRefControlToFieldHelp[sControlID][sControlProperty];
+				if (Object.keys(this.mDocuRefControlToFieldHelp[sControlID]).length === 0) {
+					delete this.mDocuRefControlToFieldHelp[sControlID];
 				}
 			}
-			this._updateHotspots().catch(() => {/* avoid uncaught in Promise; do nothing */});
+			this._updateHotspots();
 		}
 
 		/**
@@ -581,34 +636,21 @@ sap.ui.define([
 		/**
 		 * Calls the <code>fnUpdateHotspotsCallback</code> as given in {@link #activate} asynchronously with the latest
 		 * field help hotspots.
-		 *
-		 * @returns {Promise<undefined>}
-		 *   A Promise that resolves when the <code>fnUpdateHotspotsCallback</code> as given in {@link #activate} has
-		 *   been called with the latest field help hotspots; rejects if the field help has been deactivated in between.
 		 */
 		_updateHotspots() {
-			if (this.#oUpdateHotspotsPromise) {
-				return this.#oUpdateHotspotsPromise;
+			if (this.#bUpdateHotspotsPending) {
+				return;
 			}
-			let fnResolve, fnReject;
-			this.#oUpdateHotspotsPromise = new Promise((resolve, reject) => {
-				fnResolve = resolve;
-				fnReject = reject;
-			});
+			this.#bUpdateHotspotsPending = true;
 
 			// gather and send field help info in task so that e.g. field help can be displayed at a column header
 			setTimeout(() => {
 				if (this.isActive()) {
 					this.#fnUpdateHotspotsCallback(this._getFieldHelpHotspots());
 					this.#mMetaModel2TextMappingPromise.clear();
-					fnResolve();
-				} else {
-					fnReject();
 				}
-				this.#oUpdateHotspotsPromise = null;
+				this.#bUpdateHotspotsPending = false;
 			}, 0);
-
-			return this.#oUpdateHotspotsPromise;
 		}
 
 		/**
@@ -706,7 +748,7 @@ sap.ui.define([
 		 */
 		deactivate() {
 			this.#bActive = false;
-			this.#mDocuRefControlToFieldHelp = {};
+			this.mDocuRefControlToFieldHelp = {};
 			this.#fnUpdateHotspotsCallback = null;
 			this.#mMetaModel2TextMappingPromise.clear();
 			this.#mMetamodel2TextPropertyInfo.clear();

package/src/sap/ui/core/fieldhelp/FieldHelpCustomData.js

@@ -44,10 +44,6 @@ sap.ui.define([
 		if (oParent
 			&& oCustomData.getKey() === FieldHelpCustomData.DOCUMENTATION_REF_KEY
 			&& Array.isArray(oCustomData.getValue())) {
-			// For elements, for which the field help information is set manually (e.g. filter fields), the
-			// field help has to be displayed at that element, even if there are child bindings (e.g. value help)
-			// that also contribute to the field help information
-			oParent.setFieldHelpDisplay(oParent);
 			oParent.updateFieldHelp?.();
 		}
 	}

package/src/sap/ui/core/format/FormatUtils.js

@@ -11,7 +11,7 @@ sap.ui.define([], function() {
 	 * Formatter related utility functions
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @namespace
 	 * @private
 	 */

package/src/sap/ui/core/format/TimezoneUtil.js

@@ -13,7 +13,7 @@ sap.ui.define([
 	 * Static collection of utility functions to handle time zone related conversions.
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @namespace
 	 * @name module:sap/ui/core/format/TimezoneUtil
 	 * @private

package/src/sap/ui/core/getCompatibilityVersion.js

@@ -16,7 +16,7 @@ sap.ui.define([
 
 	const BASE_CVERS = Version("1.14");
 
-	const VERSION = "1.134.0";
+	const VERSION = "1.135.0";
 
 	var M_COMPAT_FEATURES = {
 		"xx-test"               : "1.15", //for testing purposes only

package/src/sap/ui/core/hyphenation/Hyphenation.js

@@ -401,7 +401,7 @@ sap.ui.define([
 	 * @see {@link topic:6322164936f047de941ec522b95d7b70 Hyphenation for Text Controls}
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.135.0
 	 * @hideconstructor
 	 * @public
 	 * @since 1.60

package/src/sap/ui/core/i18n/interaction.xml

@@ -0,0 +1,31 @@
+<interaction-documentation
+	xmlns="http://schemas.sap.com/sapui5/extension/sap.ui.core.InteractionDocumentation/1"
+	library="sap.ui.core">
+	<control-interactions>
+		<control name="sap.ui.core.Control"></control>
+		<interaction>
+            <kbd>Tab</kbd>
+            <description>
+                <p>Moves focus to the next element in the tab chain.</p>
+            </description>
+        </interaction>
+        <interaction>
+            <kbd>Shift + Tab</kbd>
+            <description>
+                <p>Moves focus to the previous element in the tab chain.</p>
+            </description>
+        </interaction>
+        <interaction>
+            <kbd>F6</kbd>
+            <description>
+                <p>Moves focus to first element of the next UI group (F6 group) in the tab chain.</p>
+            </description>
+        </interaction>
+        <interaction>
+            <kbd>Shift + F6</kbd>
+            <description>
+                <p>Moves focus to first element of the previous UI group (F6 group) in the tab chain.</p>
+            </description>
+        </interaction>
+	</control-interactions>
+</interaction-documentation>