@sapui5/types 1.120.2 → 1.120.4

package/package.json

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

package/types/sap.chart.d.ts

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

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/tnt/library" {
   export interface IToolHeader {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.1
+// For Library Version: 1.120.2
 
 declare module "sap/fe/core/AppComponent" {
   import {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.1
+// For Library Version: 1.120.2
 
 declare module "sap/fe/macros/library" {}
 

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.1
+// For Library Version: 1.120.2
 
 declare module "sap/fe/test/library" {}
 

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

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

package/types/sap.m.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/f/library" {
   export interface IShellBar {

package/types/sap.makit.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/makit/library" {
   /**

package/types/sap.me.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/me/library" {
   /**

package/types/sap.ndc.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ndc/library" {}
 

package/types/sap.ovp.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.0
+// For Library Version: 1.120.2
 
 declare module "sap/ovp/library" {}
 

package/types/sap.suite.ui.generic.template.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.1
+// For Library Version: 1.120.3
 
 declare module "sap/suite/ui/generic/template/library" {
   /**

package/types/sap.suite.ui.microchart.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/suite/ui/microchart/library" {
   /**

package/types/sap.tnt.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/tnt/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/codeeditor/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/commons/library" {
   import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/comp/library" {
   /**

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

@@ -280,7 +280,7 @@ declare namespace sap {
   }
 }
 
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/base/assert" {
   /**
@@ -28435,6 +28435,11 @@ declare module "sap/ui/core/Lib" {
      * in `mSettings` and will evaluate the descriptor file instead. Library developers therefore must keep
      * the information in both files in sync if the `manifest.json` file is maintained manually.
      *
+     * Library API-Version 2:
+     *
+     * The Library API Version 2 has been introduced to avoid access to the global namespace when retrieving
+     * enum types. With Library API Version 2 a library must declare its enum types via {@link module:sap/ui/base/DataType.registerEnum DataType.registerEnum}.
+     *
      * @returns Returns the library namespace, based on the given library name.
      */
     static init(
@@ -28450,6 +28455,10 @@ declare module "sap/ui/core/Lib" {
          * Version of the library
          */
         version?: string;
+        /**
+         * The library's API version; supported values are 1, 2 and `undefined` (defaults to 1).
+         */
+        apiVersion?: int;
         /**
          * List of libraries that this library depends on; names are in dot notation (e.g. "sap.ui.core")
          */
@@ -70308,11 +70317,12 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
      * "@@.AH.isMultiple" or "@@.isMultiple", represent computed annotations. Their name without the "@@" prefix
      * must refer to a function in `mParameters.scope` in case of a relative name starting with a dot, which
      * is stripped before lookup; see the `<template:alias>` instruction for XML Templating. In case of an
-     * absolute name, it is searched in `mParameters.scope` first and then in the global namespace. The names
-     * "requestCurrencyCodes" and "requestUnitsOfMeasure" default to {@link #requestCurrencyCodes} and {@link #requestUnitsOfMeasure }
-     * resp. if not present in `mParameters.scope`. This function is called with the current object (or primitive
-     * value) and additional details and returns the result of this {@link #requestObject} call. The additional
-     * details are given as an object with the following properties:
+     * absolute name, it is searched in `mParameters.scope` first and then in the global namespace. (Using the
+     * global namespace is @deprecated as of version 1.120.3). The names "requestCurrencyCodes" and "requestUnitsOfMeasure"
+     * default to {@link #requestCurrencyCodes} and {@link #requestUnitsOfMeasure} resp. if not present in `mParameters.scope`.
+     * This function is called with the current object (or primitive value) and additional details and returns
+     * the result of this {@link #requestObject} call. The additional details are given as an object with the
+     * following properties:
      * 	 `{boolean} $$valueAsPromise` Whether the computed annotation may return a `Promise` resolving with
      * its value (since 1.57.0)  `{@link sap.ui.model.Context} context` Points to the current object
      * `{object} overload` In case of annotations of an operation or a parameter, if filtering by binding parameter
@@ -70413,7 +70423,8 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
        */
       mParameters?: {
         /**
-         * Optional scope for lookup of aliases for computed annotations (since 1.43.0)
+         * Scope for lookup of aliases for computed annotations (since 1.43.0). Since 1.120.3 looking up a computed
+         * annotation via its global name is deprecated; always use this scope instead.
          */
         scope?: object;
       }

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/export/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/fl/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/integration/library" {
   import { URI } from "sap/ui/core/library";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/layout/library" {
   import Control from "sap/ui/core/Control";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/mdc/AggregationBaseDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -40,7 +40,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
       /**
        * Instance of an `sap.ui.mdc.Control`
        */
-      oControl: Control,
+      oControl: Control | Element,
       /**
        * The name of the property info object/JSON
        */
@@ -50,19 +50,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
        */
       mPropertyBag?: Object
     ): Promise<any>;
-    /**
-     * A validator to evaluate the state of an MDC control.
-     */
-    determineValidationState(
-      /**
-       * Instance of a MDC control
-       */
-      oControl: Control,
-      /**
-       * Object Describing the validation result
-       */
-      mValidation?: Record<string, any>
-    ): void;
     /**
      * Retrieves the relevant metadata for a given payload and returns the property info array.
      *
@@ -80,9 +67,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
      */
     onAfterXMLChangeProcessing(
       /**
-       * Instance of an MDC control
+       * XML node of a mdc control
        */
-      oControl: Record<string, Control>,
+      oControl: Element,
       /**
        * Property bag from SAPUI5 flexibility
        */
@@ -101,9 +88,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
      */
     removeItem(
       /**
-       * Instance of an `sap.ui.mdc.Control`
+       * Instance of a `sap.ui.mdc.Control`
        */
-      oControl: Control,
+      oControl: Control | Element,
       /**
        * The control instance that was removed
        */
@@ -113,34 +100,6 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
        */
       mPropertyBag?: Object
     ): Promise<any>;
-    /**
-     * A validator to evaluate the theoretical control state.
-     *
-     * @returns An object that must contain at least the `validation` attribute {@link sap.ui.core.MessageType MessageType}.
-     * If `warning` or `error` state types have been provided, the `message` is shown in addition.
-     */
-    validateState(
-      /**
-       * Instance of an `sap.ui.mdc.Control`
-       */
-      oControl: Control,
-      /**
-       * The theoretical external state representation of an MDC control. The representation of this format is
-       * similar as processed by {@link sap.ui.mdc.p13n.StateUtil StateUtil}
-       */
-      oState: Object
-    ): Object;
-    /**
-     * Visualizes the validation state of an MDC control.
-     *
-     * @returns mValidation Describes the validation result.
-     */
-    visualizeValidationState(
-      /**
-       * Instance of a MDC control
-       */
-      oControl: Record<string, Control>
-    ): Record<string, any>;
   }
   const AggregationBaseDelegate: AggregationBaseDelegate;
   export default AggregationBaseDelegate;
@@ -1144,6 +1103,179 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
   };
 }
 
+declare module "sap/ui/mdc/FilterBarDelegate" {
+  import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
+
+  import { default as FilterBar, PropertyInfo } from "sap/ui/mdc/FilterBar";
+
+  import FilterField from "sap/ui/mdc/FilterField";
+
+  import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus";
+
+  /**
+   * @since 1.61.0
+   *
+   * Base Delegate for {@link sap.ui.mdc.FilterBar FilterBar}. Extend this object in your project to use all
+   * functionalities of the {@link sap.ui.mdc.FilterBar FilterBar}. This class provides method calls, which
+   * are called by the `FilterBar` at specific operations and allows to overwrite an internal behaviour..
+   */
+  interface FilterBarDelegate extends AggregationBaseDelegate {
+    /**
+     * This method is called during the appliance of the add condition change. The intention is to update the
+     * {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
+     *
+     * @returns `Promise` that is resolved once the propertyInfo property has been updated
+     */
+    addCondition(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * The name of a property
+       */
+      sPropertyName: string,
+      /**
+       * Instance of a property bag from the SAPUI5 flexibility change API
+       */
+      mPropertyBag: Object
+    ): Promise<any>;
+    /**
+     * Creates an instance of a filter field control. **Note:** The `addItem` hook can be used during the processing
+     * of an SAPUI5 flexibility change. Consequently the parameter `mPropertyBag` is only passed during preprocessing.
+     * In runtime scenarios (such as opening a personalization dialog), this method might be called without
+     * the parameter `mPropertyBag`.
+     *
+     * @returns `Promise` that resolves with an instance of the implementing {@link sap.ui.mdc.FilterField Control}.
+     * **Note:** This method always requires a return value once it has been called. If an item for a given
+     * property `sPropertyName` has already been created, it must to either return the existing instance or
+     * create a new instance.
+     */
+    addItem(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * The name of the property info object/JSON
+       */
+      sPropertyName: string,
+      /**
+       * Instance of property bag from SAPUI5 flexibility change API
+       */
+      mPropertyBag?: Object
+    ): Promise<FilterField>;
+    /**
+     * This method is called when the Clear button is pressed.
+     *
+     * @returns `Promise` that is resolved once the action has been completed
+     */
+    clearFilters(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar
+    ): Promise<any>;
+    /**
+     * A validator to evaluate the `FilterBar` state.
+     *
+     * @returns The inner `FilterBar` state
+     */
+    determineValidationState(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * Object describing the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
+       */
+      mValidation?: {
+        /**
+         * Status of the validation {@link sap.ui.mdc.enums.FilterBarValidationStatus}
+         */
+        status?: string;
+      }
+    ): FilterBarValidationStatus;
+    /**
+     * Retrieves the relevant metadata for a given payload and returns the property info array.
+     *
+     * @returns `Promise` that resolves into an array of property info objects
+     */
+    fetchProperties(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar
+    ): Promise<PropertyInfo[]>;
+    /**
+     * propertyInfo This method is called during the appliance of the remove condition change. The intention
+     * is to update the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo} property.
+     *
+     * @returns `Promise` that is resolved once the {@link sap.ui.mdc.FilterBarBase#setPropertyInfo propertyInfo }
+     * property has been updated
+     */
+    removeCondition(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * The name of a property
+       */
+      sPropertyName: string,
+      /**
+       * Instance of a property bag from the SAPUI5 flexibility change API
+       */
+      mPropertyBag: Object
+    ): Promise<any>;
+    /**
+     * Triggers any necessary follow-up steps that need to be taken after the removal of created items via `removeItem`.
+     * The returned Boolean value inside the `Promise` can be used to prevent the default follow-up behavior
+     * of the SAPUI5 flexibility handling.
+     *
+     * **Note:**The `removeItem` hook can be used during the processing of an SAPUI5 flexibility change. Consequently
+     * the parameter `mPropertyBag` is only passed during preprocessing. In runtime scenarios (such as opening
+     * a personalization dialog), this method can be called without the parameter `mPropertyBag`.
+     *
+     * @returns `Promise` that resolved with `true`, `false` to allow/prevent default behavior of the change
+     */
+    removeItem(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * The filter field instance that was removed
+       */
+      oFilterField: FilterField,
+      /**
+       * Instance of property bag from SAPUI5 flexibility
+       */
+      mPropertyBag?: Object
+    ): Promise<boolean>;
+    /**
+     * Visualizes the `FilterBar` validation state.
+     */
+    visualizeValidationState(
+      /**
+       * Instance of the {@link sap.ui.mdc.FilterBar FilterBar} control
+       */
+      oFilterBar: FilterBar,
+      /**
+       * Describes the validation result. This object is only provided when called from the {@link sap.ui.mdc.FilterBar FilterBar}
+       */
+      mValidation: {
+        /**
+         * Status of the validation as returned via {@link sap.ui.mdc.filterbar.FilterBarBase#checkValidationState checkValidationState}
+         */
+        status: FilterBarValidationStatus;
+      }
+    ): void;
+  }
+  const FilterBarDelegate: FilterBarDelegate;
+  export default FilterBarDelegate;
+}
+
 declare module "sap/ui/mdc/LinkDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
 
@@ -24470,6 +24602,8 @@ declare namespace sap {
 
     "sap/ui/mdc/filterbar/vh/FilterBar": undefined;
 
+    "sap/ui/mdc/FilterBarDelegate": undefined;
+
     "sap/ui/mdc/FilterField": undefined;
 
     "sap/ui/mdc/library": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/richtexteditor/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/rta/api/startAdaptation" {
   import Control from "sap/ui/core/Control";

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/suite/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/support/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/table/library" {
   import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -2865,6 +2865,10 @@ declare module "sap/ui/table/plugins/MultiSelectionPlugin" {
     SelectionPlugin$SelectionChangeEventParameters,
   } from "sap/ui/table/plugins/SelectionPlugin";
 
+  import Table from "sap/ui/table/Table";
+
+  import UI5Element from "sap/ui/core/Element";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { SelectionMode } from "sap/ui/table/library";
@@ -2923,6 +2927,18 @@ declare module "sap/ui/table/plugins/MultiSelectionPlugin" {
        */
       FNMetaImpl?: Function
     ): Function;
+    /**
+     * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+     * plugin that is found is returned.
+     *
+     * @returns The found plugin instance or `undefined` if not found
+     */
+    static findOn(
+      /**
+       * The `Table` instance to check for
+       */
+      oTable: Table
+    ): UI5Element | undefined;
     /**
      * Returns a metadata object for class sap.ui.table.plugins.MultiSelectionPlugin.
      *
@@ -3346,6 +3362,8 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
 
   import Event from "sap/ui/base/Event";
 
+  import Table from "sap/ui/table/Table";
+
   import ElementMetadata from "sap/ui/core/ElementMetadata";
 
   import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
@@ -3394,6 +3412,18 @@ declare module "sap/ui/table/plugins/SelectionPlugin" {
        */
       FNMetaImpl?: Function
     ): Function;
+    /**
+     * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+     * plugin that is found is returned.
+     *
+     * @returns The found plugin instance or `undefined` if not found
+     */
+    static findOn(
+      /**
+       * The `Table` instance to check for
+       */
+      oTable: Table
+    ): UI5Element | undefined;
     /**
      * Returns a metadata object for class sap.ui.table.plugins.SelectionPlugin.
      *

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/testrecorder/library" {}
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/unified/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/ux3/library" {
   /**

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/webc/common/library" {}
 

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/webc/fiori/library" {
   /**

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/ui/webc/main/library" {
   /**

package/types/sap.uiext.inbox.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/uiext/inbox/library" {}
 

package/types/sap.ushell.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.4
 
 declare module "sap/ushell/library" {
   /**

package/types/sap.ushell_abap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.4
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/uxap/library" {
   /**

package/types/sap.viz.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare module "sap/viz/library" {
   export namespace ui5 {