@openui5/ts-types 1.127.0 → 1.128.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.127.0
282
+ // For Library Version: 1.128.0
283
283
 
284
284
  declare module "sap/base/assert" {
285
285
  /**
@@ -7909,7 +7909,7 @@ declare namespace sap {
7909
7909
  * // module 'Something' wants to use third party library 'URI.js'
7910
7910
  * // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
7911
7911
  * // the following shim helps UI5 to correctly load URI.js and to retrieve the module's export value
7912
- * // Apps don't have to define that shim, it is already applied by ui5loader-autconfig.js
7912
+ * // Apps don't have to define that shim, it is already applied by ui5loader-autoconfig.js
7913
7913
  * sap.ui.loader.config({
7914
7914
  * shim: {
7915
7915
  * 'sap/ui/thirdparty/URI': {
@@ -8158,7 +8158,7 @@ declare namespace sap {
8158
8158
  * // module 'Something' wants to use third party library 'URI.js'
8159
8159
  * // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
8160
8160
  * // the following shim helps UI5 to correctly load URI.js and to retrieve the module's export value
8161
- * // Apps don't have to define that shim, it is already applied by ui5loader-autconfig.js
8161
+ * // Apps don't have to define that shim, it is already applied by ui5loader-autoconfig.js
8162
8162
  * sap.ui.loader.config({
8163
8163
  * shim: {
8164
8164
  * 'sap/ui/thirdparty/URI': {
@@ -8401,7 +8401,7 @@ declare namespace sap {
8401
8401
  * // module 'Something' wants to use third party library 'URI.js'
8402
8402
  * // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
8403
8403
  * // the following shim helps UI5 to correctly load URI.js and to retrieve the module's export value
8404
- * // Apps don't have to define that shim, it is already applied by ui5loader-autconfig.js
8404
+ * // Apps don't have to define that shim, it is already applied by ui5loader-autoconfig.js
8405
8405
  * sap.ui.loader.config({
8406
8406
  * shim: {
8407
8407
  * 'sap/ui/thirdparty/URI': {
@@ -8645,7 +8645,7 @@ declare namespace sap {
8645
8645
  * // module 'Something' wants to use third party library 'URI.js'
8646
8646
  * // It is packaged by UI5 as non-UI5-module 'sap/ui/thirdparty/URI'
8647
8647
  * // the following shim helps UI5 to correctly load URI.js and to retrieve the module's export value
8648
- * // Apps don't have to define that shim, it is already applied by ui5loader-autconfig.js
8648
+ * // Apps don't have to define that shim, it is already applied by ui5loader-autoconfig.js
8649
8649
  * sap.ui.loader.config({
8650
8650
  * shim: {
8651
8651
  * 'sap/ui/thirdparty/URI': {
@@ -8813,7 +8813,7 @@ declare namespace sap {
8813
8813
  * Retrieve the {@link sap.ui.core.Core SAPUI5 Core} instance for the current window.
8814
8814
  *
8815
8815
  * @deprecated (since 1.118) - Please require 'sap/ui/core/Core' instead and use the module export directly
8816
- * without using 'new'."
8816
+ * without using 'new'.
8817
8817
  *
8818
8818
  * @returns the API of the current SAPUI5 Core instance.
8819
8819
  */
@@ -9250,8 +9250,9 @@ declare namespace sap {
9250
9250
  *
9251
9251
  * **Note:** Any other call signature will lead to a runtime error.
9252
9252
  *
9253
- * @deprecated (since 1.56) - Use {@link sap.ui.core.mvc.View.extend View.extend} to define the view class
9254
- * and {@link sap.ui.core.mvc.View.create View.create} to create view instances
9253
+ * @deprecated (since 1.56) - Instead use {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views} by
9254
+ * defining the view class with {@link sap.ui.core.mvc.View.extend View.extend} and creating the view instances
9255
+ * with {@link sap.ui.core.mvc.View.create View.create}.
9255
9256
  *
9256
9257
  * @returns the created JSView instance in the creation case, otherwise undefined
9257
9258
  */
@@ -9302,8 +9303,9 @@ declare namespace sap {
9302
9303
  *
9303
9304
  * **Note:** Any other call signature will lead to a runtime error.
9304
9305
  *
9305
- * @deprecated (since 1.56) - Use {@link sap.ui.core.mvc.View.extend View.extend} to define the view class
9306
- * and {@link sap.ui.core.mvc.View.create View.create} to create view instances
9306
+ * @deprecated (since 1.56) - Instead use {@link topic:e6bb33d076dc4f23be50c082c271b9f0 Typed Views} by
9307
+ * defining the view class with {@link sap.ui.core.mvc.View.extend View.extend} and creating the view instances
9308
+ * with {@link sap.ui.core.mvc.View.create View.create}.
9307
9309
  *
9308
9310
  * @returns the created JSView instance in the creation case, otherwise undefined
9309
9311
  */
@@ -15712,6 +15714,11 @@ declare namespace sap {
15712
15714
  * Native scrolling does not need content wrapper. In this case, ID of the container element should be provided.
15713
15715
  */
15714
15716
  scrollContainerId?: string;
15717
+ /**
15718
+ * if true, the delegate event listeners are called before the event listeners of the element; default is
15719
+ * "false".
15720
+ */
15721
+ callBefore?: boolean;
15715
15722
  }
15716
15723
  );
15717
15724
 
@@ -35906,7 +35913,7 @@ declare namespace sap {
35906
35913
  /**
35907
35914
  * Returns the Configuration of the Core.
35908
35915
  *
35909
- * @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corrsponding
35916
+ * @deprecated (since 1.120) - Please see {@link sap.ui.core.Configuration Configuration} for the corresponding
35910
35917
  * replacements.
35911
35918
  *
35912
35919
  * @returns the Configuration of the current Core.
@@ -36108,7 +36115,7 @@ declare namespace sap {
36108
36115
  *
36109
36116
  * @deprecated (since 0.15.0) - Replaced by `createRenderManager()`
36110
36117
  *
36111
- * @returns A newly createdRenderManeger
36118
+ * @returns A newly created RenderManager
36112
36119
  */
36113
36120
  getRenderManager(): sap.ui.core.RenderManager;
36114
36121
  /**
@@ -36427,7 +36434,7 @@ declare namespace sap {
36427
36434
  * example at the `<body>` tag. Controls can listen to the themeChanged event to realign their appearance
36428
36435
  * after changing the theme. Changing the cozy/compact CSS class should then also be handled as a theme
36429
36436
  * change. In more simple scenarios where the cozy/compact CSS class is added to a DOM element which contains
36430
- * only a few controls it might not be necessary to trigger the realigment of all controls placed in the
36437
+ * only a few controls it might not be necessary to trigger the realignment of all controls placed in the
36431
36438
  * DOM, for example changing the cozy/compact CSS class at a single control
36432
36439
  *
36433
36440
  * @deprecated (since 1.119) - Please use {@link module:sap/ui/core/Theming.notifyContentDensityChanged Theming.notifyContentDensityChanged }
@@ -36460,7 +36467,7 @@ declare namespace sap {
36460
36467
  * internal usage only. They unfortunately allow access to all internals of the Core and therefore break
36461
36468
  * encapsulation and hinder evolution of the Core. The most common use case of accessing the set of all
36462
36469
  * controls/elements or all components can now be addressed by using the APIs {@link sap.ui.core.Element.registry }
36463
- * or {@link sap.ui.core.Component.registry}, respectively. Future refactorings of the Core will only take
36470
+ * or {@link sap.ui.core.Component.registry}, respectively. Future refactoring of the Core will only take
36464
36471
  * existing plugins in the OpenUI5 repository into account.
36465
36472
  */
36466
36473
  registerPlugin(
@@ -36563,7 +36570,7 @@ declare namespace sap {
36563
36570
  *
36564
36571
  * @since 1.10
36565
36572
  * @deprecated (since 1.119) - without replacement. The need to define the location for a theme should be
36566
- * fully covered with the capabiltites of the {@link sap/base/config base configuration}.
36573
+ * fully covered with the capabilities of the {@link sap/base/config base configuration}.
36567
36574
  *
36568
36575
  * @returns the Core, to allow method chaining
36569
36576
  */
@@ -36634,7 +36641,7 @@ declare namespace sap {
36634
36641
  *
36635
36642
  * @since 1.10
36636
36643
  * @deprecated (since 1.119) - without replacement. The need to define the location for a theme should be
36637
- * fully covered with the capabiltites of the {@link sap/base/config base configuration}.
36644
+ * fully covered with the capabilities of the {@link sap/base/config base configuration}.
36638
36645
  *
36639
36646
  * @returns the Core, to allow method chaining
36640
36647
  */
@@ -36668,7 +36675,7 @@ declare namespace sap {
36668
36675
  * internal usage only. They unfortunately allow access to all internals of the Core and therefore break
36669
36676
  * encapsulation and hinder evolution of the Core. The most common use case of accessing the set of all
36670
36677
  * controls/elements or all components can now be addressed by using the APIs {@link sap.ui.core.Element.registry }
36671
- * or {@link sap.ui.core.Component.registry}, respectively. Future refactorings of the Core will only take
36678
+ * or {@link sap.ui.core.Component.registry}, respectively. Future refactoring of the Core will only take
36672
36679
  * existing plugins in the OpenUI5 repository into account.
36673
36680
  */
36674
36681
  unregisterPlugin(
@@ -50621,7 +50628,7 @@ declare namespace sap {
50621
50628
  *
50622
50629
  * This enum is part of the 'sap/ui/core/library' module export and must be accessed by the property 'MessageType'.
50623
50630
  *
50624
- * @deprecated (since 1.120) - Please use {@link sap.ui.core.message.MessageType} instead.
50631
+ * @deprecated (since 1.120) - Please use {@link module:sap/ui/core/message/MessageType} instead.
50625
50632
  */
50626
50633
  enum MessageType {
50627
50634
  /**
@@ -59502,7 +59509,8 @@ declare namespace sap {
59502
59509
  */
59503
59510
  refreshAfterChange?: boolean;
59504
59511
  /**
59505
- * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests
59512
+ * Whether to sequentialize all requests, needed in case the service cannot handle parallel requests. **Deprecated**
59513
+ * as of version 1.128.0, the concept has been discarded.
59506
59514
  */
59507
59515
  sequentializeRequests?: boolean;
59508
59516
  /**
@@ -63284,7 +63292,12 @@ declare namespace sap {
63284
63292
  *
63285
63293
  * @since 1.83.0
63286
63294
  */
63287
- collapse(): void;
63295
+ collapse(
63296
+ /**
63297
+ * Whether to collapse the node and all its descendants (@experimental as of version 1.128.0)
63298
+ */
63299
+ bAll?: boolean
63300
+ ): void;
63288
63301
  /**
63289
63302
  * Returns a promise that is resolved without data when the entity represented by this context has been
63290
63303
  * created in the back end and all selected properties of this entity are available. Expanded navigation
@@ -63650,12 +63663,12 @@ declare namespace sap {
63650
63663
  * will be the new parent itself). Any descendants of that node are then themselves in the "created" state
63651
63664
  * and also become "persisted"; otherwise, their states remain unaffected by the move.
63652
63665
  *
63653
- * Note that a node in the "created" state is not shown in its usual position as defined by the service
63654
- * and the current sort order, but out of place as the first child of its parent. It is even shown if it
63655
- * doesn't match current search or filter criteria! Once it becomes simply "persisted" due to the move (as
63656
- * described above), this special handling ends. The node is then shown in place again, or it might even
63657
- * not be shown anymore due to the search or filter criteria. If the latter happens to this context, its
63658
- * {@link #getIndex index} becomes `undefined`.
63666
+ * Note that nodes in the "created" state are not shown in their usual position as defined by the service
63667
+ * and the current sort order, but out of place as the first children of their parent or as the first roots.
63668
+ * They are even shown if they don't match current search or filter criteria! Once they become simply "persisted"
63669
+ * due to the move (as described above), this special handling ends. These nodes are then shown in place
63670
+ * again, or they might even not be shown anymore due to the search or filter criteria. If the latter happens
63671
+ * to this context, its {@link #getIndex index} becomes `undefined`.
63659
63672
  *
63660
63673
  * @since 1.125.0
63661
63674
  *
@@ -65517,7 +65530,8 @@ declare namespace sap {
65517
65530
  /**
65518
65531
  * Whether created nodes are shown in place at the position specified by the service (@experimental as of
65519
65532
  * version 1.125.0); only the value `true` is allowed. Otherwise, created nodes are displayed out of place
65520
- * as the first child of their parent.
65533
+ * as the first children of their parent or as the first roots, but not in their usual position as defined
65534
+ * by the service and the current sort order.
65521
65535
  */
65522
65536
  createInPlace?: boolean;
65523
65537
  /**
@@ -84295,7 +84309,13 @@ declare namespace sap {
84295
84309
  * See:
84296
84310
  * {@link https://ui5.sap.com/#/topic/2696ab50faad458f9b4027ec2f9b884d Opa5}
84297
84311
  */
84298
- constructor();
84312
+ constructor(
84313
+ /**
84314
+ * An object containing properties and functions. The newly created Opa will be extended by these properties
84315
+ * and functions using jQuery.extend.
84316
+ */
84317
+ extensionObject?: object
84318
+ );
84299
84319
  /**
84300
84320
  * "and" property for chaining
84301
84321
  */
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -1322,14 +1322,20 @@ declare namespace sap {
1322
1322
 
1323
1323
  "sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewInbound": undefined;
1324
1324
 
1325
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/AddTechnicalAttributes": undefined;
1326
+
1325
1327
  "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeDataSource": undefined;
1326
1328
 
1327
1329
  "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeInbound": undefined;
1328
1330
 
1331
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/ChangeOutbound": undefined;
1332
+
1329
1333
  "sap/ui/fl/apply/_internal/changes/descriptor/app/RemoveAllInboundsExceptOne": undefined;
1330
1334
 
1331
1335
  "sap/ui/fl/apply/_internal/changes/descriptor/app/SetAch": undefined;
1332
1336
 
1337
+ "sap/ui/fl/apply/_internal/changes/descriptor/app/SetDescription": undefined;
1338
+
1333
1339
  "sap/ui/fl/apply/_internal/changes/descriptor/app/SetTitle": undefined;
1334
1340
 
1335
1341
  "sap/ui/fl/apply/_internal/changes/descriptor/fiori/SetAbstract": undefined;
@@ -1370,6 +1376,8 @@ declare namespace sap {
1370
1376
 
1371
1377
  "sap/ui/fl/apply/_internal/extensionPoint/Registry": undefined;
1372
1378
 
1379
+ "sap/ui/fl/apply/_internal/flexObjects/AnnotationChange": undefined;
1380
+
1373
1381
  "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange": undefined;
1374
1382
 
1375
1383
  "sap/ui/fl/apply/_internal/flexObjects/CompVariant": undefined;
@@ -1472,8 +1480,6 @@ declare namespace sap {
1472
1480
 
1473
1481
  "sap/ui/fl/registry/Settings": undefined;
1474
1482
 
1475
- "sap/ui/fl/support/_internal/getAllUIChanges": undefined;
1476
-
1477
1483
  "sap/ui/fl/support/_internal/getChangeDependencies": undefined;
1478
1484
 
1479
1485
  "sap/ui/fl/support/_internal/getFlexSettings": undefined;
@@ -1530,7 +1536,7 @@ declare namespace sap {
1530
1536
 
1531
1537
  "sap/ui/fl/write/_internal/flexState/compVariants/CompVariantState": undefined;
1532
1538
 
1533
- "sap/ui/fl/write/_internal/flexState/FlexObjectState": undefined;
1539
+ "sap/ui/fl/write/_internal/flexState/FlexObjectManager": undefined;
1534
1540
 
1535
1541
  "sap/ui/fl/write/_internal/flexState/UI2Personalization/UI2PersonalizationState": undefined;
1536
1542
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -702,7 +702,12 @@ declare namespace sap {
702
702
  /**
703
703
  * Type of the message.
704
704
  */
705
- sType: sap.ui.core.MessageType
705
+ sType: sap.ui.integration.CardMessageType,
706
+ /**
707
+ * Close the message automatically. Default is `false` for most message types. It is `true` for message
708
+ * type `Toast`. **Note** This property has no effect for message type `Loading`.
709
+ */
710
+ bAutoClose: boolean
706
711
  ): void;
707
712
  /**
708
713
  * Triggers an action inside the card.
@@ -2194,7 +2199,12 @@ declare namespace sap {
2194
2199
  /**
2195
2200
  * Type of the message.
2196
2201
  */
2197
- sType: sap.ui.core.MessageType
2202
+ sType: sap.ui.integration.CardMessageType,
2203
+ /**
2204
+ * Close the message automatically. Default is `false` for most message types. It is `true` for message
2205
+ * type `Toast`. **Note** This property has no effect for message type `Loading`.
2206
+ */
2207
+ bAutoClose: boolean
2198
2208
  ): void;
2199
2209
  /**
2200
2210
  * Triggers an action inside the card.
@@ -4109,7 +4119,7 @@ declare namespace sap {
4109
4119
  */
4110
4120
  enum CardBlockingMessageType {
4111
4121
  /**
4112
- * An error ocurred in the card.
4122
+ * An error occurred in the card.
4113
4123
  */
4114
4124
  Error = "Error",
4115
4125
  /**
@@ -4214,6 +4224,45 @@ declare namespace sap {
4214
4224
  */
4215
4225
  TileStandardWide = "TileStandardWide",
4216
4226
  }
4227
+ /**
4228
+ * Card message strip types.
4229
+ *
4230
+ * This enum is part of the 'sap/ui/integration/library' module export and must be accessed by the property
4231
+ * 'CardMessageType'.
4232
+ *
4233
+ * @experimental (since 1.128)
4234
+ */
4235
+ enum CardMessageType {
4236
+ /**
4237
+ * Message is an error
4238
+ */
4239
+ Error = "Error",
4240
+ /**
4241
+ * Message should be just an information
4242
+ */
4243
+ Information = "Information",
4244
+ /**
4245
+ * Informs the user that the content is busy at that moment with a loading operation. Blocks the content
4246
+ * from interaction.
4247
+ */
4248
+ Loading = "Loading",
4249
+ /**
4250
+ * Message has no specific level
4251
+ */
4252
+ None = "None",
4253
+ /**
4254
+ * Message is a success message
4255
+ */
4256
+ Success = "Success",
4257
+ /**
4258
+ * Message is an informative brief toast message. For this type the default behavior is to auto close.
4259
+ */
4260
+ Toast = "Toast",
4261
+ /**
4262
+ * Message is a warning
4263
+ */
4264
+ Warning = "Warning",
4265
+ }
4217
4266
  /**
4218
4267
  * Preview modes for `{@link sap.ui.integration.widgets.Card}`. Helpful in scenarios when the end user is
4219
4268
  * choosing or configuring a card.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.127.0
1
+ // For Library Version: 1.128.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace ui {
@@ -6025,13 +6025,13 @@ declare namespace sap {
6025
6025
  * and the labels are rendered in the same row as the fields or above the fields. This behavior can be influenced
6026
6026
  * by the properties of this layout control.
6027
6027
  *
6028
- * On the {@link sap.ui.layout.form.FormContainer FormContainers}, labels and content fields, {@link sap.ui.layout.GridGata GridData }
6029
- * can be used to change the default rendering. {@link sap.ui.layout.GridGata GridData} is not supported
6028
+ * On the {@link sap.ui.layout.form.FormContainer FormContainers}, labels and content fields, {@link sap.ui.layout.GridData GridData }
6029
+ * can be used to change the default rendering. {@link sap.ui.layout.GridData GridData} is not supported
6030
6030
  * for {@link sap.ui.layout.form.FormElement FormElements}.
6031
6031
  *
6032
- * **Note:** If {@link sap.ui.layout.GridGata GridData} is used, this may result in a much more complex
6032
+ * **Note:** If {@link sap.ui.layout.GridData GridData} is used, this may result in a much more complex
6033
6033
  * layout than the default one. This means that in some cases, the calculation for the other content may
6034
- * not bring the expected result. In such cases, {@link sap.ui.layout.GridGata GridData} should be used
6034
+ * not bring the expected result. In such cases, {@link sap.ui.layout.GridData GridData} should be used
6035
6035
  * for all content controls to disable the default behavior.
6036
6036
  *
6037
6037
  * This control cannot be used stand-alone, it just renders a {@link sap.ui.layout.form.Form Form}, so it