@sapui5/types 1.117.0 → 1.118.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 (66) 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 +1 -1
  6. package/types/sap.collaboration.d.ts +1 -1
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +416 -2
  9. package/types/sap.fe.core.d.ts +47 -48
  10. package/types/sap.fe.macros.d.ts +70 -10
  11. package/types/sap.fe.navigation.d.ts +109 -4
  12. package/types/sap.fe.placeholder.d.ts +1 -1
  13. package/types/sap.fe.templates.d.ts +9 -5
  14. package/types/sap.fe.test.d.ts +1 -1
  15. package/types/sap.fe.tools.d.ts +1 -1
  16. package/types/sap.feedback.ui.d.ts +1 -1
  17. package/types/sap.gantt.d.ts +1 -1
  18. package/types/sap.insights.d.ts +20 -2
  19. package/types/sap.landvisz.d.ts +1 -1
  20. package/types/sap.m.d.ts +214 -90
  21. package/types/sap.makit.d.ts +1 -1
  22. package/types/sap.me.d.ts +1 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +1 -1
  25. package/types/sap.rules.ui.d.ts +1 -1
  26. package/types/sap.sac.df.d.ts +1426 -209
  27. package/types/sap.suite.ui.commons.d.ts +77 -23
  28. package/types/sap.suite.ui.generic.template.d.ts +64 -107
  29. package/types/sap.suite.ui.microchart.d.ts +1 -1
  30. package/types/sap.tnt.d.ts +1 -1
  31. package/types/sap.ui.codeeditor.d.ts +5 -2
  32. package/types/sap.ui.commons.d.ts +1 -1
  33. package/types/sap.ui.comp.d.ts +150 -20
  34. package/types/sap.ui.core.d.ts +1031 -197
  35. package/types/sap.ui.dt.d.ts +1 -1
  36. package/types/sap.ui.export.d.ts +7 -1
  37. package/types/sap.ui.fl.d.ts +51 -4
  38. package/types/sap.ui.generic.app.d.ts +3 -3
  39. package/types/sap.ui.generic.template.d.ts +1 -1
  40. package/types/sap.ui.integration.d.ts +68 -3
  41. package/types/sap.ui.layout.d.ts +1 -1
  42. package/types/sap.ui.mdc.d.ts +423 -141
  43. package/types/sap.ui.richtexteditor.d.ts +1 -1
  44. package/types/sap.ui.rta.d.ts +1 -4
  45. package/types/sap.ui.suite.d.ts +1 -1
  46. package/types/sap.ui.support.d.ts +1 -1
  47. package/types/sap.ui.table.d.ts +180 -39
  48. package/types/sap.ui.testrecorder.d.ts +1 -1
  49. package/types/sap.ui.unified.d.ts +1 -20
  50. package/types/sap.ui.ux3.d.ts +1 -1
  51. package/types/sap.ui.vbm.d.ts +1 -1
  52. package/types/sap.ui.vk.d.ts +38 -1
  53. package/types/sap.ui.vtm.d.ts +1 -1
  54. package/types/sap.ui.webc.common.d.ts +76 -35
  55. package/types/sap.ui.webc.fiori.d.ts +1 -1
  56. package/types/sap.ui.webc.main.d.ts +1 -1
  57. package/types/sap.uiext.inbox.d.ts +1 -1
  58. package/types/sap.ushell.d.ts +1 -1
  59. package/types/sap.ushell_abap.d.ts +1 -1
  60. package/types/sap.uxap.d.ts +116 -1
  61. package/types/sap.viz.d.ts +1 -1
  62. package/types/sap.webanalytics.core.d.ts +1 -1
  63. package/types/sap.zen.commons.d.ts +1 -1
  64. package/types/sap.zen.crosstab.d.ts +1 -1
  65. package/types/sap.zen.dsh.d.ts +1 -1
  66. package/types/sap.fe.plugins.optimisticBatch.d.ts +0 -3
@@ -1,5 +1,7 @@
1
1
  // For Library Version: 1.111.0
2
2
 
3
+ declare module "sap/fe/macros/library" {}
4
+
3
5
  declare module "sap/fe/macros/MacroAPI" {
4
6
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
5
7
 
@@ -268,7 +270,7 @@ declare module "sap/fe/macros/field/FieldAPI" {
268
270
  /**
269
271
  * Type of the message
270
272
  */
271
- type?: MessageType | keyof typeof MessageType;
273
+ type?: MessageType;
272
274
  }
273
275
  ): string;
274
276
  /**
@@ -451,7 +453,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
451
453
  *
452
454
  * @returns Active filters summary as text
453
455
  */
454
- getActiveFiltersText(): any;
456
+ getActiveFiltersText(): string;
455
457
  /**
456
458
  * Provides all the filters that are currently active
457
459
  * along with the search expression.
@@ -503,7 +505,7 @@ declare module "sap/fe/macros/filterBar/FilterBarAPI" {
503
505
  *
504
506
  * @returns Returns a promise which resolves if filter go is triggered successfully; otherwise gets rejected.
505
507
  */
506
- triggerSearch(): Promise<any>;
508
+ triggerSearch(): Promise<object | undefined>;
507
509
  }
508
510
  /**
509
511
  * Definition of a custom filter to be used inside the FilterBar.
@@ -701,8 +703,6 @@ declare module "sap/fe/macros/form/FormElement.block" {
701
703
  }
702
704
  }
703
705
 
704
- declare module "sap/fe/macros/library" {}
705
-
706
706
  declare module "sap/fe/macros/microchart/MicroChart.block" {
707
707
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
708
708
 
@@ -718,6 +718,63 @@ declare module "sap/fe/macros/microchart/MicroChart.block" {
718
718
  export interface $MicroChartSettings extends $ControlSettings {}
719
719
  }
720
720
 
721
+ declare module "sap/fe/macros/multiValueField/MultiValueField.block" {
722
+ import { default as Control, $ControlSettings } from "sap/ui/core/Control";
723
+
724
+ import Context from "sap/ui/model/Context";
725
+
726
+ import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
727
+
728
+ /**
729
+ * @since 1.118.0
730
+ * @experimental (since 1.118.0)
731
+ *
732
+ * Building block for creating a MultiValueField based on the metadata provided by OData V4.
733
+ *
734
+ *
735
+ * The MultiValueField can be used to display either a DataField or Property directly. It has to point to
736
+ * a collection property.
737
+ *
738
+ *
739
+ * Usage example:
740
+ *
741
+ * ```javascript
742
+ *
743
+ * <macro:MultiValueField
744
+ * id="SomeUniqueIdentifier"
745
+ * contextPath="{entitySet>}"
746
+ * metaPath="{dataField>}"
747
+ * />
748
+ * ```
749
+ */
750
+ export default class MultiValueField extends Control {
751
+ constructor();
752
+ }
753
+
754
+ export interface $MultiValueFieldSettings extends $ControlSettings {
755
+ /**
756
+ * The context path provided for the MultiValueField
757
+ */
758
+ contextPath?: Context | PropertyBindingInfo | `{${string}}`;
759
+
760
+ /**
761
+ * The 'id' property
762
+ */
763
+ id?: string | PropertyBindingInfo;
764
+
765
+ /**
766
+ * Defines the relative Metadata path to the MultiValueField.
767
+ * The metaPath should point to a Property or DataField.
768
+ */
769
+ metaPath?: Context | PropertyBindingInfo | `{${string}}`;
770
+
771
+ /**
772
+ * The readOnly flag
773
+ */
774
+ readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
775
+ }
776
+ }
777
+
721
778
  declare module "sap/fe/macros/paginator/Paginator.block" {
722
779
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
723
780
 
@@ -863,7 +920,7 @@ declare module "sap/fe/macros/table/TableAPI" {
863
920
  /**
864
921
  * Message type
865
922
  */
866
- type?: MessageType | keyof typeof MessageType;
923
+ type?: MessageType;
867
924
  }
868
925
  ): string;
869
926
  /**
@@ -999,7 +1056,8 @@ declare module "sap/fe/macros/table/TableAPI" {
999
1056
  */
1000
1057
  createAtEnd: boolean;
1001
1058
  /**
1002
- * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'
1059
+ * Specifies if the new entry should be hidden in case of creationMode 'InlineCreationRows'. This only applies
1060
+ * to responsive tables.
1003
1061
  *
1004
1062
  * The default value is 'false'
1005
1063
  */
@@ -1074,7 +1132,7 @@ declare module "sap/fe/macros/table/TableAPI" {
1074
1132
 
1075
1133
  /**
1076
1134
  * Number of columns that are fixed on the left. Only columns which are not fixed can be scrolled horizontally.
1077
- * This property is not relevant for Responsive tables
1135
+ * This property is not relevant for responsive tables
1078
1136
  */
1079
1137
  frozenColumnCount?: number | PropertyBindingInfo | `{${string}}`;
1080
1138
 
@@ -1132,12 +1190,12 @@ declare module "sap/fe/macros/table/TableAPI" {
1132
1190
  readOnly?: boolean | PropertyBindingInfo | `{${string}}`;
1133
1191
 
1134
1192
  /**
1135
- * Number of rows to be displayed in the table. Does not apply to Responsive tables.
1193
+ * Number of rows to be displayed in the table. Does not apply to responsive tables.
1136
1194
  */
1137
1195
  rowCount?: number | PropertyBindingInfo | `{${string}}`;
1138
1196
 
1139
1197
  /**
1140
- * Defines how the table handles the visible rows. Does not apply to Responsive tables.
1198
+ * Defines how the table handles the visible rows. Does not apply to responsive tables.
1141
1199
  * Allowed values are `Auto`, `Fixed`.
1142
1200
  *
1143
1201
  * - If set to `Fixed`, the table always has as many rows as defined in the rowCount property.
@@ -1215,6 +1273,8 @@ declare namespace sap {
1215
1273
 
1216
1274
  "sap/fe/macros/microchart/MicroChart.block": undefined;
1217
1275
 
1276
+ "sap/fe/macros/multiValueField/MultiValueField.block": undefined;
1277
+
1218
1278
  "sap/fe/macros/paginator/Paginator.block": undefined;
1219
1279
 
1220
1280
  "sap/fe/macros/richtexteditor/RichTextEditor.block": undefined;
@@ -1,5 +1,112 @@
1
1
  // For Library Version: 1.111.0
2
2
 
3
+ declare module "sap/fe/navigation/library" {
4
+ /**
5
+ * @since 1.83.0
6
+ *
7
+ * A static enumeration type which indicates the Odata version used for runnning the Navigation Handler.
8
+ */
9
+ export enum Mode {
10
+ /**
11
+ * This is used for ODataV2 services to do some internal tasks like creation of appstate, removal of sensitive
12
+ * data etc.,
13
+ */
14
+ ODataV2 = "undefined",
15
+ /**
16
+ * This is used for ODataV4 services to do some internal tasks like creation of appstate, removal of sensitive
17
+ * data etc.,
18
+ */
19
+ ODataV4 = "undefined",
20
+ }
21
+ /**
22
+ * @since 1.86.0
23
+ *
24
+ * This is the successor of {@link sap.ui.generic.app.navigation.service.NavType}.
25
+ *
26
+ * A static enumeration type which indicates the type of inbound navigation.
27
+ */
28
+ export enum NavType {
29
+ /**
30
+ * Basic cross-app navigation with URL parameters only (without sap-xapp-state) or initial start with default
31
+ * parameters
32
+ */
33
+ URLParams = "undefined",
34
+ /**
35
+ * Back navigation with sap-iapp-state parameter
36
+ */
37
+ iAppState = "undefined",
38
+ /**
39
+ * Initial startup without any navigation or default parameters
40
+ */
41
+ initial = "undefined",
42
+ /**
43
+ * Cross-app navigation with sap-xapp-state parameter (and URL parameters), defaulted parameters may be
44
+ * added
45
+ */
46
+ xAppState = "undefined",
47
+ }
48
+ /**
49
+ * @since 1.83.0
50
+ *
51
+ * This is the successor of {@link sap.ui.generic.app.navigation.service.ParamHandlingMode}.
52
+ *
53
+ * A static enumeration type which indicates the conflict resolution method when merging URL parameters
54
+ * into select options.
55
+ */
56
+ export enum ParamHandlingMode {
57
+ /**
58
+ * The conflict resolution adds URL parameters to the SelectionVariant
59
+ */
60
+ InsertInSelOpt = "undefined",
61
+ /**
62
+ * The conflict resolution favors the SelectionVariant over URL parameters
63
+ */
64
+ SelVarWins = "undefined",
65
+ /**
66
+ * The conflict resolution favors the URL parameters over the SelectionVariant. Caution: In case of cross-app
67
+ * navigation
68
+ * a navigation parameter value from the source app is overwritten by a default, if a default is maintained
69
+ * in the launchpad
70
+ * designer for this parameter in the target app!
71
+ */
72
+ URLParamWins = "undefined",
73
+ }
74
+ /**
75
+ * @since 1.83.0
76
+ *
77
+ * This is the successor of {@link sap.ui.generic.app.navigation.service.SuppressionBehavior}.
78
+ *
79
+ * A static enumeration type which indicates whether semantic attributes with values `null`,
80
+ * `undefined` or `""` (empty string) shall be suppressed, before they are mixed in to the selection variant
81
+ * in the
82
+ * method {@link sap.fe.navigation.NavigationHandler.mixAttributesAndSelectionVariant mixAttributesAndSelectionVariant}
83
+ * of the {@link sap.fe.navigation.NavigationHandler NavigationHandler}.
84
+ */
85
+ export enum SuppressionBehavior {
86
+ /**
87
+ * Semantic attributes with an empty string are ignored, the remaining attributes are mixed in to the selection
88
+ * variant.
89
+ * Warning! Consider the impact on Boolean variable values!
90
+ */
91
+ ignoreEmptyString = "undefined",
92
+ /**
93
+ * Semantic attributes with a `null` value lead to an {@link sap.fin.central.lib.error.Error error} of type
94
+ * NavigationHandler.INVALID_INPUT
95
+ */
96
+ raiseErrorOnNull = "undefined",
97
+ /**
98
+ * Semantic attributes with an `undefined` value lead to an {@link sap.fin.central.lib.error.Error error }
99
+ * of type NavigationHandler.INVALID_INPUT
100
+ */
101
+ raiseErrorOnUndefined = "undefined",
102
+ /**
103
+ * Standard suppression behavior: semantic attributes with a `null` or an `undefined` value are ignored,
104
+ * the remaining attributes are mixed in to the selection variant
105
+ */
106
+ standard = "undefined",
107
+ }
108
+ }
109
+
3
110
  declare module "sap/fe/navigation/NavError" {
4
111
  import BaseObject from "sap/ui/base/Object";
5
112
 
@@ -273,7 +380,7 @@ declare module "sap/fe/navigation/NavigationHandler" {
273
380
  * (if available)
274
381
  * and the type of navigation are returned.
275
382
  */
276
- parseNavigation(): JQuery.Promise<any, any, any>;
383
+ parseNavigation(): object;
277
384
  /**
278
385
  * Processes navigation-related tasks related to beforePopoverOpens event handling for the SmartLink control
279
386
  * and returns a Promise object. In
@@ -653,7 +760,7 @@ declare module "sap/fe/navigation/SelectionVariant" {
653
760
  */
654
761
  sLow: string,
655
762
  /**
656
- * Set only if sOption is **BT**: the upper boundary of the interval;
763
+ * Set only if sOption is **BT**: the upper boundary of the interval
657
764
  */
658
765
  sHigh?: null | string,
659
766
  /**
@@ -907,8 +1014,6 @@ declare module "sap/fe/navigation/SelectionVariant" {
907
1014
  }
908
1015
  }
909
1016
 
910
- declare module "sap/fe/navigation/library" {}
911
-
912
1017
  declare namespace sap {
913
1018
  interface IUI5DefineDependencyNames {
914
1019
  "sap/fe/navigation/library": undefined;
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,8 +1,12 @@
1
1
  // For Library Version: 1.111.0
2
2
 
3
+ declare module "sap/fe/templates/library" {}
4
+
3
5
  declare module "sap/fe/templates/ListReport/ExtensionAPI" {
4
6
  import ExtensionAPI1 from "sap/fe/core/ExtensionAPI";
5
7
 
8
+ import Context from "sap/ui/model/odata/v4/Context";
9
+
6
10
  /**
7
11
  * @since 1.79.0
8
12
  *
@@ -23,7 +27,7 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
23
27
  /**
24
28
  * Map containing the filter conditions of the FilterBar.
25
29
  */
26
- mFilterConditions: any
30
+ mFilterConditions: object
27
31
  ): object;
28
32
  /**
29
33
  * Provides all the model filters from the filter bar that are currently active
@@ -37,7 +41,7 @@ declare module "sap/fe/templates/ListReport/ExtensionAPI" {
37
41
  *
38
42
  * @returns Array containing the selected contexts
39
43
  */
40
- getSelectedContexts(): any;
44
+ getSelectedContexts(): Context[];
41
45
  /**
42
46
  * Refreshes the List Report.
43
47
  * This method currently only supports triggering the search (by clicking on the GO button)
@@ -161,6 +165,8 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
161
165
 
162
166
  import Context from "sap/ui/model/Context";
163
167
 
168
+ import Context1 from "sap/ui/model/odata/v4/Context";
169
+
164
170
  import Message from "sap/ui/core/message/Message";
165
171
 
166
172
  /**
@@ -190,7 +196,7 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
190
196
  * The ID identifying the table the selected context is requested for
191
197
  */
192
198
  sTableId: string
193
- ): any;
199
+ ): Context1[];
194
200
  /**
195
201
  * Hides the message strip below the anchor bar.
196
202
  */
@@ -231,8 +237,6 @@ declare module "sap/fe/templates/ObjectPage/ExtensionAPI" {
231
237
  }
232
238
  }
233
239
 
234
- declare module "sap/fe/templates/library" {}
235
-
236
240
  declare namespace sap {
237
241
  interface IUI5DefineDependencyNames {
238
242
  "sap/fe/templates/library": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare module "sap/fe/test/library" {}
4
4
 
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare module "sap/gantt/library" {
4
4
  import ChartScheme from "sap/gantt/config/ChartScheme";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.1
2
2
 
3
3
  declare module "sap/insights/library" {}
4
4
 
@@ -37,7 +37,25 @@ declare module "sap/insights/CardHelper" {
37
37
  showCardPreview(
38
38
  card: object,
39
39
 
40
- bTransform?: boolean,
40
+ bTransform: boolean,
41
+ /**
42
+ * object which includes type and message text related to Message
43
+ */
44
+ oCardMessageInfo: object,
45
+
46
+ calledInternally?: boolean
47
+ ): Promise<void>;
48
+ /**
49
+ * @experimental
50
+ *
51
+ * Show preview for a given card
52
+ */
53
+ showCardPreview(
54
+ card: object,
55
+ /**
56
+ * object which includes type and message text related to Message
57
+ */
58
+ oCardMessageInfo: object,
41
59
 
42
60
  calledInternally?: boolean
43
61
  ): Promise<void>;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.117.0
1
+ // For Library Version: 1.118.0
2
2
 
3
3
  declare module "sap/landvisz/library" {
4
4
  /**