@sapui5/ts-types 1.93.3 → 1.96.0

package/types/sap.ui.vtm.d.ts

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

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.93.2
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace uiext {
@@ -2169,6 +2169,7 @@ declare namespace sap {
       const InboxSecondaryFilterValuesEnum: InboxSecondaryFilterValuesEnum;
 
       /**
+       * @deprecated (since 1.38.0)
        * @EXPERIMENTAL (since 1.5.2)
        *
        * A comprehensive UI design approach with graphical and functional elements for search tasks, filter tasks,

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.93.3
+// For Library Version: 1.96.0
 
 declare namespace sap {
   /**
@@ -82,9 +82,13 @@ declare namespace sap {
          *
          * The SAPUI5 component of SAP Fiori Launchpad renderer for the Unified Shell.
          */
-        class Renderer extends sap.ui.core.UIComponent {
+        class Renderer
+          extends sap.ui.core.UIComponent
+          implements sap.ui.core.IAsyncContentCreation {
+          __implements__sap_ui_core_IAsyncContentCreation: boolean;
           /**
-           * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2")`.
+           * This method MUST be called by the Unified Shell's container only, others MUST call `sap.ushell.Container.createRenderer("fiori2",
+           * true)`.
            */
           constructor();
           /**
@@ -142,8 +146,6 @@ declare namespace sap {
            *  It will continue to work as expected as long as one of the following conditions apply:
            *  1. The control instance is already created and its ID is included in the input parameter oControlProperties
            *  2. The control type resource is already loaded
-           *  3. Synchronous XHR requests are supported by the browser
-           *
            * See:
            * 	sap.ushell.renderers.fiori2.renderer.LaunchpadState
            *   If no launchpad state is provided, the content is added in all states.
@@ -211,8 +213,6 @@ declare namespace sap {
            *  It will continue to work as expected as long as one of the following conditions apply:
            *  1. The control instance is already created and its ID is included in the input parameter oControlProperties
            *  2. The control type resource is already loaded
-           *  3. Synchronous XHR requests are supported by the browser
-           *
            * See:
            * 	LaunchpadState
            *   If no launchpad state is provided the content is added in all states.
@@ -483,8 +483,6 @@ declare namespace sap {
            *  It will continue to work as expected as long as one of the following conditions apply:
            *  1. The control instance is already created and its ID is included in the input parameter oControlProperties
            *  2. The control type resource is already loaded
-           *  3. Synchronous XHR requests are supported by the browser
-           *
            * See:
            * 	LaunchpadState
            *   If no launchpad state is provided the content is added in all states.
@@ -644,8 +642,6 @@ declare namespace sap {
            *  It will continue to work as expected as long as one of the following conditions apply:
            *  1. The control instance is already created and its ID is included in the input parameter oControlProperties
            *  2. The control type resource is already loaded
-           *  3. Synchronous XHR requests are supported by the browser
-           *
            * See:
            * 	LaunchpadState
            */
@@ -1084,7 +1080,6 @@ declare namespace sap {
            *  It will continue to work as expected as long as one of the following conditions apply:
            *  1. The control instance is already created and its ID is included in the input parameter oControlProperties
            *  2. The control type resource is already loaded
-           *  3. Synchronous XHR requests are supported by the browser
            */
           setFooterControl(
             /**
@@ -2063,7 +2058,7 @@ declare namespace sap {
              */
             icon?: string;
             /**
-             * The information text of the bookmark. This property is not relevant if CDM is used.
+             * The information text of the bookmark.
              */
             info?: string;
             /**
@@ -2079,7 +2074,7 @@ declare namespace sap {
              */
             serviceRefreshInterval?: string;
             /**
-             * The unit for the number retrieved from `serviceUrl`. This property is not relevant in the CDM context.
+             * The unit for the number retrieved from `serviceUrl`.
              */
             numberUnit?: string;
           },
@@ -2297,7 +2292,6 @@ declare namespace sap {
         cancelLogon(): void;
         /**
          * @SINCE 1.15.0
-         * @EXPERIMENTAL (since 1.55.0)
          *
          * Creates a new renderer instance for the given renderer name.
          *
@@ -2323,7 +2317,8 @@ declare namespace sap {
            */
           sRendererName?: string,
           /**
-           * If true, the renderer is created asynchronously and a Promise is returned.
+           * If true, the renderer is created asynchronously and a Promise is returned. For CSP compliance, applications
+           * must always set bAsync:true.
            */
           bAsync?: boolean
         ): sap.ui.core.Control | Promise<any>;
@@ -2379,6 +2374,18 @@ declare namespace sap {
          * All open UShell browser windows for the same origin are asked about their global dirty state.
          */
         getGlobalDirty(): jQuery.Deferred;
+        /**
+         * @SINCE 1.30.0
+         *
+         * Gets a renderer instance for the given renderer name, that was created by the createRenderer method.
+         */
+        getRenderer(
+          /**
+           * The renderer name, such as "standard" or "fiori2"; it is taken from the configuration property `defaultRenderer`
+           * if not given here.
+           */
+          sRendererName?: string
+        ): object;
         /**
          * @SINCE 1.15.0
          * @deprecated (since 1.77) - deprecated. Uses {@link#getServiceAsync} instead.
@@ -2424,7 +2431,10 @@ declare namespace sap {
          *       }
          *     }
          *   }
-         *   oService = sap.ushell.Container.getService("Foo", "runtimeConfig");
+         *   sap.ushell.Container.getServiceAsync("Foo", "runtimeConfig")
+         *       .then(function (Foo) {
+         *           // Do something with the service
+         *       });
          *   ```
          *  Now `oService` is an instance of `my.own.Foo`. The third parameter of the constructor will be "runtimeConfig",
          * the fourth parameter `{config: {header: "hidden"}}`. Its adapter is an instance of `my.own.FooAdapter`
@@ -2599,26 +2609,6 @@ declare namespace sap {
           }
         ): void;
       }
-      /**
-       * @SINCE 1.15.0
-       *
-       * This is a virtual type for the callback interface passed by {@link sap.ui.Container.getService()} to
-       * any newly created service.
-       */
-      class ContainerInterface {
-        /**
-         * See:
-         * 	sap.ushell.services.Container#getService
-         */
-        constructor();
-        /**
-         * @SINCE 1.15.0
-         *
-         * For the given remote system, creates a new adapter that corresponds to the service to which this container
-         * interface was passed at construction time.
-         */
-        createAdapter: undefined;
-      }
       /**
        * @SINCE 1.15.0
        */
@@ -2700,7 +2690,7 @@ declare namespace sap {
          * to change and therefore it may not yield to the expected results especially on mobile devices where "back"
          * is the previous inner app state iff these are put into the history!
          */
-        backToPreviousApp(): void;
+        backToPreviousApp(): Promise<void>;
         /**
          * if sHashFragment is a compacted hash (sap-intent-param is present), in a hash, this function replaces
          * it into a long url with all parameters expanded
@@ -2710,7 +2700,7 @@ declare namespace sap {
            * an (internal format) shell hash
            */
           sHashFragment: string
-        ): object;
+        ): jQuery.Promise;
         /**
          * @SINCE 1.38.0
          *
@@ -2879,7 +2869,7 @@ declare namespace sap {
            * whether the returned intents should be returned in compact format. Defaults to false.
            */
           bCompactIntents?: boolean
-        ): object;
+        ): jQuery.Promise;
         /**
          * performs window.history.go() with number of steps if provided and if supported by the underlying platform.
          * May be a noop if the url is the first url in the browser. If no argument is provided it wil call window.history.go(-1)
@@ -2892,6 +2882,7 @@ declare namespace sap {
         ): void;
         /**
          * @SINCE 1.15.0
+         * @deprecated (since 1.94) - Use `hrefForAppSpecificHashAsync` instead
          *
          * Returns a string which can be put into the DOM (e.g. in a link tag) given an application specific hash
          * suffix
@@ -2907,6 +2898,23 @@ declare namespace sap {
            */
           sAppHash: string
         ): string;
+        /**
+         * @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
+         *
+         * Example: `hrefForAppSpecificHash("View1/details/0/")` returns `#SemanticObject-action&/View1/details/0/`
+         * if the current application runs in the shell and was started using "SemanticObject-action" as shell navigation
+         * hash
+         */
+        hrefForAppSpecificHashAsync(
+          /**
+           * the app specific router, obtained e.g. via router.getURL(...). Note that sAppHash shall not exceed 512
+           * bytes when serialized as UTF-8.
+           */
+          sAppHash: string
+        ): Promise<string>;
         /**
          * @SINCE 1.15.0
          *
@@ -2947,7 +2955,7 @@ declare namespace sap {
           oComponent: object,
           /**
            * if set to `true`, a promise will be returned instead of the direct argument. The promise will only succeed
-           * after all compaction requests have been sent
+           * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
            */
           bAsync: boolean
         ): string;
@@ -2987,18 +2995,66 @@ declare namespace sap {
           oArgs: object,
           /**
            * if set to `true`, a promise will be returned instead of the direct argument. The promise will only succeed
-           * after all compaction requests have been sent
+           * after all compaction requests have been sent. `bAsync=false` is deprecated since 1.94.
            */
           bAsync: boolean
         ): string;
+        /**
+         * @SINCE 1.94.0
+         *
+         * Returns a string which 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" } }```
+           */
+          oArgs: object,
+          /**
+           * the root component of the application
+           */
+          oComponent?: object
+        ): Promise<string>;
         /**
          * @SINCE 1.36.0
+         * @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
          * home, or another target that adds an entry in the browser history.
          */
         isInitialNavigation(): boolean;
+        /**
+         * @SINCE 1.94.0
+         *
+         * 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
+         * home, or another target that adds an entry in the browser history.
+         */
+        isInitialNavigationAsync(): Promise<boolean>;
         /**
          * @SINCE 1.19.1
          * @deprecated - switch to isNavigationSupported. Note that this has a slightly different response format
@@ -3016,7 +3072,7 @@ declare namespace sap {
            * the root component of the application
            */
           oComponent?: object
-        ): object;
+        ): jQuery.Promise;
         /**
          * @SINCE 1.32
          *
@@ -3039,7 +3095,7 @@ declare namespace sap {
            * the root component of the application
            */
           oComponent?: object
-        ): object;
+        ): jQuery.Promise;
         /**
          * @SINCE 1.15.0
          *
@@ -3087,7 +3143,7 @@ declare namespace sap {
            * an optional SAP UI5 Component,
            */
           oComponent?: object
-        ): void;
+        ): Promise<void>;
       }
       /**
        * @SINCE 1.25.1
@@ -4745,76 +4801,17 @@ declare namespace sap {
          *
          *  The constructed service provides an enhancement on {@link CrossApplicationNavigation#getLinks} and
          * {@link CrossApplicationNavigation#toExternal}. In order for an application to leverage this enhancement,
-         * it is pertinent that the application uses {@link SmartNavigation#toExternal} for naviagtion. Hence the
+         * it is pertinent that the application uses {@link SmartNavigation#toExternal} for navigation. Hence the
          * caller can subsequently use {@link SmartNavigation#getLinks} with the outcome that it sorts the resulting
-         * list in the order of frequency of Attempted navigation from the application to respective links.
+         * list in the order of frequency of attempted navigation from the application to respective links.
          *  Attempted in the previous paragraph is emphasized due to the fact that a click on the link
-         * will cause an increment of the frequency count, regardless of wether the navigation was successful or
-         * not.  Note that an instance of this service should be obtained with `sap.ushell.services.Container#getServiceAsync("SmartNavigation").then(function
+         * will cause an increment of the frequency count, regardless of whether or not the navigation was successful.
+         *  Note that an instance of this service should only be obtained via `sap.ushell.services.Container#getServiceAsync("SmartNavigation").then(function
          * (SmartNavigation) {});`
          * See:
          * 	sap.ushell.services.Container#getServiceAsync
          */
         constructor();
-
-        /**
-         * @SINCE 1.44.0
-         *
-         * Resolves the given semantic object (or action) and business parameters to a list of links available to
-         * the user, sorted according their relevance to the calling application.
-         *
-         * The relevance of link is defined by the frequency with which a navigation activity from the calling application
-         * to that link occurs.
-         *
-         * Internally, this method delegates to {@link sap.ushell.services.CrossApplicationNavigation#getLinks}
-         * and then sorts the resulting list accordingly.
-         * See:
-         * 	sap.ushell.services.CrossApplicationNavigation#getLinks
-         */
-        getLinks(): jQuery.Promise;
-        /**
-         * @SINCE 1.48.0
-         *
-         * Completely delegates to {@link sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent}, and
-         * either may be used in place of the other with exactly the same outcome.
-         * See:
-         * 	sap.ushell.services.CrossApplicationNavigation#getPrimaryIntent
-         */
-        getPrimaryIntent(): void;
-        /**
-         * @SINCE 1.46.0
-         *
-         * Completely delegates to {@link sap.ushell.services.CrossApplicationNavigation#hrefFoExternal}, and either
-         * may be used in place of the other with exactly the same outcome.
-         * See:
-         * 	sap.ushell.services.CrossApplicationNavigation#hrefForExternal
-         */
-        hrefForExternal(): void;
-        /**
-         * @SINCE 1.44.0
-         *
-         * Usage of this method in place of {@link sap.ushell.services.CrossApplicationNavigation#toExternal} drives
-         * the smartness of the results returned by {@link sap.ushell.services.SmartNavigation#getLinks}.
-         * See:
-         * 	sap.ushell.services.CrossApplicationNavigation#toExternal
-         */
-        toExternal(): void;
-        /**
-         * @SINCE 1.46.0
-         *
-         * Tracks a navigation to a valid intent if provided via arguments but does not perform the navigation itself.
-         * If no valid intent was provided tracking will be prevented. The intent has to consist of SemanticObject
-         * and Action. It may be passed as complete shellHash (presidence) or as individual parts Additional parameters
-         * will not be part of the tracking and ignored This Method can be used to track a click if the actual navigation
-         * was triggered via clicking a link on the UI.
-         */
-        trackNavigation(
-          /**
-           * The navigation target as object, for example: `{ target: { shellHash: 'SaleOrder-display' } }` or ` {
-           * target: { semanticObject: 'SalesOrder', action: 'action' } } `
-           */
-          oArguments: object
-        ): object;
       }
       /**
        * @SINCE 1.19.1
@@ -5037,8 +5034,8 @@ declare namespace sap {
           /**
            * any value
            */
-          sURL: string
-        ): string;
+          sURL: String
+        ): String;
         /**
          * @SINCE 1.16.0
          *
@@ -5073,7 +5070,11 @@ declare namespace sap {
          * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
          *
          * The actual test is synchronous and *only* tests whether the hash part can be parsed and contains a semantic
-         * object and action. It does not test whether the intent or it's parameters is valid for a given user
+         * object and action. It does not test whether the intent or its parameters are valid for a given user
+         *
+         * This function does not work properly when used inside the app runtime as it compares the given URL to
+         * the app runtime's URL instead of the outer FLP's URL. It can still be used for synchronous use cases
+         * in the ushell that do not run inside the app runtime.
          */
         isIntentUrl(
           /**
@@ -5081,6 +5082,25 @@ declare namespace sap {
            */
           sUrl: string
         ): boolean;
+        /**
+         * @SINCE 1.96.0
+         *
+         * Check if a URL has an intent based navigation part which can be parsed into a semantic object and action
+         * part. Accepts only a relative URL (must contain #) or fully qualified Urls for which origin and filename
+         * must correspond to the running launchpad.
+         *
+         * Given actual url `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html?sap-language=DE#SO-action?P1=value1`,
+         * the following parts `http://www.mycorp.com/sap/fiori/FioriLaunchpad.html` must match.
+         *
+         * This function *only* tests whether the hash part can be parsed and contains a semantic object and action.
+         * It does not test whether the intent or its parameters are valid for a given user
+         */
+        isIntentUrlAsync(
+          /**
+           * the URL to test. Note: this url must be in internal format.
+           */
+          sUrl: string
+        ): Promise<boolean>;
         /**
          * @SINCE 1.20.0
          *
@@ -5091,8 +5111,8 @@ declare namespace sap {
           /**
            * any value { ABC : [1,"1 2"], DEF : ["4"]}
            */
-          oParams: object
-        ): string;
+          oParams: Object
+        ): String;
         /**
          * @SINCE 1.20.0
          *
@@ -5102,8 +5122,8 @@ declare namespace sap {
           /**
            * Parameter string, e.g. `?ABC=1&ABC=1%202DEF=4`
            */
-          sParams: string
-        ): object;
+          sParams: String
+        ): Object;
         /**
          * @SINCE 1.16.0
          *
@@ -5115,7 +5135,7 @@ declare namespace sap {
            *
            *  e.g. `"#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH`
            */
-          sHash: string
+          sHash: String
         ): object;
         /**
          * @SINCE 1.16.0
@@ -5129,7 +5149,7 @@ declare namespace sap {
            * Hash part of a shell conformant URL #SO-Action~Context?P1=a&P2=x&/route?RPV=1 the hash part
            * of an URL, e.g. "#Object-name~AFE2==?PV1=PV2&PV4=V5&/display/detail/7?UU=HH
            */
-          sHash: string
+          sHash: String
         ): object;
       }
       /**
@@ -9254,7 +9274,7 @@ declare namespace sap {
        *
        * // Component.js (the app root component)
        * ...
-       * this.getService("ShellUIService").then( // promise is returned
+       * this.getServiceAsync("ShellUIService").then( // promise is returned
        *    function (oService) {
        *       oService.setTitle("Application Title");
        *    },
@@ -9281,8 +9301,8 @@ declare namespace sap {
        *              "lazy": false,
        *              "factoryName": "sap.ushell.ui5service.ShellUIService",
        *              "settings": {
-       *                  "setHierarchy": "auto", // configuration under discussion currently
-       *                  "setTitle": "auto" // configuration under discussion currently
+       *                  "setHierarchy": "auto",
+       *                  "setTitle": "auto"
        *              }
        *          }
        *       }
@@ -9505,8 +9525,6 @@ declare namespace sap {
   }
 
   interface IUI5DefineDependencyNames {
-    "sap/ushell/bootstrap/homepage/mockContainer": undefined;
-
     "sap/ushell/components/factsheet/controls/PictureTile": undefined;
 
     "sap/ushell/components/factsheet/controls/PictureViewer": undefined;

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.93.3
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace ui {
@@ -458,7 +458,7 @@ declare namespace sap {
          * sticky session header requested. This is to avoid that the feature is disabled if the load balancer returns
          * another value for the sticky session header for some reason (e.g. the application server goes offline).
          *   NOTE: In line with {@link sap.ui2.srvc.PageBuildingService}, session stickiness is only supported
-         * in scopes different from PERS.   Currently, session stickiness is affected by the following limitations:
+         * in scopes different from PERS.   Currently, session stickiness is affected by the following restrictions:
          *
          * 	 - If the client caches the response headers for certain requests, these cached headers will be used
          * 			instead of the headers sent from the server (as in if cache was disabled).

package/types/sap.uxap.d.ts

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

package/types/sap.viz.d.ts

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.93.1
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace zen {
@@ -2800,6 +2800,10 @@ declare namespace sap {
          * busines formular style
          */
         BusinessStyleFormular = "BusinessStyleFormular",
+        /**
+         * custom style
+         */
+        CustomStyle = "CustomStyle",
         /**
          * mimicking spreadsheet
          */

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

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