@sapui5/sap.ushell 1.141.3 → 1.143.0

package/src/main/js/sap/ushell/components/tiles/applauncher/StaticTile.controller.js

@@ -52,18 +52,18 @@ sap.ui.define([
             const oConfig = tileUtils.getAppLauncherConfig(oTileApi, oTileApi.configurationUi.isEnabled(), false);
             const that = this;
             let sNavigationTargetUrl = oConfig.navigation_target_url;
-            let oHash;
+            let oParsedHash;
 
             const sSystem = oTileApi.url.getApplicationSystem();
             if (sSystem) { // propagate system to target application
                 // when the navigation url is hash we want to make sure system parameter is in the parameters part
                 if (UrlParsing.isIntentUrl(sNavigationTargetUrl)) {
-                    oHash = UrlParsing.parseShellHash(sNavigationTargetUrl);
-                    if (!oHash.params) {
-                        oHash.params = {};
+                    oParsedHash = UrlParsing.parseShellHash(sNavigationTargetUrl);
+                    if (!oParsedHash.params) {
+                        oParsedHash.params = {};
                     }
-                    oHash.params["sap-system"] = sSystem;
-                    sNavigationTargetUrl = `#${UrlParsing.constructShellHash(oHash)}`;
+                    oParsedHash.params["sap-system"] = sSystem;
+                    sNavigationTargetUrl = `#${UrlParsing.constructShellHash(oParsedHash)}`;
                 } else {
                     sNavigationTargetUrl += `${(sNavigationTargetUrl.indexOf("?") < 0) ? "?" : "&"}sap-system=${sSystem}`;
                 }

package/src/main/js/sap/ushell/components/tiles/applauncherdynamic/DynamicTile.controller.js

@@ -61,18 +61,18 @@ sap.ui.define([
         REFRESH_INTERVAL_MIN: 10,
 
         constructTargetUrlWithSapSystem: function (sNavigationTargetUrl, sSystem) {
-            let oHash;
+            let oParsedHash;
 
             if (sSystem) { // propagate system to target application
                 // when the navigation url is hash we want to make sure system parameter is in the parameters part
                 // BCP 1780450594
                 if (UrlParsing.isIntentUrl(sNavigationTargetUrl)) {
-                    oHash = UrlParsing.parseShellHash(sNavigationTargetUrl);
-                    if (!oHash.params) {
-                        oHash.params = {};
+                    oParsedHash = UrlParsing.parseShellHash(sNavigationTargetUrl);
+                    if (!oParsedHash.params) {
+                        oParsedHash.params = {};
                     }
-                    oHash.params["sap-system"] = sSystem;
-                    sNavigationTargetUrl = `#${UrlParsing.constructShellHash(oHash)}`;
+                    oParsedHash.params["sap-system"] = sSystem;
+                    sNavigationTargetUrl = `#${UrlParsing.constructShellHash(oParsedHash)}`;
                 } else {
                     sNavigationTargetUrl += `${(sNavigationTargetUrl.indexOf("?") < 0) ? "?" : "&"}sap-system=${sSystem}`;
                 }

package/src/main/js/sap/ushell/components/tiles/cdm/applauncher/StaticTile.controller.js

@@ -196,17 +196,17 @@ sap.ui.define([
         _createTargetUrl: function () {
             let sTargetURL = this.getView().getViewData().properties.targetURL;
             const sSystem = this.getView().getViewData().configuration["sap-system"];
-            let oHash;
+            let oParsedHash;
 
             if (sTargetURL && sSystem) {
                 // when the navigation url is hash we want to make sure system parameter is in the parameters part
                 if (UrlParsing.isIntentUrl(sTargetURL)) {
-                    oHash = UrlParsing.parseShellHash(sTargetURL);
-                    if (!oHash.params) {
-                        oHash.params = {};
+                    oParsedHash = UrlParsing.parseShellHash(sTargetURL);
+                    if (!oParsedHash.params) {
+                        oParsedHash.params = {};
                     }
-                    oHash.params["sap-system"] = sSystem;
-                    sTargetURL = `#${UrlParsing.constructShellHash(oHash)}`;
+                    oParsedHash.params["sap-system"] = sSystem;
+                    sTargetURL = `#${UrlParsing.constructShellHash(oParsedHash)}`;
                 } else {
                     sTargetURL += `${(sTargetURL.indexOf("?") < 0) ? "?" : "&"}sap-system=${sSystem}`;
                 }

package/src/main/js/sap/ushell/components/tiles/cdm/applauncherdynamic/DynamicTile.controller.js

@@ -97,7 +97,7 @@ sap.ui.define([
          */
         _getConfiguration: function (oViewData) {
             const oConfig = {};
-            let oHash;
+            let oParsedHash;
 
             oConfig.configuration = oViewData.configuration;
             oConfig.properties = oViewData.properties;
@@ -119,12 +119,12 @@ sap.ui.define([
             if (sTargetURL && sSystem) {
                 // when the navigation url is hash we want to make sure system parameter is in the parameters part
                 if (UrlParsing.isIntentUrl(sTargetURL)) {
-                    oHash = UrlParsing.parseShellHash(sTargetURL);
-                    if (!oHash.params) {
-                        oHash.params = {};
+                    oParsedHash = UrlParsing.parseShellHash(sTargetURL);
+                    if (!oParsedHash.params) {
+                        oParsedHash.params = {};
                     }
-                    oHash.params["sap-system"] = sSystem;
-                    sTargetURL = `#${UrlParsing.constructShellHash(oHash)}`;
+                    oParsedHash.params["sap-system"] = sSystem;
+                    sTargetURL = `#${UrlParsing.constructShellHash(oParsedHash)}`;
                 } else {
                     sTargetURL += `${(sTargetURL.indexOf("?") < 0) ? "?" : "&"
                     }sap-system=${sSystem}`;

package/src/main/js/sap/ushell/components/visualizationOrganizer/Component.js

@@ -40,7 +40,7 @@ sap.ui.define([
     // visualizationOrganizer Component
     return UIComponent.extend("sap.ushell.components.visualizationOrganizer.Component", {
         metadata: {
-            version: "1.141.3",
+            version: "1.143.0",
             library: "sap.ushell",
             dependencies: { libs: ["sap.m"] },
             properties: {

package/src/main/js/sap/ushell/designtime/ApplicationContainer.designtime.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Provides the Design Time Metadata for the sap.ushell.components.container.ApplicationContainer control
- * @version 1.141.3
+ * @version 1.143.0
  */
 sap.ui.define([], () => {
     "use strict";

package/src/main/js/sap/ushell/library.js

@@ -45,7 +45,7 @@ sap.ui.define([
     const oUshellLibrary = Library.init({
         name: "sap.ushell",
         apiVersion: 2,
-        version: "1.141.3",
+        version: "1.143.0",
         dependencies: [
             "sap.ui.core",
             "sap.m"
@@ -82,13 +82,6 @@ sap.ui.define([
             "sap.ushell.components.shell.Settings.userDefaults.UserDefaultsForm",
             "sap.ushell.components.tiles.sbtilecontent",
 
-            "sap.ushell.components.workPageBuilder.controls.WorkPage",
-            "sap.ushell.components.workPageBuilder.controls.WorkPageButton",
-            "sap.ushell.components.workPageBuilder.controls.WorkPageCell",
-            "sap.ushell.components.workPageBuilder.controls.WorkPageColumn",
-            "sap.ushell.components.workPageBuilder.controls.WorkPageColumnResizer",
-            "sap.ushell.components.workPageBuilder.controls.WorkPageRow",
-
             "sap.ushell.renderer.NavContainer",
 
             // VizInstance service

package/src/main/js/sap/ushell/modules/Assistant/AssistantAPI.js

@@ -0,0 +1,94 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ui/core/Element",
+    "sap/ushell/modules/BaseAPI"
+], (
+    Element,
+    BaseAPI
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.Assistant.AssistantAPI
+     * @namespace
+     * @description The API object for the Assistant module.
+     * This module cannot be required it gets injected in the constructor of the Assistant module.
+     * @see sap.ushell.modules.Assistant.AssistantProvider
+     *
+     * @hideconstructor
+     *
+     * @since 1.143.0
+     * @private
+     * @ui5-restricted Joule
+     */
+    class AssistantAPI extends BaseAPI {
+        /**
+         * The instance of the ShellBar or ShellHeader depending on the ushell Config.
+         *
+         * @type {sap.f.gen.ui5.webcomponents_fiori.dist.ShellBar}
+         * @since 1.143.0
+         * @private
+         */
+        #oShellBar;
+
+        /**
+         * Creates a new instance of the AssistantAPI.
+         *
+         * @param {sap.f.gen.webcomponents.dist.Button} oAssistantButton The assistant button created by the ShellBar.
+         * @param {object} oConfig The configuration object for the assistant module.
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        constructor (oAssistantButton, oConfig) {
+            super(oConfig);
+            this.#oShellBar = Element.getElementById("shell-header")?.getComponentInstance?.()?.getRootControl()?.byId("shellBar");
+            if (this.#oShellBar) {
+                this.#oShellBar.destroyAssistant();
+                this.#oShellBar.addAssistant(oAssistantButton);
+            }
+        }
+
+        /**
+         * Checks if the ShellBar instance is available. This is used as long as the ShellHeader may still be used.
+         *
+         * @returns {boolean} True if the ShellBar instance is available, false otherwise.
+         * @since 1.143.0
+         * @private
+         */
+        #isShellBar () {
+            return this.#oShellBar?.isA("sap.f.gen.ui5.webcomponents_fiori.dist.ShellBar");
+        }
+
+        /**
+         * Gets the assistant button. It is pre-created to be rendered as early as possible in the ShellBar. It will be set to disabled until the Assistant module is loaded.
+         *
+         * @returns {sap.f.gen.webcomponents.dist.Button} The assistant button or undefined if not available.
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        getAssistantButton () {
+            if (!this.#isShellBar()) {
+                // only available in ShellBar
+                return;
+            }
+            return this.#oShellBar.getAssistant()[0];
+        }
+
+        /**
+         * Gets the DOM reference for the assistant button.
+         *
+         * @returns {Element} The DOM reference.
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        getAssistantDomRef () {
+            return this.getAssistantButton()?.getDomRef();
+        }
+    }
+
+    return AssistantAPI;
+});

package/src/main/js/sap/ushell/modules/Assistant/AssistantProvider.js

@@ -0,0 +1,50 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is a wrapper for the AssistantProvider module implementation to document the required interface
+ */
+sap.ui.define([
+    "sap/ushell/modules/BaseProvider"
+], (
+    BaseProvider
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.Assistant.AssistantProvider
+     * @class
+     * @description The required interface for an Assistant module.
+     *
+     * @abstract
+     *
+     * @since 1.143.0
+     * @private
+     *
+     * @ui5-restricted Joule
+     */
+    class AssistantProvider extends BaseProvider {
+        /**
+         * Loads the search component and initializes the search functionality.
+         * @param {sap.ushell.modules.Assistant.AssistantProvider} oAssistantAPI The assistant API object.
+         *
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        constructor (oAssistantAPI) {
+            super(oAssistantAPI);
+        }
+
+        /**
+         * Cleans up the component instance.
+         *
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        async exit () {
+            // to be overridden by subclasses
+        }
+    }
+    return AssistantProvider;
+}, false);

package/src/main/js/sap/ushell/modules/Assistant/VisualConfiguration.js

@@ -0,0 +1,41 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is an empty wrapper for the Assistant.VisualConfiguration
+ */
+sap.ui.define(() => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.Assistant.VisualConfiguration
+     * @class
+     * @description The VisualConfiguration object for the Assistant button.
+     *
+     * @abstract
+     *
+     * @since 1.143.0
+     * @private
+     *
+     * @ui5-restricted Joule
+     */
+    class VisualConfiguration {
+        /**
+         * The ID of the assistant button.
+         *
+         * @type {string}
+         * @since 1.143.0
+         * @private
+         */
+        id;
+
+        /**
+         * The icon of the assistant button.
+         *
+         * @type {string}
+         * @since 1.143.0
+         * @private
+         */
+        icon;
+    }
+    return VisualConfiguration;
+}, false);

package/src/main/js/sap/ushell/modules/Assistant.js

@@ -0,0 +1,56 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This module provides an API for configuring the assistant of the Launchpad shell bar.
+ * It allows adding an AssistantProvider via for example a Plugin.
+ */
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/utils"
+], (
+    Config,
+    ushellUtils
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.Assistant
+     * @namespace
+     * @description The Assistant module API to set an AssistantProvider and Config.
+     *
+     * @since 1.143.0
+     * @private
+     *
+     * @ui5-restricted Joule
+     */
+    class Assistant {
+        /**
+         * Sets the assistant provider for the assistant module.
+         * @param {string} sModulePath The module path of the assistant provider.
+         * @param {sap.ushell.modules.Assistant.VisualConfiguration} oVisualConfiguration The visual configuration object for the assistant button.
+         * @param {object} oConfiguration  The configuration object for the assistant provider.
+         *
+         * @returns {Promise} A promise that resolves when the configuration is set.
+         *
+         * @since 1.143.0
+         * @private
+         * @ui5-restricted Joule
+         */
+        async setAssistantProvider (sModulePath, oVisualConfiguration, oConfiguration) {
+            Config.emit("/core/assistant/enabled", true);
+            Config.emit("/core/assistant/modulePath", sModulePath);
+            Config.emit("/core/assistant/configuration", JSON.stringify(oConfiguration || {}));
+            Config.emit("/core/assistant/visualConfiguration", Object.assign({
+                id: "sapUshellAssistantButton",
+                icon: "sap-icon://da"
+            }, oVisualConfiguration || {}));
+
+            // ensure the AssistantLoader is loaded so it can react to the config change.
+            // This may happen asynchronously if the FLP was not configured to use an assistant at startup.
+            const [oAssistantLoader] = await ushellUtils.requireAsync(["sap/ushell/modules/loader/AssistantLoader"]);
+            await oAssistantLoader.initialized();
+        }
+    }
+    return new Assistant();
+});

package/src/main/js/sap/ushell/modules/BaseAPI.js

@@ -0,0 +1,107 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file The modules base API providing common functionality for all module APIs.
+ */
+sap.ui.define([
+    "sap/base/util/ObjectPath"
+], (
+    ObjectPath
+) => {
+    "use strict";
+
+    /**
+     * The base API class for all module APIs.
+     *
+     * @since 1.142.0
+     * @private
+     */
+    class BaseAPI {
+        /**
+         * @type {object} The configuration object for the module.
+         */
+        #oConfig;
+        /**
+         * @type {object} An object to store property bindings to models.
+         * The keys are property aliases, the values are objects containing the model and the binding.
+         * @example
+         * {
+         *   "propertyAlias1": {
+         *     model: oModel,
+         *     binding: oBinding
+         *   },
+         *   "propertyAlias2": {
+         *     model: oModel2,
+         *     binding: oBinding2
+         *   }
+         * }
+         */
+        #oPropertyBindings = {};
+
+        /**
+         * Creates a new instance of the BaseAPI class.
+         *
+         * @param {object} [oConfig={}] The configuration object for the module.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        constructor (oConfig = {}) {
+            this.#oConfig = oConfig;
+        }
+
+        /**
+         * Gets a configuration value by its path.
+         * @param {string} sPath The path to the configuration value, using dot notation for nested properties.
+         * @returns {any} The configuration value at the given path, or undefined if not found.
+         * If the path is empty, the entire configuration object is returned.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        getConfigValue (sPath) {
+            return ObjectPath.get(sPath, this.#oConfig);
+        }
+
+        /**
+         * Binds a property of the module API to a model property.
+         * When the model property changes, the provided setter callback is called with the new value.
+         *
+         * @param {string} sPath The absolute path to the property in the model.
+         * @param {sap.ui.model.Model} oModel The model to bind to.
+         * @param {string} sPropertyAlias The alias for the property in the module API.
+         * @param {function} fnChangeHandler The callback function to call when the model property changes.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        bindModelProperty (sPath, oModel, sPropertyAlias, fnChangeHandler) {
+            const oBinding = oModel.bindProperty(sPath);
+            oBinding.attachChange(() => {
+                fnChangeHandler(oBinding.getValue());
+            });
+            // store the binding to be able to unbind it later
+            this.#oPropertyBindings[sPropertyAlias] = {
+                model: oModel,
+                binding: oBinding
+            };
+            // initialize the property with the current value
+            fnChangeHandler(oBinding.getValue());
+        }
+
+        /**
+         * Unbinds a property of the module API from its model.
+         * @param {string} sPropertyAlias The alias for the property in the module API to unbind.
+         * @since 1.142.0
+         * @private
+         */
+        unbindModelProperty (sPropertyAlias) {
+            const oModelData = this.#oPropertyBindings[sPropertyAlias];
+            if (oModelData) {
+                oModelData.binding.destroy();
+                delete this.#oPropertyBindings[sPropertyAlias];
+            }
+        }
+    }
+    return BaseAPI;
+});

package/src/main/js/sap/ushell/modules/BaseProvider.js

@@ -0,0 +1,43 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This is an empty wrapper for the BaseProvider module implementation to document the required interface
+ */
+
+sap.ui.define([
+    "sap/ushell/modules/BaseAPI"
+], (
+    BaseAPI
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.BaseProvider
+     * @interface
+     * @description The BaseProvider interface which all module providers should implement.
+     *
+     * @since 1.142.0
+     * @private
+     */
+    class BaseProvider {
+        /**
+         * Creates a new instance of the Provider module.
+         *
+         * @param {sap.ushell.modules.BaseAPI} oAPI The API instance of the module.
+         * @since 1.142.0
+         * @private
+         */
+        constructor (oAPI) {}
+
+        /**
+         * Cleans up the provider instance before destruction.
+         *
+         * @returns {Promise} A promise that resolves when the exit is completed.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        async exit () {}
+    }
+    return BaseProvider;
+});