@sapui5/sap.ushell 1.139.0 → 1.141.0

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

@@ -2,7 +2,7 @@
 
 /**
  * @file Utility functions for modules of <code>URLTemplateProcessor</code>.
- * @version 1.139.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([
@@ -12,6 +12,15 @@ sap.ui.define([
 ) => {
     "use strict";
 
+    let sURIContext;
+    function getURIHashContext () {
+        return sURIContext;
+    }
+
+    function setURIHashContext (sContext) {
+        sURIContext = sContext;
+    }
+
     function hasValue (vValue) {
         return vValue !== null && typeof vValue !== "undefined";
     }
@@ -43,6 +52,8 @@ sap.ui.define([
     return {
         mergeObject: mergeObject,
         hasValue: hasValue,
-        removeArrayParameterNotation: removeArrayParameterNotation
+        removeArrayParameterNotation: removeArrayParameterNotation,
+        getURIHashContext: getURIHashContext,
+        setURIHashContext: setURIHashContext
     };
 });

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.139.0
+ * @version 1.141.0
  * @private
  */
 sap.ui.define([
@@ -190,11 +190,21 @@ sap.ui.define([
      *   It's normally a subset of the site, but this is not a necessity.  It can be a completely separate object.
      * @param {string} sDefaultNamespace The default namespace from <code>oRuntime</code>
      *   where the values of parameters without specified namespace can be recovered.
+     * @param {string} sURIHashContext The URI context to be used during expansion. This is normally the current window location,
+     *   but can be different in some cases (e.g. during navigation target resolution).
      * @returns {string} A URL expanded according to the given template.
      */
-    function expand (oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace) {
+    function expand (oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace, sURIHashContext) {
+        // Set context for any access to URI during expansion
+        _utils.setURIHashContext(sURIHashContext);
+
         const oExpandProcessData = prepareExpandData(oTemplatePayload, oSite, oRuntime, oApplicationContext, sDefaultNamespace);
-        return _expand(oTemplatePayload, oExpandProcessData);
+        const sExpandedUrl = _expand(oTemplatePayload, oExpandProcessData);
+
+        // Clear context after expansion
+        _utils.setURIHashContext(undefined);
+
+        return sExpandedUrl;
     }
 
     return {

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

@@ -2,7 +2,7 @@
 /**
  * @fileOverview Ui5 Native Service Factory
  *
- * @version 1.139.0
+ * @version 1.141.0
  */
 
 sap.ui.define([
@@ -37,10 +37,12 @@ sap.ui.define([
                         oServicePromise = new Promise((resolve, reject) => {
                             sap.ui.require([`sap/ushell/ui5service/${sServiceName}`], (Service) => {
                                 if (!Service) {
-                                    reject();
+                                    reject(new Error(`Failed to load UI5 service ${sServiceName}`));
                                 }
                                 const oService = new Service();
                                 resolve(oService);
+                            }, () => {
+                                reject(new Error(`Failed to load UI5 service ${sServiceName}`));
                             });
                         });
                         oServicePromises[sServiceName] = oServicePromise;

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.139.0
+ * @version 1.141.0
  */
 
 sap.ui.define([
@@ -333,35 +333,37 @@ sap.ui.define([
 
             createInstance: function (oPublicServiceContext) {
                 return new Promise((fnResolve, fnReject) => {
-                    getServiceAsync(sUshellServiceName).then((oUshellService) => {
-                        if (!isValidContext(oPublicServiceContext)) {
-                            Log.error(
-                                `Invalid context for ${sUshellServiceName} service interface`,
-                                "The context must be empty or an object like { scopeType: ..., scopeObject: ... }",
-                                "sap.ushell.Ui5ServiceFactory"
-                            );
-                            fnReject(`Invalid Context for ${sUshellServiceName} service`);
-                            return;
-                        }
-
-                        const oUi5ServiceInfo = getServiceInfo(oPublicServiceContext, oUshellService, bAddCallProtection);
-
-                        // Alternative approach is to use
-                        // Service.create(oUi5ServiceInfo), but this causes
-                        // UI5 anonymous service implementation to hide public
-                        // members of oUi5ServiceInfo.
-                        const Ui5Service = Service.extend(`sap.ushell.ui5service.${sUshellServiceName}`, {
-                            getInterface: function () {
-                                return oUi5ServiceInfo;
+                    getServiceAsync(sUshellServiceName)
+                        .then((oUshellService) => {
+                            if (!isValidContext(oPublicServiceContext)) {
+                                Log.error(
+                                    `Invalid context for ${sUshellServiceName} service interface`,
+                                    "The context must be empty or an object like { scopeType: ..., scopeObject: ... }",
+                                    "sap.ushell.Ui5ServiceFactory"
+                                );
+                                fnReject(new Error(`Invalid Context for ${sUshellServiceName} service`));
+                                return;
                             }
-                        });
 
-                        const oUi5ServiceInstance = new Ui5Service(oPublicServiceContext);
+                            const oUi5ServiceInfo = getServiceInfo(oPublicServiceContext, oUshellService, bAddCallProtection);
+
+                            // Alternative approach is to use
+                            // Service.create(oUi5ServiceInfo), but this causes
+                            // UI5 anonymous service implementation to hide public
+                            // members of oUi5ServiceInfo.
+                            const Ui5Service = Service.extend(`sap.ushell.ui5service.${sUshellServiceName}`, {
+                                getInterface: function () {
+                                    return oUi5ServiceInfo;
+                                }
+                            });
 
-                        fnResolve(oUi5ServiceInstance);
-                    }, (oGetServiceError) => {
-                        fnReject(oGetServiceError);
-                    });
+                            const oUi5ServiceInstance = new Ui5Service(oPublicServiceContext);
+
+                            fnResolve(oUi5ServiceInstance);
+                        })
+                        .catch((oError) => {
+                            fnReject(oError);
+                        });
                 });
             }
         });

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

@@ -378,7 +378,7 @@ sap.ui.define([
             if (oSettings.ranges.theme[oTheme.id]) {
                 oSettings.ranges.theme[oTheme.id].themeRoot = oTheme.root;
             } else {
-                oSettings.ranges.theme[oTheme.id].displayName = '';
+                oSettings.ranges.theme[oTheme.id].displayName = "";
                 oSettings.ranges.theme[oTheme.id].themeRoot = oTheme.root;
             }
         };
@@ -391,9 +391,9 @@ sap.ui.define([
          */
         this.setThemeSet = function (sNewThemeSet) {
             if (this.isSetThemePermitted() === false) {
-                const sErrorMsg = "setThemeSet is not permitted";
-                Log.error(sErrorMsg);
-                throw new Error(sErrorMsg);
+                const sErrorMessage = "setThemeSet is not permitted";
+                Log.error(sErrorMessage);
+                throw new Error(sErrorMessage);
             }
 
             if (sNewThemeSet !== sCurrentThemeSet) {
@@ -441,9 +441,9 @@ sap.ui.define([
          */
         this.setAccessibilityMode = function (bAccessibility) {
             if (this.isSetAccessibilityPermitted() === false) {
-                const sErrorMsg = "setAccessibilityMode not permitted";
-                Log.error(sErrorMsg);
-                throw new Error(sErrorMsg);
+                const sErrorMessage = "setAccessibilityMode not permitted";
+                Log.error(sErrorMessage);
+                throw new Error(sErrorMessage);
             }
 
             oSettings.accessibility = bAccessibility;
@@ -501,9 +501,9 @@ sap.ui.define([
          */
         this.setContentDensity = function (sContentDensity) {
             if (this.isSetContentDensityPermitted() === false) {
-                const sErrorMsg = "setContentDensity not permitted";
-                Log.error(sErrorMsg);
-                throw new Error(sErrorMsg);
+                const sErrorMessage = "setContentDensity not permitted";
+                Log.error(sErrorMessage);
+                throw new Error(sErrorMessage);
             }
             Log.debug("[000] setContentDensity", sContentDensity, "User");
             this.setChangedProperties({
@@ -730,9 +730,9 @@ sap.ui.define([
          */
         this.setTheme = function (sNewTheme) {
             if (this.isSetThemePermitted() === false) {
-                const sErrorMsg = "setTheme not permitted";
-                Log.error(sErrorMsg);
-                throw new Error(sErrorMsg);
+                const sErrorMessage = "setTheme not permitted";
+                Log.error(sErrorMessage);
+                throw new Error(sErrorMessage);
             }
 
             oCurrentTheme = this._amendTheme({
@@ -757,7 +757,6 @@ sap.ui.define([
             - setTheme is more a "updateThemeId()" on the user
             - The consumer of User.setTheme() would have to call "setTheme" also on the ThemeHandler to make it active (User object could only store data)
 
-
             */
         };
 

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

@@ -447,7 +447,7 @@ sap.ui.define([
             if (sLoggingQueue) {
                 try {
                     aQueue = JSON.parse(sLoggingQueue);
-                } catch (e) {
+                } catch {
                     // ignore cases where its not a valid JSON
                 }
             }
@@ -504,7 +504,7 @@ sap.ui.define([
             let sReturnedValue = null;
             try {
                 sReturnedValue = sessionStorage.getItem(key);
-            } catch (err) {
+            } catch {
                 // continue regardless of error
             }
             return sReturnedValue;
@@ -520,7 +520,7 @@ sap.ui.define([
         _putInSessionStorage: function (key, value) {
             try {
                 sessionStorage.setItem(key, value);
-            } catch (err) {
+            } catch {
                 // continue regardless of error
             }
         }

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

@@ -25,13 +25,32 @@ sap.ui.define([
         return sKey;
     }
 
+    function AppVariantAdapterContainer (sContainerKey, oService, oScope, sAppName) {
+        this._oService = oService;
+        this._oScope = oScope;
+
+        this._sAppVarId = oScope.appVarId;
+        this._sAppVersion = oScope.appVersion;
+        this._oComponent = oScope.component;
+
+        this._sContainerKey = rectifyKey(sContainerKey);
+        this._sAppName = sAppName || "";
+
+        // Determine category resulting out of possible scope flag combinations
+        this._category = this._determineCategory(oScope);
+
+        this._aJSONContainer = [];
+        this._oChangedKeys = {};
+        this._oDeletedKeys = {};
+    }
+
     AppVariantAdapterContainer.prototype._determineCategory = function (oScope) {
         if (!oScope) {
             return "U";
         }
         if (oScope.keyCategory && oScope.keyCategory === oConstants.keyCategory.FIXED_KEY &&
-                oScope.writeFrequency && oScope.writeFrequency === oConstants.writeFrequency.LOW &&
-                    oScope.clientStorageAllowed && oScope.clientStorageAllowed === true) {
+            oScope.writeFrequency && oScope.writeFrequency === oConstants.writeFrequency.LOW &&
+            oScope.clientStorageAllowed && oScope.clientStorageAllowed === true) {
             return "P";
         }
         return "U";
@@ -53,25 +72,6 @@ sap.ui.define([
         };
     };
 
-    function AppVariantAdapterContainer (sContainerKey, oService, oScope, sAppName) {
-        this._oService = oService;
-        this._oScope = oScope;
-
-        this._sAppVarId = oScope.appVarId;
-        this._sAppVersion = oScope.appVersion;
-        this._oComponent = oScope.component;
-
-        this._sContainerKey = rectifyKey(sContainerKey);
-        this._sAppName = sAppName || "";
-
-        // Determine category resulting out of possible scope flag combinations
-        this._category = this._determineCategory(oScope);
-
-        this._aJSONContainer = [];
-        this._oChangedKeys = {};
-        this._oDeletedKeys = {};
-    }
-
     /**
      * Resets the container item values to initial (retaining key, validity, etc!)
      */
@@ -95,11 +95,11 @@ sap.ui.define([
                 this._aJSONContainer = oContainer || [];
                 oDeferred.resolve(oContainer);
             })
-            .catch((sErrorMessage) => {
-                Log.warning(sErrorMessage);
+            .catch((oError) => {
+                Log.warning("Failed to load personalization container", oError);
                 // load errors are ok (at least 404), return empty(!) container
                 this._reset();
-                oDeferred.reject(sErrorMessage);
+                oDeferred.reject(oError);
             });
 
         return oDeferred.promise();
@@ -126,13 +126,15 @@ sap.ui.define([
                     itemName: sItemKey
                 }));
             }, this);
-            Promise.all(aPromises).then((oResult) => {
-                this._oChangedKeys = {};
-                this._oDeletedKeys = {};
-                oDeferred.resolve();
-            }, (oError) => {
-                oDeferred.reject(oError);
-            });
+            Promise.all(aPromises)
+                .then((oResult) => {
+                    this._oChangedKeys = {};
+                    this._oDeletedKeys = {};
+                    oDeferred.resolve();
+                })
+                .catch((oError) => {
+                    oDeferred.reject(oError);
+                });
         });
 
         return oDeferred.promise();
@@ -151,11 +153,13 @@ sap.ui.define([
                             itemName: oItem.itemName
                         }));
                     }, this);
-                    Promise.all(aPromises).then((oResult) => {
-                        oDeferred.resolve();
-                    }, (oError) => {
-                        oDeferred.reject(oError);
-                    });
+                    Promise.all(aPromises)
+                        .then((oResult) => {
+                            oDeferred.resolve();
+                        })
+                        .catch((oError) => {
+                            oDeferred.reject(oError);
+                        });
                 });
         });
 
@@ -181,6 +185,11 @@ sap.ui.define([
 
     /**
      * Find item index by internal true key
+     * @param {string} sItemId the item name
+     * @param {string} sCategory the category of the item (I for item, V for variant)
+     * @returns {int} index of the item in the container, or undefined if not found
+     *
+     * @private
      */
     AppVariantAdapterContainer.prototype._findItemIndex = function (sItemId, sCategory) {
         let i;
@@ -189,14 +198,14 @@ sap.ui.define([
                 return i;
             }
         }
-        return undefined;
     };
 
     /**
      * Locates an item for the key sItemKey which is prefixed by the type,
-     * returns  { index : nr,  TrueItemKey : truekey,  containerProperty : }
      * either trueKey xor containerProperty is set.
      * index is filled iff it is a present item
+     * @param {string} sItemKey the item key to locate
+     * @returns {{ index: int, trueItemKey: string, category: string }} The search result.
      */
     AppVariantAdapterContainer.prototype._locateItem = function (sItemKey) {
         const res = { index: -1};
@@ -228,8 +237,10 @@ sap.ui.define([
     };
 
     /**
-     * set oItemValue under sItemKey
-     * returns undefined
+     * Set item value for the key sItemKey.
+     * If the item is not yet present, it will be created.
+     * @param {string} sItemKey the item key to set
+     * @param {object} oItemValue the value to set for the item
      */
     AppVariantAdapterContainer.prototype.setItemValue = function (sItemKey, oItemValue) {
         const oItemRef = this._locateItem(sItemKey);
@@ -254,18 +265,18 @@ sap.ui.define([
     };
 
     /**
-     * delete (1st) item with key sItemKey
+     * delete the (1st) item with key sItemKey
+     * @param {string} sItemKey the item key to delete
      */
     AppVariantAdapterContainer.prototype.delItem = function (sItemKey) {
         const oItemRef = this._locateItem(sItemKey);
         if (oItemRef.index >= 0) {
             this._aJSONContainer.splice(oItemRef.index, 1);
             this._oDeletedKeys[oItemRef.trueItemKey] = true;
-            return;
         }
     };
 
-    const AppVariantPersonalizationAdapter = function () {};
+    function AppVariantPersonalizationAdapter () {}
 
     AppVariantPersonalizationAdapter.prototype.getAdapterContainer = function (sContainerKey, oScope, sAppName) {
         return new AppVariantAdapterContainer(sContainerKey, this, oScope, sAppName);

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.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/util/Version",
@@ -110,8 +110,9 @@ sap.ui.define([
                             const aInbounds = oUtilsCdm.formatSite(oSite) || [];
                             that._getInboundsDeferred.resolve(aInbounds);
                         });
-                    }, (oErr) => {
-                        that._getInboundsDeferred.reject(oErr);
+                    })
+                    .catch((oError) => {
+                        that._getInboundsDeferred.reject(oError);
                     });
             }
 
@@ -150,8 +151,9 @@ sap.ui.define([
                         });
 
                         that.oSystemAliasesDeferred.resolve(oSystemAliases);
-                    }, (oErr) => {
-                        that.oSystemAliasesDeferred.reject(oErr);
+                    })
+                    .catch((oError) => {
+                        that.oSystemAliasesDeferred.reject(oError);
                     });
             }
 
@@ -232,9 +234,9 @@ sap.ui.define([
                     "The system alias cannot be found in the site response",
                     "sap.ushell.adapters.cdm.ClientSideTargetResolutionAdapter"
                 );
-                oDeferred.reject(sMessage);
-            }).fail((oErr) => {
-                oDeferred.reject(oErr);
+                oDeferred.reject(new Error(sMessage));
+            }).fail((oError) => {
+                oDeferred.reject(oError);
             });
 
             return oDeferred.promise();
@@ -265,8 +267,9 @@ sap.ui.define([
                             oLookup = fnDeepExtend({}, oSite.contentProviderDataOrigins);
                         }
                         that.oContentProviderDataOriginsDeferred.resolve(oLookup);
-                    }, (oErr) => {
-                        that.oContentProviderDataOriginsDeferred.reject(oErr);
+                    })
+                    .catch((oError) => {
+                        that.oContentProviderDataOriginsDeferred.reject(oError);
                     });
             }
 

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.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -67,8 +67,7 @@ sap.ui.define([
         const oSiteDataRequestDeferred = new jQuery.Deferred();
 
         if (!sUrl) {
-            return oSiteDataRequestDeferred.reject(
-                "Cannot load site: configuration property 'siteDataUrl' is missing for CommonDataModelAdapter.");
+            return oSiteDataRequestDeferred.reject(new Error("Cannot load site: configuration property 'siteDataUrl' is missing for CommonDataModelAdapter."));
         }
 
         jQuery.ajax({
@@ -79,7 +78,7 @@ sap.ui.define([
             oSiteDataRequestDeferred.resolve(oResponseData);
         }).fail((oError) => {
             Log.error(oError.responseText);
-            oSiteDataRequestDeferred.reject("CDM Site was requested but could not be loaded.");
+            oSiteDataRequestDeferred.reject(new Error("CDM Site was requested but could not be loaded."));
         });
 
         return oSiteDataRequestDeferred.promise();
@@ -129,8 +128,8 @@ sap.ui.define([
 
             delete oSiteWithoutPers.personalization;
             oDeferred.resolve(oSiteWithoutPers);
-        }).fail((sMessage) => {
-            oDeferred.reject(sMessage);
+        }).fail((oError) => {
+            oDeferred.reject(oError);
         });
 
         return oDeferred.promise();
@@ -175,12 +174,12 @@ sap.ui.define([
                         }
                         oDeferred.resolve(oPersonalizationData);
                     })
-                    .fail((sMessage) => {
-                        oDeferred.reject(sMessage);
+                    .fail((oError) => {
+                        oDeferred.reject(oError);
                     });
             }
-        }).fail((sMessage) => {
-            oDeferred.reject(sMessage);
+        }).fail((oError) => {
+            oDeferred.reject(oError);
         });
 
         return oDeferred.promise();
@@ -254,8 +253,9 @@ sap.ui.define([
                     Log.info("Personalization data has been stored successfully.");
                     oPersonalizationDeferred.resolve();
                 })
-                .catch(() => {
-                    oPersonalizationDeferred.reject("Writing personalization data failed.");
+                .catch((oError) => {
+                    Log.error("Writing personalization data failed.", oError);
+                    oPersonalizationDeferred.reject(oError);
                 });
         });
 
@@ -303,8 +303,9 @@ sap.ui.define([
                 .then((oPersonalizationData) => {
                     oPersonalizationDeferred.resolve(oPersonalizationData || {});
                 })
-                .catch(() => {
-                    oPersonalizationDeferred.reject("Fetching personalization data failed.");
+                .catch((oError) => {
+                    Log.error("Fetching personalization data failed.", oError);
+                    oPersonalizationDeferred.reject(oError);
                 });
         });
         return oPersonalizationDeferred.promise();

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

@@ -3,7 +3,7 @@
 /**
  * @fileOverview The ConfigurationDefaults adapter for the CDM platform.
  *
- * @version 1.139.0
+ * @version 1.141.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.139.0
+ * @version 1.141.0
  */
 sap.ui.define([
     "sap/base/Log",
@@ -399,7 +399,7 @@ sap.ui.define([
                             "X-CSRF-Token": "Fetch"
                         }
                     });
-                } catch (error) {
+                } catch (oError) {
                     bError = true;
                 }
 
@@ -432,7 +432,7 @@ sap.ui.define([
 
                     const sLogoutRedirectUrl = await responseLogout.text();
                     this._setWindowLocation(sLogoutRedirectUrl);
-                } catch (error) {
+                } catch (oError) {
                     bError = true;
                 }