@sapui5/types 1.145.0 → 1.146.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/ushell/library" {
   /**
@@ -890,6 +890,7 @@ declare module "sap/ushell/Container" {
      * An enumeration for the application work protect mode state.
      *
      * @since 1.21.1
+     * @deprecated As of version 1.146. the concept has been abandoned.
      */
     DirtyState: DirtyState;
 
@@ -925,7 +926,7 @@ declare module "sap/ushell/Container" {
      * Attaches a listener to the rendererCreated event.
      *
      * @since 1.34.1
-     * @deprecated As of version 1.120.
+     * @deprecated As of version 1.146. the concept has been abandoned.
      */
     attachRendererCreatedEvent(
       /**
@@ -991,6 +992,7 @@ declare module "sap/ushell/Container" {
      * Only the last registered function will be deregistered (in case it was registered multiple times).
      *
      * @since 1.67.0
+     * @deprecated As of version 1.146. replaced by {@link sap.ushell.navigation.DirtyState#deregisterDirtyStateProvider}.
      */
     deregisterDirtyStateProvider(
       /**
@@ -1013,7 +1015,7 @@ declare module "sap/ushell/Container" {
      * Detaches a listener from the rendererCreated event.
      *
      * @since 1.34.1
-     * @deprecated As of version 1.120.
+     * @deprecated As of version 1.146. the concept has been abandoned.
      */
     detachRendererCreatedEvent(
       /**
@@ -1029,7 +1031,7 @@ declare module "sap/ushell/Container" {
      * provider methods are ignored and the function simply returns 'true'.
      *
      * @since 1.27.0
-     * @deprecated As of version 1.120.
+     * @deprecated As of version 1.120. replaced by {@link sap.ushell.navigation.DirtyState#getDirtyFlag}.
      *
      * @returns The value of the dirty flag or the determined dirty state returned by the dirty state providers.
      */
@@ -1040,7 +1042,8 @@ declare module "sap/ushell/Container" {
      * All open UShell browser windows for the same origin are asked about their global dirty state.
      *
      * @since 1.21.1
-     * @deprecated As of version 1.120.
+     * @deprecated As of version 1.120. the concept has been abandoned. Use {@link sap.ushell.navigation.DirtyState#getDirtyFlag }
+     * instead.
      *
      * @returns Resolves the dirty state (see {@link sap.ushell.Container.DirtyState}).
      */
@@ -1225,6 +1228,7 @@ declare module "sap/ushell/Container" {
      * Use `Function.prototype.bind()` to determine the callback's `this` or some of its arguments.
      *
      * @since 1.31.0
+     * @deprecated As of version 1.146. replaced by {@link sap.ushell.navigation.DirtyState#registerDirtyStateProvider}.
      */
     registerDirtyStateProvider(
       /**
@@ -1236,7 +1240,7 @@ declare module "sap/ushell/Container" {
        * ```javascript
        *
        *  {
-       *    isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app our across two different applications.
+       *    isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app or across two different applications.
        *    innerAppRoute: "&/SalesOrder/11" // If it is an inner app navigation, it describes the inner app route.
        *  }
        *  ```
@@ -1249,6 +1253,7 @@ declare module "sap/ushell/Container" {
      * Default value is false
      *
      * @since 1.27.0
+     * @deprecated As of version 1.146. replaced by {@link sap.ushell.navigation.DirtyState#setDirtyFlag}.
      */
     setDirtyFlag(
       /**
@@ -1264,6 +1269,7 @@ declare module "sap/ushell/Container" {
    * An enumeration for the application work protect mode state.
    *
    * @since 1.90.0
+   * @deprecated As of version 1.146. the concept has been abandoned.
    */
   export type DirtyState = {
     /**
@@ -1281,6 +1287,85 @@ declare module "sap/ushell/Container" {
   };
 }
 
+declare module "sap/ushell/navigation/DirtyState" {
+  /**
+   * Module that stores the dirty state of the application.
+   *
+   * @since 1.146.0
+   */
+  interface DirtyState {
+    /**
+     * Deregister the work protection dirty callback function. See registerDirtyStateProvider for more information.
+     * Only the last registered function will be deregistered (in case it was registered multiple times).
+     *
+     * @since 1.146.0
+     */
+    deregisterDirtyStateProvider(
+      /**
+       * function for determining the state of the application
+       */
+      fnDirty: () => boolean
+    ): void;
+    /**
+     * If the dirty state was set to 'false' using 'setDirtyFlag' the registered dirty state provider methods
+     * get called to determine the actual dirty state. The determined dirty state is then returned.
+     *
+     * However, if the dirty state was previously set to 'true' using 'setDirtyFlag' the registered dirty state
+     * provider methods are ignored and the function simply returns 'true'.
+     *
+     * @since 1.146.0
+     *
+     * @returns The value of the dirty flag or the determined dirty state returned by the dirty state providers.
+     */
+    getDirtyFlag(): Promise<boolean>;
+    /**
+     * Register the work protection dirty callback function. In the work protect mechanism, each platform can
+     * register their own method in order to check if data was changed during the session, and notify the container
+     * about the change. Registering multiple times the same function is allowed.
+     *
+     * Use `Function.prototype.bind()` to determine the callback's `this` or some of its arguments.
+     *
+     * Note that registered callback functions are not automatically de-registered when an application is closed.
+     * Use {@link sap.ushell.navigation.DirtyState.deregisterDirtyStateProvider} to de-register the callback
+     * function.
+     *
+     * @since 1.146.0
+     */
+    registerDirtyStateProvider(
+      /**
+       * Function for determining the state of the application. The callback is used to determine the current
+       * dirty state during a navigation. The function must return a boolean which determines if the current application
+       * is dirty or not. If `true` is returned the end user is prompted with a dialog where they need to confirm
+       * the potential data loss. The callback is called with a navigation context as its first parameter which
+       * can be used to determine the dirty state:
+       * ```javascript
+       *
+       *  {
+       *    isCrossAppNavigation: true, // Boolean which indicates if the navigation is inner app or across two different applications.
+       *    innerAppRoute: "&/SalesOrder/11" // If it is an inner app navigation, it describes the inner app route.
+       *  }
+       *  ```
+       */
+      fnDirty: () => boolean
+    ): void;
+    /**
+     * Setter for the isDirty flag value.
+     *
+     * @since 1.146.0
+     *
+     * @returns Resolves when the dirty flag is set.
+     */
+    setDirtyFlag(
+      /**
+       * The value of the dirty flag.
+       */
+      bIsDirty?: boolean
+    ): Promise<undefined>;
+  }
+  const DirtyState: DirtyState;
+  export default DirtyState;
+}
+
 declare module "sap/ushell/renderers/fiori2/Renderer" {
   import {
     default as UIComponent,
@@ -2061,8 +2146,7 @@ declare module "sap/ushell/renderers/fiori2/Renderer" {
          */
         onCancel: Function;
         /**
-         * Experimental. Set this value to true if you want that your content is displayed without the standard
-         * header.
+         * Set this value to true if you want that your content is displayed without the standard header.
          */
         provideEmptyWrapper: boolean;
       },
@@ -2805,7 +2889,7 @@ declare module "sap/ushell/services/AppConfiguration" {
 declare module "sap/ushell/services/AppLifeCycle" {
   import Event from "sap/ui/base/Event";
 
-  import Component from "sap/ui/core/Component";
+  import CurrentApplication from "sap/ushell/services/AppLifeCycle/CurrentApplication";
 
   /**
    * The Unified Shell's AppLifeCycle service.
@@ -2828,25 +2912,6 @@ declare module "sap/ushell/services/AppLifeCycle" {
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
     protected constructor();
-    /**
-     * Enumeration of application info parameter names.
-     *
-     * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
-     * property 'AppInfoParameterName'.
-     *
-     * @since 1.120.0
-     */
-    static AppInfoParameterName: typeof AppInfoParameterName;
-
-    /**
-     * Enumeration of application types.
-     *
-     * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
-     * property 'ApplicationType'.
-     *
-     * @since 1.120.0
-     */
-    static ApplicationType: typeof ApplicationType;
 
     /**
      * Attaches an event handler for the appLoaded event. This event handler will be triggered each time an
@@ -2894,66 +2959,106 @@ declare module "sap/ushell/services/AppLifeCycle" {
      */
     getCurrentApplication(): CurrentApplication | undefined;
   }
+}
+
+declare module "sap/ushell/services/AppLifeCycle/CurrentApplication" {
+  import ApplicationType from "sap/ushell/services/AppLifeCycle/ApplicationType";
+
+  import Component from "sap/ui/core/Component";
+
+  import AppInfoParameterName from "sap/ushell/services/AppLifeCycle/AppInfoParameterName";
+
+  import { DecomposedHash } from "sap/ushell/services/URLParsing";
+
   /**
-   * Defines the application info.
+   * Defines the application info. Key-value pairs of application info parameters and their values.
    *
    * @since 1.120.0
    */
-  export type AppInfo = {
-    /**
-     * A human readable free form text maintained on the platform where FLP runs, and identifying the current
-     * product.
-     */
-    productName: string;
-    /**
-     * Current FLP theme. Includes the path to the theme resources if the theme is not an sap theme (does not
-     * start with sap_)
-     */
-    theme: string;
-    /**
-     * Current Language (BCP47 format)
-     */
-    languageTag: string;
-    /**
-     * Intent that was used to launch the application (including parameters)
-     */
-    appIntent: string;
+  export type AppInfo = Record<string, any>;
+
+  /**
+   * Defines the current application. This object is only valid until the next application navigation. Fetch
+   * it again from the AppLifeCycle service in the appLoaded event.
+   *
+   * @since 1.120.0
+   */
+  export default class CurrentApplication {
     /**
-     * ID of the framework
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
      */
-    appFrameworkId: string;
+    protected constructor();
     /**
-     * Identifier of the component that implements the base application.
+     * The type of the current application.
+     *
+     * @since 1.120.0
      */
-    technicalAppComponentId: string;
+    applicationType: ApplicationType | keyof typeof ApplicationType;
+
     /**
-     * Universal stable logical identifier of the application across the whole content.
+     * Reference to component. Only available for applicationType "UI5"
+     *
+     * @since 1.120.0
      */
-    appId: string;
+    componentInstance: Component | null;
+
     /**
-     * Version of the app
+     * `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
+     *
+     * @since 1.120.0
      */
-    appVersion: string;
+    homePage: boolean;
+
     /**
-     * The name of an organizational component that handles support incidents.
+     * A function to collect the values of the given parameters
+     *
+     * @since 1.120.0
+     *
+     * @returns Resolves to an object keeping the application info parameters with values
      */
-    appSupportInfo: string;
+    getInfo(
+      /**
+       * Array of requested parameters
+       */
+      aParameterNames: Array<
+        AppInfoParameterName | keyof typeof AppInfoParameterName
+      >
+    ): Promise<AppInfo>;
     /**
-     * Version of the framework
+     * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This method is for SAP-internal
+     * use only!
+     *
+     * @since 1.120.0
+     *
+     * @returns A promise that resolves with the intent of the current application
      */
-    appFrameworkVersion: string;
+    getIntent(
+      /**
+       * If set to true, the intent is extracted from the real application URL in case of a remote app
+       */
+      bRealAppIntent: boolean
+    ): Promise<DecomposedHash>;
     /**
-     * The FLP URL with the current hash included.
+     * function that returns the value of a technical parameter for the given application. This method is for
+     * SAP internal usage only.
+     *
+     * @since 1.120.0
+     *
+     * @returns A promise that resolves with the value of the technical parameter
      */
-    url: string;
-  };
+    getTechnicalParameter(
+      /**
+       * The name of the technical parameter
+       */
+      sParameterName: string
+    ): Promise<string>;
+  }
+}
 
+declare module "sap/ushell/services/AppLifeCycle/AppInfoParameterName" {
   /**
    * Enumeration of application info parameter names.
    *
-   * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
-   * property 'AppInfoParameterName'.
-   *
    * @since 1.120.0
    */
   enum AppInfoParameterName {
@@ -3004,12 +3109,13 @@ declare module "sap/ushell/services/AppLifeCycle" {
      */
     theme = "theme",
   }
+  export default AppInfoParameterName;
+}
+
+declare module "sap/ushell/services/AppLifeCycle/ApplicationType" {
   /**
    * Enumeration of application types.
    *
-   * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
-   * property 'ApplicationType'.
-   *
    * @since 1.120.0
    */
   enum ApplicationType {
@@ -3034,69 +3140,7 @@ declare module "sap/ushell/services/AppLifeCycle" {
      */
     WDA = "WDA",
   }
-  /**
-   * Defines the current application.
-   *
-   * @since 1.120.0
-   */
-  export type CurrentApplication = {
-    /**
-     * The type of the current application.
-     */
-    applicationType: ApplicationType | keyof typeof ApplicationType;
-    /**
-     * reference to component (only for applicationType "UI5")
-     */
-    componentInstance?: Component;
-    /**
-     * `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
-     */
-    homePage: boolean;
-    /**
-     * function that returns the value of a technical parameter for the given application. This method is for
-     * SAP internal usage only.
-     */
-    getTechnicalParameter: Function;
-    /**
-     * See {@link sap.ushell.services.URLParsing#parseShellHash} for details. This property is for SAP-internal
-     * use only!
-     */
-    getIntent: () => Promise<Intent>;
-    /**
-     * provides the values of the given parameters.
-     */
-    getInfo: (
-      p1: Array<AppInfoParameterName | keyof typeof AppInfoParameterName>
-    ) => Promise<AppInfo>;
-  };
-
-  /**
-   * Defines an intent. See {@link sap.ushell.services.URLParsing#parseShellHash} for details.
-   *
-   * @since 1.120.0
-   */
-  export type Intent = {
-    /**
-     * The semantic object of the intent.
-     */
-    semanticObject: string;
-    /**
-     * The action of the intent.
-     */
-    action: string;
-    /**
-     * The raw context of the intent.
-     */
-    contextRaw: string;
-    /**
-     * The parameters of the intent.
-     */
-    params: Record<string, string[]>;
-    /**
-     * The app specific route of the intent.
-     */
-    appSpecificRoute: string;
-  };
+  export default ApplicationType;
 }
 
 declare module "sap/ushell/services/Bookmark" {
@@ -4040,7 +4084,7 @@ declare module "sap/ushell/services/CrossApplicationNavigation" {
        *                               // Possible values are:
        *                               //   - "intent" (default) lexicographical sort on returned 'intent' field
        *                               //   - "text" lexicographical sort on returned 'text' field
-       *                               //   - "priority" experimental - top intents are returned first
+       *                               //   - "priority" top intents are returned first
        *
        *      treatTechHintAsFilter : true, // optional, defaults to false.
        *                                    // if true, only apps that match exactly the supplied technology (e.g. sap-ui-tech-hint=WDA) will be considered.
@@ -5241,8 +5285,10 @@ declare module "sap/ushell/services/FrameBoundExtension" {
      * The `controlType` can be any control and is by default a {@link sap.m.Bar}. The `controlProperties` are
      * passed to the constructor of the control.
      *
-     * **Note:** Only one footer is displayed at once. Any new footer will replace the previous one **Restriction:**
-     * NOT available for apps running in an iframe
+     * **Note:** Only one footer is displayed at once. Any new footer will replace the previous one **Note:**
+     * As several application views can provide own footer's, usage can result in a non aria complained HTML
+     * structure. Two 'footer' tags will be present in the HTML structure which ends in an invalid accessibility
+     * state. **Restriction:** NOT available for apps running in an iframe
      *
      * @since 1.124.0
      *
@@ -6842,7 +6888,7 @@ declare module "sap/ushell/services/Navigation" {
      * How the matching links should be sorted. Possible Values:
      * 	 -  `"intent"` lexicographical sort on returned 'intent' field
      * 	 -  `"text"` lexicographical sort on returned 'text' field
-     * 	 -  `"priority"` experimental - top intents are returned first
+     * 	 -  `"priority"` top intents are returned first
      */
     sortResultsBy?: string;
     /**
@@ -13111,6 +13157,10 @@ declare module "sap/ushell/ui/shell/ShellHeadItem" {
      * The press handler function.
      */
     press?: Function;
+    /**
+     * The tooltip used for the ShellHEadItem.
+     */
+    tooltip?: string;
   };
 }
 
@@ -14235,6 +14285,8 @@ declare namespace sap {
 
     "sap/ushell/modules/Search/SearchProvider": undefined;
 
+    "sap/ushell/navigation/DirtyState": undefined;
+
     "sap/ushell/renderer/ShellLayout": undefined;
 
     "sap/ushell/renderers/fiori2/Renderer": undefined;
@@ -14259,6 +14311,12 @@ declare namespace sap {
 
     "sap/ushell/services/AppLifeCycle": undefined;
 
+    "sap/ushell/services/AppLifeCycle/AppInfoParameterName": undefined;
+
+    "sap/ushell/services/AppLifeCycle/ApplicationType": undefined;
+
+    "sap/ushell/services/AppLifeCycle/CurrentApplication": undefined;
+
     "sap/ushell/services/Bookmark": undefined;
 
     "sap/ushell/services/BookmarkV2": undefined;

package/types/sap.ushell_abap.d.ts

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

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/uxap/library" {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/viz/library" {
   export namespace ui5 {

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/zen/commons/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/zen/crosstab/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.145.0
+// For Library Version: 1.146.0
 
 declare module "sap/zen/dsh/library" {}