@sapui5/sap.ushell 1.120.7 → 1.121.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.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ushell/services/appstate/AppStatePersistencyMethod",
@@ -15,17 +15,18 @@ sap.ui.define([
     "use strict";
 
     /**
+     * @class
+     * @classdesc The Unified Shell's personalization adapter for the local platform.
+     *
      * This method MUST be called by the Unified Shell's personalization service only.
      * Constructs a new instance of the personalization adapter for the local
      * platform.
      *
-     * @param {object}
-     *            oSystem the system served by the adapter
-     * @param {string} sParameters
-     *            Parameter string, not in use
-     * @param {object} oConfig
-     *            a potential Adapter Configuration
-     * @class The Unified Shell's personalization adapter for the local platform.
+     * @param {sap.ushell.System} oSystem the system served by the adapter
+     * @param {string} sParameters Parameter string, not in use
+     * @param {object} oConfig a potential Adapter Configuration
+     *
+     * @hideconstructor
      *
      * @since 1.28.0
      * @private
@@ -58,12 +59,10 @@ sap.ui.define([
      *            sComponent a 24 character string representing the application component,
      *            (A sap support component)
      *            may be undefined if not available on the client
-     * @returns {object} promise
-     *  A promise, done handler empty args
-     *  fail handler sMsg argument
+     * @returns {jQuery.Promise} Resolves once the app state was saved or rejects with an error message.
      * @private
      */
-    AppStateAdapter.prototype.saveAppState = function (sKey, sSessionKey, sValue, sAppname, sComponent, iPersistencyMethod, oPersistencySettings) {
+    AppStateAdapter.prototype.saveAppState = function (sKey, sSessionKey, sValue, sAppName, sComponent, iPersistencyMethod, oPersistencySettings) {
         var oDeferred = new jQuery.Deferred();
 
         this._getPersonalizationService().then(function (oPersonalizationService) {
@@ -99,9 +98,7 @@ sap.ui.define([
      *            (less than 40 characters)
      * @param {string} sValue
      *            the value to persist under the given key
-     * @returns {object} promise
-     *  A promise, done handler function(sKey, sValue)
-     *  fail handler function(sMsg) argument
+     * @returns {jQuery.Promise} Resolves with key and value or rejects with an error message.
      * @private
      */
     AppStateAdapter.prototype.loadAppState = function (sKey) {
@@ -144,9 +141,7 @@ sap.ui.define([
      * @param {string} sKey
      *            the Key value of the Application state to delete,
      *            (less than 40 characters)
-     * @returns {object} promise
-     *  A promise, done handler function(true/false)
-     *  fail handler function(sMsg) argument
+     * @returns {jQuery.Promise} Resolves once the app state was deleted or rejects with an error message.
      * @since 1.69.0
      * @private
      */
@@ -180,7 +175,7 @@ sap.ui.define([
 
     /**
      * This function returns an array of all the supported persistence method
-     * @returns {Array}
+     * @returns {string[]}
      *  An Array that contains all the supported persistence method
      * @since 1.67
      * @private

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.120.7
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/ui/thirdparty/jquery",
@@ -130,8 +130,7 @@ sap.ui.define([
     /**
      * Produces a list of Inbounds suitable for ClientSideTargetResolution.
      *
-     * @returns {jQuery.Deferred.Promise}
-     *   a jQuery promise that resolves to an array of Inbounds in
+     * @returns {jQuery.Promise} Resolves to an array of Inbounds in
      *   ClientSideTargetResolution format.
      *
      * @private
@@ -153,37 +152,36 @@ sap.ui.define([
      * @param {string} sSystemAlias
      *    the system alias name to be resolved
      *
-     * @returns {jQuery.Deferred.Promise}
-     *    a jQuery promise that resolves to an object containing the resolution result
+     * @returns {jQuery.Promise} Resolves to an object containing the resolution result
      *    as described in the constructor's doc. If the alias could not be resolved an
      *    empty object is returned. The promise is never rejected.
      *
      * @private
      */
     ClientSideTargetResolutionAdapter.prototype.resolveSystemAlias = function (sSystemAlias) {
-            var oDeferred = new jQuery.Deferred();
+        var oDeferred = new jQuery.Deferred();
 
-            setTimeout(function () {
-                if (this._oSystemAliases.hasOwnProperty(sSystemAlias)) {
-                    oDeferred.resolve(this._oSystemAliases[sSystemAlias]);
+        setTimeout(function () {
+            if (this._oSystemAliases.hasOwnProperty(sSystemAlias)) {
+                oDeferred.resolve(this._oSystemAliases[sSystemAlias]);
 
-                } else if (sSystemAlias === "") {
-                    oDeferred.resolve(this._oLocalSystemAlias);
+            } else if (sSystemAlias === "") {
+                oDeferred.resolve(this._oLocalSystemAlias);
 
-                } else {
-                    oDeferred.reject("No system alias value available");
-                }
+            } else {
+                oDeferred.reject("No system alias value available");
+            }
 
-            }.bind(this), 0);
-            return oDeferred.promise();
-        };
+        }.bind(this), 0);
+        return oDeferred.promise();
+    };
 
     /**
      * Transforms the old applications format to Inbounds.
      *
      * @param {object} oApplications
-     *   old appplications format
-     * @returns {array}
+     *   old applications format
+     * @returns {object[]}
      *   Inbounds
      *
      * @private
@@ -271,7 +269,7 @@ sap.ui.define([
      *
      * @param {object} oInbounds
      *   Inbounds as an object
-     * @returns {array}
+     * @returns {object[]}
      *   Inbounds as an array
      *
      * @private

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

@@ -2,29 +2,20 @@
 /**
  * @fileOverview The Unified Shell's container adapter for standalone demos.
  *
- * @version 1.120.7
- */
-/**
- * @namespace Default namespace for Unified Shell adapters for standalone demos. They can usually
- * be placed directly into this namespace, e.g.
- * <code>sap.ushell.adapters.local.ContainerAdapter</code>.
- *
- * @name sap.ushell.adapters.local
- * @see sap.ushell.adapters.local.ContainerAdapter
- * @since 1.15.0
+ * @version 1.121.0
  */
 sap.ui.define([
     "sap/base/Log",
+    "sap/base/i18n/Localization",
     "sap/base/util/ObjectPath",
-    "sap/ui/core/Configuration",
     "sap/ui/thirdparty/jquery",
     "sap/ushell/System",
     "sap/ushell/User",
     "sap/ushell/utils"
 ], function (
     Log,
+    Localization,
     ObjectPath,
-    Configuration,
     jQuery,
     System,
     User,
@@ -33,16 +24,32 @@ sap.ui.define([
     "use strict";
 
     /**
+     * @namespace sap.ushell.adapters.local
+     * @description Default namespace for Unified Shell adapters for standalone demos. They can usually
+     * be placed directly into this namespace, e.g.
+     * <code>sap.ushell.adapters.local.ContainerAdapter</code>.
+     *
+     * @see sap.ushell.adapters.local.ContainerAdapter
+     * @since 1.15.0
+     */
+
+    /**
+     * @class
+     * @classdesc The Unified Shell's container adapter which does the bootstrap for standalone demos.
+     *
      * This method MUST be called by the Unified Shell's container only, others MUST call
      * <code>sap.ushell.services.initializeContainer("local")</code>.
      * Constructs a new instance of the container adapter for standalone demos.
      *
-     * @param {sap.ushell.System} oSystem
-     *     the logon system (alias, platform, base URL)
+     * @param {sap.ushell.System} oSystem the logon system (alias, platform, base URL)
+     * @param {string} sParameter Parameter string, not in use
+     * @param {object} oAdapterConfiguration the Adapter Configuration
+     *
+     * @hideconstructor
      *
-     * @class The Unified Shell's container adapter which does the bootstrap for standalone demos.
      * @see sap.ushell.services.initializeContainer
      * @since 1.15.0
+     * @private
      */
     var ContainerAdapter = function (oSystem, sParameter, oAdapterConfiguration) {
         var oUser;
@@ -55,7 +62,7 @@ sap.ui.define([
             fullName: "Default User",
             accessibility: false,
             isJamActive: false,
-            language: Configuration.getLanguage() || "en",
+            language: Localization.getLanguage() || "en",
             bootTheme: {
                 theme: "sap_horizon",
                 root: ""
@@ -121,7 +128,7 @@ sap.ui.define([
         /**
          * Does the bootstrap for the demo platform (and loads the container's configuration).
          *
-         * @returns {jQuery.Deferred}
+         * @returns {jQuery.Promise}
          *     a promise that is resolved once the bootstrap is done
          *
          * @since 1.15.0
@@ -167,7 +174,7 @@ sap.ui.define([
          *
          * @param {boolean} bLogonSystem
          *      <code>true</code> if this system is the logon system
-         * @returns {jQuery.Deferred}
+         * @returns {jQuery.Promise}
          *      a <code>jQuery.Deferred</code> object's promise to be resolved when logout is
          *      finished, even when it failed
          * @since 1.15.0