@sapui5/types 1.117.1 → 1.118.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/types",
-  "version": "1.117.1",
+  "version": "1.118.0",
   "description": "SAPUI5 TypeScript Definitions",
   "homepage": "https://sap.github.io/ui5-typescript/",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -44,7 +44,6 @@
 /// <reference path="./sap.fe.macros.d.ts"/>
 /// <reference path="./sap.fe.navigation.d.ts"/>
 /// <reference path="./sap.fe.placeholder.d.ts"/>
-/// <reference path="./sap.fe.plugins.optimisticBatch.d.ts"/>
 /// <reference path="./sap.fe.templates.d.ts"/>
 /// <reference path="./sap.fe.test.d.ts"/>
 /// <reference path="./sap.fe.tools.d.ts"/>

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/apf/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/ca/ui/library" {
   export namespace charts {

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.1
+// For Library Version: 1.118.0
 
 declare module "sap/chart/library" {
   import Dimension from "sap/chart/data/Dimension";

package/types/sap.collaboration.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/collaboration/library" {
   /**

package/types/sap.esh.search.ui.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/esh/search/ui/library" {}
 

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.1
+// For Library Version: 1.118.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -1517,9 +1517,14 @@ declare module "sap/f/CardBase" {
 declare module "sap/f/cards/BaseHeader" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
+  import Text from "sap/m/Text";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
 
   /**
    * @since 1.86
@@ -1587,6 +1592,29 @@ declare module "sap/f/cards/BaseHeader" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Adds some bannerLine to the aggregation {@link #getBannerLines bannerLines}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    addBannerLine(
+      /**
+       * The bannerLine to add; if empty, nothing is inserted
+       */
+      oBannerLine: Text
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Destroys all the bannerLines in the aggregation {@link #getBannerLines bannerLines}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    destroyBannerLines(): this;
     /**
      * @since 1.86
      * @experimental (since 1.86)
@@ -1596,6 +1624,15 @@ declare module "sap/f/cards/BaseHeader" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroyToolbar(): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets content of aggregation {@link #getBannerLines bannerLines}.
+     *
+     * Show as a banner in the header area. Use for example for system info and application shortcut.
+     */
+    getBannerLines(): Text[];
     /**
      * @experimental (since 1.89) - this feature is experimental and the API may change.
      *
@@ -1634,6 +1671,66 @@ declare module "sap/f/cards/BaseHeader" {
      * Defines the toolbar.
      */
     getToolbar(): Control;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Checks for the provided `sap.m.Text` in the aggregation {@link #getBannerLines bannerLines}. and returns
+     * its index if found or -1 otherwise.
+     *
+     * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+     */
+    indexOfBannerLine(
+      /**
+       * The bannerLine whose index is looked for
+       */
+      oBannerLine: Text
+    ): int;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Inserts a bannerLine into the aggregation {@link #getBannerLines bannerLines}.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    insertBannerLine(
+      /**
+       * The bannerLine to insert; if empty, nothing is inserted
+       */
+      oBannerLine: Text,
+      /**
+       * The `0`-based index the bannerLine should be inserted at; for a negative value of `iIndex`, the bannerLine
+       * is inserted at position 0; for a value greater than the current size of the aggregation, the bannerLine
+       * is inserted at the last position
+       */
+      iIndex: int
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Removes all the controls from the aggregation {@link #getBannerLines bannerLines}.
+     *
+     * Additionally, it unregisters them from the hosting UIArea.
+     *
+     * @returns An array of the removed elements (might be empty)
+     */
+    removeAllBannerLines(): Text[];
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Removes a bannerLine from the aggregation {@link #getBannerLines bannerLines}.
+     *
+     * @returns The removed bannerLine or `null`
+     */
+    removeBannerLine(
+      /**
+       * The bannerLine to remove or its index or id
+       */
+      vBannerLine: int | string | Text
+    ): Text | null;
     /**
      * @experimental (since 1.116) - this feature is experimental and the API may change.
      *
@@ -1696,6 +1793,14 @@ declare module "sap/f/cards/BaseHeader" {
      * Defines the toolbar.
      */
     toolbar?: Control;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Show as a banner in the header area. Use for example for system info and application shortcut.
+     */
+    bannerLines?: Text[] | Text | AggregationBindingInfo | `{${string}}`;
   }
 }
 
@@ -2356,6 +2461,12 @@ declare module "sap/f/cards/NumericHeader" {
 
   import Control from "sap/ui/core/Control";
 
+  import { ValueState, URI } from "sap/ui/core/library";
+
+  import AvatarColor from "sap/m/AvatarColor";
+
+  import AvatarShape from "sap/m/AvatarShape";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { ValueColor, DeviationIndicator } from "sap/m/library";
@@ -2575,6 +2686,97 @@ declare module "sap/f/cards/NumericHeader" {
      * @returns Value of property `detailsMaxLines`
      */
     getDetailsMaxLines(): int;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getDetailsState detailsState}.
+     *
+     * The semantic color which represents the state of the details text.
+     *
+     * Default value is `None`.
+     *
+     * @returns Value of property `detailsState`
+     */
+    getDetailsState(): ValueState | keyof typeof ValueState;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconAlt iconAlt}.
+     *
+     * Defines an alt text for the avatar or icon.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Value of property `iconAlt`
+     */
+    getIconAlt(): string;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconBackgroundColor iconBackgroundColor}.
+     *
+     * Defines a background color for the avatar or icon.
+     *
+     * Default value is `Transparent`.
+     *
+     * @returns Value of property `iconBackgroundColor`
+     */
+    getIconBackgroundColor(): AvatarColor | keyof typeof AvatarColor;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconDisplayShape iconDisplayShape}.
+     *
+     * Defines the shape of the icon.
+     *
+     * Default value is `Circle`.
+     *
+     * @returns Value of property `iconDisplayShape`
+     */
+    getIconDisplayShape(): AvatarShape | keyof typeof AvatarShape;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconInitials iconInitials}.
+     *
+     * Defines the initials of the icon.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Value of property `iconInitials`
+     */
+    getIconInitials(): string;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconSrc iconSrc}.
+     *
+     * Defines the icon source.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Value of property `iconSrc`
+     */
+    getIconSrc(): URI;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Gets current value of property {@link #getIconVisible iconVisible}.
+     *
+     * Defines whether the card icon is visible.
+     *
+     * Default value is `true`.
+     *
+     * @returns Value of property `iconVisible`
+     */
+    getIconVisible(): boolean;
     /**
      * Gets current value of property {@link #getNumber number}.
      *
@@ -2788,6 +2990,146 @@ declare module "sap/f/cards/NumericHeader" {
        */
       iDetailsMaxLines?: int
     ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getDetailsState detailsState}.
+     *
+     * The semantic color which represents the state of the details text.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `None`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setDetailsState(
+      /**
+       * New value for property `detailsState`
+       */
+      sDetailsState?: ValueState | keyof typeof ValueState
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconAlt iconAlt}.
+     *
+     * Defines an alt text for the avatar or icon.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconAlt(
+      /**
+       * New value for property `iconAlt`
+       */
+      sIconAlt?: string
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconBackgroundColor iconBackgroundColor}.
+     *
+     * Defines a background color for the avatar or icon.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Transparent`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconBackgroundColor(
+      /**
+       * New value for property `iconBackgroundColor`
+       */
+      sIconBackgroundColor?: AvatarColor | keyof typeof AvatarColor
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconDisplayShape iconDisplayShape}.
+     *
+     * Defines the shape of the icon.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Circle`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconDisplayShape(
+      /**
+       * New value for property `iconDisplayShape`
+       */
+      sIconDisplayShape?: AvatarShape | keyof typeof AvatarShape
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconInitials iconInitials}.
+     *
+     * Defines the initials of the icon.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconInitials(
+      /**
+       * New value for property `iconInitials`
+       */
+      sIconInitials?: string
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconSrc iconSrc}.
+     *
+     * Defines the icon source.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `empty string`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconSrc(
+      /**
+       * New value for property `iconSrc`
+       */
+      sIconSrc?: URI
+    ): this;
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Sets a new value for property {@link #getIconVisible iconVisible}.
+     *
+     * Defines whether the card icon is visible.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `true`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconVisible(
+      /**
+       * New value for property `iconVisible`
+       */
+      bIconVisible?: boolean
+    ): this;
     /**
      * Sets a new value for property {@link #getNumber number}.
      *
@@ -2996,6 +3338,13 @@ declare module "sap/f/cards/NumericHeader" {
        */
       sUnitOfMeasurement: string
     ): this;
+    /**
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     *
+     * @returns If the icon should be shown.
+     */
+    shouldShowIcon(): boolean;
   }
 
   export interface $NumericHeaderSettings extends $BaseHeaderSettings {
@@ -3028,6 +3377,60 @@ declare module "sap/f/cards/NumericHeader" {
      */
     statusText?: string | PropertyBindingInfo;
 
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines the shape of the icon.
+     */
+    iconDisplayShape?:
+      | (AvatarShape | keyof typeof AvatarShape)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines the icon source.
+     */
+    iconSrc?: URI | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines the initials of the icon.
+     */
+    iconInitials?: string | PropertyBindingInfo;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines an alt text for the avatar or icon.
+     */
+    iconAlt?: string | PropertyBindingInfo;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines a background color for the avatar or icon.
+     */
+    iconBackgroundColor?:
+      | (AvatarColor | keyof typeof AvatarColor)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * Defines whether the card icon is visible.
+     */
+    iconVisible?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * General unit of measurement for the header. Displayed as side information to the subtitle.
      */
@@ -3077,6 +3480,17 @@ declare module "sap/f/cards/NumericHeader" {
      */
     details?: string | PropertyBindingInfo;
 
+    /**
+     * @since 1.118
+     * @experimental (since 1.118) - For usage only by Work Zone.
+     *
+     * The semantic color which represents the state of the details text.
+     */
+    detailsState?:
+      | (ValueState | keyof typeof ValueState)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
     /**
      * @experimental (since 1.101)
      *

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

@@ -270,6 +270,28 @@ declare module "sap/fe/core/ExtensionAPI" {
   }
 }
 
+declare module "sap/fe/core/library" {
+  /**
+   * @since 1.86.0
+   *
+   * Possible initial load (first app startup) modes for a ListReport.
+   */
+  export enum InitialLoadMode {
+    /**
+     * Data will be loaded initially if filters are set.
+     */
+    Auto = "undefined",
+    /**
+     * Data will not be loaded initially.
+     */
+    Disabled = "undefined",
+    /**
+     * Data will be loaded initially.
+     */
+    Enabled = "undefined",
+  }
+}
+
 declare module "sap/fe/core/PageController" {
   import BaseController from "sap/fe/core/BaseController";
 
@@ -819,8 +841,6 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
      *
      * Provides a hook to customize the {@link sap.fe.navigation.SelectionVariant} related to the intent-based
      * navigation.
-     *
-     * @returns Promise for async handling
      */
     adaptNavigationContext(
       /**
@@ -840,7 +860,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
          */
         semanticObject: string;
       }
-    ): Promise<void>;
+    ): void;
     /**
      * @since 1.86.0
      *
@@ -975,7 +995,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
       /**
        * Parameters to be used with route to create the target hash
        */
-      oParameters?: any
+      oParameters?: object
     ): Promise<boolean>;
     /**
      * @since 1.90.0
@@ -1147,6 +1167,28 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
 
   import ManagedObject from "sap/ui/base/ManagedObject";
 
+  /**
+   * Definition of a custom action to be used inside the table toolbar
+   */
+  export type NavigationParameter = {
+    /**
+     *  The actual navigation type.
+     */
+    navigationType: string;
+    /**
+     * Defines whether the standard variant must be used in variant management
+     */
+    requiresStandardVariant: boolean;
+    /**
+     * The selectionVariant from the navigation.
+     */
+    selectionVariant: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
+    /**
+     * The selectionVariant defaults from the navigation
+     */
+    selectionVariantDefaults: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
+  };
+
   /**
    * @since 1.85.0
    *
@@ -1361,29 +1403,8 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
      *
      * @returns A promise resolving the view state
      */
-    retrieveViewState(): Promise<any>;
+    retrieveViewState(): Promise<object | undefined>;
   }
-  /**
-   * Definition of a custom action to be used inside the table toolbar
-   */
-  export type NavigationParameter = {
-    /**
-     *  The actual navigation type.
-     */
-    navigationType: string;
-    /**
-     * Defines whether the standard variant must be used in variant management
-     */
-    requiresStandardVariant: boolean;
-    /**
-     * The selectionVariant from the navigation.
-     */
-    selectionVariant: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
-    /**
-     * The selectionVariant defaults from the navigation
-     */
-    selectionVariantDefaults: /* was: sap.fe.navigation.SelectionVariant.SelectionVariant */ any;
-  };
 }
 
 declare module "sap/fe/core/fpm/Component" {
@@ -1420,28 +1441,6 @@ declare module "sap/fe/core/fpm/Component" {
   }
 }
 
-declare module "sap/fe/core/library" {
-  /**
-   * @since 1.86.0
-   *
-   * Possible initial load (first app startup) modes for a ListReport.
-   */
-  export enum InitialLoadMode {
-    /**
-     * Data will be loaded initially if filters are set.
-     */
-    Auto = "undefined",
-    /**
-     * Data will not be loaded initially.
-     */
-    Disabled = "undefined",
-    /**
-     * Data will be loaded initially.
-     */
-    Enabled = "undefined",
-  }
-}
-
 declare module "sap/fe/core/rootView/Fcl.controller" {
   /**
    * @since 1.110.0