@sapui5/ts-types 1.109.3 → 1.110.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 (65) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +1 -1
  4. package/types/sap.ca.ui.d.ts +1 -1
  5. package/types/sap.chart.d.ts +39 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +235 -28
  8. package/types/sap.f.d.ts +49 -28
  9. package/types/sap.fe.core.d.ts +85 -22
  10. package/types/sap.fe.macros.d.ts +84 -36
  11. package/types/sap.fe.navigation.d.ts +316 -936
  12. package/types/sap.fe.templates.d.ts +103 -8
  13. package/types/sap.fe.test.d.ts +25 -24
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +176 -29
  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 +4272 -712
  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 +20 -8
  22. package/types/sap.ovp.d.ts +125 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.df.d.ts +102 -4
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +51 -1
  27. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +1 -1
  30. package/types/sap.ui.codeeditor.d.ts +4 -2
  31. package/types/sap.ui.commons.d.ts +86 -32
  32. package/types/sap.ui.comp.d.ts +89 -20
  33. package/types/sap.ui.core.d.ts +4160 -3750
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +86 -1
  36. package/types/sap.ui.fl.d.ts +12 -2
  37. package/types/sap.ui.generic.app.d.ts +59 -4
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +60 -41
  40. package/types/sap.ui.layout.d.ts +12 -12
  41. package/types/sap.ui.mdc.d.ts +11 -7
  42. package/types/sap.ui.richtexteditor.d.ts +19 -10
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +51 -349
  46. package/types/sap.ui.table.d.ts +66 -10
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +102 -322
  49. package/types/sap.ui.ux3.d.ts +7 -3
  50. package/types/sap.ui.vbm.d.ts +1 -1
  51. package/types/sap.ui.vk.d.ts +122 -1
  52. package/types/sap.ui.vtm.d.ts +1 -1
  53. package/types/sap.ui.webc.common.d.ts +1 -1
  54. package/types/sap.ui.webc.fiori.d.ts +6 -6
  55. package/types/sap.ui.webc.main.d.ts +5 -5
  56. package/types/sap.uiext.inbox.d.ts +1 -1
  57. package/types/sap.ushell.d.ts +32 -81
  58. package/types/sap.ushell_abap.d.ts +1 -1
  59. package/types/sap.uxap.d.ts +8 -29
  60. package/types/sap.viz.d.ts +1 -1
  61. package/types/sap.webanalytics.core.d.ts +1 -1
  62. package/types/sap.zen.commons.d.ts +1 -1
  63. package/types/sap.zen.crosstab.d.ts +1 -1
  64. package/types/sap.zen.dsh.d.ts +1 -1
  65. package/types/sap.fe.common.d.ts +0 -3
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.109.0
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -34,7 +34,7 @@ declare namespace sap {
34
34
  * Context of the document
35
35
  */
36
36
  oContext: object
37
- ): Promise<any>;
37
+ ): Promise<void>;
38
38
  /**
39
39
  * @SINCE 1.90.0
40
40
  *
@@ -96,7 +96,7 @@ declare namespace sap {
96
96
  */
97
97
  outbound?: string;
98
98
  }
99
- ): Promise<any>;
99
+ ): Promise<void>;
100
100
  /**
101
101
  * @SINCE 1.90.0
102
102
  *
@@ -122,7 +122,7 @@ declare namespace sap {
122
122
  */
123
123
  title: string;
124
124
  }
125
- ): Promise<any>;
125
+ ): Promise<void>;
126
126
  /**
127
127
  * @SINCE 1.90.0
128
128
  *
@@ -135,7 +135,7 @@ declare namespace sap {
135
135
  * Context of the active document
136
136
  */
137
137
  oContext: /* was: sap.fe.core.V4Context */ any
138
- ): Promise<any>;
138
+ ): Promise<void>;
139
139
  /**
140
140
  * @SINCE 1.90.0
141
141
  *
@@ -198,7 +198,7 @@ declare namespace sap {
198
198
  */
199
199
  skipParameterDialog?: boolean;
200
200
  }
201
- ): Promise<any>;
201
+ ): Promise<void>;
202
202
  /**
203
203
  * @SINCE 1.98.0
204
204
  *
@@ -226,7 +226,7 @@ declare namespace sap {
226
226
  */
227
227
  createParameters?: any[];
228
228
  }
229
- ): Promise<any>;
229
+ ): Promise<void>;
230
230
  /**
231
231
  * @SINCE 1.98.0
232
232
  *
@@ -250,7 +250,7 @@ declare namespace sap {
250
250
  */
251
251
  contexts?: sap.ui.model.odata.v4.Context[];
252
252
  }
253
- ): Promise<any>;
253
+ ): Promise<void>;
254
254
  /**
255
255
  * @SINCE 1.98.0
256
256
  *
@@ -274,7 +274,7 @@ declare namespace sap {
274
274
  */
275
275
  context?: sap.ui.model.odata.v4.Context;
276
276
  }
277
- ): Promise<any>;
277
+ ): Promise<void>;
278
278
  /**
279
279
  * @SINCE 1.98.0
280
280
  *
@@ -298,7 +298,7 @@ declare namespace sap {
298
298
  */
299
299
  context?: sap.ui.model.odata.v4.Context;
300
300
  }
301
- ): Promise<any>;
301
+ ): Promise<void>;
302
302
  /**
303
303
  * @SINCE 1.90.0
304
304
  *
@@ -322,7 +322,7 @@ declare namespace sap {
322
322
  */
323
323
  context?: sap.ui.model.odata.v4.Context;
324
324
  }
325
- ): Promise<any>;
325
+ ): Promise<void>;
326
326
  /**
327
327
  * @SINCE 1.90.0
328
328
  *
@@ -339,7 +339,7 @@ declare namespace sap {
339
339
  * undefined
340
340
  */
341
341
  mParameters: any
342
- ): Promise<any>;
342
+ ): Promise<void>;
343
343
  /**
344
344
  * @SINCE 1.90.0
345
345
  * @EXPERIMENTAL (since 1.90.0)
@@ -380,7 +380,7 @@ declare namespace sap {
380
380
  */
381
381
  updatesDocument?: boolean;
382
382
  }
383
- ): Promise<any>;
383
+ ): Promise<void>;
384
384
  /**
385
385
  * @SINCE 1.90.0
386
386
  *
@@ -398,7 +398,7 @@ declare namespace sap {
398
398
  * update operation is completed, so the draft status can be updated.
399
399
  */
400
400
  oPromise: Promise<any>
401
- ): Promise<any>;
401
+ ): Promise<void>;
402
402
  }
403
403
  /**
404
404
  * @SINCE 1.86.0
@@ -480,7 +480,7 @@ declare namespace sap {
480
480
  * @returns A promise that is resolved once the user closes the dialog. If there are no messages
481
481
  * to be shown, the promise is resolved immediately
482
482
  */
483
- showMessageDialog(): Promise<any>;
483
+ showMessageDialog(): Promise<void>;
484
484
  }
485
485
  /**
486
486
  * @SINCE 1.94.0
@@ -532,7 +532,7 @@ declare namespace sap {
532
532
  */
533
533
  navigate(
534
534
  /**
535
- * Object containing the context to be navigated
535
+ * Object containing the context to be navigated to
536
536
  */
537
537
  oContext: sap.ui.model.odata.v4.Context
538
538
  ): void;
@@ -550,7 +550,7 @@ declare namespace sap {
550
550
  * Parameters to be used with route to create the target hash
551
551
  */
552
552
  oParameters?: any
553
- ): Promise<any>;
553
+ ): Promise<boolean>;
554
554
  /**
555
555
  * @SINCE 1.90.0
556
556
  *
@@ -690,7 +690,7 @@ declare namespace sap {
690
690
  */
691
691
  url: string;
692
692
  }
693
- ): object | Promise<any>;
693
+ ): object | Promise<object>;
694
694
  /**
695
695
  * @SINCE 1.93.0
696
696
  *
@@ -952,6 +952,67 @@ declare namespace sap {
952
952
  }
953
953
 
954
954
  namespace rootView {
955
+ /**
956
+ * @SINCE 1.110.0
957
+ *
958
+ * Base controller class for your own root view with an sap.f.FlexibleColumnLayout control.
959
+ * By using or extending this controller, you can use your own root view with the sap.fe.core.AppComponent
960
+ * and
961
+ * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
962
+ */
963
+ class Fcl /* was: sap.fe.core.RootViewBaseController */ extends Object {
964
+ constructor();
965
+
966
+ /**
967
+ * Method that creates a new Page to display the IllustratedMessage containing the current error.
968
+ *
969
+ * @returns A promise that creates a Page to display the error
970
+ */
971
+ displayErrorPage(): Promise<boolean>;
972
+ /**
973
+ * @SINCE 1.91.0
974
+ *
975
+ * Returns the current app component.
976
+ *
977
+ * @returns The app component or, if not found, null
978
+ */
979
+ getAppComponent(): sap.fe.core.AppComponent;
980
+ /**
981
+ * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
982
+ * name into each controller.
983
+ *
984
+ * @returns The model instance
985
+ */
986
+ getModel(
987
+ /**
988
+ * The model name
989
+ */
990
+ sName?: string
991
+ ): sap.ui.model.Model;
992
+ /**
993
+ * Convenience method for getting the resource bundle.
994
+ *
995
+ * @returns The resourceModel of the component
996
+ */
997
+ getResourceBundle(): /* was: sap.base.i18n.ResourceBundle */
998
+ | any
999
+ | Promise</* was: sap.base.i18n.ResourceBundle */ any>;
1000
+ /**
1001
+ * Convenience method for setting the view model in every controller of the application.
1002
+ *
1003
+ * @returns The view instance
1004
+ */
1005
+ setModel(
1006
+ /**
1007
+ * The model instance
1008
+ */
1009
+ oModel: sap.ui.model.Model,
1010
+ /**
1011
+ * The model name
1012
+ */
1013
+ sName: string
1014
+ ): sap.ui.core.mvc.View;
1015
+ }
955
1016
  /**
956
1017
  * @SINCE 1.108.0
957
1018
  *
@@ -969,7 +1030,7 @@ declare namespace sap {
969
1030
  *
970
1031
  * @returns A promise that creates a Page to display the error
971
1032
  */
972
- displayErrorPage(): Promise<any>;
1033
+ displayErrorPage(): Promise<boolean>;
973
1034
  /**
974
1035
  * @SINCE 1.91.0
975
1036
  *
@@ -997,7 +1058,7 @@ declare namespace sap {
997
1058
  */
998
1059
  getResourceBundle(): /* was: sap.base.i18n.ResourceBundle */
999
1060
  | any
1000
- | Promise<any>;
1061
+ | Promise</* was: sap.base.i18n.ResourceBundle */ any>;
1001
1062
  /**
1002
1063
  * Convenience method for setting the view model in every controller of the application.
1003
1064
  *
@@ -1200,7 +1261,7 @@ declare namespace sap {
1200
1261
  */
1201
1262
  name: string;
1202
1263
  }
1203
- ): Promise<any>;
1264
+ ): Promise<sap.ui.core.Element | sap.ui.core.Element[]>;
1204
1265
  /**
1205
1266
  * Navigate to another target.
1206
1267
  */
@@ -1229,7 +1290,7 @@ declare namespace sap {
1229
1290
  *
1230
1291
  * @returns A promise that resolves with the new app state object.
1231
1292
  */
1232
- updateAppState(): Promise<any>;
1293
+ updateAppState(): Promise<void | object>;
1233
1294
  }
1234
1295
  /**
1235
1296
  * @SINCE 1.88.0
@@ -1332,6 +1393,8 @@ declare namespace sap {
1332
1393
 
1333
1394
  "sap/fe/core/PageController": undefined;
1334
1395
 
1396
+ "sap/fe/core/rootView/Fcl.controller": undefined;
1397
+
1335
1398
  "sap/fe/core/rootView/NavContainer.controller": undefined;
1336
1399
  }
1337
1400
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.109.0
1
+ // For Library Version: 1.110.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -6,15 +6,6 @@ declare namespace sap {
6
6
  * Library containing the building blocks for SAP Fiori elements.
7
7
  */
8
8
  namespace macros {
9
- /**
10
- * @SINCE 1.90.0
11
- *
12
- * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
13
- * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
14
- * of the syntax of the settings object.
15
- */
16
- export const FormElement: undefined;
17
-
18
9
  namespace field {
19
10
  interface $TextAreaExSettings extends sap.m.$TextAreaSettings {}
20
11
 
@@ -92,7 +83,7 @@ declare namespace sap {
92
83
  };
93
84
  }
94
85
 
95
- interface $MacroAPISettings extends sap.ui.core.$ElementSettings {
86
+ interface $MacroAPISettings extends sap.ui.core.$ControlSettings {
96
87
  /**
97
88
  * Defines the path of the context used in the current page or block.
98
89
  * This setting is defined by the framework.
@@ -209,6 +200,22 @@ declare namespace sap {
209
200
  */
210
201
  metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
211
202
 
203
+ /**
204
+ * Handles the visibility of the 'Clear' button on the FilterBar.
205
+ */
206
+ showClearButton?:
207
+ | boolean
208
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
209
+ | `{${string}}`;
210
+
211
+ /**
212
+ * Displays possible errors during the search in a message box
213
+ */
214
+ showMessages?:
215
+ | boolean
216
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
217
+ | `{${string}}`;
218
+
212
219
  /**
213
220
  * Parameter which sets the visibility of the FilterBar building block
214
221
  */
@@ -216,6 +223,15 @@ declare namespace sap {
216
223
  | boolean
217
224
  | sap.ui.base.ManagedObject.PropertyBindingInfo
218
225
  | `{${string}}`;
226
+
227
+ /**
228
+ * Aggregate filter fields of the FilterBar building block
229
+ */
230
+ filterFields?:
231
+ | sap.fe.macros.FilterField[]
232
+ | sap.fe.macros.FilterField
233
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
234
+ | `{${string}}`;
219
235
  }
220
236
 
221
237
  interface $FormSettings extends sap.fe.macros.$MacroAPISettings {
@@ -241,6 +257,42 @@ declare namespace sap {
241
257
  title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
242
258
  }
243
259
 
260
+ interface $FormElementSettings extends sap.fe.macros.$MacroAPISettings {
261
+ /**
262
+ * Defines the path of the context used in the current page or block. This setting is defined by the framework.
263
+ */
264
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
265
+
266
+ /**
267
+ * The identifier of the FormElement control.
268
+ */
269
+ id?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
270
+
271
+ /**
272
+ * Label shown for the field. If not set, the label from the annotations will be shown.
273
+ */
274
+ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
275
+
276
+ /**
277
+ * Defines the relative path of the property in the metamodel, based on the current contextPath.
278
+ */
279
+ metaPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
280
+
281
+ /**
282
+ * If set to false, the FormElement is not rendered.
283
+ */
284
+ visible?:
285
+ | boolean
286
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
287
+ | `{${string}}`;
288
+
289
+ /**
290
+ * Optional aggregation of controls that should be displayed inside the FormElement.
291
+ * If not set, a default Field building block will be rendered
292
+ */
293
+ fields?: sap.ui.core.Control;
294
+ }
295
+
244
296
  interface $TableSettings extends sap.fe.macros.$MacroAPISettings {
245
297
  /**
246
298
  * An expression that allows you to control the 'busy' state of the table.
@@ -257,7 +309,7 @@ declare namespace sap {
257
309
  contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
258
310
 
259
311
  /**
260
- * Specifies the header text that is shown in the table.
312
+ * Specifies if the column width is automatically calculated.
261
313
  */
262
314
  enableAutoColumnWidth?:
263
315
  | boolean
@@ -388,28 +440,18 @@ declare namespace sap {
388
440
  variantManagement?:
389
441
  | string
390
442
  | sap.ui.base.ManagedObject.PropertyBindingInfo;
391
- }
392
443
 
393
- /**
394
- * @SINCE 1.93.0
395
- *
396
- * Building block used specifically in an app using the flexible column layout to add the ‘expand’, ‘reduce’,
397
- * and ‘close’ action buttons.
398
- *
399
- * Usage example:
400
- * ```javascript
401
- *
402
- * <f:DynamicPageTitle id="incidentProcessFlowDynamicPageTitle">
403
- * <f:navigationActions>
404
- * <macros:FlexibleColumnLayoutActions />
405
- * </f:navigationActions>
406
- * </f:DynamicPageTitle>
407
- * <macro:FlexibleColumnLayoutActions />
408
- * ```
409
- */
410
- class FlexibleColumnLayoutActions {
411
- constructor();
444
+ /**
445
+ * Aggregate actions of the table.
446
+ */
447
+ actions?: sap.fe.macros.table.Action;
448
+
449
+ /**
450
+ * Aggregate columns of the table.
451
+ */
452
+ columns?: sap.fe.macros.table.Column;
412
453
  }
454
+
413
455
  /**
414
456
  * @SINCE 1.93.0
415
457
  *
@@ -456,7 +498,7 @@ declare namespace sap {
456
498
  /**
457
499
  * Base API control for building blocks.
458
500
  */
459
- class MacroAPI extends sap.ui.core.Element {
501
+ class MacroAPI extends sap.ui.core.Control {
460
502
  constructor();
461
503
  }
462
504
  /**
@@ -582,7 +624,7 @@ declare namespace sap {
582
624
  * The values to be applied
583
625
  */
584
626
  vValues?: string | number | boolean | string[] | number[] | boolean[]
585
- ): Promise<any>;
627
+ ): Promise<void>;
586
628
  }
587
629
  /**
588
630
  * Building block for creating a Form based on the metadata provided by OData V4.
@@ -600,6 +642,12 @@ declare namespace sap {
600
642
  class Form extends sap.fe.macros.MacroAPI {
601
643
  constructor();
602
644
  }
645
+ /**
646
+ * Building block used to create a form element based on the metadata provided by OData V4.
647
+ */
648
+ class FormElement extends sap.fe.macros.MacroAPI {
649
+ constructor();
650
+ }
603
651
  /**
604
652
  * Building block used to create a table based on the metadata provided by OData V4.
605
653
  *
@@ -739,8 +787,6 @@ declare namespace sap {
739
787
  interface IUI5DefineDependencyNames {
740
788
  "sap/fe/macros/chart/ChartAPI": undefined;
741
789
 
742
- "sap/fe/macros/fcl/FlexibleColumnLayoutActions.metadata": undefined;
743
-
744
790
  "sap/fe/macros/field/FieldAPI": undefined;
745
791
 
746
792
  "sap/fe/macros/field/TextAreaEx": undefined;
@@ -749,6 +795,8 @@ declare namespace sap {
749
795
 
750
796
  "sap/fe/macros/form/FormAPI": undefined;
751
797
 
798
+ "sap/fe/macros/form/FormElementAPI": undefined;
799
+
752
800
  "sap/fe/macros/library": undefined;
753
801
 
754
802
  "sap/fe/macros/MacroAPI": undefined;