@sapui5/ts-types 1.124.2 → 1.124.5

package/package.json

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

package/types/{sap.ui.commons.d.ts → commons-1.124.3-d.ts}

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

package/types/{core-1.124.0-d.ts → core-1.124.3-d.ts}

@@ -279,7 +279,7 @@ declare namespace sap {
     "sap/ui/thirdparty/qunit-2": undefined;
   }
 }
-// For Library Version: 1.124.0
+// For Library Version: 1.124.3
 
 declare module "sap/base/assert" {
   /**
@@ -20980,14 +20980,64 @@ declare namespace sap {
            * **Note:** This static method is automatically propagated to subclasses of `ControllerExtension`.
            *
            *
-           * @returns A controller extension class
+           * @returns The adapted controller extension class
            */
-          static override(
+          static override<
+            TheExtension extends new () => ControllerExtension,
+            AddtlProps extends object,
+          >(
+            this: TheExtension,
             /**
              * The custom extension definition
              */
-            oExtension: Record<string, Function>
-          ): Function;
+            customExtension: AddtlProps
+          ): new () => InstanceType<TheExtension> & AddtlProps;
+          /**
+           * A marker method for applying controller extensions to controller class members in TypeScript code.
+           * This method is only used to make TypeScript usage compatible to the UI5 runtime behavior, where an extension
+           * *class* is assigned when the controller is defined, but each controller instance gets an *instance* of
+           * this extension. This method call is removed in the class transformer when the ES class is transformed
+           * to the traditional UI5 class definition syntax.
+           *
+           * To allow for proper removal, it may only be called directly on the base class `ControllerExtension`,
+           * at the place where a controller extension is assigned to a member property of the new controller class.
+           * The class transformation then removes this call. If it is not removed because it is used in any other
+           * way, then it throws an error at runtime.
+           *
+           * Usage example:
+           * ```javascript
+           * import Routing from "sap/fe/core/controllerextensions/Routing";
+           * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+           * ...
+           * export default class App extends Controller {
+           *    routing = ControllerExtension.use(Routing);
+           * ```
+           *
+           * Usage example with overriding extension callbacks:
+           * ```javascript
+           * import Routing from "sap/fe/core/controllerextensions/Routing";
+           * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+           * ...
+           * export default class App extends Controller {
+           *    routing = ControllerExtension.use(Routing.override({
+           *       ...
+           *    }));
+           * ```
+           *
+           *
+           *
+           * @returns An instance of the given `ControllerExtension`. **NOTE:** this is only a dummy return type for
+           * proper usage in TypeScript. This method does not actually return an instance of `ControllerExtension`,
+           * but only throws an error at runtime. The sole purpose of this method is to mimic the actual runtime behavior
+           * where a *class* is given when a controller is defined, but an *instance* is present in each controller
+           * instance.
+           */
+          static use<TheExtension extends sap.ui.core.mvc.ControllerExtension>(
+            /**
+             * The ControllerExtension to use
+             */
+            extensionClass: new () => TheExtension
+          ): TheExtension;
           /**
            * Returns an Element of the connected view with the given local ID.
            *
@@ -27581,7 +27631,7 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the OpenSearchProvider constructor.
          *
-         * @deprecated (since 1.120)
+         * @deprecated (since 1.120) - There is no API replacement.
          */
         interface $OpenSearchProviderSettings
           extends sap.ui.core.search.$SearchProviderSettings {
@@ -27603,7 +27653,7 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the SearchProvider constructor.
          *
-         * @deprecated (since 1.120)
+         * @deprecated (since 1.120) - There is no API replacement.
          */
         interface $SearchProviderSettings extends sap.ui.core.$ElementSettings {
           /**
@@ -27615,7 +27665,7 @@ declare namespace sap {
         /**
          * A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
          *
-         * @deprecated (since 1.120)
+         * @deprecated (since 1.120) - There is no API replacement.
          */
         class OpenSearchProvider extends sap.ui.core.search.SearchProvider {
           /**
@@ -27760,7 +27810,7 @@ declare namespace sap {
          *
          * Do not create instances of this class, but use a concrete subclass instead.
          *
-         * @deprecated (since 1.120)
+         * @deprecated (since 1.120) - There is no API replacement.
          */
         abstract class SearchProvider extends sap.ui.core.Element {
           /**
@@ -28148,7 +28198,8 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the DOMAttribute constructor.
          *
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         interface $DOMAttributeSettings extends sap.ui.core.$ElementSettings {
           /**
@@ -28165,7 +28216,8 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the DOMElement constructor.
          *
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         interface $DOMElementSettings extends sap.ui.core.$ControlSettings {
           /**
@@ -28200,7 +28252,8 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the HandlebarsTemplate constructor.
          *
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         interface $HandlebarsTemplateSettings
           extends sap.ui.core.tmpl.$TemplateSettings {}
@@ -28221,7 +28274,8 @@ declare namespace sap {
         /**
          * Describes the settings that can be provided to the TemplateControl constructor.
          *
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         interface $TemplateControlSettings
           extends sap.ui.core.$ControlSettings {
@@ -28265,7 +28319,8 @@ declare namespace sap {
          * Represents a DOM attribute of a DOM element.
          *
          * @since 1.15
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         class DOMAttribute extends sap.ui.core.Element {
           /**
@@ -28385,7 +28440,8 @@ declare namespace sap {
          * Represents a DOM element. It allows to use databinding for the properties and nested DOM attributes.
          *
          * @since 1.15
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         class DOMElement extends sap.ui.core.Control {
           /**
@@ -28693,7 +28749,8 @@ declare namespace sap {
          * The class for Handlebars Templates.
          *
          * @since 1.15
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         abstract class HandlebarsTemplate extends sap.ui.core.tmpl.Template {
           /**
@@ -29032,7 +29089,8 @@ declare namespace sap {
          * This is the base class for all template controls. Template controls are declared based on templates.
          *
          * @since 1.15
-         * @deprecated (since 1.56)
+         * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
+         * instead.
          */
         class TemplateControl extends sap.ui.core.Control {
           /**
@@ -29484,7 +29542,7 @@ declare namespace sap {
          *
          * @since 1.107
          * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
-         * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
+         * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
          * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
          */
         interface registry {
@@ -29492,7 +29550,7 @@ declare namespace sap {
            * Number of existing UIAreas.
            *
            * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
-           * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
+           * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
            * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
            */
           size: int;
@@ -29596,8 +29654,8 @@ declare namespace sap {
            * When the ID is `null` or `undefined` or when there's no UIArea with the given ID, then `undefined` is
            * returned.
            *
-           * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
-           * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
+           * @deprecated (since 1.120) - without a replacement. Applications should not be interested in a certain
+           * `UIArea`. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
            * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
            *
            * @returns UIArea with the given ID or `undefined`
@@ -31321,7 +31379,7 @@ declare namespace sap {
         /**
          * Class to mock http requests made to a remote server supporting the OData V2 REST protocol.
          */
-        abstract class MockServer extends sap.ui.base.ManagedObject {
+        class MockServer extends sap.ui.base.ManagedObject {
           /**
            * Creates a mocked server. This helps to mock some back-end calls, e.g. for OData V2/JSON Models or simple
            * XHR calls, without changing the application code. This class can also be used for qunit tests.
@@ -48871,7 +48929,7 @@ declare namespace sap {
          * The node must have an ID that will be used as ID for this instance of `UIArea`.
          *
          * @deprecated (since 1.107) - without a replacement. Applications should not create or modify `UIArea`s
-         * programmatically. THey should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
+         * programmatically. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
          * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
          */
         setRootNode(
@@ -54098,9 +54156,13 @@ declare namespace sap {
             oContext?: sap.ui.model.Context
           ): any | null | undefined;
           /**
-           * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
-           * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
-           * policy, the request can not successfully retrieve data from a different domain, subdomain, or protocol.
+           * Loads JSON-encoded data from the server and stores the resulting JSON data in the model. Note: Due to
+           * browser security restrictions, most "Ajax" requests are subject to the same origin policy, the request
+           * can not successfully retrieve data from a different domain, subdomain, or protocol.
+           *
+           * Note: To send a JSON object in the body of a "POST" request to load the model data, `oParameters` has
+           * to be the JSON-stringified value of the object to be sent, and `mHeaders` has to contain a `"Content-Type"`
+           * property with the value `"application/json;charset=utf-8"`.
            *
            *
            * @returns in case bAsync is set to true a Promise is returned; this promise resolves/rejects based on
@@ -54108,15 +54170,16 @@ declare namespace sap {
            */
           loadData(
             /**
-             * A string containing the URL to which the request is sent.
+             * A string containing the URL to which the request is sent
              */
             sURL: string,
             /**
-             * A map or string that is sent to the server with the request. If the value of this parameter is a string,
-             * it must already be url-encoded. If the value of this parameter is an object (map), it is converted to
-             * a string and then url-encoded. The resulting string is appended to the URL if the HTTP request method
-             * cannot have a request body, e.g. for a GET request. Otherwise, the resulting string is added to the request
-             * body.
+             * The data to be sent to the server with the data-loading request. If `oParameters` is a string, it has
+             * to be encoded based on the used content type. The default encoding is `'application/x-www-form-urlencoded;
+             * charset=UTF-8'` but it may be overwritten via the `"Content-Type"` property given in `mHeaders`. If `oParameters`
+             * is an object, a string is generated and the keys and values are URL-encoded. The resulting string is
+             * appended to the URL if the HTTP request method cannot have a request body, e.g. for a "GET" request.
+             * Otherwise, the resulting string is added to the request body.
              */
             oParameters?: object | string,
             /**
@@ -54126,8 +54189,7 @@ declare namespace sap {
              */
             bAsync?: boolean,
             /**
-             * The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such
-             * as PUT and DELETE, can also be used here, but they are not supported by all browsers.
+             * The HTTP verb to use for the request ("GET" or "POST")
              */
             sType?: string,
             /**

package/types/{sap.ui.dt.d.ts → dt-1.124.3-d.ts}

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

package/types/index.d.ts

@@ -17,10 +17,10 @@
 /// <reference path="./sap.zen.dsh.d.ts"/>
 /// <reference path="./sap.zen.commons.d.ts"/>
 /// <reference path="./sap.sac.df.d.ts"/>
-/// <reference path="./sap.ui.commons.d.ts"/>
+/// <reference path="./commons-1.124.3-d.ts"/>
 /// <reference path="./sap.ui.comp.d.ts"/>
-/// <reference path="./core-1.124.0-d.ts"/>
-/// <reference path="./sap.ui.dt.d.ts"/>
+/// <reference path="./core-1.124.3-d.ts"/>
+/// <reference path="./dt-1.124.3-d.ts"/>
 /// <reference path="./sap.ui.export.d.ts"/>
 /// <reference path="./sap.f.d.ts"/>
 /// <reference path="./sap.ui.fl.d.ts"/>
@@ -32,8 +32,8 @@
 /// <reference path="./sap.ui.integration.d.ts"/>
 /// <reference path="./sap.ui.layout.d.ts"/>
 /// <reference path="./sap.makit.d.ts"/>
-/// <reference path="./mdc-1.124.1-d.ts"/>
-/// <reference path="./mobile-1.124.0-d.ts"/>
+/// <reference path="./sap.ui.mdc.d.ts"/>
+/// <reference path="./mobile-1.124.3-d.ts"/>
 /// <reference path="./sap.me.d.ts"/>
 /// <reference path="./sap.ndc.d.ts"/>
 /// <reference path="./sap.ovp.d.ts"/>
@@ -60,12 +60,12 @@
 /// <reference path="./sap.ui.support.d.ts"/>
 /// <reference path="./sap.ui.table.d.ts"/>
 /// <reference path="./sap.ui.testrecorder.d.ts"/>
-/// <reference path="./tnt-1.124.1-d.ts"/>
+/// <reference path="./sap.tnt.d.ts"/>
 /// <reference path="./sap.ca.ui.d.ts"/>
 /// <reference path="./sap.ui.unified.d.ts"/>
 /// <reference path="./sap.ushell.d.ts"/>
 /// <reference path="./sap.ushell_abap.d.ts"/>
-/// <reference path="./sap.ui.ux3.d.ts"/>
+/// <reference path="./ux3-1.124.3-d.ts"/>
 /// <reference path="./sap.uxap.d.ts"/>
 /// <reference path="./sap.ui.vbm.d.ts"/>
 /// <reference path="./sap.viz.d.ts"/>