@sapui5/ts-types-esm 1.129.1 → 1.130.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types-esm",
-  "version": "1.129.1",
+  "version": "1.130.0",
   "description": "SAPUI5 TypeScript Definitions - ES Modules",
   "homepage": "https://ui5.sap.com",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -45,6 +45,7 @@
 /// <reference path="./sap.cux.home.d.ts"/>
 /// <reference path="./sap.esh.search.ui.d.ts"/>
 /// <reference path="./sap.fe.base.d.ts"/>
+/// <reference path="./sap.fe.controls.d.ts"/>
 /// <reference path="./sap.fe.core.d.ts"/>
 /// <reference path="./sap.fe.ina.d.ts"/>
 /// <reference path="./sap.fe.macros.d.ts"/>

package/types/sap.apf.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.0
+// For Library Version: 1.130.0
 
 declare module "sap/apf/library" {}
 

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

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

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.0
+// For Library Version: 1.130.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.129.0
+// For Library Version: 1.130.0
 
 declare module "sap/collaboration/library" {
   /**

package/types/sap.cux.home.d.ts

@@ -2,18 +2,18 @@
 
 declare module "sap/cux/home/AppsContainer" {
   /**
-   * Container class for managing and storing Apps.
+   * Container class for managing and storing apps.
    *
    * @since 1.121
    * @experimental (since 1.121)
    */
   export default class AppsContainer {
     /**
-     * Constructor for a new Apps Container.
+     * Constructor for a new app container.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -26,7 +26,7 @@ declare module "sap/cux/home/AppsContainer" {
 
 declare module "sap/cux/home/CardsPanel" {
   /**
-   * Panel class for managing and storing Cards.
+   * Panel class for managing and storing Insights Cards.
    *
    * @since 1.122.0
    * @experimental (since 1.122.0)
@@ -35,11 +35,11 @@ declare module "sap/cux/home/CardsPanel" {
     extends /* was: sap.cux.home.BasePanel */ Object
   {
     /**
-     * Constructor for a new Cards Panel.
+     * Constructor for a new card panel.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -59,11 +59,11 @@ declare module "sap/cux/home/FrequentAppPanel" {
    */
   export default class FrequentAppPanel {
     /**
-     * Constructor for a new Frequent Apps Panel.
+     * Constructor for a new frequent app panel.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -76,18 +76,18 @@ declare module "sap/cux/home/FrequentAppPanel" {
 
 declare module "sap/cux/home/InsightsContainer" {
   /**
-   * Container class for managing and storing Insights tiles and cards.
+   * Container class for managing and storing Insights Tiles and Insights Cards.
    *
    * @since 1.121
    * @experimental (since 1.121)
    */
   export default class InsightsContainer {
     /**
-     * Constructor for a new Insights Container.
+     * Constructor for a new Insights container.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -100,18 +100,18 @@ declare module "sap/cux/home/InsightsContainer" {
 
 declare module "sap/cux/home/Layout" {
   /**
-   * Layout class for My Home layout.
+   * Layout class for the My Home layout.
    *
    * @since 1.121
    * @experimental (since 1.121)
    */
   export default class Layout {
     /**
-     * Constructor for a new Layout.
+     * Constructor for a new layout.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -124,22 +124,23 @@ declare module "sap/cux/home/Layout" {
 
 declare module "sap/cux/home/library" {
   /**
-   * Supported Layout Types for {@link sap.cux.home.BaseContainer }.
+   * Supported layout types for {@link sap.cux.home.BaseContainer }.
    *
    * @since 1.121
    * @experimental (since 1.121)
    */
   export enum LayoutType {
     /**
-     * Panels are rendered horizontally example pages and news
+     * Panels are rendered horizontally, for example Pages and News
      */
     Horizontal = "undefined",
     /**
-     * Panels are rendered side by side example todos and situaions, fav, recent and frequent apps
+     * Panels are rendered side by side, for example To-Dos and Situaions, and Favorites, Recently Used and
+     * Frequently Used apps
      */
     SideBySide = "undefined",
     /**
-     * Panels are rendered vertically example insights cards and tiles
+     * Panels are rendered vertically, for example Insights Tiles and Insights Cards
      */
     Vertical = "undefined",
   }
@@ -151,7 +152,7 @@ declare module "sap/cux/home/library" {
    */
   export enum NewsType {
     /**
-     * News is of type Custom news feed
+     * News is of type custom news feed
      */
     Custom = "undefined",
     /**
@@ -175,18 +176,18 @@ declare module "sap/cux/home/MenuItem" {
   import Event from "sap/ui/base/Event";
 
   /**
-   * Class for managing and storing Menu items.
+   * Class for managing and storing menu items.
    *
    * @since 1.121
    * @experimental (since 1.121)
    */
   export default class MenuItem extends UI5Element {
     /**
-     * Constructor for a new Menu Item.
+     * Constructor for a new menu item.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -212,7 +213,7 @@ declare module "sap/cux/home/MenuItem" {
     title?: string | PropertyBindingInfo;
 
     /**
-     * Type of menu item visualization in the menu list
+     * Type of the menu item visualization in the menu list
      */
     type?: string | PropertyBindingInfo;
   }
@@ -240,11 +241,11 @@ declare module "sap/cux/home/NewsAndPagesContainer" {
    */
   export default class NewsAndPagesContainer {
     /**
-     * Constructor for a new News and Pages Container.
+     * Constructor for the new News and Pages container.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -295,7 +296,7 @@ declare module "sap/cux/home/NewsPanel" {
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -326,11 +327,11 @@ declare module "sap/cux/home/PagePanel" {
    */
   export default class PagePanel {
     /**
-     * Constructor for a new Page Panel.
+     * Constructor for a new Page panel.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -343,18 +344,18 @@ declare module "sap/cux/home/PagePanel" {
 
 declare module "sap/cux/home/RecentAppPanel" {
   /**
-   * Provides class for managing Recent apps.
+   * Provides class for managing Recently Used apps.
    *
    * @since 1.121.0
    * @experimental (since 1.121.0)
    */
   export default class RecentAppPanel {
     /**
-     * Constructor for a new Recent Apps Panel.
+     * Constructor for a new Recently Used apps Panel.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -381,7 +382,7 @@ declare module "sap/cux/home/SituationPanel" {
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -408,7 +409,7 @@ declare module "sap/cux/home/TaskPanel" {
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -421,7 +422,7 @@ declare module "sap/cux/home/TaskPanel" {
 
 declare module "sap/cux/home/TilesPanel" {
   /**
-   * Tiles Panel class for managing and storing Tiles.
+   * Tiles Panel class for managing and storing Insights Tiles.
    *
    * @since 1.122.0
    * @experimental (since 1.122.0)
@@ -434,7 +435,7 @@ declare module "sap/cux/home/TilesPanel" {
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -462,11 +463,11 @@ declare module "sap/cux/home/ToDoPanel" {
   {
     __implements__sap_cux_home_ToDoPanel_IToDoPanel: boolean;
     /**
-     * Constructor for a new ToDo Panel.
+     * Constructor for a new To-Dos Panel.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -505,11 +506,11 @@ declare module "sap/cux/home/ToDosContainer" {
    */
   export default class ToDosContainer {
     /**
-     * Constructor for a new ToDos Container.
+     * Constructor for a new To-Dos container.
      */
     constructor(
       /**
-       * ID for the new control, generated automatically if no ID is given
+       * ID for the new control, generated automatically if an ID is not provided
        */
       id?: string,
       /**
@@ -519,7 +520,7 @@ declare module "sap/cux/home/ToDosContainer" {
     );
 
     /**
-     * Gets the selected key of the ToDosContainer.
+     * Gets the selected key of the To-Dos container.
      * If no selected key is set, it defaults to the first item.
      *
      *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.0
+// For Library Version: 1.130.0
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.0
+// For Library Version: 1.130.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -2281,6 +2281,8 @@ declare module "sap/f/cards/Header" {
 
   import AvatarShape from "sap/m/AvatarShape";
 
+  import AvatarImageFitType from "sap/m/AvatarImageFitType";
+
   import AvatarSize from "sap/m/AvatarSize";
 
   import { URI } from "sap/ui/core/library";
@@ -2497,6 +2499,18 @@ declare module "sap/f/cards/Header" {
      * @returns Value of property `iconDisplayShape`
      */
     getIconDisplayShape(): AvatarShape | keyof typeof AvatarShape;
+    /**
+     * Gets current value of property {@link #getIconFitType iconFitType}.
+     *
+     * Defines how the image fits in the icon area.
+     *
+     * Default value is `Cover`.
+     *
+     * @since 1.130
+     *
+     * @returns Value of property `iconFitType`
+     */
+    getIconFitType(): AvatarImageFitType | keyof typeof AvatarImageFitType;
     /**
      * Gets current value of property {@link #getIconInitials iconInitials}.
      *
@@ -2656,6 +2670,25 @@ declare module "sap/f/cards/Header" {
        */
       sIconDisplayShape?: AvatarShape | keyof typeof AvatarShape
     ): this;
+    /**
+     * Sets a new value for property {@link #getIconFitType iconFitType}.
+     *
+     * Defines how the image fits in the icon area.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Cover`.
+     *
+     * @since 1.130
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconFitType(
+      /**
+       * New value for property `iconFitType`
+       */
+      sIconFitType?: AvatarImageFitType | keyof typeof AvatarImageFitType
+    ): this;
     /**
      * Sets a new value for property {@link #getIconInitials iconInitials}.
      *
@@ -2914,6 +2947,16 @@ declare module "sap/f/cards/Header" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Defines how the image fits in the icon area.
+     *
+     * @since 1.130
+     */
+    iconFitType?:
+      | (AvatarImageFitType | keyof typeof AvatarImageFitType)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
     /**
      * Fires when the user presses the control.
      */
@@ -2995,6 +3038,8 @@ declare module "sap/f/cards/NumericHeader" {
 
   import AvatarShape from "sap/m/AvatarShape";
 
+  import AvatarImageFitType from "sap/m/AvatarImageFitType";
+
   import AvatarSize from "sap/m/AvatarSize";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -3285,6 +3330,18 @@ declare module "sap/f/cards/NumericHeader" {
      * @returns Value of property `iconDisplayShape`
      */
     getIconDisplayShape(): AvatarShape | keyof typeof AvatarShape;
+    /**
+     * Gets current value of property {@link #getIconFitType iconFitType}.
+     *
+     * Defines how the image fits in the icon area.
+     *
+     * Default value is `Cover`.
+     *
+     * @since 1.130
+     *
+     * @returns Value of property `iconFitType`
+     */
+    getIconFitType(): AvatarImageFitType | keyof typeof AvatarImageFitType;
     /**
      * Gets current value of property {@link #getIconInitials iconInitials}.
      *
@@ -3661,6 +3718,25 @@ declare module "sap/f/cards/NumericHeader" {
        */
       sIconDisplayShape?: AvatarShape | keyof typeof AvatarShape
     ): this;
+    /**
+     * Sets a new value for property {@link #getIconFitType iconFitType}.
+     *
+     * Defines how the image fits in the icon area.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Cover`.
+     *
+     * @since 1.130
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setIconFitType(
+      /**
+       * New value for property `iconFitType`
+       */
+      sIconFitType?: AvatarImageFitType | keyof typeof AvatarImageFitType
+    ): this;
     /**
      * Sets a new value for property {@link #getIconInitials iconInitials}.
      *
@@ -4091,6 +4167,16 @@ declare module "sap/f/cards/NumericHeader" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Defines how the image fits in the icon area.
+     *
+     * @since 1.130
+     */
+    iconFitType?:
+      | (AvatarImageFitType | keyof typeof AvatarImageFitType)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
     /**
      * General unit of measurement for the header. Displayed as side information to the subtitle.
      */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.1
+// For Library Version: 1.130.0
 
 declare module "sap/fe/base/library" {}
 

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.129.1
+// For Library Version: 1.130.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -49,7 +49,7 @@ declare module "sap/fe/core/AppComponent" {
     /**
      * Provides a hook to initialize feature toggles.
      * This hook is being called by the SAP Fiori elements AppComponent at the time feature toggles can be initialized.
-     * To change page configuration use the {@link sap.fe.core.AppComponent#changePageConfiguration } method.
+     * To change page configuration, use the {@link sap.fe.core.AppComponent#changePageConfiguration } method.
      *
      *
      *
@@ -442,9 +442,9 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      */
     createDocument(
       /**
-       * ODataListBinding object or the binding path for a temporary list binding
+       * ODataListBinding object or the binding path or a table building block for a temporary list binding
        */
-      vListBinding: ODataListBinding | string,
+      source: /* was: sap.fe.macros.Table */ any | ODataListBinding | string,
       /**
        * Contains the following attributes:
        */
@@ -454,15 +454,24 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
          * 'Inline'
          */
         createAtEnd?: boolean;
+        /**
+         * Defines the list of properties that are displayed in the creation dialog when the creation mode is set
+         * to 'CreationDialog'.
+         * The value is a comma-separated list of property names
+         */
+        creationDialogFields?: string[];
         /**
          * The creation mode using one of the following:
          *
-         * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async'
+         * NewPage - the created document is shown in a new page, depending on whether metadata 'Sync', 'Async',
          * or 'Deferred' is used
          *
          * Inline - The creation is done inline (in a table)
          *
-         * External - The creation is done in a different application specified via the parameter 'outbound'
+         * External - The creation is done in a different application specified by the parameter 'outbound'
+         *
+         * CreationDialog - the creation is done in the table, with a dialog allowing to specify some initial property
+         * values (the properties are listed in `creationDialogFields`)
          */
         creationMode: string;
         /**
@@ -489,6 +498,33 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
         tableId?: string;
       }
     ): Promise<void>;
+    /**
+     * This function can be used to execute code on the mass edit save.
+     * You can execute custom coding in this function.
+     * If you decide to do your own save processing, you can return `true` to prevent the default save behavior.
+     * This function is meant to be individually overridden by consuming controllers but not to be called directly.
+     * The override execution is: {@link sap.ui.core.mvc.OverrideExecution.Instead }.
+     *
+     *
+     * @since 1.130.0
+     *
+     * @returns `true` to prevent the default execution, `false` to keep the standard behavior
+     */
+    customMassEditSave(
+      /**
+       * Object containing the parameters passed to customMassEditSave
+       */
+      _mParameters: {
+        /**
+         * Array containing the selected contexts for the mass edit
+         */
+        aContexts: Context[];
+        /**
+         * A dictionary containing the propertyPath and its value
+         */
+        oUpdateData: Record<string, any>;
+      }
+    ): Promise<boolean>;
     /**
      * Deletes the document.
      *

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

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