@sapui5/sap.ushell 1.128.0 → 1.129.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sapui5/sap.ushell",
-    "version": "1.128.0",
+    "version": "1.129.0",
     "description": "SAPUI5 Library sap.ushell",
     "homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
     "keywords": [

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

@@ -2,7 +2,7 @@
 <library xmlns="http://www.sap.com/sap.ui.library.xsd">
     <name>sap.ushell</name>
     <vendor>SAP SE</vendor>
-    <version>1.128.0</version>
+    <version>1.129.0</version>
     <copyright>Copyright (c) 2009-2023 SAP SE, All Rights Reserved</copyright>
     <documentation>SAP library: sap.ushell</documentation>
 

package/src/main/js/sap/ushell/ApplicationType/systemAlias.js

@@ -934,6 +934,50 @@ sap.ui.define([
         });
 
         return oPromise;
+
+    }
+
+    /**
+     * Get the system alias in the provider from the fully qualified system alias.
+     * Given is the fully qualified system alias, which is a combination of the system alias and the content provider id.
+     * The expected format is: <contentProviderId>_<fully qualified systemAlias> or some edge cases when the content provider id or the system alias is missing.
+     * Different cases of the system alias in provider are to be considered:
+     * 1. If the content Provider id is missing return the fully qualified system alias which should equal the system alias in provider.
+     * 2. If the system alias in provider is empty, return undefined, ideally it should be the empty string.
+     * 3. If the format is not as expected, return undefined.
+     * 4. If the format is correct, return the system alias in provider.
+     *
+     @param {*} sFullyQualifiedSystemAlias The fully qualified system alias
+     * @param {*} sContentProviderId the content provider id
+     * @returns {string} the system alias in the provider
+     * @since 1.129.0
+    */
+    function getSystemAliasInProvider (sFullyQualifiedSystemAlias, sContentProviderId) {
+
+        if (sContentProviderId) {
+            if (!sFullyQualifiedSystemAlias.includes(sContentProviderId)) {
+                Log.error("Unexpected format for fully qualified systemAlias: missing contentProviderId.");
+                return sFullyQualifiedSystemAlias;
+            }
+
+            const sSystemAliasInProvider = sFullyQualifiedSystemAlias.replace(sContentProviderId, "");
+            // pass undefined as a default system alias within a provider
+            if (sSystemAliasInProvider.length === 0) {
+                return undefined;
+            }
+
+            if (sSystemAliasInProvider[0] !== "_") {
+                Log.error("Unexpected format for fully qualified systemAlias: missing underscore delimiter.");
+                return sSystemAliasInProvider;
+            }
+            // pass undefined as a default system alias within a provider
+            if (sSystemAliasInProvider === "_") {
+                return undefined;
+            }
+
+            return sSystemAliasInProvider.replace("_", "");
+        }
+        return sFullyQualifiedSystemAlias;
     }
 
     return {
@@ -941,6 +985,7 @@ sap.ui.define([
         SYSTEM_ALIAS_SEMANTICS: O_SYSTEM_ALIAS_SEMANTICS,
         spliceSapSystemIntoURI: spliceSapSystemIntoURI,
         isAbsoluteURI: isAbsoluteURI,
+        getSystemAliasInProvider: getSystemAliasInProvider,
 
         // for testing
         _stripURI: _stripURI,

package/src/main/js/sap/ushell/ApplicationType/urlTemplateResolution.js

@@ -14,7 +14,8 @@ sap.ui.define([
     "sap/base/util/isPlainObject",
     "sap/ushell/Container",
     "sap/ushell/ApplicationType/guiResolution",
-    "sap/ushell/utils/UrlParsing"
+    "sap/ushell/utils/UrlParsing",
+    "sap/ushell/ApplicationType/systemAlias"
 ], function (
     Log,
     Localization,
@@ -30,13 +31,16 @@ sap.ui.define([
     isPlainObject,
     Container,
     guiResolution,
-    oURLParsing
+    oURLParsing,
+    SystemAlias
 ) {
     "use strict";
 
     var oUrlParams = (new URI(document.URL)).search(true),
         sIframeURLDomainForTests = oUrlParams["iframe-url"];
 
+
+
     function generateURLTemplateResolutionResult (oMatchingTarget, sBaseUrl, fnExternalSystemAliasResolver) {
         return new Promise(function (fnResolveGlobal) {
             sap.ui.require(["sap/ushell/URLTemplateProcessor"], function (URLTemplateProcessor) {
@@ -188,6 +192,11 @@ sap.ui.define([
                             "startupParameter"
                         );
                     };
+                    var sSytemAliasOrDestination = (oTemplateContext.siteAppSection["sap.app"] &&
+                        oTemplateContext.siteAppSection["sap.app"].destination) ||
+                    oTemplateContext.siteAppSection.destination || "";
+                    var sContentProviderId = oTemplateContext?.siteAppSection["sap.app"]?.contentProviderId || "";
+                    var sSystemAlias = SystemAlias.getSystemAliasInProvider(sSytemAliasOrDestination, sContentProviderId);
 
                     var oResult = {
                         applicationType: "URL",
@@ -200,9 +209,7 @@ sap.ui.define([
                         url: sURL,
                         extendedInfo: oApplicationTypeUtils.getExtendedInfo(oMatchingTarget, oTemplateContext.siteAppSection, oTemplateContext.site),
                         contentProviderId: oInbound.contentProviderId || "",
-                        systemAlias: (oTemplateContext.siteAppSection["sap.app"] &&
-                                oTemplateContext.siteAppSection["sap.app"].destination) ||
-                            oTemplateContext.siteAppSection.destination || ""
+                        systemAlias: sSystemAlias
                     };
                     oApplicationTypeUtils.addIframeCacheHintToURL(oResult, oResult.appCapabilities.appFrameworkId);
                     oApplicationTypeUtils.addKeepAliveToURLTemplateResult(oResult);

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

@@ -5,7 +5,7 @@
  *
  * The Fiori20 adapter automatically re-styles old (Fiori 1) applications to match Fiori2 design requirements.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/base/Object",
@@ -26,12 +26,14 @@ sap.ui.define([
 ) {
     "use strict";
 
-    var oUIService;
-
     UIComponent._fnOnInstanceDestroy = function (oComponent) {
         if (oComponent._fioriAdapter) {
             oComponent._fioriAdapter.destroy();
         }
+
+        if (oComponent._oShellUIService) {
+            oComponent._oShellUIService.destroy();
+        }
     };
 
     /**
@@ -93,6 +95,7 @@ sap.ui.define([
             BaseObject.call(this);
             this._oConfig = oConfig;
             this._oAppInfo = oAppInfo;
+            this._oShellUIService = oComponent._oShellUIService;
 
             this._aHierarchy = [];
             this._defaultTitle = this._oAppInfo.getDefaultTitle();
@@ -107,8 +110,15 @@ sap.ui.define([
 
                 this._oCurrentViewInfo = oViewInfo;
                 var sTitle = this._oCurrentViewInfo.oTitleInfo ? this._oCurrentViewInfo.oTitleInfo.text : undefined;
-                if (sTitle !== oUIService.getTitle()) {
-                    oUIService.setTitle(sTitle);
+                if (sTitle !== this._oShellUIService.getTitle()) {
+                    try {
+                        this._oShellUIService.setTitle(sTitle);
+                    } catch {
+                        /*
+                         * fail silently:
+                         * The app might run in autoTitle mode. Any manual title change will raise an error.
+                         */
+                    }
                 }
                 this._updateHierarchy();
             }
@@ -124,7 +134,7 @@ sap.ui.define([
             if (oBackButton) {
                 fnBackPress = oBackButton.firePress.bind(oBackButton);
             }
-            oUIService.setBackNavigation(fnBackPress);
+            this._oShellUIService.setBackNavigation(fnBackPress);
         },
 
         _updateHierarchy: function () {
@@ -165,7 +175,14 @@ sap.ui.define([
                 aNewHierarchy.push(this._aHierarchy[j]);
             }
 
-            oUIService.setHierarchy(this._deleteUndefinedProperties(aNewHierarchy));
+            try {
+                this._oShellUIService.setHierarchy(this._deleteUndefinedProperties(aNewHierarchy));
+            } catch {
+                /*
+                 * fail silently:
+                 * The app might run in autoHierarchy mode. Any manual hierarchy change will raise an error.
+                 */
+            }
         },
 
         _createHierarchyEntry: function () {
@@ -232,14 +249,19 @@ sap.ui.define([
         }
     });
 
-    Fiori20Adapter.applyTo = function (oControl, oComponent, oConfig, oService) {
+    Fiori20Adapter.applyTo = function (oControl, oComponent, oConfig, oShellUIService) {
         var oOwner = oControl instanceof UIComponent ? oControl : Component.getOwnerComponentFor(oControl);
         if (!oOwner) {
             oOwner = oComponent;
         }
 
-        if (oOwner && !oOwner._fioriAdapter) {
-            oUIService = oService;
+        if (!oOwner) {
+            return;
+        }
+
+        oOwner._oShellUIService = oShellUIService;
+
+        if (!oOwner._fioriAdapter) {
             oOwner._fioriAdapter = new Fiori20Adapter(oOwner, oConfig);
             oOwner._fioriAdapter.init();
         }

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

@@ -4,7 +4,7 @@
  * @fileOverview The purpose Fiori20AdapterTest in this file is to decide whether to load the Fiori20Adapter at all.
  * This file is kept small in size on purpose as it is always required in productive code even when Fiori 2 adaptation is not required.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -221,10 +221,10 @@ sap.ui.define([
     };
 
     UIComponent._fnOnInstanceInitialized = function (oComponent) {
-        const oControl = oComponent.getAggregation("rootControl");
+        const oRootControl = oComponent.getAggregation("rootControl");
 
-        if (!oControl
-            || oControl.getId() === "navContainerFlp" // skip flp home page
+        if (!oRootControl
+            || oRootControl.getId() === "navContainerFlp" // skip flp home page
             || oComponent.getId().indexOf("application-") !== 0) { // skip ui5 application component
             return;
         }
@@ -252,14 +252,17 @@ sap.ui.define([
 
         const oDelegate = {
             onBeforeRendering: function () {
-                oControl.removeEventDelegate(oDelegate);
+                oRootControl.removeEventDelegate(oDelegate);
 
                 // check: ShellUIService is available
                 // this check is done after attaching onBeforeRendering since the service is obtained asynchronously
-                const oService = ServiceFactoryRegistry.get("sap.ushell.ui5service.ShellUIService"),
-                    oServiceInstancePromise = oService && oService.createInstance();
+                const oServiceFactory = ServiceFactoryRegistry.get("sap.ushell.ui5service.ShellUIService");
+                const oServiceInstancePromise = oServiceFactory && oServiceFactory.createInstance({
+                    scopeObject: oComponent,
+                    scopeType: "component"
+                });
 
-                if (!oService || !oServiceInstancePromise) {
+                if (!oServiceFactory || !oServiceInstancePromise) {
                     Log.warning(
                         "Fiori20Adapter not loaded because ShellUIService is not available",
                         "sap.ushell.ui5service.ShellUIService should be declared by configuration",
@@ -268,18 +271,18 @@ sap.ui.define([
                     return;
                 }
 
-                oServiceInstancePromise.then(
-                    (oServiceParam) => Fiori20Adapter.applyTo(oControl, oComponent, oConfig, oServiceParam),
-                    (oError) => {
+                oServiceInstancePromise
+                    // destroy is handled in _fnOnInstanceDestroy
+                    .then((oShellUIService) => Fiori20Adapter.applyTo(oRootControl, oComponent, oConfig, oShellUIService))
+                    .catch((oError) => {
                         Log.warning(
                             "Fiori20Adapter not loaded as ShellUIService is not available",
                             oError, // uses toString
                             "sap.ushell.Fiori20AdapterTest"
                         );
-                    }
-                );
+                    });
             }
         };
-        oControl.addEventDelegate(oDelegate);
+        oRootControl.addEventDelegate(oDelegate);
     };
 });

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview NWBCInterface for NWBC client
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/EventHub",

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

@@ -42,7 +42,7 @@
  * parameters. If the application tries to access an internal parameter (e.g.,
  * sap-ui-app-id-hint) via the API, the application receives an error message.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

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

@@ -915,6 +915,17 @@ sap.ui.define([
             return this;
         };
 
+        /**
+         * Updates the elements to capture.
+         * @param {NodeList|Node} aNodeList The list of elements to capture
+         *
+         * @since 1.129.0
+         * @public
+         */
+        this.setElementsToCapture = function (aNodeList) {
+            this.elementsToCapture = jQuery(aNodeList);
+        };
+
         // Initialize dynamic feature state and behaviour using configuration
         this.init(cfg);
 

package/src/main/js/sap/ushell/URLTemplateProcessor/DefinitionParameterSetBuilder.js

@@ -4,7 +4,7 @@
  * @fileOverview Methods to build the set of parameters used by the URL template.
  *
  *
- * @version 1.128.0
+ * @version 1.129.0
  *
  * @private
  *

package/src/main/js/sap/ushell/URLTemplateProcessor/DependencyGraph.js

@@ -8,7 +8,7 @@
  * The proper order of evaluation can be determined by creating and visiting a graph that represents parameters and depending parameters
  * as nodes. This graph can be also used to detect cyclic references in the parameter set definition.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/URLTemplateProcessor/Functions.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Methods to parse and execute functions defined for the URL Template parameter language.
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/URLTemplateProcessor/Resolvers.js

@@ -5,7 +5,7 @@
  * For a given context (e.g. the reference to a site, the application section from the site, parameters added during runtime, etc),
  * this module can be used to find the values associated to given URL Template parameter names.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/URLTemplateProcessor/TemplateParameterParser.js

@@ -34,7 +34,7 @@
  *     }
  *   }
  *   </pre>
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/URLTemplateProcessor/utils.js

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility functions for modules of <code>URLTemplateProcessor</code>.
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

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

@@ -26,7 +26,7 @@
  * The language to define parameters in the URL Template parameter set contains a minimal set of conditionals,
  * logical operators, and functions that allow to define the parameter set with a certain degree of control.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 
 sap.ui.define([

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

@@ -6,7 +6,7 @@
  * Exposes methods to create a UI5 Service Factory for a specific Unified Shell
  * Service.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/AppVariantPersonalizationAdapter.js

@@ -1,7 +1,7 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 sap.ui.define([
     "sap/ui/core/Lib",
-    "sap/ushell/services/_Personalization/constants",
+    "sap/ushell/services/PersonalizationV2/constants",
     "sap/ui/fl/apply/api/UI2PersonalizationApplyAPI",
     "sap/base/Log",
     "sap/ui/thirdparty/jquery"

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

@@ -9,7 +9,7 @@
  * <li>provide the resolveHashFragment function, a fallback method called by ClientSideTargetResolution service.</li>
  * </ul>
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/util/Version",

package/src/main/js/sap/ushell/adapters/cdm/CommonDataModelAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's sap.ushell.adapters.cdm.CommonDataModelAdapter for the 'CDM'
  *               platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",

package/src/main/js/sap/ushell/adapters/cdm/ConfigurationDefaultsAdapter.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ConfigurationDefaults adapter for the CDM platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/bootstrap/cdm/cdm.constants",

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview The Unified Shell"s container adapter for the Common Data Model (CDM) platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 2 (V2)
  * @deprecated since 1.100
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/PagesCommonDataModelAdapter.js

@@ -5,7 +5,7 @@
  * It combines the page data, tile data, navigation data and personalization into a CDM 3.1 site.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/base/Log",

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

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/_Personalization/internals",

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

@@ -5,7 +5,7 @@
  *
  *
  * The CDM personalization adapter can be used to store data in the RA@ABAP platform.
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "./PersonalizationAdapter"

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

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

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/modifyHome.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of modifying the home page data for the 'CDM' platform.
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 
 /**
  * @fileOverview Helper of accessing catalog data for the 'CDM' platform.
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/readHome.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper of accessing Home Page data for the 'CDM' platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/_LaunchPage/uri.transform.js

@@ -4,7 +4,7 @@
  * @fileOverview Transforms relative URIs as used e.g. for data sources in the
  * manifest.json
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/URI"

package/src/main/js/sap/ushell/adapters/cdm/util/AppForInbound.js

@@ -5,7 +5,7 @@
  * Creates CDM site entries for apps with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/util/cdmSiteUtils.js

@@ -5,7 +5,7 @@
  * Creates CDM site entities with the provided data.
  * Only used on the ABAP platform and on local for testing.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/AdapterBase.js

@@ -4,7 +4,7 @@
  * @fileOverview The Base of Unified Shell's LaunchPageAdapter for the 'CDM' platform - Version 3 (V3)
  *   and StaticGroupsContainer for Featured Group
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/v3/FlpLaunchPageAdapter.js

@@ -4,7 +4,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 3 (V3)
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/_LaunchPage/readHome",

package/src/main/js/sap/ushell/adapters/cdm/v3/LaunchPageAdapter.js

@@ -5,7 +5,7 @@
  *               'CDM' platform - Version 3 (V3)
  *
  * @deprecated since 1.100
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/FlpLaunchPageAdapter"

package/src/main/js/sap/ushell/adapters/cdm/v3/StaticGroupsAdapter.js

@@ -3,7 +3,7 @@
  * @fileOverview The Unified Shell's LaunchPageAdapter for the
  *               'CDM' platform - Version 3 (V3)
  *
- * @version 1.128.0
+ * @version 1.129.0
  */
 sap.ui.define([
     "sap/ushell/adapters/cdm/v3/AdapterBase"

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readApplications.js

@@ -3,7 +3,7 @@
 /**
  * @fileOverview Helper for accessing application data for the 'CDM' platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define([

package/src/main/js/sap/ushell/adapters/cdm/v3/_LaunchPage/readCatalogs.js

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Helper for accessing catalog data for the 'CDM' platform.
  *
- * @version 1.128.0
+ * @version 1.129.0
  * @private
  */
 sap.ui.define( [