@sapui5/types 1.115.0 → 1.115.1

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 (44) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +2 -0
  3. package/types/sap.chart.d.ts +98 -47
  4. package/types/sap.f.d.ts +860 -754
  5. package/types/sap.fe.core.d.ts +74 -86
  6. package/types/sap.fe.macros.d.ts +84 -34
  7. package/types/sap.fe.navigation.d.ts +9 -13
  8. package/types/sap.fe.placeholder.d.ts +3 -0
  9. package/types/sap.fe.templates.d.ts +11 -9
  10. package/types/sap.fe.test.d.ts +40 -69
  11. package/types/sap.fe.tools.d.ts +3 -0
  12. package/types/sap.m.d.ts +8300 -6415
  13. package/types/sap.makit.d.ts +91 -56
  14. package/types/sap.me.d.ts +119 -73
  15. package/types/sap.ndc.d.ts +43 -32
  16. package/types/sap.suite.ui.generic.template.d.ts +81 -82
  17. package/types/sap.suite.ui.microchart.d.ts +382 -291
  18. package/types/sap.tnt.d.ts +81 -74
  19. package/types/sap.ui.codeeditor.d.ts +40 -25
  20. package/types/sap.ui.commons.d.ts +991 -672
  21. package/types/sap.ui.comp.d.ts +2641 -2090
  22. package/types/sap.ui.core.d.ts +2853 -2263
  23. package/types/sap.ui.dt.d.ts +1 -1
  24. package/types/sap.ui.export.d.ts +50 -33
  25. package/types/sap.ui.fl.d.ts +85 -47
  26. package/types/sap.ui.integration.d.ts +355 -280
  27. package/types/sap.ui.layout.d.ts +399 -416
  28. package/types/sap.ui.mdc.d.ts +1016 -792
  29. package/types/sap.ui.richtexteditor.d.ts +64 -33
  30. package/types/sap.ui.rta.d.ts +7 -7
  31. package/types/sap.ui.suite.d.ts +25 -11
  32. package/types/sap.ui.support.d.ts +12 -13
  33. package/types/sap.ui.table.d.ts +498 -354
  34. package/types/sap.ui.testrecorder.d.ts +1 -1
  35. package/types/sap.ui.unified.d.ts +1228 -894
  36. package/types/sap.ui.ux3.d.ts +1023 -613
  37. package/types/sap.ui.webc.common.d.ts +7 -9
  38. package/types/sap.ui.webc.fiori.d.ts +578 -408
  39. package/types/sap.ui.webc.main.d.ts +1521 -878
  40. package/types/sap.uiext.inbox.d.ts +151 -63
  41. package/types/sap.ushell.d.ts +415 -334
  42. package/types/sap.ushell_abap.d.ts +1 -1
  43. package/types/sap.uxap.d.ts +304 -267
  44. package/types/sap.viz.d.ts +1809 -852
@@ -10,12 +10,11 @@ declare module "sap/fe/macros/MacroAPI" {
10
10
  /**
11
11
  * Base API control for building blocks.
12
12
  */
13
- class MacroAPI extends Control implements IFormContent {
13
+ export default class MacroAPI extends Control implements IFormContent {
14
14
  __implements__sap_ui_core_IFormContent: boolean;
15
15
 
16
16
  constructor();
17
17
  }
18
- export default MacroAPI;
19
18
 
20
19
  export interface $MacroAPISettings extends $ControlSettings {
21
20
  /**
@@ -44,6 +43,8 @@ declare module "sap/fe/macros/chart/ChartAPI" {
44
43
  AggregationBindingInfo,
45
44
  } from "sap/ui/base/ManagedObject";
46
45
 
46
+ import Event from "sap/ui/base/Event";
47
+
47
48
  /**
48
49
  * Building block used to create a chart based on the metadata provided by OData V4.
49
50
  *
@@ -56,7 +57,7 @@ declare module "sap/fe/macros/chart/ChartAPI" {
56
57
  * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
57
58
  * ```
58
59
  */
59
- class Chart extends MacroAPI {
60
+ export default class Chart extends MacroAPI {
60
61
  constructor();
61
62
 
62
63
  /**
@@ -66,8 +67,6 @@ declare module "sap/fe/macros/chart/ChartAPI" {
66
67
  */
67
68
  getSelectedContexts(): Context[];
68
69
  }
69
- export default Chart;
70
-
71
70
  /**
72
71
  * Definition of a custom action to be used inside the chart toolbar
73
72
  */
@@ -208,7 +207,15 @@ declare module "sap/fe/macros/chart/ChartAPI" {
208
207
  actions?: Action[] | Action | AggregationBindingInfo | `{${string}}`;
209
208
  }
210
209
 
211
- export interface $ChartSelectionChangeEventParameters {}
210
+ export interface Chart$SelectionChangeEventParameters {}
211
+
212
+ /**
213
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Chart$SelectionChangeEventParameters'
214
+ * in 1.115.1 and any later releases.
215
+ */
216
+ export type $ChartSelectionChangeEventParameters = Chart$SelectionChangeEventParameters;
217
+
218
+ export type Chart$SelectionChangeEvent = Event<Chart$SelectionChangeEventParameters>;
212
219
  }
213
220
 
214
221
  declare module "sap/fe/macros/field/FieldAPI" {
@@ -221,6 +228,8 @@ declare module "sap/fe/macros/field/FieldAPI" {
221
228
 
222
229
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
223
230
 
231
+ import Event from "sap/ui/base/Event";
232
+
224
233
  /**
225
234
  * Building block for creating a field based on the metadata provided by OData V4.
226
235
  *
@@ -234,7 +243,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
234
243
  * <macro:Field id="MyField" metaPath="MyProperty" />
235
244
  * ```
236
245
  */
237
- class Field extends MacroAPI {
246
+ export default class Field extends MacroAPI {
238
247
  constructor();
239
248
 
240
249
  /**
@@ -281,8 +290,6 @@ declare module "sap/fe/macros/field/FieldAPI" {
281
290
  id: string
282
291
  ): void;
283
292
  }
284
- export default Field;
285
-
286
293
  /**
287
294
  * Additional format options for the field.
288
295
  */
@@ -387,7 +394,15 @@ declare module "sap/fe/macros/field/FieldAPI" {
387
394
  semanticObject?: string | PropertyBindingInfo;
388
395
  }
389
396
 
390
- export interface $FieldChangeEventParameters {}
397
+ export interface Field$ChangeEventParameters {}
398
+
399
+ /**
400
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Field$ChangeEventParameters'
401
+ * in 1.115.1 and any later releases.
402
+ */
403
+ export type $FieldChangeEventParameters = Field$ChangeEventParameters;
404
+
405
+ export type Field$ChangeEvent = Event<Field$ChangeEventParameters>;
391
406
  }
392
407
 
393
408
  declare module "sap/fe/macros/field/TextAreaEx" {
@@ -396,10 +411,9 @@ declare module "sap/fe/macros/field/TextAreaEx" {
396
411
  /**
397
412
  * Extension of the TextArea control to add a check for the maximum length when setting the value.
398
413
  */
399
- class TextAreaEx extends TextArea {
414
+ export default class TextAreaEx extends TextArea {
400
415
  constructor();
401
416
  }
402
- export default TextAreaEx;
403
417
 
404
418
  export interface $TextAreaExSettings extends $TextAreaSettings {}
405
419
  }
@@ -415,6 +429,8 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
415
429
  AggregationBindingInfo,
416
430
  } from "sap/ui/base/ManagedObject";
417
431
 
432
+ import Event from "sap/ui/base/Event";
433
+
418
434
  /**
419
435
  * Building block for creating a FilterBar based on the metadata provided by OData V4.
420
436
  *
@@ -427,7 +443,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
427
443
  * <macro:FilterBar id="MyFilterBar" metaPath="@com.sap.vocabularies.UI.v1.SelectionFields" />
428
444
  * ```
429
445
  */
430
- class FilterBar extends MacroAPI {
446
+ export default class FilterBar extends MacroAPI {
431
447
  constructor();
432
448
 
433
449
  /**
@@ -471,8 +487,6 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
471
487
  */
472
488
  triggerSearch(): Promise<any>;
473
489
  }
474
- export default FilterBar;
475
-
476
490
  /**
477
491
  * Definition of a custom filter to be used inside the FilterBar.
478
492
  * The template for the FilterField has to be provided as the default aggregation
@@ -548,11 +562,35 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
548
562
  | `{${string}}`;
549
563
  }
550
564
 
551
- export interface $FilterBarAfterClearEventParameters {}
565
+ export interface FilterBar$AfterClearEventParameters {}
566
+
567
+ /**
568
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'FilterBar$AfterClearEventParameters'
569
+ * in 1.115.1 and any later releases.
570
+ */
571
+ export type $FilterBarAfterClearEventParameters = FilterBar$AfterClearEventParameters;
572
+
573
+ export type FilterBar$AfterClearEvent = Event<FilterBar$AfterClearEventParameters>;
552
574
 
553
- export interface $FilterBarFilterChangedEventParameters {}
575
+ export interface FilterBar$FilterChangedEventParameters {}
554
576
 
555
- export interface $FilterBarSearchEventParameters {}
577
+ /**
578
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'FilterBar$FilterChangedEventParameters'
579
+ * in 1.115.1 and any later releases.
580
+ */
581
+ export type $FilterBarFilterChangedEventParameters = FilterBar$FilterChangedEventParameters;
582
+
583
+ export type FilterBar$FilterChangedEvent = Event<FilterBar$FilterChangedEventParameters>;
584
+
585
+ export interface FilterBar$SearchEventParameters {}
586
+
587
+ /**
588
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'FilterBar$SearchEventParameters'
589
+ * in 1.115.1 and any later releases.
590
+ */
591
+ export type $FilterBarSearchEventParameters = FilterBar$SearchEventParameters;
592
+
593
+ export type FilterBar$SearchEvent = Event<FilterBar$SearchEventParameters>;
556
594
  }
557
595
 
558
596
  declare module "sap/fe/macros/form/Form.block" {
@@ -575,10 +613,9 @@ declare module "sap/fe/macros/form/Form.block" {
575
613
  * <macro:Form id="MyForm" metaPath="@com.sap.vocabularies.UI.v1.FieldGroup#GeneralInformation" />
576
614
  * ```
577
615
  */
578
- class Form extends Control {
616
+ export default class Form extends Control {
579
617
  constructor();
580
618
  }
581
- export default Form;
582
619
 
583
620
  export interface $FormSettings extends $ControlSettings {
584
621
  /**
@@ -612,14 +649,13 @@ declare module "sap/fe/macros/form/FormElement.block" {
612
649
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
613
650
 
614
651
  /**
615
- * @SINCE 1.90.0
652
+ * @since 1.90.0
616
653
  *
617
654
  * Building block used to create a form element based on the metadata provided by OData V4.
618
655
  */
619
- class FormElement extends Control {
656
+ export default class FormElement extends Control {
620
657
  constructor();
621
658
  }
622
- export default FormElement;
623
659
 
624
660
  export interface $FormElementSettings extends $ControlSettings {
625
661
  /**
@@ -662,14 +698,13 @@ declare module "sap/fe/macros/microchart/MicroChart.block" {
662
698
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
663
699
 
664
700
  /**
665
- * @SINCE 1.93.0
701
+ * @since 1.93.0
666
702
  *
667
703
  * Building block used to create a MicroChart based on the metadata provided by OData V4.
668
704
  */
669
- class MicroChart extends Control {
705
+ export default class MicroChart extends Control {
670
706
  constructor();
671
707
  }
672
- export default MicroChart;
673
708
 
674
709
  export interface $MicroChartSettings extends $ControlSettings {}
675
710
  }
@@ -680,7 +715,7 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
680
715
  import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
681
716
 
682
717
  /**
683
- * @SINCE 1.94.0
718
+ * @since 1.94.0
684
719
  *
685
720
  * Building block used to create a paginator control.
686
721
  * Usage example:
@@ -690,10 +725,9 @@ declare module "sap/fe/macros/paginator/Paginator.block" {
690
725
  * <macro:Paginator />
691
726
  * ```
692
727
  */
693
- class Paginator extends Control {
728
+ export default class Paginator extends Control {
694
729
  constructor();
695
730
  }
696
- export default Paginator;
697
731
 
698
732
  export interface $PaginatorSettings extends $ControlSettings {
699
733
  /**
@@ -718,6 +752,8 @@ declare module "sap/fe/macros/table/TableAPI" {
718
752
  AggregationBindingInfo,
719
753
  } from "sap/ui/base/ManagedObject";
720
754
 
755
+ import Event from "sap/ui/base/Event";
756
+
721
757
  /**
722
758
  * Building block used to create a table based on the metadata provided by OData V4.
723
759
  *
@@ -731,7 +767,7 @@ declare module "sap/fe/macros/table/TableAPI" {
731
767
  * <macro:Table id="MyTable" metaPath="@com.sap.vocabularies.UI.v1.LineItem" />
732
768
  * ```
733
769
  */
734
- class Table extends MacroAPI {
770
+ export default class Table extends MacroAPI {
735
771
  constructor();
736
772
 
737
773
  /**
@@ -780,8 +816,6 @@ declare module "sap/fe/macros/table/TableAPI" {
780
816
  id: string
781
817
  ): void;
782
818
  }
783
- export default Table;
784
-
785
819
  /**
786
820
  * Definition of a custom action to be used inside the table toolbar
787
821
  */
@@ -1019,9 +1053,25 @@ declare module "sap/fe/macros/table/TableAPI" {
1019
1053
  columns?: Column[] | Column | AggregationBindingInfo | `{${string}}`;
1020
1054
  }
1021
1055
 
1022
- export interface $TableRowPressEventParameters {}
1056
+ export interface Table$RowPressEventParameters {}
1057
+
1058
+ /**
1059
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Table$RowPressEventParameters'
1060
+ * in 1.115.1 and any later releases.
1061
+ */
1062
+ export type $TableRowPressEventParameters = Table$RowPressEventParameters;
1063
+
1064
+ export type Table$RowPressEvent = Event<Table$RowPressEventParameters>;
1065
+
1066
+ export interface Table$SelectionChangeEventParameters {}
1067
+
1068
+ /**
1069
+ * @deprecated (since 1.115.1) - This name was introduced in 1.115.0, but will be 'Table$SelectionChangeEventParameters'
1070
+ * in 1.115.1 and any later releases.
1071
+ */
1072
+ export type $TableSelectionChangeEventParameters = Table$SelectionChangeEventParameters;
1023
1073
 
1024
- export interface $TableSelectionChangeEventParameters {}
1074
+ export type Table$SelectionChangeEvent = Event<Table$SelectionChangeEventParameters>;
1025
1075
  }
1026
1076
 
1027
1077
  declare namespace sap {
@@ -4,12 +4,12 @@ declare module "sap/fe/navigation/NavError" {
4
4
  import BaseObject from "sap/ui/base/Object";
5
5
 
6
6
  /**
7
- * @SINCE 1.83.0
7
+ * @since 1.83.0
8
8
  *
9
9
  * This is the successor of {@link sap.ui.generic.app.navigation.service.NavError}.
10
10
  * An object that provides error handling information during runtime.
11
11
  */
12
- class NavError extends BaseObject {
12
+ export default class NavError extends BaseObject {
13
13
  /**
14
14
  * Constructor requiring the error code as input.
15
15
  */
@@ -27,7 +27,6 @@ declare module "sap/fe/navigation/NavError" {
27
27
  */
28
28
  getErrorCode(): string;
29
29
  }
30
- export default NavError;
31
30
  }
32
31
 
33
32
  declare module "sap/fe/navigation/NavigationHandler" {
@@ -40,7 +39,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
40
39
  import SelectionVariant from "sap/fe/navigation/SelectionVariant";
41
40
 
42
41
  /**
43
- * @SINCE 1.83.0
42
+ * @since 1.83.0
44
43
  *
45
44
  * This is the successor of {@link sap.ui.generic.app.navigation.service.NavigationHandler}.
46
45
  * Creates a new NavigationHandler class by providing the required environment.
@@ -70,11 +69,11 @@ declare module "sap/fe/navigation/NavigationHandler" {
70
69
  * **Note:** This class requires that the UShell {@link sap.ushell.services.CrossApplicationNavigation }
71
70
  * is available and initialized.
72
71
  */
73
- class NavigationHandler extends BaseObject {
72
+ export default class NavigationHandler extends BaseObject {
74
73
  constructor();
75
74
 
76
75
  /**
77
- * @PROTECTED - DO NOT USE IN APPLICATIONS (only for related classes in the framework)
76
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
78
77
  *
79
78
  * The method creates a context url based on provided data. This context url can either be used as
80
79
  * {@link sap.fe.navigation.NavigationHandler#setParameterContextUrl ParameterContextUrl} or
@@ -460,21 +459,20 @@ declare module "sap/fe/navigation/NavigationHandler" {
460
459
  bImmediateHashReplace?: boolean
461
460
  ): object;
462
461
  }
463
- export default NavigationHandler;
464
462
  }
465
463
 
466
464
  declare module "sap/fe/navigation/PresentationVariant" {
467
465
  import BaseObject from "sap/ui/base/Object";
468
466
 
469
467
  /**
470
- * @SINCE 1.83.0
468
+ * @since 1.83.0
471
469
  *
472
470
  * This is the successor of {@link sap.ui.generic.app.navigation.service.PresentationVariant}.
473
471
  * Creates a new instance of a PresentationVariant class. If no parameter is passed, an new empty instance
474
472
  * is created whose ID has been set to `""`. Passing a JSON-serialized string complying to the Selection
475
473
  * Variant Specification will parse it, and the newly created instance will contain the same information.
476
474
  */
477
- class PresentationVariant extends BaseObject {
475
+ export default class PresentationVariant extends BaseObject {
478
476
  /**
479
477
  * If no parameter is passed, a new empty instance is created whose ID has been set to `""`.
480
478
  * Passing a JSON-serialized string complying to the Selection Variant Specification will parse it,
@@ -602,16 +600,15 @@ declare module "sap/fe/navigation/PresentationVariant" {
602
600
  */
603
601
  toJSONString(): string;
604
602
  }
605
- export default PresentationVariant;
606
603
  }
607
604
 
608
605
  declare module "sap/fe/navigation/SelectionVariant" {
609
606
  import BaseObject from "sap/ui/base/Object";
610
607
 
611
608
  /**
612
- * @SINCE 1.83.0
609
+ * @since 1.83.0
613
610
  */
614
- class SelectionVariant extends BaseObject {
611
+ export default class SelectionVariant extends BaseObject {
615
612
  constructor();
616
613
 
617
614
  /**
@@ -908,7 +905,6 @@ declare module "sap/fe/navigation/SelectionVariant" {
908
905
  */
909
906
  toJSONString(): string;
910
907
  }
911
- export default SelectionVariant;
912
908
  }
913
909
 
914
910
  declare module "sap/fe/navigation/library" {}
@@ -0,0 +1,3 @@
1
+ // For Library Version: 1.115.1
2
+
3
+ declare namespace sap {}
@@ -1,15 +1,17 @@
1
1
  // For Library Version: 1.111.0
2
2
 
3
3
  declare module "sap/fe/templates/ListReport/ExtensionAPI" {
4
+ import ExtensionAPI1 from "sap/fe/core/ExtensionAPI";
5
+
4
6
  /**
5
- * @SINCE 1.79.0
7
+ * @since 1.79.0
6
8
  *
7
9
  * Extension API for list reports in SAP Fiori elements for OData V4.
8
10
  * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
9
11
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
10
12
  * created by the SAP Fiori elements framework.
11
13
  */
12
- class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
14
+ export default class ExtensionAPI extends ExtensionAPI1 {
13
15
  constructor();
14
16
 
15
17
  /**
@@ -88,17 +90,17 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
88
90
  vValues?: boolean | boolean[] | number | number[] | string | string[]
89
91
  ): Promise<void>;
90
92
  }
91
- export default ExtensionAPI;
92
93
  }
93
94
 
94
95
  declare module "sap/fe/templates/ListReport/ListReportController.controller" {
96
+ import PageController from "sap/fe/core/PageController";
97
+
95
98
  import ExtensionAPI from "sap/fe/templates/ListReport/ExtensionAPI";
96
99
 
97
100
  /**
98
101
  * Controller class for the list report page, used inside an SAP Fiori elements application.
99
102
  */
100
- class ListReportController
101
- /* was: sap.fe.core.PageController */ extends Object {
103
+ export default class ListReportController extends PageController {
102
104
  constructor();
103
105
 
104
106
  /**
@@ -152,23 +154,24 @@ declare module "sap/fe/templates/ListReport/ListReportController.controller" {
152
154
  mParameters: any
153
155
  ): void;
154
156
  }
155
- export default ListReportController;
156
157
  }
157
158
 
158
159
  declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
160
+ import ExtensionAPI1 from "sap/fe/core/ExtensionAPI";
161
+
159
162
  import Context from "sap/ui/model/Context";
160
163
 
161
164
  import Message from "sap/ui/core/message/Message";
162
165
 
163
166
  /**
164
- * @SINCE 1.79.0
167
+ * @since 1.79.0
165
168
  *
166
169
  * Extension API for object pages on SAP Fiori elements for OData V4.
167
170
  * To correctly integrate your app extension coding with SAP Fiori elements, use only the extensionAPI of
168
171
  * SAP Fiori elements. Don't access or manipulate controls, properties, models, or other internal objects
169
172
  * created by the SAP Fiori elements framework.
170
173
  */
171
- class ExtensionAPI /* was: sap.fe.core.ExtensionAPI */ extends Object {
174
+ export default class ExtensionAPI extends ExtensionAPI1 {
172
175
  constructor();
173
176
 
174
177
  /**
@@ -226,7 +229,6 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
226
229
  bShow: boolean | undefined
227
230
  ): void;
228
231
  }
229
- export default ExtensionAPI;
230
232
  }
231
233
 
232
234
  declare module "sap/fe/templates/library" {}