@sapui5/ts-types 1.94.1 → 1.97.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 +1 -0
  3. package/types/sap.apf.d.ts +6 -6
  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 +235 -1
  8. package/types/sap.f.d.ts +310 -40
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +102 -1
  11. package/types/sap.fe.macros.d.ts +36 -12
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +1 -1
  14. package/types/sap.fe.plugins.d.ts +1 -1
  15. package/types/sap.fe.semantics.d.ts +1 -1
  16. package/types/sap.fe.templates.d.ts +2 -2
  17. package/types/sap.fe.test.d.ts +89 -4
  18. package/types/sap.fe.tools.d.ts +1 -1
  19. package/types/sap.feedback.ui.d.ts +1 -1
  20. package/types/sap.gantt.d.ts +1236 -44
  21. package/types/sap.landvisz.d.ts +1 -1
  22. package/types/sap.m.d.ts +1132 -159
  23. package/types/sap.makit.d.ts +1 -1
  24. package/types/sap.me.d.ts +1 -1
  25. package/types/sap.ndc.d.ts +21 -29
  26. package/types/sap.ovp.d.ts +44 -1
  27. package/types/sap.rules.ui.d.ts +1 -1
  28. package/types/sap.sac.grid.d.ts +635 -0
  29. package/types/sap.suite.ui.commons.d.ts +177 -3
  30. package/types/sap.suite.ui.generic.template.d.ts +61 -18
  31. package/types/sap.suite.ui.microchart.d.ts +1 -1
  32. package/types/sap.tnt.d.ts +11 -12
  33. package/types/sap.ui.codeeditor.d.ts +35 -31
  34. package/types/sap.ui.commons.d.ts +1 -1
  35. package/types/sap.ui.comp.d.ts +457 -26
  36. package/types/sap.ui.core.d.ts +1076 -474
  37. package/types/sap.ui.dt.d.ts +1 -1
  38. package/types/sap.ui.export.d.ts +119 -69
  39. package/types/sap.ui.fl.d.ts +3 -3
  40. package/types/sap.ui.generic.app.d.ts +1 -1
  41. package/types/sap.ui.generic.template.d.ts +1 -1
  42. package/types/sap.ui.integration.d.ts +273 -1
  43. package/types/sap.ui.layout.d.ts +19 -1
  44. package/types/sap.ui.mdc.d.ts +70 -10
  45. package/types/sap.ui.richtexteditor.d.ts +1 -1
  46. package/types/sap.ui.rta.d.ts +5 -11
  47. package/types/sap.ui.suite.d.ts +1 -1
  48. package/types/sap.ui.support.d.ts +6 -6
  49. package/types/sap.ui.table.d.ts +9 -6
  50. package/types/sap.ui.testrecorder.d.ts +1 -1
  51. package/types/sap.ui.unified.d.ts +182 -1
  52. package/types/sap.ui.ux3.d.ts +1 -1
  53. package/types/sap.ui.vbm.d.ts +1 -1
  54. package/types/sap.ui.vk.d.ts +972 -202
  55. package/types/sap.ui.vtm.d.ts +2 -1
  56. package/types/sap.uiext.inbox.d.ts +2 -1
  57. package/types/sap.ushell.d.ts +130 -58
  58. package/types/sap.ushell_abap.d.ts +2 -2
  59. package/types/sap.uxap.d.ts +1 -1
  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 +53 -34
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -6,6 +6,18 @@ declare namespace sap {
6
6
  * Library containing the building blocks for SAP Fiori elements.
7
7
  */
8
8
  namespace macros {
9
+ /**
10
+ * Building block used to create a chart based on the metadata provided by OData V4.
11
+ * Usually, a contextPath and metaPath is expected.
12
+ *
13
+ * Usage example:
14
+ * ```javascript
15
+ *
16
+ * <macro:Chart id="Mychart" contextPath="/RootEntity" metaPath="@com.sap.vocabularies.UI.v1.Chart" />
17
+ * ```
18
+ */
19
+ export const Chart: undefined;
20
+
9
21
  /**
10
22
  * Building block for creating a field based on the metadata provided by OData V4.
11
23
  * Usually, a DataField or DataPoint annotation is expected, but the field can also be used to display
@@ -20,9 +32,9 @@ declare namespace sap {
20
32
  export const Field: undefined;
21
33
 
22
34
  /**
23
- * Macro used to create a table based on the metadata provided by OData V4.
24
- * Usually, a LineItem or PresentationVariant annotation is expected, but the macro Table can also be used
25
- * to display an EntitySet.
35
+ * Building block used to create a table based on the metadata provided by OData V4.
36
+ * Usually, a LineItem or PresentationVariant annotation is expected, but the Table building block can
37
+ * also be used to display an EntitySet.
26
38
  *
27
39
  * Usage example:
28
40
  * ```javascript
@@ -35,8 +47,8 @@ declare namespace sap {
35
47
  /**
36
48
  * @SINCE 1.93.0
37
49
  *
38
- * Building block used specifically in a Flexible Column Layout application to add the 'expand', 'reduce'
39
- * and 'close' actions buttons.
50
+ * Building block used specifically in an app using the flexible column layout to add the expand’, reduce’,
51
+ * and close action buttons.
40
52
  *
41
53
  * Usage example:
42
54
  * ```javascript
@@ -55,7 +67,7 @@ declare namespace sap {
55
67
  /**
56
68
  * @SINCE 1.90.0
57
69
  *
58
- * A form element containing a label and a field
70
+ * Building block used to create a form element containing a label and a field.
59
71
  */
60
72
  class FormElement extends sap.fe.macros.MacroMetadata {
61
73
  constructor();
@@ -72,18 +84,32 @@ declare namespace sap {
72
84
  /**
73
85
  * @SINCE 1.93.0
74
86
  *
75
- * Macro for creating a MicroChart based on the provided OData V4 metadata.
87
+ * Building block used to create a MicroChart based on the metadata provided by OData V4.
76
88
  */
77
89
  class MicroChart extends sap.fe.macros.MacroMetadata {
78
90
  constructor();
79
91
  }
92
+ /**
93
+ * @SINCE 1.94.0
94
+ *
95
+ * Building block used to create a paginator control.
96
+ *
97
+ * Usage example:
98
+ * ```javascript
99
+ *
100
+ * <macro:Paginator />
101
+ * ```
102
+ */
103
+ class Paginator extends sap.fe.macros.MacroMetadata {
104
+ constructor();
105
+ }
80
106
  /**
81
107
  * @SINCE 1.93.0
82
108
  *
83
- * Macro for creating a 'Share' functionality.
109
+ * Building block used to create the ‘Share functionality.
84
110
  * Please note that the 'Share in SAP Jam' option is only available on platforms that are integrated with
85
111
  * SAP Jam.
86
- * If you are consuming this macro in an environment where the SAP Fiori Launchpad is not available, then
112
+ * If you are consuming this macro in an environment where the SAP Fiori launchpad is not available, then
87
113
  * the 'Save as Tile' option is not visible.
88
114
  *
89
115
  * Usage example:
@@ -102,8 +128,6 @@ declare namespace sap {
102
128
  }
103
129
 
104
130
  interface IUI5DefineDependencyNames {
105
- "sap/fe/macros/Chart.metadata": undefined;
106
-
107
131
  "sap/fe/macros/FlexibleColumnLayoutActions.metadata": undefined;
108
132
 
109
133
  "sap/fe/macros/FormElement.metadata": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -25,7 +25,7 @@ declare namespace sap {
25
25
  mFilterConditions: Record<string, any>
26
26
  ): object;
27
27
  /**
28
- * Gets the list entries currently selected for the displayed table.
28
+ * Gets the list entries currently selected for the displayed control.
29
29
  */
30
30
  getSelectedContexts(): sap.ui.model.odata.v4.Context[];
31
31
  /**
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -31,6 +31,23 @@ declare namespace sap {
31
31
  */
32
32
  bClearFirst?: boolean
33
33
  ): object;
34
+ /**
35
+ * Changes the content of a field in a dialog.
36
+ */
37
+ iChangeDialogField(
38
+ /**
39
+ * The identifier of the field
40
+ */
41
+ vFieldIdentifier: sap.fe.test.api.DialogFieldIdentifier,
42
+ /**
43
+ * The new target value.
44
+ */
45
+ vValue?: string,
46
+ /**
47
+ * Set to `true` to clear previously set filters, otherwise all previously set values will be kept
48
+ */
49
+ bClearFirst?: boolean
50
+ ): object;
34
51
  /**
35
52
  * Closes the dialog by pressing the 'Escape' key.
36
53
  */
@@ -85,6 +102,29 @@ declare namespace sap {
85
102
  */
86
103
  mButtonState?: object
87
104
  ): object;
105
+ /**
106
+ * Checks the content and state of a field in a dialog.
107
+ */
108
+ iCheckDialogField(
109
+ /**
110
+ * The identifier of the field
111
+ */
112
+ vFieldIdentifier: sap.fe.test.api.DialogFieldIdentifier,
113
+ /**
114
+ * Expected value(s) of the field. if passed as an object, the following pattern will be considered:
115
+ * ```javascript
116
+ *
117
+ * {
118
+ * value: , // optional
119
+ * }
120
+ * ```
121
+ */
122
+ vValue?: string | any[] | object,
123
+ /**
124
+ * Defines the expected state of the field
125
+ */
126
+ mState?: object
127
+ ): object;
88
128
  /**
89
129
  * Checks the dialog.
90
130
  */
@@ -470,9 +510,26 @@ declare namespace sap {
470
510
  */
471
511
  iSaveVariant(
472
512
  /**
473
- * The name of the new variant. If omitted, the current variant will be overwritten.
513
+ * The name of the new variant. If no new variant name is defined, the current variant will be overwritten.
474
514
  */
475
- sVariantName?: string
515
+ sVariantName?: string,
516
+ /**
517
+ * Saves the new variant with option "Set as Default".
518
+ */
519
+ bSetAsDefault?: string,
520
+ /**
521
+ * Saves the new variant with option "Apply Automatically".
522
+ */
523
+ bApplyAutomatically?: string
524
+ ): object;
525
+ /**
526
+ * Selects the chosen variant.
527
+ */
528
+ iSelectVariant(
529
+ /**
530
+ * The name of the variant to be selected
531
+ */
532
+ sVariantName: string
476
533
  ): object;
477
534
  }
478
535
 
@@ -1457,7 +1514,7 @@ declare namespace sap {
1457
1514
  mState?: object
1458
1515
  ): object;
1459
1516
  /**
1460
- * Selects the variant of the given name.
1517
+ * Selects the chosen variant.
1461
1518
  */
1462
1519
  iSelectVariant(
1463
1520
  /**
@@ -1865,6 +1922,10 @@ declare namespace sap {
1865
1922
  * All
1866
1923
  */
1867
1924
  All = "undefined",
1925
+ /**
1926
+ * All (Hiding Drafts)
1927
+ */
1928
+ AllHidingDrafts = "undefined",
1868
1929
  /**
1869
1930
  * Locked by Another User
1870
1931
  */
@@ -1920,6 +1981,30 @@ declare namespace sap {
1920
1981
  name: string;
1921
1982
  };
1922
1983
 
1984
+ /**
1985
+ * An dialog field identifier
1986
+ */
1987
+ type DialogFieldIdentifier = {
1988
+ /**
1989
+ * The name of the field In case of an action parameter dialog, this is the fieldname only
1990
+ * ```javascript
1991
+ *
1992
+ * {
1993
+ * property:
1994
+ * }
1995
+ * ```
1996
+ * In case of a create dialog, the concatenation of the entity and fieldname has to be provided
1997
+ *
1998
+ * ```javascript
1999
+ *
2000
+ * {
2001
+ * property: ::
2002
+ * }
2003
+ * ```
2004
+ */
2005
+ property: string;
2006
+ };
2007
+
1923
2008
  /**
1924
2009
  * A dialog identifier
1925
2010
  */
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.94.0
1
+ // For Library Version: 1.97.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {