@sapui5/ts-types-esm 1.135.0 → 1.136.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 (68) hide show
  1. package/package.json +1 -1
  2. package/types/sap.apf.d.ts +1 -1
  3. package/types/sap.ca.ui.d.ts +1 -1
  4. package/types/sap.chart.d.ts +1 -1
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.cux.home.d.ts +82 -0
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +101 -1
  9. package/types/sap.fe.base.d.ts +1 -1
  10. package/types/sap.fe.controls.d.ts +1 -1
  11. package/types/sap.fe.core.d.ts +27 -3
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +446 -57
  14. package/types/sap.fe.navigation.d.ts +1 -1
  15. package/types/sap.fe.placeholder.d.ts +1 -1
  16. package/types/sap.fe.plugins.managecache.d.ts +1 -1
  17. package/types/sap.fe.templates.d.ts +1 -1
  18. package/types/sap.fe.test.d.ts +1 -1
  19. package/types/sap.fe.tools.d.ts +1 -1
  20. package/types/sap.feedback.ui.d.ts +1 -1
  21. package/types/sap.gantt.d.ts +80 -8
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +518 -39
  24. package/types/sap.makit.d.ts +1 -1
  25. package/types/sap.me.d.ts +1 -1
  26. package/types/sap.ndc.d.ts +1 -1
  27. package/types/sap.ovp.d.ts +1 -1
  28. package/types/sap.rules.ui.d.ts +1 -1
  29. package/types/sap.sac.df.d.ts +14 -6
  30. package/types/sap.suite.ui.commons.d.ts +12 -1
  31. package/types/sap.suite.ui.generic.template.d.ts +8 -2
  32. package/types/sap.suite.ui.microchart.d.ts +1 -1
  33. package/types/sap.tnt.d.ts +1 -1
  34. package/types/sap.ui.codeeditor.d.ts +1 -1
  35. package/types/sap.ui.commons.d.ts +1 -1
  36. package/types/sap.ui.comp.d.ts +3278 -212
  37. package/types/sap.ui.core.d.ts +114 -117
  38. package/types/sap.ui.dt.d.ts +1 -1
  39. package/types/sap.ui.export.d.ts +1 -1
  40. package/types/sap.ui.fl.d.ts +8 -2
  41. package/types/sap.ui.generic.app.d.ts +1 -1
  42. package/types/sap.ui.generic.template.d.ts +1 -1
  43. package/types/sap.ui.integration.d.ts +5 -3
  44. package/types/sap.ui.layout.d.ts +1 -1
  45. package/types/sap.ui.mdc.d.ts +135 -8
  46. package/types/sap.ui.richtexteditor.d.ts +8 -8
  47. package/types/sap.ui.rta.d.ts +1 -1
  48. package/types/sap.ui.suite.d.ts +1 -1
  49. package/types/sap.ui.support.d.ts +1 -1
  50. package/types/sap.ui.table.d.ts +7 -1
  51. package/types/sap.ui.testrecorder.d.ts +1 -1
  52. package/types/sap.ui.unified.d.ts +14 -32
  53. package/types/sap.ui.ux3.d.ts +3 -3
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +310 -39
  56. package/types/sap.ui.vtm.d.ts +1 -1
  57. package/types/sap.ui.webc.common.d.ts +1 -1
  58. package/types/sap.ui.webc.fiori.d.ts +1 -1
  59. package/types/sap.ui.webc.main.d.ts +1 -1
  60. package/types/sap.uiext.inbox.d.ts +1 -1
  61. package/types/sap.ushell.d.ts +46 -37
  62. package/types/sap.ushell_abap.d.ts +1 -1
  63. package/types/sap.uxap.d.ts +2 -21
  64. package/types/sap.viz.d.ts +1 -1
  65. package/types/sap.webanalytics.core.d.ts +1 -1
  66. package/types/sap.zen.commons.d.ts +1 -1
  67. package/types/sap.zen.crosstab.d.ts +1 -1
  68. package/types/sap.zen.dsh.d.ts +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types-esm",
3
- "version": "1.135.0",
3
+ "version": "1.136.1",
4
4
  "description": "SAPUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/apf/library" {}
4
4
 
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/ca/ui/library" {
4
4
  export namespace charts {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/chart/library" {
4
4
  import Dimension from "sap/chart/data/Dimension";
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/collaboration/library" {
4
4
  /**
@@ -320,6 +320,21 @@ declare module "sap/cux/home/BaseSettingsDialog" {
320
320
  * @returns An empty array representing the removed panels.
321
321
  */
322
322
  removeAllPanels(): BaseSettingsPanel[];
323
+ /**
324
+ * Removes a panel from the dialog and updates the cache.
325
+ * Removes a panel from the aggregation "panels".
326
+ * Contains the panels aggregation and should be of type BaseSettingsPanel.
327
+ *
328
+ *
329
+ *
330
+ * @returns The removed panel.
331
+ */
332
+ removePanel(
333
+ /**
334
+ * - The panel to remove.
335
+ */
336
+ panel: BaseSettingsPanel
337
+ ): BaseSettingsPanel;
323
338
  }
324
339
  /**
325
340
  * Describes the settings that can be provided to the BaseSettingsDialog constructor.
@@ -332,6 +347,8 @@ declare module "sap/cux/home/BaseSettingsDialog" {
332
347
  declare module "sap/cux/home/BaseSettingsPanel" {
333
348
  import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
334
349
 
350
+ import Button from "sap/m/Button";
351
+
335
352
  /**
336
353
  * Abstract base class for panels inside My Home Settings Dialog.
337
354
  *
@@ -353,6 +370,18 @@ declare module "sap/cux/home/BaseSettingsPanel" {
353
370
  settings?: /* was: sap.cux.home.BaseSettingsPanel.$BaseSettingsPanelSettings */ any
354
371
  );
355
372
 
373
+ /**
374
+ * Adds an action button to the panel.
375
+ *
376
+ *
377
+ * @returns The instance of the panel for chaining.
378
+ */
379
+ addActionButton(
380
+ /**
381
+ * - The button to add.
382
+ */
383
+ button: Button
384
+ ): BaseSettingsPanel;
356
385
  /**
357
386
  * Add Changes made by user in case of KeyUser Settings Panel.
358
387
  */
@@ -361,6 +390,13 @@ declare module "sap/cux/home/BaseSettingsPanel" {
361
390
  * Clear all KeyUser Changes made by user.
362
391
  */
363
392
  clearKeyUserChanges(): void;
393
+ /**
394
+ * Retrieves the action buttons from the panel.
395
+ *
396
+ *
397
+ * @returns array of action buttons.
398
+ */
399
+ getActionButtons(): Button[];
364
400
  /**
365
401
  * Returns the KeyUser Changes made by user.
366
402
  */
@@ -369,6 +405,41 @@ declare module "sap/cux/home/BaseSettingsPanel" {
369
405
  * Init lifecycle method
370
406
  */
371
407
  init(): void;
408
+ /**
409
+ * Inserts an action button at a specific index in the panel.
410
+ *
411
+ *
412
+ * @returns The instance of the panel for chaining.
413
+ */
414
+ insertActionButton(
415
+ /**
416
+ * - The button to insert.
417
+ */
418
+ button: Button,
419
+ /**
420
+ * - The index at which to insert the button.
421
+ */
422
+ index: number
423
+ ): BaseSettingsPanel;
424
+ /**
425
+ * Checks if the panel is supported. To be overridden by subclasses.
426
+ *
427
+ *
428
+ * @returns A promise that resolves to true if the panel is supported.
429
+ */
430
+ isSupported(): Promise<boolean>;
431
+ /**
432
+ * Removes an action button from the panel.
433
+ *
434
+ *
435
+ * @returns The removed button or null if not found.
436
+ */
437
+ removeActionButton(
438
+ /**
439
+ * - The button to remove.
440
+ */
441
+ button: Button
442
+ ): null | Button;
372
443
  }
373
444
  /**
374
445
  * Describes the settings that can be provided to the BaseSettingsPanel constructor.
@@ -404,6 +475,17 @@ declare module "sap/cux/home/CardsPanel" {
404
475
  */
405
476
  settings?: /* was: sap.cux.home.CardsPanel.$CardsPanelSettings */ any
406
477
  );
478
+
479
+ /**
480
+ * Triggers a full refresh of the Insights Cards's data and UI.
481
+ * Reloads all the user cards within the Insights Cards section by reinitializing relevant services
482
+ * and re-rendering the panel.
483
+ *
484
+ *
485
+ *
486
+ * @returns A promise that resolves once the Insights Cards section has been refreshed.
487
+ */
488
+ refreshData(): Promise<void>;
407
489
  }
408
490
  /**
409
491
  * Describes the settings that can be provided to the CardsPanel constructor.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.1
1
+ // For Library Version: 1.136.2
2
2
 
3
3
  declare module "sap/esh/search/ui/SearchCompositeControl" {
4
4
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
package/types/sap.f.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/tnt/library" {
4
4
  export interface IToolHeader {
@@ -1907,6 +1907,20 @@ declare module "sap/f/cards/BaseHeader" {
1907
1907
  */
1908
1908
  oBannerLine: Text
1909
1909
  ): this;
1910
+ /**
1911
+ * Adds some infoSection to the aggregation {@link #getInfoSection infoSection}.
1912
+ *
1913
+ * @since 1.136
1914
+ * @experimental As of version 1.136.
1915
+ *
1916
+ * @returns Reference to `this` in order to allow method chaining
1917
+ */
1918
+ addInfoSection(
1919
+ /**
1920
+ * The infoSection to add; if empty, nothing is inserted
1921
+ */
1922
+ oInfoSection: Control
1923
+ ): this;
1910
1924
  /**
1911
1925
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.cards.BaseHeader`.
1912
1926
  *
@@ -1963,6 +1977,15 @@ declare module "sap/f/cards/BaseHeader" {
1963
1977
  * @returns Reference to `this` in order to allow method chaining
1964
1978
  */
1965
1979
  destroyBannerLines(): this;
1980
+ /**
1981
+ * Destroys all the infoSection in the aggregation {@link #getInfoSection infoSection}.
1982
+ *
1983
+ * @since 1.136
1984
+ * @experimental As of version 1.136.
1985
+ *
1986
+ * @returns Reference to `this` in order to allow method chaining
1987
+ */
1988
+ destroyInfoSection(): this;
1966
1989
  /**
1967
1990
  * Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
1968
1991
  *
@@ -2039,6 +2062,15 @@ declare module "sap/f/cards/BaseHeader" {
2039
2062
  * @returns Value of property `href`
2040
2063
  */
2041
2064
  getHref(): string;
2065
+ /**
2066
+ * Gets content of aggregation {@link #getInfoSection infoSection}.
2067
+ *
2068
+ * Info sections to be displayed in the header.
2069
+ *
2070
+ * @since 1.136
2071
+ * @experimental As of version 1.136.
2072
+ */
2073
+ getInfoSection(): Control[];
2042
2074
  /**
2043
2075
  * Gets current value of property {@link #getStatusVisible statusVisible}.
2044
2076
  *
@@ -2098,6 +2130,21 @@ declare module "sap/f/cards/BaseHeader" {
2098
2130
  */
2099
2131
  oBannerLine: Text
2100
2132
  ): int;
2133
+ /**
2134
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getInfoSection infoSection}.
2135
+ * and returns its index if found or -1 otherwise.
2136
+ *
2137
+ * @since 1.136
2138
+ * @experimental As of version 1.136.
2139
+ *
2140
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
2141
+ */
2142
+ indexOfInfoSection(
2143
+ /**
2144
+ * The infoSection whose index is looked for
2145
+ */
2146
+ oInfoSection: Control
2147
+ ): int;
2101
2148
  /**
2102
2149
  * Inserts a bannerLine into the aggregation {@link #getBannerLines bannerLines}.
2103
2150
  *
@@ -2118,6 +2165,26 @@ declare module "sap/f/cards/BaseHeader" {
2118
2165
  */
2119
2166
  iIndex: int
2120
2167
  ): this;
2168
+ /**
2169
+ * Inserts a infoSection into the aggregation {@link #getInfoSection infoSection}.
2170
+ *
2171
+ * @since 1.136
2172
+ * @experimental As of version 1.136.
2173
+ *
2174
+ * @returns Reference to `this` in order to allow method chaining
2175
+ */
2176
+ insertInfoSection(
2177
+ /**
2178
+ * The infoSection to insert; if empty, nothing is inserted
2179
+ */
2180
+ oInfoSection: Control,
2181
+ /**
2182
+ * The `0`-based index the infoSection should be inserted at; for a negative value of `iIndex`, the infoSection
2183
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the infoSection
2184
+ * is inserted at the last position
2185
+ */
2186
+ iIndex: int
2187
+ ): this;
2121
2188
  /**
2122
2189
  * Removes all the controls from the aggregation {@link #getBannerLines bannerLines}.
2123
2190
  *
@@ -2129,6 +2196,17 @@ declare module "sap/f/cards/BaseHeader" {
2129
2196
  * @returns An array of the removed elements (might be empty)
2130
2197
  */
2131
2198
  removeAllBannerLines(): Text[];
2199
+ /**
2200
+ * Removes all the controls from the aggregation {@link #getInfoSection infoSection}.
2201
+ *
2202
+ * Additionally, it unregisters them from the hosting UIArea.
2203
+ *
2204
+ * @since 1.136
2205
+ * @experimental As of version 1.136.
2206
+ *
2207
+ * @returns An array of the removed elements (might be empty)
2208
+ */
2209
+ removeAllInfoSection(): Control[];
2132
2210
  /**
2133
2211
  * Removes a bannerLine from the aggregation {@link #getBannerLines bannerLines}.
2134
2212
  *
@@ -2143,6 +2221,20 @@ declare module "sap/f/cards/BaseHeader" {
2143
2221
  */
2144
2222
  vBannerLine: int | string | Text
2145
2223
  ): Text | null;
2224
+ /**
2225
+ * Removes a infoSection from the aggregation {@link #getInfoSection infoSection}.
2226
+ *
2227
+ * @since 1.136
2228
+ * @experimental As of version 1.136.
2229
+ *
2230
+ * @returns The removed infoSection or `null`
2231
+ */
2232
+ removeInfoSection(
2233
+ /**
2234
+ * The infoSection to remove or its index or id
2235
+ */
2236
+ vInfoSection: int | string | Control
2237
+ ): Control | null;
2146
2238
  /**
2147
2239
  * Sets a new value for property {@link #getDataTimestamp dataTimestamp}.
2148
2240
  *
@@ -2303,6 +2395,14 @@ declare module "sap/f/cards/BaseHeader" {
2303
2395
  */
2304
2396
  target?: string | PropertyBindingInfo;
2305
2397
 
2398
+ /**
2399
+ * Info sections to be displayed in the header.
2400
+ *
2401
+ * @since 1.136
2402
+ * @experimental As of version 1.136.
2403
+ */
2404
+ infoSection?: Control[] | Control | AggregationBindingInfo | `{${string}}`;
2405
+
2306
2406
  /**
2307
2407
  * Defines the toolbar.
2308
2408
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/fe/base/BuildingBlockBase" {
4
4
  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {}
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare module "sap/fe/core/AppComponent" {
4
4
  import {
@@ -1019,6 +1019,26 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
1019
1019
  * @experimental As of version 1.90.0.
1020
1020
  */
1021
1021
  export default class MessageHandler extends ControllerExtension {
1022
+ /**
1023
+ * Allows consumer of a message button BB to decide which bound messages should be shown and how.
1024
+ * This hook is called when the message button BB detects a change in the message model.
1025
+ * The hooks allows to define behaviour for messages in the message button BB.
1026
+ * Consumers will be able to do the following with this hook.
1027
+ * 1. Filter out messages so that they are not shown on the message button.
1028
+ * 2. group the messages based on their UI.
1029
+ * 3. provide a presser handler incase the message should show as a link.
1030
+ *
1031
+ *
1032
+ * @experimental
1033
+ *
1034
+ * @returns A promise that must be returned by the overridden method.
1035
+ */
1036
+ beforeShowMessageButton(
1037
+ /**
1038
+ * Object containing the details related to the message.
1039
+ */
1040
+ _messageDetails: MessageDetail[]
1041
+ ): Promise<void>;
1022
1042
  /**
1023
1043
  * Shows a message dialog with transition messages if there are any.
1024
1044
  * The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
@@ -1036,6 +1056,10 @@ declare module "sap/fe/core/controllerextensions/MessageHandler" {
1036
1056
  */
1037
1057
  showMessageDialog(): Promise<void>;
1038
1058
  }
1059
+ /**
1060
+ * Defines the message detail relevant for the MessageButton building block to display a popover.
1061
+ */
1062
+ export type MessageDetail = {};
1039
1063
  }
1040
1064
 
1041
1065
  declare module "sap/fe/core/controllerextensions/Paginator" {
@@ -1081,7 +1105,7 @@ declare module "sap/fe/core/controllerextensions/Paginator" {
1081
1105
  }
1082
1106
 
1083
1107
  declare module "sap/fe/core/controllerextensions/Routing" {
1084
- import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
1108
+ import BaseControllerExtension from "sap/fe/core/controllerextensions/BaseControllerExtension";
1085
1109
 
1086
1110
  import Context from "sap/ui/model/odata/v4/Context";
1087
1111
 
@@ -1090,7 +1114,7 @@ declare module "sap/fe/core/controllerextensions/Routing" {
1090
1114
  *
1091
1115
  * @since 1.86.0
1092
1116
  */
1093
- export default class Routing extends ControllerExtension {
1117
+ export default class Routing extends BaseControllerExtension {
1094
1118
  /**
1095
1119
  * Allows navigation to a specific context.
1096
1120
  *
@@ -1,3 +1,3 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {}