@sapui5/ts-types-esm 1.108.2 → 1.109.0

package/package.json

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

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.0
+// For Library Version: 1.109.0
 
 declare module "sap/ca/ui/library" {
   export namespace charts {
@@ -13906,8 +13906,6 @@ declare namespace sap {
 
     "sap/ca/ui/DatePicker": undefined;
 
-    "sap/ca/ui/dialog/factory": undefined;
-
     "sap/ca/ui/ExpansibleFeedListItem": undefined;
 
     "sap/ca/ui/FileUpload": undefined;

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.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.108.0
+// For Library Version: 1.109.0
 
 declare module "sap/collaboration/library" {
   /**

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

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

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -2446,6 +2446,18 @@ declare module "sap/f/cards/NumericHeader" {
      * @returns Value of property `number`
      */
     getNumber(): string;
+    /**
+     * @SINCE 1.109
+     *
+     * Gets current value of property {@link #getNumberVisible numberVisible}.
+     *
+     * Whether the main numeric indicator is visible or not
+     *
+     * Default value is `true`.
+     *
+     * @returns Value of property `numberVisible`
+     */
+    getNumberVisible(): boolean;
     /**
      * Gets current value of property {@link #getScale scale}.
      *
@@ -2654,6 +2666,25 @@ declare module "sap/f/cards/NumericHeader" {
        */
       sNumber: string
     ): this;
+    /**
+     * @SINCE 1.109
+     *
+     * Sets a new value for property {@link #getNumberVisible numberVisible}.
+     *
+     * Whether the main numeric indicator is visible or not
+     *
+     * 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
+     */
+    setNumberVisible(
+      /**
+       * New value for property `numberVisible`
+       */
+      bNumberVisible?: boolean
+    ): this;
     /**
      * Sets a new value for property {@link #getScale scale}.
      *
@@ -2870,6 +2901,13 @@ declare module "sap/f/cards/NumericHeader" {
      */
     number?: string | PropertyBindingInfo;
 
+    /**
+     * @SINCE 1.109
+     *
+     * Whether the main numeric indicator is visible or not
+     */
+    numberVisible?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the unit of measurement (scaling prefix) for the main indicator. Financial characters can be
      * used for currencies and counters. The International System of Units (SI) prefixes can be used. If the
@@ -18950,12 +18988,10 @@ declare module "sap/f/SidePanel" {
 
   /**
    * @SINCE 1.107
-   * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    *
    * Overview:
    *
-   * `SidePanel` is a layout control that allows primary and additional content to be displayed by clicking/tapping
+   * `SidePanel` is a layout control that allows primary and additional content to be displayed by choosing
    * the action items from its action bar.
    *
    * Usage:
@@ -18963,8 +18999,8 @@ declare module "sap/f/SidePanel" {
    * Action bar with action items have two states - collapsed and expanded. In collapsed state only icons
    * are displayed, and in expanded state both icons and titles are displayed.
    *
-   * Each action item can have a content and click/tap on action item toggles the display of its content.
-   * The content can be added to the action item's `content` aggregation, or can be added or changed later.
+   * Each action item can have a content and choose an action item toggles the display of its content. The
+   * content can be added to the action item's `content` aggregation, or can be added or changed later.
    *
    * Each click/tap fires an event, and in the event handler specific content can be added/changed to the
    * `content` aggregation of the clicked/tapped action item or data can be retreived from the same aggregation
@@ -18983,15 +19019,7 @@ declare module "sap/f/SidePanel" {
    * an overflow icon is displayed, and it toggles ON/OFF an overflow menu with the rest of the action items
    * that are not visible at the moment.
    *
-   * Screen width > 1440 px
-   *
-   *
-   * 	 - When expanded, the side content shrinks the main content.
-   *
-   * Screen width <= 1440 px
-   *
-   *
-   * 	 - When expanded, the side content is placed over the main content.
+   * When expanded, the side content shrinks the main content.
    *
    * **On mobile device**
    *
@@ -18999,6 +19027,14 @@ declare module "sap/f/SidePanel" {
    * and when expanded, the side content is displayed above the action bar. If there is not enough room for
    * all action items, the action bar can be swiped to access the rest of the action items.
    *
+   * Resizing:
+   *
+   * Resizing functionality only affects desktop or tablet devices.
+   *
+   * By setting the `sidePanelResizable` property, the expanded side panel can be resized by mouse (by drag
+   * or by double click on resize splitter), by keyboard or by choosing one of three predefined positions
+   * in the side panel's context menu (min, max and default widths)
+   *
    * Keyboard shortcuts:
    *
    *
@@ -19012,6 +19048,22 @@ declare module "sap/f/SidePanel" {
    * 			opened side content panel to the action items
    * 	 - [F6] / [Shift] + [F6] - Navigate back and forth between main content, side panel and side content
    * 			groups [Esc] - Close the opened side content panel and set focus back to main content
+   *
+   * If the side panel's `sidePanelResizable` property is set, there is an action item chosen, and the resize
+   * splitter is focused:
+   *
+   *
+   * 	 - [Home] - set the expanded side panel width to the minimum value defined in `sidePanelMinWidth` property
+   *
+   * 	 - [End] - set the expanded side panel width to the maximum value defined in `sidePanelMaxWidth` property
+   *
+   * 	 - [Enter] - set the expanded side panel width to the default value defined in `sidePanelWidth` property
+   *
+   * 	 - [Shift]+[F10] or [Context menu] - show the resize context menu
+   * 	 - [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with the regular
+   * 			step
+   * 	 - [Shift] + [Arrow Left] / [Arrow Right] - increase/decrease the width of the expanded side panel with
+   * 			the larger step
    */
   export default class SidePanel extends Control {
     /**
@@ -19248,6 +19300,73 @@ declare module "sap/f/SidePanel" {
      * or `null`.
      */
     getSelectedItem(): ID;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Gets current value of property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
+     *
+     * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
+     *
+     * Default value is `"90%"`.
+     *
+     * @returns Value of property `sidePanelMaxWidth`
+     */
+    getSidePanelMaxWidth(): CSSSize;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Gets current value of property {@link #getSidePanelMinWidth sidePanelMinWidth}.
+     *
+     * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
+     *
+     * Default value is `"15rem"`.
+     *
+     * @returns Value of property `sidePanelMinWidth`
+     */
+    getSidePanelMinWidth(): CSSSize;
+    /**
+     * Gets current value of property {@link #getSidePanelResizable sidePanelResizable}.
+     *
+     * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+     * desktop or tablet devices.
+     *
+     * Default value is `false`.
+     *
+     * @returns Value of property `sidePanelResizable`
+     */
+    getSidePanelResizable(): boolean;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Gets current value of property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
+     *
+     * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+     * the resize splitter is focused.
+     *
+     * Default value is `100`.
+     *
+     * @returns Value of property `sidePanelResizeLargerStep`
+     */
+    getSidePanelResizeLargerStep(): int;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Gets current value of property {@link #getSidePanelResizeStep sidePanelResizeStep}.
+     *
+     * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+     * is focused.
+     *
+     * Default value is `10`.
+     *
+     * @returns Value of property `sidePanelResizeStep`
+     */
+    getSidePanelResizeStep(): int;
     /**
      * Gets current value of property {@link #getSidePanelWidth sidePanelWidth}.
      *
@@ -19391,23 +19510,106 @@ declare module "sap/f/SidePanel" {
       sAriaLabel?: string
     ): this;
     /**
-     * Sets a new value for property {@link #getSidePanelWidth sidePanelWidth}.
+     * @SINCE 1.109.0
      *
-     * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
-     * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
-     * it's calculated in absolute units.
+     * Sets a new value for property {@link #getSidePanelMaxWidth sidePanelMaxWidth}.
+     *
+     * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
-     * Default value is `"20rem"`.
+     * Default value is `"90%"`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSidePanelMaxWidth(
+      /**
+       * New value for property `sidePanelMaxWidth`
+       */
+      sSidePanelMaxWidth?: CSSSize
+    ): this;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Sets a new value for property {@link #getSidePanelMinWidth sidePanelMinWidth}.
+     *
+     * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `"15rem"`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSidePanelMinWidth(
+      /**
+       * New value for property `sidePanelMinWidth`
+       */
+      sSidePanelMinWidth?: CSSSize
+    ): this;
+    /**
+     * Sets a new value for property {@link #getSidePanelResizable sidePanelResizable}.
+     *
+     * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+     * desktop or tablet devices.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `false`.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
-    setSidePanelWidth(
+    setSidePanelResizable(
       /**
-       * New value for property `sidePanelWidth`
+       * New value for property `sidePanelResizable`
        */
-      sSidePanelWidth?: CSSSize
+      bSidePanelResizable?: boolean
+    ): this;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Sets a new value for property {@link #getSidePanelResizeLargerStep sidePanelResizeLargerStep}.
+     *
+     * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+     * the resize splitter is focused.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `100`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSidePanelResizeLargerStep(
+      /**
+       * New value for property `sidePanelResizeLargerStep`
+       */
+      iSidePanelResizeLargerStep?: int
+    ): this;
+    /**
+     * @SINCE 1.109.0
+     *
+     * Sets a new value for property {@link #getSidePanelResizeStep sidePanelResizeStep}.
+     *
+     * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+     * is focused.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `10`.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSidePanelResizeStep(
+      /**
+       * New value for property `sidePanelResizeStep`
+       */
+      iSidePanelResizeStep?: int
     ): this;
   }
 
@@ -19422,6 +19624,12 @@ declare module "sap/f/SidePanel" {
      */
     ariaLabel?: string | PropertyBindingInfo;
 
+    /**
+     * Determines whether the side panel is resizable or fixed. **Note:** setting this property only affects
+     * desktop or tablet devices.
+     */
+    sidePanelResizable?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Determines the side panel width (Side Content width + Action Bar width). **Note:** if the width is given
      * in percent(%), it is calculated as given percent from the Side Panel parent container width, otherwise
@@ -19429,6 +19637,42 @@ declare module "sap/f/SidePanel" {
      */
     sidePanelWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * @SINCE 1.109.0
+     *
+     * Determines the minimum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
+     */
+    sidePanelMinWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * @SINCE 1.109.0
+     *
+     * Determines the maximum side panel width (Side Content width + Action Bar width). **Note:** if the width
+     * is given in percent(%), it is calculated as given percent from the Side Panel parent container width,
+     * otherwise it's calculated in absolute units.
+     */
+    sidePanelMaxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * @SINCE 1.109.0
+     *
+     * Determines the step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by this step with `Left Arrow` and `Right Arrow` keys when the resize splitter
+     * is focused.
+     */
+    sidePanelResizeStep?: int | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * @SINCE 1.109.0
+     *
+     * Determines the large step (in pixels) when changing the width of the side panel with the keyboard. **Note:**
+     * the width can be changed by large step with `Shift + Left Arrow` and `Shift + Right Arrow` keys when
+     * the resize splitter is focused.
+     */
+    sidePanelResizeLargerStep?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * The list of controls for the main content.
      */
@@ -19480,8 +19724,6 @@ declare module "sap/f/SidePanelItem" {
 
   /**
    * @SINCE 1.107
-   * @EXPERIMENTAL (since 1.107) - This class is experimental and provides only limited functionality. Also
-   * the API might be changed in future.
    *
    * Overview:
    *

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare module "sap/fe/core/library" {
   /**
@@ -44,6 +44,32 @@ declare module "sap/fe/core/AppComponent" {
    */
   export default class AppComponent extends UIComponent {
     constructor();
+
+    /**
+     * Changes the page configuration of SAP Fiori elements.
+     * This method enables you to change the page configuration of SAP Fiori elements.
+     */
+    changePageConfiguration(
+      /**
+       * The ID of the page for which the configuration is to be changed.
+       */
+      pageId: string,
+      /**
+       * The path in the page settings for which the configuration is to be changed.
+       */
+      path: string,
+      /**
+       * The new value of the configuration. This could be a plain value like a string, or a Boolean, or a structured
+       * object.
+       */
+      value: unknown
+    ): void;
+    /**
+     * 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.
+     */
+    initializeFeatureToggles(): void;
   }
 
   export interface $AppComponentSettings extends $UIComponentSettings {}
@@ -236,7 +262,7 @@ declare module "sap/fe/core/ExtensionAPI" {
      *
      * @returns A promise that resolves with the new app state object.
      */
-    updateAppState(): undefined | Promise<any>;
+    updateAppState(): Promise<any>;
   }
 }
 
@@ -1171,24 +1197,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
       /**
        * The current navigation parameter
        */
-      oNavParameter: {
-        /**
-         * The actual navigation type
-         */
-        navigationType: any;
-        /**
-         * Defines whether the standard variant must be used in variant management
-         */
-        requiresStandardVariant?: boolean;
-        /**
-         * The selectionVariant from the navigation
-         */
-        selectionVariant?: object;
-        /**
-         * The selectionVariant defaults from the navigation
-         */
-        selectionVariantDefaults?: object;
-      }
+      oNavParameter: /* was: sap.fe.core.NavigationParameter */ any
     ): Promise<any>;
     /**
      * Hook to react when state for given view was applied.
@@ -1241,6 +1250,27 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
      */
     retrieveViewState(): Promise<any>;
   }
+  /**
+   * 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: object;
+    /**
+     * The selectionVariant defaults from the navigation
+     */
+    selectionVariantDefaults: object;
+  };
 }
 
 declare module "sap/fe/core/fpm/Component" {
@@ -1296,6 +1326,12 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
     /* was: sap.fe.core.RootViewBaseController */ extends Object {
     constructor();
 
+    /**
+     * Method that creates a new Page to display the IllustratedMessage containing the current error.
+     *
+     * @returns A promise that creates a Page to display the error
+     */
+    displayErrorPage(): Promise<any>;
     /**
      * @SINCE 1.91.0
      *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare module "sap/fe/macros/library" {}
 
@@ -185,6 +185,13 @@ declare module "sap/fe/macros/field/FieldAPI" {
      * Maximum number of characters from the beginning of the text field that are shown initially.
      */
     textMaxCharactersDisplay: number;
+    /**
+     * Defines the maximum number of characters for the multiline text value.
+     *
+     * If a multiline text exceeds the maximum number of allowed characters, the counter below the input field
+     * displays the exact number.
+     */
+    textMaxLength: number;
     /**
      * Maximum number of lines that multiline texts in edit mode can grow to.
      */
@@ -229,6 +236,19 @@ declare module "sap/fe/macros/field/FieldAPI" {
   }
 }
 
+declare module "sap/fe/macros/field/TextAreaEx" {
+  import { default as TextArea, $TextAreaSettings } from "sap/m/TextArea";
+
+  /**
+   * Extension of the TextArea control to add a check for the maximum length when setting the value.
+   */
+  export default class TextAreaEx extends TextArea {
+    constructor();
+  }
+
+  export interface $TextAreaExSettings extends $TextAreaSettings {}
+}
+
 declare module "sap/fe/macros/filterBar/FilterBarAPI" {
   import {
     default as MacroAPI,
@@ -739,6 +759,8 @@ declare namespace sap {
 
     "sap/fe/macros/field/FieldAPI": undefined;
 
+    "sap/fe/macros/field/TextAreaEx": undefined;
+
     "sap/fe/macros/filterBar/FilterBarAPI": undefined;
 
     "sap/fe/macros/form/FormAPI": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare module "sap/fe/navigation/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.108.1
+// For Library Version: 1.109.0
 
 declare module "sap/fe/templates/library" {}
 
@@ -205,7 +205,7 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
      *
      * @returns A promise that resolves with the new app state object.
      */
-    updateAppState(): undefined | Promise<any>;
+    updateAppState(): Promise<any>;
   }
 }
 
@@ -395,7 +395,7 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
      *
      * @returns A promise that resolves with the new app state object.
      */
-    updateAppState(): undefined | Promise<any>;
+    updateAppState(): Promise<any>;
   }
 }