@sapui5/types 1.113.0 → 1.115.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (64) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +0 -1
  3. package/types/sap.apf.d.ts +70 -60
  4. package/types/sap.ca.ui.d.ts +207 -105
  5. package/types/sap.chart.d.ts +148 -129
  6. package/types/sap.collaboration.d.ts +98 -87
  7. package/types/sap.esh.search.ui.d.ts +133 -2
  8. package/types/sap.f.d.ts +1416 -1005
  9. package/types/sap.fe.core.d.ts +55 -166
  10. package/types/sap.fe.macros.d.ts +96 -20
  11. package/types/sap.fe.navigation.d.ts +42 -31
  12. package/types/sap.fe.templates.d.ts +15 -293
  13. package/types/sap.fe.test.d.ts +102 -46
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +1987 -1251
  16. package/types/sap.insights.d.ts +1 -1
  17. package/types/sap.landvisz.d.ts +75 -29
  18. package/types/sap.m.d.ts +7415 -5818
  19. package/types/sap.makit.d.ts +43 -18
  20. package/types/sap.me.d.ts +112 -69
  21. package/types/sap.ndc.d.ts +101 -39
  22. package/types/sap.ovp.d.ts +3 -3
  23. package/types/sap.rules.ui.d.ts +53 -24
  24. package/types/sap.sac.df.d.ts +39 -632
  25. package/types/sap.suite.ui.commons.d.ts +2094 -1437
  26. package/types/sap.suite.ui.generic.template.d.ts +47 -44
  27. package/types/sap.suite.ui.microchart.d.ts +242 -163
  28. package/types/sap.tnt.d.ts +138 -67
  29. package/types/sap.ui.codeeditor.d.ts +37 -30
  30. package/types/sap.ui.commons.d.ts +936 -708
  31. package/types/sap.ui.comp.d.ts +2707 -1862
  32. package/types/sap.ui.core.d.ts +6435 -3941
  33. package/types/sap.ui.dt.d.ts +1 -1
  34. package/types/sap.ui.export.d.ts +38 -32
  35. package/types/sap.ui.fl.d.ts +102 -82
  36. package/types/sap.ui.generic.app.d.ts +59 -50
  37. package/types/sap.ui.generic.template.d.ts +1 -1
  38. package/types/sap.ui.integration.d.ts +2489 -2327
  39. package/types/sap.ui.layout.d.ts +378 -398
  40. package/types/sap.ui.mdc.d.ts +22041 -115
  41. package/types/sap.ui.richtexteditor.d.ts +55 -50
  42. package/types/sap.ui.rta.d.ts +1 -1
  43. package/types/sap.ui.suite.d.ts +13 -11
  44. package/types/sap.ui.support.d.ts +7 -7
  45. package/types/sap.ui.table.d.ts +628 -478
  46. package/types/sap.ui.testrecorder.d.ts +1 -1
  47. package/types/sap.ui.unified.d.ts +1013 -723
  48. package/types/sap.ui.ux3.d.ts +847 -592
  49. package/types/sap.ui.vbm.d.ts +1018 -760
  50. package/types/sap.ui.vk.d.ts +2897 -1896
  51. package/types/sap.ui.vtm.d.ts +650 -479
  52. package/types/sap.ui.webc.common.d.ts +5 -3
  53. package/types/sap.ui.webc.fiori.d.ts +530 -345
  54. package/types/sap.ui.webc.main.d.ts +1114 -835
  55. package/types/sap.uiext.inbox.d.ts +79 -37
  56. package/types/sap.ushell.d.ts +444 -212
  57. package/types/sap.ushell_abap.d.ts +1 -1
  58. package/types/sap.uxap.d.ts +309 -222
  59. package/types/sap.viz.d.ts +932 -521
  60. package/types/sap.webanalytics.core.d.ts +1 -1
  61. package/types/sap.zen.commons.d.ts +15 -10
  62. package/types/sap.zen.crosstab.d.ts +7 -4
  63. package/types/sap.zen.dsh.d.ts +143 -87
  64. package/types/sap.sac.grid.d.ts +0 -774
@@ -20,7 +20,7 @@ declare module "sap/fe/core/AppComponent" {
20
20
  *
21
21
  * - sap.fe.core.rootView.Fcl when using sap.f.routing.Router (FCL use case)
22
22
  */
23
- export default class AppComponent extends UIComponent {
23
+ class AppComponent extends UIComponent {
24
24
  constructor();
25
25
 
26
26
  /**
@@ -49,6 +49,7 @@ declare module "sap/fe/core/AppComponent" {
49
49
  */
50
50
  initializeFeatureToggles(): Promise<void>;
51
51
  }
52
+ export default AppComponent;
52
53
 
53
54
  export interface $AppComponentSettings extends $UIComponentSettings {}
54
55
  }
@@ -68,7 +69,7 @@ declare module "sap/fe/core/BaseController" {
68
69
  * Internal base controller class for SAP Fiori elements application.
69
70
  * If you want to extend a base controller for your custom page, please use for sap.fe.core.PageController.
70
71
  */
71
- export default class BaseController extends Controller {
72
+ class BaseController extends Controller {
72
73
  constructor();
73
74
 
74
75
  /**
@@ -90,7 +91,7 @@ declare module "sap/fe/core/BaseController" {
90
91
  * The model name
91
92
  */
92
93
  sName?: string
93
- ): Model;
94
+ ): Model | undefined;
94
95
  /**
95
96
  * Convenience method for setting the view model in every controller of the application.
96
97
  *
@@ -107,6 +108,7 @@ declare module "sap/fe/core/BaseController" {
107
108
  sName: string
108
109
  ): View;
109
110
  }
111
+ export default BaseController;
110
112
  }
111
113
 
112
114
  declare module "sap/fe/core/ExtensionAPI" {
@@ -114,8 +116,14 @@ declare module "sap/fe/core/ExtensionAPI" {
114
116
 
115
117
  import Control from "sap/ui/core/Control";
116
118
 
119
+ import EditFlow from "sap/fe/core/controllerextensions/EditFlow";
120
+
121
+ import IntentBasedNavigation from "sap/fe/core/controllerextensions/IntentBasedNavigation";
122
+
117
123
  import Model from "sap/ui/model/Model";
118
124
 
125
+ import Routing from "sap/fe/core/controllerextensions/Routing";
126
+
119
127
  import Context from "sap/ui/model/Context";
120
128
 
121
129
  import UI5Element from "sap/ui/core/Element";
@@ -128,7 +136,7 @@ declare module "sap/fe/core/ExtensionAPI" {
128
136
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
129
137
  * created by the SAP Fiori elements framework.
130
138
  */
131
- export default class ExtensionAPI extends BaseObject {
139
+ class ExtensionAPI extends BaseObject {
132
140
  constructor();
133
141
 
134
142
  /**
@@ -145,13 +153,13 @@ declare module "sap/fe/core/ExtensionAPI" {
145
153
  *
146
154
  * @returns The editFlow controller extension
147
155
  */
148
- getEditFlow(): /* was: sap.fe.core.EditFlow */ any;
156
+ getEditFlow(): EditFlow;
149
157
  /**
150
158
  * Retrieves the intentBasedNavigation controller extension for this page.
151
159
  *
152
160
  * @returns The intentBasedNavigation controller extension
153
161
  */
154
- getIntentBasedNavigation(): /* was: sap.fe.core.IntentBasedNavigation */ any;
162
+ getIntentBasedNavigation(): IntentBasedNavigation;
155
163
  /**
156
164
  * Get access to models managed by SAP Fiori elements.
157
165
  *
@@ -184,7 +192,7 @@ declare module "sap/fe/core/ExtensionAPI" {
184
192
  *
185
193
  * @returns The routing controller extension
186
194
  */
187
- getRouting(): /* was: sap.fe.core.Routing */ any;
195
+ getRouting(): Routing;
188
196
  /**
189
197
  * Load a fragment and go through the template preprocessor with the current page context.
190
198
  *
@@ -247,19 +255,14 @@ declare module "sap/fe/core/ExtensionAPI" {
247
255
  */
248
256
  updateAppState(): Promise<object | void>;
249
257
  }
258
+ export default ExtensionAPI;
250
259
  }
251
260
 
252
261
  declare module "sap/fe/core/PageController" {
253
262
  import BaseController from "sap/fe/core/BaseController";
254
263
 
255
- import AppComponent from "sap/fe/core/AppComponent";
256
-
257
264
  import ExtensionAPI from "sap/fe/core/ExtensionAPI";
258
265
 
259
- import Model from "sap/ui/model/Model";
260
-
261
- import View from "sap/ui/core/mvc/View";
262
-
263
266
  /**
264
267
  * @SINCE 1.88.0
265
268
  *
@@ -267,51 +270,17 @@ declare module "sap/fe/core/PageController" {
267
270
  * This controller provides preconfigured extensions that will ensure you have the basic functionalities
268
271
  * required to use the building blocks.
269
272
  */
270
- export default class PageController extends BaseController {
273
+ class PageController extends BaseController {
271
274
  constructor();
272
275
 
273
- /**
274
- * @SINCE 1.91.0
275
- *
276
- * Returns the current app component.
277
- *
278
- * @returns The app component or, if not found, null
279
- */
280
- getAppComponent(): AppComponent;
281
276
  /**
282
277
  * Get the extension API for the current page.
283
278
  *
284
279
  * @returns The extension API.
285
280
  */
286
281
  getExtensionAPI(): ExtensionAPI;
287
- /**
288
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
289
- * name into each controller.
290
- *
291
- * @returns The model instance
292
- */
293
- getModel(
294
- /**
295
- * The model name
296
- */
297
- sName?: string
298
- ): Model;
299
- /**
300
- * Convenience method for setting the view model in every controller of the application.
301
- *
302
- * @returns The view instance
303
- */
304
- setModel(
305
- /**
306
- * The model instance
307
- */
308
- oModel: Model,
309
- /**
310
- * The model name
311
- */
312
- sName: string
313
- ): View;
314
282
  }
283
+ export default PageController;
315
284
  }
316
285
 
317
286
  declare module "sap/fe/core/controllerextensions/EditFlow" {
@@ -328,7 +297,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
328
297
  *
329
298
  * A controller extension offering hooks into the edit flow of the application
330
299
  */
331
- export default class EditFlow extends ControllerExtension {
300
+ class EditFlow extends ControllerExtension {
332
301
  constructor();
333
302
 
334
303
  /**
@@ -342,7 +311,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
342
311
  /**
343
312
  * Context of the document
344
313
  */
345
- oContext: object
314
+ oContext: Context
346
315
  ): Promise<void>;
347
316
  /**
348
317
  * @SINCE 1.90.0
@@ -363,7 +332,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
363
332
  /**
364
333
  * This is the control used to open the discard popover
365
334
  */
366
- control: object;
335
+ control?: object;
367
336
  /**
368
337
  * Optional, supresses the discard popover and allows custom handling
369
338
  */
@@ -706,6 +675,7 @@ declare module "sap/fe/core/controllerextensions/EditFlow" {
706
675
  updatePromise: Promise<any>
707
676
  ): Promise<void>;
708
677
  }
678
+ export default EditFlow;
709
679
  }
710
680
 
711
681
  declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
@@ -716,7 +686,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
716
686
  *
717
687
  * Controller extension providing hooks for intent-based navigation
718
688
  */
719
- export default class IntentBasedNavigation extends ControllerExtension {
689
+ class IntentBasedNavigation extends ControllerExtension {
720
690
  constructor();
721
691
 
722
692
  /**
@@ -754,7 +724,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
754
724
  * Identifier to locate the outbound definition in the manifest.
755
725
  * This provides the semantic object and action for the intent-based navigation.
756
726
  * Additionally, the outbound definition can be used to provide parameters for intent-based navigation.
757
- * See {@link topic:be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries}
727
+ * See {@link https://ui5.sap.com/#/topic/be0cf40f61184b358b5faedaec98b2da Descriptor for Applications, Components, and Libraries }
758
728
  * for more information.
759
729
  */
760
730
  sOutbound: string,
@@ -766,6 +736,7 @@ declare module "sap/fe/core/controllerextensions/IntentBasedNavigation" {
766
736
  mNavigationParameters: object
767
737
  ): void;
768
738
  }
739
+ export default IntentBasedNavigation;
769
740
  }
770
741
 
771
742
  declare module "sap/fe/core/controllerextensions/MessageHandler" {
@@ -777,7 +748,7 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
777
748
  *
778
749
  * A controller extension offering message handling.
779
750
  */
780
- export default class MessageHandler extends ControllerExtension {
751
+ class MessageHandler extends ControllerExtension {
781
752
  constructor();
782
753
 
783
754
  /**
@@ -797,6 +768,7 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
797
768
  */
798
769
  showMessageDialog(): Promise<void>;
799
770
  }
771
+ export default MessageHandler;
800
772
  }
801
773
 
802
774
  declare module "sap/fe/core/controllerextensions/Paginator" {
@@ -809,7 +781,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
809
781
  *
810
782
  * Controller extension providing hooks for the navigation using paginators
811
783
  */
812
- export default class Paginator extends ControllerExtension {
784
+ class Paginator extends ControllerExtension {
813
785
  constructor();
814
786
 
815
787
  /**
@@ -839,6 +811,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
839
811
  oContext: Context
840
812
  ): void;
841
813
  }
814
+ export default Paginator;
842
815
  }
843
816
 
844
817
  declare module "sap/fe/core/controllerextensions/Routing" {
@@ -851,7 +824,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
851
824
  *
852
825
  * A controller extension offering hooks into the routing flow of the application
853
826
  */
854
- export default class Routing extends ControllerExtension {
827
+ class Routing extends ControllerExtension {
855
828
  constructor();
856
829
 
857
830
  /**
@@ -914,7 +887,11 @@ declare module "sap/fe/core/controllerextensions/Routing" {
914
887
  * @SINCE 1.86.0
915
888
  *
916
889
  * This function can be used to intercept the routing event happening during the normal process of navigating
917
- * from one page to another.
890
+ * from one page to another (like clicking on the table row to navigate, or when pagination buttons are
891
+ * clicked).
892
+ * The function is NOT called during other means of external outbound navigation (like a navigation configured
893
+ * via a link, or by using navigation buttons).
894
+ *
918
895
  * If declared as an extension, it allows you to intercept and change the normal navigation flow.
919
896
  * If you decide to do your own navigation processing, you can return `true` to prevent the default routing
920
897
  * behavior.
@@ -937,6 +914,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
937
914
  }
938
915
  ): boolean;
939
916
  }
917
+ export default Routing;
940
918
  }
941
919
 
942
920
  declare module "sap/fe/core/controllerextensions/Share" {
@@ -947,7 +925,7 @@ declare module "sap/fe/core/controllerextensions/Share" {
947
925
  *
948
926
  * A controller extension offering hooks into the routing flow of the application
949
927
  */
950
- export default class Share extends ControllerExtension {
928
+ class Share extends ControllerExtension {
951
929
  constructor();
952
930
 
953
931
  /**
@@ -1037,6 +1015,7 @@ declare module "sap/fe/core/controllerextensions/Share" {
1037
1015
  oControl: object
1038
1016
  ): void;
1039
1017
  }
1018
+ export default Share;
1040
1019
  }
1041
1020
 
1042
1021
  declare module "sap/fe/core/controllerextensions/ViewState" {
@@ -1050,7 +1029,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1050
1029
  * A controller extension offering hooks for state handling
1051
1030
  * If you need to maintain a specific state for your application, you can use the controller extension.
1052
1031
  */
1053
- export default class ViewState extends ControllerExtension {
1032
+ class ViewState extends ControllerExtension {
1054
1033
  constructor();
1055
1034
 
1056
1035
  /**
@@ -1193,7 +1172,7 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1193
1172
  /**
1194
1173
  * The current navigation parameter
1195
1174
  */
1196
- oNavParameter: /* was: sap.fe.core.NavigationParameter */ any
1175
+ oNavParameter: NavigationParameter
1197
1176
  ): Promise<any>;
1198
1177
  /**
1199
1178
  * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
@@ -1219,7 +1198,11 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1219
1198
  /**
1220
1199
  * Extensible array of promises to be resolved before continuing
1221
1200
  */
1222
- aPromises: Promise<any>
1201
+ aPromises: Promise<any>,
1202
+ /**
1203
+ * Navigation type responsible for the applying the state
1204
+ */
1205
+ navigationType?: string
1223
1206
  ): void;
1224
1207
  /**
1225
1208
  * Called when the application is restored due to keep-alive mode.
@@ -1252,6 +1235,8 @@ declare module "sap/fe/core/controllerextensions/ViewState" {
1252
1235
  */
1253
1236
  retrieveViewState(): Promise<any>;
1254
1237
  }
1238
+ export default ViewState;
1239
+
1255
1240
  /**
1256
1241
  * Definition of a custom action to be used inside the table toolbar
1257
1242
  */
@@ -1303,10 +1288,10 @@ declare module "sap/fe/core/fpm/Component" {
1303
1288
  * }
1304
1289
  * ```
1305
1290
  */
1306
- export default class Component
1307
- /* was: sap.fe.core.TemplateComponent */ extends Object {
1291
+ class Component /* was: sap.fe.core.TemplateComponent */ extends Object {
1308
1292
  constructor();
1309
1293
  }
1294
+ export default Component;
1310
1295
  }
1311
1296
 
1312
1297
  declare module "sap/fe/core/library" {
@@ -1332,12 +1317,6 @@ declare module "sap/fe/core/library" {
1332
1317
  }
1333
1318
 
1334
1319
  declare module "sap/fe/core/rootView/Fcl.controller" {
1335
- import AppComponent from "sap/fe/core/AppComponent";
1336
-
1337
- import Model from "sap/ui/model/Model";
1338
-
1339
- import View from "sap/ui/core/mvc/View";
1340
-
1341
1320
  /**
1342
1321
  * @SINCE 1.110.0
1343
1322
  *
@@ -1346,8 +1325,8 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
1346
1325
  * and
1347
1326
  * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
1348
1327
  */
1349
- export default class Fcl
1350
- /* was: sap.fe.core.RootViewBaseController */ extends Object {
1328
+ class Fcl
1329
+ /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
1351
1330
  constructor();
1352
1331
 
1353
1332
  /**
@@ -1356,59 +1335,11 @@ declare module "sap/fe/core/rootView/Fcl.controller" {
1356
1335
  * @returns A promise that creates a Page to display the error
1357
1336
  */
1358
1337
  displayErrorPage(): Promise<boolean>;
1359
- /**
1360
- * @SINCE 1.91.0
1361
- *
1362
- * Returns the current app component.
1363
- *
1364
- * @returns The app component or, if not found, null
1365
- */
1366
- getAppComponent(): AppComponent;
1367
- /**
1368
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
1369
- * name into each controller.
1370
- *
1371
- * @returns The model instance
1372
- */
1373
- getModel(
1374
- /**
1375
- * The model name
1376
- */
1377
- sName?: string
1378
- ): Model;
1379
- /**
1380
- * Convenience method for getting the resource bundle.
1381
- *
1382
- * @returns The resourceModel of the component
1383
- */
1384
- getResourceBundle():
1385
- | Promise</* was: sap.base.i18n.ResourceBundle */ any>
1386
- | /* was: sap.base.i18n.ResourceBundle */ any;
1387
- /**
1388
- * Convenience method for setting the view model in every controller of the application.
1389
- *
1390
- * @returns The view instance
1391
- */
1392
- setModel(
1393
- /**
1394
- * The model instance
1395
- */
1396
- oModel: Model,
1397
- /**
1398
- * The model name
1399
- */
1400
- sName: string
1401
- ): View;
1402
1338
  }
1339
+ export default Fcl;
1403
1340
  }
1404
1341
 
1405
1342
  declare module "sap/fe/core/rootView/NavContainer.controller" {
1406
- import AppComponent from "sap/fe/core/AppComponent";
1407
-
1408
- import Model from "sap/ui/model/Model";
1409
-
1410
- import View from "sap/ui/core/mvc/View";
1411
-
1412
1343
  /**
1413
1344
  * @SINCE 1.108.0
1414
1345
  *
@@ -1417,8 +1348,8 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
1417
1348
  * and
1418
1349
  * you can make use of SAP Fiori elements pages and SAP Fiori elements building blocks.
1419
1350
  */
1420
- export default class NavContainer
1421
- /* was: sap.fe.core.RootViewBaseController */ extends Object {
1351
+ class NavContainer
1352
+ /* was: sap.fe.core.rootView.RootViewBaseController */ extends Object {
1422
1353
  constructor();
1423
1354
 
1424
1355
  /**
@@ -1427,50 +1358,8 @@ declare module "sap/fe/core/rootView/NavContainer.controller" {
1427
1358
  * @returns A promise that creates a Page to display the error
1428
1359
  */
1429
1360
  displayErrorPage(): Promise<boolean>;
1430
- /**
1431
- * @SINCE 1.91.0
1432
- *
1433
- * Returns the current app component.
1434
- *
1435
- * @returns The app component or, if not found, null
1436
- */
1437
- getAppComponent(): AppComponent;
1438
- /**
1439
- * Convenience method provided by SAP Fiori elements to enable applications to include the view model by
1440
- * name into each controller.
1441
- *
1442
- * @returns The model instance
1443
- */
1444
- getModel(
1445
- /**
1446
- * The model name
1447
- */
1448
- sName?: string
1449
- ): Model;
1450
- /**
1451
- * Convenience method for getting the resource bundle.
1452
- *
1453
- * @returns The resourceModel of the component
1454
- */
1455
- getResourceBundle():
1456
- | Promise</* was: sap.base.i18n.ResourceBundle */ any>
1457
- | /* was: sap.base.i18n.ResourceBundle */ any;
1458
- /**
1459
- * Convenience method for setting the view model in every controller of the application.
1460
- *
1461
- * @returns The view instance
1462
- */
1463
- setModel(
1464
- /**
1465
- * The model instance
1466
- */
1467
- oModel: Model,
1468
- /**
1469
- * The model name
1470
- */
1471
- sName: string
1472
- ): View;
1473
1361
  }
1362
+ export default NavContainer;
1474
1363
  }
1475
1364
 
1476
1365
  declare namespace sap {