@sapui5/sap.ushell 1.128.1 → 1.129.0

package/src/main/js/sap/ushell/adapters/local/AppStateAdapter.js

@@ -5,7 +5,7 @@
  *   TODO will be replaced by true persistence within this SP!
  *   This adapter delegates to the Personalization Adapter
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/services/appstate/AppStatePersistencyMethod",

package/src/main/js/sap/ushell/adapters/local/ClientSideTargetResolutionAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's ClientSideTargetResolutionAdapter for the local
  *               platform.
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/adapters/local/ContainerAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell's container adapter for standalone demos.
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/local/FlpLaunchPageAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/local/LaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  *
  * @deprecated since 1.100
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/local/FlpLaunchPageAdapter"

package/src/main/js/sap/ushell/adapters/local/NavTargetResolutionAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolution adapter for the demo platform used in scube ui5appruntime.scube.
- * @version 1.128.1
+ * @version 1.129.0
  * @deprecated since 1.120
  * @private
  */

package/src/main/js/sap/ushell/adapters/local/NavTargetResolutionInternalAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The NavTargetResolutionInternal adapter for the demo platform.
- * @version 1.128.1
+ * @version 1.129.0
  * @since 1.120
  * @private
  */

package/src/main/js/sap/ushell/adapters/local/PageBuildingAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's page builder adapter for the 'demo' platform.
  * It creates chip instances from chip raw data. Compared to the other platforms this adapter has restricted functionality.
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/core/ComponentContainer",

package/src/main/js/sap/ushell/adapters/local/PagePersistenceAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview PagePersistenceAdapter for the local platform.
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/adapters/local/PersonalizationAdapter.js

@@ -6,7 +6,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/utils",

package/src/main/js/sap/ushell/adapters/local/PersonalizationV2Adapter.js

@@ -6,7 +6,7 @@
  *
  * The local personalization adapter can be configured to store data either in
  * the local storage (default) or in memory.
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

package/src/main/js/sap/ushell/adapters/local/SearchAdapter.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Search adapter for the demo platform.
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/SearchCEPAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Search adapter for CEP Search
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 /*eslint-disable quote-props*/
 sap.ui.define([], function () {

package/src/main/js/sap/ushell/adapters/local/SupportTicketAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The SupportTicket adapter for the local platform.
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/Ui5ComponentLoaderAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The Unified Shell's Ui5ComponentLoaderAdapter for the local platform
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
 ], function () {

package/src/main/js/sap/ushell/adapters/local/UserDefaultParameterPersistenceAdapter.js

@@ -6,7 +6,7 @@
  *               TODO will be replaced by true persistence within this SP!
  *               This adapter delegates to the Personalization Adapter
  *
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/adapters/local/UserInfoAdapter.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview The UserInfo adapter for the demo platform.
- * @version 1.128.1
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",

package/src/main/js/sap/ushell/api/Copilot.js

@@ -0,0 +1,42 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @file Utility functions for the Copilot.
+ */
+sap.ui.define([
+    "sap/ushell/api/common/ComponentInstantiation"
+], function (
+    ComponentInstantiation
+) {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.api.Copilot
+     * @namespace
+     * @description The Copilot needs to instantiate app components based on intents
+     *   for which this API provides utility functions.
+     *
+     * @since 1.129.0
+     * @private
+     * @ui5-restricted sap.cp.ui
+     */
+    class Copilot {
+
+        /**
+         * Resolves a given navigation intent (if valid) and returns the respective component instance for further processing.
+         *
+         * @param {string} sIntent Semantic object and action as a string with a "#" as prefix
+         * @returns {Promise<sap.ui.core.Component>} A promise resolving the component instance.
+         *
+         * @since 1.129.0
+         * @private
+         * @ui5-restricted sap.cp.ui
+         */
+        async createComponentInstance (sIntent) {
+            return ComponentInstantiation.createComponentInstance(sIntent);
+        }
+
+    }
+
+    return new Copilot();
+});

package/src/main/js/sap/ushell/api/Inbox.js

@@ -4,21 +4,9 @@
  * @file Utility functions for the My Inbox app.
  */
 sap.ui.define([
-    "sap/base/Log",
-    "sap/ushell/Container",
-    "sap/ushell/UI5ComponentType",
-    "sap/ushell/utils/UrlParsing",
-    "sap/base/util/deepExtend",
-    "sap/ushell/ApplicationType",
-    "sap/ushell/utils"
+    "sap/ushell/api/common/ComponentInstantiation"
 ], function (
-    Log,
-    Container,
-    UI5ComponentType,
-    UrlParsing,
-    deepExtend,
-    ApplicationType,
-    ushellUtils
+    ComponentInstantiation
 ) {
     "use strict";
 
@@ -50,43 +38,7 @@ sap.ui.define([
          * @ui5-restricted cross.fnd.fiori.inbox
          */
         async createComponentInstance (sIntent, oComponentData, oOwnerComponent) {
-            const Ui5ComponentLoader = await Container.getServiceAsync("Ui5ComponentLoader");
-
-            let oModifiedComponentData = await this.createComponentInstantiationData(sIntent, oComponentData);
-            oModifiedComponentData = await Ui5ComponentLoader.modifyComponentProperties(oModifiedComponentData, UI5ComponentType.Application);
-            oModifiedComponentData.loadDefaultDependencies = false;
-
-            if (oOwnerComponent) {
-                return new Promise((resolve, reject) => {
-                    oOwnerComponent.runAsOwner(() => {
-                        this.#createComponent(oModifiedComponentData, Ui5ComponentLoader)
-                            .then(resolve)
-                            .catch(reject);
-                    });
-                });
-            }
-
-            return this.#createComponent(oModifiedComponentData, Ui5ComponentLoader);
-        }
-
-        /**
-         * Creates a UI5 component instance based on the given component properties.
-         *
-         * @param {object} oComponentProperties The properties of the component to create.
-         * @param {sap.ushell.services.Ui5ComponentLoader} Ui5ComponentLoader The UI5 component loader service.
-         * @returns {Promise<sap.ui.core.Component>} A promise resolving the component instance.
-         *
-         * @since 1.128.0
-         * @private
-         */
-        async #createComponent (oComponentProperties, Ui5ComponentLoader) {
-            try {
-                const oComponentPropertiesWithComponentHandle = await Ui5ComponentLoader.instantiateComponent(oComponentProperties);
-                return oComponentPropertiesWithComponentHandle.componentHandle.getInstance();
-            } catch (oError) {
-                Log.error(`Cannot create UI5 component: ${oError.toString()}`, oError.stack, "sap.ushell.api.Inbox");
-                return Promise.reject(oError);
-            }
+            return ComponentInstantiation.createComponentInstance(sIntent, oComponentData, oOwnerComponent);
         }
 
         /**
@@ -103,120 +55,9 @@ sap.ui.define([
          * @ui5-restricted cross.fnd.fiori.inbox
          */
         async createComponentInstantiationData (sIntent, oComponentData) {
-            const oComponentConfig = {
-                componentData: oComponentData
-            };
-
-            if (oComponentConfig.componentData) {
-                // cleanup componentData
-                delete oComponentConfig.componentData.startupParameters;
-                delete oComponentConfig.componentData.config;
-                delete oComponentConfig.componentData["sap-xapp-state"];
-            }
-
-            const sCanonicalIntent = UrlParsing.constructShellHash(UrlParsing.parseShellHash(sIntent));
-            if (!sCanonicalIntent) {
-                return Promise.reject("Navigation intent invalid!");
-            }
-
-            const NavTargetResolutionInternal = await Container.getServiceAsync("NavTargetResolutionInternal");
-            const oResolvedHashFragment = await NavTargetResolutionInternal.resolveHashFragment("#" + sCanonicalIntent);
-
-            // if my-inbox is running in cFLP inside an iframe, we need to
-            //  call app index to get the app info so it can be created embedded inside my-inbox.
-            if (oResolvedHashFragment.applicationType === ApplicationType.URL.type &&
-                oResolvedHashFragment.appCapabilities &&
-                oResolvedHashFragment.appCapabilities.appFrameworkId === "UI5" &&
-                Container.inAppRuntime()) {
-
-                // do not change the ["require"] to .require. This is to avoid
-                //  adding dependencies for non cFLP scenario.
-                const [AppLifeCycleAgent] = await ushellUtils.requireAsync(["sap/ushell/appRuntime/ui5/services/AppLifeCycleAgent"]);
-
-                let sAppId;
-                // We try to fetch the app id from the URL. As this also considers app variants and not just standard apps.
-                try {
-                    const sUrl = new URL(oResolvedHashFragment.url);
-                    const oURLParameters = new URLSearchParams(sUrl.search);
-                    sAppId = oURLParameters.get("sap-ui-app-id");
-                } catch (oError) {
-                    // If the URL is not a complete URL but only a URIComponent, we do a regex to find the required parameter value.
-                    sAppId = oResolvedHashFragment.url.match(/[?&]sap-ui-app-id=([^&]+)/)[1];
-                }
-
-                let oAppInfo = await AppLifeCycleAgent.getAppInfo(sAppId);
-                if (oAppInfo.hasOwnProperty("oResolvedHashFragment")) {
-                    oAppInfo = oAppInfo.oResolvedHashFragment;
-                }
-                oAppInfo = this.#finalizeComponentData(oAppInfo, oComponentConfig);
-                if (oAppInfo.url && sIntent.indexOf("?") > 0) {
-                    oAppInfo.url += "?" + sIntent.split("?")[1];
-                }
-
-                return this.#createComponentData({
-                    ui5ComponentName: sAppId,
-                    applicationDependencies: oAppInfo,
-                    url: oAppInfo.url
-                },
-                oComponentConfig);
-            } else if (oResolvedHashFragment.applicationType !== ApplicationType.URL.type && !(/^SAPUI5\.Component=/.test(oResolvedHashFragment.additionalInformation))) {
-                // If the application type equals "URL" and additionalInformation is undefined,
-                // the promise will be rejected if additionalInformation is not checked for existence.
-                return Promise.reject("The resolved target mapping is not of type UI5 component.");
-            }
-
-            return this.#createComponentData(oResolvedHashFragment, oComponentConfig);
-        }
-
-        /**
-         * Creates the component data
-         *
-         * @param {object} oResolvedHashFragment The resolved hash fragment
-         * @param {object} oComponentConfig The component configuration
-         * @returns {Promise<object>} The component data
-         *
-         * @since 1.128.0
-         * @private
-        */
-        async #createComponentData (oResolvedHashFragment, oComponentConfig) {
-            try {
-                oResolvedHashFragment = this.#finalizeComponentData(oResolvedHashFragment, oComponentConfig);
-                oResolvedHashFragment.loadDefaultDependencies = false;
-                const Ui5ComponentLoader = await Container.getServiceAsync("Ui5ComponentLoader");
-                return Ui5ComponentLoader.createComponentData(oResolvedHashFragment);
-            } catch (oError) {
-                Log.error("Cannot get UI5 component data: " + oError, oError.stack, "sap.ushell.api.Inbox");
-                return Promise.reject(oError);
-            }
-        }
-
-        /**
-         * Finalizes the component data
-         *
-         * @param {object} oResolvedHashFragment The resolved hash fragment
-         * @param {object} oComponentConfig The component configuration
-         * @returns {object} The finalized component data
-         *
-         * @since 1.128.0
-         * @private
-         */
-        #finalizeComponentData (oResolvedHashFragment, oComponentConfig) {
-            oResolvedHashFragment = deepExtend({}, oResolvedHashFragment, oComponentConfig);
-
-            if (!oResolvedHashFragment.ui5ComponentName) {
-                if (oResolvedHashFragment.additionalInformation) {
-                    oResolvedHashFragment.ui5ComponentName = oResolvedHashFragment.additionalInformation.replace(/^SAPUI5\.Component=/, "");
-                } else if (oResolvedHashFragment.name) {
-                    oResolvedHashFragment.ui5ComponentName = oResolvedHashFragment.name;
-                }
-            }
-
-            return oResolvedHashFragment;
+            return ComponentInstantiation.createComponentInstantiationData(sIntent, oComponentData);
         }
-
     }
 
-    const InboxInstance = new Inbox();
-
-    return InboxInstance;
+    return new Inbox();
 });

package/src/main/js/sap/ushell/api/S4MyHome.js

@@ -0,0 +1,132 @@
+// Copyright (c) 2009-2023 SAP SE, All Rights Reserved
+
+/**
+ * @file Utility functions for S/4 My Home.
+ */
+sap.ui.define([
+    "sap/ui/base/EventProvider",
+    "sap/ushell/Container",
+    "sap/ushell/utils",
+    "sap/ushell/resources" // required for formatDate
+], function (
+    EventProvider,
+    Container,
+    ushellUtils
+) {
+    "use strict";
+
+    const sHomeRouteName = "home";
+
+    /**
+     * @alias sap.ushell.api.S4MyHome#routeMatched
+     * @event
+     * The <code>routeMatched</code> event is fired, when any flp route matched.
+     * The event is used to activate and deactivate tiles on the My Home app and to change the visibility of the My Home specific buttons.
+     * @param {sap.ui.base.Event} oEvent
+     * @param {sap.ui.base.EventProvider} oEvent.getSource
+     * @param {object} oEvent.getParameters
+     * @param {boolean} oEvent.getParameters.isMyHomeRoute Whether the current route is the My Home route
+     *
+     * @since 1.129.0
+     * @private
+     * @ui5-restricted ux.eng.s4producthomes1
+     */
+
+    /**
+     * @alias sap.ushell.api.S4MyHome
+     * @namespace
+     * @description The utility functions for the S/4 My Home app.
+     *
+     * @since 1.129.0
+     * @private
+     * @ui5-restricted ux.eng.s4producthomes1
+     */
+    class S4MyHome {
+        #bInitialized = false;
+        #oEventProvider = new EventProvider();
+
+        #init () {
+            if (this.#bInitialized) {
+                return;
+            }
+
+            this.#bInitialized = true;
+            const oRouter = Container.getRendererInternal("fiori2").getRouter();
+            oRouter.attachRouteMatched(this.#handleRouteMatched.bind(this));
+        }
+
+        /**
+         * Handles the routeMatched event of the my home route.
+         * @param {sap.ui.base.Event} oEvent The event object.
+         *
+         * @since 1.129.0
+         * @private
+         */
+        #handleRouteMatched (oEvent) {
+            const bIsHomeRoute = oEvent.getParameter("name") === sHomeRouteName;
+
+            this.#oEventProvider.fireEvent("routeMatched", {
+                isMyHomeRoute: bIsHomeRoute
+            });
+        }
+
+
+        /**
+         * Attaches a handler to the routeMatched event.
+         * The event is used to activate and deactivate tiles on the My Home app and to change the visibility of the My Home specific buttons.
+         * @param {object} [oData] An application-specific payload object that will be passed to the event handler along with the event object when firing the event.
+         * @param {function} fnFunction The handler function to call when the event occurs.
+         * @param {object} [oListener] The object that wants to be notified when the event occurs.
+         *
+         * @since 1.129.0
+         * @private
+         * @ui5-restricted ux.eng.s4producthomes1
+         */
+        attachRouteMatched (...args) {
+            this.#init();
+            this.#oEventProvider.attachEvent("routeMatched", ...args);
+        }
+
+        /**
+         * Detaches a handler from the routeMatched event.
+         * @param {function} fnFunction The handler function to detach from the event.
+         * @param {object} [oListener] The object that wanted to be notified when the event occurred.
+         *
+         * @since 1.129.0
+         * @private
+         * @ui5-restricted ux.eng.s4producthomes1
+         */
+        detachRouteMatched (...args) {
+            this.#init();
+            this.#oEventProvider.detachEvent("routeMatched", ...args);
+        }
+
+        /**
+         * Formats the date to easy human readable format.
+         * @param {string} sCreatedAt a stringified date
+         * @returns {string} The formatted date e.g. 'Just now' or '10 minutes ago'
+         *
+         * @since 1.129.0
+         * @private
+         * @ui5-restricted ux.eng.s4producthomes1
+         */
+        formatDate (sCreatedAt) {
+            return ushellUtils.formatDate(sCreatedAt);
+        }
+
+        /**
+         * Resets the state of the API.
+         * For testing purposes only.
+         *
+         * @since 1.129.0
+         * @private
+         */
+        reset () {
+            this.#oEventProvider.destroy();
+            this.#oEventProvider = new EventProvider();
+            this.#bInitialized = false;
+        }
+    }
+
+    return new S4MyHome();
+});