@sapui5/sap.ushell_abap 1.139.0 → 1.140.0

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

@@ -49,7 +49,24 @@ sap.ui.define([
         }
     }
 
-    let ODataWrapper;
+    /**
+     * Clones an Object to avoid unwanted changes
+     * @param {object} oInputObject
+     *   The object that needs to be cloned
+     * @returns {object}
+     *   The cloned object
+     * @private
+     */
+    function cloneObject (oInputObject) {
+        if (oInputObject === undefined) {
+            return undefined;
+        }
+        try {
+            return JSON.parse(JSON.stringify(oInputObject));
+        } catch (e) {
+            return undefined;
+        }
+    }
 
     // "public class" ************************************************************
 
@@ -100,13 +117,15 @@ sap.ui.define([
      * @since 1.19.0
      */
     // OLD API: function (sBaseUrl, oODataService, bSupportsChangeSets)
-    ODataWrapper = function (oSettings, oODataService) {
+    function ODataWrapper (oSettings, oODataService) {
         const S_STICKY_SESSION_HEADER = "saplb"; // header to check during sticky session
         let aBatchQueue; // corresponds to data.__batchRequests
         let bChangeSetOpen; // whether a change set is currently open at the end of our batch queue
         let aDeferredQueue; // jQuery.Deferred() objects corresponding to each request
         const that = this;
+        // eslint-disable-next-line prefer-const
         let sBaseUrl;
+        // eslint-disable-next-line prefer-const
         let bSupportsChangeSets;
 
         // BEWARE: constructor code below!
@@ -137,7 +156,7 @@ sap.ui.define([
         /**
          * Getter mainly used for testing.
          *
-         * @returns {object}
+         * @returns {object} the batch queue
          */
         this.getBatchQueue = function () {
             return aBatchQueue;
@@ -244,7 +263,6 @@ sap.ui.define([
          *   the response headers
          */
         this.detectStickySession = function (oResponseHeaders) {
-            let sHeaderValue;
             const oStickySessionConfiguration =
                     ODataWrapper.oStickySessionConfiguration[sBaseUrl];
 
@@ -253,7 +271,7 @@ sap.ui.define([
             }
 
             // add sticky session header value if found
-            sHeaderValue = ODataWrapper.headerValue(S_STICKY_SESSION_HEADER, oResponseHeaders);
+            const sHeaderValue = ODataWrapper.headerValue(S_STICKY_SESSION_HEADER, oResponseHeaders);
             if (typeof sHeaderValue === "undefined") {
                 return;
             }
@@ -315,11 +333,10 @@ sap.ui.define([
          */
         this.doRequest = function (sRequestUrl, sMethod, oPayload, fnSuccess, fnFailure, oHandler, bIsRepeatedRequest) {
             Log.debug("[000] do request, sMethod", sMethod, "ODataWrapper");
-            let oHeaders;
             fnSuccess = fnSuccess || nop;
             fnFailure = fnFailure || oODataService.getDefaultErrorHandler();
             that.check(fnSuccess, fnFailure);
-            oHeaders = {
+            const oHeaders = {
                 Accept: "application/json",
                 "Accept-Language": Localization.getLanguage() || "",
                 "X-CSRF-Token": oODataService.getCsrfToken()
@@ -859,6 +876,8 @@ sap.ui.define([
 
             /**
              * Success handler for <code>OData.read</code>.
+             * @param {object} oData oData returned by the OData service
+             * @param {object} oResponse response object
              */
             function success (oData, oResponse) {
                 this.detectStickySession(oResponse.headers);
@@ -968,7 +987,7 @@ sap.ui.define([
             /**
              * Success handler for $batch request.
              *
-             * @param {object} oData
+             * @param {object} oData is the oData response object
              */
             function onBatchSuccess (oData) {
                 const iActual = oData.__batchResponses.length;
@@ -1135,7 +1154,7 @@ sap.ui.define([
                 value: undefined // the value detected if enabled = true
             };
         }
-    };
+    }
 
     /**
      * Detects and, if needed, converts old api calls of the createODataWrapper function to the current one.
@@ -1162,25 +1181,6 @@ sap.ui.define([
         return oTransformedApi;
     }
 
-    /**
-     * Clones an Object to avoid unwanted changes
-     * @param {object} oInputObject
-     *   The object that needs to be cloned
-     * @returns {object}
-     *   The cloned object
-     * @private
-     */
-    function cloneObject (oInputObject) {
-        if (oInputObject === undefined) {
-            return undefined;
-        }
-        try {
-            return JSON.parse(JSON.stringify(oInputObject));
-        } catch (e) {
-            return undefined;
-        }
-    }
-
     /*
      * Configuration for sticky session is done here as it is a static property
      * that should not rely on the instance initialization. Also, it may happen

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

@@ -46,7 +46,7 @@ sap.ui.define([
      * @since 1.2.0
      * @see sap.ushell_abap.pbServices.ui2.PageBuildingService
      */
-    const Page = function (oFactory, vPageData) {
+    function Page (oFactory, vPageData) {
         let sId; // the page ID
         let oAllCatalogs;
         let oAlterEgo; // page's representation with all relations removed
@@ -322,8 +322,6 @@ sap.ui.define([
          * @since 1.3.0
          */
         this.getBag = function (sBagId) {
-            let oBag;
-
             if (bIsLoadingBagsOnDemand) {
                 throw new SrvcError(`${that}: page is just a stub, load bags on demand`,
                     "Page");
@@ -337,7 +335,7 @@ sap.ui.define([
                 return mBags.get(sBagId);
             }
 
-            oBag = new Bag(oFactory, { pageId: this.getId(), id: sBagId, $tmp: true });
+            const oBag = new Bag(oFactory, { pageId: this.getId(), id: sBagId, $tmp: true });
             mBags.put(sBagId, oBag);
             return oBag;
         };
@@ -909,7 +907,7 @@ sap.ui.define([
         }
         mBags = new Utils.Map();
         Log.debug(`Created: ${this}`, null, "Page");
-    };
+    }
 
     return Page;
 });

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

@@ -58,7 +58,7 @@ sap.ui.define([
      * @augments ODataService
      * @since 1.2.0
      */
-    const PageBuildingService = function (vODataBase, fnDefaultFailure, bIsPersonalization, sCacheId) {
+    function PageBuildingService (vODataBase, fnDefaultFailure, bIsPersonalization, sCacheId) {
         let oWrapper;
         const that = this;
 
@@ -117,10 +117,10 @@ sap.ui.define([
         /**
          * Evaluates status code from OData batch response entry and returns the corresponding OData
          * entity or the status message.
-         * @param oEntry The batch response entry which is an element of
+         * @param {object} oEntry The batch response entry which is an element of
          *     (For change) oData.__batchResponses[0]._changeResponses array
          *     (For read) oData.__batchResponses array (without the element for change responses)
-         * @returns OData entity (object or undefined) or status message as string
+         * @returns {object} OData entity (object or undefined) or status message as string
          *
          * @private
          */
@@ -264,7 +264,7 @@ sap.ui.define([
                 // Note: drop excess parameters; try/catch
                 Utils.callHandler(fnSuccess.bind(null, oData), fnFailure);
             }, oWrapper.onError.bind(oWrapper, "GET", sRequestUrl, fnFailure, /* oDeferred */undefined),
-                OData.metadataHandler);
+            OData.metadataHandler);
         };
 
         /**
@@ -601,9 +601,9 @@ sap.ui.define([
             oWrapper.create(`CloneCatalog?sourceId='${encodeURIComponent(sCatalogId)
                 }'&targetId='${encodeURIComponent(sNewDomainId)
                 }${sNewTitle !== undefined ? `'&title='${encodeURIComponent(sNewTitle)}'` : "'"}`,
-                {}, // payload
-                fnSuccess,
-                fnFailure);
+            {}, // payload
+            fnSuccess,
+            fnFailure);
         };
 
         /**
@@ -646,17 +646,17 @@ sap.ui.define([
             oWrapper.create(`ClonePageChipInstance?sourcePageId='${encodeURIComponent(sSourcePageId)
                 }'&sourceChipInstanceId='${encodeURIComponent(sSourceChipInstanceId)
                 }'&targetPageId='${encodeURIComponent(sTargetPageId)}'`,
-                {}, // payload
-                (oRawChipInstance) => {
-                    // ClonePageChipInstance cannot expand the result
-                    // Note: the CHIP instance cannot be remote and the CHIP has already been loaded
-                    oWrapper.read(`PageChipInstances(pageId='${encodeURIComponent(oRawChipInstance.pageId)
+            {}, // payload
+            (oRawChipInstance) => {
+                // ClonePageChipInstance cannot expand the result
+                // Note: the CHIP instance cannot be remote and the CHIP has already been loaded
+                oWrapper.read(`PageChipInstances(pageId='${encodeURIComponent(oRawChipInstance.pageId)
                         }',instanceId='${encodeURIComponent(oRawChipInstance.instanceId)}')`
                         + "?$expand=ChipInstanceBags/ChipInstanceProperties",
-                        fnSuccess,
-                        fnFailure);
-                },
+                fnSuccess,
                 fnFailure);
+            },
+            fnFailure);
         };
 
         /**
@@ -736,7 +736,6 @@ sap.ui.define([
          * @since 1.16.4
          */
         this.readCatalogChips = function (sCatalogId, aChipIds, fnSuccess, fnFailure) {
-            let sUrl;
             let sFilter = "";
             let sPrefix = "?$filter=";
 
@@ -745,7 +744,7 @@ sap.ui.define([
             }
 
             // TODO: read also CHIP bags
-            sUrl = `Catalogs('${encodeURIComponent(sCatalogId)}')/Chips`;
+            const sUrl = `Catalogs('${encodeURIComponent(sCatalogId)}')/Chips`;
             if (aChipIds) {
                 if (!aChipIds.length) {
                     throw new SrvcError("No CHIP IDs given", "PageBuildingService");
@@ -1133,7 +1132,7 @@ sap.ui.define([
 
             oWrapper.del(`PageChipInstances(pageId='${encodeURIComponent(sPageId)
                 }',instanceId='${encodeURIComponent(sInstanceId)}')`,
-                fnSuccess, fnFailure);
+            fnSuccess, fnFailure);
         };
 
         /**
@@ -1334,8 +1333,6 @@ sap.ui.define([
          */
         this.createProperty = function (vParent, sBagId, sPropertyName, sValue, sTranslatable,
             fnSuccess, fnFailure) {
-            let oProperty;
-
             if (!vParent) {
                 throw new SrvcError("Missing parent ID or object",
                     "PageBuildingService");
@@ -1353,7 +1350,7 @@ sap.ui.define([
                 return;
             }
 
-            oProperty = {
+            const oProperty = {
                 bagId: sBagId,
                 name: sPropertyName,
                 pageId: vParent,
@@ -1466,7 +1463,7 @@ sap.ui.define([
         }
 
         ODataService.call(this, oWrapper, fnDefaultFailure);
-    };
+    }
 
     PageBuildingService._createODataWrapper = function (vODataBase, base) {
         return new ODataWrapper(vODataBase, base, /* bSupportsChangeSets=*/true);

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

@@ -41,8 +41,7 @@ sap.ui.define([
      * @since 1.11.0
      * @private
      */
-    const PageSet = function (oFactory, sPageSetId) {
-        let sId; // the page set ID
+    function PageSet (oFactory, sPageSetId) {
         let oAlterEgo; // page set's representation with all relations removed
         let oDefaultPage;
         let aPages = [];
@@ -50,6 +49,13 @@ sap.ui.define([
         let bIsStub = true;
         const that = this;
 
+        // constructor code -------------------------------------------------------
+        const sId = sPageSetId;
+        if (!sId) {
+            throw new SrvcError("Missing page set ID", "PageSet");
+        }
+        Log.debug(`Created: ${this}`, null, "PageSet");
+
         /**
          * Makes sure the given page set is not just a stub.
          *
@@ -453,14 +459,7 @@ sap.ui.define([
             aResult.push("})");
             return aResult.join("");
         };
-
-        // constructor code -------------------------------------------------------
-        sId = sPageSetId;
-        if (!sId) {
-            throw new SrvcError("Missing page set ID", "PageSet");
-        }
-        Log.debug(`Created: ${this}`, null, "PageSet");
-    };
+    }
 
     return PageSet;
 });

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

@@ -18,7 +18,7 @@ sap.ui.define([
      * @class
      * @since 1.19.1
      */
-    const RemoteCatalogService = function () {
+    function RemoteCatalogService () {
         // "public" methods --------------------------------------------------------
 
         /**
@@ -44,7 +44,7 @@ sap.ui.define([
             PageBuildingService.createPageBuildingService(sBaseUrl)
                 .readCatalogChips(sCatalogId, aChipIds, fnSuccess, fnFailure);
         };
-    };
+    }
 
     return RemoteCatalogService;
 });

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

@@ -19,48 +19,7 @@ sap.ui.define([
 ) => {
     "use strict";
 
-    const Utils = function () { };
-
-    // ensure that Function.prototype.bind is available, even with iOS 5
-    // utils.js is used with startup service, shell API and page building services
-    if (!Function.prototype.bind) {
-        /**
-         * Replacement for ECMAScript 5 feature which might still be missing.
-         *
-         * @param {object} oThis
-         *  The value to be passed as the <code>this</code> parameter to the target
-         *  function when the bound function is called. The value is ignored if the
-         *  bound function is constructed using the <code>new</code> operator.
-         * @param {...object} aVarArgs
-         *  Arguments to prepend to arguments provided to the bound function when
-         *  invoking the target function.
-         * @returns {function}
-         *  A function with the bound arguments aVarArgs
-         *
-         * @see <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function/bind">bind in ECMAScript 5</a>
-         */
-        Function.prototype.bind = function (oThis) {
-            /* eslint-enable no-extend-native */
-            if (typeof this !== "function") {
-                // closest thing possible to the ECMAScript 5 internal IsCallable function
-                throw new TypeError("Function.prototype.bind - what is trying to be bound is not callable");
-            }
-
-            const aArgs = Array.prototype.slice.call(arguments, 1);
-            const that = this;
-            const NOP = function () { /* no-op c'tor */ };
-            const fBound = function () {
-                return that.apply(
-                    // passing "window" as "this" has been removed (cf. "use strict";)
-                    this instanceof NOP ? this : oThis,
-                    aArgs.concat(Array.prototype.slice.call(arguments))
-                );
-            };
-            NOP.prototype = this.prototype;
-            fBound.prototype = new NOP();
-            return fBound;
-        };
-    }
+    function Utils () { }
 
     // cache for GET requests
     let oCache;
@@ -85,7 +44,7 @@ sap.ui.define([
         /* jslint regexp: true */
 
         // default base is the page location
-        sBase = sBase || location.href;
+        sBase = sBase || window.location.href;
         // base must be absolute
         if (sBase.indexOf("://") < 0 && sBase.charAt(0) !== "/") {
             throw new SrvcError(`Illegal base URL: ${sBase}`);
@@ -285,15 +244,10 @@ sap.ui.define([
      * @private
      */
     Utils.removeCBAndNormalizeUrl = function (sUrl) {
-        let aMatches;
         let sUrlPrefix;
         let sCacheBusterSegment;
         let sUrlPostfix;
 
-        if (typeof sUrl !== "string" || sUrl === "" || isUriWithRelativeOrEmptyPath(sUrl)) {
-            return sUrl;
-        }
-
         function isUriWithRelativeOrEmptyPath (sUrl0) {
             const oUri = new URI(sUrl0);
             const sPath = oUri.path();
@@ -309,9 +263,13 @@ sap.ui.define([
             return true;
         }
 
+        if (typeof sUrl !== "string" || sUrl === "" || isUriWithRelativeOrEmptyPath(sUrl)) {
+            return sUrl;
+        }
+
         // split up the URL into 3 parts: prefix, cache-buster segment, postfix
         // leading slashes are always part of the segment, the postfix might have a trailing slash
-        aMatches = sUrl.match(/(.*)(\/~[\w-]+~[A-Z0-9]?)(.*)/);
+        const aMatches = sUrl.match(/(.*)(\/~[\w-]+~[A-Z0-9]?)(.*)/);
         if (aMatches) {
             sUrlPrefix = aMatches[1];
             sCacheBusterSegment = aMatches[2];
@@ -384,11 +342,10 @@ sap.ui.define([
         const oPatterns = oCacheBusting && oCacheBusting.patterns;
         let sCacheBusterUrl = sUrl;
         let aParameterMap = [];
-        let sSapUshellNoCb;
         const aRules = [];
 
         aParameterMap = Utils.getParameterMap();
-        sSapUshellNoCb = aParameterMap["sap-ushell-nocb"] && aParameterMap["sap-ushell-nocb"][0];
+        const sSapUshellNoCb = aParameterMap["sap-ushell-nocb"] && aParameterMap["sap-ushell-nocb"][0];
 
         // When URL disables Cache Busting return URL without cache busting token
         // It can happen that we get a URL which already has a cache-buster token included (from the ABAP server), so we also remove
@@ -517,10 +474,8 @@ sap.ui.define([
         let sKey;
         let sValue;
         let iIndexOfEquals;
-        let aKeyValuePairs;
-        let aKeyValuePairsLength;
         // Note: location.search starts with "?" if not empty
-        const sSearch = arguments.length > 0 ? sSearchString : location.search;
+        const sSearch = arguments.length > 0 ? sSearchString : window.location.search;
 
         if (sSearch && sSearch.charAt(0) !== "?") {
             throw new SrvcError(`Illegal search string ${sSearch}`);
@@ -532,8 +487,8 @@ sap.ui.define([
         // Note: W3C recommends that servers support ";" as well as "&"
         //       (http://www.w3.org/TR/1999/REC-html401-19991224/appendix/notes.html#h-B.2.2)
         // http://unixpapa.com/js/querystring.html advocates this on the client-side also!
-        aKeyValuePairs = sSearch.substring(1).replace(/\+/g, " ").split(/[&;]/);
-        aKeyValuePairsLength = aKeyValuePairs.length < 500 ? aKeyValuePairs.length : 500;
+        const aKeyValuePairs = sSearch.substring(1).replace(/\+/g, " ").split(/[&;]/);
+        const aKeyValuePairsLength = aKeyValuePairs.length < 500 ? aKeyValuePairs.length : 500;
 
         for (i = 0, n = aKeyValuePairsLength; i < n; i += 1) {
             // decode key/value pair at first "=" character
@@ -574,7 +529,6 @@ sap.ui.define([
      */
     Utils.getParameterValue = function (sUrl, sName) {
         let oParameterMap;
-        let iQueryIndex;
 
         if (typeof sName !== "string") {
             // avoid surprises when sName would later be converted into a string
@@ -582,7 +536,7 @@ sap.ui.define([
         }
 
         sUrl = sUrl.split("#")[0];
-        iQueryIndex = sUrl.indexOf("?");
+        const iQueryIndex = sUrl.indexOf("?");
         if (iQueryIndex >= 0) {
             oParameterMap = Utils.getParameterMap(sUrl.slice(iQueryIndex));
             if (oParameterMap[sName]) {
@@ -630,11 +584,10 @@ sap.ui.define([
      * @since 1.2.0
      */
     Utils.parseXml = function (sXml) {
-        let oXml;
         if (!sXml || typeof sXml !== "string") {
             return null;
         }
-        oXml = new DOMParser().parseFromString(sXml, "text/xml");
+        const oXml = new DOMParser().parseFromString(sXml, "text/xml");
         if (oXml.getElementsByTagName("parsererror").length) { // Chrome, Firefox
             throw new SrvcError(`Invalid XML: ${sXml}`);
         }

package/src/main/js/sap/ushell_abap/pbServices/ui2/contracts/actions.js

@@ -211,12 +211,11 @@ sap.ui.define([
              * @see chip.types.getAvailableTypes
              */
             setType: function (sType) {
-                let sTypeLowerCase;
                 if (typeof sType !== "string" || sType === "") {
                     throw new SrvcError("The given type is not a string",
                         "contract.types");
                 }
-                sTypeLowerCase = sType.toLowerCase();
+                const sTypeLowerCase = sType.toLowerCase();
                 if (this.getAvailableTypes().indexOf(sTypeLowerCase) < 0) {
                     throw new SrvcError(`The CHIP does not support type '${sTypeLowerCase}'`,
                         "contract.types");

package/src/main/js/sap/ushell_abap/pbServices/ui2/contracts/configuration.js

@@ -141,7 +141,7 @@ sap.ui.define([
          * @name chip.writeConfiguration.setParameterValues
          * @function
          * @since 1.7.0
-         * @param {object<string,string>} mConfigurationUpdates
+         * @param {object<string, string>} mConfigurationUpdates
          *   The configuration updates. The values must be strings. You can however set a value to
          *   <code>undefined</code>. This removes it from the list of updated properties and effectively
          *   resets it to the default value.