@openui5/ts-types 1.139.0 → 1.141.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.
@@ -279,7 +279,7 @@ declare namespace sap {
279
279
  "sap/ui/thirdparty/qunit-2": undefined;
280
280
  }
281
281
  }
282
- // For Library Version: 1.139.0
282
+ // For Library Version: 1.141.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -787,7 +787,7 @@ declare module "sap/base/i18n/Formatting" {
787
787
  */
788
788
  setLanguageTag(
789
789
  /**
790
- * the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of dashes
790
+ * the new BCP47 compliant language tag; case doesn't matter and underscores can be used instead of hyphens
791
791
  * to separate components (compatibility with Java Locale IDs)
792
792
  */
793
793
  vLanguageTag: string | LanguageTag | null
@@ -1090,15 +1090,15 @@ declare module "sap/base/i18n/LanguageTag" {
1090
1090
  /**
1091
1091
  * Get the extension as a single string or `null`.
1092
1092
  *
1093
- * The extension always consists of a singleton character (not 'x'), a dash '-' and one or more extension
1094
- * token, each separated again with a dash.
1093
+ * The extension always consists of a singleton character (not 'x'), a hyphen '-' and one or more extension
1094
+ * token, each separated again with a hyphen.
1095
1095
  */
1096
1096
  extension: string | null;
1097
1097
 
1098
1098
  /**
1099
1099
  * Get the extensions as an array of tokens.
1100
1100
  *
1101
- * The leading singleton and the separating dashes are not part of the result. If there is no extensions
1101
+ * The leading singleton and the separating hyphens are not part of the result. If there is no extensions
1102
1102
  * section in the language tag, an empty array is returned.
1103
1103
  */
1104
1104
  extensionSubtags: string[];
@@ -1130,14 +1130,14 @@ declare module "sap/base/i18n/LanguageTag" {
1130
1130
  /**
1131
1131
  * Get the variants as a single string or `null`.
1132
1132
  *
1133
- * Multiple variants are separated by a dash '-'.
1133
+ * Multiple variants are separated by a hyphen '-'.
1134
1134
  */
1135
1135
  variant: string | null;
1136
1136
 
1137
1137
  /**
1138
1138
  * Get the variants as an array of individual variants.
1139
1139
  *
1140
- * The separating dashes are not part of the result. If there is no variant section in the language tag,
1140
+ * The separating hyphens are not part of the result. If there is no variant section in the language tag,
1141
1141
  * an empty array is returned.
1142
1142
  */
1143
1143
  variantSubtags: string[];
@@ -1189,8 +1189,8 @@ declare module "sap/base/i18n/Localization" {
1189
1189
  * The value returned by config method in most cases corresponds to the exact value that has been configured
1190
1190
  * by the user or application or that has been determined from the user agent settings. It has not been
1191
1191
  * normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
1192
- * allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters into
1193
- * account.
1192
+ * allowing underscores ('_') instead of the suggested hyphens ('-') and not taking the case of letters
1193
+ * into account.
1194
1194
  *
1195
1195
  * The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
1196
1196
  * That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
@@ -1308,7 +1308,7 @@ declare module "sap/base/i18n/Localization" {
1308
1308
  setLanguage(
1309
1309
  /**
1310
1310
  * the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
1311
- * of dashes to separate components (compatibility with Java Locale IDs)
1311
+ * of hyphens to separate components (compatibility with Java Locale IDs)
1312
1312
  */
1313
1313
  sLanguage: string,
1314
1314
  /**
@@ -2355,7 +2355,7 @@ declare module "sap/base/security/encodeURL" {
2355
2355
  /**
2356
2356
  * Encode the string for inclusion into a URL parameter.
2357
2357
  *
2358
- * Unescaped characters: alphabetic, decimal digits, -_. (dash, underscore, point)
2358
+ * Unescaped characters: alphabetic, decimal digits, -_. (hyphen, underscore, dot)
2359
2359
  *
2360
2360
  * @since 1.58
2361
2361
  *
@@ -2432,8 +2432,10 @@ declare module "sap/base/security/URLListValidator" {
2432
2432
  */
2433
2433
  port?: string,
2434
2434
  /**
2435
- * the path of the URL, path of the url, can be falsy to allow all paths. A wildcard asterisk can be set
2436
- * at the end, e.g. "/my-example*", "/my-news"
2435
+ * the path of the URL, e.g. "/my-news". Can be falsy to allow all paths. A wildcard asterisk can be set
2436
+ * at the end to ensure a path starts with the given string, e.g. "/my-example*". When using wildcards,
2437
+ * make sure to only provide normalized URLs to the validate function in order to mitigate the risk of path
2438
+ * traversal attacks.
2437
2439
  */
2438
2440
  path?: string
2439
2441
  ): void;
@@ -2451,11 +2453,14 @@ declare module "sap/base/security/URLListValidator" {
2451
2453
  /**
2452
2454
  * Validates a URL. Check if it's not a script or other security issue.
2453
2455
  *
2454
- * **Note**: It is strongly recommended to validate only absolute URLs. There's almost no case where checking
2455
- * only the path of a URL would allow to ensure its validity. For compatibility reasons, this API cannot
2456
- * automatically resolve URLs relative to `document.baseURI`, but callers should do so. In that case, and
2457
- * when the allow list is not empty, an entry for the origin of `document.baseURI` must be added to the
2458
- * allow list.
2456
+ * **Note**: It is strongly recommended to validate only absolute, normalized URLs. There's almost no case
2457
+ * where checking only the path of a URL would allow to ensure its validity. For compatibility reasons,
2458
+ * this API does not normalize URLs and cannot automatically resolve URLs relative to `document.baseURI`,
2459
+ * but callers should do so. In that case, and when the allow list is not empty, an entry for the origin
2460
+ * of `document.baseURI` must be added to the allow list.
2461
+ *
2462
+ * Any measures to mitigate path traversal or similar attack vectors must be taken by the caller, e.g. by
2463
+ * using the {@link https://developer.mozilla.org/docs/Web/API/URL URL} API to normalize the URL beforehand.
2459
2464
  *
2460
2465
  * Details: Splits the given URL into components and checks for allowed characters according to RFC 3986:
2461
2466
  *
@@ -3907,7 +3912,7 @@ declare module "sap/ui/core/ComponentSupport" {
3907
3912
  * instance of the {@link sap.ui.core.ComponentContainer ComponentContainer} in the JavaScript code.
3908
3913
  *
3909
3914
  * As HTML is case-insensitive, in order to define a property with upper-case characters, you have to "escape"
3910
- * them with a dash character, similar to CSS attributes. The following code gives an example:
3915
+ * them with a hyphen character, similar to CSS attributes. The following code gives an example:
3911
3916
  *
3912
3917
  *
3913
3918
  * ```javascript
@@ -5383,6 +5388,10 @@ declare module "sap/ui/dom/includeStylesheet" {
5383
5388
  *
5384
5389
  * - otherwise: no action
5385
5390
  *
5391
+ * **Note:** `includeStylesheet` must not be used for UI5 library CSS. UI5 library CSS is managed by the
5392
+ * UI5 theming lifecycle. Interfering with this lifecycle by manually including library CSS via `includeStylesheet`
5393
+ * can lead to unexpected behavior and theming issues.
5394
+ *
5386
5395
  * @since 1.58
5387
5396
  *
5388
5397
  * @returns When using the configuration object a `Promise` will be returned. The documentation for the
@@ -7226,8 +7235,6 @@ declare module "sap/ui/util/Mobile" {
7226
7235
  * work in case there is already a meta tag with name 'viewport'.
7227
7236
  * - statusBar: the iOS status bar color, "default", "black" or "black-translucent" (default: "default")
7228
7237
  *
7229
- * - hideBrowser: whether the browser UI should be hidden as far as possible to make the app feel more
7230
- * native (default: true)
7231
7238
  * - preventScroll: whether native scrolling should be disabled in order to prevent the "rubber-band"
7232
7239
  * effect where the whole window is moved (default: true)
7233
7240
  * - preventPhoneNumberDetection: whether Safari Mobile should be prevented from transforming any numbers
@@ -7235,8 +7242,6 @@ declare module "sap/ui/util/Mobile" {
7235
7242
  * break controls because Safari actually changes the DOM. This only affects all page content which is created
7236
7243
  * after init() is called and only in case there is not already a meta tag with name 'format-detection'.
7237
7244
  *
7238
- * - rootId: the ID of the root element that should be made fullscreen; only used when hideBrowser is
7239
- * set (default: the document.body)
7240
7245
  * - useFullScreenHeight: a boolean that defines whether the height of the html root element should be
7241
7246
  * set to 100%, which is required for other elements to cover the full height (default: true) homeIcon:
7242
7247
  * deprecated since 1.12, use sap/ui/util/Mobile.setIcons instead.
@@ -7254,10 +7259,6 @@ declare module "sap/ui/util/Mobile" {
7254
7259
  * the iOS status bar color, "default", "black" or "black-translucent"
7255
7260
  */
7256
7261
  statusBar?: string;
7257
- /**
7258
- * whether the browser UI should be hidden as far as possible to make the app feel more native
7259
- */
7260
- hideBrowser?: boolean;
7261
7262
  /**
7262
7263
  * whether native scrolling should be disabled in order to prevent the "rubber-band" effect where the whole
7263
7264
  * window is moved
@@ -7268,11 +7269,6 @@ declare module "sap/ui/util/Mobile" {
7268
7269
  * into clickable links
7269
7270
  */
7270
7271
  preventPhoneNumberDetection?: boolean;
7271
- /**
7272
- * the ID of the root element that should be made fullscreen; only used when hideBrowser is set. If not
7273
- * set, the body is used
7274
- */
7275
- rootId?: string;
7276
7272
  /**
7277
7273
  * whether the height of the html root element should be set to 100%, which is required for other elements
7278
7274
  * to cover the full height
@@ -24972,10 +24968,15 @@ declare namespace sap {
24972
24968
  */
24973
24969
  static getInstance(): sap.ui.core.routing.History;
24974
24970
  /**
24975
- * Determines what the navigation direction for a newly given hash would be It will say Unknown if there
24976
- * is a history foo - bar (current history) - foo If you now ask for the direction of the hash "foo" you
24977
- * get Unknown because it might be backwards or forwards. For hash replacements, the history stack will
24978
- * be replaced at this position for the history.
24971
+ * Determines what the navigation direction for a newly given hash would be.
24972
+ *
24973
+ * Returns the direction as {@link sap.ui.core.routing.HistoryDirection} (for example: Forwards, Backwards,
24974
+ * NewEntry). If no navigation has occurred yet, returns `undefined`. In cases where the direction cannot
24975
+ * be determined (if the same hash appears in multiple places), returns {@link sap.ui.core.routing.HistoryDirection.Unknown}.
24976
+ * For hash replacements, the history stack is updated at the current position.
24977
+ *
24978
+ * Example: It will say "Unknown" if there is a history "foo" - "bar" (current history) - "foo". If you
24979
+ * now ask for the direction of the hash "foo" you get "Unknown" because it might be backwards or forwards.
24979
24980
  *
24980
24981
  *
24981
24982
  * @returns Direction for the given hash or `undefined`, if no navigation has taken place yet.
@@ -25321,7 +25322,23 @@ declare namespace sap {
25321
25322
 
25322
25323
  class Router extends sap.ui.base.EventProvider {
25323
25324
  /**
25324
- * Instantiates a router
25325
+ * A Router is responsible for managing navigation within an application by interpreting and responding
25326
+ * to changes in the URL hash. It enables applications to define routes, map them to Views/Components, and
25327
+ * control their placement and transitions — all in a structured and declarative way.
25328
+ *
25329
+ * A router:
25330
+ * - Listens to hash changes and matches them to configured route patterns
25331
+ * - Instantiates Views/Components dynamically when a route is matched and caches them for better performance
25332
+ *
25333
+ * - Places Views/Components into UI containers based on the defined targets and aggregations
25334
+ * - Maintains the browser history and consistent back/forward navigation behavior
25335
+ * - Fires events such as `routeMatched` and `routePatternMatched`, allowing developers to run logic when
25336
+ * routes change
25337
+ * - Handles unmatched routes through a special bypassed configuration for displaying "Not Found" View(s)
25338
+ * or fallbacks
25339
+ *
25340
+ * It can be used directly or via a {@link sap.ui.core.UIComponent UIComponent}'s metadata (manifest.json)
25341
+ * to create scalable, maintainable, and testable navigation structures across complex applications.
25325
25342
  */
25326
25343
  constructor(
25327
25344
  /**
@@ -31952,6 +31969,18 @@ declare namespace sap {
31952
31969
  };
31953
31970
  }
31954
31971
 
31972
+ namespace Event {
31973
+ /**
31974
+ * An object literal describing the mapping of an event of a class derived from `sap.ui.core.webc.WebComponent`.
31975
+ */
31976
+ type Mapping = {
31977
+ /**
31978
+ * Defines the target of the mapping of the event to which name it will be mapped to.
31979
+ */
31980
+ to?: string;
31981
+ };
31982
+ }
31983
+
31955
31984
  namespace Property {
31956
31985
  /**
31957
31986
  * An object literal describing the mapping of a property of a class derived from `sap.ui.core.webc.WebComponent`.
@@ -32004,6 +32033,17 @@ declare namespace sap {
32004
32033
  | sap.ui.core.webc.WebComponent.MetadataOptionsAssociationMapping;
32005
32034
  };
32006
32035
 
32036
+ /**
32037
+ * An object literal describing an event of a class derived from `sap.ui.core.webc.WebComponent`. See {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
32038
+ * for details on its usage.
32039
+ */
32040
+ type Event = sap.ui.base.ManagedObject.MetadataOptions.Event & {
32041
+ /**
32042
+ * Defines the mapping of the event.
32043
+ */
32044
+ mapping?: sap.ui.core.webc.WebComponent.MetadataOptionsEventMapping;
32045
+ };
32046
+
32007
32047
  /**
32008
32048
  * An object literal describing a property of a class derived from `sap.ui.core.webc.WebComponent`. See
32009
32049
  * {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions} for details on its usage.
@@ -32058,6 +32098,14 @@ declare namespace sap {
32058
32098
  string,
32059
32099
  string | sap.ui.core.webc.WebComponent.MetadataOptions.Association
32060
32100
  >;
32101
+ /**
32102
+ * An object literal whose properties each define a new event of the ManagedObject subclass. See {@link sap.ui.base.ManagedObject.MetadataOptions.Event Event }
32103
+ * for more details.
32104
+ */
32105
+ events?: Record<
32106
+ string,
32107
+ string | sap.ui.core.webc.WebComponent.MetadataOptions.Event
32108
+ >;
32061
32109
  /**
32062
32110
  * Proxied public getters of the Web Component which are directly accessible on the wrapper Control.
32063
32111
  */
@@ -32068,15 +32116,12 @@ declare namespace sap {
32068
32116
  methods?: string[];
32069
32117
  };
32070
32118
 
32071
- /**
32072
- * HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
32073
- */
32074
32119
  type MetadataOptionsAssociationMapping =
32075
32120
  sap.ui.core.webc.WebComponent.MetadataOptions.Association.Mapping;
32076
32121
 
32077
- /**
32078
- * HACK! This mapping omits the `no-unnecessary-qualifier` error or we need to extend the `tslint.json`!
32079
- */
32122
+ type MetadataOptionsEventMapping =
32123
+ sap.ui.core.webc.WebComponent.MetadataOptions.Event.Mapping;
32124
+
32080
32125
  type MetadataOptionsPropertyMapping =
32081
32126
  sap.ui.core.webc.WebComponent.MetadataOptions.Property.Mapping;
32082
32127
  }
@@ -32190,6 +32235,18 @@ declare namespace sap {
32190
32235
  * @returns Metadata object describing this class
32191
32236
  */
32192
32237
  static getMetadata(): sap.ui.core.webc.WebComponentMetadata;
32238
+ /**
32239
+ * Sets the Web Components busy state
32240
+ *
32241
+ *
32242
+ * @returns `this` to allow method chaining
32243
+ */
32244
+ setBusy(
32245
+ /**
32246
+ * The new busy state to be set
32247
+ */
32248
+ bBusy: boolean
32249
+ ): this;
32193
32250
  }
32194
32251
  /**
32195
32252
  * @since 1.138.0
@@ -33317,7 +33374,7 @@ declare namespace sap {
33317
33374
 
33318
33375
  /**
33319
33376
  * Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
33320
- * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash.
33377
+ * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
33321
33378
  * This property can only be applied initially.
33322
33379
  */
33323
33380
  autoPrefixId?:
@@ -34789,8 +34846,8 @@ declare namespace sap {
34789
34846
  * The value returned by config method in most cases corresponds to the exact value that has been configured
34790
34847
  * by the user or application or that has been determined from the user agent settings. It has not been
34791
34848
  * normalized, but has been validated against a relaxed version of {@link http://www.ietf.org/rfc/bcp/bcp47.txt BCP47},
34792
- * allowing underscores ('_') instead of the suggested dashes ('-') and not taking the case of letters into
34793
- * account.
34849
+ * allowing underscores ('_') instead of the suggested hyphens ('-') and not taking the case of letters
34850
+ * into account.
34794
34851
  *
34795
34852
  * The exceptions mentioned above affect languages that have been specified via the URL parameter `sap-language`.
34796
34853
  * That parameter by definition represents an SAP logon language code ('ABAP language'). Most but not all
@@ -35059,7 +35116,7 @@ declare namespace sap {
35059
35116
  setFormatLocale(
35060
35117
  /**
35061
35118
  * the new format locale as a BCP47 compliant language tag; case doesn't matter and underscores can be used
35062
- * instead of dashes to separate components (compatibility with Java Locale IDs)
35119
+ * instead of hyphens to separate components (compatibility with Java Locale IDs)
35063
35120
  */
35064
35121
  sFormatLocale: string | null
35065
35122
  ): this;
@@ -35116,7 +35173,7 @@ declare namespace sap {
35116
35173
  setLanguage(
35117
35174
  /**
35118
35175
  * the new language as a BCP47 compliant language tag; case doesn't matter and underscores can be used instead
35119
- * of dashes to separate components (compatibility with Java Locale IDs)
35176
+ * of hyphens to separate components (compatibility with Java Locale IDs)
35120
35177
  */
35121
35178
  sLanguage: string,
35122
35179
  /**
@@ -38748,7 +38805,7 @@ declare namespace sap {
38748
38805
  * Gets current value of property {@link #getAutoPrefixId autoPrefixId}.
38749
38806
  *
38750
38807
  * Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
38751
- * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash.
38808
+ * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
38752
38809
  * This property can only be applied initially.
38753
38810
  *
38754
38811
  * Default value is `false`.
@@ -38901,7 +38958,7 @@ declare namespace sap {
38901
38958
  * Sets a new value for property {@link #getAutoPrefixId autoPrefixId}.
38902
38959
  *
38903
38960
  * Flag, whether to auto-prefix the ID of the nested Component or not. If this property is set to true the
38904
- * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single dash.
38961
+ * ID of the Component will be prefixed with the ID of the ComponentContainer followed by a single hyphen.
38905
38962
  * This property can only be applied initially.
38906
38963
  *
38907
38964
  * When called with a value of `null` or `undefined`, the default value of the property will be restored.
@@ -40681,8 +40738,8 @@ declare namespace sap {
40681
40738
  * returned by {@link sap.ui.core.Element#getDomRef} is wrapped and returned.
40682
40739
  *
40683
40740
  * If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single
40684
- * dash) and the DOM node with that compound ID will be wrapped by jQuery. This matches the UI5 naming convention
40685
- * for named inner DOM nodes of a control.
40741
+ * hyphen) and the DOM node with that compound ID will be wrapped by jQuery. This matches the UI5 naming
40742
+ * convention for named inner DOM nodes of a control.
40686
40743
  *
40687
40744
  * @ui5-protected Do not call from applications (only from related classes in the framework)
40688
40745
  *
@@ -41116,7 +41173,7 @@ declare namespace sap {
41116
41173
  * their current state (e.g. an initial, not yet rendered control).
41117
41174
  *
41118
41175
  * If an ID suffix is given, the ID of this Element is concatenated with the suffix (separated by a single
41119
- * dash) and the DOM node with that compound ID will be returned. This matches the UI5 naming convention
41176
+ * hyphen) and the DOM node with that compound ID will be returned. This matches the UI5 naming convention
41120
41177
  * for named inner DOM nodes of a control.
41121
41178
  *
41122
41179
  * @ui5-protected Do not call from applications (only from related classes in the framework)
@@ -44519,8 +44576,8 @@ declare namespace sap {
44519
44576
  /**
44520
44577
  * Get the locale extension as a single string or `null`.
44521
44578
  *
44522
- * The extension always consists of a singleton character (not 'x'), a dash '-' and one or more extension
44523
- * token, each separated again with a dash.
44579
+ * The extension always consists of a singleton character (not 'x'), a hyphen '-' and one or more extension
44580
+ * token, each separated again with a hyphen.
44524
44581
  *
44525
44582
  * Use {@link #getExtensions} to get the individual extension tokens as an array.
44526
44583
  *
@@ -44531,7 +44588,7 @@ declare namespace sap {
44531
44588
  /**
44532
44589
  * Get the locale extensions as an array of tokens.
44533
44590
  *
44534
- * The leading singleton and the separating dashes are not part of the result. If there is no extensions
44591
+ * The leading singleton and the separating hyphens are not part of the result. If there is no extensions
44535
44592
  * section in the locale tag, an empty array is returned.
44536
44593
  *
44537
44594
  *
@@ -44558,7 +44615,7 @@ declare namespace sap {
44558
44615
  /**
44559
44616
  * Get the locale private use section as an array of tokens.
44560
44617
  *
44561
- * The leading singleton and the separating dashes are not part of the result. If there is no private use
44618
+ * The leading singleton and the separating hyphens are not part of the result. If there is no private use
44562
44619
  * section in the locale tag, an empty array is returned.
44563
44620
  *
44564
44621
  *
@@ -44610,7 +44667,7 @@ declare namespace sap {
44610
44667
  /**
44611
44668
  * Get the locale variants as a single string or `null`.
44612
44669
  *
44613
- * Multiple variants are separated by a dash '-'.
44670
+ * Multiple variants are separated by a hyphen '-'.
44614
44671
  *
44615
44672
  *
44616
44673
  * @returns the variant or `null`
@@ -44619,8 +44676,8 @@ declare namespace sap {
44619
44676
  /**
44620
44677
  * Get the locale variants as an array of individual variants.
44621
44678
  *
44622
- * The separating dashes are not part of the result. If there is no variant section in the locale tag, an
44623
- * empty array is returned.
44679
+ * The separating hyphens are not part of the result. If there is no variant section in the locale tag,
44680
+ * an empty array is returned.
44624
44681
  *
44625
44682
  *
44626
44683
  * @returns the individual variant sections
@@ -49770,11 +49827,21 @@ declare namespace sap {
49770
49827
  /**
49771
49828
  * Initializes the component instance after creation.
49772
49829
  *
49773
- * Applications must not call this hook method directly, it is called by the framework while the constructor
49774
- * of a Component is executed.
49830
+ * The primary responsibility of this method is to create the root control of the component and manage its
49831
+ * aggregation in the "rootControl" aggregation. This is performed internally by invoking the {@link sap.ui.core.UIComponent#createContent }
49832
+ * method.
49833
+ *
49834
+ * Depending on the class metadata (e.g., if the "sap.ui.core.IAsyncContentCreation" interface is implemented),
49835
+ * the root control may be created synchronously or asynchronously.
49775
49836
  *
49776
- * Subclasses of `UIComponent` should override this hook to implement any necessary initialization. **When
49777
- * overriding this function make sure to invoke the `init` function of the `UIComponent` as well!**
49837
+ * Additionally, this method is responsible for creating the router and targets instances.
49838
+ *
49839
+ * **Note:** Applications must not call this hook method directly; it is invoked by the framework during
49840
+ * the execution of the Component constructor.
49841
+ *
49842
+ * Subclasses of `UIComponent` should override this hook to implement any required initialization logic.
49843
+ * **When overriding this method, ensure that you always invoke the `init` method of the `UIComponent` base
49844
+ * class.**
49778
49845
  *
49779
49846
  * @ui5-protected Do not call from applications (only from related classes in the framework)
49780
49847
  */
@@ -51554,7 +51621,7 @@ declare namespace sap {
51554
51621
  /**
51555
51622
  * A string type representing an ID or a name.
51556
51623
  *
51557
- * Allowed is a sequence of characters (capital/lowercase), digits, underscores, dashes, points and/or colons.
51624
+ * Allowed is a sequence of characters (capital/lowercase), digits, underscores, hyphens, dots and/or colons.
51558
51625
  * It may start with a character or underscore only.
51559
51626
  */
51560
51627
  type ID = string;
@@ -59279,8 +59346,8 @@ declare namespace sap {
59279
59346
  */
59280
59347
  usePreliminaryContext?: boolean;
59281
59348
  /**
59282
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
59283
- * the binding.
59349
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
59350
+ * originating from the binding.
59284
59351
  */
59285
59352
  batchGroupId?: string;
59286
59353
  }
@@ -59433,8 +59500,8 @@ declare namespace sap {
59433
59500
  */
59434
59501
  usePreliminaryContext?: boolean;
59435
59502
  /**
59436
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
59437
- * the binding.
59503
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
59504
+ * originating from the binding.
59438
59505
  */
59439
59506
  batchGroupId?: string;
59440
59507
  /**
@@ -59928,8 +59995,8 @@ declare namespace sap {
59928
59995
  */
59929
59996
  refreshAfterChange?: boolean;
59930
59997
  /**
59931
- * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests. **Deprecated**
59932
- * as of version 1.128.0, the concept has been discarded.
59998
+ * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests. **Deprecated
59999
+ * as of version 1.128.0**, the concept has been discarded.
59933
60000
  */
59934
60001
  sequentializeRequests?: boolean;
59935
60002
  /**
@@ -59964,19 +60031,20 @@ declare namespace sap {
59964
60031
  */
59965
60032
  withCredentials?: boolean;
59966
60033
  /**
59967
- * **Deprecated** for security reasons. Use strong server side authentication instead. Password for the
59968
- * service.
60034
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
60035
+ * Password for the service.
59969
60036
  */
59970
60037
  password?: string;
59971
60038
  /**
59972
- * **Deprecated** This parameter does not prevent creation of annotations from the metadata document in
59973
- * this model's metamodel. Whether to skip the automated loading of annotations from the metadata document.
59974
- * Loading annotations from metadata does not have any effects (except the lost performance by invoking
59975
- * the parser) if there are no annotations inside the metadata document
60039
+ * **Deprecated as of version 1.112.0** This parameter does not prevent creation of annotations from the
60040
+ * metadata document in this model's metamodel. Whether to skip the automated loading of annotations from
60041
+ * the metadata document. Loading annotations from metadata does not have any effects (except the lost performance
60042
+ * by invoking the parser) if there are no annotations inside the metadata document
59976
60043
  */
59977
60044
  skipMetadataAnnotationParsing?: boolean;
59978
60045
  /**
59979
- * **Deprecated** for security reasons. Use strong server side authentication instead. UserID for the service.
60046
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
60047
+ * UserID for the service.
59980
60048
  */
59981
60049
  user?: string;
59982
60050
  }
@@ -60315,8 +60383,8 @@ declare namespace sap {
60315
60383
  */
60316
60384
  usePreliminaryContext?: boolean;
60317
60385
  /**
60318
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
60319
- * the binding.
60386
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
60387
+ * originating from the binding.
60320
60388
  */
60321
60389
  batchGroupId?: string;
60322
60390
  }
@@ -60402,14 +60470,14 @@ declare namespace sap {
60402
60470
  */
60403
60471
  usePreliminaryContext?: boolean;
60404
60472
  /**
60405
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
60406
- * the binding.
60473
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
60474
+ * originating from the binding.
60407
60475
  */
60408
60476
  batchGroupId?: string;
60409
60477
  /**
60410
- * Deprecated since 1.102.0, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated; the threshold
60411
- * that defines how many entries should be fetched at least by the binding if `operationMode` is set to
60412
- * `Auto`.
60478
+ * **Deprecated as of version 1.102.0**, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated;
60479
+ * the threshold that defines how many entries should be fetched at least by the binding if `operationMode`
60480
+ * is set to `Auto`.
60413
60481
  */
60414
60482
  threshold?: int;
60415
60483
  }
@@ -60468,27 +60536,22 @@ declare namespace sap {
60468
60536
  * of levels, with only a single initial OData request.
60469
60537
  *
60470
60538
  * For services without the `hierarchy-node-descendant-count-for` annotation, the `numberOfExpandedLevels`
60471
- * property is not supported and deprecated.
60539
+ * property is not supported and deprecated since 1.44.5.
60472
60540
  *
60473
- * Operation Modes: For a full definition and explanation of all OData binding operation modes, see {@link sap.ui.model.odata.OperationMode}.
60541
+ * The OData service must always return node collections which are sufficient to create a valid hierarchy
60542
+ * on the client. This means that for each node in the response all parent nodes up to the hierarchy root
60543
+ * must also be contained in the response. Note that this rule applies independent of any filters set for
60544
+ * the binding.
60474
60545
  *
60475
- * OperationMode.Server: Filtering on the `ODataTreeBinding` is only supported with filters of type {@link sap.ui.model.FilterType.Application}.
60476
- * Be aware that this applies only to filters which do not prevent the creation of a hierarchy. So filtering
60477
- * on a property (e.g. a "Customer") is fine, as long as the application ensures that the responses from
60478
- * the back end are sufficient to create a valid hierarchy on the client. Subsequent paging requests for
60479
- * sibling and child nodes must also return responses, since the filters are sent with every request. Using
60480
- * control-defined filters (see {@link sap.ui.model.FilterType.Control}) via the {@link #filter} function
60481
- * is not supported for the operation mode `Server`.
60546
+ * You must not define filters on tree annotation properties for this binding as this interferes with hierarchy
60547
+ * filters defined by the binding itself.
60482
60548
  *
60483
- * OperationMode.Client and OperationMode.Auto: The ODataTreeBinding supports control-defined filters only
60484
- * in operation modes `Client` and `Auto`. With these operation modes, the filters and sorters are applied
60485
- * on the client, like for the {@link sap.ui.model.odata.v2.ODataListBinding}.
60549
+ * Notes On Operation Modes: For a full definition and explanation of all OData binding operation modes,
60550
+ * see {@link sap.ui.model.odata.OperationMode}.
60486
60551
  *
60487
60552
  * The operation modes `Client` and `Auto` are only supported for services which expose the hierarchy annotations
60488
- * mentioned above, but do **not** expose the `hierarchy-node-descendant-count-for` annotation. Services
60489
- * with hierarchy annotations including the `hierarchy-node-descendant-count-for` annotation, do **not**
60490
- * support the operation modes `Client` and `Auto`. **Note:** {@link sap.ui.model.odata.OperationMode.Auto }
60491
- * is deprecated since 1.102.0.
60553
+ * mentioned above, but do **not** expose the `hierarchy-node-descendant-count-for` annotation. **Note:**
60554
+ * {@link sap.ui.model.odata.OperationMode.Auto} is deprecated since 1.102.0.
60492
60555
  *
60493
60556
  * **Note:** OData tree bindings do neither support {@link sap.ui.model.Binding#suspend suspend} nor {@link sap.ui.model.Binding#resume resume}.
60494
60557
  * See:
@@ -60551,10 +60614,15 @@ declare namespace sap {
60551
60614
  * property has to be an integer type
60552
60615
  */
60553
60616
  hierarchyNodeDescendantCountFor?: string;
60617
+ /**
60618
+ * The property name in the same type holding the preorder rank for the node; the type of the referenced
60619
+ * property has to be an integer type
60620
+ */
60621
+ hierarchyPreorderRankFor?: string;
60554
60622
  };
60555
60623
  /**
60556
60624
  * The number of levels that are auto-expanded initially. Setting this property might lead to multiple back-end
60557
- * requests. The auto-expand feature is **deprecated for services without the `hierarchy-node-descendant-count-for`
60625
+ * requests. The auto-expand feature is **deprecated as of Version 1.44.5 for services without the `hierarchy-node-descendant-count-for`
60558
60626
  * annotation**
60559
60627
  */
60560
60628
  numberOfExpandedLevels?: number;
@@ -60570,7 +60638,6 @@ declare namespace sap {
60570
60638
  * The operation mode for this binding; defaults to the model's default operation mode if not specified.
60571
60639
  * {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is only supported for services which
60572
60640
  * expose the hierarchy annotations, yet do **NOT** expose the `hierarchy-node-descendant-count-for` annotation.
60573
- * **Note:** {@link sap.ui.model.odata.OperationMode.Auto} is deprecated since 1.102.0.
60574
60641
  */
60575
60642
  operationMode?: sap.ui.model.odata.OperationMode;
60576
60643
  /**
@@ -60580,13 +60647,9 @@ declare namespace sap {
60580
60647
  */
60581
60648
  threshold?: number;
60582
60649
  /**
60583
- * Deprecated since 1.102.0, as {@link sap.ui.model.odata.OperationMode.Auto} is deprecated; whether `$filter`
60584
- * statements should be used for the `$count` / `$inlinecount` requests and for the data request if the
60585
- * operation mode is {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto}. Use this feature
60586
- * only if your back end supports pre-filtering the tree and is capable of responding with a complete tree
60587
- * hierarchy, including all inner nodes. To construct the hierarchy on the client, it is mandatory that
60588
- * all filter matches include their complete parent chain up to the root level. If {@link sap.ui.model.odata.OperationMode.Client OperationMode.Client }
60589
- * is used, the complete collection without filters is requested; filters are applied on the client side.
60650
+ * Whether `$filter` statements should be used for the `$count` / `$inlinecount` requests and for the data
60651
+ * request if the operation mode is {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} or
60652
+ * {@link sap.ui.model.odata.OperationMode.Client OperationMode.Client}
60590
60653
  */
60591
60654
  useServersideApplicationFilters?: boolean;
60592
60655
  /**
@@ -60600,6 +60663,18 @@ declare namespace sap {
60600
60663
  * or {@link sap.ui.model.odata.OperationMode.Auto OperationMode.Auto} is used.
60601
60664
  */
60602
60665
  treeState?: any;
60666
+ /**
60667
+ * This parameter is experimental as of version 1.141.0.
60668
+ *
60669
+ * Whether the tree state is restored on hierarchy maintenance, such as adding, removing, or deleting a
60670
+ * node. This is only supported if the following conditions are met:
60671
+ * - The binding has to use {@link sap.ui.model.odata.OperationMode.Server OperationMode.Server}
60672
+ * - The `"hierarchy-node-descendant-count-for"` annotation must be present in the service metadata or
60673
+ * provided via `treeAnnotationProperties.hierarchyNodeDescendantCountFor`
60674
+ * - The `"hierarchy-preorder-rank-for"` annotation must be present in the service metadata or provided
60675
+ * via `treeAnnotationProperties.hierarchyPreorderRankFor`
60676
+ */
60677
+ restoreTreeStateAfterChange?: boolean;
60603
60678
  /**
60604
60679
  * Defines the count mode of this binding; if not specified, the default count mode of the binding's model
60605
60680
  * is applied. The resulting count mode must not be {@link sap.ui.model.odata.CountMode.None}.
@@ -60611,16 +60686,16 @@ declare namespace sap {
60611
60686
  */
60612
60687
  usePreliminaryContext?: boolean;
60613
60688
  /**
60614
- * **Deprecated**, use `groupId` instead. Sets the batch group id to be used for requests originating from
60615
- * this binding
60689
+ * **Deprecated as of version 1.31.0**, use `groupId` instead. Sets the batch group id to be used for requests
60690
+ * originating from this binding
60616
60691
  */
60617
60692
  batchGroupId?: string;
60618
60693
  /**
60619
60694
  * A map describing the navigation properties between entity sets, which is used for constructing and paging
60620
60695
  * the tree. Keys in this object are entity names, whereas the values name the navigation properties.
60621
60696
  *
60622
- * **Deprecated: since 1.44** The use of navigation properties to build up the hierarchy structure is deprecated.
60623
- * It is recommended to use the hierarchy annotations mentioned above instead.
60697
+ * **Deprecated as of version 1.44** The use of navigation properties to build up the hierarchy structure
60698
+ * is deprecated. It is recommended to use the hierarchy annotations mentioned above instead.
60624
60699
  */
60625
60700
  navigation?: object;
60626
60701
  },
@@ -60740,7 +60815,7 @@ declare namespace sap {
60740
60815
  */
60741
60816
  urlParameters?: Record<string, any>;
60742
60817
  /**
60743
- * **Deprecated - use `groupId` instead**
60818
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
60744
60819
  */
60745
60820
  batchGroupId?: string;
60746
60821
  }
@@ -60803,7 +60878,7 @@ declare namespace sap {
60803
60878
  */
60804
60879
  headers?: Record<string, string>;
60805
60880
  /**
60806
- * Deprecated - use `groupId` instead
60881
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
60807
60882
  */
60808
60883
  batchGroupId?: string;
60809
60884
  /**
@@ -60943,7 +61018,7 @@ declare namespace sap {
60943
61018
  */
60944
61019
  mParameters: {
60945
61020
  /**
60946
- * Deprecated - use `groupId` instead
61021
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
60947
61022
  */
60948
61023
  batchGroupId?: string;
60949
61024
  /**
@@ -61576,9 +61651,9 @@ declare namespace sap {
61576
61651
  */
61577
61652
  oContext?: object,
61578
61653
  /**
61579
- * Deprecated, use {@link #getObject} function with 'select' and 'expand' parameters instead. Whether entities
61580
- * for navigation properties of this property which have been read via `$expand` are part of the return
61581
- * value.
61654
+ * **Deprecated as of version 1.41.0**, use {@link #getObject} function with 'select' and 'expand' parameters
61655
+ * instead. Whether entities for navigation properties of this property which have been read via `$expand`
61656
+ * are part of the return value.
61582
61657
  */
61583
61658
  bIncludeExpandEntries?: boolean
61584
61659
  ): any;
@@ -61814,7 +61889,7 @@ declare namespace sap {
61814
61889
  */
61815
61890
  error?: Function;
61816
61891
  /**
61817
- * Deprecated - use `groupId` instead
61892
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
61818
61893
  */
61819
61894
  batchGroupId?: string;
61820
61895
  /**
@@ -61927,7 +62002,7 @@ declare namespace sap {
61927
62002
  */
61928
62003
  headers?: Record<string, string>;
61929
62004
  /**
61930
- * Deprecated - use `groupId` instead
62005
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
61931
62006
  */
61932
62007
  batchGroupId?: string;
61933
62008
  /**
@@ -62224,13 +62299,14 @@ declare namespace sap {
62224
62299
  */
62225
62300
  error?: Function;
62226
62301
  /**
62227
- * **Deprecated**, use `groupId` instead
62302
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
62228
62303
  */
62229
62304
  batchGroupId?: string;
62230
62305
  /**
62231
- * **Deprecated** since 1.38.0; use the `defaultUpdateMethod` constructor parameter instead. If unset, the
62232
- * update method is determined from the `defaultUpdateMethod` constructor parameter. If `true`, `sap.ui.model.odata.UpdateMethod.MERGE`
62233
- * is used for update operations; if set to `false`, `sap.ui.model.odata.UpdateMethod.PUT` is used.
62306
+ * **Deprecated as of version 1.38.0**, use the `defaultUpdateMethod` constructor parameter instead. If
62307
+ * unset, the update method is determined from the `defaultUpdateMethod` constructor parameter. If `true`,
62308
+ * `sap.ui.model.odata.UpdateMethod.MERGE` is used for update operations; if set to `false`, `sap.ui.model.odata.UpdateMethod.PUT`
62309
+ * is used.
62234
62310
  */
62235
62311
  merge?: boolean;
62236
62312
  }
@@ -62289,7 +62365,7 @@ declare namespace sap {
62289
62365
  */
62290
62366
  headers?: Record<string, string>;
62291
62367
  /**
62292
- * Deprecated - use `groupId` instead
62368
+ * **Deprecated as of version 1.31.0**, use `groupId` instead
62293
62369
  */
62294
62370
  batchGroupId?: string;
62295
62371
  /**
@@ -63100,7 +63176,7 @@ declare namespace sap {
63100
63176
  *
63101
63177
  * Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
63102
63178
  * the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
63103
- * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0 this does not apply to annotations
63179
+ * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations
63104
63180
  * on a parameter. In the former case, we assume that the resulting data binding is relative to the parent
63105
63181
  * context of the operation binding, that is, to the context representing the binding parameter itself.
63106
63182
  * In the latter case, we assume that the resulting data binding is relative to the parameter context of
@@ -63423,7 +63499,7 @@ declare namespace sap {
63423
63499
  *
63424
63500
  * Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter,
63425
63501
  * the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression
63426
- * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0 this does not apply to annotations
63502
+ * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations
63427
63503
  * on a parameter. In the former case, we assume that the resulting data binding is relative to the parent
63428
63504
  * context of the operation binding, that is, to the context representing the binding parameter itself.
63429
63505
  * In the latter case, we assume that the resulting data binding is relative to the parameter context of
@@ -63538,6 +63614,11 @@ declare namespace sap {
63538
63614
  * apply to annotations on a parameter (since 1.76.0).
63539
63615
  */
63540
63616
  overload?: object;
63617
+ /**
63618
+ * Optional prefix to be added to each dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath";
63619
+ * is either an empty string or a path ending with a "/" (since 1.141.0)
63620
+ */
63621
+ prefix?: string;
63541
63622
  }
63542
63623
  ): string;
63543
63624
  }
@@ -63741,7 +63822,7 @@ declare namespace sap {
63741
63822
  * as a binding context. Exceptions hold for status APIs like {@link #isDeleted}, {@link #isKeepAlive},
63742
63823
  * {@link #hasPendingChanges}, {@link #resetChanges}, or {@link #isSelected} (returns `false` since 1.114.0).
63743
63824
  *
63744
- * Since 1.105 such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
63825
+ * Since 1.105, such a pending deletion is a pending change. It causes `hasPendingChanges` to return `true`
63745
63826
  * for the context, the binding containing it, and the model. The `resetChanges` method called on the context,
63746
63827
  * the binding, or the model cancels the deletion and restores the context.
63747
63828
  *
@@ -63785,7 +63866,7 @@ declare namespace sap {
63785
63866
  * binding is used, see {@link #getUpdateGroupId}. Since 1.81, if this context is transient (see {@link #isTransient}),
63786
63867
  * no group ID needs to be specified. Since 1.98.0, you can use `null` to prevent the DELETE request in
63787
63868
  * case of a kept-alive context that is not in the collection and of which you know that it does not exist
63788
- * on the server anymore (for example, a draft after activation). Since 1.108.0 the usage of a group ID
63869
+ * on the server anymore (for example, a draft after activation). Since 1.108.0, the usage of a group ID
63789
63870
  * with {@link sap.ui.model.odata.v4.SubmitMode.API} is possible. Since 1.121.0, you can use the '$single'
63790
63871
  * group ID to send a DELETE request as fast as possible; it will be wrapped in a batch request as for a
63791
63872
  * '$auto' group.
@@ -64107,8 +64188,8 @@ declare namespace sap {
64107
64188
  */
64108
64189
  oParameters: {
64109
64190
  /**
64110
- * Whether the node should be copied instead of moved (@experimental as of version 1.135.0). The returned
64111
- * promise resolves with the index for the copied node.
64191
+ * Whether the node should be copied instead of moved. The returned promise resolves with the index for
64192
+ * the copied node. Supported since 1.141.0.
64112
64193
  */
64113
64194
  copy?: boolean;
64114
64195
  /**
@@ -64222,7 +64303,7 @@ declare namespace sap {
64222
64303
  requestParent(): Promise<sap.ui.model.odata.v4.Context | null>;
64223
64304
  /**
64224
64305
  * Returns a promise on the property value for the given path relative to this context. The path is expected
64225
- * to point to a structural property with primitive type. Since 1.81.1 it is possible to request more than
64306
+ * to point to a structural property with primitive type. Since 1.81.1, it is possible to request more than
64226
64307
  * one property. Property values that are not cached yet are requested from the back end.
64227
64308
  * See:
64228
64309
  * sap.ui.model.odata.v4.ODataMetaModel#requestUI5Type
@@ -64321,7 +64402,7 @@ declare namespace sap {
64321
64402
  * (unless listed explicitly), for example `[{$PropertyPath : "*"}, {$NavigationPropertyPath : "EMPLOYEE_2_MANAGER"}]`
64322
64403
  * or `[{$PropertyPath : "EMPLOYEE_2_MANAGER/*"}]`.
64323
64404
  *
64324
- * Since 1.82.0 absolute paths are supported. Absolute paths must start with the entity container (example
64405
+ * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
64325
64406
  * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
64326
64407
  * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.4.11 Expression edm:String"
64327
64408
  * is accepted as well.
@@ -64402,7 +64483,7 @@ declare namespace sap {
64402
64483
  /**
64403
64484
  * Sets a new value for the property identified by the given path. The path is relative to this context
64404
64485
  * and is expected to point to a structural property with primitive type or, since 1.85.0, to an instance
64405
- * annotation. Since 1.122.0 the client-side annotation "@$ui5.context.isSelected" can be given as a path.
64486
+ * annotation. Since 1.122.0, the client-side annotation "@$ui5.context.isSelected" can be given as a path.
64406
64487
  * Note: Writing to a client-side annotation never initiates a PATCH request, even if `sGroupId` is given.
64407
64488
  * Thus, reverting the value of this annotation cannot be done via {@link #resetChanges}.
64408
64489
  * See:
@@ -64854,11 +64935,12 @@ declare namespace sap {
64854
64935
  * messages will be related to the return value context only. Such a message can only be connected to a
64855
64936
  * corresponding control if the control's property bindings use the return value context as binding context.
64856
64937
  *
64857
- * A return value context may also be provided if the parent context's path contains a maximum of one navigation
64858
- * property. In addition to the existing preconditions for a return value context, the metadata has to specify
64859
- * a partner attribute for the navigation property and the partner relationship has to be bi-directional.
64860
- * Also the navigation property binding has to be available in the entity set of the first segment in the
64861
- * parent context's path (@experimental as of version 1.119.0).
64938
+ * Since 1.141.0, a return value context may also be provided if the parent context's path contains a maximum
64939
+ * of one navigation property. In addition to the existing preconditions for a return value context, the
64940
+ * metadata has to specify a partner attribute for the navigation property and the partner relationship
64941
+ * has to be bi-directional. Also a navigation property binding has to be available for the entity set of
64942
+ * the first segment in the parent context's path. **Note:** Ensure your service implementation returns
64943
+ * all selected key properties; otherwise, no return value context is provided.
64862
64944
  */
64863
64945
  invoke(
64864
64946
  /**
@@ -65022,7 +65104,7 @@ declare namespace sap {
65022
65104
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
65023
65105
  * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive }
65024
65106
  * context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
65025
- * of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0 {@link sap.ui.model.odata.v4.Context#delete deleted }
65107
+ * of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0, {@link sap.ui.model.odata.v4.Context#delete deleted }
65026
65108
  * contexts do not count as pending changes.
65027
65109
  * See:
65028
65110
  * {@link https://ui5.sap.com/#/topic/b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
@@ -65291,12 +65373,15 @@ declare namespace sap {
65291
65373
  * set `bSkipRefresh` to `true`. To avoid errors you must skip this refresh when using {@link sap.ui.model.odata.v4.Context#requestSideEffects }
65292
65374
  * in the same $batch to refresh the complete collection containing the newly created entity.
65293
65375
  *
65294
- * Since 1.115.0 it is possible to create nested entities in a collection-valued navigation property together
65376
+ * Since 1.115.0, it is possible to create nested entities in a collection-valued navigation property together
65295
65377
  * with the entity (so-called "deep create"), for example a list of items for an order. For this purpose,
65296
65378
  * bind the list relative to a transient context. Calling this method then adds a transient entity to the
65297
65379
  * parent's navigation property, which is sent with the payload of the parent entity. Such a nested context
65298
65380
  * cannot be inactive.
65299
65381
  *
65382
+ * **Caution:** Only a single list must be bound to the same collection-valued navigation property relative
65383
+ * to a transient context. Created data cannot be shared between list bindings.
65384
+ *
65300
65385
  * **Note:** After a successful creation of the main entity the context returned for a nested entity is
65301
65386
  * no longer valid. Do not use the {@link sap.ui.model.odata.v4.Context#created created} promise of such
65302
65387
  * a context! New contexts are created for the nested collection because it is not possible to reliably
@@ -65304,7 +65389,7 @@ declare namespace sap {
65304
65389
  * the `created` promises of all nested contexts are always rejected with an instance of `Error`, even if
65305
65390
  * the deep create succeeds. This error always has the property `canceled` with the value `true`.
65306
65391
  *
65307
- * Since 1.118.0 deep create also supports single-valued navigation properties; no API call is required
65392
+ * Since 1.118.0, deep create also supports single-valued navigation properties; no API call is required
65308
65393
  * in this case. Simply bind properties of the related entity relative to a transient context. An update
65309
65394
  * to the property adds it to the POST request of the parent entity, and by this the create becomes deep.
65310
65395
  *
@@ -65356,7 +65441,7 @@ declare namespace sap {
65356
65441
  */
65357
65442
  bSkipRefresh?: boolean,
65358
65443
  /**
65359
- * Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0 the first
65444
+ * Whether the entity is inserted at the end of the list. Supported since 1.66.0. Since 1.99.0, the first
65360
65445
  * insertion determines the overall position of created contexts within the binding's context list. Every
65361
65446
  * succeeding insertion is relative to the created contexts within this list.
65362
65447
  */
@@ -65712,7 +65797,7 @@ declare namespace sap {
65712
65797
  getHeaderContext(): sap.ui.model.odata.v4.Context | null;
65713
65798
  /**
65714
65799
  * Calls {@link sap.ui.model.odata.v4.Context#setKeepAlive} at the context for the given path and returns
65715
- * it. Since 1.100.0 the function always returns such a context. If none exists yet, it is created without
65800
+ * it. Since 1.100.0, the function always returns such a context. If none exists yet, it is created without
65716
65801
  * data and a request for its entity is sent.
65717
65802
  * See:
65718
65803
  * sap.ui.model.odata.v4.ODataModel#getKeepAliveContext
@@ -66153,7 +66238,7 @@ declare namespace sap {
66153
66238
  * requests. Call {@link #resume} to resume the binding. Before 1.53.0, this method was not supported and
66154
66239
  * threw an error. Since 1.97.0, pending changes are ignored if they relate to a {@link sap.ui.model.odata.v4.Context#isKeepAlive kept-alive }
66155
66240
  * context of this binding. Since 1.98.0, {@link sap.ui.model.odata.v4.Context#isTransient transient} contexts
66156
- * of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0 {@link sap.ui.model.odata.v4.Context#delete deleted }
66241
+ * of a {@link #getRootBinding root binding} do not count as pending changes. Since 1.108.0, {@link sap.ui.model.odata.v4.Context#delete deleted }
66157
66242
  * contexts do not count as pending changes.
66158
66243
  * See:
66159
66244
  * {@link https://ui5.sap.com/#/topic/b0f5c531e5034a27952cc748954cbe39 Suspend and Resume}
@@ -66721,9 +66806,9 @@ declare namespace sap {
66721
66806
  * results either in a simple name like "EMPLOYEES" or maybe in a path like "some.other.EntityContainer/SomeEntitySet".
66722
66807
  * The path must not continue after "@sapui.name".
66723
66808
  *
66724
- * If the current object is a string value, that string value is treated as a relative path and followed
66725
- * step-by-step before the next segment is processed. Except for this, a path must not continue if it comes
66726
- * across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."),
66809
+ * If the current object is a string value, that string value is treated as an absolute or relative path
66810
+ * and followed step-by-step before the next segment is processed. Except for this, a path must not continue
66811
+ * if it comes across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."),
66727
66812
  * a simple identifier (example path "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/...") including
66728
66813
  * the special name "$ReturnType" (since 1.71.0), or even a path according to "14.5.12 Expression edm:Path"
66729
66814
  * etc. (example path "/TEAMS/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...".
@@ -66785,6 +66870,10 @@ declare namespace sap {
66785
66870
  * way, "/acme.DefaultContainer/EMPLOYEES" addresses the "EMPLOYEES" child of the schema child named "acme.DefaultContainer".
66786
66871
  * This also works indirectly ("/$EntityContainer/EMPLOYEES") and implicitly ("/EMPLOYEES", see below).
66787
66872
  *
66873
+ * Since 1.140.0, the special name "$count" can be used as the last segment instead of an OData simple identifier.
66874
+ * For an entity set or a collection-valued (structural or navigation) property, it is treated as a property
66875
+ * of type "Edm.Int64". Otherwise, it is invalid.
66876
+ *
66788
66877
  * A segment which represents an OData simple identifier (or the special names "$ReturnType", since 1.71.0,
66789
66878
  * or "$Parameter", since 1.73.0) needs special preparations. The same applies to the empty segment after
66790
66879
  * a trailing slash. If the current object has a "$Action", "$Function" or "$Type" property, it
@@ -66871,7 +66960,7 @@ declare namespace sap {
66871
66960
  /**
66872
66961
  * Scope for lookup of aliases for computed annotations (since 1.43.0) as a map from alias to a module (like
66873
66962
  * `{AH : AnnotationHelper}`) or function (like `{format : AnnotationHelper.format}`); the alias must not
66874
- * contain a dot. Since 1.120.3 looking up a computed annotation via its global name is **deprecated**;
66963
+ * contain a dot. Since 1.120.3, looking up a computed annotation via its global name is **deprecated**;
66875
66964
  * always use this scope instead.
66876
66965
  */
66877
66966
  scope?: Record<string, object | Function>;
@@ -67822,8 +67911,8 @@ declare namespace sap {
67822
67911
  * Returns a context with the given path belonging to a matching list binding that has been marked with
67823
67912
  * `$$getKeepAliveContext` (see {@link #bindList}). If such a matching binding can be found, a context is
67824
67913
  * returned and kept alive (see {@link sap.ui.model.odata.v4.ODataListBinding#getKeepAliveContext}). Since
67825
- * 1.100.0 a temporary binding is used if no such binding could be found. If such a binding is created or
67826
- * resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
67914
+ * 1.100.0, a temporary binding is used if no such binding could be found. If such a binding is created
67915
+ * or resolved later, the context and its data are transferred to it, and the temporary binding is destroyed
67827
67916
  * again.
67828
67917
  *
67829
67918
  * A `$$getKeepAliveContext` binding matches if its resolved binding path is the collection path of the
@@ -68067,6 +68156,28 @@ declare namespace sap {
68067
68156
  */
68068
68157
  sGroupId?: string
68069
68158
  ): void;
68159
+ /**
68160
+ * Sets the "odata.continue-on-error" preference for the **current** batch request associated with the given
68161
+ * group ID. This method can be called early on, when the batch queue is still empty, or even synchronously
68162
+ * after {@link #submitBatch} - just as long as the $batch request is not already being sent to the server.
68163
+ * It needs to be called again for future batch requests with the same group ID. It is safe to call it multiple
68164
+ * times for the same batch request.
68165
+ *
68166
+ * **Caution:** Make sure that no user input is lost due to a side-effects GET being applied even after
68167
+ * a failed PATCH. It's safe to use this method if, for example, only actions are invoked or when {@link sap.ui.model.odata.v4.Context#setProperty }
68168
+ * is used without `bRetry` for mass updates.
68169
+ *
68170
+ * @since 1.141.0
68171
+ */
68172
+ setContinueOnError(
68173
+ /**
68174
+ * A valid group ID as specified in {@link sap.ui.model.odata.v4.ODataModel}. Avoid '$auto' to control which
68175
+ * requests are affected by this preference. Using a {@link module:sap/base/util/uid UID} may be one way
68176
+ * to achieve this, but take care to replace hyphens with underscores: `"$auto." + uid().replaceAll("-",
68177
+ * "_")`
68178
+ */
68179
+ sGroupId: string
68180
+ ): void;
68070
68181
  /**
68071
68182
  * Method not supported
68072
68183
  *
@@ -68412,7 +68523,7 @@ declare namespace sap {
68412
68523
  * Sets the new current value and updates the cache. If the value cannot be accepted or cannot be updated
68413
68524
  * on the server, an error is logged to the console and added to the message manager as a technical message.
68414
68525
  * Unless preconditions fail synchronously, a {@link sap.ui.model.odata.v4.ODataModel#event:propertyChange 'propertyChange' }
68415
- * event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0 this
68526
+ * event is fired and provides a promise on the outcome of the asynchronous operation. Since 1.122.0, this
68416
68527
  * method allows updates to the client-side annotation "@$ui5.context.isSelected". Note: Changing the value
68417
68528
  * of a client-side annotation never initiates a PATCH request, no matter which `sGroupId` is given. Thus,
68418
68529
  * it cannot be reverted via {@link #resetChanges}.
@@ -70733,12 +70844,13 @@ declare namespace sap {
70733
70844
  */
70734
70845
  async?: boolean;
70735
70846
  /**
70736
- * **Deprecated** for security reasons. Use strong server side authentication instead. UserID for the service.
70847
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
70848
+ * UserID for the service.
70737
70849
  */
70738
70850
  user?: string;
70739
70851
  /**
70740
- * **Deprecated** for security reasons. Use strong server side authentication instead. Password for the
70741
- * service.
70852
+ * **Deprecated as of version 1.75.0** for security reasons. Use strong server side authentication instead.
70853
+ * Password for the service.
70742
70854
  */
70743
70855
  password?: string;
70744
70856
  /**
@@ -74707,8 +74819,14 @@ declare namespace sap {
74707
74819
  */
74708
74820
  oFormatOptions?: {
74709
74821
  /**
74710
- * The number of decimals to be used for formatting the number part of the unit; defaults to **3** if none
74711
- * of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` is given
74822
+ * The number of decimals to be used for formatting the numerical value of the unit composite type; if none
74823
+ * of the format options `maxFractionDigits`, `minFractionDigits` or `decimals` are given, the following
74824
+ * defaults apply:
74825
+ * - **0** if the numerical value is of an OData integer type, i.e. {@link sap.ui.model.odata.type.Int }
74826
+ * or {@link sap.ui.model.odata.type.Int64}
74827
+ * - the **scale constraint of the numerical value's type** if this type is {@link sap.ui.model.odata.type.Decimal }
74828
+ * and the scale is not "variable"
74829
+ * - **3** otherwise
74712
74830
  */
74713
74831
  decimals?: object;
74714
74832
  /**
@@ -74986,7 +75104,7 @@ declare namespace sap {
74986
75104
  async?: boolean;
74987
75105
 
74988
75106
  /**
74989
- * Additional information for the request (if available) **deprecated**
75107
+ * **Deprecated as of version 1.38.0.**, additional information for the request (if available)
74990
75108
  */
74991
75109
  info?: string;
74992
75110
 
@@ -75041,7 +75159,7 @@ declare namespace sap {
75041
75159
  async?: boolean;
75042
75160
 
75043
75161
  /**
75044
- * Additional information for the request (if available) **deprecated**
75162
+ * **Deprecated as of version 1.38.0.**, additional information for the request (if available)
75045
75163
  */
75046
75164
  info?: string;
75047
75165
 
@@ -82165,7 +82283,7 @@ declare namespace sap {
82165
82283
  *
82166
82284
  *
82167
82285
  * - Trim spaces off the string on both sides. For example: `" hello "` becomes `"hello"`.
82168
- * - Assume that dashes and underscores are analogs for a space. For example: `"sold-to party"` and `"sold
82286
+ * - Assume that hyphens and underscores are analogs for a space. For example: `"sold-to party"` and `"sold
82169
82287
  * to party"` are equivalent, and would both convert to the camelCase `"soldToParty"`.
82170
82288
  * - Trim multiple spaces between words. For example: `"hello____world"` becomes `"hello world"`.
82171
82289
  * - Remove any characters that are not alphanumeric or whitespace. For example: `"(hello)"` becomes `"hello"`.