@sapui5/sap.ushell 1.120.8 → 1.121.0

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

@@ -1,13 +1,26 @@
 // Copyright (c) 2009-2023 SAP SE, All Rights Reserved
 
 /**
- * @namespace Default namespace for Unified Shell services.
- * @name sap.ushell.services
- * @see sap.ushell.Container.getServiceAsync()
+ * @namespace sap.ushell.services
+ * @description Default namespace for Unified Shell services.
+ * @see sap.ushell.Container.getServiceAsync
  * @since 1.15.0
  * @public
  */
 
+/**
+ * @name sap.ushell.services.Service
+ * @class
+ * @classdesc Abstract base class for ushell services. For details, see {@link sap.ushell.Container#getServiceAsync}.
+ *
+ * @hideconstructor
+ * @abstract
+ *
+ * @see sap.ushell.Container.getServiceAsync
+ * @since 1.121.0
+ * @public
+ */
+
 /**
  * An enumeration for the application work protect mode state.
  * @typedef {object} sap.ushell.Container.DirtyState
@@ -28,7 +41,7 @@ sap.ui.define([
     "sap/base/util/uid",
     "sap/ui/base/EventProvider",
     "sap/ui/core/Control",
-    "sap/ui/core/Core",
+    "sap/ui/core/EventBus",
     "sap/ui/core/service/ServiceFactoryRegistry",
     "sap/ui/performance/Measurement",
     "sap/ui/thirdparty/jquery",
@@ -40,7 +53,8 @@ sap.ui.define([
     "sap/ushell/utils",
     "sap/ushell/utils/UrlParsing",
     "sap/ushell/renderer/ShellLayout",
-    "sap/base/util/Deferred"
+    "sap/base/util/Deferred",
+    "sap/base/util/ObjectPath"
 ], function (
     assert,
     Log,
@@ -49,7 +63,7 @@ sap.ui.define([
     uid,
     EventProvider,
     Control,
-    Core,
+    EventBus,
     ServiceFactoryRegistry,
     Measurement,
     jQuery,
@@ -61,13 +75,14 @@ sap.ui.define([
     ushellUtils,
     UrlParsing,
     ShellLayout,
-    Deferred
+    Deferred,
+    ObjectPath
 ) {
     "use strict";
 
     /* global OData */
 
-    var S_COMPONENT_NAME = "sap.ushell.services.Container";
+    var S_COMPONENT_NAME = "sap.ushell.Container";
     var S_DIRTY_STATE_PREFIX = "sap.ushell.Container.dirtyState.";
     // The configuration as read from window["sap-ushell-config"]
     var oConfigSetting = {};
@@ -140,14 +155,14 @@ sap.ui.define([
         var oAdapterConfig = getServiceConfig(sName).adapter || {};
         var sAdapterName;
 
-        async function getAdapterInstanceAsync (AdapterModule) {
+        async function getAdapterInstance (AdapterModule) {
             let AdapterClass;
             try {
                 [AdapterClass] = await ushellUtils.requireAsync([AdapterModule]);
             } catch (oError) {
                 if (AdapterModule.endsWith("PersonalizationV2Adapter")) {
                     const sNewAdapterModule = AdapterModule.replace("PersonalizationV2Adapter", "PersonalizationAdapter");
-                    return getAdapterInstanceAsync(sNewAdapterModule);
+                    return getAdapterInstance(sNewAdapterModule);
                 }
                 throw oError;
             }
@@ -165,48 +180,47 @@ sap.ui.define([
         }
 
         var sModule = sAdapterName.replace(/\./g, "/");
-        if (bAsync) {
-            return getAdapterInstanceAsync(sModule);
-        }
 
         /**
          * @deprecated As of version 1.100
          * @private
          */
-        return (function () {
-            function getAdapterInstance (AdapterModule) {
-                var AdapterClass;
-                try {
-                    AdapterClass = sap.ui.requireSync(AdapterModule); // LEGACY API (deprecated)
-                } catch (oError) {
-                    if (AdapterModule.endsWith("PersonalizationV2Adapter")) {
-                        const sNewAdapterModule = AdapterModule.replace("PersonalizationV2Adapter", "PersonalizationAdapter");
-                        AdapterClass = sap.ui.requireSync(sNewAdapterModule); // LEGACY API (deprecated)
-                    } else {
-                        throw oError;
-                    }
+        function getAdapterInstanceSync (AdapterModule) {
+            var AdapterClass;
+            try {
+                AdapterClass = sap.ui.requireSync(AdapterModule); // LEGACY API (deprecated)
+            } catch (oError) {
+                if (AdapterModule.endsWith("PersonalizationV2Adapter")) {
+                    const sNewAdapterModule = AdapterModule.replace("PersonalizationV2Adapter", "PersonalizationAdapter");
+                    AdapterClass = sap.ui.requireSync(sNewAdapterModule); // LEGACY API (deprecated)
+                } else {
+                    throw oError;
                 }
-                return new AdapterClass(oSystem, sParameter,
-                    { config: oAdapterConfig.config || {} }
-                );
             }
-            return getAdapterInstance(sModule);
-        })();
+            return new AdapterClass(oSystem, sParameter,
+                { config: oAdapterConfig.config || {} }
+            );
+        }
+
+        /**
+         * @deprecated As of version 1.100
+         * @private
+         */
+        if (!bAsync) {
+            return getAdapterInstanceSync(sModule);
+        }
+        return getAdapterInstance(sModule);
     }
 
     /**
-     * @class
      * @alias sap.ushell.Container
-     * @classdesc The Unified Shell's container.
-     * Manages renderers, services, and adapters.
+     * @namespace
+     * @description The Unified Shell's container. Manages renderers, services, and adapters.
      * The container is designed to be a singleton, therefore instead of creating an instance, access the central one via <code>sap.ushell.Container</code>.
      *
      * @see sap.ushell.bootstrap
      * @since 1.15.0
      * @public
-     *
-     * @hideconstructor
-     * @param {object} oAdapter the platform-specific adapter corresponding to this service
      */
     function Container () {
         var oEventProvider = new EventProvider();
@@ -228,8 +242,16 @@ sap.ui.define([
 
         var oContainerReadyDeferred = new Deferred();
 
+        /**
+         * @param {string} sPlatform The platform to initialize
+         * @param {object} mAdapterPackagesByPlatform The adapters
+         * @returns {Promise} Resolves once the container is initialized
+         *
+         * @private
+         * @alias sap.ushell.Container#init
+         */
         this.init = function (sPlatform, mAdapterPackagesByPlatform) {
-            sap.ushell.Container = oContainerInstance;
+            ObjectPath.set("sap.ushell.Container", oContainerInstance);
             return this._init(sPlatform, mAdapterPackagesByPlatform)
                 .then(function (oCreatedAdapter) {
                     oAdapter = oCreatedAdapter;
@@ -244,6 +266,21 @@ sap.ui.define([
                 });
         };
 
+        /**
+         * @returns {boolean} Whether the container is initialized
+         *
+         * *Note*: ONLY for ushell-internal use!
+         * This API must not be used by any consumer outside ushell lib.
+         *
+         * Other SAP-internal consumers can use ready() on request (after
+         * the consuming lib has been added to the restriced list) when
+         * they need a definite trigger to run code after FLP's bootstrap.
+         * Besides that, sap.ui.require("sap/ushell/Container") (Container proping)
+         * should be used to identify if a FLP environment has been launched, i.e. if
+         * an app is running stand-alone or hosted in a Fiori launchpad.
+         *
+         * @private
+         */
         this.isInitialized = function () {
             return bInitialized;
         };
@@ -256,8 +293,9 @@ sap.ui.define([
          *
          * @since 1.21.2
          * @public
-         * @see sap.ushell.services.Container#setLogonFrameProvider
+         * @see sap.ushell.Container#setLogonFrameProvider
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#cancelLogon
          */
         this.cancelLogon = function () {
             if (this.oFrameLogonManager) {
@@ -292,6 +330,7 @@ sap.ui.define([
          * @since 1.15.0
          * @public
          * @deprecated since 1.120.0
+         * @alias sap.ushell.Container#createRenderer
          */
         this.createRenderer = function (sRendererName, bAsync) {
             // shift params if necessary
@@ -310,7 +349,7 @@ sap.ui.define([
             if (!sRendererName) {
                 throw new Error("Missing renderer name");
             }
-            oRendererConfig = (oConfig.renderers && oConfig.renderers[sRendererName]) || {};
+            oRendererConfig = (oConfig && oConfig.renderers && oConfig.renderers[sRendererName]) || {};
             sComponentName = oRendererConfig.module || (sRendererName.indexOf(".") < 0
                 ? "sap.ushell.renderers." + sRendererName + ".Renderer"
                 : sRendererName);
@@ -465,9 +504,11 @@ sap.ui.define([
          * @param {string} [sRendererName] The renderer name, such as "standard" or "acme.foo.bar.MyRenderer";
          *   it is taken from the configuration property <code>defaultRenderer</code> if not given here.
          *
-         * @returns {sap.ui.core.Control|Promise<sap.ui.core.Control>|sap.ui.core.ComponentContainer|Promise<sap.ui.core.ComponentContainer>} the renderer or Promise (in asynchronous mode)
+         * @returns {Promise<sap.ui.core.Control>|Promise<sap.ui.core.ComponentContainer>} the renderer or Promise (in asynchronous mode)
+         *
          * @since 1.120.0
          * @private
+         * @alias sap.ushell.Container#createRendererInternal
          */
         this.createRendererInternal = async function (sRendererName) {
             var oComponentData = { async: true };
@@ -588,9 +629,11 @@ sap.ui.define([
          *   (i.e. extend <code>sap.ui.core.Control</code>) or a UI component (i.e. extend <code>sap.ui.core.UIComponent</code>),
          *   i.e. this method unwraps the renderer component from its <code>sap.ui.core.ComponentContainer</code>;
          *   if no renderer name can be determined and a single renderer instance has been created, this single instance is returned.
+         *
          * @since 1.30.0
          * @public
          * @deprecated since 1.120.0
+         * @alias sap.ushell.Container#getRenderer
          */
         this.getRenderer = function (sRendererName) {
             var oRendererControl;
@@ -629,8 +672,10 @@ sap.ui.define([
          *   (i.e. extend <code>sap.ui.core.Control</code>) or a UI component (i.e. extend <code>sap.ui.core.UIComponent</code>),
          *   i.e. this method unwraps the renderer component from its <code>sap.ui.core.ComponentContainer</code>;
          *   if no renderer name can be determined and a single renderer instance has been created, this single instance is returned.
+         *
          * @since 1.120.0
          * @private
+         * @alias sap.ushell.Container#getRendererInternal
          */
         this.getRendererInternal = function (sRendererName) {
             var oRendererControl;
@@ -663,9 +708,11 @@ sap.ui.define([
         /**
          * An enumeration for the application work protect mode state.
          * @type {sap.ushell.Container.DirtyState}
+         *
          * @since 1.21.1
          * @public
          * @member
+         * @alias sap.ushell.Container#DirtyState
          */
         this.DirtyState = {
             /**
@@ -729,12 +776,13 @@ sap.ui.define([
          *
          * All open UShell browser windows for the same origin are asked about their global dirty state.
          *
-         * @returns {jQuery.Deferred} A <code>jQuery.Deferred</code> object's promise receiving the dirty state
-         *   (see {@link sap.ushell.Container.DirtyState}).
+         * @returns {jQuery.Promise} Resolves the dirty state (see {@link sap.ushell.Container.DirtyState}).
          * @throws  {Error} Raises an exception, if called again before promise is resolved.
+         *
          * @since 1.21.1
          * @public
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#getGlobalDirty
          */
         this.getGlobalDirty = function () {
             var oDeferred = new jQuery.Deferred();
@@ -844,6 +892,7 @@ sap.ui.define([
          * @since 1.15.0
          * @private
          * @ui5-restricted sap.fl
+         * @alias sap.ushell.Container#getLogonSystem
          */
         this.getLogonSystem = function () {
             if (!oAdapter) {
@@ -860,6 +909,7 @@ sap.ui.define([
          * @since 1.120.0
          * @private
          * @ui5-restricted sap.fl
+         * @alias sap.ushell.Container#ready
          */
         this.ready = function () {
             return oContainerReadyDeferred.promise;
@@ -869,8 +919,10 @@ sap.ui.define([
          * Returns the logged-in user.
          *
          * @returns {sap.ushell.User} object providing information about the logged-in user
+         *
          * @since 1.15.0
          * @private
+         * @alias sap.ushell.Container#getUser
          */
         this.getUser = function () {
             return oAdapter.getUser();
@@ -884,15 +936,16 @@ sap.ui.define([
          * However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty
          * state provider methods are ignored and the function simply returns 'true'.
          *
-         * @returns {boolean}
-         *  The value of the dirty flag or the determined dirty state returned by the dirty state providers.
+         * @returns {boolean} The value of the dirty flag or the determined dirty state returned by the dirty state providers.
+         *
          * @since 1.27.0
          * @public
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#getDirtyFlag
          */
         this.getDirtyFlag = function () {
             var bDirty = isDirty; // in case it was set
-            var oNavigationContext = this._oShellNavigationService.getNavigationContext();
+            var oNavigationContext = this._oShellNavigationInternal.getNavigationContext();
             for (var i = 0; i < aRegisteredDirtyMethods.length; i++) {
                 bDirty = bDirty || aRegisteredDirtyMethods[i](oNavigationContext);
             }
@@ -911,13 +964,14 @@ sap.ui.define([
          *
          * @since 1.98.0
          * @private
-        */
+         * @alias sap.ushell.Container#getDirtyFlagsAsync
+         */
         this.getDirtyFlagsAsync = function () {
             if (!this.fnAsyncDirtyStateProvider) {
                 return Promise.resolve(this.getDirtyFlag());
             }
 
-            var oNavigationContext = this._oShellNavigationService.getNavigationContext();
+            var oNavigationContext = this._oShellNavigationInternal.getNavigationContext();
             return this.fnAsyncDirtyStateProvider(oNavigationContext)
                 .then(function (bIsDirty) {
                     return bIsDirty || this.getDirtyFlag();
@@ -931,6 +985,7 @@ sap.ui.define([
          *
          * @since 1.98.0
          * @private
+         * @alias sap.ushell.Container#isAsyncDirtyStateProviderSet
          */
         this.isAsyncDirtyStateProviderSet = function () {
             return typeof this.fnAsyncDirtyStateProvider === "function";
@@ -945,6 +1000,7 @@ sap.ui.define([
          *
          * @since 1.98.0
          * @private
+         * @alias sap.ushell.Container#setAsyncDirtyStateProvider
          */
         this.setAsyncDirtyStateProvider = function (fnAsyncDirtyStateProvider) {
             this.fnAsyncDirtyStateProvider = fnAsyncDirtyStateProvider;
@@ -959,6 +1015,7 @@ sap.ui.define([
          * @default false
          * @since 1.27.0
          * @public
+         * @alias sap.ushell.Container#setDirtyFlag
          */
         this.setDirtyFlag = function (bIsDirty) {
             isDirty = bIsDirty;
@@ -969,6 +1026,7 @@ sap.ui.define([
          *
          * @since 1.48.0
          * @private
+         * @alias sap.ushell.Container#sessionKeepAlive
          */
         this.sessionKeepAlive = function () {
             if (oAdapter.sessionKeepAlive) {
@@ -981,6 +1039,7 @@ sap.ui.define([
          *
          * @since 1.96.0
          * @private
+         * @alias sap.ushell.Container#extendSession
          */
         this.extendSession = function () {
             EventHub.emit("nwbcUserIsActive", Date.now());
@@ -1009,6 +1068,7 @@ sap.ui.define([
          *
          * @since 1.31.0
          * @public
+         * @alias sap.ushell.Container#registerDirtyStateProvider
          */
         this.registerDirtyStateProvider = function (fnDirty) {
             if (typeof fnDirty !== "function") {
@@ -1023,8 +1083,10 @@ sap.ui.define([
          * Only the last registered function will be deregistered (in case it was registered multiple times).
          *
          * @param {function(): boolean} fnDirty function for determining the state of the application
+         *
          * @since 1.67.0
          * @public
+         * @alias sap.ushell.Container#deregisterDirtyStateProvider
          */
         this.deregisterDirtyStateProvider = function (fnDirty) {
             if (typeof fnDirty !== "function") {
@@ -1100,11 +1162,12 @@ sap.ui.define([
          * Note that the api will throw a runtime error (or reject for async mode)
          * if the service name does not reflect a service available.
          *
+         * @template {sap.ushell.services.Service} ServiceType
          * @param {string} sServiceName The service name, such as "Menu"
          * @param {string} [sParameter] A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
          * @param {boolean} [bAsync] if true, the adapter is loaded asynchronously and a Promise is returned. (since 1.55.0)
          *
-         * @returns {object|Promise<object>} the service or, in asynchronous mode, a Promise that returns the service
+         * @returns {ServiceType|Promise<ServiceType>} the service or, in asynchronous mode, a Promise that returns the service
          *
          * @throws {Error} If <code>sServiceName</code> is not the name of an available service.
          *
@@ -1113,9 +1176,10 @@ sap.ui.define([
          * @since 1.15.0
          * @deprecated since 1.77. Please use {@link #getServiceAsync} instead.
          * @public
+         * @alias sap.ushell.Container#getService
          */
         this.getService = function (sServiceName, sParameter, bAsync) {
-            return that._getService.apply(that, arguments);
+            return that._getServiceSync.apply(that, arguments);
         };
 
         /**
@@ -1171,17 +1235,20 @@ sap.ui.define([
          * Its adapter is an instance of <code>my.own.FooAdapter</code> constructed with the parameters logon system,
          * "runtimeConfig" and <code>{config: {foo: "bar"}}</code>.
          *
+         * @template {sap.ushell.services.Service} ServiceType
          * @param {string} sServiceName The service name, such as "Menu"
          * @param {string} [sParameter] A parameter which is passed to the service constructor and every adapter constructor.
-         * @returns {Promise<object>} a Promise that returns the requested service
+         * @returns {Promise<ServiceType>} a Promise that returns the requested service
          * @see sap.ushell.services.ContainerInterface
+         *
          * @since 1.55.0
          * @public
+         * @alias sap.ushell.Container#getServiceAsync
          */
         this.getServiceAsync = function (sServiceName, sParameter) {
             // Some applications override .getService and the async flag is ignored then.
             // Wrap into Promise.resolve to make sure that a Promise is always returned
-            return that._getService(sServiceName, sParameter, true);
+            return that._getServiceAsync(sServiceName, sParameter);
         };
 
         /**
@@ -1190,15 +1257,16 @@ sap.ui.define([
          * @param {boolean} [bAsync] If true, the adapter is loaded asynchronously and a Promise is returned.
          *
          * @returns {object|Promise} The service or, in asynchronous mode, a Promise that returns the service
-         *
          * @throws {Error} If <code>sServiceName</code> is not the name of an available service.
-         *
          * @see sap.ushell.services.ContainerInterface
          *
-         * @since 1.86
+         *
+         * @deprecated As of version 1.120
+         * @since 1.120
          * @private
+         * @alias sap.ushell.Container#_getServiceSync
          */
-        this._getService = function (sServiceName, sParameter, bAsync) {
+        this._getServiceSync = function (sServiceName, sParameter, bAsync) {
             var oContainerInterface = {};
 
             /**
@@ -1206,10 +1274,10 @@ sap.ui.define([
              * creates a new adapter that corresponds to the service to which this container interface was passed at construction time.
              *
              * @param {sap.ushell.System} oSystem information about the remote system to which the resulting adapter should connect
-             * @returns {jQuery.Deferred} A <code>jQuery.Deferred</code> object's promise receiving the remote adapter.
-             * @memberof sap.ushell.services.ContainerInterface#
-             * @name createAdapter
+             * @returns {jQuery.Promise} Resolves the remote adapter.
+             *
              * @since 1.15.0
+             * @name sap.ushell.services.ContainerInterface#createAdapter
              */
             function createRemoteAdapter (oSystem) {
                 var oDeferred = new jQuery.Deferred();
@@ -1268,32 +1336,31 @@ sap.ui.define([
             }
 
             if (!mServicesByName.containsKey(sKey)) {
-                // extract information about the requested service
-                if (bAsync) {
-                    if (!mServicesByNamePromise.containsKey(sKey)) {
-                        var oServicePromise = new Promise(function (resolve, reject) {
-                            sap.ui.require([sModuleName.replace(/[.]/g, "/")], function (ServiceClass) {
-                                resolve(getServiceInstance(ServiceClass, true));
-                            }, reject);
-                        });
-                        mServicesByNamePromise.put(sKey, oServicePromise);
-                        return oServicePromise;
-                    }
-                    return mServicesByNamePromise.get(sKey);
-                }
                 /**
                  * @deprecated As of version 1.100
                  * @private
                  */
-                (function () {
+                if (!bAsync) {
                     // else - synchronous call
                     Log.error("Deprecated API call of 'sap.ushell.Container.getService'. Please use 'getServiceAsync' instead",
                         null,
-                        "sap.ushell.services.Container"
+                        "sap.ushell.Container"
                     );
                     var Service = sap.ui.requireSync(sModuleName.replace(/[.]/g, "/")); // LEGACY API (deprecated)
                     return getServiceInstance(Service);
-                })();
+                }
+
+                // extract information about the requested service
+                if (!mServicesByNamePromise.containsKey(sKey)) {
+                    var oServicePromise = new Promise(function (resolve, reject) {
+                        sap.ui.require([sModuleName.replace(/[.]/g, "/")], function (ServiceClass) {
+                            resolve(getServiceInstance(ServiceClass, true));
+                        }, reject);
+                    });
+                    mServicesByNamePromise.put(sKey, oServicePromise);
+                    return oServicePromise;
+                }
+                return mServicesByNamePromise.get(sKey);
             }
             if (bAsync) {
                 // If the service was first called sync and then async, there will be no
@@ -1304,10 +1371,109 @@ sap.ui.define([
             return mServicesByName.get(sKey);
         };
 
+        /**
+         * @param {string} sServiceName The service name, such as "Menu"
+         * @param {string} [sParameter] A parameter which is passed to the service constructor and every adapter constructor. (since 1.15.0)
+         *
+         * @returns {Promise} A Promise that returns the service
+         * @throws {Error} If <code>sServiceName</code> is not the name of an available service.
+         * @see sap.ushell.services.ContainerInterface
+         *
+         * @since 1.120
+         * @private
+         * @alias sap.ushell.Container#_getServiceAsync
+         */
+        this._getServiceAsync = function (sServiceName, sParameter) {
+            var oContainerInterface = {};
+
+            /**
+             * For the given remote system,
+             * creates a new adapter that corresponds to the service to which this container interface was passed at construction time.
+             *
+             * @param {sap.ushell.System} oSystem information about the remote system to which the resulting adapter should connect
+             * @returns {jQuery.Promise} Resolves the remote adapter.
+             *
+             * @since 1.15.0
+             * @name sap.ushell.services.ContainerInterface#createAdapter
+             */
+            function createRemoteAdapter (oSystem) {
+                var oDeferred = new jQuery.Deferred();
+                if (!oSystem) {
+                    throw new Error("Missing system");
+                }
+                // Note: this might become really asynchronous once the remote adapter is loaded
+                // from the remote system itself
+                oDeferred.resolve(createAdapter(sServiceName, oSystem, sParameter));
+                sap.ushell.Container.addRemoteSystem(oSystem);
+                return oDeferred.promise();
+            }
+
+            if (!sServiceName) {
+                throw new Error("Missing service name");
+            }
+            if (sServiceName.indexOf(".") >= 0) {
+                // TODO support this once we have some configuration and can thus find adapters
+                throw new Error("Unsupported service name");
+            }
+            var oServiceConfig = getServiceConfig(sServiceName);
+            var sModuleName = oServiceConfig.module || "sap.ushell.services." + sServiceName;
+            var sKey = sModuleName + "/" + (sParameter || "");
+            var oServiceProperties = { config: oServiceConfig.config || {} };
+
+            function createService (ServiceClass, Adapter) {
+                oContainerInterface.createAdapter = createRemoteAdapter;
+                return new ServiceClass(Adapter, oContainerInterface, sParameter, oServiceProperties);
+            }
+
+            function getServiceInstance (ServiceClass) {
+                var oService;
+
+                // Check again if the service has already been created to prevent re-instantiation during race conditions
+                if (mServicesByName.containsKey(sKey)) {
+                    oService = mServicesByName.get(sKey);
+                } else if (ServiceClass.hasNoAdapter) {
+                    // has no adapter: don't create and don't pass one
+                    oService = new ServiceClass(oContainerInterface, sParameter, oServiceProperties);
+                } else {
+                    // create and pass adapter for logon system as first parameter
+                    var oServiceAdapter = createAdapter(sServiceName, oAdapter.getSystem(),
+                        sParameter, true, ServiceClass.useConfiguredAdapterOnly);
+                        return oServiceAdapter.then(function (serviceAdapter) {
+                            var oServiceInstance = createService(ServiceClass, serviceAdapter);
+                            mServicesByName.put(sKey, oServiceInstance);
+                            return oServiceInstance;
+                        });
+                }
+
+                mServicesByName.put(sKey, oService);
+                return Promise.resolve(oService);
+            }
+
+            if (!mServicesByName.containsKey(sKey)) {
+                // extract information about the requested service
+                if (!mServicesByNamePromise.containsKey(sKey)) {
+                    var oServicePromise = new Promise(function (resolve, reject) {
+                        sap.ui.require([sModuleName.replace(/[.]/g, "/")], function (ServiceClass) {
+                            resolve(getServiceInstance(ServiceClass));
+                        }, reject);
+                    });
+                    mServicesByNamePromise.put(sKey, oServicePromise);
+                    return oServicePromise;
+                }
+                return mServicesByNamePromise.get(sKey);
+
+            }
+            // If the service was first called sync and then async, there will be no
+            // promise in mServicesByNamePromise, so we return wrap mServicesByName
+            // just in case, as that will always contain the service.
+            return Promise.resolve(mServicesByName.get(sKey));
+        };
+
         /**
          * Get list of remote systems currently in use.
          *
-         * @returns {object} map of sap.ushell.System
+         * @returns {Object<string, sap.ushell.System>} map of sap.ushell.System
+         *
          * @since 1.17.1
          * @private
          */
@@ -1347,8 +1513,13 @@ sap.ui.define([
                     setTimeout(fnFailure.bind(null, sErrorMessage), 5000);
                 }
                 // the original APIs provides abort handler which have to be stubbed also
-                return { abort: function () { return; } };
+                return {
+                    abort: function () {
+                        return;
+                    }
+                };
             }
+
             OData.read = function (oRequest, fnSuccess, fnFailure) {
                 return stub("OData.read('" +
                     (oRequest && oRequest.Uri ? oRequest.requestUri : oRequest) +
@@ -1366,30 +1537,32 @@ sap.ui.define([
          * On logout this list is processed and performs a logout for each system via the ContainerAdapter specific for its platform.
          *
          * @param {sap.ushell.System} oRemoteSystem Remote system to be added.
+         *
          * @since 1.15.0
          * @public
+         * @alias sap.ushell.Container#addRemoteSystem
          */
         this.addRemoteSystem = function (oRemoteSystem) {
             /*
-            Internal details
-            oRemoteSystem.getAlias() is the unique key within the remote systems list.
-            oRemoteSystem.getPlatform determines which ContainerAdapter implementation is used.
-            oRemoteSystem.getBaseUrl determines the logout request routing; there are 3 routing modes:
-            1. empty baseUrl:
-                The logout is done with its platform-specific, server-absolute service path e.g.
-                oRemoteSystem.platform is 'abap':
-                '/sap/public/bc/icf/logoff'
-                oRemoteSystem.platform is 'hana':
-                '<protocol://host:port>/sap/hana/xs/formLogin/token.xsjs'
-            2. baseUrl beginning with '/' e.g. '/MY_PREFIX':
-                The logout request was fired with the baseUrl as prefix e.g. platform 'abap':
-                '<protocol://host:port>/MY_PREFIX/sap/public/bc/icf/logoff'
-            3. baseUrl is ';o=':
-                The logout request is fired with <code>;o=oRemoteSystem.alias</code>
-                e.g. oRemoteSystem.platform 'abap' and oRemoteSystem.alias = 'MY_SYSTEM_ALIAS':
-                '<protocol://host:port>/sap/public/bc/icf/logoff;o=MY_SYSTEM_ALIAS'
-            Note: Cases 2. and 3. require a corresponding Web Dispatcher rule.
-            */
+             * Internal details
+             * oRemoteSystem.getAlias() is the unique key within the remote systems list.
+             * oRemoteSystem.getPlatform determines which ContainerAdapter implementation is used.
+             * oRemoteSystem.getBaseUrl determines the logout request routing; there are 3 routing modes:
+             * 1. empty baseUrl:
+             *     The logout is done with its platform-specific, server-absolute service path e.g.
+             *     oRemoteSystem.platform is 'abap':
+             *     '/sap/public/bc/icf/logoff'
+             *     oRemoteSystem.platform is 'hana':
+             *     '<protocol://host:port>/sap/hana/xs/formLogin/token.xsjs'
+             * 2. baseUrl beginning with '/' e.g. '/MY_PREFIX':
+             *     The logout request was fired with the baseUrl as prefix e.g. platform 'abap':
+             *     '<protocol://host:port>/MY_PREFIX/sap/public/bc/icf/logoff'
+             * 3. baseUrl is ';o=':
+             *     The logout request is fired with <code>;o=oRemoteSystem.alias</code>
+             *     e.g. oRemoteSystem.platform 'abap' and oRemoteSystem.alias = 'MY_SYSTEM_ALIAS':
+             *     '<protocol://host:port>/sap/public/bc/icf/logoff;o=MY_SYSTEM_ALIAS'
+             * Note: Cases 2. and 3. require a corresponding Web Dispatcher rule.
+             */
             var sAlias = oRemoteSystem.getAlias();
             var oOldSystem = mRemoteSystems[sAlias];
 
@@ -1415,7 +1588,9 @@ sap.ui.define([
          *
          * @param {sap.ushell.System} oSystem system object
          * @returns {boolean} return true if system has "LOCAL" alias or if system has the same baseURL and client as FLP
+         *
          * @private
+         * @alias sap.ushell.Container#_isLocalSystem
          */
         this._isLocalSystem = function (oSystem) {
             var sAlias = oSystem.getAlias();
@@ -1437,8 +1612,10 @@ sap.ui.define([
          * If this succeeds, {@link #addRemoteSystem} is called accordingly with a base URL of ";o=".
          *
          * @param {string} sServiceUrl An OData service URL.
+         *
          * @since 1.23.0
          * @private
+         * @alias sap.ushell.Container#addRemoteSystemForServiceUrl
          */
         this.addRemoteSystemForServiceUrl = function (sServiceUrl) {
             var oSystemInfo = { baseUrl: ";o=" };
@@ -1474,8 +1651,10 @@ sap.ui.define([
          *
          * @param  {function} fnFunction Event handler to be attached.
          * @param  {boolean} bAsyncFunction Whether the function returns a Promise to wait for its resolvent (since 1.81.0).
+         *
          * @since 1.19.1
          * @public
+         * @alias sap.ushell.Container#attachLogoutEvent
          */
         this.attachLogoutEvent = function (fnFunction, bAsyncFunction) {
             var bFound = false;
@@ -1499,8 +1678,10 @@ sap.ui.define([
          * Detaches a listener from the logout event.
          *
          * @param  {function} fnFunction Event handler to be detached.
+         *
          * @since 1.19.1
          * @public
+         * @alias sap.ushell.Container#detachLogoutEvent
          */
         this.detachLogoutEvent = function (fnFunction) {
             oEventProvider.detachEvent("Logout", fnFunction);
@@ -1520,9 +1701,11 @@ sap.ui.define([
          *   The event object provides the instance of the created renderer as parameter &quot;renderer&quot;.
          *   If the renderer is a SAPUI5 UI component (i.e. extend <code>sap.ui.core.UIComponent</code>),
          *   the event parameter returns the component instance, i.e. it unwraps the renderer component from its component container.
+         *
          * @since 1.34.1
          * @public
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#attachRendererCreatedEvent
          */
         this.attachRendererCreatedEvent = function (fnFunction) {
             oEventProvider.attachEvent("rendererCreated", fnFunction);
@@ -1532,9 +1715,11 @@ sap.ui.define([
          * Detaches a listener from the rendererCreated event.
          *
          * @param  {function} fnFunction Event handler to be detached.
+         *
          * @since 1.34.1
          * @public
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#detachRendererCreatedEvent
          */
         this.detachRendererCreatedEvent = function (fnFunction) {
             oEventProvider.detachEvent("rendererCreated", fnFunction);
@@ -1543,9 +1728,11 @@ sap.ui.define([
         /**
          * Logs out the current user from all relevant back-end systems, including the logon system itself.
          *
-         * @returns {jQuery.Deferred} A <code>jQuery.promise</code> to be resolved when logout is finished, even when it fails.
+         * @returns {jQuery.Promise} Resolves when logout is finished, even when it fails.
+         *
          * @since 1.15.0
          * @private
+         * @alias sap.ushell.Container#defaultLogout
          */
         this.defaultLogout = function () {
             var oDeferred = new jQuery.Deferred();
@@ -1626,15 +1813,17 @@ sap.ui.define([
         };
 
         /**
+         * @function
          * Logs out the current user from all relevant back-end systems, including the logon system itself.
          * This member represents the default native implementation of logout.
          * If SessionHandler was created, we register the alternate logout function using registerLogout function.
          *
-         * @function
-         * @returns {jQuery.Deferred} A <code>jQuery.promise</code> to be resolved when logout is finished, even when it fails.
+         * @returns {jQuery.Promise} Resolves when logout is finished, even when it fails.
+         *
          * @since 1.15.0
          * @public
          * @deprecated since 1.120
+         * @alias sap.ushell.Container#logout
          */
         this.logout = this.defaultLogout;
 
@@ -1644,8 +1833,10 @@ sap.ui.define([
          * This is so that we can logout additional systems before we can logout from the Shell.
          * In this case we will register a substitute logout func from the SessionHandler.
          * @param {function} fnLogout function to be set
+         *
          * @since 1.15.0
          * @private
+         * @alias sap.ushell.Container#registerLogout
          */
         this.registerLogout = function (fnLogout) {
             this.logout = fnLogout;
@@ -1679,9 +1870,11 @@ sap.ui.define([
          * @param {function} oLogonFrameProvider.show A function taking no arguments which is called to indicate that the current frame
          *   probably needs to be shown to the user because interaction is required. Note that there may be false positives here.
          *   It is up to the provider how and when the frame is shown exactly; make sure to provide a good user interaction design here.
+         * @see sap.ushell.Container#cancelLogon
+         *
          * @since 1.21.2
          * @private
-         * @see sap.ushell.services.Container#cancelLogon
+         * @alias sap.ushell.Container#setLogonFrameProvider
          */
         this.setLogonFrameProvider = function (oLogonFrameProvider) {
             if (this.oFrameLogonManager) {
@@ -1699,8 +1892,10 @@ sap.ui.define([
          *
          * @param {string} sPath the URL path for which the custom timeout will be applied
          * @param {int} iTimeout the timeout value in milliseconds
+         *
          * @since 1.46.3
          * @private
+         * @alias sap.ushell.Container#setXhrLogonTimeout
          */
         this.setXhrLogonTimeout = function (sPath, iTimeout) {
             if (this.oFrameLogonManager) {
@@ -1712,8 +1907,10 @@ sap.ui.define([
          * Returns the current Configuration, the configuration will contains URL of the FLP, scopeId in the case of CDM
          *
          * @returns {Promise} Returns a Promise that resolves the configuration data.
+         *
          * @since 1.71
          * @private
+         * @alias sap.ushell.Container#getFLPConfig
          */
         this.getFLPConfig = function () {
             var oPromise = new Promise(function (resolve, reject) {
@@ -1741,8 +1938,10 @@ sap.ui.define([
          *
          * @param {boolean} [bIncludeHash=false] defines if the hash is added to the result.
          * @returns {string} URL.
+         *
          * @since 1.56
          * @private
+         * @alias sap.ushell.Container#getFLPUrl
          */
         this.getFLPUrl = function (bIncludeHash) {
             var sUrl = ushellUtils.getLocationHref();
@@ -1761,9 +1960,11 @@ sap.ui.define([
          *
          * @param {boolean} [bIncludeHash=false] defines if the hash is added to the result.
          *
-         * @returns {jQuery.Promise} a promise that is resolved with FLP URL
+         * @returns {jQuery.Promise} Resolves the FLP URL.
+         *
          * @since 1.87
          * @private
+         * @alias sap.ushell.Container#getFLPUrlAsync
          */
         this.getFLPUrlAsync = function (bIncludeHash) {
             return new jQuery.Deferred().resolve(that.getFLPUrl(bIncludeHash)).promise();
@@ -1775,14 +1976,28 @@ sap.ui.define([
          * @returns {boolean}.
          * @since 1.87
          * @private
+         * @alias sap.ushell.Container#inAppRuntime
          */
         this.inAppRuntime = function () {
             return false;
         };
-        //for backward computability
+
+        /**
+         * Returns indication is we are in AppRuntime (for special use cases handling)
+         * for backward compatibility
+         * @returns {boolean}.
+         * @private
+         * @alias sap.ushell.Container#runningInIframe
+         */
         this.runningInIframe = this.inAppRuntime;
 
-        //Returns the adapter (for cflp appruntime internal usage only)
+        /**
+         * Returns the adapter (for cflp appruntime internal usage only)
+         * @returns {object} The adapter
+         *
+         * @private
+         * @alias sap.ushell.Container#_getAdapter
+         */
         this._getAdapter = function () {
             return oAdapter;
         };
@@ -1791,8 +2006,10 @@ sap.ui.define([
          * Returns FLP's platform as specified in the configuration
          * @param {boolean} bSync return Platform string sync
          * @returns {object|Promise} if async - a Promise that returns the FLP Platform's value
+         *
          * @since 1.96
          * @private
+         * @alias sap.ushell.Container#getFLPPlatform
          */
         this.getFLPPlatform = function (bSync) {
             if (bSync === true) {
@@ -1810,7 +2027,7 @@ sap.ui.define([
 
         // constructor code -------------------------------------------------------
         // loose coupling to allow re-use from sap.ushell_abap.pbServices.ui2.Catalog#addSystemToServiceUrl
-        Core.getEventBus().subscribe("sap.ushell.Container",
+        EventBus.getInstance().subscribe("sap.ushell.Container",
             "addRemoteSystemForServiceUrl", function (sChannelId, sEventId, oData) {
                 that.addRemoteSystemForServiceUrl(oData);
             });
@@ -1822,8 +2039,10 @@ sap.ui.define([
          * @param {Object<string, string>} [mAdapterPackagesByPlatform={}] the map with platform specific package names for the service adapters.
          *   You only need to specify these package names if they differ from the standard name <code>"sap.ushell.adapters." + sPlatform</code>.
          * @returns {Promise} a promise that is resolved once the container is available
+         *
          * @since 1.119
          * @private
+         * @alias sap.ushell.Container#_init
          */
         this._init = function (sPlatform, mAdapterPackagesByPlatform) {
             var oPromise = new Promise(function (fnResolve) {
@@ -1896,12 +2115,12 @@ sap.ui.define([
                             Log.error("Ushell Config's preloadServices should not be used!");
                         }
 
-                        var oShellNavigationServicePromise = this.getServiceAsync("ShellNavigation")
-                            .then(function (ShellNavigationService) {
-                                this._oShellNavigationService = ShellNavigationService;
+                        var oShellNavigationInternalPromise = this.getServiceAsync("ShellNavigationInternal")
+                            .then(function (oShellNavigationInternal) {
+                                this._oShellNavigationInternal = oShellNavigationInternal;
                             }.bind(this));
 
-                        servicesForPreloading.push(oShellNavigationServicePromise);
+                        servicesForPreloading.push(oShellNavigationInternalPromise);
 
                         Promise.all(servicesForPreloading)
                             .then(function () {
@@ -1977,6 +2196,7 @@ sap.ui.define([
                         that._closeWindow();
                         that._redirectWindow();
                     }
+
                     if (sap.ushell.Container !== that) {
                         // In integration test suite, old listeners remain which do not belong to the current sap.ushell.Container instance.
                         // IE sends events also to own window. Then these old listeners react as if a remote window logged out...
@@ -2010,12 +2230,14 @@ sap.ui.define([
          *
          * @returns {object} An object containing the exposed functions.
          * @private
+         * @alias sap.ushell.Container#_getFunctionsForUnitTest
          */
         this._getFunctionsForUnitTest = function () {
             return {
                 createAdapter: createAdapter
             };
         };
+
         /**
          * Resets the internal service instance store.
          * NOTE:
@@ -2023,6 +2245,7 @@ sap.ui.define([
          *
          * @since 1.119
          * @private
+         * @alias sap.ushell.Container#resetServices
          */
         this.resetServices = function () {
             mServicesByName = new ushellUtils.Map();
@@ -2036,6 +2259,7 @@ sap.ui.define([
          *
          * @since 1.119
          * @private
+         * @alias sap.ushell.Container#reset
          */
         this.reset = function () {
             this.resetServices();
@@ -2112,7 +2336,8 @@ sap.ui.define([
      * @param {string} sPlatform the target platform, such as "abap" or "cdm".
      * @param {Object<string, string>} [mAdapterPackagesByPlatform={}] the map with platform specific package names for the service adapters.
      *   You only need to specify these package names if they differ from the standard name <code>"sap.ushell.adapters." + sPlatform</code>.
-     * @returns {jQuery.Promise} a promise that is resolved once the container is available
+     * @returns {jQuery.Promise} Resolves once the container is available.
+     *
      * @since 1.15.0
      * @ui5-global-only
      * @public