@sapui5/ts-types-esm 1.138.0 → 1.139.0

package/README.md

@@ -6,7 +6,7 @@
 
 This npm package contains the TypeScript type definitions based on ES modules for all the SAPUI5 libraries.
 
-The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://sap.github.io/ui5-typescript.
+The central entry point for all information about using UI5 with TypeScript (incl. sample apps and templates) is at https://ui5.github.io/typescript.
 
 ## License
 This package is provided under the terms of the [SAP Developer License Agreement](https://tools.hana.ondemand.com/developer-license-3_2.txt).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sapui5/ts-types-esm",
-  "version": "1.138.0",
+  "version": "1.139.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.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/apf/library" {}
 

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

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

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.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.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/collaboration/library" {
   /**

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

@@ -876,20 +876,7 @@ declare module "sap/cux/home/library" {
    *
    * @since 1.121
    */
-  export enum NewsType {
-    /**
-     * Url is of type ATOM
-     */
-    ATOM = "undefined",
-    /**
-     * News is of type custom news feed
-     */
-    Custom = "undefined",
-    /**
-     * Url is of type RSS
-     */
-    RSS = "undefined",
-  }
+  export enum NewsType {}
 }
 
 declare module "sap/cux/home/MenuItem" {
@@ -1056,8 +1043,6 @@ declare module "sap/cux/home/NewsPanel" {
     $BaseNewsPanelSettings,
   } from "sap/cux/home/BaseNewsPanel";
 
-  import { NewsType } from "sap/cux/home/library";
-
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
 
   /**
@@ -1080,13 +1065,6 @@ declare module "sap/cux/home/NewsPanel" {
       settings?: /* was: sap.cux.home.BaseNewsPanel.$BaseNewsPanelSettings */ any
     );
 
-    /**
-     * Gets current value of property type.
-     *
-     *
-     * @returns Value of property `type`
-     */
-    getType(): NewsType;
     /**
      * Gets current value of property url.
      *
@@ -1094,13 +1072,6 @@ declare module "sap/cux/home/NewsPanel" {
      * @returns Value of property `url`
      */
     getUrl(): string;
-    /**
-     * Gets current value of property type.
-     *
-     *
-     * @returns Value of property `type`
-     */
-    setType(): NewsType;
     /**
      * Gets current value of property url.
      *
@@ -1113,11 +1084,6 @@ declare module "sap/cux/home/NewsPanel" {
    * Describes the settings that can be provided to the NewsPanel constructor.
    */
   export interface $NewsPanelSettings extends $BaseNewsPanelSettings {
-    /**
-     * Type of the news item.
-     */
-    type?: NewsType | PropertyBindingInfo | `{${string}}`;
-
     /**
      * The URL of the news item.
      */

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.1
+// For Library Version: 1.139.0
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -544,7 +544,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
     /**
      * Gets current value of property {@link #getEventConsumers eventConsumers}.
      *
-     * Adds a callback function which is called whenever there is a user triggered event.
+     * Adds a callback function which is called whenever there is a user or a technical event. A user event
+     * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
+     * is an event which is triggered by the internal events or events which can also be triggered by API.
      *
      * @since 1.120
      *
@@ -1190,7 +1192,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
     /**
      * Sets a new value for property {@link #getEventConsumers eventConsumers}.
      *
-     * Adds a callback function which is called whenever there is a user triggered event.
+     * Adds a callback function which is called whenever there is a user or a technical event. A user event
+     * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
+     * is an event which is triggered by the internal events or events which can also be triggered by API.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
@@ -2190,7 +2194,9 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
     isFilterBarVisible?: Function | PropertyBindingInfo | `{${string}}`;
 
     /**
-     * Adds a callback function which is called whenever there is a user triggered event.
+     * Adds a callback function which is called whenever there is a user or a technical event. A user event
+     * is an event which is triggered by the user interaction with the UI, such as clicking. A technical event
+     * is an event which is triggered by the internal events or events which can also be triggered by API.
      *
      * @since 1.120
      */

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -6898,8 +6898,8 @@ declare module "sap/f/DynamicPageTitle" {
      * Gets content of aggregation {@link #getActions actions}.
      *
      * The `DynamicPageTitle` actions.
-     * **Note:** The `actions` aggregation accepts any UI5 control, but it`s recommended to use controls, suitable
-     * for {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.
+     * **Note:** The `actions` aggregation accepts any UI5 control. However, it is best to use buttons or controls
+     * that work well inside toolbars, such as those typically used with {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.
      *
      * **Note:** If the `snappedTitleOnMobile` aggregation is set, its content overrides this aggregation when
      * the control is viewed on a phone mobile device and the `DynamicPageHeader` is in its collapsed (snapped)
@@ -7614,8 +7614,8 @@ declare module "sap/f/DynamicPageTitle" {
 
     /**
      * The `DynamicPageTitle` actions.
-     * **Note:** The `actions` aggregation accepts any UI5 control, but it`s recommended to use controls, suitable
-     * for {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.
+     * **Note:** The `actions` aggregation accepts any UI5 control. However, it is best to use buttons or controls
+     * that work well inside toolbars, such as those typically used with {@link sap.m.Toolbar} and {@link sap.m.OverflowToolbar}.
      *
      * **Note:** If the `snappedTitleOnMobile` aggregation is set, its content overrides this aggregation when
      * the control is viewed on a phone mobile device and the `DynamicPageHeader` is in its collapsed (snapped)

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/base/BuildingBlockBase" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -608,10 +608,14 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.90.0
      *
-     * @returns A promise which resolves once the action has been executed. If resolved, the promise returns:
-     * - If the parameter contexts is an array: an array of objects, each object containing a key "status",
+     * @returns A promise which resolves once the action has been executed. If resolved, the promise returns
+     *
+     *
+     * 	 - If the parameter contexts is an array: an array of objects, each object containing a key "status",
      *     as well as "value" referencing the action status and the context
-     * - If the parameter contexts is not an array: a single context
+     *
+     * 	 - If the parameter contexts is not an array: a single context
+     *
      * The context(s) provided in the promise is (are) either the return value context of the action or the
      * bound context if the return value is undefined.
      */
@@ -1103,10 +1107,14 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
    */
   export default class Paginator extends ControllerExtension {
     /**
-     * This function is used to determine the type of navigation.
-     * If the context is not navigable, it must return 'ContextNavigationType.None'.
-     * If the context is navigable within the same application to a sub object page, it must return 'ContextNavigationType.Internal'.
-     * If the context is navigable to an external application, it must return 'ContextNavigationType.External'.
+     * This method is invoked whenever a context is loaded using the paginator buttons. It determines whether
+     * the context supports navigation. The method must return one of the following:
+     * ContextNavigationType.None: If the context is not navigable.
+     * ContextNavigationType.Internal: If the context supports internal navigation within the same application
+     * to a detail view, such as an object page or a subobject page.
+     * ContextNavigationType.External: If the context navigates to an external application.
+     * The paginator buttons only allow navigation to contexts with internal navigation. Contexts with None
+     * or External navigation are skipped.
      *
      * @since 1.138.0
      *

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/macros/Chart" {
   import {
@@ -1934,14 +1934,14 @@ declare module "sap/fe/macros/field/FieldFormatOptions" {
     /**
      * Property for defining a custom pattern for the date, time, or dateTime format.
      *
-     * If there is a dateTimePattern defined dateTimeStyle is ignored.
+     * If a dateTimePattern is defined, the dateTimeStyle is ignored.
      */
     dateTimePattern?: string | PropertyBindingInfo;
 
     /**
      * Property for defining the display style for the date, time, or dateTime format.
      *
-     * If there is a dateTimePattern defined dateTimeStyle is ignored.
+     * If there is a dateTimePattern defined, dateTimeStyle is ignored.
      */
     dateTimeStyle?: string | PropertyBindingInfo;
 
@@ -1974,6 +1974,21 @@ declare module "sap/fe/macros/field/FieldFormatOptions" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * When the Field is displayed as a clickable element, it defines the size of the reactive area of the clickable
+     * element:
+     * - ReactiveAreaMode.Inline - The link is displayed as part of a sentence.
+     * - ReactiveAreaMode.Overlay - The link is displayed as an overlay on top of other interactive parts of
+     *     the page.
+     * Note: It is designed to make the clickable element easier to activate and helps meet the WCAG 2.2 Target
+     * Size requirement. It is applicable only for the SAP Horizon themes. Note: The size of the reactive area
+     * is sufficiently large to help users avoid accidentally selecting (clicking or tapping) unintended UI
+     * elements. UI elements positioned over other parts of the page may need an invisible active touch area.
+     * This ensures that no elements beneath are activated accidentally when the user tries to interact with
+     * the overlay element.
+     */
+    reactiveAreaMode?: string | PropertyBindingInfo;
+
     /**
      * Defines if the date part of a date time with timezone field should be shown.
      *
@@ -3853,6 +3868,22 @@ declare module "sap/fe/macros/table/Table.block" {
      */
     personalization?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the layout options of the table popins. Only applies to responsive tables.
+     * Allowed values are `Block`, `GridLarge`, and `GridSmall`.
+     *
+     * - `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container
+     *     are rendered one below the other.
+     *
+     * - `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single
+     *     popin row.
+     *
+     * - `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is small, so this layout allows more content to be rendered in a single popin row.
+     */
+    popinLayout?: string | PropertyBindingInfo;
+
     /**
      * An expression that allows you to control the 'read-only' state of the table.
      * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
@@ -4480,6 +4511,22 @@ declare module "sap/fe/macros/table/Table" {
      */
     personalization?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the layout options of the table popins. Only applies to responsive tables.
+     * Allowed values are `Block`, `GridLarge`, and `GridSmall`.
+     *
+     * - `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container
+     *     are rendered one below the other.
+     *
+     * - `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single
+     *     popin row.
+     *
+     * - `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is small, so this layout allows more content to be rendered in a single popin row.
+     */
+    popinLayout?: string | PropertyBindingInfo;
+
     /**
      * An expression that allows you to control the 'read-only' state of the table.
      * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
@@ -5100,6 +5147,22 @@ declare module "sap/fe/macros/table/TreeTable.block" {
      */
     personalization?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the layout options of the table popins. Only applies to responsive tables.
+     * Allowed values are `Block`, `GridLarge`, and `GridSmall`.
+     *
+     * - `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container
+     *     are rendered one below the other.
+     *
+     * - `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single
+     *     popin row.
+     *
+     * - `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is small, so this layout allows more content to be rendered in a single popin row.
+     */
+    popinLayout?: string | PropertyBindingInfo;
+
     /**
      * An expression that allows you to control the 'read-only' state of the table.
      * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the
@@ -5760,6 +5823,22 @@ declare module "sap/fe/macros/table/TreeTable" {
      */
     personalization?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the layout options of the table popins. Only applies to responsive tables.
+     * Allowed values are `Block`, `GridLarge`, and `GridSmall`.
+     *
+     * - `Block`: Sets a block layout for rendering the table popins. The elements inside the popin container
+     *     are rendered one below the other.
+     *
+     * - `GridLarge`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is comparatively larger than GridSmall, so this layout allows less content to be rendered in a single
+     *     popin row.
+     *
+     * - `GridSmall`: Sets a grid layout for rendering the table popins. The grid width for each table popin
+     *     is small, so this layout allows more content to be rendered in a single popin row.
+     */
+    popinLayout?: string | PropertyBindingInfo;
+
     /**
      * An expression that allows you to control the 'read-only' state of the table.
      * If you do not set any expression, SAP Fiori elements hooks into the standard lifecycle to determine the

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

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

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

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

package/types/sap.fe.plugins.managecache.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/plugins/managecache/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/templates/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/fe/test/library" {}
 
@@ -976,6 +976,18 @@ declare module "sap/fe/test/api/FilterBarActions" {
        */
       bApplyAutomatically?: string
     ): object;
+    /**
+     * Select a value from a filter field drop-down list.
+     *
+     *
+     * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
+     */
+    iSelectDropDownOption(
+      /**
+       * The new value to be selected from the drop-down list
+       */
+      vValue?: string
+    ): object;
     /**
      * Selects the chosen variant.
      *

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

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

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

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

package/types/sap.gantt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/gantt/library" {
   import ChartScheme from "sap/gantt/config/ChartScheme";
@@ -11156,7 +11156,7 @@ declare module "sap/gantt/def/pattern/SlashPattern" {
    * background Color
    * strokeColor strokeWidth
    */
-  export default abstract class SlashPattern extends PatternBase {
+  export default class SlashPattern extends PatternBase {
     /**
      * Creates and initializes a slash pattern defined for later reuse.
      *
@@ -45665,6 +45665,16 @@ declare module "sap/gantt/simple/GanttChartWithTable" {
        */
       vValue: Date | string | any[]
     ): void;
+    /**
+     * @since 1.139
+     */
+    multiColumnSort(
+      /**
+       * must be structured as the following { control: table control, oColumns: [], an array of sorted columns,
+       * a column must have a new value oldValues: [], an array of old values for sorted columns }
+       */
+      oEvent: object
+    ): void;
     /**
      * Bind rows of the table aggregtion with given parameters Also, create the promise to wait for inner gantt
      * rendering
@@ -55066,7 +55076,9 @@ declare module "sap/gantt/simple/StockChartPeriod" {
 
   /**
    *  StockChartPeriod is used by `sap.gantt.simple.StockChart` It represents a time period that a specific
-   * stock usages
+   * stock usages If the tooltip aggregation is defined for a stock chart period, it is used to render the
+   * tooltip. If explicitly set to " ", no tooltip is shown. If the tooltip aggregation is not provided, a
+   * default tooltip is displayed in the format - dimension name:period value.
    *
    *  StockChartPeriod is defined as an aggregation of `sap.gantt.simple.StockChartDimension`
    */

package/types/sap.insights.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.139.0
 
 declare module "sap/insights/library" {}