@sapui5/ts-types 1.97.2 → 1.98.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.1
+// For Library Version: 1.98.0
 
 declare namespace sap {
   /**
@@ -23,42 +23,51 @@ declare namespace sap {
     /**
      * @SINCE 1.15.0
      *
-     * Initializes the Unified Shell container for the given platform. This method must be called exactly once
-     * in the very beginning by platform-specific code in order to bootstrap the container. As soon as the returned
-     * promise has been resolved, the container will be available as a singleton object `sap.ushell.Container`.
+     * Initializes the Unified Shell Container.
      *
-     * For convenience, platform-specific bootstrap code is available and can be easily included (**before**
-     * the SAPUI5 bootstrap) by a corporate shell as follows:
-     * ```javascript
+     * This platform-specific method must be called exactly once in the very beginning to resolve all necessary
+     * depdencies and prepare Unified Shell's global infrastructure. As soon as the returned promise has been
+     * resolved, the container will be available as a singleton object in namespace `sap.ushell.Container`.
      *
-     * <script src="/sap/public/bc/ui5_ui5/resources/sap/ushell_abap/evo/bootstrap/abap.js"></script>
-     * <script id="sap-ui-bootstrap" src=".../sap-ui-core.js"></script>
-     * ```
-     *  This bootstrap code will automatically defer the initialization of SAPUI5 until the container is available.
-     * This is the preferred way of bootstrapping the Unified Shell.
+     * **Note:** `sap.ushell.bootstrap` is used internally by the Fiori Launchpad. Developers that build apps
+     * or plugins for the Fiori Launchpad must not use `sap.ushell.bootstrap` in their code. However, there
+     * are special use cases where a customized bootstrap of Unified Shell makes sense, e.g. when Unified Shell
+     * UI services need to be accessed without having loaded the Unified Shell's UI. In such cases, additional
+     * depdencides need to be required to allow proper usage of Unified Shell's functionality.
      *
-     * Note: For SAPUI5 application projects the recommended way is to add a dependency to the "sap.ushell_abap"
-     * library (`<groupId>com.sap.ushell</groupId> <artifactId>ushell_abap</artifactId>`)
-     * and load the bootstrap code via the application's resources folder:
+     * **Example:**
      * ```javascript
      *
-     * <script src=".../resources/sap/ushell_abap/bootstrap/evo/abap.js"></script>
-     * <script id="sap-ui-bootstrap" src=".../sap-ui-core.js"></script>
-     * ```
+     * <!--...-->
+     * <script id="sap-ui-bootstrap"
+     *         src=".../sap-ui-core.js"
+     *         data-sap-ui-libs="sap.ushell,sap.m">
+     * </script>
+     * <!--...-->
+     * <script>
+     *   sap.ui.getCore().attachInit(function () {
+     *     sap.ui.require([\/* ... *\/], function (\/* ... *\/) {
+     *       window["sap-ushell-config"] = {\/* config *\/};
      *
+     *       sap.ushell.bootstrap("abap", {
+     *         abap: "sap.ushell_abap.adapters.abap"
+     *       }).then(function () {
+     *         sap.ushell.Container.getServiceAsync(\/* Service *\/).then(function (serviceInstance) {
+     *           \/* ... *\/
+     *         });
+     *       });
+     *     });
+     *   });
+     * </script>
+     * <!--...-->
+     * ```
      *
-     * Since 1.15.0 you can provide the function `window['sap.ushell.bootstrap.callback']` for calling back
-     * from this method asynchronously. SAPUI5's bootstrap is ongoing then. The same restrictions apply as for
-     * the function `window['sap-ui-config']['xx-bootTask']`) when the Unified Shell container has not yet finished
-     * its bootstrap. You cannot delay the bootstrap of SAPUI5 or the Unified Shell container; any errors are
-     * ignored. This callback is useful for sending asynchronous back-end requests at the earliest opportunity
-     * without delaying the core bootstrap of SAPUI5 and the Unified Shell container.
      * See:
      * 	sap.ushell.Container
      */
     function bootstrap(
       /**
-       * the target platform, such as "abap" or "local" (Note: there is no fixed enumeration of possible platforms)
+       * the target platform, such as "abap" or "cdm".
        */
       sPlatform: string,
       /**
@@ -2624,24 +2633,11 @@ declare namespace sap {
          *
          * This interface is for usage by applications or shell renderers/containers.
          *
-         * Usage:
-         * ```javascript
-         *
-         *   sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService) {
-         *
-         *      var sHref = oService.hrefForExternal({
-         *          target : {
-         *              semanticObject : "Product",
-         *              action : "display" },
-         *          params : {
-         *              "ProductID" : "102343333"
-         *          }
-         *      }) || "";
-         *
-         *      // do something with sHref
-         *   });
-         *   ```
+         * Usage:  sap.ushell.Container.getServiceAsync("CrossApplicationNavigation").then( function (oService)
+         * {
          *
+         * oService.hrefForExternalAsync({ target : { semanticObject : "Product", action : "display" }, params :
+         * { "ProductID" : "102343333" } }).then( function(sHref) { // do something with sHref }); });
          *
          * Parameter names and values are case sensitive.
          *
@@ -2832,7 +2828,7 @@ declare namespace sap {
         ): jQuery.Deferred;
         /**
          * @SINCE 1.19.0
-         * @deprecated (since 1.38.0) - use getLinks
+         * @deprecated (since 1.38) - use getLinks() instead.
          *
          * Resolves a given semantic object and business parameters to a list of links, taking into account the
          * form factor of the current device.
@@ -2901,10 +2897,10 @@ declare namespace sap {
         /**
          * @SINCE 1.94.0
          *
-         * Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash
-         * suffix
+         * Returns a Promise which resolves a string that can be put into the DOM (e.g. in a link tag) given an
+         * application specific hash suffix
          *
-         * Example: `hrefForAppSpecificHash("View1/details/0/")` returns `#SemanticObject-action&/View1/details/0/`
+         * Example: `hrefForAppSpecificHashAsync("View1/details/0/")` returns a Promise that resolves: `#SemanticObject-action&/View1/details/0/`
          * if the current application runs in the shell and was started using "SemanticObject-action" as shell navigation
          * hash
          */
@@ -2917,6 +2913,8 @@ declare namespace sap {
         ): Promise<string>;
         /**
          * @SINCE 1.15.0
+         * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
+         * instead.
          *
          * Returns a string which can be put into the DOM (e.g. in a link tag)
          */
@@ -2958,9 +2956,11 @@ declare namespace sap {
            * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
            */
           bAsync: boolean
-        ): string;
+        ): string | Promise<string>;
         /**
          * @SINCE 1.15.0
+         * @deprecated (since 1.98) - Use {@link sap.ushell.services.CrossApplicationNavigation#hrefForExternalAsync}
+         * instead.
          *
          * Returns a string which can be put into the DOM (e.g. in a link tag)
          */
@@ -2998,39 +2998,18 @@ declare namespace sap {
            * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
            */
           bAsync: boolean
-        ): string;
+        ): string | Promise<string>;
         /**
          * @SINCE 1.94.0
          *
-         * Returns a string which can be put into the DOM (e.g. in a link tag)
+         * Returns a Promise which resolves a string. That string can be put into the DOM (e.g. in a link tag)
          */
         hrefForExternalAsync(
           /**
-           * object encoding a semantic object and action, e.g.
-           * ```javascript
-           *
-           *   {
-           *     target : { semanticObject : "AnObject", action: "action" },
-           *     params : { A : "B" }
-           *   }
-           *   ```
-           *  or e.g.
-           * ```javascript
-           *
-           *   {
-           *     target : {
-           *       semanticObject : "AnObject",
-           *       action: "action", context  : "AB7F3C"
-           *     },
-           *     params : {
-           *       A : "B",
-           *       c : "e"
-           *     }
-           *   }
-           *   ```
-           *  or
-           * ```javascript
-           * { target : { shellHash : "SO-36?jumper=postman" } }```
+           * object encoding a semantic object and action, e.g. ` { target : { semanticObject : "AnObject", action:
+           * "action" }, params : { A : "B" } } ` or e.g. ` { target : { semanticObject : "AnObject", action: "action",
+           * context : "AB7F3C" }, params : { A : "B", c : "e" } } ` or `{ target : { shellHash : "SO-36?jumper=postman"
+           * } }`
            */
           oArgs: object,
           /**
@@ -3040,7 +3019,7 @@ declare namespace sap {
         ): Promise<string>;
         /**
          * @SINCE 1.36.0
-         * @deprecated (since 1.94) - Use `isInitialNavigationAsync` instead
+         * @deprecated (since 1.94) - Use `isInitialNavigationAsync` instead.
          *
          * Checks whether the FLP has performed the first navigation. This method can be used to detect whether
          * the current app was started directly, that is, without a previous navigation to another app, to the FLP

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.1
+// For Library Version: 1.98.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.1
+// For Library Version: 1.98.0
 
 declare namespace sap {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.1
+// For Library Version: 1.98.0
 
 declare namespace sap {
   /**

package/types/sap.webanalytics.core.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.98.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.zen.commons.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.98.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.crosstab.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.98.0
 
 declare namespace sap {
   namespace zen {

package/types/sap.zen.dsh.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.97.0
+// For Library Version: 1.98.0
 
 declare namespace sap {
   namespace zen {
@@ -496,10 +496,6 @@ declare namespace sap {
              */
             sDim: string
           ): this;
-          /**
-           * Resets this data provider to the state after the metadata import
-           */
-          resetToDefault(): void;
           /**
            * Distribute the dimension among the rows and columns
            */

package/types/sap.fe.placeholder.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.plugins.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.semantics.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}

package/types/sap.fe.tools.d.ts

@@ -1,3 +0,0 @@
-// For Library Version: 1.97.0
-
-declare namespace sap {}