@sapui5/sap.ushell 1.141.3 → 1.143.0

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

@@ -0,0 +1,56 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file This module provides an API for configuring the search of the Launchpad shell bar.
+ * It allows adding a SearchProvider to the search via for example a Plugin.
+ */
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/utils"
+], (
+    Config,
+    ushellUtils
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.modules.Search
+     * @namespace
+     * @description The Search module API to set a SearchProvider and Config.
+     *
+     * @since 1.142.0
+     * @private
+     *
+     * @ui5-restricted HAN-AS-INA-UI
+     */
+    class Search {
+        /**
+         * Sets the search provider for the search module.
+         * @param {string} sModulePath The module path of the search provider.
+         * @param {string} sSearchResultAppIntent The intent to be used for the search result app incl. #.
+         * @param {object} oConfiguration  The configuration object for the search provider.
+         *
+         * @returns {Promise} A promise that resolves when the configuration is set.
+         *
+         * @since 1.142.0
+         * @private
+         * @ui5-restricted HAN-AS-INA-UI
+         */
+        async setSearchProvider (sModulePath, sSearchResultAppIntent, oConfiguration) {
+            Config.emit("/core/search", {
+                enabled: true,
+                modulePath: sModulePath,
+                useWebComponents: true,
+                initiallyCollapsed: Config.last("/core/search/initiallyCollapsed"),
+                configuration: JSON.stringify(oConfiguration || {}),
+                searchResultAppIntent: sSearchResultAppIntent
+            });
+            // ensure the SearchLoader is loaded so it can react to the config change.
+            // This may happen asynchronously if the FLP was not configured to use search at startup.
+            const [oSearchLoader] = await ushellUtils.requireAsync(["sap/ushell/modules/loader/SearchLoader"]);
+            await oSearchLoader.initialized();
+        }
+    }
+    return new Search();
+});

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

@@ -0,0 +1,95 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+/**
+ * @file Abstract module loader providing common functionality for all module loaders.
+ */
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ushell/Config",
+    "sap/ushell/utils",
+    "sap/ushell/EventHub"
+], (
+    Log,
+    Config,
+    ushellUtils,
+    EventHub
+) => {
+    "use strict";
+
+    /**
+     * Abstract module loader
+     * @abstract
+     *
+     * @since 1.142.0
+     * @private
+     */
+    class AbstractLoader {
+        /**
+         * Doables to be used for cleaning up configuration listeners.
+         */
+        #aDoables = [];
+
+        /**
+         * Loads the module of the given module path and creates an instance of it.
+         *
+         * @param {string} sModulePath The module path to load the module.
+         * @param {object} oModuleAPI The module API instance.
+         * @returns {Promise} A promise that resolves with the module instance.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        async loadModule (sModulePath, oModuleAPI) {
+            const oModuleLoaded = Promise.withResolvers();
+            EventHub.once("CoreResourcesComplementLoaded").do(async () => {
+                const [Module] = await ushellUtils.requireAsync([sModulePath]);
+                oModuleLoaded.resolve(new Module(oModuleAPI));
+            });
+            return oModuleLoaded.promise;
+        }
+
+        /**
+         * Reads the ushell Config at the given path, parses it as JSON, and returns the resulting object.
+         * If the configuration value is not set, it returns an empty object. It throws an error if parsing fails.
+         *
+         * @param {string} sPath The configuration path to read.
+         * @returns {object} The parsed JSON object from the configuration or an empty object if not set.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        parseJSONFromConfig (sPath) {
+            const sConfigValue = Config.last(sPath);
+            if (sConfigValue) {
+                try {
+                    return JSON.parse(sConfigValue);
+                } catch (oError) {
+                    Log.error(`Failed to parse JSON from configuration at path: ${sPath}`, oError);
+                }
+            }
+            return {};
+        }
+
+        /**
+         * Registers a configuration listener for the given path and stores the doable for cleanup.
+         * @param {string} sPath The configuration path to listen to.
+         * @param {function} fnListener The listener function to be called on configuration changes.
+         * @since 1.142.0
+         * @private
+         */
+        registerConfigListener (sPath, fnListener) {
+            this.#aDoables.push(Config.on(sPath).do(fnListener));
+        }
+
+        /**
+         * Resets the loader by removing all configuration listeners.
+         * @since 1.142.0
+         * @private
+         */
+        async exit () {
+            this.#aDoables.forEach((oDoable) => oDoable.off());
+            this.#aDoables = [];
+        }
+    }
+    return AbstractLoader;
+});

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/modules/loader/NotificationsLoader.js

@@ -0,0 +1,148 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/modules/loader/AbstractLoader",
+    "sap/ushell/modules/Notifications/NotificationsAPI",
+    "sap/ushell/state/StateManager"
+], (
+    Config,
+    AbstractLoader,
+    NotificationsAPI,
+    StateManager
+) => {
+    "use strict";
+    const sConfigBasePath = "/core/notifications";
+
+    // shortcut for sap.ushell.state.StateManager.Operation
+    const Operation = StateManager.Operation;
+
+    /**
+     * Notifications component for the Fiori Launchpad.
+     *
+     * @augments sap.ushell.modules.loader.AbstractLoader
+     * @since 1.142.0
+     * @private
+     */
+    class NotificationsLoader extends AbstractLoader {
+        /**
+         * The instance of the loaded notifications module.
+         *
+         * @type {sap.ushell.modules.Notifications.NotificationsProvider|null}
+         * @since 1.142.0
+         * @private
+         */
+        #oModuleInstance;
+
+        /**
+         * The API object passed to the notifications module.
+         *
+         * @type {sap.ushell.modules.Notifications.NotificationsAPI}
+         * @since 1.142.0
+         * @private
+         */
+        #oModuleAPI;
+
+        /**
+         * A promise that resolves when the loader is initialized.
+         * @type {Promise}
+         */
+        #pInitialized;
+
+        /**
+         * Creates a new instance of the NotificationsLoader.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        constructor () {
+            super();
+            this.#init();
+        }
+
+        /**
+         * Initializes the loader by setting up a listener for configuration changes.
+         * Loads or unloads the notifications module based on the configuration.
+         *
+         * @returns {Promise} A promise that resolves when the initialization is complete.
+         * @since 1.142.0
+         * @private
+         */
+        async #init () {
+            this.registerConfigListener("/core/notifications", async () => {
+                const bEnabled = Config.last("/core/notifications/enabled");
+                StateManager.updateAllBaseStates("header.notifications.visible", Operation.Set, bEnabled);
+                await this.#cleanup();
+                if (bEnabled) {
+                    this.#oModuleInstance = await this.#load();
+                }
+                this.#pInitialized.resolve();
+            });
+        }
+
+        /**
+         * Returns a promise that resolves when the loader is initialized.
+         * @returns {Promise} A promise that resolves when the loader is initialized.
+         * @since 1.142.0
+         * @private
+         */
+        initialized () {
+            return this.#pInitialized.promise;
+        }
+
+        /**
+         * Loads the notifications module and creates an instance of it.
+         *
+         * @returns {Promise<sap.ushell.modules.Notifications.NotificationsProvider>} A promise that resolves to the notifications module instance.
+         * @since 1.142.0
+         * @private
+         */
+        async #load () {
+            this.#oModuleAPI = new NotificationsAPI(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.142.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.142.0
+         * @private
+         */
+        async #cleanup () {
+            if (this.#oModuleInstance && typeof this.#oModuleInstance.exit === "function") {
+                await this.#oModuleInstance.exit();
+            }
+            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.142.0
+         * @private
+         * @override
+         */
+        async exit () {
+            await super.exit();
+            await this.#cleanup();
+        }
+    }
+    return new NotificationsLoader();
+});

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

@@ -0,0 +1,153 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/Config",
+    "sap/ushell/Container",
+    "sap/ushell/modules/loader/AbstractLoader",
+    "sap/ushell/modules/Search/SearchAPI",
+    "sap/ushell/utils/UrlParsing"
+], (
+    Config,
+    Container,
+    AbstractLoader,
+    SearchAPI,
+    UrlParsing
+) => {
+    "use strict";
+    const sConfigBasePath = "/core/search";
+
+    /**
+     * Search module loader for the Fiori Launchpad.
+     *
+     * @since 1.142.0
+     * @private
+     */
+    class SearchLoader extends AbstractLoader {
+        /**
+         * The module instance.
+         * @type {sap.ushell.modules.Search.SearchProvider}
+         */
+        #oModuleInstance;
+
+        /**
+         * The module API instance.
+         * @type {sap.ushell.modules.Search.SearchAPI}
+         */
+        #oModuleAPI;
+
+        /**
+         * A promise that resolves when the loader is initialized.
+         * @type {Promise}
+         */
+        #pInitialized;
+
+        constructor () {
+            super();
+            this.#init();
+        }
+
+        #init () {
+            this.registerConfigListener(sConfigBasePath, async () => {
+                const bEnabled = Config.last(`${sConfigBasePath}/enabled`);
+                await this.#cleanup();
+
+                if (bEnabled) {
+                    this.#oModuleInstance = await this.#load();
+                }
+                this.#pInitialized.resolve();
+            });
+        }
+
+        /**
+         * Returns a promise that resolves when the loader is initialized.
+         * @returns {Promise} A promise that resolves when the loader is initialized.
+         * @since 1.142.0
+         * @private
+         */
+        initialized () {
+            return this.#pInitialized.promise;
+        }
+
+        /**
+         * Loads the search module and creates an instance of it.
+         *
+         * @returns {Promise<sap.ushell.modules.Search.SearchProvider>} A promise that resolves to the search module instance.
+         * @since 1.142.0
+         * @private
+         */
+        async #load () {
+            this.#oModuleAPI = new SearchAPI(this.parseJSONFromConfig(`${sConfigBasePath}/configuration`));
+
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            AppLifeCycle.attachAppLoaded(this.#handleSearchFieldExpandState, this);
+
+            this.#handleSearchFieldExpandState();
+
+            // load the module
+            return this.loadModule(Config.last(`${sConfigBasePath}/modulePath`), this.#oModuleAPI);
+        }
+
+        /**
+         * Handles the search field expand state based on the appOpened event. If the search result app is opened,
+         * it sets the search field to be shown.
+         *
+         * @since 1.142.0
+         * @private
+         */
+        async #handleSearchFieldExpandState () {
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            const oCurrentApplication = await AppLifeCycle.getCurrentApplication();
+            const oAppInfo = await oCurrentApplication.getInfo(["appIntent"]);
+
+            const sSearchResultAppIntent = Config.last(`${sConfigBasePath}/searchResultAppIntent`);
+            if (UrlParsing.compareHashes(oAppInfo.appIntent, sSearchResultAppIntent).sameIntent) {
+                this.#oModuleAPI.setShowSearchField(true);
+            }
+        }
+
+        /**
+         * 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.142.0
+         * @private
+         */
+        async reset () {
+            await this.exit();
+            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.142.0
+         * @private
+         */
+        async #cleanup () {
+            if (this.#oModuleInstance) {
+                await this.#oModuleInstance.exit();
+            }
+
+            const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+            AppLifeCycle.detachAppLoaded(this.#handleSearchFieldExpandState, this);
+
+            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.142.0
+         * @private
+         * @override
+         */
+        async exit () {
+            await super.exit();
+            await this.#cleanup();
+        }
+    }
+    return new SearchLoader();
+});

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.141.3
+ * @version 1.143.0
  */
 sap.ui.define([
     "sap/base/Log",