@sapui5/ts-types 1.108.1 → 1.109.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 (64) 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 -3
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +1 -1
  7. package/types/sap.f.d.ts +285 -25
  8. package/types/sap.fe.common.d.ts +1 -1
  9. package/types/sap.fe.core.d.ts +57 -20
  10. package/types/sap.fe.macros.d.ts +23 -3
  11. package/types/sap.fe.navigation.d.ts +888 -1
  12. package/types/sap.fe.templates.d.ts +3 -3
  13. package/types/sap.fe.test.d.ts +33 -17
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +51 -1
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +1 -1
  18. package/types/sap.m.d.ts +152 -54
  19. package/types/sap.makit.d.ts +1 -1
  20. package/types/sap.me.d.ts +1 -1
  21. package/types/sap.ndc.d.ts +83 -29
  22. package/types/sap.ovp.d.ts +1 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.df.d.ts +117 -675
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +3 -3
  27. package/types/sap.suite.ui.generic.template.d.ts +499 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +1 -1
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +97 -13
  33. package/types/sap.ui.core.d.ts +240 -260
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +1 -1
  36. package/types/sap.ui.fl.d.ts +92 -11
  37. package/types/sap.ui.generic.app.d.ts +1 -1
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +63 -5
  40. package/types/sap.ui.layout.d.ts +1 -1
  41. package/types/sap.ui.mdc.d.ts +3 -1
  42. package/types/sap.ui.richtexteditor.d.ts +1 -1
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +380 -80
  46. package/types/sap.ui.table.d.ts +1 -3
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +81 -3
  49. package/types/sap.ui.ux3.d.ts +1 -1
  50. package/types/sap.ui.vbm.d.ts +39 -36
  51. package/types/sap.ui.vk.d.ts +512 -248
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +1 -1
  55. package/types/sap.ui.webc.main.d.ts +1 -1
  56. package/types/sap.uiext.inbox.d.ts +5 -5
  57. package/types/sap.ushell.d.ts +1 -1
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +1 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
@@ -264,7 +264,7 @@ interface JQuery<TElement = HTMLElement> extends Iterable<TElement> {
264
264
  ): jQuery;
265
265
  }
266
266
 
267
- // For Library Version: 1.108.0
267
+ // For Library Version: 1.109.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -415,10 +415,24 @@ declare module "sap/base/i18n/ResourceBundle" {
415
415
  * The text is searched in this resource bundle according to the fallback chain described in {@link module:sap/base/i18n/ResourceBundle}.
416
416
  * If no text could be found, the key itself is used as text.
417
417
  *
418
- * If the second parameter `aArgs` is given, then any placeholder of the form "{n}" (with n
419
- * being an integer) is replaced by the corresponding value from `aArgs` with index n. Note: This
420
- * replacement is applied to the key if no text could be found. For more details on the replacement mechanism
421
- * refer to {@link module:sap/base/strings/formatMessage}.
418
+ * Placeholders:
419
+ *
420
+ * A text can contain placeholders that will be replaced with concrete values when `getText` is called.
421
+ * The replacement is triggered by the `aArgs` parameter.
422
+ *
423
+ * Whenever this parameter is given, then the text and the arguments are additionally run through the {@link
424
+ * module:sap/base/strings/formatMessage} API to replace placeholders in the text with the corresponding
425
+ * values from the arguments array. The resulting string is returned by `getText`.
426
+ *
427
+ * As the `formatMessage` API imposes some requirements on the input text (regarding curly braces and single
428
+ * apostrophes), text authors need to be aware of the specifics of the `formatMessage` API. Callers of `getText`,
429
+ * on the other side, should only supply `aArgs` when the text has been created with the `formatMessage`
430
+ * API in mind. Otherwise, single apostrophes in the text might be removed unintentionally.
431
+ *
432
+ * When `getText` is called without `aArgs`, the `formatMessage` API is not applied and the transformation
433
+ * reg. placeholders and apostrophes does not happen.
434
+ *
435
+ * For more details on the replacement mechanism refer to {@link module:sap/base/strings/formatMessage}.
422
436
  *
423
437
  * @returns The value belonging to the key, if found; otherwise the key itself or `undefined` depending
424
438
  * on `bIgnoreKeyFallback`.
@@ -599,9 +613,10 @@ declare module "sap/base/Log" {
599
613
  */
600
614
  sMessage: string,
601
615
  /**
602
- * Details about the message, might be omitted
616
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged with
617
+ * the stack.
603
618
  */
604
- sDetails?: string,
619
+ vDetails?: string | Error,
605
620
  /**
606
621
  * Name of the component that produced the log entry
607
622
  */
@@ -623,9 +638,10 @@ declare module "sap/base/Log" {
623
638
  */
624
639
  sMessage: string,
625
640
  /**
626
- * Details about the message, might be omitted
641
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged together
642
+ * with its stacktrace.
627
643
  */
628
- sDetails?: string,
644
+ vDetails?: string | Error,
629
645
  /**
630
646
  * Name of the component that produced the log entry
631
647
  */
@@ -647,9 +663,10 @@ declare module "sap/base/Log" {
647
663
  */
648
664
  sMessage: string,
649
665
  /**
650
- * Details about the message, might be omitted
666
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged together
667
+ * with its stacktrace.
651
668
  */
652
- sDetails?: string,
669
+ vDetails?: string | Error,
653
670
  /**
654
671
  * Name of the component that produced the log entry
655
672
  */
@@ -717,9 +734,10 @@ declare module "sap/base/Log" {
717
734
  */
718
735
  sMessage: string,
719
736
  /**
720
- * Details about the message, might be omitted
737
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged with
738
+ * the stack.
721
739
  */
722
- sDetails?: string,
740
+ vDetails?: string | Error,
723
741
  /**
724
742
  * Name of the component that produced the log entry
725
743
  */
@@ -760,7 +778,7 @@ declare module "sap/base/Log" {
760
778
  oListener: object
761
779
  ): void;
762
780
  /**
763
- * Defines the maximum `sap.base.log.Level` of log entries that will be recorded. Log entries with a higher
781
+ * Defines the maximum `sap/base/Log.Level` of log entries that will be recorded. Log entries with a higher
764
782
  * (less important) log level will be omitted from the log. When a component name is given, the log level
765
783
  * will be configured for that component only, otherwise the log level for the default component of this
766
784
  * logger is set. For the global logger, the global default level is set.
@@ -787,9 +805,10 @@ declare module "sap/base/Log" {
787
805
  */
788
806
  sMessage: string,
789
807
  /**
790
- * Details about the message, might be omitted
808
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged with
809
+ * the stack.
791
810
  */
792
- sDetails?: string,
811
+ vDetails?: string | Error,
793
812
  /**
794
813
  * Name of the component that produced the log entry
795
814
  */
@@ -811,9 +830,10 @@ declare module "sap/base/Log" {
811
830
  */
812
831
  sMessage: string,
813
832
  /**
814
- * Details about the message, might be omitted
833
+ * Optional details about the message, might be omitted. Can be an Error object which will be logged together
834
+ * with its stacktrace.
815
835
  */
816
- sDetails?: string,
836
+ vDetails?: string | Error,
817
837
  /**
818
838
  * Name of the component that produced the log entry
819
839
  */
@@ -1577,7 +1597,8 @@ declare module "sap/base/util/extend" {
1577
1597
  declare module "sap/base/util/includes" {
1578
1598
  /**
1579
1599
  * @SINCE 1.58
1580
- * @deprecated (since 1.90) - Use the `Array.includes` or `String.includes` instead.
1600
+ * @deprecated (since 1.90) - Use the `Array.prototype.includes` or `String.prototype.includes` instead,
1601
+ * but note that `Array.prototype.includes` or `String.prototype.includes` fail when called on null values.
1581
1602
  *
1582
1603
  * Checks if value is included in collection.
1583
1604
  *
@@ -1995,10 +2016,12 @@ declare module "sap/base/util/UriParameters" {
1995
2016
  declare module "sap/base/util/values" {
1996
2017
  /**
1997
2018
  * @SINCE 1.58
1998
- * @deprecated (since 1.90) - Use the `Object.values` instead.
1999
2019
  *
2000
2020
  * Returns values from an object.
2001
2021
  *
2022
+ * **Note:**Whenever possible, please try to use the native function `Object.values` instead. Especially,
2023
+ * if you don't need to rely on handling null values as argument.
2024
+ *
2002
2025
  * @returns - array of object values, if object does not contain values, an empty array will be returned
2003
2026
  */
2004
2027
  export default function values(
@@ -3767,17 +3790,17 @@ declare module "sap/ui/util/Mobile" {
3767
3790
  * be removed. When at least one home icon is given, all existing home icons will be removed and new home
3768
3791
  * icon tags for all four resolutions will be created.
3769
3792
  *
3770
- * The home icons must be in PNG format and given in different sizes for iPad/iPhone with and without retina
3771
- * display. The favicon is used in the browser and for desktop shortcuts and should optimally be in ICO
3772
- * format: ICO files can contain different image sizes for different usage locations. E.g. a 16x16px version
3773
- * is used inside browsers.
3793
+ * The home icons must be in PNG format and given in different sizes for iPad/iPhone with low and high pixel
3794
+ * density display. The favicon is used in the browser and for desktop shortcuts and should optimally be
3795
+ * in ICO format: ICO files can contain different image sizes for different usage locations. E.g. a 16x16px
3796
+ * version is used inside browsers.
3774
3797
  *
3775
3798
  * All icons are given in an an object holding icon URLs and other settings. The properties of this object
3776
3799
  * are:
3777
- * - phone: a 60x60 pixel version for non-retina iPhones
3778
- * - tablet: a 76x76 pixel version for non-retina iPads
3779
- * - phone@2: a 120x120 pixel version for retina iPhones
3780
- * - tablet@2: a 152x152 pixel version for retina iPads
3800
+ * - phone: a 120x120 pixel version for iPhones with low pixel density
3801
+ * - tablet: a 152x152 pixel version for iPads with low pixel density
3802
+ * - phone@2: a 180x180 pixel version for iPhones with high pixel density
3803
+ * - tablet@2: a 167x167 pixel version for iPads with high pixel density
3781
3804
  * - precomposed: whether the home icons already have some glare effect (otherwise iOS will add it) (default:
3782
3805
  * false)
3783
3806
  * - favicon: the ICO file to be used inside the browser and for desktop shortcuts
@@ -3786,10 +3809,10 @@ declare module "sap/ui/util/Mobile" {
3786
3809
  * ```javascript
3787
3810
  *
3788
3811
  * {
3789
- * 'phone':'phone-icon_60x60.png',
3790
- * 'phone@2':'phone-retina_120x120.png',
3791
- * 'tablet':'tablet-icon_76x76.png',
3792
- * 'tablet@2':'tablet-retina_152x152.png',
3812
+ * 'phone':'phone-icon_120x120.png',
3813
+ * 'phone@2':'phone-retina_180x180.png',
3814
+ * 'tablet':'tablet-icon_152x152.png',
3815
+ * 'tablet@2':'tablet-retina_167x167.png',
3793
3816
  * 'precomposed':true,
3794
3817
  * 'favicon':'desktop.ico'
3795
3818
  * }
@@ -3835,27 +3858,34 @@ declare module "sap/ui/util/Storage" {
3835
3858
  * confidential information.
3836
3859
  *
3837
3860
  * Provides a unified interface and methods to store data on the client using the Web Storage API or a custom
3838
- * implementation. By default, data can be persisted inside localStorage or a sessionStorage.
3839
- *
3840
- * You can access the 'default' storage by using {@link module:sap/ui/util/Storage} methods static on the
3841
- * module export or by creating an own instance of Storage via the constructor.
3861
+ * implementation. By default, data can be persisted inside localStorage or sessionStorage.
3842
3862
  *
3843
3863
  * A typical intended usage of this API is the storage of a string representing the state of a control.
3844
3864
  * In this case, the data is stored in the browser session, and the methods to be used are {@link #put}
3845
3865
  * and {@link #get}. The method {@link #remove} can be used to delete the previously saved state.
3846
3866
  *
3847
- * For the sake of completeness, the method {@link #clear} is available. However, it should be called only
3848
- * in very particular situations, when a global erasing of data is required. If only keys with certain prefix
3849
- * should be deleted, the method {@link #removeAll} should be used.
3867
+ * The `Storage` class allows a simple scoping by prefixing the keys of all `put/get/remove` operations
3868
+ * with a fixed prefix given when constructing a storage instance. By choosing unique prefixes, different
3869
+ * instances can write/read/delete data to the same underlying storage implementation without interfering
3870
+ * with each other.
3871
+ *
3872
+ * For the sake of completeness, the method {@link #clear} is available. However, it does not honor the
3873
+ * scoping and therefore should only be called when a global erasing of data is required. If only keys with
3874
+ * certain prefix should be deleted, the method {@link #removeAll} should be used.
3875
+ *
3876
+ * Besides creating an own storage instance, callers can use the static methods of the `Storage` class to
3877
+ * access a default session storage instance. All calls will use the same scope (same prefix).
3850
3878
  */
3851
3879
  export default class Storage {
3852
3880
  constructor(
3853
3881
  /**
3854
- * The type this storage should be of or an Object implementing the typical Storage API for direct usage.
3882
+ * The type of native storage implementation that this `Storage` instance should use internally. Alternatively,
3883
+ * this can be a custom implementation of the {@link https://developer.mozilla.org/en-US/docs/Web/API/Storage
3884
+ * Storage Web API).
3855
3885
  */
3856
- pStorage?: (Type | keyof typeof Type) | Storage,
3886
+ vStorage?: (Type | keyof typeof Type) | Storage,
3857
3887
  /**
3858
- * The prefix to use in this storage.
3888
+ * The scope prefix to be used by this storage instance
3859
3889
  */
3860
3890
  sStorageKeyPrefix?: string
3861
3891
  );
@@ -3864,28 +3894,104 @@ declare module "sap/ui/util/Storage" {
3864
3894
  * Clears the whole storage (Independent of the current Storage instance!).
3865
3895
  *
3866
3896
  * **CAUTION** This method should be called only in very particular situations, when a global erasing of
3867
- * data is required. Given that the method deletes the data saved under any ID, it should not be called
3897
+ * data is required. Given that the method deletes the data saved under any key, it should not be called
3898
+ * when managing data for specific controls.
3899
+ *
3900
+ * @returns Whether clearing the storage was successful
3901
+ */
3902
+ static clear(): boolean;
3903
+ /**
3904
+ * Retrieves the value for the given key or `null` if the key does not exist in this storage.
3905
+ *
3906
+ * The returned value will be of a type that `JSON.parse` could return, too.
3907
+ *
3908
+ * @returns The key's value or `null` if the key does not exist in the storage.
3909
+ */
3910
+ static get(
3911
+ /**
3912
+ * Key to retrieve the value for; will be prefixed with the prefix given when constructing this `Storage`
3913
+ */
3914
+ sKey: string
3915
+ ): any;
3916
+ /**
3917
+ * Returns the type of this storage.
3918
+ *
3919
+ * @returns Type of this storage or "unknown" when the Storage was created with an unknown type or implementation
3920
+ */
3921
+ static getType(): (Type | keyof typeof Type) | string;
3922
+ /**
3923
+ * Returns whether the given storage is supported.
3924
+ *
3925
+ * @returns true if storage is supported, false otherwise (e.g. due to browser security settings)
3926
+ */
3927
+ static isSupported(): boolean;
3928
+ /**
3929
+ * Stores the given value under the given key in the storage or updates the value if the key already exists.
3930
+ *
3931
+ * This method supports the same types of values as `JSON.stringify`.
3932
+ *
3933
+ * @returns Whether the data was successfully stored
3934
+ */
3935
+ static put(
3936
+ /**
3937
+ * Key to store the given value under; will be prefixed with the prefix given when constructing this `Storage`
3938
+ */
3939
+ sKey: string,
3940
+ /**
3941
+ * Value to store/update under the given key
3942
+ */
3943
+ vValue: any
3944
+ ): boolean;
3945
+ /**
3946
+ * Removes the key and its value from storage, if the key exists.
3947
+ *
3948
+ * @returns Whether the deletion succeeded; if the key didn't exists, the method also reports a success
3949
+ */
3950
+ static remove(
3951
+ /**
3952
+ * Key to remove; will be prefixed with the prefix given when constructing this `Storage`
3953
+ */
3954
+ sKey: string
3955
+ ): boolean;
3956
+ /**
3957
+ * Removes all key/value pairs form the storage where the key starts with the given `sKeyPrefix`.
3958
+ *
3959
+ * @returns Whether the deletion was successful; if no key matches the prefix, this is also a success
3960
+ */
3961
+ static removeAll(
3962
+ /**
3963
+ * Key prefix for the keys/values to delete; will be additionally prefixed with the prefix given when constructing
3964
+ * this `Storage`
3965
+ */
3966
+ sKeyPrefix?: string
3967
+ ): boolean;
3968
+ /**
3969
+ * Clears the whole storage (Independent of the current Storage instance!).
3970
+ *
3971
+ * **CAUTION** This method should be called only in very particular situations, when a global erasing of
3972
+ * data is required. Given that the method deletes the data saved under any key, it should not be called
3868
3973
  * when managing data for specific controls.
3869
3974
  *
3870
- * @returns true if execution of removal was successful or the data to remove doesn't exist, and false if
3871
- * the feature is unavailable or a problem occurred
3975
+ * @returns Whether clearing the storage was successful
3872
3976
  */
3873
3977
  clear(): boolean;
3874
3978
  /**
3875
- * Retrieves data item for a specific key.
3979
+ * Retrieves the value for the given key or `null` if the key does not exist in this storage.
3980
+ *
3981
+ * The returned value will be of a type that `JSON.parse` could return, too.
3876
3982
  *
3877
- * @returns key's value or `null`
3983
+ * @returns The key's value or `null` if the key does not exist in the storage.
3878
3984
  */
3879
3985
  get(
3880
3986
  /**
3881
- * key to retrieve
3987
+ * Key to retrieve the value for; will be prefixed with the prefix given when constructing this `Storage`
3882
3988
  */
3883
3989
  sKey: string
3884
- ): object | null;
3990
+ ): any;
3885
3991
  /**
3886
- * Returns the storage type.
3992
+ * Returns the type of this storage.
3887
3993
  *
3888
- * @returns storage type or "unknown"
3994
+ * @returns Type of this storage or "unknown" when the Storage was created with an unknown type or implementation
3889
3995
  */
3890
3996
  getType(): (Type | keyof typeof Type) | string;
3891
3997
  /**
@@ -3895,43 +4001,44 @@ declare module "sap/ui/util/Storage" {
3895
4001
  */
3896
4002
  isSupported(): boolean;
3897
4003
  /**
3898
- * Add key to the storage or updates value if the key already exists.
4004
+ * Stores the given value under the given key in the storage or updates the value if the key already exists.
3899
4005
  *
3900
- * @returns true if the data was successfully stored, otherwise false
4006
+ * This method supports the same types of values as `JSON.stringify`.
4007
+ *
4008
+ * @returns Whether the data was successfully stored
3901
4009
  */
3902
4010
  put(
3903
4011
  /**
3904
- * key to create
4012
+ * Key to store the given value under; will be prefixed with the prefix given when constructing this `Storage`
3905
4013
  */
3906
4014
  sKey: string,
3907
4015
  /**
3908
- * value to create/update
4016
+ * Value to store/update under the given key
3909
4017
  */
3910
- sValue: string
4018
+ vValue: any
3911
4019
  ): boolean;
3912
4020
  /**
3913
- * Removes key from storage if it exists.
4021
+ * Removes the key and its value from storage, if the key exists.
3914
4022
  *
3915
- * @returns true if the deletion was successful or the data doesn't exist under the specified key, and false
3916
- * if the feature is unavailable or a problem occurred
4023
+ * @returns Whether the deletion succeeded; if the key didn't exists, the method also reports a success
3917
4024
  */
3918
4025
  remove(
3919
4026
  /**
3920
- * key to remove
4027
+ * Key to remove; will be prefixed with the prefix given when constructing this `Storage`
3921
4028
  */
3922
4029
  sKey: string
3923
4030
  ): boolean;
3924
4031
  /**
3925
- * Removes all stored keys.
4032
+ * Removes all key/value pairs form the storage where the key starts with the given `sKeyPrefix`.
3926
4033
  *
3927
- * @returns true if the deletion was successful or the data doesn't exist under the specified key, and false
3928
- * if the feature is unavailable or a problem occurred
4034
+ * @returns Whether the deletion was successful; if no key matches the prefix, this is also a success
3929
4035
  */
3930
4036
  removeAll(
3931
4037
  /**
3932
- * prefix id for the states to delete
4038
+ * Key prefix for the keys/values to delete; will be additionally prefixed with the prefix given when constructing
4039
+ * this `Storage`
3933
4040
  */
3934
- sIdPrefix?: string
4041
+ sKeyPrefix?: string
3935
4042
  ): boolean;
3936
4043
  }
3937
4044
  /**
@@ -16564,7 +16671,7 @@ declare namespace sap {
16564
16671
  viewName?: string;
16565
16672
  /**
16566
16673
  * The view definition. Only supported for XML and HTML views. See also {@link sap.ui.core.mvc.XMLView.create}
16567
- * and {@link sap.ui.core.mvc.HTMLView.create} for more information
16674
+ * and {@link sap.ui.core.mvc.HTMLView.create} (deprecated) for more information.
16568
16675
  */
16569
16676
  definition?: any;
16570
16677
  /**
@@ -17605,9 +17712,15 @@ declare namespace sap {
17605
17712
  * Specifies possible view types.
17606
17713
  *
17607
17714
  * **Note:** Typed views do not rely on a `ViewType`, it must be omitted in the view settings.
17715
+ *
17716
+ * See the {@link topic:91f27e3e6f4d1014b6dd926db0e91070 documentation} for more information on the different
17717
+ * view types.
17608
17718
  */
17609
17719
  enum ViewType {
17610
17720
  /**
17721
+ * @deprecated (since 1.108) - Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
17722
+ * (view classes written in JavaScript) instead.
17723
+ *
17611
17724
  * HTML view
17612
17725
  */
17613
17726
  HTML = "HTML",
@@ -38668,7 +38781,7 @@ declare namespace sap {
38668
38781
  /**
38669
38782
  * Value of the style property
38670
38783
  */
38671
- sValue: string
38784
+ vValue: string | float | int
38672
38785
  ): this;
38673
38786
  /**
38674
38787
  * @SINCE 1.67
@@ -48970,187 +49083,20 @@ declare namespace sap {
48970
49083
  /**
48971
49084
  * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
48972
49085
  */
48973
- oInitialData: object,
48974
- /**
48975
- * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
48976
- * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
48977
- * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
48978
- * order of the resulting back end creation requests.
48979
- */
48980
- bAtEnd: boolean,
48981
- /**
48982
- * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry}, where only
48983
- * the subset given below is supported. In case of deep create, **none** of the parameters in `mParameters`
48984
- * must be set.
48985
- */
48986
- mParameters: {
48987
- /**
48988
- * The ID of the `ChangeSet` that this request should belong to
48989
- */
48990
- changeSetId?: string;
48991
- /**
48992
- * The error callback function
48993
- */
48994
- error?: Function;
48995
- /**
48996
- * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
48997
- * sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
48998
- * parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
48999
- */
49000
- expand?: string;
49001
- /**
49002
- * The ID of a request group; requests belonging to the same group will be bundled in one batch request
49003
- */
49004
- groupId?: string;
49005
- /**
49006
- * Whether the created context is inactive. An inactive context will only be sent to the server after the
49007
- * first property update. From then on it behaves like any other created context.
49008
- */
49009
- inactive?: boolean;
49010
- /**
49011
- * The success callback function
49012
- */
49013
- success?: Function;
49014
- }
49015
- ): sap.ui.model.odata.v2.Context;
49016
- /**
49017
- * @SINCE 1.98.0
49018
- *
49019
- * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
49020
- * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
49021
- * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
49022
- * Entities documentation} for comprehensive information on the topic.
49023
- *
49024
- * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
49025
- *
49026
- * Since 1.108.0, this method supports deep create, which means it may be called if this binding's context
49027
- * is transient. The restrictions specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} regarding
49028
- * deep create apply.
49029
- *
49030
- * @returns The context representing the created entity
49031
- */
49032
- create(
49033
- /**
49034
- * The initial data for the created entity; see the `mParameters.properties` parameter of {@link sap.ui.model.odata.v2.ODataModel#createEntry}
49035
- */
49036
- oInitialData: object,
49037
- /**
49038
- * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry}, where only
49039
- * the subset given below is supported. In case of deep create, **none** of the parameters in `mParameters`
49040
- * must be set.
49041
- */
49042
- mParameters: {
49043
- /**
49044
- * The ID of the `ChangeSet` that this request should belong to
49045
- */
49046
- changeSetId?: string;
49047
- /**
49048
- * The error callback function
49049
- */
49050
- error?: Function;
49051
- /**
49052
- * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
49053
- * sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
49054
- * parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
49055
- */
49056
- expand?: string;
49057
- /**
49058
- * The ID of a request group; requests belonging to the same group will be bundled in one batch request
49059
- */
49060
- groupId?: string;
49061
- /**
49062
- * Whether the created context is inactive. An inactive context will only be sent to the server after the
49063
- * first property update. From then on it behaves like any other created context.
49064
- */
49065
- inactive?: boolean;
49066
- /**
49067
- * The success callback function
49068
- */
49069
- success?: Function;
49070
- }
49071
- ): sap.ui.model.odata.v2.Context;
49072
- /**
49073
- * @SINCE 1.98.0
49074
- *
49075
- * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
49076
- * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
49077
- * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
49078
- * Entities documentation} for comprehensive information on the topic.
49079
- *
49080
- * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
49081
- *
49082
- * Since 1.108.0, this method supports deep create, which means it may be called if this binding's context
49083
- * is transient. The restrictions specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} regarding
49084
- * deep create apply.
49085
- *
49086
- * @returns The context representing the created entity
49087
- */
49088
- create(
49086
+ oInitialData?: object,
49089
49087
  /**
49090
49088
  * Whether the entity is inserted at the end of the list. The first insertion determines the overall position
49091
49089
  * of created contexts within the list. Every succeeding insertion is relative to the created contexts within
49092
49090
  * this list. Note: the order of created contexts in the binding does not necessarily correspond to the
49093
49091
  * order of the resulting back end creation requests.
49094
49092
  */
49095
- bAtEnd: boolean,
49096
- /**
49097
- * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry}, where only
49098
- * the subset given below is supported. In case of deep create, **none** of the parameters in `mParameters`
49099
- * must be set.
49100
- */
49101
- mParameters: {
49102
- /**
49103
- * The ID of the `ChangeSet` that this request should belong to
49104
- */
49105
- changeSetId?: string;
49106
- /**
49107
- * The error callback function
49108
- */
49109
- error?: Function;
49110
- /**
49111
- * A comma-separated list of navigation properties to be expanded for the newly created entity; see {@link
49112
- * sap.ui.model.odata.v2.ODataModel#createEntry}; **Note:** if no expand parameter is given, the expand
49113
- * parameter of this binding is used; see {@link sap.ui.model.odata.v2.ODataModel#bindList}
49114
- */
49115
- expand?: string;
49116
- /**
49117
- * The ID of a request group; requests belonging to the same group will be bundled in one batch request
49118
- */
49119
- groupId?: string;
49120
- /**
49121
- * Whether the created context is inactive. An inactive context will only be sent to the server after the
49122
- * first property update. From then on it behaves like any other created context.
49123
- */
49124
- inactive?: boolean;
49125
- /**
49126
- * The success callback function
49127
- */
49128
- success?: Function;
49129
- }
49130
- ): sap.ui.model.odata.v2.Context;
49131
- /**
49132
- * @SINCE 1.98.0
49133
- *
49134
- * Creates a new entity for this binding's collection via {@link sap.ui.model.odata.v2.ODataModel#createEntry}
49135
- * using the parameters given in `mParameters` and inserts it at the list position specified by the `bAtEnd`
49136
- * parameter. See {@link topic:6c47b2b39db9404582994070ec3d57a2#loio4c4cd99af9b14e08bb72470cc7cabff4 Creating
49137
- * Entities documentation} for comprehensive information on the topic.
49138
- *
49139
- * Note: This method requires that the model metadata has been loaded; see {@link sap.ui.model.odata.v2.ODataModel#metadataLoaded}.
49140
- *
49141
- * Since 1.108.0, this method supports deep create, which means it may be called if this binding's context
49142
- * is transient. The restrictions specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry} regarding
49143
- * deep create apply.
49144
- *
49145
- * @returns The context representing the created entity
49146
- */
49147
- create(
49093
+ bAtEnd?: boolean,
49148
49094
  /**
49149
49095
  * A map of parameters as specified for {@link sap.ui.model.odata.v2.ODataModel#createEntry}, where only
49150
49096
  * the subset given below is supported. In case of deep create, **none** of the parameters in `mParameters`
49151
49097
  * must be set.
49152
49098
  */
49153
- mParameters: {
49099
+ mParameters?: {
49154
49100
  /**
49155
49101
  * The ID of the `ChangeSet` that this request should belong to
49156
49102
  */
@@ -52932,19 +52878,26 @@ declare namespace sap {
52932
52878
  *
52933
52879
  * Deletes the OData entity this context points to. The context is removed from the binding immediately,
52934
52880
  * even if {@link sap.ui.model.odata.v4.SubmitMode.API} is used, and the request is only sent later when
52935
- * {@link sap.ui.model.odata.v4.ODataModel#submitBatch} is called. As long as the context is deleted on
52936
- * the client, but not yet on the server, {@link #isDeleted} returns `true` and the context must not be
52937
- * used anymore (except for checking {@link #isDeleted}), especially not as a binding context. The application
52938
- * has to take care that the context is no longer used.
52881
+ * {@link sap.ui.model.odata.v4.ODataModel#submitBatch} is called. As soon as the context is deleted on
52882
+ * the client, {@link #isDeleted} returns `true` and the context must not be used anymore (except for status
52883
+ * APIs like {@link #isDeleted}, {@link #isKeepAlive}, {@link #hasPendingChanges}, {@link #resetChanges}),
52884
+ * especially not as a binding context.
52939
52885
  *
52940
52886
  * Since 1.105 such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
52941
- * for the context, the binding containing it, and the model. `resetChanges` in binding or model cancels
52942
- * the deletion and restores the context.
52887
+ * for the context, the binding containing it, and the model. The `resetChanges` method called on the context
52888
+ * (since 1.109.0), the binding, or the model cancels the deletion and restores the context.
52889
+ *
52890
+ * If the DELETE request succeeds, the context is destroyed and must not be used anymore. If it fails or
52891
+ * is canceled, the context is restored, reinserted into the list, and fully functional again.
52943
52892
  *
52944
- * If the DELETE request succeeds, the context is destroyed and must not be used anymore. If it fails, the
52945
- * context is restored, reinserted into the list, and fully functional again.
52893
+ * If the deleted context is used as binding context of a control or view, the application is advised to
52894
+ * unbind it via `{@link sap.ui.base.ManagedObject#setBindingContext setBindingContext(null)}` before calling
52895
+ * `delete`, and to possibly rebind it after reset or failure. The model itself ensures that all bindings
52896
+ * depending on this context become unresolved, but no attempt is made to restore these bindings in case
52897
+ * of reset or failure.
52946
52898
  * See:
52947
52899
  * #hasPendingChanges
52900
+ * #resetChanges
52948
52901
  * sap.ui.model.odata.v4.ODataContextBinding#hasPendingChanges
52949
52902
  * sap.ui.model.odata.v4.ODataListBinding#hasPendingChanges
52950
52903
  * sap.ui.model.odata.v4.ODataModel#hasPendingChanges
@@ -53103,8 +53056,9 @@ declare namespace sap {
53103
53056
  *
53104
53057
  * Returns whether there are pending changes for bindings dependent on this context, or for unresolved bindings
53105
53058
  * (see {@link sap.ui.model.Binding#isResolved}) which were dependent on this context at the time the pending
53106
- * change was created. This includes the context itself being {@link #isTransient transient} or {@link #isDeleted
53107
- * deleted}. Since 1.98.0, {@link #isInactive inactive} contexts are ignored.
53059
+ * change was created. This includes the context itself being {@link #isTransient transient} or {@link #delete
53060
+ * deleted} on the client, but not yet on the server. Since 1.98.0, {@link #isInactive inactive} contexts
53061
+ * are ignored.
53108
53062
  *
53109
53063
  * @returns Whether there are pending changes
53110
53064
  */
@@ -53112,8 +53066,10 @@ declare namespace sap {
53112
53066
  /**
53113
53067
  * @SINCE 1.105.0
53114
53068
  *
53115
- * Returns whether this context is deleted on the client, but not on the server yet. The result of this
53116
- * function can also be accessed via the "@$ui5.context.isDeleted" instance annotation at the entity.
53069
+ * Returns whether this context is deleted. It becomes `true` immediately after calling {@link #delete},
53070
+ * even while the request is waiting for {@link sap.ui.model.odata.v4.ODataModel#submitBatch submitBatch}
53071
+ * or is in process. It becomes `false` again when the DELETE request fails or is canceled. The result of
53072
+ * this function can also be accessed via the "@$ui5.context.isDeleted" instance annotation at the entity.
53117
53073
  * See:
53118
53074
  * #delete
53119
53075
  *
@@ -53364,6 +53320,20 @@ declare namespace sap {
53364
53320
  */
53365
53321
  sGroupId?: string
53366
53322
  ): Promise<undefined>;
53323
+ /**
53324
+ * @EXPERIMENTAL (since 1.109.0)
53325
+ *
53326
+ * Resets all pending changes of this context, see {@link #hasPendingChanges}. Resets also invalid user
53327
+ * input. If this context is currently {@link #delete deleted} on the client, but not yet on the server,
53328
+ * this method cancels the deletion and restores the context.
53329
+ *
53330
+ * Note: This is an experimental API. Currently only PATCH and DELETE changes for row contexts of an absolute
53331
+ * {@link sap.ui.model.odata.v4.ODataListBinding} are supported.
53332
+ *
53333
+ * @returns A promise which is resolved without a defined result as soon as all changes in the context itself
53334
+ * are canceled
53335
+ */
53336
+ resetChanges(): Promise<any>;
53367
53337
  /**
53368
53338
  * @SINCE 1.81.0
53369
53339
  *
@@ -54186,8 +54156,8 @@ declare namespace sap {
54186
54156
  bAtEnd?: boolean,
54187
54157
  /**
54188
54158
  * Create an inactive context. Such a context will only be sent to the server after the first property update.
54189
- * From then on it behaves like any other created context. Supported since 1.97.0 Since 1.98.0, when
54190
- * the first property updates happens, the context is no longer {@link sap.ui.model.odata.v4.Context#isInactive
54159
+ * From then on it behaves like any other created context. Supported since 1.97.0
54160
+ * Since 1.98.0, when the first property updates happens, the context is no longer {@link sap.ui.model.odata.v4.Context#isInactive
54191
54161
  * inactive} and the {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate createActivate}
54192
54162
  * event is fired. While inactive, it does not count as a {@link #hasPendingChanges pending change} and
54193
54163
  * does not contribute to the {@link #getCount count}.
@@ -54333,6 +54303,14 @@ declare namespace sap {
54333
54303
  */
54334
54304
  sFilterType?: sap.ui.model.FilterType
54335
54305
  ): this;
54306
+ /**
54307
+ * @SINCE 1.109.0
54308
+ *
54309
+ * Returns the current object holding the information needed for data aggregation, see {@link #setAggregation}.
54310
+ *
54311
+ * @returns The current data aggregation object, incl. some default values
54312
+ */
54313
+ getAggregation(): object;
54336
54314
  /**
54337
54315
  * @SINCE 1.98.0
54338
54316
  *
@@ -54753,6 +54731,8 @@ declare namespace sap {
54753
54731
  * @SINCE 1.55.0
54754
54732
  *
54755
54733
  * Sets a new data aggregation object and derives the system query option `$apply` implicitly from it.
54734
+ * See:
54735
+ * #getAggregation
54756
54736
  */
54757
54737
  setAggregation(
54758
54738
  /**
@@ -54786,8 +54766,9 @@ declare namespace sap {
54786
54766
  */
54787
54767
  aggregate?: object;
54788
54768
  /**
54789
- * The number of initially expanded levels as a positive integer (@experimental as of version 1.105.0),
54790
- * supported only if a `hierarchyQualifier` is given.
54769
+ * The number (as a positive integer) of different levels initially available without calling {@link sap.ui.model.odata.v4.Context#expand}
54770
+ * (@experimental as of version 1.105.0), supported only if a `hierarchyQualifier` is given. Root nodes
54771
+ * are on the first level. By default, only root nodes are available; they are not yet expanded.
54791
54772
  */
54792
54773
  expandTo?: number;
54793
54774
  /**
@@ -54842,6 +54823,11 @@ declare namespace sap {
54842
54823
  * at this list binding and they are used for each following data request. Since 1.97.0, if sorters are
54843
54824
  * unchanged, no request is sent, regardless of pending changes.
54844
54825
  *
54826
+ * **Note:** To allow proper detection whether sorters are unchanged, care must be taken if a sorter uses
54827
+ * a function (for example via the `vGroup` parameter): it must be the exact same function instance which
54828
+ * was given before, and not a newly created one, for example because `Function.prototype.bind` is called
54829
+ * repeatedly.
54830
+ *
54845
54831
  * If there are pending changes that cannot be ignored, an error is thrown. Use {@link #hasPendingChanges}
54846
54832
  * to check if there are such pending changes. If there are, call {@link sap.ui.model.odata.v4.ODataModel#submitBatch}
54847
54833
  * to submit the changes or {@link sap.ui.model.odata.v4.ODataModel#resetChanges} to reset the changes before
@@ -56694,7 +56680,7 @@ declare namespace sap {
56694
56680
  * which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
56695
56681
  * the same group ID. This function does not reset the execution of OData operations (see {@link sap.ui.model.odata.v4.ODataContextBinding#execute}).
56696
56682
  * See:
56697
- * sap.ui.model.odata.v4.ODataModel#constructor.
56683
+ * sap.ui.model.odata.v4.ODataModel#constructor
56698
56684
  */
56699
56685
  resetChanges(
56700
56686
  /**
@@ -73903,8 +73889,6 @@ declare namespace sap {
73903
73889
 
73904
73890
  "sap/ui/events/TouchToMouseMapping": undefined;
73905
73891
 
73906
- "sap/ui/Global": undefined;
73907
-
73908
73892
  "sap/ui/model/analytics/AnalyticalBinding": undefined;
73909
73893
 
73910
73894
  "sap/ui/model/analytics/AnalyticalTreeBindingAdapter": undefined;
@@ -73913,8 +73897,6 @@ declare namespace sap {
73913
73897
 
73914
73898
  "sap/ui/model/analytics/odata4analytics": undefined;
73915
73899
 
73916
- "sap/ui/model/analytics/ODataModelAdapter": undefined;
73917
-
73918
73900
  "sap/ui/model/base/ManagedObjectModel": undefined;
73919
73901
 
73920
73902
  "sap/ui/model/Binding": undefined;
@@ -74240,8 +74222,6 @@ declare namespace sap {
74240
74222
  "sap/ui/util/XMLHelper": undefined;
74241
74223
 
74242
74224
  "sap/ui/VersionInfo": undefined;
74243
-
74244
- ui5loader: undefined;
74245
74225
  }
74246
74226
 
74247
74227
  type ClassInfo<T, C> = T & Partial<C> & ThisType<T & C>;