@sapui5/sap.ushell_abap 1.97.1 → 1.99.1

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>sap.ushell_abap.pbServices.ui2.Chip</code> object with related functions.
@@ -170,8 +170,7 @@ sap.ui.define([
                 // eslint-disable-next-line no-useless-escape
                 aMatches = /^(?:([^\/]+)\/)?(.*)\.view\.(.*)$/.exec(sViewName);
                 if (!aMatches) {
-                    throw new SrvcError(that + ": Illegal view name: " + sViewName,
-                        "Chip");
+                    throw new SrvcError(that + ": Illegal view name: " + sViewName, "Chip");
                 }
 
                 // determine namespace, view name, and view type
@@ -502,6 +501,18 @@ sap.ui.define([
             return oAlterEgo.id;
         };
 
+        /**
+         * Returns this CHIP's reference ID also known as the stable ID
+         *
+         * @returns {string}
+         *  this CHIP's reference ID
+         * @since 1.98.0
+         * @private
+         */
+        this.getReferenceChipId = function () {
+            return oAlterEgo.referenceChipId;
+        };
+
         /**
          * Returns this CHIP instance's implementation of type SAPUI5 as a control. This control
          * represents the root of this CHIP instance's UI from a page builder point of view. Can only
@@ -512,12 +523,18 @@ sap.ui.define([
          * @returns {sap.ui.core.Control}
          *   this CHIP instance's SAPUI5 implementation as a control
          * @since 1.2.0
+         * @deprecated since version 1.97. Use <code>getImplementationAsSapui5Async</code> instead
          *
          * @see #isStub()
          */
         this.getImplementationAsSapui5 = function (oApi) {
             var oData, oImplementation, sBaseChipId;
 
+            Log.error("Deprecated API call of 'Chip.getImplementationAsSapui5'. Please use 'getImplementationAsSapui5Async' instead",
+                null,
+                "sap.ushell_abap.pbServices.ui2.Chip"
+            );
+
             checkStub();
             oData = {
                 /*
@@ -542,12 +559,25 @@ sap.ui.define([
 
             if (oImplementation.componentName) {
                 // SAPUI5 component
-                return new sap.ui.core.ComponentContainer({
-                    component: sap.ui.getCore().createComponent({
-                        componentData: oData,
-                        name: oImplementation.componentName
-                    })
+                var oComponentContainer = new sap.ui.core.ComponentContainer();
+                // load the content lazily to enable components using async interface
+                this.oComponentPromise = new Promise(function (resolve, reject) {
+                    sap.ui.require([
+                        "sap/ui/core/Component"
+                    ], function (Component) {
+                        Component.create({
+                            name: oImplementation.componentName,
+                            componentData: oData
+                        })
+                            .then(function (oComponent) {
+                                oComponentContainer.setComponent(oComponent);
+                            })
+                            .then(resolve)
+                            .catch(reject);
+                    });
                 });
+
+                return oComponentContainer;
             }
 
             // SAPUI5 MVC
@@ -558,6 +588,80 @@ sap.ui.define([
             });
         };
 
+        /**
+         * Returns this CHIP instance's implementation of type SAPUI5 as a control. This control
+         * represents the root of this CHIP instance's UI from a page builder point of view. Can only
+         * be called if the CHIP is not a stub anymore.
+         *
+         * @param {object} oApi
+         *   the CHIP instance specific API
+         * @returns {Promise<sap.ui.core.Control>}
+         *   this CHIP instance's SAPUI5 implementation as a control
+         * @since 1.97.0
+         *
+         * @see #isStub()
+         */
+        this.getImplementationAsSapui5Async = function (oApi) {
+            try {
+                checkStub();
+            } catch (oError) {
+                return Promise.reject(oError);
+            }
+
+            return new Promise(function (resolve, reject) {
+                sap.ui.require([
+                    "sap/ui/core/ComponentContainer",
+                    "sap/ui/core/Component",
+                    "sap/ui/core/mvc/View"
+                ], function (ComponentContainer, Component, View) {
+                    var oData = {
+                        /*
+                        * @namespace The namespace for the instance specific CHIP API, which allows you to
+                        * access the various contracts consumed by your CHIP instance.
+                        * @name chip
+                        */
+                        chip: oApi
+                    };
+                    var oImplementation = oDefinition.implementation.sapui5;
+
+                    // In case the chip is used in FLP wave 2 or later context we load it from the standard path
+                    var sBaseChipId = this.getBaseChipId();
+                    if ((sBaseChipId !== "X-SAP-UI2-CHIP:/UI2/STATIC_APPLAUNCHER") && (sBaseChipId !== "X-SAP-UI2-CHIP:/UI2/DYNAMIC_APPLAUNCHER")) {
+                        if (oImplementation.$VirtualNamespace) {
+                            oImplementation.$absolutePath = this.toAbsoluteUrl(oImplementation.basePath);
+                            jQuery.sap.registerModulePath(oImplementation.$Namespace, oImplementation.$absolutePath);
+                        } else {
+                            jQuery.sap.registerModulePath(oImplementation.$Namespace, oImplementation.$UrlPrefix);
+                        }
+                    }
+
+                    if (oImplementation.componentName) {
+                        // SAPUI5 component
+                        return Component.create({
+                            name: oImplementation.componentName,
+                            componentData: oData
+                        })
+                            .then(function (oComponent) {
+                                return new ComponentContainer({
+                                    component: oComponent
+                                });
+                            })
+                            .then(resolve)
+                            .catch(reject);
+                    }
+
+                    // SAPUI5 MVC
+                    return View.create({
+                        type: oImplementation.$ViewType,
+                        viewName: oImplementation.$ViewName,
+                        viewData: oData
+                    })
+                        .then(resolve)
+                        .catch(reject);
+                }.bind(this));
+            }.bind(this));
+        };
+
         /**
          * Returns the catalog by which this remote CHIP was loaded. This catalog is
          * <code>undefined</code> if the CHIP is from the same system as the catalog.
@@ -951,8 +1055,8 @@ sap.ui.define([
          * This is only relevant when the CHIP navigation property was expanded
          * (OData $expand).
          *
-         * @returns {boolean}
-         *    Whether the CHIP initially existed.
+         * @param {boolean} bDefined defined
+         * @returns {boolean} Whether the CHIP initially existed.
          *
          * @private
          */
@@ -963,6 +1067,12 @@ sap.ui.define([
             oAlterEgo && !oAlterEgo.hasOwnProperty("$proxy") // $proxy (set from factory) when null
         );
 
+        // for test purposes -------------------------------------------------------
+
+        this._setDefinition = function (oNewDefinition) {
+            oDefinition = oNewDefinition;
+        };
+
         // constructor code -------------------------------------------------------
         if (!oAlterEgo) {
             throw new SrvcError("Missing CHIP description", "Chip");
@@ -1016,11 +1126,13 @@ sap.ui.define([
         delete mContractsByName[sName];
     };
 
-    // TODO remove when FLPD is adapted (uses this function in global namespace)
-    if (jQuery && jQuery.sap) { // true only in FLPD case
-        jQuery.sap.declare("sap.ui2.srvc.chip");
-        jQuery.sap.declare("sap.ui2.srvc.Chip");
-        sap.ui2.srvc.Chip = sap.ui2.srvc.chip = Chip;
+    // Add "navigation" contract stub as this is requested in some cases for historic reasons - but not used in FLP scenarios
+    if (!mContractsByName.navigation) {
+        Chip.addContract("navigation", function (oChipInstance) {
+            this.navigateToUrl = function (sUrl, oSettings) {
+                throw new SrvcError("'navigation' contract not implemented!");
+            };
+        });
     }
 
     return Chip;

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>sap.ushell_abap.pbServices.ui2.ChipDefinition</code> object, representing an XML document

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>sap.ushell_abap.pbServices.ui2.ChipInstance</code> object with related functions.
@@ -396,7 +396,7 @@ sap.ui.define([
          * @name chip
          * @since 1.2.0
          *
-         * @see sap.ushell_abap.pbServices.ui2.ChipInstance#getImplementationAsSapui5
+         * @see sap.ushell_abap.pbServices.ui2.ChipInstance#getImplementationAsSapui5Async
          */
 
         /**
@@ -459,10 +459,15 @@ sap.ui.define([
          * @returns {sap.ui.core.Control}
          *   this CHIP instance's SAPUI5 implementation as a control
          * @since 1.2.0
+         * @deprecated since version 1.97. Use <code>getImplementationAsSapui5Async</code> instead
          *
          * @see #isStub()
          */
         this.getImplementationAsSapui5 = function () {
+            Log.error("Deprecated API call of 'ChipInstance.getImplementationAsSapui5'. Please use 'getImplementationAsSapui5Async' instead",
+                null,
+                "sap.ushell_abap.pbServices.ui2.ChipInstance"
+            );
             checkStub();
             return oChip.getImplementationAsSapui5(oApi);
         };
@@ -478,11 +483,14 @@ sap.ui.define([
          *
          * @see #isStub()
          */
-         this.getImplementationAsSapui5Async = function () {
-            return new Promise(function (resolve, reject) {
+        this.getImplementationAsSapui5Async = function () {
+            try {
                 checkStub();
-                resolve(oChip.getImplementationAsSapui5(oApi));
-            });
+            } catch (oError) {
+                return Promise.reject(oError);
+            }
+
+            return oChip.getImplementationAsSapui5Async(oApi);
         };
 
         /**

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview An error object which logs the error message immediately.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A factory for wrapper objects corresponding to the four

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A facade to any OData service, providing CSRF token handling and a default

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A wrapper around <code>OData</code>, providing CSRF token handling, caching and

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A wrapper for a page loaded from the page building service.
@@ -909,12 +909,5 @@ sap.ui.define([
         Log.debug("Created: " + this, null, "Page");
     };
 
-    // TODO remove when SSB is adapted (uses this module in global namespace)
-    if (jQuery && jQuery.sap) { // true only in FLPD case
-        jQuery.sap.declare("sap.ui2.srvc.chip");
-        jQuery.sap.declare("sap.ui2.srvc.Chip");
-        sap.ui2.srvc.Page = sap.ui2.srvc.page = Page;
-    }
-
     return Page;
 }, true);

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A facade to the page building service, providing all needed

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A wrapper for a page set loaded from the page building service.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview A catalog service which is able to read CHIPs from a remote server.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /* eslint-disable no-console */
 
@@ -756,12 +756,5 @@ sap.ui.define([
     // initialize the cache for GET
     Utils.clearCache();
 
-
-    // TODO remove when FLPD is adapted (uses this function in global namespace)
-    sap.ui2 = sap.ui2 || {};
-    sap.ui2.srvc = sap.ui2.srvc || {};
-    sap.ui2.srvc.removeCBAndNormalizeUrl = Utils.removeCBAndNormalizeUrl;
-    sap.ui2.srvc.addCacheBusterTokenUsingUshellConfig = Utils.addCacheBusterTokenUsingUshellConfig;
-
     return Utils;
 });

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>actions</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>bag</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>configuration</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>configurationUi</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>fullscreen</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>preview</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>refresh</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>search</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview Dummy file, The <code>types</code> contract is in the file contracts/actions.js !

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>url</code> contract.

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

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /**
  * @fileOverview The <code>visible</code> contract.

package/src/main/js/sap/ushell_abap/support/plugins/app-infra/AppInfraOnSapNetWeaverSupportPlugin.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 /* eslint-disable no-console */
 

package/src/main/js/sap/ushell_abap/ui5appruntime/AppInfoAdapter.js

@@ -1,4 +1,4 @@
-// Copyright (c) 2009-2022 SAP SE. All rights reserved.
+// Copyright (c) 2009-2022 SAP SE, All Rights Reserved
 
 // Implementation of an AppInfoAdapter for the ABAP platform
 // Loads UI5 app index data for the UI5 app runtime