@sapui5/ts-types-esm 1.139.0 → 1.140.0

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.
Files changed (69) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +0 -1623
  7. package/types/sap.esh.search.ui.d.ts +1 -2297
  8. package/types/sap.f.d.ts +59 -11
  9. package/types/sap.fe.ariba.d.ts +1 -1
  10. package/types/sap.fe.base.d.ts +1 -5
  11. package/types/sap.fe.controls.d.ts +1 -1
  12. package/types/sap.fe.core.d.ts +15 -8
  13. package/types/sap.fe.ina.d.ts +1 -1
  14. package/types/sap.fe.macros.d.ts +3 -10
  15. package/types/sap.fe.navigation.d.ts +1 -1
  16. package/types/sap.fe.placeholder.d.ts +1 -1
  17. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  18. package/types/sap.fe.templates.d.ts +1 -1
  19. package/types/sap.fe.test.d.ts +1 -1
  20. package/types/sap.fe.tools.d.ts +1 -1
  21. package/types/sap.feedback.ui.d.ts +1 -1
  22. package/types/sap.gantt.d.ts +41 -11
  23. package/types/sap.insights.d.ts +130 -2
  24. package/types/sap.m.d.ts +645 -274
  25. package/types/sap.makit.d.ts +1 -1
  26. package/types/sap.me.d.ts +1 -1
  27. package/types/sap.ndc.d.ts +1 -1
  28. package/types/sap.ovp.d.ts +1 -1
  29. package/types/sap.rules.ui.d.ts +1 -1
  30. package/types/sap.sac.df.d.ts +99 -1
  31. package/types/sap.suite.ui.commons.d.ts +1 -1
  32. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  33. package/types/sap.suite.ui.microchart.d.ts +1 -1
  34. package/types/sap.tnt.d.ts +5 -1
  35. package/types/sap.ui.codeeditor.d.ts +1 -1
  36. package/types/sap.ui.commons.d.ts +1 -1
  37. package/types/sap.ui.comp.d.ts +16 -1
  38. package/types/sap.ui.core.d.ts +402 -97
  39. package/types/sap.ui.dt.d.ts +1 -1
  40. package/types/sap.ui.export.d.ts +1 -1
  41. package/types/sap.ui.fl.d.ts +1 -7
  42. package/types/sap.ui.generic.app.d.ts +1 -1
  43. package/types/sap.ui.generic.template.d.ts +1 -1
  44. package/types/sap.ui.integration.d.ts +13 -13
  45. package/types/sap.ui.layout.d.ts +1 -1
  46. package/types/sap.ui.mdc.d.ts +80 -28
  47. package/types/sap.ui.richtexteditor.d.ts +1 -1
  48. package/types/sap.ui.rta.d.ts +1 -1
  49. package/types/sap.ui.suite.d.ts +1 -1
  50. package/types/sap.ui.support.d.ts +1 -1
  51. package/types/sap.ui.table.d.ts +568 -1
  52. package/types/sap.ui.testrecorder.d.ts +1 -1
  53. package/types/sap.ui.unified.d.ts +1 -1
  54. package/types/sap.ui.ux3.d.ts +1 -1
  55. package/types/sap.ui.vbm.d.ts +1 -1
  56. package/types/sap.ui.vk.d.ts +307 -6
  57. package/types/sap.ui.vtm.d.ts +1 -1
  58. package/types/sap.ui.webc.common.d.ts +1 -1
  59. package/types/sap.ui.webc.fiori.d.ts +1 -1
  60. package/types/sap.ui.webc.main.d.ts +1 -1
  61. package/types/sap.uiext.inbox.d.ts +1 -1
  62. package/types/sap.ushell.d.ts +10 -6
  63. package/types/sap.ushell_abap.d.ts +3 -1
  64. package/types/sap.uxap.d.ts +1 -1
  65. package/types/sap.viz.d.ts +1 -1
  66. package/types/sap.webanalytics.core.d.ts +1 -1
  67. package/types/sap.zen.commons.d.ts +1 -1
  68. package/types/sap.zen.crosstab.d.ts +1 -1
  69. package/types/sap.zen.dsh.d.ts +1 -1
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.139.0
282
+ // For Library Version: 1.140.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -2432,8 +2432,10 @@ declare module "sap/base/security/URLListValidator" {
2432
2432
  */
2433
2433
  port?: string,
2434
2434
  /**
2435
- * the path of the URL, path of the url, can be falsy to allow all paths. A wildcard asterisk can be set
2436
- * at the end, e.g. "/my-example*", "/my-news"
2435
+ * the path of the URL, e.g. "/my-news". Can be falsy to allow all paths. A wildcard asterisk can be set
2436
+ * at the end to ensure a path starts with the given string, e.g. "/my-example*". When using wildcards,
2437
+ * make sure to only provide normalized URLs to the validate function in order to mitigate the risk of path
2438
+ * traversal attacks.
2437
2439
  */
2438
2440
  path?: string
2439
2441
  ): void;
@@ -2451,11 +2453,14 @@ declare module "sap/base/security/URLListValidator" {
2451
2453
  /**
2452
2454
  * Validates a URL. Check if it's not a script or other security issue.
2453
2455
  *
2454
- * **Note**: It is strongly recommended to validate only absolute URLs. There's almost no case where checking
2455
- * only the path of a URL would allow to ensure its validity. For compatibility reasons, this API cannot
2456
- * automatically resolve URLs relative to `document.baseURI`, but callers should do so. In that case, and
2457
- * when the allow list is not empty, an entry for the origin of `document.baseURI` must be added to the
2458
- * allow list.
2456
+ * **Note**: It is strongly recommended to validate only absolute, normalized URLs. There's almost no case
2457
+ * where checking only the path of a URL would allow to ensure its validity. For compatibility reasons,
2458
+ * this API does not normalize URLs and cannot automatically resolve URLs relative to `document.baseURI`,
2459
+ * but callers should do so. In that case, and when the allow list is not empty, an entry for the origin
2460
+ * of `document.baseURI` must be added to the allow list.
2461
+ *
2462
+ * Any measures to mitigate path traversal or similar attack vectors must be taken by the caller, e.g. by
2463
+ * using the {@link https://developer.mozilla.org/docs/Web/API/URL URL} API to normalize the URL beforehand.
2459
2464
  *
2460
2465
  * Details: Splits the given URL into components and checks for allowed characters according to RFC 3986:
2461
2466
  *
@@ -5415,6 +5420,10 @@ declare module "sap/ui/dom/includeStylesheet" {
5415
5420
  *
5416
5421
  * - otherwise: no action
5417
5422
  *
5423
+ * **Note:** `includeStylesheet` must not be used for UI5 library CSS. UI5 library CSS is managed by the
5424
+ * UI5 theming lifecycle. Interfering with this lifecycle by manually including library CSS via `includeStylesheet`
5425
+ * can lead to unexpected behavior and theming issues.
5426
+ *
5418
5427
  * @since 1.58
5419
5428
  *
5420
5429
  * @returns When using the configuration object a `Promise` will be returned. The documentation for the
@@ -6015,8 +6024,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6015
6024
  */
6016
6025
  refreshAfterChange?: boolean;
6017
6026
  /**
6018
- * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests. **Deprecated**
6019
- * as of version 1.128.0, the concept has been discarded.
6027
+ * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests. **Deprecated
6028
+ * as of version 1.128.0**, the concept has been discarded.
6020
6029
  */
6021
6030
  sequentializeRequests?: boolean;
6022
6031
  /**
@@ -6051,19 +6060,20 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6051
6060
  */
6052
6061
  withCredentials?: boolean;
6053
6062
  /**
6054
- * **Deprecated** for security reasons. Use strong server side authentication instead. Password for the
6055
- * service.
6063
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
6064
+ * Password for the service.
6056
6065
  */
6057
6066
  password?: string;
6058
6067
  /**
6059
- * **Deprecated** This parameter does not prevent creation of annotations from the metadata document in
6060
- * this model's metamodel. Whether to skip the automated loading of annotations from the metadata document.
6061
- * Loading annotations from metadata does not have any effects (except the lost performance by invoking
6062
- * the parser) if there are no annotations inside the metadata document
6068
+ * **Deprecated as of version 1.112.0** This parameter does not prevent creation of annotations from the
6069
+ * metadata document in this model's metamodel. Whether to skip the automated loading of annotations from
6070
+ * the metadata document. Loading annotations from metadata does not have any effects (except the lost performance
6071
+ * by invoking the parser) if there are no annotations inside the metadata document
6063
6072
  */
6064
6073
  skipMetadataAnnotationParsing?: boolean;
6065
6074
  /**
6066
- * **Deprecated** for security reasons. Use strong server side authentication instead. UserID for the service.
6075
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
6076
+ * UserID for the service.
6067
6077
  */
6068
6078
  user?: string;
6069
6079
  }
@@ -6402,8 +6412,8 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6402
6412
  */
6403
6413
  usePreliminaryContext?: boolean;
6404
6414
  /**
6405
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
6406
- * the binding.
6415
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
6416
+ * originating from the binding.
6407
6417
  */
6408
6418
  batchGroupId?: string;
6409
6419
  }
@@ -6489,14 +6499,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6489
6499
  */
6490
6500
  usePreliminaryContext?: boolean;
6491
6501
  /**
6492
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
6493
- * the binding.
6502
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
6503
+ * originating from the binding.
6494
6504
  */
6495
6505
  batchGroupId?: string;
6496
6506
  /**
6497
- * Deprecated since 1.102.0, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated; the threshold
6498
- * that defines how many entries should be fetched at least by the binding if `operationMode` is set to
6499
- * `Auto`.
6507
+ * **Deprecated as of version 1.102.0**, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated;
6508
+ * the threshold that defines how many entries should be fetched at least by the binding if `operationMode`
6509
+ * is set to `Auto`.
6500
6510
  */
6501
6511
  threshold?: int;
6502
6512
  }
@@ -6555,27 +6565,22 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6555
6565
  * of levels, with only a single initial OData request.
6556
6566
  *
6557
6567
  * For services without the `hierarchy-node-descendant-count-for` annotation, the `numberOfExpandedLevels`
6558
- * property is not supported and deprecated.
6568
+ * property is not supported and deprecated since 1.44.5.
6559
6569
  *
6560
- * Operation Modes: For a full definition and explanation of all OData binding operation modes, see {@link sap.ui.model.odata.OperationMode}.
6570
+ * The OData service must always return node collections which are sufficient to create a valid hierarchy
6571
+ * on the client. This means that for each node in the response all parent nodes up to the hierarchy root
6572
+ * must also be contained in the response. Note that this rule applies independent of any filters set for
6573
+ * the binding.
6561
6574
  *
6562
- * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with filters of type {@link sap.ui.model.FilterType.Application}.
6563
- * Be aware that this applies only to filters which do not prevent the creation of a hierarchy. So filtering
6564
- * on a property (e.g. a "Customer") is fine, as long as the application ensures that the responses from
6565
- * the back end are sufficient to create a valid hierarchy on the client. Subsequent paging requests for
6566
- * sibling and child nodes must also return responses, since the filters are sent with every request. Using
6567
- * control-defined filters (see {@link sap.ui.model.FilterType.Control}) via the {@link #filter} function
6568
- * is not supported for the operation mode `Server`.
6575
+ * You must not define filters on tree annotation properties for this binding as this interferes with hierarchy
6576
+ * filters defined by the binding itself.
6569
6577
  *
6570
- * OperationMode.Client and OperationMode.Auto: The ODataTreeBinding supports control-defined filters only
6571
- * in operation modes `Client` and `Auto`. With these operation modes, the filters and sorters are applied
6572
- * on the client, like for the {@link sap.ui.model.odata.v2.ODataListBinding}.
6578
+ * Notes On Operation Modes: For a full definition and explanation of all OData binding operation modes,
6579
+ * see {@link sap.ui.model.odata.OperationMode}.
6573
6580
  *
6574
6581
  * The operation modes `Client` and `Auto` are only supported for services which expose the hierarchy annotations
6575
- * mentioned above, but do **not** expose the `hierarchy-node-descendant-count-for` annotation. Services
6576
- * with hierarchy annotations including the `hierarchy-node-descendant-count-for` annotation, do **not**
6577
- * support the operation modes `Client` and `Auto`. **Note:** {@link sap.ui.model.odata.OperationMode.Auto }
6578
- * is deprecated since 1.102.0.
6582
+ * mentioned above, but do **not** expose the `hierarchy-node-descendant-count-for` annotation. **Note:**
6583
+ * {@link sap.ui.model.odata.OperationMode.Auto} is deprecated since 1.102.0.
6579
6584
  *
6580
6585
  * **Note:** OData tree bindings do neither support {@link sap.ui.model.Binding#suspend suspend} nor {@link sap.ui.model.Binding#resume resume}.
6581
6586
  * See:
@@ -6641,7 +6646,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6641
6646
  };
6642
6647
  /**
6643
6648
  * The number of levels that are auto-expanded initially. Setting this property might lead to multiple back-end
6644
- * requests. The auto-expand feature is **deprecated for services without the `hierarchy-node-descendant-count-for`
6649
+ * requests. The auto-expand feature is **deprecated as of Version 1.44.5 for services without the `hierarchy-node-descendant-count-for`
6645
6650
  * annotation**
6646
6651
  */
6647
6652
  numberOfExpandedLevels?: number;
@@ -6657,7 +6662,6 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6657
6662
  * The operation mode for this binding; defaults to the model's default operation mode if not specified.
6658
6663
  * {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is only supported for services which
6659
6664
  * expose the hierarchy annotations, yet do **NOT** expose the `hierarchy-node-descendant-count-for` annotation.
6660
- * **Note:** {@link sap.ui.model.odata.OperationMode.Auto} is deprecated since 1.102.0.
6661
6665
  */
6662
6666
  operationMode?: OperationMode | keyof typeof OperationMode;
6663
6667
  /**
@@ -6667,13 +6671,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6667
6671
  */
6668
6672
  threshold?: number;
6669
6673
  /**
6670
- * Deprecated since 1.102.0, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated; whether `$filter`
6671
- * statements should be used for the `$count` / `$inlinecount` requests and for the data request if the
6672
- * operation mode is {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto}. Use this feature
6673
- * only if your back end supports pre-filtering the tree and is capable of responding with a complete tree
6674
- * hierarchy, including all inner nodes. To construct the hierarchy on the client, it is mandatory that
6675
- * all filter matches include their complete parent chain up to the root level. If {@link sap.ui.model.odata.OperationMode.Client OperationMode.Client }
6676
- * is used, the complete collection without filters is requested; filters are applied on the client side.
6674
+ * Whether `$filter` statements should be used for the `$count` / `$inlinecount` requests and for the data
6675
+ * request if the operation mode is {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} or
6676
+ * {@link sap.ui.model.odata.OperationMode.Client OperationMode.Client}
6677
6677
  */
6678
6678
  useServersideApplicationFilters?: boolean;
6679
6679
  /**
@@ -6698,16 +6698,16 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6698
6698
  */
6699
6699
  usePreliminaryContext?: boolean;
6700
6700
  /**
6701
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
6702
- * this binding
6701
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
6702
+ * originating from this binding
6703
6703
  */
6704
6704
  batchGroupId?: string;
6705
6705
  /**
6706
6706
  * A map describing the navigation properties between entity sets, which is used for constructing and paging
6707
6707
  * the tree. Keys in this object are entity names, whereas the values name the navigation properties.
6708
6708
  *
6709
- * **Deprecated: since 1.44** The use of navigation properties to build up the hierarchy structure is deprecated.
6710
- * It is recommended to use the hierarchy annotations mentioned above instead.
6709
+ * **Deprecated as of version 1.44** The use of navigation properties to build up the hierarchy structure
6710
+ * is deprecated. It is recommended to use the hierarchy annotations mentioned above instead.
6711
6711
  */
6712
6712
  navigation?: object;
6713
6713
  },
@@ -6827,7 +6827,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6827
6827
  */
6828
6828
  urlParameters?: Record<string, any>;
6829
6829
  /**
6830
- * **Deprecated - use `groupId` instead**
6830
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
6831
6831
  */
6832
6832
  batchGroupId?: string;
6833
6833
  }
@@ -6890,7 +6890,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
6890
6890
  */
6891
6891
  headers?: Record<string, string>;
6892
6892
  /**
6893
- * Deprecated - use `groupId` instead
6893
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
6894
6894
  */
6895
6895
  batchGroupId?: string;
6896
6896
  /**
@@ -7030,7 +7030,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
7030
7030
  */
7031
7031
  mParameters: {
7032
7032
  /**
7033
- * Deprecated - use `groupId` instead
7033
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
7034
7034
  */
7035
7035
  batchGroupId?: string;
7036
7036
  /**
@@ -7657,9 +7657,9 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
7657
7657
  */
7658
7658
  oContext?: object,
7659
7659
  /**
7660
- * Deprecated, use {@link #getObject} function with 'select' and 'expand' parameters instead. Whether entities
7661
- * for navigation properties of this property which have been read via `$expand` are part of the return
7662
- * value.
7660
+ * **Deprecated as of version 1.41.0**, use {@link #getObject} function with 'select' and 'expand' parameters
7661
+ * instead. Whether entities for navigation properties of this property which have been read via `$expand`
7662
+ * are part of the return value.
7663
7663
  */
7664
7664
  bIncludeExpandEntries?: boolean
7665
7665
  ): any;
@@ -7895,7 +7895,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
7895
7895
  */
7896
7896
  error?: Function;
7897
7897
  /**
7898
- * Deprecated - use `groupId` instead
7898
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
7899
7899
  */
7900
7900
  batchGroupId?: string;
7901
7901
  /**
@@ -8008,7 +8008,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
8008
8008
  */
8009
8009
  headers?: Record<string, string>;
8010
8010
  /**
8011
- * Deprecated - use `groupId` instead
8011
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
8012
8012
  */
8013
8013
  batchGroupId?: string;
8014
8014
  /**
@@ -8297,13 +8297,14 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
8297
8297
  */
8298
8298
  error?: Function;
8299
8299
  /**
8300
- * **Deprecated**, use `groupId` instead
8300
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
8301
8301
  */
8302
8302
  batchGroupId?: string;
8303
8303
  /**
8304
- * **Deprecated** since 1.38.0; use the `defaultUpdateMethod` constructor parameter instead. If unset, the
8305
- * update method is determined from the `defaultUpdateMethod` constructor parameter. If `true`, `sap.ui.model.odata.UpdateMethod.MERGE`
8306
- * is used for update operations; if set to `false`, `sap.ui.model.odata.UpdateMethod.PUT` is used.
8304
+ * **Deprecated as of version 1.38.0**, use the `defaultUpdateMethod` constructor parameter instead. If
8305
+ * unset, the update method is determined from the `defaultUpdateMethod` constructor parameter. If `true`,
8306
+ * `sap.ui.model.odata.UpdateMethod.MERGE` is used for update operations; if set to `false`, `sap.ui.model.odata.UpdateMethod.PUT`
8307
+ * is used.
8307
8308
  */
8308
8309
  merge?: boolean;
8309
8310
  }
@@ -8362,7 +8363,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" {
8362
8363
  */
8363
8364
  headers?: Record<string, string>;
8364
8365
  /**
8365
- * Deprecated - use `groupId` instead
8366
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
8366
8367
  */
8367
8368
  batchGroupId?: string;
8368
8369
  /**
@@ -10213,8 +10214,6 @@ declare module "sap/ui/util/Mobile" {
10213
10214
  * work in case there is already a meta tag with name 'viewport'.
10214
10215
  * - statusBar: the iOS status bar color, "default", "black" or "black-translucent" (default: "default")
10215
10216
  *
10216
- * - hideBrowser: whether the browser UI should be hidden as far as possible to make the app feel more
10217
- * native (default: true)
10218
10217
  * - preventScroll: whether native scrolling should be disabled in order to prevent the "rubber-band"
10219
10218
  * effect where the whole window is moved (default: true)
10220
10219
  * - preventPhoneNumberDetection: whether Safari Mobile should be prevented from transforming any numbers
@@ -10222,8 +10221,6 @@ declare module "sap/ui/util/Mobile" {
10222
10221
  * break controls because Safari actually changes the DOM. This only affects all page content which is created
10223
10222
  * after init() is called and only in case there is not already a meta tag with name 'format-detection'.
10224
10223
  *
10225
- * - rootId: the ID of the root element that should be made fullscreen; only used when hideBrowser is
10226
- * set (default: the document.body)
10227
10224
  * - useFullScreenHeight: a boolean that defines whether the height of the html root element should be
10228
10225
  * set to 100%, which is required for other elements to cover the full height (default: true) homeIcon:
10229
10226
  * deprecated since 1.12, use sap/ui/util/Mobile.setIcons instead.
@@ -10241,10 +10238,6 @@ declare module "sap/ui/util/Mobile" {
10241
10238
  * the iOS status bar color, "default", "black" or "black-translucent"
10242
10239
  */
10243
10240
  statusBar?: string;
10244
- /**
10245
- * whether the browser UI should be hidden as far as possible to make the app feel more native
10246
- */
10247
- hideBrowser?: boolean;
10248
10241
  /**
10249
10242
  * whether native scrolling should be disabled in order to prevent the "rubber-band" effect where the whole
10250
10243
  * window is moved
@@ -10255,11 +10248,6 @@ declare module "sap/ui/util/Mobile" {
10255
10248
  * into clickable links
10256
10249
  */
10257
10250
  preventPhoneNumberDetection?: boolean;
10258
- /**
10259
- * the ID of the root element that should be made fullscreen; only used when hideBrowser is set. If not
10260
- * set, the body is used
10261
- */
10262
- rootId?: string;
10263
10251
  /**
10264
10252
  * whether the height of the html root element should be set to 100%, which is required for other elements
10265
10253
  * to cover the full height
@@ -43258,7 +43246,23 @@ declare module "sap/ui/core/routing/Router" {
43258
43246
 
43259
43247
  export default class Router extends EventProvider {
43260
43248
  /**
43261
- * Instantiates a router
43249
+ * A Router is responsible for managing navigation within an application by interpreting and responding
43250
+ * to changes in the URL hash. It enables applications to define routes, map them to Views/Components, and
43251
+ * control their placement and transitions — all in a structured and declarative way.
43252
+ *
43253
+ * A router:
43254
+ * - Listens to hash changes and matches them to configured route patterns
43255
+ * - Instantiates Views/Components dynamically when a route is matched and caches them for better performance
43256
+ *
43257
+ * - Places Views/Components into UI containers based on the defined targets and aggregations
43258
+ * - Maintains the browser history and consistent back/forward navigation behavior
43259
+ * - Fires events such as `routeMatched` and `routePatternMatched`, allowing developers to run logic when
43260
+ * routes change
43261
+ * - Handles unmatched routes through a special bypassed configuration for displaying "Not Found" View(s)
43262
+ * or fallbacks
43263
+ *
43264
+ * It can be used directly or via a {@link sap.ui.core.UIComponent UIComponent}'s metadata (manifest.json)
43265
+ * to create scalable, maintainable, and testable navigation structures across complex applications.
43262
43266
  */
43263
43267
  constructor(
43264
43268
  /**
@@ -51866,6 +51870,18 @@ declare module "sap/ui/core/webc/WebComponent" {
51866
51870
  * @returns Metadata object describing this class
51867
51871
  */
51868
51872
  static getMetadata(): WebComponentMetadata;
51873
+ /**
51874
+ * Sets the Web Components busy state
51875
+ *
51876
+ *
51877
+ * @returns `this` to allow method chaining
51878
+ */
51879
+ setBusy(
51880
+ /**
51881
+ * The new busy state to be set
51882
+ */
51883
+ bBusy: boolean
51884
+ ): this;
51869
51885
  }
51870
51886
  /**
51871
51887
  * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
@@ -51891,6 +51907,11 @@ declare module "sap/ui/core/webc/WebComponent" {
51891
51907
  * for more details.
51892
51908
  */
51893
51909
  associations?: Record<string, string | MetadataOptions.Association>;
51910
+ /**
51911
+ * An object literal whose properties each define a new event of the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Event Event }
51912
+ * for more details.
51913
+ */
51914
+ events?: Record<string, string | MetadataOptions.Event>;
51894
51915
  /**
51895
51916
  * Proxied public getters of the Web Component which are directly accessible on the wrapper Control.
51896
51917
  */
@@ -51901,15 +51922,11 @@ declare module "sap/ui/core/webc/WebComponent" {
51901
51922
  methods?: string[];
51902
51923
  };
51903
51924
 
51904
- /**
51905
- * HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
51906
- */
51907
51925
  export type MetadataOptionsAssociationMapping =
51908
51926
  MetadataOptions.Association.Mapping;
51909
51927
 
51910
- /**
51911
- * HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
51912
- */
51928
+ export type MetadataOptionsEventMapping = MetadataOptions.Event.Mapping;
51929
+
51913
51930
  export type MetadataOptionsPropertyMapping = MetadataOptions.Property.Mapping;
51914
51931
 
51915
51932
  /**
@@ -51940,6 +51957,18 @@ declare module "sap/ui/core/webc/WebComponent" {
51940
51957
  };
51941
51958
  }
51942
51959
 
51960
+ namespace Event {
51961
+ /**
51962
+ * An object literal describing the mapping of an event of a class derived from `sap.ui.core.webc.WebComponent`.
51963
+ */
51964
+ type Mapping = {
51965
+ /**
51966
+ * Defines the target of the mapping of the event to which name it will be mapped to.
51967
+ */
51968
+ to?: string;
51969
+ };
51970
+ }
51971
+
51943
51972
  namespace Property {
51944
51973
  /**
51945
51974
  * An object literal describing the mapping of a property of a class derived from `sap.ui.core.webc.WebComponent`.
@@ -51988,6 +52017,17 @@ declare module "sap/ui/core/webc/WebComponent" {
51988
52017
  mapping?: "property" | MetadataOptionsAssociationMapping;
51989
52018
  };
51990
52019
 
52020
+ /**
52021
+ * An object literal describing an event of a class derived from `sap.ui.core.webc.WebComponent`. See {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
52022
+ * for details on its usage.
52023
+ */
52024
+ type Event = MetadataOptions2.Event & {
52025
+ /**
52026
+ * Defines the mapping of the event.
52027
+ */
52028
+ mapping?: MetadataOptionsEventMapping;
52029
+ };
52030
+
51991
52031
  /**
51992
52032
  * An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
51993
52033
  * {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
@@ -59718,6 +59758,260 @@ declare module "sap/ui/model/json/JSONModel" {
59718
59758
  }
59719
59759
  }
59720
59760
 
59761
+ declare module "sap/ui/model/json/TypedJSONModel" {
59762
+ import JSONModel from "sap/ui/model/json/JSONModel";
59763
+ import TypedJSONContext from "sap/ui/model/json/TypedJSONContext";
59764
+ import Context from "sap/ui/model/Context";
59765
+
59766
+ /**
59767
+ * TypedJSONModel is a subclass of JSONModel that provides type-safe access to the model data. It is only available when using UI5 with TypeScript.
59768
+ *
59769
+ * @since 1.140.0
59770
+ */
59771
+ export default class TypedJSONModel<Data extends object> extends JSONModel {
59772
+ constructor(oData?: Data, bObserve?: boolean);
59773
+ createBindingContext<Path extends AbsoluteBindingPath<Data>>(
59774
+ sPath: Path,
59775
+ oContext?: Context,
59776
+ mParameters?: object,
59777
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
59778
+ fnCallBack?: Function,
59779
+ bReload?: boolean
59780
+ ): TypedJSONContext<Data, Path>;
59781
+ getData(): Data;
59782
+ getProperty<Path extends AbsoluteBindingPath<Data>>(
59783
+ sPath: Path
59784
+ ): PropertyByAbsoluteBindingPath<Data, Path>;
59785
+ getProperty<
59786
+ Path extends RelativeBindingPath<Data, Root>,
59787
+ Root extends AbsoluteBindingPath<Data>,
59788
+ >(
59789
+ sPath: Path,
59790
+ oContext: TypedJSONContext<Data, Root>
59791
+ ): PropertyByRelativeBindingPath<Data, Root, Path>;
59792
+
59793
+ setData(oData: Data, bMerge?: boolean): void;
59794
+
59795
+ // setProperty with AbsoluteBindingPath (context === undefined),
59796
+ // PLEASE NOTE: the parameter is still necessary so
59797
+ // the bAsyncUpdate parameter can also be used with absolute paths.
59798
+ setProperty<Path extends AbsoluteBindingPath<Data>>(
59799
+ sPath: Path,
59800
+ oValue: PropertyByAbsoluteBindingPath<Data, Path>,
59801
+ oContext?: undefined,
59802
+ bAsyncUpdate?: boolean
59803
+ ): boolean;
59804
+ setProperty<
59805
+ Path extends RelativeBindingPath<Data, Root>,
59806
+ Root extends AbsoluteBindingPath<Data>,
59807
+ >(
59808
+ sPath: Path,
59809
+ oValue: PropertyByRelativeBindingPath<Data, Root, Path>,
59810
+ oContext: TypedJSONContext<Data, Root>,
59811
+ bAsyncUpdate?: boolean
59812
+ ): boolean;
59813
+ }
59814
+
59815
+ /**
59816
+ * Valid absolute binding in a JSONModel with the underlying type `Type`.
59817
+ * Counterpart to {@link PropertyByAbsoluteBindingPath}
59818
+ * @example
59819
+ * type Person = { name: string, id: number };
59820
+ * type PathInPerson = PathInJSONModel<Person>; // "/name" | "/id"
59821
+ * let path: PathInPerson = "/name"; // ok
59822
+ * path = "/firstName"; // error
59823
+ */
59824
+ export type AbsoluteBindingPath<Type> =
59825
+ Type extends Array<unknown>
59826
+ ? // if Type is an array:
59827
+ | `/${number}` // /0 -> first element of array
59828
+ | `/${number}${AbsoluteBindingPath<Type[number]>}` // /0/{NestedPath}
59829
+ : // if Type is not an array:
59830
+ Type extends object
59831
+ ?
59832
+ | {
59833
+ [Key in keyof Type]: Type[Key] extends Array<unknown>
59834
+ ? // Type[Key] is an array:
59835
+ | `/${string & Key}/${number}` // items/0 -> elem of array
59836
+ // path can end there or:
59837
+ | `/${string & Key}/${number}${AbsoluteBindingPath<Type[Key][number]>}` // items/0/{NestedPath}
59838
+ : // Type[Key] is NOT an array:
59839
+ `/${string & Key}${AbsoluteBindingPath<Type[Key]>}`;
59840
+ }[keyof Type]
59841
+ | `/${string & PropertiesOf<Type>}` // /items/0/id -> last part of path
59842
+ : // if T is not of type object:
59843
+ never;
59844
+
59845
+ /**
59846
+ * Valid relative binding path in a JSONModel.
59847
+ * The root of the path is defined by the given root string.
59848
+ *
59849
+ * @example
59850
+ * type PersonWrapper = { person: { name: string, id: number } };
59851
+ * type PathRelativeToPerson = RelativeBindingPath<PersonWrapper, "/person">; // "name" | "id"
59852
+ */
59853
+ export type RelativeBindingPath<
59854
+ Type,
59855
+ Root extends AbsoluteBindingPath<Type>,
59856
+ > =
59857
+ AbsoluteBindingPath<TypeAtPath<Type, Root>> extends `/${infer Rest}`
59858
+ ? Rest
59859
+ : never;
59860
+
59861
+ /**
59862
+ * The type of a property in a JSONModel identified by the given path.
59863
+ * Counterpart to {@link AbsoluteBindingPath}.
59864
+ * @example
59865
+ * type Person = { name: string, id: number };
59866
+ * type PersonName = PropertyInJSONModel<Person, "/name">; // string
59867
+ * const name: PersonName = "John"; // ok
59868
+ */
59869
+ export type PropertyByAbsoluteBindingPath<
59870
+ Type,
59871
+ Path extends string,
59872
+ > = Path extends `/${number}`
59873
+ ? Type extends Array<infer U>
59874
+ ? U
59875
+ : never
59876
+ : Path extends `/${number}${infer Rest}`
59877
+ ? Type extends Array<infer U>
59878
+ ? PropertyByAbsoluteBindingPath<U, Rest>
59879
+ : never
59880
+ : Path extends `/${infer Key}/${number}/${infer Rest}`
59881
+ ? Key extends keyof Type
59882
+ ? FromArrayWithSubPath<Type, Key, Rest>
59883
+ : never
59884
+ : Path extends `/${infer Key}/${number}`
59885
+ ? Key extends keyof Type
59886
+ ? FromArrayElement<Type, Key>
59887
+ : never
59888
+ : Path extends `/${infer Key}/${infer Rest}`
59889
+ ? Key extends keyof Type
59890
+ ? FromNestedProperty<Type, Key, Rest>
59891
+ : never
59892
+ : Path extends `/${infer Key}`
59893
+ ? Key extends keyof Type
59894
+ ? FromTopLevelProperty<Type, Key>
59895
+ : never
59896
+ : never;
59897
+
59898
+ /**
59899
+ * The type of a property in a JSONModel identified by the given relative path and root.
59900
+ * Counterpart to {@link RelativeBindingPath}.
59901
+ * @example
59902
+ * type PersonWrapper = { person: { name: string, id: number } };
59903
+ * type PersonName = PropertyByRelativeBindingPath<PersonWrapper, "/person", "name">;
59904
+ * const name: PersonName = "John"; // ok
59905
+ */
59906
+ export type PropertyByRelativeBindingPath<
59907
+ Type,
59908
+ Root extends string,
59909
+ RelativePath extends string,
59910
+ > = PropertyByAbsoluteBindingPath<Type, `${Root}/${RelativePath}`>;
59911
+
59912
+ /***********************************************************************************************************************
59913
+ * Helper types to split the types above into separate parts
59914
+ * to make it easier to read and understand.
59915
+ /**********************************************************************************************************************/
59916
+
59917
+ /**
59918
+ * Helper type to handle paths that point to an array with a subpath.
59919
+ * @example const path = "/orders/0/items"
59920
+ */
59921
+ type FromArrayWithSubPath<Type, Key extends keyof Type, Rest extends string> =
59922
+ Type[Key] extends Array<infer U>
59923
+ ? PropertyByAbsoluteBindingPath<U, `/${Rest}`>
59924
+ : never;
59925
+
59926
+ /**
59927
+ * Helper type to handle paths that point to an array element.
59928
+ * @example const path = "/orders/0"
59929
+ */
59930
+ type FromArrayElement<Type, Key extends keyof Type> =
59931
+ Type[Key] extends Array<infer U> ? U : never;
59932
+
59933
+ /**
59934
+ * Helper type to handle paths that point to a nested property.
59935
+ * @example const path = "/customer/address/street"
59936
+ */
59937
+ type FromNestedProperty<
59938
+ Type,
59939
+ Key extends keyof Type,
59940
+ Rest extends string,
59941
+ > = PropertyByAbsoluteBindingPath<Type[Key], `/${Rest}`>;
59942
+
59943
+ /**
59944
+ * Helper type to handle paths that point to a top-level property.
59945
+ * @example const path = "/customer"
59946
+ */
59947
+ type FromTopLevelProperty<Type, Key extends keyof Type> = Type[Key];
59948
+
59949
+ /**
59950
+ * Helper type to navigate along a nested path.
59951
+ * Navigates from the root type along the path to determine the sub-type.
59952
+ */
59953
+ type TypeAtPath<
59954
+ Type,
59955
+ Path extends string,
59956
+ > = Path extends `/${infer Key}/${infer Rest}`
59957
+ ? Key extends keyof Type
59958
+ ? TypeAtPath<Type[Key], `/${Rest}`>
59959
+ : never
59960
+ : Path extends `/${infer Key}`
59961
+ ? Key extends keyof Type
59962
+ ? Type[Key]
59963
+ : never
59964
+ : never;
59965
+
59966
+ /**
59967
+ * Helper type to extract the names of the properties of a given type.
59968
+ * Excludes properties that are of the type `Function` or `symbol`.
59969
+ * @example
59970
+ * type Person = { name: string, id: number };
59971
+ * type PersonProperties = PropertiesOf<Person>; // "name" | "id"
59972
+ * let property: PersonProperties = "name"; // ok
59973
+ * property = "firstName"; // error
59974
+ */
59975
+ type PropertiesOf<Type> = {
59976
+ // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
59977
+ [Key in keyof Type]: Type[Key] extends Function
59978
+ ? never
59979
+ : Type[Key] extends symbol
59980
+ ? never
59981
+ : Key;
59982
+ }[keyof Type];
59983
+
59984
+ export {}; // this prevents the non-exported types like PropertiesOf from being visible for applications
59985
+ }
59986
+
59987
+ declare module "sap/ui/model/json/TypedJSONContext" {
59988
+ import Context from "sap/ui/model/Context";
59989
+ import TypedJSONModel from "sap/ui/model/json/TypedJSONModel";
59990
+ import {
59991
+ AbsoluteBindingPath,
59992
+ RelativeBindingPath,
59993
+ PropertyByRelativeBindingPath,
59994
+ } from "sap/ui/model/json/TypedJSONModel";
59995
+
59996
+ /**
59997
+ * TypedJSONContext is a subclass of Context that provides type-safe access to the model data. It is only available when using UI5 with TypeScript.
59998
+ *
59999
+ * @since 1.140.0
60000
+ */
60001
+ export default class TypedJSONContext<
60002
+ Data extends object,
60003
+ Root extends AbsoluteBindingPath<Data>,
60004
+ > extends Context {
60005
+ constructor(oModel: TypedJSONModel<Data>, sPath: Root);
60006
+
60007
+ getModel(): TypedJSONModel<Data>;
60008
+
60009
+ getProperty<P extends RelativeBindingPath<Data, Root>>(
60010
+ sPath: P extends RelativeBindingPath<Data, Root> ? P : never
60011
+ ): PropertyByRelativeBindingPath<Data, Root, P>;
60012
+ }
60013
+ }
60014
+
59721
60015
  declare module "sap/ui/model/json/JSONPropertyBinding" {
59722
60016
  import ClientPropertyBinding from "sap/ui/model/ClientPropertyBinding";
59723
60017
 
@@ -61371,7 +61665,7 @@ declare module "sap/ui/model/Model" {
61371
61665
  async?: boolean;
61372
61666
 
61373
61667
  /**
61374
- * Additional information for the request (if available) **deprecated**
61668
+ * **Deprecated as of version 1.38.0.**, additional information for the request (if available)
61375
61669
  */
61376
61670
  info?: string;
61377
61671
 
@@ -61442,7 +61736,7 @@ declare module "sap/ui/model/Model" {
61442
61736
  async?: boolean;
61443
61737
 
61444
61738
  /**
61445
- * Additional information for the request (if available) **deprecated**
61739
+ * **Deprecated as of version 1.38.0.**, additional information for the request (if available)
61446
61740
  */
61447
61741
  info?: string;
61448
61742
 
@@ -62734,12 +63028,13 @@ declare module "sap/ui/model/odata/ODataMetadata" {
62734
63028
  */
62735
63029
  async?: boolean;
62736
63030
  /**
62737
- * **Deprecated** for security reasons. Use strong server side authentication instead. UserID for the service.
63031
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
63032
+ * UserID for the service.
62738
63033
  */
62739
63034
  user?: string;
62740
63035
  /**
62741
- * **Deprecated** for security reasons. Use strong server side authentication instead. Password for the
62742
- * service.
63036
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
63037
+ * Password for the service.
62743
63038
  */
62744
63039
  password?: string;
62745
63040
  /**
@@ -70067,8 +70362,8 @@ declare module "sap/ui/model/odata/v2/ODataContextBinding" {
70067
70362
  */
70068
70363
  usePreliminaryContext?: boolean;
70069
70364
  /**
70070
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
70071
- * the binding.
70365
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
70366
+ * originating from the binding.
70072
70367
  */
70073
70368
  batchGroupId?: string;
70074
70369
  }
@@ -70245,8 +70540,8 @@ declare module "sap/ui/model/odata/v2/ODataListBinding" {
70245
70540
  */
70246
70541
  usePreliminaryContext?: boolean;
70247
70542
  /**
70248
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
70249
- * the binding.
70543
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
70544
+ * originating from the binding.
70250
70545
  */
70251
70546
  batchGroupId?: string;
70252
70547
  /**
@@ -74948,6 +75243,10 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" {
74948
75243
  * way, "/acme.DefaultContainer/EMPLOYEES" addresses the "EMPLOYEES" child of the schema child named "acme.DefaultContainer".
74949
75244
  * This also works indirectly ("/$EntityContainer/EMPLOYEES") and implicitly ("/EMPLOYEES", see below).
74950
75245
  *
75246
+ * Since 1.140.0, the special name "$count" can be used as the last segment instead of an OData simple identifier.
75247
+ * For an entity set or a collection-valued (structural or navigation) property, it is treated as a property
75248
+ * of type "Edm.Int64". Otherwise, it is invalid.
75249
+ *
74951
75250
  * A segment which represents an OData simple identifier (or the special names "$ReturnType", since 1.71.0,
74952
75251
  * or "$Parameter", since 1.73.0) needs special preparations. The same applies to the empty segment after
74953
75252
  * a trailing slash. If the current object has a "$Action", "$Function" or "$Type" property, it
@@ -79746,8 +80045,14 @@ declare module "sap/ui/model/type/Unit" {
79746
80045
  */
79747
80046
  oFormatOptions?: {
79748
80047
  /**
79749
- * The number of decimals to be used for formatting the number part of the unit; defaults to **3** if none
79750
- * of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` is given
80048
+ * The number of decimals to be used for formatting the numerical value of the unit composite type; if none
80049
+ * of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` are given, the following
80050
+ * defaults apply:
80051
+ * - **0** if the numerical value is of an OData integer type, i.e. {@link sap.ui.model.odata.type.Int }
80052
+ * or {@link sap.ui.model.odata.type.Int64}
80053
+ * - the **scale constraint of the numerical value's type** if this type is {@link sap.ui.model.odata.type.Decimal }
80054
+ * and the scale is not "variable"
80055
+ * - **3** otherwise
79751
80056
  */
79752
80057
  decimals?: object;
79753
80058
  /**