@sapui5/ts-types 1.105.1 → 1.106.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 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +25 -25
  6. package/types/sap.esh.search.ui.d.ts +111 -1
  7. package/types/sap.f.d.ts +80 -4
  8. package/types/sap.fe.common.d.ts +1 -1
  9. package/types/sap.fe.core.d.ts +4 -4
  10. package/types/sap.fe.macros.d.ts +23 -95
  11. package/types/sap.fe.navigation.d.ts +1 -1
  12. package/types/sap.fe.templates.d.ts +155 -1
  13. package/types/sap.fe.test.d.ts +17 -3
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +153 -4
  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 +387 -103
  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 +1 -1
  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 +39 -1
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +25 -11
  27. package/types/sap.suite.ui.generic.template.d.ts +17 -3
  28. package/types/sap.suite.ui.microchart.d.ts +13 -13
  29. package/types/sap.tnt.d.ts +3 -3
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +31 -31
  32. package/types/sap.ui.comp.d.ts +110 -36
  33. package/types/sap.ui.core.d.ts +426 -225
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +3 -3
  36. package/types/sap.ui.fl.d.ts +3 -3
  37. package/types/sap.ui.generic.app.d.ts +6 -2
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +64 -33
  40. package/types/sap.ui.layout.d.ts +7 -7
  41. package/types/sap.ui.mdc.d.ts +3 -1
  42. package/types/sap.ui.richtexteditor.d.ts +2 -2
  43. package/types/sap.ui.rta.d.ts +3 -1
  44. package/types/sap.ui.suite.d.ts +5 -5
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +26 -8
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +16 -16
  49. package/types/sap.ui.ux3.d.ts +11 -11
  50. package/types/sap.ui.vbm.d.ts +3 -3
  51. package/types/sap.ui.vk.d.ts +44 -6
  52. package/types/sap.ui.vtm.d.ts +2 -2
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +31 -28
  55. package/types/sap.ui.webc.main.d.ts +132 -104
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +7 -3
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +41 -1
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +2 -6
  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.105.0
267
+ // For Library Version: 1.106.0
268
268
 
269
269
  declare module "sap/base/assert" {
270
270
  /**
@@ -440,7 +440,7 @@ declare module "sap/base/i18n/ResourceBundle" {
440
440
  * fallback bundle.
441
441
  */
442
442
  bIgnoreKeyFallback?: boolean
443
- ): string;
443
+ ): string | undefined;
444
444
  /**
445
445
  * Checks whether a text for the given key can be found in the first loaded resource bundle or not. Neither
446
446
  * the custom resource bundles nor the fallback chain will be processed.
@@ -451,7 +451,7 @@ declare module "sap/base/i18n/ResourceBundle" {
451
451
  * When requesting the resource bundle asynchronously this check must only be used after the resource bundle
452
452
  * has been loaded.
453
453
  *
454
- * @returns true if the text has been found in the concrete bundle
454
+ * @returns Whether the text has been found in the concrete bundle
455
455
  */
456
456
  hasText(
457
457
  /**
@@ -1712,7 +1712,7 @@ declare module "sap/base/util/ObjectPath" {
1712
1712
  * Root context where the path starts
1713
1713
  */
1714
1714
  oRootContext?: Object
1715
- ): any;
1715
+ ): any | undefined;
1716
1716
  /**
1717
1717
  * Sets a value located in the provided path.
1718
1718
  *
@@ -1820,7 +1820,7 @@ declare module "sap/base/util/Properties" {
1820
1820
  * Optional, a default value that will be returned if the requested key is not in the collection
1821
1821
  */
1822
1822
  sDefaultValue?: string
1823
- ): string;
1823
+ ): string | null;
1824
1824
  /**
1825
1825
  * Stores or changes the value for the given key in the collection.
1826
1826
  *
@@ -2480,7 +2480,11 @@ declare module "sap/ui/dom/getScrollbarSize" {
2480
2480
  * are reset.
2481
2481
  */
2482
2482
  bForce?: boolean
2483
- ): object;
2483
+ ): {
2484
+ width: number;
2485
+
2486
+ height: number;
2487
+ };
2484
2488
  }
2485
2489
 
2486
2490
  declare module "sap/ui/dom/includeScript" {
@@ -6808,9 +6812,13 @@ declare namespace sap {
6808
6812
  * Array of binding info objects for the parts of a composite binding; the structure of each binding info
6809
6813
  * is the same as described for the `oBindingInfo` as a whole.
6810
6814
  *
6811
- * **Note**: recursive composite bindings are currently not supported
6815
+ * If a part is not specified as a binding info object but as a simple string, a binding info object will
6816
+ * be created with that string as `path`. The string may start with a model name prefix (see property `path`).
6817
+ *
6818
+ * **Note**: recursive composite bindings are currently not supported. Therefore, a part must not contain
6819
+ * a `parts` property.
6812
6820
  */
6813
- parts?: sap.ui.base.ManagedObject.PropertyBindingInfo[];
6821
+ parts?: Array<string | sap.ui.base.ManagedObject.PropertyBindingInfo>;
6814
6822
  };
6815
6823
  }
6816
6824
  /**
@@ -7029,7 +7037,7 @@ declare namespace sap {
7029
7037
  *
7030
7038
  * @returns Object with enum keys and values or `undefined`
7031
7039
  */
7032
- getEnumValues(): object;
7040
+ getEnumValues(): object | undefined;
7033
7041
  /**
7034
7042
  * The qualified name of the data type.
7035
7043
  *
@@ -7202,7 +7210,7 @@ declare namespace sap {
7202
7210
  *
7203
7211
  * @returns All parameters of the event
7204
7212
  */
7205
- getParameters(): object;
7213
+ getParameters(): Record<string, any>;
7206
7214
  /**
7207
7215
  * Returns the event provider on which the event was fired.
7208
7216
  *
@@ -7455,7 +7463,7 @@ declare namespace sap {
7455
7463
  *
7456
7464
  * @returns The parent event provider
7457
7465
  */
7458
- getEventingParent(): sap.ui.base.EventProvider;
7466
+ getEventingParent(): sap.ui.base.EventProvider | null;
7459
7467
  /**
7460
7468
  * Returns whether there are any registered event handlers for the event with the given identifier.
7461
7469
  *
@@ -7883,7 +7891,7 @@ declare namespace sap {
7883
7891
  * Example:
7884
7892
  * ```javascript
7885
7893
  *
7886
- * ManagedObect.extend('sap.mylib.MyClass', {
7894
+ * ManagedObject.extend('sap.mylib.MyClass', {
7887
7895
  * metadata : {
7888
7896
  * library: 'sap.mylib',
7889
7897
  * properties : {
@@ -9117,9 +9125,9 @@ declare namespace sap {
9117
9125
  * the object that is used in case the current aggregation is empty (only null or empty array allowed)
9118
9126
  */
9119
9127
  oDefaultForCreation: object
9120
- ): string | string[];
9128
+ ): string | string[] | null;
9121
9129
  /**
9122
- * Get the binding object for a specific aggregation/property
9130
+ * Get the binding object for a specific aggregation/property.
9123
9131
  *
9124
9132
  * @returns the binding for the given name
9125
9133
  */
@@ -9128,7 +9136,7 @@ declare namespace sap {
9128
9136
  * the name of the property or aggregation
9129
9137
  */
9130
9138
  sName: string
9131
- ): sap.ui.model.Binding;
9139
+ ): sap.ui.model.Binding | undefined;
9132
9140
  /**
9133
9141
  * Get the binding context of this object for the given model name.
9134
9142
  *
@@ -9169,7 +9177,7 @@ declare namespace sap {
9169
9177
  sName: string
9170
9178
  ): object;
9171
9179
  /**
9172
- * Get the binding path for a specific aggregation/property
9180
+ * Get the binding path for a specific aggregation/property.
9173
9181
  *
9174
9182
  * @returns the binding path for the given name
9175
9183
  */
@@ -9178,14 +9186,14 @@ declare namespace sap {
9178
9186
  * the name of the property or aggregation
9179
9187
  */
9180
9188
  sName: string
9181
- ): string;
9189
+ ): string | undefined;
9182
9190
  /**
9183
9191
  * Returns the parent managed object as new eventing parent to enable control event bubbling or `null` if
9184
9192
  * this object hasn't been added to a parent yet.
9185
9193
  *
9186
9194
  * @returns the parent event provider
9187
9195
  */
9188
- getEventingParent(): sap.ui.base.EventProvider;
9196
+ getEventingParent(): sap.ui.base.EventProvider | null;
9189
9197
  /**
9190
9198
  * Returns the object's ID.
9191
9199
  *
@@ -9246,7 +9254,7 @@ declare namespace sap {
9246
9254
  * Non-empty name of the model or `undefined`
9247
9255
  */
9248
9256
  sModelName?: string
9249
- ): sap.ui.model.ContextBinding;
9257
+ ): sap.ui.model.ContextBinding | undefined;
9250
9258
  /**
9251
9259
  * Returns the origin info for the value of the given property.
9252
9260
  *
@@ -9322,7 +9330,7 @@ declare namespace sap {
9322
9330
  *
9323
9331
  * @returns The technical parent managed object or `null`
9324
9332
  */
9325
- getParent(): sap.ui.base.ManagedObject;
9333
+ getParent(): sap.ui.base.ManagedObject | null;
9326
9334
  /**
9327
9335
  * Returns the value for the property with the given `sPropertyName`.
9328
9336
  *
@@ -10118,7 +10126,7 @@ declare namespace sap {
10118
10126
  * name of the aggregation or empty
10119
10127
  */
10120
10128
  sName?: string
10121
- ): Object;
10129
+ ): Object | undefined;
10122
10130
  /**
10123
10131
  * Returns a map of info objects for the public aggregations of the described class. Aggregations declared
10124
10132
  * by ancestor classes are not included.
@@ -10248,7 +10256,7 @@ declare namespace sap {
10248
10256
  * name of the association
10249
10257
  */
10250
10258
  sName: string
10251
- ): Object;
10259
+ ): Object | undefined;
10252
10260
  /**
10253
10261
  * Returns a map of info objects for all public associations of the described class. Associations declared
10254
10262
  * by ancestor classes are not included.
@@ -10305,7 +10313,7 @@ declare namespace sap {
10305
10313
  * name of the event
10306
10314
  */
10307
10315
  sName: string
10308
- ): Object;
10316
+ ): Object | undefined;
10309
10317
  /**
10310
10318
  * Returns a map of info objects for the public events of the described class. Events declared by ancestor
10311
10319
  * classes are not included.
@@ -10412,7 +10420,7 @@ declare namespace sap {
10412
10420
  * name of the property
10413
10421
  */
10414
10422
  sName: string
10415
- ): Object;
10423
+ ): Object | undefined;
10416
10424
  /**
10417
10425
  * Returns a map of default values for all properties declared by the described class and its ancestors,
10418
10426
  * keyed by the property name.
@@ -10441,7 +10449,7 @@ declare namespace sap {
10441
10449
  * name of the property like setting
10442
10450
  */
10443
10451
  sName: string
10444
- ): Object;
10452
+ ): Object | undefined;
10445
10453
  /**
10446
10454
  * Checks the existence of the given public aggregation by its name.
10447
10455
  *
@@ -11378,7 +11386,9 @@ declare namespace sap {
11378
11386
  * value.
11379
11387
  */
11380
11388
  time: int,
11381
-
11389
+ /**
11390
+ * Called when the scroll completes or stops without completing
11391
+ */
11382
11392
  fnScrollEndCallback: Function
11383
11393
  ): this;
11384
11394
  /**
@@ -11393,7 +11403,9 @@ declare namespace sap {
11393
11403
  * Vertical position of the scrollbar
11394
11404
  */
11395
11405
  y: int,
11396
-
11406
+ /**
11407
+ * Called when the scroll completes or stops without completing
11408
+ */
11397
11409
  fnScrollEndCallback: Function
11398
11410
  ): this;
11399
11411
  /**
@@ -14519,7 +14531,7 @@ declare namespace sap {
14519
14531
  * the string containing a formatted numeric value
14520
14532
  */
14521
14533
  sValue: string
14522
- ): number | any[] | string;
14534
+ ): number | any[] | string | null;
14523
14535
  }
14524
14536
  /**
14525
14537
  * @SINCE 1.99.0
@@ -18147,24 +18159,7 @@ declare namespace sap {
18147
18159
  * scenarios or levels. The implementation of the Control (JavaScript or CSS) has to be done differently
18148
18160
  * for each animation mode.
18149
18161
  */
18150
- enum AnimationMode {
18151
- /**
18152
- * `basic` can be used for a reduced, more light-weight set of animations.
18153
- */
18154
- basic = "basic",
18155
- /**
18156
- * `full` represents a mode with unrestricted animation capabilities.
18157
- */
18158
- full = "full",
18159
- /**
18160
- * `minimal` includes animations of fundamental functionality.
18161
- */
18162
- minimal = "minimal",
18163
- /**
18164
- * `none` deactivates the animation completely.
18165
- */
18166
- none = "none",
18167
- }
18162
+ enum AnimationMode {}
18168
18163
  }
18169
18164
 
18170
18165
  namespace Element {
@@ -19456,14 +19451,14 @@ declare namespace sap {
19456
19451
  /**
19457
19452
  * Get a registered router.
19458
19453
  *
19459
- * @returns The router with the specified name, else undefined
19454
+ * @returns The router with the specified name, else `undefined`
19460
19455
  */
19461
19456
  static getRouter(
19462
19457
  /**
19463
19458
  * Name of the router
19464
19459
  */
19465
19460
  sName: string
19466
- ): sap.ui.core.routing.Router;
19461
+ ): sap.ui.core.routing.Router | undefined;
19467
19462
  /**
19468
19463
  * Adds a route to the router.
19469
19464
  */
@@ -23360,7 +23355,7 @@ declare namespace sap {
23360
23355
  * index of part in case of the root formatter of a composite binding (since 1.31.0)
23361
23356
  */
23362
23357
  iPart?: number
23363
- ): sap.ui.model.Model;
23358
+ ): sap.ui.model.Model | undefined;
23364
23359
  /**
23365
23360
  * Returns the absolute path related to the current formatter call.
23366
23361
  *
@@ -23372,7 +23367,7 @@ declare namespace sap {
23372
23367
  * index of part in case of the root formatter of a composite binding (since 1.31.0)
23373
23368
  */
23374
23369
  iPart?: number
23375
- ): string;
23370
+ ): string | undefined;
23376
23371
  /**
23377
23372
  * Returns the value of the setting with the given name which was provided to the XML template processing.
23378
23373
  *
@@ -27606,7 +27601,10 @@ declare namespace sap {
27606
27601
  * Whether the resource bundle is loaded asynchronously
27607
27602
  */
27608
27603
  bAsync?: boolean
27609
- ): import("sap/base/i18n/ResourceBundle").default | Promise<any>;
27604
+ ):
27605
+ | import("sap/base/i18n/ResourceBundle").default
27606
+ | undefined
27607
+ | Promise<import("sap/base/i18n/ResourceBundle").default | undefined>;
27610
27608
  /**
27611
27609
  * Returns a map of library info objects for all currently loaded libraries, keyed by their names.
27612
27610
  *
@@ -27689,7 +27687,7 @@ declare namespace sap {
27689
27687
  * DOM element or ID of the UIArea
27690
27688
  */
27691
27689
  o: string | /* was Element */ global_Element
27692
- ): sap.ui.core.UIArea;
27690
+ ): sap.ui.core.UIArea | null | undefined;
27693
27691
  /**
27694
27692
  * Returns `true` if there are any pending rendering tasks or when such rendering tasks are currently being
27695
27693
  * executed.
@@ -28076,9 +28074,9 @@ declare namespace sap {
28076
28074
  * for styling the `my.own.library` controls will be loaded from the configured location:
28077
28075
  * ```javascript
28078
28076
  *
28079
- * https://openui5.hana.ondemand.com/resources/sap/ui/core/themes/sap_belize/library.css
28080
- * https://openui5.hana.ondemand.com/resources/sap/ui/layout/themes/sap_belize/library.css
28081
- * https://openui5.hana.ondemand.com/resources/sap/m/themes/sap_belize/library.css
28077
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
28078
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
28079
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
28082
28080
  * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
28083
28081
  * ```
28084
28082
  *
@@ -28145,9 +28143,9 @@ declare namespace sap {
28145
28143
  * for styling the `my.own.library` controls will be loaded from the configured location:
28146
28144
  * ```javascript
28147
28145
  *
28148
- * https://openui5.hana.ondemand.com/resources/sap/ui/core/themes/sap_belize/library.css
28149
- * https://openui5.hana.ondemand.com/resources/sap/ui/layout/themes/sap_belize/library.css
28150
- * https://openui5.hana.ondemand.com/resources/sap/m/themes/sap_belize/library.css
28146
+ * https://sdk.openui5.org/resources/sap/ui/core/themes/sap_belize/library.css
28147
+ * https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_belize/library.css
28148
+ * https://sdk.openui5.org/resources/sap/m/themes/sap_belize/library.css
28151
28149
  * https://mythemeserver.com/allThemes/my/own/library/themes/sap_belize/library.css
28152
28150
  * ```
28153
28151
  *
@@ -28291,12 +28289,24 @@ declare namespace sap {
28291
28289
  */
28292
28290
  resourceBundle?: import("sap/base/i18n/ResourceBundle").default;
28293
28291
  }
28294
- ): object;
28292
+ ): {
28293
+ name: string;
28294
+
28295
+ collection: string;
28296
+
28297
+ uri: string;
28298
+
28299
+ fontFamily: string;
28300
+
28301
+ content: string | string[];
28302
+
28303
+ suppressMirroring: boolean;
28304
+ };
28295
28305
  /**
28296
28306
  * Creates an instance of {@link sap.ui.core.Icon} if the given URI is an icon URI, otherwise the given
28297
28307
  * constructor is called. The given URI is set to the src property of the control.
28298
28308
  *
28299
- * @returns Either an instance of sap.ui.core.Icon or instance created by calling the given constructor
28309
+ * @returns Either an instance of `sap.ui.core.Icon` or instance created by calling the given constructor
28300
28310
  */
28301
28311
  createControlByURI(
28302
28312
  /**
@@ -28404,7 +28414,7 @@ declare namespace sap {
28404
28414
  * Name of the icon collection; to access built-in icons, omit the collection name
28405
28415
  */
28406
28416
  collectionName?: string
28407
- ): string;
28417
+ ): string | undefined;
28408
28418
  /**
28409
28419
  * Adds CSS code to load an icon font to the DOM
28410
28420
  */
@@ -28487,14 +28497,14 @@ declare namespace sap {
28487
28497
  * Returns a generic indication color message if the given Element has a property `IndicationColor` with
28488
28498
  * one of the states or the given `indicationColor` string represents one of five states.
28489
28499
  *
28490
- * @returns the indication color text, if appropriate; otherwise null
28500
+ * @returns the indication color text, if appropriate; otherwise `null`
28491
28501
  */
28492
28502
  getAdditionalText(
28493
28503
  /**
28494
28504
  * the Element of which the indicationColor needs to be checked, or the IndicationColor explicitly
28495
28505
  */
28496
28506
  vValue: sap.ui.core.Element | sap.ui.core.IndicationColor
28497
- ): string;
28507
+ ): string | null;
28498
28508
  }
28499
28509
  const IndicationColorSupport: IndicationColorSupport;
28500
28510
 
@@ -28826,7 +28836,7 @@ declare namespace sap {
28826
28836
  * details about the available parameters of this event.
28827
28837
  */
28828
28838
  fHandler: Function
28829
- ): string;
28839
+ ): string | null;
28830
28840
  }
28831
28841
  const ResizeHandler: ResizeHandler;
28832
28842
 
@@ -28876,7 +28886,7 @@ declare namespace sap {
28876
28886
  * the Element of which the valueState needs to be checked, or the ValueState explicitly
28877
28887
  */
28878
28888
  vValue: sap.ui.core.Element | sap.ui.core.ValueState
28879
- ): string;
28889
+ ): string | null;
28880
28890
  }
28881
28891
  const ValueStateSupport: ValueStateSupport;
28882
28892
 
@@ -29308,7 +29318,7 @@ declare namespace sap {
29308
29318
  * ID of the component.
29309
29319
  */
29310
29320
  sId: string
29311
- ): sap.ui.core.Component;
29321
+ ): sap.ui.core.Component | undefined;
29312
29322
  /**
29313
29323
  * Returns the metadata for the Component class.
29314
29324
  *
@@ -29331,7 +29341,7 @@ declare namespace sap {
29331
29341
  * Object to retrieve the owner Component for
29332
29342
  */
29333
29343
  oObject: sap.ui.base.ManagedObject
29334
- ): sap.ui.core.Component;
29344
+ ): sap.ui.core.Component | undefined;
29335
29345
  /**
29336
29346
  * @SINCE 1.15.1
29337
29347
  *
@@ -29364,7 +29374,7 @@ declare namespace sap {
29364
29374
  * Object to retrieve the owner ID for
29365
29375
  */
29366
29376
  oObject: sap.ui.base.ManagedObject
29367
- ): string;
29377
+ ): string | undefined;
29368
29378
  /**
29369
29379
  * @SINCE 1.56.0
29370
29380
  *
@@ -30622,9 +30632,9 @@ declare namespace sap {
30622
30632
  * ignores the entries of the manifest file! It returns only the entries which have been defined in the
30623
30633
  * Component metadata or in the proper Component manifest.
30624
30634
  *
30625
- * @returns Required version of UI5 or if not specified then null.
30635
+ * @returns Required version of UI5 or if not specified then `null`.
30626
30636
  */
30627
- getUI5Version(): string;
30637
+ getUI5Version(): string | null;
30628
30638
  /**
30629
30639
  * @deprecated (since 1.34.2) - Please use {@link sap.ui.core.Component#getManifestEntry}("/sap.app/applicationVersion/version")
30630
30640
  *
@@ -30670,9 +30680,6 @@ declare namespace sap {
30670
30680
  * Values of boolean parameters are case insensitive where "true" and "x" are interpreted as true.
30671
30681
  */
30672
30682
  class Configuration extends sap.ui.base.Object {
30673
- /**
30674
- * Creates a new Configuration object.
30675
- */
30676
30683
  constructor();
30677
30684
 
30678
30685
  /**
@@ -30739,7 +30746,7 @@ declare namespace sap {
30739
30746
  *
30740
30747
  * @returns if no active terminologies are set, the default value `undefined` is returned.
30741
30748
  */
30742
- getActiveTerminologies(): string[];
30749
+ getActiveTerminologies(): string[] | undefined;
30743
30750
  /**
30744
30751
  * URL of the allowlist service.
30745
30752
  *
@@ -30801,9 +30808,9 @@ declare namespace sap {
30801
30808
  sFeature: string
30802
30809
  ): import("sap/base/util/Version").default;
30803
30810
  /**
30804
- * Returns whether the page runs in debug mode.
30811
+ * Returns whether the page runs in full debug mode.
30805
30812
  *
30806
- * @returns whether the page runs in debug mode
30813
+ * @returns Whether the page runs in full debug mode
30807
30814
  */
30808
30815
  getDebug(): boolean;
30809
30816
  /**
@@ -30831,9 +30838,9 @@ declare namespace sap {
30831
30838
  * Returns the URL from where the UI5 flexibility services are called; if empty, the flexibility services
30832
30839
  * are not called.
30833
30840
  *
30834
- * @returns URL from where the flexibility services are requested
30841
+ * @returns Flexibility services configuration
30835
30842
  */
30836
- getFlexibilityServices(): string;
30843
+ getFlexibilityServices(): object[];
30837
30844
  /**
30838
30845
  * Returns the format locale string with language and region code. Falls back to language configuration,
30839
30846
  * in case it has not been explicitly defined.
@@ -30854,7 +30861,7 @@ declare namespace sap {
30854
30861
  */
30855
30862
  getFrameOptions(): string;
30856
30863
  /**
30857
- * Returns whether the UI5 control inspector is displayed. Has only an effect when the sap-ui-debug module
30864
+ * Returns whether the UI5 control inspe ctor is displayed. Has only an effect when the sap-ui-debug module
30858
30865
  * has been loaded
30859
30866
  *
30860
30867
  * @returns whether the UI5 control inspector is displayed
@@ -30967,6 +30974,17 @@ declare namespace sap {
30967
30974
  * @returns the security token handlers (an empty array if there are none)
30968
30975
  */
30969
30976
  getSecurityTokenHandlers(): Function[];
30977
+ /**
30978
+ * @SINCE 1.106.0
30979
+ *
30980
+ * Flag if statistics are requested.
30981
+ *
30982
+ * Flag set by TechnicalInfo Popup will also be checked. So its active if set by URL parameter or manually
30983
+ * via TechnicalInfo.
30984
+ *
30985
+ * @returns Whether statistics are enabled
30986
+ */
30987
+ getStatisticsEnabled(): boolean;
30970
30988
  /**
30971
30989
  * Returns the theme name
30972
30990
  *
@@ -32308,6 +32326,30 @@ declare namespace sap {
32308
32326
  mSettings?: sap.ui.core.$ElementSettings
32309
32327
  );
32310
32328
 
32329
+ /**
32330
+ * @SINCE 1.106
32331
+ *
32332
+ * Returns the nearest [UI5 Element]{@link sap.ui.core.Element} that wraps the given DOM element.
32333
+ *
32334
+ * A DOM element or a CSS selector is accepted as a given parameter. When a CSS selector is given as parameter,
32335
+ * only the first DOM element that matches the CSS selector is taken to find the nearest UI5 Element that
32336
+ * wraps it. When no UI5 Element can be found, `undefined` is returned.
32337
+ *
32338
+ * @returns The UI5 Element that wraps the given DOM element. `undefined` is returned when no UI5 Element
32339
+ * can be found.
32340
+ */
32341
+ static closestTo(
32342
+ /**
32343
+ * A DOM Element or a CSS selector from which to start the search for the nearest UI5 Element by traversing
32344
+ * up the DOM tree
32345
+ */
32346
+ vParam: HTMLElement | string,
32347
+ /**
32348
+ * Whether the `data-sap-ui-related` attribute is also accepted as a selector for a UI5 Element, in addition
32349
+ * to `data-sap-ui`
32350
+ */
32351
+ bIncludeRelated?: boolean
32352
+ ): sap.ui.core.Element;
32311
32353
  /**
32312
32354
  * @deprecated (since 1.3.1) - Use the static `extend` method of the desired base class (e.g. {@link sap.ui.core.Element.extend})
32313
32355
  *
@@ -32821,7 +32863,7 @@ declare namespace sap {
32821
32863
  * Name of the model or `undefined`
32822
32864
  */
32823
32865
  sModelName?: string
32824
- ): sap.ui.model.ContextBinding;
32866
+ ): sap.ui.model.ContextBinding | undefined;
32825
32867
  /**
32826
32868
  * Returns the DOM Element that should get the focus or `null` if there's no such element currently.
32827
32869
  *
@@ -32872,9 +32914,9 @@ declare namespace sap {
32872
32914
  * text no matter where it comes from (be it a string tooltip or the text from a TooltipBase instance) then
32873
32915
  * they could call {@link #getTooltip_Text} instead.
32874
32916
  *
32875
- * @returns The tooltip for this Element.
32917
+ * @returns The tooltip for this Element or `null`.
32876
32918
  */
32877
- getTooltip(): string | sap.ui.core.TooltipBase;
32919
+ getTooltip(): string | sap.ui.core.TooltipBase | null;
32878
32920
  /**
32879
32921
  * Returns the tooltip for this element but only if it is a simple string. Otherwise, `undefined` is returned.
32880
32922
  *
@@ -32889,7 +32931,7 @@ declare namespace sap {
32889
32931
  *
32890
32932
  * @returns Text of the current tooltip or `undefined` or `null`
32891
32933
  */
32892
- getTooltip_Text(): string | undefined;
32934
+ getTooltip_Text(): string | undefined | null;
32893
32935
  /**
32894
32936
  * Checks for the provided `sap.ui.core.CustomData` in the aggregation {@link #getCustomData customData}.
32895
32937
  * and returns its index if found or -1 otherwise.
@@ -34420,7 +34462,7 @@ declare namespace sap {
34420
34462
  * The ariaLabelledBy to be removed or its index or ID
34421
34463
  */
34422
34464
  vAriaLabelledBy: int | sap.ui.core.ID | sap.ui.core.Control
34423
- ): sap.ui.core.ID;
34465
+ ): sap.ui.core.ID | null;
34424
34466
  /**
34425
34467
  * Sets a new value for property {@link #getActiveBackgroundColor activeBackgroundColor}.
34426
34468
  *
@@ -35854,7 +35896,7 @@ declare namespace sap {
35854
35896
  * @returns the map of all currency symbols available in this locale, e.g. { "AUD": "A$", "BRL": "R$", "EUR":
35855
35897
  * "€", "GBP": "£", }
35856
35898
  */
35857
- getCurrencySymbols(): object;
35899
+ getCurrencySymbols(): Record<string, string>;
35858
35900
  /**
35859
35901
  * @SINCE 1.34
35860
35902
  *
@@ -36120,7 +36162,7 @@ declare namespace sap {
36120
36162
  *
36121
36163
  * @returns map of locale specific language names
36122
36164
  */
36123
- getLanguages(): object;
36165
+ getLanguages(): Record<string, string>;
36124
36166
  /**
36125
36167
  * Get lenient number symbols for "plusSign" or "minusSign".
36126
36168
  *
@@ -36497,13 +36539,13 @@ declare namespace sap {
36497
36539
  *
36498
36540
  * @returns map of locale specific script names
36499
36541
  */
36500
- getScripts(): object;
36542
+ getScripts(): Record<string, string>;
36501
36543
  /**
36502
36544
  * Get locale specific territory names.
36503
36545
  *
36504
36546
  * @returns map of locale specific territory names
36505
36547
  */
36506
- getTerritories(): object;
36548
+ getTerritories(): Record<string, string>;
36507
36549
  /**
36508
36550
  * Get time pattern in style "short", "medium", "long" or "full".
36509
36551
  *
@@ -39707,8 +39749,8 @@ declare namespace sap {
39707
39749
  /**
39708
39750
  * Map of logging flags keyed by event types
39709
39751
  */
39710
- mEventTypes?: object
39711
- ): object;
39752
+ mEventTypes?: Record<string, boolean>
39753
+ ): Record<string, boolean>;
39712
39754
  /**
39713
39755
  * Creates a new subclass of class sap.ui.core.UIArea with name `sClassName` and enriches it with the information
39714
39756
  * contained in `oClassInfo`.
@@ -39984,7 +40026,7 @@ declare namespace sap {
39984
40026
  /**
39985
40027
  * the hosting DOM node for this instance of `UIArea`.
39986
40028
  */
39987
- oRootNode: object
40029
+ oRootNode: /* was Element */ global_Element
39988
40030
  ): void;
39989
40031
  /**
39990
40032
  * Un-Locks this instance of UIArea.
@@ -40106,7 +40148,7 @@ declare namespace sap {
40106
40148
  * Component local ID of the element
40107
40149
  */
40108
40150
  sId: string
40109
- ): sap.ui.core.Element;
40151
+ ): sap.ui.core.Element | undefined;
40110
40152
  /**
40111
40153
  * Hook method to create the content (UI Control Tree) of this component.
40112
40154
  *
@@ -40185,7 +40227,7 @@ declare namespace sap {
40185
40227
  * Prefixed ID
40186
40228
  */
40187
40229
  sId: string
40188
- ): string;
40230
+ ): string | null;
40189
40231
  /**
40190
40232
  * @SINCE 1.44.0
40191
40233
  *
@@ -40617,7 +40659,7 @@ declare namespace sap {
40617
40659
  * XMLComposite-local ID of the inner element
40618
40660
  */
40619
40661
  sId: string
40620
- ): sap.ui.core.Element;
40662
+ ): sap.ui.core.Element | undefined;
40621
40663
  /**
40622
40664
  * This method is a hook for the RenderManager that gets called during the rendering of child Controls.
40623
40665
  * It allows to add, remove and update existing accessibility attributes (ARIA) of those controls.
@@ -44591,7 +44633,7 @@ declare namespace sap {
44591
44633
  * The context which will be used to retrieve the property
44592
44634
  */
44593
44635
  oContext?: sap.ui.model.Context
44594
- ): any;
44636
+ ): any | null | undefined;
44595
44637
  /**
44596
44638
  * Load JSON-encoded data from the server using a GET HTTP request and store the resulting JSON data in
44597
44639
  * the model. Note: Due to browser security restrictions, most "Ajax" requests are subject to the same origin
@@ -47795,7 +47837,7 @@ declare namespace sap {
47795
47837
  * with the `bDeleteCreatedEntities` parameter set to `true`, the promise rejects with an object `oError`
47796
47838
  * containing the error information, where `oError.aborted === true`.
47797
47839
  */
47798
- created(): Promise<any>;
47840
+ created(): Promise<any | undefined> | undefined;
47799
47841
  /**
47800
47842
  * @SINCE 1.101
47801
47843
  *
@@ -47828,7 +47870,7 @@ declare namespace sap {
47828
47870
  */
47829
47871
  refreshAfterChange?: boolean;
47830
47872
  }
47831
- ): Promise<any>;
47873
+ ): Promise<undefined>;
47832
47874
  /**
47833
47875
  * @SINCE 1.98.0
47834
47876
  *
@@ -47860,7 +47902,7 @@ declare namespace sap {
47860
47902
  * inline creation rows, and
47861
47903
  * - `undefined`: otherwise
47862
47904
  */
47863
- isTransient(): boolean;
47905
+ isTransient(): boolean | undefined;
47864
47906
  }
47865
47907
  /**
47866
47908
  * @SINCE 1.37.0
@@ -48479,7 +48521,7 @@ declare namespace sap {
48479
48521
  *
48480
48522
  * @returns The context object used by this context binding or `null`
48481
48523
  */
48482
- getBoundContext(): sap.ui.model.odata.v2.Context;
48524
+ getBoundContext(): sap.ui.model.odata.v2.Context | null;
48483
48525
  /**
48484
48526
  * See:
48485
48527
  * sap.ui.model.ContextBinding.prototype.refresh
@@ -49011,7 +49053,7 @@ declare namespace sap {
49011
49053
  * is considered. If no callback function is given, all messages are considered.
49012
49054
  */
49013
49055
  fnFilter?: (p1: sap.ui.core.message.Message) => boolean
49014
- ): Promise<sap.ui.model.Filter>;
49056
+ ): Promise<sap.ui.model.Filter | null>;
49015
49057
  /**
49016
49058
  * Sorts the list.
49017
49059
  *
@@ -50672,7 +50714,7 @@ declare namespace sap {
50672
50714
  * The entity data
50673
50715
  */
50674
50716
  oEntity?: object
50675
- ): string;
50717
+ ): string | null;
50676
50718
  /**
50677
50719
  * Returns all headers and custom headers which are stored in this OData model.
50678
50720
  *
@@ -50690,7 +50732,7 @@ declare namespace sap {
50690
50732
  * The canonical entry URI, the context or entry object
50691
50733
  */
50692
50734
  vValue: string | object | sap.ui.model.Context
50693
- ): string;
50735
+ ): string | undefined;
50694
50736
  /**
50695
50737
  * @SINCE 1.76.0
50696
50738
  *
@@ -50769,7 +50811,7 @@ declare namespace sap {
50769
50811
  */
50770
50812
  expand?: string;
50771
50813
  }
50772
- ): any;
50814
+ ): any | undefined;
50773
50815
  /**
50774
50816
  * Returns the original value for the property with the given path and context. The original value is the
50775
50817
  * value that was last responded by the server.
@@ -51803,8 +51845,7 @@ declare namespace sap {
51803
51845
  /**
51804
51846
  * @SINCE 1.43.0
51805
51847
  *
51806
- * A collection of methods which help to consume
51807
- * OData V4 annotations in XML template views. Every context argument must belong to a {@link sap.ui.model.odata.v4.ODataMetaModel}
51848
+ * A collection of methods which help to consume OData V4 annotations in XML template views. Every context argument must belong to a {@link sap.ui.model.odata.v4.ODataMetaModel}
51808
51849
  * instance.
51809
51850
  */
51810
51851
  interface AnnotationHelper {
@@ -52388,8 +52429,7 @@ declare namespace sap {
52388
52429
  *
52389
52430
  * Formats the given OData value into a literal suitable for usage in data binding paths and URLs.
52390
52431
  *
52391
- * @returns The literal according to "OData Version 4.0 Part 2: URL Conventions" section "5.1.1.6.1 Primitive
52392
- * Literals"
52432
+ * @returns The literal according to "OData Version 4.0 Part 2: URL Conventions" section "5.1.1.11.1 Primitive Literals"
52393
52433
  */
52394
52434
  formatLiteral(
52395
52435
  /**
@@ -52523,7 +52563,7 @@ declare namespace sap {
52523
52563
  * It is rejected with an `Error` instance without `oError.canceled` if loading of $metadata fails. Returns
52524
52564
  * `undefined` if the context has not been created using {@link sap.ui.model.odata.v4.ODataListBinding#create}.
52525
52565
  */
52526
- created(): Promise<any>;
52566
+ created(): Promise<void> | undefined;
52527
52567
  /**
52528
52568
  * @SINCE 1.41.0
52529
52569
  *
@@ -52606,12 +52646,13 @@ declare namespace sap {
52606
52646
  /**
52607
52647
  * @SINCE 1.39.0
52608
52648
  *
52609
- * Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the
52610
- * specification "OData Version 4.0 Part 2: URL Conventions", this is the "name of the entity set associated
52611
- * with the entity followed by the key predicate identifying the entity within the collection". Use the
52612
- * canonical path in {@link sap.ui.core.Element#bindElement} to create an element binding. Note: For a transient
52613
- * context (see {@link #isTransient}) a wrong path is returned unless all key properties are available within
52614
- * the initial data.
52649
+ * Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is
52650
+ * the "name of the entity set associated with the entity followed by the key predicate identifying the
52651
+ * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create
52652
+ * an element binding.
52653
+ *
52654
+ * Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all key properties
52655
+ * are available within the initial data.
52615
52656
  *
52616
52657
  * @returns The canonical path (e.g. "/SalesOrderList('0500000000')")
52617
52658
  */
@@ -52633,8 +52674,8 @@ declare namespace sap {
52633
52674
  * representing a created entity is deleted again.
52634
52675
  *
52635
52676
  * @returns The context's index within the binding's collection. It is `undefined` if
52636
- * it does not belong to a list binding, it is kept alive (see {@link #isKeepAlive}), but not in
52637
- * the collection currently.
52677
+ * it does not belong to a list binding, it is {@link #isKeepAlive kept alive}, but not in the collection
52678
+ * currently.
52638
52679
  */
52639
52680
  getIndex(): number | undefined;
52640
52681
  /**
@@ -52642,7 +52683,7 @@ declare namespace sap {
52642
52683
  *
52643
52684
  * Returns the value for the given path relative to this context. The function allows access to the complete
52644
52685
  * data the context points to (if `sPath` is "") or any part thereof. The data is a JSON structure as described
52645
- * in "OData
52686
+ * in "OData
52646
52687
  * JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.ODataPropertyBinding#setValue}.
52647
52688
  *
52648
52689
  * Returns `undefined` if the data is not (yet) available; no request is triggered. Use {@link #requestObject}
@@ -52698,14 +52739,14 @@ declare namespace sap {
52698
52739
  *
52699
52740
  * Returns whether there are pending changes for bindings dependent on this context, or for unresolved bindings
52700
52741
  * (see {@link sap.ui.model.Binding#isResolved}) which were dependent on this context at the time the pending
52701
- * change was created. This includes the context itself being {@link #isTransient transient}. Since 1.98.0,
52702
- * {@link #isInactive inactive} contexts are ignored.
52742
+ * change was created. This includes the context itself being {@link #isTransient transient} or {@link #isDeleted
52743
+ * deleted}. Since 1.98.0, {@link #isInactive inactive} contexts are ignored.
52703
52744
  *
52704
52745
  * @returns Whether there are pending changes
52705
52746
  */
52706
52747
  hasPendingChanges(): boolean;
52707
52748
  /**
52708
- * @SINCE 1.105
52749
+ * @SINCE 1.105.0
52709
52750
  *
52710
52751
  * Returns whether this context is deleted on the client, but not on the server yet. The result of this
52711
52752
  * function can also be accessed via the "@$ui5.context.isDeleted" instance annotation at the entity.
@@ -52740,11 +52781,12 @@ declare namespace sap {
52740
52781
  * @returns `true` if this context is inactive, `false` if it was created in an inactive state and has been
52741
52782
  * activated, and `undefined` otherwise.
52742
52783
  */
52743
- isInactive(): boolean;
52784
+ isInactive(): boolean | undefined;
52744
52785
  /**
52745
52786
  * @SINCE 1.81.0
52746
52787
  *
52747
- * Returns whether this context is kept alive.
52788
+ * Returns whether this context is kept alive even when it is removed from its binding's collection, for
52789
+ * example if a filter is applied and the entity represented by this context does not match the filter criteria.
52748
52790
  * See:
52749
52791
  * #setKeepAlive
52750
52792
  *
@@ -52764,7 +52806,7 @@ declare namespace sap {
52764
52806
  * @returns Whether this context is transient if it is created using {@link sap.ui.model.odata.v4.ODataListBinding#create};
52765
52807
  * `undefined` if it is not created using {@link sap.ui.model.odata.v4.ODataListBinding#create}
52766
52808
  */
52767
- isTransient(): boolean;
52809
+ isTransient(): boolean | undefined;
52768
52810
  /**
52769
52811
  * @SINCE 1.53.0
52770
52812
  *
@@ -52783,7 +52825,7 @@ declare namespace sap {
52783
52825
  * {@link sap.ui.model.odata.v4.ODataListBinding#filter}; a removed context is destroyed, see {@link #destroy}.
52784
52826
  * If the context belongs to a context binding, the parameter must not be used. Supported since 1.55.0
52785
52827
  *
52786
- * Since 1.84.0, if this context is kept alive (see {@link #isKeepAlive}), it is only destroyed if the corresponding
52828
+ * Since 1.84.0, if this context is {@link #isKeepAlive kept alive}, it is only destroyed if the corresponding
52787
52829
  * entity does no longer exist in the back end. In this case, the `fnOnBeforeDestroy` callback passed with
52788
52830
  * {@link #setKeepAlive}) is called.
52789
52831
  */
@@ -52805,11 +52847,12 @@ declare namespace sap {
52805
52847
  /**
52806
52848
  * @SINCE 1.39.0
52807
52849
  *
52808
- * Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical
52809
- * URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is the "name of the entity
52810
- * set associated with the entity followed by the key predicate identifying the entity within the collection".
52811
- * Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element binding. Note:
52812
- * For a transient context (see {@link #isTransient}) a wrong path is returned unless all key properties
52850
+ * Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is
52851
+ * the "name of the entity set associated with the entity followed by the key predicate identifying the
52852
+ * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create
52853
+ * an element binding.
52854
+ *
52855
+ * Note: For a transient context (see {@link #isTransient}) a wrong path is returned unless all key properties
52813
52856
  * are available within the initial data.
52814
52857
  *
52815
52858
  * @returns A promise which is resolved with the canonical path (e.g. "/SalesOrderList('0500000000')") in
@@ -52822,8 +52865,7 @@ declare namespace sap {
52822
52865
  *
52823
52866
  * Returns a promise on the value for the given path relative to this context. The function allows access
52824
52867
  * to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON
52825
- * structure as described in
52826
- * "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
52868
+ * structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
52827
52869
  * sap.ui.model.odata.v4.Context#setProperty}.
52828
52870
  *
52829
52871
  * The header context of a list binding only delivers `$count` (wrapped in an object if `sPath` is "").
@@ -52954,7 +52996,7 @@ declare namespace sap {
52954
52996
  * are no pending changes for the affected properties.
52955
52997
  */
52956
52998
  sGroupId?: string
52957
- ): Promise<any>;
52999
+ ): Promise<undefined>;
52958
53000
  /**
52959
53001
  * @SINCE 1.81.0
52960
53002
  *
@@ -53045,7 +53087,14 @@ declare namespace sap {
53045
53087
  /**
53046
53088
  * @SINCE 1.39.0
53047
53089
  *
53048
- * Returns a string representation of this object including the binding path.
53090
+ * Returns a string representation of this object including the {@link #getPath binding path), {@link #getIndex
53091
+ * index}, and state (see also "Context states" of {@link topic:c9723f8265f644af91c0ed941e114d46 Creating
53092
+ * an Entity}).
53093
+ * See:
53094
+ * #destroy
53095
+ * #isDeleted
53096
+ * #isInactive
53097
+ * #isTransient
53049
53098
  *
53050
53099
  * @returns A string description of this binding
53051
53100
  */
@@ -53255,7 +53304,8 @@ declare namespace sap {
53255
53304
  * A return value context is a {@link sap.ui.model.odata.v4.Context} which represents a bound operation
53256
53305
  * response. It is created only if the operation is bound and has a single entity return value from the
53257
53306
  * same entity set as the operation's binding parameter and has a parent context which is a {@link sap.ui.model.odata.v4.Context}
53258
- * and points to an entity from an entity set.
53307
+ * and points to an entity from an entity set. It is destroyed the next time this operation binding is executed
53308
+ * again!
53259
53309
  * If a return value context is created, it must be used instead of `this.getBoundContext()`. All bound
53260
53310
  * messages will be related to the return value context only. Such a message can only be connected to a
53261
53311
  * corresponding control if the control's property bindings use the return value context as binding context.
@@ -53284,14 +53334,15 @@ declare namespace sap {
53284
53334
  fnOnStrictHandlingFailed?: Function,
53285
53335
  /**
53286
53336
  * Whether this operation binding's parent context, which must belong to a list binding, is replaced with
53287
- * the operation's return value context (see below) and that list context is returned instead. The list
53337
+ * the operation's return value context (see below) and that list context is returned instead. That list
53288
53338
  * context may be a newly created context or an existing context. A newly created context has the same `keepAlive`
53289
53339
  * attribute and `fnOnBeforeDestroy` function as the parent context, see {@link sap.ui.model.odata.v4.Context#setKeepAlive};
53290
53340
  * `fnOnBeforeDestroy` will be called with the new context instance as the only argument in this case. An
53291
53341
  * existing context does not change its `keepAlive` attribute. In any case, the resulting context takes
53292
- * the place (index, position) of the parent context {@link sap.ui.model.odata.v4.Context#getIndex}. If
53293
- * the parent context has requested messages when it was kept alive, they will be inherited if the $$inheritExpandSelect
53294
- * binding parameter is set to `true`. Since 1.97.0.
53342
+ * the place (index, position) of the parent context (see {@link sap.ui.model.odata.v4.Context#getIndex}),
53343
+ * which need not be in the collection currently if it is {@link sap.ui.model.odata.v4.Context#isKeepAlive
53344
+ * kept alive}. If the parent context has requested messages when it was kept alive, they will be inherited
53345
+ * if the $$inheritExpandSelect binding parameter is set to `true`. Since 1.97.0.
53295
53346
  */
53296
53347
  bReplaceWithRVC?: boolean
53297
53348
  ): Promise<any>;
@@ -53326,7 +53377,7 @@ declare namespace sap {
53326
53377
  /**
53327
53378
  * @SINCE 1.53.0
53328
53379
  *
53329
- * Returns the root binding of this binding's hierarchy, see binding {@link topic:54e0ddf695af4a6c978472cecb01c64d
53380
+ * Returns the root binding of this binding's hierarchy, see {@link topic:fccfb2eb41414f0792c165e69a878717
53330
53381
  * Initialization and Read Requests}.
53331
53382
  *
53332
53383
  * @returns The root binding or `undefined` if this binding is unresolved (see {@link sap.ui.model.Binding#isResolved}).
@@ -53368,7 +53419,7 @@ declare namespace sap {
53368
53419
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
53369
53420
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
53370
53421
  * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
53371
- * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
53422
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context
53372
53423
  * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
53373
53424
  * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
53374
53425
  * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
@@ -53430,8 +53481,7 @@ declare namespace sap {
53430
53481
  *
53431
53482
  * Returns a promise on the value for the given path relative to this binding. The function allows access
53432
53483
  * to the complete data the binding points to (if `sPath` is "") or any part thereof. The data is a JSON
53433
- * structure as described in
53434
- * "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
53484
+ * structure as described in "OData JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link
53435
53485
  * sap.ui.model.odata.v4.Context#setProperty}.
53436
53486
  *
53437
53487
  * If you want {@link #requestObject} to read fresh data, call `oBinding.refresh()` first.
@@ -53446,7 +53496,7 @@ declare namespace sap {
53446
53496
  * A path relative to this context binding
53447
53497
  */
53448
53498
  sPath?: string
53449
- ): Promise<any>;
53499
+ ): Promise<any | undefined>;
53450
53500
  /**
53451
53501
  * @SINCE 1.87.0
53452
53502
  *
@@ -53505,7 +53555,7 @@ declare namespace sap {
53505
53555
  *
53506
53556
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
53507
53557
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
53508
- * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
53558
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive
53509
53559
  * kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
53510
53560
  * contexts of a {@link #getRootBinding root binding} do not count as pending changes.
53511
53561
  * See:
@@ -53893,9 +53943,9 @@ declare namespace sap {
53893
53943
  * Returns all current contexts of this list binding in no special order. Just like {@link #getCurrentContexts},
53894
53944
  * this method does not request any data from a back end and does not change the binding's state. In contrast
53895
53945
  * to {@link #getCurrentContexts}, it does not only return those contexts that were last requested by a
53896
- * control, but all contexts that are currently available in the binding, including kept-alive contexts.
53897
- * To filter out kept-alive contexts that are not part of the list, you could check whether the index is
53898
- * `undefined`, as described in {@link sap.ui.model.odata.v4.Context#getIndex}.
53946
+ * control, but all contexts that are currently available in the binding, including {@link sap.ui.model.odata.v4.Context#isKeepAlive
53947
+ * kept-alive} contexts. To filter out kept-alive contexts that are not part of the list, you could check
53948
+ * whether the index is `undefined`, as described in {@link sap.ui.model.odata.v4.Context#getIndex}.
53899
53949
  *
53900
53950
  * @returns All current contexts of this list binding, in no special order
53901
53951
  */
@@ -54019,7 +54069,7 @@ declare namespace sap {
54019
54069
  *
54020
54070
  * @returns The header context or `null` if the binding is relative and has no context
54021
54071
  */
54022
- getHeaderContext(): sap.ui.model.odata.v4.Context;
54072
+ getHeaderContext(): sap.ui.model.odata.v4.Context | null;
54023
54073
  /**
54024
54074
  * @SINCE 1.99.0
54025
54075
  *
@@ -54076,7 +54126,7 @@ declare namespace sap {
54076
54126
  /**
54077
54127
  * @SINCE 1.53.0
54078
54128
  *
54079
- * Returns the root binding of this binding's hierarchy, see binding {@link topic:54e0ddf695af4a6c978472cecb01c64d
54129
+ * Returns the root binding of this binding's hierarchy, see {@link topic:fccfb2eb41414f0792c165e69a878717
54080
54130
  * Initialization and Read Requests}.
54081
54131
  *
54082
54132
  * @returns The root binding or `undefined` if this binding is unresolved (see {@link sap.ui.model.Binding#isResolved}).
@@ -54118,7 +54168,7 @@ declare namespace sap {
54118
54168
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
54119
54169
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
54120
54170
  * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
54121
- * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
54171
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context
54122
54172
  * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
54123
54173
  * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
54124
54174
  * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
@@ -54264,7 +54314,7 @@ declare namespace sap {
54264
54314
  * is considered. If no callback function is given, all messages are considered.
54265
54315
  */
54266
54316
  fnFilter?: (p1: sap.ui.core.message.Message) => boolean
54267
- ): Promise<sap.ui.model.Filter>;
54317
+ ): Promise<sap.ui.model.Filter | null>;
54268
54318
  /**
54269
54319
  * @SINCE 1.87.0
54270
54320
  *
@@ -54362,12 +54412,12 @@ declare namespace sap {
54362
54412
  /**
54363
54413
  * The qualifier for the pair of "Org.OData.Aggregation.V1.RecursiveHierarchy" and "com.sap.vocabularies.Hierarchy.v1.RecursiveHierarchy"
54364
54414
  * annotations at this binding's entity type (@experimental as of version 1.105.0). If present, a recursive
54365
- * hierarchy without data aggregation is defined, and the only other supported property is `expandTo`.
54415
+ * hierarchy without data aggregation is defined, and the only other supported properties are `expandTo`
54416
+ * and `search`. A recursive hierarchy cannot be combined with "$search".
54366
54417
  */
54367
54418
  hierarchyQualifier?: string;
54368
54419
  /**
54369
- * Like the
54370
- * "5.1.7 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that
54420
+ * Like the "5.1.7 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that
54371
54421
  * certain content will break the syntax of the system query option `$apply` and result in an invalid request.
54372
54422
  * If the OData service supports the proposal ODATA-1452,
54373
54423
  * then `ODataUtils.formatLiteral(sSearch, "Edm.String");` should be used to encapsulate the whole search
@@ -54411,7 +54461,7 @@ declare namespace sap {
54411
54461
  *
54412
54462
  * Suspends this binding. A suspended binding does not fire change events nor does it trigger data service
54413
54463
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
54414
- * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive
54464
+ * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive
54415
54465
  * kept-alive} context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
54416
54466
  * contexts of a {@link #getRootBinding root binding} do not count as pending changes.
54417
54467
  * See:
@@ -54694,7 +54744,7 @@ declare namespace sap {
54694
54744
  * header is sent at all. Note that this map may change due to load-on-demand of "cross-service references"
54695
54745
  * (see parameter `supportReferences` of {@link sap.ui.model.odata.v4.ODataModel#constructor}).
54696
54746
  */
54697
- getETags(): object;
54747
+ getETags(): Record<string, string | null>;
54698
54748
  /**
54699
54749
  * @SINCE 1.47.0
54700
54750
  * @deprecated (since 1.51.0) - use {@link #getETags} instead because modifications to old files may be
@@ -54765,7 +54815,7 @@ declare namespace sap {
54765
54815
  */
54766
54816
  scope?: object;
54767
54817
  }
54768
- ): any;
54818
+ ): any | undefined;
54769
54819
  /**
54770
54820
  * @SINCE 1.37.0
54771
54821
  *
@@ -54863,7 +54913,16 @@ declare namespace sap {
54863
54913
  */
54864
54914
  context?: sap.ui.model.Context;
54865
54915
  }
54866
- ): Promise<any>;
54916
+ ): Promise<Record<
54917
+ string,
54918
+ {
54919
+ StandardCode: string;
54920
+
54921
+ Text: string;
54922
+
54923
+ UnitSpecificScale: string;
54924
+ }
54925
+ > | null>;
54867
54926
  /**
54868
54927
  * @SINCE 1.59.0
54869
54928
  *
@@ -54909,9 +54968,8 @@ declare namespace sap {
54909
54968
  * ```
54910
54969
  *
54911
54970
  *
54912
- * The basic idea is that every path described in "14.2.1 Attribute Target" in specification "OData Version
54913
- * 4.0 Part 3: Common Schema Definition Language" is a valid absolute path within the metadata model if
54914
- * a leading slash is added; for example "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty".
54971
+ * The basic idea is that every path described in "14.2.1 Attribute Target" in specification "OData Version 4.0 Part 3: Common Schema Definition Language"
54972
+ * is a valid absolute path within the metadata model if a leading slash is added; for example "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty".
54915
54973
  * Also, every path described in "14.5.2 Expression edm:AnnotationPath", "14.5.11 Expression edm:NavigationPropertyPath",
54916
54974
  * "14.5.12 Expression edm:Path", and "14.5.13 Expression edm:PropertyPath" is a valid relative path within
54917
54975
  * the metadata model if a suitable prefix is added which addresses an entity container, entity set, singleton,
@@ -54967,8 +55025,8 @@ declare namespace sap {
54967
55025
  * itself. In a similar way, annotations of "7.2 Element edm:ReferentialConstraint", "7.3 Element edm:OnDelete",
54968
55026
  * "10.2 Element edm:Member" and "14.5.14.2 Element edm:PropertyValue" are addressed by segments like "<7.2.1
54969
55027
  * Attribute Property>@...", "$OnDelete@...", "<10.2.1 Attribute Name>@..." and "<14.5.14.2.1 Attribute
54970
- * Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData
54971
- * Version 4.0 Part 3: Common Schema Definition Language").
55028
+ * Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData Version 4.0 Part 3:
55029
+ * Common Schema Definition Language").
54972
55030
  *
54973
55031
  * Annotations starting with "@@", for example "@@sap.ui.model.odata.v4.AnnotationHelper.isMultiple" or
54974
55032
  * "@@.AH.isMultiple" or "@@.isMultiple", represent computed annotations. Their name without the "@@" prefix
@@ -55143,7 +55201,16 @@ declare namespace sap {
55143
55201
  */
55144
55202
  context?: sap.ui.model.Context;
55145
55203
  }
55146
- ): Promise<any>;
55204
+ ): Promise<Record<
55205
+ string,
55206
+ {
55207
+ StandardCode: string;
55208
+
55209
+ Text: string;
55210
+
55211
+ UnitSpecificScale: string;
55212
+ }
55213
+ > | null>;
55147
55214
  /**
55148
55215
  * @SINCE 1.45.0
55149
55216
  *
@@ -55234,12 +55301,11 @@ declare namespace sap {
55234
55301
  *
55235
55302
  * This model is not prepared to be inherited from.
55236
55303
  *
55237
- * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path"
55238
- * in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding path within this
55239
- * model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to access an entity
55240
- * instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the example of {@link
55241
- * sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an operation binding,
55242
- * see {@link sap.ui.model.odata.v4.ODataContextBinding}.
55304
+ * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding
55305
+ * path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to
55306
+ * access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the
55307
+ * example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
55308
+ * operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
55243
55309
  *
55244
55310
  * Note that the OData V4 model has its own {@link sap.ui.model.odata.v4.Context} class. Bindings which
55245
55311
  * are relative to such a V4 context depend on their corresponding parent binding and do not access data
@@ -55325,8 +55391,8 @@ declare namespace sap {
55325
55391
  * Root URL of the service to request data from. The path part of the URL must end with a forward slash
55326
55392
  * according to OData V4 specification ABNF, rule "serviceRoot". You may append OData custom query options
55327
55393
  * to the service root URL separated with a "?", for example "/MyService/?custom=foo". See specification
55328
- * "OData Version 4.0 Part 2: URL Conventions", "5.2 Custom Query Options". OData system query options and
55329
- * OData parameter aliases lead to an error.
55394
+ * "OData Version 4.0 Part 2: URL Conventions", "5.2 Custom Query Options". OData system query options
55395
+ * and OData parameter aliases lead to an error.
55330
55396
  */
55331
55397
  serviceUrl: string;
55332
55398
  /**
@@ -55385,6 +55451,40 @@ declare namespace sap {
55385
55451
  * @returns Metadata object describing this class
55386
55452
  */
55387
55453
  static getMetadata(): sap.ui.base.Metadata;
55454
+ /**
55455
+ * @SINCE 1.105.0
55456
+ *
55457
+ * Attach event handler `fnFunction` to the 'dataReceived' event of this binding.
55458
+ *
55459
+ * @returns `this` to allow method chaining
55460
+ */
55461
+ attachDataReceived(
55462
+ /**
55463
+ * The function to call when the event occurs
55464
+ */
55465
+ fnFunction: Function,
55466
+ /**
55467
+ * Object on which to call the given function
55468
+ */
55469
+ oListener?: object
55470
+ ): this;
55471
+ /**
55472
+ * @SINCE 1.106.0
55473
+ *
55474
+ * Attach event handler `fnFunction` to the 'dataRequested' event of this binding.
55475
+ *
55476
+ * @returns `this` to allow method chaining
55477
+ */
55478
+ attachDataRequested(
55479
+ /**
55480
+ * The function to call when the event occurs
55481
+ */
55482
+ fnFunction: Function,
55483
+ /**
55484
+ * Object on which to call the given function
55485
+ */
55486
+ oListener?: object
55487
+ ): this;
55388
55488
  /**
55389
55489
  * @SINCE 1.37.0
55390
55490
  *
@@ -55442,10 +55542,10 @@ declare namespace sap {
55442
55542
  */
55443
55543
  oContext?: sap.ui.model.odata.v4.Context,
55444
55544
  /**
55445
- * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
55446
- * URL Conventions" or the binding-specific parameters as specified below. Note: The binding creates its
55447
- * own data service request if it is absolute or if it has any parameters or if it is relative and has a
55448
- * context created via {@link #createBindingContext}. The following OData query options are allowed:
55545
+ * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters as specified below.
55546
+ * Note: The binding creates its own data service request if it is absolute or if it has any parameters
55547
+ * or if it is relative and has a context created via {@link #createBindingContext}. The following OData
55548
+ * query options are allowed:
55449
55549
  * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
55450
55550
  * "sap-valid-") The $count, $expand, $filter, $levels, $orderby, $search and $select "5.1 System Query
55451
55551
  * Options"; OData V4 only allows $count, $filter, $levels, $orderby and $search inside resource paths that
@@ -55453,6 +55553,22 @@ declare namespace sap {
55453
55553
  * query options lead to an error. Query options specified for the binding overwrite model query options.
55454
55554
  */
55455
55555
  mParameters?: {
55556
+ /**
55557
+ * The value for the "5.1.2 System Query Option $expand" or an object which determines that value. The object
55558
+ * is a map from expand path to expand options, where the options are again maps of system query options,
55559
+ * typically with string values. $count can also be given as a `boolean` value, $expand can recursively
55560
+ * be given as a map, $levels can also be given as a `number` value, and $select can also be given as an
55561
+ * array (but without navigation paths). An empty map can also be given as `null` or `true`. See also {@link
55562
+ * topic:1ab4f62de6ab467096a2a98b363a1373 Parameters}.
55563
+ */
55564
+ $expand?: string | object;
55565
+ /**
55566
+ * A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option
55567
+ * $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link sap.ui.model.odata.v4.ODataModel#constructor}),
55568
+ * paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option
55569
+ * $expand".
55570
+ */
55571
+ $select?: string | string[];
55456
55572
  /**
55457
55573
  * Whether a binding relative to a {@link sap.ui.model.odata.v4.Context} uses the canonical path computed
55458
55574
  * from its context's path for data service requests; only the value `true` is allowed.
@@ -55521,17 +55637,54 @@ declare namespace sap {
55521
55637
  */
55522
55638
  vFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
55523
55639
  /**
55524
- * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
55525
- * URL Conventions" or binding-specific parameters as specified below. Note: The binding creates its own
55526
- * data service request if it is absolute or if it has any parameters or if it is relative and has a context
55527
- * created via {@link #createBindingContext} or if it has sorters or filters. The following OData query
55528
- * options are allowed:
55640
+ * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or binding-specific parameters as specified below. Note:
55641
+ * The binding creates its own data service request if it is absolute or if it has any parameters or if
55642
+ * it is relative and has a context created via {@link #createBindingContext} or if it has sorters or filters.
55643
+ * The following OData query options are allowed:
55529
55644
  * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
55530
55645
  * "sap-valid-") The $apply, $count, $expand, $filter, $levels, $orderby, $search, and $select "5.1
55531
- * System Query Options" All other query options lead to an error. Query options specified for the
55532
- * binding overwrite model query options.
55646
+ * System Query Options"; OData V4 only allows $levels inside $expand. All other query options lead
55647
+ * to an error. Query options specified for the binding overwrite model query options.
55533
55648
  */
55534
55649
  mParameters?: {
55650
+ /**
55651
+ * The value for the "3 System Query Option $apply" (see also OData
55652
+ * Extension for Data Aggregation Version 4.0) as an alternative to `$$aggregation`
55653
+ */
55654
+ $apply?: string;
55655
+ /**
55656
+ * The value for the "5.1.6 System Query Option $count", useful for creation at the end and {@link sap.ui.model.odata.v4.ODataListBinding#getCount}
55657
+ */
55658
+ $count?: string | boolean;
55659
+ /**
55660
+ * The value for the "5.1.2 System Query Option $expand" or an object which determines that value. The object
55661
+ * is a map from expand path to expand options, where the options are again maps of system query options,
55662
+ * typically with string values. $count can also be given as a `boolean` value, $expand can recursively
55663
+ * be given as a map, $levels can also be given as a `number` value, and $select can also be given as an
55664
+ * array (but without navigation paths). An empty map can also be given as `null` or `true`. See also {@link
55665
+ * topic:1ab4f62de6ab467096a2a98b363a1373 Parameters}.
55666
+ */
55667
+ $expand?: string | object;
55668
+ /**
55669
+ * The value for the "5.1.1 System Query Option $filter" used in addition to `vFilters`
55670
+ */
55671
+ $filter?: string;
55672
+ /**
55673
+ * The value for the "5.1.4 System Query Option $orderby" used in addition to `vSorters`
55674
+ */
55675
+ $orderby?: string | number;
55676
+ /**
55677
+ * The value for the "5.1.7 System Query Option $search"; see also `oAggregation.search` at {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}
55678
+ * and the note there!
55679
+ */
55680
+ $search?: string;
55681
+ /**
55682
+ * A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option
55683
+ * $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link sap.ui.model.odata.v4.ODataModel#constructor}),
55684
+ * paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option
55685
+ * $expand".
55686
+ */
55687
+ $select?: string | string[];
55535
55688
  /**
55536
55689
  * An object holding the information needed for data aggregation, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}
55537
55690
  * for details.
@@ -55630,9 +55783,8 @@ declare namespace sap {
55630
55783
  */
55631
55784
  oContext?: sap.ui.model.Context,
55632
55785
  /**
55633
- * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2:
55634
- * URL Conventions" or the binding-specific parameters as specified below. The following OData query options
55635
- * are allowed:
55786
+ * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters as specified below.
55787
+ * The following OData query options are allowed:
55636
55788
  * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with
55637
55789
  * "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with
55638
55790
  * a "$count" segment. All other query options lead to an error. Query options specified for the binding
@@ -55641,6 +55793,19 @@ declare namespace sap {
55641
55793
  * ignored in case the binding creates no own data service request or in case the binding points to metadata.
55642
55794
  */
55643
55795
  mParameters?: {
55796
+ /**
55797
+ * The value for the "3 System Query Option $apply" (see also OData
55798
+ * Extension for Data Aggregation Version 4.0), if the path ends with a "$count" segment
55799
+ */
55800
+ $apply?: string;
55801
+ /**
55802
+ * The value for the "5.1.1 System Query Option $filter", if the path ends with a "$count" segment
55803
+ */
55804
+ $filter?: string;
55805
+ /**
55806
+ * The value for the "5.1.7 System Query Option $search", if the path ends with a "$count" segment
55807
+ */
55808
+ $search?: string;
55644
55809
  /**
55645
55810
  * The group ID to be used for **read** requests triggered by this binding; if not specified, either the
55646
55811
  * parent binding's group ID (if the binding is relative) or the model's group ID is used, see {@link sap.ui.model.odata.v4.ODataModel#constructor}.
@@ -55693,10 +55858,10 @@ declare namespace sap {
55693
55858
  * requests within the batch. The headers are changed according to the given map of headers: Headers with
55694
55859
  * an `undefined` value are removed, the other headers are set, and missing headers remain unchanged. The
55695
55860
  * following headers must not be used:
55696
- * OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification
55697
- * "OData Version 4.0 Part 1: Protocol" OData V2 request headers as specified in "2.2.5 HTTP Header
55698
- * Fields" of the specification "OData Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding"
55699
- * The header "SAP-ContextId" Note: The "X-CSRF-Token" header will not be used for metadata requests.
55861
+ * OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification "OData Version 4.0 Part 1: Protocol"
55862
+ * OData V2 request headers as specified in "2.2.5 HTTP Header Fields" of the specification "OData
55863
+ * Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding" The header "SAP-ContextId"
55864
+ * Note: The "X-CSRF-Token" header will not be used for metadata requests.
55700
55865
  *
55701
55866
  * If not `undefined`, a header value must conform to the following rules:
55702
55867
  * It must be a non-empty string. It must be completely in the US-ASCII character set. It must
@@ -55796,6 +55961,40 @@ declare namespace sap {
55796
55961
  * Method not supported
55797
55962
  */
55798
55963
  destroyBindingContext(): void;
55964
+ /**
55965
+ * @SINCE 1.105.0
55966
+ *
55967
+ * Detach event handler `fnFunction` from the 'dataReceived' event of this model.
55968
+ *
55969
+ * @returns `this` to allow method chaining
55970
+ */
55971
+ detachDataReceived(
55972
+ /**
55973
+ * The function to call when the event occurs
55974
+ */
55975
+ fnFunction: Function,
55976
+ /**
55977
+ * Object on which to call the given function
55978
+ */
55979
+ oListener?: object
55980
+ ): this;
55981
+ /**
55982
+ * @SINCE 1.106.0
55983
+ *
55984
+ * Detach event handler `fnFunction` from the 'dataRequested' event of this model.
55985
+ *
55986
+ * @returns `this` to allow method chaining
55987
+ */
55988
+ detachDataRequested(
55989
+ /**
55990
+ * The function to call when the event occurs
55991
+ */
55992
+ fnFunction: Function,
55993
+ /**
55994
+ * Object on which to call the given function
55995
+ */
55996
+ oListener?: object
55997
+ ): this;
55799
55998
  /**
55800
55999
  * @SINCE 1.66.0
55801
56000
  *
@@ -56010,10 +56209,10 @@ declare namespace sap {
56010
56209
  * @SINCE 1.37.0
56011
56210
  * @deprecated (since 1.39.0) - Use {@link sap.ui.model.odata.v4.Context#requestCanonicalPath} instead.
56012
56211
  *
56013
- * Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1 Canonical
56014
- * URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is the "name of the entity
56015
- * set associated with the entity followed by the key predicate identifying the entity within the collection".
56016
- * Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element binding.
56212
+ * Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is
56213
+ * the "name of the entity set associated with the entity followed by the key predicate identifying the
56214
+ * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create
56215
+ * an element binding.
56017
56216
  *
56018
56217
  * @returns A promise which is resolved with the canonical path (e.g. "/SalesOrderList('0500000000')") in
56019
56218
  * case of success, or rejected with an instance of `Error` in case of failure, e.g. when the given context
@@ -56066,7 +56265,7 @@ declare namespace sap {
56066
56265
  * A valid group ID as specified in {@link sap.ui.model.odata.v4.ODataModel}.
56067
56266
  */
56068
56267
  sGroupId: string
56069
- ): Promise<any>;
56268
+ ): Promise<undefined>;
56070
56269
  /**
56071
56270
  * @SINCE 1.37.0
56072
56271
  *
@@ -56162,7 +56361,7 @@ declare namespace sap {
56162
56361
  /**
56163
56362
  * @SINCE 1.53.0
56164
56363
  *
56165
- * Returns the root binding of this binding's hierarchy, see binding {@link topic:54e0ddf695af4a6c978472cecb01c64d
56364
+ * Returns the root binding of this binding's hierarchy, see {@link topic:fccfb2eb41414f0792c165e69a878717
56166
56365
  * Initialization and Read Requests}.
56167
56366
  *
56168
56367
  * @returns The root binding or `undefined` if this binding is unresolved (see {@link sap.ui.model.Binding#isResolved}).
@@ -56222,7 +56421,7 @@ declare namespace sap {
56222
56421
  * Whether to ignore changes which will not be lost by APIs like {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters
56223
56422
  * changeParameters}, {@link sap.ui.model.odata.v4.ODataListBinding#filter filter}, {@link sap.ui.model.odata.v4.ODataListBinding#refresh
56224
56423
  * refresh} (since 1.100.0), {@link sap.ui.model.odata.v4.ODataListBinding#sort sort}, or {@link sap.ui.model.odata.v4.ODataListBinding#suspend
56225
- * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#setKeepAlive kept-alive} context
56424
+ * suspend} because they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive} context
56226
56425
  * of this binding (since 1.97.0). Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient}
56227
56426
  * contexts of a {@link #getRootBinding root binding} are treated as kept-alive by this flag. Since 1.99.0,
56228
56427
  * the same happens for bindings using the `$$ownRequest` parameter (see {@link sap.ui.model.odata.v4.ODataModel#bindList}).
@@ -56293,7 +56492,7 @@ declare namespace sap {
56293
56492
  * @returns A promise resolving with the resulting value or `undefined` if it could not be determined, or
56294
56493
  * rejecting in case of an error
56295
56494
  */
56296
- requestValue(): Promise<any>;
56495
+ requestValue(): Promise<any | undefined>;
56297
56496
  /**
56298
56497
  * @SINCE 1.45.0
56299
56498
  *
@@ -56659,7 +56858,7 @@ declare namespace sap {
56659
56858
  * type; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
56660
56859
  */
56661
56860
  oContext: sap.ui.model.Context
56662
- ): string;
56861
+ ): string | undefined;
56663
56862
  /**
56664
56863
  * Helper function for a `template:with` instruction that goes to the entity type with the qualified name
56665
56864
  * which `oContext` points at.
@@ -56682,7 +56881,7 @@ declare namespace sap {
56682
56881
  * sap.ui.model.odata.ODataMetaModel}
56683
56882
  */
56684
56883
  oContext: sap.ui.model.Context
56685
- ): string;
56884
+ ): string | undefined;
56686
56885
  /**
56687
56886
  * @SINCE 1.29.1
56688
56887
  *
@@ -56709,7 +56908,7 @@ declare namespace sap {
56709
56908
  * function import; the context's model must be an {@link sap.ui.model.odata.ODataMetaModel}
56710
56909
  */
56711
56910
  oContext: sap.ui.model.Context
56712
- ): string;
56911
+ ): string | undefined;
56713
56912
  /**
56714
56913
  * A formatter function to be used in a complex binding inside an XML template view in order to interpret
56715
56914
  * OData V4 annotations. It knows about the following dynamic expressions:
@@ -56771,7 +56970,7 @@ declare namespace sap {
56771
56970
  * be an {@link sap.ui.model.odata.ODataMetaModel}
56772
56971
  */
56773
56972
  oContext: sap.ui.model.Context
56774
- ): string;
56973
+ ): string | undefined;
56775
56974
  /**
56776
56975
  * Formatter function that is used in a complex binding inside an XML template view. The function is used
56777
56976
  * to interpret OData V4 annotations, supporting the same annotations as {@link #.format format} but with
@@ -57957,7 +58156,7 @@ declare namespace sap {
57957
58156
  * To avoid problems with changing indexes, {@link sap.ui.model.Model#getObject getObject} and {@link sap.ui.model.Model#getProperty
57958
58157
  * getProperty} support XPath-like queries for the indexes (since 1.29.1). Each index can be replaced by
57959
58158
  * a query in square brackets. You can, for example, address the schema using the path `/dataServices/schema/[${namespace}==='MySchema']`
57960
- * or the entity using `/dataServices/schema/[${namespace}==='MySchema']/entityType/[sap.ui.core==='Order']`.
58159
+ * or the entity using `/dataServices/schema/[${namespace}==='MySchema']/entityType/[${name}==='Order']`.
57961
58160
  *
57962
58161
  * The syntax inside the square brackets is the same as in expression binding. The query is executed for
57963
58162
  * each object in the array until the result is true (truthy) for the first time. This object is then chosen.
@@ -58041,7 +58240,7 @@ declare namespace sap {
58041
58240
  * resource path component of a URI according to OData V2 URI conventions
58042
58241
  */
58043
58242
  sPath?: string
58044
- ): sap.ui.model.Context;
58243
+ ): sap.ui.model.Context | null;
58045
58244
  /**
58046
58245
  * Returns the OData association end corresponding to the given entity type's navigation property of given
58047
58246
  * name.
@@ -58057,7 +58256,7 @@ declare namespace sap {
58057
58256
  * the name of a navigation property within this entity type
58058
58257
  */
58059
58258
  sName: string
58060
- ): object;
58259
+ ): object | null;
58061
58260
  /**
58062
58261
  * Returns the OData association ***set*** end corresponding to the given entity type's navigation property
58063
58262
  * of given name.
@@ -58073,7 +58272,7 @@ declare namespace sap {
58073
58272
  * the name of a navigation property within this entity type
58074
58273
  */
58075
58274
  sName: string
58076
- ): object;
58275
+ ): object | null;
58077
58276
  /**
58078
58277
  * Returns the OData complex type with the given qualified name, either as a path or as an object, as indicated.
58079
58278
  *
@@ -58089,7 +58288,7 @@ declare namespace sap {
58089
58288
  * determines whether the complex type is returned as a path or as an object
58090
58289
  */
58091
58290
  bAsPath?: boolean
58092
- ): object | string;
58291
+ ): object | string | undefined | null;
58093
58292
  /**
58094
58293
  * Returns the OData default entity container. If there is only a single schema with a single entity container,
58095
58294
  * the entity container does not need to be marked as default explicitly.
@@ -58102,7 +58301,7 @@ declare namespace sap {
58102
58301
  * determines whether the entity container is returned as a path or as an object
58103
58302
  */
58104
58303
  bAsPath?: boolean
58105
- ): object | string;
58304
+ ): object | string | undefined | null;
58106
58305
  /**
58107
58306
  * Returns the OData entity set with the given simple name from the default entity container.
58108
58307
  *
@@ -58118,7 +58317,7 @@ declare namespace sap {
58118
58317
  * determines whether the entity set is returned as a path or as an object
58119
58318
  */
58120
58319
  bAsPath?: boolean
58121
- ): object | string;
58320
+ ): object | string | undefined | null;
58122
58321
  /**
58123
58322
  * Returns the OData entity type with the given qualified name, either as a path or as an object, as indicated.
58124
58323
  *
@@ -58134,7 +58333,7 @@ declare namespace sap {
58134
58333
  * determines whether the entity type is returned as a path or as an object
58135
58334
  */
58136
58335
  bAsPath?: boolean
58137
- ): object | string;
58336
+ ): object | string | undefined | null;
58138
58337
  /**
58139
58338
  * @SINCE 1.29.0
58140
58339
  *
@@ -58153,7 +58352,7 @@ declare namespace sap {
58153
58352
  * determines whether the function import is returned as a path or as an object
58154
58353
  */
58155
58354
  bAsPath?: boolean
58156
- ): object | string;
58355
+ ): object | string | undefined | null;
58157
58356
  /**
58158
58357
  * Returns the given OData type's property (not navigation property!) of given name.
58159
58358
  *
@@ -58216,7 +58415,7 @@ declare namespace sap {
58216
58415
  * determines whether the property is returned as a path or as an object
58217
58416
  */
58218
58417
  bAsPath?: boolean
58219
- ): object | string;
58418
+ ): object | string | undefined | null;
58220
58419
  /**
58221
58420
  * @SINCE 1.29.1
58222
58421
  *
@@ -59950,7 +60149,7 @@ declare namespace sap {
59950
60149
  * The path to the property
59951
60150
  */
59952
60151
  sPath: string
59953
- ): string;
60152
+ ): string | null;
59954
60153
  /**
59955
60154
  * Gets the resource bundle of this model.
59956
60155
  *
@@ -60438,7 +60637,7 @@ declare namespace sap {
60438
60637
  * primitive type}
60439
60638
  */
60440
60639
  sTargetType: string
60441
- ): string;
60640
+ ): string | null;
60442
60641
  /**
60443
60642
  * @SINCE 1.82.0
60444
60643
  *
@@ -61104,7 +61303,7 @@ declare namespace sap {
61104
61303
  * "float", "int" or "string" as its {@link sap.ui.base.DataType#getPrimitiveType primitive type}
61105
61304
  */
61106
61305
  sTargetType: string
61107
- ): string | number | boolean;
61306
+ ): string | number | boolean | null;
61108
61307
  /**
61109
61308
  * Parses the given value, which is expected to be of the given type, to a string.
61110
61309
  *
@@ -63084,7 +63283,7 @@ declare namespace sap {
63084
63283
  *
63085
63284
  * @returns Context object used by this context binding or `null`
63086
63285
  */
63087
- getBoundContext(): sap.ui.model.Context;
63286
+ getBoundContext(): sap.ui.model.Context | null;
63088
63287
  }
63089
63288
  /**
63090
63289
  * Holds the status data of a binding. To react to changes of this status data, a control must implement
@@ -63203,7 +63402,7 @@ declare namespace sap {
63203
63402
  *
63204
63403
  * @returns The value that was rejected or `undefined`
63205
63404
  */
63206
- getInvalidValue(): any;
63405
+ getInvalidValue(): any | undefined;
63207
63406
  /**
63208
63407
  * Returns the array of this data state's current messages combining the model and control messages. The
63209
63408
  * array is sorted descendingly by message severity.
@@ -63963,7 +64162,7 @@ declare namespace sap {
63963
64162
  * is considered. If no callback function is given, all messages are considered.
63964
64163
  */
63965
64164
  fnFilter?: (p1: sap.ui.core.message.Message) => boolean
63966
- ): Promise<sap.ui.model.Filter>;
64165
+ ): Promise<sap.ui.model.Filter | null>;
63967
64166
  /**
63968
64167
  * Sorts the list according to the sorter object.
63969
64168
  *
@@ -63982,7 +64181,7 @@ declare namespace sap {
63982
64181
  /**
63983
64182
  * The Sorter object or an array of sorters which defines the sort order
63984
64183
  */
63985
- aSorters: sap.ui.model.Sorter | any[]
64184
+ aSorters: sap.ui.model.Sorter | sap.ui.model.Sorter[]
63986
64185
  ): this;
63987
64186
  }
63988
64187
  /**
@@ -64674,7 +64873,7 @@ declare namespace sap {
64674
64873
  *
64675
64874
  * @returns The meta model or `undefined` if no meta model exists.
64676
64875
  */
64677
- getMetaModel(): sap.ui.model.MetaModel;
64876
+ getMetaModel(): sap.ui.model.MetaModel | undefined;
64678
64877
  /**
64679
64878
  *
64680
64879
  * @returns The value for the given path/context or `undefined` if data could not be found
@@ -64692,7 +64891,7 @@ declare namespace sap {
64692
64891
  * Additional model-specific parameters
64693
64892
  */
64694
64893
  mParameters?: object
64695
- ): any;
64894
+ ): any | undefined;
64696
64895
  /**
64697
64896
  * Returns the original value for the property with the given path and context.
64698
64897
  *
@@ -65432,7 +65631,7 @@ declare namespace sap {
65432
65631
  * The value to be validated
65433
65632
  */
65434
65633
  vValue: any
65435
- ): void | Promise<any>;
65634
+ ): void | Promise<undefined>;
65436
65635
  }
65437
65636
  /**
65438
65637
  * Sorter for list bindings.
@@ -65525,7 +65724,7 @@ declare namespace sap {
65525
65724
  */
65526
65725
  static getMetadata(): sap.ui.base.Metadata;
65527
65726
  /**
65528
- * Returns a group object, at least containing a key property for group detection. May contain additional
65727
+ * Returns a group object, at least containing a "key" property for group detection. May contain additional
65529
65728
  * properties as provided by a custom group function.
65530
65729
  *
65531
65730
  * @returns An object containing a key property and optional custom properties
@@ -65535,7 +65734,7 @@ declare namespace sap {
65535
65734
  * the binding context
65536
65735
  */
65537
65736
  oContext: sap.ui.model.Context
65538
- ): object;
65737
+ ): Record<string, any>;
65539
65738
  /**
65540
65739
  * Returns the group function of this Sorter. If grouping is not enabled on this Sorter, it will return
65541
65740
  * undefined, if no explicit group function has been defined the default group function is returned. The
@@ -70166,7 +70365,7 @@ declare namespace sap {
70166
70365
  * the index within the aggregation
70167
70366
  */
70168
70367
  iIndex: int
70169
- ): Function;
70368
+ ): (p1: sap.ui.core.Control) => sap.ui.base.ManagedObject;
70170
70369
  /**
70171
70370
  * Creates a {@link sap.ui.test.matchers.AggregationLengthEquals} matcher.
70172
70371
  *
@@ -72837,6 +73036,8 @@ declare namespace sap {
72837
73036
 
72838
73037
  "sap/ui/app/MockServer": undefined;
72839
73038
 
73039
+ "sap/ui/base/BindingInfo": undefined;
73040
+
72840
73041
  "sap/ui/base/DataType": undefined;
72841
73042
 
72842
73043
  "sap/ui/base/Event": undefined;