@sapui5/ts-types 1.144.1 → 1.145.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 (70) hide show
  1. package/package.json +1 -1
  2. package/types/{sap.ui.core.d.ts → core-1.145.0-d.ts} +140 -97
  3. package/types/index.d.ts +3 -3
  4. package/types/{sap.ui.mdc.d.ts → mdc-1.145.0-d.ts} +356 -49
  5. package/types/{sap.m.d.ts → mobile-1.145.0-d.ts} +29 -12
  6. package/types/sap.apf.d.ts +1 -1
  7. package/types/sap.ca.ui.d.ts +1 -1
  8. package/types/sap.chart.d.ts +1 -1
  9. package/types/sap.collaboration.d.ts +1 -1
  10. package/types/sap.esh.search.ui.d.ts +112 -82
  11. package/types/sap.f.d.ts +1 -1
  12. package/types/sap.fe.ariba.d.ts +1 -1
  13. package/types/sap.fe.base.d.ts +300 -28
  14. package/types/sap.fe.controls.d.ts +1 -1
  15. package/types/sap.fe.core.d.ts +165 -4
  16. package/types/sap.fe.ina.d.ts +1 -1
  17. package/types/sap.fe.macros.d.ts +1108 -284
  18. package/types/sap.fe.navigation.d.ts +1 -1
  19. package/types/sap.fe.placeholder.d.ts +1 -1
  20. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  21. package/types/sap.fe.templates.d.ts +12 -1
  22. package/types/sap.fe.test.d.ts +150 -1
  23. package/types/sap.fe.tools.d.ts +1 -1
  24. package/types/sap.feedback.ui.d.ts +1 -1
  25. package/types/sap.gantt.d.ts +134 -1
  26. package/types/sap.insights.d.ts +1 -1
  27. package/types/sap.makit.d.ts +1 -1
  28. package/types/sap.me.d.ts +1 -1
  29. package/types/sap.ndc.d.ts +1 -1
  30. package/types/sap.ovp.d.ts +32 -2
  31. package/types/sap.rules.ui.d.ts +1 -1
  32. package/types/sap.sac.df.d.ts +1 -1
  33. package/types/sap.suite.ui.commons.d.ts +234 -15
  34. package/types/sap.suite.ui.generic.template.d.ts +46 -1
  35. package/types/sap.suite.ui.microchart.d.ts +2 -1
  36. package/types/sap.tnt.d.ts +19 -11
  37. package/types/sap.ui.codeeditor.d.ts +1 -1
  38. package/types/sap.ui.commons.d.ts +1 -1
  39. package/types/sap.ui.comp.d.ts +76 -2
  40. package/types/sap.ui.dt.d.ts +1 -1
  41. package/types/sap.ui.export.d.ts +1 -1
  42. package/types/sap.ui.fl.d.ts +5 -1
  43. package/types/sap.ui.generic.app.d.ts +1 -1
  44. package/types/sap.ui.generic.template.d.ts +1 -1
  45. package/types/sap.ui.geomap.d.ts +1 -1
  46. package/types/sap.ui.integration.d.ts +1 -1
  47. package/types/sap.ui.layout.d.ts +1 -1
  48. package/types/sap.ui.richtexteditor.d.ts +29 -7
  49. package/types/sap.ui.rta.d.ts +1 -1
  50. package/types/sap.ui.suite.d.ts +1 -1
  51. package/types/sap.ui.support.d.ts +1 -1
  52. package/types/sap.ui.table.d.ts +5 -1
  53. package/types/sap.ui.testrecorder.d.ts +1 -1
  54. package/types/sap.ui.unified.d.ts +42 -1
  55. package/types/sap.ui.ux3.d.ts +1 -1
  56. package/types/sap.ui.vbm.d.ts +1 -1
  57. package/types/sap.ui.vk.d.ts +175 -1
  58. package/types/sap.ui.vtm.d.ts +1 -1
  59. package/types/sap.ui.webc.common.d.ts +1 -1
  60. package/types/sap.ui.webc.fiori.d.ts +1 -1
  61. package/types/sap.ui.webc.main.d.ts +1 -1
  62. package/types/sap.uiext.inbox.d.ts +1 -1
  63. package/types/sap.ushell.d.ts +5 -1
  64. package/types/sap.ushell_abap.d.ts +1 -1
  65. package/types/sap.uxap.d.ts +18 -8
  66. package/types/sap.viz.d.ts +1 -1
  67. package/types/sap.webanalytics.core.d.ts +1 -1
  68. package/types/sap.zen.commons.d.ts +1 -1
  69. package/types/sap.zen.crosstab.d.ts +1 -1
  70. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,31 +1,303 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.145.1
2
+
2
3
 
3
4
  declare namespace sap {
4
- namespace fe {
5
- /**
6
- * Library providing the base functionality of the runtime for SAP Fiori elements for OData V4.
7
- */
8
- namespace base {
9
- /**
10
- * Describes the settings that can be provided to the BuildingBlockBase constructor.
11
- */
12
- interface $BuildingBlockBaseSettings
13
- extends sap.ui.core.$ControlSettings {}
14
-
15
- /**
16
- * Base class for building blocks.
17
- * This contains the low level functionality of having a content aggregation and handling the rendering
18
- * of the content without an actual DOM element.
19
- * The building block also defines a state object that can be used to store the state of the building block.
20
- * Accessibility and classes information are forwarded to the content control.
21
- */
22
- class BuildingBlockBase extends sap.ui.core.Control {}
23
- }
24
- }
25
-
26
- interface IUI5DefineDependencyNames {
27
- "sap/fe/base/BuildingBlockBase": undefined;
28
-
29
- "sap/fe/base/library": undefined;
30
- }
5
+
6
+
7
+
8
+ namespace fe {
9
+
10
+
11
+ /**
12
+ * Library providing the base functionality of the runtime for SAP Fiori elements for OData V4.
13
+ */
14
+ namespace base {
15
+
16
+
17
+
18
+ namespace BindingToolkit {
19
+
20
+
21
+
22
+
23
+
24
+
25
+ /**
26
+ * A binding expression that evaluates to type T.
27
+ *
28
+ * @experimental As of version 1.145.0.
29
+ */
30
+ type BindingToolkitExpression = {
31
+ }
32
+
33
+ }
34
+
35
+ namespace ClassSupport {
36
+
37
+
38
+
39
+
40
+
41
+
42
+ /**
43
+ * Represents the state object of a building block.
44
+ *
45
+ * @experimental As of version 1.145.0.
46
+ */
47
+ type BindingInfoHolder = {
48
+ }
49
+
50
+ /**
51
+ * Represents the state object of a building block.
52
+ *
53
+ * @experimental As of version 1.145.0.
54
+ */
55
+ type ExtendWithObject = {
56
+ }
57
+
58
+ /**
59
+ * Returns the properties of a control.
60
+ *
61
+ * @experimental As of version 1.145.0.
62
+ */
63
+ type PropertiesOf = {
64
+ }
65
+
66
+ /**
67
+ * Represents the state object of a building block.
68
+ *
69
+ * @experimental As of version 1.145.0.
70
+ */
71
+ type StateOf = {
72
+ }
73
+
74
+ /**
75
+ * Definition of a UI5 aggregation metadata.
76
+ *
77
+ * @experimental As of version 1.145.0.
78
+ */
79
+ type UI5AggregationMetadata = {
80
+ }
81
+
82
+ /**
83
+ * Definition of a UI5 association metadata.
84
+ *
85
+ * @experimental As of version 1.145.0.
86
+ */
87
+ type UI5AssociationMetadata = {
88
+ }
89
+
90
+ /**
91
+ * Definition of a UI5 property metadata.
92
+ *
93
+ * @experimental As of version 1.145.0.
94
+ */
95
+ type UI5PropertyMetadata = {
96
+ }
97
+
98
+ }
99
+ /**
100
+ * Describes the settings that can be provided to the BuildingBlockBase constructor.
101
+ */
102
+ interface $BuildingBlockBaseSettings extends sap.ui.core.$ControlSettings {
103
+ /**
104
+ * The current state value of the component.
105
+ * This property holds the state data managed by the component, with the type
106
+ * determined by the generic parameter K.
107
+ */
108
+ state? : /* was: sap.fe.base.ClassSupport.StateOf */ any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`
109
+
110
+ /**
111
+ * Optional content of generic type T.
112
+ * This property holds the main data or payload for the containing object.
113
+ * When undefined, it indicates that no content has been set or is available.
114
+ * The specific type and structure of the content depends on the generic type parameter T.
115
+ */
116
+ content? : sap.ui.core.Element
117
+
118
+ /**
119
+ * Association to controls / IDs that label this control (see WAI-ARIA attribute aria-labelledby).
120
+ */
121
+ ariaLabelledBy? : sap.ui.core.Control | string
122
+
123
+
124
+ }
125
+
126
+ /**
127
+ * Collection of functions to support the manipulation of UI5 bindings
128
+ *
129
+ * @experimental As of version 1.145.0.
130
+ */
131
+ interface BindingToolkit {
132
+
133
+
134
+ }
135
+
136
+ /**
137
+ * Collection of decorators to support the creation of UI5 classes.
138
+ */
139
+ interface ClassSupport {
140
+
141
+ /**
142
+ * Defines and configures the following aggregation in the control metadata.
143
+ *
144
+ * @experimental As of version 1.145.0.
145
+ *
146
+ * @returns The decorated property.
147
+ */
148
+ aggregation(
149
+ /**
150
+ * The aggregation definition
151
+ */
152
+ aggregationDefinition: sap.fe.base.ClassSupport.UI5AggregationMetadata
153
+ ): PropertyDecorator
154
+ /**
155
+ * Defines and configures the following association in the control metadata.
156
+ *
157
+ * @experimental As of version 1.145.0.
158
+ *
159
+ * @returns The decorated property
160
+ */
161
+ association(
162
+ /**
163
+ * The definition of the association.
164
+ */
165
+ ui5AssociationMetadata: sap.fe.base.ClassSupport.UI5AssociationMetadata
166
+ ): PropertyDecorator
167
+ /**
168
+ * Allows to define a property that holds the control state.
169
+ * Properties defined with this decorator are automatically bound to the control state when used in JSX.
170
+ * Arrays need to be bound using the `bindState` function.
171
+ *
172
+ *
173
+ * @experimental As of version 1.145.0.
174
+ *
175
+ * @returns A property decorator
176
+ */
177
+ defineState(
178
+
179
+ ): PropertyDecorator
180
+ /**
181
+ * Indicates that the following class should define a UI5 control of the specified name.
182
+ *
183
+ * @experimental As of version 1.145.0.
184
+ *
185
+ * @returns A class decorator that creates a UI5 class out of the TS class
186
+ */
187
+ defineUI5Class(
188
+ /**
189
+ * The fully qualified name of the UI5 class
190
+ */
191
+ target: string,
192
+ /**
193
+ * Additional inline metadata definition
194
+ */
195
+ metadataDefinition?: Partial</* was: sap.fe.base.ClassSupport.UI5ControlMetadataDefinition */ any>
196
+ ): ClassDecorator
197
+ /**
198
+ * Indicates that the property is declared as an event on the control metadata.
199
+ *
200
+ * @experimental As of version 1.145.0.
201
+ *
202
+ * @returns The decorated property
203
+ */
204
+ event(
205
+
206
+ ): PropertyDecorator
207
+ /**
208
+ * Defines in the metadata that this control implements a specific interface.
209
+ *
210
+ * @experimental As of version 1.144.0.
211
+ *
212
+ * @returns The decorated method
213
+ */
214
+ implementInterface(
215
+ /**
216
+ * The name of the implemented interface
217
+ */
218
+ interfaceName: string
219
+ ): PropertyDecorator
220
+ /**
221
+ * Defines the following property as a managed object in the control metadata.
222
+ *
223
+ * @experimental As of version 1.145.0.
224
+ *
225
+ * @returns The decorated property.
226
+ */
227
+ property(
228
+ /**
229
+ * The property definition
230
+ */
231
+ attributeDefinition: sap.fe.base.ClassSupport.UI5PropertyMetadata
232
+ ): PropertyDecorator
233
+ }
234
+
235
+ /**
236
+ * Base class for building blocks.
237
+ * This contains the low-level functionality of having a content aggregation and handling the rendering
238
+ * of the content without an actual DOM element.
239
+ *
240
+ * The building block also defines a state object that can be used to store the state of the building block.
241
+ *
242
+ * Accessibility and classes information are forwarded to the content control.
243
+ *
244
+ * This class is not meant to be used directly, it's there for internal use only (and documentation)
245
+ */
246
+ class BuildingBlockBase extends sap.ui.core.Control {
247
+
248
+
249
+ /**
250
+ * Shorthand for the BindingToolkit.bindState function with the current state object.
251
+ *
252
+ * @experimental As of version 1.145.0.
253
+ *
254
+ * @returns The binding toolkit expression for the state
255
+ */
256
+ bindState(
257
+ /**
258
+ * A property in the state object
259
+ */
260
+ path:
261
+ ): /* was: sap.fe.base.BindingToolkit.BindingToolkitExpression */ any
262
+ /**
263
+ * Framework hook for state change handling.
264
+ * Subclasses can override this method to react to state changes.
265
+ *
266
+ * @experimental As of version 1.145.0.
267
+ */
268
+ onStateChange(
269
+ /**
270
+ * List of changed property names
271
+ */
272
+ _changedProps: string[]
273
+ ): void
274
+ }
275
+
276
+
277
+ }
278
+
279
+
280
+
281
+
282
+ }
283
+
284
+ interface IUI5DefineDependencyNames {
285
+
286
+ "sap/fe/base/BindingToolkit" : undefined
287
+
288
+
289
+ "sap/fe/base/BuildingBlockBase" : undefined
290
+
291
+
292
+ "sap/fe/base/ClassSupport" : undefined
293
+
294
+
295
+ "sap/fe/base/library" : undefined
296
+
297
+
298
+ }
299
+
300
+
301
+
302
+
31
303
  }
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.145.1
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.145.1
2
2
 
3
3
  declare namespace sap {
4
4
  /**
@@ -368,6 +368,10 @@ declare namespace sap {
368
368
  contexts?:
369
369
  | sap.ui.model.odata.v4.Context
370
370
  | sap.ui.model.odata.v4.Context[];
371
+ /**
372
+ * Disables strict handling of action calls to turn off 412 confirmation popups
373
+ */
374
+ disableStrictHandling?: boolean;
371
375
  /**
372
376
  * Mode how actions are to be called: 'ChangeSet' to put all action calls into one changeset, 'Isolated'
373
377
  * to put them into separate changesets
@@ -1272,6 +1276,18 @@ declare namespace sap {
1272
1276
  * Collection of classes provided by SAP Fiori elements for the Flexible Programming Model
1273
1277
  */
1274
1278
  namespace fpm {
1279
+ /**
1280
+ * Describes the settings that can be provided to the Component constructor.
1281
+ */
1282
+ interface $ComponentSettings
1283
+ extends sap.fe.core.$TemplateComponentSettings {
1284
+ /**
1285
+ * Name of the XML view which is used for this page. The XML view can contain SAP Fiori elements Building
1286
+ * Blocks and XML template constructions.
1287
+ */
1288
+ viewName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1289
+ }
1290
+
1275
1291
  /**
1276
1292
  * Component that can be used as a wrapper component for custom pages.
1277
1293
  * The component can be used in case you want to use SAP Fiori elements Building Blocks or XML template
@@ -1299,9 +1315,7 @@ declare namespace sap {
1299
1315
  *
1300
1316
  * @since 1.92.0
1301
1317
  */
1302
- class Component
1303
- extends /* was: sap.fe.core.TemplateComponent */ Object
1304
- {
1318
+ class Component extends sap.fe.core.TemplateComponent {
1305
1319
  /**
1306
1320
  * Returns the current AppComponent.
1307
1321
  *
@@ -1390,6 +1404,43 @@ declare namespace sap {
1390
1404
  interface $AppComponentSettings
1391
1405
  extends sap.ui.core.$UIComponentSettings {}
1392
1406
 
1407
+ /**
1408
+ * Describes the settings that can be provided to the ReuseComponent constructor.
1409
+ */
1410
+ interface $ReuseComponentSettings
1411
+ extends sap.fe.core.fpm.$ComponentSettings {
1412
+ /**
1413
+ * Event that is fired once the component is initialized
1414
+ */
1415
+ initialized?: (oEvent: sap.ui.base.Event) => void;
1416
+ }
1417
+
1418
+ /**
1419
+ * Describes the settings that can be provided to the TemplateComponent constructor.
1420
+ */
1421
+ interface $TemplateComponentSettings
1422
+ extends sap.ui.core.$UIComponentSettings {
1423
+ /**
1424
+ * Defines the path of the context used in the current page.
1425
+ */
1426
+ contextPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
1427
+
1428
+ /**
1429
+ * Enhance the i18n bundle used for this page with one or more app specific i18n resource bundles or resource
1430
+ * models
1431
+ * or a combination of both. The last resource bundle or model is given the highest priority.
1432
+ */
1433
+ enhanceI18n?:
1434
+ | string[]
1435
+ | sap.ui.base.ManagedObject.PropertyBindingInfo
1436
+ | `{${string}}`;
1437
+ }
1438
+
1439
+ /**
1440
+ * Parameters of the ReuseComponent#initialized event.
1441
+ */
1442
+ interface ReuseComponent$InitializedEventParameters {}
1443
+
1393
1444
  /**
1394
1445
  * Main class for components used for an application in SAP Fiori elements.
1395
1446
  * Application developers using the templates and building blocks provided by SAP Fiori elements should
@@ -1674,6 +1725,105 @@ declare namespace sap {
1674
1725
  */
1675
1726
  getExtensionAPI(): sap.fe.core.ExtensionAPI;
1676
1727
  }
1728
+ /**
1729
+ * Base component for reuse compontents in SAP Fiori elements.
1730
+ * By extending from this component you get access to the extension API of the page component
1731
+ * and get native support for SAP Fiori elements building blocks.
1732
+ *
1733
+ *
1734
+ * @since 1.145.0
1735
+ */
1736
+ class ReuseComponent extends sap.fe.core.fpm.Component {
1737
+ /**
1738
+ *
1739
+ * @returns Reference to sap.fe.core.ReuseComponent
1740
+ * to allow method chaining
1741
+ */
1742
+ attachInitialized(
1743
+ /**
1744
+ * An application-specific payload object that will be passed to the event handler along with the event
1745
+ * object when firing the event
1746
+ */
1747
+ oData: object,
1748
+ /**
1749
+ * The function to be called when the event occurs
1750
+ */
1751
+ fnFunction: (p1: sap.ui.base.Event) => void,
1752
+ /**
1753
+ * The context object to call the event handler with. Defaults to this `this` control
1754
+ */
1755
+ oListener?: object
1756
+ ): this;
1757
+ /**
1758
+ *
1759
+ * @returns Reference to sap.fe.core.ReuseComponent
1760
+ * to allow method chaining
1761
+ */
1762
+ attachInitialized(
1763
+ /**
1764
+ * The function to be called when the event occurs
1765
+ */
1766
+ fnFunction: (p1: sap.ui.base.Event) => void,
1767
+ /**
1768
+ * The context object to call the event handler with. Defaults to this `this` control
1769
+ */
1770
+ oListener?: object
1771
+ ): this;
1772
+ /**
1773
+ *
1774
+ * @returns Reference to sap.fe.core.ReuseComponent
1775
+ * to allow method chaining
1776
+ */
1777
+ detachInitialized(
1778
+ /**
1779
+ * The function to be called when the event occurs
1780
+ */
1781
+ fnFunction: (p1: sap.ui.base.Event) => void,
1782
+ /**
1783
+ * The context object to call the event handler with. Defaults to this `this` control
1784
+ */
1785
+ oListener?: object
1786
+ ): this;
1787
+ /**
1788
+ * Fires event initialized
1789
+ * to attached listeners.
1790
+ *
1791
+ * @ui5-protected Do not call from applications (only from related classes in the framework)
1792
+ *
1793
+ * @returns Reference to sap.fe.core.ReuseComponent
1794
+ * to allow method chaining
1795
+ */
1796
+ fireInitialized(
1797
+ /**
1798
+ * The parameters to pass along with the event.
1799
+ * See {@link Function} for the set of parameters that are expected by the event handlers.
1800
+ */
1801
+ mParameters?: {}
1802
+ ): this;
1803
+ /**
1804
+ * Returns the extension API of the page component that owns the reuse component.
1805
+ *
1806
+ *
1807
+ * @returns The extension API
1808
+ */
1809
+ getExtensionAPI(): sap.fe.core.ExtensionAPI;
1810
+ }
1811
+ /**
1812
+ * Base component for SAP Fiori elements floorplans.
1813
+ * This component provides as foundation for all SAP Fiori elements page types, and shall not be used directly.
1814
+ *
1815
+ *
1816
+ * @since 1.145.0
1817
+ */
1818
+ class TemplateComponent
1819
+ extends sap.ui.core.UIComponent
1820
+ implements
1821
+ sap.ui.core.IAsyncContentCreation,
1822
+ /* was: sap.fe.core.buildingBlocks.IBuildingBlockOwnerComponent.IBuildingBlockOwnerComponent */ Object
1823
+ {
1824
+ __implements__sap_ui_core_IAsyncContentCreation: boolean;
1825
+ __implements__sap_fe_core_buildingBlocks_IBuildingBlockOwnerComponent_IBuildingBlockOwnerComponent: boolean;
1826
+ }
1677
1827
  /**
1678
1828
  * Possible navigation modes for a pagination.
1679
1829
  *
@@ -1712,6 +1862,13 @@ declare namespace sap {
1712
1862
  */
1713
1863
  Enabled = "undefined",
1714
1864
  }
1865
+ /**
1866
+ * Event object of the ReuseComponent#initialized event.
1867
+ */
1868
+ type ReuseComponent$InitializedEvent = sap.ui.base.Event<
1869
+ ReuseComponent$InitializedEventParameters,
1870
+ ReuseComponent
1871
+ >;
1715
1872
  }
1716
1873
  }
1717
1874
 
@@ -1754,8 +1911,12 @@ declare namespace sap {
1754
1911
 
1755
1912
  "sap/fe/core/PageController": undefined;
1756
1913
 
1914
+ "sap/fe/core/ReuseComponent": undefined;
1915
+
1757
1916
  "sap/fe/core/rootView/Fcl.controller": undefined;
1758
1917
 
1759
1918
  "sap/fe/core/rootView/NavContainer.controller": undefined;
1919
+
1920
+ "sap/fe/core/TemplateComponent": undefined;
1760
1921
  }
1761
1922
  }
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.144.0
1
+ // For Library Version: 1.145.1
2
2
 
3
3
  declare namespace sap {}