@sapui5/ts-types 1.135.0 → 1.136.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 (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 +80 -0
  7. package/types/sap.esh.search.ui.d.ts +1 -1
  8. package/types/sap.f.d.ts +105 -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 +30 -2
  12. package/types/sap.fe.ina.d.ts +1 -1
  13. package/types/sap.fe.macros.d.ts +421 -47
  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 +78 -8
  22. package/types/sap.insights.d.ts +1 -1
  23. package/types/sap.m.d.ts +497 -32
  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 +4 -4
  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 +3474 -380
  37. package/types/sap.ui.core.d.ts +108 -111
  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 +1 -1
  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 +2 -2
  44. package/types/sap.ui.layout.d.ts +1 -1
  45. package/types/sap.ui.mdc.d.ts +127 -8
  46. package/types/sap.ui.richtexteditor.d.ts +8 -6
  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 +11 -31
  53. package/types/sap.ui.ux3.d.ts +1 -1
  54. package/types/sap.ui.vbm.d.ts +1 -1
  55. package/types/sap.ui.vk.d.ts +295 -25
  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",
3
- "version": "1.135.0",
3
+ "version": "1.136.0",
4
4
  "description": "SAPUI5 TypeScript Definitions",
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 namespace sap {
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 namespace sap {
4
4
  namespace ca {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
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 namespace sap {
4
4
  /**
@@ -545,6 +545,21 @@ declare namespace sap {
545
545
  * @returns An empty array representing the removed panels.
546
546
  */
547
547
  removeAllPanels(): sap.cux.home.BaseSettingsPanel[];
548
+ /**
549
+ * Removes a panel from the dialog and updates the cache.
550
+ * Removes a panel from the aggregation "panels".
551
+ * Contains the panels aggregation and should be of type BaseSettingsPanel.
552
+ *
553
+ *
554
+ *
555
+ * @returns The removed panel.
556
+ */
557
+ removePanel(
558
+ /**
559
+ * - The panel to remove.
560
+ */
561
+ panel: sap.cux.home.BaseSettingsPanel
562
+ ): sap.cux.home.BaseSettingsPanel;
548
563
  }
549
564
  /**
550
565
  * Abstract base class for panels inside My Home Settings Dialog.
@@ -567,6 +582,18 @@ declare namespace sap {
567
582
  settings?: /* was: sap.cux.home.BaseSettingsPanel.$BaseSettingsPanelSettings */ any
568
583
  );
569
584
 
585
+ /**
586
+ * Adds an action button to the panel.
587
+ *
588
+ *
589
+ * @returns The instance of the panel for chaining.
590
+ */
591
+ addActionButton(
592
+ /**
593
+ * - The button to add.
594
+ */
595
+ button: sap.m.Button
596
+ ): BaseSettingsPanel;
570
597
  /**
571
598
  * Add Changes made by user in case of KeyUser Settings Panel.
572
599
  */
@@ -575,6 +602,13 @@ declare namespace sap {
575
602
  * Clear all KeyUser Changes made by user.
576
603
  */
577
604
  clearKeyUserChanges(): void;
605
+ /**
606
+ * Retrieves the action buttons from the panel.
607
+ *
608
+ *
609
+ * @returns array of action buttons.
610
+ */
611
+ getActionButtons(): sap.m.Button[];
578
612
  /**
579
613
  * Returns the KeyUser Changes made by user.
580
614
  */
@@ -583,6 +617,41 @@ declare namespace sap {
583
617
  * Init lifecycle method
584
618
  */
585
619
  init(): void;
620
+ /**
621
+ * Inserts an action button at a specific index in the panel.
622
+ *
623
+ *
624
+ * @returns The instance of the panel for chaining.
625
+ */
626
+ insertActionButton(
627
+ /**
628
+ * - The button to insert.
629
+ */
630
+ button: sap.m.Button,
631
+ /**
632
+ * - The index at which to insert the button.
633
+ */
634
+ index: number
635
+ ): BaseSettingsPanel;
636
+ /**
637
+ * Checks if the panel is supported. To be overridden by subclasses.
638
+ *
639
+ *
640
+ * @returns A promise that resolves to true if the panel is supported.
641
+ */
642
+ isSupported(): Promise<boolean>;
643
+ /**
644
+ * Removes an action button from the panel.
645
+ *
646
+ *
647
+ * @returns The removed button or null if not found.
648
+ */
649
+ removeActionButton(
650
+ /**
651
+ * - The button to remove.
652
+ */
653
+ button: sap.m.Button
654
+ ): null | sap.m.Button;
586
655
  }
587
656
  /**
588
657
  * Panel class for managing and storing Insights Cards.
@@ -604,6 +673,17 @@ declare namespace sap {
604
673
  */
605
674
  settings?: /* was: sap.cux.home.CardsPanel.$CardsPanelSettings */ any
606
675
  );
676
+
677
+ /**
678
+ * Triggers a full refresh of the Insights Cards's data and UI.
679
+ * Reloads all the user cards within the Insights Cards section by reinitializing relevant services
680
+ * and re-rendering the panel.
681
+ *
682
+ *
683
+ *
684
+ * @returns A promise that resolves once the Insights Cards section has been refreshed.
685
+ */
686
+ refreshData(): Promise<void>;
607
687
  }
608
688
  /**
609
689
  * Provides the FavAppPanel Class.
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.1
1
+ // For Library Version: 1.136.2
2
2
 
3
3
  declare namespace sap {
4
4
  namespace esh {
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 namespace sap {
4
4
  /**
@@ -108,6 +108,18 @@ declare namespace sap {
108
108
  */
109
109
  target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
110
110
 
111
+ /**
112
+ * Info sections to be displayed in the header.
113
+ *
114
+ * @since 1.136
115
+ * @experimental As of version 1.136.
116
+ */
117
+ infoSection?:
118
+ | sap.ui.core.Control[]
119
+ | sap.ui.core.Control
120
+ | sap.ui.base.ManagedObject.AggregationBindingInfo
121
+ | `{${string}}`;
122
+
111
123
  /**
112
124
  * Defines the toolbar.
113
125
  *
@@ -642,6 +654,20 @@ declare namespace sap {
642
654
  */
643
655
  oBannerLine: sap.m.Text
644
656
  ): this;
657
+ /**
658
+ * Adds some infoSection to the aggregation {@link #getInfoSection infoSection}.
659
+ *
660
+ * @since 1.136
661
+ * @experimental As of version 1.136.
662
+ *
663
+ * @returns Reference to `this` in order to allow method chaining
664
+ */
665
+ addInfoSection(
666
+ /**
667
+ * The infoSection to add; if empty, nothing is inserted
668
+ */
669
+ oInfoSection: sap.ui.core.Control
670
+ ): this;
645
671
  /**
646
672
  * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.f.cards.BaseHeader`.
647
673
  *
@@ -698,6 +724,15 @@ declare namespace sap {
698
724
  * @returns Reference to `this` in order to allow method chaining
699
725
  */
700
726
  destroyBannerLines(): this;
727
+ /**
728
+ * Destroys all the infoSection in the aggregation {@link #getInfoSection infoSection}.
729
+ *
730
+ * @since 1.136
731
+ * @experimental As of version 1.136.
732
+ *
733
+ * @returns Reference to `this` in order to allow method chaining
734
+ */
735
+ destroyInfoSection(): this;
701
736
  /**
702
737
  * Destroys the toolbar in the aggregation {@link #getToolbar toolbar}.
703
738
  *
@@ -774,6 +809,15 @@ declare namespace sap {
774
809
  * @returns Value of property `href`
775
810
  */
776
811
  getHref(): string;
812
+ /**
813
+ * Gets content of aggregation {@link #getInfoSection infoSection}.
814
+ *
815
+ * Info sections to be displayed in the header.
816
+ *
817
+ * @since 1.136
818
+ * @experimental As of version 1.136.
819
+ */
820
+ getInfoSection(): sap.ui.core.Control[];
777
821
  /**
778
822
  * Gets current value of property {@link #getStatusVisible statusVisible}.
779
823
  *
@@ -833,6 +877,21 @@ declare namespace sap {
833
877
  */
834
878
  oBannerLine: sap.m.Text
835
879
  ): int;
880
+ /**
881
+ * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getInfoSection infoSection}.
882
+ * and returns its index if found or -1 otherwise.
883
+ *
884
+ * @since 1.136
885
+ * @experimental As of version 1.136.
886
+ *
887
+ * @returns The index of the provided control in the aggregation if found, or -1 otherwise
888
+ */
889
+ indexOfInfoSection(
890
+ /**
891
+ * The infoSection whose index is looked for
892
+ */
893
+ oInfoSection: sap.ui.core.Control
894
+ ): int;
836
895
  /**
837
896
  * Inserts a bannerLine into the aggregation {@link #getBannerLines bannerLines}.
838
897
  *
@@ -853,6 +912,26 @@ declare namespace sap {
853
912
  */
854
913
  iIndex: int
855
914
  ): this;
915
+ /**
916
+ * Inserts a infoSection into the aggregation {@link #getInfoSection infoSection}.
917
+ *
918
+ * @since 1.136
919
+ * @experimental As of version 1.136.
920
+ *
921
+ * @returns Reference to `this` in order to allow method chaining
922
+ */
923
+ insertInfoSection(
924
+ /**
925
+ * The infoSection to insert; if empty, nothing is inserted
926
+ */
927
+ oInfoSection: sap.ui.core.Control,
928
+ /**
929
+ * The `0`-based index the infoSection should be inserted at; for a negative value of `iIndex`, the infoSection
930
+ * is inserted at position 0; for a value greater than the current size of the aggregation, the infoSection
931
+ * is inserted at the last position
932
+ */
933
+ iIndex: int
934
+ ): this;
856
935
  /**
857
936
  * Removes all the controls from the aggregation {@link #getBannerLines bannerLines}.
858
937
  *
@@ -864,6 +943,17 @@ declare namespace sap {
864
943
  * @returns An array of the removed elements (might be empty)
865
944
  */
866
945
  removeAllBannerLines(): sap.m.Text[];
946
+ /**
947
+ * Removes all the controls from the aggregation {@link #getInfoSection infoSection}.
948
+ *
949
+ * Additionally, it unregisters them from the hosting UIArea.
950
+ *
951
+ * @since 1.136
952
+ * @experimental As of version 1.136.
953
+ *
954
+ * @returns An array of the removed elements (might be empty)
955
+ */
956
+ removeAllInfoSection(): sap.ui.core.Control[];
867
957
  /**
868
958
  * Removes a bannerLine from the aggregation {@link #getBannerLines bannerLines}.
869
959
  *
@@ -878,6 +968,20 @@ declare namespace sap {
878
968
  */
879
969
  vBannerLine: int | string | sap.m.Text
880
970
  ): sap.m.Text | null;
971
+ /**
972
+ * Removes a infoSection from the aggregation {@link #getInfoSection infoSection}.
973
+ *
974
+ * @since 1.136
975
+ * @experimental As of version 1.136.
976
+ *
977
+ * @returns The removed infoSection or `null`
978
+ */
979
+ removeInfoSection(
980
+ /**
981
+ * The infoSection to remove or its index or id
982
+ */
983
+ vInfoSection: int | string | sap.ui.core.Control
984
+ ): sap.ui.core.Control | null;
881
985
  /**
882
986
  * Sets a new value for property {@link #getDataTimestamp dataTimestamp}.
883
987
  *
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.135.0
1
+ // For Library Version: 1.136.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -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 namespace sap {
4
4
  /**
@@ -14,6 +14,13 @@ declare namespace sap {
14
14
  * can override to allow more flexibility.
15
15
  */
16
16
  namespace controllerextensions {
17
+ namespace MessageHandler {
18
+ /**
19
+ * Defines the message detail relevant for the MessageButton building block to display a popover.
20
+ */
21
+ type MessageDetail = {};
22
+ }
23
+
17
24
  namespace ViewState {
18
25
  /**
19
26
  * Definition of a navigation parameter
@@ -654,6 +661,26 @@ declare namespace sap {
654
661
  * @experimental As of version 1.90.0.
655
662
  */
656
663
  class MessageHandler extends sap.ui.core.mvc.ControllerExtension {
664
+ /**
665
+ * Allows consumer of a message button BB to decide which bound messages should be shown and how.
666
+ * This hook is called when the message button BB detects a change in the message model.
667
+ * The hooks allows to define behaviour for messages in the message button BB.
668
+ * Consumers will be able to do the following with this hook.
669
+ * 1. Filter out messages so that they are not shown on the message button.
670
+ * 2. group the messages based on their UI.
671
+ * 3. provide a presser handler incase the message should show as a link.
672
+ *
673
+ *
674
+ * @experimental
675
+ *
676
+ * @returns A promise that must be returned by the overridden method.
677
+ */
678
+ beforeShowMessageButton(
679
+ /**
680
+ * Object containing the details related to the message.
681
+ */
682
+ _messageDetails: sap.fe.core.controllerextensions.MessageHandler.MessageDetail[]
683
+ ): Promise<void>;
657
684
  /**
658
685
  * Shows a message dialog with transition messages if there are any.
659
686
  * The message dialog is shown as a modal dialog. Once the user confirms the dialog, all transition messages
@@ -709,7 +736,8 @@ declare namespace sap {
709
736
  *
710
737
  * @since 1.86.0
711
738
  */
712
- class Routing extends sap.ui.core.mvc.ControllerExtension {
739
+ class Routing extends sap.fe.core.controllerextensions
740
+ .BaseControllerExtension {
713
741
  /**
714
742
  * Allows navigation to a specific context.
715
743
  *
@@ -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 {}