@sapui5/ts-types-esm 1.136.2 → 1.138.0

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

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