@sapui5/sap.ushell 1.142.0 → 1.143.0

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.142.0",
+            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.142.0
+ * @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.142.0",
+        version: "1.143.0",
         dependencies: [
             "sap.ui.core",
             "sap.m"

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/Notifications/NotificationsProvider.js

@@ -25,7 +25,7 @@ sap.ui.define([
     class NotificationsProvider extends BaseProvider {
         /**
          * Loads the search component and initializes the search functionality.
-         * @param {sap.ushell.modules.Notifications.NotificationsAPI} oNotificationsAPI The side navigation API object.
+         * @param {sap.ushell.modules.Notifications.NotificationsAPI} oNotificationsAPI The notifications API object.
          *
          * @since 1.142.0
          * @private

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

@@ -42,6 +42,7 @@ sap.ui.define([
                 enabled: true,
                 modulePath: sModulePath,
                 useWebComponents: true,
+                initiallyCollapsed: Config.last("/core/search/initiallyCollapsed"),
                 configuration: JSON.stringify(oConfiguration || {}),
                 searchResultAppIntent: sSearchResultAppIntent
             });

package/src/main/js/sap/ushell/modules/loader/AssistantLoader.js

@@ -0,0 +1,156 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/modules/loader/AbstractLoader",
+    "sap/ushell/modules/Assistant/AssistantAPI",
+    "sap/ushell/utils"
+], (
+    Config,
+    AbstractLoader,
+    AssistantAPI,
+    ushellUtils
+) => {
+    "use strict";
+    const sConfigBasePath = "/core/assistant";
+
+    /**
+     * Assistant component for the Fiori Launchpad.
+     *
+     * @augments sap.ushell.modules.loader.AbstractLoader
+     * @since 1.143.0
+     * @private
+     */
+
+    class AssistantLoader extends AbstractLoader {
+        /**
+         * The instance of the loaded assistant module.
+         *
+         * @type {sap.ushell.modules.Assistant.AssistantProvider|null}
+         * @since 1.143.0
+         * @private
+         */
+        #oModuleInstance;
+
+        /**
+         * The API object passed to the assistant module.
+         *
+         * @type {sap.ushell.modules.Assistant.AssistantAPI}
+         * @since 1.143.0
+         * @private
+         */
+        #oModuleAPI;
+
+        /**
+         * A promise that resolves when the loader is initialized.
+         * @since 1.143.0
+         * @type {Promise}
+         */
+        #pInitialized;
+
+        /**
+         * Creates a new instance of the AssistantLoader.
+         *
+         * @since 1.143.0
+         * @private
+         */
+        constructor () {
+            super();
+            this.#init();
+        }
+
+        /**
+         * Initializes the loader by setting up a listener for configuration changes.
+         * Loads or unloads the assistant module based on the configuration.
+         *
+         * @returns {Promise} A promise that resolves when the initialization is complete.
+         * @since 1.143.0
+         * @private
+         */
+        async #init () {
+            this.registerConfigListener(sConfigBasePath, async () => {
+                const bEnabled = Config.last(`${sConfigBasePath}/enabled`);
+                await this.#cleanup();
+                if (bEnabled) {
+                    this.#oModuleInstance = await this.#load();
+                }
+                this.#pInitialized.resolve();
+                this.#oModuleAPI.getAssistantButton()?.setEnabled(true);
+            });
+        }
+
+        /**
+         * Returns a promise that resolves when the loader is initialized.
+         * @returns {Promise} A promise that resolves when the loader is initialized.
+         * @since 1.143.0
+         * @private
+         */
+        initialized () {
+            return this.#pInitialized.promise;
+        }
+
+        /**
+         * Loads the assistant module and creates an instance of it.
+         *
+         * @returns {Promise<sap.ushell.modules.Assistant.AssistantProvider>} A promise that resolves to the assistant module instance.
+         * @since 1.143.0
+         * @private
+         */
+        async #load () {
+            const oVisualConfig = Config.last(`${sConfigBasePath}/visualConfiguration`);
+            const [Button] = await ushellUtils.requireAsync(["sap/f/gen/ui5/webcomponents/dist/Button"]);
+            const oAssistantButton = new Button(oVisualConfig.id, {
+                icon: oVisualConfig.icon,
+                enabled: false // will be enabled after the module is loaded
+            });
+
+            this.#oModuleAPI = new AssistantAPI(oAssistantButton, this.parseJSONFromConfig(`${sConfigBasePath}/configuration`));
+
+            // load the module
+            return this.loadModule(Config.last(`${sConfigBasePath}/modulePath`), this.#oModuleAPI);
+        }
+
+        /**
+         * Resets the loader by cleaning up the current module instance and re-initializing it.
+         *
+         * @returns {Promise} A promise that resolves when the module instance is destroyed and references are cleared.
+         * @since 1.143.0
+         * @private
+         */
+        async reset () {
+            await this.exit();
+            await this.#init();
+        }
+
+        /**
+         * Cleans up the current module instance and clears the API reference.
+         * @returns {Promise} A promise that resolves when the cleanup is complete.
+         * @since 1.143.0
+         * @private
+         */
+        async #cleanup () {
+            if (this.#oModuleInstance?.exit) {
+                await this.#oModuleInstance.exit();
+            }
+
+            this.#oModuleAPI?.getAssistantButton()?.destroy();
+            this.#oModuleAPI = null;
+            this.#oModuleInstance = null;
+            this.#pInitialized = Promise.withResolvers();
+        }
+
+        /**
+         * Cleans up the loader by resetting the module instance and calling the superclass exit method.
+         *
+         * @returns {Promise} A promise that resolves when the loader is cleaned up.
+         * @since 1.143.0
+         * @private
+         * @override
+         */
+        async exit () {
+            await super.exit();
+            await this.#cleanup();
+        }
+    }
+    return new AssistantLoader();
+});

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

@@ -11,7 +11,7 @@
  * Method Compute is used by ClientSide TargetResolution and takes not only the
  * next application but also the current application into account.
  *
- * @version 1.142.0
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/ShellAnalytics.js

@@ -3,7 +3,7 @@
  * @fileOverview Provides analytical data like duration for navigation steps in the shell, in FLP,
  *               in particular an array of all statistical records
  *
- * @version 1.142.0
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/performance/StatisticalRecord.js

@@ -3,7 +3,7 @@
  * @fileOverview Class for statistical record
  *               It should contain data like step, duration after a navigation in the shell, can have status open.
  *               The closing of a record is logged in debug mode
- * @version 1.142.0
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/plugins/appwarmup/Component.js

@@ -87,7 +87,7 @@ sap.ui.define(
         const sComponentName = "sap.ushell.plugins.appwarmup.Component";
         return Component.extend(sComponentName, {
             metadata: {
-                version: "1.142.0",
+                version: "1.143.0",
                 library: "sap.ushell"
             },
 

package/src/main/js/sap/ushell/renderer/Renderer.js

@@ -106,9 +106,9 @@ sap.ui.define([
      */
     const Renderer = UIComponent.extend("sap.ushell.renderer.Renderer", /** @lends sap.ushell.renderer.Renderer.prototype */ {
         metadata: {
-            version: "1.142.0",
+            version: "1.143.0",
             dependencies: {
-                version: "1.142.0",
+                version: "1.143.0",
                 libs: ["sap.ui.core", "sap.m"],
                 components: []
             },
@@ -408,8 +408,7 @@ sap.ui.define([
         const sCustomHomeTitle = Config.last("/core/shell/homePageTitle");
         const sHomeTitle = ushellResources.getTranslationFromJSON(sCustomHomeTitle) || ushellResources.i18n.getText("homeBtn_tooltip");
 
-        const sRootIntent = this.getShellConfig().rootIntent;
-        const bIsRootIntentFlpHome = !sRootIntent || ushellUtils.isFlpHomeIntent(sRootIntent);
+        const bIsRootIntentFlpHome = ushellUtils.isFlpHomeIntent(ushellUtils.getRootIntent());
 
         // switch to home first so that #set calls below have effect
         AppLifeCycleAI.switchViewState(bIsRootIntentFlpHome ? LaunchpadState.Home : LaunchpadState.App, false, "Shell-home");
@@ -2748,7 +2747,7 @@ sap.ui.define([
      * It returns true if it can match the intent, false otherwise.
      * On its first call, a copy of all of those path is created and stored.
      *
-     * @param {object} oParsedHash A resolved hash as returned by URLParsing
+     * @param {sap.ushell.services.URLParsing.DecomposedHash} oParsedHash A resolved hash as returned by URLParsing
      * @returns {boolean} True if the intent is built in, false otherwise
      * @private
      * @since 1.85.0