@sapui5/sap.ushell_abap 1.94.0 → 1.96.1

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.request.startup.js

@@ -3,8 +3,13 @@ sap.ui.define([
     "./abap.bootstrap.utils",
     "sap/base/util/ObjectPath",
     "sap/base/Log",
-    "sap/ui2/srvc/utils"
-], function (oAbapUtils, ObjectPath, Log /*, oUi2Utils*/) {
+    "sap/ushell_abap/pbServices/ui2/Utils"
+], function (
+    oAbapUtils,
+    ObjectPath,
+    Log,
+    Utils
+) {
     "use strict";
 
     var oStartupHandler = {};
@@ -23,7 +28,7 @@ sap.ui.define([
      */
     function requestStartup (sQuery, aParametertsFromUrl, oStartupConfig) {
         var sRequestUrl = "/sap/bc/ui2/start_up?",
-            mParameterMap = sap.ui2.srvc.getParameterMap(),
+            mParameterMap = Utils.getParameterMap(),
             oXHR;
 
         if (sQuery) {
@@ -53,7 +58,7 @@ sap.ui.define([
         }
 
         return new Promise(function (resolve, reject) {
-            sap.ui2.srvc.get(
+            Utils.get(
                 sRequestUrl,
                 false, /*xml=*/
                 function (sStartupCallResult) {
@@ -123,7 +128,7 @@ sap.ui.define([
      */
     oStartupHandler.requestDirectStart = function (oStartupConfig, oParsedShellHash, oInitialKeys) {
 
-        var sFormFactor = sap.ui2.srvc.getFormFactor(),
+        var sFormFactor = Utils.getFormFactor(),
             sQueryPath = "";
 
         sQueryPath = "so=" + oParsedShellHash.semanticObject + "&action=" + oParsedShellHash.action;

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.ui5.boot.handler.js

@@ -2,8 +2,11 @@
 
 sap.ui.define([
     "sap/base/Log",
-    "sap/ui2/srvc/utils"
-], function (Log/*, oUtil */) {
+    "sap/ushell_abap/pbServices/ui2/Utils"
+], function (
+    Log,
+    Utils
+) {
     "use strict";
 
     var oBootHandler = {},
@@ -25,8 +28,8 @@ sap.ui.define([
 
         function normalizeUrlAndAddCacheBusterToken (sUrlPrefix) {
             // Removing cache buster token (if available) of url and normalize the url afterwards
-            var sNormalizedUrl = sap.ui2.srvc.removeCBAndNormalizeUrl(sUrlPrefix),
-                sUrlPrefixModified = sap.ui2.srvc.addCacheBusterTokenUsingUshellConfig(sNormalizedUrl);
+            var sNormalizedUrl = Utils.removeCBAndNormalizeUrl(sUrlPrefix),
+                sUrlPrefixModified = Utils.addCacheBusterTokenUsingUshellConfig(sNormalizedUrl);
             return sUrlPrefixModified;
         }
 

package/src/main/js/sap/ushell_abap/bootstrap/evo/abap.xhr.handler.js

@@ -3,8 +3,15 @@ sap.ui.define([
     "sap/ushell/bootstrap/common/common.load.xhrlogon",
     "sap/ushell/bootstrap/common/common.configure.xhrlogon",
     "./abap.bootstrap.utils",
-    "./XhrLogonEventHandler"
-], function (oXhrLogonLib, oConfigureXhrLogon, oAbapUtils, XhrLogonEventHandler) {
+    "./XhrLogonEventHandler",
+    "sap/base/Log"
+], function (
+    oXhrLogonLib,
+    oConfigureXhrLogon,
+    oAbapUtils,
+    XhrLogonEventHandler,
+    Log
+) {
     "use strict";
 
     var oHandler = {};
@@ -45,7 +52,7 @@ sap.ui.define([
                 oXhrLogonEventHandler.handleEvent(oEvent);
             });
         } else if (sLogonMode !== "frame") {
-            sap.ui2.srvc.log.warning("Unknown setting for xhrLogonMode: '" + sLogonMode + "'. Using default mode 'frame'.",
+            Log.warning("Unknown setting for xhrLogonMode: '" + sLogonMode + "'. Using default mode 'frame'.",
             null, "sap.ushell_abap.bootstrap.evo.abap.xhr.handler");
         }
 

package/src/main/js/sap/ushell_abap/bootstrap/evo/boottask.js

@@ -15,7 +15,8 @@ sap.ui.define([
     "sap/base/Log",
     "sap/ushell/services/Container",
     "sap/ui/Device",
-    "sap/ui2/srvc/utils"
+    "sap/ushell_abap/pbServices/ui2/Utils",
+    "sap/ushell_abap/pbServices/ui2/Chip" // TODO remove when FLPD is adapted (needs to be loaded early in FLPD scenario)
 ],
 function (
     oXhrLogonLib,
@@ -29,7 +30,11 @@ function (
     EventHub,
     initTraces,
     ObjectPath,
-    Log
+    Log,
+    Container,
+    Device,
+    Utils,
+    Chip
 ) {
     "use strict";
 
@@ -126,7 +131,7 @@ function (
                                 if (oUri) {
                                     if (oSelf.url.toUpperCase().indexOf(oUri.path().toUpperCase()) !== 0) {
                                         //no applicationDependencies in this case as they belong to the wrong app
-                                        sap.ui2.srvc.log.debug("Component URL defined in target mapping "
+                                        Log.debug("Component URL defined in target mapping "
                                                 + "does not match the URL retrieved from application index. "
                                                 + "The URL of the application index is used for further processing.",
                                         "Target mapping URL: " + oResult.url + "\nApplication index URL: " + oSelf.url,
@@ -134,7 +139,7 @@ function (
                                     }
                                     oUri.path(oSelf.url);
                                     sUrl = oUri.toString();
-                                    jQuery.sap.log.debug("ResolveLink result's component url has been replaced with the url specified " +
+                                    Log.debug("ResolveLink result's component url has been replaced with the url specified " +
                                         "in Application Dependencies, which includes cache buster token");
                                 } else {
                                     sUrl = oSelf.url;
@@ -143,7 +148,7 @@ function (
 
                             oAdjustedResult.applicationDependencies = oAppDependencies;
                         } catch (oError) {
-                            sap.ui2.srvc.log.error(
+                            Log.error(
                                 "Parsing of applicationDependencies attribute in resolveLink result failed for SAPUI5 component '"
                                 + sComponentName + "'",
                                 oError,
@@ -161,7 +166,7 @@ function (
                     // we only do this for SAPUI5 applications - if a plain URL or NWBC app is launched,
                     // we keep it as it is
                     // see internal BCP inicdent 1580137234 2015
-                    sUrl = sap.ui2.srvc.addCacheBusterTokenUsingUshellConfig(sUrl);
+                    sUrl = Utils.addCacheBusterTokenUsingUshellConfig(sUrl);
                 }
             }
 
@@ -319,7 +324,7 @@ function (
         try {
             return JSON.parse(JSON.stringify(oObject));
         } catch (e) {
-            sap.ui2.srvc.log.error(
+            Log.error(
                 "Could not clone object",
                 null,
                 "sap.ushell_abap.bootstrap"
@@ -405,7 +410,7 @@ function (
      */
     function extractSystemThemeRoot (oStartupServiceResult) {
         if (!oStartupServiceResult) {
-            sap.ui2.srvc.log.error("extractSystemThemeRoot: mandatory parameter oStartupServiceResult not supplied");
+            Log.error("extractSystemThemeRoot: mandatory parameter oStartupServiceResult not supplied");
         }
         if (oStartupServiceResult.themeRoot) {
             // we expect that theme root is supplied by the startup service
@@ -413,14 +418,14 @@ function (
         }
         if (oStartupServiceResult.client) {
             // fallback
-            sap.ui2.srvc.log.warning(
+            Log.warning(
                 "Theme root was not contained in startup service result. A fallback to /sap/public/bc/themes/~client-<client number> is used",
                 null,
                 "sap.ushell_abap.bootstrap"
             );
             return "/sap/public/bc/themes/~client-" + oStartupServiceResult.client;
         }
-        sap.ui2.srvc.log.error("extractSystemThemeRoot: Could not determine system theme root");
+        Log.error("extractSystemThemeRoot: Could not determine system theme root");
     }
 
     /**
@@ -525,7 +530,7 @@ function (
      * @private
      */
     function getSapThemeUrlParameter () {
-        var sUrlTheme = sap.ui2.srvc.getParameterMap()["sap-theme"] && sap.ui2.srvc.getParameterMap()["sap-theme"][0];
+        var sUrlTheme = Utils.getParameterMap()["sap-theme"] && Utils.getParameterMap()["sap-theme"][0];
         if (sUrlTheme) {
             return sUrlTheme;
         }
@@ -581,7 +586,7 @@ function (
             // URL = prio 1
             oUrlTheme = determineUrlTheme(sSystemThemeRoot);
             oBootTheme = oUrlTheme;
-            sap.ui2.srvc.log.debug("theme: URL theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
+            Log.debug("theme: URL theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
                     null, "sap.ushell_abap.bootstrap");
             // theme is loaded by UI5
             //The theme root should be set fot the custom theme. For the sap theme the root is calculated by core.
@@ -591,7 +596,7 @@ function (
         } else if (oStartupTheme) {
             // startup theme = prio 2
             oBootTheme = oStartupTheme;
-            sap.ui2.srvc.log.debug("theme: startup service theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
+            Log.debug("theme: startup service theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
                     null, "sap.ushell_abap.bootstrap");
 
             if (oBootTheme.root) {
@@ -615,14 +620,14 @@ function (
                     theme: oHtmlTheme.theme,
                     root: oHtmlTheme.root
                 };
-                sap.ui2.srvc.log.debug("theme: html file theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
+                Log.debug("theme: html file theme = '" + oBootTheme.theme + "' theme root = '" + oBootTheme.root + "'",
                         null, "sap.ushell_abap.bootstrap");
             } else {
                 oBootTheme = {
                     theme: "",
                     root: ""
                 };
-                sap.ui2.srvc.log.error("Could not determine theme",
+                Log.error("Could not determine theme",
                         null, "sap.ushell_abap.bootstrap");
             }
         }
@@ -642,7 +647,7 @@ function (
         // TODO: split in merging with config => do first,
         // THEN merge with Configuration file ( if relevant)
         // THEN process => apply to ui5 services etc.
-        var mParameterMap = sap.ui2.srvc.getParameterMap(),
+        var mParameterMap = Utils.getParameterMap(),
             sRequestLocale = oAbapUtils.getUrlParameterValue("sap-locale", mParameterMap),
             oUi5UserInfo = {},
             oConfig;

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

@@ -13,13 +13,13 @@ sap.ui.define([
      * @namespace
      * @name sap.ushell_abap
      * @author SAP SE
-     * @version 1.94.0
+     * @version 1.96.1
      * @private
      * @ui5-restricted
      */
     sap.ui.getCore().initLibrary({
         name: "sap.ushell_abap",
-        version: "1.94.0",
+        version: "1.96.1",
         dependencies: ["sap.ui.core", "sap.m"],
         noLibraryCSS: true,
         extensions: {

package/src/main/js/sap/ushell_abap/pbServices/ui2/AllCatalogs.js

@@ -0,0 +1,186 @@
+// Copyright (c) 2009-2021 SAP SE. All rights reserved.
+
+/**
+ * @fileOverview A wrapper for a page's <code>allCatalogs</code> collection loaded from the page
+ * building service.
+ */
+
+sap.ui.define([
+    "sap/ushell_abap/pbServices/ui2/Catalog",
+    "sap/ushell_abap/pbServices/ui2/Error",
+    "sap/base/Log"
+], function (
+    Catalog,
+    SrvcError,
+    Log
+) {
+    "use strict";
+
+
+    // "public class" ************************************************************
+
+    /**
+     * Constructs a new representation (wrapper) for the given page's <code>allCatalogs</code>
+     * collection to be loaded from the given factory's page building service. Note that this
+     * collection does not contain the page's classic catalog as returned by
+     * {@link sap.ushell_abap.pbServices.ui2.Page#getCatalog}).
+     *
+     * @param {sap.ushell_abap.pbServices.ui2.Factory} oFactory
+     *  the factory
+     * @param {string} sPageId
+     *   ID of the page
+     *
+     * <p>
+     * Initially a stub is created, which can later load its properties and related objects
+     * asynchronously.
+     * <p>
+     * This collection and the contained catalogs are currently read-only and cannot be updated
+     * through the page building service.
+     * (see {@link sap.ushell_abap.pbServices.ui2.PageBuildingService}, {@link sap.ushell_abap.pbServices.ui2.Catalog})
+     *
+     * @class
+     * @since 1.7.0
+     */
+    var AllCatalogs = function (oFactory, sPageId) {
+        var aCatalogs = [],
+            bIsStub = true,
+            that = this;
+
+        // BEWARE: constructor code below!
+
+        // "private" methods ---------------------------------------------------------
+
+        /**
+         * Makes sure we are not just a stub.
+         *
+         * @private
+         */
+        function checkStub () {
+            if (bIsStub) {
+                throw new SrvcError(that + ": collection is just a stub",
+                    "AllCatalogs");
+            }
+        }
+
+        // "public" methods ----------------------------------------------------------
+
+        /**
+         * Returns this collection's catalog instances. Can only be called if the collection itself is
+         * not a stub anymore.
+         *
+         * @returns {sap.ushell_abap.pbServices.ui2.Catalog[]}
+         *   this collection's catalog instances
+         * @since 1.7.0
+         *
+         * @see #isStub()
+         */
+        this.getCatalogs = function () {
+            checkStub();
+            return aCatalogs.slice();
+        };
+
+        /**
+         * Tells whether this <code>allCatalogs</code> collection is still only a stub and does not yet
+         * know its individual catalogs.
+         *
+         * @returns {boolean}
+         *   whether this <code>allCatalogs</code> collection is still only a stub
+         * @since 1.7.0
+         *
+         * @see #load()
+         */
+        this.isStub = function () {
+            return bIsStub;
+        };
+
+        /**
+         * Loads this <code>allCatalogs</code> collection including all of its catalogs and their CHIPs.
+         * Notifies one of the given handlers.
+         *
+         * @param {function ()} fnSuccess
+         *   no-args success handler
+         * @param {function (string, object=)} [fnFailure]
+         *   error handler taking an error message and, since version 1.28.6, an
+         *   optional object containing the complete error information as delivered
+         *   by the ODataService. See fnFailure parameter of {@link sap.ushell_abap.pbServices.ui2.ODataWrapper#onError}
+         *   for more details.
+         *   If not given, the default <code>{@link sap.ushell_abap.pbServices.ui2.ODataService#getDefaultErrorHandler}</code> is used
+         * @param {string} [sFilter]
+         *   filter value as defined by OData specification e.g. "type eq 'H'" for HANA catalogs.
+         *   Filter has been introduced with version 1.16.2.
+         * @param {boolean} [bPartially=false]
+         *   Whether to load the <code>allCatalogs</code> collection only partially instead of making
+         *   sure that also remote catalogs are fully loaded (since 1.17.1). Note: Non-remote catalogs
+         *   are not affected!
+         * @param {string} sSorting
+         *   name of the field to be sorted on via $orderby as defined by OData specification.
+         *   If not defined the dafault sorting would be on the field id (since 1.44)
+         * @param {boolean} bCache use cache when true
+         * @since 1.7.0
+         */
+        this.load = function (fnSuccess, fnFailure, sFilter, bPartially, sSorting, bCache) {
+            if (!bIsStub) {
+                throw new SrvcError(that + ": collection is not a stub anymore",
+                    "AllCatalogs");
+            }
+
+            function loadCatalogs () {
+                var i, n, oCatalog;
+
+                if (!bPartially) {
+                    // Note: If a catalog is still a stub here, it refers to a different system. We don't
+                    // expect to have many such catalogs, so we don't mind loading them serialized.
+                    for (i = 0, n = aCatalogs.length; i < n; i += 1) {
+                        oCatalog = aCatalogs[i];
+                        if (oCatalog.isStub()) {
+                            oCatalog.load(loadCatalogs, fnFailure);
+                            return;
+                        }
+                    }
+                }
+                fnSuccess();
+            }
+
+            function onSuccess (oAlterEgo) {
+                var i, n;
+
+                Log.debug("Loaded: " + that, null, "AllCatalogs");
+                bIsStub = false;
+                aCatalogs = [];
+                for (i = 0, n = oAlterEgo.results.length; i < n; i += 1) {
+                    aCatalogs.push(oFactory.createCatalog(oAlterEgo.results[i]));
+                }
+                Log.debug("Initialized: " + that, null, "AllCatalogs");
+                loadCatalogs();
+            }
+
+            oFactory.getPageBuildingService().readAllCatalogs(sPageId, onSuccess, fnFailure, sFilter, sSorting, !!bCache /* false is the default */);
+        };
+
+        /**
+         * Returns this <code>allCatalogs</code> collection's string representation.
+         *
+         * @param {boolean} [bVerbose=false]
+         *   flag whether to show all properties
+         * @returns {string}
+         *   this <code>allCatalogs</code> collection's string representation
+         * @since 1.7.0
+         */
+        this.toString = function (bVerbose) {
+            var aResult = ['AllCatalogs({sPageId:"', sPageId, '",bIsStub:', bIsStub];
+            if (bVerbose) {
+                aResult.push(",aCatalogs:", JSON.stringify(aCatalogs));
+            }
+            aResult.push("})");
+            return aResult.join("");
+        };
+
+        // constructor code -------------------------------------------------------
+        if (!sPageId) {
+            throw new SrvcError("Missing page ID", "AllCatalogs");
+        }
+        Log.debug("Created: " + this, null, "AllCatalogs");
+    };
+
+    return AllCatalogs;
+}, true);