@sapui5/ts-types-esm 1.130.1 → 1.131.0

package/package.json

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

package/types/index.d.ts

@@ -19,7 +19,7 @@
 /// <reference path="./sap.sac.df.d.ts"/>
 /// <reference path="./sap.ui.commons.d.ts"/>
 /// <reference path="./sap.ui.comp.d.ts"/>
-/// <reference path="./core-1.130.0-esm-d.ts"/>
+/// <reference path="./sap.ui.core.d.ts"/>
 /// <reference path="./sap.ui.dt.d.ts"/>
 /// <reference path="./sap.ui.export.d.ts"/>
 /// <reference path="./sap.f.d.ts"/>
@@ -32,8 +32,8 @@
 /// <reference path="./sap.ui.integration.d.ts"/>
 /// <reference path="./sap.ui.layout.d.ts"/>
 /// <reference path="./sap.makit.d.ts"/>
-/// <reference path="./mdc-1.130.0-esm-d.ts"/>
-/// <reference path="./mobile-1.130.0-esm-d.ts"/>
+/// <reference path="./sap.ui.mdc.d.ts"/>
+/// <reference path="./sap.m.d.ts"/>
 /// <reference path="./sap.me.d.ts"/>
 /// <reference path="./sap.ndc.d.ts"/>
 /// <reference path="./sap.ovp.d.ts"/>

package/types/sap.apf.d.ts

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

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

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

package/types/sap.chart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.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.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/collaboration/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.0
+// For Library Version: 1.131.0
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -59,7 +59,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Creates a new subclass of class sap.esh.search.ui.SearchCompositeControl with name `sClassName` and enriches
      * it with the information contained in `oClassInfo`.
      *
-     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.VerticalLayout.extend}.
      *
      *
      * @returns Created class / constructor function
@@ -590,8 +590,10 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Gets current value of property {@link #getFacetVisibility facetVisibility}.
      *
      * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
-     * initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
-     * panel typically is taken from the user personalization storage.
+     * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
+     * depending on the user's personalization settings.
+     *
+     * Default value is `false`.
      *
      * @since 1.113.0
      *
@@ -720,6 +722,17 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @returns Value of property `isSearchUrl`
      */
     getIsSearchUrl(): Function;
+    /**
+     * Gets current value of property {@link #getLimitAjaxRequests limitAjaxRequests}.
+     *
+     * Prevents too many ajax requests in a short time.
+     *
+     * Default value is `true`.
+     *
+     *
+     * @returns Value of property `limitAjaxRequests`
+     */
+    getLimitAjaxRequests(): boolean;
     /**
      * Gets current value of property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
      *
@@ -1165,11 +1178,13 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * Sets a new value for property {@link #getFacetVisibility facetVisibility}.
      *
      * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
-     * initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
-     * panel typically is taken from the user personalization storage.
+     * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
+     * depending on the user's personalization settings.
      *
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
+     * Default value is `false`.
+     *
      * @since 1.113.0
      *
      * @returns Reference to `this` in order to allow method chaining
@@ -1178,7 +1193,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
       /**
        * New value for property `facetVisibility`
        */
-      bFacetVisibility: boolean
+      bFacetVisibility?: boolean
     ): this;
     /**
      * Sets a new value for property {@link #getFilterDataSources filterDataSources}.
@@ -1370,6 +1385,24 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       fnIsSearchUrl: Function
     ): this;
+    /**
+     * Sets a new value for property {@link #getLimitAjaxRequests limitAjaxRequests}.
+     *
+     * Prevents too many ajax requests in a short time.
+     *
+     * 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
+     */
+    setLimitAjaxRequests(
+      /**
+       * New value for property `limitAjaxRequests`
+       */
+      bLimitAjaxRequests?: boolean
+    ): this;
     /**
      * Sets a new value for property {@link #getOptimizeForValueHelp optimizeForValueHelp}.
      *
@@ -1902,8 +1935,8 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
 
     /**
      * A boolean which indicates whether the facet panel is initially openend or closed. This affects only the
-     * initial state of the facet panel. When not setting 'facetVisibility', the initial state of the facet
-     * panel typically is taken from the user personalization storage.
+     * initial state of the facet panel. This initial state of the facet panel can be overwritten by the user,
+     * depending on the user's personalization settings.
      *
      * @since 1.113.0
      */
@@ -2020,6 +2053,11 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      */
     eventConsumers?: string | PropertyBindingInfo;
 
+    /**
+     * Prevents too many ajax requests in a short time.
+     */
+    limitAjaxRequests?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Event is fired when search is started.
      *

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {
@@ -43,7 +43,6 @@ declare module "sap/f/library" {
    * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'AvatarGroupType'.
    *
    * @since 1.73
-   * @experimental (since 1.73)
    */
   export enum AvatarGroupType {
     /**
@@ -192,8 +191,6 @@ declare module "sap/f/library" {
    * Interface for controls suitable for the `additionalContent` aggregation of `{@link sap.f.ShellBar}`.
    *
    * @since 1.63
-   * @experimental (since 1.63) - that provides only limited functionality. Also, it can be removed in future
-   * versions.
    */
   export interface IShellBar {
     __implements__sap_f_IShellBar: boolean;
@@ -412,6 +409,24 @@ declare module "sap/f/library" {
        */
       End = "End",
     }
+    /**
+     * Different options for the semantic role in controls that implement the {@link sap.f.ICard} interface.
+     *
+     * This enum is part of the 'sap/f/library' module export and must be accessed by the property 'cards.SemanticRole'.
+     *
+     * @since 1.131
+     * @experimental
+     */
+    enum SemanticRole {
+      /**
+       * The card has interactive elements.
+       */
+      ListItem = "ListItem",
+      /**
+       * The card has no interactive elements.
+       */
+      Region = "Region",
+    }
   }
 
   export namespace dnd {
@@ -1446,10 +1461,12 @@ declare module "sap/f/Card" {
 declare module "sap/f/CardBase" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
 
-  import { ICard } from "sap/f/library";
+  import { ICard, cards } from "sap/f/library";
 
   import { IBadge } from "sap/m/library";
 
+  import Event from "sap/ui/base/Event";
+
   import { CSSSize } from "sap/ui/core/library";
 
   import ElementMetadata from "sap/ui/core/ElementMetadata";
@@ -1524,6 +1541,88 @@ declare module "sap/f/CardBase" {
      * @returns Metadata object describing this class
      */
     static getMetadata(): ElementMetadata;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.CardBase`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.f.CardBase` itself.
+     *
+     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     *
+     * @experimental (since 1.131)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachPress(
+      /**
+       * An application-specific payload object that will be passed to the event handler along with the event
+       * object when firing the event
+       */
+      oData: object,
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.f.CardBase` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.CardBase`.
+     *
+     * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
+     * otherwise it will be bound to this `sap.f.CardBase` itself.
+     *
+     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     *
+     * @experimental (since 1.131)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachPress(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.f.CardBase` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.f.CardBase`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     * @experimental (since 1.131)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachPress(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: Event) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
+    /**
+     * Fires event {@link #event:press press} to attached listeners.
+     *
+     * @experimental (since 1.131)
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    firePress(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: object
+    ): this;
     /**
      * Returns the DOM Element that should get the focus.
      *
@@ -1543,6 +1642,18 @@ declare module "sap/f/CardBase" {
      * @returns Value of property `height`
      */
     getHeight(): CSSSize;
+    /**
+     * Gets current value of property {@link #getSemanticRole semanticRole}.
+     *
+     * Defines the role of the Card Header.
+     *
+     * Default value is `Region`.
+     *
+     * @experimental (since 1.131)
+     *
+     * @returns Value of property `semanticRole`
+     */
+    getSemanticRole(): cards.SemanticRole | keyof typeof cards.SemanticRole;
     /**
      * Gets current value of property {@link #getWidth width}.
      *
@@ -1572,6 +1683,25 @@ declare module "sap/f/CardBase" {
        */
       sHeight?: CSSSize
     ): this;
+    /**
+     * Sets a new value for property {@link #getSemanticRole semanticRole}.
+     *
+     * Defines the role of the Card Header.
+     *
+     * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+     *
+     * Default value is `Region`.
+     *
+     * @experimental (since 1.131)
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    setSemanticRole(
+      /**
+       * New value for property `semanticRole`
+       */
+      sSemanticRole?: cards.SemanticRole | keyof typeof cards.SemanticRole
+    ): this;
     /**
      * Sets a new value for property {@link #getWidth width}.
      *
@@ -1604,7 +1734,41 @@ declare module "sap/f/CardBase" {
      * Defines the height of the card.
      */
     height?: CSSSize | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Defines the role of the Card Header.
+     *
+     * @experimental (since 1.131)
+     */
+    semanticRole?:
+      | (cards.SemanticRole | keyof typeof cards.SemanticRole)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * Fired when action is added on card level. Note: Can be used only if `semanticRole` is `sap.f.cards.SemanticRole.ListItem`.
+     *
+     * @experimental (since 1.131)
+     */
+    press?: (oEvent: Event) => void;
   }
+
+  /**
+   * Parameters of the CardBase#press event.
+   *
+   * @experimental (since 1.131)
+   */
+  export interface CardBase$PressEventParameters {}
+
+  /**
+   * Event object of the CardBase#press event.
+   *
+   * @experimental (since 1.131)
+   */
+  export type CardBase$PressEvent = Event<
+    CardBase$PressEventParameters,
+    CardBase
+  >;
 }
 
 declare module "sap/f/cards/BaseHeader" {
@@ -2038,12 +2202,19 @@ declare module "sap/f/cards/BaseHeader" {
 }
 
 declare module "sap/f/cards/CardBadgeCustomData" {
+  import {
+    default as CustomData,
+    $CustomDataSettings,
+  } from "sap/ui/core/CustomData";
+
   import { URI } from "sap/ui/core/library";
 
-  import Metadata from "sap/ui/base/Metadata";
+  import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { CardBadgeVisibilityMode } from "sap/f/library";
 
+  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
+
   /**
    * Contains a single key/value pair of custom data attached to an `Element`.
    *
@@ -2051,9 +2222,20 @@ declare module "sap/f/cards/CardBadgeCustomData" {
    *
    * @since 1.128
    */
-  export default class CardBadgeCustomData
-    extends /* was: sap..ui.core.CustomData */ Object
-  {
+  export default class CardBadgeCustomData extends CustomData {
+    /**
+     * Constructor for a new `CardBadgeCustomData` element.
+     *
+     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
+     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
+     * of the syntax of the settings object.
+     */
+    constructor(
+      /**
+       * Initial settings for the new element
+       */
+      mSettings?: $CardBadgeCustomDataSettings
+    );
     /**
      * Constructor for a new `CardBadgeCustomData` element.
      *
@@ -2069,14 +2251,14 @@ declare module "sap/f/cards/CardBadgeCustomData" {
       /**
        * Initial settings for the new element
        */
-      mSettings?: object
+      mSettings?: $CardBadgeCustomDataSettings
     );
 
     /**
      * Creates a new subclass of class sap.f.cards.CardBadgeCustomData with name `sClassName` and enriches it
      * with the information contained in `oClassInfo`.
      *
-     * `oClassInfo` might contain the same kind of information as described in {@link sap..ui.core.CustomData.extend}.
+     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.CustomData.extend}.
      *
      *
      * @returns Created class / constructor function
@@ -2102,7 +2284,7 @@ declare module "sap/f/cards/CardBadgeCustomData" {
      *
      * @returns Metadata object describing this class
      */
-    static getMetadata(): Metadata;
+    static getMetadata(): ElementMetadata;
     /**
      * Gets current value of property {@link #getAnnouncementText announcementText}.
      *
@@ -2263,6 +2445,50 @@ declare module "sap/f/cards/CardBadgeCustomData" {
       bVisible?: boolean
     ): this;
   }
+  /**
+   * Describes the settings that can be provided to the CardBadgeCustomData constructor.
+   */
+  export interface $CardBadgeCustomDataSettings extends $CustomDataSettings {
+    /**
+     * Icon URI. This may be either an icon font or image path.
+     *
+     * @since 1.128
+     */
+    icon?: URI | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Describes the corresponding visibility mode, see also {@link sap.f.CardBadgeVisibilityMode}.
+     *
+     * @since 1.128
+     */
+    visibilityMode?:
+      | (CardBadgeVisibilityMode | keyof typeof CardBadgeVisibilityMode)
+      | PropertyBindingInfo
+      | `{${string}}`;
+
+    /**
+     * Defines the color of the badge. The allowed values are from the enum type `sap.ui.core.IndicationColor`.
+     * Additionally values from `sap.ui.core.ValueState` can be used, but this is not recommended by design
+     * guidelines.
+     *
+     * @since 1.128
+     */
+    state?: string | PropertyBindingInfo;
+
+    /**
+     * Defines the cards badge visibility.
+     *
+     * @since 1.128
+     */
+    visible?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Defines text which will is overriding default announcement.
+     *
+     * @since 1.128
+     */
+    announcementText?: string | PropertyBindingInfo;
+  }
 }
 
 declare module "sap/f/cards/Header" {

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

@@ -1,9 +1,32 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
+
+declare module "sap/fe/base/BuildingBlockBase" {
+  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+
+  /**
+   * Base class for building blocks.
+   * This contains the low level functionality of having a content aggregation and handling the rendering
+   * of the content without an actual DOM element.
+   * The building block also defines a state object that can be used to store the state of the building block.
+   * Accessibility and classes information are forwarded to the content control.
+   *
+   * @experimental
+   */
+  export default class BuildingBlockBase extends Control {}
+  /**
+   * Describes the settings that can be provided to the BuildingBlockBase constructor.
+   *
+   * @experimental
+   */
+  export interface $BuildingBlockBaseSettings extends $ControlSettings {}
+}
 
 declare module "sap/fe/base/library" {}
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {
+    "sap/fe/base/BuildingBlockBase": undefined;
+
     "sap/fe/base/library": undefined;
   }
 }

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.130.1
+// For Library Version: 1.131.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -345,8 +345,11 @@ declare module "sap/fe/core/PageController" {
   }
 }
 
-declare module "sap/fe/core/buildingBlocks/BuildingBlockBase" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+declare module "sap/fe/core/buildingBlocks/BuildingBlock" {
+  import {
+    default as BuildingBlockBase,
+    $BuildingBlockBaseSettings,
+  } from "sap/fe/base/BuildingBlockBase";
 
   /**
    * Defines a control that will not exist in the DOM.
@@ -355,13 +358,13 @@ declare module "sap/fe/core/buildingBlocks/BuildingBlockBase" {
    * @since 1.121.0
    * @experimental (since 1.121.0)
    */
-  export default class BuildingBlockBase extends Control {}
+  export default class BuildingBlock extends BuildingBlockBase {}
   /**
-   * Describes the settings that can be provided to the BuildingBlockBase constructor.
+   * Describes the settings that can be provided to the BuildingBlock constructor.
    *
    * @experimental (since 1.121.0)
    */
-  export interface $BuildingBlockBaseSettings extends $ControlSettings {}
+  export interface $BuildingBlockSettings extends $BuildingBlockBaseSettings {}
 }
 
 declare module "sap/fe/core/controllerextensions/BaseControllerExtension" {
@@ -1582,7 +1585,7 @@ declare namespace sap {
 
     "sap/fe/core/BaseController": undefined;
 
-    "sap/fe/core/buildingBlocks/BuildingBlockBase": undefined;
+    "sap/fe/core/buildingBlocks/BuildingBlock": undefined;
 
     "sap/fe/core/controllerextensions/BaseControllerExtension": undefined;
 

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

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