@sapui5/sap.ushell 1.134.0 → 1.135.0

package/src/main/js/sap/ushell/api/common/ComponentInstantiation.js

@@ -5,20 +5,20 @@
  */
 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/Container",
+    "sap/ushell/UI5ComponentType",
+    "sap/ushell/utils",
+    "sap/ushell/utils/UrlParsing"
 ], function (
     Log,
-    Container,
-    UI5ComponentType,
-    UrlParsing,
     deepExtend,
     ApplicationType,
-    ushellUtils
+    Container,
+    UI5ComponentType,
+    ushellUtils,
+    UrlParsing
 ) {
     "use strict";
 
@@ -37,7 +37,7 @@ sap.ui.define([
          * 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
-         * @param {object} [oComponentData={}] The componentData relevant for this component.
+         * @param {sap.ushell.services.Ui5ComponentLoader.ComponentData} [oComponentData={}] The componentData relevant for this component.
          *   <b>Note:</b> Please don't pass <code>startupParameters</code>, <code>config</code>
          *   and <code>["sap-xapp-state"]</code>
          * @param {sap.ui.core.Component} [oOwnerComponent] If specified, the created component will be called within the context of the oOwnerComponent
@@ -50,36 +50,36 @@ sap.ui.define([
         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;
+            let oModifiedInstantiationData = await this.createComponentInstantiationData(sIntent, oComponentData);
+            oModifiedInstantiationData = await Ui5ComponentLoader.modifyComponentProperties(oModifiedInstantiationData, UI5ComponentType.Application);
+            oModifiedInstantiationData.loadDefaultDependencies = false;
 
             if (oOwnerComponent) {
                 return new Promise((resolve, reject) => {
                     oOwnerComponent.runAsOwner(() => {
-                        this.#createComponent(oModifiedComponentData, Ui5ComponentLoader)
+                        this.#createComponent(oModifiedInstantiationData, Ui5ComponentLoader)
                             .then(resolve)
                             .catch(reject);
                     });
                 });
             }
 
-            return this.#createComponent(oModifiedComponentData, Ui5ComponentLoader);
+            return this.#createComponent(oModifiedInstantiationData, 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.InstantiationData} oInstantiationData 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.129.0
          * @private
          */
-        async #createComponent (oComponentProperties, Ui5ComponentLoader) {
+        async #createComponent (oInstantiationData, Ui5ComponentLoader) {
             try {
-                const oComponentPropertiesWithComponentHandle = await Ui5ComponentLoader.instantiateComponent(oComponentProperties);
+                const oComponentPropertiesWithComponentHandle = await Ui5ComponentLoader.instantiateComponent(oInstantiationData);
                 return oComponentPropertiesWithComponentHandle.componentHandle.getInstance();
             } catch (oError) {
                 Log.error(`Cannot create UI5 component: ${oError.toString()}`, oError.stack, "sap.ushell.api.common.ComponentInstantiation");
@@ -94,21 +94,21 @@ sap.ui.define([
          * @param {sap.ushell.services.Ui5ComponentLoader.ComponentData} [oComponentData] The componentData relevant for this component.
          *   <b>Note:</b> Please don't pass <code>startupParameters</code>, <code>config</code>
          *   and <code>["sap-xapp-state"]</code>
-         * @returns {Promise<sap.ushell.services.Ui5ComponentLoader.ComponentData>} A promise resolving the instantiation data for the component.
+         * @returns {Promise<sap.ushell.services.Ui5ComponentLoader.InstantiationData>} A promise resolving the instantiation data for the component.
          *
          * @since 1.129.0
          * @private
          */
         async createComponentInstantiationData (sIntent, oComponentData) {
-            const oComponentConfig = {
+            const oInstantiationData = {
                 componentData: oComponentData
             };
 
-            if (oComponentConfig.componentData) {
+            if (oInstantiationData.componentData) {
                 // cleanup componentData
-                delete oComponentConfig.componentData.startupParameters;
-                delete oComponentConfig.componentData.config;
-                delete oComponentConfig.componentData["sap-xapp-state"];
+                delete oInstantiationData.componentData.startupParameters;
+                delete oInstantiationData.componentData.config;
+                delete oInstantiationData.componentData["sap-xapp-state"];
             }
 
             const sCanonicalIntent = UrlParsing.constructShellHash(UrlParsing.parseShellHash(sIntent));
@@ -144,38 +144,38 @@ sap.ui.define([
                 if (oAppInfo.hasOwnProperty("oResolvedHashFragment")) {
                     oAppInfo = oAppInfo.oResolvedHashFragment;
                 }
-                oAppInfo = this.#finalizeComponentData(oAppInfo, oComponentConfig);
+                oAppInfo = this.#finalizeHashFragment(oAppInfo, oInstantiationData);
                 if (oAppInfo.url && sIntent.indexOf("?") > 0) {
                     oAppInfo.url += "?" + sIntent.split("?")[1];
                 }
 
-                return this.#createComponentData({
+                return this.#createInstantiationData({
                     ui5ComponentName: sAppId,
                     applicationDependencies: oAppInfo,
                     url: oAppInfo.url
                 },
-                oComponentConfig);
+                oInstantiationData);
             } else if (oResolvedHashFragment.applicationType !== ApplicationType.URL.type && !(/^SAPUI5\.Component=/.test(oResolvedHashFragment.additionalInformation))) {
                 // For applications that are not of type 'URL', the additionalInformation has to provide a UI5 component.
                 return Promise.reject("The resolved target mapping is not of type UI5 component.");
             }
 
-            return this.#createComponentData(oResolvedHashFragment, oComponentConfig);
+            return this.#createInstantiationData(oResolvedHashFragment, oInstantiationData);
         }
 
         /**
          * Creates the component data
          *
          * @param {object} oResolvedHashFragment The resolved hash fragment
-         * @param {object} oComponentConfig The component configuration
-         * @returns {Promise<object>} The component data
+         * @param {sap.ushell.services.Ui5ComponentLoader.InstantiationData} oInstantiationData The component configuration
+         * @returns {Promise<sap.ushell.services.Ui5ComponentLoader.InstantiationData>} The component data
          *
          * @since 1.129.0
          * @private
         */
-        async #createComponentData (oResolvedHashFragment, oComponentConfig) {
+        async #createInstantiationData (oResolvedHashFragment, oInstantiationData) {
             try {
-                oResolvedHashFragment = this.#finalizeComponentData(oResolvedHashFragment, oComponentConfig);
+                oResolvedHashFragment = this.#finalizeHashFragment(oResolvedHashFragment, oInstantiationData);
                 oResolvedHashFragment.loadDefaultDependencies = false;
                 const Ui5ComponentLoader = await Container.getServiceAsync("Ui5ComponentLoader");
                 return Ui5ComponentLoader.createComponentData(oResolvedHashFragment);
@@ -186,17 +186,17 @@ sap.ui.define([
         }
 
         /**
-         * Finalizes the component data
+         * Finalizes the hash fragment
          *
          * @param {object} oResolvedHashFragment The resolved hash fragment
-         * @param {object} oComponentConfig The component configuration
-         * @returns {object} The finalized component data
+         * @param {sap.ushell.services.Ui5ComponentLoader.InstantiationData} oInstantiationData The component configuration
+         * @returns {object} The finalized hash fragment
          *
          * @since 1.129.0
          * @private
          */
-        #finalizeComponentData (oResolvedHashFragment, oComponentConfig) {
-            oResolvedHashFragment = deepExtend({}, oResolvedHashFragment, oComponentConfig);
+        #finalizeHashFragment (oResolvedHashFragment, oInstantiationData) {
+            oResolvedHashFragment = deepExtend({}, oResolvedHashFragment, oInstantiationData);
 
             if (!oResolvedHashFragment.ui5ComponentName) {
                 if (oResolvedHashFragment.additionalInformation) {

package/src/main/js/sap/ushell/appIntegration/AppLifeCycle/KeepAliveMode.js

@@ -0,0 +1,43 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+
+sap.ui.define([
+], function (
+) {
+    "use strict";
+
+    /**
+     * @alias sap.ushell.appIntegration.AppLifeCycle.KeepAliveMode
+     * @enum {string}
+     *
+     * @since 1.135.0
+     * @private
+     */
+    const KeepAliveMode = {
+        /**
+         * Keep applications as long as possible.
+         *
+         * @since 1.135.0
+         * @private
+         */
+        True: "true",
+
+        /**
+         * Keep applications only for a "journey".
+         * Destroy them after navigation to home.
+         *
+         * @since 1.135.0
+         * @private
+         */
+        Restricted: "restricted",
+
+        /**
+         * Do not keep applications.
+         *
+         * @since 1.135.0
+         * @private
+         */
+        False: ""
+    };
+
+    return KeepAliveMode;
+});