@sapui5/ts-types 1.95.0 → 1.96.0

package/package.json

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

package/types/index.d.ts

@@ -10,6 +10,7 @@
 /// <reference path="./sap.zen.crosstab.d.ts"/>
 /// <reference path="./sap.zen.dsh.d.ts"/>
 /// <reference path="./sap.zen.commons.d.ts"/>
+/// <reference path="./sap.sac.grid.d.ts"/>
 /// <reference path="./sap.ui.commons.d.ts"/>
 /// <reference path="./sap.ui.comp.d.ts"/>
 /// <reference path="./sap.ui.core.d.ts"/>

package/types/sap.apf.d.ts

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace ca {

package/types/sap.chart.d.ts

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

package/types/sap.collaboration.d.ts

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

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

@@ -1,7 +1,241 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
+  namespace esh {
+    namespace search {
+      /**
+       * UI5 library: sap.esh.search.ui.
+       */
+      namespace ui {
+        interface $SearchCompositeControlSettings
+          extends sap.ui.core.$ControlSettings {
+          /**
+           * An additional CSS class to add to this control
+           */
+          cssClass?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * Defines the initial search term for the search input
+           */
+          searchTerm?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * Defines if the search control will search for the given term right on control instantiation.
+           */
+          searchOnStart?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+          /**
+           * Control instances which are part of this composite control.
+           */
+          content?:
+            | sap.ui.core.Control[]
+            | sap.ui.core.Control
+            | sap.ui.base.ManagedObject.AggregationBindingInfo;
+        }
+
+        /**
+         * @SINCE 1.93.0
+         *
+         * This is the UI5 composite control by the Enterprise Search Team to make full use of the Enterprise Search
+         * Services. This composite control is a complete UI which includes a search input box including a suggestion
+         * dropdown, a result list which can have different styles including tiles and table, result facets and
+         * more. This control is ready to use with an enterprise search backend service but also allows deep modifications
+         * to match requirements of adopting applications.
+         */
+        class SearchCompositeControl extends sap.ui.core.Control {
+          /**
+           * Constructs a new `SearchCompositeControl` to interact with a SAP Enterprise Search Service.
+           *
+           * 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 control
+             */
+            mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
+          );
+          /**
+           * Constructs a new `SearchCompositeControl` to interact with a SAP Enterprise Search Service.
+           *
+           * 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(
+            /**
+             * ID for the new control, generated automatically if no ID is given
+             */
+            sId?: string,
+            /**
+             * Initial settings for the new control
+             */
+            mSettings?: sap.esh.search.ui.$SearchCompositeControlSettings
+          );
+
+          /**
+           * 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}.
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.esh.search.ui.SearchCompositeControl
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Returns a metadata object for class sap.esh.search.ui.SearchCompositeControl.
+           */
+          static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Adds some content to the aggregation {@link #getContent content}.
+           */
+          addContent(
+            /**
+             * The content to add; if empty, nothing is inserted
+             */
+            oContent: sap.ui.core.Control
+          ): this;
+          /**
+           * Destroys all the content in the aggregation {@link #getContent content}.
+           */
+          destroyContent(): this;
+          /**
+           * Gets content of aggregation {@link #getContent content}.
+           *
+           * Control instances which are part of this composite control.
+           */
+          getContent(): sap.ui.core.Control[];
+          /**
+           * Gets current value of property {@link #getCssClass cssClass}.
+           *
+           * An additional CSS class to add to this control
+           */
+          getCssClass(): string;
+          /**
+           * Gets current value of property {@link #getSearchOnStart searchOnStart}.
+           *
+           * Defines if the search control will search for the given term right on control instantiation.
+           *
+           * Default value is `true`.
+           */
+          getSearchOnStart(): boolean;
+          /**
+           * Gets current value of property {@link #getSearchTerm searchTerm}.
+           *
+           * Defines the initial search term for the search input
+           *
+           * Default value is `"*"`.
+           */
+          getSearchTerm(): string;
+          /**
+           * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns
+           * its index if found or -1 otherwise.
+           */
+          indexOfContent(
+            /**
+             * The content whose index is looked for
+             */
+            oContent: sap.ui.core.Control
+          ): int;
+          /**
+           * Inserts a content into the aggregation {@link #getContent content}.
+           */
+          insertContent(
+            /**
+             * The content to insert; if empty, nothing is inserted
+             */
+            oContent: sap.ui.core.Control,
+            /**
+             * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content
+             * is inserted at position 0; for a value greater than the current size of the aggregation, the content
+             * is inserted at the last position
+             */
+            iIndex: int
+          ): this;
+          /**
+           * Removes all the controls from the aggregation {@link #getContent content}.
+           *
+           * Additionally, it unregisters them from the hosting UIArea.
+           */
+          removeAllContent(): sap.ui.core.Control[];
+          /**
+           * Removes a content from the aggregation {@link #getContent content}.
+           */
+          removeContent(
+            /**
+             * The content to remove or its index or id
+             */
+            vContent: int | string | sap.ui.core.Control
+          ): sap.ui.core.Control;
+          /**
+           * Sets a new value for property {@link #getCssClass cssClass}.
+           *
+           * An additional CSS class to add to this control
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           */
+          setCssClass(
+            /**
+             * New value for property `cssClass`
+             */
+            sCssClass: string
+          ): this;
+          /**
+           * Sets a new value for property {@link #getSearchOnStart searchOnStart}.
+           *
+           * Defines if the search control will search for the given term right on control instantiation.
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `true`.
+           */
+          setSearchOnStart(
+            /**
+             * New value for property `searchOnStart`
+             */
+            bSearchOnStart?: boolean
+          ): this;
+          /**
+           * Sets a new value for property {@link #getSearchTerm searchTerm}.
+           *
+           * Defines the initial search term for the search input
+           *
+           * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+           *
+           * Default value is `"*"`.
+           */
+          setSearchTerm(
+            /**
+             * New value for property `searchTerm`
+             */
+            sSearchTerm?: string
+          ): this;
+        }
+      }
+    }
+  }
+
   interface IUI5DefineDependencyNames {
     "sap/esh/search/ui/library": undefined;
+
+    "sap/esh/search/ui/SearchCompositeControl": undefined;
   }
 }

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   /**
@@ -154,6 +154,13 @@ declare namespace sap {
          */
         details?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * The alignment of the side indicators.
+         */
+        sideIndicatorsAlignment?:
+          | sap.f.cards.NumericHeaderSideIndicatorsAlignment
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
         /**
          * Additional side number indicators. For example "Deviation" and "Target". Not more than two side indicators
          * should be used.
@@ -637,8 +644,8 @@ declare namespace sap {
        * Displays general information in the header of the {@link sap.f.Card} and allows the configuration of
        * a numeric value visualization.
        *
-       * You can configure the title, subtitle, status text and icon, using the provided properties. To add more
-       * side number indicators, use the `sideIndicators` aggregation.
+       * You can configure the title, subtitle, and status text, using the provided properties. To add more side
+       * number indicators, use the `sideIndicators` aggregation.
        *
        * **Notes:**
        * 	 - You should always set a title.
@@ -811,6 +818,14 @@ declare namespace sap {
          * should be used.
          */
         getSideIndicators(): sap.f.cards.NumericSideIndicator[];
+        /**
+         * Gets current value of property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+         *
+         * The alignment of the side indicators.
+         *
+         * Default value is `"Begin"`.
+         */
+        getSideIndicatorsAlignment(): sap.f.cards.NumericHeaderSideIndicatorsAlignment;
         /**
          * @EXPERIMENTAL (since 1.64)
          *
@@ -922,6 +937,21 @@ declare namespace sap {
            */
           sValue: string
         ): this;
+        /**
+         * Sets a new value for property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+         *
+         * The alignment of the side indicators.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `"Begin"`.
+         */
+        setSideIndicatorsAlignment(
+          /**
+           * New value for property `sideIndicatorsAlignment`
+           */
+          sSideIndicatorsAlignment?: sap.f.cards.NumericHeaderSideIndicatorsAlignment
+        ): this;
         /**
          * Sets the semantic color which represents the state of the main number indicator.
          */
@@ -1133,6 +1163,21 @@ declare namespace sap {
          */
         Top = "Top",
       }
+      /**
+       * @SINCE 1.96
+       *
+       * Different options for the alignment of the side indicators in the numeric header.
+       */
+      enum NumericHeaderSideIndicatorsAlignment {
+        /**
+         * Sets the alignment to the beginning (left or right depending on LTR/RTL).
+         */
+        Begin = "Begin",
+        /**
+         * Explicitly sets the alignment to the end (left or right depending on LTR/RTL).
+         */
+        End = "End",
+      }
     }
 
     namespace dnd {
@@ -1364,8 +1409,11 @@ declare namespace sap {
        * Used for closing dialogs and showing transitions in `NavContainers` when targets are displayed.
        *
        * **Note:** You should not create an own instance of this class. It is created when using `{@link sap.f.routing.Router}`
-       * or `{@link sap.f.routing.Targets}`. You may use the `{@link #setCloseDialogs}` function to specify if
-       * dialogs should be closed on displaying other views.
+       * or `{@link sap.f.routing.Targets}`.
+       *
+       * **Note:** You may use the `{@link #setCloseDialogs}` function to specify if dialogs should be closed
+       * on displaying other views. The dialogs are closed when a different target is displayed than the previously
+       * displayed one, otherwise the dialogs are kept open.
        */
       class TargetHandler extends sap.ui.base.Object {
         /**
@@ -1373,10 +1421,10 @@ declare namespace sap {
          */
         constructor(
           /**
-           * Closes all open dialogs before navigating, if set to `true` (default). If set to `false`, it just navigates
-           * without closing dialogs.
+           * Closes all open dialogs before navigating to a different target, if set to `true` (default). If set to
+           * `false`, it will just navigate without closing dialogs.
            */
-          bCloseDialogs: boolean
+          closeDialogs: boolean
         );
 
         /**
@@ -1410,6 +1458,9 @@ declare namespace sap {
         getCloseDialogs(): boolean;
         /**
          * Sets if a navigation should close dialogs.
+         *
+         * **Note:** The dialogs are closed when a different target is displayed than the previous one, otherwise
+         * the dialogs are kept open even when `bCloseDialogs` is `true`.
          */
         setCloseDialogs(
           /**
@@ -11215,22 +11266,6 @@ declare namespace sap {
        * Default value is `false`.
        */
       getRestoreFocusOnBackNavigation(): boolean;
-      /**
-       * @SINCE 1.91
-       *
-       * Hides the placeholder on the corresponding column for the provided aggregation name.
-       */
-      hidePlaceholder(
-        /**
-         * Object containing the aggregation name
-         */
-        mSettings: {
-          /**
-           * The aggregation name to decide on which column/container the placeholder should be hidden
-           */
-          aggregation: string;
-        }
-      ): void;
       /**
        * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBeginColumnPages beginColumnPages}.
        * and returns its index if found or -1 otherwise.
@@ -11516,22 +11551,6 @@ declare namespace sap {
          */
         bRestoreFocusOnBackNavigation?: boolean
       ): this;
-      /**
-       * @SINCE 1.91
-       *
-       * Shows the placeholder on the corresponding column for the provided aggregation name.
-       */
-      showPlaceholder(
-        /**
-         * Object containing the aggregation name
-         */
-        mSettings: {
-          /**
-           * The aggregation name to decide on which column/container the placeholder should be shown
-           */
-          aggregation: string;
-        }
-      ): void;
       /**
        * Navigates to the given page inside the FlexibleColumnLayout. Columns are scanned for the page in the
        * following order: `Begin`, `Mid`, `End`.

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   /**
@@ -306,6 +306,69 @@ declare namespace sap {
            */
           showMessageDialog(): Promise<any>;
         }
+        /**
+         * @SINCE 1.94.0
+         *
+         * Controller extension providing hooks for the navigation using paginators
+         */
+        class Paginator extends sap.ui.core.mvc.ControllerExtension {
+          constructor();
+
+          /**
+           * Creates a new subclass of class sap.fe.core.controllerextensions.Paginator 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.mvc.ControllerExtension.extend}.
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.fe.core.controllerextensions.Paginator
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Returns a metadata object for class sap.fe.core.controllerextensions.Paginator.
+           */
+          static getMetadata(): sap.ui.base.Metadata;
+          /**
+           * @SINCE 1.94.0
+           *
+           * Initiates the paginator control.
+           */
+          initialize(
+            /**
+             * ODataListBinding object
+             */
+            oBinding: string,
+            /**
+             * Current context where the navigation is initiated
+             */
+            oContext: object
+          ): void;
+          /**
+           * @SINCE 1.94.0
+           *
+           * Returns the updated context after the paginator operation.
+           */
+          onContextUpdate(
+            /**
+             * Final context returned after the paginator action
+             */
+            oContext: string
+          ): void;
+        }
         /**
          * @SINCE 1.86.0
          *
@@ -508,7 +571,7 @@ declare namespace sap {
              */
             oControl: sap.ui.base.ManagedObject,
             /**
-             * A plain object which should have one function: `refreshBinding`
+             * A plain object which can have one function: `refreshBinding`
              */
             oControlHandler: object[]
           ): void;
@@ -654,6 +717,14 @@ declare namespace sap {
              */
             aPromises: Promise<any>
           ): void;
+          /**
+           * Called when the application is restored due to keep-alive mode.
+           */
+          onRestore(): void;
+          /**
+           * Called when the application is suspended due to keep-alive mode.
+           */
+          onSuspend(): void;
           /**
            * Extend the map of additional states (not control bound) to be added to the current view state of the
            * given view.

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace fe {
@@ -6,6 +6,18 @@ declare namespace sap {
      * Library containing the building blocks for SAP Fiori elements.
      */
     namespace macros {
+      /**
+       * Building block used to create a chart based on the metadata provided by OData V4.
+       *  Usually, a contextPath and metaPath is expected.
+       *
+       * Usage example:
+       * ```javascript
+       *
+       * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
+       * ```
+       */
+      export const Chart: undefined;
+
       /**
        * Building block for creating a field based on the metadata provided by OData V4.
        *  Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display
@@ -77,6 +89,20 @@ declare namespace sap {
       class MicroChart extends sap.fe.macros.MacroMetadata {
         constructor();
       }
+      /**
+       * @SINCE 1.94.0
+       *
+       * Building block used to create a paginator control.
+       *
+       * Usage example:
+       * ```javascript
+       *
+       * <macro:Paginator />
+       * ```
+       */
+      class Paginator extends sap.fe.macros.MacroMetadata {
+        constructor();
+      }
       /**
        * @SINCE 1.93.0
        *
@@ -102,8 +128,6 @@ declare namespace sap {
   }
 
   interface IUI5DefineDependencyNames {
-    "sap/fe/macros/Chart.metadata": undefined;
-
     "sap/fe/macros/FlexibleColumnLayoutActions.metadata": undefined;
 
     "sap/fe/macros/FormElement.metadata": undefined;

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace fe {

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

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

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

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

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

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

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace fe {

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.95.0
+// For Library Version: 1.96.0
 
 declare namespace sap {
   namespace fe {

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

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

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

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