@openui5/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/types",
3
- "version": "1.120.16",
3
+ "version": "1.120.18",
4
4
  "description": "OpenUI5 TypeScript Definitions",
5
5
  "homepage": "https://sap.github.io/ui5-typescript",
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 module "sap/tnt/library" {
4
4
  export interface IToolHeader {
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 module "sap/f/library" {
4
4
  export interface IShellBar {
@@ -150588,7 +150588,7 @@ declare module "sap/m/upload/UploadSet" {
150588
150588
  * Required for receiving a `readyState` is to set the property `sendXHR` to true. This property is not
150589
150589
  * supported by Internet Explorer 9.
150590
150590
  */
150591
- readyState?: string;
150591
+ readyState?: int;
150592
150592
 
150593
150593
  /**
150594
150594
  * Status of the XHR request.
@@ -150596,7 +150596,7 @@ declare module "sap/m/upload/UploadSet" {
150596
150596
  * Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported
150597
150597
  * by Internet Explorer 9.
150598
150598
  */
150599
- status?: string;
150599
+ status?: int;
150600
150600
 
150601
150601
  /**
150602
150602
  * 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 module "sap/tnt/library" {
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 module "sap/ui/codeeditor/library" {}
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 module "sap/ui/commons/library" {
4
4
  import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library";
@@ -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
  /**
@@ -32689,14 +32689,64 @@ declare module "sap/ui/core/mvc/ControllerExtension" {
32689
32689
  * **Note:** This static method is automatically propagated to subclasses of `ControllerExtension`.
32690
32690
  *
32691
32691
  *
32692
- * @returns A controller extension class
32692
+ * @returns The adapted controller extension class
32693
32693
  */
32694
- static override(
32694
+ static override<
32695
+ TheExtension extends new () => ControllerExtension,
32696
+ AddtlProps extends object
32697
+ >(
32698
+ this: TheExtension,
32695
32699
  /**
32696
32700
  * The custom extension definition
32697
32701
  */
32698
- oExtension: Record<string, Function>
32699
- ): Function;
32702
+ customExtension: AddtlProps
32703
+ ): new () => InstanceType<TheExtension> & AddtlProps;
32704
+ /**
32705
+ * A marker method for applying controller extensions to controller class members in TypeScript code.
32706
+ * This method is only used to make TypeScript usage compatible to the UI5 runtime behavior, where an extension
32707
+ * *class* is assigned when the controller is defined, but each controller instance gets an *instance* of
32708
+ * this extension. This method call is removed in the class transformer when the ES class is transformed
32709
+ * to the traditional UI5 class definition syntax.
32710
+ *
32711
+ * To allow for proper removal, it may only be called directly on the base class `ControllerExtension`,
32712
+ * at the place where a controller extension is assigned to a member property of the new controller class.
32713
+ * The class transformation then removes this call. If it is not removed because it is used in any other
32714
+ * way, then it throws an error at runtime.
32715
+ *
32716
+ * Usage example:
32717
+ * ```javascript
32718
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
32719
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
32720
+ * ...
32721
+ * export default class App extends Controller {
32722
+ * routing = ControllerExtension.use(Routing);
32723
+ * ```
32724
+ *
32725
+ * Usage example with overriding extension callbacks:
32726
+ * ```javascript
32727
+ * import Routing from "sap/fe/core/controllerextensions/Routing";
32728
+ * import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
32729
+ * ...
32730
+ * export default class App extends Controller {
32731
+ * routing = ControllerExtension.use(Routing.override({
32732
+ * ...
32733
+ * }));
32734
+ * ```
32735
+ *
32736
+ *
32737
+ *
32738
+ * @returns An instance of the given `ControllerExtension`. **NOTE:** this is only a dummy return type for
32739
+ * proper usage in TypeScript. This method does not actually return an instance of `ControllerExtension`,
32740
+ * but only throws an error at runtime. The sole purpose of this method is to mimic the actual runtime behavior
32741
+ * where a *class* is given when a controller is defined, but an *instance* is present in each controller
32742
+ * instance.
32743
+ */
32744
+ static use<TheExtension extends ControllerExtension>(
32745
+ /**
32746
+ * The ControllerExtension to use
32747
+ */
32748
+ extensionClass: new () => TheExtension
32749
+ ): TheExtension;
32700
32750
  /**
32701
32751
  * Returns an Element of the connected view with the given local ID.
32702
32752
  *
@@ -41155,7 +41205,7 @@ declare module "sap/ui/core/search/OpenSearchProvider" {
41155
41205
  /**
41156
41206
  * A SearchProvider which uses the OpenSearch protocol (either JSON or XML).
41157
41207
  *
41158
- * @deprecated (since 1.120)
41208
+ * @deprecated (since 1.120) - There is no API replacement.
41159
41209
  */
41160
41210
  export default class OpenSearchProvider extends SearchProvider {
41161
41211
  /**
@@ -41295,7 +41345,7 @@ declare module "sap/ui/core/search/OpenSearchProvider" {
41295
41345
  /**
41296
41346
  * Describes the settings that can be provided to the OpenSearchProvider constructor.
41297
41347
  *
41298
- * @deprecated (since 1.120)
41348
+ * @deprecated (since 1.120) - There is no API replacement.
41299
41349
  */
41300
41350
  export interface $OpenSearchProviderSettings extends $SearchProviderSettings {
41301
41351
  /**
@@ -41323,7 +41373,7 @@ declare module "sap/ui/core/search/SearchProvider" {
41323
41373
  *
41324
41374
  * Do not create instances of this class, but use a concrete subclass instead.
41325
41375
  *
41326
- * @deprecated (since 1.120)
41376
+ * @deprecated (since 1.120) - There is no API replacement.
41327
41377
  */
41328
41378
  export default abstract class SearchProvider extends UI5Element {
41329
41379
  /**
@@ -41432,7 +41482,7 @@ declare module "sap/ui/core/search/SearchProvider" {
41432
41482
  /**
41433
41483
  * Describes the settings that can be provided to the SearchProvider constructor.
41434
41484
  *
41435
- * @deprecated (since 1.120)
41485
+ * @deprecated (since 1.120) - There is no API replacement.
41436
41486
  */
41437
41487
  export interface $SearchProviderSettings extends $ElementSettings {
41438
41488
  /**
@@ -42042,7 +42092,8 @@ declare module "sap/ui/core/tmpl/DOMAttribute" {
42042
42092
  * Represents a DOM attribute of a DOM element.
42043
42093
  *
42044
42094
  * @since 1.15
42045
- * @deprecated (since 1.56)
42095
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42096
+ * instead.
42046
42097
  */
42047
42098
  export default class DOMAttribute extends UI5Element {
42048
42099
  /**
@@ -42161,7 +42212,8 @@ declare module "sap/ui/core/tmpl/DOMAttribute" {
42161
42212
  /**
42162
42213
  * Describes the settings that can be provided to the DOMAttribute constructor.
42163
42214
  *
42164
- * @deprecated (since 1.56)
42215
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42216
+ * instead.
42165
42217
  */
42166
42218
  export interface $DOMAttributeSettings extends $ElementSettings {
42167
42219
  /**
@@ -42192,7 +42244,8 @@ declare module "sap/ui/core/tmpl/DOMElement" {
42192
42244
  * Represents a DOM element. It allows to use databinding for the properties and nested DOM attributes.
42193
42245
  *
42194
42246
  * @since 1.15
42195
- * @deprecated (since 1.56)
42247
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42248
+ * instead.
42196
42249
  */
42197
42250
  export default class DOMElement extends Control {
42198
42251
  /**
@@ -42499,7 +42552,8 @@ declare module "sap/ui/core/tmpl/DOMElement" {
42499
42552
  /**
42500
42553
  * Describes the settings that can be provided to the DOMElement constructor.
42501
42554
  *
42502
- * @deprecated (since 1.56)
42555
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42556
+ * instead.
42503
42557
  */
42504
42558
  export interface $DOMElementSettings extends $ControlSettings {
42505
42559
  /**
@@ -42544,7 +42598,8 @@ declare module "sap/ui/core/tmpl/HandlebarsTemplate" {
42544
42598
  * The class for Handlebars Templates.
42545
42599
  *
42546
42600
  * @since 1.15
42547
- * @deprecated (since 1.56)
42601
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42602
+ * instead.
42548
42603
  */
42549
42604
  export default abstract class HandlebarsTemplate extends Template {
42550
42605
  /**
@@ -42626,7 +42681,8 @@ declare module "sap/ui/core/tmpl/HandlebarsTemplate" {
42626
42681
  /**
42627
42682
  * Describes the settings that can be provided to the HandlebarsTemplate constructor.
42628
42683
  *
42629
- * @deprecated (since 1.56)
42684
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42685
+ * instead.
42630
42686
  */
42631
42687
  export interface $HandlebarsTemplateSettings extends $TemplateSettings {}
42632
42688
  }
@@ -42923,7 +42979,8 @@ declare module "sap/ui/core/tmpl/TemplateControl" {
42923
42979
  * This is the base class for all template controls. Template controls are declared based on templates.
42924
42980
  *
42925
42981
  * @since 1.15
42926
- * @deprecated (since 1.56)
42982
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
42983
+ * instead.
42927
42984
  */
42928
42985
  export default class TemplateControl extends Control {
42929
42986
  /**
@@ -43354,7 +43411,8 @@ declare module "sap/ui/core/tmpl/TemplateControl" {
43354
43411
  /**
43355
43412
  * Describes the settings that can be provided to the TemplateControl constructor.
43356
43413
  *
43357
- * @deprecated (since 1.56)
43414
+ * @deprecated (since 1.56) - Use an {@link sap.ui.core.mvc.XMLView XMLView} or a {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed View }
43415
+ * instead.
43358
43416
  */
43359
43417
  export interface $TemplateControlSettings extends $ControlSettings {
43360
43418
  /**
@@ -43956,7 +44014,7 @@ declare module "sap/ui/core/UIArea" {
43956
44014
  *
43957
44015
  * @since 1.107
43958
44016
  * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
43959
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44017
+ * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
43960
44018
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
43961
44019
  */
43962
44020
  static registry: registry;
@@ -44272,7 +44330,7 @@ declare module "sap/ui/core/UIArea" {
44272
44330
  * The node must have an ID that will be used as ID for this instance of `UIArea`.
44273
44331
  *
44274
44332
  * @deprecated (since 1.107) - without a replacement. Applications should not create or modify `UIArea`s
44275
- * programmatically. THey should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44333
+ * programmatically. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44276
44334
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
44277
44335
  */
44278
44336
  setRootNode(
@@ -44293,7 +44351,7 @@ declare module "sap/ui/core/UIArea" {
44293
44351
  *
44294
44352
  * @since 1.107
44295
44353
  * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
44296
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44354
+ * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44297
44355
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
44298
44356
  */
44299
44357
  interface registry {
@@ -44301,7 +44359,7 @@ declare module "sap/ui/core/UIArea" {
44301
44359
  * Number of existing UIAreas.
44302
44360
  *
44303
44361
  * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
44304
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44362
+ * `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44305
44363
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
44306
44364
  */
44307
44365
  size: int;
@@ -44405,8 +44463,8 @@ declare module "sap/ui/core/UIArea" {
44405
44463
  * When the ID is `null` or `undefined` or when there's no UIArea with the given ID, then `undefined` is
44406
44464
  * returned.
44407
44465
  *
44408
- * @deprecated (since 1.120) - without a replacement. Applications should not be interested in the set of
44409
- * all `UIArea`s. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44466
+ * @deprecated (since 1.120) - without a replacement. Applications should not be interested in a certain
44467
+ * `UIArea`. They should only assign controls to them, by using {@link sap.ui.core.Control.prototype.placeAt Control.prototype.placeAt }
44410
44468
  * or use the API of a `UIArea` as reachable via {@link sap.ui.core.Control.prototype.getUIArea Control.prototype.getUIArea}.
44411
44469
  *
44412
44470
  * @returns UIArea with the given ID or `undefined`
@@ -46165,7 +46223,7 @@ declare module "sap/ui/core/util/MockServer" {
46165
46223
  /**
46166
46224
  * Class to mock http requests made to a remote server supporting the OData V2 REST protocol.
46167
46225
  */
46168
- export default abstract class MockServer extends ManagedObject {
46226
+ export default class MockServer extends ManagedObject {
46169
46227
  /**
46170
46228
  * Creates a mocked server. This helps to mock some back-end calls, e.g. for OData V2/JSON Models or simple
46171
46229
  * XHR calls, without changing the application code. This class can also be used for qunit tests.
@@ -55029,9 +55087,13 @@ declare module "sap/ui/model/json/JSONModel" {
55029
55087
  oContext?: Context
55030
55088
  ): any | null | undefined;
55031
55089
  /**
55032
- * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
55033
- * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
55034
- * policy, the request can not successfully retrieve data from a different domain, subdomain, or protocol.
55090
+ * Loads JSON-encoded data from the server and stores the resulting JSON data in the model. Note: Due to
55091
+ * browser security restrictions, most "Ajax" requests are subject to the same origin policy, the request
55092
+ * can not successfully retrieve data from a different domain, subdomain, or protocol.
55093
+ *
55094
+ * Note: To send a JSON object in the body of a "POST" request to load the model data, `oParameters` has
55095
+ * to be the JSON-stringified value of the object to be sent, and `mHeaders` has to contain a `"Content-Type"`
55096
+ * property with the value `"application/json;charset=utf-8"`.
55035
55097
  *
55036
55098
  *
55037
55099
  * @returns in case bAsync is set to true a Promise is returned; this promise resolves/rejects based on
@@ -55039,13 +55101,16 @@ declare module "sap/ui/model/json/JSONModel" {
55039
55101
  */
55040
55102
  loadData(
55041
55103
  /**
55042
- * A string containing the URL to which the request is sent.
55104
+ * A string containing the URL to which the request is sent
55043
55105
  */
55044
55106
  sURL: string,
55045
55107
  /**
55046
- * A map or string that is sent to the server with the request. Data that is sent to the server is appended
55047
- * to the URL as a query string. If the value of the data parameter is an object (map), it is converted
55048
- * to a string and url-encoded before it is appended to the URL.
55108
+ * The data to be sent to the server with the data-loading request. If `oParameters` is a string, it has
55109
+ * to be encoded based on the used content type. The default encoding is `'application/x-www-form-urlencoded;
55110
+ * charset=UTF-8'` but it may be overwritten via the `"Content-Type"` property given in `mHeaders`. If `oParameters`
55111
+ * is an object, a string is generated and the keys and values are URL-encoded. The resulting string is
55112
+ * appended to the URL if the HTTP request method cannot have a request body, e.g. for a "GET" request.
55113
+ * Otherwise, the resulting string is added to the request body.
55049
55114
  */
55050
55115
  oParameters?: object | string,
55051
55116
  /**
@@ -55055,8 +55120,7 @@ declare module "sap/ui/model/json/JSONModel" {
55055
55120
  */
55056
55121
  bAsync?: boolean,
55057
55122
  /**
55058
- * The type of request to make ("POST" or "GET"), default is "GET". Note: Other HTTP request methods, such
55059
- * as PUT and DELETE, can also be used here, but they are not supported by all browsers.
55123
+ * The HTTP verb to use for the request ("GET" or "POST")
55060
55124
  */
55061
55125
  sType?: string,
55062
55126
  /**
@@ -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 module "sap/ui/fl/library" {}
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 module "sap/ui/integration/library" {
4
4
  import { URI } from "sap/ui/core/library";
@@ -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/layout/library" {
4
4
  import Control from "sap/ui/core/Control";
@@ -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
  import Control from "sap/ui/core/Control";
@@ -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/suite/library" {
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 module "sap/ui/support/library" {
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 module "sap/ui/table/library" {
4
4
  import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode";
@@ -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/testrecorder/library" {}
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 module "sap/ui/unified/library" {
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 module "sap/ui/ux3/library" {
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 module "sap/ui/webc/common/library" {}
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 module "sap/ui/webc/fiori/library" {
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 module "sap/ui/webc/main/library" {
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 module "sap/uxap/library" {
4
4
  /**