@openui5/ts-types 1.120.2 → 1.120.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.120.2",
+  "version": "1.120.3",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/index.d.ts

@@ -1,6 +1,6 @@
 /*!
 * OpenUI5
-* Copyright 2009-2023 SAP SE or an SAP affiliate company.
+* Copyright 2009-2024 SAP SE or an SAP affiliate company.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 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 namespace sap {
   /**

package/types/sap.tnt.d.ts

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

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

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

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

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

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" {
   /**
@@ -40998,6 +40998,11 @@ declare namespace sap {
          * 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(
@@ -41013,6 +41018,10 @@ declare namespace sap {
              * 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")
              */
@@ -62412,11 +62421,12 @@ declare namespace sap {
              * "@@.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
@@ -62517,7 +62527,8 @@ declare namespace sap {
                */
               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.fl.d.ts

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

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

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

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

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

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";
@@ -36,7 +36,7 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
       /**
        * Instance of an `sap.ui.mdc.Control`
        */
-      oControl: sap.ui.mdc.Control,
+      oControl: sap.ui.mdc.Control | Element,
       /**
        * The name of the property info object/JSON
        */
@@ -46,19 +46,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: sap.ui.mdc.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.
      *
@@ -76,9 +63,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
      */
     onAfterXMLChangeProcessing(
       /**
-       * Instance of an MDC control
+       * XML node of a mdc control
        */
-      oControl: Record<string, sap.ui.mdc.Control>,
+      oControl: Element,
       /**
        * Property bag from SAPUI5 flexibility
        */
@@ -97,9 +84,9 @@ declare module "sap/ui/mdc/AggregationBaseDelegate" {
      */
     removeItem(
       /**
-       * Instance of an `sap.ui.mdc.Control`
+       * Instance of a `sap.ui.mdc.Control`
        */
-      oControl: sap.ui.mdc.Control,
+      oControl: sap.ui.mdc.Control | Element,
       /**
        * The control instance that was removed
        */
@@ -109,34 +96,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: sap.ui.mdc.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, sap.ui.mdc.Control>
-    ): Record<string, any>;
   }
   const AggregationBaseDelegate: AggregationBaseDelegate;
   export default AggregationBaseDelegate;
@@ -1028,6 +987,173 @@ declare module "sap/ui/mdc/field/FieldBaseDelegate" {
   export default FieldBaseDelegate;
 }
 
+declare module "sap/ui/mdc/FilterBarDelegate" {
+  import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate";
+
+  /**
+   * @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: sap.ui.mdc.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: sap.ui.mdc.FilterBar,
+      /**
+       * The name of the property info object/JSON
+       */
+      sPropertyName: string,
+      /**
+       * Instance of property bag from SAPUI5 flexibility change API
+       */
+      mPropertyBag?: Object
+    ): Promise<sap.ui.mdc.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: sap.ui.mdc.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: sap.ui.mdc.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;
+      }
+    ): sap.ui.mdc.enums.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: sap.ui.mdc.FilterBar
+    ): Promise<sap.ui.mdc.filterbar.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: sap.ui.mdc.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: sap.ui.mdc.FilterBar,
+      /**
+       * The filter field instance that was removed
+       */
+      oFilterField: sap.ui.mdc.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: sap.ui.mdc.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: sap.ui.mdc.enums.FilterBarValidationStatus;
+      }
+    ): void;
+  }
+  const FilterBarDelegate: FilterBarDelegate;
+  export default FilterBarDelegate;
+}
+
 declare module "sap/ui/mdc/LinkDelegate" {
   import BaseDelegate from "sap/ui/mdc/BaseDelegate";
 
@@ -24044,6 +24170,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.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" {
   /**

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

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.2
+// For Library Version: 1.120.3
 
 declare namespace sap {
   namespace ui {
@@ -156,6 +156,18 @@ declare namespace sap {
              */
             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: sap.ui.table.Table
+          ): sap.ui.core.Element | undefined;
           /**
            * Returns a metadata object for class sap.ui.table.plugins.MultiSelectionPlugin.
            *
@@ -546,6 +558,18 @@ declare namespace sap {
              */
             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: sap.ui.table.Table
+          ): sap.ui.core.Element | 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 namespace sap {
   interface IUI5DefineDependencyNames {

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

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

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

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

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 namespace sap {
   namespace ui {

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 namespace sap {
   namespace ui {

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 namespace sap {
   namespace ui {

package/types/sap.uxap.d.ts

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