@sapui5/ts-types 1.144.1 → 1.146.0

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.144.1
+// For Library Version: 1.146.0
 
 declare namespace sap {
   /**
@@ -101,10 +101,81 @@ declare namespace sap {
 
       namespace AppLifeCycle {
         /**
-         * Enumeration of application info parameter names.
+         * 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.
          *
-         * This enum is part of the 'sap/ushell/services/AppLifeCycle' module export and must be accessed by the
-         * property 'AppInfoParameterName'.
+         * @since 1.120.0
+         */
+        class CurrentApplication {
+          /**
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           */
+          protected constructor();
+          /**
+           * The type of the current application.
+           *
+           * @since 1.120.0
+           */
+          applicationType: sap.ushell.services.AppLifeCycle.ApplicationType;
+
+          /**
+           * Reference to component. Only available for applicationType "UI5"
+           *
+           * @since 1.120.0
+           */
+          componentInstance: sap.ui.core.Component | null;
+
+          /**
+           * `true` when root intent (normally #Shell-home) or Appfinder (#Shell-appfinder) is currently displayed.
+           *
+           * @since 1.120.0
+           */
+          homePage: boolean;
+
+          /**
+           * 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
+           */
+          getInfo(
+            /**
+             * Array of requested parameters
+             */
+            aParameterNames: sap.ushell.services.AppLifeCycle.AppInfoParameterName[]
+          ): Promise<sap.ushell.services.AppLifeCycle.AppInfo>;
+          /**
+           * 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
+           */
+          getIntent(
+            /**
+             * If set to true, the intent is extracted from the real application URL in case of a remote app
+             */
+            bRealAppIntent: boolean
+          ): Promise<sap.ushell.services.URLParsing.DecomposedHash>;
+          /**
+           * 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
+           */
+          getTechnicalParameter(
+            /**
+             * The name of the technical parameter
+             */
+            sParameterName: string
+          ): Promise<string>;
+        }
+        /**
+         * Enumeration of application info parameter names.
          *
          * @since 1.120.0
          */
@@ -159,9 +230,6 @@ declare namespace sap {
         /**
          * 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 {
@@ -187,122 +255,11 @@ declare namespace sap {
           WDA = "WDA",
         }
         /**
-         * Defines the application info.
-         *
-         * @since 1.120.0
-         */
-        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;
-          /**
-           * ID of the framework
-           */
-          appFrameworkId: string;
-          /**
-           * Identifier of the component that implements the base application.
-           */
-          technicalAppComponentId: string;
-          /**
-           * Universal stable logical identifier of the application across the whole content.
-           */
-          appId: string;
-          /**
-           * Version of the app
-           */
-          appVersion: string;
-          /**
-           * The name of an organizational component that handles support incidents.
-           */
-          appSupportInfo: string;
-          /**
-           * Version of the framework
-           */
-          appFrameworkVersion: string;
-          /**
-           * The FLP URL with the current hash included.
-           */
-          url: string;
-        };
-
-        /**
-         * Defines the current application.
-         *
-         * @since 1.120.0
-         */
-        type CurrentApplication = {
-          /**
-           * The type of the current application.
-           */
-          applicationType: sap.ushell.services.AppLifeCycle.ApplicationType;
-          /**
-           * reference to component (only for applicationType "UI5")
-           */
-          componentInstance?: sap.ui.core.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<sap.ushell.services.AppLifeCycle.Intent>;
-          /**
-           * provides the values of the given parameters.
-           */
-          getInfo: (
-            p1: sap.ushell.services.AppLifeCycle.AppInfoParameterName[]
-          ) => Promise<sap.ushell.services.AppLifeCycle.AppInfo>;
-        };
-
-        /**
-         * Defines an intent. See {@link sap.ushell.services.URLParsing#parseShellHash} for details.
+         * Defines the application info. Key-value pairs of application info parameters and their values.
          *
          * @since 1.120.0
          */
-        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;
-        };
+        type AppInfo = Record<string, any>;
       }
 
       namespace Bookmark {
@@ -528,6 +485,8 @@ declare namespace sap {
           /**
            * Shows the item for the current application. The item will be hidden after the user navigates away from
            * this application. The item will not be added again if the user navigates back to the application.
+           * Exception: Apps which are using the keep alive feature. There the visibility is restored together with
+           * the app.
            *
            * @since 1.120.0
            *
@@ -646,6 +605,8 @@ declare namespace sap {
           /**
            * Shows the item for the current application. The item will be hidden after the user navigates away from
            * this application. The item will not be added again if the user navigates back to the application.
+           * Exception: Apps which are using the keep alive feature. There the visibility is restored together with
+           * the app.
            *
            * @since 1.124.0
            *
@@ -905,7 +866,7 @@ declare namespace sap {
            * 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;
           /**
@@ -3751,7 +3712,7 @@ declare namespace sap {
            *                               // 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.
@@ -4847,8 +4808,10 @@ declare namespace sap {
          * 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
          *
@@ -8775,6 +8738,7 @@ declare namespace sap {
        * An enumeration for the application work protect mode state.
        *
        * @since 1.90.0
+       * @deprecated As of version 1.146. the concept has been abandoned.
        */
       type DirtyState = {
         /**
@@ -8792,6 +8756,83 @@ declare namespace sap {
       };
     }
 
+    namespace navigation {
+      /**
+       * 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>;
+      }
+    }
+
     namespace renderers {
       namespace fiori2 {
         /**
@@ -9571,8 +9612,7 @@ declare namespace sap {
                */
               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;
             },
@@ -12552,6 +12592,10 @@ declare namespace sap {
              * The press handler function.
              */
             press?: Function;
+            /**
+             * The tooltip used for the ShellHEadItem.
+             */
+            tooltip?: string;
           };
         }
         /**
@@ -13499,6 +13543,7 @@ declare namespace sap {
        * 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: sap.ushell.Container.DirtyState;
 
@@ -13534,7 +13579,7 @@ declare namespace sap {
        * 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(
         /**
@@ -13600,6 +13645,7 @@ declare namespace sap {
        * 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(
         /**
@@ -13622,7 +13668,7 @@ declare namespace sap {
        * 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(
         /**
@@ -13638,7 +13684,7 @@ declare namespace sap {
        * 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.
        */
@@ -13649,7 +13695,8 @@ declare namespace sap {
        * 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}).
        */
@@ -13834,6 +13881,7 @@ declare namespace sap {
        * 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(
         /**
@@ -13845,7 +13893,7 @@ declare namespace sap {
          * ```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.
          *  }
          *  ```
@@ -13858,6 +13906,7 @@ declare namespace sap {
        * Default value is false
        *
        * @since 1.27.0
+       * @deprecated As of version 1.146. replaced by {@link sap.ushell.navigation.DirtyState#setDirtyFlag}.
        */
       setDirtyFlag(
         /**
@@ -14007,6 +14056,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;
@@ -14031,6 +14082,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.144.1
+// 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.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   /**
@@ -1140,8 +1140,7 @@ declare namespace sap {
       /**
        * The list of Subsections.
        *
-       * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
-       * reasons.
+       * **Note:** If you use multiple subsections, set a `title` for each subsection to avoid accessibility violations.
        */
       subSections?:
         | sap.uxap.ObjectPageSubSection[]
@@ -1173,8 +1172,12 @@ declare namespace sap {
        * Defines the title of the respective section/subsection.
        *
        * **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
-       * instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
+       * instead of the section title. This behavior is true even if the `showTitle` property of {@link sap.uxap.ObjectPageSubSection }
        * is set to `false`.
+       *
+       * **Note:** To avoid accessibility issues, always set a `title` on {@link sap.uxap.ObjectPageSubSection},
+       * especially when a section contains multiple subsections. If no `title` is set on a subsection, the anchor
+       * bar button popover will appear empty, which will lead to accessibility violations.
        */
       title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
@@ -7099,8 +7102,7 @@ declare namespace sap {
        *
        * The list of Subsections.
        *
-       * Note: If multiple subsections are used, it is highly recommended to set a title for the section for accessibility
-       * reasons.
+       * **Note:** If you use multiple subsections, set a `title` for each subsection to avoid accessibility violations.
        */
       getSubSections(): sap.uxap.ObjectPageSubSection[];
       /**
@@ -7396,9 +7398,13 @@ declare namespace sap {
        * Defines the title of the respective section/subsection.
        *
        * **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
-       * instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
+       * instead of the section title. This behavior is true even if the `showTitle` property of {@link sap.uxap.ObjectPageSubSection }
        * is set to `false`.
        *
+       * **Note:** To avoid accessibility issues, always set a `title` on {@link sap.uxap.ObjectPageSubSection},
+       * especially when a section contains multiple subsections. If no `title` is set on a subsection, the anchor
+       * bar button popover will appear empty, which will lead to accessibility violations.
+       *
        *
        * @returns Value of property `title`
        */
@@ -7486,9 +7492,13 @@ declare namespace sap {
        * Defines the title of the respective section/subsection.
        *
        * **Note:** If a subsection is the only one (or the only one visible) within a section, its title is displayed
-       * instead of the section title. This behavior is true even if the `showTitle` propeprty of {@link sap.uxap.ObjectPageSubSection }
+       * instead of the section title. This behavior is true even if the `showTitle` property of {@link sap.uxap.ObjectPageSubSection }
        * is set to `false`.
        *
+       * **Note:** To avoid accessibility issues, always set a `title` on {@link sap.uxap.ObjectPageSubSection},
+       * especially when a section contains multiple subsections. If no `title` is set on a subsection, the anchor
+       * bar button popover will appear empty, which will lead to accessibility violations.
+       *
        * When called with a value of `null` or `undefined`, the default value of the property will be restored.
        *
        *

package/types/sap.viz.d.ts

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

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

@@ -1,3 +1,3 @@
-// For Library Version: 1.144.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.144.0
+// For Library Version: 1.146.0
 
 declare namespace sap {
   namespace zen {

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

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

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

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