@openui5/ts-types 1.120.16 → 1.120.18

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openui5/ts-types",
3
- "version": "1.120.16",
3
+ "version": "1.120.18",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://openui5.org",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  /**
package/types/sap.m.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -15861,7 +15861,7 @@ declare namespace sap {
15861
15861
  * Required for receiving a `readyState` is to set the property `sendXHR` to true. This property is not
15862
15862
  * supported by Internet Explorer 9.
15863
15863
  */
15864
- readyState?: string;
15864
+ readyState?: int;
15865
15865
 
15866
15866
  /**
15867
15867
  * Status of the XHR request.
@@ -15869,7 +15869,7 @@ declare namespace sap {
15869
15869
  * Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported
15870
15870
  * by Internet Explorer 9.
15871
15871
  */
15872
- status?: string;
15872
+ status?: int;
15873
15873
 
15874
15874
  /**
15875
15875
  * Http-Response which comes from the server.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -280,7 +280,7 @@ declare namespace sap {
280
280
  }
281
281
  }
282
282
 
283
- // For Library Version: 1.120.16
283
+ // For Library Version: 1.120.18
284
284
 
285
285
  declare module "sap/base/assert" {
286
286
  /**
@@ -20124,14 +20124,64 @@ declare namespace sap {
20124
20124
  * **Note:** This static method is automatically propagated to subclasses of `ControllerExtension`.
20125
20125
  *
20126
20126
  *
20127
- * @returns A controller extension class
20127
+ * @returns The adapted controller extension class
20128
20128
  */
20129
- static override(
20129
+ static override<
20130
+ TheExtension extends new () => ControllerExtension,
20131
+ AddtlProps extends object
20132
+ >(
20133
+ this: TheExtension,
20130
20134
  /**
20131
20135
  * The custom extension definition
20132
20136
  */
20133
- oExtension: Record<string, Function>
20134
- ): Function;
20137
+ customExtension: AddtlProps
20138
+ ): new () => InstanceType<TheExtension> & AddtlProps;
20139
+ /**
20140
+ * A marker method for applying controller extensions to controller class members in TypeScript code.
20141
+ * This method is only used to make TypeScript usage compatible to the UI5 runtime behavior, where an extension
20142
+ * *class* is assigned when the controller is defined, but each controller instance gets an *instance* of
20143
+ * this extension. This method call is removed in the class transformer when the ES class is transformed
20144
+ * to the traditional UI5 class definition syntax.
20145
+ *
20146
+ * To allow for proper removal, it may only be called directly on the base class `ControllerExtension`,
20147
+ * at the place where a controller extension is assigned to a member property of the new controller class.
20148
+ * The class transformation then removes this call. If it is not removed because it is used in any other
20149
+ * way, then it throws an error at runtime.
20150
+ *
20151
+ * Usage example:
20152
+ * ```javascript
20153
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
20154
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
20155
+ * ...
20156
+ * export default class App extends Controller {
20157
+ * routing = ControllerExtension.use(Routing);
20158
+ * ```
20159
+ *
20160
+ * Usage example with overriding extension callbacks:
20161
+ * ```javascript
20162
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
20163
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
20164
+ * ...
20165
+ * export default class App extends Controller {
20166
+ * routing = ControllerExtension.use(Routing.override({
20167
+ * ...
20168
+ * }));
20169
+ * ```
20170
+ *
20171
+ *
20172
+ *
20173
+ * @returns An instance of the given `ControllerExtension`. **NOTE:** this is only a dummy return type for
20174
+ * proper usage in TypeScript. This method does not actually return an instance of `ControllerExtension`,
20175
+ * but only throws an error at runtime. The sole purpose of this method is to mimic the actual runtime behavior
20176
+ * where a *class* is given when a controller is defined, but an *instance* is present in each controller
20177
+ * instance.
20178
+ */
20179
+ static use<TheExtension extends sap.ui.core.mvc.ControllerExtension>(
20180
+ /**
20181
+ * The ControllerExtension to use
20182
+ */
20183
+ extensionClass: new () => TheExtension
20184
+ ): TheExtension;
20135
20185
  /**
20136
20186
  * Returns an Element of the connected view with the given local ID.
20137
20187
  *
@@ -26642,7 +26692,7 @@ declare namespace sap {
26642
26692
  /**
26643
26693
  * Describes the settings that can be provided to the OpenSearchProvider constructor.
26644
26694
  *
26645
- * @deprecated (since 1.120)
26695
+ * @deprecated (since 1.120) - There is no API replacement.
26646
26696
  */
26647
26697
  interface $OpenSearchProviderSettings
26648
26698
  extends sap.ui.core.search.$SearchProviderSettings {
@@ -26664,7 +26714,7 @@ declare namespace sap {
26664
26714
  /**
26665
26715
  * Describes the settings that can be provided to the SearchProvider constructor.
26666
26716
  *
26667
- * @deprecated (since 1.120)
26717
+ * @deprecated (since 1.120) - There is no API replacement.
26668
26718
  */
26669
26719
  interface $SearchProviderSettings extends sap.ui.core.$ElementSettings {
26670
26720
  /**
@@ -26676,7 +26726,7 @@ declare namespace sap {
26676
26726
  /**
26677
26727
  * A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
26678
26728
  *
26679
- * @deprecated (since 1.120)
26729
+ * @deprecated (since 1.120) - There is no API replacement.
26680
26730
  */
26681
26731
  class OpenSearchProvider extends sap.ui.core.search.SearchProvider {
26682
26732
  /**
@@ -26821,7 +26871,7 @@ declare namespace sap {
26821
26871
  *
26822
26872
  * Do not create instances of this class, but use a concrete subclass instead.
26823
26873
  *
26824
- * @deprecated (since 1.120)
26874
+ * @deprecated (since 1.120) - There is no API replacement.
26825
26875
  */
26826
26876
  abstract class SearchProvider extends sap.ui.core.Element {
26827
26877
  /**
@@ -27209,7 +27259,8 @@ declare namespace sap {
27209
27259
  /**
27210
27260
  * Describes the settings that can be provided to the DOMAttribute constructor.
27211
27261
  *
27212
- * @deprecated (since 1.56)
27262
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27263
+ * instead.
27213
27264
  */
27214
27265
  interface $DOMAttributeSettings extends sap.ui.core.$ElementSettings {
27215
27266
  /**
@@ -27226,7 +27277,8 @@ declare namespace sap {
27226
27277
  /**
27227
27278
  * Describes the settings that can be provided to the DOMElement constructor.
27228
27279
  *
27229
- * @deprecated (since 1.56)
27280
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27281
+ * instead.
27230
27282
  */
27231
27283
  interface $DOMElementSettings extends sap.ui.core.$ControlSettings {
27232
27284
  /**
@@ -27261,7 +27313,8 @@ declare namespace sap {
27261
27313
  /**
27262
27314
  * Describes the settings that can be provided to the HandlebarsTemplate constructor.
27263
27315
  *
27264
- * @deprecated (since 1.56)
27316
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27317
+ * instead.
27265
27318
  */
27266
27319
  interface $HandlebarsTemplateSettings
27267
27320
  extends sap.ui.core.tmpl.$TemplateSettings {}
@@ -27282,7 +27335,8 @@ declare namespace sap {
27282
27335
  /**
27283
27336
  * Describes the settings that can be provided to the TemplateControl constructor.
27284
27337
  *
27285
- * @deprecated (since 1.56)
27338
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27339
+ * instead.
27286
27340
  */
27287
27341
  interface $TemplateControlSettings
27288
27342
  extends sap.ui.core.$ControlSettings {
@@ -27326,7 +27380,8 @@ declare namespace sap {
27326
27380
  * Represents a DOM attribute of a DOM element.
27327
27381
  *
27328
27382
  * @since 1.15
27329
- * @deprecated (since 1.56)
27383
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27384
+ * instead.
27330
27385
  */
27331
27386
  class DOMAttribute extends sap.ui.core.Element {
27332
27387
  /**
@@ -27446,7 +27501,8 @@ declare namespace sap {
27446
27501
  * Represents a DOM element. It allows to use databinding for the properties and nested DOM attributes.
27447
27502
  *
27448
27503
  * @since 1.15
27449
- * @deprecated (since 1.56)
27504
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27505
+ * instead.
27450
27506
  */
27451
27507
  class DOMElement extends sap.ui.core.Control {
27452
27508
  /**
@@ -27754,7 +27810,8 @@ declare namespace sap {
27754
27810
  * The class for Handlebars Templates.
27755
27811
  *
27756
27812
  * @since 1.15
27757
- * @deprecated (since 1.56)
27813
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
27814
+ * instead.
27758
27815
  */
27759
27816
  abstract class HandlebarsTemplate extends sap.ui.core.tmpl.Template {
27760
27817
  /**
@@ -28093,7 +28150,8 @@ declare namespace sap {
28093
28150
  * This is the base class for all template controls. Template controls are declared based on templates.
28094
28151
  *
28095
28152
  * @since 1.15
28096
- * @deprecated (since 1.56)
28153
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
28154
+ * instead.
28097
28155
  */
28098
28156
  class TemplateControl extends sap.ui.core.Control {
28099
28157
  /**
@@ -28545,7 +28603,7 @@ declare namespace sap {
28545
28603
  *
28546
28604
  * @since 1.107
28547
28605
  * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
28548
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28606
+ * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28549
28607
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
28550
28608
  */
28551
28609
  interface registry {
@@ -28553,7 +28611,7 @@ declare namespace sap {
28553
28611
  * Number of existing UIAreas.
28554
28612
  *
28555
28613
  * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
28556
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28614
+ * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28557
28615
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
28558
28616
  */
28559
28617
  size: int;
@@ -28657,8 +28715,8 @@ declare namespace sap {
28657
28715
  * When the ID is `null` or `undefined` or when there's no UIArea with the given ID, then `undefined` is
28658
28716
  * returned.
28659
28717
  *
28660
- * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
28661
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28718
+ * @deprecated (since 1.120) - without a replacement. Applications should not be interested in a certain
28719
+ * `UIArea`. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
28662
28720
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
28663
28721
  *
28664
28722
  * @returns UIArea with the given ID or `undefined`
@@ -30379,7 +30437,7 @@ declare namespace sap {
30379
30437
  /**
30380
30438
  * Class to mock http requests made to a remote server supporting the OData V2 REST protocol.
30381
30439
  */
30382
- abstract class MockServer extends sap.ui.base.ManagedObject {
30440
+ class MockServer extends sap.ui.base.ManagedObject {
30383
30441
  /**
30384
30442
  * Creates a mocked server. This helps to mock some back-end calls, e.g. for OData V2/JSON Models or simple
30385
30443
  * XHR calls, without changing the application code. This class can also be used for qunit tests.
@@ -47845,7 +47903,7 @@ declare namespace sap {
47845
47903
  * The node must have an ID that will be used as ID for this instance of `UIArea`.
47846
47904
  *
47847
47905
  * @deprecated (since 1.107) - without a replacement. Applications should not create or modify `UIArea`s
47848
- * programmatically. THey should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
47906
+ * programmatically. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
47849
47907
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
47850
47908
  */
47851
47909
  setRootNode(
@@ -53017,9 +53075,13 @@ declare namespace sap {
53017
53075
  oContext?: sap.ui.model.Context
53018
53076
  ): any | null | undefined;
53019
53077
  /**
53020
- * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
53021
- * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
53022
- * policy, the request can not successfully retrieve data from a different domain, subdomain, or protocol.
53078
+ * Loads JSON-encoded data from the server and stores the resulting JSON data in the model. Note: Due to
53079
+ * browser security restrictions, most "Ajax" requests are subject to the same origin policy, the request
53080
+ * can not successfully retrieve data from a different domain, subdomain, or protocol.
53081
+ *
53082
+ * Note: To send a JSON object in the body of a "POST" request to load the model data, `oParameters` has
53083
+ * to be the JSON-stringified value of the object to be sent, and `mHeaders` has to contain a `"Content-Type"`
53084
+ * property with the value `"application/json;charset=utf-8"`.
53023
53085
  *
53024
53086
  *
53025
53087
  * @returns in case bAsync is set to true a Promise is returned; this promise resolves/rejects based on
@@ -53027,13 +53089,16 @@ declare namespace sap {
53027
53089
  */
53028
53090
  loadData(
53029
53091
  /**
53030
- * A string containing the URL to which the request is sent.
53092
+ * A string containing the URL to which the request is sent
53031
53093
  */
53032
53094
  sURL: string,
53033
53095
  /**
53034
- * A map or string that is sent to the server with the request. Data that is sent to the server is appended
53035
- * to the URL as a query string. If the value of the data parameter is an object (map), it is converted
53036
- * to a string and url-encoded before it is appended to the URL.
53096
+ * The data to be sent to the server with the data-loading request. If `oParameters` is a string, it has
53097
+ * to be encoded based on the used content type. The default encoding is `'application/x-www-form-urlencoded;
53098
+ * charset=UTF-8'` but it may be overwritten via the `"Content-Type"` property given in `mHeaders`. If `oParameters`
53099
+ * is an object, a string is generated and the keys and values are URL-encoded. The resulting string is
53100
+ * appended to the URL if the HTTP request method cannot have a request body, e.g. for a "GET" request.
53101
+ * Otherwise, the resulting string is added to the request body.
53037
53102
  */
53038
53103
  oParameters?: object | string,
53039
53104
  /**
@@ -53043,8 +53108,7 @@ declare namespace sap {
53043
53108
  */
53044
53109
  bAsync?: boolean,
53045
53110
  /**
53046
- * The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such
53047
- * as PUT and DELETE, can also be used here, but they are not supported by all browsers.
53111
+ * The HTTP verb to use for the request ("GET" or "POST")
53048
53112
  */
53049
53113
  sType?: string,
53050
53114
  /**
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare module "sap/ui/mdc/AggregationBaseDelegate" {
4
4
  import BaseDelegate from "sap/ui/mdc/BaseDelegate";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare module "sap/ui/rta/api/startAdaptation" {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -6,6 +6,8 @@ declare namespace sap {
6
6
  * Namespace for UI5 Web Components Retrofit libraries
7
7
  *
8
8
  * @since 1.92.0
9
+ * @deprecated (since 1.120) - this Web Components consumption model has been discarded. An alternative
10
+ * consumption model is planned for the future.
9
11
  * @experimental (since 1.92.0)
10
12
  */
11
13
  namespace webc {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.120.16
1
+ // For Library Version: 1.120.18
2
2
 
3
3
  declare namespace sap {
4
4
  /**