@sapui5/ts-types-esm 1.93.2 → 1.93.6

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 (59) hide show
  1. package/package.json +1 -1
  2. package/types/index.d.ts +1 -1
  3. package/types/sap.apf.d.ts +233 -253
  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 +228 -1
  8. package/types/sap.f.d.ts +1 -1
  9. package/types/sap.fe.common.d.ts +1 -1
  10. package/types/sap.fe.core.d.ts +1 -1
  11. package/types/sap.fe.macros.d.ts +1 -1
  12. package/types/sap.fe.navigation.d.ts +1 -1
  13. package/types/sap.fe.placeholder.d.ts +3 -0
  14. package/types/sap.fe.plugins.d.ts +1 -1
  15. package/types/sap.fe.templates.d.ts +1 -1
  16. package/types/sap.fe.test.d.ts +1 -1
  17. package/types/sap.fe.tools.d.ts +1 -1
  18. package/types/sap.feedback.ui.d.ts +1 -1
  19. package/types/sap.gantt.d.ts +1 -1
  20. package/types/sap.m.d.ts +1 -1
  21. package/types/sap.makit.d.ts +1 -1
  22. package/types/sap.me.d.ts +1 -1
  23. package/types/sap.ndc.d.ts +1 -1
  24. package/types/sap.ovp.d.ts +1 -1
  25. package/types/sap.rules.ui.d.ts +1 -1
  26. package/types/sap.suite.ui.commons.d.ts +1 -1
  27. package/types/sap.suite.ui.generic.template.d.ts +1 -1
  28. package/types/sap.suite.ui.microchart.d.ts +1 -1
  29. package/types/sap.tnt.d.ts +1 -1
  30. package/types/sap.ui.codeeditor.d.ts +1 -1
  31. package/types/sap.ui.commons.d.ts +1 -1
  32. package/types/sap.ui.comp.d.ts +3 -3
  33. package/types/sap.ui.core.d.ts +1 -9
  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 +1 -1
  37. package/types/sap.ui.integration.d.ts +1 -1
  38. package/types/sap.ui.layout.d.ts +1 -1
  39. package/types/sap.ui.mdc.d.ts +1 -1
  40. package/types/sap.ui.richtexteditor.d.ts +1 -1
  41. package/types/sap.ui.rta.d.ts +1 -1
  42. package/types/sap.ui.suite.d.ts +1 -1
  43. package/types/sap.ui.support.d.ts +6 -6
  44. package/types/sap.ui.table.d.ts +1 -1
  45. package/types/sap.ui.testrecorder.d.ts +1 -1
  46. package/types/sap.ui.unified.d.ts +1 -1
  47. package/types/sap.ui.ux3.d.ts +1 -1
  48. package/types/sap.ui.vbm.d.ts +1 -1
  49. package/types/sap.ui.vk.d.ts +1 -1
  50. package/types/sap.ui.vtm.d.ts +1 -1
  51. package/types/sap.uiext.inbox.d.ts +1 -1
  52. package/types/sap.ushell.d.ts +14 -5
  53. package/types/sap.ushell_abap.d.ts +1 -1
  54. package/types/sap.uxap.d.ts +1 -1
  55. package/types/sap.viz.d.ts +1 -1
  56. package/types/sap.zen.commons.d.ts +1 -1
  57. package/types/sap.zen.crosstab.d.ts +1 -1
  58. package/types/sap.zen.dsh.d.ts +1 -1
  59. package/types/sap.fe.placeholder-1.93.0-esm-d.ts +0 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sapui5/ts-types-esm",
3
- "version": "1.93.2",
3
+ "version": "1.93.6",
4
4
  "description": "SAPUI5 TypeScript Definitions - ES Modules",
5
5
  "homepage": "https://ui5.sap.com",
6
6
  "author": "SAP SE (https://www.sap.com)",
package/types/index.d.ts CHANGED
@@ -36,7 +36,7 @@
36
36
  /// <reference path="./sap.fe.core.d.ts"/>
37
37
  /// <reference path="./sap.fe.macros.d.ts"/>
38
38
  /// <reference path="./sap.fe.navigation.d.ts"/>
39
- /// <reference path="./sap.fe.placeholder-1.93.0-esm-d.ts"/>
39
+ /// <reference path="./sap.fe.placeholder.d.ts"/>
40
40
  /// <reference path="./sap.fe.plugins.d.ts"/>
41
41
  /// <reference path="./sap.fe.templates.d.ts"/>
42
42
  /// <reference path="./sap.fe.test.d.ts"/>
@@ -1,259 +1,7 @@
1
- // For Library Version: 1.93.0
1
+ // For Library Version: 1.93.1
2
2
 
3
3
  declare module "sap/apf/library" {}
4
4
 
5
- declare module "sap/apf/api" {
6
- import MessageObject from "sap/apf/core/messageObject";
7
-
8
- /**
9
- * Official API for Analysis Path Framework (APF)
10
- * The APF API provides a consuming application access to the functionality of the APF. It is assumed
11
- * that the consuming application extends type {@link sap.apf.base.Component}. The API reference is returned
12
- * by method {@link sap.apf.base.Component#getApi}.
13
- * Objects and types returned by methods of APF API or passed in parameters of APF API method also belong
14
- * to the API. These objects and types are documented in their respective sections of this documentation.
15
- * All methods, objects or types that are not explicitly documented as public are strictly internal and
16
- * may be changed without prior notice. This also includes all methods, objects or types being classified
17
- * as experimental.
18
- * Furthermore there is no need to instantiate required entities directly by applying the JavaScript 'new'-operator
19
- * on their respective constructors. Instead they should be created by consumers using a create method available
20
- * on API-level, such as e.g. {@link sap.apf.Api#createMessageObject} for {@link sap.apf.core.MessageObject}
21
- * or {@link sap.apf.Api#createFilter} for {@link sap.apf.utils.Filter}.
22
- */
23
- export default class Api {
24
- constructor(
25
- /**
26
- * A reference to the calling Component.js. The reference provides access to parameters and context.
27
- */
28
- oComponent: /* was: sap.apf.Component */
29
- | any
30
- | /* was: sap.apf.base.Component */ any,
31
- /**
32
- * injected constructors and functions for testing only.
33
- */
34
- inject?: Object,
35
- /**
36
- * manifests of the component and the base component itself
37
- */
38
- manifests?: Object
39
- );
40
- /**
41
- * Contains 'api'
42
- */
43
- type: undefined;
44
-
45
- /**
46
- * @EXPERIMENTAL
47
- *
48
- * The handling of the window.onerror by the message handler is either switched on or off. Per default the
49
- * handling is deactivated.
50
- */
51
- activateOnErrorHandling(
52
- /**
53
- * Boolean true switches the winow.onerror handling on
54
- */
55
- bHandling: boolean
56
- ): undefined;
57
- /**
58
- * @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
59
- * @EXPERIMENTAL
60
- *
61
- * Adds an element to the footer area.
62
- */
63
- addMasterFooterContent(
64
- /**
65
- * any valid UI5 control.
66
- */
67
- oControl: object
68
- ): void;
69
- /**
70
- * Adds a filter to the path. Subsequent changes need to be done by the update method providing the identifier.
71
- * Limitation: Only a single filter term or a disjunction/conjunction of single terms over a single property
72
- * is supported. Limitation: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
73
- * supported.
74
- */
75
- addPathFilter(filter: sap.apf.utils.Filter): number;
76
- /**
77
- * Creates an empty filter object. Its methods can be used to create a logical filter expression.
78
- */
79
- createFilter(): sap.apf.utils.Filter;
80
- /**
81
- * Creates a message object, which is the mandatory parameter for API method putMessage. So first create
82
- * the message object and afterwards call putMessage with the message object as argument.
83
- */
84
- createMessageObject(
85
- /**
86
- * Configuration object for the message object.
87
- */
88
- oConfig: {
89
- /**
90
- * The message is classified by its code. The code identifies an entry in the message configuration.
91
- */
92
- code: string;
93
- /**
94
- * Additional parameters for the message. The parameters are filled into the message text, when the message
95
- * will be processed by the text resource handler.
96
- */
97
- aParameters?: any[];
98
- /**
99
- * Reference of the calling object. This can be used later to visualize on the user interface, where the
100
- * message occurred.
101
- */
102
- oCallingObject?: object;
103
- /**
104
- * Raw text for non translated messages.
105
- */
106
- rawText?: string;
107
- }
108
- ): MessageObject;
109
- /**
110
- * Creates an object for performing an Odata Request get operation.
111
- * See:
112
- * sap.apf#createReadRequest
113
- */
114
- createReadRequest(
115
- /**
116
- * identifies a request configuration, which is contained in the analytical configuration. or the request
117
- * configuration is directly passed as an object oRequestConfiguration.
118
- */
119
- requestConfiguration: string | object
120
- ): sap.apf.core.ReadRequest;
121
- /**
122
- * helps to call customer defined custom formatter function(fnCallback).
123
- */
124
- customFormat(
125
- /**
126
- * custom format function need to be called.
127
- */
128
- fnCallback: Function
129
- ): void;
130
- /**
131
- * Gets a path filter fragment for the given identifier by fully replacing the existing one.
132
- */
133
- getPathFilter(
134
- /**
135
- * Identifier of the path filter fragment as it was returned by addPathFilter method.
136
- */
137
- id: number | string
138
- ): sap.apf.utils.Filter;
139
- /**
140
- * Retrieves a text and applies HTML encoding
141
- */
142
- getTextHtmlEncoded(
143
- /**
144
- * || {string} Label object or text key
145
- */
146
- oLabel: object,
147
- /**
148
- * Array with parameters to replace place holders in text.
149
- */
150
- aParameters: string[]
151
- ): string;
152
- /**
153
- * Retrieves a text without application of HTML encoding
154
- */
155
- getTextNotHtmlEncoded(
156
- /**
157
- * || {string} Label object or text key
158
- */
159
- oLabel: object,
160
- /**
161
- * Array with parameters to replace place holders in text.
162
- */
163
- aParameters: string[]
164
- ): string;
165
- /**
166
- * @deprecated (since 1.23.1)
167
- * @EXPERIMENTAL
168
- *
169
- * Loads a new application configuration in JSON format. When called many times, the file is loaded only
170
- * the first time.
171
- */
172
- loadApplicationConfig(
173
- /**
174
- * The absolute path of an application configuration file. Host and port will be added in front of this
175
- * path.
176
- */
177
- sFilePath: string
178
- ): void;
179
- /**
180
- * A message is passed to the APF message handler for further processing. All message specific settings
181
- * (e.g. message code or severity) need to be passed within an APF message object instance.
182
- */
183
- putMessage(
184
- /**
185
- * The message object shall be created by method {@link sap.apf.Api#createMessageObject}.
186
- */
187
- oMessage: MessageObject
188
- ): undefined;
189
- /**
190
- * @EXPERIMENTAL
191
- *
192
- * Calls the sap.apf.core.instance#updatePath (also see {@link sap.apf.core.Path#update}) with proper callback
193
- * for UI. It also refreshes the steps either from the active step or all the steps depending on the boolean
194
- * value passed.
195
- */
196
- selectionChanged(bRefreshAllSteps: boolean): void;
197
- /**
198
- * Register the function callback to be executed after APF start-up and content has been created. Callback
199
- * is called with APF API instance as parameter and 'this' set to the Component instance.
200
- */
201
- setCallbackAfterApfStartup(
202
- /**
203
- * that will be executed after APF start-up and content has been created.
204
- */
205
- fnCallback: Function
206
- ): void;
207
- /**
208
- * Register the function callback to be executed before APF start-up. Callback is called with APF API instance
209
- * as parameter and 'this' set to the Component instance.
210
- */
211
- setCallbackBeforeApfStartup(
212
- /**
213
- * that will be executed before APF start-up.
214
- */
215
- fnCallback: Function
216
- ): void;
217
- /**
218
- * @EXPERIMENTAL
219
- *
220
- * Register the function callback to be executed on the given event type. fnCallback will be executed under
221
- * a context and will be passed with arguments depending on the event type.
222
- */
223
- setEventCallback(
224
- /**
225
- * is the type of event for registering the fnCallback for that particular event type printTriggered - Registers
226
- * a callback for initial page print, this callback returns 2d array contextChanged : Registers a callback
227
- * for context change, which will set the context of the application
228
- */
229
- sEventType: /* was: sap.apf.core.constants.eventTypes */ any,
230
- /**
231
- * that will be executed depending on the event type.
232
- */
233
- fnCallback: Function
234
- ): boolean;
235
- /**
236
- * true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
237
- * startupApf
238
- */
239
- startupSucceeded(): boolean;
240
- /**
241
- * Updates a filter of the path. Limitation: Only a single filter term or a disjunction/conjunction of single
242
- * terms over a single property is supported. Limitation: Only the operators EQ, LE (less equal than) and
243
- * GE (greater equal than) are supported.
244
- */
245
- updatePathFilter(
246
- /**
247
- * Identifier of the path filter as it was returned by addPathFilter method. When using an ID of type string
248
- * the caller must ensure that it is unique.
249
- */
250
- id: number | string,
251
-
252
- filter: sap.apf.utils.Filter
253
- ): void;
254
- }
255
- }
256
-
257
5
  declare module "sap/apf/core/messageObject" {
258
6
  /**
259
7
  * The message object represents the APF specific message object for detailed evaluation. The message object
@@ -914,6 +662,238 @@ declare namespace sap {
914
662
  getId(): string;
915
663
  }
916
664
  }
665
+
666
+ /**
667
+ * Official API for Analysis Path Framework (APF)
668
+ * The APF API provides a consuming application access to the functionality of the APF. It is assumed
669
+ * that the consuming application extends type {@link sap.apf.base.Component}. The API reference is returned
670
+ * by method {@link sap.apf.base.Component#getApi}.
671
+ * Objects and types returned by methods of APF API or passed in parameters of APF API method also belong
672
+ * to the API. These objects and types are documented in their respective sections of this documentation.
673
+ * All methods, objects or types that are not explicitly documented as public are strictly internal and
674
+ * may be changed without prior notice. This also includes all methods, objects or types being classified
675
+ * as experimental.
676
+ * Furthermore there is no need to instantiate required entities directly by applying the JavaScript 'new'-operator
677
+ * on their respective constructors. Instead they should be created by consumers using a create method available
678
+ * on API-level, such as e.g. {@link sap.apf.Api#createMessageObject} for {@link sap.apf.core.MessageObject}
679
+ * or {@link sap.apf.Api#createFilter} for {@link sap.apf.utils.Filter}.
680
+ */
681
+ class Api {
682
+ constructor(
683
+ /**
684
+ * A reference to the calling Component.js. The reference provides access to parameters and context.
685
+ */
686
+ oComponent: /* was: sap.apf.Component */
687
+ | any
688
+ | /* was: sap.apf.base.Component */ any,
689
+ /**
690
+ * injected constructors and functions for testing only.
691
+ */
692
+ inject?: Object,
693
+ /**
694
+ * manifests of the component and the base component itself
695
+ */
696
+ manifests?: Object
697
+ );
698
+
699
+ /**
700
+ * @EXPERIMENTAL
701
+ *
702
+ * The handling of the window.onerror by the message handler is either switched on or off. Per default the
703
+ * handling is deactivated.
704
+ */
705
+ activateOnErrorHandling(
706
+ /**
707
+ * Boolean true switches the winow.onerror handling on
708
+ */
709
+ bHandling: boolean
710
+ ): undefined;
711
+ /**
712
+ * @deprecated (since 1.23.1) - Remains in api in order to maintain downward compatibility to 3 Wave 5 apps.
713
+ * @EXPERIMENTAL
714
+ *
715
+ * Adds an element to the footer area.
716
+ */
717
+ addMasterFooterContent(
718
+ /**
719
+ * any valid UI5 control.
720
+ */
721
+ oControl: object
722
+ ): void;
723
+ /**
724
+ * Adds a filter to the path. Subsequent changes need to be done by the update method providing the identifier.
725
+ * Limitation: Only a single filter term or a disjunction/conjunction of single terms over a single property
726
+ * is supported. Limitation: Only the operators EQ, LE (less equal than) and GE (greater equal than) are
727
+ * supported.
728
+ */
729
+ addPathFilter(filter: utils.Filter): number;
730
+ /**
731
+ * Creates an empty filter object. Its methods can be used to create a logical filter expression.
732
+ */
733
+ createFilter(): utils.Filter;
734
+ /**
735
+ * Creates a message object, which is the mandatory parameter for API method putMessage. So first create
736
+ * the message object and afterwards call putMessage with the message object as argument.
737
+ */
738
+ createMessageObject(
739
+ /**
740
+ * Configuration object for the message object.
741
+ */
742
+ oConfig: {
743
+ /**
744
+ * The message is classified by its code. The code identifies an entry in the message configuration.
745
+ */
746
+ code: string;
747
+ /**
748
+ * Additional parameters for the message. The parameters are filled into the message text, when the message
749
+ * will be processed by the text resource handler.
750
+ */
751
+ aParameters?: any[];
752
+ /**
753
+ * Reference of the calling object. This can be used later to visualize on the user interface, where the
754
+ * message occurred.
755
+ */
756
+ oCallingObject?: object;
757
+ /**
758
+ * Raw text for non translated messages.
759
+ */
760
+ rawText?: string;
761
+ }
762
+ ): import("sap/apf/core/messageObject").default;
763
+ /**
764
+ * helps to call customer defined custom formatter function(fnCallback).
765
+ */
766
+ customFormat(
767
+ /**
768
+ * custom format function need to be called.
769
+ */
770
+ fnCallback: Function
771
+ ): void;
772
+ /**
773
+ * Gets a path filter fragment for the given identifier by fully replacing the existing one.
774
+ */
775
+ getPathFilter(
776
+ /**
777
+ * Identifier of the path filter fragment as it was returned by addPathFilter method.
778
+ */
779
+ id: number | string
780
+ ): utils.Filter;
781
+ /**
782
+ * Retrieves a text and applies HTML encoding
783
+ */
784
+ getTextHtmlEncoded(
785
+ /**
786
+ * || {string} Label object or text key
787
+ */
788
+ oLabel: object,
789
+ /**
790
+ * Array with parameters to replace place holders in text.
791
+ */
792
+ aParameters: string[]
793
+ ): string;
794
+ /**
795
+ * Retrieves a text without application of HTML encoding
796
+ */
797
+ getTextNotHtmlEncoded(
798
+ /**
799
+ * || {string} Label object or text key
800
+ */
801
+ oLabel: object,
802
+ /**
803
+ * Array with parameters to replace place holders in text.
804
+ */
805
+ aParameters: string[]
806
+ ): string;
807
+ /**
808
+ * @deprecated (since 1.23.1)
809
+ * @EXPERIMENTAL
810
+ *
811
+ * Loads a new application configuration in JSON format. When called many times, the file is loaded only
812
+ * the first time.
813
+ */
814
+ loadApplicationConfig(
815
+ /**
816
+ * The absolute path of an application configuration file. Host and port will be added in front of this
817
+ * path.
818
+ */
819
+ sFilePath: string
820
+ ): void;
821
+ /**
822
+ * A message is passed to the APF message handler for further processing. All message specific settings
823
+ * (e.g. message code or severity) need to be passed within an APF message object instance.
824
+ */
825
+ putMessage(
826
+ /**
827
+ * The message object shall be created by method {@link sap.apf.Api#createMessageObject}.
828
+ */
829
+ oMessage: import("sap/apf/core/messageObject").default
830
+ ): undefined;
831
+ /**
832
+ * @EXPERIMENTAL
833
+ *
834
+ * Calls the sap.apf.core.instance#updatePath (also see {@link sap.apf.core.Path#update}) with proper callback
835
+ * for UI. It also refreshes the steps either from the active step or all the steps depending on the boolean
836
+ * value passed.
837
+ */
838
+ selectionChanged(bRefreshAllSteps: boolean): void;
839
+ /**
840
+ * Register the function callback to be executed after APF start-up and content has been created. Callback
841
+ * is called with APF API instance as parameter and 'this' set to the Component instance.
842
+ */
843
+ setCallbackAfterApfStartup(
844
+ /**
845
+ * that will be executed after APF start-up and content has been created.
846
+ */
847
+ fnCallback: Function
848
+ ): void;
849
+ /**
850
+ * Register the function callback to be executed before APF start-up. Callback is called with APF API instance
851
+ * as parameter and 'this' set to the Component instance.
852
+ */
853
+ setCallbackBeforeApfStartup(
854
+ /**
855
+ * that will be executed before APF start-up.
856
+ */
857
+ fnCallback: Function
858
+ ): void;
859
+ /**
860
+ * @EXPERIMENTAL
861
+ *
862
+ * Register the function callback to be executed on the given event type. fnCallback will be executed under
863
+ * a context and will be passed with arguments depending on the event type.
864
+ */
865
+ setEventCallback(
866
+ /**
867
+ * is the type of event for registering the fnCallback for that particular event type printTriggered - Registers
868
+ * a callback for initial page print, this callback returns 2d array contextChanged : Registers a callback
869
+ * for context change, which will set the context of the application
870
+ */
871
+ sEventType: /* was: sap.apf.core.constants.eventTypes */ any,
872
+ /**
873
+ * that will be executed depending on the event type.
874
+ */
875
+ fnCallback: Function
876
+ ): boolean;
877
+ /**
878
+ * true, when no fatal error occurred during startup phase. Startup phase includes the initialization +
879
+ * startupApf
880
+ */
881
+ startupSucceeded(): boolean;
882
+ /**
883
+ * Updates a filter of the path. Limitation: Only a single filter term or a disjunction/conjunction of single
884
+ * terms over a single property is supported. Limitation: Only the operators EQ, LE (less equal than) and
885
+ * GE (greater equal than) are supported.
886
+ */
887
+ updatePathFilter(
888
+ /**
889
+ * Identifier of the path filter as it was returned by addPathFilter method. When using an ID of type string
890
+ * the caller must ensure that it is unique.
891
+ */
892
+ id: number | string,
893
+
894
+ filter: utils.Filter
895
+ ): void;
896
+ }
917
897
  }
918
898
 
919
899
  interface IUI5DefineDependencyNames {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.0
1
+ // For Library Version: 1.93.1
2
2
 
3
3
  declare module "sap/ca/ui/library" {
4
4
  export namespace charts {
@@ -1,4 +1,4 @@
1
- // For Library Version: 1.93.1
1
+ // For Library Version: 1.93.4
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.93.0
1
+ // For Library Version: 1.93.1
2
2
 
3
3
  declare module "sap/collaboration/library" {
4
4
  /**