@sapui5/ts-types 1.136.3 → 1.138.1

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

@@ -279,7 +279,7 @@ declare namespace sap {
     "sap/ui/thirdparty/qunit-2": undefined;
   }
 }
-// For Library Version: 1.136.2
+// For Library Version: 1.138.0
 
 declare module "sap/base/assert" {
   /**
@@ -18853,8 +18853,7 @@ declare namespace sap {
                */
               groupingBaseSize?: int;
               /**
-               * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
-               * the `groupingSize` format option is set to a non-positive value.
+               * defines whether grouping is enabled (grouping separators are shown)
                */
               groupingEnabled?: boolean;
               /**
@@ -18863,8 +18862,7 @@ declare namespace sap {
                */
               groupingSeparator?: string;
               /**
-               * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
-               * non-positive value, grouping will be disabled entirely.
+               * defines the grouping size in digits; the default is `3`. It must be a positive number.
                */
               groupingSize?: int;
               /**
@@ -19034,8 +19032,7 @@ declare namespace sap {
                */
               groupingBaseSize?: int;
               /**
-               * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
-               * the `groupingSize` format option is set to a non-positive value.
+               * defines whether grouping is enabled (grouping separators are shown)
                */
               groupingEnabled?: boolean;
               /**
@@ -19044,8 +19041,7 @@ declare namespace sap {
                */
               groupingSeparator?: string;
               /**
-               * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
-               * non-positive value, grouping will be disabled entirely.
+               * defines the grouping size in digits; the default is `3`. It must be a positive number.
                */
               groupingSize?: int;
               /**
@@ -19199,8 +19195,7 @@ declare namespace sap {
                */
               groupingBaseSize?: int;
               /**
-               * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
-               * the `groupingSize` format option is set to a non-positive value.
+               * defines whether grouping is enabled (grouping separators are shown)
                */
               groupingEnabled?: boolean;
               /**
@@ -19209,8 +19204,7 @@ declare namespace sap {
                */
               groupingSeparator?: string;
               /**
-               * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
-               * non-positive value, grouping will be disabled entirely.
+               * defines the grouping size in digits; the default is `3`. It must be a positive number.
                */
               groupingSize?: int;
               /**
@@ -19359,8 +19353,7 @@ declare namespace sap {
                */
               groupingBaseSize?: int;
               /**
-               * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
-               * the `groupingSize` format option is set to a non-positive value.
+               * defines whether grouping is enabled (grouping separators are shown)
                */
               groupingEnabled?: boolean;
               /**
@@ -19369,8 +19362,7 @@ declare namespace sap {
                */
               groupingSeparator?: string;
               /**
-               * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
-               * non-positive value, grouping will be disabled entirely.
+               * defines the grouping size in digits; the default is `3`. It must be a positive number.
                */
               groupingSize?: int;
               /**
@@ -19531,8 +19523,7 @@ declare namespace sap {
                */
               groupingBaseSize?: int;
               /**
-               * defines whether grouping is enabled (grouping separators are shown). **Note:** Grouping is disabled if
-               * the `groupingSize` format option is set to a non-positive value.
+               * defines whether grouping is enabled (grouping separators are shown)
                */
               groupingEnabled?: boolean;
               /**
@@ -19541,8 +19532,7 @@ declare namespace sap {
                */
               groupingSeparator?: string;
               /**
-               * defines the grouping size in digits; the default is `3`. **Note:** If this format option is set to a
-               * non-positive value, grouping will be disabled entirely.
+               * defines the grouping size in digits; the default is `3`. It must be a positive number.
                */
               groupingSize?: int;
               /**
@@ -26462,6 +26452,27 @@ declare namespace sap {
            * @returns Metadata object describing this class
            */
           static getMetadata(): sap.ui.base.Metadata;
+          /**
+           * Returns a managed instance of {@link sap.ui.core.routing.RouterHashChanger} associated with the current
+           * instance.
+           *
+           * This sub-instance handles a specific part of the URL hash. When the sub-instance modifies the hash, it
+           * notifies the parent instance, which then updates the browser’s hash accordingly. Likewise, when the relevant
+           * part of the hash changes externally, the parent instance notifies the sub-instance.
+           *
+           * The provided `sKey` is used as an identifier for caching the sub-instance. If this method is called again
+           * with the same key, the previously created instance is returned.
+           *
+           * @ui5-protected Do not call from applications (only from related classes in the framework)
+           *
+           * @returns The corresponding sub RouterHashChanger instance.
+           */
+          createSubHashChanger(
+            /**
+             * A unique key used as the prefix for the sub RouterHashChanger.
+             */
+            sKey: string
+          ): sap.ui.core.routing.RouterHashChanger;
           /**
            * Save the given hash and potentially fires a "hashChanged" event; may be extended to modify the hash before
            * firing the event.
@@ -26725,7 +26736,10 @@ declare namespace sap {
             oListener?: object
           ): this;
           /**
-           * Creates a view and puts it in an aggregation of a control that has been defined in the {@link sap.ui.core.routing.Target#constructor}.
+           * Creates a view and puts it in an aggregation of a control that has been defined in the {@link #constructor}.
+           *
+           * This method can be used to display a target without changing the browser hash. If the browser hash should
+           * be changed, the {@link sap.ui.core.routing.Router#navTo} method should be used instead
            *
            *
            * @returns resolves with {name: *, view: *, control: *} if the target can be successfully displayed otherwise
@@ -27040,41 +27054,29 @@ declare namespace sap {
            * Creates a view and puts it in an aggregation of the specified control.
            *
            *
-           * @returns this pointer for chaining or a Promise
+           * @returns resolving with {{name: *, view: *, control: *}|undefined} for every vTargets, object for single,
+           * array for multiple
            */
           display(
             /**
-             * Either the target name or a target info object. To display multiple targets you may also pass an array
-             * of target names or target info objects.
+             * the key of the target as specified in the {@link #constructor}. To display multiple targets you may also
+             * pass an array of keys. If the target(s) represents a sap.ui.core.UIComponent, a prefix for its Router
+             * is needed. You can set this parameter with an object which has the 'name' property set with the key of
+             * the target and the 'prefix' property set with the prefix for the UIComponent's router. To display multiple
+             * component targets, you man also pass an array of objects.
              */
-            vTargets:
-              | string
-              | string[]
-              | sap.ui.core.routing.TargetInfo
-              | sap.ui.core.routing.TargetInfo[],
+            vTargets: string | string[] | object | object[],
             /**
              * an object that will be passed to the display event in the data property. If the target has parents, the
              * data will also be passed to them.
              */
-            oData?: object,
+            vData?: object,
             /**
              * the name of the target from which the title option is taken for firing the {@link sap.ui.core.routing.Targets#event:titleChanged titleChanged }
              * event
              */
             sTitleTarget?: string
-          ):
-            | this
-            | Promise<
-                Array<{
-                  name: string;
-
-                  view: sap.ui.core.mvc.View;
-
-                  control: sap.ui.core.Control;
-
-                  targetInfo: sap.ui.core.routing.TargetInfo;
-                }>
-              >;
+          ): Promise<any>;
           /**
            * Fires event {@link #event:created created} to attached listeners.
            *
@@ -32066,8 +32068,6 @@ declare namespace sap {
         }
         /**
          * Describes the settings that can be provided to the WebComponent constructor.
-         *
-         * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
          */
         interface $WebComponentSettings extends sap.ui.core.$ControlSettings {}
 
@@ -32077,8 +32077,7 @@ declare namespace sap {
          * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
          * controls in the dedicated slots of the Web Component.
          *
-         * @since 1.118.0
-         * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
+         * @since 1.138.0
          */
         class WebComponent extends sap.ui.core.Control {
           /**
@@ -32179,8 +32178,7 @@ declare namespace sap {
           static getMetadata(): sap.ui.core.webc.WebComponentMetadata;
         }
         /**
-         * @since 1.118.0
-         * @experimental As of version 1.118.0. The API might change. It is not intended for productive usage yet!
+         * @since 1.138.0
          */
         class WebComponentMetadata extends sap.ui.core.ElementMetadata {
           /**
@@ -51926,7 +51924,7 @@ declare namespace sap {
         /**
          * If called on an instance of an (v1/v2) ODataModel it will enrich it with analytics capabilities.
          *
-         * @experimental This module is only for experimental use!
+         * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
          * @ui5-protected Do not call from applications (only from related classes in the framework)
          */
         function ODataModelAdapter(): void;
@@ -53849,7 +53847,7 @@ declare namespace sap {
          *
          * Lazy initialization of attributes will cause unexpected values when you access object attributes directly.
          *
-         * @experimental This module is only for experimental use!
+         * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
          * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
          */
         interface odata4analytics {
@@ -53880,7 +53878,7 @@ declare namespace sap {
          * to OData requests. If a binding count mode is set to `Request` or `Both`, a warning is logged to remind
          * the application that the OData requests generated by the AnalyticalBinding include a $inlinecount.
          *
-         * @experimental This module is only for experimental use!
+         * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
          * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
          */
         class AnalyticalBinding extends sap.ui.model.TreeBinding {
@@ -54476,7 +54474,10 @@ declare namespace sap {
             bForceChange: boolean
           ): void;
         }
-
+        /**
+         * @deprecated As of version 1.138.0. will be replaced by OData V4 data aggregation, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1 Extension for Data Aggregation}
+         * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
+         */
         class AnalyticalTreeBindingAdapter {
           /**
            * Adapter for TreeBindings to add the ListBinding functionality and use the tree structure in list based
@@ -55042,7 +55043,7 @@ declare namespace sap {
          * controls. Only usable with the sap.ui.table.TreeTable control. The functions defined here are only available
          * when you are using a TreeTable and an ODataModel.
          *
-         * @experimental This module is only for experimental and internal use!
+         * @deprecated As of version 1.138.0. will be replaced by OData V4 hierarchy functionality, see {@link topic:7d914317c0b64c23824bf932cc8a4ae1/section_RCH Recursive Hierarchy}
          */
         function ODataTreeBindingAdapter(): void;
         /**
@@ -62809,8 +62810,6 @@ declare namespace sap {
 
           /**
            * Parameters of the ODataListBinding#separateReceived event.
-           *
-           * @experimental As of version 1.131.0.
            */
           interface ODataListBinding$SeparateReceivedEventParameters {
             /**
@@ -62829,9 +62828,9 @@ declare namespace sap {
             length?: number;
 
             /**
-             * A UI5 message of type {@link module:sap/ui/core/message/MessageType MessageType.Error}
+             * An array of UI5 messages if the request failed; `undefined` otherwise
              */
-            errorMessage?: sap.ui.core.message.Message;
+            messagesOnError?: sap.ui.core.message.Message[];
           }
 
           /**
@@ -66774,7 +66773,9 @@ declare namespace sap {
              * is not an OData simple identifier, it can be used as a placeholder for one. In this way, "/EMPLOYEES/"
              * addresses the same entity type as "/EMPLOYEES/$Type/". That entity type in turn is a map of all its OData
              * children (that is, structural and navigation properties) and determines the set of possible child names
-             * that might be used after the trailing slash.
+             * that might be used after the trailing slash. Since 1.137.0, open (complex or entity) types are supported
+             * as follows: A simple identifier that does not refer to an OData child is valid and treated as a dynamic
+             * property of type "Edm.Untyped".
              *
              * "$" can be used as the last segment to continue a path and thus force scope lookup, but no OData simple
              * identifier preparations. In this way, it serves as a placeholder for a technical property. The path must
@@ -67401,12 +67402,12 @@ declare namespace sap {
                  */
                 $$ownRequest?: boolean;
                 /**
-                 * An array of navigation property names which are omitted from the main list request and loaded in a separate
-                 * request instead (@experimental as of version 1.129.0). This results in the main list becoming available
-                 * faster, while the separate properties are merged as soon as the data is received. Note that the separate
-                 * properties must be single valued and part of the '$expand' system query option, either automatically
-                 * via the "autoExpandSelect" model parameter (see {@link #constructor}) or manually. The `$$separate` parameter
-                 * must not be combined with `$$aggregation`.
+                 * An array of navigation property names which are omitted from the main list request (since 1.137.0). Instead,
+                 * each of them is loaded in a separate request. This results in the main list becoming available faster,
+                 * while the separate properties are merged as soon as the data is received. Note that the separate properties
+                 * must be single valued and part of the '$expand' system query option, either automatically via the "autoExpandSelect"
+                 * model parameter (see {@link #constructor}) or manually. The `$$separate` parameter must not be combined
+                 * with `$$aggregation`.
                  */
                 $$separate?: string[];
                 /**
@@ -68569,8 +68570,6 @@ declare namespace sap {
 
           /**
            * Event object of the ODataListBinding#separateReceived event.
-           *
-           * @experimental As of version 1.131.0.
            */
           type ODataListBinding$SeparateReceivedEvent = sap.ui.base.Event<
             ODataListBinding$SeparateReceivedEventParameters,
@@ -85905,11 +85904,11 @@ declare namespace sap {
          * whether a function is used as arrangement or action. Each function typically contains one or multiple
          * `waitFor` statements.
          */
-        actions?: Record<string, () => void> | Function;
+        actions?: Record<string, Function> | Function;
         /**
          * A map or a class of functions that can be used as assertions in Opa tests.
          */
-        assertions?: Record<string, () => void> | Function;
+        assertions?: Record<string, Function> | Function;
       };
     }
     /**

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

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