@sapui5/ts-types 1.102.1 → 1.103.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 (61) 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 +11 -11
  4. package/types/sap.chart.d.ts +2 -2
  5. package/types/sap.collaboration.d.ts +1 -1
  6. package/types/sap.esh.search.ui.d.ts +1 -1
  7. package/types/sap.f.d.ts +164 -24
  8. package/types/sap.fe.common.d.ts +1 -1
  9. package/types/sap.fe.core.d.ts +29 -1159
  10. package/types/sap.fe.macros.d.ts +52 -627
  11. package/types/sap.fe.navigation.d.ts +1 -1309
  12. package/types/sap.fe.templates.d.ts +2 -161
  13. package/types/sap.fe.test.d.ts +12 -244
  14. package/types/sap.feedback.ui.d.ts +1 -1
  15. package/types/sap.gantt.d.ts +343 -63
  16. package/types/sap.insights.d.ts +2 -61
  17. package/types/sap.landvisz.d.ts +15 -15
  18. package/types/sap.m.d.ts +513 -284
  19. package/types/sap.makit.d.ts +5 -5
  20. package/types/sap.me.d.ts +2 -2
  21. package/types/sap.ndc.d.ts +75 -3
  22. package/types/sap.ovp.d.ts +6 -1
  23. package/types/sap.rules.ui.d.ts +1 -1
  24. package/types/sap.sac.df.d.ts +163 -1
  25. package/types/sap.sac.grid.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +59 -59
  27. package/types/sap.suite.ui.generic.template.d.ts +98 -12
  28. package/types/sap.suite.ui.microchart.d.ts +14 -14
  29. package/types/sap.tnt.d.ts +5 -5
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +36 -36
  32. package/types/sap.ui.comp.d.ts +113 -28
  33. package/types/sap.ui.core.d.ts +294 -92
  34. package/types/sap.ui.dt.d.ts +1 -1
  35. package/types/sap.ui.export.d.ts +3 -3
  36. package/types/sap.ui.fl.d.ts +3 -1
  37. package/types/sap.ui.generic.app.d.ts +13 -6
  38. package/types/sap.ui.generic.template.d.ts +1 -1
  39. package/types/sap.ui.integration.d.ts +3 -3
  40. package/types/sap.ui.layout.d.ts +33 -41
  41. package/types/sap.ui.mdc.d.ts +1 -1
  42. package/types/sap.ui.richtexteditor.d.ts +2 -2
  43. package/types/sap.ui.rta.d.ts +1 -1
  44. package/types/sap.ui.suite.d.ts +1 -1
  45. package/types/sap.ui.support.d.ts +1 -1
  46. package/types/sap.ui.table.d.ts +9 -9
  47. package/types/sap.ui.testrecorder.d.ts +1 -1
  48. package/types/sap.ui.unified.d.ts +35 -35
  49. package/types/sap.ui.ux3.d.ts +43 -43
  50. package/types/sap.ui.vbm.d.ts +130 -55
  51. package/types/sap.ui.vk.d.ts +25 -25
  52. package/types/sap.ui.vtm.d.ts +15 -12
  53. package/types/sap.uiext.inbox.d.ts +3 -3
  54. package/types/sap.ushell.d.ts +14 -12
  55. package/types/sap.ushell_abap.d.ts +1 -1
  56. package/types/sap.uxap.d.ts +13 -13
  57. package/types/sap.viz.d.ts +8 -8
  58. package/types/sap.webanalytics.core.d.ts +1 -1
  59. package/types/sap.zen.commons.d.ts +4 -4
  60. package/types/sap.zen.crosstab.d.ts +1 -1
  61. package/types/sap.zen.dsh.d.ts +1 -1
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.0
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -10,173 +10,14 @@ declare namespace sap {
10
10
  /**
11
11
  * @SINCE 1.79.0
12
12
  *
13
- *
14
13
  * Extension API for list reports on SAP Fiori elements for OData V4.
15
14
  */
16
- class ExtensionAPI
17
- /* was: sap.fe.templates.ExtensionAPI */ extends Object {
18
- constructor();
19
-
20
- /**
21
- * Add any control as a dependent control to this SAP Fiori elements page.
22
- */
23
- addDependent(
24
- /**
25
- * Control to be added as a dependent control
26
- */
27
- oControl: sap.ui.core.Control
28
- ): void;
29
- /**
30
- * This method converts filter conditions to filters.
31
- *
32
- * @returns Object containing the converted FilterBar filters.
33
- */
34
- createFiltersFromFilterConditions(
35
- /**
36
- * Map containing the filter conditions of the FilterBar.
37
- */
38
- mFilterConditions: any
39
- ): object;
40
- /**
41
- * Get access to models managed by SAP Fiori elements.
42
- *
43
- * The following models can be accessed:
44
- *
45
- *
46
- * - undefined: the undefined model returns the SAPUI5 OData V4 model bound to this page
47
- *
48
- * - i18n / further data models defined in the manifest
49
- * ui: returns a SAPUI5 JSON model containing UI information.
50
- * Only the following properties are public and supported:
51
- *
52
- *
53
- * - isEditable: set to true if the application is in edit mode
54
- *
55
- *
56
- * .
57
- * editMode is deprecated and should not be used anymore. Use isEditable instead.
58
- *
59
- * @returns The required model
60
- */
61
- getModel(
62
- /**
63
- * Name of the model
64
- */
65
- sModelName?: string
66
- ): undefined | sap.ui.model.Model;
67
- /**
68
- * Gets the list entries currently selected for the displayed control.
69
- *
70
- * @returns Array containing the selected contexts
71
- */
72
- getSelectedContexts(): any;
73
- /**
74
- * Load a fragment and go through the template preprocessor with the current page context.
75
- *
76
- * @returns The fragment definition
77
- */
78
- loadFragment(
79
- /**
80
- * The settings object
81
- */
82
- mSettings: {
83
- /**
84
- * The contextPath to be used for the templating process
85
- */
86
- contextPath: string;
87
- /**
88
- * The controller to be attached to the fragment
89
- */
90
- controller: object;
91
- /**
92
- * The ID of the fragment itself
93
- */
94
- id: string;
95
- /**
96
- * The initial binding context
97
- */
98
- initialBindingContext: sap.ui.model.Context;
99
- /**
100
- * The name of the fragment to be loaded
101
- */
102
- name: string;
103
- }
104
- ): Promise<any>;
105
- /**
106
- * Navigate to another target.
107
- */
108
- navigateToTarget(
109
- /**
110
- * Name of the target route
111
- */
112
- sTarget: string,
113
- /**
114
- * Context instance
115
- */
116
- oContext: sap.ui.model.Context
117
- ): void;
118
- /**
119
- * Refreshes the List Report.
120
- * This method currently only supports triggering the search (by clicking on the GO button)
121
- * in the List Report Filter Bar. It can be used to request the initial load or to refresh the
122
- * currently shown data based on the filters entered by the user.
123
- * Please note: The Promise is resolved once the search is triggered and not once the data is returned.
124
- *
125
- * @returns Resolved once the data is refreshed or rejected if the request failed
126
- */
127
- refresh(): any;
128
- /**
129
- * Remove a dependent control from this SAP Fiori elements page.
130
- */
131
- removeDependent(
132
- /**
133
- * Control to be added as a dependent control
134
- */
135
- oControl: sap.ui.core.Control
136
- ): void;
137
- /**
138
- * Set the filter values for the given property in the filter bar.
139
- * The filter values can be either a single value or an array of values.
140
- * Each filter value must be represented as a primitive value.
141
- *
142
- * @returns A promise for asynchronous handling
143
- */
144
- setFilterValues(
145
- /**
146
- * The path to the property as a condition path
147
- */
148
- sConditionPath: string,
149
- /**
150
- * The operator to be used (optional) - if not set, the default operator (EQ) will be used
151
- */
152
- sOperator: undefined | string,
153
- /**
154
- * The values to be applied
155
- */
156
- vValues:
157
- | undefined
158
- | string
159
- | number
160
- | boolean
161
- | string[]
162
- | number[]
163
- | boolean[]
164
- ): void;
165
- /**
166
- * Triggers an update of the app state.
167
- * Should be called if the state of a control, or any other state-relevant information, was changed.
168
- *
169
- * @returns A promise that resolves with the new app state object.
170
- */
171
- updateAppState(): undefined | Promise<any>;
172
- }
15
+ export const ExtensionAPI: undefined;
173
16
  }
174
17
  }
175
18
  }
176
19
 
177
20
  interface IUI5DefineDependencyNames {
178
21
  "sap/fe/templates/library": undefined;
179
-
180
- "sap/fe/templates/ListReport/ExtensionAPI": undefined;
181
22
  }
182
23
  }
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.0
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  namespace fe {
@@ -180,11 +180,11 @@ declare namespace sap {
180
180
  */
181
181
  iExecuteRefresh(): object;
182
182
  /**
183
- * Selects the specified entry in the draft data loss popup
183
+ * Selects the specified entry in the draft data loss popup.
184
184
  *
185
185
  * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
186
186
  */
187
- iSelectDraftDataLossOption(): object;
187
+ iSelectDraftDataLossOption(optionKey: any): object;
188
188
  }
189
189
 
190
190
  class DialogMessageAssertions extends sap.fe.test.api.DialogAssertions {
@@ -1055,6 +1055,12 @@ declare namespace sap {
1055
1055
  * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1056
1056
  */
1057
1057
  iExecuteDelete(): object;
1058
+ /**
1059
+ * Executes the Draft/Saved Version action in the header toolbar of an object page.
1060
+ *
1061
+ * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
1062
+ */
1063
+ iExecuteDraftAndSavedVersionSwitch(): object;
1058
1064
  /**
1059
1065
  * Executes the Edit action in the header toolbar of an object page.
1060
1066
  *
@@ -1826,7 +1832,7 @@ declare namespace sap {
1826
1832
  */
1827
1833
  sFieldLabel: string,
1828
1834
 
1829
- bDescending: undefined
1835
+ bDescending: boolean
1830
1836
  ): object;
1831
1837
  /**
1832
1838
  * Sorts the table entries by the specified column.
@@ -1842,7 +1848,7 @@ declare namespace sap {
1842
1848
  | sap.fe.test.api.ColumnIdentifier
1843
1849
  | number,
1844
1850
 
1845
- bDescending: undefined
1851
+ bDescending: boolean
1846
1852
  ): object;
1847
1853
  }
1848
1854
 
@@ -2755,238 +2761,6 @@ declare namespace sap {
2755
2761
  const assertions: assertions;
2756
2762
  }
2757
2763
 
2758
- /**
2759
- * All common actions (`When`) for all Opa tests are defined here.
2760
- */
2761
- class BaseActions extends sap.ui.test.Opa5 {
2762
- /**
2763
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2764
- */
2765
- constructor();
2766
-
2767
- /**
2768
- * Creates a new subclass of class sap.fe.test.BaseActions with name `sClassName` and enriches it with the
2769
- * information contained in `oClassInfo`.
2770
- *
2771
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2772
- *
2773
- * @returns Created class / constructor function
2774
- */
2775
- static extend<T extends Record<string, unknown>>(
2776
- /**
2777
- * Name of the class being created
2778
- */
2779
- sClassName: string,
2780
- /**
2781
- * Object literal with information about the class
2782
- */
2783
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseActions>,
2784
- /**
2785
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2786
- * used by this class
2787
- */
2788
- FNMetaImpl?: Function
2789
- ): Function;
2790
- /**
2791
- * Returns a metadata object for class sap.fe.test.BaseActions.
2792
- *
2793
- * @returns Metadata object describing this class
2794
- */
2795
- static getMetadata(): sap.ui.base.Metadata;
2796
- /**
2797
- * Closes the open popover via function.
2798
- *
2799
- * NOTE: This function ensures that a certain UI state is maintained in some exceptional cases. This function
2800
- * isn't usually called directly in a journey.
2801
- *
2802
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2803
- */
2804
- iClosePopover(): object;
2805
- /**
2806
- * Simulates the pressing of the Esc key for the element in focus.
2807
- *
2808
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2809
- */
2810
- iPressEscape(): object;
2811
- }
2812
- /**
2813
- * All common arrangements (`Given`) for all Opa tests are defined here.
2814
- */
2815
- class BaseArrangements extends sap.ui.test.Opa5 {
2816
- /**
2817
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2818
- */
2819
- constructor(
2820
- /**
2821
- * The settings object required for launching the application
2822
- */
2823
- mSettings: {
2824
- /**
2825
- * The URL to the launching page (usually a FLP.html)
2826
- */
2827
- launchUrl: string;
2828
- /**
2829
- * The URL launch parameters
2830
- */
2831
- launchParameters: object;
2832
- }
2833
- );
2834
-
2835
- /**
2836
- * Creates a new subclass of class sap.fe.test.BaseArrangements with name `sClassName` and enriches it with
2837
- * the information contained in `oClassInfo`.
2838
- *
2839
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2840
- *
2841
- * @returns Created class / constructor function
2842
- */
2843
- static extend<T extends Record<string, unknown>>(
2844
- /**
2845
- * Name of the class being created
2846
- */
2847
- sClassName: string,
2848
- /**
2849
- * Object literal with information about the class
2850
- */
2851
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseArrangements>,
2852
- /**
2853
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2854
- * used by this class
2855
- */
2856
- FNMetaImpl?: Function
2857
- ): Function;
2858
- /**
2859
- * Returns a metadata object for class sap.fe.test.BaseArrangements.
2860
- *
2861
- * @returns Metadata object describing this class
2862
- */
2863
- static getMetadata(): sap.ui.base.Metadata;
2864
- /**
2865
- * Resets the mock data.
2866
- *
2867
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2868
- */
2869
- iResetMockData(
2870
- /**
2871
- * The application id or a uri pointing to the service. One of the following properties needs to be provided
2872
- * within the parameter:
2873
- * ```javascript
2874
- *
2875
- * {
2876
- * :
2877
- * :
2878
- * }
2879
- * ```
2880
- * NOTE: When passing the AppId, the application needs to be running already. Calling the function
2881
- * before the application is started can be done by passing the ServiceUri.
2882
- */
2883
- oAppInfo?: object
2884
- ): object;
2885
- /**
2886
- * Resets the test data.
2887
- *
2888
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2889
- */
2890
- iResetTestData(): object;
2891
- /**
2892
- * Simulates a refresh of the page by tearing it down and then restarting it with the very same hash.
2893
- *
2894
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2895
- */
2896
- iRestartMyApp(): object;
2897
- /**
2898
- * Starts the app in an IFrame, using the `launchUrl` and `launchParameters` provided via the settings object
2899
- * of the {@link sap.fe.test.BaseArrangements#constructor}.
2900
- *
2901
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2902
- */
2903
- iStartMyApp(
2904
- /**
2905
- * The app hash
2906
- */
2907
- sAppHash?: string,
2908
- /**
2909
- * A map with additional URL parameters
2910
- */
2911
- mUrlParameters?: object
2912
- ): object;
2913
- /**
2914
- * Tears down the current application.
2915
- *
2916
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2917
- */
2918
- iTearDownMyApp(): object;
2919
- /**
2920
- * Clears the browser's local storage and session storage.
2921
- *
2922
- * NOTE: The function itself is not meant to be called directly within a journey. Instead, it can be overwritten
2923
- * to add custom clean-up functionality when calling {@link sap.fe.test.BaseArrangements#iResetTestData}.
2924
- *
2925
- * @returns A `Promise` object
2926
- */
2927
- resetTestData(): object;
2928
- }
2929
- /**
2930
- * All common assertions (`Then`) for all Opa tests are defined here.
2931
- */
2932
- class BaseAssertions extends sap.ui.test.Opa5 {
2933
- /**
2934
- * Constructs a new {@link sap.fe.test.Opa5} instance.
2935
- */
2936
- constructor();
2937
-
2938
- /**
2939
- * Creates a new subclass of class sap.fe.test.BaseAssertions with name `sClassName` and enriches it with
2940
- * the information contained in `oClassInfo`.
2941
- *
2942
- * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.test.Opa5.extend}.
2943
- *
2944
- * @returns Created class / constructor function
2945
- */
2946
- static extend<T extends Record<string, unknown>>(
2947
- /**
2948
- * Name of the class being created
2949
- */
2950
- sClassName: string,
2951
- /**
2952
- * Object literal with information about the class
2953
- */
2954
- oClassInfo?: sap.ClassInfo<T, sap.fe.test.BaseAssertions>,
2955
- /**
2956
- * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
2957
- * used by this class
2958
- */
2959
- FNMetaImpl?: Function
2960
- ): Function;
2961
- /**
2962
- * Returns a metadata object for class sap.fe.test.BaseAssertions.
2963
- *
2964
- * @returns Metadata object describing this class
2965
- */
2966
- static getMetadata(): sap.ui.base.Metadata;
2967
- /**
2968
- * Checks whether a {@link sap.m.MessagePage} with given message is shown.
2969
- *
2970
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2971
- */
2972
- iSeeMessagePage(
2973
- /**
2974
- * The message shown on the message page
2975
- */
2976
- sMessage: string
2977
- ): object;
2978
- /**
2979
- * Checks whether a {@link sap.m.MessageToast} with the given text is shown.
2980
- *
2981
- * @returns The result of the {@link sap.ui.test.Opa5#waitFor} function, to be used for chained statements
2982
- */
2983
- iSeeMessageToast(
2984
- /**
2985
- * The text shown in the MessageToast
2986
- */
2987
- sText: string
2988
- ): object;
2989
- }
2990
2764
  /**
2991
2765
  * A JourneyRunner for executing integration tests with given settings.
2992
2766
  */
@@ -3222,7 +2996,7 @@ declare namespace sap {
3222
2996
  /**
3223
2997
  * Additional custom page functions, provided in an object containing `actions` and `assertions`
3224
2998
  */
3225
- ...aAdditionalPageDefinitions: object[]
2999
+ ...aInAdditionalPageDefinitions: object[]
3226
3000
  );
3227
3001
  }
3228
3002
  /**
@@ -3418,12 +3192,6 @@ declare namespace sap {
3418
3192
 
3419
3193
  "sap/fe/test/api/TableAssertions": undefined;
3420
3194
 
3421
- "sap/fe/test/BaseActions": undefined;
3422
-
3423
- "sap/fe/test/BaseArrangements": undefined;
3424
-
3425
- "sap/fe/test/BaseAssertions": undefined;
3426
-
3427
3195
  "sap/fe/test/JourneyRunner": undefined;
3428
3196
 
3429
3197
  "sap/fe/test/library": undefined;
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.102.1
1
+ // For Library Version: 1.103.0
2
2
 
3
3
  declare namespace sap {
4
4
  interface IUI5DefineDependencyNames {