@sapui5/ts-types-esm 1.136.3 → 1.138.1

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.4
+// For Library Version: 1.138.1
 
 declare module "sap/esh/search/ui/SearchCompositeControl" {
   import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -714,6 +714,16 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @returns Value of property `initAsync`
      */
     getInitAsync(): Function;
+    /**
+     * Get the status of initialization. In unsuccessful case, the corresponding error instance is returned
+     * either.
+     *
+     * @since 1.132.0
+     *
+     * @returns Promise<{success: boolean;error?: Error;}> If success is true, the initialization was successful.
+     * If success is false, the error property contains the error instance for further handling.
+     */
+    getInitializationStatus(): object;
     /**
      * Gets current value of property {@link #getIsFilterBarVisible isFilterBarVisible}.
      *
@@ -916,6 +926,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * A callback which is called whenever the selection of result view items changes.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
      *
      * @returns Value of property `selectionChange`
      */
@@ -954,6 +965,56 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * @returns Value of property `updateUrl`
      */
     getUpdateUrl(): boolean;
+    /**
+     * Invalidate the search cache. To trigger a search in addition, use function 'retriggerSearch' instead.
+     *
+     * @since 1.124.0
+     */
+    invalidateSearchResultCache(): Promise<void>;
+    /**
+     * Resets the active data source which is selected in the data source drop down list to its default (see
+     * 'defaultDataSource'/'exclusiveDataSource').
+     *
+     * @since 1.124.0
+     */
+    resetDataSource(
+      /**
+       * If true, fires a search query right away. Set to 'false' for batch updates.
+       */
+      fireQuery?: boolean
+    ): this;
+    /**
+     * Resets the UI / search results (reset search query and fire a new search).
+     *
+     * @since 1.125.0
+     */
+    resetSearch(): Promise<void>;
+    /**
+     * Fire a new search (includes invalidation of search cache). To invalidate the search cache w/o triggering
+     * a new search, use function 'invalidateSearchResultCache' instead.
+     *
+     * @since 1.124.0
+     */
+    retriggerSearch(): Promise<void>;
+    /**
+     * Invalidate the search cache and optionally fire a new search. Also see functions 'retriggerSearch' and
+     * 'invalidateSearchResultCache'.
+     *
+     * @since 1.124.0
+     *
+     * @returns Returns 'true' if the search query was fired, otherwise 'void'.
+     */
+    search(
+      /**
+       * Indicates wether the search query should be resetted. Set to 'true' to reset the query.
+       */
+      invalidateQuery?: boolean,
+      /**
+       * Indicates wether the search query should be sent to the search service or not. Set to 'false', to prevent
+       * auto-update of search results.
+       */
+      fireQuery?: boolean
+    ): Promise<true | void>;
     /**
      * Sets a new value for property {@link #getApplicationComponent applicationComponent}.
      *
@@ -1704,6 +1765,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * When called with a value of `null` or `undefined`, the default value of the property will be restored.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -1768,6 +1830,13 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
        */
       bUpdateUrl?: boolean
     ): this;
+    /**
+     * Update hierarchy facet Updates the one and only (static) hierarchy facet (tree control on facet panel).
+     * If no hierarchy facet exists, nothing will happen.
+     *
+     * @since 1.126.0
+     */
+    updateStaticHierarchyFacet(): Promise<void>;
   }
   /**
    * Describes the settings that can be provided to the SearchCompositeControl constructor.
@@ -2076,6 +2145,7 @@ declare module "sap/esh/search/ui/SearchCompositeControl" {
      * A callback which is called whenever the selection of result view items changes.
      *
      * @since 1.113.0
+     * @deprecated As of version 1.137.0. this setting is ignored, subscribe to event 'selectionChange'.
      */
     selectionChange?: Function | PropertyBindingInfo | `{${string}}`;
 

package/types/sap.f.d.ts

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.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.136.2
+// For Library Version: 1.138.0
 
 declare namespace sap {}

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare module "sap/fe/core/AppComponent" {
   import {
@@ -316,6 +316,25 @@ declare module "sap/fe/core/ExtensionAPI" {
 }
 
 declare module "sap/fe/core/library" {
+  /**
+   * Possible navigation modes for a pagination.
+   *
+   * @since 1.138.0
+   */
+  export enum ContextNavigationType {
+    /**
+     * Indicates that the navigation is to an external application.
+     */
+    External = "undefined",
+    /**
+     * Indicates that the navigation is to a subobject page within the same application.
+     */
+    Internal = "undefined",
+    /**
+     * Indicates that there is no navigation.
+     */
+    None = "undefined",
+  }
   /**
    * Possible initial load (first app startup) modes for a ListReport.
    *
@@ -650,7 +669,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.116.0
      *
-     * @returns A promise to be returned by the overridden method.
+     * @returns A promise to be returned by the overridden method. If rejected, any further processing by the
+     * framework is stopped.
      */
     onAfterCreate(
       /**
@@ -672,7 +692,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.116.0
      *
-     * @returns A promise to be returned by the overridden method.
+     * @returns A promise to be returned by the overridden method. If rejected, any further processing by the
+     * framework is stopped.
      */
     onAfterDelete(
       /**
@@ -694,7 +715,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.116.0
      *
-     * @returns A promise to be returned by the overridden method.
+     * @returns A promise to be returned by the overridden method. If rejected, any further processing by the
+     * framework is stopped.
      */
     onAfterDiscard(
       /**
@@ -716,7 +738,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.116.0
      *
-     * @returns A promise to be returned by the overridden method.
+     * @returns A promise to be returned by the overridden method. If rejected, any further processing by the
+     * framework is stopped.
      */
     onAfterEdit(
       /**
@@ -738,7 +761,8 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
      *
      * @since 1.116.0
      *
-     * @returns A promise to be returned by the overridden method.
+     * @returns A promise to be returned by the overridden method. If rejected, any further processing by the
+     * framework is stopped.
      */
     onAfterSave(
       /**
@@ -1066,16 +1090,34 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
 declare module "sap/fe/core/controllerextensions/Paginator" {
   import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 
-  import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
-
   import Context from "sap/ui/model/odata/v4/Context";
 
+  import { ContextNavigationType } from "sap/fe/core/library";
+
+  import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
+
   /**
    * Controller extension providing hooks for the navigation using paginators
    *
    * @since 1.94.0
    */
   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'.
+     *
+     * @since 1.138.0
+     *
+     * @returns A Promise which should resolve to ContextNavigationType enum.
+     */
+    determineContextNavigationType(
+      /**
+       * Object containing the context to be navigated.
+       */
+      context: Context
+    ): Promise<ContextNavigationType>;
     /**
      * Initiates the paginator control.
      *

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare module "sap/fe/macros/Chart" {
   import {
@@ -327,7 +327,7 @@ declare module "sap/fe/macros/CollectionBindingInfo" {
   import Sorter from "sap/ui/model/Sorter";
 
   /**
-   * API to add parameters to the collection binding infos.
+   * API to add parameters to the collection binding info.
    */
   export default class CollectionBindingInfo {
     /**
@@ -357,6 +357,27 @@ declare module "sap/fe/macros/CollectionBindingInfo" {
        */
       sorter: Sorter
     ): void;
+    /**
+     * Attach the events to the table binding.
+     */
+    attachEvent(
+      /**
+       * The event ID to attach the callback to
+       */
+      eventId: string,
+      /**
+       * The callback function to be executed when the event is triggered
+       */
+      callback: Function,
+      /**
+       * The listener object that will be used as the context for the callback function
+       */
+      listener?: object,
+      /**
+       * Data that will be passed to the callback function when the event is triggered
+       */
+      data?: object
+    ): void;
     /**
      * Retrieve the 'serialized' binding info, useful if you want to create your own binding
      *
@@ -556,6 +577,58 @@ declare module "sap/fe/macros/Field" {
   >;
 }
 
+declare module "sap/fe/macros/FormElement" {
+  import {
+    default as FormElement1,
+    $FormElementSettings as $FormElementSettings1,
+  } from "sap/ui/layout/form/FormElement";
+
+  import {
+    PropertyBindingInfo,
+    AggregationBindingInfo,
+  } from "sap/ui/base/ManagedObject";
+
+  import Control from "sap/ui/core/Control";
+
+  /**
+   * Building block used to create a form element based on the metadata provided by OData V4.
+   *
+   * @since 1.90.0
+   */
+  export default class FormElement extends FormElement1 {}
+  /**
+   * Describes the settings that can be provided to the FormElement constructor.
+   */
+  export interface $FormElementSettings extends $FormElementSettings1 {
+    /**
+     * Defines the path of the context used in the current page or block.
+     * This setting is defined by the framework.
+     */
+    contextPath?: string | PropertyBindingInfo;
+
+    /**
+     * Label shown for the field. If not set, the label from the annotations will be shown.
+     */
+    label?: string | PropertyBindingInfo;
+
+    /**
+     * Defines the relative path of the property in the metamodel, based on the current contextPath.
+     */
+    metaPath?: string | PropertyBindingInfo;
+
+    /**
+     * If set to false, the FormElement is not rendered.
+     */
+    visible?: boolean | PropertyBindingInfo | `{${string}}`;
+
+    /**
+     * Optional aggregation of controls that should be displayed inside the FormElement.
+     * If not set, a default Field building block will be rendered
+     */
+    fields?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
+  }
+}
+
 declare module "sap/fe/macros/KPITag" {
   import {
     default as BuildingBlock,
@@ -878,7 +951,7 @@ declare module "sap/fe/macros/MultiValueField" {
     contextPath?: string | PropertyBindingInfo;
 
     /**
-     * Property added to be able to add data / items to the multi value field via a different model
+     * Property added to be able to add data / items to the multi-input field using a different model
      */
     items?: any | PropertyBindingInfo | `{${string}}`;
 
@@ -2042,6 +2115,9 @@ declare module "sap/fe/macros/filterBar/FilterBar" {
     getFilters(): object;
     /**
      * Get the selection variant from the filter bar.
+     * Note: This method returns all the filter values that are set in the filter bar, including the text from
+     * the search field (with $search as the property name). However, it doesn't return any filter field condition
+     * that uses a custom operator.
      *
      *
      * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
@@ -2119,6 +2195,8 @@ declare module "sap/fe/macros/filterBar/FilterBar" {
     /**
      * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
      * existing filters and then apply the SelectionVariant values.
+     * Note: This method cannot set the search field text or any filter field condition that relies on a custom
+     * operator.
      *
      *
      * @returns A promise for asynchronous handling
@@ -2310,6 +2388,9 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     getFilters(): object;
     /**
      * Get the selection variant from the filter bar.
+     * Note: This method returns all the filter values that are set in the filter bar, including the text from
+     * the search field (with $search as the property name). However, it doesn't return any filter field condition
+     * that uses a custom operator.
      *
      *
      * @returns A promise which resolves with a {@link sap.fe.navigation.SelectionVariant }
@@ -2387,6 +2468,8 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
     /**
      * Sets {@link sap.fe.navigation.SelectionVariant } to the filter bar. Note: setSelectionVariant will clear
      * existing filters and then apply the SelectionVariant values.
+     * Note: This method cannot set the search field text or any filter field condition that relies on a custom
+     * operator.
      *
      *
      * @returns A promise for asynchronous handling
@@ -2601,67 +2684,6 @@ declare module "sap/fe/macros/form/Form.block" {
   }
 }
 
-declare module "sap/fe/macros/form/FormElement.block" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
-
-  import Context from "sap/ui/model/Context";
-
-  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
-
-  import Event from "sap/ui/base/Event";
-
-  /**
-   * Building block used to create a form element based on the metadata provided by OData V4.
-   *
-   * @since 1.90.0
-   */
-  export default class FormElement extends Control {}
-  /**
-   * Describes the settings that can be provided to the FormElement constructor.
-   */
-  export interface $FormElementSettings extends $ControlSettings {
-    /**
-     * Defines the path of the context used in the current page or block.
-     * This setting is defined by the framework.
-     */
-    contextPath?: Context | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * Label shown for the field. If not set, the label from the annotations will be shown.
-     */
-    label?: string | PropertyBindingInfo;
-
-    /**
-     * Defines the relative path of the property in the metamodel, based on the current contextPath.
-     */
-    metaPath?: Context | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * If set to false, the FormElement is not rendered.
-     */
-    visible?: boolean | PropertyBindingInfo | `{${string}}`;
-
-    /**
-     * Optional aggregation of controls that should be displayed inside the FormElement.
-     * If not set, a default Field building block will be rendered
-     */
-    fields?: Control;
-  }
-
-  /**
-   * Parameters of the FormElement#change event.
-   */
-  export interface FormElement$ChangeEventParameters {}
-
-  /**
-   * Event object of the FormElement#change event.
-   */
-  export type FormElement$ChangeEvent = Event<
-    FormElement$ChangeEventParameters,
-    FormElement
-  >;
-}
-
 declare module "sap/fe/macros/microchart/MicroChart" {
   import {
     default as MicroChart1,
@@ -2924,6 +2946,11 @@ declare module "sap/fe/macros/table/Action" {
      */
     enableOnSelect?: string | PropertyBindingInfo;
 
+    /**
+     * Displays the AI Icon on the action button.
+     */
+    isAIOperation?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Unique identifier of the action
      */
@@ -3126,6 +3153,11 @@ declare module "sap/fe/macros/table/ActionOverride" {
      */
     enableOnSelect?: string | PropertyBindingInfo;
 
+    /**
+     * Displays the AI Icon on the action button.
+     */
+    isAIOperation?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Unique identifier of the action to overridden.
      */
@@ -3498,7 +3530,7 @@ declare module "sap/fe/macros/table/Table.block" {
    * <macros:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
    * ```
    *
-   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table Overview of Table Building Blocks}
+   * {@link demo:sap/fe/core/fpmExplorer/index.html#/buildingBlocks/table/tableDefault Overview of Table Building Blocks}
    */
   export default class Table extends MacroAPI {
     /**
@@ -3532,6 +3564,13 @@ declare module "sap/fe/macros/table/Table.block" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -3688,6 +3727,12 @@ declare module "sap/fe/macros/table/Table.block" {
      */
     creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -3857,6 +3902,11 @@ declare module "sap/fe/macros/table/Table.block" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data.
      * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
@@ -4088,6 +4138,13 @@ declare module "sap/fe/macros/table/Table" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -4297,6 +4354,12 @@ declare module "sap/fe/macros/table/Table" {
      */
     creationMode?: TableCreationOptions | PropertyBindingInfo | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -4466,6 +4529,11 @@ declare module "sap/fe/macros/table/Table" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data.
      * Allowed values are `GridTable`, `ResponsiveTable` and `AnalyticalTable`.
@@ -4715,6 +4783,13 @@ declare module "sap/fe/macros/table/TreeTable.block" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -4874,6 +4949,12 @@ declare module "sap/fe/macros/table/TreeTable.block" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -5068,6 +5149,11 @@ declare module "sap/fe/macros/table/TreeTable.block" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data. This setting is
      * defined by the framework.
@@ -5303,6 +5389,13 @@ declare module "sap/fe/macros/table/TreeTable" {
         type?: /* was: sap.ui.core.message.MessageType */ any;
       }
     ): Promise<string>;
+    /**
+     * Get the count of the row binding of the table.
+     *
+     *
+     * @returns The count of the row binding
+     */
+    getCount(): number | undefined;
     /**
      * Get the variant management applied to the table.
      *
@@ -5516,6 +5609,12 @@ declare module "sap/fe/macros/table/TreeTable" {
       | PropertyBindingInfo
       | `{${string}}`;
 
+    /**
+     * Determines whether the number of fixed columns can be configured in the Column Settings dialog.
+     * This property doesn't apply for responsive tables
+     */
+    disableColumnFreeze?: boolean | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Controls if the copy functionality of the table is disabled or not.
      */
@@ -5710,6 +5809,11 @@ declare module "sap/fe/macros/table/TreeTable" {
      */
     selectionMode?: string | PropertyBindingInfo;
 
+    /**
+     * Defines the number of records to be initially requested from the back end.
+     */
+    threshold?: int | PropertyBindingInfo | `{${string}}`;
+
     /**
      * Defines the type of table that will be used by the building block to render the data. This setting is
      * defined by the framework.
@@ -6020,7 +6124,7 @@ declare namespace sap {
 
     "sap/fe/macros/form/Form.block": undefined;
 
-    "sap/fe/macros/form/FormElement.block": undefined;
+    "sap/fe/macros/FormElement": undefined;
 
     "sap/fe/macros/KPITag": undefined;
 

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

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

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

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

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

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